X-Git-Url: http://git.hcoop.net/bpt/guile.git/blobdiff_plain/bb06fceef02a20ce42b069192eb45ddd9012e5ab..8cb0d6d7fa9aaac316c29a64c541336b51b6f93d:/libguile/frames.h diff --git a/libguile/frames.h b/libguile/frames.h dissimilarity index 79% index 836763700..eaed79d43 100644 --- a/libguile/frames.h +++ b/libguile/frames.h @@ -1,146 +1,151 @@ -/* Copyright (C) 2001 Free Software Foundation, Inc. - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2, or (at your option) - * any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this software; see the file COPYING. If not, write to - * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, - * Boston, MA 02111-1307 USA - * - * As a special exception, the Free Software Foundation gives permission - * for additional uses of the text contained in its release of GUILE. - * - * The exception is that, if you link the GUILE library with other files - * to produce an executable, this does not by itself cause the - * resulting executable to be covered by the GNU General Public License. - * Your use of that executable is in no way restricted on account of - * linking the GUILE library code into it. - * - * This exception does not however invalidate any other reasons why - * the executable file might be covered by the GNU General Public License. - * - * This exception applies only to the code released by the - * Free Software Foundation under the name GUILE. If you copy - * code from other Free Software Foundation releases into a copy of - * GUILE, as the General Public License permits, the exception does - * not apply to the code that you add in this way. To avoid misleading - * anyone as to the status of such modified files, you must delete - * this exception notice from them. - * - * If you write modifications of your own for GUILE, it is your choice - * whether to permit this exception to apply to your modifications. - * If you do not wish that, delete this exception notice. */ - -#ifndef _SCM_FRAMES_H_ -#define _SCM_FRAMES_H_ - -#include -#include "programs.h" - - -/* - * VM frames - */ - -/* VM Frame Layout - --------------- - - | | <- fp + bp->nargs + bp->nlocs + 4 - +------------------+ = SCM_FRAME_UPPER_ADDRESS (fp) - | Return address | - | MV return address| - | Dynamic link | - | External link | <- fp + bp->nargs + bp->nlocs - | Local variable 1 | = SCM_FRAME_DATA_ADDRESS (fp) - | Local variable 0 | <- fp + bp->nargs - | Argument 1 | - | Argument 0 | <- fp - | Program | <- fp - 1 - +------------------+ = SCM_FRAME_LOWER_ADDRESS (fp) - | | - - As can be inferred from this drawing, it is assumed that - `sizeof (SCM *) == sizeof (SCM)', since pointers (the `link' parts) are - assumed to be as long as SCM objects. */ - -#define SCM_FRAME_DATA_ADDRESS(fp) \ - (fp + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nargs \ - + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nlocs) -#define SCM_FRAME_UPPER_ADDRESS(fp) (SCM_FRAME_DATA_ADDRESS (fp) + 4) -#define SCM_FRAME_LOWER_ADDRESS(fp) (fp - 1) - -#define SCM_FRAME_BYTE_CAST(x) ((scm_byte_t *) SCM_UNPACK (x)) -#define SCM_FRAME_STACK_CAST(x) ((SCM *) SCM_UNPACK (x)) - -#define SCM_FRAME_RETURN_ADDRESS(fp) \ - (SCM_FRAME_BYTE_CAST (SCM_FRAME_DATA_ADDRESS (fp)[3])) -#define SCM_FRAME_MV_RETURN_ADDRESS(fp) \ - (SCM_FRAME_BYTE_CAST (SCM_FRAME_DATA_ADDRESS (fp)[2])) -#define SCM_FRAME_DYNAMIC_LINK(fp) \ - (SCM_FRAME_STACK_CAST (SCM_FRAME_DATA_ADDRESS (fp)[1])) -#define SCM_FRAME_SET_DYNAMIC_LINK(fp, dl) \ - ((SCM_FRAME_DATA_ADDRESS (fp)[1])) = (SCM)(dl); -#define SCM_FRAME_EXTERNAL_LINK(fp) (SCM_FRAME_DATA_ADDRESS (fp)[0]) -#define SCM_FRAME_VARIABLE(fp,i) fp[i] -#define SCM_FRAME_PROGRAM(fp) fp[-1] - - -/* - * Heap frames - */ - -extern scm_t_bits scm_tc16_vm_frame; - -struct scm_vm_frame -{ - SCM stack_holder; - SCM *fp; - SCM *sp; - scm_byte_t *ip; - scm_t_ptrdiff offset; -}; - -#define SCM_VM_FRAME_P(x) SCM_SMOB_PREDICATE (scm_tc16_vm_frame, x) -#define SCM_VM_FRAME_DATA(x) ((struct scm_vm_frame*)SCM_SMOB_DATA (x)) -#define SCM_VM_FRAME_STACK_HOLDER(f) SCM_VM_FRAME_DATA(f)->stack_holder -#define SCM_VM_FRAME_FP(f) SCM_VM_FRAME_DATA(f)->fp -#define SCM_VM_FRAME_SP(f) SCM_VM_FRAME_DATA(f)->sp -#define SCM_VM_FRAME_IP(f) SCM_VM_FRAME_DATA(f)->ip -#define SCM_VM_FRAME_OFFSET(f) SCM_VM_FRAME_DATA(f)->offset -#define SCM_VALIDATE_VM_FRAME(p,x) SCM_MAKE_VALIDATE (p, x, VM_FRAME_P) - -/* FIXME rename scm_byte_t */ -extern SCM scm_c_make_vm_frame (SCM stack_holder, SCM *fp, SCM *sp, - scm_byte_t *ip, scm_t_ptrdiff offset); -extern SCM scm_vm_frame_p (SCM obj); -extern SCM scm_vm_frame_program (SCM frame); -extern SCM scm_vm_frame_arguments (SCM frame); -extern SCM scm_vm_frame_source (SCM frame); -extern SCM scm_vm_frame_local_ref (SCM frame, SCM index); -extern SCM scm_vm_frame_local_set_x (SCM frame, SCM index, SCM val); -extern SCM scm_vm_frame_return_address (SCM frame); -extern SCM scm_vm_frame_mv_return_address (SCM frame); -extern SCM scm_vm_frame_dynamic_link (SCM frame); -extern SCM scm_vm_frame_external_link (SCM frame); -extern SCM scm_vm_frame_stack (SCM frame); - -extern SCM scm_c_vm_frame_prev (SCM frame); - -extern void scm_bootstrap_frames (void); -extern void scm_init_frames (void); - -#endif /* _SCM_FRAMES_H_ */ - -/* - Local Variables: - c-file-style: "gnu" - End: -*/ +/* Copyright (C) 2001, 2009, 2010, 2011 Free Software Foundation, Inc. + * * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation; either version 3 of + * the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA + * 02110-1301 USA + */ + +#ifndef _SCM_FRAMES_H_ +#define _SCM_FRAMES_H_ + +#include +#include "programs.h" + + +/* + * VM frames + */ + +/* + * It's a little confusing, but there are two representations of frames in this + * file: frame pointers and Scheme objects wrapping those frame pointers. The + * former uses the SCM_FRAME_... macro prefix, the latter SCM_VM_FRAME_.. + * prefix. + * + * The confusing thing is that only Scheme frame objects have functions that use + * them, and they use the scm_frame_.. prefix. Hysterical raisins. + */ + +/* VM Frame Layout + --------------- + + | ... | + | Intermed. val. 0 | <- fp + nargs + nlocs + +------------------+ + | Local variable 1 | + | Local variable 0 | <- fp + nargs + | Argument 1 | + | Argument 0 | <- fp = SCM_FRAME_STACK_ADDRESS (fp) + | Program | <- fp - 1 + +==================+ + | Return address | <- SCM_FRAME_UPPER_ADDRESS (fp) + | MV return address| + | Dynamic link | <- fp - 4 = SCM_FRAME_DATA_ADDRESS (fp) = SCM_FRAME_LOWER_ADDRESS (fp) + +==================+ + | | + + As can be inferred from this drawing, it is assumed that + `sizeof (SCM *) == sizeof (SCM)', since pointers (the `link' parts) are + assumed to be as long as SCM objects. */ + +/* This structure maps to the contents of a VM stack frame. It can + alias a frame directly. */ +struct scm_vm_frame +{ + SCM *dynamic_link; + scm_t_uint8 *mv_return_address; + scm_t_uint8 *return_address; + SCM program; + SCM stack[1]; /* Variable-length */ +}; + +#define SCM_FRAME_STRUCT(fp) \ + ((struct scm_vm_frame *) SCM_FRAME_DATA_ADDRESS (fp)) + +#define SCM_FRAME_DATA_ADDRESS(fp) (((SCM *) (fp)) - 4) +#define SCM_FRAME_STACK_ADDRESS(fp) (SCM_FRAME_STRUCT (fp)->stack) +#define SCM_FRAME_UPPER_ADDRESS(fp) ((SCM*)&SCM_FRAME_STRUCT (fp)->return_address) +#define SCM_FRAME_LOWER_ADDRESS(fp) ((SCM*)SCM_FRAME_STRUCT (fp)) + +#define SCM_FRAME_BYTE_CAST(x) ((scm_t_uint8 *) SCM_UNPACK (x)) +#define SCM_FRAME_STACK_CAST(x) ((SCM *) SCM_UNPACK (x)) + +#define SCM_FRAME_RETURN_ADDRESS(fp) \ + (SCM_FRAME_STRUCT (fp)->return_address) +#define SCM_FRAME_SET_RETURN_ADDRESS(fp, ra) \ + SCM_FRAME_STRUCT (fp)->return_address = (ra) +#define SCM_FRAME_MV_RETURN_ADDRESS(fp) \ + (SCM_FRAME_STRUCT (fp)->mv_return_address) +#define SCM_FRAME_SET_MV_RETURN_ADDRESS(fp, mvra) \ + SCM_FRAME_STRUCT (fp)->mv_return_address = (mvra) +#define SCM_FRAME_DYNAMIC_LINK(fp) \ + (SCM_FRAME_STRUCT (fp)->dynamic_link) +#define SCM_FRAME_SET_DYNAMIC_LINK(fp, dl) \ + SCM_FRAME_DYNAMIC_LINK (fp) = (dl) +#define SCM_FRAME_VARIABLE(fp,i) \ + (SCM_FRAME_STRUCT (fp)->stack[i]) +#define SCM_FRAME_PROGRAM(fp) \ + (SCM_FRAME_STRUCT (fp)->program) + + +/* + * Heap frames + */ + +struct scm_frame +{ + SCM stack_holder; + SCM *fp; + SCM *sp; + scm_t_uint8 *ip; + scm_t_ptrdiff offset; +}; + +#define SCM_VM_FRAME_P(x) (SCM_NIMP (x) && SCM_TYP7 (x) == scm_tc7_frame) +#define SCM_VM_FRAME_DATA(x) ((struct scm_frame*)SCM_CELL_WORD_1 (x)) +#define SCM_VM_FRAME_STACK_HOLDER(f) SCM_VM_FRAME_DATA(f)->stack_holder +#define SCM_VM_FRAME_FP(f) SCM_VM_FRAME_DATA(f)->fp +#define SCM_VM_FRAME_SP(f) SCM_VM_FRAME_DATA(f)->sp +#define SCM_VM_FRAME_IP(f) SCM_VM_FRAME_DATA(f)->ip +#define SCM_VM_FRAME_OFFSET(f) SCM_VM_FRAME_DATA(f)->offset +#define SCM_VALIDATE_VM_FRAME(p,x) SCM_MAKE_VALIDATE (p, x, VM_FRAME_P) + +SCM_API SCM scm_c_make_frame (SCM stack_holder, SCM *fp, SCM *sp, + scm_t_uint8 *ip, scm_t_ptrdiff offset); +SCM_API SCM scm_frame_p (SCM obj); +SCM_API SCM scm_frame_procedure (SCM frame); +SCM_API SCM scm_frame_arguments (SCM frame); +SCM_API SCM scm_frame_source (SCM frame); +SCM_API SCM scm_frame_num_locals (SCM frame); +SCM_API SCM scm_frame_local_ref (SCM frame, SCM index); +SCM_API SCM scm_frame_local_set_x (SCM frame, SCM index, SCM val); +SCM_API SCM scm_frame_address (SCM frame); +SCM_API SCM scm_frame_stack_pointer (SCM frame); +SCM_API SCM scm_frame_instruction_pointer (SCM frame); +SCM_API SCM scm_frame_return_address (SCM frame); +SCM_API SCM scm_frame_mv_return_address (SCM frame); +SCM_API SCM scm_frame_dynamic_link (SCM frame); +SCM_API SCM scm_frame_previous (SCM frame); + +SCM_INTERNAL void scm_i_frame_print (SCM frame, SCM port, + scm_print_state *pstate); +SCM_INTERNAL void scm_init_frames (void); + +#endif /* _SCM_FRAMES_H_ */ + +/* + Local Variables: + c-file-style: "gnu" + End: +*/