Commit | Line | Data |
---|---|---|
e4b17023 JM |
1 | /* Function declarations for libiberty. |
2 | ||
3 | Copyright 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, | |
4 | 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. | |
5 | ||
6 | Note - certain prototypes declared in this header file are for | |
7 | functions whoes implementation copyright does not belong to the | |
8 | FSF. Those prototypes are present in this file for reference | |
9 | purposes only and their presence in this file should not construed | |
10 | as an indication of ownership by the FSF of the implementation of | |
11 | those functions in any way or form whatsoever. | |
12 | ||
13 | This program is free software; you can redistribute it and/or modify | |
14 | it under the terms of the GNU General Public License as published by | |
15 | the Free Software Foundation; either version 2, or (at your option) | |
16 | any later version. | |
17 | ||
18 | This program is distributed in the hope that it will be useful, | |
19 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | GNU General Public License for more details. | |
22 | ||
23 | You should have received a copy of the GNU General Public License | |
24 | along with this program; if not, write to the Free Software | |
25 | Foundation, Inc., 51 Franklin Street - Fifth Floor, | |
26 | Boston, MA 02110-1301, USA. | |
27 | ||
28 | Written by Cygnus Support, 1994. | |
29 | ||
30 | The libiberty library provides a number of functions which are | |
31 | missing on some operating systems. We do not declare those here, | |
32 | to avoid conflicts with the system header files on operating | |
33 | systems that do support those functions. In this file we only | |
34 | declare those functions which are specific to libiberty. */ | |
35 | ||
36 | #ifndef LIBIBERTY_H | |
37 | #define LIBIBERTY_H | |
38 | ||
39 | #ifdef __cplusplus | |
40 | extern "C" { | |
41 | #endif | |
42 | ||
43 | #include "ansidecl.h" | |
44 | ||
45 | /* Get a definition for size_t. */ | |
46 | #include <stddef.h> | |
47 | /* Get a definition for va_list. */ | |
48 | #include <stdarg.h> | |
49 | ||
50 | #include <stdio.h> | |
51 | ||
52 | /* If the OS supports it, ensure that the supplied stream is setup to | |
53 | avoid any multi-threaded locking. Otherwise leave the FILE pointer | |
54 | unchanged. If the stream is NULL do nothing. */ | |
55 | ||
56 | extern void unlock_stream (FILE *); | |
57 | ||
58 | /* If the OS supports it, ensure that the standard I/O streams, stdin, | |
59 | stdout and stderr are setup to avoid any multi-threaded locking. | |
60 | Otherwise do nothing. */ | |
61 | ||
62 | extern void unlock_std_streams (void); | |
63 | ||
64 | /* Open and return a FILE pointer. If the OS supports it, ensure that | |
65 | the stream is setup to avoid any multi-threaded locking. Otherwise | |
66 | return the FILE pointer unchanged. */ | |
67 | ||
68 | extern FILE *fopen_unlocked (const char *, const char *); | |
69 | extern FILE *fdopen_unlocked (int, const char *); | |
70 | extern FILE *freopen_unlocked (const char *, const char *, FILE *); | |
71 | ||
72 | /* Build an argument vector from a string. Allocates memory using | |
73 | malloc. Use freeargv to free the vector. */ | |
74 | ||
75 | extern char **buildargv (const char *) ATTRIBUTE_MALLOC; | |
76 | ||
77 | /* Free a vector returned by buildargv. */ | |
78 | ||
79 | extern void freeargv (char **); | |
80 | ||
81 | /* Duplicate an argument vector. Allocates memory using malloc. Use | |
82 | freeargv to free the vector. */ | |
83 | ||
84 | extern char **dupargv (char **) ATTRIBUTE_MALLOC; | |
85 | ||
86 | /* Expand "@file" arguments in argv. */ | |
87 | ||
88 | extern void expandargv PARAMS ((int *, char ***)); | |
89 | ||
90 | /* Write argv to an @-file, inserting necessary quoting. */ | |
91 | ||
92 | extern int writeargv PARAMS ((char **, FILE *)); | |
93 | ||
94 | /* Return the number of elements in argv. */ | |
95 | ||
96 | extern int countargv (char**); | |
97 | ||
98 | /* Return the last component of a path name. Note that we can't use a | |
99 | prototype here because the parameter is declared inconsistently | |
100 | across different systems, sometimes as "char *" and sometimes as | |
101 | "const char *" */ | |
102 | ||
103 | /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is | |
104 | undefined, we haven't run the autoconf check so provide the | |
105 | declaration without arguments. If it is 0, we checked and failed | |
106 | to find the declaration so provide a fully prototyped one. If it | |
107 | is 1, we found it so don't provide any declaration at all. */ | |
108 | #if !HAVE_DECL_BASENAME | |
fdc4107c JM |
109 | #if defined (__GNU_LIBRARY__ ) \ |
110 | || defined (__linux__) \ | |
111 | || defined (__DragonFly__) \ | |
112 | || defined (__FreeBSD__) \ | |
113 | || defined (__OpenBSD__) \ | |
114 | || defined (__NetBSD__) \ | |
115 | || defined (__CYGWIN__) \ | |
116 | || defined (__CYGWIN32__) \ | |
117 | || defined (__MINGW32__) \ | |
118 | || defined (HAVE_DECL_BASENAME) | |
e4b17023 JM |
119 | extern char *basename (const char *); |
120 | #else | |
121 | /* Do not allow basename to be used if there is no prototype seen. We | |
122 | either need to use the above prototype or have one from | |
123 | autoconf which would result in HAVE_DECL_BASENAME being set. */ | |
124 | #define basename basename_cannot_be_used_without_a_prototype | |
125 | #endif | |
126 | #endif | |
127 | ||
128 | /* A well-defined basename () that is always compiled in. */ | |
129 | ||
130 | extern const char *lbasename (const char *); | |
131 | ||
132 | /* Same, but assumes DOS semantics (drive name, backslash is also a | |
133 | dir separator) regardless of host. */ | |
134 | ||
135 | extern const char *dos_lbasename (const char *); | |
136 | ||
137 | /* Same, but assumes Unix semantics (absolute paths always start with | |
138 | a slash, only forward slash is accepted as dir separator) | |
139 | regardless of host. */ | |
140 | ||
141 | extern const char *unix_lbasename (const char *); | |
142 | ||
143 | /* A well-defined realpath () that is always compiled in. */ | |
144 | ||
145 | extern char *lrealpath (const char *); | |
146 | ||
147 | /* Concatenate an arbitrary number of strings. You must pass NULL as | |
148 | the last argument of this function, to terminate the list of | |
149 | strings. Allocates memory using xmalloc. */ | |
150 | ||
151 | extern char *concat (const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL; | |
152 | ||
153 | /* Concatenate an arbitrary number of strings. You must pass NULL as | |
154 | the last argument of this function, to terminate the list of | |
155 | strings. Allocates memory using xmalloc. The first argument is | |
156 | not one of the strings to be concatenated, but if not NULL is a | |
157 | pointer to be freed after the new string is created, similar to the | |
158 | way xrealloc works. */ | |
159 | ||
160 | extern char *reconcat (char *, const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL; | |
161 | ||
162 | /* Determine the length of concatenating an arbitrary number of | |
163 | strings. You must pass NULL as the last argument of this function, | |
164 | to terminate the list of strings. */ | |
165 | ||
166 | extern unsigned long concat_length (const char *, ...) ATTRIBUTE_SENTINEL; | |
167 | ||
168 | /* Concatenate an arbitrary number of strings into a SUPPLIED area of | |
169 | memory. You must pass NULL as the last argument of this function, | |
170 | to terminate the list of strings. The supplied memory is assumed | |
171 | to be large enough. */ | |
172 | ||
173 | extern char *concat_copy (char *, const char *, ...) ATTRIBUTE_SENTINEL; | |
174 | ||
175 | /* Concatenate an arbitrary number of strings into a GLOBAL area of | |
176 | memory. You must pass NULL as the last argument of this function, | |
177 | to terminate the list of strings. The supplied memory is assumed | |
178 | to be large enough. */ | |
179 | ||
180 | extern char *concat_copy2 (const char *, ...) ATTRIBUTE_SENTINEL; | |
181 | ||
182 | /* This is the global area used by concat_copy2. */ | |
183 | ||
184 | extern char *libiberty_concat_ptr; | |
185 | ||
186 | /* Concatenate an arbitrary number of strings. You must pass NULL as | |
187 | the last argument of this function, to terminate the list of | |
188 | strings. Allocates memory using alloca. The arguments are | |
189 | evaluated twice! */ | |
190 | #define ACONCAT(ACONCAT_PARAMS) \ | |
191 | (libiberty_concat_ptr = (char *) alloca (concat_length ACONCAT_PARAMS + 1), \ | |
192 | concat_copy2 ACONCAT_PARAMS) | |
193 | ||
194 | /* Check whether two file descriptors refer to the same file. */ | |
195 | ||
196 | extern int fdmatch (int fd1, int fd2); | |
197 | ||
198 | /* Return the position of the first bit set in the argument. */ | |
199 | /* Prototypes vary from system to system, so we only provide a | |
200 | prototype on systems where we know that we need it. */ | |
201 | #if defined (HAVE_DECL_FFS) && !HAVE_DECL_FFS | |
202 | extern int ffs(int); | |
203 | #endif | |
204 | ||
205 | /* Get the working directory. The result is cached, so don't call | |
206 | chdir() between calls to getpwd(). */ | |
207 | ||
208 | extern char * getpwd (void); | |
209 | ||
210 | /* Get the current time. */ | |
211 | /* Prototypes vary from system to system, so we only provide a | |
212 | prototype on systems where we know that we need it. */ | |
213 | #ifdef __MINGW32__ | |
214 | /* Forward declaration to avoid #include <sys/time.h>. */ | |
215 | struct timeval; | |
216 | extern int gettimeofday (struct timeval *, void *); | |
217 | #endif | |
218 | ||
219 | /* Get the amount of time the process has run, in microseconds. */ | |
220 | ||
221 | extern long get_run_time (void); | |
222 | ||
223 | /* Generate a relocated path to some installation directory. Allocates | |
224 | return value using malloc. */ | |
225 | ||
226 | extern char *make_relative_prefix (const char *, const char *, | |
227 | const char *) ATTRIBUTE_MALLOC; | |
228 | ||
229 | /* Generate a relocated path to some installation directory without | |
230 | attempting to follow any soft links. Allocates | |
231 | return value using malloc. */ | |
232 | ||
233 | extern char *make_relative_prefix_ignore_links (const char *, const char *, | |
234 | const char *) ATTRIBUTE_MALLOC; | |
235 | ||
236 | /* Choose a temporary directory to use for scratch files. */ | |
237 | ||
238 | extern char *choose_temp_base (void) ATTRIBUTE_MALLOC; | |
239 | ||
240 | /* Return a temporary file name or NULL if unable to create one. */ | |
241 | ||
242 | extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC; | |
243 | ||
244 | /* Remove a link to a file unless it is special. */ | |
245 | ||
246 | extern int unlink_if_ordinary (const char *); | |
247 | ||
248 | /* Allocate memory filled with spaces. Allocates using malloc. */ | |
249 | ||
250 | extern const char *spaces (int count); | |
251 | ||
252 | /* Return the maximum error number for which strerror will return a | |
253 | string. */ | |
254 | ||
255 | extern int errno_max (void); | |
256 | ||
257 | /* Return the name of an errno value (e.g., strerrno (EINVAL) returns | |
258 | "EINVAL"). */ | |
259 | ||
260 | extern const char *strerrno (int); | |
261 | ||
262 | /* Given the name of an errno value, return the value. */ | |
263 | ||
264 | extern int strtoerrno (const char *); | |
265 | ||
266 | /* ANSI's strerror(), but more robust. */ | |
267 | ||
268 | extern char *xstrerror (int); | |
269 | ||
270 | /* Return the maximum signal number for which strsignal will return a | |
271 | string. */ | |
272 | ||
273 | extern int signo_max (void); | |
274 | ||
275 | /* Return a signal message string for a signal number | |
276 | (e.g., strsignal (SIGHUP) returns something like "Hangup"). */ | |
277 | /* This is commented out as it can conflict with one in system headers. | |
278 | We still document its existence though. */ | |
279 | ||
280 | /*extern const char *strsignal (int);*/ | |
281 | ||
282 | /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns | |
283 | "SIGHUP"). */ | |
284 | ||
285 | extern const char *strsigno (int); | |
286 | ||
287 | /* Given the name of a signal, return its number. */ | |
288 | ||
289 | extern int strtosigno (const char *); | |
290 | ||
291 | /* Register a function to be run by xexit. Returns 0 on success. */ | |
292 | ||
293 | extern int xatexit (void (*fn) (void)); | |
294 | ||
295 | /* Exit, calling all the functions registered with xatexit. */ | |
296 | ||
297 | extern void xexit (int status) ATTRIBUTE_NORETURN; | |
298 | ||
299 | /* Set the program name used by xmalloc. */ | |
300 | ||
301 | extern void xmalloc_set_program_name (const char *); | |
302 | ||
303 | /* Report an allocation failure. */ | |
304 | extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN; | |
305 | ||
306 | /* Allocate memory without fail. If malloc fails, this will print a | |
307 | message to stderr (using the name set by xmalloc_set_program_name, | |
308 | if any) and then call xexit. */ | |
309 | ||
310 | extern void *xmalloc (size_t) ATTRIBUTE_MALLOC; | |
311 | ||
312 | /* Reallocate memory without fail. This works like xmalloc. Note, | |
313 | realloc type functions are not suitable for attribute malloc since | |
314 | they may return the same address across multiple calls. */ | |
315 | ||
316 | extern void *xrealloc (void *, size_t); | |
317 | ||
318 | /* Allocate memory without fail and set it to zero. This works like | |
319 | xmalloc. */ | |
320 | ||
321 | extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC; | |
322 | ||
323 | /* Copy a string into a memory buffer without fail. */ | |
324 | ||
325 | extern char *xstrdup (const char *) ATTRIBUTE_MALLOC; | |
326 | ||
327 | /* Copy at most N characters from string into a buffer without fail. */ | |
328 | ||
329 | extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC; | |
330 | ||
331 | /* Copy an existing memory buffer to a new memory buffer without fail. */ | |
332 | ||
333 | extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC; | |
334 | ||
335 | /* Physical memory routines. Return values are in BYTES. */ | |
336 | extern double physmem_total (void); | |
337 | extern double physmem_available (void); | |
338 | ||
339 | /* Compute the 32-bit CRC of a block of memory. */ | |
340 | extern unsigned int xcrc32 (const unsigned char *, int, unsigned int); | |
341 | ||
342 | /* These macros provide a K&R/C89/C++-friendly way of allocating structures | |
343 | with nice encapsulation. The XDELETE*() macros are technically | |
344 | superfluous, but provided here for symmetry. Using them consistently | |
345 | makes it easier to update client code to use different allocators such | |
346 | as new/delete and new[]/delete[]. */ | |
347 | ||
348 | /* Scalar allocators. */ | |
349 | ||
350 | #define XALLOCA(T) ((T *) alloca (sizeof (T))) | |
351 | #define XNEW(T) ((T *) xmalloc (sizeof (T))) | |
352 | #define XCNEW(T) ((T *) xcalloc (1, sizeof (T))) | |
353 | #define XDUP(T, P) ((T *) xmemdup ((P), sizeof (T), sizeof (T))) | |
354 | #define XDELETE(P) free ((void*) (P)) | |
355 | ||
356 | /* Array allocators. */ | |
357 | ||
358 | #define XALLOCAVEC(T, N) ((T *) alloca (sizeof (T) * (N))) | |
359 | #define XNEWVEC(T, N) ((T *) xmalloc (sizeof (T) * (N))) | |
360 | #define XCNEWVEC(T, N) ((T *) xcalloc ((N), sizeof (T))) | |
361 | #define XDUPVEC(T, P, N) ((T *) xmemdup ((P), sizeof (T) * (N), sizeof (T) * (N))) | |
362 | #define XRESIZEVEC(T, P, N) ((T *) xrealloc ((void *) (P), sizeof (T) * (N))) | |
363 | #define XDELETEVEC(P) free ((void*) (P)) | |
364 | ||
365 | /* Allocators for variable-sized structures and raw buffers. */ | |
366 | ||
367 | #define XALLOCAVAR(T, S) ((T *) alloca ((S))) | |
368 | #define XNEWVAR(T, S) ((T *) xmalloc ((S))) | |
369 | #define XCNEWVAR(T, S) ((T *) xcalloc (1, (S))) | |
370 | #define XDUPVAR(T, P, S1, S2) ((T *) xmemdup ((P), (S1), (S2))) | |
371 | #define XRESIZEVAR(T, P, S) ((T *) xrealloc ((P), (S))) | |
372 | ||
373 | /* Type-safe obstack allocator. */ | |
374 | ||
375 | #define XOBNEW(O, T) ((T *) obstack_alloc ((O), sizeof (T))) | |
376 | #define XOBNEWVEC(O, T, N) ((T *) obstack_alloc ((O), sizeof (T) * (N))) | |
377 | #define XOBNEWVAR(O, T, S) ((T *) obstack_alloc ((O), (S))) | |
378 | #define XOBFINISH(O, T) ((T) obstack_finish ((O))) | |
379 | ||
380 | /* hex character manipulation routines */ | |
381 | ||
382 | #define _hex_array_size 256 | |
383 | #define _hex_bad 99 | |
384 | extern const unsigned char _hex_value[_hex_array_size]; | |
385 | extern void hex_init (void); | |
386 | #define hex_p(c) (hex_value (c) != _hex_bad) | |
387 | /* If you change this, note well: Some code relies on side effects in | |
388 | the argument being performed exactly once. */ | |
389 | #define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)]) | |
390 | ||
391 | /* Flags for pex_init. These are bits to be or'ed together. */ | |
392 | ||
393 | /* Record subprocess times, if possible. */ | |
394 | #define PEX_RECORD_TIMES 0x1 | |
395 | ||
396 | /* Use pipes for communication between processes, if possible. */ | |
397 | #define PEX_USE_PIPES 0x2 | |
398 | ||
399 | /* Save files used for communication between processes. */ | |
400 | #define PEX_SAVE_TEMPS 0x4 | |
401 | ||
402 | /* Prepare to execute one or more programs, with standard output of | |
403 | each program fed to standard input of the next. | |
404 | FLAGS As above. | |
405 | PNAME The name of the program to report in error messages. | |
406 | TEMPBASE A base name to use for temporary files; may be NULL to | |
407 | use a random name. | |
408 | Returns NULL on error. */ | |
409 | ||
410 | extern struct pex_obj *pex_init (int flags, const char *pname, | |
411 | const char *tempbase); | |
412 | ||
413 | /* Flags for pex_run. These are bits to be or'ed together. */ | |
414 | ||
415 | /* Last program in pipeline. Standard output of program goes to | |
416 | OUTNAME, or, if OUTNAME is NULL, to standard output of caller. Do | |
417 | not set this if you want to call pex_read_output. After this is | |
418 | set, pex_run may no longer be called with the same struct | |
419 | pex_obj. */ | |
420 | #define PEX_LAST 0x1 | |
421 | ||
422 | /* Search for program in executable search path. */ | |
423 | #define PEX_SEARCH 0x2 | |
424 | ||
425 | /* OUTNAME is a suffix. */ | |
426 | #define PEX_SUFFIX 0x4 | |
427 | ||
428 | /* Send program's standard error to standard output. */ | |
429 | #define PEX_STDERR_TO_STDOUT 0x8 | |
430 | ||
431 | /* Input file should be opened in binary mode. This flag is ignored | |
432 | on Unix. */ | |
433 | #define PEX_BINARY_INPUT 0x10 | |
434 | ||
435 | /* Output file should be opened in binary mode. This flag is ignored | |
436 | on Unix. For proper behaviour PEX_BINARY_INPUT and | |
437 | PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using | |
438 | PEX_BINARY_OUTPUT should be followed by a call using | |
439 | PEX_BINARY_INPUT. */ | |
440 | #define PEX_BINARY_OUTPUT 0x20 | |
441 | ||
442 | /* Capture stderr to a pipe. The output can be read by | |
443 | calling pex_read_err and reading from the returned | |
444 | FILE object. This flag may be specified only for | |
445 | the last program in a pipeline. | |
446 | ||
447 | This flag is supported only on Unix and Windows. */ | |
448 | #define PEX_STDERR_TO_PIPE 0x40 | |
449 | ||
450 | /* Capture stderr in binary mode. This flag is ignored | |
451 | on Unix. */ | |
452 | #define PEX_BINARY_ERROR 0x80 | |
453 | ||
454 | ||
455 | /* Execute one program. Returns NULL on success. On error returns an | |
456 | error string (typically just the name of a system call); the error | |
457 | string is statically allocated. | |
458 | ||
459 | OBJ Returned by pex_init. | |
460 | ||
461 | FLAGS As above. | |
462 | ||
463 | EXECUTABLE The program to execute. | |
464 | ||
465 | ARGV NULL terminated array of arguments to pass to the program. | |
466 | ||
467 | OUTNAME Sets the output file name as follows: | |
468 | ||
469 | PEX_SUFFIX set (OUTNAME may not be NULL): | |
470 | TEMPBASE parameter to pex_init not NULL: | |
471 | Output file name is the concatenation of TEMPBASE | |
472 | and OUTNAME. | |
473 | TEMPBASE is NULL: | |
474 | Output file name is a random file name ending in | |
475 | OUTNAME. | |
476 | PEX_SUFFIX not set: | |
477 | OUTNAME not NULL: | |
478 | Output file name is OUTNAME. | |
479 | OUTNAME NULL, TEMPBASE not NULL: | |
480 | Output file name is randomly chosen using | |
481 | TEMPBASE. | |
482 | OUTNAME NULL, TEMPBASE NULL: | |
483 | Output file name is randomly chosen. | |
484 | ||
485 | If PEX_LAST is not set, the output file name is the | |
486 | name to use for a temporary file holding stdout, if | |
487 | any (there will not be a file if PEX_USE_PIPES is set | |
488 | and the system supports pipes). If a file is used, it | |
489 | will be removed when no longer needed unless | |
490 | PEX_SAVE_TEMPS is set. | |
491 | ||
492 | If PEX_LAST is set, and OUTNAME is not NULL, standard | |
493 | output is written to the output file name. The file | |
494 | will not be removed. If PEX_LAST and PEX_SUFFIX are | |
495 | both set, TEMPBASE may not be NULL. | |
496 | ||
497 | ERRNAME If not NULL, this is the name of a file to which | |
498 | standard error is written. If NULL, standard error of | |
499 | the program is standard error of the caller. | |
500 | ||
501 | ERR On an error return, *ERR is set to an errno value, or | |
502 | to 0 if there is no relevant errno. | |
503 | */ | |
504 | ||
505 | extern const char *pex_run (struct pex_obj *obj, int flags, | |
506 | const char *executable, char * const *argv, | |
507 | const char *outname, const char *errname, | |
508 | int *err); | |
509 | ||
510 | /* As for pex_run (), but takes an extra parameter to enable the | |
511 | environment for the child process to be specified. | |
512 | ||
513 | ENV The environment for the child process, specified as | |
514 | an array of character pointers. Each element of the | |
515 | array should point to a string of the form VAR=VALUE, | |
516 | with the exception of the last element which must be | |
517 | a null pointer. | |
518 | */ | |
519 | ||
520 | extern const char *pex_run_in_environment (struct pex_obj *obj, int flags, | |
521 | const char *executable, | |
522 | char * const *argv, | |
523 | char * const *env, | |
524 | const char *outname, | |
525 | const char *errname, int *err); | |
526 | ||
527 | /* Return a stream for a temporary file to pass to the first program | |
528 | in the pipeline as input. The file name is chosen as for pex_run. | |
529 | pex_run closes the file automatically; don't close it yourself. */ | |
530 | ||
531 | extern FILE *pex_input_file (struct pex_obj *obj, int flags, | |
532 | const char *in_name); | |
533 | ||
534 | /* Return a stream for a pipe connected to the standard input of the | |
535 | first program in the pipeline. You must have passed | |
536 | `PEX_USE_PIPES' to `pex_init'. Close the returned stream | |
537 | yourself. */ | |
538 | ||
539 | extern FILE *pex_input_pipe (struct pex_obj *obj, int binary); | |
540 | ||
541 | /* Read the standard output of the last program to be executed. | |
542 | pex_run can not be called after this. BINARY should be non-zero if | |
543 | the file should be opened in binary mode; this is ignored on Unix. | |
544 | Returns NULL on error. Don't call fclose on the returned FILE; it | |
545 | will be closed by pex_free. */ | |
546 | ||
547 | extern FILE *pex_read_output (struct pex_obj *, int binary); | |
548 | ||
549 | /* Read the standard error of the last program to be executed. | |
550 | pex_run can not be called after this. BINARY should be non-zero if | |
551 | the file should be opened in binary mode; this is ignored on Unix. | |
552 | Returns NULL on error. Don't call fclose on the returned FILE; it | |
553 | will be closed by pex_free. */ | |
554 | ||
555 | extern FILE *pex_read_err (struct pex_obj *, int binary); | |
556 | ||
557 | /* Return exit status of all programs in VECTOR. COUNT indicates the | |
558 | size of VECTOR. The status codes in the vector are in the order of | |
559 | the calls to pex_run. Returns 0 on error, 1 on success. */ | |
560 | ||
561 | extern int pex_get_status (struct pex_obj *, int count, int *vector); | |
562 | ||
563 | /* Return times of all programs in VECTOR. COUNT indicates the size | |
564 | of VECTOR. struct pex_time is really just struct timeval, but that | |
565 | is not portable to all systems. Returns 0 on error, 1 on | |
566 | success. */ | |
567 | ||
568 | struct pex_time | |
569 | { | |
570 | unsigned long user_seconds; | |
571 | unsigned long user_microseconds; | |
572 | unsigned long system_seconds; | |
573 | unsigned long system_microseconds; | |
574 | }; | |
575 | ||
576 | extern int pex_get_times (struct pex_obj *, int count, | |
577 | struct pex_time *vector); | |
578 | ||
579 | /* Clean up a pex_obj. If you have not called pex_get_times or | |
580 | pex_get_status, this will try to kill the subprocesses. */ | |
581 | ||
582 | extern void pex_free (struct pex_obj *); | |
583 | ||
584 | /* Just execute one program. Return value is as for pex_run. | |
585 | FLAGS Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT. | |
586 | EXECUTABLE As for pex_run. | |
587 | ARGV As for pex_run. | |
588 | PNAME As for pex_init. | |
589 | OUTNAME As for pex_run when PEX_LAST is set. | |
590 | ERRNAME As for pex_run. | |
591 | STATUS Set to exit status on success. | |
592 | ERR As for pex_run. | |
593 | */ | |
594 | ||
595 | extern const char *pex_one (int flags, const char *executable, | |
596 | char * const *argv, const char *pname, | |
597 | const char *outname, const char *errname, | |
598 | int *status, int *err); | |
599 | ||
600 | /* pexecute and pwait are the old pexecute interface, still here for | |
601 | backward compatibility. Don't use these for new code. Instead, | |
602 | use pex_init/pex_run/pex_get_status/pex_free, or pex_one. */ | |
603 | ||
604 | /* Definitions used by the pexecute routine. */ | |
605 | ||
606 | #define PEXECUTE_FIRST 1 | |
607 | #define PEXECUTE_LAST 2 | |
608 | #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST) | |
609 | #define PEXECUTE_SEARCH 4 | |
610 | #define PEXECUTE_VERBOSE 8 | |
611 | ||
612 | /* Execute a program. */ | |
613 | ||
614 | extern int pexecute (const char *, char * const *, const char *, | |
615 | const char *, char **, char **, int); | |
616 | ||
617 | /* Wait for pexecute to finish. */ | |
618 | ||
619 | extern int pwait (int, int *, int); | |
620 | ||
621 | #if !HAVE_DECL_ASPRINTF | |
622 | /* Like sprintf but provides a pointer to malloc'd storage, which must | |
623 | be freed by the caller. */ | |
624 | ||
625 | extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2; | |
626 | #endif | |
627 | ||
628 | #if !HAVE_DECL_VASPRINTF | |
629 | /* Like vsprintf but provides a pointer to malloc'd storage, which | |
630 | must be freed by the caller. */ | |
631 | ||
632 | extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0); | |
633 | #endif | |
634 | ||
635 | #if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF | |
636 | /* Like sprintf but prints at most N characters. */ | |
637 | extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3; | |
638 | #endif | |
639 | ||
640 | #if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF | |
641 | /* Like vsprintf but prints at most N characters. */ | |
642 | extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0); | |
643 | #endif | |
644 | ||
645 | #if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP | |
646 | /* Compare version strings. */ | |
647 | extern int strverscmp (const char *, const char *); | |
648 | #endif | |
649 | ||
650 | /* Set the title of a process */ | |
651 | extern void setproctitle (const char *name, ...); | |
652 | ||
653 | /* Increase stack limit if possible. */ | |
654 | extern void stack_limit_increase (unsigned long); | |
655 | ||
656 | #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0])) | |
657 | ||
658 | /* Drastically simplified alloca configurator. If we're using GCC, | |
659 | we use __builtin_alloca; otherwise we use the C alloca. The C | |
660 | alloca is always available. You can override GCC by defining | |
661 | USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is | |
662 | also set/unset as it is often used to indicate whether code needs | |
663 | to call alloca(0). */ | |
664 | extern void *C_alloca (size_t) ATTRIBUTE_MALLOC; | |
665 | #undef alloca | |
666 | #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA | |
667 | # define alloca(x) __builtin_alloca(x) | |
668 | # undef C_ALLOCA | |
669 | # define ASTRDUP(X) \ | |
670 | (__extension__ ({ const char *const libiberty_optr = (X); \ | |
671 | const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \ | |
672 | char *const libiberty_nptr = (char *const) alloca (libiberty_len); \ | |
673 | (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); })) | |
674 | #else | |
675 | # define alloca(x) C_alloca(x) | |
676 | # undef USE_C_ALLOCA | |
677 | # define USE_C_ALLOCA 1 | |
678 | # undef C_ALLOCA | |
679 | # define C_ALLOCA 1 | |
680 | extern const char *libiberty_optr; | |
681 | extern char *libiberty_nptr; | |
682 | extern unsigned long libiberty_len; | |
683 | # define ASTRDUP(X) \ | |
684 | (libiberty_optr = (X), \ | |
685 | libiberty_len = strlen (libiberty_optr) + 1, \ | |
686 | libiberty_nptr = (char *) alloca (libiberty_len), \ | |
687 | (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len)) | |
688 | #endif | |
689 | ||
690 | #ifdef __cplusplus | |
691 | } | |
692 | #endif | |
693 | ||
694 | ||
695 | #endif /* ! defined (LIBIBERTY_H) */ |