This is libiberty.info, produced by makeinfo version 4.2 from
/usr/src/gnu/lib/libiberty/src/libiberty.texi.

INFO-DIR-SECTION GNU libraries
START-INFO-DIR-ENTRY
* Libiberty: (libiberty).          Library of utility functions which
                                   are missing or broken on some systems.
END-INFO-DIR-ENTRY

   This manual describes the GNU `libiberty' library of utility
subroutines.  This edition accompanies GCC 3, September 2001.

   Copyright (C) 2001 Free Software Foundation, Inc.

   Permission is granted to copy, distribute and/or modify this document
     under the terms of the GNU Free Documentation License, Version 1.2
     or any later version published by the Free Software Foundation;
   with no Invariant Sections, with no Front-Cover Texts, and with no
    Back-Cover Texts.  A copy of the license is included in the
section entitled "GNU Free Documentation License".


File: libiberty.info,  Node: Top,  Next: Using

Introduction
************

   The `libiberty' library is a collection of subroutines used by
various GNU programs.  It is available under the Library General Public
License; for more information, see *Note Library Copying::.

   This edition accompanies GCC 3, September 2001.

* Menu:

* Using::              How to use libiberty in your code.

* Overview::           Overview of available function groups.

* Functions::          Available functions, macros, and global variables.

* Obstacks::           Object Stacks.

* Licenses::           The various licenses under which libiberty sources are
                       distributed.

* Index::              Index of functions and categories.


File: libiberty.info,  Node: Using,  Next: Overview,  Prev: Top,  Up: Top

Using
*****

   To date, `libiberty' is generally not installed on its own.  It has
evolved over years but does not have its own version number nor release
schedule.

   Possibly the easiest way to use `libiberty' in your projects is to
drop the `libiberty' code into your project's sources, and to build the
library along with your own sources; the library would then be linked
in at the end.  This prevents any possible version mismatches with
other copies of libiberty elsewhere on the system.

   Passing `--enable-install-libiberty' to the `configure' script when
building `libiberty' causes the header files and archive library to be
installed when `make install' is run.  This option also takes an
(optional) argument to specify the installation location, in the same
manner as `--prefix'.

   For your own projects, an approach which offers stability and
flexibility is to include `libiberty' with your code, but allow the end
user to optionally choose to use a previously-installed version
instead.  In this way the user may choose (for example) to install
`libiberty' as part of GCC, and use that version for all software built
with that compiler.  (This approach has proven useful with software
using the GNU `readline' library.)

   Making use of `libiberty' code usually requires that you include one
or more header files from the `libiberty' distribution.  (They will be
named as necessary in the function descriptions.)  At link time, you
will need to add `-liberty' to your link command invocation.


File: libiberty.info,  Node: Overview,  Next: Functions,  Prev: Using,  Up: Top

Overview
********

   Functions contained in `libiberty' can be divided into three general
categories.

* Menu:

* Supplemental Functions::       Providing functions which don't exist
                                 on older operating systems.

* Replacement Functions::        These functions are sometimes buggy or
                                 unpredictable on some operating systems.

* Extensions::                   Functions which provide useful extensions
                                 or safety wrappers around existing code.


File: libiberty.info,  Node: Supplemental Functions,  Next: Replacement Functions,  Up: Overview

Supplemental Functions
======================

   Certain operating systems do not provide functions which have since
become standardized, or at least common.  For example, the Single Unix
Specification Version 2 requires that the `basename' function be
provided, but an OS which predates that specification might not have
this function.  This should not prevent well-written code from running
on such a system.

   Similarly, some functions exist only among a particular "flavor" or
"family" of operating systems.  As an example, the `bzero' function is
often not present on systems outside the BSD-derived family of systems.

   Many such functions are provided in `libiberty'.  They are quickly
listed here with little description, as systems which lack them become
less and less common.  Each function FOO is implemented in `FOO.c' but
not declared in any `libiberty' header file; more comments and caveats
for each function's implementation are often available in the source
file.  Generally, the function can simply be declared as `extern'.


File: libiberty.info,  Node: Replacement Functions,  Next: Extensions,  Prev: Supplemental Functions,  Up: Overview

Replacement Functions
=====================

   Some functions have extremely limited implementations on different
platforms.  Other functions are tedious to use correctly; for example,
proper use of `malloc' calls for the return value to be checked and
appropriate action taken if memory has been exhausted.  A group of
"replacement functions" is available in `libiberty' to address these
issues for some of the most commonly used subroutines.

   All of these functions are declared in the `libiberty.h' header
file.  Many of the implementations will use preprocessor macros set by
GNU Autoconf, if you decide to make use of that program.  Some of these
functions may call one another.

* Menu:

* Memory Allocation::            Testing and handling failed memory
                                   requests automatically.
* Exit Handlers::                Calling routines on program exit.
* Error Reporting::              Mapping errno and signal numbers to
                                   more useful string formats.


File: libiberty.info,  Node: Memory Allocation,  Next: Exit Handlers,  Up: Replacement Functions

Memory Allocation
-----------------

   The functions beginning with the letter `x' are wrappers around
standard functions; the functions provided by the system environment
are called and their results checked before the results are passed back
to client code.  If the standard functions fail, these wrappers will
terminate the program.  Thus, these versions can be used with impunity.


File: libiberty.info,  Node: Exit Handlers,  Next: Error Reporting,  Prev: Memory Allocation,  Up: Replacement Functions

Exit Handlers
-------------

   The existence and implementation of the `atexit' routine varies
amongst the flavors of Unix.  `libiberty' provides an unvarying
dependable implementation via `xatexit' and `xexit'.


File: libiberty.info,  Node: Error Reporting,  Prev: Exit Handlers,  Up: Replacement Functions

Error Reporting
---------------

   These are a set of routines to facilitate programming with the system
`errno' interface.  The `libiberty' source file `strerror.c' contains a
good deal of documentation for these functions.


File: libiberty.info,  Node: Extensions,  Prev: Replacement Functions,  Up: Overview

Extensions
==========

   `libiberty' includes additional functionality above and beyond
standard functions, which has proven generically useful in GNU
programs, such as obstacks and regex.  These functions are often copied
from other projects as they gain popularity, and are included here to
provide a central location from which to use, maintain, and distribute
them.

* Menu:

* Obstacks::                     Stacks of arbitrary objects.


File: libiberty.info,  Node: Obstacks,  Next: Licenses,  Prev: Functions,  Up: Top

Obstacks
********

   An "obstack" is a pool of memory containing a stack of objects.  You
can create any number of separate obstacks, and then allocate objects in
specified obstacks.  Within each obstack, the last object allocated must
always be the first one freed, but distinct obstacks are independent of
each other.

   Aside from this one constraint of order of freeing, obstacks are
totally general: an obstack can contain any number of objects of any
size.  They are implemented with macros, so allocation is usually very
fast as long as the objects are usually small.  And the only space
overhead per object is the padding needed to start each object on a
suitable boundary.

* Menu:

* Creating Obstacks::		How to declare an obstack in your program.
* Preparing for Obstacks::	Preparations needed before you can
				 use obstacks.
* Allocation in an Obstack::    Allocating objects in an obstack.
* Freeing Obstack Objects::     Freeing objects in an obstack.
* Obstack Functions::		The obstack functions are both
				 functions and macros.
* Growing Objects::             Making an object bigger by stages.
* Extra Fast Growing::		Extra-high-efficiency (though more
				 complicated) growing objects.
* Status of an Obstack::        Inquiries about the status of an obstack.
* Obstacks Data Alignment::     Controlling alignment of objects in obstacks.
* Obstack Chunks::              How obstacks obtain and release chunks;
				 efficiency considerations.
* Summary of Obstacks::


File: libiberty.info,  Node: Creating Obstacks,  Next: Preparing for Obstacks,  Up: Obstacks

Creating Obstacks
=================

   The utilities for manipulating obstacks are declared in the header
file `obstack.h'.

 - Data Type: struct obstack
     An obstack is represented by a data structure of type `struct
     obstack'.  This structure has a small fixed size; it records the
     status of the obstack and how to find the space in which objects
     are allocated.  It does not contain any of the objects themselves.
     You should not try to access the contents of the structure
     directly; use only the functions described in this chapter.

   You can declare variables of type `struct obstack' and use them as
obstacks, or you can allocate obstacks dynamically like any other kind
of object.  Dynamic allocation of obstacks allows your program to have a
variable number of different stacks.  (You can even allocate an obstack
structure in another obstack, but this is rarely useful.)

   All the functions that work with obstacks require you to specify
