NAME
dlclose — close a
symbol table handle
SYNOPSIS
#include
<dlfcn.h>
int dlclose(void *handle);
DESCRIPTION
The dlclose () function shall inform the
system that the symbol table handle specified by handle is
no longer needed by the application.
An application writer may use dlclose ()
to make a statement of intent on the part of the process, but this statement
does not create any requirement upon the implementation. When the symbol
table handle is closed, the implementation may unload the executable object
files that were loaded by dlopen(3) when the symbol table
handle was opened and those that were loaded by dlsym(3)
when using the symbol table handle identified by
handle.
Once a symbol table handle has been closed, an application should assume that any symbols (function identifiers and data object identifiers) made visible using handle, are no longer available to the process.
Although a dlclose () operation is not
required to remove any functions or data objects from the address space,
neither is an implementation prohibited from doing so. The only restriction
on such a removal is that no function nor data object shall be removed to
which references have been relocated, until or unless all such references
are removed. For instance, an executable object file that had been loaded
with a dlopen(3) operation specifying the RTLD_GLOBAL flag
might provide a target for dynamic relocations performed in the processing
of other relocatable objects-in such environments, an application may assume
that no relocation, once made, shall be undone or remade unless the
executable object file containing the relocated object has itself been
removed.
RETURN VALUE
If the referenced symbol table handle was successfully closed,
dlclose () shall return 0. If
handle does not refer to an open symbol table handle or if
the symbol table handle could not be closed, dlclose
() shall return a non-zero value. More detailed diagnostic information shall
be available through dlerror(3).
ERRORS
No errors are defined.
EXAMPLES
The following example illustrates use of
dlopen(3) and dlclose ():
#include <dlfcn.h>
int eret;
void *mylib;
...
/* Open a dynamic library and then close it ... */
mylib = dlopen("mylib.so", RTLD_LOCAL | RTLD_LAZY);
...
eret = dlclose(mylib);
...
APPLICATION USAGE
A conforming application should employ a symbol table handle
returned from a dlopen(3) invocation only within a given
scope bracketed by a dlopen(3) operation and the
corresponding dlclose () operation. Implementations
are free to use reference counting or other techniques such that multiple
calls to dlopen(3) referencing the same executable object
file may return a pointer to the same data object as the symbol table
handle.
Implementations are also free to re-use a handle. For these
reasons, the value of a handle must be treated as an opaque data type by the
application, used only in calls to dlsym(3) and
dlclose ().
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
dlerror(3), dlopen(3), dlsym(3)
XBD <dlfcn.h>
CHANGE HISTORY
First released in Issue 5.
Issue 6
The DESCRIPTION is updated to say that the referenced object is closed "if this is the last reference to it".
Issue 7
The dlopen(3) function is moved from the XSI option to Base.
POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0069 [74] is applied.