lgc.h File Reference

#include "lobject.h"

Go to the source code of this file.

Macros
#define	GCSpause   0
#define	GCSpropagate   1
#define	GCSsweepstring   2
#define	GCSsweep   3
#define	GCSfinalize   4
#define	resetbits(x, m)   ((x) &= cast(lu_byte, ~(m)))
#define	setbits(x, m)   ((x) |= (m))
#define	testbits(x, m)   ((x) & (m))
#define	bitmask(b)   (1<<(b))
#define	bit2mask(b1, b2)   (bitmask(b1) | bitmask(b2))
#define	l_setbit(x, b)   setbits(x, bitmask(b))
#define	resetbit(x, b)   resetbits(x, bitmask(b))
#define	testbit(x, b)   testbits(x, bitmask(b))
#define	set2bits(x, b1, b2)   setbits(x, (bit2mask(b1, b2)))
#define	reset2bits(x, b1, b2)   resetbits(x, (bit2mask(b1, b2)))
#define	test2bits(x, b1, b2)   testbits(x, (bit2mask(b1, b2)))
#define	WHITE0BIT   0
#define	WHITE1BIT   1
#define	BLACKBIT   2
#define	FINALIZEDBIT   3
#define	KEYWEAKBIT   3
#define	VALUEWEAKBIT   4
#define	FIXEDBIT   5
#define	SFIXEDBIT   6
#define	WHITEBITS   bit2mask(WHITE0BIT, WHITE1BIT)
#define	iswhite(x)   test2bits((x)->gch.marked, WHITE0BIT, WHITE1BIT)
#define	isblack(x)   testbit((x)->gch.marked, BLACKBIT)
#define	isgray(x)   (!isblack(x) && !iswhite(x))
#define	otherwhite(g)   (g->currentwhite ^ WHITEBITS)
#define	isdead(g, v)   ((v)->gch.marked & otherwhite(g) & WHITEBITS)
#define	changewhite(x)   ((x)->gch.marked ^= WHITEBITS)
#define	gray2black(x)   l_setbit((x)->gch.marked, BLACKBIT)
#define	valiswhite(x)   (iscollectable(x) && iswhite(gcvalue(x)))
#define	luaC_white(g)   cast(lu_byte, (g)->currentwhite & WHITEBITS)
#define	luaC_checkGC(L)
#define	luaC_barrier(L, p, v)
#define	luaC_barriert(L, t, v)
#define	luaC_objbarrier(L, p, o)
#define	luaC_objbarriert(L, t, o)    { if (iswhite(obj2gco(o)) && isblack(obj2gco(t))) luaC_barrierback(L,t); }

Functions
LUAI_FUNC size_t	luaC_separateudata (lua_State *L, int all)
LUAI_FUNC void	luaC_callGCTM (lua_State *L)
LUAI_FUNC void	luaC_freeall (lua_State *L)
LUAI_FUNC void	luaC_step (lua_State *L)
LUAI_FUNC void	luaC_fullgc (lua_State *L)
LUAI_FUNC void	luaC_link (lua_State *L, GCObject *o, lu_byte tt)
LUAI_FUNC void	luaC_linkupval (lua_State *L, UpVal *uv)
LUAI_FUNC void	luaC_barrierf (lua_State *L, GCObject *o, GCObject *v)
LUAI_FUNC void	luaC_barrierback (lua_State *L, Table *t)

Macro Definition Documentation

bit2mask

#define bit2mask	(		b1,
			b2 )   (bitmask(b1) | bitmask(b2))

Definition at line 31 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate().

bitmask

#define bitmask

(

b

)

(1<<(b))

Definition at line 30 of file lua-5.1.5/src/lgc.h.

Referenced by entergen(), fullinc(), generationalcollection(), lua_newstate(), luaC_changemode(), luaC_freeall(), luaC_fullgc(), luaS_resize(), stepgenfull(), sweeplist(), and sweeplist().

BLACKBIT

#define BLACKBIT   2

Definition at line 56 of file lua-5.1.5/src/lgc.h.

changewhite

#define changewhite

(

x

)

((x)->gch.marked ^= WHITEBITS)

