1 /* Function declarations for libiberty. 2 3 Copyright 2001, 2002, 2005 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 /* 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 *" */ 93 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 109 110 /* A well-defined basename () that is always compiled in. */ 111 112 extern const char *lbasename (const char *); 113 114 /* A well-defined realpath () that is always compiled in. */ 115 116 extern char *lrealpath (const char *); 117 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. */ 121 122 extern char *concat (const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL; 123 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. */ 130 131 extern char *reconcat (char *, const char *, ...) ATTRIBUTE_MALLOC ATTRIBUTE_SENTINEL; 132 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. */ 136 137 extern unsigned long concat_length (const char *, ...) ATTRIBUTE_SENTINEL; 138 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. */ 143 144 extern char *concat_copy (char *, const char *, ...) ATTRIBUTE_SENTINEL; 145 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. */ 150 151 extern char *concat_copy2 (const char *, ...) ATTRIBUTE_SENTINEL; 152 153 /* This is the global area used by concat_copy2. */ 154 155 extern char *libiberty_concat_ptr; 156 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) 164 165 /* Check whether two file descriptors refer to the same file. */ 166 167 extern int fdmatch (int fd1, int fd2); 168 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 175 176 /* Get the working directory. The result is cached, so don't call 177 chdir() between calls to getpwd(). */ 178 179 extern char * getpwd (void); 180 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 189 190 /* Get the amount of time the process has run, in microseconds. */ 191 192 extern long get_run_time (void); 193 194 /* Generate a relocated path to some installation directory. Allocates 195 return value using malloc. */ 196 197 extern char *make_relative_prefix (const char *, const char *, 198 const char *) ATTRIBUTE_MALLOC; 199 200 /* LLVM LOCAL begin */ 201 /* Generate a relocated path to some installation directory without 202 attempting to follow any soft links. Allocates 203 return value using malloc. */ 204 205 extern char *make_relative_prefix_ignore_links (const char *, const char *, 206 const char *) ATTRIBUTE_MALLOC; 207 /* LLVM LOCAL end */ 208 209 /* Choose a temporary directory to use for scratch files. */ 210 211 extern char *choose_temp_base (void) ATTRIBUTE_MALLOC; 212 213 /* Return a temporary file name or NULL if unable to create one. */ 214 215 extern char *make_temp_file (const char *) ATTRIBUTE_MALLOC; 216 217 /* Remove a link to a file unless it is special. */ 218 219 extern int unlink_if_ordinary (const char *); 220 221 /* Allocate memory filled with spaces. Allocates using malloc. */ 222 223 extern const char *spaces (int count); 224 225 /* Return the maximum error number for which strerror will return a 226 string. */ 227 228 extern int errno_max (void); 229 230 /* Return the name of an errno value (e.g., strerrno (EINVAL) returns 231 "EINVAL"). */ 232 233 extern const char *strerrno (int); 234 235 /* Given the name of an errno value, return the value. */ 236 237 extern int strtoerrno (const char *); 238 239 /* ANSI's strerror(), but more robust. */ 240 241 extern char *xstrerror (int); 242 243 /* Return the maximum signal number for which strsignal will return a 244 string. */ 245 246 extern int signo_max (void); 247 248 /* Return a signal message string for a signal number 249 (e.g., strsignal (SIGHUP) returns something like "Hangup"). */ 250 /* This is commented out as it can conflict with one in system headers. 251 We still document its existence though. */ 252 253 /*extern const char *strsignal (int);*/ 254 255 /* Return the name of a signal number (e.g., strsigno (SIGHUP) returns 256 "SIGHUP"). */ 257 258 extern const char *strsigno (int); 259 260 /* Given the name of a signal, return its number. */ 261 262 extern int strtosigno (const char *); 263 264 /* Register a function to be run by xexit. Returns 0 on success. */ 265 266 extern int xatexit (void (*fn) (void)); 267 268 /* Exit, calling all the functions registered with xatexit. */ 269 270 extern void xexit (int status) ATTRIBUTE_NORETURN; 271 272 /* Set the program name used by xmalloc. */ 273 274 extern void xmalloc_set_program_name (const char *); 275 276 /* Report an allocation failure. */ 277 extern void xmalloc_failed (size_t) ATTRIBUTE_NORETURN; 278 279 /* Allocate memory without fail. If malloc fails, this will print a 280 message to stderr (using the name set by xmalloc_set_program_name, 281 if any) and then call xexit. */ 282 283 extern void *xmalloc (size_t) ATTRIBUTE_MALLOC; 284 285 /* Reallocate memory without fail. This works like xmalloc. Note, 286 realloc type functions are not suitable for attribute malloc since 287 they may return the same address across multiple calls. */ 288 289 extern void *xrealloc (void *, size_t); 290 291 /* Allocate memory without fail and set it to zero. This works like 292 xmalloc. */ 293 294 extern void *xcalloc (size_t, size_t) ATTRIBUTE_MALLOC; 295 296 /* Copy a string into a memory buffer without fail. */ 297 298 extern char *xstrdup (const char *) ATTRIBUTE_MALLOC; 299 300 /* Copy at most N characters from string into a buffer without fail. */ 301 302 extern char *xstrndup (const char *, size_t) ATTRIBUTE_MALLOC; 303 304 /* Copy an existing memory buffer to a new memory buffer without fail. */ 305 306 extern void *xmemdup (const void *, size_t, size_t) ATTRIBUTE_MALLOC; 307 308 /* APPLE LOCAL begin retune gc params 6124839 */ 309 extern unsigned int ncpu_available (void); 310 /* APPLE LOCAL end retune gc params 6124839 */ 311 312 /* Physical memory routines. Return values are in BYTES. */ 313 extern double physmem_total (void); 314 extern double physmem_available (void); 315 316 317 /* These macros provide a K&R/C89/C++-friendly way of allocating structures 318 with nice encapsulation. The XDELETE*() macros are technically 319 superfluous, but provided here for symmetry. Using them consistently 320 makes it easier to update client code to use different allocators such 321 as new/delete and new[]/delete[]. */ 322 323 /* Scalar allocators. */ 324 325 #define XNEW(T) ((T *) xmalloc (sizeof (T))) 326 #define XCNEW(T) ((T *) xcalloc (1, sizeof (T))) 327 #define XDELETE(P) free ((void*) (P)) 328 329 /* Array allocators. */ 330 331 #define XNEWVEC(T, N) ((T *) xmalloc (sizeof (T) * (N))) 332 #define XCNEWVEC(T, N) ((T *) xcalloc ((N), sizeof (T))) 333 #define XRESIZEVEC(T, P, N) ((T *) xrealloc ((void *) (P), sizeof (T) * (N))) 334 #define XDELETEVEC(P) free ((void*) (P)) 335 336 /* Allocators for variable-sized structures and raw buffers. */ 337 338 #define XNEWVAR(T, S) ((T *) xmalloc ((S))) 339 #define XCNEWVAR(T, S) ((T *) xcalloc (1, (S))) 340 #define XRESIZEVAR(T, P, S) ((T *) xrealloc ((P), (S))) 341 342 /* Type-safe obstack allocator. */ 343 344 #define XOBNEW(O, T) ((T *) obstack_alloc ((O), sizeof (T))) 345 #define XOBFINISH(O, T) ((T) obstack_finish ((O))) 346 347 /* hex character manipulation routines */ 348 349 #define _hex_array_size 256 350 #define _hex_bad 99 351 extern const unsigned char _hex_value[_hex_array_size]; 352 extern void hex_init (void); 353 #define hex_p(c) (hex_value (c) != _hex_bad) 354 /* If you change this, note well: Some code relies on side effects in 355 the argument being performed exactly once. */ 356 #define hex_value(c) ((unsigned int) _hex_value[(unsigned char) (c)]) 357 358 /* Flags for pex_init. These are bits to be or'ed together. */ 359 360 /* Record subprocess times, if possible. */ 361 #define PEX_RECORD_TIMES 0x1 362 363 /* Use pipes for communication between processes, if possible. */ 364 #define PEX_USE_PIPES 0x2 365 366 /* Save files used for communication between processes. */ 367 #define PEX_SAVE_TEMPS 0x4 368 369 /* Prepare to execute one or more programs, with standard output of 370 each program fed to standard input of the next. 371 FLAGS As above. 372 PNAME The name of the program to report in error messages. 373 TEMPBASE A base name to use for temporary files; may be NULL to 374 use a random name. 375 Returns NULL on error. */ 376 377 extern struct pex_obj *pex_init (int flags, const char *pname, 378 const char *tempbase); 379 380 /* Flags for pex_run. These are bits to be or'ed together. */ 381 382 /* Last program in pipeline. Standard output of program goes to 383 OUTNAME, or, if OUTNAME is NULL, to standard output of caller. Do 384 not set this if you want to call pex_read_output. After this is 385 set, pex_run may no longer be called with the same struct 386 pex_obj. */ 387 #define PEX_LAST 0x1 388 389 /* Search for program in executable search path. */ 390 #define PEX_SEARCH 0x2 391 392 /* OUTNAME is a suffix. */ 393 #define PEX_SUFFIX 0x4 394 395 /* Send program's standard error to standard output. */ 396 #define PEX_STDERR_TO_STDOUT 0x8 397 398 /* Input file should be opened in binary mode. This flag is ignored 399 on Unix. */ 400 #define PEX_BINARY_INPUT 0x10 401 402 /* Output file should be opened in binary mode. This flag is ignored 403 on Unix. For proper behaviour PEX_BINARY_INPUT and 404 PEX_BINARY_OUTPUT have to match appropriately--i.e., a call using 405 PEX_BINARY_OUTPUT should be followed by a call using 406 PEX_BINARY_INPUT. */ 407 #define PEX_BINARY_OUTPUT 0x20 408 409 /* Execute one program. Returns NULL on success. On error returns an 410 error string (typically just the name of a system call); the error 411 string is statically allocated. 412 413 OBJ Returned by pex_init. 414 415 FLAGS As above. 416 417 EXECUTABLE The program to execute. 418 419 ARGV NULL terminated array of arguments to pass to the program. 420 421 OUTNAME Sets the output file name as follows: 422 423 PEX_SUFFIX set (OUTNAME may not be NULL): 424 TEMPBASE parameter to pex_init not NULL: 425 Output file name is the concatenation of TEMPBASE 426 and OUTNAME. 427 TEMPBASE is NULL: 428 Output file name is a random file name ending in 429 OUTNAME. 430 PEX_SUFFIX not set: 431 OUTNAME not NULL: 432 Output file name is OUTNAME. 433 OUTNAME NULL, TEMPBASE not NULL: 434 Output file name is randomly chosen using 435 TEMPBASE. 436 OUTNAME NULL, TEMPBASE NULL: 437 Output file name is randomly chosen. 438 439 If PEX_LAST is not set, the output file name is the 440 name to use for a temporary file holding stdout, if 441 any (there will not be a file if PEX_USE_PIPES is set 442 and the system supports pipes). If a file is used, it 443 will be removed when no longer needed unless 444 PEX_SAVE_TEMPS is set. 445 446 If PEX_LAST is set, and OUTNAME is not NULL, standard 447 output is written to the output file name. The file 448 will not be removed. If PEX_LAST and PEX_SUFFIX are 449 both set, TEMPBASE may not be NULL. 450 451 ERRNAME If not NULL, this is the name of a file to which 452 standard error is written. If NULL, standard error of 453 the program is standard error of the caller. 454 455 ERR On an error return, *ERR is set to an errno value, or 456 to 0 if there is no relevant errno. 457 */ 458 459 extern const char *pex_run (struct pex_obj *obj, int flags, 460 const char *executable, char * const *argv, 461 const char *outname, const char *errname, 462 int *err); 463 464 /* As for pex_run (), but takes an extra parameter to enable the 465 environment for the child process to be specified. 466 467 ENV The environment for the child process, specified as 468 an array of character pointers. Each element of the 469 array should point to a string of the form VAR=VALUE, 470 with the exception of the last element which must be 471 a null pointer. 472 */ 473 474 extern const char *pex_run_in_environment (struct pex_obj *obj, int flags, 475 const char *executable, 476 char * const *argv, 477 char * const *env, 478 const char *outname, 479 const char *errname, int *err); 480 481 /* Return a stream for a temporary file to pass to the first program 482 in the pipeline as input. The file name is chosen as for pex_run. 483 pex_run closes the file automatically; don't close it yourself. */ 484 485 extern FILE *pex_input_file (struct pex_obj *obj, int flags, 486 const char *in_name); 487 488 /* Return a stream for a pipe connected to the standard input of the 489 first program in the pipeline. You must have passed 490 `PEX_USE_PIPES' to `pex_init'. Close the returned stream 491 yourself. */ 492 493 extern FILE *pex_input_pipe (struct pex_obj *obj, int binary); 494 495 /* Read the standard output of the last program to be executed. 496 pex_run can not be called after this. BINARY should be non-zero if 497 the file should be opened in binary mode; this is ignored on Unix. 498 Returns NULL on error. Don't call fclose on the returned FILE; it 499 will be closed by pex_free. */ 500 501 extern FILE *pex_read_output (struct pex_obj *, int binary); 502 503 /* Return exit status of all programs in VECTOR. COUNT indicates the 504 size of VECTOR. The status codes in the vector are in the order of 505 the calls to pex_run. Returns 0 on error, 1 on success. */ 506 507 extern int pex_get_status (struct pex_obj *, int count, int *vector); 508 509 /* Return times of all programs in VECTOR. COUNT indicates the size 510 of VECTOR. struct pex_time is really just struct timeval, but that 511 is not portable to all systems. Returns 0 on error, 1 on 512 success. */ 513 514 struct pex_time 515 { 516 unsigned long user_seconds; 517 unsigned long user_microseconds; 518 unsigned long system_seconds; 519 unsigned long system_microseconds; 520 }; 521 522 extern int pex_get_times (struct pex_obj *, int count, 523 struct pex_time *vector); 524 525 /* Clean up a pex_obj. */ 526 527 extern void pex_free (struct pex_obj *); 528 529 /* Just execute one program. Return value is as for pex_run. 530 FLAGS Combination of PEX_SEARCH and PEX_STDERR_TO_STDOUT. 531 EXECUTABLE As for pex_run. 532 ARGV As for pex_run. 533 PNAME As for pex_init. 534 OUTNAME As for pex_run when PEX_LAST is set. 535 ERRNAME As for pex_run. 536 STATUS Set to exit status on success. 537 ERR As for pex_run. 538 */ 539 540 extern const char *pex_one (int flags, const char *executable, 541 char * const *argv, const char *pname, 542 const char *outname, const char *errname, 543 int *status, int *err); 544 545 /* pexecute and pwait are the old pexecute interface, still here for 546 backward compatibility. Don't use these for new code. Instead, 547 use pex_init/pex_run/pex_get_status/pex_free, or pex_one. */ 548 549 /* Definitions used by the pexecute routine. */ 550 551 #define PEXECUTE_FIRST 1 552 #define PEXECUTE_LAST 2 553 #define PEXECUTE_ONE (PEXECUTE_FIRST + PEXECUTE_LAST) 554 #define PEXECUTE_SEARCH 4 555 #define PEXECUTE_VERBOSE 8 556 557 /* Execute a program. */ 558 559 extern int pexecute (const char *, char * const *, const char *, 560 const char *, char **, char **, int); 561 562 /* Wait for pexecute to finish. */ 563 564 extern int pwait (int, int *, int); 565 566 #if !HAVE_DECL_ASPRINTF 567 /* Like sprintf but provides a pointer to malloc'd storage, which must 568 be freed by the caller. */ 569 570 extern int asprintf (char **, const char *, ...) ATTRIBUTE_PRINTF_2; 571 #endif 572 573 #if !HAVE_DECL_VASPRINTF 574 /* Like vsprintf but provides a pointer to malloc'd storage, which 575 must be freed by the caller. */ 576 577 extern int vasprintf (char **, const char *, va_list) ATTRIBUTE_PRINTF(2,0); 578 #endif 579 580 #if defined(HAVE_DECL_SNPRINTF) && !HAVE_DECL_SNPRINTF 581 /* Like sprintf but prints at most N characters. */ 582 extern int snprintf (char *, size_t, const char *, ...) ATTRIBUTE_PRINTF_3; 583 #endif 584 585 #if defined(HAVE_DECL_VSNPRINTF) && !HAVE_DECL_VSNPRINTF 586 /* Like vsprintf but prints at most N characters. */ 587 extern int vsnprintf (char *, size_t, const char *, va_list) ATTRIBUTE_PRINTF(3,0); 588 #endif 589 590 #if defined(HAVE_DECL_STRVERSCMP) && !HAVE_DECL_STRVERSCMP 591 /* Compare version strings. */ 592 extern int strverscmp (const char *, const char *); 593 #endif 594 595 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0])) 596 597 /* Drastically simplified alloca configurator. If we're using GCC, 598 we use __builtin_alloca; otherwise we use the C alloca. The C 599 alloca is always available. You can override GCC by defining 600 USE_C_ALLOCA yourself. The canonical autoconf macro C_ALLOCA is 601 also set/unset as it is often used to indicate whether code needs 602 to call alloca(0). */ 603 extern void *C_alloca (size_t) ATTRIBUTE_MALLOC; 604 #undef alloca 605 #if GCC_VERSION >= 2000 && !defined USE_C_ALLOCA 606 # define alloca(x) __builtin_alloca(x) 607 # undef C_ALLOCA 608 # define ASTRDUP(X) \ 609 (__extension__ ({ const char *const libiberty_optr = (X); \ 610 const unsigned long libiberty_len = strlen (libiberty_optr) + 1; \ 611 char *const libiberty_nptr = (char *const) alloca (libiberty_len); \ 612 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len); })) 613 #else 614 # define alloca(x) C_alloca(x) 615 # undef USE_C_ALLOCA 616 # define USE_C_ALLOCA 1 617 # undef C_ALLOCA 618 # define C_ALLOCA 1 619 extern const char *libiberty_optr; 620 extern char *libiberty_nptr; 621 extern unsigned long libiberty_len; 622 # define ASTRDUP(X) \ 623 (libiberty_optr = (X), \ 624 libiberty_len = strlen (libiberty_optr) + 1, \ 625 libiberty_nptr = (char *) alloca (libiberty_len), \ 626 (char *) memcpy (libiberty_nptr, libiberty_optr, libiberty_len)) 627 #endif 628 629 #ifdef __cplusplus 630 } 631 #endif 632 633 634 #endif /* ! defined (LIBIBERTY_H) */ 635