xref: /aosp_15_r20/external/lua/src/lundump.c (revision 088332b5b69e7ab13924864b272aabfc2509d2d5)
1*088332b5SXin Li /*
2*088332b5SXin Li ** $Id: lundump.c $
3*088332b5SXin Li ** load precompiled Lua chunks
4*088332b5SXin Li ** See Copyright Notice in lua.h
5*088332b5SXin Li */
6*088332b5SXin Li 
7*088332b5SXin Li #define lundump_c
8*088332b5SXin Li #define LUA_CORE
9*088332b5SXin Li 
10*088332b5SXin Li #include "lprefix.h"
11*088332b5SXin Li 
12*088332b5SXin Li 
13*088332b5SXin Li #include <limits.h>
14*088332b5SXin Li #include <string.h>
15*088332b5SXin Li 
16*088332b5SXin Li #include "lua.h"
17*088332b5SXin Li 
18*088332b5SXin Li #include "ldebug.h"
19*088332b5SXin Li #include "ldo.h"
20*088332b5SXin Li #include "lfunc.h"
21*088332b5SXin Li #include "lmem.h"
22*088332b5SXin Li #include "lobject.h"
23*088332b5SXin Li #include "lstring.h"
24*088332b5SXin Li #include "lundump.h"
25*088332b5SXin Li #include "lzio.h"
26*088332b5SXin Li 
27*088332b5SXin Li 
28*088332b5SXin Li #if !defined(luai_verifycode)
29*088332b5SXin Li #define luai_verifycode(L,f)  /* empty */
30*088332b5SXin Li #endif
31*088332b5SXin Li 
32*088332b5SXin Li 
33*088332b5SXin Li typedef struct {
34*088332b5SXin Li   lua_State *L;
35*088332b5SXin Li   ZIO *Z;
36*088332b5SXin Li   const char *name;
37*088332b5SXin Li } LoadState;
38*088332b5SXin Li 
39*088332b5SXin Li 
error(LoadState * S,const char * why)40*088332b5SXin Li static l_noret error (LoadState *S, const char *why) {
41*088332b5SXin Li   luaO_pushfstring(S->L, "%s: bad binary format (%s)", S->name, why);
42*088332b5SXin Li   luaD_throw(S->L, LUA_ERRSYNTAX);
43*088332b5SXin Li }
44*088332b5SXin Li 
45*088332b5SXin Li 
46*088332b5SXin Li /*
47*088332b5SXin Li ** All high-level loads go through loadVector; you can change it to
48*088332b5SXin Li ** adapt to the endianness of the input
49*088332b5SXin Li */
50*088332b5SXin Li #define loadVector(S,b,n)	loadBlock(S,b,(n)*sizeof((b)[0]))
51*088332b5SXin Li 
loadBlock(LoadState * S,void * b,size_t size)52*088332b5SXin Li static void loadBlock (LoadState *S, void *b, size_t size) {
53*088332b5SXin Li   if (luaZ_read(S->Z, b, size) != 0)
54*088332b5SXin Li     error(S, "truncated chunk");
55*088332b5SXin Li }
56*088332b5SXin Li 
57*088332b5SXin Li 
58*088332b5SXin Li #define loadVar(S,x)		loadVector(S,&x,1)
59*088332b5SXin Li 
60*088332b5SXin Li 
loadByte(LoadState * S)61*088332b5SXin Li static lu_byte loadByte (LoadState *S) {
62*088332b5SXin Li   int b = zgetc(S->Z);
63*088332b5SXin Li   if (b == EOZ)
64*088332b5SXin Li     error(S, "truncated chunk");
65*088332b5SXin Li   return cast_byte(b);
66*088332b5SXin Li }
67*088332b5SXin Li 
68*088332b5SXin Li 
loadUnsigned(LoadState * S,size_t limit)69*088332b5SXin Li static size_t loadUnsigned (LoadState *S, size_t limit) {
70*088332b5SXin Li   size_t x = 0;
71*088332b5SXin Li   int b;
72*088332b5SXin Li   limit >>= 7;
73*088332b5SXin Li   do {
74*088332b5SXin Li     b = loadByte(S);
75*088332b5SXin Li     if (x >= limit)
76*088332b5SXin Li       error(S, "integer overflow");
77*088332b5SXin Li     x = (x << 7) | (b & 0x7f);
78*088332b5SXin Li   } while ((b & 0x80) == 0);
79*088332b5SXin Li   return x;
80*088332b5SXin Li }
81*088332b5SXin Li 
82*088332b5SXin Li 
loadSize(LoadState * S)83*088332b5SXin Li static size_t loadSize (LoadState *S) {
84*088332b5SXin Li   return loadUnsigned(S, ~(size_t)0);
85*088332b5SXin Li }
86*088332b5SXin Li 
87*088332b5SXin Li 
loadInt(LoadState * S)88*088332b5SXin Li static int loadInt (LoadState *S) {
89*088332b5SXin Li   return cast_int(loadUnsigned(S, INT_MAX));
90*088332b5SXin Li }
91*088332b5SXin Li 
92*088332b5SXin Li 
loadNumber(LoadState * S)93*088332b5SXin Li static lua_Number loadNumber (LoadState *S) {
94*088332b5SXin Li   lua_Number x;
95*088332b5SXin Li   loadVar(S, x);
96*088332b5SXin Li   return x;
97*088332b5SXin Li }
98*088332b5SXin Li 
99*088332b5SXin Li 
loadInteger(LoadState * S)100*088332b5SXin Li static lua_Integer loadInteger (LoadState *S) {
101*088332b5SXin Li   lua_Integer x;
102*088332b5SXin Li   loadVar(S, x);
103*088332b5SXin Li   return x;
104*088332b5SXin Li }
105*088332b5SXin Li 
106*088332b5SXin Li 
107*088332b5SXin Li /*
108*088332b5SXin Li ** Load a nullable string into prototype 'p'.
109*088332b5SXin Li */
loadStringN(LoadState * S,Proto * p)110*088332b5SXin Li static TString *loadStringN (LoadState *S, Proto *p) {
111*088332b5SXin Li   lua_State *L = S->L;
112*088332b5SXin Li   TString *ts;
113*088332b5SXin Li   size_t size = loadSize(S);
114*088332b5SXin Li   if (size == 0)  /* no string? */
115*088332b5SXin Li     return NULL;
116*088332b5SXin Li   else if (--size <= LUAI_MAXSHORTLEN) {  /* short string? */
117*088332b5SXin Li     char buff[LUAI_MAXSHORTLEN];
118*088332b5SXin Li     loadVector(S, buff, size);  /* load string into buffer */
119*088332b5SXin Li     ts = luaS_newlstr(L, buff, size);  /* create string */
120*088332b5SXin Li   }
121*088332b5SXin Li   else {  /* long string */
122*088332b5SXin Li     ts = luaS_createlngstrobj(L, size);  /* create string */
123*088332b5SXin Li     setsvalue2s(L, L->top, ts);  /* anchor it ('loadVector' can GC) */
124*088332b5SXin Li     luaD_inctop(L);
125*088332b5SXin Li     loadVector(S, getstr(ts), size);  /* load directly in final place */
126*088332b5SXin Li     L->top--;  /* pop string */
127*088332b5SXin Li   }
128*088332b5SXin Li   luaC_objbarrier(L, p, ts);
129*088332b5SXin Li   return ts;
130*088332b5SXin Li }
131*088332b5SXin Li 
132*088332b5SXin Li 
133*088332b5SXin Li /*
134*088332b5SXin Li ** Load a non-nullable string into prototype 'p'.
135*088332b5SXin Li */
loadString(LoadState * S,Proto * p)136*088332b5SXin Li static TString *loadString (LoadState *S, Proto *p) {
137*088332b5SXin Li   TString *st = loadStringN(S, p);
138*088332b5SXin Li   if (st == NULL)
139*088332b5SXin Li     error(S, "bad format for constant string");
140*088332b5SXin Li   return st;
141*088332b5SXin Li }
142*088332b5SXin Li 
143*088332b5SXin Li 
loadCode(LoadState * S,Proto * f)144*088332b5SXin Li static void loadCode (LoadState *S, Proto *f) {
145*088332b5SXin Li   int n = loadInt(S);
146*088332b5SXin Li   f->code = luaM_newvectorchecked(S->L, n, Instruction);
147*088332b5SXin Li   f->sizecode = n;
148*088332b5SXin Li   loadVector(S, f->code, n);
149*088332b5SXin Li }
150*088332b5SXin Li 
151*088332b5SXin Li 
152*088332b5SXin Li static void loadFunction(LoadState *S, Proto *f, TString *psource);
153*088332b5SXin Li 
154*088332b5SXin Li 
loadConstants(LoadState * S,Proto * f)155*088332b5SXin Li static void loadConstants (LoadState *S, Proto *f) {
156*088332b5SXin Li   int i;
157*088332b5SXin Li   int n = loadInt(S);
158*088332b5SXin Li   f->k = luaM_newvectorchecked(S->L, n, TValue);
159*088332b5SXin Li   f->sizek = n;
160*088332b5SXin Li   for (i = 0; i < n; i++)
161*088332b5SXin Li     setnilvalue(&f->k[i]);
162*088332b5SXin Li   for (i = 0; i < n; i++) {
163*088332b5SXin Li     TValue *o = &f->k[i];
164*088332b5SXin Li     int t = loadByte(S);
165*088332b5SXin Li     switch (t) {
166*088332b5SXin Li       case LUA_VNIL:
167*088332b5SXin Li         setnilvalue(o);
168*088332b5SXin Li         break;
169*088332b5SXin Li       case LUA_VFALSE:
170*088332b5SXin Li         setbfvalue(o);
171*088332b5SXin Li         break;
172*088332b5SXin Li       case LUA_VTRUE:
173*088332b5SXin Li         setbtvalue(o);
174*088332b5SXin Li         break;
175*088332b5SXin Li       case LUA_VNUMFLT:
176*088332b5SXin Li         setfltvalue(o, loadNumber(S));
177*088332b5SXin Li         break;
178*088332b5SXin Li       case LUA_VNUMINT:
179*088332b5SXin Li         setivalue(o, loadInteger(S));
180*088332b5SXin Li         break;
181*088332b5SXin Li       case LUA_VSHRSTR:
182*088332b5SXin Li       case LUA_VLNGSTR:
183*088332b5SXin Li         setsvalue2n(S->L, o, loadString(S, f));
184*088332b5SXin Li         break;
185*088332b5SXin Li       default: lua_assert(0);
186*088332b5SXin Li     }
187*088332b5SXin Li   }
188*088332b5SXin Li }
189*088332b5SXin Li 
190*088332b5SXin Li 
loadProtos(LoadState * S,Proto * f)191*088332b5SXin Li static void loadProtos (LoadState *S, Proto *f) {
192*088332b5SXin Li   int i;
193*088332b5SXin Li   int n = loadInt(S);
194*088332b5SXin Li   f->p = luaM_newvectorchecked(S->L, n, Proto *);
195*088332b5SXin Li   f->sizep = n;
196*088332b5SXin Li   for (i = 0; i < n; i++)
197*088332b5SXin Li     f->p[i] = NULL;
198*088332b5SXin Li   for (i = 0; i < n; i++) {
199*088332b5SXin Li     f->p[i] = luaF_newproto(S->L);
200*088332b5SXin Li     luaC_objbarrier(S->L, f, f->p[i]);
201*088332b5SXin Li     loadFunction(S, f->p[i], f->source);
202*088332b5SXin Li   }
203*088332b5SXin Li }
204*088332b5SXin Li 
205*088332b5SXin Li 
206*088332b5SXin Li /*
207*088332b5SXin Li ** Load the upvalues for a function. The names must be filled first,
208*088332b5SXin Li ** because the filling of the other fields can raise read errors and
209*088332b5SXin Li ** the creation of the error message can call an emergency collection;
210*088332b5SXin Li ** in that case all prototypes must be consistent for the GC.
211*088332b5SXin Li */
loadUpvalues(LoadState * S,Proto * f)212*088332b5SXin Li static void loadUpvalues (LoadState *S, Proto *f) {
213*088332b5SXin Li   int i, n;
214*088332b5SXin Li   n = loadInt(S);
215*088332b5SXin Li   f->upvalues = luaM_newvectorchecked(S->L, n, Upvaldesc);
216*088332b5SXin Li   f->sizeupvalues = n;
217*088332b5SXin Li   for (i = 0; i < n; i++)  /* make array valid for GC */
218*088332b5SXin Li     f->upvalues[i].name = NULL;
219*088332b5SXin Li   for (i = 0; i < n; i++) {  /* following calls can raise errors */
220*088332b5SXin Li     f->upvalues[i].instack = loadByte(S);
221*088332b5SXin Li     f->upvalues[i].idx = loadByte(S);
222*088332b5SXin Li     f->upvalues[i].kind = loadByte(S);
223*088332b5SXin Li   }
224*088332b5SXin Li }
225*088332b5SXin Li 
226*088332b5SXin Li 
loadDebug(LoadState * S,Proto * f)227*088332b5SXin Li static void loadDebug (LoadState *S, Proto *f) {
228*088332b5SXin Li   int i, n;
229*088332b5SXin Li   n = loadInt(S);
230*088332b5SXin Li   f->lineinfo = luaM_newvectorchecked(S->L, n, ls_byte);
231*088332b5SXin Li   f->sizelineinfo = n;
232*088332b5SXin Li   loadVector(S, f->lineinfo, n);
233*088332b5SXin Li   n = loadInt(S);
234*088332b5SXin Li   f->abslineinfo = luaM_newvectorchecked(S->L, n, AbsLineInfo);
235*088332b5SXin Li   f->sizeabslineinfo = n;
236*088332b5SXin Li   for (i = 0; i < n; i++) {
237*088332b5SXin Li     f->abslineinfo[i].pc = loadInt(S);
238*088332b5SXin Li     f->abslineinfo[i].line = loadInt(S);
239*088332b5SXin Li   }
240*088332b5SXin Li   n = loadInt(S);
241*088332b5SXin Li   f->locvars = luaM_newvectorchecked(S->L, n, LocVar);
242*088332b5SXin Li   f->sizelocvars = n;
243*088332b5SXin Li   for (i = 0; i < n; i++)
244*088332b5SXin Li     f->locvars[i].varname = NULL;
245*088332b5SXin Li   for (i = 0; i < n; i++) {
246*088332b5SXin Li     f->locvars[i].varname = loadStringN(S, f);
247*088332b5SXin Li     f->locvars[i].startpc = loadInt(S);
248*088332b5SXin Li     f->locvars[i].endpc = loadInt(S);
249*088332b5SXin Li   }
250*088332b5SXin Li   n = loadInt(S);
251*088332b5SXin Li   for (i = 0; i < n; i++)
252*088332b5SXin Li     f->upvalues[i].name = loadStringN(S, f);
253*088332b5SXin Li }
254*088332b5SXin Li 
255*088332b5SXin Li 
loadFunction(LoadState * S,Proto * f,TString * psource)256*088332b5SXin Li static void loadFunction (LoadState *S, Proto *f, TString *psource) {
257*088332b5SXin Li   f->source = loadStringN(S, f);
258*088332b5SXin Li   if (f->source == NULL)  /* no source in dump? */
259*088332b5SXin Li     f->source = psource;  /* reuse parent's source */
260*088332b5SXin Li   f->linedefined = loadInt(S);
261*088332b5SXin Li   f->lastlinedefined = loadInt(S);
262*088332b5SXin Li   f->numparams = loadByte(S);
263*088332b5SXin Li   f->is_vararg = loadByte(S);
264*088332b5SXin Li   f->maxstacksize = loadByte(S);
265*088332b5SXin Li   loadCode(S, f);
266*088332b5SXin Li   loadConstants(S, f);
267*088332b5SXin Li   loadUpvalues(S, f);
268*088332b5SXin Li   loadProtos(S, f);
269*088332b5SXin Li   loadDebug(S, f);
270*088332b5SXin Li }
271*088332b5SXin Li 
272*088332b5SXin Li 
checkliteral(LoadState * S,const char * s,const char * msg)273*088332b5SXin Li static void checkliteral (LoadState *S, const char *s, const char *msg) {
274*088332b5SXin Li   char buff[sizeof(LUA_SIGNATURE) + sizeof(LUAC_DATA)]; /* larger than both */
275*088332b5SXin Li   size_t len = strlen(s);
276*088332b5SXin Li   loadVector(S, buff, len);
277*088332b5SXin Li   if (memcmp(s, buff, len) != 0)
278*088332b5SXin Li     error(S, msg);
279*088332b5SXin Li }
280*088332b5SXin Li 
281*088332b5SXin Li 
fchecksize(LoadState * S,size_t size,const char * tname)282*088332b5SXin Li static void fchecksize (LoadState *S, size_t size, const char *tname) {
283*088332b5SXin Li   if (loadByte(S) != size)
284*088332b5SXin Li     error(S, luaO_pushfstring(S->L, "%s size mismatch", tname));
285*088332b5SXin Li }
286*088332b5SXin Li 
287*088332b5SXin Li 
288*088332b5SXin Li #define checksize(S,t)	fchecksize(S,sizeof(t),#t)
289*088332b5SXin Li 
checkHeader(LoadState * S)290*088332b5SXin Li static void checkHeader (LoadState *S) {
291*088332b5SXin Li   /* skip 1st char (already read and checked) */
292*088332b5SXin Li   checkliteral(S, &LUA_SIGNATURE[1], "not a binary chunk");
293*088332b5SXin Li   if (loadByte(S) != LUAC_VERSION)
294*088332b5SXin Li     error(S, "version mismatch");
295*088332b5SXin Li   if (loadByte(S) != LUAC_FORMAT)
296*088332b5SXin Li     error(S, "format mismatch");
297*088332b5SXin Li   checkliteral(S, LUAC_DATA, "corrupted chunk");
298*088332b5SXin Li   checksize(S, Instruction);
299*088332b5SXin Li   checksize(S, lua_Integer);
300*088332b5SXin Li   checksize(S, lua_Number);
301*088332b5SXin Li   if (loadInteger(S) != LUAC_INT)
302*088332b5SXin Li     error(S, "integer format mismatch");
303*088332b5SXin Li   if (loadNumber(S) != LUAC_NUM)
304*088332b5SXin Li     error(S, "float format mismatch");
305*088332b5SXin Li }
306*088332b5SXin Li 
307*088332b5SXin Li 
308*088332b5SXin Li /*
309*088332b5SXin Li ** Load precompiled chunk.
310*088332b5SXin Li */
luaU_undump(lua_State * L,ZIO * Z,const char * name)311*088332b5SXin Li LClosure *luaU_undump(lua_State *L, ZIO *Z, const char *name) {
312*088332b5SXin Li   LoadState S;
313*088332b5SXin Li   LClosure *cl;
314*088332b5SXin Li   if (*name == '@' || *name == '=')
315*088332b5SXin Li     S.name = name + 1;
316*088332b5SXin Li   else if (*name == LUA_SIGNATURE[0])
317*088332b5SXin Li     S.name = "binary string";
318*088332b5SXin Li   else
319*088332b5SXin Li     S.name = name;
320*088332b5SXin Li   S.L = L;
321*088332b5SXin Li   S.Z = Z;
322*088332b5SXin Li   checkHeader(&S);
323*088332b5SXin Li   cl = luaF_newLclosure(L, loadByte(&S));
324*088332b5SXin Li   setclLvalue2s(L, L->top, cl);
325*088332b5SXin Li   luaD_inctop(L);
326*088332b5SXin Li   cl->p = luaF_newproto(L);
327*088332b5SXin Li   luaC_objbarrier(L, cl, cl->p);
328*088332b5SXin Li   loadFunction(&S, cl->p, NULL);
329*088332b5SXin Li   lua_assert(cl->nupvalues == cl->p->sizeupvalues);
330*088332b5SXin Li   luai_verifycode(L, cl->p);
331*088332b5SXin Li   return cl;
332*088332b5SXin Li }
333*088332b5SXin Li 
334