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