Documentation ¶
Overview ¶
The compile package defines the Skylark bytecode compiler. It is an internal package of the Skylark interpreter and is not directly accessible to clients.
The compiler generates byte code with optional uint32 operands for a virtual machine with the following components:
- a program counter, which is an index into the byte code array.
- an operand stack, whose maximum size is computed for each function by the compiler.
- an stack of active iterators.
- an array of local variables. The number of local variables and their indices are computed by the resolver.
- an array of free variables, for nested functions. As with locals, these are computed by the resolver.
- an array of global variables, shared among all functions in the same module. All elements are initially nil.
- two maps of predeclared and universal identifiers.
A line number table maps each program counter value to a source position; these source positions do not currently record column information.
Operands, logically uint32s, are encoded using little-endian 7-bit varints, the top bit indicating that more bytes follow.
Index ¶
Constants ¶
const Version = 3
Increment this to force recompilation of saved bytecode files.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Funcode ¶
type Funcode struct { Prog *Program Pos syntax.Position // position of def or lambda token Name string // name of this function Code []byte // the byte code Locals []Ident // for error messages and tracing Freevars []Ident // for tracing MaxStack int NumParams int HasVarargs, HasKwargs bool // contains filtered or unexported fields }
A Funcode is the code of a compiled Skylark function.
Funcodes are serialized by the gobFunc function, which must be updated whenever this declaration is changed.
type Opcode ¶
type Opcode uint8
const ( NOP Opcode = iota // - NOP - // stack operations DUP // x DUP x x DUP2 // x y DUP2 x y x y POP // x POP - EXCH // x y EXCH y x // binary comparisons // (order must match Token) LT GT GE LE EQL NEQ // binary arithmetic // (order must match Token) PLUS MINUS STAR SLASH SLASHSLASH PERCENT AMP PIPE CIRCUMFLEX LTLT GTGT IN // unary operators UPLUS // x UPLUS x UMINUS // x UMINUS -x TILDE // x TILDE ~x NONE // - NONE None TRUE // - TRUE True FALSE // - FALSE False ITERPUSH // iterable ITERPUSH - [pushes the iterator stack] ITERPOP // - ITERPOP - [pops the iterator stack] NOT // value NOT bool RETURN // value RETURN - SETINDEX // a i new SETINDEX - INDEX // a i INDEX elem SETDICT // dict key value SETDICT - SETDICTUNIQ // dict key value SETDICTUNIQ - APPEND // list elem APPEND - SLICE // x lo hi step SLICE slice INPLACE_ADD // x y INPLACE_ADD z where z is x+y or x.extend(y) MAKEDICT // - MAKEDICT dict // control flow JMP // - JMP<addr> - CJMP // cond CJMP<addr> - ITERJMP // - ITERJMP<addr> elem (and fall through) [acts on topmost iterator] CONSTANT // - CONSTANT<constant> value MAKETUPLE // x1 ... xn MAKETUPLE<n> tuple MAKELIST // x1 ... xn MAKELIST<n> list MAKEFUNC // args kwargs MAKEFUNC<func> fn LOAD // from1 ... fromN module LOAD<n> v1 ... vN SETLOCAL // value SETLOCAL<local> - SETGLOBAL // value SETGLOBAL<global> - LOCAL // - LOCAL<local> value FREE // - FREE<freevar> value GLOBAL // - GLOBAL<global> value PREDECLARED // - PREDECLARED<name> value UNIVERSAL // - UNIVERSAL<name> value ATTR // x ATTR<name> y y = x.name SETFIELD // x y SETFIELD<name> - x.name = y UNPACK // iterable UNPACK<n> vn ... v1 // n>>8 is #positional args and n&0xff is #named args (pairs). CALL // fn positional named CALL<n> result CALL_VAR // fn positional named *args CALL_VAR<n> result CALL_KW // fn positional named **kwargs CALL_KW<n> result CALL_VAR_KW // fn positional named *args **kwargs CALL_VAR_KW<n> result OpcodeArgMin = JMP OpcodeMax = CALL_VAR_KW )
"x DUP x x" is a "stack picture" that describes the state of the stack before and after execution of the instruction.
OP<index> indicates an immediate operand that is an index into the specified table: locals, names, freevars, constants.
type Program ¶
type Program struct { Loads []Ident // name (really, string) and position of each load stmt Names []string // names of attributes and predeclared variables Constants []interface{} // = string | int64 | float64 | *big.Int Functions []*Funcode Globals []Ident // for error messages and tracing Toplevel *Funcode // module initialization function }
A Program is a Skylark file in executable form.
Programs are serialized by the gobProgram function, which must be updated whenever this declaration is changed.
func ReadProgram ¶
ReadProgram reads a compiled Skylark program from in.