/* Frame object implementation */

#include "Python.h"

#include "code.h"

#include "frameobject.h"

#include "opcode.h"

#include "structmember.h"

#undef MIN

#undef MAX

#define MIN(a, b) ((a) < (b) ? (a) : (b))

#define MAX(a, b) ((a) > (b) ? (a) : (b))

#define OFF(x) offsetof(PyFrameObject, x)

static PyMemberDef frame_memberlist[] = {

	{"f_back",	T_OBJECT,	OFF(f_back),	RO},

	{"f_code",	T_OBJECT,	OFF(f_code),	RO},

	{"f_builtins",	T_OBJECT,	OFF(f_builtins),RO},

	{"f_globals",	T_OBJECT,	OFF(f_globals),	RO},

	{"f_lasti",	T_INT,		OFF(f_lasti),	RO},

	{"f_exc_type",	T_OBJECT,	OFF(f_exc_type)},

	{"f_exc_value",	T_OBJECT,	OFF(f_exc_value)},

	{"f_exc_traceback", T_OBJECT,	OFF(f_exc_traceback)},

	{NULL}	/* Sentinel */

};

static PyObject *

frame_getlocals(PyFrameObject *f, void *closure)

{

	PyFrame_FastToLocals(f);

	Py_INCREF(f->f_locals);

	return f->f_locals;

}

static PyObject *

frame_getlineno(PyFrameObject *f, void *closure)

{

	int lineno;

	if (f->f_trace)

		lineno = f->f_lineno;

	else

		lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);

	return PyInt_FromLong(lineno);

}

/* Setter for f_lineno - you can set f_lineno from within a trace function in

 * order to jump to a given line of code, subject to some restrictions.	 Most

 * lines are OK to jump to because they don't make any assumptions about the

 * state of the stack (obvious because you could remove the line and the code

 * would still work without any stack errors), but there are some constructs

 * that limit jumping:

 *

 *  o Lines with an 'except' statement on them can't be jumped to, because

 *    they expect an exception to be on the top of the stack.

 *  o Lines that live in a 'finally' block can't be jumped from or to, since

 *    the END_FINALLY expects to clean up the stack after the 'try' block.

 *  o 'try'/'for'/'while' blocks can't be jumped into because the blockstack

 *    needs to be set up before their code runs, and for 'for' loops the

 *    iterator needs to be on the stack.

 */

static int

frame_setlineno(PyFrameObject *f, PyObject* p_new_lineno)

