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);
182 #ifdef USE_5005THREADS
183 char *buf = malloc(BUFSIZ);
187 if (strerror_r(err, buf, BUFSIZ) == 0)
190 msg = strerror_r_failed;
191 msgsiz = strlen(msg);
192 if (strsiz + msgsiz < BUFSIZ)
196 if ((msg = strerror(err)) == 0)
197 msg = strerror_failed;
198 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
199 if (strsiz + msgsiz < BUFSIZ) /* Do not move this after #endif. */
206 char *strerrorcpy(char *str, int err) {
210 #ifdef USE_5005THREADS
211 char *buf = malloc(BUFSIZ);
215 if (strerror_r(err, buf, BUFSIZ) == 0)
218 msg = strerror_r_failed;
219 msgsiz = strlen(msg);
224 if ((msg = strerror(err)) == 0)
225 msg = strerror_failed;
226 msgsiz = strlen(msg); /* Note msg = buf and free() above. */
227 if (msgsiz < BUFSIZ) /* Do not move this after #endif. */
235 void *dlopen(char *path, int mode)
239 register ModulePtr mp;
242 * Upon the first call register a terminate handler that will
243 * close all libraries.
245 if (dl_mainModule == NULL) {
246 if ((dl_mainModule = findMain()) == NULL)
250 * Scan the list of modules if have the module already loaded.
252 for (mp = dl_modList; mp; mp = mp->next)
253 if (strcmp(mp->name, path) == 0) {
257 Newz(1000,mp,1,Module);
260 strcpy(dl_errbuf, "Newz: ");
261 strerrorcat(dl_errbuf, errno);
265 if ((mp->name = savepv(path)) == NULL) {
267 strcpy(dl_errbuf, "savepv: ");
268 strerrorcat(dl_errbuf, errno);
274 * load should be declared load(const char *...). Thus we
275 * cast the path to a normal char *. Ugly.
277 if ((mp->entry = (void *)LOAD((char *)path,
278 #ifdef L_LIBPATH_EXEC
283 int saverrno = errno;
288 strcpy(dl_errbuf, "dlopen: ");
289 strcat(dl_errbuf, path);
290 strcat(dl_errbuf, ": ");
292 * If AIX says the file is not executable, the error
293 * can be further described by querying the loader about
296 if (saverrno == ENOEXEC) {
297 char *moreinfo[BUFSIZ/sizeof(char *)];
298 if (loadquery(L_GETMESSAGES, moreinfo, sizeof(moreinfo)) == -1)
299 strerrorcpy(dl_errbuf, saverrno);
302 for (p = moreinfo; *p; p++)
306 strerrorcat(dl_errbuf, saverrno);
310 mp->next = dl_modList;
313 * Assume anonymous exports come from the module this dlopen
314 * is linked into, that holds true as long as dlopen and all
315 * of the perl core are in the same shared object. Also bind
316 * against the main part, in the case a perl is not the main
317 * part, e.g mod_perl as DSO in Apache so perl modules can
318 * also reference Apache symbols.
320 if (loadbind(0, (void *)dlopen, mp->entry) == -1 ||
321 loadbind(0, dl_mainModule, mp->entry)) {
322 int saverrno = errno;
326 strcpy(dl_errbuf, "loadbind: ");
327 strerrorcat(dl_errbuf, saverrno);
330 if (readExports(mp) == -1) {
338 * Attempt to decipher an AIX loader error message and append it
339 * to our static error message buffer.
341 static void caterr(char *s)
345 register char *p = s;
347 while (*p >= '0' && *p <= '9')
350 case L_ERROR_TOOMANY:
351 strcat(dl_errbuf, "too many errors");
354 strcat(dl_errbuf, "can't load library");
355 strcat(dl_errbuf, p);
358 strcat(dl_errbuf, "can't find symbol");
359 strcat(dl_errbuf, p);
362 strcat(dl_errbuf, "bad RLD");
363 strcat(dl_errbuf, p);
366 strcat(dl_errbuf, "bad exec format in");
367 strcat(dl_errbuf, p);
370 strerrorcat(dl_errbuf, atoi(++p));
373 strcat(dl_errbuf, s);
378 void *dlsym(void *handle, const char *symbol)
382 register ModulePtr mp = (ModulePtr)handle;
383 register ExportPtr ep;
387 * Could speed up search, but I assume that one assigns
388 * the result to function pointers anyways.
390 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
391 if (strcmp(ep->name, symbol) == 0)
394 strcpy(dl_errbuf, "dlsym: undefined symbol ");
395 strcat(dl_errbuf, symbol);
410 int dlclose(void *handle)
414 register ModulePtr mp = (ModulePtr)handle;
416 register ModulePtr mp1;
418 if (--mp->refCnt > 0)
420 result = UNLOAD(mp->entry);
423 strerrorcpy(dl_errbuf, errno);
426 register ExportPtr ep;
428 for (ep = mp->exports, i = mp->nExports; i; i--, ep++)
431 safefree(mp->exports);
433 if (mp == dl_modList)
434 dl_modList = mp->next;
436 for (mp1 = dl_modList; mp1; mp1 = mp1->next)
437 if (mp1->next == mp) {
438 mp1->next = mp->next;
447 /* Added by Wayne Scott
448 * This is needed because the ldopen system call calls
449 * calloc to allocated a block of date. The ldclose call calls free.
450 * Without this we get this system calloc and perl's free, resulting
451 * in a "Bad free" message. This way we always use perl's malloc.
453 void *calloc(size_t ne, size_t sz)
457 out = (void *) safemalloc(ne*sz);
463 * Build the export table from the XCOFF .loader section.
465 static int readExports(ModulePtr mp)
477 if ((ldp = ldopen(mp->name, ldp)) == NULL) {
481 if (errno != ENOENT) {
483 strcpy(dl_errbuf, "readExports: ");
484 strerrorcat(dl_errbuf, errno);
488 * The module might be loaded due to the LIBPATH
489 * environment variable. Search for the loaded
490 * module using L_GETINFO.
492 if ((buf = safemalloc(size)) == NULL) {
494 strcpy(dl_errbuf, "readExports: ");
495 strerrorcat(dl_errbuf, errno);
498 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
501 if ((buf = safemalloc(size)) == NULL) {
503 strcpy(dl_errbuf, "readExports: ");
504 strerrorcat(dl_errbuf, errno);
510 strcpy(dl_errbuf, "readExports: ");
511 strerrorcat(dl_errbuf, errno);
516 * Traverse the list of loaded modules. The entry point
517 * returned by LOAD() does actually point to the data
520 lp = (struct ld_info *)buf;
522 if (lp->ldinfo_dataorg == mp->entry) {
523 ldp = ldopen(lp->ldinfo_filename, ldp);
526 if (lp->ldinfo_next == 0)
529 lp = (struct ld_info *)((char *)lp + lp->ldinfo_next);
534 strcpy(dl_errbuf, "readExports: ");
535 strerrorcat(dl_errbuf, errno);
539 #ifdef USE_64_BIT_ALL
540 if (TYPE(ldp) != U803XTOCMAGIC) {
542 if (TYPE(ldp) != U802TOCMAGIC) {
545 strcpy(dl_errbuf, "readExports: bad magic");
546 while(ldclose(ldp) == FAILURE)
550 if (ldnshread(ldp, _LOADER, &sh) != SUCCESS) {
552 strcpy(dl_errbuf, "readExports: cannot read loader section header");
553 while(ldclose(ldp) == FAILURE)
558 * We read the complete loader section in one chunk, this makes
559 * finding long symbol names residing in the string table easier.
561 if ((ldbuf = (char *)safemalloc(sh.s_size)) == NULL) {
563 strcpy(dl_errbuf, "readExports: ");
564 strerrorcat(dl_errbuf, errno);
565 while(ldclose(ldp) == FAILURE)
569 if (FSEEK(ldp, sh.s_scnptr, BEGINNING) != OKFSEEK) {
571 strcpy(dl_errbuf, "readExports: cannot seek to loader section");
573 while(ldclose(ldp) == FAILURE)
577 /* This first case is a hack, since it assumes that the 3rd parameter to
578 FREAD is 1. See the redefinition of FREAD above to see how this works. */
579 if (FREAD(ldbuf, sh.s_size, 1, ldp) != 1) {
581 strcpy(dl_errbuf, "readExports: cannot read loader section");
583 while(ldclose(ldp) == FAILURE)
587 lhp = (AIX_LDHDR *)ldbuf;
588 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
590 * Count the number of exports to include in our export table.
592 for (i = lhp->l_nsyms; i; i--, ls++) {
593 if (!LDR_EXPORT(*ls))
597 Newz(1001, mp->exports, mp->nExports, Export);
598 if (mp->exports == NULL) {
600 strcpy(dl_errbuf, "readExports: ");
601 strerrorcat(dl_errbuf, errno);
603 while(ldclose(ldp) == FAILURE)
608 * Fill in the export table. All entries are relative to
609 * the entry point we got from load.
612 ls = (AIX_LDSYM *)(ldbuf+AIX_LDHDRSZ);
613 for (i = lhp->l_nsyms; i; i--, ls++) {
615 if (!LDR_EXPORT(*ls))
617 #ifndef USE_64_BIT_ALL
618 if (ls->l_zeroes == 0)
620 symname = ls->l_offset+lhp->l_stoff+ldbuf;
621 #ifndef USE_64_BIT_ALL
623 symname = ls->l_name;
625 ep->name = savepv(symname);
626 ep->addr = (void *)((unsigned long)mp->entry + ls->l_value);
630 while(ldclose(ldp) == FAILURE)
636 * Find the main modules entry point. This is used as export pointer
637 * for loadbind() to be able to resolve references to the main part.
639 static void * findMain(void)
649 if ((buf = safemalloc(size)) == NULL) {
651 strcpy(dl_errbuf, "findMain: ");
652 strerrorcat(dl_errbuf, errno);
655 while ((i = loadquery(L_GETINFO, buf, size)) == -1 && errno == ENOMEM) {
658 if ((buf = safemalloc(size)) == NULL) {
660 strcpy(dl_errbuf, "findMain: ");
661 strerrorcat(dl_errbuf, errno);
667 strcpy(dl_errbuf, "findMain: ");
668 strerrorcat(dl_errbuf, errno);
673 * The first entry is the main module. The entry point
674 * returned by load() does actually point to the data
677 lp = (struct ld_info *)buf;
678 ret = lp->ldinfo_dataorg;
682 #endif /* USE_NATIVE_DLOPEN */
686 * Platform: SunOS/Solaris, possibly others which use dlopen.
687 * Author: Paul Marquess (Paul.Marquess@btinternet.com)
688 * Created: 10th July 1994
691 * 15th July 1994 - Added code to explicitly save any error messages.
692 * 3rd August 1994 - Upgraded to v3 spec.
693 * 9th August 1994 - Changed to use IV
694 * 10th August 1994 - Tim Bunce: Added RTLD_LAZY, switchable debugging,
695 * basic FreeBSD support, removed ClearError
706 dl_private_init(pTHX)
708 (void)dl_generic_private_init(aTHX);
711 MODULE = DynaLoader PACKAGE = DynaLoader
714 (void)dl_private_init(aTHX);
718 dl_load_file(filename, flags=0)
722 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_load_file(%s,%x):\n", filename,flags));
724 Perl_warn(aTHX_ "Can't make loaded symbols global on this platform while loading %s",filename);
725 RETVAL = dlopen(filename, RTLD_GLOBAL|RTLD_LAZY) ;
726 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " libref=%x\n", RETVAL));
727 ST(0) = sv_newmortal() ;
729 SaveError(aTHX_ "%s",dlerror()) ;
731 sv_setiv( ST(0), PTR2IV(RETVAL) );
734 dl_unload_file(libref)
737 DLDEBUG(1,PerlIO_printf(Perl_debug_log, "dl_unload_file(%lx):\n", libref));
738 RETVAL = (dlclose(libref) == 0 ? 1 : 0);
740 SaveError(aTHX_ "%s", dlerror()) ;
741 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " retval = %d\n", RETVAL));
746 dl_find_symbol(libhandle, symbolname)
750 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_find_symbol(handle=%x, symbol=%s)\n",
751 libhandle, symbolname));
752 RETVAL = dlsym(libhandle, symbolname);
753 DLDEBUG(2,PerlIO_printf(Perl_debug_log, " symbolref = %x\n", RETVAL));
754 ST(0) = sv_newmortal() ;
756 SaveError(aTHX_ "%s",dlerror()) ;
758 sv_setiv( ST(0), PTR2IV(RETVAL));
767 # These functions should not need changing on any platform:
770 dl_install_xsub(perl_name, symref, filename="$Package")
775 DLDEBUG(2,PerlIO_printf(Perl_debug_log, "dl_install_xsub(name=%s, symref=%x)\n",
777 ST(0) = sv_2mortal(newRV((SV*)newXS(perl_name,
778 (void(*)(pTHX_ CV *))symref,
786 RETVAL = dl_last_error ;