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
;
94 /* Generate a temporary file name based on OBJ, FLAGS, and NAME.
95 Return NULL if we were unable to reserve a temporary filename.
97 If non-NULL, the result is either allocated with malloc, or the
98 same pointer as NAME. */
100 temp_file (struct pex_obj
*obj
, int flags
, char *name
)
104 if (obj
->tempbase
== NULL
)
106 name
= make_temp_file (NULL
);
110 int len
= strlen (obj
->tempbase
);
114 && strcmp (obj
->tempbase
+ len
- 6, "XXXXXX") == 0)
115 name
= xstrdup (obj
->tempbase
);
117 name
= concat (obj
->tempbase
, "XXXXXX", NULL
);
119 out
= mkstemps (name
, 0);
126 /* This isn't obj->funcs->close because we got the
127 descriptor from mkstemps, not from a function in
128 obj->funcs. Calling close here is just like what
129 make_temp_file does. */
133 else if ((flags
& PEX_SUFFIX
) != 0)
135 if (obj
->tempbase
== NULL
)
136 name
= make_temp_file (name
);
138 name
= concat (obj
->tempbase
, name
, NULL
);
147 pex_run (struct pex_obj
*obj
, int flags
, const char *executable
,
148 char * const * argv
, const char *orig_outname
, const char *errname
,
154 int outname_allocated
;
161 outname
= (char *) orig_outname
;
162 outname_allocated
= 0;
166 if (obj
->next_input_name
!= NULL
)
168 /* We have to make sure that the previous process has completed
169 before we try to read the file. */
170 if (!pex_get_status_and_time (obj
, 0, &errmsg
, err
))
173 in
= obj
->funcs
->open_read (obj
, obj
->next_input_name
,
174 (flags
& PEX_BINARY_INPUT
) != 0);
178 errmsg
= "open temporary file";
181 if (obj
->next_input_name_allocated
)
183 free (obj
->next_input_name
);
184 obj
->next_input_name_allocated
= 0;
186 obj
->next_input_name
= NULL
;
190 in
= obj
->next_input
;
194 errmsg
= "pipeline already complete";
199 /* Set OUT and OBJ->NEXT_INPUT/OBJ->NEXT_INPUT_NAME. */
201 if ((flags
& PEX_LAST
) != 0)
204 out
= STDOUT_FILE_NO
;
205 else if ((flags
& PEX_SUFFIX
) != 0)
207 outname
= concat (obj
->tempbase
, outname
, NULL
);
208 outname_allocated
= 1;
210 obj
->next_input
= -1;
212 else if ((obj
->flags
& PEX_USE_PIPES
) == 0)
214 outname
= temp_file (obj
, flags
, outname
);
218 errmsg
= "could not create temporary file";
222 if (outname
!= orig_outname
)
223 outname_allocated
= 1;
225 if ((obj
->flags
& PEX_SAVE_TEMPS
) == 0)
227 pex_add_remove (obj
, outname
, outname_allocated
);
228 outname_allocated
= 0;
231 /* Hand off ownership of outname to the next stage. */
232 obj
->next_input_name
= outname
;
233 obj
->next_input_name_allocated
= outname_allocated
;
234 outname_allocated
= 0;
238 if (obj
->funcs
->pipe (obj
, p
, (flags
& PEX_BINARY_OUTPUT
) != 0) < 0)
246 obj
->next_input
= p
[READ_PORT
];
251 out
= obj
->funcs
->open_write (obj
, outname
,
252 (flags
& PEX_BINARY_OUTPUT
) != 0);
256 errmsg
= "open temporary output file";
261 if (outname_allocated
)
264 outname_allocated
= 0;
270 errdes
= STDERR_FILE_NO
;
273 /* We assume that stderr is in text mode--it certainly shouldn't
274 be controlled by PEX_BINARY_OUTPUT. If necessary, we can add
275 a PEX_BINARY_STDERR flag. */
276 errdes
= obj
->funcs
->open_write (obj
, errname
, 0);
280 errmsg
= "open error file";
285 /* Run the program. */
287 pid
= obj
->funcs
->exec_child (obj
, flags
, executable
, argv
, in
, out
, errdes
,
293 obj
->children
= XRESIZEVEC (long, obj
->children
, obj
->count
);
294 obj
->children
[obj
->count
- 1] = pid
;
299 if (in
>= 0 && in
!= STDIN_FILE_NO
)
300 obj
->funcs
->close (obj
, in
);
301 if (out
>= 0 && out
!= STDOUT_FILE_NO
)
302 obj
->funcs
->close (obj
, out
);
303 if (errdes
>= 0 && errdes
!= STDERR_FILE_NO
)
304 obj
->funcs
->close (obj
, errdes
);
305 if (outname_allocated
)
310 /* Return a FILE pointer for the output of the last program
314 pex_read_output (struct pex_obj
*obj
, int binary
)
316 if (obj
->next_input_name
!= NULL
)
321 /* We have to make sure that the process has completed before we
322 try to read the file. */
323 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
329 obj
->read_output
= fopen (obj
->next_input_name
, binary
? "rb" : "r");
331 if (obj
->next_input_name_allocated
)
333 free (obj
->next_input_name
);
334 obj
->next_input_name_allocated
= 0;
336 obj
->next_input_name
= NULL
;
343 if (o
< 0 || o
== STDIN_FILE_NO
)
345 obj
->read_output
= obj
->funcs
->fdopenr (obj
, o
, binary
);
346 obj
->next_input
= -1;
349 return obj
->read_output
;
352 /* Get the exit status and, if requested, the resource time for all
353 the child processes. Return 0 on failure, 1 on success. */
356 pex_get_status_and_time (struct pex_obj
*obj
, int done
, const char **errmsg
,
362 if (obj
->number_waited
== obj
->count
)
365 obj
->status
= XRESIZEVEC (int, obj
->status
, obj
->count
);
366 if ((obj
->flags
& PEX_RECORD_TIMES
) != 0)
367 obj
->time
= XRESIZEVEC (struct pex_time
, obj
->time
, obj
->count
);
370 for (i
= obj
->number_waited
; i
< obj
->count
; ++i
)
372 if (obj
->funcs
->wait (obj
, obj
->children
[i
], &obj
->status
[i
],
373 obj
->time
== NULL
? NULL
: &obj
->time
[i
],
374 done
, errmsg
, err
) < 0)
377 obj
->number_waited
= i
;
382 /* Get exit status of executed programs. */
385 pex_get_status (struct pex_obj
*obj
, int count
, int *vector
)
387 if (obj
->status
== NULL
)
392 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
396 if (count
> obj
->count
)
398 memset (vector
+ obj
->count
, 0, (count
- obj
->count
) * sizeof (int));
402 memcpy (vector
, obj
->status
, count
* sizeof (int));
407 /* Get process times of executed programs. */
410 pex_get_times (struct pex_obj
*obj
, int count
, struct pex_time
*vector
)
412 if (obj
->status
== NULL
)
417 if (!pex_get_status_and_time (obj
, 0, &errmsg
, &err
))
421 if (obj
->time
== NULL
)
424 if (count
> obj
->count
)
426 memset (vector
+ obj
->count
, 0,
427 (count
- obj
->count
) * sizeof (struct pex_time
));
431 memcpy (vector
, obj
->time
, count
* sizeof (struct pex_time
));
436 /* Free a pex_obj structure. */
439 pex_free (struct pex_obj
*obj
)
441 if (obj
->next_input
>= 0 && obj
->next_input
!= STDIN_FILE_NO
)
442 obj
->funcs
->close (obj
, obj
->next_input
);
444 /* If the caller forgot to wait for the children, we do it here, to
446 if (obj
->status
== NULL
)
451 obj
->flags
&= ~ PEX_RECORD_TIMES
;
452 pex_get_status_and_time (obj
, 1, &errmsg
, &err
);
455 if (obj
->next_input_name_allocated
)
456 free (obj
->next_input_name
);
457 if (obj
->children
!= NULL
)
458 free (obj
->children
);
459 if (obj
->status
!= NULL
)
461 if (obj
->time
!= NULL
)
463 if (obj
->read_output
!= NULL
)
464 fclose (obj
->read_output
);
466 if (obj
->remove_count
> 0)
470 for (i
= 0; i
< obj
->remove_count
; ++i
)
472 remove (obj
->remove
[i
]);
473 free (obj
->remove
[i
]);
478 if (obj
->funcs
->cleanup
!= NULL
)
479 obj
->funcs
->cleanup (obj
);