3 * Written: 8/31/94 by Wayne Scott (wscott@ichips.intel.com)
5 * All I did was take Jens-Uwe Mager's libdl emulation library for
6 * AIX and merged it with the dl_dlopen.xs file to create a dynamic library
7 * package that works for AIX.
9 * I did change all malloc's, free's, strdup's, calloc's to use the perl
10 * equilvant. I also removed some stuff we will not need. Call fini()
11 * on statup... It can probably be trimmed more.
14 #define PERLIO_NOT_STDIO 0
17 * On AIX 4.3 and above the emulation layer is not needed any more, and
18 * indeed if perl uses its emulation and perl is linked into apache
19 * which is supposed to use the native dlopen conflicts arise.
20 * Jens-Uwe Mager jum@helios.de
22 #ifdef USE_NATIVE_DLOPEN
29 #include "dlutils.c" /* SaveError() etc */
34 * @(#)dlfcn.c 1.5 revision of 93/02/14 20:14:17
35 * This is an unpublished work copyright (c) 1992 Helios Software GmbH
36 * 3000 Hannover 1, Germany
42 /* When building as a 64-bit binary on AIX, define this to get the
43 * correct structure definitions. Also determines the field-name
44 * macros and gates some logic in readEntries(). -- Steven N. Hirsch
45 * <hirschs@btv.ibm.com> */
55 #include <sys/types.h>
63 # define AIX_SCNHDR SCNHDR_64
64 # define AIX_LDHDR LDHDR_64
65 # define AIX_LDSYM LDSYM_64
66 # define AIX_LDHDRSZ LDHDRSZ_64
68 # define AIX_SCNHDR SCNHDR
69 # define AIX_LDHDR LDHDR
70 # define AIX_LDSYM LDSYM
71 # define AIX_LDHDRSZ LDHDRSZ
74 /* When using Perl extensions written in C++ the longer versions
75 * of load() and unload() from libC and libC_r need to be used,
76 * otherwise statics in the extensions won't get initialized right.
77 * -- Stephanie Beals <bealzy@us.ibm.com> */
79 /* Older AIX C compilers cannot deal with C++ double-slash comments in
80 the ibmcxx and/or xlC includes. Since we only need a single file,
81 be more fine-grained about what's included <hirschs@btv.ibm.com> */
83 #ifdef USE_libC /* The define comes, when it comes, from hints/aix.pl. */
84 # define LOAD loadAndInit
85 # define UNLOAD terminateAndUnload
86 # if defined(USE_vacpp_load_h)
87 # include "/usr/vacpp/include/load.h"
88 # elif defined(USE_ibmcxx_load_h)
89 # include "/usr/ibmcxx/include/load.h"
90 # elif defined(USE_xlC_load_h)
91 # include "/usr/lpp/xlC/include/load.h"
92 # elif defined(USE_load_h)
93 # include "/usr/include/load.h"
97 # define UNLOAD unload
101 * AIX 4.3 does remove some useful definitions from ldfcn.h. Define
102 * these here to compensate for that lossage.
105 # define BEGINNING SEEK_SET
108 # define FSEEK(ldptr,o,p) fseek(IOPTR(ldptr),(p==BEGINNING)?(OFFSET(ldptr) +o):o,p)
111 # define FREAD(p,s,n,ldptr) fread(p,s,n,IOPTR(ldptr))
118 # define RTLD_GLOBAL 0
122 * We simulate dlopen() et al. through a call to load. Because AIX has
123 * no call to find an exported symbol we read the loader section of the
124 * loaded module and build a list of exported symbols and their virtual
129 char *name; /* the symbols's name */
130 void *addr; /* its relocated virtual address */
131 } Export, *ExportPtr;
134 * The void * handle returned from dlopen is actually a ModulePtr.
136 typedef struct Module {
138 char *name; /* module name for refcounting */
139 int refCnt; /* the number of references */
140 void *entry; /* entry point from load */
141 int nExports; /* the number of exports found */
142 ExportPtr exports; /* the array of exports */
143 } Module, *ModulePtr;
147 * We keep a list of all loaded modules to be able to reference count
148 * duplicate dlopen's.
153 * The last error from one of the dl* routines is kept in static
154 * variables here. Each error is returned only once to the caller.
156 char x_errbuf[BUFSIZ];
159 } my_cxtx_t; /* this *must* be named my_cxtx_t */
161 #define DL_CXT_EXTRA /* ask for dl_cxtx to be defined in dlutils.c */
162 #include "dlutils.c" /* SaveError() etc */
164 #define dl_modList (dl_cxtx.x_modList)
165 #define dl_errbuf (dl_cxtx.x_errbuf)
166 #define dl_errvalid (dl_cxtx.x_errvalid)
167 #define dl_mainModule (dl_cxtx.x_mainModule)
169 static void caterr(char *);
170 static int readExports(ModulePtr);
171 static void *findMain(void);
173 /* these statics are ok because they're constants */
174 static char *strerror_failed = "(strerror failed)";
175 static char *strerror_r_failed = "(strerror_r failed)";
177 char *strerrorcat(char *str, int err) {
178 int strsiz = strlen(str);
184 if ((msg = strerror(err)) == 0)
185 msg = strerror_failed;
186 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
187 if (strsiz + msgsiz < BUFSIZ) /* Do not move this after #endif. */
193 char *strerrorcpy(char *str, int err) {
199 if ((msg = strerror(err)) == 0)
200 msg = strerror_failed;
201 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
202 if (msgsiz < BUFSIZ) /* Do not move this after #endif. */
209 void *dlopen(char *path, int mode)
213 register ModulePtr mp;
216 * Upon the first call register a terminate handler that will
217 * close all libraries.
219 if (dl_mainModule == NULL) {
220 if ((dl_mainModule = findMain()) == NULL)
224 * Scan the list of modules if have the module already loaded.
226 for (mp = dl_modList; mp; mp = mp->next)
227 if (strcmp(mp->name, path) == 0) {
234 strcpy(dl_errbuf, "Newz: ");
235 strerrorcat(dl_errbuf, errno);
239 if ((mp->name = savepv(path)) == NULL) {
241 strcpy(dl_errbuf, "savepv: ");
242 strerrorcat(dl_errbuf, errno);
248 * load should be declared load(const char *...). Thus we
249 * cast the path to a normal char *. Ugly.
251 if ((mp->entry = (void *)LOAD((char *)path,
252 #ifdef L_LIBPATH_EXEC
257 int saverrno = errno;
262 strcpy(dl_errbuf, "dlopen: ");
263 strcat(dl_errbuf, path);
264 strcat(dl_errbuf, ": ");
266 * If AIX says the file is not executable, the error
267 * can be further described by querying the loader about
270 if (saverrno == ENOEXEC) {
271 char *moreinfo[BUFSIZ/sizeof(char *)];
272 if (loadquery(L_GETMESSAGES, moreinfo, sizeof(moreinfo)) == -1)
273 strerrorcpy(dl_errbuf, saverrno);
276 for (p = moreinfo; *p; p++)
280 strerrorcat(dl_errbuf, saverrno);
284 mp->next = dl_modList;
287 * Assume anonymous exports come from the module this dlopen
288 * is linked into, that holds true as long as dlopen and all
289 * of the perl core are in the same shared object. Also bind
290 * against the main part, in the case a perl is not the main
291 * part, e.g mod_perl as DSO in Apache so perl modules can
292 * also reference Apache symbols.
294 if (loadbind(0, (void *)dlopen, mp->entry) == -1 ||
295 loadbind(0, dl_mainModule, mp->entry)) {
296 int saverrno = errno;
300 strcpy(dl_errbuf, "loadbind: ");
301 strerrorcat(dl_errbuf, saverrno);
304 if (readExports(mp) == -1) {
312 * Attempt to decipher an AIX loader error message and append it
313 * to our static error message buffer.
315 static void caterr(char *s)
319 register char *p = s;
321 while (*p >= '0' && *p <= '9')
324 case L_ERROR_TOOMANY:
325 strcat(dl_errbuf, "too many errors");
328 strcat(dl_errbuf, "can't load library");
329 strcat(dl_errbuf, p);
332 strcat(dl_errbuf, "can't find symbol");
333 strcat(dl_errbuf, p);
336 strcat(dl_errbuf, "bad RLD");
337 strcat(dl_errbuf, p);
340 strcat(dl_errbuf, "bad exec format in");
341 strcat(dl_errbuf, p);
344 strerrorcat(dl_errbuf, atoi(++p));
347 strcat(dl_errbuf, s);
352 void *dlsym(void *handle, const char *symbol)
356 register ModulePtr mp = (ModulePtr)handle;
357 register ExportPtr ep;
361 * Could speed up search, but I assume that one assigns
362 * the result to function pointers anyways.
364 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
365 if (strcmp(ep->name, symbol) == 0)
368 strcpy(dl_errbuf, "dlsym: undefined symbol ");
369 strcat(dl_errbuf, symbol);
384 int dlclose(void *handle)
388 register ModulePtr mp = (ModulePtr)handle;
390 register ModulePtr mp1;
392 if (--mp->refCnt > 0)
394 result = UNLOAD(mp->entry);
397 strerrorcpy(dl_errbuf, errno);
400 register ExportPtr ep;
402 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
405 safefree(mp->exports);
407 if (mp == dl_modList)
408 dl_modList = mp->next;
410 for (mp1 = dl_modList; mp1; mp1 = mp1->next)
411 if (mp1->next == mp) {
412 mp1->next = mp->next;
421 /* Added by Wayne Scott
422 * This is needed because the ldopen system call calls
423 * calloc to allocated a block of date. The ldclose call calls free.
424 * Without this we get this system calloc and perl's free, resulting
425 * in a "Bad free" message. This way we always use perl's malloc.
427 void *calloc(size_t ne, size_t sz)
431 out = (void *) safemalloc(ne*sz);
437 * Build the export table from the XCOFF .loader section.
439 static int readExports(ModulePtr mp)
451 if ((ldp = ldopen(mp->name, ldp)) == NULL) {
455 if (errno != ENOENT) {
457 strcpy(dl_errbuf, "readExports: ");
458 strerrorcat(dl_errbuf, errno);
462 * The module might be loaded due to the LIBPATH
463 * environment variable. Search for the loaded
464 * module using L_GETINFO.
466 if ((buf = safemalloc(size)) == NULL) {
468 strcpy(dl_errbuf, "readExports: ");
469 strerrorcat(dl_errbuf, errno);
472 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
475 if ((buf = safemalloc(size)) == NULL) {
477 strcpy(dl_errbuf, "readExports: ");
478 strerrorcat(dl_errbuf, errno);
484 strcpy(dl_errbuf, "readExports: ");
485 strerrorcat(dl_errbuf, errno);
490 * Traverse the list of loaded modules. The entry point
491 * returned by LOAD() does actually point to the data
494 lp = (struct ld_info *)buf;
496 if (lp->ldinfo_dataorg == mp->entry) {
497 ldp = ldopen(lp->ldinfo_filename, ldp);
500 if (lp->ldinfo_next == 0)
503 lp = (struct ld_info *)((char *)lp + lp->ldinfo_next);
508 strcpy(dl_errbuf, "readExports: ");
509 strerrorcat(dl_errbuf, errno);
513 #ifdef USE_64_BIT_ALL
514 if (TYPE(ldp) != U803XTOCMAGIC) {
516 if (TYPE(ldp) != U802TOCMAGIC) {
519 strcpy(dl_errbuf, "readExports: bad magic");
520 while(ldclose(ldp) == FAILURE)
524 if (ldnshread(ldp, _LOADER, &sh) != SUCCESS) {
526 strcpy(dl_errbuf, "readExports: cannot read loader section header");
527 while(ldclose(ldp) == FAILURE)
532 * We read the complete loader section in one chunk, this makes
533 * finding long symbol names residing in the string table easier.
535 if ((ldbuf = (char *)safemalloc(sh.s_size)) == NULL) {
537 strcpy(dl_errbuf, "readExports: ");
538 strerrorcat(dl_errbuf, errno);
539 while(ldclose(ldp) == FAILURE)
543 if (FSEEK(ldp, sh.s_scnptr, BEGINNING) != OKFSEEK) {
545 strcpy(dl_errbuf, "readExports: cannot seek to loader section");
547 while(ldclose(ldp) == FAILURE)
551 /* This first case is a hack, since it assumes that the 3rd parameter to
552 FREAD is 1. See the redefinition of FREAD above to see how this works. */
553 if (FREAD(ldbuf, sh.s_size, 1, ldp) != 1) {
555 strcpy(dl_errbuf, "readExports: cannot read loader section");
557 while(ldclose(ldp) == FAILURE)
561 lhp = (AIX_LDHDR *)ldbuf;
562 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
564 * Count the number of exports to include in our export table.
566 for (i = lhp->l_nsyms; i; i--, ls++) {
567 if (!LDR_EXPORT(*ls))
571 Newxz(mp->exports, mp->nExports, Export);
572 if (mp->exports == NULL) {
574 strcpy(dl_errbuf, "readExports: ");
575 strerrorcat(dl_errbuf, errno);
577 while(ldclose(ldp) == FAILURE)
582 * Fill in the export table. All entries are relative to
583 * the entry point we got from load.
586 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
587 for (i = lhp->l_nsyms; i; i--, ls++) {
589 if (!LDR_EXPORT(*ls))
591 #ifndef USE_64_BIT_ALL
592 if (ls->l_zeroes == 0)
594 symname = ls->l_offset+lhp->l_stoff+ldbuf;
595 #ifndef USE_64_BIT_ALL
597 symname = ls->l_name;
599 ep->name = savepv(symname);
600 ep->addr = (void *)((unsigned long)mp->entry + ls->l_value);
604 while(ldclose(ldp) == FAILURE)
610 * Find the main modules entry point. This is used as export pointer
611 * for loadbind() to be able to resolve references to the main part.
613 static void * findMain(void)
623 if ((buf = safemalloc(size)) == NULL) {
625 strcpy(dl_errbuf, "findMain: ");
626 strerrorcat(dl_errbuf, errno);
629 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
632 if ((buf = safemalloc(size)) == NULL) {
634 strcpy(dl_errbuf, "findMain: ");
635 strerrorcat(dl_errbuf, errno);
641 strcpy(dl_errbuf, "findMain: ");
642 strerrorcat(dl_errbuf, errno);
647 * The first entry is the main module. The entry point
648 * returned by load() does actually point to the data
651 lp = (struct ld_info *)buf;
652 ret = lp->ldinfo_dataorg;
656 #endif /* USE_NATIVE_DLOPEN */
660 * Platform: SunOS/Solaris, possibly others which use dlopen.
661 * Author: Paul Marquess (Paul.Marquess@btinternet.com)
662 * Created: 10th July 1994
665 * 15th July 1994 - Added code to explicitly save any error messages.
666 * 3rd August 1994 - Upgraded to v3 spec.
667 * 9th August 1994 - Changed to use IV
668 * 10th August 1994 - Tim Bunce: Added RTLD_LAZY, switchable debugging,
669 * basic FreeBSD support, removed ClearError
680 dl_private_init(pTHX)
682 (void)dl_generic_private_init(aTHX);
685 MODULE = DynaLoader PACKAGE = DynaLoader
688 (void)dl_private_init(aTHX);
692 dl_load_file(filename, flags=0)
696 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_load_file(%s,%x):\n", filename,flags));
698 Perl_warn(aTHX_ "Can't make loaded symbols global on this platform while loading %s",filename);
699 RETVAL = dlopen(filename, RTLD_GLOBAL|RTLD_LAZY) ;
700 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " libref=%x\n", RETVAL));
701 ST(0) = sv_newmortal() ;
703 SaveError(aTHX_ "%s",dlerror()) ;
705 sv_setiv( ST(0), PTR2IV(RETVAL) );
708 dl_unload_file(libref)
711 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_unload_file(%lx):\n", libref));
712 RETVAL = (dlclose(libref) == 0 ? 1 : 0);
714 SaveError(aTHX_ "%s", dlerror()) ;
715 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " retval = %d\n", RETVAL));
720 dl_find_symbol(libhandle, symbolname)
724 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_find_symbol(handle=%x, symbol=%s)\n",
725 libhandle, symbolname));
726 RETVAL = dlsym(libhandle, symbolname);
727 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " symbolref = %x\n", RETVAL));
728 ST(0) = sv_newmortal() ;
730 SaveError(aTHX_ "%s",dlerror()) ;
732 sv_setiv( ST(0), PTR2IV(RETVAL));
741 # These functions should not need changing on any platform:
744 dl_install_xsub(perl_name, symref, filename="$Package")
747 const char * filename
749 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_install_xsub(name=%s, symref=%x)\n",
751 ST(0) = sv_2mortal(newRV((SV*)newXS_flags(perl_name,
752 (void(*)(pTHX_ CV *))symref,
754 XS_DYNAMIC_FILENAME)));
761 RETVAL = dl_last_error ;
765 #if defined(USE_ITHREADS)
772 /* MY_CXT_CLONE just does a memcpy on the whole structure, so to avoid
773 * using Perl variables that belong to another thread, we create our
774 * own for this thread.
776 MY_CXT.x_dl_last_error = newSVpvn("", 0);