which obstack to use.  You do this with a pointer of type `struct
obstack *'.  In the following, we often say "an obstack" when strictly
speaking the object at hand is such a pointer.

   The objects in the obstack are packed into large blocks called
"chunks".  The `struct obstack' structure points to a chain of the
chunks currently in use.

   The obstack library obtains a new chunk whenever you allocate an
object that won't fit in the previous chunk.  Since the obstack library
manages chunks automatically, you don't need to pay much attention to
them, but you do need to supply a function which the obstack library
should use to get a chunk.  Usually you supply a function which uses
`malloc' directly or indirectly.  You must also supply a function to
free a chunk.  These matters are described in the following section.


File: libiberty.info,  Node: Preparing for Obstacks,  Next: Allocation in an Obstack,  Prev: Creating Obstacks,  Up: Obstacks

Preparing for Using Obstacks
============================

   Each source file in which you plan to use the obstack functions must
include the header file `obstack.h', like this:

     #include <obstack.h>

   Also, if the source file uses the macro `obstack_init', it must
declare or define two functions or macros that will be called by the
obstack library.  One, `obstack_chunk_alloc', is used to allocate the
chunks of memory into which objects are packed.  The other,
`obstack_chunk_free', is used to return chunks when the objects in them
are freed.  These macros should appear before any use of obstacks in
the source file.

   Usually these are defined to use `malloc' via the intermediary
`xmalloc' (*note Unconstrained Allocation: (libc)Unconstrained
Allocation.).  This is done with the following pair of macro
definitions:

     #define obstack_chunk_alloc xmalloc
     #define obstack_chunk_free free

Though the memory you get using obstacks really comes from `malloc',
using obstacks is faster because `malloc' is called less often, for
larger blocks of memory.  *Note Obstack Chunks::, for full details.

   At run time, before the program can use a `struct obstack' object as
an obstack, it must initialize the obstack by calling `obstack_init'.

 - Function: int obstack_init (struct obstack *OBSTACK-PTR)
     Initialize obstack OBSTACK-PTR for allocation of objects.  This
     function calls the obstack's `obstack_chunk_alloc' function.  If
     allocation of memory fails, the function pointed to by
     `obstack_alloc_failed_handler' is called.  The `obstack_init'
     function always returns 1 (Compatibility notice: Former versions of
     obstack returned 0 if allocation failed).

   Here are two examples of how to allocate the space for an obstack and
initialize it.  First, an obstack that is a static variable:

     static struct obstack myobstack;
     ...
     obstack_init (&myobstack);

Second, an obstack that is itself dynamically allocated:

     struct obstack *myobstack_ptr
       = (struct obstack *) xmalloc (sizeof (struct obstack));
     
     obstack_init (myobstack_ptr);

 - Variable: obstack_alloc_failed_handler
     The value of this variable is a pointer to a function that
     `obstack' uses when `obstack_chunk_alloc' fails to allocate
     memory.  The default action is to print a message and abort.  You
     should supply a function that either calls `exit' (*note Program
     Termination: (libc)Program Termination.) or `longjmp' (*note
     Non-Local Exits: (libc)Non-Local Exits.) and doesn't return.

          void my_obstack_alloc_failed (void)
          ...
          obstack_alloc_failed_handler = &my_obstack_alloc_failed;



File: libiberty.info,  Node: Allocation in an Obstack,  Next: Freeing Obstack Objects,  Prev: Preparing for Obstacks,  Up: Obstacks

Allocation in an Obstack
========================

   The most direct way to allocate an object in an obstack is with
`obstack_alloc', which is invoked almost like `malloc'.

 - Function: void * obstack_alloc (struct obstack *OBSTACK-PTR, int
          SIZE)
     This allocates an uninitialized block of SIZE bytes in an obstack
     and returns its address.  Here OBSTACK-PTR specifies which obstack
     to allocate the block in; it is the address of the `struct obstack'
     object which represents the obstack.  Each obstack function or
     macro requires you to specify an OBSTACK-PTR as the first argument.

     This function calls the obstack's `obstack_chunk_alloc' function if
     it needs to allocate a new chunk of memory; it calls
     `obstack_alloc_failed_handler' if allocation of memory by
     `obstack_chunk_alloc' failed.

   For example, here is a function that allocates a copy of a string STR
in a specific obstack, which is in the variable `string_obstack':

     struct obstack string_obstack;
     
     char *
     copystring (char *string)
     {
       size_t len = strlen (string) + 1;
       char *s = (char *) obstack_alloc (&string_obstack, len);
       memcpy (s, string, len);
       return s;
     }

   To allocate a block with specified contents, use the function
`obstack_copy', declared like this:

 - Function: void * obstack_copy (struct obstack *OBSTACK-PTR, void
          *ADDRESS, int SIZE)
     This allocates a block and initializes it by copying SIZE bytes of
     data starting at ADDRESS.  It calls `obstack_alloc_failed_handler'
     if allocation of memory by `obstack_chunk_alloc' failed.

 - Function: void * obstack_copy0 (struct obstack *OBSTACK-PTR, void
          *ADDRESS, int SIZE)
     Like `obstack_copy', but appends an extra byte containing a null
     character.  This extra byte is not counted in the argument SIZE.

   The `obstack_copy0' function is convenient for copying a sequence of
characters into an obstack as a null-terminated string.  Here is an
example of its use:

     char *
     obstack_savestring (char *addr, int size)
     {
       return obstack_copy0 (&myobstack, addr, size);
     }

Contrast this with the previous example of `savestring' using `malloc'
(*note Basic Allocation: (libc)Basic Allocation.).


File: libiberty.info,  Node: Freeing Obstack Objects,  Next: Obstack Functions,  Prev: Allocation in an Obstack,  Up: Obstacks

Freeing Objects in an Obstack
=============================

   To free an object allocated in an obstack, use the function
`obstack_free'.  Since the obstack is a stack of objects, freeing one
object automatically frees all other objects allocated more recently in
the same obstack.

 - Function: void obstack_free (struct obstack *OBSTACK-PTR, void
          *OBJECT)
     If OBJECT is a null pointer, everything allocated in the obstack
     is freed.  Otherwise, OBJECT must be the address of an object
     allocated in the obstack.  Then OBJECT is freed, along with
     everything allocated in OBSTACK since OBJECT.

   Note that if OBJECT is a null pointer, the result is an
uninitialized obstack.  To free all memory in an obstack but leave it
valid for further allocation, call `obstack_free' with the address of
the first object allocated on the obstack:

     obstack_free (obstack_ptr, first_object_allocated_ptr);

   Recall that the objects in an obstack are grouped into chunks.  When
all the objects in a chunk become free, the obstack library
automatically frees the chunk (*note Preparing for Obstacks::).  Then
other obstacks, or non-obstack allocation, can reuse the space of the
chunk.


File: libiberty.info,  Node: Obstack Functions,  Next: Growing Objects,  Prev: Freeing Obstack Objects,  Up: Obstacks

Obstack Functions and Macros
============================

   The interfaces for using obstacks may be defined either as functions
or as macros, depending on the compiler.  The obstack facility works
with all C compilers, including both ISO C and traditional C, but there
are precautions you must take if you plan to use compilers other than
GNU C.

   If you are using an old-fashioned non-ISO C compiler, all the obstack
"functions" are actually defined only as macros.  You can call these
macros like functions, but you cannot use them in any other way (for
example, you cannot take their address).

   Calling the macros requires a special precaution: namely, the first
operand (the obstack pointer) may not contain any side effects, because
it may be computed more than once.  For example, if you write this:

     obstack_alloc (get_obstack (), 4);

you will find that `get_obstack' may be called several times.  If you
use `*obstack_list_ptr++' as the obstack pointer argument, you will get
very strange results since the incrementation may occur several times.

   In ISO C, each function has both a macro definition and a function
definition.  The function definition is used if you take the address of
the function without calling it.  An ordinary call uses the macro
definition by default, but you can request the function definition
instead by writing the function name in parentheses, as shown here:

     char *x;
     void *(*funcp) ();
     /* Use the macro.  */
     x = (char *) obstack_alloc (obptr, size);
     /* Call the function.  */
     x = (char *) (obstack_alloc) (obptr, size);
     /* Take the address of the function.  */
     funcp = obstack_alloc;

This is the same situation that exists in ISO C for the standard library
functions.  *Note Macro Definitions: (libc)Macro Definitions.

   *Warning:* When you do use the macros, you must observe the
precaution of avoiding side effects in the first operand, even in ISO C.

   If you use the GNU C compiler, this precaution is not necessary,
