1*bdda0531Snikita /* $NetBSD: loadlib.c,v 1.11 2023/06/08 21:12:08 nikita Exp $ */
2bee09862Smbalmer
3dbec5304Smbalmer /*
4f0dad708Snikita ** Id: loadlib.c
5dbec5304Smbalmer ** Dynamic library loader for Lua
6dbec5304Smbalmer ** See Copyright Notice in lua.h
7dbec5304Smbalmer **
8dbec5304Smbalmer ** This module contains an implementation of loadlib for Unix systems
94ab4902eSlneto ** that have dlfcn, an implementation for Windows, and a stub for other
104ab4902eSlneto ** systems.
11dbec5304Smbalmer */
12dbec5304Smbalmer
1373008250Slneto #define loadlib_c
1473008250Slneto #define LUA_LIB
15dbec5304Smbalmer
1673008250Slneto #include "lprefix.h"
174ab4902eSlneto
184ab4902eSlneto
19bee09862Smbalmer #include <stdio.h>
20dbec5304Smbalmer #include <stdlib.h>
21dbec5304Smbalmer #include <string.h>
22dbec5304Smbalmer
23dbec5304Smbalmer #include "lua.h"
24dbec5304Smbalmer
25dbec5304Smbalmer #include "lauxlib.h"
26dbec5304Smbalmer #include "lualib.h"
27dbec5304Smbalmer
28dbec5304Smbalmer
294ab4902eSlneto /*
304ab4902eSlneto ** LUA_IGMARK is a mark to ignore all before it when building the
314ab4902eSlneto ** luaopen_ function name.
324ab4902eSlneto */
334ab4902eSlneto #if !defined (LUA_IGMARK)
344ab4902eSlneto #define LUA_IGMARK "-"
354ab4902eSlneto #endif
364ab4902eSlneto
374ab4902eSlneto
384ab4902eSlneto /*
394ab4902eSlneto ** LUA_CSUBSEP is the character that replaces dots in submodule names
404ab4902eSlneto ** when searching for a C loader.
414ab4902eSlneto ** LUA_LSUBSEP is the character that replaces dots in submodule names
424ab4902eSlneto ** when searching for a Lua loader.
434ab4902eSlneto */
444ab4902eSlneto #if !defined(LUA_CSUBSEP)
454ab4902eSlneto #define LUA_CSUBSEP LUA_DIRSEP
464ab4902eSlneto #endif
474ab4902eSlneto
484ab4902eSlneto #if !defined(LUA_LSUBSEP)
494ab4902eSlneto #define LUA_LSUBSEP LUA_DIRSEP
504ab4902eSlneto #endif
514ab4902eSlneto
524ab4902eSlneto
53dbec5304Smbalmer /* prefix for open functions in C libraries */
54dbec5304Smbalmer #define LUA_POF "luaopen_"
55dbec5304Smbalmer
56dbec5304Smbalmer /* separator for open functions in C libraries */
57dbec5304Smbalmer #define LUA_OFSEP "_"
58dbec5304Smbalmer
59dbec5304Smbalmer
6073008250Slneto /*
61f0dad708Snikita ** key for table in the registry that keeps handles
6273008250Slneto ** for all loaded C libraries
6373008250Slneto */
64f0dad708Snikita static const char *const CLIBS = "_CLIBS";
65dbec5304Smbalmer
66dbec5304Smbalmer #define LIB_FAIL "open"
67dbec5304Smbalmer
689e2f6347Smbalmer
69dbec5304Smbalmer #define setprogdir(L) ((void)0)
70dbec5304Smbalmer
71dbec5304Smbalmer
724ab4902eSlneto /*
73f0dad708Snikita ** Special type equivalent to '(void*)' for functions in gcc
74f0dad708Snikita ** (to suppress warnings when converting function pointers)
75f0dad708Snikita */
76f0dad708Snikita typedef void (*voidf)(void);
77f0dad708Snikita
78f0dad708Snikita
79f0dad708Snikita /*
804ab4902eSlneto ** system-dependent functions
814ab4902eSlneto */
8273008250Slneto
8373008250Slneto /*
8473008250Slneto ** unload library 'lib'
8573008250Slneto */
8673008250Slneto static void lsys_unloadlib (void *lib);
8773008250Slneto
8873008250Slneto /*
8973008250Slneto ** load C library in file 'path'. If 'seeglb', load with all names in
9073008250Slneto ** the library global.
9173008250Slneto ** Returns the library; in case of error, returns NULL plus an
9273008250Slneto ** error string in the stack.
9373008250Slneto */
9473008250Slneto static void *lsys_load (lua_State *L, const char *path, int seeglb);
9573008250Slneto
9673008250Slneto /*
9773008250Slneto ** Try to find a function named 'sym' in library 'lib'.
9873008250Slneto ** Returns the function; in case of error, returns NULL plus an
9973008250Slneto ** error string in the stack.
10073008250Slneto */
10173008250Slneto static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym);
102dbec5304Smbalmer
103dbec5304Smbalmer
104dbec5304Smbalmer
10573008250Slneto
10673008250Slneto #if defined(LUA_USE_DLOPEN) /* { */
107dbec5304Smbalmer /*
108dbec5304Smbalmer ** {========================================================================
109dbec5304Smbalmer ** This is an implementation of loadlib based on the dlfcn interface.
110dbec5304Smbalmer ** The dlfcn interface is available in Linux, SunOS, Solaris, IRIX, FreeBSD,
111dbec5304Smbalmer ** NetBSD, AIX 4.2, HPUX 11, and probably most other Unix flavors, at least
112dbec5304Smbalmer ** as an emulation layer on top of native functions.
113dbec5304Smbalmer ** =========================================================================
114dbec5304Smbalmer */
115dbec5304Smbalmer
116dbec5304Smbalmer #include <dlfcn.h>
117dbec5304Smbalmer
11873008250Slneto /*
119bee09862Smbalmer ** Macro to convert pointer-to-void* to pointer-to-function. This cast
120bee09862Smbalmer ** is undefined according to ISO C, but POSIX assumes that it works.
12173008250Slneto ** (The '__extension__' in gnu compilers is only to avoid warnings.)
12273008250Slneto */
12373008250Slneto #if defined(__GNUC__)
12473008250Slneto #define cast_func(p) (__extension__ (lua_CFunction)(p))
12573008250Slneto #else
12673008250Slneto #define cast_func(p) ((lua_CFunction)(p))
12773008250Slneto #endif
12873008250Slneto
12973008250Slneto
lsys_unloadlib(void * lib)13073008250Slneto static void lsys_unloadlib (void *lib) {
131dbec5304Smbalmer dlclose(lib);
132dbec5304Smbalmer }
133dbec5304Smbalmer
134dbec5304Smbalmer
lsys_load(lua_State * L,const char * path,int seeglb)13573008250Slneto static void *lsys_load (lua_State *L, const char *path, int seeglb) {
1364ab4902eSlneto void *lib = dlopen(path, RTLD_NOW | (seeglb ? RTLD_GLOBAL : RTLD_LOCAL));
137f0dad708Snikita if (l_unlikely(lib == NULL))
138f0dad708Snikita lua_pushstring(L, dlerror());
139dbec5304Smbalmer return lib;
140dbec5304Smbalmer }
141dbec5304Smbalmer
142dbec5304Smbalmer
lsys_sym(lua_State * L,void * lib,const char * sym)14373008250Slneto static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
14473008250Slneto lua_CFunction f = cast_func(dlsym(lib, sym));
145f0dad708Snikita if (l_unlikely(f == NULL))
146f0dad708Snikita lua_pushstring(L, dlerror());
147dbec5304Smbalmer return f;
148dbec5304Smbalmer }
149dbec5304Smbalmer
150dbec5304Smbalmer /* }====================================================== */
151dbec5304Smbalmer
152dbec5304Smbalmer
153dbec5304Smbalmer
15473008250Slneto #elif defined(LUA_DL_DLL) /* }{ */
155dbec5304Smbalmer /*
156dbec5304Smbalmer ** {======================================================================
157dbec5304Smbalmer ** This is an implementation of loadlib for Windows using native functions.
158dbec5304Smbalmer ** =======================================================================
159dbec5304Smbalmer */
160dbec5304Smbalmer
16173008250Slneto #include <windows.h>
16273008250Slneto
163dbec5304Smbalmer
1644ab4902eSlneto /*
1654ab4902eSlneto ** optional flags for LoadLibraryEx
1664ab4902eSlneto */
1674ab4902eSlneto #if !defined(LUA_LLE_FLAGS)
1684ab4902eSlneto #define LUA_LLE_FLAGS 0
1694ab4902eSlneto #endif
1704ab4902eSlneto
1714ab4902eSlneto
1729e2f6347Smbalmer #undef setprogdir
1739e2f6347Smbalmer
1749e2f6347Smbalmer
1759e2f6347Smbalmer /*
1769e2f6347Smbalmer ** Replace in the path (on the top of the stack) any occurrence
1779e2f6347Smbalmer ** of LUA_EXEC_DIR with the executable's path.
1789e2f6347Smbalmer */
setprogdir(lua_State * L)179dbec5304Smbalmer static void setprogdir (lua_State *L) {
180dbec5304Smbalmer char buff[MAX_PATH + 1];
181dbec5304Smbalmer char *lb;
182dbec5304Smbalmer DWORD nsize = sizeof(buff)/sizeof(char);
1839e2f6347Smbalmer DWORD n = GetModuleFileNameA(NULL, buff, nsize); /* get exec. name */
184dbec5304Smbalmer if (n == 0 || n == nsize || (lb = strrchr(buff, '\\')) == NULL)
185dbec5304Smbalmer luaL_error(L, "unable to get ModuleFileName");
186dbec5304Smbalmer else {
1879e2f6347Smbalmer *lb = '\0'; /* cut name on the last '\\' to get the path */
1884ab4902eSlneto luaL_gsub(L, lua_tostring(L, -1), LUA_EXEC_DIR, buff);
189dbec5304Smbalmer lua_remove(L, -2); /* remove original string */
190dbec5304Smbalmer }
191dbec5304Smbalmer }
192dbec5304Smbalmer
193dbec5304Smbalmer
1949e2f6347Smbalmer
1959e2f6347Smbalmer
pusherror(lua_State * L)196dbec5304Smbalmer static void pusherror (lua_State *L) {
197dbec5304Smbalmer int error = GetLastError();
198dbec5304Smbalmer char buffer[128];
199dbec5304Smbalmer if (FormatMessageA(FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_SYSTEM,
2004ab4902eSlneto NULL, error, 0, buffer, sizeof(buffer)/sizeof(char), NULL))
201dbec5304Smbalmer lua_pushstring(L, buffer);
202dbec5304Smbalmer else
203dbec5304Smbalmer lua_pushfstring(L, "system error %d\n", error);
204dbec5304Smbalmer }
205dbec5304Smbalmer
lsys_unloadlib(void * lib)20673008250Slneto static void lsys_unloadlib (void *lib) {
2074ab4902eSlneto FreeLibrary((HMODULE)lib);
208dbec5304Smbalmer }
209dbec5304Smbalmer
210dbec5304Smbalmer
lsys_load(lua_State * L,const char * path,int seeglb)21173008250Slneto static void *lsys_load (lua_State *L, const char *path, int seeglb) {
2124ab4902eSlneto HMODULE lib = LoadLibraryExA(path, NULL, LUA_LLE_FLAGS);
2134ab4902eSlneto (void)(seeglb); /* not used: symbols are 'global' by default */
214dbec5304Smbalmer if (lib == NULL) pusherror(L);
215dbec5304Smbalmer return lib;
216dbec5304Smbalmer }
217dbec5304Smbalmer
218dbec5304Smbalmer
lsys_sym(lua_State * L,void * lib,const char * sym)21973008250Slneto static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
220f0dad708Snikita lua_CFunction f = (lua_CFunction)(voidf)GetProcAddress((HMODULE)lib, sym);
221dbec5304Smbalmer if (f == NULL) pusherror(L);
222dbec5304Smbalmer return f;
223dbec5304Smbalmer }
224dbec5304Smbalmer
225dbec5304Smbalmer /* }====================================================== */
226dbec5304Smbalmer
227dbec5304Smbalmer
22873008250Slneto #else /* }{ */
229dbec5304Smbalmer /*
230dbec5304Smbalmer ** {======================================================
231dbec5304Smbalmer ** Fallback for other systems
232dbec5304Smbalmer ** =======================================================
233dbec5304Smbalmer */
234dbec5304Smbalmer
235dbec5304Smbalmer #undef LIB_FAIL
236dbec5304Smbalmer #define LIB_FAIL "absent"
237dbec5304Smbalmer
238dbec5304Smbalmer
239dbec5304Smbalmer #define DLMSG "dynamic libraries not enabled; check your Lua installation"
240dbec5304Smbalmer
241dbec5304Smbalmer
lsys_unloadlib(void * lib)24273008250Slneto static void lsys_unloadlib (void *lib) {
2434ab4902eSlneto (void)(lib); /* not used */
244dbec5304Smbalmer }
245dbec5304Smbalmer
246dbec5304Smbalmer
lsys_load(lua_State * L,const char * path,int seeglb)24773008250Slneto static void *lsys_load (lua_State *L, const char *path, int seeglb) {
2484ab4902eSlneto (void)(path); (void)(seeglb); /* not used */
249dbec5304Smbalmer lua_pushliteral(L, DLMSG);
250dbec5304Smbalmer return NULL;
251dbec5304Smbalmer }
252dbec5304Smbalmer
253dbec5304Smbalmer
lsys_sym(lua_State * L,void * lib,const char * sym)25473008250Slneto static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
2554ab4902eSlneto (void)(lib); (void)(sym); /* not used */
256dbec5304Smbalmer lua_pushliteral(L, DLMSG);
257dbec5304Smbalmer return NULL;
258dbec5304Smbalmer }
259dbec5304Smbalmer
260dbec5304Smbalmer /* }====================================================== */
26173008250Slneto #endif /* } */
262dbec5304Smbalmer
263dbec5304Smbalmer
26473008250Slneto /*
2659e2f6347Smbalmer ** {==================================================================
2669e2f6347Smbalmer ** Set Paths
2679e2f6347Smbalmer ** ===================================================================
2689e2f6347Smbalmer */
2699e2f6347Smbalmer
2709e2f6347Smbalmer /*
2719e2f6347Smbalmer ** LUA_PATH_VAR and LUA_CPATH_VAR are the names of the environment
2729e2f6347Smbalmer ** variables that Lua check to set its paths.
2739e2f6347Smbalmer */
2749e2f6347Smbalmer #if !defined(LUA_PATH_VAR)
2759e2f6347Smbalmer #define LUA_PATH_VAR "LUA_PATH"
2769e2f6347Smbalmer #endif
2779e2f6347Smbalmer
2789e2f6347Smbalmer #if !defined(LUA_CPATH_VAR)
2799e2f6347Smbalmer #define LUA_CPATH_VAR "LUA_CPATH"
2809e2f6347Smbalmer #endif
2819e2f6347Smbalmer
2829e2f6347Smbalmer
2839e2f6347Smbalmer
2849e2f6347Smbalmer /*
2859e2f6347Smbalmer ** return registry.LUA_NOENV as a boolean
2869e2f6347Smbalmer */
noenv(lua_State * L)2879e2f6347Smbalmer static int noenv (lua_State *L) {
2889e2f6347Smbalmer int b;
2899e2f6347Smbalmer lua_getfield(L, LUA_REGISTRYINDEX, "LUA_NOENV");
2909e2f6347Smbalmer b = lua_toboolean(L, -1);
2919e2f6347Smbalmer lua_pop(L, 1); /* remove value */
2929e2f6347Smbalmer return b;
2939e2f6347Smbalmer }
2949e2f6347Smbalmer
2959e2f6347Smbalmer
2969e2f6347Smbalmer /*
2979e2f6347Smbalmer ** Set a path
2989e2f6347Smbalmer */
setpath(lua_State * L,const char * fieldname,const char * envname,const char * dft)2999e2f6347Smbalmer static void setpath (lua_State *L, const char *fieldname,
3009e2f6347Smbalmer const char *envname,
3019e2f6347Smbalmer const char *dft) {
302f0dad708Snikita const char *dftmark;
3039e2f6347Smbalmer const char *nver = lua_pushfstring(L, "%s%s", envname, LUA_VERSUFFIX);
304f0dad708Snikita const char *path = getenv(nver); /* try versioned name */
305f0dad708Snikita if (path == NULL) /* no versioned environment variable? */
3069e2f6347Smbalmer path = getenv(envname); /* try unversioned name */
3079e2f6347Smbalmer if (path == NULL || noenv(L)) /* no environment variable? */
3089e2f6347Smbalmer lua_pushstring(L, dft); /* use default */
309f0dad708Snikita else if ((dftmark = strstr(path, LUA_PATH_SEP LUA_PATH_SEP)) == NULL)
310f0dad708Snikita lua_pushstring(L, path); /* nothing to change */
311f0dad708Snikita else { /* path contains a ";;": insert default path in its place */
312f0dad708Snikita size_t len = strlen(path);
313f0dad708Snikita luaL_Buffer b;
314f0dad708Snikita luaL_buffinit(L, &b);
315f0dad708Snikita if (path < dftmark) { /* is there a prefix before ';;'? */
316f0dad708Snikita luaL_addlstring(&b, path, dftmark - path); /* add it */
317f0dad708Snikita luaL_addchar(&b, *LUA_PATH_SEP);
318f0dad708Snikita }
319f0dad708Snikita luaL_addstring(&b, dft); /* add default */
320f0dad708Snikita if (dftmark < path + len - 2) { /* is there a suffix after ';;'? */
321f0dad708Snikita luaL_addchar(&b, *LUA_PATH_SEP);
322f0dad708Snikita luaL_addlstring(&b, dftmark + 2, (path + len - 2) - dftmark);
323f0dad708Snikita }
324f0dad708Snikita luaL_pushresult(&b);
3259e2f6347Smbalmer }
3269e2f6347Smbalmer setprogdir(L);
3279e2f6347Smbalmer lua_setfield(L, -3, fieldname); /* package[fieldname] = path value */
328f0dad708Snikita lua_pop(L, 1); /* pop versioned variable name ('nver') */
3299e2f6347Smbalmer }
3309e2f6347Smbalmer
3319e2f6347Smbalmer /* }================================================================== */
3329e2f6347Smbalmer
3339e2f6347Smbalmer
3349e2f6347Smbalmer /*
33573008250Slneto ** return registry.CLIBS[path]
33673008250Slneto */
checkclib(lua_State * L,const char * path)33773008250Slneto static void *checkclib (lua_State *L, const char *path) {
3384ab4902eSlneto void *plib;
339f0dad708Snikita lua_getfield(L, LUA_REGISTRYINDEX, CLIBS);
3404ab4902eSlneto lua_getfield(L, -1, path);
3414ab4902eSlneto plib = lua_touserdata(L, -1); /* plib = CLIBS[path] */
3424ab4902eSlneto lua_pop(L, 2); /* pop CLIBS table and 'plib' */
343dbec5304Smbalmer return plib;
344dbec5304Smbalmer }
345dbec5304Smbalmer
346dbec5304Smbalmer
34773008250Slneto /*
34873008250Slneto ** registry.CLIBS[path] = plib -- for queries
34973008250Slneto ** registry.CLIBS[#CLIBS + 1] = plib -- also keep a list of all libraries
35073008250Slneto */
addtoclib(lua_State * L,const char * path,void * plib)35173008250Slneto static void addtoclib (lua_State *L, const char *path, void *plib) {
352f0dad708Snikita lua_getfield(L, LUA_REGISTRYINDEX, CLIBS);
3534ab4902eSlneto lua_pushlightuserdata(L, plib);
3544ab4902eSlneto lua_pushvalue(L, -1);
3554ab4902eSlneto lua_setfield(L, -3, path); /* CLIBS[path] = plib */
3564ab4902eSlneto lua_rawseti(L, -2, luaL_len(L, -2) + 1); /* CLIBS[#CLIBS + 1] = plib */
3574ab4902eSlneto lua_pop(L, 1); /* pop CLIBS table */
3584ab4902eSlneto }
3594ab4902eSlneto
3604ab4902eSlneto
361dbec5304Smbalmer /*
36273008250Slneto ** __gc tag method for CLIBS table: calls 'lsys_unloadlib' for all lib
3634ab4902eSlneto ** handles in list CLIBS
364dbec5304Smbalmer */
gctm(lua_State * L)365dbec5304Smbalmer static int gctm (lua_State *L) {
36673008250Slneto lua_Integer n = luaL_len(L, 1);
3674ab4902eSlneto for (; n >= 1; n--) { /* for each handle, in reverse order */
3684ab4902eSlneto lua_rawgeti(L, 1, n); /* get handle CLIBS[n] */
36973008250Slneto lsys_unloadlib(lua_touserdata(L, -1));
3704ab4902eSlneto lua_pop(L, 1); /* pop handle */
3714ab4902eSlneto }
372dbec5304Smbalmer return 0;
373dbec5304Smbalmer }
374dbec5304Smbalmer
375dbec5304Smbalmer
37673008250Slneto
37773008250Slneto /* error codes for 'lookforfunc' */
37873008250Slneto #define ERRLIB 1
37973008250Slneto #define ERRFUNC 2
38073008250Slneto
38173008250Slneto /*
38273008250Slneto ** Look for a C function named 'sym' in a dynamically loaded library
38373008250Slneto ** 'path'.
38473008250Slneto ** First, check whether the library is already loaded; if not, try
38573008250Slneto ** to load it.
38673008250Slneto ** Then, if 'sym' is '*', return true (as library has been loaded).
38773008250Slneto ** Otherwise, look for symbol 'sym' in the library and push a
38873008250Slneto ** C function with that symbol.
38973008250Slneto ** Return 0 and 'true' or a function in the stack; in case of
39073008250Slneto ** errors, return an error code and an error message in the stack.
39173008250Slneto */
lookforfunc(lua_State * L,const char * path,const char * sym)39273008250Slneto static int lookforfunc (lua_State *L, const char *path, const char *sym) {
39373008250Slneto void *reg = checkclib(L, path); /* check loaded C libraries */
3944ab4902eSlneto if (reg == NULL) { /* must load library? */
39573008250Slneto reg = lsys_load(L, path, *sym == '*'); /* global symbols if 'sym'=='*' */
3964ab4902eSlneto if (reg == NULL) return ERRLIB; /* unable to load library */
39773008250Slneto addtoclib(L, path, reg);
3984ab4902eSlneto }
3994ab4902eSlneto if (*sym == '*') { /* loading only library (no function)? */
4004ab4902eSlneto lua_pushboolean(L, 1); /* return 'true' */
4014ab4902eSlneto return 0; /* no errors */
4024ab4902eSlneto }
403dbec5304Smbalmer else {
40473008250Slneto lua_CFunction f = lsys_sym(L, reg, sym);
405dbec5304Smbalmer if (f == NULL)
406dbec5304Smbalmer return ERRFUNC; /* unable to find function */
4074ab4902eSlneto lua_pushcfunction(L, f); /* else create new function */
4084ab4902eSlneto return 0; /* no errors */
409dbec5304Smbalmer }
410dbec5304Smbalmer }
411dbec5304Smbalmer
412dbec5304Smbalmer
ll_loadlib(lua_State * L)413dbec5304Smbalmer static int ll_loadlib (lua_State *L) {
414dbec5304Smbalmer const char *path = luaL_checkstring(L, 1);
415dbec5304Smbalmer const char *init = luaL_checkstring(L, 2);
41673008250Slneto int stat = lookforfunc(L, path, init);
417f0dad708Snikita if (l_likely(stat == 0)) /* no errors? */
418dbec5304Smbalmer return 1; /* return the loaded function */
419dbec5304Smbalmer else { /* error; error message is on stack top */
420f0dad708Snikita luaL_pushfail(L);
421dbec5304Smbalmer lua_insert(L, -2);
422dbec5304Smbalmer lua_pushstring(L, (stat == ERRLIB) ? LIB_FAIL : "init");
423f0dad708Snikita return 3; /* return fail, error message, and where */
424dbec5304Smbalmer }
425dbec5304Smbalmer }
426dbec5304Smbalmer
427dbec5304Smbalmer
428dbec5304Smbalmer
429dbec5304Smbalmer /*
430dbec5304Smbalmer ** {======================================================
431dbec5304Smbalmer ** 'require' function
432dbec5304Smbalmer ** =======================================================
433dbec5304Smbalmer */
434dbec5304Smbalmer
435dbec5304Smbalmer
readable(const char * filename)436dbec5304Smbalmer static int readable (const char *filename) {
437dbec5304Smbalmer FILE *f = fopen(filename, "r"); /* try to open file */
438dbec5304Smbalmer if (f == NULL) return 0; /* open failed */
439dbec5304Smbalmer fclose(f);
440dbec5304Smbalmer return 1;
441dbec5304Smbalmer }
442dbec5304Smbalmer
443dbec5304Smbalmer
444f0dad708Snikita /*
445f0dad708Snikita ** Get the next name in '*path' = 'name1;name2;name3;...', changing
446f0dad708Snikita ** the ending ';' to '\0' to create a zero-terminated string. Return
447f0dad708Snikita ** NULL when list ends.
448f0dad708Snikita */
getnextfilename(char ** path,char * end)449f0dad708Snikita static const char *getnextfilename (char **path, char *end) {
450f0dad708Snikita char *sep;
451f0dad708Snikita char *name = *path;
452f0dad708Snikita if (name == end)
453f0dad708Snikita return NULL; /* no more names */
454f0dad708Snikita else if (*name == '\0') { /* from previous iteration? */
455f0dad708Snikita *name = *LUA_PATH_SEP; /* restore separator */
456f0dad708Snikita name++; /* skip it */
457f0dad708Snikita }
458f0dad708Snikita sep = strchr(name, *LUA_PATH_SEP); /* find next separator */
459f0dad708Snikita if (sep == NULL) /* separator not found? */
460f0dad708Snikita sep = end; /* name goes until the end */
461f0dad708Snikita *sep = '\0'; /* finish file name */
462f0dad708Snikita *path = sep; /* will start next search from here */
463f0dad708Snikita return name;
464f0dad708Snikita }
465f0dad708Snikita
466f0dad708Snikita
467f0dad708Snikita /*
468f0dad708Snikita ** Given a path such as ";blabla.so;blublu.so", pushes the string
469f0dad708Snikita **
470f0dad708Snikita ** no file 'blabla.so'
471f0dad708Snikita ** no file 'blublu.so'
472f0dad708Snikita */
pusherrornotfound(lua_State * L,const char * path)473f0dad708Snikita static void pusherrornotfound (lua_State *L, const char *path) {
474f0dad708Snikita luaL_Buffer b;
475f0dad708Snikita luaL_buffinit(L, &b);
476f0dad708Snikita luaL_addstring(&b, "no file '");
477f0dad708Snikita luaL_addgsub(&b, path, LUA_PATH_SEP, "'\n\tno file '");
478f0dad708Snikita luaL_addstring(&b, "'");
479f0dad708Snikita luaL_pushresult(&b);
480dbec5304Smbalmer }
481dbec5304Smbalmer
482dbec5304Smbalmer
searchpath(lua_State * L,const char * name,const char * path,const char * sep,const char * dirsep)4834ab4902eSlneto static const char *searchpath (lua_State *L, const char *name,
4844ab4902eSlneto const char *path,
4854ab4902eSlneto const char *sep,
4864ab4902eSlneto const char *dirsep) {
487f0dad708Snikita luaL_Buffer buff;
488f0dad708Snikita char *pathname; /* path with name inserted */
489f0dad708Snikita char *endpathname; /* its end */
490f0dad708Snikita const char *filename;
491f0dad708Snikita /* separator is non-empty and appears in 'name'? */
492f0dad708Snikita if (*sep != '\0' && strchr(name, *sep) != NULL)
4934ab4902eSlneto name = luaL_gsub(L, name, sep, dirsep); /* replace it by 'dirsep' */
494f0dad708Snikita luaL_buffinit(L, &buff);
495f0dad708Snikita /* add path to the buffer, replacing marks ('?') with the file name */
496f0dad708Snikita luaL_addgsub(&buff, path, LUA_PATH_MARK, name);
497f0dad708Snikita luaL_addchar(&buff, '\0');
498f0dad708Snikita pathname = luaL_buffaddr(&buff); /* writable list of file names */
499f0dad708Snikita endpathname = pathname + luaL_bufflen(&buff) - 1;
500f0dad708Snikita while ((filename = getnextfilename(&pathname, endpathname)) != NULL) {
501dbec5304Smbalmer if (readable(filename)) /* does file exist and is readable? */
502f0dad708Snikita return lua_pushstring(L, filename); /* save and return name */
503dbec5304Smbalmer }
504f0dad708Snikita luaL_pushresult(&buff); /* push path to create error message */
505f0dad708Snikita pusherrornotfound(L, lua_tostring(L, -1)); /* create error message */
506dbec5304Smbalmer return NULL; /* not found */
507dbec5304Smbalmer }
508dbec5304Smbalmer
509dbec5304Smbalmer
ll_searchpath(lua_State * L)5104ab4902eSlneto static int ll_searchpath (lua_State *L) {
5114ab4902eSlneto const char *f = searchpath(L, luaL_checkstring(L, 1),
5124ab4902eSlneto luaL_checkstring(L, 2),
5134ab4902eSlneto luaL_optstring(L, 3, "."),
5144ab4902eSlneto luaL_optstring(L, 4, LUA_DIRSEP));
5154ab4902eSlneto if (f != NULL) return 1;
5164ab4902eSlneto else { /* error message is on top of the stack */
517f0dad708Snikita luaL_pushfail(L);
5184ab4902eSlneto lua_insert(L, -2);
519f0dad708Snikita return 2; /* return fail + error message */
5204ab4902eSlneto }
5214ab4902eSlneto }
5224ab4902eSlneto
5234ab4902eSlneto
findfile(lua_State * L,const char * name,const char * pname,const char * dirsep)5244ab4902eSlneto static const char *findfile (lua_State *L, const char *name,
5254ab4902eSlneto const char *pname,
5264ab4902eSlneto const char *dirsep) {
5274ab4902eSlneto const char *path;
5284ab4902eSlneto lua_getfield(L, lua_upvalueindex(1), pname);
5294ab4902eSlneto path = lua_tostring(L, -1);
530f0dad708Snikita if (l_unlikely(path == NULL))
53173008250Slneto luaL_error(L, "'package.%s' must be a string", pname);
5324ab4902eSlneto return searchpath(L, name, path, ".", dirsep);
5334ab4902eSlneto }
5344ab4902eSlneto
5354ab4902eSlneto
checkload(lua_State * L,int stat,const char * filename)5364ab4902eSlneto static int checkload (lua_State *L, int stat, const char *filename) {
537f0dad708Snikita if (l_likely(stat)) { /* module loaded successfully? */
5384ab4902eSlneto lua_pushstring(L, filename); /* will be 2nd argument to module */
5394ab4902eSlneto return 2; /* return open function and file name */
5404ab4902eSlneto }
5414ab4902eSlneto else
54273008250Slneto return luaL_error(L, "error loading module '%s' from file '%s':\n\t%s",
543dbec5304Smbalmer lua_tostring(L, 1), filename, lua_tostring(L, -1));
544dbec5304Smbalmer }
545dbec5304Smbalmer
546dbec5304Smbalmer
searcher_Lua(lua_State * L)5474ab4902eSlneto static int searcher_Lua (lua_State *L) {
548dbec5304Smbalmer const char *filename;
549dbec5304Smbalmer const char *name = luaL_checkstring(L, 1);
5504ab4902eSlneto filename = findfile(L, name, "path", LUA_LSUBSEP);
5514ab4902eSlneto if (filename == NULL) return 1; /* module not found in this path */
5524ab4902eSlneto return checkload(L, (luaL_loadfile(L, filename) == LUA_OK), filename);
553dbec5304Smbalmer }
554dbec5304Smbalmer
555dbec5304Smbalmer
55673008250Slneto /*
55773008250Slneto ** Try to find a load function for module 'modname' at file 'filename'.
55873008250Slneto ** First, change '.' to '_' in 'modname'; then, if 'modname' has
55973008250Slneto ** the form X-Y (that is, it has an "ignore mark"), build a function
56073008250Slneto ** name "luaopen_X" and look for it. (For compatibility, if that
56173008250Slneto ** fails, it also tries "luaopen_Y".) If there is no ignore mark,
56273008250Slneto ** look for a function named "luaopen_modname".
56373008250Slneto */
loadfunc(lua_State * L,const char * filename,const char * modname)5644ab4902eSlneto static int loadfunc (lua_State *L, const char *filename, const char *modname) {
56573008250Slneto const char *openfunc;
5664ab4902eSlneto const char *mark;
5674ab4902eSlneto modname = luaL_gsub(L, modname, ".", LUA_OFSEP);
5684ab4902eSlneto mark = strchr(modname, *LUA_IGMARK);
5694ab4902eSlneto if (mark) {
5704ab4902eSlneto int stat;
57173008250Slneto openfunc = lua_pushlstring(L, modname, mark - modname);
57273008250Slneto openfunc = lua_pushfstring(L, LUA_POF"%s", openfunc);
57373008250Slneto stat = lookforfunc(L, filename, openfunc);
5744ab4902eSlneto if (stat != ERRFUNC) return stat;
5754ab4902eSlneto modname = mark + 1; /* else go ahead and try old-style name */
5764ab4902eSlneto }
57773008250Slneto openfunc = lua_pushfstring(L, LUA_POF"%s", modname);
57873008250Slneto return lookforfunc(L, filename, openfunc);
579dbec5304Smbalmer }
580dbec5304Smbalmer
581dbec5304Smbalmer
searcher_C(lua_State * L)5824ab4902eSlneto static int searcher_C (lua_State *L) {
583dbec5304Smbalmer const char *name = luaL_checkstring(L, 1);
5844ab4902eSlneto const char *filename = findfile(L, name, "cpath", LUA_CSUBSEP);
5854ab4902eSlneto if (filename == NULL) return 1; /* module not found in this path */
5864ab4902eSlneto return checkload(L, (loadfunc(L, filename, name) == 0), filename);
587dbec5304Smbalmer }
588dbec5304Smbalmer
589dbec5304Smbalmer
searcher_Croot(lua_State * L)5904ab4902eSlneto static int searcher_Croot (lua_State *L) {
591dbec5304Smbalmer const char *filename;
592dbec5304Smbalmer const char *name = luaL_checkstring(L, 1);
593dbec5304Smbalmer const char *p = strchr(name, '.');
594dbec5304Smbalmer int stat;
595dbec5304Smbalmer if (p == NULL) return 0; /* is root */
596dbec5304Smbalmer lua_pushlstring(L, name, p - name);
5974ab4902eSlneto filename = findfile(L, lua_tostring(L, -1), "cpath", LUA_CSUBSEP);
598dbec5304Smbalmer if (filename == NULL) return 1; /* root not found */
5994ab4902eSlneto if ((stat = loadfunc(L, filename, name)) != 0) {
6004ab4902eSlneto if (stat != ERRFUNC)
6014ab4902eSlneto return checkload(L, 0, filename); /* real error */
6024ab4902eSlneto else { /* open function not found */
603f0dad708Snikita lua_pushfstring(L, "no module '%s' in file '%s'", name, filename);
604dbec5304Smbalmer return 1;
605dbec5304Smbalmer }
6064ab4902eSlneto }
6074ab4902eSlneto lua_pushstring(L, filename); /* will be 2nd argument to module */
6084ab4902eSlneto return 2;
6094ab4902eSlneto }
610dbec5304Smbalmer
611dbec5304Smbalmer
searcher_preload(lua_State * L)6124ab4902eSlneto static int searcher_preload (lua_State *L) {
613dbec5304Smbalmer const char *name = luaL_checkstring(L, 1);
6149e2f6347Smbalmer lua_getfield(L, LUA_REGISTRYINDEX, LUA_PRELOAD_TABLE);
615f0dad708Snikita if (lua_getfield(L, -1, name) == LUA_TNIL) { /* not found? */
616f0dad708Snikita lua_pushfstring(L, "no field package.preload['%s']", name);
617dbec5304Smbalmer return 1;
618dbec5304Smbalmer }
619f0dad708Snikita else {
620f0dad708Snikita lua_pushliteral(L, ":preload:");
621f0dad708Snikita return 2;
622f0dad708Snikita }
623f0dad708Snikita }
624dbec5304Smbalmer
625dbec5304Smbalmer
findloader(lua_State * L,const char * name)6264ab4902eSlneto static void findloader (lua_State *L, const char *name) {
6274ab4902eSlneto int i;
6284ab4902eSlneto luaL_Buffer msg; /* to build error message */
62973008250Slneto /* push 'package.searchers' to index 3 in the stack */
630f0dad708Snikita if (l_unlikely(lua_getfield(L, lua_upvalueindex(1), "searchers")
631f0dad708Snikita != LUA_TTABLE))
63273008250Slneto luaL_error(L, "'package.searchers' must be a table");
633f0dad708Snikita luaL_buffinit(L, &msg);
6344ab4902eSlneto /* iterate over available searchers to find a loader */
6354ab4902eSlneto for (i = 1; ; i++) {
636f0dad708Snikita luaL_addstring(&msg, "\n\t"); /* error-message prefix */
637f0dad708Snikita if (l_unlikely(lua_rawgeti(L, 3, i) == LUA_TNIL)) { /* no more searchers? */
6384ab4902eSlneto lua_pop(L, 1); /* remove nil */
639f0dad708Snikita luaL_buffsub(&msg, 2); /* remove prefix */
6404ab4902eSlneto luaL_pushresult(&msg); /* create error message */
64173008250Slneto luaL_error(L, "module '%s' not found:%s", name, lua_tostring(L, -1));
6424ab4902eSlneto }
6434ab4902eSlneto lua_pushstring(L, name);
6444ab4902eSlneto lua_call(L, 1, 2); /* call it */
6454ab4902eSlneto if (lua_isfunction(L, -2)) /* did it find a loader? */
6464ab4902eSlneto return; /* module loader found */
6474ab4902eSlneto else if (lua_isstring(L, -2)) { /* searcher returned error message? */
6484ab4902eSlneto lua_pop(L, 1); /* remove extra return */
6494ab4902eSlneto luaL_addvalue(&msg); /* concatenate error message */
6504ab4902eSlneto }
651f0dad708Snikita else { /* no error message */
6524ab4902eSlneto lua_pop(L, 2); /* remove both returns */
653f0dad708Snikita luaL_buffsub(&msg, 2); /* remove prefix */
654f0dad708Snikita }
6554ab4902eSlneto }
6564ab4902eSlneto }
657dbec5304Smbalmer
658dbec5304Smbalmer
ll_require(lua_State * L)659dbec5304Smbalmer static int ll_require (lua_State *L) {
660dbec5304Smbalmer const char *name = luaL_checkstring(L, 1);
6619e2f6347Smbalmer lua_settop(L, 1); /* LOADED table will be at index 2 */
6629e2f6347Smbalmer lua_getfield(L, LUA_REGISTRYINDEX, LUA_LOADED_TABLE);
6639e2f6347Smbalmer lua_getfield(L, 2, name); /* LOADED[name] */
6644ab4902eSlneto if (lua_toboolean(L, -1)) /* is it there? */
665dbec5304Smbalmer return 1; /* package is already loaded */
6664ab4902eSlneto /* else must load package */
6674ab4902eSlneto lua_pop(L, 1); /* remove 'getfield' result */
6684ab4902eSlneto findloader(L, name);
669f0dad708Snikita lua_rotate(L, -2, 1); /* function <-> loader data */
670f0dad708Snikita lua_pushvalue(L, 1); /* name is 1st argument to module loader */
671f0dad708Snikita lua_pushvalue(L, -3); /* loader data is 2nd argument */
672f0dad708Snikita /* stack: ...; loader data; loader function; mod. name; loader data */
6734ab4902eSlneto lua_call(L, 2, 1); /* run loader to load module */
674f0dad708Snikita /* stack: ...; loader data; result from loader */
675dbec5304Smbalmer if (!lua_isnil(L, -1)) /* non-nil return? */
6769e2f6347Smbalmer lua_setfield(L, 2, name); /* LOADED[name] = returned value */
677f0dad708Snikita else
678f0dad708Snikita lua_pop(L, 1); /* pop nil */
6794ab4902eSlneto if (lua_getfield(L, 2, name) == LUA_TNIL) { /* module set no value? */
680dbec5304Smbalmer lua_pushboolean(L, 1); /* use true as result */
681f0dad708Snikita lua_copy(L, -1, -2); /* replace loader result */
6829e2f6347Smbalmer lua_setfield(L, 2, name); /* LOADED[name] = true */
683dbec5304Smbalmer }
684f0dad708Snikita lua_rotate(L, -2, 1); /* loader data <-> module result */
685f0dad708Snikita return 2; /* return module result and loader data */
686dbec5304Smbalmer }
687dbec5304Smbalmer
688dbec5304Smbalmer /* }====================================================== */
689dbec5304Smbalmer
690dbec5304Smbalmer
691dbec5304Smbalmer
692dbec5304Smbalmer
693dbec5304Smbalmer static const luaL_Reg pk_funcs[] = {
694dbec5304Smbalmer {"loadlib", ll_loadlib},
6954ab4902eSlneto {"searchpath", ll_searchpath},
69673008250Slneto /* placeholders */
69773008250Slneto {"preload", NULL},
69873008250Slneto {"cpath", NULL},
69973008250Slneto {"path", NULL},
70073008250Slneto {"searchers", NULL},
70173008250Slneto {"loaded", NULL},
702dbec5304Smbalmer {NULL, NULL}
703dbec5304Smbalmer };
704dbec5304Smbalmer
705dbec5304Smbalmer
706dbec5304Smbalmer static const luaL_Reg ll_funcs[] = {
707dbec5304Smbalmer {"require", ll_require},
708dbec5304Smbalmer {NULL, NULL}
709dbec5304Smbalmer };
710dbec5304Smbalmer
711dbec5304Smbalmer
createsearcherstable(lua_State * L)7124ab4902eSlneto static void createsearcherstable (lua_State *L) {
713*bdda0531Snikita static const lua_CFunction searchers[] = {
714*bdda0531Snikita searcher_preload,
715*bdda0531Snikita searcher_Lua,
716*bdda0531Snikita searcher_C,
717*bdda0531Snikita searcher_Croot,
718*bdda0531Snikita NULL
719*bdda0531Snikita };
720dbec5304Smbalmer int i;
7214ab4902eSlneto /* create 'searchers' table */
7224ab4902eSlneto lua_createtable(L, sizeof(searchers)/sizeof(searchers[0]) - 1, 0);
7232d6cb6c2Slneto /* fill it with predefined searchers */
7244ab4902eSlneto for (i=0; searchers[i] != NULL; i++) {
7254ab4902eSlneto lua_pushvalue(L, -2); /* set 'package' as upvalue for all searchers */
7264ab4902eSlneto lua_pushcclosure(L, searchers[i], 1);
727dbec5304Smbalmer lua_rawseti(L, -2, i+1);
728dbec5304Smbalmer }
72973008250Slneto lua_setfield(L, -2, "searchers"); /* put it in field 'searchers' */
73073008250Slneto }
73173008250Slneto
73273008250Slneto
73373008250Slneto /*
73473008250Slneto ** create table CLIBS to keep track of loaded C libraries,
73573008250Slneto ** setting a finalizer to close all libraries when closing state.
73673008250Slneto */
createclibstable(lua_State * L)73773008250Slneto static void createclibstable (lua_State *L) {
738f0dad708Snikita luaL_getsubtable(L, LUA_REGISTRYINDEX, CLIBS); /* create CLIBS table */
73973008250Slneto lua_createtable(L, 0, 1); /* create metatable for CLIBS */
74073008250Slneto lua_pushcfunction(L, gctm);
74173008250Slneto lua_setfield(L, -2, "__gc"); /* set finalizer for CLIBS table */
74273008250Slneto lua_setmetatable(L, -2);
7434ab4902eSlneto }
7444ab4902eSlneto
7454ab4902eSlneto
luaopen_package(lua_State * L)7464ab4902eSlneto LUAMOD_API int luaopen_package (lua_State *L) {
74773008250Slneto createclibstable(L);
74873008250Slneto luaL_newlib(L, pk_funcs); /* create 'package' table */
7494ab4902eSlneto createsearcherstable(L);
7509e2f6347Smbalmer /* set paths */
7519e2f6347Smbalmer setpath(L, "path", LUA_PATH_VAR, LUA_PATH_DEFAULT);
7529e2f6347Smbalmer setpath(L, "cpath", LUA_CPATH_VAR, LUA_CPATH_DEFAULT);
753dbec5304Smbalmer /* store config information */
7544ab4902eSlneto lua_pushliteral(L, LUA_DIRSEP "\n" LUA_PATH_SEP "\n" LUA_PATH_MARK "\n"
7554ab4902eSlneto LUA_EXEC_DIR "\n" LUA_IGMARK "\n");
756dbec5304Smbalmer lua_setfield(L, -2, "config");
75773008250Slneto /* set field 'loaded' */
7589e2f6347Smbalmer luaL_getsubtable(L, LUA_REGISTRYINDEX, LUA_LOADED_TABLE);
759dbec5304Smbalmer lua_setfield(L, -2, "loaded");
76073008250Slneto /* set field 'preload' */
7619e2f6347Smbalmer luaL_getsubtable(L, LUA_REGISTRYINDEX, LUA_PRELOAD_TABLE);
762dbec5304Smbalmer lua_setfield(L, -2, "preload");
7634ab4902eSlneto lua_pushglobaltable(L);
7644ab4902eSlneto lua_pushvalue(L, -2); /* set 'package' as upvalue for next lib */
7654ab4902eSlneto luaL_setfuncs(L, ll_funcs, 1); /* open lib into global table */
7664ab4902eSlneto lua_pop(L, 1); /* pop global table */
767dbec5304Smbalmer return 1; /* return 'package' table */
768dbec5304Smbalmer }
769dbec5304Smbalmer
770