include/libiberty.h

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