GNU libiberty

Node: Functions, Next: Obstacks, Previous: Overview, Up: Top

Function, Variable, and Macro Listing.

void* alloca (size_t size) Replacement

This function allocates memory which will be automatically reclaimed after the procedure exits. The libiberty implementation does not free the memory immediately but will do so eventually during subsequent calls to this function. Memory is allocated using xmalloc under normal circumstances.
The header file alloca-conf.h can be used in conjunction with the GNU Autoconf test AC_FUNC_ALLOCA to test for and properly make available this function. The AC_FUNC_ALLOCA test requires that client code use a block of preprocessor code to be safe (see the Autoconf manual for more); this header incorporates that logic and more, including the possibility of a GCC built-in function.

int asprintf (char **resptr, const char *format, ...) Extension

Like sprintf, but instead of passing a pointer to a buffer, you pass a pointer to a pointer. This function will compute the size of the buffer needed, allocate memory with malloc, and store a pointer to the allocated memory in *resptr. The value returned is the same as sprintf would return. If memory could not be allocated, zero is returned and NULL is stored in *resptr.

int atexit (void (*f)()) Supplemental

Causes function f to be called at exit. Returns 0.

char* basename (const char *name) Supplemental

Returns a pointer to the last component of pathname name. Behavior is undefined if the pathname ends in a directory separator.

int bcmp (char *x, char *y, int count) Supplemental

Compares the first count bytes of two areas of memory. Returns zero if they are the same, nonzero otherwise. Returns zero if count is zero. A nonzero result only indicates a difference, it does not indicate any sorting order (say, by having a positive result mean x sorts before y).

void bcopy (char *in, char *out, int length) Supplemental

Copies length bytes from memory region in to region out. The use of bcopy is deprecated in new programs.

void* bsearch (const void *key, const void *base, size_t nmemb, size_t size, int (*compar)(const void *, const void *)) Supplemental

Performs a search over an array of nmemb elements pointed to by base for a member that matches the object pointed to by key. The size of each member is specified by size. The array contents should be sorted in ascending order according to the compar comparison function. This routine should take two arguments pointing to the key and to an array member, in that order, and should return an integer less than, equal to, or greater than zero if the key object is respectively less than, matching, or greater than the array member.

char** buildargv (char *sp) Extension

Given a pointer to a string, parse the string extracting fields separated by whitespace and optionally enclosed within either single or double quotes (which are stripped off), and build a vector of pointers to copies of the string for each field. The input string remains unchanged. The last element of the vector is followed by a NULL element.
All of the memory for the pointer array and copies of the string is obtained from malloc. All of the memory can be returned to the system with the single function call freeargv, which takes the returned result of buildargv, as it's argument.
Returns a pointer to the argument vector if successful. Returns NULL if sp is NULL or if there is insufficient memory to complete building the argument vector.
If the input is a null string (as opposed to a NULL pointer), then buildarg returns an argument vector that has one arg, a null string.

void bzero (char *mem, int count) Supplemental

Zeros count bytes starting at mem. Use of this function is deprecated in favor of memset.

void* calloc (size_t nelem, size_t elsize) Supplemental

Uses malloc to allocate storage for nelem objects of elsize bytes each, then zeros the memory.

char* choose_temp_base (void) Extension

Return a prefix for temporary file names or NULL if unable to find one. The current directory is chosen if all else fails so the program is exited if a temporary directory can't be found (mktemp fails). The buffer for the result is obtained with xmalloc.
This function is provided for backwards compatability only. Its use is not recommended.

char* choose_tmpdir () Replacement

Returns a pointer to a directory path suitable for creating temporary files in.

long clock (void) Supplemental

Returns an approximation of the CPU time used by the process as a clock_t; divide this number by CLOCKS_PER_SEC to get the number of seconds used.

char* concat (const char *s1, const char *s2, ..., NULL) Extension

Concatenate zero or more of strings and return the result in freshly xmalloced memory. Returns NULL if insufficient memory is available. The argument list is terminated by the first NULL pointer encountered. Pointers to empty strings are ignored.

char** dupargv (char **vector) Extension

Duplicate an argument vector. Simply scans through vector, duplicating each argument until the terminating NULL is found. Returns a pointer to the argument vector if successful. Returns NULL if there is insufficient memory to complete building the argument vector.

int errno_max (void) Extension

Returns the maximum errno value for which a corresponding symbolic name or message is available. Note that in the case where we use the sys_errlist supplied by the system, it is possible for there to be more symbolic names than messages, or vice versa. In fact, the manual page for perror(3C) explicitly warns that one should check the size of the table (sys_nerr) before indexing it, since new error codes may be added to the system before they are added to the table. Thus sys_nerr might be smaller than value implied by the largest errno value defined in <errno.h>.
We return the maximum value that can be used to obtain a meaningful symbolic name or message.

