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