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