because various language extensions in GNU C permit defining the macros
so as to compute each argument only once.


File: libiberty.info,  Node: Growing Objects,  Next: Extra Fast Growing,  Prev: Obstack Functions,  Up: Obstacks

Growing Objects
===============

   Because memory in obstack chunks is used sequentially, it is
possible to build up an object step by step, adding one or more bytes
at a time to the end of the object.  With this technique, you do not
need to know how much data you will put in the object until you come to
the end of it.  We call this the technique of "growing objects".  The
special functions for adding data to the growing object are described
in this section.

   You don't need to do anything special when you start to grow an
object.  Using one of the functions to add data to the object
automatically starts it.  However, it is necessary to say explicitly
when the object is finished.  This is done with the function
`obstack_finish'.

   The actual address of the object thus built up is not known until the
object is finished.  Until then, it always remains possible that you
will add so much data that the object must be copied into a new chunk.

   While the obstack is in use for a growing object, you cannot use it
for ordinary allocation of another object.  If you try to do so, the
space already added to the growing object will become part of the other
object.

 - Function: void obstack_blank (struct obstack *OBSTACK-PTR, int SIZE)
     The most basic function for adding to a growing object is
     `obstack_blank', which adds space without initializing it.

 - Function: void obstack_grow (struct obstack *OBSTACK-PTR, void
          *DATA, int SIZE)
     To add a block of initialized space, use `obstack_grow', which is
     the growing-object analogue of `obstack_copy'.  It adds SIZE bytes
     of data to the growing object, copying the contents from DATA.

 - Function: void obstack_grow0 (struct obstack *OBSTACK-PTR, void
          *DATA, int SIZE)
     This is the growing-object analogue of `obstack_copy0'.  It adds
     SIZE bytes copied from DATA, followed by an additional null
     character.

 - Function: void obstack_1grow (struct obstack *OBSTACK-PTR, char C)
     To add one character at a time, use the function `obstack_1grow'.
     It adds a single byte containing C to the growing object.

 - Function: void obstack_ptr_grow (struct obstack *OBSTACK-PTR, void
          *DATA)
     Adding the value of a pointer one can use the function
     `obstack_ptr_grow'.  It adds `sizeof (void *)' bytes containing
     the value of DATA.

 - Function: void obstack_int_grow (struct obstack *OBSTACK-PTR, int
          DATA)
     A single value of type `int' can be added by using the
     `obstack_int_grow' function.  It adds `sizeof (int)' bytes to the
     growing object and initializes them with the value of DATA.

 - Function: void * obstack_finish (struct obstack *OBSTACK-PTR)
     When you are finished growing the object, use the function
     `obstack_finish' to close it off and return its final address.

     Once you have finished the object, the obstack is available for
     ordinary allocation or for growing another object.

     This function can return a null pointer under the same conditions
     as `obstack_alloc' (*note Allocation in an Obstack::).

   When you build an object by growing it, you will probably need to
know afterward how long it became.  You need not keep track of this as
you grow the object, because you can find out the length from the
obstack just before finishing the object with the function
`obstack_object_size', declared as follows:

 - Function: int obstack_object_size (struct obstack *OBSTACK-PTR)
     This function returns the current size of the growing object, in
     bytes.  Remember to call this function _before_ finishing the
     object.  After it is finished, `obstack_object_size' will return
     zero.

   If you have started growing an object and wish to cancel it, you
should finish it and then free it, like this:

     obstack_free (obstack_ptr, obstack_finish (obstack_ptr));

This has no effect if no object was growing.

   You can use `obstack_blank' with a negative size argument to make
the current object smaller.  Just don't try to shrink it beyond zero
length--there's no telling what will happen if you do that.


File: libiberty.info,  Node: Extra Fast Growing,  Next: Status of an Obstack,  Prev: Growing Objects,  Up: Obstacks

Extra Fast Growing Objects
==========================

   The usual functions for growing objects incur overhead for checking
whether there is room for the new growth in the current chunk.  If you
are frequently constructing objects in small steps of growth, this
overhead can be significant.

   You can reduce the overhead by using special "fast growth" functions
that grow the object without checking.  In order to have a robust
program, you must do the checking yourself.  If you do this checking in
the simplest way each time you are about to add data to the object, you
have not saved anything, because that is what the ordinary growth
functions do.  But if you can arrange to check less often, or check
more efficiently, then you make the program faster.

   The function `obstack_room' returns the amount of room available in
the current chunk.  It is declared as follows:

 - Function: int obstack_room (struct obstack *OBSTACK-PTR)
     This returns the number of bytes that can be added safely to the
     current growing object (or to an object about to be started) in
     obstack OBSTACK using the fast growth functions.

   While you know there is room, you can use these fast growth functions
for adding data to a growing object:

 - Function: void obstack_1grow_fast (struct obstack *OBSTACK-PTR, char
          C)
     The function `obstack_1grow_fast' adds one byte containing the
     character C to the growing object in obstack OBSTACK-PTR.

 - Function: void obstack_ptr_grow_fast (struct obstack *OBSTACK-PTR,
          void *DATA)
     The function `obstack_ptr_grow_fast' adds `sizeof (void *)' bytes
     containing the value of DATA to the growing object in obstack
     OBSTACK-PTR.

 - Function: void obstack_int_grow_fast (struct obstack *OBSTACK-PTR,
          int DATA)
     The function `obstack_int_grow_fast' adds `sizeof (int)' bytes
     containing the value of DATA to the growing object in obstack
     OBSTACK-PTR.

 - Function: void obstack_blank_fast (struct obstack *OBSTACK-PTR, int
          SIZE)
     The function `obstack_blank_fast' adds SIZE bytes to the growing
     object in obstack OBSTACK-PTR without initializing them.

   When you check for space using `obstack_room' and there is not
enough room for what you want to add, the fast growth functions are not
safe.  In this case, simply use the corresponding ordinary growth
function instead.  Very soon this will copy the object to a new chunk;
then there will be lots of room available again.

   So, each time you use an ordinary growth function, check afterward
for sufficient space using `obstack_room'.  Once the object is copied
to a new chunk, there will be plenty of space again, so the program will
start using the fast growth functions again.

   Here is an example:

     void
     add_string (struct obstack *obstack, const char *ptr, int len)
     {
       while (len > 0)
         {
           int room = obstack_room (obstack);
           if (room == 0)
             {
               /* Not enough room. Add one character slowly,
                  which may copy to a new chunk and make room.  */
               obstack_1grow (obstack, *ptr++);
               len--;
             }
           else
             {
               if (room > len)
                 room = len;
               /* Add fast as much as we have room for. */
               len -= room;
               while (room-- > 0)
                 obstack_1grow_fast (obstack, *ptr++);
             }
         }
     }


File: libiberty.info,  Node: Status of an Obstack,  Next: Obstacks Data Alignment,  Prev: Extra Fast Growing,  Up: Obstacks

Status of an Obstack
====================

   Here are functions that provide information on the current status of
allocation in an obstack.  You can use them to learn about an object
while still growing it.

 - Function: void * obstack_base (struct obstack *OBSTACK-PTR)
     This function returns the tentative address of the beginning of the
     currently growing object in OBSTACK-PTR.  If you finish the object
     immediately, it will have that address.  If you make it larger
     first, it may outgrow the current chunk--then its address will
     change!

     If no object is growing, this value says where the next object you
     allocate will start (once again assuming it fits in the current
     chunk).

 - Function: void * obstack_next_free (struct obstack *OBSTACK-PTR)
     This function returns the address of the first free byte in the
     current chunk of obstack OBSTACK-PTR.  This is the end of the
     currently growing object.  If no object is growing,
     `obstack_next_free' returns the same value as `obstack_base'.

 - Function: int obstack_object_size (struct obstack *OBSTACK-PTR)
     This function returns the size in bytes of the currently growing
     object.  This is equivalent to

          obstack_next_free (OBSTACK-PTR) - obstack_base (OBSTACK-PTR)


File: libiberty.info,  Node: Obstacks Data Alignment,  Next: Obstack Chunks,  Prev: Status of an Obstack,  Up: Obstacks

Alignment of Data in Obstacks
=============================

   Each obstack has an "alignment boundary"; each object allocated in
the obstack automatically starts on an address that is a multiple of the
specified boundary.  By default, this boundary is 4 bytes.

   To access an obstack's alignment boundary, use the macro
