simgear/nasal/code.c

   1 #include "nasal.h"
   2 #include "code.h"
   3
   4 ////////////////////////////////////////////////////////////////////////
   5 // Debugging stuff. ////////////////////////////////////////////////////
   6 ////////////////////////////////////////////////////////////////////////
   7 #if !defined(DEBUG_NASAL)
   8 # define DBG(expr) /* noop */
   9 #else
  10 # define DBG(expr) expr
  11 # include <stdio.h>
  12 # include <stdlib.h>
  13 #endif
  14 char* opStringDEBUG(int op);
  15 void printOpDEBUG(int ip, int op);
  16 void printRefDEBUG(naRef r);
  17 void printStackDEBUG(struct Context* ctx);
  18 ////////////////////////////////////////////////////////////////////////
  19
  20 // FIXME: need to store a list of all contexts
  21 struct Context globalContext;
  22
  23 #define ERR(c, msg) naRuntimeError((c),(msg))
  24 void naRuntimeError(struct Context* c, char* msg)
  25 {
  26     c->error = msg;
  27     longjmp(c->jumpHandle, 1);
  28 }
  29
  30 int boolify(struct Context* ctx, naRef r)
  31 {
  32     if(IS_NIL(r)) return 0;
  33     if(IS_NUM(r)) return r.num != 0;
  34     if(IS_STR(r)) return 1;
  35     ERR(ctx, "non-scalar used in boolean context");
  36     return 0;
  37 }
  38
  39 static double numify(struct Context* ctx, naRef o)
  40 {
  41     double n;
  42     if(IS_NUM(o)) return o.num;
  43     else if(IS_NIL(o)) ERR(ctx, "nil used in numeric context");
  44     else if(!IS_STR(o)) ERR(ctx, "non-scalar in numeric context");
  45     else if(naStr_tonum(o, &n)) return n;
  46     else ERR(ctx, "non-numeric string in numeric context");
  47     return 0;
  48 }
  49
  50 static naRef stringify(struct Context* ctx, naRef r)
  51 {
  52     if(IS_STR(r)) return r;
  53     if(IS_NUM(r)) return naStr_fromnum(naNewString(ctx), r.num);
  54     ERR(ctx, "non-scalar in string context");
  55     return naNil();
  56 }
  57
  58 static int checkVec(struct Context* ctx, naRef vec, naRef idx)
  59 {
  60     int i = (int)numify(ctx, idx);
  61     if(i < 0 || i >= vec.ref.ptr.vec->size)
  62         ERR(ctx, "vector index out of bounds");
  63     return i;
  64 }
  65
  66 static naRef containerGet(struct Context* ctx, naRef box, naRef key)
  67 {
  68     naRef result = naNil();
  69     if(!IS_SCALAR(key)) ERR(ctx, "container index not scalar");
  70     if(IS_HASH(box)) {
  71         if(!naHash_get(box, key, &result))
  72             ERR(ctx, "undefined value in container");
  73     } else if(IS_VEC(box)) {
  74         result = naVec_get(box, checkVec(ctx, box, key));
  75     } else {
  76         ERR(ctx, "extract from non-container");
  77     }
  78     return result;
  79 }
  80
  81 static void containerSet(struct Context* ctx, naRef box, naRef key, naRef val)
  82 {
  83     if(!IS_SCALAR(key))   ERR(ctx, "container index not scalar");
  84     else if(IS_HASH(box)) naHash_set(box, key, val);
  85     else if(IS_VEC(box))  naVec_set(box, checkVec(ctx, box, key), val);
  86     else                  ERR(ctx, "insert into non-container");
  87 }
  88
  89 static void initContext(struct Context* c)
  90 {
  91     int i;
  92     for(i=0; i<NUM_NASAL_TYPES; i++)
  93         naGC_init(&(c->pools[i]), i);
  94
  95     c->fTop = c->opTop = c->markTop = 0;
  96
  97     naBZero(c->fStack, MAX_RECURSION * sizeof(struct Frame));
  98     naBZero(c->opStack, MAX_STACK_DEPTH * sizeof(naRef));
  99
 100     // Make sure the args vectors (which are static with the context)
 101     // are initialized to nil.
 102     for(i=0; i<MAX_RECURSION; i++)
 103         c->fStack[i].args = naNil();
 104
 105     // Note we can't use naNewVector() for this; it requires that
 106     // temps exist first.
 107     c->temps = naObj(T_VEC, naGC_get(&(c->pools[T_VEC])));
 108
 109     c->save = naNil();
 110
 111     // Cache pre-calculated "me", "arg" and "parents" scalars
 112     c->meRef = naStr_fromdata(naNewString(c), "me", 2);
 113     c->argRef = naStr_fromdata(naNewString(c), "arg", 3);
 114     c->parentsRef = naStr_fromdata(naNewString(c), "parents", 7);
 115 }
 116
 117 struct Context* naNewContext()
 118 {
 119     // FIXME: need more than one!
 120     struct Context* c = &globalContext;
 121     initContext(c);
 122     return c;
 123 }
 124
 125 void naGarbageCollect()
 126 {
 127     int i;
 128     struct Context* c = &globalContext; // FIXME: more than one!
 129
 130     for(i=0; i < c->fTop; i++) {
 131         naGC_mark(c->fStack[i].func);
 132         naGC_mark(c->fStack[i].locals);
 133     }
 134     for(i=0; i < MAX_RECURSION; i++)
 135         naGC_mark(c->fStack[i].args); // collect *all* the argument lists
 136     for(i=0; i < c->opTop; i++)
 137         naGC_mark(c->opStack[i]);
 138
 139     naGC_mark(c->temps);
 140     naGC_mark(c->save);
 141
 142     naGC_mark(c->meRef);
 143     naGC_mark(c->argRef);
 144     naGC_mark(c->parentsRef);
 145
 146     // Finally collect all the freed objects
 147     for(i=0; i<NUM_NASAL_TYPES; i++)
 148         naGC_reap(&(c->pools[i]));
 149 }
 150
 151 void setupFuncall(struct Context* ctx, naRef func, naRef args)
 152 {
 153     if(!IS_FUNC(func) ||
 154        !(IS_CCODE(func.ref.ptr.func->code) ||
 155          IS_CODE(func.ref.ptr.func->code)))
 156     {
 157         ERR(ctx, "function/method call invoked on uncallable object");
 158     }
 159
 160     struct Frame* f;
 161     f = &(ctx->fStack[ctx->fTop++]);
 162     f->func = func;
 163     f->ip = 0;
 164     f->bp = ctx->opTop;
 165     f->line = 0;
 166
 167     DBG(printf("Entering frame %d\n", ctx->fTop-1);)
 168
 169     f->args = args;
 170     if(IS_CCODE(func.ref.ptr.func->code)) {
 171         f->locals = naNil();
 172     } else if(IS_CODE(func.ref.ptr.func->code)) {
 173         f->locals = naNewHash(ctx);
 174         naHash_set(f->locals, ctx->argRef, args);
 175     }
 176 }
 177
 178 static naRef evalAndOr(struct Context* ctx, int op, naRef ra, naRef rb)
 179 {
 180     int a = boolify(ctx, ra);
 181     int b = boolify(ctx, rb);
 182     int result;
 183     if(op == OP_AND) result = a && b ? 1 : 0;
 184     else             result = a || b ? 1 : 0;
 185     return naNum(result);
 186 }
 187
 188 static naRef evalEquality(int op, naRef ra, naRef rb)
 189 {
 190     int result = naEqual(ra, rb);
 191     return naNum((op==OP_EQ) ? result : !result);
 192 }
 193
 194 static naRef evalBinaryNumeric(struct Context* ctx, int op, naRef ra, naRef rb)
 195 {
 196     double a = numify(ctx, ra), b = numify(ctx, rb);
 197     switch(op) {
 198     case OP_PLUS:  return naNum(a + b);
 199     case OP_MINUS: return naNum(a - b);
 200     case OP_MUL:   return naNum(a * b);
 201     case OP_DIV:   return naNum(a / b);
 202     case OP_LT:    return naNum(a < b ? 1 : 0);
 203     case OP_LTE:   return naNum(a <= b ? 1 : 0);
 204     case OP_GT:    return naNum(a > b ? 1 : 0);
 205     case OP_GTE:   return naNum(a >= b ? 1 : 0);
 206     }
 207     return naNil();
 208 }
 209
 210 // When a code object comes out of the constant pool and shows up on
 211 // the stack, it needs to be bound with the lexical context.
 212 static naRef bindFunction(struct Context* ctx, struct Frame* f, naRef code)
 213 {
 214     naRef next = f->func.ref.ptr.func->closure;
 215     naRef closure = naNewClosure(ctx, f->locals, next);
 216     naRef result = naNewFunc(ctx, code);
 217     result.ref.ptr.func->closure = closure;
 218     return result;
 219 }
 220
 221 static int getClosure(struct naClosure* c, naRef sym, naRef* result)
 222 {
 223     while(c) {
 224         if(naHash_get(c->namespace, sym, result)) return 1;
 225         c = c->next.ref.ptr.closure;
 226     }
 227     return 0;
 228 }
 229
 230 // Get a local symbol, or check the closure list if it isn't there
 231 static naRef getLocal(struct Context* ctx, struct Frame* f, naRef sym)
 232 {
 233     naRef result;
 234     if(!naHash_get(f->locals, sym, &result)) {
 235         naRef c = f->func.ref.ptr.func->closure;
 236         if(!getClosure(c.ref.ptr.closure, sym, &result))
 237             ERR(ctx, "undefined symbol");
 238     }
 239     return result;
 240 }
 241
 242 static int setClosure(naRef closure, naRef sym, naRef val)
 243 {
 244     struct naClosure* c = closure.ref.ptr.closure;
 245     if(c == 0) { return 0; }
 246     else if(naHash_tryset(c->namespace, sym, val)) { return 1; }
 247     else { return setClosure(c->next, sym, val); }
 248 }
 249
 250 static naRef setLocal(struct Frame* f, naRef sym, naRef val)
 251 {
 252     // Try the locals first, if not already there try the closures in
 253     // order.  Finally put it in the locals if nothing matched.
 254     if(!naHash_tryset(f->locals, sym, val))
 255         if(!setClosure(f->func.ref.ptr.func->closure, sym, val))
 256             naHash_set(f->locals, sym, val);
 257     return val;
 258 }
 259
 260 // Recursively descend into the parents lists
 261 static int getMember(struct Context* ctx, naRef obj, naRef fld, naRef* result)
 262 {
 263     naRef p;
 264     if(!IS_HASH(obj)) ERR(ctx, "non-objects have no members");
 265     if(naHash_get(obj, fld, result)) {
 266         return 1;
 267     } else if(naHash_get(obj, ctx->parentsRef, &p)) {
 268         int i;
 269         if(!IS_VEC(p)) ERR(ctx, "parents field not vector");
 270         for(i=0; i<p.ref.ptr.vec->size; i++)
 271             if(getMember(ctx, p.ref.ptr.vec->array[i], fld, result))
 272                 return 1;
 273     }
 274     return 0;
 275 }
 276
 277 static void PUSH(struct Context* ctx, naRef r)
 278 {
 279     if(ctx->opTop >= MAX_STACK_DEPTH) ERR(ctx, "stack overflow");
 280     ctx->opStack[ctx->opTop++] = r;
 281 }
 282
 283 static naRef POP(struct Context* ctx)
 284 {
 285     if(ctx->opTop == 0) ERR(ctx, "BUG: stack underflow");
 286     return ctx->opStack[--ctx->opTop];
 287 }
 288
 289 static naRef TOP(struct Context* ctx)
 290 {
 291     if(ctx->opTop == 0) ERR(ctx, "BUG: stack underflow");
 292     return ctx->opStack[ctx->opTop-1];
 293 }
 294
 295 static int ARG16(unsigned char* byteCode, struct Frame* f)
 296 {
 297     int arg = byteCode[f->ip]<<8 | byteCode[f->ip+1];
 298     f->ip += 2;
 299     return arg;
 300 }
 301
 302 // OP_EACH works like a vector get, except that it leaves the vector
 303 // and index on the stack, increments the index after use, and pops
 304 // the arguments and pushes a nil if the index is beyond the end.
 305 static void evalEach(struct Context* ctx)
 306 {
 307     int idx = (int)(ctx->opStack[ctx->opTop-1].num);
 308     naRef vec = ctx->opStack[ctx->opTop-2];
 309     if(idx >= vec.ref.ptr.vec->size) {
 310         ctx->opTop -= 2; // pop two values
 311         PUSH(ctx, naNil());
 312         return;
 313     }
 314     ctx->opStack[ctx->opTop-1].num = idx+1; // modify in place
 315     PUSH(ctx, naVec_get(vec, idx));
 316 }
 317
 318 static void run1(struct Context* ctx, struct Frame* f, naRef code)
 319 {
 320     naRef a, b, c;
 321     struct naCode* cd = code.ref.ptr.code;
 322     int op, arg;
 323
 324     if(f->ip >= cd->nBytes) {
 325         DBG(printf("Done with frame %d\n", ctx->fTop-1);)
 326         ctx->fTop--;
 327         if(ctx->fTop <= 0)
 328             ctx->done = 1;
 329         return;
 330     }
 331
 332     op = cd->byteCode[f->ip++];
 333     DBG(printf("Stack Depth: %d\n", ctx->opTop));
 334     DBG(printOpDEBUG(f->ip-1, op));
 335     switch(op) {
 336     case OP_POP:
 337         POP(ctx);
 338         break;
 339     case OP_DUP:
 340         PUSH(ctx, ctx->opStack[ctx->opTop-1]);
 341         break;
 342     case OP_XCHG:
 343         a = POP(ctx); b = POP(ctx);
 344         PUSH(ctx, a); PUSH(ctx, b);
 345         break;
 346     case OP_PLUS: case OP_MUL: case OP_DIV: case OP_MINUS:
 347     case OP_LT: case OP_LTE: case OP_GT: case OP_GTE:
 348         a = POP(ctx); b = POP(ctx);
 349         PUSH(ctx, evalBinaryNumeric(ctx, op, b, a));
 350         break;
 351     case OP_EQ: case OP_NEQ:
 352         a = POP(ctx); b = POP(ctx);
 353         PUSH(ctx, evalEquality(op, b, a));
 354         break;
 355     case OP_AND: case OP_OR:
 356         a = POP(ctx); b = POP(ctx);
 357         PUSH(ctx, evalAndOr(ctx, op, a, b));
 358         break;
 359     case OP_CAT:
 360         // stringify can call the GC, so don't take stuff of the stack!
 361         if(ctx->opTop <= 1) ERR(ctx, "BUG: stack underflow");
 362         a = stringify(ctx, ctx->opStack[ctx->opTop-1]);
 363         b = stringify(ctx, ctx->opStack[ctx->opTop-2]);
 364         c = naStr_concat(naNewString(ctx), b, a);
 365         ctx->opTop -= 2;
 366         PUSH(ctx, c);
 367         break;
 368     case OP_NEG:
 369         a = POP(ctx);
 370         PUSH(ctx, naNum(-numify(ctx, a)));
 371         break;
 372     case OP_NOT:
 373         a = POP(ctx);
 374         PUSH(ctx, naNum(boolify(ctx, a) ? 0 : 1));
 375         break;
 376     case OP_PUSHCONST:
 377         a = cd->constants[ARG16(cd->byteCode, f)];
 378         if(IS_CODE(a)) a = bindFunction(ctx, f, a);
 379         PUSH(ctx, a);
 380         break;
 381     case OP_PUSHONE:
 382         PUSH(ctx, naNum(1));
 383         break;
 384     case OP_PUSHZERO:
 385         PUSH(ctx, naNum(0));
 386         break;
 387     case OP_PUSHNIL:
 388         PUSH(ctx, naNil());
 389         break;
 390     case OP_NEWVEC:
 391         PUSH(ctx, naNewVector(ctx));
 392         break;
 393     case OP_VAPPEND:
 394         b = POP(ctx); a = TOP(ctx);
 395         naVec_append(a, b);
 396         break;
 397     case OP_NEWHASH:
 398         PUSH(ctx, naNewHash(ctx));
 399         break;
 400     case OP_HAPPEND:
 401         c = POP(ctx); b = POP(ctx); a = TOP(ctx); // a,b,c: hash, key, val
 402         naHash_set(a, b, c);
 403         break;
 404     case OP_LOCAL:
 405         a = getLocal(ctx, f, POP(ctx));
 406         PUSH(ctx, a);
 407         break;
 408     case OP_SETLOCAL:
 409         a = POP(ctx); b = POP(ctx);
 410         PUSH(ctx, setLocal(f, b, a));
 411         break;
 412     case OP_MEMBER:
 413         a = POP(ctx); b = POP(ctx);
 414         if(!getMember(ctx, b, a, &c))
 415             ERR(ctx, "no such member");
 416         PUSH(ctx, c);
 417         break;
 418     case OP_SETMEMBER:
 419         c = POP(ctx); b = POP(ctx); a = POP(ctx); // a,b,c: hash, key, val
 420         if(!IS_HASH(a)) ERR(ctx, "non-objects have no members");
 421         naHash_set(a, b, c);
 422         PUSH(ctx, c);
 423         break;
 424     case OP_INSERT:
 425         c = POP(ctx); b = POP(ctx); a = POP(ctx); // a,b,c: box, key, val
 426         containerSet(ctx, a, b, c);
 427         PUSH(ctx, c);
 428         break;
 429     case OP_EXTRACT:
 430         b = POP(ctx); a = POP(ctx); // a,b: box, key
 431         PUSH(ctx, containerGet(ctx, a, b));
 432         break;
 433     case OP_JMP:
 434         f->ip = ARG16(cd->byteCode, f);
 435         DBG(printf("   [Jump to: %d]\n", f->ip);)
 436         break;
 437     case OP_JIFNIL:
 438         arg = ARG16(cd->byteCode, f);
 439         a = TOP(ctx);
 440         if(IS_NIL(a)) {
 441             POP(ctx); // Pops **ONLY** if it's nil!
 442             f->ip = arg;
 443             DBG(printf("   [Jump to: %d]\n", f->ip);)
 444         }
 445         break;
 446     case OP_JIFNOT:
 447         arg = ARG16(cd->byteCode, f);
 448         if(!boolify(ctx, POP(ctx))) {
 449             f->ip = arg;
 450             DBG(printf("   [Jump to: %d]\n", f->ip);)
 451         }
 452         break;
 453     case OP_FCALL:
 454         b = POP(ctx); a = POP(ctx); // a,b = func, args
 455         setupFuncall(ctx, a, b);
 456         break;
 457     case OP_MCALL:
 458         c = POP(ctx); b = POP(ctx); a = POP(ctx); // a,b,c = obj, func, args
 459         naVec_append(ctx->temps, a);
 460         setupFuncall(ctx, b, c);
 461         naHash_set(ctx->fStack[ctx->fTop-1].locals, ctx->meRef, a);
 462         break;
 463     case OP_RETURN:
 464         a = POP(ctx);
 465         ctx->opTop = f->bp; // restore the correct stack frame!
 466         ctx->fTop--;
 467         ctx->fStack[ctx->fTop].args.ref.ptr.vec->size = 0;
 468         PUSH(ctx, a);
 469         break;
 470     case OP_LINE:
 471         f->line = ARG16(cd->byteCode, f);
 472         break;
 473     case OP_EACH:
 474         evalEach(ctx);
 475         break;
 476     case OP_MARK: // save stack state (e.g. "setjmp")
 477         ctx->markStack[ctx->markTop++] = ctx->opTop;
 478         break;
 479     case OP_UNMARK: // pop stack state set by mark
 480         ctx->markTop--;
 481         break;
 482     case OP_BREAK: // restore stack state (FOLLOW WITH JMP!)
 483         ctx->opTop = ctx->markStack[--ctx->markTop];
 484         break;
 485     default:
 486         ERR(ctx, "BUG: bad opcode");
 487     }
 488
 489     if(ctx->fTop <= 0)
 490         ctx->done = 1;
 491 }
 492
 493 static void nativeCall(struct Context* ctx, struct Frame* f, naRef ccode)
 494 {
 495     naCFunction fptr = ccode.ref.ptr.ccode->fptr;
 496     naRef result = (*fptr)(ctx, f->args);
 497     ctx->fTop--;
 498     ctx->fStack[ctx->fTop].args.ref.ptr.vec->size = 0;
 499     PUSH(ctx, result);
 500 }
 501
 502 void naSave(struct Context* ctx, naRef obj)
 503 {
 504     ctx->save = obj;
 505 }
 506
 507 int naStackDepth(struct Context* ctx)
 508 {
 509     return ctx->fTop;
 510 }
 511
 512 int naGetLine(struct Context* ctx, int frame)
 513 {
 514     return ctx->fStack[ctx->fTop-1-frame].line;
 515 }
 516
 517 naRef naGetSourceFile(struct Context* ctx, int frame)
 518 {
 519     naRef f = ctx->fStack[ctx->fTop-1-frame].func;
 520     f = f.ref.ptr.func->code;
 521     return f.ref.ptr.code->srcFile;
 522 }
 523
 524 char* naGetError(struct Context* ctx)
 525 {
 526     return ctx->error;
 527 }
 528
 529 static naRef run(naContext ctx)
 530 {
 531     // Return early if an error occurred.  It will be visible to the
 532     // caller via naGetError().
 533     ctx->error = 0;
 534     if(setjmp(ctx->jumpHandle))
 535         return naNil();
 536
 537     ctx->done = 0;
 538     while(!ctx->done) {
 539         struct Frame* f = &(ctx->fStack[ctx->fTop-1]);
 540         naRef code = f->func.ref.ptr.func->code;
 541         if(IS_CCODE(code)) nativeCall(ctx, f, code);
 542         else               run1(ctx, f, code);
 543
 544         ctx->temps.ref.ptr.vec->size = 0; // Reset the temporaries
 545         DBG(printStackDEBUG(ctx);)
 546     }
 547
 548     DBG(printStackDEBUG(ctx);)
 549     return ctx->opStack[--ctx->opTop];
 550 }
 551
 552 naRef naBindFunction(naContext ctx, naRef code, naRef closure)
 553 {
 554     naRef func = naNewFunc(ctx, code);
 555     func.ref.ptr.func->closure = naNewClosure(ctx, closure, naNil());
 556     return func;
 557 }
 558
 559 naRef naCall(naContext ctx, naRef func, naRef args, naRef obj, naRef locals)
 560 {
 561     // We might have to allocate objects, which can call the GC.  But
 562     // the call isn't on the Nasal stack yet, so the GC won't find our
 563     // C-space arguments.
 564     naVec_append(ctx->temps, func);
 565     naVec_append(ctx->temps, args);
 566     naVec_append(ctx->temps, obj);
 567     naVec_append(ctx->temps, locals);
 568
 569     if(IS_NIL(args))
 570         args = naNewVector(ctx);
 571     if(IS_NIL(locals))
 572         locals = naNewHash(ctx);
 573     if(!IS_FUNC(func)) {
 574         // Generate a noop closure for bare code objects
 575         naRef code = func;
 576         func = naNewFunc(ctx, code);
 577         func.ref.ptr.func->closure = naNewClosure(ctx, locals, naNil());
 578     }
 579     if(!IS_NIL(obj))
 580         naHash_set(locals, ctx->meRef, obj);
 581
 582     ctx->fTop = ctx->opTop = ctx->markTop = 0;
 583     setupFuncall(ctx, func, args);
 584     ctx->fStack[ctx->fTop-1].locals = locals;
 585
 586     return run(ctx);
 587 }
 588