ChangeLog rotatation and copyright year update
[deliverable/binutils-gdb.git] / include / libiberty.h
CommitLineData
252b5132 1/* Function declarations for libiberty.
4f1d9bd8 2
b90efa5b 3 Copyright (C) 1997-2015 Free Software Foundation, Inc.
4f1d9bd8 4
526c3e12
NC
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
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
9334f9c6 83extern char **dupargv (char **) 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
281e9aa6 91extern int writeargv (char **, FILE *);
0c18fee5 92
514c97d3
DD
93/* Return the number of elements in argv. */
94
95extern int countargv (char**);
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
252b5132
RH
229/* Choose a temporary directory to use for scratch files. */
230
689a1abf 231extern char *choose_temp_base (void) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
cc89ffe6
ILT
232
233/* Return a temporary file name or NULL if unable to create one. */
234
9334f9c6 235extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC;
252b5132 236
190eb137
DD
237/* Remove a link to a file unless it is special. */
238
9334f9c6 239extern int unlink_if_ordinary (const char *);
190eb137 240
252b5132
RH
241/* Allocate memory filled with spaces. Allocates using malloc. */
242
9334f9c6 243extern const char *spaces (int count);
252b5132
RH
244
245/* Return the maximum error number for which strerror will return a
246 string. */
247
9334f9c6 248extern int errno_max (void);
252b5132
RH
249
250/* Return the name of an errno value (e.g., strerrno (EINVAL) returns
251 "EINVAL"). */
252
9334f9c6 253extern const char *strerrno (int);
252b5132
RH
254
255/* Given the name of an errno value, return the value. */
256
9334f9c6 257extern int strtoerrno (const char *);
252b5132
RH
258
259/* ANSI's strerror(), but more robust. */
260
689a1abf 261extern char *xstrerror (int) ATTRIBUTE_RETURNS_NONNULL;
252b5132
RH
262
263/* Return the maximum signal number for which strsignal will return a
264 string. */
265
9334f9c6 266extern int signo_max (void);
252b5132
RH
267
268/* Return a signal message string for a signal number
269 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
270/* This is commented out as it can conflict with one in system headers.
271 We still document its existence though. */
272
9334f9c6 273/*extern const char *strsignal (int);*/
252b5132
RH
274
275/* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
276 "SIGHUP"). */
277
9334f9c6 278extern const char *strsigno (int);
252b5132
RH
279
280/* Given the name of a signal, return its number. */
281
9334f9c6 282extern int strtosigno (const char *);
252b5132
RH
283
284/* Register a function to be run by xexit. Returns 0 on success. */
285
9334f9c6 286extern int xatexit (void (*fn) (void));
252b5132
RH
287
288/* Exit, calling all the functions registered with xatexit. */
289
9334f9c6 290extern void xexit (int status) ATTRIBUTE_NORETURN;
252b5132
RH
291
292/* Set the program name used by xmalloc. */
293
9334f9c6 294extern void xmalloc_set_program_name (const char *);
252b5132 295
b13291a9 296/* Report an allocation failure. */
9334f9c6 297extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN;
b13291a9 298
252b5132
RH
299/* Allocate memory without fail. If malloc fails, this will print a
300 message to stderr (using the name set by xmalloc_set_program_name,
301 if any) and then call xexit. */
302
689a1abf 303extern void *xmalloc (size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
252b5132 304
cc89ffe6
ILT
305/* Reallocate memory without fail. This works like xmalloc. Note,
306 realloc type functions are not suitable for attribute malloc since
307 they may return the same address across multiple calls. */
252b5132 308
689a1abf 309extern void *xrealloc (void *, size_t) ATTRIBUTE_RETURNS_NONNULL;
252b5132
RH
310
311/* Allocate memory without fail and set it to zero. This works like
312 xmalloc. */
313
689a1abf 314extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
252b5132
RH
315
316/* Copy a string into a memory buffer without fail. */
317
689a1abf 318extern char *xstrdup (const char *) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
cc89ffe6 319
0fad4bdb
DD
320/* Copy at most N characters from string into a buffer without fail. */
321
689a1abf 322extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
0fad4bdb 323
cc89ffe6
ILT
324/* Copy an existing memory buffer to a new memory buffer without fail. */
325
689a1abf 326extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC ATTRIBUTE_RETURNS_NONNULL;
252b5132 327
638ceb1a 328/* Physical memory routines. Return values are in BYTES. */
9334f9c6
DD
329extern double physmem_total (void);
330extern double physmem_available (void);
4938384a 331
6e881691 332/* Compute the 32-bit CRC of a block of memory. */
bdc0e08d 333extern unsigned int xcrc32 (const unsigned char *, int, unsigned int);
d5b4094f
DD
334
335/* These macros provide a K&R/C89/C++-friendly way of allocating structures
336 with nice encapsulation. The XDELETE*() macros are technically
337 superfluous, but provided here for symmetry. Using them consistently
338 makes it easier to update client code to use different allocators such
339 as new/delete and new[]/delete[]. */
340
341/* Scalar allocators. */
342
1e5d0832 343#define XALLOCA(T) ((T *) alloca (sizeof (T)))
d5b4094f
DD
344#define XNEW(T) ((T *) xmalloc (sizeof (T)))
345#define XCNEW(T) ((T *) xcalloc (1, sizeof (T)))
1e5d0832 346#define XDUP(T, P) ((T *) xmemdup ((P), sizeof (T), sizeof (T)))
deaa6723 347#define XDELETE(P) free ((void*) (P))
d5b4094f
DD
348
349/* Array allocators. */
350
1e5d0832 351#define XALLOCAVEC(T, N) ((T *) alloca (sizeof (T) * (N)))
d5b4094f
DD
352#define XNEWVEC(T, N) ((T *) xmalloc (sizeof (T) * (N)))
353#define XCNEWVEC(T, N) ((T *) xcalloc ((N), sizeof (T)))
1e5d0832 354#define XDUPVEC(T, P, N) ((T *) xmemdup ((P), sizeof (T) * (N), sizeof (T) * (N)))
deaa6723
DD
355#define XRESIZEVEC(T, P, N) ((T *) xrealloc ((void *) (P), sizeof (T) * (N)))
356#define XDELETEVEC(P) free ((void*) (P))
d5b4094f
DD
357
358/* Allocators for variable-sized structures and raw buffers. */
359
1e5d0832 360#define XALLOCAVAR(T, S) ((T *) alloca ((S)))
d5b4094f
DD
361#define XNEWVAR(T, S) ((T *) xmalloc ((S)))
362#define XCNEWVAR(T, S) ((T *) xcalloc (1, (S)))
1e5d0832 363#define XDUPVAR(T, P, S1, S2) ((T *) xmemdup ((P), (S1), (S2)))
d5b4094f
DD
364#define XRESIZEVAR(T, P, S) ((T *) xrealloc ((P), (S)))
365
366/* Type-safe obstack allocator. */
367
368#define XOBNEW(O, T) ((T *) obstack_alloc ((O), sizeof (T)))
1e5d0832
DD
369#define XOBNEWVEC(O, T, N) ((T *) obstack_alloc ((O), sizeof (T) * (N)))
370#define XOBNEWVAR(O, T, S) ((T *) obstack_alloc ((O), (S)))
d30d42d1 371#define XOBFINISH(O, T) ((T) obstack_finish ((O)))
d5b4094f 372
252b5132
RH
373/* hex character manipulation routines */
374
375#define _hex_array_size 256
376#define _hex_bad 99
e4f79046 377extern const unsigned char _hex_value[_hex_array_size];
9334f9c6 378extern void hex_init (void);
252b5132
RH
379#define hex_p(c) (hex_value (c) != _hex_bad)
380/* If you change this, note well: Some code relies on side effects in
381 the argument being performed exactly once. */
e4f79046 382#define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)])
252b5132 383
b109e79a
ILT
384/* Flags for pex_init. These are bits to be or'ed together. */
385
386/* Record subprocess times, if possible. */
387#define PEX_RECORD_TIMES 0x1
388
389/* Use pipes for communication between processes, if possible. */
390#define PEX_USE_PIPES 0x2
391
392/* Save files used for communication between processes. */
393#define PEX_SAVE_TEMPS 0x4
394
395/* Prepare to execute one or more programs, with standard output of
396 each program fed to standard input of the next.
397 FLAGS As above.
398 PNAME The name of the program to report in error messages.
399 TEMPBASE A base name to use for temporary files; may be NULL to
400 use a random name.
401 Returns NULL on error. */
402
403extern struct pex_obj *pex_init (int flags, const char *pname,
689a1abf 404 const char *tempbase) ATTRIBUTE_RETURNS_NONNULL;
b109e79a
ILT
405
406/* Flags for pex_run. These are bits to be or'ed together. */
407
408/* Last program in pipeline. Standard output of program goes to
409 OUTNAME, or, if OUTNAME is NULL, to standard output of caller. Do
410 not set this if you want to call pex_read_output. After this is
411 set, pex_run may no longer be called with the same struct
412 pex_obj. */
413#define PEX_LAST 0x1
414
415/* Search for program in executable search path. */
416#define PEX_SEARCH 0x2
417
418/* OUTNAME is a suffix. */
419#define PEX_SUFFIX 0x4
420
421/* Send program's standard error to standard output. */
422#define PEX_STDERR_TO_STDOUT 0x8
423
424/* Input file should be opened in binary mode. This flag is ignored
425 on Unix. */
426#define PEX_BINARY_INPUT 0x10
427
428/* Output file should be opened in binary mode. This flag is ignored
429 on Unix. For proper behaviour PEX_BINARY_INPUT and
430 PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using
431 PEX_BINARY_OUTPUT should be followed by a call using
432 PEX_BINARY_INPUT. */
433#define PEX_BINARY_OUTPUT 0x20
434
53d7966f
VP
435/* Capture stderr to a pipe. The output can be read by
436 calling pex_read_err and reading from the returned
437 FILE object. This flag may be specified only for
438 the last program in a pipeline.
439
440 This flag is supported only on Unix and Windows. */
441#define PEX_STDERR_TO_PIPE 0x40
442
443/* Capture stderr in binary mode. This flag is ignored
444 on Unix. */
445#define PEX_BINARY_ERROR 0x80
446
b55f9678
IB
447/* Append stdout to existing file instead of truncating it. */
448#define PEX_STDOUT_APPEND 0x100
449
450/* Thes same as PEX_STDOUT_APPEND, but for STDERR. */
451#define PEX_STDERR_APPEND 0x200
53d7966f 452
b109e79a
ILT
453/* Execute one program. Returns NULL on success. On error returns an
454 error string (typically just the name of a system call); the error
455 string is statically allocated.
456
457 OBJ Returned by pex_init.
458
459 FLAGS As above.
460
461 EXECUTABLE The program to execute.
462
463 ARGV NULL terminated array of arguments to pass to the program.
464
465 OUTNAME Sets the output file name as follows:
466
467 PEX_SUFFIX set (OUTNAME may not be NULL):
468 TEMPBASE parameter to pex_init not NULL:
469 Output file name is the concatenation of TEMPBASE
470 and OUTNAME.
471 TEMPBASE is NULL:
472 Output file name is a random file name ending in
473 OUTNAME.
474 PEX_SUFFIX not set:
475 OUTNAME not NULL:
476 Output file name is OUTNAME.
477 OUTNAME NULL, TEMPBASE not NULL:
478 Output file name is randomly chosen using
479 TEMPBASE.
480 OUTNAME NULL, TEMPBASE NULL:
481 Output file name is randomly chosen.
482
483 If PEX_LAST is not set, the output file name is the
484 name to use for a temporary file holding stdout, if
485 any (there will not be a file if PEX_USE_PIPES is set
486 and the system supports pipes). If a file is used, it
487 will be removed when no longer needed unless
488 PEX_SAVE_TEMPS is set.
489
490 If PEX_LAST is set, and OUTNAME is not NULL, standard
491 output is written to the output file name. The file
492 will not be removed. If PEX_LAST and PEX_SUFFIX are
493 both set, TEMPBASE may not be NULL.
494
495 ERRNAME If not NULL, this is the name of a file to which
496 standard error is written. If NULL, standard error of
497 the program is standard error of the caller.
498
499 ERR On an error return, *ERR is set to an errno value, or
500 to 0 if there is no relevant errno.
501*/
502
503extern const char *pex_run (struct pex_obj *obj, int flags,
504 const char *executable, char * const *argv,
505 const char *outname, const char *errname,
506 int *err);
507
014a8caf
DD
508/* As for pex_run (), but takes an extra parameter to enable the
509 environment for the child process to be specified.
510
511 ENV The environment for the child process, specified as
512 an array of character pointers. Each element of the
513 array should point to a string of the form VAR=VALUE,
514 with the exception of the last element which must be
515 a null pointer.
516*/
517
518extern const char *pex_run_in_environment (struct pex_obj *obj, int flags,
519 const char *executable,
520 char * const *argv,
521 char * const *env,
522 const char *outname,
523 const char *errname, int *err);
524
3db2e6dd
DD
525/* Return a stream for a temporary file to pass to the first program
526 in the pipeline as input. The file name is chosen as for pex_run.
527 pex_run closes the file automatically; don't close it yourself. */
528
529extern FILE *pex_input_file (struct pex_obj *obj, int flags,
530 const char *in_name);
531
532/* Return a stream for a pipe connected to the standard input of the
533 first program in the pipeline. You must have passed
534 `PEX_USE_PIPES' to `pex_init'. Close the returned stream
535 yourself. */
536
537extern FILE *pex_input_pipe (struct pex_obj *obj, int binary);
538
b109e79a
ILT
539/* Read the standard output of the last program to be executed.
540 pex_run can not be called after this. BINARY should be non-zero if
541 the file should be opened in binary mode; this is ignored on Unix.
542 Returns NULL on error. Don't call fclose on the returned FILE; it
543 will be closed by pex_free. */
544
545extern FILE *pex_read_output (struct pex_obj *, int binary);
546
53d7966f
VP
547/* Read the standard error of the last program to be executed.
548 pex_run can not be called after this. BINARY should be non-zero if
549 the file should be opened in binary mode; this is ignored on Unix.
550 Returns NULL on error. Don't call fclose on the returned FILE; it
551 will be closed by pex_free. */
552
553extern FILE *pex_read_err (struct pex_obj *, int binary);
554
b109e79a
ILT
555/* Return exit status of all programs in VECTOR. COUNT indicates the
556 size of VECTOR. The status codes in the vector are in the order of
557 the calls to pex_run. Returns 0 on error, 1 on success. */
558
559extern int pex_get_status (struct pex_obj *, int count, int *vector);
560
561/* Return times of all programs in VECTOR. COUNT indicates the size
562 of VECTOR. struct pex_time is really just struct timeval, but that
563 is not portable to all systems. Returns 0 on error, 1 on
564 success. */
565
566struct pex_time
567{
568 unsigned long user_seconds;
569 unsigned long user_microseconds;
570 unsigned long system_seconds;
571 unsigned long system_microseconds;
572};
573
574extern int pex_get_times (struct pex_obj *, int count,
575 struct pex_time *vector);
576
3a0ab695
DD
577/* Clean up a pex_obj. If you have not called pex_get_times or
578 pex_get_status, this will try to kill the subprocesses. */
b109e79a 579
7e10245c 580extern void pex_free (struct pex_obj *);
b109e79a
ILT
581
582/* Just execute one program. Return value is as for pex_run.
583 FLAGS Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT.
584 EXECUTABLE As for pex_run.
585 ARGV As for pex_run.
586 PNAME As for pex_init.
587 OUTNAME As for pex_run when PEX_LAST is set.
588 ERRNAME As for pex_run.
589 STATUS Set to exit status on success.
590 ERR As for pex_run.
591*/
592
593extern const char *pex_one (int flags, const char *executable,
594 char * const *argv, const char *pname,
595 const char *outname, const char *errname,
596 int *status, int *err);
597
598/* pexecute and pwait are the old pexecute interface, still here for
599 backward compatibility. Don't use these for new code. Instead,
600 use pex_init/pex_run/pex_get_status/pex_free, or pex_one. */
601
252b5132
RH
602/* Definitions used by the pexecute routine. */
603
604#define PEXECUTE_FIRST 1
605#define PEXECUTE_LAST 2
606#define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
607#define PEXECUTE_SEARCH 4
608#define PEXECUTE_VERBOSE 8
609
610/* Execute a program. */
611
9334f9c6
DD
612extern int pexecute (const char *, char * const *, const char *,
613 const char *, char **, char **, int);
252b5132
RH
614
615/* Wait for pexecute to finish. */
616
9334f9c6 617extern int pwait (int, int *, int);
252b5132 618
bb7eb039 619#if !HAVE_DECL_ASPRINTF
cc89ffe6
ILT
620/* Like sprintf but provides a pointer to malloc'd storage, which must
621 be freed by the caller. */
622
9334f9c6 623extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2;
bb7eb039 624#endif
cc89ffe6 625
bb7eb039 626#if !HAVE_DECL_VASPRINTF
cc89ffe6
ILT
627/* Like vsprintf but provides a pointer to malloc'd storage, which
628 must be freed by the caller. */
629
c2bd6e35 630extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0);
bb7eb039 631#endif
cc89ffe6 632
01e94249
DD
633#if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
634/* Like sprintf but prints at most N characters. */
635extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3;
636#endif
637
638#if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
639/* Like vsprintf but prints at most N characters. */
c2bd6e35 640extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0);
01e94249
DD
641#endif
642
b55f9678
IB
643#if defined (HAVE_DECL_STRNLEN) && !HAVE_DECL_STRNLEN
644extern size_t strnlen (const char *, size_t);
645#endif
646
67f3cb05
GK
647#if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP
648/* Compare version strings. */
649extern int strverscmp (const char *, const char *);
650#endif
651
9711ae4d
DD
652/* Set the title of a process */
653extern void setproctitle (const char *name, ...);
654
26ac1280
DD
655/* Increase stack limit if possible. */
656extern void stack_limit_increase (unsigned long);
657
b18903cb
NC
658#define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
659
30673bf5
DD
660/* Drastically simplified alloca configurator. If we're using GCC,
661 we use __builtin_alloca; otherwise we use the C alloca. The C
662 alloca is always available. You can override GCC by defining
129e8d96
DD
663 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is
664 also set/unset as it is often used to indicate whether code needs
665 to call alloca(0). */
a288642d 666extern void *C_alloca (size_t) ATTRIBUTE_MALLOC;
30673bf5
DD
667#undef alloca
668#if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
669# define alloca(x) __builtin_alloca(x)
129e8d96 670# undef C_ALLOCA
54c20242
DD
671# define ASTRDUP(X) \
672 (__extension__ ({ const char *const libiberty_optr = (X); \
673 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
7ab9a76e 674 char *const libiberty_nptr = (char *const) alloca (libiberty_len); \
54c20242 675 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
30673bf5
DD
676#else
677# define alloca(x) C_alloca(x)
678# undef USE_C_ALLOCA
679# define USE_C_ALLOCA 1
129e8d96
DD
680# undef C_ALLOCA
681# define C_ALLOCA 1
54c20242
DD
682extern const char *libiberty_optr;
683extern char *libiberty_nptr;
684extern unsigned long libiberty_len;
685# define ASTRDUP(X) \
686 (libiberty_optr = (X), \
687 libiberty_len = strlen (libiberty_optr) + 1, \
7ab9a76e 688 libiberty_nptr = (char *) alloca (libiberty_len), \
54c20242 689 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
30673bf5
DD
690#endif
691
252b5132
RH
692#ifdef __cplusplus
693}
694#endif
695
696
697#endif /* ! defined (LIBIBERTY_H) */
This page took 0.647068 seconds and 4 git commands to generate.