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
32 * @(#)dlfcn.c 1.5 revision of 93/02/14 20:14:17
33 * This is an unpublished work copyright (c) 1992 Helios Software GmbH
34 * 3000 Hannover 1, Germany
40 /* When building as a 64-bit binary on AIX, define this to get the
41 * correct structure definitions. Also determines the field-name
42 * macros and gates some logic in readEntries(). -- Steven N. Hirsch
43 * <hirschs@btv.ibm.com> */
53 #include <sys/types.h>
61 # define AIX_SCNHDR SCNHDR_64
62 # define AIX_LDHDR LDHDR_64
63 # define AIX_LDSYM LDSYM_64
64 # define AIX_LDHDRSZ LDHDRSZ_64
66 # define AIX_SCNHDR SCNHDR
67 # define AIX_LDHDR LDHDR
68 # define AIX_LDSYM LDSYM
69 # define AIX_LDHDRSZ LDHDRSZ
72 /* When using Perl extensions written in C++ the longer versions
73 * of load() and unload() from libC and libC_r need to be used,
74 * otherwise statics in the extensions won't get initialized right.
75 * -- Stephanie Beals <bealzy@us.ibm.com> */
77 /* Older AIX C compilers cannot deal with C++ double-slash comments in
78 the ibmcxx and/or xlC includes. Since we only need a single file,
79 be more fine-grained about what's included <hirschs@btv.ibm.com> */
81 #ifdef USE_libC /* The define comes, when it comes, from hints/aix.pl. */
82 # define LOAD loadAndInit
83 # define UNLOAD terminateAndUnload
84 # if defined(USE_vacpp_load_h)
85 # include "/usr/vacpp/include/load.h"
86 # elif defined(USE_ibmcxx_load_h)
87 # include "/usr/ibmcxx/include/load.h"
88 # elif defined(USE_xlC_load_h)
89 # include "/usr/lpp/xlC/include/load.h"
90 # elif defined(USE_load_h)
91 # include "/usr/include/load.h"
95 # define UNLOAD unload
99 * AIX 4.3 does remove some useful definitions from ldfcn.h. Define
100 * these here to compensate for that lossage.
103 # define BEGINNING SEEK_SET
106 # define FSEEK(ldptr,o,p) fseek(IOPTR(ldptr),(p==BEGINNING)?(OFFSET(ldptr) +o):o,p)
109 # define FREAD(p,s,n,ldptr) fread(p,s,n,IOPTR(ldptr))
116 # define RTLD_GLOBAL 0
120 * We simulate dlopen() et al. through a call to load. Because AIX has
121 * no call to find an exported symbol we read the loader section of the
122 * loaded module and build a list of exported symbols and their virtual
127 char *name; /* the symbols's name */
128 void *addr; /* its relocated virtual address */
129 } Export, *ExportPtr;
132 * The void * handle returned from dlopen is actually a ModulePtr.
134 typedef struct Module {
136 char *name; /* module name for refcounting */
137 int refCnt; /* the number of references */
138 void *entry; /* entry point from load */
139 int nExports; /* the number of exports found */
140 ExportPtr exports; /* the array of exports */
141 } Module, *ModulePtr;
145 * We keep a list of all loaded modules to be able to reference count
146 * duplicate dlopen's.
151 * The last error from one of the dl* routines is kept in static
152 * variables here. Each error is returned only once to the caller.
154 char x_errbuf[BUFSIZ];
157 } my_cxtx_t; /* this *must* be named my_cxtx_t */
159 #define DL_CXT_EXTRA /* ask for dl_cxtx to be defined in dlutils.c */
160 #include "dlutils.c" /* SaveError() etc */
162 #define dl_modList (dl_cxtx.x_modList)
163 #define dl_errbuf (dl_cxtx.x_errbuf)
164 #define dl_errvalid (dl_cxtx.x_errvalid)
165 #define dl_mainModule (dl_cxtx.x_mainModule)
167 static void caterr(char *);
168 static int readExports(ModulePtr);
169 static void *findMain(void);
171 /* these statics are ok because they're constants */
172 static char *strerror_failed = "(strerror failed)";
173 static char *strerror_r_failed = "(strerror_r failed)";
175 char *strerrorcat(char *str, int err) {
176 int strsiz = strlen(str);
180 #ifdef USE_5005THREADS
181 char *buf = malloc(BUFSIZ);
185 if (strerror_r(err, buf, BUFSIZ) == 0)
188 msg = strerror_r_failed;
189 msgsiz = strlen(msg);
190 if (strsiz + msgsiz < BUFSIZ)
194 if ((msg = strerror(err)) == 0)
195 msg = strerror_failed;
196 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
197 if (strsiz + msgsiz < BUFSIZ) /* Do not move this after #endif. */
204 char *strerrorcpy(char *str, int err) {
208 #ifdef USE_5005THREADS
209 char *buf = malloc(BUFSIZ);
213 if (strerror_r(err, buf, BUFSIZ) == 0)
216 msg = strerror_r_failed;
217 msgsiz = strlen(msg);
222 if ((msg = strerror(err)) == 0)
223 msg = strerror_failed;
224 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
225 if (msgsiz < BUFSIZ) /* Do not move this after #endif. */
233 void *dlopen(char *path, int mode)
237 register ModulePtr mp;
240 * Upon the first call register a terminate handler that will
241 * close all libraries.
243 if (dl_mainModule == NULL) {
244 if ((dl_mainModule = findMain()) == NULL)
248 * Scan the list of modules if have the module already loaded.
250 for (mp = dl_modList; mp; mp = mp->next)
251 if (strcmp(mp->name, path) == 0) {
255 Newz(1000,mp,1,Module);
258 strcpy(dl_errbuf, "Newz: ");
259 strerrorcat(dl_errbuf, errno);
263 if ((mp->name = savepv(path)) == NULL) {
265 strcpy(dl_errbuf, "savepv: ");
266 strerrorcat(dl_errbuf, errno);
272 * load should be declared load(const char *...). Thus we
273 * cast the path to a normal char *. Ugly.
275 if ((mp->entry = (void *)LOAD((char *)path,
276 #ifdef L_LIBPATH_EXEC
281 int saverrno = errno;
286 strcpy(dl_errbuf, "dlopen: ");
287 strcat(dl_errbuf, path);
288 strcat(dl_errbuf, ": ");
290 * If AIX says the file is not executable, the error
291 * can be further described by querying the loader about
294 if (saverrno == ENOEXEC) {
295 char *moreinfo[BUFSIZ/sizeof(char *)];
296 if (loadquery(L_GETMESSAGES, moreinfo, sizeof(moreinfo)) == -1)
297 strerrorcpy(dl_errbuf, saverrno);
300 for (p = moreinfo; *p; p++)
304 strerrorcat(dl_errbuf, saverrno);
308 mp->next = dl_modList;
311 * Assume anonymous exports come from the module this dlopen
312 * is linked into, that holds true as long as dlopen and all
313 * of the perl core are in the same shared object. Also bind
314 * against the main part, in the case a perl is not the main
315 * part, e.g mod_perl as DSO in Apache so perl modules can
316 * also reference Apache symbols.
318 if (loadbind(0, (void *)dlopen, mp->entry) == -1 ||
319 loadbind(0, dl_mainModule, mp->entry)) {
320 int saverrno = errno;
324 strcpy(dl_errbuf, "loadbind: ");
325 strerrorcat(dl_errbuf, saverrno);
328 if (readExports(mp) == -1) {
336 * Attempt to decipher an AIX loader error message and append it
337 * to our static error message buffer.
339 static void caterr(char *s)
343 register char *p = s;
345 while (*p >= '0' && *p <= '9')
348 case L_ERROR_TOOMANY:
349 strcat(dl_errbuf, "too many errors");
352 strcat(dl_errbuf, "can't load library");
353 strcat(dl_errbuf, p);
356 strcat(dl_errbuf, "can't find symbol");
357 strcat(dl_errbuf, p);
360 strcat(dl_errbuf, "bad RLD");
361 strcat(dl_errbuf, p);
364 strcat(dl_errbuf, "bad exec format in");
365 strcat(dl_errbuf, p);
368 strerrorcat(dl_errbuf, atoi(++p));
371 strcat(dl_errbuf, s);
376 void *dlsym(void *handle, const char *symbol)
380 register ModulePtr mp = (ModulePtr)handle;
381 register ExportPtr ep;
385 * Could speed up search, but I assume that one assigns
386 * the result to function pointers anyways.
388 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
389 if (strcmp(ep->name, symbol) == 0)
392 strcpy(dl_errbuf, "dlsym: undefined symbol ");
393 strcat(dl_errbuf, symbol);
408 int dlclose(void *handle)
412 register ModulePtr mp = (ModulePtr)handle;
414 register ModulePtr mp1;
416 if (--mp->refCnt > 0)
418 result = UNLOAD(mp->entry);
421 strerrorcpy(dl_errbuf, errno);
424 register ExportPtr ep;
426 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
429 safefree(mp->exports);
431 if (mp == dl_modList)
432 dl_modList = mp->next;
434 for (mp1 = dl_modList; mp1; mp1 = mp1->next)
435 if (mp1->next == mp) {
436 mp1->next = mp->next;
445 /* Added by Wayne Scott
446 * This is needed because the ldopen system call calls
447 * calloc to allocated a block of date. The ldclose call calls free.
448 * Without this we get this system calloc and perl's free, resulting
449 * in a "Bad free" message. This way we always use perl's malloc.
451 void *calloc(size_t ne, size_t sz)
455 out = (void *) safemalloc(ne*sz);
461 * Build the export table from the XCOFF .loader section.
463 static int readExports(ModulePtr mp)
475 if ((ldp = ldopen(mp->name, ldp)) == NULL) {
479 if (errno != ENOENT) {
481 strcpy(dl_errbuf, "readExports: ");
482 strerrorcat(dl_errbuf, errno);
486 * The module might be loaded due to the LIBPATH
487 * environment variable. Search for the loaded
488 * module using L_GETINFO.
490 if ((buf = safemalloc(size)) == NULL) {
492 strcpy(dl_errbuf, "readExports: ");
493 strerrorcat(dl_errbuf, errno);
496 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
499 if ((buf = safemalloc(size)) == NULL) {
501 strcpy(dl_errbuf, "readExports: ");
502 strerrorcat(dl_errbuf, errno);
508 strcpy(dl_errbuf, "readExports: ");
509 strerrorcat(dl_errbuf, errno);
514 * Traverse the list of loaded modules. The entry point
515 * returned by LOAD() does actually point to the data
518 lp = (struct ld_info *)buf;
520 if (lp->ldinfo_dataorg == mp->entry) {
521 ldp = ldopen(lp->ldinfo_filename, ldp);
524 if (lp->ldinfo_next == 0)
527 lp = (struct ld_info *)((char *)lp + lp->ldinfo_next);
532 strcpy(dl_errbuf, "readExports: ");
533 strerrorcat(dl_errbuf, errno);
537 #ifdef USE_64_BIT_ALL
538 if (TYPE(ldp) != U803XTOCMAGIC) {
540 if (TYPE(ldp) != U802TOCMAGIC) {
543 strcpy(dl_errbuf, "readExports: bad magic");
544 while(ldclose(ldp) == FAILURE)
548 if (ldnshread(ldp, _LOADER, &sh) != SUCCESS) {
550 strcpy(dl_errbuf, "readExports: cannot read loader section header");
551 while(ldclose(ldp) == FAILURE)
556 * We read the complete loader section in one chunk, this makes
557 * finding long symbol names residing in the string table easier.
559 if ((ldbuf = (char *)safemalloc(sh.s_size)) == NULL) {
561 strcpy(dl_errbuf, "readExports: ");
562 strerrorcat(dl_errbuf, errno);
563 while(ldclose(ldp) == FAILURE)
567 if (FSEEK(ldp, sh.s_scnptr, BEGINNING) != OKFSEEK) {
569 strcpy(dl_errbuf, "readExports: cannot seek to loader section");
571 while(ldclose(ldp) == FAILURE)
575 /* This first case is a hack, since it assumes that the 3rd parameter to
576 FREAD is 1. See the redefinition of FREAD above to see how this works. */
577 if (FREAD(ldbuf, sh.s_size, 1, ldp) != 1) {
579 strcpy(dl_errbuf, "readExports: cannot read loader section");
581 while(ldclose(ldp) == FAILURE)
585 lhp = (AIX_LDHDR *)ldbuf;
586 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
588 * Count the number of exports to include in our export table.
590 for (i = lhp->l_nsyms; i; i--, ls++) {
591 if (!LDR_EXPORT(*ls))
595 Newz(1001, mp->exports, mp->nExports, Export);
596 if (mp->exports == NULL) {
598 strcpy(dl_errbuf, "readExports: ");
599 strerrorcat(dl_errbuf, errno);
601 while(ldclose(ldp) == FAILURE)
606 * Fill in the export table. All entries are relative to
607 * the entry point we got from load.
610 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
611 for (i = lhp->l_nsyms; i; i--, ls++) {
613 if (!LDR_EXPORT(*ls))
615 #ifndef USE_64_BIT_ALL
616 if (ls->l_zeroes == 0)
618 symname = ls->l_offset+lhp->l_stoff+ldbuf;
619 #ifndef USE_64_BIT_ALL
621 symname = ls->l_name;
623 ep->name = savepv(symname);
624 ep->addr = (void *)((unsigned long)mp->entry + ls->l_value);
628 while(ldclose(ldp) == FAILURE)
634 * Find the main modules entry point. This is used as export pointer
635 * for loadbind() to be able to resolve references to the main part.
637 static void * findMain(void)
647 if ((buf = safemalloc(size)) == NULL) {
649 strcpy(dl_errbuf, "findMain: ");
650 strerrorcat(dl_errbuf, errno);
653 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
656 if ((buf = safemalloc(size)) == NULL) {
658 strcpy(dl_errbuf, "findMain: ");
659 strerrorcat(dl_errbuf, errno);
665 strcpy(dl_errbuf, "findMain: ");
666 strerrorcat(dl_errbuf, errno);
671 * The first entry is the main module. The entry point
672 * returned by load() does actually point to the data
675 lp = (struct ld_info *)buf;
676 ret = lp->ldinfo_dataorg;
680 #endif /* USE_NATIVE_DLOPEN */
684 * Platform: SunOS/Solaris, possibly others which use dlopen.
685 * Author: Paul Marquess (Paul.Marquess@btinternet.com)
686 * Created: 10th July 1994
689 * 15th July 1994 - Added code to explicitly save any error messages.
690 * 3rd August 1994 - Upgraded to v3 spec.
691 * 9th August 1994 - Changed to use IV
692 * 10th August 1994 - Tim Bunce: Added RTLD_LAZY, switchable debugging,
693 * basic FreeBSD support, removed ClearError
704 dl_private_init(pTHX)
706 (void)dl_generic_private_init(aTHX);
709 MODULE = DynaLoader PACKAGE = DynaLoader
712 (void)dl_private_init(aTHX);
716 dl_load_file(filename, flags=0)
720 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_load_file(%s,%x):\n", filename,flags));
722 Perl_warn(aTHX_ "Can't make loaded symbols global on this platform while loading %s",filename);
723 RETVAL = dlopen(filename, RTLD_GLOBAL|RTLD_LAZY) ;
724 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " libref=%x\n", RETVAL));
725 ST(0) = sv_newmortal() ;
727 SaveError(aTHX_ "%s",dlerror()) ;
729 sv_setiv( ST(0), PTR2IV(RETVAL) );
732 dl_unload_file(libref)
735 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_unload_file(%lx):\n", libref));
736 RETVAL = (dlclose(libref) == 0 ? 1 : 0);
738 SaveError(aTHX_ "%s", dlerror()) ;
739 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " retval = %d\n", RETVAL));
744 dl_find_symbol(libhandle, symbolname)
748 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_find_symbol(handle=%x, symbol=%s)\n",
749 libhandle, symbolname));
750 RETVAL = dlsym(libhandle, symbolname);
751 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " symbolref = %x\n", RETVAL));
752 ST(0) = sv_newmortal() ;
754 SaveError(aTHX_ "%s",dlerror()) ;
756 sv_setiv( ST(0), PTR2IV(RETVAL));
765 # These functions should not need changing on any platform:
768 dl_install_xsub(perl_name, symref, filename="$Package")
773 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_install_xsub(name=%s, symref=%x)\n",
775 ST(0) = sv_2mortal(newRV((SV*)newXS(perl_name,
776 (void(*)(pTHX_ CV *))symref,
784 RETVAL = dl_last_error ;