`obstack_alignment_mask', whose function prototype looks like this:

 - Macro: int obstack_alignment_mask (struct obstack *OBSTACK-PTR)
     The value is a bit mask; a bit that is 1 indicates that the
     corresponding bit in the address of an object should be 0.  The
     mask value should be one less than a power of 2; the effect is
     that all object addresses are multiples of that power of 2.  The
     default value of the mask is 3, so that addresses are multiples of
     4.  A mask value of 0 means an object can start on any multiple of
     1 (that is, no alignment is required).

     The expansion of the macro `obstack_alignment_mask' is an lvalue,
     so you can alter the mask by assignment.  For example, this
     statement:

          obstack_alignment_mask (obstack_ptr) = 0;

     has the effect of turning off alignment processing in the
     specified obstack.

   Note that a change in alignment mask does not take effect until
_after_ the next time an object is allocated or finished in the
obstack.  If you are not growing an object, you can make the new
alignment mask take effect immediately by calling `obstack_finish'.
This will finish a zero-length object and then do proper alignment for
the next object.


File: libiberty.info,  Node: Obstack Chunks,  Next: Summary of Obstacks,  Prev: Obstacks Data Alignment,  Up: Obstacks

Obstack Chunks
==============

   Obstacks work by allocating space for themselves in large chunks, and
then parceling out space in the chunks to satisfy your requests.  Chunks
are normally 4096 bytes long unless you specify a different chunk size.
The chunk size includes 8 bytes of overhead that are not actually used
for storing objects.  Regardless of the specified size, longer chunks
will be allocated when necessary for long objects.

   The obstack library allocates chunks by calling the function
`obstack_chunk_alloc', which you must define.  When a chunk is no
longer needed because you have freed all the objects in it, the obstack
library frees the chunk by calling `obstack_chunk_free', which you must
also define.

   These two must be defined (as macros) or declared (as functions) in
each source file that uses `obstack_init' (*note Creating Obstacks::).
Most often they are defined as macros like this:

     #define obstack_chunk_alloc malloc
     #define obstack_chunk_free free

   Note that these are simple macros (no arguments).  Macro definitions
with arguments will not work!  It is necessary that
`obstack_chunk_alloc' or `obstack_chunk_free', alone, expand into a
function name if it is not itself a function name.

   If you allocate chunks with `malloc', the chunk size should be a
power of 2.  The default chunk size, 4096, was chosen because it is long
enough to satisfy many typical requests on the obstack yet short enough
not to waste too much memory in the portion of the last chunk not yet
used.

 - Macro: int obstack_chunk_size (struct obstack *OBSTACK-PTR)
     This returns the chunk size of the given obstack.

   Since this macro expands to an lvalue, you can specify a new chunk
size by assigning it a new value.  Doing so does not affect the chunks
already allocated, but will change the size of chunks allocated for
that particular obstack in the future.  It is unlikely to be useful to
make the chunk size smaller, but making it larger might improve
efficiency if you are allocating many objects whose size is comparable
to the chunk size.  Here is how to do so cleanly:

     if (obstack_chunk_size (obstack_ptr) < NEW-CHUNK-SIZE)
       obstack_chunk_size (obstack_ptr) = NEW-CHUNK-SIZE;


File: libiberty.info,  Node: Summary of Obstacks,  Prev: Obstack Chunks,  Up: Obstacks

Summary of Obstack Functions
============================

   Here is a summary of all the functions associated with obstacks.
Each takes the address of an obstack (`struct obstack *') as its first
argument.

`void obstack_init (struct obstack *OBSTACK-PTR)'
     Initialize use of an obstack.  *Note Creating Obstacks::.

`void *obstack_alloc (struct obstack *OBSTACK-PTR, int SIZE)'
     Allocate an object of SIZE uninitialized bytes.  *Note Allocation
     in an Obstack::.

`void *obstack_copy (struct obstack *OBSTACK-PTR, void *ADDRESS, int SIZE)'
     Allocate an object of SIZE bytes, with contents copied from
     ADDRESS.  *Note Allocation in an Obstack::.

`void *obstack_copy0 (struct obstack *OBSTACK-PTR, void *ADDRESS, int SIZE)'
     Allocate an object of SIZE+1 bytes, with SIZE of them copied from
     ADDRESS, followed by a null character at the end.  *Note
     Allocation in an Obstack::.

`void obstack_free (struct obstack *OBSTACK-PTR, void *OBJECT)'
     Free OBJECT (and everything allocated in the specified obstack
     more recently than OBJECT).  *Note Freeing Obstack Objects::.

`void obstack_blank (struct obstack *OBSTACK-PTR, int SIZE)'
     Add SIZE uninitialized bytes to a growing object.  *Note Growing
     Objects::.

`void obstack_grow (struct obstack *OBSTACK-PTR, void *ADDRESS, int SIZE)'
     Add SIZE bytes, copied from ADDRESS, to a growing object.  *Note
     Growing Objects::.

`void obstack_grow0 (struct obstack *OBSTACK-PTR, void *ADDRESS, int SIZE)'
     Add SIZE bytes, copied from ADDRESS, to a growing object, and then
     add another byte containing a null character.  *Note Growing
     Objects::.

`void obstack_1grow (struct obstack *OBSTACK-PTR, char DATA-CHAR)'
     Add one byte containing DATA-CHAR to a growing object.  *Note
     Growing Objects::.

`void *obstack_finish (struct obstack *OBSTACK-PTR)'
     Finalize the object that is growing and return its permanent
     address.  *Note Growing Objects::.

`int obstack_object_size (struct obstack *OBSTACK-PTR)'
     Get the current size of the currently growing object.  *Note
     Growing Objects::.

`void obstack_blank_fast (struct obstack *OBSTACK-PTR, int SIZE)'
     Add SIZE uninitialized bytes to a growing object without checking
     that there is enough room.  *Note Extra Fast Growing::.

`void obstack_1grow_fast (struct obstack *OBSTACK-PTR, char DATA-CHAR)'
     Add one byte containing DATA-CHAR to a growing object without
     checking that there is enough room.  *Note Extra Fast Growing::.

`int obstack_room (struct obstack *OBSTACK-PTR)'
     Get the amount of room now available for growing the current
     object.  *Note Extra Fast Growing::.

`int obstack_alignment_mask (struct obstack *OBSTACK-PTR)'
     The mask used for aligning the beginning of an object.  This is an
     lvalue.  *Note Obstacks Data Alignment::.

`int obstack_chunk_size (struct obstack *OBSTACK-PTR)'
     The size for allocating chunks.  This is an lvalue.  *Note Obstack
     Chunks::.

`void *obstack_base (struct obstack *OBSTACK-PTR)'
     Tentative starting address of the currently growing object.  *Note
     Status of an Obstack::.

`void *obstack_next_free (struct obstack *OBSTACK-PTR)'
     Address just after the end of the currently growing object.  *Note
     Status of an Obstack::.


File: libiberty.info,  Node: Functions,  Next: Obstacks,  Prev: Overview,  Up: Top

