jim-load.c

   1 #include <string.h>
   2
   3 #include "jimautoconf.h"
   4 #include <jim.h>
   5
   6 /* -----------------------------------------------------------------------------
   7  * Dynamic libraries support (WIN32 not supported)
   8  * ---------------------------------------------------------------------------*/
   9
  10 #if defined(HAVE_DLOPEN) || defined(HAVE_DLOPEN_COMPAT)
  11
  12 #ifdef HAVE_DLFCN_H
  13 #include <dlfcn.h>
  14 #endif
  15
  16 #ifndef RTLD_NOW
  17     #define RTLD_NOW 0
  18 #endif
  19 #ifndef RTLD_LOCAL
  20     #define RTLD_LOCAL 0
  21 #endif
  22
  23 static void JimFreeLoadHandles(Jim_Interp *interp, void *data);
  24
  25 /**
  26  * Note that Jim_LoadLibrary() requires a path to an existing file.
  27  *
  28  * If it is necessary to search JIM_LIBPATH, use Jim_PackageRequire() instead.
  29  */
  30 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
  31 {
  32     void *handle = dlopen(pathName, RTLD_NOW | RTLD_LOCAL);
  33     if (handle == NULL) {
  34         Jim_SetResultFormatted(interp, "error loading extension \"%s\": %s", pathName,
  35             dlerror());
  36     }
  37     else {
  38         /* We use a unique init symbol depending on the extension name.
  39          * This is done for compatibility between static and dynamic extensions.
  40          * For extension readline.so, the init symbol is "Jim_readlineInit"
  41          */
  42         const char *pt;
  43         const char *pkgname;
  44         int pkgnamelen;
  45         char initsym[40];
  46         typedef int jim_module_init_func_type(Jim_Interp *);
  47         jim_module_init_func_type *onload;
  48
  49         pt = strrchr(pathName, '/');
  50         if (pt) {
  51             pkgname = pt + 1;
  52         }
  53         else {
  54             pkgname = pathName;
  55         }
  56         pt = strchr(pkgname, '.');
  57         if (pt) {
  58             pkgnamelen = pt - pkgname;
  59         }
  60         else {
  61             pkgnamelen = strlen(pkgname);
  62         }
  63         snprintf(initsym, sizeof(initsym), "Jim_%.*sInit", pkgnamelen, pkgname);
  64
  65         if ((onload = (jim_module_init_func_type *)dlsym(handle, initsym)) == NULL) {
  66             Jim_SetResultFormatted(interp,
  67                 "No %s symbol found in extension %s", initsym, pathName);
  68         }
  69         else if (onload(interp) != JIM_ERR) {
  70             /* Add this handle to the stack of handles to be freed */
  71             Jim_Stack *loadHandles = Jim_GetAssocData(interp, "load::handles");
  72             if (loadHandles == NULL) {
  73                 loadHandles = Jim_Alloc(sizeof(*loadHandles));
  74                 Jim_InitStack(loadHandles);
  75                 Jim_SetAssocData(interp, "load::handles", JimFreeLoadHandles, loadHandles);
  76             }
  77             Jim_StackPush(loadHandles, handle);
  78
  79             Jim_SetEmptyResult(interp);
  80
  81             return JIM_OK;
  82         }
  83     }
  84     if (handle) {
  85         dlclose(handle);
  86     }
  87     return JIM_ERR;
  88 }
  89
  90 static void JimFreeOneLoadHandle(void *handle)
  91 {
  92     dlclose(handle);
  93 }
  94
  95 static void JimFreeLoadHandles(Jim_Interp *interp, void *data)
  96 {
  97     Jim_Stack *handles = data;
  98
  99     if (handles) {
 100         Jim_FreeStackElements(handles, JimFreeOneLoadHandle);
 101         Jim_FreeStack(handles);
 102         Jim_Free(handles);
 103     }
 104 }
 105
 106 #else /* JIM_DYNLIB */
 107 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
 108 {
 109     JIM_NOTUSED(interp);
 110     JIM_NOTUSED(pathName);
 111
 112     Jim_SetResultString(interp, "the Jim binary has no support for [load]", -1);
 113     return JIM_ERR;
 114 }
 115
 116 void Jim_FreeLoadHandles(Jim_Interp *interp)
 117 {
 118 }
 119 #endif /* JIM_DYNLIB */
 120
 121 /* [load] */
 122 static int Jim_LoadCoreCommand(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 123 {
 124     if (argc < 2) {
 125         Jim_WrongNumArgs(interp, 1, argv, "libraryFile");
 126         return JIM_ERR;
 127     }
 128     return Jim_LoadLibrary(interp, Jim_String(argv[1]));
 129 }
 130
 131 int Jim_loadInit(Jim_Interp *interp)
 132 {
 133     Jim_CreateCommand(interp, "load", Jim_LoadCoreCommand, NULL, NULL);
 134     return JIM_OK;
 135 }