Definition at line 72 of file lua-5.1.5/src/lgc.h.

Referenced by internshrstr(), internshrstr(), internshrstr(), luaF_findupval(), and luaS_newlstr().

FINALIZEDBIT

#define FINALIZEDBIT   3

Definition at line 57 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_checkfinalizer(), separatetobefnz(), udata2finalize(), and udata2finalize().

FIXEDBIT

#define FIXEDBIT   5

Definition at line 60 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate(), and sweeplist().

GCSfinalize

#define GCSfinalize   4

Definition at line 21 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_barrierback(), luaC_barrierf(), luaC_fullgc(), luaC_linkupval(), and singlestep().

GCSpause

#define GCSpause   0

Definition at line 17 of file lua-5.1.5/src/lgc.h.

Referenced by entergen(), enterinc(), fullinc(), generationalcollection(), incstep(), incstep(), lua_gc(), lua_gc(), lua_newstate(), luaC_barrier_(), luaC_barrierback(), luaC_barrierf(), luaC_forcestep(), luaC_fullgc(), luaC_fullgc(), luaC_linkupval(), luaC_step(), singlestep(), singlestep(), singlestep(), singlestep(), and stepgenfull().

GCSpropagate

#define GCSpropagate   1

Definition at line 18 of file lua-5.1.5/src/lgc.h.

Referenced by entergen(), finishgencycle(), generationalcollection(), luaC_barrierf(), luaC_changemode(), luaC_fullgc(), luaC_fullgc(), luaC_linkupval(), markroot(), singlestep(), singlestep(), singlestep(), singlestep(), stepgenfull(), traverseephemeron(), traverseephemeron(), traversethread(), traverseweakvalue(), and youngcollection().

GCSsweep

#define GCSsweep   3

Definition at line 20 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_fullgc(), singlestep(), and singlestep().

GCSsweepstring

#define GCSsweepstring   2

Definition at line 19 of file lua-5.1.5/src/lgc.h.

Referenced by atomic(), entersweep(), luaC_fullgc(), luaS_resize(), singlestep(), and singlestep().

gray2black

#define gray2black

(

x

)

l_setbit((x)->gch.marked, BLACKBIT)

Definition at line 73 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_checkupvalcolor(), luaC_linkupval(), propagatemark(), propagatemark(), propagatemark(), reallymarkobject(), reallymarkobject(), and reallymarkobject().

isblack

#define isblack

(

x

)

testbit((x)->gch.marked, BLACKBIT)

Definition at line 66 of file lua-5.1.5/src/lgc.h.

Referenced by genlink(), luaC_barrier_(), luaC_barrierback(), luaC_barrierback_(), luaC_barrierback_(), luaC_barrierf(), luaC_barrierproto_(), luaC_checkupvalcolor(), luaF_close(), markold(), pushclosure(), and remarkupvals().

isdead

#define isdead	(		g,
			v )   ((v)->gch.marked & otherwhite(g) & WHITEBITS)

Definition at line 70 of file lua-5.1.5/src/lgc.h.

Referenced by internshrstr(), internshrstr(), internshrstr(), luaC_barrier_(), luaC_barrierback(), luaC_barrierback_(), luaC_barrierback_(), luaC_barrierf(), luaF_close(), luaF_findupval(), luaS_newlstr(), reallymarkobject(), sweep2old(), sweepgen(), and sweeplist().

isgray

#define isgray

(

x

)

(!isblack(x) && !iswhite(x))

Definition at line 67 of file lua-5.1.5/src/lgc.h.

Referenced by correctgraylist(), linkgclist_(), luaC_checkupvalcolor(), luaC_linkupval(), propagatemark(), propagatemark(), propagatemark(), remarkupvals(), remarkupvals(), remarkupvals(), and remarkupvals().

iswhite

#define iswhite

(

x

)

test2bits((x)->gch.marked, WHITE0BIT, WHITE1BIT)

Definition at line 65 of file lua-5.1.5/src/lgc.h.

