include/libiberty.h

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