{

	int new_lineno = 0;		/* The new value of f_lineno */

	int new_lasti = 0;		/* The new value of f_lasti */

	int new_iblock = 0;		/* The new value of f_iblock */

	unsigned char *code = NULL;	/* The bytecode for the frame... */

	Py_ssize_t code_len = 0;	/* ...and its length */

	char *lnotab = NULL;		/* Iterating over co_lnotab */

	Py_ssize_t lnotab_len = 0;	/* (ditto) */

	int offset = 0;			/* (ditto) */

	int line = 0;			/* (ditto) */

	int addr = 0;			/* (ditto) */

	int min_addr = 0;		/* Scanning the SETUPs and POPs */

	int max_addr = 0;		/* (ditto) */

	int delta_iblock = 0;		/* (ditto) */

	int min_delta_iblock = 0;	/* (ditto) */

	int min_iblock = 0;		/* (ditto) */

	int f_lasti_setup_addr = 0;	/* Policing no-jump-into-finally */

	int new_lasti_setup_addr = 0;	/* (ditto) */

	int blockstack[CO_MAXBLOCKS];	/* Walking the 'finally' blocks */

	int in_finally[CO_MAXBLOCKS];	/* (ditto) */

	int blockstack_top = 0;		/* (ditto) */

	unsigned char setup_op = 0;	/* (ditto) */

	/* f_lineno must be an integer. */

	if (!PyInt_Check(p_new_lineno)) {

		PyErr_SetString(PyExc_ValueError,

				"lineno must be an integer");

		return -1;

	}

	/* You can only do this from within a trace function, not via

	 * _getframe or similar hackery. */

	if (!f->f_trace)

	{

		PyErr_Format(PyExc_ValueError,

			     "f_lineno can only be set by a trace function");

		return -1;

	}

	/* Fail if the line comes before the start of the code block. */

	new_lineno = (int) PyInt_AsLong(p_new_lineno);

	if (new_lineno < f->f_code->co_firstlineno) {

		PyErr_Format(PyExc_ValueError,

			     "line %d comes before the current code block",

			     new_lineno);

		return -1;

	}

	/* Find the bytecode offset for the start of the given line, or the

	 * first code-owning line after it. */

	PyString_AsStringAndSize(f->f_code->co_lnotab, &lnotab, &lnotab_len);

	addr = 0;

	line = f->f_code->co_firstlineno;

	new_lasti = -1;

	for (offset = 0; offset < lnotab_len; offset += 2) {

		addr += lnotab[offset];

		line += lnotab[offset+1];

		if (line >= new_lineno) {

			new_lasti = addr;

			new_lineno = line;

			break;

		}

	}

	/* If we didn't reach the requested line, return an error. */

	if (new_lasti == -1) {

		PyErr_Format(PyExc_ValueError,

			     "line %d comes after the current code block",

			     new_lineno);

		return -1;

	}

	/* We're now ready to look at the bytecode. */

	PyString_AsStringAndSize(f->f_code->co_code, (char **)&code, &code_len);

	min_addr = MIN(new_lasti, f->f_lasti);

	max_addr = MAX(new_lasti, f->f_lasti);

	/* You can't jump onto a line with an 'except' statement on it -

	 * they expect to have an exception on the top of the stack, which

	 * won't be true if you jump to them.  They always start with code

	 * that either pops the exception using POP_TOP (plain 'except:'

	 * lines do this) or duplicates the exception on the stack using

	 * DUP_TOP (if there's an exception type specified).  See compile.c,

	 * 'com_try_except' for the full details.  There aren't any other

	 * cases (AFAIK) where a line's code can start with DUP_TOP or

	 * POP_TOP, but if any ever appear, they'll be subject to the same

	 * restriction (but with a different error message). */

	if (code[new_lasti] == DUP_TOP || code[new_lasti] == POP_TOP) {

		PyErr_SetString(PyExc_ValueError,

		    "can't jump to 'except' line as there's no exception");

		return -1;

	}

	/* You can't jump into or out of a 'finally' block because the 'try'

	 * block leaves something on the stack for the END_FINALLY to clean

	 * up.	So we walk the bytecode, maintaining a simulated blockstack.

	 * When we reach the old or new address and it's in a 'finally' block

	 * we note the address of the corresponding SETUP_FINALLY.  The jump

	 * is only legal if neither address is in a 'finally' block or

	 * they're both in the same one.  'blockstack' is a stack of the

	 * bytecode addresses of the SETUP_X opcodes, and 'in_finally' tracks

	 * whether we're in a 'finally' block at each blockstack level. */

	f_lasti_setup_addr = -1;

	new_lasti_setup_addr = -1;

	memset(blockstack, '\0', sizeof(blockstack));

	memset(in_finally, '\0', sizeof(in_finally));

	blockstack_top = 0;

	for (addr = 0; addr < code_len; addr++) {

		unsigned char op = code[addr];

		switch (op) {

		case SETUP_LOOP:

		case SETUP_EXCEPT:

		case SETUP_FINALLY:

			blockstack[blockstack_top++] = addr;

			in_finally[blockstack_top-1] = 0;

			break;

		case POP_BLOCK:

			assert(blockstack_top > 0);

			setup_op = code[blockstack[blockstack_top-1]];

			if (setup_op == SETUP_FINALLY) {

				in_finally[blockstack_top-1] = 1;

			}

			else {

				blockstack_top--;

			}

			break;

		case END_FINALLY:

			/* Ignore END_FINALLYs for SETUP_EXCEPTs - they exist

			 * in the bytecode but don't correspond to an actual

			 * 'finally' block.  (If blockstack_top is 0, we must

			 * be seeing such an END_FINALLY.) */

			if (blockstack_top > 0) {

				setup_op = code[blockstack[blockstack_top-1]];

				if (setup_op == SETUP_FINALLY) {

					blockstack_top--;

				}

			}

			break;

		}

		/* For the addresses we're interested in, see whether they're

		 * within a 'finally' block and if so, remember the address

		 * of the SETUP_FINALLY. */

		if (addr == new_lasti || addr == f->f_lasti) {

			int i = 0;

			int setup_addr = -1;

			for (i = blockstack_top-1; i >= 0; i--) {

				if (in_finally[i]) {

					setup_addr = blockstack[i];

					break;

				}

			}

			if (setup_addr != -1) {

				if (addr == new_lasti) {

					new_lasti_setup_addr = setup_addr;

				}

				if (addr == f->f_lasti) {

					f_lasti_setup_addr = setup_addr;

				}

			}

		}

		if (op >= HAVE_ARGUMENT) {

			addr += 2;

		}

	}

	/* Verify that the blockstack tracking code didn't get lost. */

	assert(blockstack_top == 0);

	/* After all that, are we jumping into / out of a 'finally' block? */

	if (new_lasti_setup_addr != f_lasti_setup_addr) {

		PyErr_SetString(PyExc_ValueError,

			    "can't jump into or out of a 'finally' block");

		return -1;

	}

	/* Police block-jumping (you can't jump into the middle of a block)

	 * and ensure that the blockstack finishes up in a sensible state (by

	 * popping any blocks we're jumping out of).  We look at all the

	 * blockstack operations between the current position and the new

	 * one, and keep track of how many blocks we drop out of on the way.

	 * By also keeping track of the lowest blockstack position we see, we

	 * can tell whether the jump goes into any blocks without coming out

	 * again - in that case we raise an exception below. */

	delta_iblock = 0;

	for (addr = min_addr; addr < max_addr; addr++) {

		unsigned char op = code[addr];

		switch (op) {

		case SETUP_LOOP:

		case SETUP_EXCEPT:

		case SETUP_FINALLY:

			delta_iblock++;

			break;

		case POP_BLOCK:

			delta_iblock--;

			break;

		}

		min_delta_iblock = MIN(min_delta_iblock, delta_iblock);

		if (op >= HAVE_ARGUMENT) {

			addr += 2;

		}

	}

	/* Derive the absolute iblock values from the deltas. */

	min_iblock = f->f_iblock + min_delta_iblock;

	if (new_lasti > f->f_lasti) {

		/* Forwards jump. */

		new_iblock = f->f_iblock + delta_iblock;

	}

	else {

		/* Backwards jump. */

		new_iblock = f->f_iblock - delta_iblock;

	}

	/* Are we jumping into a block? */

	if (new_iblock > min_iblock) {

		PyErr_SetString(PyExc_ValueError,

				"can't jump into the middle of a block");

		return -1;

	}

	/* Pop any blocks that we're jumping out of. */

	while (f->f_iblock > new_iblock) {

		PyTryBlock *b = &f->f_blockstack[--f->f_iblock];

		while ((f->f_stacktop - f->f_valuestack) > b->b_level) {

			PyObject *v = (*--f->f_stacktop);

			Py_DECREF(v);

		}

	}

	/* Finally set the new f_lineno and f_lasti and return OK. */

	f->f_lineno = new_lineno;

	f->f_lasti = new_lasti;

	return 0;

}