Referenced by adjust_varargs(), atomic(), atomic(), atomic(), atomic(), correctgraylist(), iscleared(), iscleared(), iscleared(), iscleared(), lua_pushcclosure(), luaC_barrier_(), luaC_barrierf(), luaC_separateudata(), luaE_newthread(), luaF_closeupval(), luaS_clearcache(), luaY_parser(), markold(), reallymarkobject(), remarkupvals(), separatetobefnz(), separatetobefnz(), separatetobefnz(), sweep2old(), sweepgen(), traverseproto(), and traverseproto().

KEYWEAKBIT

#define KEYWEAKBIT   3

Definition at line 58 of file lua-5.1.5/src/lgc.h.

Referenced by cleartable(), and traversetable().

l_setbit

#define l_setbit	(		x,
			b )   setbits(x, bitmask(b))

Definition at line 32 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_checkfinalizer(), and separatetobefnz().

luaC_barrier

#define luaC_barrier	(		L,
			p,
			v )

Value:

    { if (valiswhite(v) && isblack(obj2gco(p)))  \
    luaC_barrierf(L,obj2gco(p),gcvalue(v)); }

Definition at line 86 of file lua-5.1.5/src/lgc.h.

#define luaC_barrier(L,p,v) { if (valiswhite(v) && isblack(obj2gco(p)))  \
    luaC_barrierf(L,obj2gco(p),gcvalue(v)); }

Referenced by addk(), addk(), addk(), addk(), lua_copy(), lua_load(), lua_replace(), lua_setupvalue(), lua_setuservalue(), luaC_linkupval(), luaF_closeupval(), luaV_execute(), luaV_execute(), luaV_execute(), and moveto().

luaC_barriert

#define luaC_barriert	(		L,
			t,
			v )

Value:

    { if (valiswhite(v) && isblack(obj2gco(t)))  \
    luaC_barrierback(L,t); }

Definition at line 89 of file lua-5.1.5/src/lgc.h.

#define luaC_barriert(L,t,v) { if (valiswhite(v) && isblack(obj2gco(t)))  \
    luaC_barrierback(L,t); }

Referenced by lua_rawset(), lua_rawseti(), luaV_execute(), luaV_settable(), and newkey().

luaC_checkGC

#define luaC_checkGC

(

L

)

Value:

  { \
  condhardstacktests(luaD_reallocstack(L, L->stacksize - EXTRA_STACK - 1)); \
  if (G(L)->totalbytes >= G(L)->GCthreshold) \
    luaC_step(L); }

Definition at line 80 of file lua-5.1.5/src/lgc.h.

#define luaC_checkGC(L) { \
  condhardstacktests(luaD_reallocstack(L, L->stacksize - EXTRA_STACK - 1)); \
  if (G(L)->totalbytes >= G(L)->GCthreshold) \
    luaC_step(L); }

Referenced by adjust_varargs(), close_func(), close_func(), close_func(), f_parser(), lua_concat(), lua_createtable(), lua_gc(), lua_gc(), lua_newthread(), lua_newuserdata(), lua_newuserdatauv(), lua_pushcclosure(), lua_pushfstring(), lua_pushlstring(), lua_pushstring(), lua_pushvfstring(), lua_tolstring(), luaD_call(), luaD_precall(), luaG_runerror(), luaV_execute(), and luaX_newstring().

luaC_objbarrier

#define luaC_objbarrier	(		L,
			p,
			o )

Value:

    { if (iswhite(obj2gco(o)) && isblack(obj2gco(p))) \
        luaC_barrierf(L,obj2gco(p),obj2gco(o)); }

Definition at line 92 of file lua-5.1.5/src/lgc.h.

#define luaC_objbarrier(L,p,o)  \
    { if (iswhite(obj2gco(o)) && isblack(obj2gco(p))) \
        luaC_barrierf(L,obj2gco(p),obj2gco(o)); }

Referenced by addprototype(), addprototype(), addprototype(), f_parser(), indexupvalue(), LoadProtos(), loadProtos(), LoadString(), loadStringN(), lua_setfenv(), lua_setmetatable(), lua_setuservalue(), lua_upvaluejoin(), luaC_barrierproto_(), luaF_initupvals(), luaU_undump(), luaY_parser(), mainfunc(), mainfunc(), newupvalue(), newupvalue(), newupvalue(), open_func(), open_func(), pushclosure(), pushclosure(), registerlocalvar(), registerlocalvar(), registerlocalvar(), and registerlocalvar().