Function, Variable, and Macro Listing.
**************************************

 - Replacement: void* alloca (size_t SIZE)
     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.


 - Extension: int asprintf (char **RESPTR, const char *FORMAT, ...)
     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'.


 - Supplemental: int atexit (void (*F)())
     Causes function F to be called at exit.  Returns 0.


 - Supplemental: char* basename (const char *NAME)
     Returns a pointer to the last component of pathname NAME.
     Behavior is undefined if the pathname ends in a directory
     separator.


 - Supplemental: int bcmp (char *X, char *Y, int COUNT)
     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).


 - Supplemental: void bcopy (char *IN, char *OUT, int LENGTH)
     Copies LENGTH bytes from memory region IN to region OUT.  The use
     of `bcopy' is deprecated in new programs.


 - Supplemental: void* bsearch (const void *KEY, const void *BASE,
          size_t NMEMB, size_t SIZE, int (*COMPAR)(const void *, const
          void *))
     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.


 - Extension: char** buildargv (char *SP)
     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.


 - Supplemental: void bzero (char *MEM, int COUNT)
     Zeros COUNT bytes starting at MEM.  Use of this function is
     deprecated in favor of `memset'.


 - Supplemental: void* calloc (size_t NELEM, size_t ELSIZE)
     Uses `malloc' to allocate storage for NELEM objects of ELSIZE
     bytes each, then zeros the memory.


 - Extension: char* choose_temp_base (void)
     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.


 - Replacement: char* choose_tmpdir ()
     Returns a pointer to a directory path suitable for creating
     temporary files in.


 - Supplemental: long clock (void)
     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.


 - Extension: char* concat (const char *S1, const char *S2, ..., `NULL')
     Concatenate zero or more of strings and return the result in
     freshly `xmalloc'ed 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.


 - Extension: char** dupargv (char **VECTOR)
     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.


 - Extension: int errno_max (void)
     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.


 - Extension: int fdmatch (int FD1, int FD2)
     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.


 - Supplemental: int ffs (int VALU)
     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.


 - Replacement: int fnmatch (const char *PATTERN, const char *STRING,
          int FLAGS)
     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.


 - Extension: void freeargv (char **VECTOR)
     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.


 - Replacement: long get_run_time (void)
     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.


 - Supplemental: char* getcwd (char *PATHNAME, int LEN)
     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'.


 - Supplemental: int getpagesize (void)
     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.


 - Supplemental: char* getpwd (void)
     Returns the current working directory.  This implementation caches
     the result on the assumption that the process will not call `chdir'
     between calls to `getpwd'.


 - Extension: void hex_init (void)
     Initializes the array mapping the current character set to
     corresponding hex values.  This function must be called before any
     call to `hex_p' or `hex_value'.  If you fail to call it, a default
     ASCII-based table will normally be used on ASCII systems.


 - Extension: int hex_p (int C)
     Evaluates to non-zero if the given character is a valid hex
     character, or zero if it is not.  Note that the value you pass
     will be cast to `unsigned char' within the macro.


 - Extension: int hex_value (int C)
     Returns the numeric equivalent of the given character when
     interpreted as a hexidecimal digit.  The result is undefined if
     you pass an invalid hex digit.  Note that the value you pass will
     be cast to `unsigned char' within the macro.


 - Supplemental: char* index (char *S, int C)
     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'.


 - Supplemental: void insque (struct qelem *ELEM, struct qelem *PRED)
 - Supplemental: void remque (struct qelem *ELEM)
     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[];
          };


 - Replacement: const char* lbasename (const char *NAME)
     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.


 - Replacement: const char* lrealpath (const char *NAME)
     Given a pointer to a string containing a pathname, returns a
     canonical version of the filename.  Symlinks will be resolved, and
     "." and ".."  components will be simplified.  The returned value
     will be allocated using `malloc', or `NULL' will be returned on a
     memory allocation error.


 - Extension: const char* make_relative_prefix (const char *PROGNAME,
          const char *BIN_PREFIX, const char *PREFIX)
     Given three paths PROGNAME, BIN_PREFIX, PREFIX, return the path
     that is in the same position relative to PROGNAME's directory as
     PREFIX is relative to BIN_PREFIX.  That is, a string starting with
     the directory portion of PROGNAME, followed by a relative pathname
     of the difference between BIN_PREFIX and PREFIX.

     If PROGNAME does not contain any directory separators,
     `make_relative_prefix' will search `PATH' to find a program named
     PROGNAME.  Also, if PROGNAME is a symbolic link, the symbolic link
     will be resolved.

     For example, if BIN_PREFIX is `/alpha/beta/gamma/gcc/delta',
     PREFIX is `/alpha/beta/gamma/omega/', and PROGNAME is
     `/red/green/blue/gcc', then this function will return
     `/red/green/blue/../../omega/'.

     The return value is normally allocated via `malloc'.  If no
     relative prefix can be found, return `NULL'.


 - Replacement: char* make_temp_file (const char *SUFFIX)
     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 `malloc'ed, and the temporary file has been created.


 - Supplemental: void* memchr (const void *S, int C, size_t N)
     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.


 - Supplemental: int memcmp (const void *X, const void *Y, size_t COUNT)
     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.


 - Supplemental: void* memcpy (void *OUT, const void *IN, size_t LENGTH)
     Copies LENGTH bytes from memory region IN to region OUT.  Returns
     a pointer to OUT.


 - Supplemental: void* memmove (void *FROM, const void *TO, size_t
          COUNT)
     Copies COUNT bytes from memory area FROM to memory area TO,
     returning a pointer to TO.


 - Supplemental: void* mempcpy (void *OUT, const void *IN, size_t
          LENGTH)
     Copies LENGTH bytes from memory region IN to region OUT.  Returns
     a pointer to OUT + LENGTH.


 - Supplemental: void* memset (void *S, int C, size_t COUNT)
     Sets the first COUNT bytes of S to the constant byte C, returning
     a pointer to S.


 - Replacement: int mkstemps (char *TEMPLATE, int SUFFIX_LEN)
     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.


 - Extension: int pexecute (const char *PROGRAM, char * const *ARGV,
          const char *THIS_PNAME, const char *TEMP_BASE, char
          **ERRMSG_FMT, char **ERRMSG_ARG, int flags)
     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.


 - Supplemental: void psignal (unsigned SIGNO, char *MESSAGE)
     Print MESSAGE to the standard error, followed by a colon, followed
     by the description of the signal specified by SIGNO, followed by a
     newline.


 - Supplemental: int putenv (const char *STRING)
     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.


 - Extension: int pwait (int PID, int *STATUS, int FLAGS)
     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.


 - Supplement: 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)
     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.


 - Extension: char* reconcat (char *OPTR, const char *S1, ..., `NULL')
     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);


 - Supplemental: int rename (const char *OLD, const char *NEW)
     Renames a file from OLD to NEW.  If NEW already exists, it is
     removed.


 - Supplemental: char* rindex (const char *S, int C)
     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'.


 - Supplemental: int setenv (const char *NAME, const char *VALUE, int
          OVERWRITE)
 - Supplemental: void unsetenv (const char *NAME)
     `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.


 - Extension: int signo_max (void)
     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.


 - Supplemental: int sigsetmask (int SET)
     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').


 - Supplemental: int snprintf (char *BUF, size_t N, const char *FORMAT,
          ...)
     This function is similar to sprintf, but it will print at most N
     characters.  On error the return value is -1, otherwise it returns
     the number of characters that would have been printed had N been
     sufficiently large, regardless of the actual value of N.  Note
     some pre-C99 system libraries do not implement this correctly so
     users cannot generally rely on the return value if the system
     version of this function is used.


 - Extension: char* spaces (int COUNT)
     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.


 - Supplemental: char* stpcpy (char *DST, const char *SRC)
     Copies the string SRC into DST.  Returns a pointer to DST +
     strlen(SRC).


 - Supplemental: char* stpncpy (char *DST, const char *SRC, size_t LEN)
     Copies the string SRC into DST, copying exactly LEN and padding
     with zeros if necessary.  If LEN < strlen(SRC) then return DST +
     LEN, otherwise returns DST + strlen(SRC).


 - Supplemental: int strcasecmp (const char *S1, const char *S2)
     A case-insensitive `strcmp'.


 - Supplemental: char* strchr (const char *S, int C)
     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.


 - Supplemental: char* strdup (const char *S)
     Returns a pointer to a copy of S in memory obtained from `malloc',
     or `NULL' if insufficient memory was available.


 - Replacement: const char* strerrno (int ERRNUM)
     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'.


 - Supplemental: char* strerror (int ERRNOVAL)
     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'.


 - Supplemental: int strncasecmp (const char *S1, const char *S2)
     A case-insensitive `strncmp'.


 - Supplemental: int strncmp (const char *S1, const char *S2, size_t N)
     Compares the first N bytes of two strings, returning a value as
     `strcmp'.


 - Supplemental: char* strrchr (const char *S, int C)
     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.


 - Supplemental: const char * strsignal (int SIGNO)
     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'.


 - Extension: const char* strsigno (int SIGNO)
     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'.


 - Supplemental: char* strstr (const char *STRING, const char *SUB)
     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.


 - Supplemental: double strtod (const char *STRING, char **ENDPTR)
     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.


 - Extension: int strtoerrno (const char *NAME)
     Given the symbolic name of a error number (e.g., `EACCES'), map it
     to an errno value.  If no translation is found, returns 0.


 - Supplemental: long int strtol (const char *STRING, char **ENDPTR,
          int BASE)
 - Supplemental: unsigned long int strtoul (const char *STRING, char
          **ENDPTR, int BASE)
     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.


 - Extension: int strtosigno (const char *NAME)
     Given the symbolic name of a signal, map it to a signal number.
     If no translation is found, returns 0.


 - Supplemental: char* tmpnam (char *S)
     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.


 - Extension: int vasprintf (char **RESPTR, const char *FORMAT, va_list
          ARGS)
     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'.


 - Supplemental: int vfork (void)
     Emulates `vfork' by calling `fork' and returning its value.


 - 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)
     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'.


 - Supplemental: int vsnprintf (char *BUF, size_t N, const char
          *FORMAT, va_list AP)
     This function is similar to vsprintf, but it will print at most N
     characters.  On error the return value is -1, otherwise it returns
     the number of characters that would have been printed had N been
     sufficiently large, regardless of the actual value of N.  Note
     some pre-C99 system libraries do not implement this correctly so
     users cannot generally rely on the return value if the system
     version of this function is used.


 - Supplemental: int waitpid (int PID, int *STATUS, int)
     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'.


 - Function: int xatexit (void (*FN) (void))
     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.


 - Replacement: void* xcalloc (size_t NELEM, size_t ELSIZE)
     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.


 - Replacement: void xexit (int CODE)
     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.


 - Replacement: void* xmalloc (size_t)
     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.


 - Replacement: void xmalloc_failed (size_t)
     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.


 - Replacement: void xmalloc_set_program_name (const char *NAME)
     You can use this to set the name of the program used by
     `xmalloc_failed' when printing a failure message.


 - Replacement: void* xmemdup (void *INPUT, size_t COPY_SIZE, size_t
          ALLOC_SIZE)
     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.


 - Replacement: void* xrealloc (void *PTR, size_t SIZE)
     Reallocate memory without fail.  This routine functions like
     `realloc', but will behave the same as `xmalloc' if memory cannot
     be found.


 - Replacement: char* xstrdup (const char *S)
     Duplicates a character string without fail, using `xmalloc' to
     obtain memory.


 - Replacement: char* xstrerror (int ERRNUM)
     Behaves exactly like the standard `strerror' function, but will
     never return a `NULL' pointer.



File: libiberty.info,  Node: Licenses,  Next: Index,  Prev: Obstacks,  Up: Top

Licenses
********

* Menu:


* Library Copying::   The GNU Library General Public License
* BSD::               Regents of the University of California


File: libiberty.info,  Node: Library Copying,  Next: BSD,  Up: Licenses

GNU LESSER GENERAL PUBLIC LICENSE
=================================

                      Version 2.1, February 1999
     Copyright (C) 1991, 1999 Free Software Foundation, Inc.
     59 Temple Place -- Suite 330, Boston, MA 02111-1307, USA
     
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.
     
     [This is the first released version of the Lesser GPL.  It also counts
     as the successor of the GNU Library Public License, version 2, hence the
     version number 2.1.]

Preamble
--------

   The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.

   This license, the Lesser General Public License, applies to some
specially designated software--typically libraries--of the Free
Software Foundation and other authors who decide to use it.  You can use
it too, but we suggest you first think carefully about whether this
license or the ordinary General Public License is the better strategy to
use in any particular case, based on the explanations below.

   When we speak of free software, we are referring to freedom of use,
not price.  Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of it
in new free programs; and that you are informed that you can do these
things.

   To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights.  These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.

   For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you.  You must make sure that they, too, receive or can get the source
code.  If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it.  And you must show them these terms so they know their rights.

   We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.

   To protect each distributor, we want to make it very clear that
there is no warranty for the free library.  Also, if the library is
modified by someone else and passed on, the recipients should know that
what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.

   Finally, software patents pose a constant threat to the existence of
any free program.  We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder.  Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.

   Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License.  This license, the GNU Lesser
General Public License, applies to certain designated libraries, and is
quite different from the ordinary General Public License.  We use this
license for certain libraries in order to permit linking those
libraries into non-free programs.

   When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library.  The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom.  The Lesser General
Public License permits more lax criteria for linking other code with
the library.

   We call this license the "Lesser" General Public License because it
does _Less_ to protect the user's freedom than the ordinary General
Public License.  It also provides other free software developers Less
of an advantage over competing non-free programs.  These disadvantages
are the reason we use the ordinary General Public License for many
libraries.  However, the Lesser license provides advantages in certain
special circumstances.

   For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it
becomes a de-facto standard.  To achieve this, non-free programs must be
allowed to use the library.  A more frequent case is that a free
library does the same job as widely used non-free libraries.  In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.

   In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of free
software.  For example, permission to use the GNU C Library in non-free
programs enables many more people to use the whole GNU operating
system, as well as its variant, the GNU/Linux operating system.

   Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run that
program using a modified version of the Library.

   The precise terms and conditions for copying, distribution and
modification follow.  Pay close attention to the difference between a
"work based on the library" and a "work that uses the library".  The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.

                   GNU LESSER GENERAL PUBLIC LICENSE
    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
  0. This License Agreement applies to any software library or other
     program which contains a notice placed by the copyright holder or
     other authorized party saying it may be distributed under the
     terms of this Lesser General Public License (also called "this
     License").  Each licensee is addressed as "you".

     A "library" means a collection of software functions and/or data
     prepared so as to be conveniently linked with application programs
     (which use some of those functions and data) to form executables.

     The "Library", below, refers to any such software library or work
     which has been distributed under these terms.  A "work based on the
     Library" means either the Library or any derivative work under
     copyright law: that is to say, a work containing the Library or a
     portion of it, either verbatim or with modifications and/or
     translated straightforwardly into another language.  (Hereinafter,
     translation is included without limitation in the term
     "modification".)

     "Source code" for a work means the preferred form of the work for
     making modifications to it.  For a library, complete source code
     means all the source code for all modules it contains, plus any
     associated interface definition files, plus the scripts used to
     control compilation and installation of the library.

     Activities other than copying, distribution and modification are
     not covered by this License; they are outside its scope.  The act
     of running a program using the Library is not restricted, and
     output from such a program is covered only if its contents
     constitute a work based on the Library (independent of the use of
     the Library in a tool for writing it).  Whether that is true
     depends on what the Library does and what the program that uses
     the Library does.

  1. You may copy and distribute verbatim copies of the Library's
     complete source code as you receive it, in any medium, provided
     that you conspicuously and appropriately publish on each copy an
     appropriate copyright notice and disclaimer of warranty; keep
     intact all the notices that refer to this License and to the
     absence of any warranty; and distribute a copy of this License
     along with the Library.

     You may charge a fee for the physical act of transferring a copy,
     and you may at your option offer warranty protection in exchange
     for a fee.

  2. You may modify your copy or copies of the Library or any portion
     of it, thus forming a work based on the Library, and copy and
     distribute such modifications or work under the terms of Section 1
     above, provided that you also meet all of these conditions:

       a. The modified work must itself be a software library.

       b. You must cause the files modified to carry prominent notices
          stating that you changed the files and the date of any change.

       c. You must cause the whole of the work to be licensed at no
          charge to all third parties under the terms of this License.

       d. If a facility in the modified Library refers to a function or
          a table of data to be supplied by an application program that
          uses the facility, other than as an argument passed when the
          facility is invoked, then you must make a good faith effort
          to ensure that, in the event an application does not supply
          such function or table, the facility still operates, and
          performs whatever part of its purpose remains meaningful.

          (For example, a function in a library to compute square roots
          has a purpose that is entirely well-defined independent of the
          application.  Therefore, Subsection 2d requires that any
          application-supplied function or table used by this function
          must be optional: if the application does not supply it, the
          square root function must still compute square roots.)

     These requirements apply to the modified work as a whole.  If
     identifiable sections of that work are not derived from the
     Library, and can be reasonably considered independent and separate
     works in themselves, then this License, and its terms, do not
     apply to those sections when you distribute them as separate
     works.  But when you distribute the same sections as part of a
     whole which is a work based on the Library, the distribution of
     the whole must be on the terms of this License, whose permissions
     for other licensees extend to the entire whole, and thus to each
     and every part regardless of who wrote it.

     Thus, it is not the intent of this section to claim rights or
     contest your rights to work written entirely by you; rather, the
     intent is to exercise the right to control the distribution of
     derivative or collective works based on the Library.

     In addition, mere aggregation of another work not based on the
     Library with the Library (or with a work based on the Library) on
     a volume of a storage or distribution medium does not bring the
     other work under the scope of this License.

  3. You may opt to apply the terms of the ordinary GNU General Public
     License instead of this License to a given copy of the Library.
     To do this, you must alter all the notices that refer to this
     License, so that they refer to the ordinary GNU General Public
     License, version 2, instead of to this License.  (If a newer
     version than version 2 of the ordinary GNU General Public License
     has appeared, then you can specify that version instead if you
     wish.)  Do not make any other change in these notices.

     Once this change is made in a given copy, it is irreversible for
     that copy, so the ordinary GNU General Public License applies to
     all subsequent copies and derivative works made from that copy.

     This option is useful when you wish to copy part of the code of
     the Library into a program that is not a library.

  4. You may copy and distribute the Library (or a portion or
     derivative of it, under Section 2) in object code or executable
     form under the terms of Sections 1 and 2 above provided that you
     accompany it with the complete corresponding machine-readable
     source code, which must be distributed under the terms of Sections
     1 and 2 above on a medium customarily used for software
     interchange.

     If distribution of object code is made by offering access to copy
     from a designated place, then offering equivalent access to copy
     the source code from the same place satisfies the requirement to
     distribute the source code, even though third parties are not
     compelled to copy the source along with the object code.

  5. A program that contains no derivative of any portion of the
     Library, but is designed to work with the Library by being
     compiled or linked with it, is called a "work that uses the
     Library".  Such a work, in isolation, is not a derivative work of
     the Library, and therefore falls outside the scope of this License.

     However, linking a "work that uses the Library" with the Library
     creates an executable that is a derivative of the Library (because
     it contains portions of the Library), rather than a "work that
     uses the library".  The executable is therefore covered by this
     License.  Section 6 states terms for distribution of such
     executables.

     When a "work that uses the Library" uses material from a header
     file that is part of the Library, the object code for the work may
     be a derivative work of the Library even though the source code is
     not.  Whether this is true is especially significant if the work
     can be linked without the Library, or if the work is itself a
     library.  The threshold for this to be true is not precisely
     defined by law.

     If such an object file uses only numerical parameters, data
     structure layouts and accessors, and small macros and small inline
     functions (ten lines or less in length), then the use of the object
     file is unrestricted, regardless of whether it is legally a
     derivative work.  (Executables containing this object code plus
     portions of the Library will still fall under Section 6.)

     Otherwise, if the work is a derivative of the Library, you may
     distribute the object code for the work under the terms of Section
     6.  Any executables containing that work also fall under Section 6,
     whether or not they are linked directly with the Library itself.

  6. As an exception to the Sections above, you may also combine or
     link a "work that uses the Library" with the Library to produce a
     work containing portions of the Library, and distribute that work
     under terms of your choice, provided that the terms permit
     modification of the work for the customer's own use and reverse
     engineering for debugging such modifications.

     You must give prominent notice with each copy of the work that the
     Library is used in it and that the Library and its use are covered
     by this License.  You must supply a copy of this License.  If the
     work during execution displays copyright notices, you must include
     the copyright notice for the Library among them, as well as a
     reference directing the user to the copy of this License.  Also,
     you must do one of these things:

       a. Accompany the work with the complete corresponding
          machine-readable source code for the Library including
          whatever changes were used in the work (which must be
          distributed under Sections 1 and 2 above); and, if the work
          is an executable linked with the Library, with the complete
          machine-readable "work that uses the Library", as object code
          and/or source code, so that the user can modify the Library
          and then relink to produce a modified executable containing
          the modified Library.  (It is understood that the user who
          changes the contents of definitions files in the Library will
          not necessarily be able to recompile the application to use
          the modified definitions.)

       b. Use a suitable shared library mechanism for linking with the
          Library.  A suitable mechanism is one that (1) uses at run
          time a copy of the library already present on the user's
          computer system, rather than copying library functions into
          the executable, and (2) will operate properly with a modified
          version of the library, if the user installs one, as long as
          the modified version is interface-compatible with the version
          that the work was made with.

       c. Accompany the work with a written offer, valid for at least
          three years, to give the same user the materials specified in
          Subsection 6a, above, for a charge no more than the cost of
          performing this distribution.

       d. If distribution of the work is made by offering access to copy
          from a designated place, offer equivalent access to copy the
          above specified materials from the same place.

       e. Verify that the user has already received a copy of these
          materials or that you have already sent this user a copy.

     For an executable, the required form of the "work that uses the
     Library" must include any data and utility programs needed for
     reproducing the executable from it.  However, as a special
     exception, the materials to be distributed need not include
     anything that is normally distributed (in either source or binary
     form) with the major components (compiler, kernel, and so on) of
     the operating system on which the executable runs, unless that
     component itself accompanies the executable.

     It may happen that this requirement contradicts the license
     restrictions of other proprietary libraries that do not normally
     accompany the operating system.  Such a contradiction means you
     cannot use both them and the Library together in an executable
     that you distribute.

  7. You may place library facilities that are a work based on the
     Library side-by-side in a single library together with other
     library facilities not covered by this License, and distribute
     such a combined library, provided that the separate distribution
     of the work based on the Library and of the other library
     facilities is otherwise permitted, and provided that you do these
     two things:

       a. Accompany the combined library with a copy of the same work
          based on the Library, uncombined with any other library
          facilities.  This must be distributed under the terms of the
          Sections above.

       b. Give prominent notice with the combined library of the fact
          that part of it is a work based on the Library, and explaining
          where to find the accompanying uncombined form of the same
          work.

  8. You may not copy, modify, sublicense, link with, or distribute the
     Library except as expressly provided under this License.  Any
     attempt otherwise to copy, modify, sublicense, link with, or
     distribute the Library is void, and will automatically terminate
     your rights under this License.  However, parties who have
     received copies, or rights, from you under this License will not
     have their licenses terminated so long as such parties remain in
     full compliance.

  9. You are not required to accept this License, since you have not
     signed it.  However, nothing else grants you permission to modify
     or distribute the Library or its derivative works.  These actions
     are prohibited by law if you do not accept this License.
     Therefore, by modifying or distributing the Library (or any work
     based on the Library), you indicate your acceptance of this
     License to do so, and all its terms and conditions for copying,
     distributing or modifying the Library or works based on it.

 10. Each time you redistribute the Library (or any work based on the
     Library), the recipient automatically receives a license from the
     original licensor to copy, distribute, link with or modify the
     Library subject to these terms and conditions.  You may not impose
     any further restrictions on the recipients' exercise of the rights
     granted herein.  You are not responsible for enforcing compliance
     by third parties with this License.

 11. If, as a consequence of a court judgment or allegation of patent
     infringement or for any other reason (not limited to patent
     issues), conditions are imposed on you (whether by court order,
     agreement or otherwise) that contradict the conditions of this
     License, they do not excuse you from the conditions of this
     License.  If you cannot distribute so as to satisfy simultaneously
     your obligations under this License and any other pertinent
     obligations, then as a consequence you may not distribute the
     Library at all.  For example, if a patent license would not permit
     royalty-free redistribution of the Library by all those who
     receive copies directly or indirectly through you, then the only
     way you could satisfy both it and this License would be to refrain
     entirely from distribution of the Library.

     If any portion of this section is held invalid or unenforceable
     under any particular circumstance, the balance of the section is
     intended to apply, and the section as a whole is intended to apply
     in other circumstances.

     It is not the purpose of this section to induce you to infringe any
     patents or other property right claims or to contest validity of
     any such claims; this section has the sole purpose of protecting
     the integrity of the free software distribution system which is
     implemented by public license practices.  Many people have made
     generous contributions to the wide range of software distributed
     through that system in reliance on consistent application of that
     system; it is up to the author/donor to decide if he or she is
     willing to distribute software through any other system and a
     licensee cannot impose that choice.

     This section is intended to make thoroughly clear what is believed
     to be a consequence of the rest of this License.

 12. If the distribution and/or use of the Library is restricted in
     certain countries either by patents or by copyrighted interfaces,
     the original copyright holder who places the Library under this
     License may add an explicit geographical distribution limitation
     excluding those countries, so that distribution is permitted only
     in or among countries not thus excluded.  In such case, this
     License incorporates the limitation as if written in the body of
     this License.

 13. The Free Software Foundation may publish revised and/or new
     versions of the Lesser General Public License from time to time.
     Such new versions will be similar in spirit to the present version,
     but may differ in detail to address new problems or concerns.

     Each version is given a distinguishing version number.  If the
     Library specifies a version number of this License which applies
     to it and "any later version", you have the option of following
     the terms and conditions either of that version or of any later
     version published by the Free Software Foundation.  If the Library
     does not specify a license version number, you may choose any
     version ever published by the Free Software Foundation.

 14. If you wish to incorporate parts of the Library into other free
     programs whose distribution conditions are incompatible with these,
     write to the author to ask for permission.  For software which is
     copyrighted by the Free Software Foundation, write to the Free
     Software Foundation; we sometimes make exceptions for this.  Our
     decision will be guided by the two goals of preserving the free
     status of all derivatives of our free software and of promoting
     the sharing and reuse of software generally.

                                NO WARRANTY

 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
     WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE
     LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
     HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT
     WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
     NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
     FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE
     QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU.  SHOULD THE
     LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
     SERVICING, REPAIR OR CORRECTION.

 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
     WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
     MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE
     LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
     INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
     INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF
     DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
     OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY
     OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
     ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

                      END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Libraries
----------------------------------------------

   If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change.  You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of
the ordinary General Public License).

   To apply these terms, attach the following notices to the library.
It is safest to attach them to the start of each source file to most
effectively convey the exclusion of warranty; and each file should have
at least the "copyright" line and a pointer to where the full notice is
found.

     ONE LINE TO GIVE THE LIBRARY'S NAME AND AN IDEA OF WHAT IT DOES.
     Copyright (C) YEAR  NAME OF AUTHOR
     
     This library is free software; you can redistribute it and/or modify it
     under the terms of the GNU Lesser General Public License as published by
     the Free Software Foundation; either version 2.1 of the License, or (at
     your option) any later version.
     
     This library is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Lesser General Public License for more details.
     
     You should have received a copy of the GNU Lesser General Public
     License along with this library; if not, write to the Free Software
     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307,
     USA.

   Also add information on how to contact you by electronic and paper
mail.

   You should also get your employer (if you work as a programmer) or
your school, if any, to sign a "copyright disclaimer" for the library,
if necessary.  Here is a sample; alter the names:

     Yoyodyne, Inc., hereby disclaims all copyright interest in the library
     `Frob' (a library for tweaking knobs) written by James Random Hacker.
     
     SIGNATURE OF TY COON, 1 April 1990
     Ty Coon, President of Vice

   That's all there is to it!


