xref: /aosp_15_r20/external/lua/src/loadlib.c (revision 088332b5b69e7ab13924864b272aabfc2509d2d5)
1*088332b5SXin Li /*
2*088332b5SXin Li ** $Id: loadlib.c $
3*088332b5SXin Li ** Dynamic library loader for Lua
4*088332b5SXin Li ** See Copyright Notice in lua.h
5*088332b5SXin Li **
6*088332b5SXin Li ** This module contains an implementation of loadlib for Unix systems
7*088332b5SXin Li ** that have dlfcn, an implementation for Windows, and a stub for other
8*088332b5SXin Li ** systems.
9*088332b5SXin Li */
10*088332b5SXin Li 
11*088332b5SXin Li #define loadlib_c
12*088332b5SXin Li #define LUA_LIB
13*088332b5SXin Li 
14*088332b5SXin Li #include "lprefix.h"
15*088332b5SXin Li 
16*088332b5SXin Li 
17*088332b5SXin Li #include <stdio.h>
18*088332b5SXin Li #include <stdlib.h>
19*088332b5SXin Li #include <string.h>
20*088332b5SXin Li 
21*088332b5SXin Li #include "lua.h"
22*088332b5SXin Li 
23*088332b5SXin Li #include "lauxlib.h"
24*088332b5SXin Li #include "lualib.h"
25*088332b5SXin Li 
26*088332b5SXin Li 
27*088332b5SXin Li /*
28*088332b5SXin Li ** LUA_IGMARK is a mark to ignore all before it when building the
29*088332b5SXin Li ** luaopen_ function name.
30*088332b5SXin Li */
31*088332b5SXin Li #if !defined (LUA_IGMARK)
32*088332b5SXin Li #define LUA_IGMARK		"-"
33*088332b5SXin Li #endif
34*088332b5SXin Li 
35*088332b5SXin Li 
36*088332b5SXin Li /*
37*088332b5SXin Li ** LUA_CSUBSEP is the character that replaces dots in submodule names
38*088332b5SXin Li ** when searching for a C loader.
39*088332b5SXin Li ** LUA_LSUBSEP is the character that replaces dots in submodule names
40*088332b5SXin Li ** when searching for a Lua loader.
41*088332b5SXin Li */
42*088332b5SXin Li #if !defined(LUA_CSUBSEP)
43*088332b5SXin Li #define LUA_CSUBSEP		LUA_DIRSEP
44*088332b5SXin Li #endif
45*088332b5SXin Li 
46*088332b5SXin Li #if !defined(LUA_LSUBSEP)
47*088332b5SXin Li #define LUA_LSUBSEP		LUA_DIRSEP
48*088332b5SXin Li #endif
49*088332b5SXin Li 
50*088332b5SXin Li 
51*088332b5SXin Li /* prefix for open functions in C libraries */
52*088332b5SXin Li #define LUA_POF		"luaopen_"
53*088332b5SXin Li 
54*088332b5SXin Li /* separator for open functions in C libraries */
55*088332b5SXin Li #define LUA_OFSEP	"_"
56*088332b5SXin Li 
57*088332b5SXin Li 
58*088332b5SXin Li /*
59*088332b5SXin Li ** key for table in the registry that keeps handles
60*088332b5SXin Li ** for all loaded C libraries
61*088332b5SXin Li */
62*088332b5SXin Li static const char *const CLIBS = "_CLIBS";
63*088332b5SXin Li 
64*088332b5SXin Li #define LIB_FAIL	"open"
65*088332b5SXin Li 
66*088332b5SXin Li 
67*088332b5SXin Li #define setprogdir(L)           ((void)0)
68*088332b5SXin Li 
69*088332b5SXin Li 
70*088332b5SXin Li /*
71*088332b5SXin Li ** Special type equivalent to '(void*)' for functions in gcc
72*088332b5SXin Li ** (to suppress warnings when converting function pointers)
73*088332b5SXin Li */
74*088332b5SXin Li typedef void (*voidf)(void);
75*088332b5SXin Li 
76*088332b5SXin Li 
77*088332b5SXin Li /*
78*088332b5SXin Li ** system-dependent functions
79*088332b5SXin Li */
80*088332b5SXin Li 
81*088332b5SXin Li /*
82*088332b5SXin Li ** unload library 'lib'
83*088332b5SXin Li */
84*088332b5SXin Li static void lsys_unloadlib (void *lib);
85*088332b5SXin Li 
86*088332b5SXin Li /*
87*088332b5SXin Li ** load C library in file 'path'. If 'seeglb', load with all names in
88*088332b5SXin Li ** the library global.
89*088332b5SXin Li ** Returns the library; in case of error, returns NULL plus an
90*088332b5SXin Li ** error string in the stack.
91*088332b5SXin Li */
92*088332b5SXin Li static void *lsys_load (lua_State *L, const char *path, int seeglb);
93*088332b5SXin Li 
94*088332b5SXin Li /*
95*088332b5SXin Li ** Try to find a function named 'sym' in library 'lib'.
96*088332b5SXin Li ** Returns the function; in case of error, returns NULL plus an
97*088332b5SXin Li ** error string in the stack.
98*088332b5SXin Li */
99*088332b5SXin Li static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym);
100*088332b5SXin Li 
101*088332b5SXin Li 
102*088332b5SXin Li 
103*088332b5SXin Li 
104*088332b5SXin Li #if defined(LUA_USE_DLOPEN)	/* { */
105*088332b5SXin Li /*
106*088332b5SXin Li ** {========================================================================
107*088332b5SXin Li ** This is an implementation of loadlib based on the dlfcn interface.
108*088332b5SXin Li ** The dlfcn interface is available in Linux, SunOS, Solaris, IRIX, FreeBSD,
109*088332b5SXin Li ** NetBSD, AIX 4.2, HPUX 11, and  probably most other Unix flavors, at least
110*088332b5SXin Li ** as an emulation layer on top of native functions.
111*088332b5SXin Li ** =========================================================================
112*088332b5SXin Li */
113*088332b5SXin Li 
114*088332b5SXin Li #include <dlfcn.h>
115*088332b5SXin Li 
116*088332b5SXin Li /*
117*088332b5SXin Li ** Macro to convert pointer-to-void* to pointer-to-function. This cast
118*088332b5SXin Li ** is undefined according to ISO C, but POSIX assumes that it works.
119*088332b5SXin Li ** (The '__extension__' in gnu compilers is only to avoid warnings.)
120*088332b5SXin Li */
121*088332b5SXin Li #if defined(__GNUC__)
122*088332b5SXin Li #define cast_func(p) (__extension__ (lua_CFunction)(p))
123*088332b5SXin Li #else
124*088332b5SXin Li #define cast_func(p) ((lua_CFunction)(p))
125*088332b5SXin Li #endif
126*088332b5SXin Li 
127*088332b5SXin Li 
lsys_unloadlib(void * lib)128*088332b5SXin Li static void lsys_unloadlib (void *lib) {
129*088332b5SXin Li   dlclose(lib);
130*088332b5SXin Li }
131*088332b5SXin Li 
132*088332b5SXin Li 
lsys_load(lua_State * L,const char * path,int seeglb)133*088332b5SXin Li static void *lsys_load (lua_State *L, const char *path, int seeglb) {
134*088332b5SXin Li   void *lib = dlopen(path, RTLD_NOW | (seeglb ? RTLD_GLOBAL : RTLD_LOCAL));
135*088332b5SXin Li   if (lib == NULL) lua_pushstring(L, dlerror());
136*088332b5SXin Li   return lib;
137*088332b5SXin Li }
138*088332b5SXin Li 
139*088332b5SXin Li 
lsys_sym(lua_State * L,void * lib,const char * sym)140*088332b5SXin Li static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
141*088332b5SXin Li   lua_CFunction f = cast_func(dlsym(lib, sym));
142*088332b5SXin Li   if (f == NULL) lua_pushstring(L, dlerror());
143*088332b5SXin Li   return f;
144*088332b5SXin Li }
145*088332b5SXin Li 
146*088332b5SXin Li /* }====================================================== */
147*088332b5SXin Li 
148*088332b5SXin Li 
149*088332b5SXin Li 
150*088332b5SXin Li #elif defined(LUA_DL_DLL)	/* }{ */
151*088332b5SXin Li /*
152*088332b5SXin Li ** {======================================================================
153*088332b5SXin Li ** This is an implementation of loadlib for Windows using native functions.
154*088332b5SXin Li ** =======================================================================
155*088332b5SXin Li */
156*088332b5SXin Li 
157*088332b5SXin Li #include <windows.h>
158*088332b5SXin Li 
159*088332b5SXin Li 
160*088332b5SXin Li /*
161*088332b5SXin Li ** optional flags for LoadLibraryEx
162*088332b5SXin Li */
163*088332b5SXin Li #if !defined(LUA_LLE_FLAGS)
164*088332b5SXin Li #define LUA_LLE_FLAGS	0
165*088332b5SXin Li #endif
166*088332b5SXin Li 
167*088332b5SXin Li 
168*088332b5SXin Li #undef setprogdir
169*088332b5SXin Li 
170*088332b5SXin Li 
171*088332b5SXin Li /*
172*088332b5SXin Li ** Replace in the path (on the top of the stack) any occurrence
173*088332b5SXin Li ** of LUA_EXEC_DIR with the executable's path.
174*088332b5SXin Li */
setprogdir(lua_State * L)175*088332b5SXin Li static void setprogdir (lua_State *L) {
176*088332b5SXin Li   char buff[MAX_PATH + 1];
177*088332b5SXin Li   char *lb;
178*088332b5SXin Li   DWORD nsize = sizeof(buff)/sizeof(char);
179*088332b5SXin Li   DWORD n = GetModuleFileNameA(NULL, buff, nsize);  /* get exec. name */
180*088332b5SXin Li   if (n == 0 || n == nsize || (lb = strrchr(buff, '\\')) == NULL)
181*088332b5SXin Li     luaL_error(L, "unable to get ModuleFileName");
182*088332b5SXin Li   else {
183*088332b5SXin Li     *lb = '\0';  /* cut name on the last '\\' to get the path */
184*088332b5SXin Li     luaL_gsub(L, lua_tostring(L, -1), LUA_EXEC_DIR, buff);
185*088332b5SXin Li     lua_remove(L, -2);  /* remove original string */
186*088332b5SXin Li   }
187*088332b5SXin Li }
188*088332b5SXin Li 
189*088332b5SXin Li 
190*088332b5SXin Li 
191*088332b5SXin Li 
pusherror(lua_State * L)192*088332b5SXin Li static void pusherror (lua_State *L) {
193*088332b5SXin Li   int error = GetLastError();
194*088332b5SXin Li   char buffer[128];
195*088332b5SXin Li   if (FormatMessageA(FORMAT_MESSAGE_IGNORE_INSERTS | FORMAT_MESSAGE_FROM_SYSTEM,
196*088332b5SXin Li       NULL, error, 0, buffer, sizeof(buffer)/sizeof(char), NULL))
197*088332b5SXin Li     lua_pushstring(L, buffer);
198*088332b5SXin Li   else
199*088332b5SXin Li     lua_pushfstring(L, "system error %d\n", error);
200*088332b5SXin Li }
201*088332b5SXin Li 
lsys_unloadlib(void * lib)202*088332b5SXin Li static void lsys_unloadlib (void *lib) {
203*088332b5SXin Li   FreeLibrary((HMODULE)lib);
204*088332b5SXin Li }
205*088332b5SXin Li 
206*088332b5SXin Li 
lsys_load(lua_State * L,const char * path,int seeglb)207*088332b5SXin Li static void *lsys_load (lua_State *L, const char *path, int seeglb) {
208*088332b5SXin Li   HMODULE lib = LoadLibraryExA(path, NULL, LUA_LLE_FLAGS);
209*088332b5SXin Li   (void)(seeglb);  /* not used: symbols are 'global' by default */
210*088332b5SXin Li   if (lib == NULL) pusherror(L);
211*088332b5SXin Li   return lib;
212*088332b5SXin Li }
213*088332b5SXin Li 
214*088332b5SXin Li 
lsys_sym(lua_State * L,void * lib,const char * sym)215*088332b5SXin Li static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
216*088332b5SXin Li   lua_CFunction f = (lua_CFunction)(voidf)GetProcAddress((HMODULE)lib, sym);
217*088332b5SXin Li   if (f == NULL) pusherror(L);
218*088332b5SXin Li   return f;
219*088332b5SXin Li }
220*088332b5SXin Li 
221*088332b5SXin Li /* }====================================================== */
222*088332b5SXin Li 
223*088332b5SXin Li 
224*088332b5SXin Li #else				/* }{ */
225*088332b5SXin Li /*
226*088332b5SXin Li ** {======================================================
227*088332b5SXin Li ** Fallback for other systems
228*088332b5SXin Li ** =======================================================
229*088332b5SXin Li */
230*088332b5SXin Li 
231*088332b5SXin Li #undef LIB_FAIL
232*088332b5SXin Li #define LIB_FAIL	"absent"
233*088332b5SXin Li 
234*088332b5SXin Li 
235*088332b5SXin Li #define DLMSG	"dynamic libraries not enabled; check your Lua installation"
236*088332b5SXin Li 
237*088332b5SXin Li 
lsys_unloadlib(void * lib)238*088332b5SXin Li static void lsys_unloadlib (void *lib) {
239*088332b5SXin Li   (void)(lib);  /* not used */
240*088332b5SXin Li }
241*088332b5SXin Li 
242*088332b5SXin Li 
lsys_load(lua_State * L,const char * path,int seeglb)243*088332b5SXin Li static void *lsys_load (lua_State *L, const char *path, int seeglb) {
244*088332b5SXin Li   (void)(path); (void)(seeglb);  /* not used */
245*088332b5SXin Li   lua_pushliteral(L, DLMSG);
246*088332b5SXin Li   return NULL;
247*088332b5SXin Li }
248*088332b5SXin Li 
249*088332b5SXin Li 
lsys_sym(lua_State * L,void * lib,const char * sym)250*088332b5SXin Li static lua_CFunction lsys_sym (lua_State *L, void *lib, const char *sym) {
251*088332b5SXin Li   (void)(lib); (void)(sym);  /* not used */
252*088332b5SXin Li   lua_pushliteral(L, DLMSG);
253*088332b5SXin Li   return NULL;
254*088332b5SXin Li }
255*088332b5SXin Li 
256*088332b5SXin Li /* }====================================================== */
257*088332b5SXin Li #endif				/* } */
258*088332b5SXin Li 
259*088332b5SXin Li 
260*088332b5SXin Li /*
261*088332b5SXin Li ** {==================================================================
262*088332b5SXin Li ** Set Paths
263*088332b5SXin Li ** ===================================================================
264*088332b5SXin Li */
265*088332b5SXin Li 
266*088332b5SXin Li /*
267*088332b5SXin Li ** LUA_PATH_VAR and LUA_CPATH_VAR are the names of the environment
268*088332b5SXin Li ** variables that Lua check to set its paths.
269*088332b5SXin Li */
270*088332b5SXin Li #if !defined(LUA_PATH_VAR)
271*088332b5SXin Li #define LUA_PATH_VAR    "LUA_PATH"
272*088332b5SXin Li #endif
273*088332b5SXin Li 
274*088332b5SXin Li #if !defined(LUA_CPATH_VAR)
275*088332b5SXin Li #define LUA_CPATH_VAR   "LUA_CPATH"
276*088332b5SXin Li #endif
277*088332b5SXin Li 
278*088332b5SXin Li 
279*088332b5SXin Li 
280*088332b5SXin Li /*
281*088332b5SXin Li ** return registry.LUA_NOENV as a boolean
282*088332b5SXin Li */
noenv(lua_State * L)283*088332b5SXin Li static int noenv (lua_State *L) {
284*088332b5SXin Li   int b;
285*088332b5SXin Li   lua_getfield(L, LUA_REGISTRYINDEX, "LUA_NOENV");
286*088332b5SXin Li   b = lua_toboolean(L, -1);
287*088332b5SXin Li   lua_pop(L, 1);  /* remove value */
288*088332b5SXin Li   return b;
289*088332b5SXin Li }
290*088332b5SXin Li 
291*088332b5SXin Li 
292*088332b5SXin Li /*
293*088332b5SXin Li ** Set a path
294*088332b5SXin Li */
setpath(lua_State * L,const char * fieldname,const char * envname,const char * dft)295*088332b5SXin Li static void setpath (lua_State *L, const char *fieldname,
296*088332b5SXin Li                                    const char *envname,
297*088332b5SXin Li                                    const char *dft) {
298*088332b5SXin Li   const char *dftmark;
299*088332b5SXin Li   const char *nver = lua_pushfstring(L, "%s%s", envname, LUA_VERSUFFIX);
300*088332b5SXin Li   const char *path = getenv(nver);  /* try versioned name */
301*088332b5SXin Li   if (path == NULL)  /* no versioned environment variable? */
302*088332b5SXin Li     path = getenv(envname);  /* try unversioned name */
303*088332b5SXin Li   if (path == NULL || noenv(L))  /* no environment variable? */
304*088332b5SXin Li     lua_pushstring(L, dft);  /* use default */
305*088332b5SXin Li   else if ((dftmark = strstr(path, LUA_PATH_SEP LUA_PATH_SEP)) == NULL)
306*088332b5SXin Li     lua_pushstring(L, path);  /* nothing to change */
307*088332b5SXin Li   else {  /* path contains a ";;": insert default path in its place */
308*088332b5SXin Li     size_t len = strlen(path);
309*088332b5SXin Li     luaL_Buffer b;
310*088332b5SXin Li     luaL_buffinit(L, &b);
311*088332b5SXin Li     if (path < dftmark) {  /* is there a prefix before ';;'? */
312*088332b5SXin Li       luaL_addlstring(&b, path, dftmark - path);  /* add it */
313*088332b5SXin Li       luaL_addchar(&b, *LUA_PATH_SEP);
314*088332b5SXin Li     }
315*088332b5SXin Li     luaL_addstring(&b, dft);  /* add default */
316*088332b5SXin Li     if (dftmark < path + len - 2) {  /* is there a suffix after ';;'? */
317*088332b5SXin Li       luaL_addchar(&b, *LUA_PATH_SEP);
318*088332b5SXin Li       luaL_addlstring(&b, dftmark + 2, (path + len - 2) - dftmark);
319*088332b5SXin Li     }
320*088332b5SXin Li     luaL_pushresult(&b);
321*088332b5SXin Li   }
322*088332b5SXin Li   setprogdir(L);
323*088332b5SXin Li   lua_setfield(L, -3, fieldname);  /* package[fieldname] = path value */
324*088332b5SXin Li   lua_pop(L, 1);  /* pop versioned variable name ('nver') */
325*088332b5SXin Li }
326*088332b5SXin Li 
327*088332b5SXin Li /* }================================================================== */
328*088332b5SXin Li 
329*088332b5SXin Li 
330*088332b5SXin Li /*
331*088332b5SXin Li ** return registry.CLIBS[path]
332*088332b5SXin Li */
checkclib(lua_State * L,const char * path)333*088332b5SXin Li static void *checkclib (lua_State *L, const char *path) {
334*088332b5SXin Li   void *plib;
335*088332b5SXin Li   lua_getfield(L, LUA_REGISTRYINDEX, CLIBS);
336*088332b5SXin Li   lua_getfield(L, -1, path);
337*088332b5SXin Li   plib = lua_touserdata(L, -1);  /* plib = CLIBS[path] */
338*088332b5SXin Li   lua_pop(L, 2);  /* pop CLIBS table and 'plib' */
339*088332b5SXin Li   return plib;
340*088332b5SXin Li }
341*088332b5SXin Li 
342*088332b5SXin Li 
343*088332b5SXin Li /*
344*088332b5SXin Li ** registry.CLIBS[path] = plib        -- for queries
345*088332b5SXin Li ** registry.CLIBS[#CLIBS + 1] = plib  -- also keep a list of all libraries
346*088332b5SXin Li */
addtoclib(lua_State * L,const char * path,void * plib)347*088332b5SXin Li static void addtoclib (lua_State *L, const char *path, void *plib) {
348*088332b5SXin Li   lua_getfield(L, LUA_REGISTRYINDEX, CLIBS);
349*088332b5SXin Li   lua_pushlightuserdata(L, plib);
350*088332b5SXin Li   lua_pushvalue(L, -1);
351*088332b5SXin Li   lua_setfield(L, -3, path);  /* CLIBS[path] = plib */
352*088332b5SXin Li   lua_rawseti(L, -2, luaL_len(L, -2) + 1);  /* CLIBS[#CLIBS + 1] = plib */
353*088332b5SXin Li   lua_pop(L, 1);  /* pop CLIBS table */
354*088332b5SXin Li }
355*088332b5SXin Li 
356*088332b5SXin Li 
357*088332b5SXin Li /*
358*088332b5SXin Li ** __gc tag method for CLIBS table: calls 'lsys_unloadlib' for all lib
359*088332b5SXin Li ** handles in list CLIBS
360*088332b5SXin Li */
gctm(lua_State * L)361*088332b5SXin Li static int gctm (lua_State *L) {
362*088332b5SXin Li   lua_Integer n = luaL_len(L, 1);
363*088332b5SXin Li   for (; n >= 1; n--) {  /* for each handle, in reverse order */
364*088332b5SXin Li     lua_rawgeti(L, 1, n);  /* get handle CLIBS[n] */
365*088332b5SXin Li     lsys_unloadlib(lua_touserdata(L, -1));
366*088332b5SXin Li     lua_pop(L, 1);  /* pop handle */
367*088332b5SXin Li   }
368*088332b5SXin Li   return 0;
369*088332b5SXin Li }
370*088332b5SXin Li 
371*088332b5SXin Li 
372*088332b5SXin Li 
373*088332b5SXin Li /* error codes for 'lookforfunc' */
374*088332b5SXin Li #define ERRLIB		1
375*088332b5SXin Li #define ERRFUNC		2
376*088332b5SXin Li 
377*088332b5SXin Li /*
378*088332b5SXin Li ** Look for a C function named 'sym' in a dynamically loaded library
379*088332b5SXin Li ** 'path'.
380*088332b5SXin Li ** First, check whether the library is already loaded; if not, try
381*088332b5SXin Li ** to load it.
382*088332b5SXin Li ** Then, if 'sym' is '*', return true (as library has been loaded).
383*088332b5SXin Li ** Otherwise, look for symbol 'sym' in the library and push a
384*088332b5SXin Li ** C function with that symbol.
385*088332b5SXin Li ** Return 0 and 'true' or a function in the stack; in case of
386*088332b5SXin Li ** errors, return an error code and an error message in the stack.
387*088332b5SXin Li */
lookforfunc(lua_State * L,const char * path,const char * sym)388*088332b5SXin Li static int lookforfunc (lua_State *L, const char *path, const char *sym) {
389*088332b5SXin Li   void *reg = checkclib(L, path);  /* check loaded C libraries */
390*088332b5SXin Li   if (reg == NULL) {  /* must load library? */
391*088332b5SXin Li     reg = lsys_load(L, path, *sym == '*');  /* global symbols if 'sym'=='*' */
392*088332b5SXin Li     if (reg == NULL) return ERRLIB;  /* unable to load library */
393*088332b5SXin Li     addtoclib(L, path, reg);
394*088332b5SXin Li   }
395*088332b5SXin Li   if (*sym == '*') {  /* loading only library (no function)? */
396*088332b5SXin Li     lua_pushboolean(L, 1);  /* return 'true' */
397*088332b5SXin Li     return 0;  /* no errors */
398*088332b5SXin Li   }
399*088332b5SXin Li   else {
400*088332b5SXin Li     lua_CFunction f = lsys_sym(L, reg, sym);
401*088332b5SXin Li     if (f == NULL)
402*088332b5SXin Li       return ERRFUNC;  /* unable to find function */
403*088332b5SXin Li     lua_pushcfunction(L, f);  /* else create new function */
404*088332b5SXin Li     return 0;  /* no errors */
405*088332b5SXin Li   }
406*088332b5SXin Li }
407*088332b5SXin Li 
408*088332b5SXin Li 
ll_loadlib(lua_State * L)409*088332b5SXin Li static int ll_loadlib (lua_State *L) {
410*088332b5SXin Li   const char *path = luaL_checkstring(L, 1);
411*088332b5SXin Li   const char *init = luaL_checkstring(L, 2);
412*088332b5SXin Li   int stat = lookforfunc(L, path, init);
413*088332b5SXin Li   if (stat == 0)  /* no errors? */
414*088332b5SXin Li     return 1;  /* return the loaded function */
415*088332b5SXin Li   else {  /* error; error message is on stack top */
416*088332b5SXin Li     luaL_pushfail(L);
417*088332b5SXin Li     lua_insert(L, -2);
418*088332b5SXin Li     lua_pushstring(L, (stat == ERRLIB) ?  LIB_FAIL : "init");
419*088332b5SXin Li     return 3;  /* return fail, error message, and where */
420*088332b5SXin Li   }
421*088332b5SXin Li }
422*088332b5SXin Li 
423*088332b5SXin Li 
424*088332b5SXin Li 
425*088332b5SXin Li /*
426*088332b5SXin Li ** {======================================================
427*088332b5SXin Li ** 'require' function
428*088332b5SXin Li ** =======================================================
429*088332b5SXin Li */
430*088332b5SXin Li 
431*088332b5SXin Li 
readable(const char * filename)432*088332b5SXin Li static int readable (const char *filename) {
433*088332b5SXin Li   FILE *f = fopen(filename, "r");  /* try to open file */
434*088332b5SXin Li   if (f == NULL) return 0;  /* open failed */
435*088332b5SXin Li   fclose(f);
436*088332b5SXin Li   return 1;
437*088332b5SXin Li }
438*088332b5SXin Li 
439*088332b5SXin Li 
440*088332b5SXin Li /*
441*088332b5SXin Li ** Get the next name in '*path' = 'name1;name2;name3;...', changing
442*088332b5SXin Li ** the ending ';' to '\0' to create a zero-terminated string. Return
443*088332b5SXin Li ** NULL when list ends.
444*088332b5SXin Li */
getnextfilename(char ** path,char * end)445*088332b5SXin Li static const char *getnextfilename (char **path, char *end) {
446*088332b5SXin Li   char *sep;
447*088332b5SXin Li   char *name = *path;
448*088332b5SXin Li   if (name == end)
449*088332b5SXin Li     return NULL;  /* no more names */
450*088332b5SXin Li   else if (*name == '\0') {  /* from previous iteration? */
451*088332b5SXin Li     *name = *LUA_PATH_SEP;  /* restore separator */
452*088332b5SXin Li     name++;  /* skip it */
453*088332b5SXin Li   }
454*088332b5SXin Li   sep = strchr(name, *LUA_PATH_SEP);  /* find next separator */
455*088332b5SXin Li   if (sep == NULL)  /* separator not found? */
456*088332b5SXin Li     sep = end;  /* name goes until the end */
457*088332b5SXin Li   *sep = '\0';  /* finish file name */
458*088332b5SXin Li   *path = sep;  /* will start next search from here */
459*088332b5SXin Li   return name;
460*088332b5SXin Li }
461*088332b5SXin Li 
462*088332b5SXin Li 
463*088332b5SXin Li /*
464*088332b5SXin Li ** Given a path such as ";blabla.so;blublu.so", pushes the string
465*088332b5SXin Li **
466*088332b5SXin Li ** no file 'blabla.so'
467*088332b5SXin Li **	no file 'blublu.so'
468*088332b5SXin Li */
pusherrornotfound(lua_State * L,const char * path)469*088332b5SXin Li static void pusherrornotfound (lua_State *L, const char *path) {
470*088332b5SXin Li   luaL_Buffer b;
471*088332b5SXin Li   luaL_buffinit(L, &b);
472*088332b5SXin Li   luaL_addstring(&b, "no file '");
473*088332b5SXin Li   luaL_addgsub(&b, path, LUA_PATH_SEP, "'\n\tno file '");
474*088332b5SXin Li   luaL_addstring(&b, "'");
475*088332b5SXin Li   luaL_pushresult(&b);
476*088332b5SXin Li }
477*088332b5SXin Li 
478*088332b5SXin Li 
searchpath(lua_State * L,const char * name,const char * path,const char * sep,const char * dirsep)479*088332b5SXin Li static const char *searchpath (lua_State *L, const char *name,
480*088332b5SXin Li                                              const char *path,
481*088332b5SXin Li                                              const char *sep,
482*088332b5SXin Li                                              const char *dirsep) {
483*088332b5SXin Li   luaL_Buffer buff;
484*088332b5SXin Li   char *pathname;  /* path with name inserted */
485*088332b5SXin Li   char *endpathname;  /* its end */
486*088332b5SXin Li   const char *filename;
487*088332b5SXin Li   /* separator is non-empty and appears in 'name'? */
488*088332b5SXin Li   if (*sep != '\0' && strchr(name, *sep) != NULL)
489*088332b5SXin Li     name = luaL_gsub(L, name, sep, dirsep);  /* replace it by 'dirsep' */
490*088332b5SXin Li   luaL_buffinit(L, &buff);
491*088332b5SXin Li   /* add path to the buffer, replacing marks ('?') with the file name */
492*088332b5SXin Li   luaL_addgsub(&buff, path, LUA_PATH_MARK, name);
493*088332b5SXin Li   luaL_addchar(&buff, '\0');
494*088332b5SXin Li   pathname = luaL_buffaddr(&buff);  /* writable list of file names */
495*088332b5SXin Li   endpathname = pathname + luaL_bufflen(&buff) - 1;
496*088332b5SXin Li   while ((filename = getnextfilename(&pathname, endpathname)) != NULL) {
497*088332b5SXin Li     if (readable(filename))  /* does file exist and is readable? */
498*088332b5SXin Li       return lua_pushstring(L, filename);  /* save and return name */
499*088332b5SXin Li   }
500*088332b5SXin Li   luaL_pushresult(&buff);  /* push path to create error message */
501*088332b5SXin Li   pusherrornotfound(L, lua_tostring(L, -1));  /* create error message */
502*088332b5SXin Li   return NULL;  /* not found */
503*088332b5SXin Li }
504*088332b5SXin Li 
505*088332b5SXin Li 
ll_searchpath(lua_State * L)506*088332b5SXin Li static int ll_searchpath (lua_State *L) {
507*088332b5SXin Li   const char *f = searchpath(L, luaL_checkstring(L, 1),
508*088332b5SXin Li                                 luaL_checkstring(L, 2),
509*088332b5SXin Li                                 luaL_optstring(L, 3, "."),
510*088332b5SXin Li                                 luaL_optstring(L, 4, LUA_DIRSEP));
511*088332b5SXin Li   if (f != NULL) return 1;
512*088332b5SXin Li   else {  /* error message is on top of the stack */
513*088332b5SXin Li     luaL_pushfail(L);
514*088332b5SXin Li     lua_insert(L, -2);
515*088332b5SXin Li     return 2;  /* return fail + error message */
516*088332b5SXin Li   }
517*088332b5SXin Li }
518*088332b5SXin Li 
519*088332b5SXin Li 
findfile(lua_State * L,const char * name,const char * pname,const char * dirsep)520*088332b5SXin Li static const char *findfile (lua_State *L, const char *name,
521*088332b5SXin Li                                            const char *pname,
522*088332b5SXin Li                                            const char *dirsep) {
523*088332b5SXin Li   const char *path;
524*088332b5SXin Li   lua_getfield(L, lua_upvalueindex(1), pname);
525*088332b5SXin Li   path = lua_tostring(L, -1);
526*088332b5SXin Li   if (path == NULL)
527*088332b5SXin Li     luaL_error(L, "'package.%s' must be a string", pname);
528*088332b5SXin Li   return searchpath(L, name, path, ".", dirsep);
529*088332b5SXin Li }
530*088332b5SXin Li 
531*088332b5SXin Li 
checkload(lua_State * L,int stat,const char * filename)532*088332b5SXin Li static int checkload (lua_State *L, int stat, const char *filename) {
533*088332b5SXin Li   if (stat) {  /* module loaded successfully? */
534*088332b5SXin Li     lua_pushstring(L, filename);  /* will be 2nd argument to module */
535*088332b5SXin Li     return 2;  /* return open function and file name */
536*088332b5SXin Li   }
537*088332b5SXin Li   else
538*088332b5SXin Li     return luaL_error(L, "error loading module '%s' from file '%s':\n\t%s",
539*088332b5SXin Li                           lua_tostring(L, 1), filename, lua_tostring(L, -1));
540*088332b5SXin Li }
541*088332b5SXin Li 
542*088332b5SXin Li 
searcher_Lua(lua_State * L)543*088332b5SXin Li static int searcher_Lua (lua_State *L) {
544*088332b5SXin Li   const char *filename;
545*088332b5SXin Li   const char *name = luaL_checkstring(L, 1);
546*088332b5SXin Li   filename = findfile(L, name, "path", LUA_LSUBSEP);
547*088332b5SXin Li   if (filename == NULL) return 1;  /* module not found in this path */
548*088332b5SXin Li   return checkload(L, (luaL_loadfile(L, filename) == LUA_OK), filename);
549*088332b5SXin Li }
550*088332b5SXin Li 
551*088332b5SXin Li 
552*088332b5SXin Li /*
553*088332b5SXin Li ** Try to find a load function for module 'modname' at file 'filename'.
554*088332b5SXin Li ** First, change '.' to '_' in 'modname'; then, if 'modname' has
555*088332b5SXin Li ** the form X-Y (that is, it has an "ignore mark"), build a function
556*088332b5SXin Li ** name "luaopen_X" and look for it. (For compatibility, if that
557*088332b5SXin Li ** fails, it also tries "luaopen_Y".) If there is no ignore mark,
558*088332b5SXin Li ** look for a function named "luaopen_modname".
559*088332b5SXin Li */
loadfunc(lua_State * L,const char * filename,const char * modname)560*088332b5SXin Li static int loadfunc (lua_State *L, const char *filename, const char *modname) {
561*088332b5SXin Li   const char *openfunc;
562*088332b5SXin Li   const char *mark;
563*088332b5SXin Li   modname = luaL_gsub(L, modname, ".", LUA_OFSEP);
564*088332b5SXin Li   mark = strchr(modname, *LUA_IGMARK);
565*088332b5SXin Li   if (mark) {
566*088332b5SXin Li     int stat;
567*088332b5SXin Li     openfunc = lua_pushlstring(L, modname, mark - modname);
568*088332b5SXin Li     openfunc = lua_pushfstring(L, LUA_POF"%s", openfunc);
569*088332b5SXin Li     stat = lookforfunc(L, filename, openfunc);
570*088332b5SXin Li     if (stat != ERRFUNC) return stat;
571*088332b5SXin Li     modname = mark + 1;  /* else go ahead and try old-style name */
572*088332b5SXin Li   }
573*088332b5SXin Li   openfunc = lua_pushfstring(L, LUA_POF"%s", modname);
574*088332b5SXin Li   return lookforfunc(L, filename, openfunc);
575*088332b5SXin Li }
576*088332b5SXin Li 
577*088332b5SXin Li 
searcher_C(lua_State * L)578*088332b5SXin Li static int searcher_C (lua_State *L) {
579*088332b5SXin Li   const char *name = luaL_checkstring(L, 1);
580*088332b5SXin Li   const char *filename = findfile(L, name, "cpath", LUA_CSUBSEP);
581*088332b5SXin Li   if (filename == NULL) return 1;  /* module not found in this path */
582*088332b5SXin Li   return checkload(L, (loadfunc(L, filename, name) == 0), filename);
583*088332b5SXin Li }
584*088332b5SXin Li 
585*088332b5SXin Li 
searcher_Croot(lua_State * L)586*088332b5SXin Li static int searcher_Croot (lua_State *L) {
587*088332b5SXin Li   const char *filename;
588*088332b5SXin Li   const char *name = luaL_checkstring(L, 1);
589*088332b5SXin Li   const char *p = strchr(name, '.');
590*088332b5SXin Li   int stat;
591*088332b5SXin Li   if (p == NULL) return 0;  /* is root */
592*088332b5SXin Li   lua_pushlstring(L, name, p - name);
593*088332b5SXin Li   filename = findfile(L, lua_tostring(L, -1), "cpath", LUA_CSUBSEP);
594*088332b5SXin Li   if (filename == NULL) return 1;  /* root not found */
595*088332b5SXin Li   if ((stat = loadfunc(L, filename, name)) != 0) {
596*088332b5SXin Li     if (stat != ERRFUNC)
597*088332b5SXin Li       return checkload(L, 0, filename);  /* real error */
598*088332b5SXin Li     else {  /* open function not found */
599*088332b5SXin Li       lua_pushfstring(L, "no module '%s' in file '%s'", name, filename);
600*088332b5SXin Li       return 1;
601*088332b5SXin Li     }
602*088332b5SXin Li   }
603*088332b5SXin Li   lua_pushstring(L, filename);  /* will be 2nd argument to module */
604*088332b5SXin Li   return 2;
605*088332b5SXin Li }
606*088332b5SXin Li 
607*088332b5SXin Li 
searcher_preload(lua_State * L)608*088332b5SXin Li static int searcher_preload (lua_State *L) {
609*088332b5SXin Li   const char *name = luaL_checkstring(L, 1);
610*088332b5SXin Li   lua_getfield(L, LUA_REGISTRYINDEX, LUA_PRELOAD_TABLE);
611*088332b5SXin Li   if (lua_getfield(L, -1, name) == LUA_TNIL) {  /* not found? */
612*088332b5SXin Li     lua_pushfstring(L, "no field package.preload['%s']", name);
613*088332b5SXin Li     return 1;
614*088332b5SXin Li   }
615*088332b5SXin Li   else {
616*088332b5SXin Li     lua_pushliteral(L, ":preload:");
617*088332b5SXin Li     return 2;
618*088332b5SXin Li   }
619*088332b5SXin Li }
620*088332b5SXin Li 
621*088332b5SXin Li 
findloader(lua_State * L,const char * name)622*088332b5SXin Li static void findloader (lua_State *L, const char *name) {
623*088332b5SXin Li   int i;
624*088332b5SXin Li   luaL_Buffer msg;  /* to build error message */
625*088332b5SXin Li   /* push 'package.searchers' to index 3 in the stack */
626*088332b5SXin Li   if (lua_getfield(L, lua_upvalueindex(1), "searchers") != LUA_TTABLE)
627*088332b5SXin Li     luaL_error(L, "'package.searchers' must be a table");
628*088332b5SXin Li   luaL_buffinit(L, &msg);
629*088332b5SXin Li   /*  iterate over available searchers to find a loader */
630*088332b5SXin Li   for (i = 1; ; i++) {
631*088332b5SXin Li     luaL_addstring(&msg, "\n\t");  /* error-message prefix */
632*088332b5SXin Li     if (lua_rawgeti(L, 3, i) == LUA_TNIL) {  /* no more searchers? */
633*088332b5SXin Li       lua_pop(L, 1);  /* remove nil */
634*088332b5SXin Li       luaL_buffsub(&msg, 2);  /* remove prefix */
635*088332b5SXin Li       luaL_pushresult(&msg);  /* create error message */
636*088332b5SXin Li       luaL_error(L, "module '%s' not found:%s", name, lua_tostring(L, -1));
637*088332b5SXin Li     }
638*088332b5SXin Li     lua_pushstring(L, name);
639*088332b5SXin Li     lua_call(L, 1, 2);  /* call it */
640*088332b5SXin Li     if (lua_isfunction(L, -2))  /* did it find a loader? */
641*088332b5SXin Li       return;  /* module loader found */
642*088332b5SXin Li     else if (lua_isstring(L, -2)) {  /* searcher returned error message? */
643*088332b5SXin Li       lua_pop(L, 1);  /* remove extra return */
644*088332b5SXin Li       luaL_addvalue(&msg);  /* concatenate error message */
645*088332b5SXin Li     }
646*088332b5SXin Li     else {  /* no error message */
647*088332b5SXin Li       lua_pop(L, 2);  /* remove both returns */
648*088332b5SXin Li       luaL_buffsub(&msg, 2);  /* remove prefix */
649*088332b5SXin Li     }
650*088332b5SXin Li   }
651*088332b5SXin Li }
652*088332b5SXin Li 
653*088332b5SXin Li 
ll_require(lua_State * L)654*088332b5SXin Li static int ll_require (lua_State *L) {
655*088332b5SXin Li   const char *name = luaL_checkstring(L, 1);
656*088332b5SXin Li   lua_settop(L, 1);  /* LOADED table will be at index 2 */
657*088332b5SXin Li   lua_getfield(L, LUA_REGISTRYINDEX, LUA_LOADED_TABLE);
658*088332b5SXin Li   lua_getfield(L, 2, name);  /* LOADED[name] */
659*088332b5SXin Li   if (lua_toboolean(L, -1))  /* is it there? */
660*088332b5SXin Li     return 1;  /* package is already loaded */
661*088332b5SXin Li   /* else must load package */
662*088332b5SXin Li   lua_pop(L, 1);  /* remove 'getfield' result */
663*088332b5SXin Li   findloader(L, name);
664*088332b5SXin Li   lua_rotate(L, -2, 1);  /* function <-> loader data */
665*088332b5SXin Li   lua_pushvalue(L, 1);  /* name is 1st argument to module loader */
666*088332b5SXin Li   lua_pushvalue(L, -3);  /* loader data is 2nd argument */
667*088332b5SXin Li   /* stack: ...; loader data; loader function; mod. name; loader data */
668*088332b5SXin Li   lua_call(L, 2, 1);  /* run loader to load module */
669*088332b5SXin Li   /* stack: ...; loader data; result from loader */
670*088332b5SXin Li   if (!lua_isnil(L, -1))  /* non-nil return? */
671*088332b5SXin Li     lua_setfield(L, 2, name);  /* LOADED[name] = returned value */
672*088332b5SXin Li   else
673*088332b5SXin Li     lua_pop(L, 1);  /* pop nil */
674*088332b5SXin Li   if (lua_getfield(L, 2, name) == LUA_TNIL) {   /* module set no value? */
675*088332b5SXin Li     lua_pushboolean(L, 1);  /* use true as result */
676*088332b5SXin Li     lua_copy(L, -1, -2);  /* replace loader result */
677*088332b5SXin Li     lua_setfield(L, 2, name);  /* LOADED[name] = true */
678*088332b5SXin Li   }
679*088332b5SXin Li   lua_rotate(L, -2, 1);  /* loader data <-> module result  */
680*088332b5SXin Li   return 2;  /* return module result and loader data */
681*088332b5SXin Li }
682*088332b5SXin Li 
683*088332b5SXin Li /* }====================================================== */
684*088332b5SXin Li 
685*088332b5SXin Li 
686*088332b5SXin Li 
687*088332b5SXin Li 
688*088332b5SXin Li static const luaL_Reg pk_funcs[] = {
689*088332b5SXin Li   {"loadlib", ll_loadlib},
690*088332b5SXin Li   {"searchpath", ll_searchpath},
691*088332b5SXin Li   /* placeholders */
692*088332b5SXin Li   {"preload", NULL},
693*088332b5SXin Li   {"cpath", NULL},
694*088332b5SXin Li   {"path", NULL},
695*088332b5SXin Li   {"searchers", NULL},
696*088332b5SXin Li   {"loaded", NULL},
697*088332b5SXin Li   {NULL, NULL}
698*088332b5SXin Li };
699*088332b5SXin Li 
700*088332b5SXin Li 
701*088332b5SXin Li static const luaL_Reg ll_funcs[] = {
702*088332b5SXin Li   {"require", ll_require},
703*088332b5SXin Li   {NULL, NULL}
704*088332b5SXin Li };
705*088332b5SXin Li 
706*088332b5SXin Li 
createsearcherstable(lua_State * L)707*088332b5SXin Li static void createsearcherstable (lua_State *L) {
708*088332b5SXin Li   static const lua_CFunction searchers[] =
709*088332b5SXin Li     {searcher_preload, searcher_Lua, searcher_C, searcher_Croot, NULL};
710*088332b5SXin Li   int i;
711*088332b5SXin Li   /* create 'searchers' table */
712*088332b5SXin Li   lua_createtable(L, sizeof(searchers)/sizeof(searchers[0]) - 1, 0);
713*088332b5SXin Li   /* fill it with predefined searchers */
714*088332b5SXin Li   for (i=0; searchers[i] != NULL; i++) {
715*088332b5SXin Li     lua_pushvalue(L, -2);  /* set 'package' as upvalue for all searchers */
716*088332b5SXin Li     lua_pushcclosure(L, searchers[i], 1);
717*088332b5SXin Li     lua_rawseti(L, -2, i+1);
718*088332b5SXin Li   }
719*088332b5SXin Li   lua_setfield(L, -2, "searchers");  /* put it in field 'searchers' */
720*088332b5SXin Li }
721*088332b5SXin Li 
722*088332b5SXin Li 
723*088332b5SXin Li /*
724*088332b5SXin Li ** create table CLIBS to keep track of loaded C libraries,
725*088332b5SXin Li ** setting a finalizer to close all libraries when closing state.
726*088332b5SXin Li */
createclibstable(lua_State * L)727*088332b5SXin Li static void createclibstable (lua_State *L) {
728*088332b5SXin Li   luaL_getsubtable(L, LUA_REGISTRYINDEX, CLIBS);  /* create CLIBS table */
729*088332b5SXin Li   lua_createtable(L, 0, 1);  /* create metatable for CLIBS */
730*088332b5SXin Li   lua_pushcfunction(L, gctm);
731*088332b5SXin Li   lua_setfield(L, -2, "__gc");  /* set finalizer for CLIBS table */
732*088332b5SXin Li   lua_setmetatable(L, -2);
733*088332b5SXin Li }
734*088332b5SXin Li 
735*088332b5SXin Li 
luaopen_package(lua_State * L)736*088332b5SXin Li LUAMOD_API int luaopen_package (lua_State *L) {
737*088332b5SXin Li   createclibstable(L);
738*088332b5SXin Li   luaL_newlib(L, pk_funcs);  /* create 'package' table */
739*088332b5SXin Li   createsearcherstable(L);
740*088332b5SXin Li   /* set paths */
741*088332b5SXin Li   setpath(L, "path", LUA_PATH_VAR, LUA_PATH_DEFAULT);
742*088332b5SXin Li   setpath(L, "cpath", LUA_CPATH_VAR, LUA_CPATH_DEFAULT);
743*088332b5SXin Li   /* store config information */
744*088332b5SXin Li   lua_pushliteral(L, LUA_DIRSEP "\n" LUA_PATH_SEP "\n" LUA_PATH_MARK "\n"
745*088332b5SXin Li                      LUA_EXEC_DIR "\n" LUA_IGMARK "\n");
746*088332b5SXin Li   lua_setfield(L, -2, "config");
747*088332b5SXin Li   /* set field 'loaded' */
748*088332b5SXin Li   luaL_getsubtable(L, LUA_REGISTRYINDEX, LUA_LOADED_TABLE);
749*088332b5SXin Li   lua_setfield(L, -2, "loaded");
750*088332b5SXin Li   /* set field 'preload' */
751*088332b5SXin Li   luaL_getsubtable(L, LUA_REGISTRYINDEX, LUA_PRELOAD_TABLE);
752*088332b5SXin Li   lua_setfield(L, -2, "preload");
753*088332b5SXin Li   lua_pushglobaltable(L);
754*088332b5SXin Li   lua_pushvalue(L, -2);  /* set 'package' as upvalue for next lib */
755*088332b5SXin Li   luaL_setfuncs(L, ll_funcs, 1);  /* open lib into global table */
756*088332b5SXin Li   lua_pop(L, 1);  /* pop global table */
757*088332b5SXin Li   return 1;  /* return 'package' table */
758*088332b5SXin Li }
759*088332b5SXin Li 
760