/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is Mozilla Communicator client code, released * March 31, 1998. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1998 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * Alternatively, the contents of this file may be used under the terms of * either of the GNU General Public License Version 2 or later (the "GPL"), * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef jsopcode_h___ #define jsopcode_h___ /* * JS bytecode definitions. */ #include #include "jsprvtd.h" #include "jspubtd.h" #include "jsutil.h" JS_BEGIN_EXTERN_C /* * JS operation bytecodes. */ typedef enum JSOp { #define OPDEF(op,val,name,token,length,nuses,ndefs,prec,format) \ op = val, #include "jsopcode.tbl" #undef OPDEF JSOP_LIMIT } JSOp; typedef enum JSOpLength { #define OPDEF(op,val,name,token,length,nuses,ndefs,prec,format) \ op##_LENGTH = length, #include "jsopcode.tbl" #undef OPDEF JSOP_LIMIT_LENGTH } JSOpLength; /* * JS bytecode formats. */ #define JOF_BYTE 0 /* single bytecode, no immediates */ #define JOF_JUMP 1 /* signed 16-bit jump offset immediate */ #define JOF_CONST 2 /* unsigned 16-bit constant pool index */ #define JOF_UINT16 3 /* unsigned 16-bit immediate operand */ #define JOF_TABLESWITCH 4 /* table switch */ #define JOF_LOOKUPSWITCH 5 /* lookup switch */ #define JOF_QARG 6 /* quickened get/set function argument ops */ #define JOF_QVAR 7 /* quickened get/set local variable ops */ #define JOF_INDEXCONST 8 /* uint16 slot index + constant pool index */ #define JOF_JUMPX 9 /* signed 32-bit jump offset immediate */ #define JOF_TABLESWITCHX 10 /* extended (32-bit offset) table switch */ #define JOF_LOOKUPSWITCHX 11 /* extended (32-bit offset) lookup switch */ #define JOF_UINT24 12 /* extended unsigned 24-bit literal (index) */ #define JOF_LITOPX 13 /* JOF_UINT24 followed by op being extended, where op if JOF_CONST has no unsigned 16- bit immediate operand */ #define JOF_LOCAL 14 /* block-local operand stack variable */ #define JOF_TYPEMASK 0x000f /* mask for above immediate types */ #define JOF_NAME 0x0010 /* name operation */ #define JOF_PROP 0x0020 /* obj.prop operation */ #define JOF_ELEM 0x0030 /* obj[index] operation */ #define JOF_MODEMASK 0x0030 /* mask for above addressing modes */ #define JOF_SET 0x0040 /* set (i.e., assignment) operation */ #define JOF_DEL 0x0080 /* delete operation */ #define JOF_DEC 0x0100 /* decrement (--, not ++) opcode */ #define JOF_INC 0x0200 /* increment (++, not --) opcode */ #define JOF_INCDEC 0x0300 /* increment or decrement opcode */ #define JOF_POST 0x0400 /* postorder increment or decrement */ #define JOF_IMPORT 0x0800 /* import property op */ #define JOF_FOR 0x1000 /* for-in property op */ #define JOF_ASSIGNING JOF_SET /* hint for JSClass.resolve, used for ops that do simplex assignment */ #define JOF_DETECTING 0x2000 /* object detection flag for JSNewResolveOp */ #define JOF_BACKPATCH 0x4000 /* backpatch placeholder during codegen */ #define JOF_LEFTASSOC 0x8000 /* left-associative operator */ #define JOF_DECLARING 0x10000 /* var, const, or function declaration op */ #define JOF_XMLNAME 0x20000 /* XML name: *, a::b, @a, @a::b, etc. */ #define JOF_TYPE_IS_EXTENDED_JUMP(t) \ ((unsigned)((t) - JOF_JUMPX) <= (unsigned)(JOF_LOOKUPSWITCHX - JOF_JUMPX)) /* * Immediate operand getters, setters, and bounds. */ /* Short (2-byte signed offset) relative jump macros. */ #define JUMP_OFFSET_LEN 2 #define JUMP_OFFSET_HI(off) ((jsbytecode)((off) >> 8)) #define JUMP_OFFSET_LO(off) ((jsbytecode)(off)) #define GET_JUMP_OFFSET(pc) ((int16)(((pc)[1] << 8) | (pc)[2])) #define SET_JUMP_OFFSET(pc,off) ((pc)[1] = JUMP_OFFSET_HI(off), \ (pc)[2] = JUMP_OFFSET_LO(off)) #define JUMP_OFFSET_MIN ((int16)0x8000) #define JUMP_OFFSET_MAX ((int16)0x7fff) /* * When a short jump won't hold a relative offset, its 2-byte immediate offset * operand is an unsigned index of a span-dependency record, maintained until * code generation finishes -- after which some (but we hope not nearly all) * span-dependent jumps must be extended (see OptimizeSpanDeps in jsemit.c). * * If the span-dependency record index overflows SPANDEP_INDEX_MAX, the jump * offset will contain SPANDEP_INDEX_HUGE, indicating that the record must be * found (via binary search) by its "before span-dependency optimization" pc * offset (from script main entry point). */ #define GET_SPANDEP_INDEX(pc) ((uint16)(((pc)[1] << 8) | (pc)[2])) #define SET_SPANDEP_INDEX(pc,i) ((pc)[1] = JUMP_OFFSET_HI(i), \ (pc)[2] = JUMP_OFFSET_LO(i)) #define SPANDEP_INDEX_MAX ((uint16)0xfffe) #define SPANDEP_INDEX_HUGE ((uint16)0xffff) /* Ultimately, if short jumps won't do, emit long (4-byte signed) offsets. */ #define JUMPX_OFFSET_LEN 4 #define JUMPX_OFFSET_B3(off) ((jsbytecode)((off) >> 24)) #define JUMPX_OFFSET_B2(off) ((jsbytecode)((off) >> 16)) #define JUMPX_OFFSET_B1(off) ((jsbytecode)((off) >> 8)) #define JUMPX_OFFSET_B0(off) ((jsbytecode)(off)) #define GET_JUMPX_OFFSET(pc) ((int32)(((pc)[1] << 24) | ((pc)[2] << 16) \ | ((pc)[3] << 8) | (pc)[4])) #define SET_JUMPX_OFFSET(pc,off)((pc)[1] = JUMPX_OFFSET_B3(off), \ (pc)[2] = JUMPX_OFFSET_B2(off), \ (pc)[3] = JUMPX_OFFSET_B1(off), \ (pc)[4] = JUMPX_OFFSET_B0(off)) #define JUMPX_OFFSET_MIN ((int32)0x80000000) #define JUMPX_OFFSET_MAX ((int32)0x7fffffff) /* * A literal is indexed by a per-script atom map. Most scripts have relatively * few literals, so the standard JOF_CONST format specifies a fixed 16 bits of * immediate operand index. A script with more than 64K literals must push all * high-indexed literals on the stack using JSOP_LITERAL, then use JOF_ELEM ops * instead of JOF_PROP, etc. */ #define ATOM_INDEX_LEN 2 #define ATOM_INDEX_HI(i) ((jsbytecode)((i) >> 8)) #define ATOM_INDEX_LO(i) ((jsbytecode)(i)) #define GET_ATOM_INDEX(pc) ((jsatomid)(((pc)[1] << 8) | (pc)[2])) #define SET_ATOM_INDEX(pc,i) ((pc)[1] = ATOM_INDEX_HI(i), \ (pc)[2] = ATOM_INDEX_LO(i)) #define GET_ATOM(cx,script,pc) js_GetAtom((cx), &(script)->atomMap, \ GET_ATOM_INDEX(pc)) /* A full atom index for JSOP_UINT24 uses 24 bits of immediate operand. */ #define UINT24_HI(i) ((jsbytecode)((i) >> 16)) #define UINT24_MID(i) ((jsbytecode)((i) >> 8)) #define UINT24_LO(i) ((jsbytecode)(i)) #define GET_UINT24(pc) ((jsatomid)(((pc)[1] << 16) | \ ((pc)[2] << 8) | \ (pc)[3])) #define SET_UINT24(pc,i) ((pc)[1] = UINT24_HI(i), \ (pc)[2] = UINT24_MID(i), \ (pc)[3] = UINT24_LO(i)) /* Same format for JSOP_LITERAL, etc., but future-proof with different names. */ #define LITERAL_INDEX_LEN 3 #define LITERAL_INDEX_HI(i) UINT24_HI(i) #define LITERAL_INDEX_MID(i) UINT24_MID(i) #define LITERAL_INDEX_LO(i) UINT24_LO(i) #define GET_LITERAL_INDEX(pc) GET_UINT24(pc) #define SET_LITERAL_INDEX(pc,i) SET_UINT24(pc,i) /* Atom index limit is determined by SN_3BYTE_OFFSET_FLAG, see jsemit.h. */ #define ATOM_INDEX_LIMIT_LOG2 23 #define ATOM_INDEX_LIMIT ((uint32)1 << ATOM_INDEX_LIMIT_LOG2) JS_STATIC_ASSERT(sizeof(jsatomid) * JS_BITS_PER_BYTE >= ATOM_INDEX_LIMIT_LOG2 + 1); /* Common uint16 immediate format helpers. */ #define UINT16_HI(i) ((jsbytecode)((i) >> 8)) #define UINT16_LO(i) ((jsbytecode)(i)) #define GET_UINT16(pc) ((uintN)(((pc)[1] << 8) | (pc)[2])) #define SET_UINT16(pc,i) ((pc)[1] = UINT16_HI(i), (pc)[2] = UINT16_LO(i)) #define UINT16_LIMIT ((uintN)1 << 16) /* Actual argument count operand format helpers. */ #define ARGC_HI(argc) UINT16_HI(argc) #define ARGC_LO(argc) UINT16_LO(argc) #define GET_ARGC(pc) GET_UINT16(pc) #define ARGC_LIMIT UINT16_LIMIT /* Synonyms for quick JOF_QARG and JOF_QVAR bytecodes. */ #define GET_ARGNO(pc) GET_UINT16(pc) #define SET_ARGNO(pc,argno) SET_UINT16(pc,argno) #define ARGNO_LEN 2 #define ARGNO_LIMIT UINT16_LIMIT #define GET_VARNO(pc) GET_UINT16(pc) #define SET_VARNO(pc,varno) SET_UINT16(pc,varno) #define VARNO_LEN 2 #define VARNO_LIMIT UINT16_LIMIT struct JSCodeSpec { const char *name; /* JS bytecode name */ const char *token; /* JS source literal or null */ int8 length; /* length including opcode byte */ int8 nuses; /* arity, -1 if variadic */ int8 ndefs; /* number of stack results */ uint8 prec; /* operator precedence */ uint32 format; /* immediate operand format */ }; extern const JSCodeSpec js_CodeSpec[]; extern uintN js_NumCodeSpecs; extern const jschar js_EscapeMap[]; /* * Return a GC'ed string containing the chars in str, with any non-printing * chars or quotes (' or " as specified by the quote argument) escaped, and * with the quote character at the beginning and end of the result string. */ extern JSString * js_QuoteString(JSContext *cx, JSString *str, jschar quote); /* * JSPrinter operations, for printf style message formatting. The return * value from js_GetPrinterOutput() is the printer's cumulative output, in * a GC'ed string. */ extern JSPrinter * js_NewPrinter(JSContext *cx, const char *name, uintN indent, JSBool pretty); extern void js_DestroyPrinter(JSPrinter *jp); extern JSString * js_GetPrinterOutput(JSPrinter *jp); extern int js_printf(JSPrinter *jp, const char *format, ...); extern JSBool js_puts(JSPrinter *jp, const char *s); #ifdef DEBUG /* * Disassemblers, for debugging only. */ #include extern JS_FRIEND_API(JSBool) js_Disassemble(JSContext *cx, JSScript *script, JSBool lines, FILE *fp); extern JS_FRIEND_API(uintN) js_Disassemble1(JSContext *cx, JSScript *script, jsbytecode *pc, uintN loc, JSBool lines, FILE *fp); #endif /* DEBUG */ /* * Decompilers, for script, function, and expression pretty-printing. */ extern JSBool js_DecompileCode(JSPrinter *jp, JSScript *script, jsbytecode *pc, uintN len, uintN pcdepth); extern JSBool js_DecompileScript(JSPrinter *jp, JSScript *script); extern JSBool js_DecompileFunctionBody(JSPrinter *jp, JSFunction *fun); extern JSBool js_DecompileFunction(JSPrinter *jp, JSFunction *fun); /* * Find the source expression that resulted in v, and return a new string * containing it. Fall back on v's string conversion (fallback) if we can't * find the bytecode that generated and pushed v on the operand stack. * * Search the current stack frame if spindex is JSDVG_SEARCH_STACK. Don't * look for v on the stack if spindex is JSDVG_IGNORE_STACK. Otherwise, * spindex is the negative index of v, measured from cx->fp->sp, or from a * lower frame's sp if cx->fp is native. */ extern JSString * js_DecompileValueGenerator(JSContext *cx, intN spindex, jsval v, JSString *fallback); #define JSDVG_IGNORE_STACK 0 #define JSDVG_SEARCH_STACK 1 JS_END_EXTERN_C #endif /* jsopcode_h___ */