Mercurial > pub > dyncall > dyncall
annotate dynload/dynload.3 @ 243:2a77747a5496
dynload doc:
- improved overall
- added dlGetLibraryPath description:
- BUGS section to manpage
| author | Tassilo Philipp |
|---|---|
| date | Thu, 04 May 2017 13:54:09 +0200 |
| parents | f8a6e60598cc |
| children | ab23f9f2934a |
| rev | line source |
|---|---|
|
216
28bf0b231bce
- dynload man page clarification about resolving own symbols
Tassilo Philipp
parents:
93
diff
changeset
|
1 .\" Copyright (c) 2007-2017 Daniel Adler <dadler AT uni-goettingen DOT de>, |
| 0 | 2 .\" Tassilo Philipp <tphilipp AT potion-studios DOT com> |
| 3 .\" | |
| 4 .\" Permission to use, copy, modify, and distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
| 16 .Dd $Mdocdate$ | |
| 17 .Dt dynload 3 | |
| 18 .Sh NAME | |
| 19 .Nm dynload | |
| 20 .Nd encapsulates dynamic loading mechanisms and | |
| 21 gives access to functions in foreign dynamic libraries and code modules. | |
| 22 .Sh SYNOPSIS | |
| 23 .In dynload.h | |
| 24 .Ft DLLib * | |
| 25 .Fn dlLoadLibrary "const char * libpath" | |
| 26 .Ft void | |
| 27 .Fn dlFreeLibrary "DLLib * pLib" | |
| 28 .Ft void * | |
|
216
28bf0b231bce
- dynload man page clarification about resolving own symbols
Tassilo Philipp
parents:
93
diff
changeset
|
29 .Fn dlFindSymbol "DLLib * pLib" "const char * pSymbolName" |
| 243 | 30 .Ft int |
| 31 .Fn dlGetLibraryPath "DLLib * pLib" "char * sOut" "int bufSize" | |
| 228 | 32 .Ft DLSyms* |
| 33 .Fn dlSymsInit "const char * libPath" | |
| 34 .Ft void | |
| 35 .Fn dlSymsCleanup "DLSyms * pSyms" | |
| 36 .Ft int | |
| 37 .Fn dlSymsCount "DLSyms * pSyms" | |
| 38 .Ft const char* | |
| 39 .Fn dlSymsName "DLSyms * pSyms" "int index" | |
| 40 .Ft const char* | |
| 41 .Fn dlSymsNameFromValue "DLSyms * pSyms" "void * value" | |
| 0 | 42 .Sh DESCRIPTION |
| 43 The | |
| 44 .Nm | |
| 45 library provides an interface to load foreign dynamic libraries and access | |
| 46 to their symbols. | |
| 47 .Pp | |
| 48 .Fn dlLoadLibrary | |
| 49 loads a dynamic library at | |
| 50 .Ar libpath | |
| 51 and returns a handle to it for use in | |
| 52 .Fn dlFreeLibrary | |
| 53 and | |
| 54 .Fn dlFindSymbol | |
|
216
28bf0b231bce
- dynload man page clarification about resolving own symbols
Tassilo Philipp
parents:
93
diff
changeset
|
55 calls. Passing a null pointer for the |
|
28bf0b231bce
- dynload man page clarification about resolving own symbols
Tassilo Philipp
parents:
93
diff
changeset
|
56 .Ar libpath |
| 243 | 57 argument is valid, and returns a handle to the main executable of the calling code. Also, searching libraries in library paths (e.g. by just passing the library's leaf name) should work, however, they are OS specific. Returns a null pointer on error. |
| 0 | 58 .Pp |
| 59 .Fn dlFreeLibrary | |
| 60 frees the loaded library with handle | |
| 61 .Ar pLib . | |
| 62 .Pp | |
| 63 .Fn dlFindSymbol | |
| 64 returns a pointer to a symbol with name | |
| 65 .Ar pSymbolName | |
| 66 in the library with handle | |
| 67 .Ar pLib , | |
|
223
7076f551faf5
- dynload mach-o handling fixes for 64bit platforms
Tassilo Philipp
parents:
216
diff
changeset
|
68 or returns a null pointer if the symbol cannot be found. The name is specified as it would appear in C source code (mangled if C++, etc.). |
| 228 | 69 .Pp |
| 243 | 70 .Fn dlGetLibraryPath |
| 71 can be used to get a copy of the path to the library loaded with handle | |
| 72 .Ar pLib . | |
| 73 The parameter | |
| 74 .Ar sOut | |
| 75 is a pointer to a buffer of size | |
| 76 .Ar bufSize | |
| 77 (in bytes), to hold the output string. The return value is the size of the buffer (in bytes) needed to hold the null-terminated string, or 0 if it can't be looked up. If | |
| 78 .Ar bufSize | |
| 79 >= return value > 1, a null-terminted string with the path to the library should be in | |
| 80 .Ar sOut . | |
| 81 .Pp | |
| 82 The dlSyms* functions can be used to iterate over symbols. Since they can be used on libraries that are not linked, they are made | |
| 83 for symbol name lookups, not to get symbols' addresses. For that refer to | |
| 228 | 84 .Fn dlFindSymbol . |
| 85 .Fn dlSymsInit | |
| 86 will return a handle (or null pointer on error) to the shared object specified by | |
| 243 | 87 .Ar libPath , |
| 88 to be used with the other dlSyms* functions. Note that contrary to loading and linking libraries, no (OS-specific) rules for searching libraries in library paths, etc. apply. The handle must be freed with | |
| 228 | 89 .Fn dlSymsCleanup . |
| 90 .Fn dlSymsCount | |
| 91 returns the number of symbols in the shared object, | |
| 92 .Fn dlSymsName | |
| 93 and | |
| 94 .Fn dlSymsNameFromValue | |
| 95 are used to lookup symbol names using an index or symbol's address, respectively, returning a null pointer on error. The names are returned as they would appear in C source code (mangled if C++, etc.). The address passed to | |
| 96 .Fn dlSymsNameFromValue | |
| 97 must point to a loaded symbol. | |
| 243 | 98 .Sh BUGS |
| 99 .Fn dlGetLibraryPath | |
| 100 and | |
| 101 .Fn dlSymsInit | |
| 102 are not thread-safe on Darwin (macOS, iOS, ...). | |
| 0 | 103 .Sh SEE ALSO |
| 104 .Xr dyncall 3 , | |
| 105 .Xr dyncallback 3 | |
| 93 | 106 and the dyncall manual (available in HTML and PDF format) for more information. |
| 0 | 107 .Sh AUTHORS |
| 108 .An "Daniel Adler" Aq dadler@uni-goettingen.de | |
| 109 .An "Tassilo Philipp" Aq tphilipp@potion-studios.com |