ldebug.c 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961
  1. /*
  2. ** $Id: ldebug.c $
  3. ** Debug Interface
  4. ** See Copyright Notice in lua.h
  5. */
  6. #define ldebug_c
  7. #define LUA_CORE
  8. #include "lprefix.h"
  9. #include <stdarg.h>
  10. #include <stddef.h>
  11. #include <string.h>
  12. #include "lua.h"
  13. #include "lapi.h"
  14. #include "lcode.h"
  15. #include "ldebug.h"
  16. #include "ldo.h"
  17. #include "lfunc.h"
  18. #include "lobject.h"
  19. #include "lopcodes.h"
  20. #include "lstate.h"
  21. #include "lstring.h"
  22. #include "ltable.h"
  23. #include "ltm.h"
  24. #include "lvm.h"
  25. #define noLuaClosure(f) ((f) == NULL || (f)->c.tt == LUA_VCCL)
  26. static const char *funcnamefromcall (lua_State *L, CallInfo *ci,
  27. const char **name);
  28. static int currentpc (CallInfo *ci) {
  29. lua_assert(isLua(ci));
  30. return pcRel(ci->u.l.savedpc, ci_func(ci)->p);
  31. }
  32. /*
  33. ** Get a "base line" to find the line corresponding to an instruction.
  34. ** Base lines are regularly placed at MAXIWTHABS intervals, so usually
  35. ** an integer division gets the right place. When the source file has
  36. ** large sequences of empty/comment lines, it may need extra entries,
  37. ** so the original estimate needs a correction.
  38. ** If the original estimate is -1, the initial 'if' ensures that the
  39. ** 'while' will run at least once.
  40. ** The assertion that the estimate is a lower bound for the correct base
  41. ** is valid as long as the debug info has been generated with the same
  42. ** value for MAXIWTHABS or smaller. (Previous releases use a little
  43. ** smaller value.)
  44. */
  45. static int getbaseline (const Proto *f, int pc, int *basepc) {
  46. if (f->sizeabslineinfo == 0 || pc < f->abslineinfo[0].pc) {
  47. *basepc = -1; /* start from the beginning */
  48. return f->linedefined;
  49. }
  50. else {
  51. int i = cast_uint(pc) / MAXIWTHABS - 1; /* get an estimate */
  52. /* estimate must be a lower bound of the correct base */
  53. lua_assert(i < 0 ||
  54. (i < f->sizeabslineinfo && f->abslineinfo[i].pc <= pc));
  55. while (i + 1 < f->sizeabslineinfo && pc >= f->abslineinfo[i + 1].pc)
  56. i++; /* low estimate; adjust it */
  57. *basepc = f->abslineinfo[i].pc;
  58. return f->abslineinfo[i].line;
  59. }
  60. }
  61. /*
  62. ** Get the line corresponding to instruction 'pc' in function 'f';
  63. ** first gets a base line and from there does the increments until
  64. ** the desired instruction.
  65. */
  66. int luaG_getfuncline (const Proto *f, int pc) {
  67. if (f->lineinfo == NULL) /* no debug information? */
  68. return -1;
  69. else {
  70. int basepc;
  71. int baseline = getbaseline(f, pc, &basepc);
  72. while (basepc++ < pc) { /* walk until given instruction */
  73. lua_assert(f->lineinfo[basepc] != ABSLINEINFO);
  74. baseline += f->lineinfo[basepc]; /* correct line */
  75. }
  76. return baseline;
  77. }
  78. }
  79. static int getcurrentline (CallInfo *ci) {
  80. return luaG_getfuncline(ci_func(ci)->p, currentpc(ci));
  81. }
  82. /*
  83. ** Set 'trap' for all active Lua frames.
  84. ** This function can be called during a signal, under "reasonable"
  85. ** assumptions. A new 'ci' is completely linked in the list before it
  86. ** becomes part of the "active" list, and we assume that pointers are
  87. ** atomic; see comment in next function.
  88. ** (A compiler doing interprocedural optimizations could, theoretically,
  89. ** reorder memory writes in such a way that the list could be
  90. ** temporarily broken while inserting a new element. We simply assume it
  91. ** has no good reasons to do that.)
  92. */
  93. static void settraps (CallInfo *ci) {
  94. for (; ci != NULL; ci = ci->previous)
  95. if (isLua(ci))
  96. ci->u.l.trap = 1;
  97. }
  98. /*
  99. ** This function can be called during a signal, under "reasonable"
  100. ** assumptions.
  101. ** Fields 'basehookcount' and 'hookcount' (set by 'resethookcount')
  102. ** are for debug only, and it is no problem if they get arbitrary
  103. ** values (causes at most one wrong hook call). 'hookmask' is an atomic
  104. ** value. We assume that pointers are atomic too (e.g., gcc ensures that
  105. ** for all platforms where it runs). Moreover, 'hook' is always checked
  106. ** before being called (see 'luaD_hook').
  107. */
  108. LUA_API void lua_sethook (lua_State *L, lua_Hook func, int mask, int count) {
  109. if (func == NULL || mask == 0) { /* turn off hooks? */
  110. mask = 0;
  111. func = NULL;
  112. }
  113. L->hook = func;
  114. L->basehookcount = count;
  115. resethookcount(L);
  116. L->hookmask = cast_byte(mask);
  117. if (mask)
  118. settraps(L->ci); /* to trace inside 'luaV_execute' */
  119. }
  120. LUA_API lua_Hook lua_gethook (lua_State *L) {
  121. return L->hook;
  122. }
  123. LUA_API int lua_gethookmask (lua_State *L) {
  124. return L->hookmask;
  125. }
  126. LUA_API int lua_gethookcount (lua_State *L) {
  127. return L->basehookcount;
  128. }
  129. LUA_API int lua_getstack (lua_State *L, int level, lua_Debug *ar) {
  130. int status;
  131. CallInfo *ci;
  132. if (level < 0) return 0; /* invalid (negative) level */
  133. lua_lock(L);
  134. for (ci = L->ci; level > 0 && ci != &L->base_ci; ci = ci->previous)
  135. level--;
  136. if (level == 0 && ci != &L->base_ci) { /* level found? */
  137. status = 1;
  138. ar->i_ci = ci;
  139. }
  140. else status = 0; /* no such level */
  141. lua_unlock(L);
  142. return status;
  143. }
  144. static const char *upvalname (const Proto *p, int uv) {
  145. TString *s = check_exp(uv < p->sizeupvalues, p->upvalues[uv].name);
  146. if (s == NULL) return "?";
  147. else return getstr(s);
  148. }
  149. static const char *findvararg (CallInfo *ci, int n, StkId *pos) {
  150. if (clLvalue(s2v(ci->func.p))->p->is_vararg) {
  151. int nextra = ci->u.l.nextraargs;
  152. if (n >= -nextra) { /* 'n' is negative */
  153. *pos = ci->func.p - nextra - (n + 1);
  154. return "(vararg)"; /* generic name for any vararg */
  155. }
  156. }
  157. return NULL; /* no such vararg */
  158. }
  159. const char *luaG_findlocal (lua_State *L, CallInfo *ci, int n, StkId *pos) {
  160. StkId base = ci->func.p + 1;
  161. const char *name = NULL;
  162. if (isLua(ci)) {
  163. if (n < 0) /* access to vararg values? */
  164. return findvararg(ci, n, pos);
  165. else
  166. name = luaF_getlocalname(ci_func(ci)->p, n, currentpc(ci));
  167. }
  168. if (name == NULL) { /* no 'standard' name? */
  169. StkId limit = (ci == L->ci) ? L->top.p : ci->next->func.p;
  170. if (limit - base >= n && n > 0) { /* is 'n' inside 'ci' stack? */
  171. /* generic name for any valid slot */
  172. name = isLua(ci) ? "(temporary)" : "(C temporary)";
  173. }
  174. else
  175. return NULL; /* no name */
  176. }
  177. if (pos)
  178. *pos = base + (n - 1);
  179. return name;
  180. }
  181. LUA_API const char *lua_getlocal (lua_State *L, const lua_Debug *ar, int n) {
  182. const char *name;
  183. lua_lock(L);
  184. if (ar == NULL) { /* information about non-active function? */
  185. if (!isLfunction(s2v(L->top.p - 1))) /* not a Lua function? */
  186. name = NULL;
  187. else /* consider live variables at function start (parameters) */
  188. name = luaF_getlocalname(clLvalue(s2v(L->top.p - 1))->p, n, 0);
  189. }
  190. else { /* active function; get information through 'ar' */
  191. StkId pos = NULL; /* to avoid warnings */
  192. name = luaG_findlocal(L, ar->i_ci, n, &pos);
  193. if (name) {
  194. setobjs2s(L, L->top.p, pos);
  195. api_incr_top(L);
  196. }
  197. }
  198. lua_unlock(L);
  199. return name;
  200. }
  201. LUA_API const char *lua_setlocal (lua_State *L, const lua_Debug *ar, int n) {
  202. StkId pos = NULL; /* to avoid warnings */
  203. const char *name;
  204. lua_lock(L);
  205. name = luaG_findlocal(L, ar->i_ci, n, &pos);
  206. if (name) {
  207. setobjs2s(L, pos, L->top.p - 1);
  208. L->top.p--; /* pop value */
  209. }
  210. lua_unlock(L);
  211. return name;
  212. }
  213. static void funcinfo (lua_Debug *ar, Closure *cl) {
  214. if (noLuaClosure(cl)) {
  215. ar->source = "=[C]";
  216. ar->srclen = LL("=[C]");
  217. ar->linedefined = -1;
  218. ar->lastlinedefined = -1;
  219. ar->what = "C";
  220. }
  221. else {
  222. const Proto *p = cl->l.p;
  223. if (p->source) {
  224. ar->source = getstr(p->source);
  225. ar->srclen = tsslen(p->source);
  226. }
  227. else {
  228. ar->source = "=?";
  229. ar->srclen = LL("=?");
  230. }
  231. ar->linedefined = p->linedefined;
  232. ar->lastlinedefined = p->lastlinedefined;
  233. ar->what = (ar->linedefined == 0) ? "main" : "Lua";
  234. }
  235. luaO_chunkid(ar->short_src, ar->source, ar->srclen);
  236. }
  237. static int nextline (const Proto *p, int currentline, int pc) {
  238. if (p->lineinfo[pc] != ABSLINEINFO)
  239. return currentline + p->lineinfo[pc];
  240. else
  241. return luaG_getfuncline(p, pc);
  242. }
  243. static void collectvalidlines (lua_State *L, Closure *f) {
  244. if (noLuaClosure(f)) {
  245. setnilvalue(s2v(L->top.p));
  246. api_incr_top(L);
  247. }
  248. else {
  249. int i;
  250. TValue v;
  251. const Proto *p = f->l.p;
  252. int currentline = p->linedefined;
  253. Table *t = luaH_new(L); /* new table to store active lines */
  254. sethvalue2s(L, L->top.p, t); /* push it on stack */
  255. api_incr_top(L);
  256. setbtvalue(&v); /* boolean 'true' to be the value of all indices */
  257. if (!p->is_vararg) /* regular function? */
  258. i = 0; /* consider all instructions */
  259. else { /* vararg function */
  260. lua_assert(GET_OPCODE(p->code[0]) == OP_VARARGPREP);
  261. currentline = nextline(p, currentline, 0);
  262. i = 1; /* skip first instruction (OP_VARARGPREP) */
  263. }
  264. for (; i < p->sizelineinfo; i++) { /* for each instruction */
  265. currentline = nextline(p, currentline, i); /* get its line */
  266. luaH_setint(L, t, currentline, &v); /* table[line] = true */
  267. }
  268. }
  269. }
  270. static const char *getfuncname (lua_State *L, CallInfo *ci, const char **name) {
  271. /* calling function is a known function? */
  272. if (ci != NULL && !(ci->callstatus & CIST_TAIL))
  273. return funcnamefromcall(L, ci->previous, name);
  274. else return NULL; /* no way to find a name */
  275. }
  276. static int auxgetinfo (lua_State *L, const char *what, lua_Debug *ar,
  277. Closure *f, CallInfo *ci) {
  278. int status = 1;
  279. for (; *what; what++) {
  280. switch (*what) {
  281. case 'S': {
  282. funcinfo(ar, f);
  283. break;
  284. }
  285. case 'l': {
  286. ar->currentline = (ci && isLua(ci)) ? getcurrentline(ci) : -1;
  287. break;
  288. }
  289. case 'u': {
  290. ar->nups = (f == NULL) ? 0 : f->c.nupvalues;
  291. if (noLuaClosure(f)) {
  292. ar->isvararg = 1;
  293. ar->nparams = 0;
  294. }
  295. else {
  296. ar->isvararg = f->l.p->is_vararg;
  297. ar->nparams = f->l.p->numparams;
  298. }
  299. break;
  300. }
  301. case 't': {
  302. ar->istailcall = (ci) ? ci->callstatus & CIST_TAIL : 0;
  303. break;
  304. }
  305. case 'n': {
  306. ar->namewhat = getfuncname(L, ci, &ar->name);
  307. if (ar->namewhat == NULL) {
  308. ar->namewhat = ""; /* not found */
  309. ar->name = NULL;
  310. }
  311. break;
  312. }
  313. case 'r': {
  314. if (ci == NULL || !(ci->callstatus & CIST_TRAN))
  315. ar->ftransfer = ar->ntransfer = 0;
  316. else {
  317. ar->ftransfer = ci->u2.transferinfo.ftransfer;
  318. ar->ntransfer = ci->u2.transferinfo.ntransfer;
  319. }
  320. break;
  321. }
  322. case 'L':
  323. case 'f': /* handled by lua_getinfo */
  324. break;
  325. default: status = 0; /* invalid option */
  326. }
  327. }
  328. return status;
  329. }
  330. LUA_API int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar) {
  331. int status;
  332. Closure *cl;
  333. CallInfo *ci;
  334. TValue *func;
  335. lua_lock(L);
  336. if (*what == '>') {
  337. ci = NULL;
  338. func = s2v(L->top.p - 1);
  339. api_check(L, ttisfunction(func), "function expected");
  340. what++; /* skip the '>' */
  341. L->top.p--; /* pop function */
  342. }
  343. else {
  344. ci = ar->i_ci;
  345. func = s2v(ci->func.p);
  346. lua_assert(ttisfunction(func));
  347. }
  348. cl = ttisclosure(func) ? clvalue(func) : NULL;
  349. status = auxgetinfo(L, what, ar, cl, ci);
  350. if (strchr(what, 'f')) {
  351. setobj2s(L, L->top.p, func);
  352. api_incr_top(L);
  353. }
  354. if (strchr(what, 'L'))
  355. collectvalidlines(L, cl);
  356. lua_unlock(L);
  357. return status;
  358. }
  359. /*
  360. ** {======================================================
  361. ** Symbolic Execution
  362. ** =======================================================
  363. */
  364. static int filterpc (int pc, int jmptarget) {
  365. if (pc < jmptarget) /* is code conditional (inside a jump)? */
  366. return -1; /* cannot know who sets that register */
  367. else return pc; /* current position sets that register */
  368. }
  369. /*
  370. ** Try to find last instruction before 'lastpc' that modified register 'reg'.
  371. */
  372. static int findsetreg (const Proto *p, int lastpc, int reg) {
  373. int pc;
  374. int setreg = -1; /* keep last instruction that changed 'reg' */
  375. int jmptarget = 0; /* any code before this address is conditional */
  376. if (testMMMode(GET_OPCODE(p->code[lastpc])))
  377. lastpc--; /* previous instruction was not actually executed */
  378. for (pc = 0; pc < lastpc; pc++) {
  379. Instruction i = p->code[pc];
  380. OpCode op = GET_OPCODE(i);
  381. int a = GETARG_A(i);
  382. int change; /* true if current instruction changed 'reg' */
  383. switch (op) {
  384. case OP_LOADNIL: { /* set registers from 'a' to 'a+b' */
  385. int b = GETARG_B(i);
  386. change = (a <= reg && reg <= a + b);
  387. break;
  388. }
  389. case OP_TFORCALL: { /* affect all regs above its base */
  390. change = (reg >= a + 2);
  391. break;
  392. }
  393. case OP_CALL:
  394. case OP_TAILCALL: { /* affect all registers above base */
  395. change = (reg >= a);
  396. break;
  397. }
  398. case OP_JMP: { /* doesn't change registers, but changes 'jmptarget' */
  399. int b = GETARG_sJ(i);
  400. int dest = pc + 1 + b;
  401. /* jump does not skip 'lastpc' and is larger than current one? */
  402. if (dest <= lastpc && dest > jmptarget)
  403. jmptarget = dest; /* update 'jmptarget' */
  404. change = 0;
  405. break;
  406. }
  407. default: /* any instruction that sets A */
  408. change = (testAMode(op) && reg == a);
  409. break;
  410. }
  411. if (change)
  412. setreg = filterpc(pc, jmptarget);
  413. }
  414. return setreg;
  415. }
  416. /*
  417. ** Find a "name" for the constant 'c'.
  418. */
  419. static const char *kname (const Proto *p, int index, const char **name) {
  420. TValue *kvalue = &p->k[index];
  421. if (ttisstring(kvalue)) {
  422. *name = getstr(tsvalue(kvalue));
  423. return "constant";
  424. }
  425. else {
  426. *name = "?";
  427. return NULL;
  428. }
  429. }
  430. static const char *basicgetobjname (const Proto *p, int *ppc, int reg,
  431. const char **name) {
  432. int pc = *ppc;
  433. *name = luaF_getlocalname(p, reg + 1, pc);
  434. if (*name) /* is a local? */
  435. return "local";
  436. /* else try symbolic execution */
  437. *ppc = pc = findsetreg(p, pc, reg);
  438. if (pc != -1) { /* could find instruction? */
  439. Instruction i = p->code[pc];
  440. OpCode op = GET_OPCODE(i);
  441. switch (op) {
  442. case OP_MOVE: {
  443. int b = GETARG_B(i); /* move from 'b' to 'a' */
  444. if (b < GETARG_A(i))
  445. return basicgetobjname(p, ppc, b, name); /* get name for 'b' */
  446. break;
  447. }
  448. case OP_GETUPVAL: {
  449. *name = upvalname(p, GETARG_B(i));
  450. return "upvalue";
  451. }
  452. case OP_LOADK: return kname(p, GETARG_Bx(i), name);
  453. case OP_LOADKX: return kname(p, GETARG_Ax(p->code[pc + 1]), name);
  454. default: break;
  455. }
  456. }
  457. return NULL; /* could not find reasonable name */
  458. }
  459. /*
  460. ** Find a "name" for the register 'c'.
  461. */
  462. static void rname (const Proto *p, int pc, int c, const char **name) {
  463. const char *what = basicgetobjname(p, &pc, c, name); /* search for 'c' */
  464. if (!(what && *what == 'c')) /* did not find a constant name? */
  465. *name = "?";
  466. }
  467. /*
  468. ** Find a "name" for a 'C' value in an RK instruction.
  469. */
  470. static void rkname (const Proto *p, int pc, Instruction i, const char **name) {
  471. int c = GETARG_C(i); /* key index */
  472. if (GETARG_k(i)) /* is 'c' a constant? */
  473. kname(p, c, name);
  474. else /* 'c' is a register */
  475. rname(p, pc, c, name);
  476. }
  477. /*
  478. ** Check whether table being indexed by instruction 'i' is the
  479. ** environment '_ENV'
  480. */
  481. static const char *isEnv (const Proto *p, int pc, Instruction i, int isup) {
  482. int t = GETARG_B(i); /* table index */
  483. const char *name; /* name of indexed variable */
  484. if (isup) /* is 't' an upvalue? */
  485. name = upvalname(p, t);
  486. else /* 't' is a register */
  487. basicgetobjname(p, &pc, t, &name);
  488. return (name && strcmp(name, LUA_ENV) == 0) ? "global" : "field";
  489. }
  490. /*
  491. ** Extend 'basicgetobjname' to handle table accesses
  492. */
  493. static const char *getobjname (const Proto *p, int lastpc, int reg,
  494. const char **name) {
  495. const char *kind = basicgetobjname(p, &lastpc, reg, name);
  496. if (kind != NULL)
  497. return kind;
  498. else if (lastpc != -1) { /* could find instruction? */
  499. Instruction i = p->code[lastpc];
  500. OpCode op = GET_OPCODE(i);
  501. switch (op) {
  502. case OP_GETTABUP: {
  503. int k = GETARG_C(i); /* key index */
  504. kname(p, k, name);
  505. return isEnv(p, lastpc, i, 1);
  506. }
  507. case OP_GETTABLE: {
  508. int k = GETARG_C(i); /* key index */
  509. rname(p, lastpc, k, name);
  510. return isEnv(p, lastpc, i, 0);
  511. }
  512. case OP_GETI: {
  513. *name = "integer index";
  514. return "field";
  515. }
  516. case OP_GETFIELD: {
  517. int k = GETARG_C(i); /* key index */
  518. kname(p, k, name);
  519. return isEnv(p, lastpc, i, 0);
  520. }
  521. case OP_SELF: {
  522. rkname(p, lastpc, i, name);
  523. return "method";
  524. }
  525. default: break; /* go through to return NULL */
  526. }
  527. }
  528. return NULL; /* could not find reasonable name */
  529. }
  530. /*
  531. ** Try to find a name for a function based on the code that called it.
  532. ** (Only works when function was called by a Lua function.)
  533. ** Returns what the name is (e.g., "for iterator", "method",
  534. ** "metamethod") and sets '*name' to point to the name.
  535. */
  536. static const char *funcnamefromcode (lua_State *L, const Proto *p,
  537. int pc, const char **name) {
  538. TMS tm = (TMS)0; /* (initial value avoids warnings) */
  539. Instruction i = p->code[pc]; /* calling instruction */
  540. switch (GET_OPCODE(i)) {
  541. case OP_CALL:
  542. case OP_TAILCALL:
  543. return getobjname(p, pc, GETARG_A(i), name); /* get function name */
  544. case OP_TFORCALL: { /* for iterator */
  545. *name = "for iterator";
  546. return "for iterator";
  547. }
  548. /* other instructions can do calls through metamethods */
  549. case OP_SELF: case OP_GETTABUP: case OP_GETTABLE:
  550. case OP_GETI: case OP_GETFIELD:
  551. tm = TM_INDEX;
  552. break;
  553. case OP_SETTABUP: case OP_SETTABLE: case OP_SETI: case OP_SETFIELD:
  554. tm = TM_NEWINDEX;
  555. break;
  556. case OP_MMBIN: case OP_MMBINI: case OP_MMBINK: {
  557. tm = cast(TMS, GETARG_C(i));
  558. break;
  559. }
  560. case OP_UNM: tm = TM_UNM; break;
  561. case OP_BNOT: tm = TM_BNOT; break;
  562. case OP_LEN: tm = TM_LEN; break;
  563. case OP_CONCAT: tm = TM_CONCAT; break;
  564. case OP_EQ: tm = TM_EQ; break;
  565. /* no cases for OP_EQI and OP_EQK, as they don't call metamethods */
  566. case OP_LT: case OP_LTI: case OP_GTI: tm = TM_LT; break;
  567. case OP_LE: case OP_LEI: case OP_GEI: tm = TM_LE; break;
  568. case OP_CLOSE: case OP_RETURN: tm = TM_CLOSE; break;
  569. default:
  570. return NULL; /* cannot find a reasonable name */
  571. }
  572. *name = getshrstr(G(L)->tmname[tm]) + 2;
  573. return "metamethod";
  574. }
  575. /*
  576. ** Try to find a name for a function based on how it was called.
  577. */
  578. static const char *funcnamefromcall (lua_State *L, CallInfo *ci,
  579. const char **name) {
  580. if (ci->callstatus & CIST_HOOKED) { /* was it called inside a hook? */
  581. *name = "?";
  582. return "hook";
  583. }
  584. else if (ci->callstatus & CIST_FIN) { /* was it called as a finalizer? */
  585. *name = "__gc";
  586. return "metamethod"; /* report it as such */
  587. }
  588. else if (isLua(ci))
  589. return funcnamefromcode(L, ci_func(ci)->p, currentpc(ci), name);
  590. else
  591. return NULL;
  592. }
  593. /* }====================================================== */
  594. /*
  595. ** Check whether pointer 'o' points to some value in the stack frame of
  596. ** the current function and, if so, returns its index. Because 'o' may
  597. ** not point to a value in this stack, we cannot compare it with the
  598. ** region boundaries (undefined behavior in ISO C).
  599. */
  600. static int instack (CallInfo *ci, const TValue *o) {
  601. int pos;
  602. StkId base = ci->func.p + 1;
  603. for (pos = 0; base + pos < ci->top.p; pos++) {
  604. if (o == s2v(base + pos))
  605. return pos;
  606. }
  607. return -1; /* not found */
  608. }
  609. /*
  610. ** Checks whether value 'o' came from an upvalue. (That can only happen
  611. ** with instructions OP_GETTABUP/OP_SETTABUP, which operate directly on
  612. ** upvalues.)
  613. */
  614. static const char *getupvalname (CallInfo *ci, const TValue *o,
  615. const char **name) {
  616. LClosure *c = ci_func(ci);
  617. int i;
  618. for (i = 0; i < c->nupvalues; i++) {
  619. if (c->upvals[i]->v.p == o) {
  620. *name = upvalname(c->p, i);
  621. return "upvalue";
  622. }
  623. }
  624. return NULL;
  625. }
  626. static const char *formatvarinfo (lua_State *L, const char *kind,
  627. const char *name) {
  628. if (kind == NULL)
  629. return ""; /* no information */
  630. else
  631. return luaO_pushfstring(L, " (%s '%s')", kind, name);
  632. }
  633. /*
  634. ** Build a string with a "description" for the value 'o', such as
  635. ** "variable 'x'" or "upvalue 'y'".
  636. */
  637. static const char *varinfo (lua_State *L, const TValue *o) {
  638. CallInfo *ci = L->ci;
  639. const char *name = NULL; /* to avoid warnings */
  640. const char *kind = NULL;
  641. if (isLua(ci)) {
  642. kind = getupvalname(ci, o, &name); /* check whether 'o' is an upvalue */
  643. if (!kind) { /* not an upvalue? */
  644. int reg = instack(ci, o); /* try a register */
  645. if (reg >= 0) /* is 'o' a register? */
  646. kind = getobjname(ci_func(ci)->p, currentpc(ci), reg, &name);
  647. }
  648. }
  649. return formatvarinfo(L, kind, name);
  650. }
  651. /*
  652. ** Raise a type error
  653. */
  654. static l_noret typeerror (lua_State *L, const TValue *o, const char *op,
  655. const char *extra) {
  656. const char *t = luaT_objtypename(L, o);
  657. luaG_runerror(L, "attempt to %s a %s value%s", op, t, extra);
  658. }
  659. /*
  660. ** Raise a type error with "standard" information about the faulty
  661. ** object 'o' (using 'varinfo').
  662. */
  663. l_noret luaG_typeerror (lua_State *L, const TValue *o, const char *op) {
  664. typeerror(L, o, op, varinfo(L, o));
  665. }
  666. /*
  667. ** Raise an error for calling a non-callable object. Try to find a name
  668. ** for the object based on how it was called ('funcnamefromcall'); if it
  669. ** cannot get a name there, try 'varinfo'.
  670. */
  671. l_noret luaG_callerror (lua_State *L, const TValue *o) {
  672. CallInfo *ci = L->ci;
  673. const char *name = NULL; /* to avoid warnings */
  674. const char *kind = funcnamefromcall(L, ci, &name);
  675. const char *extra = kind ? formatvarinfo(L, kind, name) : varinfo(L, o);
  676. typeerror(L, o, "call", extra);
  677. }
  678. l_noret luaG_forerror (lua_State *L, const TValue *o, const char *what) {
  679. luaG_runerror(L, "bad 'for' %s (number expected, got %s)",
  680. what, luaT_objtypename(L, o));
  681. }
  682. l_noret luaG_concaterror (lua_State *L, const TValue *p1, const TValue *p2) {
  683. if (ttisstring(p1) || cvt2str(p1)) p1 = p2;
  684. luaG_typeerror(L, p1, "concatenate");
  685. }
  686. l_noret luaG_opinterror (lua_State *L, const TValue *p1,
  687. const TValue *p2, const char *msg) {
  688. if (!ttisnumber(p1)) /* first operand is wrong? */
  689. p2 = p1; /* now second is wrong */
  690. luaG_typeerror(L, p2, msg);
  691. }
  692. /*
  693. ** Error when both values are convertible to numbers, but not to integers
  694. */
  695. l_noret luaG_tointerror (lua_State *L, const TValue *p1, const TValue *p2) {
  696. lua_Integer temp;
  697. if (!luaV_tointegerns(p1, &temp, LUA_FLOORN2I))
  698. p2 = p1;
  699. luaG_runerror(L, "number%s has no integer representation", varinfo(L, p2));
  700. }
  701. l_noret luaG_ordererror (lua_State *L, const TValue *p1, const TValue *p2) {
  702. const char *t1 = luaT_objtypename(L, p1);
  703. const char *t2 = luaT_objtypename(L, p2);
  704. if (strcmp(t1, t2) == 0)
  705. luaG_runerror(L, "attempt to compare two %s values", t1);
  706. else
  707. luaG_runerror(L, "attempt to compare %s with %s", t1, t2);
  708. }
  709. /* add src:line information to 'msg' */
  710. const char *luaG_addinfo (lua_State *L, const char *msg, TString *src,
  711. int line) {
  712. char buff[LUA_IDSIZE];
  713. if (src)
  714. luaO_chunkid(buff, getstr(src), tsslen(src));
  715. else { /* no source available; use "?" instead */
  716. buff[0] = '?'; buff[1] = '\0';
  717. }
  718. return luaO_pushfstring(L, "%s:%d: %s", buff, line, msg);
  719. }
  720. l_noret luaG_errormsg (lua_State *L) {
  721. if (L->errfunc != 0) { /* is there an error handling function? */
  722. StkId errfunc = restorestack(L, L->errfunc);
  723. lua_assert(ttisfunction(s2v(errfunc)));
  724. setobjs2s(L, L->top.p, L->top.p - 1); /* move argument */
  725. setobjs2s(L, L->top.p - 1, errfunc); /* push function */
  726. L->top.p++; /* assume EXTRA_STACK */
  727. luaD_callnoyield(L, L->top.p - 2, 1); /* call it */
  728. }
  729. luaD_throw(L, LUA_ERRRUN);
  730. }
  731. l_noret luaG_runerror (lua_State *L, const char *fmt, ...) {
  732. CallInfo *ci = L->ci;
  733. const char *msg;
  734. va_list argp;
  735. luaC_checkGC(L); /* error message uses memory */
  736. va_start(argp, fmt);
  737. msg = luaO_pushvfstring(L, fmt, argp); /* format message */
  738. va_end(argp);
  739. if (isLua(ci)) { /* if Lua function, add source:line information */
  740. luaG_addinfo(L, msg, ci_func(ci)->p->source, getcurrentline(ci));
  741. setobjs2s(L, L->top.p - 2, L->top.p - 1); /* remove 'msg' */
  742. L->top.p--;
  743. }
  744. luaG_errormsg(L);
  745. }
  746. /*
  747. ** Check whether new instruction 'newpc' is in a different line from
  748. ** previous instruction 'oldpc'. More often than not, 'newpc' is only
  749. ** one or a few instructions after 'oldpc' (it must be after, see
  750. ** caller), so try to avoid calling 'luaG_getfuncline'. If they are
  751. ** too far apart, there is a good chance of a ABSLINEINFO in the way,
  752. ** so it goes directly to 'luaG_getfuncline'.
  753. */
  754. static int changedline (const Proto *p, int oldpc, int newpc) {
  755. if (p->lineinfo == NULL) /* no debug information? */
  756. return 0;
  757. if (newpc - oldpc < MAXIWTHABS / 2) { /* not too far apart? */
  758. int delta = 0; /* line difference */
  759. int pc = oldpc;
  760. for (;;) {
  761. int lineinfo = p->lineinfo[++pc];
  762. if (lineinfo == ABSLINEINFO)
  763. break; /* cannot compute delta; fall through */
  764. delta += lineinfo;
  765. if (pc == newpc)
  766. return (delta != 0); /* delta computed successfully */
  767. }
  768. }
  769. /* either instructions are too far apart or there is an absolute line
  770. info in the way; compute line difference explicitly */
  771. return (luaG_getfuncline(p, oldpc) != luaG_getfuncline(p, newpc));
  772. }
  773. /*
  774. ** Traces Lua calls. If code is running the first instruction of a function,
  775. ** and function is not vararg, and it is not coming from an yield,
  776. ** calls 'luaD_hookcall'. (Vararg functions will call 'luaD_hookcall'
  777. ** after adjusting its variable arguments; otherwise, they could call
  778. ** a line/count hook before the call hook. Functions coming from
  779. ** an yield already called 'luaD_hookcall' before yielding.)
  780. */
  781. int luaG_tracecall (lua_State *L) {
  782. CallInfo *ci = L->ci;
  783. Proto *p = ci_func(ci)->p;
  784. ci->u.l.trap = 1; /* ensure hooks will be checked */
  785. if (ci->u.l.savedpc == p->code) { /* first instruction (not resuming)? */
  786. if (p->is_vararg)
  787. return 0; /* hooks will start at VARARGPREP instruction */
  788. else if (!(ci->callstatus & CIST_HOOKYIELD)) /* not yieded? */
  789. luaD_hookcall(L, ci); /* check 'call' hook */
  790. }
  791. return 1; /* keep 'trap' on */
  792. }
  793. /*
  794. ** Traces the execution of a Lua function. Called before the execution
  795. ** of each opcode, when debug is on. 'L->oldpc' stores the last
  796. ** instruction traced, to detect line changes. When entering a new
  797. ** function, 'npci' will be zero and will test as a new line whatever
  798. ** the value of 'oldpc'. Some exceptional conditions may return to
  799. ** a function without setting 'oldpc'. In that case, 'oldpc' may be
  800. ** invalid; if so, use zero as a valid value. (A wrong but valid 'oldpc'
  801. ** at most causes an extra call to a line hook.)
  802. ** This function is not "Protected" when called, so it should correct
  803. ** 'L->top.p' before calling anything that can run the GC.
  804. */
  805. int luaG_traceexec (lua_State *L, const Instruction *pc) {
  806. CallInfo *ci = L->ci;
  807. lu_byte mask = L->hookmask;
  808. const Proto *p = ci_func(ci)->p;
  809. int counthook;
  810. if (!(mask & (LUA_MASKLINE | LUA_MASKCOUNT))) { /* no hooks? */
  811. ci->u.l.trap = 0; /* don't need to stop again */
  812. return 0; /* turn off 'trap' */
  813. }
  814. pc++; /* reference is always next instruction */
  815. ci->u.l.savedpc = pc; /* save 'pc' */
  816. counthook = (--L->hookcount == 0 && (mask & LUA_MASKCOUNT));
  817. if (counthook)
  818. resethookcount(L); /* reset count */
  819. else if (!(mask & LUA_MASKLINE))
  820. return 1; /* no line hook and count != 0; nothing to be done now */
  821. if (ci->callstatus & CIST_HOOKYIELD) { /* called hook last time? */
  822. ci->callstatus &= ~CIST_HOOKYIELD; /* erase mark */
  823. return 1; /* do not call hook again (VM yielded, so it did not move) */
  824. }
  825. if (!isIT(*(ci->u.l.savedpc - 1))) /* top not being used? */
  826. L->top.p = ci->top.p; /* correct top */
  827. if (counthook)
  828. luaD_hook(L, LUA_HOOKCOUNT, -1, 0, 0); /* call count hook */
  829. if (mask & LUA_MASKLINE) {
  830. /* 'L->oldpc' may be invalid; use zero in this case */
  831. int oldpc = (L->oldpc < p->sizecode) ? L->oldpc : 0;
  832. int npci = pcRel(pc, p);
  833. if (npci <= oldpc || /* call hook when jump back (loop), */
  834. changedline(p, oldpc, npci)) { /* or when enter new line */
  835. int newline = luaG_getfuncline(p, npci);
  836. luaD_hook(L, LUA_HOOKLINE, newline, 0, 0); /* call line hook */
  837. }
  838. L->oldpc = npci; /* 'pc' of last call to line hook */
  839. }
  840. if (L->status == LUA_YIELD) { /* did hook yield? */
  841. if (counthook)
  842. L->hookcount = 1; /* undo decrement to zero */
  843. ci->u.l.savedpc--; /* undo increment (resume will increment it again) */
  844. ci->callstatus |= CIST_HOOKYIELD; /* mark that it yielded */
  845. luaD_throw(L, LUA_YIELD);
  846. }
  847. return 1; /* keep 'trap' on */
  848. }