lua/lstate.h

232 lines
7.3 KiB
C
Raw Normal View History

1997-11-19 20:31:19 +03:00
/*
** $Id: lstate.h,v 2.41 2009/04/08 18:04:33 roberto Exp roberto $
1997-11-19 20:31:19 +03:00
** Global State
** See Copyright Notice in lua.h
*/
#ifndef lstate_h
#define lstate_h
#include "lua.h"
2001-12-05 23:15:18 +03:00
#include "lobject.h"
#include "ltm.h"
#include "lzio.h"
1997-11-19 20:31:19 +03:00
/*
** Some notes about garbage-collected objects: All objects in Lua must
** be kept somehow accessible until being freed.
**
** Lua keeps most objects linked in list g->rootgc. The link uses field
** 'next' of the CommonHeader.
**
** Strings are kept in several lists headed by the array g->strt.hash.
**
** Open upvalues are not subject to independent garbage collection. They
** are collected together with their respective threads. Lua keeps a
** double-linked list with all open upvalues (g->uvhead) so that it can
** mark objects referred by them. (They are always gray, so they must
** be remarked in the atomic step. Usually their contents would be marked
** when traversing the respective threads, but the thread may already be
** dead, while the upvalue is still accessible through closures.)
**
** Userdata with finalizers are kept in the list g->rootgc, but after
** the mainthread, which should be otherwise the last element in the
** list, as it was the first one inserted there.
**
** The list g->tobefnz links all userdata being finalized.
*/
1999-05-10 17:54:01 +04:00
2000-09-25 20:22:42 +04:00
struct lua_longjmp; /* defined in ldo.c */
2001-12-05 23:15:18 +03:00
/* table of globals */
2005-07-09 17:22:34 +04:00
#define gt(L) (&L->l_gt)
2001-12-05 23:15:18 +03:00
/* registry */
2005-07-09 17:22:34 +04:00
#define registry(L) (&G(L)->l_registry)
2001-12-05 23:15:18 +03:00
2002-01-26 01:14:54 +03:00
2002-08-05 21:36:24 +04:00
/* extra stack space to handle TM calls and some other extras */
#define EXTRA_STACK 5
2002-01-26 01:14:54 +03:00
2002-03-26 23:46:10 +03:00
#define BASIC_CI_SIZE 8
2002-01-26 01:14:54 +03:00
#define BASIC_STACK_SIZE (2*LUA_MINSTACK)
1997-11-19 20:31:19 +03:00
/* kinds of Garbage Collection */
#define KGC_NORMAL 0
#define KGC_FORCED 1 /* gc was forced by the program */
#define KGC_EMERGENCY 2 /* gc was forced by an allocation failure */
1997-11-19 20:31:19 +03:00
1999-05-10 17:54:01 +04:00
typedef struct stringtable {
GCObject **hash;
lu_int32 nuse; /* number of elements */
int size;
1997-11-19 20:31:19 +03:00
} stringtable;
2001-12-18 23:52:30 +03:00
/*
** informations about a call
*/
typedef struct CallInfo {
StkId base; /* base for this function */
StkId func; /* function index in the stack */
StkId top; /* top for this function */
struct CallInfo *previous, *next; /* dynamic call link */
const Instruction *savedpc;
short nresults; /* expected number of results from a call */
lu_byte callstatus;
union {
struct { /* only for Lua functions */
int tailcalls; /* number of tail calls lost under this entry */
} l;
struct { /* only for C functions */
2009-03-23 17:26:12 +03:00
int ctx; /* context info. in case of yields */
lua_CFunction k; /* continuation in case of yields */
ptrdiff_t old_errfunc;
ptrdiff_t oldtop;
lu_byte old_allowhook;
lu_byte status;
} c;
} u;
2001-12-18 23:52:30 +03:00
} CallInfo;
/*
** Bits in CallInfo status
*/
#define CIST_LUA (1<<0) /* call is running a Lua function */
#define CIST_HOOKED (1<<1) /* call is running a debug hook */
#define CIST_REENTRY (1<<2) /* call is running on same invocation of
luaV_execute of previous call */
#define CIST_YIELDED (1<<3) /* call reentered after suspension */
#define CIST_YPCALL (1<<4) /* call is a yieldable protected call */
#define CIST_STAT (1<<5) /* call has an error status (pcall) */
#define curr_func(L) (clvalue(L->ci->func))
#define ci_func(ci) (clvalue((ci)->func))
#define isLua(ci) ((ci)->callstatus & CIST_LUA)
2001-12-18 23:52:30 +03:00
/*
2001-02-23 20:17:25 +03:00
** `global state', shared by all threads of this state
*/
typedef struct global_State {
2000-05-10 20:33:20 +04:00
stringtable strt; /* hash table for strings */
2005-02-23 20:30:22 +03:00
lua_Alloc frealloc; /* function to reallocate memory */
void *ud; /* auxiliary data to `frealloc' */
unsigned short nCcalls; /* number of nested C calls */
lu_byte currentwhite;
lu_byte gcstate; /* state of garbage collector */
lu_byte gckind; /* kind of GC running */
2006-02-06 21:27:59 +03:00
int sweepstrgc; /* position of sweep in `strt' */
GCObject *rootgc; /* list of all collectable objects */
2008-06-23 20:51:08 +04:00
GCObject **sweepgc; /* current position of sweep */
2003-11-18 17:55:11 +03:00
GCObject *gray; /* list of gray objects */
2003-12-04 21:52:23 +03:00
GCObject *grayagain; /* list of objects to be traversed atomically */
GCObject *weak; /* list of tables with weak values */
GCObject *ephemeron; /* list of ephemeron tables (weak keys) */
2007-10-31 18:41:19 +03:00
GCObject *allweak; /* list of all-weak tables */
GCObject *tobefnz; /* list of userdata to be GC */
Mbuffer buff; /* temporary buffer for string concatentation */
lu_mem GCthreshold;
2004-08-30 17:44:44 +04:00
lu_mem totalbytes; /* number of bytes currently allocated */
lu_mem estimate; /* an estimate of number of bytes actually in use */
lu_mem gcdept; /* how much GC is `behind schedule' */
2005-03-22 19:04:29 +03:00
int gcpause; /* size of pause between successive GCs */
int gcstepmul; /* GC `granularity' */
2002-04-16 21:08:28 +04:00
lua_CFunction panic; /* to be called in unprotected errors */
2005-07-09 17:22:34 +04:00
TValue l_registry;
struct lua_State *mainthread;
2005-01-18 20:18:09 +03:00
UpVal uvhead; /* head of double-linked list of all open upvalues */
2005-05-05 19:34:03 +04:00
struct Table *mt[NUM_TAGS]; /* metatables for basic types */
2001-12-05 23:15:18 +03:00
TString *tmname[TM_N]; /* array with tag-method names */
const TValue *nilobjp; /* pointer to nil object (to check consistency) */
} global_State;
/*
2001-02-23 20:17:25 +03:00
** `per thread' state
*/
struct lua_State {
CommonHeader;
2006-02-06 21:27:59 +03:00
lu_byte status;
StkId top; /* first free slot in the stack */
StkId base; /* base of current function */
2005-07-09 17:22:34 +04:00
global_State *l_G;
CallInfo *ci; /* call info for current function */
int nci; /* number of total CallInfo structures linked */
2005-04-05 17:41:29 +04:00
const Instruction *savedpc; /* `savedpc' of current function */
const Instruction *oldpc; /* last pc traced */
StkId stack_last; /* last free slot in the stack */
StkId stack; /* stack base */
2006-02-06 21:27:59 +03:00
int stacksize;
unsigned short nny; /* number of non-yieldable calls in stack */
lu_byte hookmask;
lu_byte allowhook;
int basehookcount;
int hookcount;
2002-07-08 22:21:33 +04:00
lua_Hook hook;
2005-07-09 17:22:34 +04:00
TValue l_gt; /* table of globals */
TValue env; /* temporary place for environments */
GCObject *openupval; /* list of open upvalues in this stack */
2002-11-13 14:32:26 +03:00
GCObject *gclist;
2002-08-05 21:36:24 +04:00
struct lua_longjmp *errorJmp; /* current error recover point */
2002-08-06 19:32:22 +04:00
ptrdiff_t errfunc; /* current error handling function (stack index) */
CallInfo base_ci; /* CallInfo for first level (C calling Lua) */
};
1997-11-19 20:31:19 +03:00
2005-07-09 17:22:34 +04:00
#define G(L) (L->l_G)
/*
** Union of all collectable objects
*/
union GCObject {
GCheader gch; /* common header */
union TString ts;
union Udata u;
union Closure cl;
struct Table h;
struct Proto p;
struct UpVal uv;
struct lua_State th; /* thread */
};
#define gch(o) (&(o)->gch)
2002-11-13 14:32:26 +03:00
/* macros to convert a GCObject into a specific value */
#define rawgco2ts(o) check_exp((o)->gch.tt == LUA_TSTRING, &((o)->ts))
#define gco2ts(o) (&rawgco2ts(o)->tsv)
#define rawgco2u(o) check_exp((o)->gch.tt == LUA_TUSERDATA, &((o)->u))
#define gco2u(o) (&rawgco2u(o)->uv)
#define gco2cl(o) check_exp((o)->gch.tt == LUA_TFUNCTION, &((o)->cl))
#define gco2t(o) check_exp((o)->gch.tt == LUA_TTABLE, &((o)->h))
#define gco2p(o) check_exp((o)->gch.tt == LUA_TPROTO, &((o)->p))
#define gco2uv(o) check_exp((o)->gch.tt == LUA_TUPVAL, &((o)->uv))
#define ngcotouv(o) check_exp((o)->gch.tt == LUA_TUPVAL, &((o)->uv))
#define gco2th(o) check_exp((o)->gch.tt == LUA_TTHREAD, &((o)->th))
2002-11-13 14:32:26 +03:00
/* macro to convert any Lua object into a GCObject */
#define obj2gco(v) (cast(GCObject *, (v)))
2002-11-13 14:32:26 +03:00
LUAI_FUNC void luaE_freethread (lua_State *L, lua_State *L1);
LUAI_FUNC CallInfo *luaE_extendCI (lua_State *L);
LUAI_FUNC void luaE_freeCI (lua_State *L);
1997-11-19 20:31:19 +03:00
#endif