Commit | Line | Data |
---|---|---|
b2b33168 | 1 | /* Copyright (C) 2001, 2009, 2010, 2011 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 | ||
aa3f6951 AW |
30 | /* |
31 | * It's a little confusing, but there are two representations of frames in this | |
32 | * file: frame pointers and Scheme objects wrapping those frame pointers. The | |
33 | * former uses the SCM_FRAME_... macro prefix, the latter SCM_VM_FRAME_.. | |
34 | * prefix. | |
35 | * | |
36 | * The confusing thing is that only Scheme frame objects have functions that use | |
37 | * them, and they use the scm_frame_.. prefix. Hysterical raisins. | |
38 | */ | |
39 | ||
b6368dbb LC |
40 | /* VM Frame Layout |
41 | --------------- | |
42 | ||
03e6c165 | 43 | | ... | |
6c6a4439 AW |
44 | | Intermed. val. 0 | <- fp + nargs + nlocs |
45 | +------------------+ | |
03e6c165 | 46 | | Local variable 1 | |
6c6a4439 | 47 | | Local variable 0 | <- fp + nargs |
ac99cb0c | 48 | | Argument 1 | |
6c6a4439 | 49 | | Argument 0 | <- fp = SCM_FRAME_STACK_ADDRESS (fp) |
ac99cb0c | 50 | | Program | <- fp - 1 |
6c6a4439 AW |
51 | +==================+ |
52 | | Return address | <- SCM_FRAME_UPPER_ADDRESS (fp) | |
03e6c165 AW |
53 | | MV return address| |
54 | | Dynamic link | <- fp - 4 = SCM_FRAME_DATA_ADDRESS (fp) = SCM_FRAME_LOWER_ADDRESS (fp) | |
55 | +==================+ | |
ac99cb0c | 56 | | | |
b6368dbb LC |
57 | |
58 | As can be inferred from this drawing, it is assumed that | |
59 | `sizeof (SCM *) == sizeof (SCM)', since pointers (the `link' parts) are | |
60 | assumed to be as long as SCM objects. */ | |
ac99cb0c | 61 | |
3e54fdfc AW |
62 | /* This structure maps to the contents of a VM stack frame. It can |
63 | alias a frame directly. */ | |
64 | struct scm_vm_frame | |
65 | { | |
66 | SCM *dynamic_link; | |
67 | scm_t_uint8 *mv_return_address; | |
68 | scm_t_uint8 *return_address; | |
69 | SCM program; | |
70 | SCM stack[1]; /* Variable-length */ | |
71 | }; | |
72 | ||
73 | #define SCM_FRAME_STRUCT(fp) ((struct scm_vm_frame*)(((SCM*)(fp)) - 4)) | |
74 | ||
03e6c165 | 75 | #define SCM_FRAME_DATA_ADDRESS(fp) (fp - 4) |
3e54fdfc AW |
76 | #define SCM_FRAME_STACK_ADDRESS(fp) (SCM_FRAME_STRUCT (fp)->stack) |
77 | #define SCM_FRAME_UPPER_ADDRESS(fp) ((SCM*)&SCM_FRAME_STRUCT (fp)->return_address) | |
78 | #define SCM_FRAME_LOWER_ADDRESS(fp) ((SCM*)SCM_FRAME_STRUCT (fp)) | |
af988bbf | 79 | |
2fb924f6 | 80 | #define SCM_FRAME_BYTE_CAST(x) ((scm_t_uint8 *) SCM_UNPACK (x)) |
af988bbf | 81 | #define SCM_FRAME_STACK_CAST(x) ((SCM *) SCM_UNPACK (x)) |
ac99cb0c | 82 | |
3e54fdfc AW |
83 | #define SCM_FRAME_RETURN_ADDRESS(fp) \ |
84 | (SCM_FRAME_STRUCT (fp)->return_address) | |
85 | #define SCM_FRAME_SET_RETURN_ADDRESS(fp, ra) \ | |
86 | SCM_FRAME_STRUCT (fp)->return_address = (ra) | |
87 | #define SCM_FRAME_MV_RETURN_ADDRESS(fp) \ | |
88 | (SCM_FRAME_STRUCT (fp)->mv_return_address) | |
89 | #define SCM_FRAME_SET_MV_RETURN_ADDRESS(fp, mvra) \ | |
90 | SCM_FRAME_STRUCT (fp)->mv_return_address = (mvra) | |
91 | #define SCM_FRAME_DYNAMIC_LINK(fp) \ | |
92 | (SCM_FRAME_STRUCT (fp)->dynamic_link) | |
93 | #define SCM_FRAME_SET_DYNAMIC_LINK(fp, dl) \ | |
94 | SCM_FRAME_STRUCT (fp)->dynamic_link = (dl) | |
95 | #define SCM_FRAME_VARIABLE(fp,i) \ | |
96 | (SCM_FRAME_STRUCT (fp)->stack[i]) | |
97 | #define SCM_FRAME_PROGRAM(fp) \ | |
98 | (SCM_FRAME_STRUCT (fp)->program) | |
ac99cb0c KN |
99 | |
100 | \f | |
101 | /* | |
af988bbf | 102 | * Heap frames |
ac99cb0c KN |
103 | */ |
104 | ||
aa3f6951 | 105 | struct scm_frame |
b1b942b7 AW |
106 | { |
107 | SCM stack_holder; | |
108 | SCM *fp; | |
109 | SCM *sp; | |
2fb924f6 | 110 | scm_t_uint8 *ip; |
b1b942b7 AW |
111 | scm_t_ptrdiff offset; |
112 | }; | |
113 | ||
6f3b0cc2 AW |
114 | #define SCM_VM_FRAME_P(x) (SCM_NIMP (x) && SCM_TYP7 (x) == scm_tc7_frame) |
115 | #define SCM_VM_FRAME_DATA(x) ((struct scm_frame*)SCM_CELL_WORD_1 (x)) | |
b1b942b7 AW |
116 | #define SCM_VM_FRAME_STACK_HOLDER(f) SCM_VM_FRAME_DATA(f)->stack_holder |
117 | #define SCM_VM_FRAME_FP(f) SCM_VM_FRAME_DATA(f)->fp | |
118 | #define SCM_VM_FRAME_SP(f) SCM_VM_FRAME_DATA(f)->sp | |
119 | #define SCM_VM_FRAME_IP(f) SCM_VM_FRAME_DATA(f)->ip | |
120 | #define SCM_VM_FRAME_OFFSET(f) SCM_VM_FRAME_DATA(f)->offset | |
121 | #define SCM_VALIDATE_VM_FRAME(p,x) SCM_MAKE_VALIDATE (p, x, VM_FRAME_P) | |
122 | ||
aa3f6951 AW |
123 | SCM_API SCM scm_c_make_frame (SCM stack_holder, SCM *fp, SCM *sp, |
124 | scm_t_uint8 *ip, scm_t_ptrdiff offset); | |
125 | SCM_API SCM scm_frame_p (SCM obj); | |
126 | SCM_API SCM scm_frame_procedure (SCM frame); | |
127 | SCM_API SCM scm_frame_arguments (SCM frame); | |
128 | SCM_API SCM scm_frame_source (SCM frame); | |
129 | SCM_API SCM scm_frame_num_locals (SCM frame); | |
130 | SCM_API SCM scm_frame_local_ref (SCM frame, SCM index); | |
131 | SCM_API SCM scm_frame_local_set_x (SCM frame, SCM index, SCM val); | |
2e30f398 | 132 | SCM_API SCM scm_frame_address (SCM frame); |
542f975e | 133 | SCM_API SCM scm_frame_stack_pointer (SCM frame); |
aa3f6951 AW |
134 | SCM_API SCM scm_frame_instruction_pointer (SCM frame); |
135 | SCM_API SCM scm_frame_return_address (SCM frame); | |
136 | SCM_API SCM scm_frame_mv_return_address (SCM frame); | |
137 | SCM_API SCM scm_frame_dynamic_link (SCM frame); | |
93dbc31b | 138 | SCM_API SCM scm_frame_previous (SCM frame); |
560b9c25 | 139 | |
6f3b0cc2 AW |
140 | SCM_INTERNAL void scm_i_frame_print (SCM frame, SCM port, |
141 | scm_print_state *pstate); | |
560b9c25 | 142 | SCM_INTERNAL void scm_init_frames (void); |
ac99cb0c KN |
143 | |
144 | #endif /* _SCM_FRAMES_H_ */ | |
145 | ||
146 | /* | |
147 | Local Variables: | |
148 | c-file-style: "gnu" | |
149 | End: | |
150 | */ |