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