int fdmatch (int fd1, int fd2) Extension

Check to see if two open file descriptors refer to the same file. This is useful, for example, when we have an open file descriptor for an unnamed file, and the name of a file that we believe to correspond to that fd. This can happen when we are exec'd with an already open file (stdout for example) or from the SVR4 /proc calls that return open file descriptors for mapped address spaces. All we have to do is open the file by name and check the two file descriptors for a match, which is done by comparing major and minor device numbers and inode numbers.

int ffs (int valu) Supplemental

Find the first (least significant) bit set in valu. Bits are numbered from right to left, starting with bit 1 (corresponding to the value 1). If valu is zero, zero is returned.

int fnmatch (const char *pattern, const char *string, int flags) Replacement

Matches string against pattern, returning zero if it matches, FNM_NOMATCH if not. pattern may contain the wildcards ? to match any one character, * to match any zero or more characters, or a set of alternate characters in square brackets, like [a-gt8], which match one character (a through g, or t, or 8, in this example) if that one character is in the set. A set may be inverted (i.e., match anything except what's in the set) by giving ^ or ! as the first character in the set. To include those characters in the set, list them as anything other than the first character of the set. To include a dash in the set, list it last in the set. A backslash character makes the following character not special, so for example you could match against a literal asterisk with \*. To match a literal backslash, use \\.
flags controls various aspects of the matching process, and is a boolean OR of zero or more of the following values (defined in <fnmatch.h>):

FNM_PATHNAME
FNM_FILE_NAME
string is assumed to be a path name. No wildcard will ever match /.
FNM_NOESCAPE
Do not interpret backslashes as quoting the following special character.
FNM_PERIOD
A leading period (at the beginning of string, or if FNM_PATHNAME after a slash) is not matched by * or ? but must be matched explicitly.
FNM_LEADING_DIR
Means that string also matches pattern if some initial part of string matches, and is followed by / and zero or more characters. For example, foo* would match either foobar or foobar/grill.
FNM_CASEFOLD
Ignores case when performing the comparison.

void freeargv (char **vector) Extension

Free an argument vector that was built using buildargv. Simply scans through vector, freeing the memory for each argument until the terminating NULL is found, and then frees vector itself.

long get_run_time (void) Replacement

Returns the time used so far, in microseconds. If possible, this is the time used by this process, else it is the elapsed time since the process started.

char* getcwd (char *pathname, int len) Supplemental

Copy the absolute pathname for the current working directory into pathname, which is assumed to point to a buffer of at least len bytes, and return a pointer to the buffer. If the current directory's path doesn't fit in len characters, the result is NULL and errno is set. If pathname is a null pointer, getcwd will obtain len bytes of space using malloc.

int getpagesize (void) Supplemental

Returns the number of bytes in a page of memory. This is the granularity of many of the system memory management routines. No guarantee is made as to whether or not it is the same as the basic memory management hardware page size.

char* getpwd (void) Supplemental

Returns the current working directory. This implementation caches the result on the assumption that the process will not call chdir between calls to getpwd.

char* index (char *s, int c) Supplemental

Returns a pointer to the first occurrence of the character c in the string s, or NULL if not found. The use of index is deprecated in new programs in favor of strchr.

void insque (struct qelem *elem, struct qelem *pred) Supplemental

void remque (struct qelem *elem) Supplemental

Routines to manipulate queues built from doubly linked lists. The insque routine inserts elem in the queue immediately after pred. The remque routine removes elem from its containing queue. These routines expect to be passed pointers to structures which have as their first members a forward pointer and a back pointer, like this prototype (although no prototype is provided):
struct qelem { struct qelem *q_forw; struct qelem *q_back; char q_data[]; };

const char* lbasename (const char *name) Replacement

Given a pointer to a string containing a typical pathname (/usr/src/cmd/ls/ls.c for example), returns a pointer to the last component of the pathname (ls.c in this case). The returned pointer is guaranteed to lie within the original string. This latter fact is not true of many vendor C libraries, which return special strings or modify the passed strings for particular input.
In particular, the empty string returns the same empty string, and a path ending in / returns the empty string after it.

char* make_temp_file (const char *suffix) Replacement

Return a temporary file name (as a string) or NULL if unable to create one. suffix is a suffix to append to the file name. The string is malloced, and the temporary file has been created.

void* memchr (const void *s, int c, size_t n) Supplemental

This function searches memory starting at *s for the character c. The search only ends with the first occurrence of c, or after length characters; in particular, a null character does not terminate the search. If the character c is found within length characters of *s, a pointer to the character is returned. If c is not found, then NULL is returned.

int memcmp (const void *x, const void *y, size_t count) Supplemental

Compares the first count bytes of two areas of memory. Returns zero if they are the same, a value less than zero if x is lexically less than y, or a value greater than zero if x is lexically greater than y. Note that lexical order is determined as if comparing unsigned char arrays.

void* memcpy (void *out, const void *in, size_t length) Supplemental

Copies length bytes from memory region in to region out. Returns a pointer to out.

void* memmove (void *from, const void *to, size_t count) Supplemental

Copies count bytes from memory area from to memory area to, returning a pointer to to.

void* memset (void *s, int c, size_t count) Supplemental

Sets the first count bytes of s to the constant byte c, returning a pointer to s.

int mkstemps (char *template, int suffix_len) Replacement

Generate a unique temporary file name from template. template has the form:
path/ccXXXXXXsuffix

suffix_len tells us how long suffix is (it can be zero length). The last six characters of template before suffix must be XXXXXX; they are replaced with a string that makes the filename unique. Returns a file descriptor open on the file for reading and writing.

int pexecute (const char *program, char * const *argv, const char *this_pname, const char *temp_base, char **errmsg_fmt, char **errmsg_arg, int flags) Extension

Executes a program.
program and argv are the arguments to execv/execvp.
this_pname is name of the calling program (i.e., argv[0]).
temp_base is the path name, sans suffix, of a temporary file to use if needed. This is currently only needed for MS-DOS ports that don't use go32 (do any still exist?). Ports that don't need it can pass NULL.
(flags & PEXECUTE_SEARCH) is non-zero if PATH should be searched (??? It's not clear that GCC passes this flag correctly). (flags& PEXECUTE_FIRST) is nonzero for the first process in chain. (flags & PEXECUTE_FIRST) is nonzero for the last process in chain. The first/last flags could be simplified to only mark the last of a chain of processes but that requires the caller to always mark the last one (and not give up early if some error occurs). It's more robust to require the caller to mark both ends of the chain.
The result is the pid on systems like Unix where we fork/exec and on systems like WIN32 and OS/2 where we use spawn. It is up to the caller to wait for the child.
The result is the WEXITSTATUS on systems like MS-DOS where we spawn and wait for the child here.
Upon failure, errmsg_fmt and errmsg_arg are set to the text of the error message with an optional argument (if not needed, errmsg_arg is set to NULL), and -1 is returned. errno is available to the caller to use.

void psignal (unsigned signo, char *message) Supplemental

Print message to the standard error, followed by a colon, followed by the description of the signal specified by signo, followed by a newline.

int putenv (const char *string) Supplemental

Uses setenv or unsetenv to put string into the environment or remove it. If string is of the form name=value the string is added; if no = is present the name is unset/removed.

int pwait (int pid, int *status, int flags) Extension

Waits for a program started by pexecute to finish.
pid is the process id of the task to wait for. status is the `status' argument to wait. flags is currently unused (allows future enhancement without breaking upward compatibility). Pass 0 for now.
The result is the pid of the child reaped, or -1 for failure (errno says why).
On systems that don't support waiting for a particular child, pid is ignored. On systems like MS-DOS that don't really multitask pwait is just a mechanism to provide a consistent interface for the caller.

long int random (void) Supplement

void srandom (unsigned int seed) Supplement

void* initstate (unsigned int seed, void *arg_state, unsigned long n) Supplement

void* setstate (void *arg_state) Supplement

Random number functions. random returns a random number in the range 0 to LONG_MAX. srandom initializes the random number generator to some starting point determined by seed (else, the values returned by random are always the same for each run of the program). initstate and setstate allow fine-grained control over the state of the random number generator.

char* reconcat (char *optr, const char *s1, ..., NULL) Extension

Same as concat, except that if optr is not NULL it is freed after the string is created. This is intended to be useful when you're extending an existing string or building up a string in a loop:
str = reconcat (str, "pre-", str, NULL);

int rename (const char *old, const char *new) Supplemental

Renames a file from old to new. If new already exists, it is removed.

char* rindex (const char *s, int c) Supplemental

Returns a pointer to the last occurrence of the character c in the string s, or NULL if not found. The use of rindex is deprecated in new programs in favor of strrchr.

int setenv (const char *name, const char *value, int overwrite) Supplemental

void unsetenv (const char *name) Supplemental

setenv adds name to the environment with value value. If the name was already present in the environment, the new value will be stored only if overwrite is nonzero. The companion unsetenv function removes name from the environment. This implementation is not safe for multithreaded code.

int signo_max (void) Extension

Returns the maximum signal value for which a corresponding symbolic name or message is available. Note that in the case where we use the sys_siglist supplied by the system, it is possible for there to be more symbolic names than messages, or vice versa. In fact, the manual page for psignal(3b) explicitly warns that one should check the size of the table (NSIG) before indexing it, since new signal codes may be added to the system before they are added to the table. Thus NSIG might be smaller than value implied by the largest signo value defined in <signal.h>.
We return the maximum value that can be used to obtain a meaningful symbolic name or message.

int sigsetmask (int set) Supplemental

Sets the signal mask to the one provided in set and returns the old mask (which, for libiberty's implementation, will always be the value 1).

char* spaces (int count) Extension

Returns a pointer to a memory region filled with the specified number of spaces and null terminated. The returned pointer is valid until at least the next call.

int strcasecmp (const char *s1, const char *s2) Supplemental

A case-insensitive strcmp.

char* strchr (const char *s, int c) Supplemental

Returns a pointer to the first occurrence of the character c in the string s, or NULL if not found. If c is itself the null character, the results are undefined.

char* strdup (const char *s) Supplemental

Returns a pointer to a copy of s in memory obtained from malloc, or NULL if insufficient memory was available.

const char* strerrno (int errnum) Replacement

Given an error number returned from a system call (typically returned in errno), returns a pointer to a string containing the symbolic name of that error number, as found in <errno.h>.
If the supplied error number is within the valid range of indices for symbolic names, but no name is available for the particular error number, then returns the string Error num, where num is the error number.
If the supplied error number is not within the range of valid indices, then returns NULL.
The contents of the location pointed to are only guaranteed to be valid until the next call to strerrno.

char* strerror (int errnoval) Supplemental

Maps an errno number to an error message string, the contents of which are implementation defined. On systems which have the external variables sys_nerr and sys_errlist, these strings will be the same as the ones used by perror.
If the supplied error number is within the valid range of indices for the sys_errlist, but no message is available for the particular error number, then returns the string Error num, where num is the error number.
If the supplied error number is not a valid index into sys_errlist, returns NULL.
The returned string is only guaranteed to be valid only until the next call to strerror.

int strncasecmp (const char *s1, const char *s2) Supplemental

A case-insensitive strncmp.

int strncmp (const char *s1, const char *s2, size_t n) Supplemental

Compares the first n bytes of two strings, returning a value as strcmp.

char* strrchr (const char *s, int c) Supplemental

Returns a pointer to the last occurrence of the character c in the string s, or NULL if not found. If c is itself the null character, the results are undefined.

const char * strsignal (int signo) Supplemental

Maps an signal number to an signal message string, the contents of which are implementation defined. On systems which have the external variable sys_siglist, these strings will be the same as the ones used by psignal().
If the supplied signal number is within the valid range of indices for the sys_siglist, but no message is available for the particular signal number, then returns the string Signal num, where num is the signal number.
If the supplied signal number is not a valid index into sys_siglist, returns NULL.
The returned string is only guaranteed to be valid only until the next call to strsignal.

const char* strsigno (int signo) Extension

Given an signal number, returns a pointer to a string containing the symbolic name of that signal number, as found in <signal.h>.
If the supplied signal number is within the valid range of indices for symbolic names, but no name is available for the particular signal number, then returns the string Signal num, where num is the signal number.
If the supplied signal number is not within the range of valid indices, then returns NULL.
The contents of the location pointed to are only guaranteed to be valid until the next call to strsigno.

char* strstr (const char *string, const char *sub) Supplemental

This function searches for the substring sub in the string string, not including the terminating null characters. A pointer to the first occurrence of sub is returned, or NULL if the substring is absent. If sub points to a string with zero length, the function returns string.

double strtod (const char *string, char **endptr) Supplemental

This ISO C function converts the initial portion of string to a double. If endptr is not NULL, a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr. If no conversion is performed, zero is returned and the value of string is stored in the location referenced by endptr.

int strtoerrno (const char *name) Extension

Given the symbolic name of a error number (e.g., EACCES), map it to an errno value. If no translation is found, returns 0.

long int strtol (const char *string, char **endptr, int base) Supplemental

unsigned long int strtoul (const char *string, char **endptr, int base) Supplemental

The strtol function converts the string in string to a long integer value according to the given base, which must be between 2 and 36 inclusive, or be the special value 0. If base is 0, strtol will look for the prefixes 0 and 0x to indicate bases 8 and 16, respectively, else default to base 10. When the base is 16 (either explicitly or implicitly), a prefix of 0x is allowed. The handling of endptr is as that of strtod above. The strtoul function is the same, except that the converted value is unsigned.

int strtosigno (const char *name) Extension

Given the symbolic name of a signal, map it to a signal number. If no translation is found, returns 0.

char* tmpnam (char *s) Supplemental

This function attempts to create a name for a temporary file, which will be a valid file name yet not exist when tmpnam checks for it. s must point to a buffer of at least L_tmpnam bytes, or be NULL. Use of this function creates a security risk, and it must not be used in new projects. Use mkstemp instead.

int vasprintf (char **resptr, const char *format, va_list args) Extension

Like vsprintf, but instead of passing a pointer to a buffer, you pass a pointer to a pointer. This function will compute the size of the buffer needed, allocate memory with malloc, and store a pointer to the allocated memory in *resptr. The value returned is the same as vsprintf would return. If memory could not be allocated, zero is returned and NULL is stored in *resptr.

int vfork (void) Supplemental

Emulates vfork by calling fork and returning its value.

int vprintf (const char *format, va_list ap) Supplemental

int vfprintf (FILE *stream, const char *format, va_list ap) Supplemental

int vsprintf (char *str, const char *format, va_list ap) Supplemental

These functions are the same as printf, fprintf, and sprintf, respectively, except that they are called with a va_list instead of a variable number of arguments. Note that they do not call va_end; this is the application's responsibility. In libiberty they are implemented in terms of the nonstandard but common function _doprnt.

int waitpid (int pid, int *status, int) Supplemental

This is a wrapper around the wait function. Any "special" values of pid depend on your implementation of wait, as does the return value. The third argument is unused in libiberty.

int xatexit (void (*fn) (void)) Function

Behaves as the standard atexit function, but with no limit on the number of registered functions. Returns 0 on success, or -1 on failure. If you use xatexit to register functions, you must use xexit to terminate your program.

void* xcalloc (size_t nelem, size_t elsize) Replacement

Allocate memory without fail, and set it to zero. This routine functions like calloc, but will behave the same as xmalloc if memory cannot be found.

void xexit (int code) Replacement

Terminates the program. If any functions have been registered with the xatexit replacement function, they will be called first. Termination is handled via the system's normal exit call.

void* xmalloc (size_t) Replacement

Allocate memory without fail. If malloc fails, this will print a message to stderr (using the name set by xmalloc_set_program_name, if any) and then call xexit. Note that it is therefore safe for a program to contain #define malloc xmalloc in its source.

void xmalloc_failed (size_t) Replacement

This function is not meant to be called by client code, and is listed here for completeness only. If any of the allocation routines fail, this function will be called to print an error message and terminate execution.

void xmalloc_set_program_name (const char *name) Replacement

You can use this to set the name of the program used by xmalloc_failed when printing a failure message.

void* xmemdup (void *input, size_t copy_size, size_t alloc_size) Replacement

Duplicates a region of memory without fail. First, alloc_size bytes are allocated, then copy_size bytes from input are copied into it, and the new memory is returned. If fewer bytes are copied than were allocated, the remaining memory is zeroed.

void* xrealloc (void *ptr, size_t size) Replacement

Reallocate memory without fail. This routine functions like realloc, but will behave the same as xmalloc if memory cannot be found.

char* xstrdup (const char *s) Replacement

Duplicates a character string without fail, using xmalloc to obtain memory.

char* xstrerror (int errnum) Replacement

Behaves exactly like the standard strerror function, but will never return a NULL pointer.

void insque (struct qelem `elem`, struct qelem `pred`)	Supplemental
void remque (struct qelem *`elem`)	Supplemental

long int random (void)	Supplement
void srandom (unsigned int `seed`)	Supplement
void* initstate (unsigned int `seed`, void `arg_state`, unsigned long* `n`)	Supplement
void* setstate (void *`arg_state`)	Supplement

int setenv (const char `name`, const char `value`, int `overwrite`)	Supplemental
void unsetenv (const char *`name`)	Supplemental

long int strtol (const char `string`, char `endptr`, int* `base`)	Supplemental
unsigned long int strtoul (const char `string`, char `endptr`, int* `base`)	Supplemental

int vprintf (const char `format`, va_list* `ap`)	Supplemental
int vfprintf (FILE `stream`, const char `format`, va_list `ap`)	Supplemental
int vsprintf (char `str`, const char `format`, va_list `ap`)	Supplemental