1 /* Common code for executing a program in a sub-process.
2 Copyright (C) 2005 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor <ian@airs.com>.
5 This file is part of the libiberty library.
6 Libiberty is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
11 Libiberty is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with libiberty; see the file COPYING.LIB. If not,
18 write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
19 Boston, MA 02110-1301, USA. */
22 #include "libiberty.h"
23 #include "pex-common.h"
27 #ifdef NEED_DECLARATION_ERRNO
40 extern int mkstemps (char *, int);
42 /* This file contains subroutines for the program execution routines
43 (pex_init, pex_run, etc.). This file is compiled on all
46 static void pex_add_remove (struct pex_obj
*, const char *, int);
47 static int pex_get_status_and_time (struct pex_obj
*, int, const char **,
50 /* Initialize a pex_obj structure. */
53 pex_init_common (int flags
, const char *pname
, const char *tempbase
,
54 const struct pex_funcs
*funcs
)
58 obj
= XNEW (struct pex_obj
);
61 obj
->tempbase
= tempbase
;
62 obj
->next_input
= STDIN_FILE_NO
;
63 obj
->next_input_name
= NULL
;
64 obj
->next_input_name_allocated
= 0;
69 obj
->number_waited
= 0;
70 obj
->read_output
= NULL
;
71 obj
->remove_count
= 0;
78 /* Add a file to be removed when we are done. */
81 pex_add_remove (struct pex_obj
*obj
, const char *name
, int allocated
)
86 obj
->remove
= XRESIZEVEC (char *, obj
->remove
, obj
->remove_count
);
91 obj
->remove
[obj
->remove_count
- 1] = add
;
97 pex_run (struct pex_obj
*obj
, int flags
, const char *executable
,
98 char * const * argv
, const char *orig_outname
, const char *errname
,
104 int outname_allocated
;
111 outname
= (char *) orig_outname
;
112 outname_allocated
= 0;
116 if (obj
->next_input_name
!= NULL
)
118 /* We have to make sure that the previous process has completed
119 before we try to read the file. */
120 if (!pex_get_status_and_time (obj
, 0, &errmsg
, err
))
123 in
= obj
->funcs
->open_read (obj
, obj
->next_input_name
,
124 (flags
& PEX_BINARY_INPUT
) != 0);
128 errmsg
= "open temporary file";
131 if (obj
->next_input_name_allocated
)
133 free (obj
->next_input_name
);
134 obj
->next_input_name_allocated
= 0;
136 obj
->next_input_name
= NULL
;
140 in
= obj
->next_input
;
144 errmsg
= "pipeline already complete";
149 /* Set OUT and OBJ->NEXT_INPUT/OBJ->NEXT_INPUT_NAME. */
151 if ((flags
& PEX_LAST
) != 0)
154 out
= STDOUT_FILE_NO
;
155 else if ((flags
& PEX_SUFFIX
) != 0)
157 outname
= concat (obj
->tempbase
, outname
, NULL
);
158 outname_allocated
= 1;
160 obj
->next_input
= -1;
162 else if ((obj
->flags
& PEX_USE_PIPES
) == 0)
166 if (obj
->tempbase
== NULL
)
168 outname
= make_temp_file (NULL
);
169 outname_allocated
= 1;
173 int len
= strlen (obj
->tempbase
);
176 && strcmp (obj
->tempbase
+ len
- 6, "XXXXXX") == 0)
177 outname
= xstrdup (obj
->tempbase
);
179 outname
= concat (obj
->tempbase
, "XXXXXX", NULL
);
181 outname_allocated
= 1;
183 out
= mkstemps (outname
, 0);
187 errmsg
= "could not create temporary output file";
191 /* This isn't obj->funcs->close because we got the
192 descriptor from mkstemps, not from a function in
193 obj->funcs. Calling close here is just like what
194 make_temp_file does. */
199 else if ((flags
& PEX_SUFFIX
) != 0)
201 if (obj
->tempbase
== NULL
)
202 outname
= make_temp_file (outname
);
204 outname
= concat (obj
->tempbase
, outname
, NULL
);
205 outname_allocated
= 1;
208 if ((obj
->flags
& PEX_SAVE_TEMPS
) == 0)
210 pex_add_remove (obj
, outname
, outname_allocated
);
211 outname_allocated
= 0;
214 /* Hand off ownership of outname to the next stage. */
215 obj
->next_input_name
= outname
;
216 obj
->next_input_name_allocated
= outname_allocated
;
217 outname_allocated
= 0;
221 if (obj
->funcs
->pipe (obj
, p
, (flags
& PEX_BINARY_OUTPUT
) != 0) < 0)
229 obj
->next_input
= p
[READ_PORT
];
234 out
= obj
->funcs
->open_write (obj
, outname
,
235 (flags
& PEX_BINARY_OUTPUT
) != 0);
239 errmsg
= "open temporary output file";
244 if (outname_allocated
)
247 outname_allocated
= 0;
253 errdes
= STDERR_FILE_NO
;
256 /* We assume that stderr is in text mode--it certainly shouldn't
257 be controlled by PEX_BINARY_OUTPUT. If necessary, we can add
258 a PEX_BINARY_STDERR flag. */
259 errdes
= obj
->funcs
->open_write (obj
, errname
, 0);
263 errmsg
= "open error file";
268 /* Run the program. */
270 pid
= obj
->funcs
->exec_child (obj
, flags
, executable
, argv
, in
, out
, errdes
,
276 obj
->children
= XRESIZEVEC (long, obj
->children
, obj
->count
);
277 obj
->children
[obj
->count
- 1] = pid
;
282 if (in
>= 0 && in
!= STDIN_FILE_NO
)
283 obj
->funcs
->close (obj
, in
);
284 if (out
>= 0 && out
!= STDOUT_FILE_NO
)
285 obj
->funcs
->close (obj
, out
);
286 if (errdes
>= 0 && errdes
!= STDERR_FILE_NO
)
287 obj
->funcs
->close (obj
, errdes
);
288 if (outname_allocated
)
293 /* Return a FILE pointer for the output of the last program
297 pex_read_output (struct pex_obj
*obj
, int binary
)
299 if (obj
->next_input_name
!= NULL
)
304 /* We have to make sure that the process has completed before we
305 try to read the file. */
306 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
312 obj
->read_output
= fopen (obj
->next_input_name
, binary
? "rb" : "r");
314 if (obj
->next_input_name_allocated
)
316 free (obj
->next_input_name
);
317 obj
->next_input_name_allocated
= 0;
319 obj
->next_input_name
= NULL
;
326 if (o
< 0 || o
== STDIN_FILE_NO
)
328 obj
->read_output
= obj
->funcs
->fdopenr (obj
, o
, binary
);
329 obj
->next_input
= -1;
332 return obj
->read_output
;
335 /* Get the exit status and, if requested, the resource time for all
336 the child processes. Return 0 on failure, 1 on success. */
339 pex_get_status_and_time (struct pex_obj
*obj
, int done
, const char **errmsg
,
345 if (obj
->number_waited
== obj
->count
)
348 obj
->status
= XRESIZEVEC (int, obj
->status
, obj
->count
);
349 if ((obj
->flags
& PEX_RECORD_TIMES
) != 0)
350 obj
->time
= XRESIZEVEC (struct pex_time
, obj
->time
, obj
->count
);
353 for (i
= obj
->number_waited
; i
< obj
->count
; ++i
)
355 if (obj
->funcs
->wait (obj
, obj
->children
[i
], &obj
->status
[i
],
356 obj
->time
== NULL
? NULL
: &obj
->time
[i
],
357 done
, errmsg
, err
) < 0)
360 obj
->number_waited
= i
;
365 /* Get exit status of executed programs. */
368 pex_get_status (struct pex_obj
*obj
, int count
, int *vector
)
370 if (obj
->status
== NULL
)
375 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
379 if (count
> obj
->count
)
381 memset (vector
+ obj
->count
, 0, (count
- obj
->count
) * sizeof (int));
385 memcpy (vector
, obj
->status
, count
* sizeof (int));
390 /* Get process times of executed programs. */
393 pex_get_times (struct pex_obj
*obj
, int count
, struct pex_time
*vector
)
395 if (obj
->status
== NULL
)
400 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
404 if (obj
->time
== NULL
)
407 if (count
> obj
->count
)
409 memset (vector
+ obj
->count
, 0,
410 (count
- obj
->count
) * sizeof (struct pex_time
));
414 memcpy (vector
, obj
->time
, count
* sizeof (struct pex_time
));
419 /* Free a pex_obj structure. */
422 pex_free (struct pex_obj
*obj
)
424 if (obj
->next_input
>= 0 && obj
->next_input
!= STDIN_FILE_NO
)
425 obj
->funcs
->close (obj
, obj
->next_input
);
427 /* If the caller forgot to wait for the children, we do it here, to
429 if (obj
->status
== NULL
)
434 obj
->flags
&= ~ PEX_RECORD_TIMES
;
435 pex_get_status_and_time (obj
, 1, &errmsg
, &err
);
438 if (obj
->next_input_name_allocated
)
439 free (obj
->next_input_name
);
440 if (obj
->children
!= NULL
)
441 free (obj
->children
);
442 if (obj
->status
!= NULL
)
444 if (obj
->time
!= NULL
)
446 if (obj
->read_output
!= NULL
)
447 fclose (obj
->read_output
);
449 if (obj
->remove_count
> 0)
453 for (i
= 0; i
< obj
->remove_count
; ++i
)
455 remove (obj
->remove
[i
]);
456 free (obj
->remove
[i
]);
461 if (obj
->funcs
->cleanup
!= NULL
)
462 obj
->funcs
->cleanup (obj
);