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