d053499b10ebb6ff35d454133f37b93a250abe9e
[cacao.git] / src / vm / jit / jit.h
1 /* src/vm/jit/jit.h - code generation header
2
3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
6    J. Wenninger, Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23    02110-1301, USA.
24
25    Contact: cacao@cacaojvm.org
26
27    Authors: Andreas Krall
28             Reinhard Grafl
29             Christian Thalinger
30             Edwin Steiner
31
32    $Id: jit.h 6057 2006-11-27 14:58:43Z edwin $
33
34 */
35
36
37 #ifndef _JIT_H
38 #define _JIT_H
39
40 /* forward typedefs ***********************************************************/
41
42 typedef struct jitdata jitdata;
43 typedef struct stackelement stackelement;
44 typedef stackelement *stackptr;
45 typedef struct basicblock basicblock;
46 typedef struct branchref branchref;
47 typedef struct instruction instruction;
48 typedef struct insinfo_inline insinfo_inline;
49 typedef struct exception_entry exception_entry;
50
51
52 #include "config.h"
53 #include "vm/types.h"
54
55 #include "toolbox/chain.h"
56 #include "vm/global.h"
57 #include "vm/method.h"
58 #include "vm/references.h"
59 #include "vm/resolve.h"
60 #include "vm/statistics.h"
61 #include "vm/jit/codegen-common.h"
62 #include "vm/jit/reg.h"
63 #include "vm/jit/stacktrace.h"
64 #include "vm/jit/replace.h"
65
66 #if defined(ENABLE_INLINING)
67 # include "vm/jit/inline/inline.h"
68 #endif
69
70 #if defined(ENABLE_LOOP)
71 # include "vm/jit/loop/loop.h"
72 #endif
73 #if defined(ENABLE_SSA) 
74 # include "vm/jit/optimizing/lsra.h"
75 #endif
76 #if defined(ENABLE_LSRA)
77 # include "vm/jit/allocator/lsra.h"
78 #endif
79
80 #include "vm/jit/verify/typeinfo.h"
81
82 /* common jit/codegen macros **************************************************/
83
84 #if defined(ENABLE_STATISTICS)
85 # define COUNT(x)        (x)++
86 # define COUNT_SPILLS    count_spills++
87 #else
88 # define COUNT(x)        /* nothing */
89 # define COUNT_SPILLS    /* nothing */
90 #endif
91
92 typedef struct interface_info interface_info;
93
94 struct interface_info {
95         s4 flags;
96         s4 regoff;
97 };
98
99
100 /* jitdata ********************************************************************/
101
102 struct jitdata {
103         methodinfo      *m;               /* methodinfo of the method compiled    */
104         codeinfo        *code;
105         codegendata     *cd;
106         registerdata    *rd;
107 #if defined(ENABLE_LOOP)
108         loopdata        *ld;
109 #endif
110 #if defined(ENABLE_SSA) || defined(ENABLE_LSRA)
111         lsradata        *ls;
112 #endif
113
114         u4               flags;           /* contains JIT compiler flags          */
115         bool             isleafmethod;    /* true, if no subroutines are called   */
116
117         instruction     *instructions;    /* ICMDs, valid between parse and stack */
118         basicblock      *basicblocks;     /* start of basic block list            */
119         s4              *basicblockindex; /* block index for each JavaPC          */
120                                       /* valid between parse and stack        */
121         stackelement    *stack;           /* XXX should become stack.c internal   */
122         s4               instructioncount;/* XXX remove this?                     */
123         s4               basicblockcount; /* number of basic blocks               */
124         s4               stackcount;      /* number of stackelements to allocate  */
125                                       /* (passed from parse to stack)         */
126
127         varinfo         *var;             /* array of variables                   */
128         s4               vartop;          /* next free index in var array         */
129     
130         s4               varcount;        /* number of variables in var array     */
131         s4               localcount;      /* number of locals at start of var ar. */
132     s4              *local_map;  /* internal structure to rename(de-coallesc) */
133                                                 /* locals and keep the coalescing info for simplereg. */
134                             /* local_map[local_index * 5 + local_type] =          */
135                             /* new_index in rd->var or UNUSED                     */
136         s4               maxlocals;       /* max. number of javalocals            */
137
138         interface_info  *interface_map;   /* interface variables (for simplereg)  */
139         s4               maxinterfaces;   /* max. number of interface variables   */
140
141         s4               exceptiontablelength; /* exceptiontable length           */
142         exception_entry *exceptiontable;       /* the exceptiontable              */
143
144         basicblock      *returnblock;          /* block containing the *RETURN    */
145                                                /* (only use if returncount==1)    */
146         s4               returncount;          /* number of return instructions   */
147         bool             branchtoentry;        /* true if first block is a target */
148         bool             branchtoend;          /* true if end dummy is a target   */
149 };
150
151
152 #define UNUSED                     -1
153
154 #define JITDATA_FLAG_PARSE               0x00000001
155 #define JITDATA_FLAG_VERIFY              0x00000002
156
157 #define JITDATA_FLAG_INSTRUMENT          0x00000004
158
159 #define JITDATA_FLAG_IFCONV              0x00000008
160 #define JITDATA_FLAG_REORDER             0x00000010
161
162 #define JITDATA_FLAG_SHOWINTERMEDIATE    0x20000000
163 #define JITDATA_FLAG_SHOWDISASSEMBLE     0x40000000
164 #define JITDATA_FLAG_VERBOSECALL         0x80000000
165
166
167 #define JITDATA_HAS_FLAG_PARSE(jd) \
168     ((jd)->flags & JITDATA_FLAG_PARSE)
169
170 #define JITDATA_HAS_FLAG_VERIFY(jd) \
171     ((jd)->flags & JITDATA_FLAG_VERIFY)
172
173 #define JITDATA_HAS_FLAG_INSTRUMENT(jd) \
174     ((jd)->flags & JITDATA_FLAG_INSTRUMENT)
175
176 #define JITDATA_HAS_FLAG_IFCONV(jd) \
177     ((jd)->flags & JITDATA_FLAG_IFCONV)
178
179 #define JITDATA_HAS_FLAG_REORDER(jd) \
180     ((jd)->flags & JITDATA_FLAG_REORDER)
181
182 #define JITDATA_HAS_FLAG_SHOWINTERMEDIATE(jd) \
183     ((jd)->flags & JITDATA_FLAG_SHOWINTERMEDIATE)
184
185 #define JITDATA_HAS_FLAG_SHOWDISASSEMBLE(jd) \
186     ((jd)->flags & JITDATA_FLAG_SHOWDISASSEMBLE)
187
188 #define JITDATA_HAS_FLAG_VERBOSECALL(jd) \
189     ((jd)->flags & JITDATA_FLAG_VERBOSECALL)
190
191
192 /* macros for accessing variables *********************************************
193  
194    Use VAROP for s1, s2, s3 and dst operands (eg. VAROP(iptr->s1)),
195    use VAR if you have the variable index (eg. VAR(iptr->sx.s23.s2.args[0])).
196
197 ******************************************************************************/
198
199 #define VAROP(v) (jd->var + (v).varindex)
200 #define VAR(i)   (jd->var + (i))
201
202
203 /* exception_entry ************************************************************/
204
205 struct exception_entry {
206         basicblock           *start;
207         basicblock           *end;
208         basicblock           *handler;
209         classref_or_classinfo catchtype; /* catchtype of exc. (NULL == catchall)  */
210         exception_entry      *next;      /* next in list of exceptions when       */
211                                                                          /* loops are copied                      */
212         exception_entry      *down;      /* next exception_entry                  */
213 };
214
215
216 /* stack element structure ****************************************************/
217
218 /* flags */
219
220 #define SAVEDVAR      1         /* variable has to survive method invocations */
221 #define INMEMORY      2         /* variable stored in memory                  */
222 #define SAVREG        4         /* allocated to a saved register              */
223 #define ARGREG        8         /* allocated to an arg register               */
224 #define PASSTHROUGH  32         /* stackslot was passed-through by an ICMD    */
225 #define PREALLOC     64         /* preallocated var like for ARGVARS. Used    */
226                                 /* with the new var system */
227 #define INOUT    128            /* variable is an invar or/and an outvar      */
228
229 #define IS_SAVEDVAR(x)    ((x) & SAVEDVAR)
230 #define IS_INMEMORY(x)    ((x) & INMEMORY)
231
232
233 /* variable kinds */
234
235 #define UNDEFVAR   0            /* stack slot will become temp during regalloc*/
236 #define TEMPVAR    1            /* stack slot is temp register                */
237 #define STACKVAR   2            /* stack slot is numbered stack slot          */
238 #define LOCALVAR   3            /* stack slot is local variable               */
239 #define ARGVAR     4            /* stack slot is argument variable            */
240
241
242 struct stackelement {
243         stackptr prev;              /* pointer to next element towards bottom     */
244         instruction *creator;       /* instruction that created this element      */
245         s4       type;              /* slot type of stack element                 */
246         s4       flags;             /* flags (SAVED, INMEMORY)                    */
247         s4       varkind;           /* kind of variable or register               */
248         s4       varnum;            /* number of variable                         */
249 };
250
251
252 /**************************** instruction structure ***************************/
253
254 /* branch_target_t: used in TABLESWITCH tables */
255
256 typedef union {
257     s4                         insindex; /* used between parse and stack      */
258     basicblock                *block;    /* used from stack analysis onwards  */
259 } branch_target_t;
260
261 /* lookup_target_t: used in LOOKUPSWITCH tables */
262
263 typedef struct {
264     s4                         value;    /* case value                        */
265     branch_target_t            target;   /* branch target, see above          */
266 } lookup_target_t;
267
268 /*** s1 operand ***/
269
270 typedef union {
271         s4                         varindex;
272     s4                         argcount;
273 } s1_operand_t;
274
275 /*** s2 operand ***/
276
277 typedef union {
278         s4                         varindex;
279         s4                        *args;
280     classref_or_classinfo      c;
281     unresolved_class          *uc;
282     ptrint                     constval;         /* for PUT*CONST             */
283     s4                         tablelow;         /* for TABLESWITCH           */
284     u4                         lookupcount;      /* for LOOKUPSWITCH          */
285         s4                         retaddrnr;        /* for ASTORE                */
286 } s2_operand_t;
287
288 /*** s3 operand ***/
289
290 typedef union {
291         s4                         varindex;
292     ptrint                     constval;
293     classref_or_classinfo      c;
294     constant_FMIref           *fmiref;
295     unresolved_method         *um;
296     unresolved_field          *uf;
297     insinfo_inline            *inlineinfo;       /* for INLINE_START/END      */
298     s4                         tablehigh;        /* for TABLESWITCH           */
299     branch_target_t            lookupdefault;    /* for LOOKUPSWITCH          */
300     branch_target_t            jsrtarget;        /* for JSR                   */
301         s4                         javaindex;        /* for *STORE                */
302     struct builtintable_entry *bte;
303 } s3_operand_t;
304
305 /*** val operand ***/
306
307 typedef union {
308     s4                        i;
309     s8                        l;
310     float                     f;
311     double                    d;
312     void                     *anyptr;
313     java_objectheader        *stringconst;       /* for ACONST with string    */
314     classref_or_classinfo     c;                 /* for ACONST with class     */
315 } val_operand_t;
316
317 /*** dst operand ***/
318
319 typedef union {
320         s4                         varindex;
321     basicblock                *block;       /* valid after stack analysis     */
322     branch_target_t           *table;       /* for TABLESWITCH                */
323     lookup_target_t           *lookup;      /* for LOOKUPSWITCH               */
324     s4                         insindex;    /* used between parse and stack   */
325 } dst_operand_t;
326
327 /*** flags (32 bits) ***/
328
329 #define INS_FLAG_UNRESOLVED    0x01    /* contains unresolved field/meth/class*/
330 #define INS_FLAG_CLASS         0x02    /* for ACONST, PUT*CONST with class    */
331 #define INS_FLAG_ARRAY         0x04    /* for CHECKCAST/INSTANCEOF with array */
332 #define INS_FLAG_CHECK         0x08    /* for *ALOAD|*ASTORE: check index     */
333                                        /* for BUILTIN: check exception        */
334 #define INS_FLAG_KILL_PREV     0x02    /* for *STORE, invalidate prev local   */
335 #define INS_FLAG_KILL_NEXT     0x04    /* for *STORE, invalidate next local   */
336 #define INS_FLAG_RETADDR       0x08    /* for ASTORE: op is a returnAddress   */
337
338 #define INS_FLAG_ID_SHIFT      4
339 #define INS_FLAG_ID_MASK       (~0 << INS_FLAG_ID_SHIFT)
340
341 typedef union {
342     u4                  bits;
343 } flags_operand_t;
344
345 /*** instruction ***/
346
347 /* The instruction format for the intermediate representation: */
348
349 struct instruction {
350     u2                      opc;    /* opcode       */
351     u2                      line;   /* line number  */
352 #if SIZEOF_VOID_P == 8
353     flags_operand_t         flags;  /* 4 bytes      */
354 #endif
355     s1_operand_t            s1;     /* pointer-size */
356     union {
357         struct {
358             s2_operand_t    s2;     /* pointer-size */
359             s3_operand_t    s3;     /* pointer-size */
360         } s23;                      /*     XOR      */
361         val_operand_t       val;    /*  long-size   */
362     } sx;
363     dst_operand_t           dst;    /* pointer-size */
364 #if SIZEOF_VOID_P == 4
365     flags_operand_t         flags;  /* 4 bytes      */
366 #endif
367 };
368
369
370 #define INSTRUCTION_IS_RESOLVED(iptr) \
371         (!((iptr)->flags.bits & INS_FLAG_UNRESOLVED))
372
373 #define INSTRUCTION_IS_UNRESOLVED(iptr) \
374         ((iptr)->flags.bits & INS_FLAG_UNRESOLVED)
375
376 #define INSTRUCTION_MUST_CHECK(iptr) \
377         ((iptr)->flags.bits & INS_FLAG_CHECK)
378
379 #define INSTRUCTION_GET_FIELDREF(iptr,fref) \
380         do { \
381                 if (iptr->flags.bits & INS_FLAG_UNRESOLVED) \
382                         fref = iptr->sx.s23.s3.uf->fieldref; \
383                 else \
384                         fref = iptr->sx.s23.s3.fmiref; \
385         } while (0)
386
387 #define INSTRUCTION_GET_METHODREF(iptr,mref) \
388         do { \
389                 if (iptr->flags.bits & INS_FLAG_UNRESOLVED) \
390                         mref = iptr->sx.s23.s3.um->methodref; \
391                 else \
392                         mref = iptr->sx.s23.s3.fmiref; \
393         } while (0)
394
395 #define INSTRUCTION_GET_METHODDESC(iptr, md) \
396         do { \
397                 if (iptr->flags.bits & INS_FLAG_UNRESOLVED) \
398                         md = iptr->sx.s23.s3.um->methodref->parseddesc.md; \
399                 else \
400                         md = iptr->sx.s23.s3.fmiref->parseddesc.md; \
401         } while (0)
402
403
404 /* additional info structs for special instructions ***************************/
405
406 /* for ICMD_INLINE_START and ICMD_INLINE_END */
407
408 struct insinfo_inline {
409         /* fields copied from the inlining tree ----------------------------------*/
410         insinfo_inline *parent;     /* insinfo of the surrounding inlining, if any*/
411         methodinfo     *method;     /* the inlined method starting/ending here    */
412         methodinfo     *outer;      /* the outer method suspended/resumed here    */
413         s4              synclocal;      /* local index used for synchronization   */
414         bool            synchronize;    /* true if synchronization is needed      */
415         s4              throughcount;   /* total # of pass-through variables      */
416         s4              paramcount;     /* number of parameters of original call  */
417         s4              stackvarscount; /* source stackdepth at INLINE_START      */
418         s4             *stackvars;      /* stack vars at INLINE_START             */
419
420         /* fields set by inlining ------------------------------------------------*/
421         s4         *javalocals_start; /* javalocals at start of inlined body      */
422         s4         *javalocals_end;   /* javalocals after inlined body            */
423
424         /* fields set by replacement point creation ------------------------------*/
425         rplpoint   *rp;             /* replacement point at INLINE_START          */
426
427         /* fields set by the codegen ---------------------------------------------*/
428         s4          startmpc;       /* machine code offset of start of inlining   */
429 };
430
431
432 /* basicblock *****************************************************************/
433
434 /* flags */
435
436 #define BBDELETED            -2
437 #define BBUNDEF              -1
438 #define BBREACHED            0
439 #define BBFINISHED           1
440
441 #define BBTYPECHECK_UNDEF    2
442 #define BBTYPECHECK_REACHED  3
443
444 #define BBTYPE_STD           0  /* standard basic block type                  */
445 #define BBTYPE_EXH           1  /* exception handler basic block type         */
446 #define BBTYPE_SBR           2  /* subroutine basic block type                */
447
448 #define BBFLAG_REPLACEMENT   0x01  /* put a replacement point at the start    */
449
450 /* XXX basicblock wastes quite a lot of memory by having four flag fields     */
451 /* (flags, bitflags, type and lflags). Probably the last three could be       */
452 /* combined without loss of efficiency. The first one could be combined with  */
453 /* the others by using bitfields.                                             */
454
455 /* XXX "flags" should probably be called "state", as it is an integer state   */
456
457 struct basicblock {
458         s4            nr;           /* basic block number                         */
459         s4            flags;        /* used during stack analysis, init with -1   */
460         s4            bitflags;     /* OR of BBFLAG_... constants, init with 0    */
461         s4            type;         /* basic block type (std, xhandler, subroutine*/
462         s4            lflags;       /* used during loop copying, init with 0      */
463
464         s4            icount;       /* number of intermediate code instructions   */
465         instruction  *iinstr;       /* pointer to intermediate code instructions  */
466
467         varinfo      *inlocals;     /* copy of locals on block entry              */
468         s4           *javalocals;   /* map from java locals to cacao variables    */
469         s4           *invars;       /* array of in-variables at begin of block    */
470         s4           *outvars;      /* array of out-variables at end of block     */
471         s4            indepth;      /* stack depth at begin of basic block        */
472         s4            outdepth;     /* stack depth end of basic block             */
473         s4            varstart;     /* index of first non-invar block variable    */
474         s4            varcount;     /* number of non-invar block variables        */
475
476         s4            predecessorcount;
477         s4            successorcount;
478         basicblock  **predecessors; /* array of predecessor basic blocks          */
479         basicblock  **successors;   /* array of successor basic blocks            */
480
481         branchref    *branchrefs;   /* list of branches to be patched             */
482
483         basicblock   *next;         /* used to build a BB list (instead of array) */
484         basicblock   *copied_to;    /* points to the copy of this basic block     */
485                                 /* when loop nodes are copied                 */
486         basicblock   *original;     /* block of which this block is a clone       */
487                                     /* NULL for the original block itself         */
488         methodinfo   *method;       /* method this block belongs to               */
489         insinfo_inline *inlineinfo; /* inlineinfo for the start of this block     */
490
491         s4            mpc;          /* machine code pc at start of block          */
492 };
493
494
495 /* Macro for initializing newly allocated basic block's. It does not
496    need to zero fields, as we zero out the whole basic block array. */
497
498 #define BASICBLOCK_INIT(bptr,m)                        \
499         do {                                               \
500                 bptr->mpc    = -1;                             \
501                 bptr->flags  = -1;                             \
502                 bptr->type   = BBTYPE_STD;                     \
503                 bptr->method = (m);                            \
504         } while (0)
505                         
506
507 /* branchref *****************************************************************/
508
509 struct branchref {
510         s4         branchpos;       /* patching position in code segment          */
511         branchref *next;            /* next element in branchref list             */
512 };
513
514
515 /* data-flow constants for the ICMD table ************************************/
516
517 #define DF_0_TO_0      0
518 #define DF_1_TO_0      1
519 #define DF_2_TO_0      2
520 #define DF_3_TO_0      3
521
522 #define DF_DST_BASE    4      /* from this value on, iptr->dst is a variable */
523
524 #define DF_0_TO_1      (DF_DST_BASE + 0)
525 #define DF_1_TO_1      (DF_DST_BASE + 1)
526 #define DF_2_TO_1      (DF_DST_BASE + 2)
527 #define DF_3_TO_1      (DF_DST_BASE + 3)
528 #define DF_N_TO_1      (DF_DST_BASE + 4)
529
530 #define DF_INVOKE      (DF_DST_BASE + 5)
531 #define DF_BUILTIN     (DF_DST_BASE + 6)
532
533 #define DF_COPY        (DF_DST_BASE + 7)
534 #define DF_MOVE        (DF_DST_BASE + 8)
535
536 #define DF_DUP         -1
537 #define DF_DUP_X1      -1
538 #define DF_DUP_X2      -1
539 #define DF_DUP2        -1
540 #define DF_DUP2_X1     -1
541 #define DF_DUP2_X2     -1
542 #define DF_SWAP        -1
543
544 /* special data-flow recognized by verify/generate.pl: */
545 #define DF_LOAD        DF_COPY
546 #define DF_STORE       DF_MOVE
547 #define DF_IINC        DF_1_TO_1
548 #define DF_POP         DF_1_TO_0
549 #define DF_POP2        DF_2_TO_0
550
551
552 /* control-flow constants for the ICMD table *********************************/
553
554 #define CF_NORMAL      0
555 #define CF_IF          1
556
557 #define CF_END_BASE    2  /* from here on, they mark the end of a superblock */
558
559 #define CF_END         (CF_END_BASE + 0)
560 #define CF_GOTO        (CF_END_BASE + 1)
561 #define CF_TABLE       (CF_END_BASE + 2)
562 #define CF_LOOKUP      (CF_END_BASE + 3)
563 #define CF_JSR         (CF_END_BASE + 4)
564 #define CF_RET         (CF_END_BASE + 5)
565
566
567 /* flag constants for the ICMD table *****************************************/
568
569 #define ICMDTABLE_PEI    0x0001               /* ICMD may throw an exception */
570 #define ICMDTABLE_CALLS  0x0002     /* needs registers to be saved, may call */
571
572
573 /* ICMD table entry **********************************************************/
574
575 typedef struct icmdtable_entry_t icmdtable_entry_t;
576
577 struct icmdtable_entry_t {
578 #if !defined(NDEBUG)
579         char *name;                                /* name, without ICMD_ prefix */
580 #endif
581         s4    dataflow;                             /* a DF_ constant, see above */
582         s4    controlflow;                          /* a CF_ constant, see above */
583         s4    flags;                        /* a combination of ICMDTABLE_ flags */
584 };
585
586
587 /* the ICMD table ************************************************************/
588
589 extern icmdtable_entry_t icmd_table[256];
590
591
592 /********** JavaVM operation codes (sorted) and instruction lengths ***********/
593
594 extern char *opcode_names[256];
595 extern int jcommandsize[256];
596 extern int stackreq[256];
597
598 #define JAVA_NOP               0
599 #define ICMD_NOP               0
600
601 #define JAVA_ACONST_NULL       1
602 #define ICMD_ACONST            1        /* val.a = constant                   */
603
604 #define JAVA_ICONST_M1         2
605 #define ICMD_CHECKNULL         2
606
607 #define JAVA_ICONST_0          3
608 #define ICMD_ICONST            3        /* val.i = constant                   */
609
610 #define JAVA_ICONST_1          4
611
612 #define JAVA_ICONST_2          5
613 #define ICMD_IDIVPOW2          5        /* val.i = constant                   */
614
615 #define JAVA_ICONST_3          6
616 #define ICMD_LDIVPOW2          6        /* val.l = constant                   */
617
618 #define JAVA_ICONST_4          7
619
620 #define JAVA_ICONST_5          8
621
622 #define JAVA_LCONST_0          9
623 #define ICMD_LCONST            9        /* val.l = constant                   */
624
625 #define JAVA_LCONST_1         10
626 #define ICMD_LCMPCONST        10        /* val.l = constant                   */
627
628 #define JAVA_FCONST_0         11
629 #define ICMD_FCONST           11        /* val.f = constant                   */
630
631 #define JAVA_FCONST_1         12
632
633 #define JAVA_FCONST_2         13
634
635 #define JAVA_DCONST_0         14
636 #define ICMD_DCONST           14        /* val.d = constant                   */
637
638 #define JAVA_DCONST_1         15
639 #define ICMD_COPY             15
640
641 #define JAVA_BIPUSH           16
642 #define ICMD_MOVE             16
643
644 #define JAVA_SIPUSH           17
645
646 #define JAVA_LDC1             18
647
648 #define JAVA_LDC2             19
649
650 #define JAVA_LDC2W            20
651
652                                             /* order of LOAD instructions must be */
653                                             /* equal to order of TYPE_* defines   */
654 #define JAVA_ILOAD            21
655 #define ICMD_ILOAD            21        /* op1 = local variable               */
656
657 #define JAVA_LLOAD            22
658 #define ICMD_LLOAD            22        /* op1 = local variable               */
659
660 #define JAVA_FLOAD            23
661 #define ICMD_FLOAD            23        /* op1 = local variable               */
662
663 #define JAVA_DLOAD            24
664 #define ICMD_DLOAD            24        /* op1 = local variable               */
665
666 #define JAVA_ALOAD            25
667 #define ICMD_ALOAD            25        /* op1 = local variable               */
668
669 #define JAVA_ILOAD_0          26
670 #define ICMD_IADDCONST        26        /* val.i = constant                   */
671
672 #define JAVA_ILOAD_1          27
673 #define ICMD_ISUBCONST        27        /* val.i = constant                   */
674
675 #define JAVA_ILOAD_2          28
676 #define ICMD_IMULCONST        28        /* val.i = constant                   */
677
678 #define JAVA_ILOAD_3          29
679 #define ICMD_IANDCONST        29        /* val.i = constant                   */
680
681 #define JAVA_LLOAD_0          30
682 #define ICMD_IORCONST         30        /* val.i = constant                   */
683
684 #define JAVA_LLOAD_1          31
685 #define ICMD_IXORCONST        31        /* val.i = constant                   */
686
687 #define JAVA_LLOAD_2          32
688 #define ICMD_ISHLCONST        32        /* val.i = constant                   */
689
690 #define JAVA_LLOAD_3          33
691 #define ICMD_ISHRCONST        33        /* val.i = constant                   */
692
693 #define JAVA_FLOAD_0          34
694 #define ICMD_IUSHRCONST       34        /* val.i = constant                   */
695
696 #define JAVA_FLOAD_1          35
697 #define ICMD_IREMPOW2         35        /* val.i = constant                   */
698
699 #define JAVA_FLOAD_2          36
700 #define ICMD_LADDCONST        36        /* val.l = constant                   */
701
702 #define JAVA_FLOAD_3          37
703 #define ICMD_LSUBCONST        37        /* val.l = constant                   */
704
705 #define JAVA_DLOAD_0          38
706 #define ICMD_LMULCONST        38        /* val.l = constant                   */
707
708 #define JAVA_DLOAD_1          39
709 #define ICMD_LANDCONST        39        /* val.l = constant                   */
710
711 #define JAVA_DLOAD_2          40
712 #define ICMD_LORCONST         40        /* val.l = constant                   */
713
714 #define JAVA_DLOAD_3          41
715 #define ICMD_LXORCONST        41        /* val.l = constant                   */
716
717 #define JAVA_ALOAD_0          42
718 #define ICMD_LSHLCONST        42        /* val.l = constant                   */
719
720 #define JAVA_ALOAD_1          43
721 #define ICMD_LSHRCONST        43        /* val.l = constant                   */
722
723 #define JAVA_ALOAD_2          44
724 #define ICMD_LUSHRCONST       44        /* val.l = constant                   */
725
726 #define JAVA_ALOAD_3          45
727 #define ICMD_LREMPOW2         45        /* val.l = constant                   */
728
729 #define JAVA_IALOAD           46
730 #define ICMD_IALOAD           46
731
732 #define JAVA_LALOAD           47
733 #define ICMD_LALOAD           47
734
735 #define JAVA_FALOAD           48
736 #define ICMD_FALOAD           48
737
738 #define JAVA_DALOAD           49
739 #define ICMD_DALOAD           49
740
741 #define JAVA_AALOAD           50
742 #define ICMD_AALOAD           50
743
744 #define JAVA_BALOAD           51
745 #define ICMD_BALOAD           51
746
747 #define JAVA_CALOAD           52
748 #define ICMD_CALOAD           52
749
750 #define JAVA_SALOAD           53
751 #define ICMD_SALOAD           53
752
753                                             /* order of STORE instructions must be*/
754                                             /* equal to order of TYPE_* defines   */
755 #define JAVA_ISTORE           54
756 #define ICMD_ISTORE           54        /* op1 = local variable               */
757
758 #define JAVA_LSTORE           55
759 #define ICMD_LSTORE           55        /* op1 = local variable               */
760
761 #define JAVA_FSTORE           56
762 #define ICMD_FSTORE           56        /* op1 = local variable               */
763
764 #define JAVA_DSTORE           57
765 #define ICMD_DSTORE           57        /* op1 = local variable               */
766
767 #define JAVA_ASTORE           58
768 #define ICMD_ASTORE           58        /* op1 = local variable               */
769
770 #define JAVA_ISTORE_0         59
771 #define ICMD_IF_LEQ           59        /* op1 = target JavaVM pc, val.l      */
772
773 #define JAVA_ISTORE_1         60
774 #define ICMD_IF_LNE           60        /* op1 = target JavaVM pc, val.l      */
775
776 #define JAVA_ISTORE_2         61
777 #define ICMD_IF_LLT           61        /* op1 = target JavaVM pc, val.l      */
778
779 #define JAVA_ISTORE_3         62
780 #define ICMD_IF_LGE           62        /* op1 = target JavaVM pc, val.l      */
781
782 #define JAVA_LSTORE_0         63
783 #define ICMD_IF_LGT           63        /* op1 = target JavaVM pc, val.l      */
784
785 #define JAVA_LSTORE_1         64
786 #define ICMD_IF_LLE           64        /* op1 = target JavaVM pc, val.l      */
787
788 #define JAVA_LSTORE_2         65
789 #define ICMD_IF_LCMPEQ        65        /* op1 = target JavaVM pc             */
790
791 #define JAVA_LSTORE_3         66
792 #define ICMD_IF_LCMPNE        66        /* op1 = target JavaVM pc             */
793
794 #define JAVA_FSTORE_0         67
795 #define ICMD_IF_LCMPLT        67        /* op1 = target JavaVM pc             */
796
797 #define JAVA_FSTORE_1         68
798 #define ICMD_IF_LCMPGE        68        /* op1 = target JavaVM pc             */
799
800 #define JAVA_FSTORE_2         69
801 #define ICMD_IF_LCMPGT        69        /* op1 = target JavaVM pc             */
802
803 #define JAVA_FSTORE_3         70
804 #define ICMD_IF_LCMPLE        70        /* op1 = target JavaVM pc             */
805
806 #define JAVA_DSTORE_0         71
807
808 #define JAVA_DSTORE_1         72
809
810 #define JAVA_DSTORE_2         73
811
812 #define JAVA_DSTORE_3         74
813
814 #define JAVA_ASTORE_0         75
815
816 #define JAVA_ASTORE_1         76
817
818 #define JAVA_ASTORE_2         77
819
820 #define JAVA_ASTORE_3         78
821
822 #define JAVA_IASTORE          79
823 #define ICMD_IASTORE          79
824
825 #define JAVA_LASTORE          80
826 #define ICMD_LASTORE          80
827
828 #define JAVA_FASTORE          81
829 #define ICMD_FASTORE          81
830
831 #define JAVA_DASTORE          82
832 #define ICMD_DASTORE          82
833
834 #define JAVA_AASTORE          83
835 #define ICMD_AASTORE          83
836
837 #define JAVA_BASTORE          84
838 #define ICMD_BASTORE          84
839
840 #define JAVA_CASTORE          85
841 #define ICMD_CASTORE          85
842
843 #define JAVA_SASTORE          86
844 #define ICMD_SASTORE          86
845
846 #define JAVA_POP              87
847 #define ICMD_POP              87
848
849 #define JAVA_POP2             88
850 #define ICMD_POP2             88
851
852 #define JAVA_DUP              89
853 #define ICMD_DUP              89
854
855 #define JAVA_DUP_X1           90
856 #define ICMD_DUP_X1           90
857
858 #define JAVA_DUP_X2           91
859 #define ICMD_DUP_X2           91
860
861 #define JAVA_DUP2             92
862 #define ICMD_DUP2             92
863
864 #define JAVA_DUP2_X1          93
865 #define ICMD_DUP2_X1          93
866
867 #define JAVA_DUP2_X2          94
868 #define ICMD_DUP2_X2          94
869
870 #define JAVA_SWAP             95
871 #define ICMD_SWAP             95
872
873 #define JAVA_IADD             96
874 #define ICMD_IADD             96
875
876 #define JAVA_LADD             97
877 #define ICMD_LADD             97
878
879 #define JAVA_FADD             98
880 #define ICMD_FADD             98
881
882 #define JAVA_DADD             99
883 #define ICMD_DADD             99
884
885 #define JAVA_ISUB             100
886 #define ICMD_ISUB             100
887
888 #define JAVA_LSUB             101
889 #define ICMD_LSUB             101
890
891 #define JAVA_FSUB             102
892 #define ICMD_FSUB             102
893
894 #define JAVA_DSUB             103
895 #define ICMD_DSUB             103
896
897 #define JAVA_IMUL             104
898 #define ICMD_IMUL             104
899
900 #define JAVA_LMUL             105
901 #define ICMD_LMUL             105
902
903 #define JAVA_FMUL             106
904 #define ICMD_FMUL             106
905
906 #define JAVA_DMUL             107
907 #define ICMD_DMUL             107
908
909 #define JAVA_IDIV             108
910 #define ICMD_IDIV             108
911
912 #define JAVA_LDIV             109
913 #define ICMD_LDIV             109
914
915 #define JAVA_FDIV             110
916 #define ICMD_FDIV             110
917
918 #define JAVA_DDIV             111
919 #define ICMD_DDIV             111
920
921 #define JAVA_IREM             112
922 #define ICMD_IREM             112
923
924 #define JAVA_LREM             113
925 #define ICMD_LREM             113
926
927 #define JAVA_FREM             114
928 #define ICMD_FREM             114
929
930 #define JAVA_DREM             115
931 #define ICMD_DREM             115
932
933 #define JAVA_INEG             116
934 #define ICMD_INEG             116
935
936 #define JAVA_LNEG             117
937 #define ICMD_LNEG             117
938
939 #define JAVA_FNEG             118
940 #define ICMD_FNEG             118
941
942 #define JAVA_DNEG             119
943 #define ICMD_DNEG             119
944
945 #define JAVA_ISHL             120
946 #define ICMD_ISHL             120
947
948 #define JAVA_LSHL             121
949 #define ICMD_LSHL             121
950
951 #define JAVA_ISHR             122
952 #define ICMD_ISHR             122
953
954 #define JAVA_LSHR             123
955 #define ICMD_LSHR             123
956
957 #define JAVA_IUSHR            124
958 #define ICMD_IUSHR            124
959
960 #define JAVA_LUSHR            125
961 #define ICMD_LUSHR            125
962
963 #define JAVA_IAND             126
964 #define ICMD_IAND             126
965
966 #define JAVA_LAND             127
967 #define ICMD_LAND             127
968
969 #define JAVA_IOR              128
970 #define ICMD_IOR              128
971
972 #define JAVA_LOR              129
973 #define ICMD_LOR              129
974
975 #define JAVA_IXOR             130
976 #define ICMD_IXOR             130
977
978 #define JAVA_LXOR             131
979 #define ICMD_LXOR             131
980
981 #define JAVA_IINC             132
982 #define ICMD_IINC             132   /* op1 = local variable, val.i = constant */
983
984 #define JAVA_I2L              133
985 #define ICMD_I2L              133
986
987 #define JAVA_I2F              134
988 #define ICMD_I2F              134
989
990 #define JAVA_I2D              135
991 #define ICMD_I2D              135
992
993 #define JAVA_L2I              136
994 #define ICMD_L2I              136
995
996 #define JAVA_L2F              137
997 #define ICMD_L2F              137
998
999 #define JAVA_L2D              138
1000 #define ICMD_L2D              138
1001
1002 #define JAVA_F2I              139
1003 #define ICMD_F2I              139
1004
1005 #define JAVA_F2L              140
1006 #define ICMD_F2L              140
1007
1008 #define JAVA_F2D              141
1009 #define ICMD_F2D              141
1010
1011 #define JAVA_D2I              142
1012 #define ICMD_D2I              142
1013
1014 #define JAVA_D2L              143
1015 #define ICMD_D2L              143
1016
1017 #define JAVA_D2F              144
1018 #define ICMD_D2F              144
1019
1020 #define JAVA_INT2BYTE         145
1021 #define ICMD_INT2BYTE         145
1022
1023 #define JAVA_INT2CHAR         146
1024 #define ICMD_INT2CHAR         146
1025
1026 #define JAVA_INT2SHORT        147
1027 #define ICMD_INT2SHORT        147
1028
1029 #define JAVA_LCMP             148
1030 #define ICMD_LCMP             148
1031
1032 #define JAVA_FCMPL            149
1033 #define ICMD_FCMPL            149
1034
1035 #define JAVA_FCMPG            150
1036 #define ICMD_FCMPG            150
1037
1038 #define JAVA_DCMPL            151
1039 #define ICMD_DCMPL            151
1040
1041 #define JAVA_DCMPG            152
1042 #define ICMD_DCMPG            152
1043
1044 #define JAVA_IFEQ             153
1045 #define ICMD_IFEQ             153       /* op1 = target JavaVM pc, val.i      */
1046
1047 #define JAVA_IFNE             154
1048 #define ICMD_IFNE             154       /* op1 = target JavaVM pc, val.i      */
1049
1050 #define JAVA_IFLT             155
1051 #define ICMD_IFLT             155       /* op1 = target JavaVM pc, val.i      */
1052
1053 #define JAVA_IFGE             156
1054 #define ICMD_IFGE             156       /* op1 = target JavaVM pc, val.i      */
1055
1056 #define JAVA_IFGT             157
1057 #define ICMD_IFGT             157       /* op1 = target JavaVM pc, val.i      */
1058
1059 #define JAVA_IFLE             158
1060 #define ICMD_IFLE             158       /* op1 = target JavaVM pc, val.i      */
1061
1062 #define JAVA_IF_ICMPEQ        159
1063 #define ICMD_IF_ICMPEQ        159       /* op1 = target JavaVM pc             */
1064
1065 #define JAVA_IF_ICMPNE        160
1066 #define ICMD_IF_ICMPNE        160       /* op1 = target JavaVM pc             */
1067
1068 #define JAVA_IF_ICMPLT        161
1069 #define ICMD_IF_ICMPLT        161       /* op1 = target JavaVM pc             */
1070
1071 #define JAVA_IF_ICMPGE        162
1072 #define ICMD_IF_ICMPGE        162       /* op1 = target JavaVM pc             */
1073
1074 #define JAVA_IF_ICMPGT        163
1075 #define ICMD_IF_ICMPGT        163       /* op1 = target JavaVM pc             */
1076
1077 #define JAVA_IF_ICMPLE        164
1078 #define ICMD_IF_ICMPLE        164       /* op1 = target JavaVM pc             */
1079
1080 #define JAVA_IF_ACMPEQ        165
1081 #define ICMD_IF_ACMPEQ        165       /* op1 = target JavaVM pc             */
1082
1083 #define JAVA_IF_ACMPNE        166
1084 #define ICMD_IF_ACMPNE        166       /* op1 = target JavaVM pc             */
1085
1086 #define JAVA_GOTO             167
1087 #define ICMD_GOTO             167       /* op1 = target JavaVM pc             */
1088
1089 #define JAVA_JSR              168
1090 #define ICMD_JSR              168       /* op1 = target JavaVM pc             */
1091
1092 #define JAVA_RET              169
1093 #define ICMD_RET              169       /* op1 = local variable               */
1094
1095 #define JAVA_TABLESWITCH      170
1096 #define ICMD_TABLESWITCH      170       /* val.a = pointer to s4 table        */
1097                                         /* length must be computed            */
1098 #define JAVA_LOOKUPSWITCH     171
1099 #define ICMD_LOOKUPSWITCH     171       /* val.a = pointer to s4 table        */
1100                                         /* length must be computed            */
1101 #define JAVA_IRETURN          172
1102 #define ICMD_IRETURN          172
1103
1104 #define JAVA_LRETURN          173
1105 #define ICMD_LRETURN          173
1106
1107 #define JAVA_FRETURN          174
1108 #define ICMD_FRETURN          174
1109
1110 #define JAVA_DRETURN          175
1111 #define ICMD_DRETURN          175
1112
1113 #define JAVA_ARETURN          176
1114 #define ICMD_ARETURN          176
1115
1116 #define JAVA_RETURN           177
1117 #define ICMD_RETURN           177
1118
1119 #define JAVA_GETSTATIC        178
1120 #define ICMD_GETSTATIC        178       /* op1 = type, val.a = field address  */
1121
1122 #define JAVA_PUTSTATIC        179
1123 #define ICMD_PUTSTATIC        179       /* op1 = type, val.a = field address  */
1124
1125 #define JAVA_GETFIELD         180
1126 #define ICMD_GETFIELD         180       /* op1 = type, val.i = field offset   */
1127
1128 #define JAVA_PUTFIELD         181
1129 #define ICMD_PUTFIELD         181       /* op1 = type, val.i = field offset   */
1130
1131 #define JAVA_INVOKEVIRTUAL    182
1132 #define ICMD_INVOKEVIRTUAL    182       /* val.a = method info pointer        */
1133
1134 #define JAVA_INVOKESPECIAL    183
1135 #define ICMD_INVOKESPECIAL    183       /* val.a = method info pointer        */
1136
1137 #define JAVA_INVOKESTATIC     184
1138 #define ICMD_INVOKESTATIC     184       /* val.a = method info pointer        */
1139
1140 #define JAVA_INVOKEINTERFACE  185
1141 #define ICMD_INVOKEINTERFACE  185       /* val.a = method info pointer        */
1142
1143 /* UNDEF186 */
1144
1145 #define JAVA_NEW              187
1146 #define ICMD_NEW              187       /* op1 = 1, val.a = class pointer     */
1147
1148 #define JAVA_NEWARRAY         188
1149 #define ICMD_NEWARRAY         188       /* op1 = basic type                   */
1150
1151 #define JAVA_ANEWARRAY        189
1152 #define ICMD_ANEWARRAY        189       /* op1 = 0, val.a = array pointer     */
1153                                         /* op1 = 1, val.a = class pointer     */
1154 #define JAVA_ARRAYLENGTH      190
1155 #define ICMD_ARRAYLENGTH      190
1156
1157 #define JAVA_ATHROW           191
1158 #define ICMD_ATHROW           191
1159
1160 #define JAVA_CHECKCAST        192
1161 #define ICMD_CHECKCAST        192       /* op1 = 0, val.a = array pointer     */
1162                                         /* op1 = 1, val.a = class pointer     */
1163 #define JAVA_INSTANCEOF       193
1164 #define ICMD_INSTANCEOF       193       /* op1 = 0, val.a = array pointer     */
1165                                         /* op1 = 1, val.a = class pointer     */
1166 #define JAVA_MONITORENTER     194
1167 #define ICMD_MONITORENTER     194
1168
1169 #define JAVA_MONITOREXIT      195
1170 #define ICMD_MONITOREXIT      195
1171
1172 #define JAVA_WIDE             196
1173
1174 #define JAVA_MULTIANEWARRAY   197
1175 #define ICMD_MULTIANEWARRAY   197       /* op1 = dimension, val.a = array     */
1176                                         /* pointer                            */
1177 #define JAVA_IFNULL           198
1178 #define ICMD_IFNULL           198       /* op1 = target JavaVM pc             */
1179
1180 #define JAVA_IFNONNULL        199
1181 #define ICMD_IFNONNULL        199       /* op1 = target JavaVM pc             */
1182
1183 #define JAVA_GOTO_W           200
1184
1185 #define JAVA_JSR_W            201
1186
1187 #define JAVA_BREAKPOINT       202
1188
1189 /* UNDEF203 */
1190
1191 #define ICMD_IASTORECONST     204
1192 #define ICMD_LASTORECONST     205
1193 #define ICMD_FASTORECONST     206
1194 #define ICMD_DASTORECONST     207
1195 #define ICMD_AASTORECONST     208
1196 #define ICMD_BASTORECONST     209
1197 #define ICMD_CASTORECONST     210
1198 #define ICMD_SASTORECONST     211
1199
1200 #define ICMD_PUTSTATICCONST   212
1201 #define ICMD_PUTFIELDCONST    213
1202
1203 #define ICMD_IMULPOW2         214
1204 #define ICMD_LMULPOW2         215
1205
1206 #define ICMD_IF_FCMPEQ        216
1207 #define ICMD_IF_FCMPNE        217
1208
1209 #define ICMD_IF_FCMPL_LT      218
1210 #define ICMD_IF_FCMPL_GE      219
1211 #define ICMD_IF_FCMPL_GT      220
1212 #define ICMD_IF_FCMPL_LE      221
1213
1214 #define ICMD_IF_FCMPG_LT      222
1215 #define ICMD_IF_FCMPG_GE      223
1216 #define ICMD_IF_FCMPG_GT      224
1217 #define ICMD_IF_FCMPG_LE      225
1218
1219 #define ICMD_IF_DCMPEQ        226
1220 #define ICMD_IF_DCMPNE        227
1221
1222 #define ICMD_IF_DCMPL_LT      228
1223 #define ICMD_IF_DCMPL_GE      229
1224 #define ICMD_IF_DCMPL_GT      230
1225 #define ICMD_IF_DCMPL_LE      231
1226
1227 #define ICMD_IF_DCMPG_LT      232
1228 #define ICMD_IF_DCMPG_GE      233
1229 #define ICMD_IF_DCMPG_GT      234
1230 #define ICMD_IF_DCMPG_LE      235
1231
1232 #define ICMD_INLINE_START     251       /* instruction before inlined method  */
1233 #define ICMD_INLINE_END       252       /* instruction after inlined method   */
1234 #define ICMD_INLINE_BODY      253       /* start of inlined body              */
1235
1236 #define ICMD_BUILTIN          255       /* internal opcode                    */
1237
1238
1239 /***************************** register types *********************************/
1240
1241 #define REG_RES   0         /* reserved register for OS or code generator     */
1242 #define REG_RET   1         /* return value register                          */
1243 #define REG_EXC   2         /* exception value register                       */
1244 #define REG_SAV   3         /* (callee) saved register                        */
1245 #define REG_TMP   4         /* scratch temporary register (caller saved)      */
1246 #define REG_ARG   5         /* argument register (caller saved)               */
1247
1248 #define REG_END   -1        /* last entry in tables                           */
1249  
1250 #define PARAMMODE_NUMBERED  0 
1251 #define PARAMMODE_STUFFED   1
1252
1253
1254 /* function prototypes ********************************************************/
1255
1256 /* compiler initialisation */
1257 void jit_init(void);
1258
1259 /* compiler finalisation */
1260 void jit_close(void);
1261
1262 /* create a new jitdata */
1263 jitdata *jit_jitdata_new(methodinfo *m);
1264
1265 /* compile a method with jit compiler */
1266 u1 *jit_compile(methodinfo *m);
1267 u1 *jit_recompile(methodinfo *m);
1268
1269 void jit_invalidate_code(methodinfo *m);
1270 codeinfo *jit_get_current_code(methodinfo *m);
1271 void jit_request_optimization(methodinfo *m);
1272
1273 /* patch the method entrypoint */
1274 u1 *jit_asm_compile(methodinfo *m, u1 *mptr, u1 *sp, u1 *ra);
1275
1276 s4 jit_complement_condition(s4 opcode);
1277
1278 void jit_renumber_basicblocks(jitdata *jd);
1279 #if !defined(NDEBUG)
1280 void jit_check_basicblock_numbers(jitdata *jd);
1281 #endif
1282
1283 /* machine dependent functions */
1284 #if defined(ENABLE_JIT)
1285 void md_init(void);
1286
1287 u1  *md_get_method_patch_address(u1 *ra, stackframeinfo *sfi, u1 *mptr);
1288
1289 void md_cacheflush(u1 *addr, s4 nbytes);
1290 void md_icacheflush(u1 *addr, s4 nbytes);
1291 void md_dcacheflush(u1 *addr, s4 nbytes);
1292 #endif
1293
1294 #if defined(ENABLE_INTRP)
1295 void intrp_md_init(void);
1296 #endif
1297
1298 #endif /* _JIT_H */
1299
1300
1301 /*
1302  * These are local overrides for various environment variables in Emacs.
1303  * Please do not remove this and leave it at the end of the file, where
1304  * Emacs will automagically detect them.
1305  * ---------------------------------------------------------------------
1306  * Local variables:
1307  * mode: c
1308  * indent-tabs-mode: t
1309  * c-basic-offset: 4
1310  * tab-width: 4
1311  * End:
1312  * vim:noexpandtab:sw=4:ts=4:
1313  */