1 /* Utilities to execute a program in a subprocess (possibly linked by pipes 2 with other subprocesses), and wait for it. Shared logic. 3 Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2003, 2004 4 Free Software Foundation, Inc. 5 6 This file is part of the libiberty library. 7 Libiberty is free software; you can redistribute it and/or 8 modify it under the terms of the GNU Library General Public 9 License as published by the Free Software Foundation; either 10 version 2 of the License, or (at your option) any later version. 11 12 Libiberty is distributed in the hope that it will be useful, 13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 Library General Public License for more details. 16 17 You should have received a copy of the GNU Library General Public 18 License along with libiberty; see the file COPYING.LIB. If not, 19 write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor, 20 Boston, MA 02110-1301, USA. */ 21 22 #ifndef PEX_COMMON_H 23 #define PEX_COMMON_H 24 25 #include "config.h" 26 #include "libiberty.h" 27 #include <stdio.h> 28 29 #define install_error_msg "installation problem, cannot exec `%s'" 30 31 /* stdin file number. */ 32 #define STDIN_FILE_NO 0 33 34 /* stdout file number. */ 35 #define STDOUT_FILE_NO 1 36 37 /* stderr file number. */ 38 #define STDERR_FILE_NO 2 39 40 /* value of `pipe': port index for reading. */ 41 #define READ_PORT 0 42 43 /* value of `pipe': port index for writing. */ 44 #define WRITE_PORT 1 45 46 /* The structure used by pex_init and friends. */ 47 48 struct pex_obj 49 { 50 /* Flags. */ 51 int flags; 52 /* Name of calling program, for error messages. */ 53 const char *pname; 54 /* Base name to use for temporary files. */ 55 const char *tempbase; 56 /* Pipe to use as stdin for next process. */ 57 int next_input; 58 /* File name to use as stdin for next process. */ 59 char *next_input_name; 60 /* Whether next_input_name was allocated using malloc. */ 61 int next_input_name_allocated; 62 /* Number of child processes. */ 63 int count; 64 /* PIDs of child processes; array allocated using maloc. */ 65 long *children; 66 /* Exit statuses of child processes; array allocated using malloc. */ 67 int *status; 68 /* Time used by child processes; array allocated using malloc. */ 69 struct pex_time *time; 70 /* Number of children we have already waited for. */ 71 int number_waited; 72 /* FILE created by pex_read_output. */ 73 FILE *read_output; 74 /* Number of temporary files to remove. */ 75 int remove_count; 76 /* List of temporary files to remove; array allocated using malloc 77 of strings allocated using malloc. */ 78 char **remove; 79 /* Pointers to system dependent functions. */ 80 const struct pex_funcs *funcs; 81 /* For use by system dependent code. */ 82 void *sysdep; 83 }; 84 85 /* Functions passed to pex_run_common. */ 86 87 struct pex_funcs 88 { 89 /* Open file NAME for reading. If BINARY is non-zero, open in 90 binary mode. Return >= 0 on success, -1 on error. */ 91 int (*open_read) (struct pex_obj *, const char *name, int binary); 92 /* Open file NAME for writing. If BINARY is non-zero, open in 93 binary mode. Return >= 0 on success, -1 on error. */ 94 int (*open_write) (struct pex_obj *, const char *name, int binary); 95 /* Execute a child process. FLAGS, EXECUTABLE, ARGV, ERR are from 96 pex_run. IN, OUT, ERRDES are each a descriptor, from open_read, 97 open_write, or pipe, or they are one of STDIN_FILE_NO, 98 STDOUT_FILE_NO or STDERR_FILE_NO; if not STD*_FILE_NO, they 99 should be closed. The function should handle the 100 PEX_STDERR_TO_STDOUT flag. Return >= 0 on success, or -1 on 101 error and set *ERRMSG and *ERR. */ 102 long (*exec_child) (struct pex_obj *, int flags, const char *executable, 103 char * const * argv, int in, int out, int errdes, 104 const char **errmsg, int *err); 105 /* Close a descriptor. Return 0 on success, -1 on error. */ 106 int (*close) (struct pex_obj *, int); 107 /* Wait for a child to complete, returning exit status in *STATUS 108 and time in *TIME (if it is not null). CHILD is from fork. DONE 109 is 1 if this is called via pex_free. ERRMSG and ERR are as in 110 fork. Return 0 on success, -1 on error. */ 111 int (*wait) (struct pex_obj *, long, int *status, struct pex_time *time, 112 int done, const char **errmsg, int *err); 113 /* Create a pipe (only called if PEX_USE_PIPES is set) storing two 114 descriptin in *P. If BINARY is non-zero, open in binary mode. 115 Return 0 on success, -1 on error. */ 116 int (*pipe) (struct pex_obj *, int *p, int binary); 117 /* Get a FILE pointer to read from a file descriptor (only called if 118 PEX_USE_PIPES is set). If BINARY is non-zero, open in binary 119 mode. Return pointer on success, NULL on error. */ 120 FILE * (*fdopenr) (struct pex_obj *, int fd, int binary); 121 /* Free any system dependent data associated with OBJ. May be 122 NULL if there is nothing to do. */ 123 void (*cleanup) (struct pex_obj *); 124 }; 125 126 extern struct pex_obj *pex_init_common (int, const char *, const char *, 127 const struct pex_funcs *); 128 129 #endif 130