static PyObject *

frame_gettrace(PyFrameObject *f, void *closure)

{

	PyObject* trace = f->f_trace;

	if (trace == NULL)

		trace = Py_None;

	Py_INCREF(trace);

	return trace;

}

static int

frame_settrace(PyFrameObject *f, PyObject* v, void *closure)

{

	/* We rely on f_lineno being accurate when f_trace is set. */

	PyObject* old_value = f->f_trace;

	Py_XINCREF(v);

	f->f_trace = v;

	if (v != NULL)

		f->f_lineno = PyCode_Addr2Line(f->f_code, f->f_lasti);

	Py_XDECREF(old_value);

	return 0;

}

static PyObject *

frame_getrestricted(PyFrameObject *f, void *closure)

{

	return PyBool_FromLong(PyFrame_IsRestricted(f));

}

static PyGetSetDef frame_getsetlist[] = {

	{"f_locals",	(getter)frame_getlocals, NULL, NULL},

	{"f_lineno",	(getter)frame_getlineno,

			(setter)frame_setlineno, NULL},

	{"f_trace",	(getter)frame_gettrace, (setter)frame_settrace, NULL},

	{"f_restricted",(getter)frame_getrestricted,NULL, NULL},

	{0}

};

/* Stack frames are allocated and deallocated at a considerable rate.

   In an attempt to improve the speed of function calls, we:

   1. Hold a single "zombie" frame on each code object. This retains

   the allocated and initialised frame object from an invocation of

   the code object. The zombie is reanimated the next time we need a

   frame object for that code object. Doing this saves the malloc/

   realloc required when using a free_list frame that isn't the

   correct size. It also saves some field initialisation.

   In zombie mode, no field of PyFrameObject holds a reference, but

   the following fields are still valid:

     * ob_type, ob_size, f_code, f_valuestack;

     * f_locals, f_trace,

       f_exc_type, f_exc_value, f_exc_traceback are NULL;

     * f_localsplus does not require re-allocation and

       the local variables in f_localsplus are NULL.

   2. We also maintain a separate free list of stack frames (just like

   integers are allocated in a special way -- see intobject.c).  When

   a stack frame is on the free list, only the following members have

   a meaning:

	ob_type		== &Frametype

	f_back		next item on free list, or NULL

	f_stacksize	size of value stack

	ob_size		size of localsplus

   Note that the value and block stacks are preserved -- this can save

   another malloc() call or two (and two free() calls as well!).

   Also note that, unlike for integers, each frame object is a

   malloc'ed object in its own right -- it is only the actual calls to

   malloc() that we are trying to save here, not the administration.

   After all, while a typical program may make millions of calls, a

   call depth of more than 20 or 30 is probably already exceptional

   unless the program contains run-away recursion.  I hope.

   Later, PyFrame_MAXFREELIST was added to bound the # of frames saved on

   free_list.  Else programs creating lots of cyclic trash involving

   frames could provoke free_list into growing without bound.

*/

