2006-10-22 H.J. Lu <hongjiu.lu@intel.com>
[official-gcc.git] / include / libiberty.h
blob1328d3eb14c0340cb3641d73828b1b529a928e99
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)
15 any later version.
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. */
35 #ifndef LIBIBERTY_H
36 #define LIBIBERTY_H
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
42 #include "ansidecl.h"
44 /* Get a definition for size_t. */
45 #include <stddef.h>
46 /* Get a definition for va_list. */
47 #include <stdarg.h>
49 #include <stdio.h>
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;
85 /* Expand "@file" arguments in argv. */
87 extern void expandargv PARAMS ((int *, char ***));
89 /* Return the last component of a path name. Note that we can't use a
90 prototype here because the parameter is declared inconsistently
91 across different systems, sometimes as "char *" and sometimes as
92 "const char *" */
94 /* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
95 undefined, we haven't run the autoconf check so provide the
96 declaration without arguments. If it is 0, we checked and failed
97 to find the declaration so provide a fully prototyped one. If it
98 is 1, we found it so don't provide any declaration at all. */
99 #if !HAVE_DECL_BASENAME
100 #if defined (__GNU_LIBRARY__ ) || defined (__linux__) || defined (__FreeBSD__) || defined (__OpenBSD__) || defined(__NetBSD__) || defined (__CYGWIN__) || defined (__CYGWIN32__) || defined (__MINGW32__) || defined (HAVE_DECL_BASENAME)
101 extern char *basename (const char *);
102 #else
103 /* Do not allow basename to be used if there is no prototype seen. We
104 either need to use the above prototype or have one from
105 autoconf which would result in HAVE_DECL_BASENAME being set. */
106 #define basename basename_cannot_be_used_without_a_prototype
107 #endif
108 #endif
110 /* A well-defined basename () that is always compiled in. */
112 extern const char *lbasename (const char *);
114 /* A well-defined realpath () that is always compiled in. */
116 extern char *lrealpath (const char *);
118 /* Concatenate an arbitrary number of strings. You must pass NULL as
119 the last argument of this function, to terminate the list of
120 strings. Allocates memory using xmalloc. */
122 extern char *concat (const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL;
124 /* Concatenate an arbitrary number of strings. You must pass NULL as
125 the last argument of this function, to terminate the list of
126 strings. Allocates memory using xmalloc. The first argument is
127 not one of the strings to be concatenated, but if not NULL is a
128 pointer to be freed after the new string is created, similar to the
129 way xrealloc works. */
131 extern char *reconcat (char *, const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL;
133 /* Determine the length of concatenating an arbitrary number of
134 strings. You must pass NULL as the last argument of this function,
135 to terminate the list of strings. */
137 extern unsigned long concat_length (const char *, ...) ATTRIBUTE_SENTINEL;
139 /* Concatenate an arbitrary number of strings into a SUPPLIED area of
140 memory. You must pass NULL as the last argument of this function,
141 to terminate the list of strings. The supplied memory is assumed
142 to be large enough. */
144 extern char *concat_copy (char *, const char *, ...) ATTRIBUTE_SENTINEL;
146 /* Concatenate an arbitrary number of strings into a GLOBAL area of
147 memory. You must pass NULL as the last argument of this function,
148 to terminate the list of strings. The supplied memory is assumed
149 to be large enough. */
151 extern char *concat_copy2 (const char *, ...) ATTRIBUTE_SENTINEL;
153 /* This is the global area used by concat_copy2. */
155 extern char *libiberty_concat_ptr;
157 /* Concatenate an arbitrary number of strings. You must pass NULL as
158 the last argument of this function, to terminate the list of
159 strings. Allocates memory using alloca. The arguments are
160 evaluated twice! */
161 #define ACONCAT(ACONCAT_PARAMS) \
162 (libiberty_concat_ptr = (char *) alloca (concat_length ACONCAT_PARAMS + 1), \
163 concat_copy2 ACONCAT_PARAMS)
165 /* Check whether two file descriptors refer to the same file. */
167 extern int fdmatch (int fd1, int fd2);
169 /* Return the position of the first bit set in the argument. */
170 /* Prototypes vary from system to system, so we only provide a
171 prototype on systems where we know that we need it. */
172 #if defined (HAVE_DECL_FFS) && !HAVE_DECL_FFS
173 extern int ffs(int);
174 #endif
176 /* Get the working directory. The result is cached, so don't call
177 chdir() between calls to getpwd(). */
179 extern char * getpwd (void);
181 /* Get the current time. */
182 /* Prototypes vary from system to system, so we only provide a
183 prototype on systems where we know that we need it. */
184 #ifdef __MINGW32__
185 /* Forward declaration to avoid #include <sys/time.h>. */
186 struct timeval;
187 extern int gettimeofday (struct timeval *, void *);
188 #endif
190 /* Get the amount of time the process has run, in microseconds. */
192 extern long get_run_time (void);
194 /* Generate a relocated path to some installation directory. Allocates
195 return value using malloc. */
197 extern char *make_relative_prefix (const char *, const char *,
198 const char *) ATTRIBUTE_MALLOC;
200 /* Choose a temporary directory to use for scratch files. */
202 extern char *choose_temp_base (void) ATTRIBUTE_MALLOC;
204 /* Return a temporary file name or NULL if unable to create one. */
206 extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC;
208 /* Remove a link to a file unless it is special. */
210 extern int unlink_if_ordinary (const char *);
212 /* Allocate memory filled with spaces. Allocates using malloc. */
214 extern const char *spaces (int count);
216 /* Return the maximum error number for which strerror will return a
217 string. */
219 extern int errno_max (void);
221 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns
222 "EINVAL"). */
224 extern const char *strerrno (int);
226 /* Given the name of an errno value, return the value. */
228 extern int strtoerrno (const char *);
230 /* ANSI's strerror(), but more robust. */
232 extern char *xstrerror (int);
234 /* Return the maximum signal number for which strsignal will return a
235 string. */
237 extern int signo_max (void);
239 /* Return a signal message string for a signal number
240 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */
241 /* This is commented out as it can conflict with one in system headers.
242 We still document its existence though. */
244 /*extern const char *strsignal (int);*/
246 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns
247 "SIGHUP"). */
249 extern const char *strsigno (int);
251 /* Given the name of a signal, return its number. */
253 extern int strtosigno (const char *);
255 /* Register a function to be run by xexit. Returns 0 on success. */
257 extern int xatexit (void (*fn) (void));
259 /* Exit, calling all the functions registered with xatexit. */
261 extern void xexit (int status) ATTRIBUTE_NORETURN;
263 /* Set the program name used by xmalloc. */
265 extern void xmalloc_set_program_name (const char *);
267 /* Report an allocation failure. */
268 extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN;
270 /* Allocate memory without fail. If malloc fails, this will print a
271 message to stderr (using the name set by xmalloc_set_program_name,
272 if any) and then call xexit. */
274 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC;
276 /* Reallocate memory without fail. This works like xmalloc. Note,
277 realloc type functions are not suitable for attribute malloc since
278 they may return the same address across multiple calls. */
280 extern void *xrealloc (void *, size_t);
282 /* Allocate memory without fail and set it to zero. This works like
283 xmalloc. */
285 extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC;
287 /* Copy a string into a memory buffer without fail. */
289 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC;
291 /* Copy at most N characters from string into a buffer without fail. */
293 extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC;
295 /* Copy an existing memory buffer to a new memory buffer without fail. */
297 extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC;
299 /* Physical memory routines. Return values are in BYTES. */
300 extern double physmem_total (void);
301 extern double physmem_available (void);
304 /* These macros provide a K&R/C89/C++-friendly way of allocating structures
305 with nice encapsulation. The XDELETE*() macros are technically
306 superfluous, but provided here for symmetry. Using them consistently
307 makes it easier to update client code to use different allocators such
308 as new/delete and new[]/delete[]. */
310 /* Scalar allocators. */
312 #define XNEW(T) ((T *) xmalloc (sizeof (T)))
313 #define XCNEW(T) ((T *) xcalloc (1, sizeof (T)))
314 #define XDELETE(P) free ((void*) (P))
316 /* Array allocators. */
318 #define XNEWVEC(T, N) ((T *) xmalloc (sizeof (T) * (N)))
319 #define XCNEWVEC(T, N) ((T *) xcalloc ((N), sizeof (T)))
320 #define XRESIZEVEC(T, P, N) ((T *) xrealloc ((void *) (P), sizeof (T) * (N)))
321 #define XDELETEVEC(P) free ((void*) (P))
323 /* Allocators for variable-sized structures and raw buffers. */
325 #define XNEWVAR(T, S) ((T *) xmalloc ((S)))
326 #define XCNEWVAR(T, S) ((T *) xcalloc (1, (S)))
327 #define XRESIZEVAR(T, P, S) ((T *) xrealloc ((P), (S)))
329 /* Type-safe obstack allocator. */
331 #define XOBNEW(O, T) ((T *) obstack_alloc ((O), sizeof (T)))
332 #define XOBFINISH(O, T) ((T) obstack_finish ((O)))
334 /* hex character manipulation routines */
336 #define _hex_array_size 256
337 #define _hex_bad 99
338 extern const unsigned char _hex_value[_hex_array_size];
339 extern void hex_init (void);
340 #define hex_p(c) (hex_value (c) != _hex_bad)
341 /* If you change this, note well: Some code relies on side effects in
342 the argument being performed exactly once. */
343 #define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)])
345 /* Flags for pex_init. These are bits to be or'ed together. */
347 /* Record subprocess times, if possible. */
348 #define PEX_RECORD_TIMES 0x1
350 /* Use pipes for communication between processes, if possible. */
351 #define PEX_USE_PIPES 0x2
353 /* Save files used for communication between processes. */
354 #define PEX_SAVE_TEMPS 0x4
356 /* Prepare to execute one or more programs, with standard output of
357 each program fed to standard input of the next.
358 FLAGS As above.
359 PNAME The name of the program to report in error messages.
360 TEMPBASE A base name to use for temporary files; may be NULL to
361 use a random name.
362 Returns NULL on error. */
364 extern struct pex_obj *pex_init (int flags, const char *pname,
365 const char *tempbase);
367 /* Flags for pex_run. These are bits to be or'ed together. */
369 /* Last program in pipeline. Standard output of program goes to
370 OUTNAME, or, if OUTNAME is NULL, to standard output of caller. Do
371 not set this if you want to call pex_read_output. After this is
372 set, pex_run may no longer be called with the same struct
373 pex_obj. */
374 #define PEX_LAST 0x1
376 /* Search for program in executable search path. */
377 #define PEX_SEARCH 0x2
379 /* OUTNAME is a suffix. */
380 #define PEX_SUFFIX 0x4
382 /* Send program's standard error to standard output. */
383 #define PEX_STDERR_TO_STDOUT 0x8
385 /* Input file should be opened in binary mode. This flag is ignored
386 on Unix. */
387 #define PEX_BINARY_INPUT 0x10
389 /* Output file should be opened in binary mode. This flag is ignored
390 on Unix. For proper behaviour PEX_BINARY_INPUT and
391 PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using
392 PEX_BINARY_OUTPUT should be followed by a call using
393 PEX_BINARY_INPUT. */
394 #define PEX_BINARY_OUTPUT 0x20
396 /* Execute one program. Returns NULL on success. On error returns an
397 error string (typically just the name of a system call); the error
398 string is statically allocated.
400 OBJ Returned by pex_init.
402 FLAGS As above.
404 EXECUTABLE The program to execute.
406 ARGV NULL terminated array of arguments to pass to the program.
408 OUTNAME Sets the output file name as follows:
410 PEX_SUFFIX set (OUTNAME may not be NULL):
411 TEMPBASE parameter to pex_init not NULL:
412 Output file name is the concatenation of TEMPBASE
413 and OUTNAME.
414 TEMPBASE is NULL:
415 Output file name is a random file name ending in
416 OUTNAME.
417 PEX_SUFFIX not set:
418 OUTNAME not NULL:
419 Output file name is OUTNAME.
420 OUTNAME NULL, TEMPBASE not NULL:
421 Output file name is randomly chosen using
422 TEMPBASE.
423 OUTNAME NULL, TEMPBASE NULL:
424 Output file name is randomly chosen.
426 If PEX_LAST is not set, the output file name is the
427 name to use for a temporary file holding stdout, if
428 any (there will not be a file if PEX_USE_PIPES is set
429 and the system supports pipes). If a file is used, it
430 will be removed when no longer needed unless
431 PEX_SAVE_TEMPS is set.
433 If PEX_LAST is set, and OUTNAME is not NULL, standard
434 output is written to the output file name. The file
435 will not be removed. If PEX_LAST and PEX_SUFFIX are
436 both set, TEMPBASE may not be NULL.
438 ERRNAME If not NULL, this is the name of a file to which
439 standard error is written. If NULL, standard error of
440 the program is standard error of the caller.
442 ERR On an error return, *ERR is set to an errno value, or
443 to 0 if there is no relevant errno.
446 extern const char *pex_run (struct pex_obj *obj, int flags,
447 const char *executable, char * const *argv,
448 const char *outname, const char *errname,
449 int *err);
451 /* As for pex_run (), but takes an extra parameter to enable the
452 environment for the child process to be specified.
454 ENV The environment for the child process, specified as
455 an array of character pointers. Each element of the
456 array should point to a string of the form VAR=VALUE,
457 with the exception of the last element which must be
458 a null pointer.
461 extern const char *pex_run_in_environment (struct pex_obj *obj, int flags,
462 const char *executable,
463 char * const *argv,
464 char * const *env,
465 const char *outname,
466 const char *errname, int *err);
468 /* Return a `FILE' pointer FP for the standard input of the first
469 program in the pipeline; FP is opened for writing. You must have
470 passed `PEX_USE_PIPES' to the `pex_init' call that returned OBJ.
471 You must close FP yourself with `fclose' to indicate that the
472 pipeline's input is complete.
474 The file descriptor underlying FP is marked not to be inherited by
475 child processes.
477 This call is not supported on systems which do not support pipes;
478 it returns with an error. (We could implement it by writing a
479 temporary file, but then you would need to write all your data and
480 close FP before your first call to `pex_run' -- and that wouldn't
481 work on systems that do support pipes: the pipe would fill up, and
482 you would block. So there isn't any easy way to conceal the
483 differences between the two types of systems.)
485 If you call both `pex_write_input' and `pex_read_output', be
486 careful to avoid deadlock. If the output pipe fills up, so that
487 each program in the pipeline is waiting for the next to read more
488 data, and you fill the input pipe by writing more data to FP, then
489 there is no way to make progress: the only process that could read
490 data from the output pipe is you, but you are blocked on the input
491 pipe. */
493 extern FILE *pex_write_input (struct pex_obj *obj, int binary);
495 /* Return a stream for a temporary file to pass to the first program
496 in the pipeline as input. The file name is chosen as for pex_run.
497 pex_run closes the file automatically; don't close it yourself. */
499 extern FILE *pex_input_file (struct pex_obj *obj, int flags,
500 const char *in_name);
502 /* Return a stream for a pipe connected to the standard input of the
503 first program in the pipeline. You must have passed
504 `PEX_USE_PIPES' to `pex_init'. Close the returned stream
505 yourself. */
507 extern FILE *pex_input_pipe (struct pex_obj *obj, int binary);
509 /* Read the standard output of the last program to be executed.
510 pex_run can not be called after this. BINARY should be non-zero if
511 the file should be opened in binary mode; this is ignored on Unix.
512 Returns NULL on error. Don't call fclose on the returned FILE; it
513 will be closed by pex_free. */
515 extern FILE *pex_read_output (struct pex_obj *, int binary);
517 /* Return exit status of all programs in VECTOR. COUNT indicates the
518 size of VECTOR. The status codes in the vector are in the order of
519 the calls to pex_run. Returns 0 on error, 1 on success. */
521 extern int pex_get_status (struct pex_obj *, int count, int *vector);
523 /* Return times of all programs in VECTOR. COUNT indicates the size
524 of VECTOR. struct pex_time is really just struct timeval, but that
525 is not portable to all systems. Returns 0 on error, 1 on
526 success. */
528 struct pex_time
530 unsigned long user_seconds;
531 unsigned long user_microseconds;
532 unsigned long system_seconds;
533 unsigned long system_microseconds;
536 extern int pex_get_times (struct pex_obj *, int count,
537 struct pex_time *vector);
539 /* Clean up a pex_obj. */
541 extern void pex_free (struct pex_obj *);
543 /* Just execute one program. Return value is as for pex_run.
544 FLAGS Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT.
545 EXECUTABLE As for pex_run.
546 ARGV As for pex_run.
547 PNAME As for pex_init.
548 OUTNAME As for pex_run when PEX_LAST is set.
549 ERRNAME As for pex_run.
550 STATUS Set to exit status on success.
551 ERR As for pex_run.
554 extern const char *pex_one (int flags, const char *executable,
555 char * const *argv, const char *pname,
556 const char *outname, const char *errname,
557 int *status, int *err);
559 /* pexecute and pwait are the old pexecute interface, still here for
560 backward compatibility. Don't use these for new code. Instead,
561 use pex_init/pex_run/pex_get_status/pex_free, or pex_one. */
563 /* Definitions used by the pexecute routine. */
565 #define PEXECUTE_FIRST 1
566 #define PEXECUTE_LAST 2
567 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST)
568 #define PEXECUTE_SEARCH 4
569 #define PEXECUTE_VERBOSE 8
571 /* Execute a program. */
573 extern int pexecute (const char *, char * const *, const char *,
574 const char *, char **, char **, int);
576 /* Wait for pexecute to finish. */
578 extern int pwait (int, int *, int);
580 #if !HAVE_DECL_ASPRINTF
581 /* Like sprintf but provides a pointer to malloc'd storage, which must
582 be freed by the caller. */
584 extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2;
585 #endif
587 #if !HAVE_DECL_VASPRINTF
588 /* Like vsprintf but provides a pointer to malloc'd storage, which
589 must be freed by the caller. */
591 extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0);
592 #endif
594 #if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF
595 /* Like sprintf but prints at most N characters. */
596 extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3;
597 #endif
599 #if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF
600 /* Like vsprintf but prints at most N characters. */
601 extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0);
602 #endif
604 #if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP
605 /* Compare version strings. */
606 extern int strverscmp (const char *, const char *);
607 #endif
609 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
611 /* Drastically simplified alloca configurator. If we're using GCC,
612 we use __builtin_alloca; otherwise we use the C alloca. The C
613 alloca is always available. You can override GCC by defining
614 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is
615 also set/unset as it is often used to indicate whether code needs
616 to call alloca(0). */
617 extern void *C_alloca (size_t) ATTRIBUTE_MALLOC;
618 #undef alloca
619 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA
620 # define alloca(x) __builtin_alloca(x)
621 # undef C_ALLOCA
622 # define ASTRDUP(X) \
623 (__extension__ ({ const char *const libiberty_optr = (X); \
624 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \
625 char *const libiberty_nptr = (char *const) alloca (libiberty_len); \
626 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); }))
627 #else
628 # define alloca(x) C_alloca(x)
629 # undef USE_C_ALLOCA
630 # define USE_C_ALLOCA 1
631 # undef C_ALLOCA
632 # define C_ALLOCA 1
633 extern const char *libiberty_optr;
634 extern char *libiberty_nptr;
635 extern unsigned long libiberty_len;
636 # define ASTRDUP(X) \
637 (libiberty_optr = (X), \
638 libiberty_len = strlen (libiberty_optr) + 1, \
639 libiberty_nptr = (char *) alloca (libiberty_len), \
640 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len))
641 #endif
643 #ifdef __cplusplus
645 #endif
648 #endif /* ! defined (LIBIBERTY_H) */