File: libiberty.info,  Node: BSD,  Prev: Library Copying,  Up: Licenses

BSD
===

   Copyright (C) 1990 Regents of the University of California.  All
rights reserved.

   Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

  1. Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the
     distribution.

  3. [rescinded 22 July 1999]

  4. Neither the name of the University nor the names of its
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.


   THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


File: libiberty.info,  Node: Index,  Prev: Licenses,  Up: Top

Index
*****

* Menu:

* alignment (in obstacks):               Obstacks Data Alignment.
* alloca:                                Functions.
* allocation (obstacks):                 Allocation in an Obstack.
* asprintf:                              Functions.
* atexit:                                Functions.
* basename:                              Functions.
* bcmp:                                  Functions.
* bcopy:                                 Functions.
* bsearch:                               Functions.
* buildargv:                             Functions.
* bzero:                                 Functions.
* calloc:                                Functions.
* changing the size of a block (obstacks): Growing Objects.
* choose_temp_base:                      Functions.
* choose_tmpdir:                         Functions.
* chunks:                                Obstack Chunks.
* clock:                                 Functions.
* concat:                                Functions.
* dupargv:                               Functions.
* efficiency and obstacks:               Extra Fast Growing.
* efficiency of chunks:                  Obstack Chunks.
* errno_max:                             Functions.
* error reporting:                       Error Reporting.
* exit handlers:                         Exit Handlers.
* extensions:                            Extensions.
* fdmatch:                               Functions.
* ffs:                                   Functions.
* fnmatch:                               Functions.
* freeargv:                              Functions.
* freeing (obstacks):                    Freeing Obstack Objects.
* functions, extension:                  Extensions.
* functions, missing:                    Supplemental Functions.
* functions, replacement:                Replacement Functions.
* functions, supplemental:               Supplemental Functions.
* get_run_time:                          Functions.
* getcwd:                                Functions.
* getpagesize:                           Functions.
* getpwd:                                Functions.
* growing objects (in obstacks):         Growing Objects.
* hex_init:                              Functions.
* hex_p:                                 Functions.
* hex_value:                             Functions.
* how to use:                            Using.
* index:                                 Functions.
* initstate:                             Functions.
* insque:                                Functions.
* lbasename:                             Functions.
* LGPL, Lesser General Public License:   Library Copying.
* libiberty usage:                       Using.
* lrealpath:                             Functions.
* macros:                                Obstack Functions.
* make_relative_prefix:                  Functions.
* make_temp_file:                        Functions.
* memchr:                                Functions.
* memcmp:                                Functions.
* memcpy:                                Functions.
* memmove:                               Functions.
* memory allocation:                     Memory Allocation.
* mempcpy:                               Functions.
* memset:                                Functions.
* mkstemps:                              Functions.
* obstack status:                        Status of an Obstack.
* obstack.h:                             Creating Obstacks.
* obstack_1grow:                         Growing Objects.
* obstack_1grow_fast:                    Extra Fast Growing.
* obstack_alignment_mask:                Obstacks Data Alignment.
* obstack_alloc:                         Allocation in an Obstack.
* obstack_alloc_failed_handler:          Preparing for Obstacks.
* obstack_base:                          Status of an Obstack.
* obstack_blank:                         Growing Objects.
* obstack_blank_fast:                    Extra Fast Growing.
* obstack_chunk_alloc:                   Preparing for Obstacks.
* obstack_chunk_free:                    Preparing for Obstacks.
* obstack_chunk_size:                    Obstack Chunks.
* obstack_copy:                          Allocation in an Obstack.
* obstack_copy0:                         Allocation in an Obstack.
* obstack_finish:                        Growing Objects.
* obstack_free:                          Freeing Obstack Objects.
* obstack_grow:                          Growing Objects.
* obstack_grow0:                         Growing Objects.
* obstack_init:                          Preparing for Obstacks.
* obstack_int_grow:                      Growing Objects.
* obstack_int_grow_fast:                 Extra Fast Growing.
* obstack_next_free:                     Status of an Obstack.
* obstack_object_size <1>:               Growing Objects.
* obstack_object_size:                   Status of an Obstack.
* obstack_ptr_grow:                      Growing Objects.
* obstack_ptr_grow_fast:                 Extra Fast Growing.
* obstack_room:                          Extra Fast Growing.
* obstacks:                              Obstacks.
* pexecute:                              Functions.
* psignal:                               Functions.
* putenv:                                Functions.
* pwait:                                 Functions.
* random:                                Functions.
* reconcat:                              Functions.
* remque:                                Functions.
* rename:                                Functions.
* replacement functions:                 Replacement Functions.
* rindex:                                Functions.
* setenv:                                Functions.
* setstate:                              Functions.
* shrinking objects:                     Growing Objects.
* signo_max:                             Functions.
* sigsetmask:                            Functions.
* snprintf:                              Functions.
* spaces:                                Functions.
* srandom:                               Functions.
* status of obstack:                     Status of an Obstack.
* stpcpy:                                Functions.
* stpncpy:                               Functions.
* strcasecmp:                            Functions.
* strchr:                                Functions.
* strdup:                                Functions.
* strerrno:                              Functions.
* strerror:                              Functions.
* strncasecmp:                           Functions.
* strncmp:                               Functions.
* strrchr:                               Functions.
* strsignal:                             Functions.
* strsigno:                              Functions.
* strstr:                                Functions.
* strtod:                                Functions.
* strtoerrno:                            Functions.
* strtol:                                Functions.
* strtosigno:                            Functions.
* strtoul:                               Functions.
* supplemental functions:                Supplemental Functions.
* tmpnam:                                Functions.
* unsetenv:                              Functions.
* using libiberty:                       Using.
* vasprintf:                             Functions.
* vfork:                                 Functions.
* vfprintf:                              Functions.
* vprintf:                               Functions.
* vsnprintf:                             Functions.
* vsprintf:                              Functions.
* waitpid:                               Functions.
* xatexit:                               Functions.
* xcalloc:                               Functions.
* xexit:                                 Functions.
* xmalloc:                               Functions.
* xmalloc_failed:                        Functions.
* xmalloc_set_program_name:              Functions.
* xmemdup:                               Functions.
* xrealloc:                              Functions.
* xstrdup:                               Functions.
* xstrerror:                             Functions.



Tag Table:
Node: Top907
Node: Using1654
Node: Overview3247
Node: Supplemental Functions3873
Node: Replacement Functions5021
Node: Memory Allocation6165
Node: Exit Handlers6652
Node: Error Reporting6990
Node: Extensions7315
Node: Obstacks7847
Node: Creating Obstacks9426
Node: Preparing for Obstacks11330
Node: Allocation in an Obstack14157
Node: Freeing Obstack Objects16592
Node: Obstack Functions17931
Node: Growing Objects20189
Node: Extra Fast Growing24439
Node: Status of an Obstack28063
Node: Obstacks Data Alignment29487
Node: Obstack Chunks31178
Node: Summary of Obstacks33538
Node: Functions36957
Node: Licenses71281
Node: Library Copying71516
Node: BSD99658
Node: Index101307

End Tag Table