static PyFrameObject *free_list = NULL;

static int numfree = 0;		/* number of frames currently in free_list */

/* max value for numfree */

#define PyFrame_MAXFREELIST 200	

static void

frame_dealloc(PyFrameObject *f)

{

	PyObject **p, **valuestack;

	PyCodeObject *co;

	PyObject_GC_UnTrack(f);

	Py_TRASHCAN_SAFE_BEGIN(f)

	/* Kill all local variables */

	valuestack = f->f_valuestack;

	for (p = f->f_localsplus; p < valuestack; p++)

		Py_CLEAR(*p);

	/* Free stack */

	if (f->f_stacktop != NULL) {

		for (p = valuestack; p < f->f_stacktop; p++)

			Py_XDECREF(*p);

	}

	Py_XDECREF(f->f_back);

	Py_DECREF(f->f_builtins);

	Py_DECREF(f->f_globals);

	Py_CLEAR(f->f_locals);

	Py_CLEAR(f->f_trace);

	Py_CLEAR(f->f_exc_type);

	Py_CLEAR(f->f_exc_value);

	Py_CLEAR(f->f_exc_traceback);

	co = f->f_code;

	if (co->co_zombieframe == NULL)

		co->co_zombieframe = f;

	else if (numfree < PyFrame_MAXFREELIST) {

		++numfree;

		f->f_back = free_list;

		free_list = f;

	}

	else 

		PyObject_GC_Del(f);

	Py_DECREF(co);

	Py_TRASHCAN_SAFE_END(f)

}

static int

frame_traverse(PyFrameObject *f, visitproc visit, void *arg)

{

	PyObject **fastlocals, **p;

	int i, slots;

	Py_VISIT(f->f_back);

	Py_VISIT(f->f_code);

	Py_VISIT(f->f_builtins);

	Py_VISIT(f->f_globals);

	Py_VISIT(f->f_locals);

	Py_VISIT(f->f_trace);

	Py_VISIT(f->f_exc_type);

	Py_VISIT(f->f_exc_value);

	Py_VISIT(f->f_exc_traceback);

	/* locals */

	slots = f->f_code->co_nlocals + PyTuple_GET_SIZE(f->f_code->co_cellvars) + PyTuple_GET_SIZE(f->f_code->co_freevars);

	fastlocals = f->f_localsplus;

	for (i = slots; --i >= 0; ++fastlocals)

		Py_VISIT(*fastlocals);

	/* stack */

	if (f->f_stacktop != NULL) {

		for (p = f->f_valuestack; p < f->f_stacktop; p++)

			Py_VISIT(*p);

	}

	return 0;

}

static void

frame_clear(PyFrameObject *f)

{

	PyObject **fastlocals, **p, **oldtop;

	int i, slots;

	/* Before anything else, make sure that this frame is clearly marked

	 * as being defunct!  Else, e.g., a generator reachable from this

	 * frame may also point to this frame, believe itself to still be

	 * active, and try cleaning up this frame again.

	 */

	oldtop = f->f_stacktop;

	f->f_stacktop = NULL;

	Py_CLEAR(f->f_exc_type);

	Py_CLEAR(f->f_exc_value);

	Py_CLEAR(f->f_exc_traceback);

	Py_CLEAR(f->f_trace);

	/* locals */

	slots = f->f_code->co_nlocals + PyTuple_GET_SIZE(f->f_code->co_cellvars) + PyTuple_GET_SIZE(f->f_code->co_freevars);

	fastlocals = f->f_localsplus;

	for (i = slots; --i >= 0; ++fastlocals)

		Py_CLEAR(*fastlocals);

	/* stack */

	if (oldtop != NULL) {

		for (p = f->f_valuestack; p < oldtop; p++)

			Py_CLEAR(*p);

	}

}

static PyObject *

frame_sizeof(PyFrameObject *f)

{

	Py_ssize_t res, extras, ncells, nfrees;

	ncells = PyTuple_GET_SIZE(f->f_code->co_cellvars);

	nfrees = PyTuple_GET_SIZE(f->f_code->co_freevars);

	extras = f->f_code->co_stacksize + f->f_code->co_nlocals +

		 ncells + nfrees;

	/* subtract one as it is already included in PyFrameObject */

	res = sizeof(PyFrameObject) + (extras-1) * sizeof(PyObject *);

	return PyInt_FromSsize_t(res);

}

PyDoc_STRVAR(sizeof__doc__,

"F.__sizeof__() -> size of F in memory, in bytes");