Home | History | Annotate | Download | only in include
      1 /* Function declarations for libiberty.
      2 
      3    Copyright 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
      4    2006, 2007, 2008, 2009, 2010, 2011, 2013 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 (int *, char ***);
     89 
     90 /* Write argv to an @-file, inserting necessary quoting.  */
     91 
     92 extern int writeargv (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
    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)
    113 extern char *basename (const char *) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_NONNULL(1);
    114 #else
    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
    119 #endif
    120 #endif
    121 
    122 /* A well-defined basename () that is always compiled in.  */
    123 
    124 extern const char *lbasename (const char *) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_NONNULL(1);
    125 
    126 /* Same, but assumes DOS semantics (drive name, backslash is also a
    127    dir separator) regardless of host.  */
    128 
    129 extern const char *dos_lbasename (const char *) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_NONNULL(1);
    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 
    135 extern const char *unix_lbasename (const char *) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_NONNULL(1);
    136 
    137 /* A well-defined realpath () that is always compiled in.  */
    138 
    139 extern char *lrealpath (const char *);
    140 
    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.  */
    144 
    145 extern char *concat (const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_SENTINEL;
    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.  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 
    154 extern char *reconcat (char *, const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_SENTINEL;
    155 
    156 /* Determine the length of concatenating an arbitrary number of
    157    strings.  You must pass NULL as the last argument of this function,
    158    to terminate the list of strings.  */
    159 
    160 extern unsigned long concat_length (const char *, ...) ATTRIBUTE_SENTINEL;
    161 
    162 /* Concatenate an arbitrary number of strings into a SUPPLIED area of
    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.  */
    166 
    167 extern char *concat_copy (char *, const char *, ...) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_NONNULL(1) ATTRIBUTE_SENTINEL;
    168 
    169 /* Concatenate an arbitrary number of strings into a GLOBAL area of
    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.  */
    173 
    174 extern char *concat_copy2 (const char *, ...) ATTRIBUTE_RETURNS_NONNULL ATTRIBUTE_SENTINEL;
    175 
    176 /* This is the global area used by concat_copy2.  */
    177 
    178 extern char *libiberty_concat_ptr;
    179 
    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!  */
    184 #define ACONCAT(ACONCAT_PARAMS) \
    185   (libiberty_concat_ptr = (char *) alloca (concat_length ACONCAT_PARAMS + 1), \
    186    concat_copy2 ACONCAT_PARAMS)
    187 
    188 /* Check whether two file descriptors refer to the same file.  */
    189 
    190 extern int fdmatch (int fd1, int fd2);
    191 
    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 
    199 /* Get the working directory.  The result is cached, so don't call
    200    chdir() between calls to getpwd().  */
    201 
    202 extern char * getpwd (void);
    203 
    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;
    210 extern int gettimeofday (struct timeval *, void *);
    211 #endif
    212 
    213 /* Get the amount of time the process has run, in microseconds.  */
    214 
    215 extern long get_run_time (void);
    216 
    217 /* Generate a relocated path to some installation directory.  Allocates
    218    return value using malloc.  */
    219 
    220 extern char *make_relative_prefix (const char *, const char *,
    221                                    const char *) ATTRIBUTE_MALLOC;
    222 
    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 
    230 /* Choose a temporary directory to use for scratch files.  */
    231 
    232 extern char *choose_temp_base (void) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    233 
    234 /* Return a temporary file name or NULL if unable to create one.  */
    235 
    236 extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC;
    237 
    238 /* Remove a link to a file unless it is special. */
    239 
    240 extern int unlink_if_ordinary (const char *);
    241 
    242 /* Allocate memory filled with spaces.  Allocates using malloc.  */
    243 
    244 extern const char *spaces (int count);
    245 
    246 /* Return the maximum error number for which strerror will return a
    247    string.  */
    248 
    249 extern int errno_max (void);
    250 
    251 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
    252    "EINVAL").  */
    253 
    254 extern const char *strerrno (int);
    255 
    256 /* Given the name of an errno value, return the value.  */
    257 
    258 extern int strtoerrno (const char *);
    259 
    260 /* ANSI's strerror(), but more robust.  */
    261 
    262 extern char *xstrerror (int) ATTRIBUTE_RETURNS_NONNULL;
    263 
    264 /* Return the maximum signal number for which strsignal will return a
    265    string.  */
    266 
    267 extern int signo_max (void);
    268 
    269 /* Return a signal message string for a signal number
    270    (e.g., strsignal (SIGHUP) returns something like "Hangup").  */
    271 /* This is commented out as it can conflict with one in system headers.
    272    We still document its existence though.  */
    273 
    274 /*extern const char *strsignal (int);*/
    275 
    276 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
    277    "SIGHUP").  */
    278 
    279 extern const char *strsigno (int);
    280 
    281 /* Given the name of a signal, return its number.  */
    282 
    283 extern int strtosigno (const char *);
    284 
    285 /* Register a function to be run by xexit.  Returns 0 on success.  */
    286 
    287 extern int xatexit (void (*fn) (void));
    288 
    289 /* Exit, calling all the functions registered with xatexit.  */
    290 
    291 extern void xexit (int status) ATTRIBUTE_NORETURN;
    292 
    293 /* Set the program name used by xmalloc.  */
    294 
    295 extern void xmalloc_set_program_name (const char *);
    296 
    297 /* Report an allocation failure.  */
    298 extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN;
    299 
    300 /* Allocate memory without fail.  If malloc fails, this will print a
    301    message to stderr (using the name set by xmalloc_set_program_name,
    302    if any) and then call xexit.  */
    303 
    304 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    305 
    306 /* Reallocate memory without fail.  This works like xmalloc.  Note,
    307    realloc type functions are not suitable for attribute malloc since
    308    they may return the same address across multiple calls. */
    309 
    310 extern void *xrealloc (void *, size_t) ATTRIBUTE_RETURNS_NONNULL;
    311 
    312 /* Allocate memory without fail and set it to zero.  This works like
    313    xmalloc.  */
    314 
    315 extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    316 
    317 /* Copy a string into a memory buffer without fail.  */
    318 
    319 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    320 
    321 /* Copy at most N characters from string into a buffer without fail.  */
    322 
    323 extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    324 
    325 /* Copy an existing memory buffer to a new memory buffer without fail.  */
    326 
    327 extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
    328 
    329 /* Physical memory routines.  Return values are in BYTES.  */
    330 extern double physmem_total (void);
    331 extern double physmem_available (void);
    332 
    333 /* Compute the 32-bit CRC of a block of memory.  */
    334 extern unsigned int xcrc32 (const unsigned char *, int, unsigned int);
    335 
    336 /* These macros provide a K&R/C89/C++-friendly way of allocating structures
    337    with nice encapsulation.  The XDELETE*() macros are technically
    338    superfluous, but provided here for symmetry.  Using them consistently
    339    makes it easier to update client code to use different allocators such
    340    as new/delete and new[]/delete[].  */
    341 
    342 /* Scalar allocators.  */
    343 
    344 #define XALLOCA(T)		((T *) alloca (sizeof (T)))
    345 #define XNEW(T)			((T *) xmalloc (sizeof (T)))
    346 #define XCNEW(T)		((T *) xcalloc (1, sizeof (T)))
    347 #define XDUP(T, P)		((T *) xmemdup ((P), sizeof (T), sizeof (T)))
    348 #define XDELETE(P)		free ((void*) (P))
    349 
    350 /* Array allocators.  */
    351 
    352 #define XALLOCAVEC(T, N)	((T *) alloca (sizeof (T) * (N)))
    353 #define XNEWVEC(T, N)		((T *) xmalloc (sizeof (T) * (N)))
    354 #define XCNEWVEC(T, N)		((T *) xcalloc ((N), sizeof (T)))
    355 #define XDUPVEC(T, P, N)	((T *) xmemdup ((P), sizeof (T) * (N), sizeof (T) * (N)))
    356 #define XRESIZEVEC(T, P, N)	((T *) xrealloc ((void *) (P), sizeof (T) * (N)))
    357 #define XDELETEVEC(P)		free ((void*) (P))
    358 
    359 /* Allocators for variable-sized structures and raw buffers.  */
    360 
    361 #define XALLOCAVAR(T, S)	((T *) alloca ((S)))
    362 #define XNEWVAR(T, S)		((T *) xmalloc ((S)))
    363 #define XCNEWVAR(T, S)		((T *) xcalloc (1, (S)))
    364 #define XDUPVAR(T, P, S1, S2)	((T *) xmemdup ((P), (S1), (S2)))
    365 #define XRESIZEVAR(T, P, S)	((T *) xrealloc ((P), (S)))
    366 
    367 /* Type-safe obstack allocator.  */
    368 
    369 #define XOBNEW(O, T)		((T *) obstack_alloc ((O), sizeof (T)))
    370 #define XOBNEWVEC(O, T, N)	((T *) obstack_alloc ((O), sizeof (T) * (N)))
    371 #define XOBNEWVAR(O, T, S)	((T *) obstack_alloc ((O), (S)))
    372 #define XOBFINISH(O, T)         ((T) obstack_finish ((O)))
    373 
    374 /* hex character manipulation routines */
    375 
    376 #define _hex_array_size 256
    377 #define _hex_bad	99
    378 extern const unsigned char _hex_value[_hex_array_size];
    379 extern void hex_init (void);
    380 #define hex_p(c)	(hex_value (c) != _hex_bad)
    381 /* If you change this, note well: Some code relies on side effects in
    382    the argument being performed exactly once.  */
    383 #define hex_value(c)	((unsigned int) _hex_value[(unsigned char) (c)])
    384 
    385 /* Flags for pex_init.  These are bits to be or'ed together.  */
    386 
    387 /* Record subprocess times, if possible.  */
    388 #define PEX_RECORD_TIMES	0x1
    389 
    390 /* Use pipes for communication between processes, if possible.  */
    391 #define PEX_USE_PIPES		0x2
    392 
    393 /* Save files used for communication between processes.  */
    394 #define PEX_SAVE_TEMPS		0x4
    395 
    396 /* Prepare to execute one or more programs, with standard output of
    397    each program fed to standard input of the next.
    398    FLAGS	As above.
    399    PNAME	The name of the program to report in error messages.
    400    TEMPBASE	A base name to use for temporary files; may be NULL to
    401    		use a random name.
    402    Returns NULL on error.  */
    403 
    404 extern struct pex_obj *pex_init (int flags, const char *pname,
    405 				 const char *tempbase) ATTRIBUTE_RETURNS_NONNULL;
    406 
    407 /* Flags for pex_run.  These are bits to be or'ed together.  */
    408 
    409 /* Last program in pipeline.  Standard output of program goes to
    410    OUTNAME, or, if OUTNAME is NULL, to standard output of caller.  Do
    411    not set this if you want to call pex_read_output.  After this is
    412    set, pex_run may no longer be called with the same struct
    413    pex_obj.  */
    414 #define PEX_LAST		0x1
    415 
    416 /* Search for program in executable search path.  */
    417 #define PEX_SEARCH		0x2
    418 
    419 /* OUTNAME is a suffix.  */
    420 #define PEX_SUFFIX		0x4
    421 
    422 /* Send program's standard error to standard output.  */
    423 #define PEX_STDERR_TO_STDOUT	0x8
    424 
    425 /* Input file should be opened in binary mode.  This flag is ignored
    426    on Unix.  */
    427 #define PEX_BINARY_INPUT	0x10
    428 
    429 /* Output file should be opened in binary mode.  This flag is ignored
    430    on Unix.  For proper behaviour PEX_BINARY_INPUT and
    431    PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using
    432    PEX_BINARY_OUTPUT should be followed by a call using
    433    PEX_BINARY_INPUT.  */
    434 #define PEX_BINARY_OUTPUT	0x20
    435 
    436 /* Capture stderr to a pipe.  The output can be read by
    437    calling pex_read_err and reading from the returned
    438    FILE object.  This flag may be specified only for
    439    the last program in a pipeline.
    440 
    441    This flag is supported only on Unix and Windows.  */
    442 #define PEX_STDERR_TO_PIPE	0x40
    443 
    444 /* Capture stderr in binary mode.  This flag is ignored
    445    on Unix.  */
    446 #define PEX_BINARY_ERROR	0x80
    447 
    448 /* Append stdout to existing file instead of truncating it.  */
    449 #define PEX_STDOUT_APPEND	0x100
    450 
    451 /* Thes same as PEX_STDOUT_APPEND, but for STDERR.  */
    452 #define PEX_STDERR_APPEND	0x200
    453 
    454 /* Execute one program.  Returns NULL on success.  On error returns an
    455    error string (typically just the name of a system call); the error
    456    string is statically allocated.
    457 
    458    OBJ		Returned by pex_init.
    459 
    460    FLAGS	As above.
    461 
    462    EXECUTABLE	The program to execute.
    463 
    464    ARGV		NULL terminated array of arguments to pass to the program.
    465 
    466    OUTNAME	Sets the output file name as follows:
    467 
    468 		PEX_SUFFIX set (OUTNAME may not be NULL):
    469 		  TEMPBASE parameter to pex_init not NULL:
    470 		    Output file name is the concatenation of TEMPBASE
    471 		    and OUTNAME.
    472 		  TEMPBASE is NULL:
    473 		    Output file name is a random file name ending in
    474 		    OUTNAME.
    475 		PEX_SUFFIX not set:
    476 		  OUTNAME not NULL:
    477 		    Output file name is OUTNAME.
    478 		  OUTNAME NULL, TEMPBASE not NULL:
    479 		    Output file name is randomly chosen using
    480 		    TEMPBASE.
    481 		  OUTNAME NULL, TEMPBASE NULL:
    482 		    Output file name is randomly chosen.
    483 
    484 		If PEX_LAST is not set, the output file name is the
    485    		name to use for a temporary file holding stdout, if
    486    		any (there will not be a file if PEX_USE_PIPES is set
    487    		and the system supports pipes).  If a file is used, it
    488    		will be removed when no longer needed unless
    489    		PEX_SAVE_TEMPS is set.
    490 
    491 		If PEX_LAST is set, and OUTNAME is not NULL, standard
    492    		output is written to the output file name.  The file
    493    		will not be removed.  If PEX_LAST and PEX_SUFFIX are
    494    		both set, TEMPBASE may not be NULL.
    495 
    496    ERRNAME	If not NULL, this is the name of a file to which
    497 		standard error is written.  If NULL, standard error of
    498 		the program is standard error of the caller.
    499 
    500    ERR		On an error return, *ERR is set to an errno value, or
    501    		to 0 if there is no relevant errno.
    502 */
    503 
    504 extern const char *pex_run (struct pex_obj *obj, int flags,
    505 			    const char *executable, char * const *argv,
    506 			    const char *outname, const char *errname,
    507 			    int *err);
    508 
    509 /* As for pex_run (), but takes an extra parameter to enable the
    510    environment for the child process to be specified.
    511 
    512    ENV		The environment for the child process, specified as
    513 		an array of character pointers.  Each element of the
    514 		array should point to a string of the form VAR=VALUE,
    515                 with the exception of the last element which must be
    516                 a null pointer.
    517 */
    518 
    519 extern const char *pex_run_in_environment (struct pex_obj *obj, int flags,
    520 			                   const char *executable,
    521                                            char * const *argv,
    522                                            char * const *env,
    523               	          		   const char *outname,
    524 					   const char *errname, int *err);
    525 
    526 /* Return a stream for a temporary file to pass to the first program
    527    in the pipeline as input.  The file name is chosen as for pex_run.
    528    pex_run closes the file automatically; don't close it yourself.  */
    529 
    530 extern FILE *pex_input_file (struct pex_obj *obj, int flags,
    531                              const char *in_name);
    532 
    533 /* Return a stream for a pipe connected to the standard input of the
    534    first program in the pipeline.  You must have passed
    535    `PEX_USE_PIPES' to `pex_init'.  Close the returned stream
    536    yourself.  */
    537 
    538 extern FILE *pex_input_pipe (struct pex_obj *obj, int binary);
    539 
    540 /* Read the standard output of the last program to be executed.
    541    pex_run can not be called after this.  BINARY should be non-zero if
    542    the file should be opened in binary mode; this is ignored on Unix.
    543    Returns NULL on error.  Don't call fclose on the returned FILE; it
    544    will be closed by pex_free.  */
    545 
    546 extern FILE *pex_read_output (struct pex_obj *, int binary);
    547 
    548 /* Read the standard error of the last program to be executed.
    549    pex_run can not be called after this.  BINARY should be non-zero if
    550    the file should be opened in binary mode; this is ignored on Unix.
    551    Returns NULL on error.  Don't call fclose on the returned FILE; it
    552    will be closed by pex_free.  */
    553 
    554 extern FILE *pex_read_err (struct pex_obj *, int binary);
    555 
    556 /* Return exit status of all programs in VECTOR.  COUNT indicates the
    557    size of VECTOR.  The status codes in the vector are in the order of
    558    the calls to pex_run.  Returns 0 on error, 1 on success.  */
    559 
    560 extern int pex_get_status (struct pex_obj *, int count, int *vector);
    561 
    562 /* Return times of all programs in VECTOR.  COUNT indicates the size
    563    of VECTOR.  struct pex_time is really just struct timeval, but that
    564    is not portable to all systems.  Returns 0 on error, 1 on
    565    success.  */
    566 
    567 struct pex_time
    568 {
    569   unsigned long user_seconds;
    570   unsigned long user_microseconds;
    571   unsigned long system_seconds;
    572   unsigned long system_microseconds;
    573 };
    574 
    575 extern int pex_get_times (struct pex_obj *, int count,
    576 			  struct pex_time *vector);
    577 
    578 /* Clean up a pex_obj.  If you have not called pex_get_times or
    579    pex_get_status, this will try to kill the subprocesses.  */
    580 
    581 extern void pex_free (struct pex_obj *);
    582 
    583 /* Just execute one program.  Return value is as for pex_run.
    584    FLAGS	Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT.
    585    EXECUTABLE	As for pex_run.
    586    ARGV		As for pex_run.
    587    PNAME	As for pex_init.
    588    OUTNAME	As for pex_run when PEX_LAST is set.
    589    ERRNAME	As for pex_run.
    590    STATUS	Set to exit status on success.
    591    ERR		As for pex_run.
    592 */
    593 
    594 extern const char *pex_one (int flags, const char *executable,
    595 			    char * const *argv, const char *pname,
    596 			    const char *outname, const char *errname,
    597 			    int *status, int *err);
    598 
    599 /* pexecute and pwait are the old pexecute interface, still here for
    600    backward compatibility.  Don't use these for new code.  Instead,
    601    use pex_init/pex_run/pex_get_status/pex_free, or pex_one.  */
    602 
    603 /* Definitions used by the pexecute routine.  */
    604 
    605 #define PEXECUTE_FIRST   1
    606 #define PEXECUTE_LAST    2
    607 #define PEXECUTE_ONE     (PEXECUTE_FIRST + PEXECUTE_LAST)
    608 #define PEXECUTE_SEARCH  4
    609 #define PEXECUTE_VERBOSE 8
    610 
    611 /* Execute a program.  */
    612 
    613 extern int pexecute (const char *, char * const *, const char *,
    614                      const char *, char **, char **, int);
    615 
    616 /* Wait for pexecute to finish.  */
    617 
    618 extern int pwait (int, int *, int);
    619 
    620 #if !HAVE_DECL_ASPRINTF
    621 /* Like sprintf but provides a pointer to malloc'd storage, which must
    622    be freed by the caller.  */
    623 
    624 extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2;
    625 #endif
    626 
    627 #if !HAVE_DECL_VASPRINTF
    628 /* Like vsprintf but provides a pointer to malloc'd storage, which
    629    must be freed by the caller.  */
    630 
    631 extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0);
    632 #endif
    633 
    634 #if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
    635 /* Like sprintf but prints at most N characters.  */
    636 extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3;
    637 #endif
    638 
    639 #if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
    640 /* Like vsprintf but prints at most N characters.  */
    641 extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0);
    642 #endif
    643 
    644 #if defined (HAVE_DECL_STRNLEN) && !HAVE_DECL_STRNLEN
    645 extern size_t strnlen (const char *, size_t);
    646 #endif
    647 
    648 #if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP
    649 /* Compare version strings.  */
    650 extern int strverscmp (const char *, const char *);
    651 #endif
    652 
    653 /* Set the title of a process */
    654 extern void setproctitle (const char *name, ...);
    655 
    656 /* Increase stack limit if possible.  */
    657 extern void stack_limit_increase (unsigned long);
    658 
    659 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
    660 
    661 /* Drastically simplified alloca configurator.  If we're using GCC,
    662    we use __builtin_alloca; otherwise we use the C alloca.  The C
    663    alloca is always available.  You can override GCC by defining
    664    USE_C_ALLOCA yourself.  The canonical autoconf macro C_ALLOCA is
    665    also set/unset as it is often used to indicate whether code needs
    666    to call alloca(0).  */
    667 extern void *C_alloca (size_t) ATTRIBUTE_MALLOC;
    668 #undef alloca
    669 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
    670 # define alloca(x) __builtin_alloca(x)
    671 # undef C_ALLOCA
    672 # define ASTRDUP(X) \
    673   (__extension__ ({ const char *const libiberty_optr = (X); \
    674    const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
    675    char *const libiberty_nptr = (char *const) alloca (libiberty_len); \
    676    (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
    677 #else
    678 # define alloca(x) C_alloca(x)
    679 # undef USE_C_ALLOCA
    680 # define USE_C_ALLOCA 1
    681 # undef C_ALLOCA
    682 # define C_ALLOCA 1
    683 extern const char *libiberty_optr;
    684 extern char *libiberty_nptr;
    685 extern unsigned long libiberty_len;
    686 # define ASTRDUP(X) \
    687   (libiberty_optr = (X), \
    688    libiberty_len = strlen (libiberty_optr) + 1, \
    689    libiberty_nptr = (char *) alloca (libiberty_len), \
    690    (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
    691 #endif
    692 
    693 #ifdef __cplusplus
    694 }
    695 #endif
    696 
    697 
    698 #endif /* ! defined (LIBIBERTY_H) */
    699