luaC_objbarriert

#define luaC_objbarriert	(		L,
			t,
			o )    { if (iswhite(obj2gco(o)) && isblack(obj2gco(t))) luaC_barrierback(L,t); }

Definition at line 96 of file lua-5.1.5/src/lgc.h.

#define luaC_objbarriert(L,t,o)  \
   { if (iswhite(obj2gco(o)) && isblack(obj2gco(t))) luaC_barrierback(L,t); }

Referenced by lua_setmetatable().

luaC_white

#define luaC_white

(

g

)

cast(lu_byte, (g)->currentwhite & WHITEBITS)

Definition at line 77 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate(), lua_newthread(), luaC_link(), luaC_newobj(), luaC_newobj(), luaF_findupval(), luaS_newudata(), newlstr(), sweepgen(), sweeplist(), sweeplist(), sweeplist(), and whitelist().

otherwhite

#define otherwhite

(

g

)

(g->currentwhite ^ WHITEBITS)

Definition at line 69 of file lua-5.1.5/src/lgc.h.

Referenced by atomic(), atomic(), atomic(), atomic(), sweeplist(), sweeplist(), sweeplist(), and sweeplist().

reset2bits

#define reset2bits	(		x,
			b1,
			b2 )   resetbits(x, (bit2mask(b1, b2)))

Definition at line 36 of file lua-5.1.5/src/lgc.h.

resetbit

#define resetbit	(		x,
			b )   resetbits(x, bitmask(b))

Definition at line 33 of file lua-5.1.5/src/lgc.h.

Referenced by udata2finalize(), udata2finalize(), and udata2finalize().

resetbits

#define resetbits	(		x,
			m )   ((x) &= cast(lu_byte, ~(m)))

Definition at line 27 of file lua-5.1.5/src/lgc.h.

set2bits

#define set2bits	(		x,
			b1,
			b2 )   setbits(x, (bit2mask(b1, b2)))

Definition at line 35 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate().

setbits

#define setbits	(		x,
			m )   ((x) |= (m))

Definition at line 28 of file lua-5.1.5/src/lgc.h.

SFIXEDBIT

#define SFIXEDBIT   6

Definition at line 61 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate(), luaC_freeall(), and sweeplist().

test2bits

#define test2bits	(		x,
			b1,
			b2 )   testbits(x, (bit2mask(b1, b2)))

Definition at line 37 of file lua-5.1.5/src/lgc.h.

testbit

#define testbit	(		x,
			b )   testbits(x, bitmask(b))

Definition at line 34 of file lua-5.1.5/src/lgc.h.

Referenced by cleartable(), luaC_checkfinalizer(), luaC_runtilstate(), separatetobefnz(), and sweeplist().

testbits

#define testbits	(		x,
			m )   ((x) & (m))

Definition at line 29 of file lua-5.1.5/src/lgc.h.

Referenced by sweeplist().

valiswhite

#define valiswhite

(

x

)

(iscollectable(x) && iswhite(gcvalue(x)))

Definition at line 75 of file lua-5.1.5/src/lgc.h.

Referenced by removeentry(), and traverseephemeron().

VALUEWEAKBIT

#define VALUEWEAKBIT   4

Definition at line 59 of file lua-5.1.5/src/lgc.h.

Referenced by cleartable(), and traversetable().

WHITE0BIT

#define WHITE0BIT   0

Definition at line 54 of file lua-5.1.5/src/lgc.h.

Referenced by lua_newstate().

WHITE1BIT

#define WHITE1BIT   1

Definition at line 55 of file lua-5.1.5/src/lgc.h.

WHITEBITS

#define WHITEBITS   bit2mask(WHITE0BIT, WHITE1BIT)

Definition at line 62 of file lua-5.1.5/src/lgc.h.

Referenced by luaC_freeall(), luaC_freeallobjects(), and sweeplist().

Function Documentation

luaC_barrierback()

LUAI_FUNC void luaC_barrierback	(	lua_State *	L,
		Table *	t )

