gateway: simplify stopping the cleanup timer
[olsrd.git] / lib / tas / src / lua / lopcodes.h
1
2 /*
3 ** $Id: lopcodes.h,v 1.102 2002/08/21 18:56:09 roberto Exp $
4 ** Opcodes for Lua virtual machine
5 ** See Copyright Notice in lua.h
6 */
7
8 #ifndef lopcodes_h
9 #define lopcodes_h
10
11 #include "llimits.h"
12
13
14 /*===========================================================================
15   We assume that instructions are unsigned numbers.
16   All instructions have an opcode in the first 6 bits.
17   Instructions can have the following fields:
18         `A' : 8 bits
19         `B' : 9 bits
20         `C' : 9 bits
21         `Bx' : 18 bits (`B' and `C' together)
22         `sBx' : signed Bx
23
24   A signed argument is represented in excess K; that is, the number
25   value is the unsigned value minus K. K is exactly the maximum value
26   for that argument (so that -max is represented by 0, and +max is
27   represented by 2*max), which is half the maximum for the corresponding
28   unsigned argument.
29 ===========================================================================*/
30
31
32 enum OpMode { iABC, iABx, iAsBx };     /* basic instruction format */
33
34
35 /*
36 ** size and position of opcode arguments.
37 */
38 #define SIZE_C          9
39 #define SIZE_B          9
40 #define SIZE_Bx         (SIZE_C + SIZE_B)
41 #define SIZE_A          8
42
43 #define SIZE_OP         6
44
45 #define POS_C           SIZE_OP
46 #define POS_B           (POS_C + SIZE_C)
47 #define POS_Bx          POS_C
48 #define POS_A           (POS_B + SIZE_B)
49
50
51 /*
52 ** limits for opcode arguments.
53 ** we use (signed) int to manipulate most arguments,
54 ** so they must fit in BITS_INT-1 bits (-1 for sign)
55 */
56 #if SIZE_Bx < BITS_INT-1
57 #define MAXARG_Bx        ((1<<SIZE_Bx)-1)
58 #define MAXARG_sBx        (MAXARG_Bx>>1)        /* `sBx' is signed */
59 #else
60 #define MAXARG_Bx        MAX_INT
61 #define MAXARG_sBx        MAX_INT
62 #endif
63
64
65 #define MAXARG_A        ((1<<SIZE_A)-1)
66 #define MAXARG_B        ((1<<SIZE_B)-1)
67 #define MAXARG_C        ((1<<SIZE_C)-1)
68
69
70 /* creates a mask with `n' 1 bits at position `p' */
71 #define MASK1(n,p)      ((~((~(Instruction)0)<<n))<<p)
72
73 /* creates a mask with `n' 0 bits at position `p' */
74 #define MASK0(n,p)      (~MASK1(n,p))
75
76 /*
77 ** the following macros help to manipulate instructions
78 */
79
80 #define GET_OPCODE(i)   (cast(OpCode, (i)&MASK1(SIZE_OP,0)))
81 #define SET_OPCODE(i,o) ((i) = (((i)&MASK0(SIZE_OP,0)) | cast(Instruction, o)))
82
83 #define GETARG_A(i)     (cast(int, (i)>>POS_A))
84 #define SETARG_A(i,u)   ((i) = (((i)&MASK0(SIZE_A,POS_A)) | \
85                 ((cast(Instruction, u)<<POS_A)&MASK1(SIZE_A,POS_A))))
86
87 #define GETARG_B(i)     (cast(int, ((i)>>POS_B) & MASK1(SIZE_B,0)))
88 #define SETARG_B(i,b)   ((i) = (((i)&MASK0(SIZE_B,POS_B)) | \
89                 ((cast(Instruction, b)<<POS_B)&MASK1(SIZE_B,POS_B))))
90
91 #define GETARG_C(i)     (cast(int, ((i)>>POS_C) & MASK1(SIZE_C,0)))
92 #define SETARG_C(i,b)   ((i) = (((i)&MASK0(SIZE_C,POS_C)) | \
93                 ((cast(Instruction, b)<<POS_C)&MASK1(SIZE_C,POS_C))))
94
95 #define GETARG_Bx(i)    (cast(int, ((i)>>POS_Bx) & MASK1(SIZE_Bx,0)))
96 #define SETARG_Bx(i,b)  ((i) = (((i)&MASK0(SIZE_Bx,POS_Bx)) | \
97                 ((cast(Instruction, b)<<POS_Bx)&MASK1(SIZE_Bx,POS_Bx))))
98
99 #define GETARG_sBx(i)   (GETARG_Bx(i)-MAXARG_sBx)
100 #define SETARG_sBx(i,b) SETARG_Bx((i),cast(unsigned int, (b)+MAXARG_sBx))
101
102
103 #define CREATE_ABC(o,a,b,c)     (cast(Instruction, o) \
104                         | (cast(Instruction, a)<<POS_A) \
105                         | (cast(Instruction, b)<<POS_B) \
106                         | (cast(Instruction, c)<<POS_C))
107
108 #define CREATE_ABx(o,a,bc)      (cast(Instruction, o) \
109                         | (cast(Instruction, a)<<POS_A) \
110                         | (cast(Instruction, bc)<<POS_Bx))
111
112
113
114
115 /*
116 ** invalid register that fits in 8 bits
117 */
118 #define NO_REG          MAXARG_A
119
120
121 /*
122 ** R(x) - register
123 ** Kst(x) - constant (in constant table)
124 ** RK(x) == if x < MAXSTACK then R(x) else Kst(x-MAXSTACK)
125 */
126
127
128 /*
129 ** grep "ORDER OP" if you change these enums
130 */
131
132 typedef enum {
133
134 /*----------------------------------------------------------------------
135 name            args    description
136 ------------------------------------------------------------------------*/
137   OP_MOVE,                             /*      A B     R(A) := R(B)                                    */
138   OP_LOADK,                            /*     A Bx    R(A) := Kst(Bx)                                 */
139   OP_LOADBOOL,                         /*  A B C   R(A) := (Bool)B; if (C) PC++                    */
140   OP_LOADNIL,                          /*   A B     R(A) := ... := R(B) := nil                      */
141   OP_GETUPVAL,                         /*  A B     R(A) := UpValue[B]                              */
142
143   OP_GETGLOBAL,                        /* A Bx    R(A) := Gbl[Kst(Bx)]                            */
144   OP_GETTABLE,                         /*  A B C   R(A) := R(B)[RK(C)]                             */
145
146   OP_SETGLOBAL,                        /* A Bx    Gbl[Kst(Bx)] := R(A)                            */
147   OP_SETUPVAL,                         /*  A B     UpValue[B] := R(A)                              */
148   OP_SETTABLE,                         /*  A B C   R(A)[RK(B)] := RK(C)                            */
149
150   OP_NEWTABLE,                         /*  A B C   R(A) := {} (size = B,C)                         */
151
152   OP_SELF,                             /*      A B C   R(A+1) := R(B); R(A) := R(B)[RK(C)]             */
153
154   OP_ADD,                              /*       A B C   R(A) := RK(B) + RK(C)                           */
155   OP_SUB,                              /*       A B C   R(A) := RK(B) - RK(C)                           */
156   OP_MUL,                              /*       A B C   R(A) := RK(B) * RK(C)                           */
157   OP_DIV,                              /*       A B C   R(A) := RK(B) / RK(C)                           */
158   OP_POW,                              /*       A B C   R(A) := RK(B) ^ RK(C)                           */
159   OP_UNM,                              /*       A B     R(A) := -R(B)                                   */
160   OP_NOT,                              /*       A B     R(A) := not R(B)                                */
161
162   OP_CONCAT,                           /*    A B C   R(A) := R(B).. ... ..R(C)                       */
163
164   OP_JMP,                              /*       sBx     PC += sBx                                       */
165
166   OP_EQ,                               /*        A B C   if ((RK(B) == RK(C)) ~= A) then pc++            */
167   OP_LT,                               /*        A B C   if ((RK(B) <  RK(C)) ~= A) then pc++            */
168   OP_LE,                               /*        A B C   if ((RK(B) <= RK(C)) ~= A) then pc++            */
169
170   OP_TEST,                             /*      A B C   if (R(B) <=> C) then R(A) := R(B) else pc++     */
171
172   OP_CALL,                             /*      A B C   R(A), ... ,R(A+C-2) := R(A)(R(A+1), ... ,R(A+B-1)) */
173   OP_TAILCALL,                         /*  A B C   return R(A)(R(A+1), ... ,R(A+B-1))              */
174   OP_RETURN,                           /*    A B     return R(A), ... ,R(A+B-2)      (see note)      */
175
176   OP_FORLOOP,                          /*   A sBx   R(A)+=R(A+2); if R(A) <?= R(A+1) then PC+= sBx  */
177
178   OP_TFORLOOP,                         /*  A C     R(A+2), ... ,R(A+2+C) := R(A)(R(A+1), R(A+2));
179                                           if R(A+2) ~= nil then pc++                       */
180   OP_TFORPREP,                         /*  A sBx   if type(R(A)) == table then R(A+1):=R(A), R(A):=next;
181                                           PC += sBx                                        */
182
183   OP_SETLIST,                          /*   A Bx    R(A)[Bx-Bx%FPF+i] := R(A+i), 1 <= i <= Bx%FPF+1 */
184   OP_SETLISTO,                         /*  A Bx                                                    */
185
186   OP_CLOSE,                            /*     A       close all variables in the stack up to (>=) R(A) */
187   OP_CLOSURE                           /*    A Bx    R(A) := closure(KPROTO[Bx], R(A), ... ,R(A+n))  */
188 } OpCode;
189
190
191 #define NUM_OPCODES     (cast(int, OP_CLOSURE+1))
192
193
194
195 /*===========================================================================
196   Notes:
197   (1) In OP_CALL, if (B == 0) then B = top. C is the number of returns - 1,
198       and can be 0: OP_CALL then sets `top' to last_result+1, so
199       next open instruction (OP_CALL, OP_RETURN, OP_SETLIST) may use `top'.
200
201   (2) In OP_RETURN, if (B == 0) then return up to `top'
202
203   (3) For comparisons, B specifies what conditions the test should accept.
204
205   (4) All `skips' (pc++) assume that next instruction is a jump
206 ===========================================================================*/
207
208
209 /*
210 ** masks for instruction properties
211 */
212 enum OpModeMask {
213   OpModeBreg = 2,                      /* B is a register */
214   OpModeBrk,                    /* B is a register/constant */
215   OpModeCrk,                    /* C is a register/constant */
216   OpModesetA,                   /* instruction set register A */
217   OpModeK,                      /* Bx is a constant */
218   OpModeT                       /* operator is a test */
219 };
220
221
222 extern const lu_byte luaP_opmodes[NUM_OPCODES];
223
224 #define getOpMode(m)            (cast(enum OpMode, luaP_opmodes[m] & 3))
225 #define testOpMode(m, b)        (luaP_opmodes[m] & (1 << (b)))
226
227
228 #ifdef LUA_OPNAMES
229 extern const char *const luaP_opnames[];        /* opcode names */
230 #endif
231
232
233
234 /* number of list items to accumulate before a SETLIST instruction */
235
236 /* (must be a power of 2) */
237 #define LFIELDS_PER_FLUSH       32
238
239
240 #endif