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