Definition at line 674 of file lua-5.1.5/src/lgc.c.

                                               {
  global_State *g = G(L);
  GCObject *o = obj2gco(t);
  lua_assert(isblack(o) && !isdead(g, o));
  lua_assert(g->gcstate != GCSfinalize && g->gcstate != GCSpause);
  black2gray(o);  /* make table gray (again) */
  t->gclist = g->grayagain;
  g->grayagain = o;
}

References black2gray, G, Table::gclist, GCSfinalize, GCSpause, global_State::gcstate, global_State::grayagain, isblack, isdead, lua_assert, and obj2gco.

luaC_barrierf()

LUAI_FUNC void luaC_barrierf	(	lua_State *	L,
		GCObject *	o,
		GCObject *	v )

Definition at line 661 of file lua-5.1.5/src/lgc.c.

                                                            {
  global_State *g = G(L);
  lua_assert(isblack(o) && iswhite(v) && !isdead(g, v) && !isdead(g, o));
  lua_assert(g->gcstate != GCSfinalize && g->gcstate != GCSpause);
  lua_assert(ttype(&o->gch) != LUA_TTABLE);
  /* must keep invariant? */
  if (g->gcstate == GCSpropagate)
    reallymarkobject(g, v);  /* restore invariant */
  else  /* don't mind */
    makewhite(g, o);  /* mark as white just to avoid other barriers */
}

References G, GCObject::gch, GCSfinalize, GCSpause, GCSpropagate, global_State::gcstate, isblack, isdead, iswhite, lua_assert, LUA_TTABLE, makewhite, reallymarkobject(), and ttype.

luaC_callGCTM()

LUAI_FUNC void luaC_callGCTM

(

lua_State *

L

)

Definition at line 477 of file lua-5.1.5/src/lgc.c.

                                  {
  while (G(L)->tmudata)
    GCTM(L);
}

References G, and GCTM().

Referenced by callallgcTM().

luaC_freeall()

LUAI_FUNC void luaC_freeall

(

lua_State *

L

)

Definition at line 483 of file lua-5.1.5/src/lgc.c.

                                 {
  global_State *g = G(L);
  int i;
  g->currentwhite = WHITEBITS | bitmask(SFIXEDBIT);  /* mask to collect all elements */
  sweepwholelist(L, &g->rootgc);
  for (i = 0; i < g->strt.size; i++)  /* free all string lists */
    sweepwholelist(L, &g->strt.hash[i]);
}

References bitmask, global_State::currentwhite, G, stringtable::hash, global_State::rootgc, SFIXEDBIT, stringtable::size, global_State::strt, sweepwholelist, and WHITEBITS.

Referenced by close_state().

luaC_fullgc()

LUAI_FUNC void luaC_fullgc

(

lua_State *

L

)

Definition at line 635 of file lua-5.1.5/src/lgc.c.

                                {
  global_State *g = G(L);
  if (g->gcstate <= GCSpropagate) {
    /* reset sweep marks to sweep all elements (returning them to white) */
    g->sweepstrgc = 0;
    g->sweepgc = &g->rootgc;
    /* reset other collector lists */
    g->gray = NULL;
    g->grayagain = NULL;
    g->weak = NULL;
    g->gcstate = GCSsweepstring;
  }
  lua_assert(g->gcstate != GCSpause && g->gcstate != GCSpropagate);
  /* finish any pending sweep phase */
  while (g->gcstate != GCSfinalize) {
    lua_assert(g->gcstate == GCSsweepstring || g->gcstate == GCSsweep);
    singlestep(L);
  }
  markroot(L);
  while (g->gcstate != GCSpause) {
    singlestep(L);
  }
  setthreshold(g);
}

References G, GCSfinalize, GCSpause, GCSpropagate, GCSsweep, GCSsweepstring, global_State::gcstate, global_State::gray, global_State::grayagain, lua_assert, markroot(), NULL, global_State::rootgc, setthreshold, singlestep(), global_State::sweepgc, global_State::sweepstrgc, and global_State::weak.

Referenced by growstrtab(), lua_gc(), lua_gc(), luaM_realloc_(), and tryagain().

