src/frames.h

   1 /* Copyright (C) 2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 #ifndef _SCM_FRAMES_H_
  43 #define _SCM_FRAMES_H_
  44
  45 #include <libguile.h>
  46 #include "config.h"
  47 #include "programs.h"
  48
  49 \f
  50 /*
  51  * VM frames
  52  */
  53
  54 /*
  55    |                  | <- fp + bp->nargs + bp->nlocs + 4
  56    +------------------+    = SCM_FRAME_UPPER_ADDRESS (fp)
  57    | Return address   |
  58    | Dynamic link     |
  59    | Heap link        |
  60    | External link    | <- fp + bp->nargs + bp->nlocs
  61    | Local varialbe 1 |    = SCM_FRAME_DATA_ADDRESS (fp)
  62    | Local variable 0 | <- fp + bp->nargs
  63    | Argument 1       |
  64    | Argument 0       | <- fp
  65    | Program          | <- fp - 1
  66    +------------------+    = SCM_FRAME_LOWER_ADDRESS (fp)
  67    |                  |
  68 */
  69
  70 #define SCM_FRAME_DATA_ADDRESS(fp)                              \
  71   (fp + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nargs        \
  72       + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nlocs)
  73 #define SCM_FRAME_UPPER_ADDRESS(fp)     (SCM_FRAME_DATA_ADDRESS (fp) + 4)
  74 #define SCM_FRAME_LOWER_ADDRESS(fp)     (fp - 1)
  75
  76 #define SCM_FRAME_BYTE_CAST(x)          ((scm_byte_t *) SCM_UNPACK (x))
  77 #define SCM_FRAME_STACK_CAST(x)         ((SCM *) SCM_UNPACK (x))
  78
  79 #define SCM_FRAME_RETURN_ADDRESS(fp)    SCM_FRAME_BYTE_CAST (SCM_FRAME_DATA_ADDRESS (fp)[3])
  80 #define SCM_FRAME_DYNAMIC_LINK(fp)      SCM_FRAME_STACK_CAST (SCM_FRAME_DATA_ADDRESS (fp)[2])
  81 #define SCM_FRAME_HEAP_LINK(fp)         SCM_FRAME_DATA_ADDRESS (fp)[1]
  82 #define SCM_FRAME_EXTERNAL_LINK(fp)     SCM_FRAME_DATA_ADDRESS (fp)[0]
  83 #define SCM_FRAME_VARIABLE(fp,i)        fp[i]
  84 #define SCM_FRAME_PROGRAM(fp)           fp[-1]
  85
  86 \f
  87 /*
  88  * Heap frames
  89  */
  90
  91 extern scm_bits_t scm_tc16_heap_frame;
  92
  93 #define SCM_HEAP_FRAME_P(x)     SCM_SMOB_PREDICATE (scm_tc16_heap_frame, x)
  94 #define SCM_HEAP_FRAME_DATA(f)          ((SCM *) SCM_SMOB_DATA (f))
  95 #define SCM_HEAP_FRAME_SELF(f)          (SCM_HEAP_FRAME_DATA (f)[0])
  96 #define SCM_HEAP_FRAME_POINTER(f)       (SCM_HEAP_FRAME_DATA (f) + 2)
  97 #define SCM_VALIDATE_HEAP_FRAME(p,x)    SCM_MAKE_VALIDATE (p, x, HEAP_FRAME_P)
  98
  99 extern SCM scm_c_make_heap_frame (SCM *fp);
 100 extern void scm_init_frames (void);
 101
 102 #endif /* _SCM_FRAMES_H_ */
 103
 104 /*
 105   Local Variables:
 106   c-file-style: "gnu"
 107   End:
 108 */