1 /* Function declarations for libiberty.
3 Copyright 2001, 2002, 2005 Free Software Foundation, Inc.
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.
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)
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.
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.
27 Written by Cygnus Support, 1994.
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. */
44 /* Get a definition for size_t. */
46 /* Get a definition for va_list. */
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. */
55 extern void unlock_stream (FILE *);
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. */
61 extern void unlock_std_streams (void);
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. */
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 *);
71 /* Build an argument vector from a string. Allocates memory using
72 malloc. Use freeargv to free the vector. */
74 extern char **buildargv (const char *) ATTRIBUTE_MALLOC
;
76 /* Free a vector returned by buildargv. */
78 extern void freeargv (char **);
80 /* Duplicate an argument vector. Allocates memory using malloc. Use
81 freeargv to free the vector. */
83 extern char **dupargv (char **) ATTRIBUTE_MALLOC
;
86 /* Return the last component of a path name. Note that we can't use a
87 prototype here because the parameter is declared inconsistently
88 across different systems, sometimes as "char *" and sometimes as
91 /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
92 undefined, we haven't run the autoconf check so provide the
93 declaration without arguments. If it is 0, we checked and failed
94 to find the declaration so provide a fully prototyped one. If it
95 is 1, we found it so don't provide any declaration at all. */
96 #if !HAVE_DECL_BASENAME
97 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined(__NetBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || defined (__MINGW32__) || defined (HAVE_DECL_BASENAME)
98 extern char *basename (const char *);
100 /* Do not allow basename to be used if there is no prototype seen. We
101 either need to use the above prototype or have one from
102 autoconf which would result in HAVE_DECL_BASENAME being set. */
103 #define basename basename_cannot_be_used_without_a_prototype
107 /* A well-defined basename () that is always compiled in. */
109 extern const char *lbasename (const char *);
111 /* A well-defined realpath () that is always compiled in. */
113 extern char *lrealpath (const char *);
115 /* Concatenate an arbitrary number of strings. You must pass NULL as
116 the last argument of this function, to terminate the list of
117 strings. Allocates memory using xmalloc. */
119 extern char *concat (const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL
;
121 /* Concatenate an arbitrary number of strings. You must pass NULL as
122 the last argument of this function, to terminate the list of
123 strings. Allocates memory using xmalloc. The first argument is
124 not one of the strings to be concatenated, but if not NULL is a
125 pointer to be freed after the new string is created, similar to the
126 way xrealloc works. */
128 extern char *reconcat (char *, const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL
;
130 /* Determine the length of concatenating an arbitrary number of
131 strings. You must pass NULL as the last argument of this function,
132 to terminate the list of strings. */
134 extern unsigned long concat_length (const char *, ...) ATTRIBUTE_SENTINEL
;
136 /* Concatenate an arbitrary number of strings into a SUPPLIED area of
137 memory. You must pass NULL as the last argument of this function,
138 to terminate the list of strings. The supplied memory is assumed
139 to be large enough. */
141 extern char *concat_copy (char *, const char *, ...) ATTRIBUTE_SENTINEL
;
143 /* Concatenate an arbitrary number of strings into a GLOBAL 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. */
148 extern char *concat_copy2 (const char *, ...) ATTRIBUTE_SENTINEL
;
150 /* This is the global area used by concat_copy2. */
152 extern char *libiberty_concat_ptr
;
154 /* Concatenate an arbitrary number of strings. You must pass NULL as
155 the last argument of this function, to terminate the list of
156 strings. Allocates memory using alloca. The arguments are
158 #define ACONCAT(ACONCAT_PARAMS) \
159 (libiberty_concat_ptr = (char *) alloca (concat_length ACONCAT_PARAMS + 1), \
160 concat_copy2 ACONCAT_PARAMS)
162 /* Check whether two file descriptors refer to the same file. */
164 extern int fdmatch (int fd1
, int fd2
);
166 /* Return the position of the first bit set in the argument. */
167 /* Prototypes vary from system to system, so we only provide a
168 prototype on systems where we know that we need it. */
169 #if defined (HAVE_DECL_FFS) && !HAVE_DECL_FFS
173 /* Get the working directory. The result is cached, so don't call
174 chdir() between calls to getpwd(). */
176 extern char * getpwd (void);
178 /* Get the current time. */
179 /* Prototypes vary from system to system, so we only provide a
180 prototype on systems where we know that we need it. */
182 /* Forward declaration to avoid #include <sys/time.h>. */
184 extern int gettimeofday (struct timeval
*, void *);
187 /* Get the amount of time the process has run, in microseconds. */
189 extern long get_run_time (void);
191 /* Generate a relocated path to some installation directory. Allocates
192 return value using malloc. */
194 extern char *make_relative_prefix (const char *, const char *,
195 const char *) ATTRIBUTE_MALLOC
;
197 /* Choose a temporary directory to use for scratch files. */
199 extern char *choose_temp_base (void) ATTRIBUTE_MALLOC
;
201 /* Return a temporary file name or NULL if unable to create one. */
203 extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC
;
205 /* Remove a link to a file unless it is special. */
207 extern int unlink_if_ordinary (const char *);
209 /* Allocate memory filled with spaces. Allocates using malloc. */
211 extern const char *spaces (int count
);
213 /* Return the maximum error number for which strerror will return a
216 extern int errno_max (void);
218 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
221 extern const char *strerrno (int);
223 /* Given the name of an errno value, return the value. */
225 extern int strtoerrno (const char *);
227 /* ANSI's strerror(), but more robust. */
229 extern char *xstrerror (int);
231 /* Return the maximum signal number for which strsignal will return a
234 extern int signo_max (void);
236 /* Return a signal message string for a signal number
237 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
238 /* This is commented out as it can conflict with one in system headers.
239 We still document its existence though. */
241 /*extern const char *strsignal (int);*/
243 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
246 extern const char *strsigno (int);
248 /* Given the name of a signal, return its number. */
250 extern int strtosigno (const char *);
252 /* Register a function to be run by xexit. Returns 0 on success. */
254 extern int xatexit (void (*fn
) (void));
256 /* Exit, calling all the functions registered with xatexit. */
258 extern void xexit (int status
) ATTRIBUTE_NORETURN
;
260 /* Set the program name used by xmalloc. */
262 extern void xmalloc_set_program_name (const char *);
264 /* Report an allocation failure. */
265 extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN
;
267 /* Allocate memory without fail. If malloc fails, this will print a
268 message to stderr (using the name set by xmalloc_set_program_name,
269 if any) and then call xexit. */
271 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC
;
273 /* Reallocate memory without fail. This works like xmalloc. Note,
274 realloc type functions are not suitable for attribute malloc since
275 they may return the same address across multiple calls. */
277 extern void *xrealloc (void *, size_t);
279 /* Allocate memory without fail and set it to zero. This works like
282 extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC
;
284 /* Copy a string into a memory buffer without fail. */
286 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC
;
288 /* Copy at most N characters from string into a buffer without fail. */
290 extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC
;
292 /* Copy an existing memory buffer to a new memory buffer without fail. */
294 extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC
;
296 /* Physical memory routines. Return values are in BYTES. */
297 extern double physmem_total (void);
298 extern double physmem_available (void);
301 /* These macros provide a K&R/C89/C++-friendly way of allocating structures
302 with nice encapsulation. The XDELETE*() macros are technically
303 superfluous, but provided here for symmetry. Using them consistently
304 makes it easier to update client code to use different allocators such
305 as new/delete and new[]/delete[]. */
307 /* Scalar allocators. */
309 #define XNEW(T) ((T *) xmalloc (sizeof (T)))
310 #define XCNEW(T) ((T *) xcalloc (1, sizeof (T)))
311 #define XDELETE(P) free ((void*) (P))
313 /* Array allocators. */
315 #define XNEWVEC(T, N) ((T *) xmalloc (sizeof (T) * (N)))
316 #define XCNEWVEC(T, N) ((T *) xcalloc ((N), sizeof (T)))
317 #define XRESIZEVEC(T, P, N) ((T *) xrealloc ((void *) (P), sizeof (T) * (N)))
318 #define XDELETEVEC(P) free ((void*) (P))
320 /* Allocators for variable-sized structures and raw buffers. */
322 #define XNEWVAR(T, S) ((T *) xmalloc ((S)))
323 #define XCNEWVAR(T, S) ((T *) xcalloc (1, (S)))
324 #define XRESIZEVAR(T, P, S) ((T *) xrealloc ((P), (S)))
326 /* Type-safe obstack allocator. */
328 #define XOBNEW(O, T) ((T *) obstack_alloc ((O), sizeof (T)))
329 #define XOBFINISH(O, T) ((T) obstack_finish ((O)))
331 /* hex character manipulation routines */
333 #define _hex_array_size 256
335 extern const unsigned char _hex_value
[_hex_array_size
];
336 extern void hex_init (void);
337 #define hex_p(c) (hex_value (c) != _hex_bad)
338 /* If you change this, note well: Some code relies on side effects in
339 the argument being performed exactly once. */
340 #define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)])
342 /* Flags for pex_init. These are bits to be or'ed together. */
344 /* Record subprocess times, if possible. */
345 #define PEX_RECORD_TIMES 0x1
347 /* Use pipes for communication between processes, if possible. */
348 #define PEX_USE_PIPES 0x2
350 /* Save files used for communication between processes. */
351 #define PEX_SAVE_TEMPS 0x4
353 /* Prepare to execute one or more programs, with standard output of
354 each program fed to standard input of the next.
356 PNAME The name of the program to report in error messages.
357 TEMPBASE A base name to use for temporary files; may be NULL to
359 Returns NULL on error. */
361 extern struct pex_obj
*pex_init (int flags
, const char *pname
,
362 const char *tempbase
);
364 /* Flags for pex_run. These are bits to be or'ed together. */
366 /* Last program in pipeline. Standard output of program goes to
367 OUTNAME, or, if OUTNAME is NULL, to standard output of caller. Do
368 not set this if you want to call pex_read_output. After this is
369 set, pex_run may no longer be called with the same struct
373 /* Search for program in executable search path. */
374 #define PEX_SEARCH 0x2
376 /* OUTNAME is a suffix. */
377 #define PEX_SUFFIX 0x4
379 /* Send program's standard error to standard output. */
380 #define PEX_STDERR_TO_STDOUT 0x8
382 /* Input file should be opened in binary mode. This flag is ignored
384 #define PEX_BINARY_INPUT 0x10
386 /* Output file should be opened in binary mode. This flag is ignored
387 on Unix. For proper behaviour PEX_BINARY_INPUT and
388 PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using
389 PEX_BINARY_OUTPUT should be followed by a call using
391 #define PEX_BINARY_OUTPUT 0x20
393 /* Execute one program. Returns NULL on success. On error returns an
394 error string (typically just the name of a system call); the error
395 string is statically allocated.
397 OBJ Returned by pex_init.
401 EXECUTABLE The program to execute.
403 ARGV NULL terminated array of arguments to pass to the program.
405 OUTNAME Sets the output file name as follows:
407 PEX_SUFFIX set (OUTNAME may not be NULL):
408 TEMPBASE parameter to pex_init not NULL:
409 Output file name is the concatenation of TEMPBASE
412 Output file name is a random file name ending in
416 Output file name is OUTNAME.
417 OUTNAME NULL, TEMPBASE not NULL:
418 Output file name is randomly chosen using
420 OUTNAME NULL, TEMPBASE NULL:
421 Output file name is randomly chosen.
423 If PEX_LAST is not set, the output file name is the
424 name to use for a temporary file holding stdout, if
425 any (there will not be a file if PEX_USE_PIPES is set
426 and the system supports pipes). If a file is used, it
427 will be removed when no longer needed unless
428 PEX_SAVE_TEMPS is set.
430 If PEX_LAST is set, and OUTNAME is not NULL, standard
431 output is written to the output file name. The file
432 will not be removed. If PEX_LAST and PEX_SUFFIX are
433 both set, TEMPBASE may not be NULL.
435 ERRNAME If not NULL, this is the name of a file to which
436 standard error is written. If NULL, standard error of
437 the program is standard error of the caller.
439 ERR On an error return, *ERR is set to an errno value, or
440 to 0 if there is no relevant errno.
443 extern const char *pex_run (struct pex_obj
*obj
, int flags
,
444 const char *executable
, char * const *argv
,
445 const char *outname
, const char *errname
,
448 /* Read the standard output of the last program to be executed.
449 pex_run can not be called after this. BINARY should be non-zero if
450 the file should be opened in binary mode; this is ignored on Unix.
451 Returns NULL on error. Don't call fclose on the returned FILE; it
452 will be closed by pex_free. */
454 extern FILE *pex_read_output (struct pex_obj
*, int binary
);
456 /* Return exit status of all programs in VECTOR. COUNT indicates the
457 size of VECTOR. The status codes in the vector are in the order of
458 the calls to pex_run. Returns 0 on error, 1 on success. */
460 extern int pex_get_status (struct pex_obj
*, int count
, int *vector
);
462 /* Return times of all programs in VECTOR. COUNT indicates the size
463 of VECTOR. struct pex_time is really just struct timeval, but that
464 is not portable to all systems. Returns 0 on error, 1 on
469 unsigned long user_seconds
;
470 unsigned long user_microseconds
;
471 unsigned long system_seconds
;
472 unsigned long system_microseconds
;
475 extern int pex_get_times (struct pex_obj
*, int count
,
476 struct pex_time
*vector
);
478 /* Clean up a pex_obj. */
480 extern void pex_free (struct pex_obj
*);
482 /* Just execute one program. Return value is as for pex_run.
483 FLAGS Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT.
484 EXECUTABLE As for pex_run.
486 PNAME As for pex_init.
487 OUTNAME As for pex_run when PEX_LAST is set.
488 ERRNAME As for pex_run.
489 STATUS Set to exit status on success.
493 extern const char *pex_one (int flags
, const char *executable
,
494 char * const *argv
, const char *pname
,
495 const char *outname
, const char *errname
,
496 int *status
, int *err
);
498 /* pexecute and pwait are the old pexecute interface, still here for
499 backward compatibility. Don't use these for new code. Instead,
500 use pex_init/pex_run/pex_get_status/pex_free, or pex_one. */
502 /* Definitions used by the pexecute routine. */
504 #define PEXECUTE_FIRST 1
505 #define PEXECUTE_LAST 2
506 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
507 #define PEXECUTE_SEARCH 4
508 #define PEXECUTE_VERBOSE 8
510 /* Execute a program. */
512 extern int pexecute (const char *, char * const *, const char *,
513 const char *, char **, char **, int);
515 /* Wait for pexecute to finish. */
517 extern int pwait (int, int *, int);
519 #if !HAVE_DECL_ASPRINTF
520 /* Like sprintf but provides a pointer to malloc'd storage, which must
521 be freed by the caller. */
523 extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2
;
526 #if !HAVE_DECL_VASPRINTF
527 /* Like vsprintf but provides a pointer to malloc'd storage, which
528 must be freed by the caller. */
530 extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0);
533 #if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
534 /* Like sprintf but prints at most N characters. */
535 extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3
;
538 #if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
539 /* Like vsprintf but prints at most N characters. */
540 extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0);
543 #if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP
544 /* Compare version strings. */
545 extern int strverscmp (const char *, const char *);
548 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
550 /* Drastically simplified alloca configurator. If we're using GCC,
551 we use __builtin_alloca; otherwise we use the C alloca. The C
552 alloca is always available. You can override GCC by defining
553 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is
554 also set/unset as it is often used to indicate whether code needs
555 to call alloca(0). */
556 extern void *C_alloca (size_t) ATTRIBUTE_MALLOC
;
558 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
559 # define alloca(x) __builtin_alloca(x)
561 # define ASTRDUP(X) \
562 (__extension__ ({ const char *const libiberty_optr = (X); \
563 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
564 char *const libiberty_nptr = (char *const) alloca (libiberty_len); \
565 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
567 # define alloca(x) C_alloca(x)
569 # define USE_C_ALLOCA 1
572 extern const char *libiberty_optr
;
573 extern char *libiberty_nptr
;
574 extern unsigned long libiberty_len
;
575 # define ASTRDUP(X) \
576 (libiberty_optr = (X), \
577 libiberty_len = strlen (libiberty_optr) + 1, \
578 libiberty_nptr = (char *) alloca (libiberty_len), \
579 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
587 #endif /* ! defined (LIBIBERTY_H) */