dlsym, dlvsym — obtain address of a symbol in a shared object or executable
#include <dlfcn.h>
void
*dlsym( |
void *handle, |
const char *symbol) ; |
#define _GNU_SOURCE #include <dlfcn.h>
void
*dlvsym( |
void *handle, |
char *symbol, | |
char *version) ; |
Note | |
---|---|
Link with |
The function dlsym
() takes a
"handle" of a dynamic loaded shared object returned by
dlopen(3) along with a
null-terminated symbol name, and returns the address where
that symbol is loaded into memory. If the symbol is not
found, in the specified object or any of the shared objects
that were automatically loaded by dlopen(3) when that object
was loaded, dlsym
() returns
NULL. (The search performed by dlsym
() is breadth first through the
dependency tree of these shared objects.)
Since the value of the symbol could actually be NULL (so
that a NULL return from dlsym
()
need not indicate an error), the correct way to test for an
error is to call dlerror(3) to clear any old
error conditions, then call dlsym
(), and then call dlerror(3) again, saving
its return value into a variable, and check whether this
saved value is not NULL.
There are two special pseudo-handles that may be specified
in handle
:
RTLD_DEFAULT
Find the first occurrence of the desired symbol
using the default shared object search order. The
search will include global symbols in the executable
and its dependencies, as well as symbols in shared
objects that were dynamically loaded with the
RTLD_GLOBAL
flag.
RTLD_NEXT
Find the next occurrence of the desired symbol in
the search order after the current object. This allows
one to provide a wrapper around a function in another
shared object, so that, for example, the definition of
a function in a preloaded shared object (see
LD_PRELOAD
in ld.so(8)) can find
and invoke the "real" function provided in another
shared object (or for that matter, the "next"
definition of the function in cases where there are
multiple layers of preloading).
The function dlvsym
() does
the same as dlsym
() but takes a
version string as an additional argument.
On success, these functions return the address associated
with symbol
. On
failure, they return NULL; the cause of the error can be
diagnosed using dlerror(3).
For an explanation of the terms used in this section, see attributes(7).
Interface | Attribute | Value |
dlsym (), dlvsym () |
Thread safety | MT-Safe |
This page is part of release 4.07 of the Linux man-pages
project. A
description of the project, information about reporting bugs,
and the latest version of this page, can be found at
https://www.kernel.org/doc/man−pages/.
Copyright 1995 Yggdrasil Computing, Incorporated. and Copyright 2003, 2015 Michael Kerrisk <mtk.manpagesgmail.com> %%%LICENSE_START(GPLv2+_DOC_FULL) This is free documentation; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. The GNU General Public License's references to "object code" and "executables" are to be interpreted as the output of any document formatting or typesetting system, including intermediate and printed output. This manual 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 General Public License for more details. You should have received a copy of the GNU General Public License along with this manual; if not, see <http://www.gnu.org/licenses/>. %%%LICENSE_END |