1 /* $NetBSD: ldebug.c,v 1.5 2015/10/08 13:21:00 mbalmer Exp $ */
4 ** Id: ldebug.c,v 2.115 2015/05/22 17:45:56 roberto Exp
6 ** See Copyright Notice in lua.h
38 #define noLuaClosure(f) ((f) == NULL || (f)->c.tt == LUA_TCCL)
41 /* Active Lua function (given call info) */
42 #define ci_func(ci) (clLvalue((ci)->func))
45 static const char *getfuncname (lua_State
*L
, CallInfo
*ci
, const char **name
);
48 static int currentpc (CallInfo
*ci
) {
49 lua_assert(isLua(ci
));
50 return pcRel(ci
->u
.l
.savedpc
, ci_func(ci
)->p
);
54 static int currentline (CallInfo
*ci
) {
55 return getfuncline(ci_func(ci
)->p
, currentpc(ci
));
60 ** If function yielded, its 'func' can be in the 'extra' field. The
61 ** next function restores 'func' to its correct value for debugging
62 ** purposes. (It exchanges 'func' and 'extra'; so, when called again,
63 ** after debugging, it also "re-restores" ** 'func' to its altered value.
65 static void swapextra (lua_State
*L
) {
66 if (L
->status
== LUA_YIELD
) {
67 CallInfo
*ci
= L
->ci
; /* get function that yielded */
68 StkId temp
= ci
->func
; /* exchange its 'func' and 'extra' values */
69 ci
->func
= restorestack(L
, ci
->extra
);
70 ci
->extra
= savestack(L
, temp
);
76 ** this function can be called asynchronous (e.g. during a signal)
78 LUA_API
void lua_sethook (lua_State
*L
, lua_Hook func
, int mask
, int count
) {
79 if (func
== NULL
|| mask
== 0) { /* turn off hooks? */
84 L
->oldpc
= L
->ci
->u
.l
.savedpc
;
86 L
->basehookcount
= count
;
88 L
->hookmask
= cast_byte(mask
);
92 LUA_API lua_Hook
lua_gethook (lua_State
*L
) {
97 LUA_API
int lua_gethookmask (lua_State
*L
) {
102 LUA_API
int lua_gethookcount (lua_State
*L
) {
103 return L
->basehookcount
;
107 LUA_API
int lua_getstack (lua_State
*L
, int level
, lua_Debug
*ar
) {
110 if (level
< 0) return 0; /* invalid (negative) level */
112 for (ci
= L
->ci
; level
> 0 && ci
!= &L
->base_ci
; ci
= ci
->previous
)
114 if (level
== 0 && ci
!= &L
->base_ci
) { /* level found? */
118 else status
= 0; /* no such level */
124 static const char *upvalname (Proto
*p
, int uv
) {
125 TString
*s
= check_exp(uv
< p
->sizeupvalues
, p
->upvalues
[uv
].name
);
126 if (s
== NULL
) return "?";
127 else return getstr(s
);
131 static const char *findvararg (CallInfo
*ci
, int n
, StkId
*pos
) {
132 int nparams
= clLvalue(ci
->func
)->p
->numparams
;
133 if (n
>= cast_int(ci
->u
.l
.base
- ci
->func
) - nparams
)
134 return NULL
; /* no such vararg */
136 *pos
= ci
->func
+ nparams
+ n
;
137 return "(*vararg)"; /* generic name for any vararg */
142 static const char *findlocal (lua_State
*L
, CallInfo
*ci
, int n
,
144 const char *name
= NULL
;
147 if (n
< 0) /* access to vararg values? */
148 return findvararg(ci
, -n
, pos
);
151 name
= luaF_getlocalname(ci_func(ci
)->p
, n
, currentpc(ci
));
156 if (name
== NULL
) { /* no 'standard' name? */
157 StkId limit
= (ci
== L
->ci
) ? L
->top
: ci
->next
->func
;
158 if (limit
- base
>= n
&& n
> 0) /* is 'n' inside 'ci' stack? */
159 name
= "(*temporary)"; /* generic name for any valid slot */
161 return NULL
; /* no name */
163 *pos
= base
+ (n
- 1);
168 LUA_API
const char *lua_getlocal (lua_State
*L
, const lua_Debug
*ar
, int n
) {
172 if (ar
== NULL
) { /* information about non-active function? */
173 if (!isLfunction(L
->top
- 1)) /* not a Lua function? */
175 else /* consider live variables at function start (parameters) */
176 name
= luaF_getlocalname(clLvalue(L
->top
- 1)->p
, n
, 0);
178 else { /* active function; get information through 'ar' */
179 StkId pos
= NULL
; /* to avoid warnings */
180 name
= findlocal(L
, ar
->i_ci
, n
, &pos
);
182 setobj2s(L
, L
->top
, pos
);
192 LUA_API
const char *lua_setlocal (lua_State
*L
, const lua_Debug
*ar
, int n
) {
193 StkId pos
= NULL
; /* to avoid warnings */
197 name
= findlocal(L
, ar
->i_ci
, n
, &pos
);
199 setobjs2s(L
, pos
, L
->top
- 1);
200 L
->top
--; /* pop value */
208 static void funcinfo (lua_Debug
*ar
, Closure
*cl
) {
209 if (noLuaClosure(cl
)) {
211 ar
->linedefined
= -1;
212 ar
->lastlinedefined
= -1;
217 ar
->source
= p
->source
? getstr(p
->source
) : "=?";
218 ar
->linedefined
= p
->linedefined
;
219 ar
->lastlinedefined
= p
->lastlinedefined
;
220 ar
->what
= (ar
->linedefined
== 0) ? "main" : "Lua";
222 luaO_chunkid(ar
->short_src
, ar
->source
, LUA_IDSIZE
);
226 static void collectvalidlines (lua_State
*L
, Closure
*f
) {
227 if (noLuaClosure(f
)) {
234 int *lineinfo
= f
->l
.p
->lineinfo
;
235 Table
*t
= luaH_new(L
); /* new table to store active lines */
236 sethvalue(L
, L
->top
, t
); /* push it on stack */
238 setbvalue(&v
, 1); /* boolean 'true' to be the value of all indices */
239 for (i
= 0; i
< f
->l
.p
->sizelineinfo
; i
++) /* for all lines with code */
240 luaH_setint(L
, t
, lineinfo
[i
], &v
); /* table[line] = true */
245 static int auxgetinfo (lua_State
*L
, const char *what
, lua_Debug
*ar
,
246 Closure
*f
, CallInfo
*ci
) {
248 for (; *what
; what
++) {
255 ar
->currentline
= (ci
&& isLua(ci
)) ? currentline(ci
) : -1;
259 ar
->nups
= (f
== NULL
) ? 0 : f
->c
.nupvalues
;
260 if (noLuaClosure(f
)) {
265 ar
->isvararg
= f
->l
.p
->is_vararg
;
266 ar
->nparams
= f
->l
.p
->numparams
;
271 ar
->istailcall
= (ci
) ? ci
->callstatus
& CIST_TAIL
: 0;
275 /* calling function is a known Lua function? */
276 if (ci
&& !(ci
->callstatus
& CIST_TAIL
) && isLua(ci
->previous
))
277 ar
->namewhat
= getfuncname(L
, ci
->previous
, &ar
->name
);
280 if (ar
->namewhat
== NULL
) {
281 ar
->namewhat
= ""; /* not found */
287 case 'f': /* handled by lua_getinfo */
289 default: status
= 0; /* invalid option */
296 LUA_API
int lua_getinfo (lua_State
*L
, const char *what
, lua_Debug
*ar
) {
306 api_check(L
, ttisfunction(func
), "function expected");
307 what
++; /* skip the '>' */
308 L
->top
--; /* pop function */
313 lua_assert(ttisfunction(ci
->func
));
315 cl
= ttisclosure(func
) ? clvalue(func
) : NULL
;
316 status
= auxgetinfo(L
, what
, ar
, cl
, ci
);
317 if (strchr(what
, 'f')) {
318 setobjs2s(L
, L
->top
, func
);
321 swapextra(L
); /* correct before option 'L', which can raise a mem. error */
322 if (strchr(what
, 'L'))
323 collectvalidlines(L
, cl
);
330 ** {======================================================
331 ** Symbolic Execution
332 ** =======================================================
335 static const char *getobjname (Proto
*p
, int lastpc
, int reg
,
340 ** find a "name" for the RK value 'c'
342 static void kname (Proto
*p
, int pc
, int c
, const char **name
) {
343 if (ISK(c
)) { /* is 'c' a constant? */
344 TValue
*kvalue
= &p
->k
[INDEXK(c
)];
345 if (ttisstring(kvalue
)) { /* literal constant? */
346 *name
= svalue(kvalue
); /* it is its own name */
349 /* else no reasonable name found */
351 else { /* 'c' is a register */
352 const char *what
= getobjname(p
, pc
, c
, name
); /* search for 'c' */
353 if (what
&& *what
== 'c') { /* found a constant name? */
354 return; /* 'name' already filled */
356 /* else no reasonable name found */
358 *name
= "?"; /* no reasonable name found */
362 static int filterpc (int pc
, int jmptarget
) {
363 if (pc
< jmptarget
) /* is code conditional (inside a jump)? */
364 return -1; /* cannot know who sets that register */
365 else return pc
; /* current position sets that register */
370 ** try to find last instruction before 'lastpc' that modified register 'reg'
372 static int findsetreg (Proto
*p
, int lastpc
, int reg
) {
374 int setreg
= -1; /* keep last instruction that changed 'reg' */
375 int jmptarget
= 0; /* any code before this address is conditional */
376 for (pc
= 0; pc
< lastpc
; pc
++) {
377 Instruction i
= p
->code
[pc
];
378 OpCode op
= GET_OPCODE(i
);
383 if (a
<= reg
&& reg
<= a
+ b
) /* set registers from 'a' to 'a+b' */
384 setreg
= filterpc(pc
, jmptarget
);
388 if (reg
>= a
+ 2) /* affect all regs above its base */
389 setreg
= filterpc(pc
, jmptarget
);
394 if (reg
>= a
) /* affect all registers above base */
395 setreg
= filterpc(pc
, jmptarget
);
399 int b
= GETARG_sBx(i
);
400 int dest
= pc
+ 1 + b
;
401 /* jump is forward and do not skip 'lastpc'? */
402 if (pc
< dest
&& dest
<= lastpc
) {
403 if (dest
> jmptarget
)
404 jmptarget
= dest
; /* update 'jmptarget' */
409 if (testAMode(op
) && reg
== a
) /* any instruction that set A */
410 setreg
= filterpc(pc
, jmptarget
);
418 static const char *getobjname (Proto
*p
, int lastpc
, int reg
,
421 *name
= luaF_getlocalname(p
, reg
+ 1, lastpc
);
422 if (*name
) /* is a local? */
424 /* else try symbolic execution */
425 pc
= findsetreg(p
, lastpc
, reg
);
426 if (pc
!= -1) { /* could find instruction? */
427 Instruction i
= p
->code
[pc
];
428 OpCode op
= GET_OPCODE(i
);
431 int b
= GETARG_B(i
); /* move from 'b' to 'a' */
433 return getobjname(p
, pc
, b
, name
); /* get name for 'b' */
438 int k
= GETARG_C(i
); /* key index */
439 int t
= GETARG_B(i
); /* table index */
440 const char *vn
= (op
== OP_GETTABLE
) /* name of indexed variable */
441 ? luaF_getlocalname(p
, t
+ 1, pc
)
443 kname(p
, pc
, k
, name
);
444 return (vn
&& strcmp(vn
, LUA_ENV
) == 0) ? "global" : "field";
447 *name
= upvalname(p
, GETARG_B(i
));
452 int b
= (op
== OP_LOADK
) ? GETARG_Bx(i
)
453 : GETARG_Ax(p
->code
[pc
+ 1]);
454 if (ttisstring(&p
->k
[b
])) {
455 *name
= svalue(&p
->k
[b
]);
461 int k
= GETARG_C(i
); /* key index */
462 kname(p
, pc
, k
, name
);
465 default: break; /* go through to return NULL */
468 return NULL
; /* could not find reasonable name */
472 static const char *getfuncname (lua_State
*L
, CallInfo
*ci
, const char **name
) {
473 TMS tm
= (TMS
)0; /* to avoid warnings */
474 Proto
*p
= ci_func(ci
)->p
; /* calling function */
475 int pc
= currentpc(ci
); /* calling instruction index */
476 Instruction i
= p
->code
[pc
]; /* calling instruction */
477 if (ci
->callstatus
& CIST_HOOKED
) { /* was it called inside a hook? */
481 switch (GET_OPCODE(i
)) {
483 case OP_TAILCALL
: /* get function name */
484 return getobjname(p
, pc
, GETARG_A(i
), name
);
485 case OP_TFORCALL
: { /* for iterator */
486 *name
= "for iterator";
487 return "for iterator";
489 /* all other instructions can call only through metamethods */
490 case OP_SELF
: case OP_GETTABUP
: case OP_GETTABLE
:
493 case OP_SETTABUP
: case OP_SETTABLE
:
496 case OP_ADD
: case OP_SUB
: case OP_MUL
: case OP_MOD
:
498 case OP_POW
: case OP_DIV
: case OP_IDIV
: case OP_BAND
:
500 case OP_IDIV
: case OP_BAND
:
502 case OP_BOR
: case OP_BXOR
: case OP_SHL
: case OP_SHR
: {
503 int offset
= cast_int(GET_OPCODE(i
)) - cast_int(OP_ADD
); /* ORDER OP */
504 tm
= cast(TMS
, offset
+ cast_int(TM_ADD
)); /* ORDER TM */
507 case OP_UNM
: tm
= TM_UNM
; break;
508 case OP_BNOT
: tm
= TM_BNOT
; break;
509 case OP_LEN
: tm
= TM_LEN
; break;
510 case OP_CONCAT
: tm
= TM_CONCAT
; break;
511 case OP_EQ
: tm
= TM_EQ
; break;
512 case OP_LT
: tm
= TM_LT
; break;
513 case OP_LE
: tm
= TM_LE
; break;
514 default: lua_assert(0); /* other instructions cannot call a function */
516 *name
= getstr(G(L
)->tmname
[tm
]);
520 /* }====================================================== */
525 ** The subtraction of two potentially unrelated pointers is
526 ** not ISO C, but it should not crash a program; the subsequent
527 ** checks are ISO C and ensure a correct result.
529 static int isinstack (CallInfo
*ci
, const TValue
*o
) {
530 ptrdiff_t i
= o
- ci
->u
.l
.base
;
531 return (0 <= i
&& i
< (ci
->top
- ci
->u
.l
.base
) && ci
->u
.l
.base
+ i
== o
);
536 ** Checks whether value 'o' came from an upvalue. (That can only happen
537 ** with instructions OP_GETTABUP/OP_SETTABUP, which operate directly on
540 static const char *getupvalname (CallInfo
*ci
, const TValue
*o
,
542 LClosure
*c
= ci_func(ci
);
544 for (i
= 0; i
< c
->nupvalues
; i
++) {
545 if (c
->upvals
[i
]->v
== o
) {
546 *name
= upvalname(c
->p
, i
);
554 static const char *varinfo (lua_State
*L
, const TValue
*o
) {
555 const char *name
= NULL
; /* to avoid warnings */
556 CallInfo
*ci
= L
->ci
;
557 const char *kind
= NULL
;
559 kind
= getupvalname(ci
, o
, &name
); /* check whether 'o' is an upvalue */
560 if (!kind
&& isinstack(ci
, o
)) /* no? try a register */
561 kind
= getobjname(ci_func(ci
)->p
, currentpc(ci
),
562 cast_int(o
- ci
->u
.l
.base
), &name
);
564 return (kind
) ? luaO_pushfstring(L
, " (%s '%s')", kind
, name
) : "";
568 l_noret
luaG_typeerror (lua_State
*L
, const TValue
*o
, const char *op
) {
569 const char *t
= objtypename(o
);
570 luaG_runerror(L
, "attempt to %s a %s value%s", op
, t
, varinfo(L
, o
));
574 l_noret
luaG_concaterror (lua_State
*L
, const TValue
*p1
, const TValue
*p2
) {
575 if (ttisstring(p1
) || cvt2str(p1
)) p1
= p2
;
576 luaG_typeerror(L
, p1
, "concatenate");
580 l_noret
luaG_opinterror (lua_State
*L
, const TValue
*p1
,
581 const TValue
*p2
, const char *msg
) {
583 if (!tonumber(p1
, &temp
)) /* first operand is wrong? */
584 p2
= p1
; /* now second is wrong */
585 luaG_typeerror(L
, p2
, msg
);
590 ** Error when both values are convertible to numbers, but not to integers
592 l_noret
luaG_tointerror (lua_State
*L
, const TValue
*p1
, const TValue
*p2
) {
594 if (!tointeger(p1
, &temp
))
596 luaG_runerror(L
, "number%s has no integer representation", varinfo(L
, p2
));
600 l_noret
luaG_ordererror (lua_State
*L
, const TValue
*p1
, const TValue
*p2
) {
601 const char *t1
= objtypename(p1
);
602 const char *t2
= objtypename(p2
);
604 luaG_runerror(L
, "attempt to compare two %s values", t1
);
606 luaG_runerror(L
, "attempt to compare %s with %s", t1
, t2
);
610 /* add src:line information to 'msg' */
611 const char *luaG_addinfo (lua_State
*L
, const char *msg
, TString
*src
,
613 char buff
[LUA_IDSIZE
];
615 luaO_chunkid(buff
, getstr(src
), LUA_IDSIZE
);
616 else { /* no source available; use "?" instead */
617 buff
[0] = '?'; buff
[1] = '\0';
619 return luaO_pushfstring(L
, "%s:%d: %s", buff
, line
, msg
);
623 l_noret
luaG_errormsg (lua_State
*L
) {
624 if (L
->errfunc
!= 0) { /* is there an error handling function? */
625 StkId errfunc
= restorestack(L
, L
->errfunc
);
626 setobjs2s(L
, L
->top
, L
->top
- 1); /* move argument */
627 setobjs2s(L
, L
->top
- 1, errfunc
); /* push function */
628 L
->top
++; /* assume EXTRA_STACK */
629 luaD_call(L
, L
->top
- 2, 1, 0); /* call it */
631 luaD_throw(L
, LUA_ERRRUN
);
635 l_noret
luaG_runerror (lua_State
*L
, const char *fmt
, ...) {
636 CallInfo
*ci
= L
->ci
;
640 msg
= luaO_pushvfstring(L
, fmt
, argp
); /* format message */
642 if (isLua(ci
)) /* if Lua function, add source:line information */
643 luaG_addinfo(L
, msg
, ci_func(ci
)->p
->source
, currentline(ci
));
648 void luaG_traceexec (lua_State
*L
) {
649 CallInfo
*ci
= L
->ci
;
650 lu_byte mask
= L
->hookmask
;
651 int counthook
= ((mask
& LUA_MASKCOUNT
) && L
->hookcount
== 0);
653 resethookcount(L
); /* reset count */
654 if (ci
->callstatus
& CIST_HOOKYIELD
) { /* called hook last time? */
655 ci
->callstatus
&= ~CIST_HOOKYIELD
; /* erase mark */
656 return; /* do not call hook again (VM yielded, so it did not move) */
659 luaD_hook(L
, LUA_HOOKCOUNT
, -1); /* call count hook */
660 if (mask
& LUA_MASKLINE
) {
661 Proto
*p
= ci_func(ci
)->p
;
662 int npc
= pcRel(ci
->u
.l
.savedpc
, p
);
663 int newline
= getfuncline(p
, npc
);
664 if (npc
== 0 || /* call linehook when enter a new function, */
665 ci
->u
.l
.savedpc
<= L
->oldpc
|| /* when jump back (loop), or when */
666 newline
!= getfuncline(p
, pcRel(L
->oldpc
, p
))) /* enter a new line */
667 luaD_hook(L
, LUA_HOOKLINE
, newline
); /* call line hook */
669 L
->oldpc
= ci
->u
.l
.savedpc
;
670 if (L
->status
== LUA_YIELD
) { /* did hook yield? */
672 L
->hookcount
= 1; /* undo decrement to zero */
673 ci
->u
.l
.savedpc
--; /* undo increment (resume will increment it again) */
674 ci
->callstatus
|= CIST_HOOKYIELD
; /* mark that it yielded */
675 ci
->func
= L
->top
- 1; /* protect stack below results */
676 luaD_throw(L
, LUA_YIELD
);