Annotation of gforth/engine/threaded.h, revision 1.35
1.1 anton 1: /* This file defines a number of threading schemes.
2:
1.35 ! anton 3: Copyright (C) 1995, 1996,1997,1999,2003,2004,2005 Free Software Foundation, Inc.
1.1 anton 4:
5: This file is part of Gforth.
6:
7: Gforth is free software; you can redistribute it and/or
8: modify it under the terms of the GNU General Public License
9: as published by the Free Software Foundation; either version 2
10: of the License, or (at your option) any later version.
11:
12: This program is distributed in the hope that it will be useful,
13: but WITHOUT ANY WARRANTY; without even the implied warranty of
14: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: GNU General Public License for more details.
16:
17: You should have received a copy of the GNU General Public License
18: along with this program; if not, write to the Free Software
1.7 anton 19: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1 anton 20:
21:
22: This files defines macros for threading. Many sets of macros are
23: defined. Functionally they have only one difference: Some implement
24: direct threading, some indirect threading. The other differences are
25: just variations to help GCC generate faster code for various
26: machines.
27:
28: (Well, to tell the truth, there actually is another functional
29: difference in some pathological cases: e.g., a '!' stores into the
30: cell where the next executed word comes from; or, the next word
31: executed comes from the top-of-stack. These differences are one of
32: the reasons why GCC cannot produce the right variation by itself. We
33: chose disallowing such practices and using the added implementation
34: freedom to achieve a significant speedup, because these practices
35: are not common in Forth (I have never heard of or seen anyone using
36: them), and it is easy to circumvent problems: A control flow change
37: will flush any prefetched words; you may want to do a "0
38: drop" before that to write back the top-of-stack cache.)
39:
40: These macro sets are used in the following ways: After translation
41: to C a typical primitive looks like
42:
43: ...
44: {
45: DEF_CA
46: other declarations
47: NEXT_P0;
48: main part of the primitive
49: NEXT_P1;
50: store results to stack
51: NEXT_P2;
52: }
53:
54: DEF_CA and all the NEXT_P* together must implement NEXT; In the main
55: part the instruction pointer can be read with IP, changed with
56: INC_IP(const_inc), and the cell right behind the presently executing
57: word (i.e. the value of *IP) is accessed with NEXT_INST.
58:
59: If a primitive does not fall through the main part, it has to do the
60: rest by itself. If it changes ip, it has to redo NEXT_P0 (perhaps we
61: should define a macro SET_IP).
62:
63: Some primitives (execute, dodefer) do not end with NEXT, but with
64: EXEC(.). If NEXT_P0 has been called earlier, it has to perform
65: "ip=IP;" to ensure that ip has the right value (NEXT_P0 may change
66: it).
67:
68: Finally, there is NEXT1_P1 and NEXT1_P2, which are parts of EXEC
69: (EXEC(XT) could be defined as "cfa=XT; NEXT1_P1; NEXT1_P2;" (is this
70: true?)) and are used for making docol faster.
71:
72: We can define the ways in which these macros are used with a regular
73: expression:
74:
75: For a primitive
76:
77: DEF_CA NEXT_P0 ( IP | INC_IP | NEXT_INST | ip=...; NEXT_P0 ) * ( NEXT_P1 NEXT_P2 | EXEC(...) )
78:
79: For a run-time routine, e.g., docol:
80: PFA1(cfa) ( NEXT_P0 NEXT | cfa=...; NEXT1_P1; NEXT1_P2 | EXEC(...) )
81:
82: This comment does not yet describe all the dependences that the
83: macros have to satisfy.
84:
85: To organize the former ifdef chaos, each path is separated
86: This gives a quite impressive number of paths, but you clearly
87: find things that go together.
88:
89: It should be possible to organize the whole thing in a way that
90: contains less redundancy and allows a simpler description.
91:
92: */
93:
1.29 anton 94: #ifdef GCC_PR15242_WORKAROUND
95: #define DO_GOTO goto before_goto
96: #else
97: #define DO_GOTO goto *real_ca
98: #endif
1.30 pazsan 99: #ifndef GOTO_ALIGN
100: #define GOTO_ALIGN
101: #endif
1.29 anton 102:
1.28 anton 103: #define GOTO(target) do {(real_ca=(target));} while(0)
104: #define NEXT_P2 do {NEXT_P1_5; DO_GOTO;} while(0)
1.32 anton 105: #define EXEC(XT) do { real_ca=EXEC1(XT); DO_GOTO;} while (0)
1.33 anton 106: #define VM_JUMP(target) do {GOTO(target);} while (0)
1.28 anton 107: #define NEXT do {DEF_CA NEXT_P1; NEXT_P2;} while(0)
1.30 pazsan 108: #define FIRST_NEXT_P2 NEXT_P1_5; GOTO_ALIGN; \
109: before_goto: goto *real_ca; after_goto:
1.31 anton 110: #define FIRST_NEXT do {DEF_CA NEXT_P1; FIRST_NEXT_P2;} while(0)
1.28 anton 111: #define IPTOS NEXT_INST
112:
113:
1.1 anton 114: #ifdef DOUBLY_INDIRECT
1.19 pazsan 115: # ifndef DEBUG_DITC
116: # define DEBUG_DITC 0
117: # endif
118: /* define to 1 if you want to check consistency */
1.26 pazsan 119: # define NEXT_P0 do {cfa1=cfa; cfa=*ip;} while(0)
1.23 anton 120: # define CFA cfa1
121: # define MORE_VARS Xt cfa1;
1.1 anton 122: # define IP (ip)
1.26 pazsan 123: # define SET_IP(p) do {ip=(p); cfa=*ip;} while(0)
1.1 anton 124: # define NEXT_INST (cfa)
1.26 pazsan 125: # define INC_IP(const_inc) do {cfa=IP[const_inc]; ip+=(const_inc);} while(0)
1.1 anton 126: # define DEF_CA Label ca;
1.26 pazsan 127: # define NEXT_P1 do {\
1.19 pazsan 128: if (DEBUG_DITC && (cfa<=vm_prims+DOESJUMP || cfa>=vm_prims+npriminfos)) \
129: fprintf(stderr,"NEXT encountered prim %p at ip=%p\n", cfa, ip); \
1.26 pazsan 130: ip++;} while(0)
1.28 anton 131: # define NEXT_P1_5 do {ca=**cfa; GOTO(ca);} while(0)
1.32 anton 132: # define EXEC1(XT) ({DEF_CA cfa=(XT);\
1.19 pazsan 133: if (DEBUG_DITC && (cfa>vm_prims+DOESJUMP && cfa<vm_prims+npriminfos)) \
1.14 anton 134: fprintf(stderr,"EXEC encountered xt %p at ip=%p, vm_prims=%p, xts=%p\n", cfa, ip, vm_prims, xts); \
1.32 anton 135: ca=**cfa; ca;})
1.1 anton 136:
1.16 anton 137: #elif defined(NO_IP)
138:
139: #define NEXT_P0
1.25 anton 140: # define CFA cfa
1.16 anton 141: #define SET_IP(target) assert(0)
142: #define INC_IP(n) ((void)0)
143: #define DEF_CA
144: #define NEXT_P1
1.28 anton 145: #define NEXT_P1_5 do {goto *next_code;} while(0)
1.16 anton 146: /* set next_code to the return address before performing EXEC */
1.32 anton 147: /* original: */
148: /* #define EXEC1(XT) do {cfa=(XT); goto **cfa;} while(0) */
149: /* fake, to make syntax check work */
150: #define EXEC1(XT) ({cfa=(XT); *cfa;})
1.16 anton 151:
152: #else /* !defined(DOUBLY_INDIRECT) && !defined(NO_IP) */
1.1 anton 153:
1.3 anton 154: #if defined(DIRECT_THREADED)
155:
1.17 anton 156: /* This lets the compiler know that cfa is dead before; we place it at
157: "goto *"s that perform direct threaded dispatch (i.e., not EXECUTE
158: etc.), and thus do not reach doers, which would use cfa; the only
159: way to a doer is through EXECUTE etc., which set the cfa
160: themselves.
161:
162: Some of these direct threaded schemes use "cfa" to hold the code
163: address in normal direct threaded code. Of course we cannot use
164: KILLS there.
165:
166: KILLS works by having an empty asm instruction, and claiming to the
167: compiler that it writes to cfa.
168:
169: KILLS is optional. You can write
170:
171: #define KILLS
172:
173: and lose just a little performance.
174: */
175: #define KILLS asm("":"=X"(cfa));
176:
1.3 anton 177: #warning direct threading scheme 8: cfa dead, i386 hack
1.1 anton 178: # define NEXT_P0
1.23 anton 179: # define CFA cfa
1.1 anton 180: # define IP (ip)
1.26 pazsan 181: # define SET_IP(p) do {ip=(p); NEXT_P0;} while(0)
1.1 anton 182: # define NEXT_INST (*IP)
1.26 pazsan 183: # define INC_IP(const_inc) do { ip+=(const_inc);} while(0)
1.1 anton 184: # define DEF_CA
185: # define NEXT_P1 (ip++)
1.28 anton 186: # define NEXT_P1_5 do {KILLS GOTO(*(ip-1));} while(0)
1.32 anton 187: # define EXEC1(XT) ({cfa=(XT); *cfa;})
1.1 anton 188:
1.3 anton 189: /* direct threaded */
190: #else
1.1 anton 191: /* indirect THREADED */
1.20 anton 192:
1.3 anton 193: #warning indirect threading scheme 8: low latency,cisc
1.1 anton 194: # define NEXT_P0
1.23 anton 195: # define CFA cfa
1.1 anton 196: # define IP (ip)
1.26 pazsan 197: # define SET_IP(p) do {ip=(p); NEXT_P0;} while(0)
1.1 anton 198: # define NEXT_INST (*ip)
1.26 pazsan 199: # define INC_IP(const_inc) do {ip+=(const_inc);} while(0)
1.1 anton 200: # define DEF_CA
201: # define NEXT_P1
1.28 anton 202: # define NEXT_P1_5 do {cfa=*ip++; GOTO(*cfa);} while(0)
1.32 anton 203: # define EXEC1(XT) ({cfa=(XT); *cfa;})
1.1 anton 204:
1.3 anton 205: /* indirect threaded */
1.1 anton 206: #endif
207:
1.16 anton 208: #endif /* !defined(DOUBLY_INDIRECT) && !defined(NO_IP) */
1.1 anton 209:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to threaded.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth / engine