luaC_link()

LUAI_FUNC void luaC_link	(	lua_State *	L,
		GCObject *	o,
		lu_byte	tt )

Definition at line 685 of file lua-5.1.5/src/lgc.c.

                                                       {
  global_State *g = G(L);
  o->gch.next = g->rootgc;
  g->rootgc = o;
  o->gch.marked = luaC_white(g);
  o->gch.tt = tt;
}

References G, GCObject::gch, luaC_white, and global_State::rootgc.

Referenced by luaE_newthread(), luaF_newCclosure(), luaF_newLclosure(), luaF_newproto(), luaF_newupval(), and luaH_new().

luaC_linkupval()

LUAI_FUNC void luaC_linkupval	(	lua_State *	L,
		UpVal *	uv )

Definition at line 694 of file lua-5.1.5/src/lgc.c.

                                              {
  global_State *g = G(L);
  GCObject *o = obj2gco(uv);
  o->gch.next = g->rootgc;  /* link upvalue into `rootgc' list */
  g->rootgc = o;
  if (isgray(o)) { 
    if (g->gcstate == GCSpropagate) {
      gray2black(o);  /* closed upvalues need barrier */
      luaC_barrier(L, uv, uv->v);
    }
    else {  /* sweep phase: sweep it (turning it into white) */
      makewhite(g, o);
      lua_assert(g->gcstate != GCSfinalize && g->gcstate != GCSpause);
    }
  }
}

References G, GCObject::gch, GCSfinalize, GCSpause, GCSpropagate, global_State::gcstate, gray2black, isgray, lua_assert, luaC_barrier, makewhite, obj2gco, global_State::rootgc, and UpVal::v.

Referenced by luaF_close().

luaC_separateudata()

LUAI_FUNC size_t luaC_separateudata	(	lua_State *	L,
		int	all )

Definition at line 128 of file lua-5.1.5/src/lgc.c.

                                                  {
  global_State *g = G(L);
  size_t deadmem = 0;
  GCObject **p = &g->mainthread->next;
  GCObject *curr;
  while ((curr = *p) != NULL) {
    if (!(iswhite(curr) || all) || isfinalized(gco2u(curr)))
      p = &curr->gch.next;  /* don't bother with them */
    else if (fasttm(L, gco2u(curr)->metatable, TM_GC) == NULL) {
      markfinalized(gco2u(curr));  /* don't need finalization */
      p = &curr->gch.next;
    }
    else {  /* must call its gc method */
      deadmem += sizeudata(gco2u(curr));
      markfinalized(gco2u(curr));
      *p = curr->gch.next;
      /* link `curr' at the end of `tmudata' list */
      if (g->tmudata == NULL)  /* list is empty? */
        g->tmudata = curr->gch.next = curr;  /* creates a circular list */
      else {
        curr->gch.next = g->tmudata->gch.next;
        g->tmudata->gch.next = curr;
        g->tmudata = curr;
      }
    }
  }
  return deadmem;
}

References fasttm, G, GCObject::gch, gco2u, isfinalized, iswhite, global_State::mainthread, markfinalized, NULL, sizeudata, TM_GC, and global_State::tmudata.

Referenced by atomic(), and lua_close().

luaC_step()

LUAI_FUNC void luaC_step

(

lua_State *

L

)

Definition at line 610 of file lua-5.1.5/src/lgc.c.

                              {
  global_State *g = G(L);
  l_mem lim = (GCSTEPSIZE/100) * g->gcstepmul;
  if (lim == 0)
    lim = (MAX_LUMEM-1)/2;  /* no limit */
  g->gcdept += g->totalbytes - g->GCthreshold;
  do {
    lim -= singlestep(L);
    if (g->gcstate == GCSpause)
      break;
  } while (lim > 0);
  if (g->gcstate != GCSpause) {
    if (g->gcdept < GCSTEPSIZE)
      g->GCthreshold = g->totalbytes + GCSTEPSIZE;  /* - lim/g->gcstepmul;*/
    else {
      g->gcdept -= GCSTEPSIZE;
      g->GCthreshold = g->totalbytes;
    }
  }
  else {
    setthreshold(g);
  }
}