Commit | Line | Data |
---|---|---|
20d47c39 | 1 | /* Copyright (C) 2001, 2009 Free Software Foundation, Inc. |
560b9c25 AW |
2 | * * |
3 | * This library is free software; you can redistribute it and/or | |
53befeb7 NJ |
4 | * modify it under the terms of the GNU Lesser General Public License |
5 | * as published by the Free Software Foundation; either version 3 of | |
6 | * the License, or (at your option) any later version. | |
ac99cb0c | 7 | * |
53befeb7 NJ |
8 | * This library is distributed in the hope that it will be useful, but |
9 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
560b9c25 AW |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
ac99cb0c | 12 | * |
560b9c25 AW |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
53befeb7 NJ |
15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA |
16 | * 02110-1301 USA | |
560b9c25 | 17 | */ |
ac99cb0c KN |
18 | |
19 | #ifndef _SCM_FRAMES_H_ | |
20 | #define _SCM_FRAMES_H_ | |
21 | ||
22 | #include <libguile.h> | |
ac99cb0c KN |
23 | #include "programs.h" |
24 | ||
ac99cb0c KN |
25 | \f |
26 | /* | |
af988bbf | 27 | * VM frames |
ac99cb0c KN |
28 | */ |
29 | ||
b6368dbb LC |
30 | /* VM Frame Layout |
31 | --------------- | |
32 | ||
20d47c39 | 33 | | | <- fp + bp->nargs + bp->nlocs + 3 |
af988bbf | 34 | +------------------+ = SCM_FRAME_UPPER_ADDRESS (fp) |
ac99cb0c | 35 | | Return address | |
da320011 | 36 | | MV return address| |
20d47c39 | 37 | | Dynamic link | <- fp + bp->nargs + bp->blocs |
b6368dbb | 38 | | Local variable 1 | = SCM_FRAME_DATA_ADDRESS (fp) |
ac99cb0c KN |
39 | | Local variable 0 | <- fp + bp->nargs |
40 | | Argument 1 | | |
41 | | Argument 0 | <- fp | |
42 | | Program | <- fp - 1 | |
af988bbf | 43 | +------------------+ = SCM_FRAME_LOWER_ADDRESS (fp) |
ac99cb0c | 44 | | | |
b6368dbb LC |
45 | |
46 | As can be inferred from this drawing, it is assumed that | |
47 | `sizeof (SCM *) == sizeof (SCM)', since pointers (the `link' parts) are | |
48 | assumed to be as long as SCM objects. */ | |
ac99cb0c | 49 | |
af988bbf KN |
50 | #define SCM_FRAME_DATA_ADDRESS(fp) \ |
51 | (fp + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nargs \ | |
52 | + SCM_PROGRAM_DATA (SCM_FRAME_PROGRAM (fp))->nlocs) | |
20d47c39 | 53 | #define SCM_FRAME_UPPER_ADDRESS(fp) (SCM_FRAME_DATA_ADDRESS (fp) + 3) |
af988bbf KN |
54 | #define SCM_FRAME_LOWER_ADDRESS(fp) (fp - 1) |
55 | ||
56 | #define SCM_FRAME_BYTE_CAST(x) ((scm_byte_t *) SCM_UNPACK (x)) | |
57 | #define SCM_FRAME_STACK_CAST(x) ((SCM *) SCM_UNPACK (x)) | |
ac99cb0c | 58 | |
b6368dbb | 59 | #define SCM_FRAME_RETURN_ADDRESS(fp) \ |
b1b942b7 | 60 | (SCM_FRAME_BYTE_CAST (SCM_FRAME_DATA_ADDRESS (fp)[2])) |
20d47c39 AW |
61 | #define SCM_FRAME_MV_RETURN_ADDRESS(fp) \ |
62 | (SCM_FRAME_BYTE_CAST (SCM_FRAME_DATA_ADDRESS (fp)[1])) | |
b6368dbb | 63 | #define SCM_FRAME_DYNAMIC_LINK(fp) \ |
20d47c39 | 64 | (SCM_FRAME_STACK_CAST (SCM_FRAME_DATA_ADDRESS (fp)[0])) |
b6368dbb | 65 | #define SCM_FRAME_SET_DYNAMIC_LINK(fp, dl) \ |
9557ecc6 | 66 | ((SCM_FRAME_DATA_ADDRESS (fp)[0])) = (SCM)(dl); |
af988bbf KN |
67 | #define SCM_FRAME_VARIABLE(fp,i) fp[i] |
68 | #define SCM_FRAME_PROGRAM(fp) fp[-1] | |
ac99cb0c KN |
69 | |
70 | \f | |
71 | /* | |
af988bbf | 72 | * Heap frames |
ac99cb0c KN |
73 | */ |
74 | ||
560b9c25 | 75 | SCM_API scm_t_bits scm_tc16_vm_frame; |
b1b942b7 AW |
76 | |
77 | struct scm_vm_frame | |
78 | { | |
79 | SCM stack_holder; | |
80 | SCM *fp; | |
81 | SCM *sp; | |
82 | scm_byte_t *ip; | |
83 | scm_t_ptrdiff offset; | |
84 | }; | |
85 | ||
86 | #define SCM_VM_FRAME_P(x) SCM_SMOB_PREDICATE (scm_tc16_vm_frame, x) | |
87 | #define SCM_VM_FRAME_DATA(x) ((struct scm_vm_frame*)SCM_SMOB_DATA (x)) | |
88 | #define SCM_VM_FRAME_STACK_HOLDER(f) SCM_VM_FRAME_DATA(f)->stack_holder | |
89 | #define SCM_VM_FRAME_FP(f) SCM_VM_FRAME_DATA(f)->fp | |
90 | #define SCM_VM_FRAME_SP(f) SCM_VM_FRAME_DATA(f)->sp | |
91 | #define SCM_VM_FRAME_IP(f) SCM_VM_FRAME_DATA(f)->ip | |
92 | #define SCM_VM_FRAME_OFFSET(f) SCM_VM_FRAME_DATA(f)->offset | |
93 | #define SCM_VALIDATE_VM_FRAME(p,x) SCM_MAKE_VALIDATE (p, x, VM_FRAME_P) | |
94 | ||
95 | /* FIXME rename scm_byte_t */ | |
560b9c25 | 96 | SCM_API SCM scm_c_make_vm_frame (SCM stack_holder, SCM *fp, SCM *sp, |
b1b942b7 | 97 | scm_byte_t *ip, scm_t_ptrdiff offset); |
560b9c25 AW |
98 | SCM_API SCM scm_vm_frame_p (SCM obj); |
99 | SCM_API SCM scm_vm_frame_program (SCM frame); | |
100 | SCM_API SCM scm_vm_frame_arguments (SCM frame); | |
101 | SCM_API SCM scm_vm_frame_source (SCM frame); | |
102 | SCM_API SCM scm_vm_frame_local_ref (SCM frame, SCM index); | |
103 | SCM_API SCM scm_vm_frame_local_set_x (SCM frame, SCM index, SCM val); | |
104 | SCM_API SCM scm_vm_frame_return_address (SCM frame); | |
105 | SCM_API SCM scm_vm_frame_mv_return_address (SCM frame); | |
106 | SCM_API SCM scm_vm_frame_dynamic_link (SCM frame); | |
560b9c25 AW |
107 | SCM_API SCM scm_vm_frame_stack (SCM frame); |
108 | ||
109 | SCM_API SCM scm_c_vm_frame_prev (SCM frame); | |
110 | ||
111 | SCM_INTERNAL void scm_bootstrap_frames (void); | |
112 | SCM_INTERNAL void scm_init_frames (void); | |
ac99cb0c KN |
113 | |
114 | #endif /* _SCM_FRAMES_H_ */ | |
115 | ||
116 | /* | |
117 | Local Variables: | |
118 | c-file-style: "gnu" | |
119 | End: | |
120 | */ |