src/vm_system.c

   1 /* Copyright (C) 2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* This file is included in vm_engine.c */
  43
  44 \f
  45 /*
  46  * Basic operations
  47  */
  48
  49 /* This must be the first instruction! */
  50 VM_DEFINE_INSTRUCTION (nop, "nop", 0, 0, 0)
  51 {
  52   NEXT;
  53 }
  54
  55 VM_DEFINE_INSTRUCTION (halt, "halt", 0, 0, 0)
  56 {
  57   SCM ret;
  58   vp->time += scm_c_get_internal_run_time () - start_time;
  59   HALT_HOOK ();
  60   POP (ret);
  61   FREE_FRAME ();
  62   SYNC_ALL ();
  63   return ret;
  64 }
  65
  66 VM_DEFINE_INSTRUCTION (break, "break", 0, 0, 0)
  67 {
  68   BREAK_HOOK ();
  69   NEXT;
  70 }
  71
  72 VM_DEFINE_INSTRUCTION (drop, "drop", 0, 0, 0)
  73 {
  74   DROP ();
  75   NEXT;
  76 }
  77
  78 VM_DEFINE_INSTRUCTION (mark, "mark", 0, 0, 1)
  79 {
  80   PUSH (SCM_UNDEFINED);
  81   NEXT;
  82 }
  83
  84 VM_DEFINE_INSTRUCTION (dup, "dup", 0, 0, 1)
  85 {
  86   SCM x = *sp;
  87   PUSH (x);
  88   NEXT;
  89 }
  90
  91 \f
  92 /*
  93  * Object creation
  94  */
  95
  96 VM_DEFINE_INSTRUCTION (void, "void", 0, 0, 1)
  97 {
  98   PUSH (SCM_UNSPECIFIED);
  99   NEXT;
 100 }
 101
 102 VM_DEFINE_INSTRUCTION (make_true, "make-true", 0, 0, 1)
 103 {
 104   PUSH (SCM_BOOL_T);
 105   NEXT;
 106 }
 107
 108 VM_DEFINE_INSTRUCTION (make_false, "make-false", 0, 0, 1)
 109 {
 110   PUSH (SCM_BOOL_F);
 111   NEXT;
 112 }
 113
 114 VM_DEFINE_INSTRUCTION (make_eol, "make-eol", 0, 0, 1)
 115 {
 116   PUSH (SCM_EOL);
 117   NEXT;
 118 }
 119
 120 VM_DEFINE_INSTRUCTION (make_int8, "make-int8", 1, 0, 1)
 121 {
 122   PUSH (SCM_I_MAKINUM ((signed char) FETCH ()));
 123   NEXT;
 124 }
 125
 126 VM_DEFINE_INSTRUCTION (make_int8_0, "make-int8:0", 0, 0, 1)
 127 {
 128   PUSH (SCM_INUM0);
 129   NEXT;
 130 }
 131
 132 VM_DEFINE_INSTRUCTION (make_int8_1, "make-int8:1", 0, 0, 1)
 133 {
 134   PUSH (SCM_I_MAKINUM (1));
 135   NEXT;
 136 }
 137
 138 VM_DEFINE_INSTRUCTION (make_int16, "make-int16", 2, 0, 1)
 139 {
 140   int h = FETCH ();
 141   int l = FETCH ();
 142   PUSH (SCM_I_MAKINUM ((signed short) (h << 8) + l));
 143   NEXT;
 144 }
 145
 146 VM_DEFINE_INSTRUCTION (make_char8, "make-char8", 1, 0, 1)
 147 {
 148   PUSH (SCM_MAKE_CHAR (FETCH ()));
 149   NEXT;
 150 }
 151
 152 VM_DEFINE_INSTRUCTION (list, "list", 2, -1, 1)
 153 {
 154   unsigned h = FETCH ();
 155   unsigned l = FETCH ();
 156   unsigned len = ((h << 8) + l);
 157   POP_LIST (len);
 158   NEXT;
 159 }
 160
 161 VM_DEFINE_INSTRUCTION (vector, "vector", 2, -1, 1)
 162 {
 163   unsigned h = FETCH ();
 164   unsigned l = FETCH ();
 165   unsigned len = ((h << 8) + l);
 166   POP_LIST (len);
 167   *sp = scm_vector (*sp);
 168   NEXT;
 169 }
 170
 171 VM_DEFINE_INSTRUCTION (list_mark, "list-mark", 0, 0, 0)
 172 {
 173   POP_LIST_MARK ();
 174   NEXT;
 175 }
 176
 177 VM_DEFINE_INSTRUCTION (vector_mark, "vector-mark", 0, 0, 0)
 178 {
 179   POP_LIST_MARK ();
 180   *sp = scm_vector (*sp);
 181   NEXT;
 182 }
 183
 184 VM_DEFINE_INSTRUCTION (list_break, "list-break", 0, 0, 0)
 185 {
 186   SCM l;
 187   POP (l);
 188   for (; !SCM_NULLP (l); l = SCM_CDR (l))
 189     PUSH (SCM_CAR (l));
 190   NEXT;
 191 }
 192
 193 \f
 194 /*
 195  * Variable access
 196  */
 197
 198 #define OBJECT_REF(i)           objects[i]
 199 #define OBJECT_SET(i,o)         objects[i] = o
 200
 201 #define LOCAL_REF(i)            SCM_FRAME_VARIABLE (fp, i)
 202 #define LOCAL_SET(i,o)          SCM_FRAME_VARIABLE (fp, i) = o
 203
 204 /* For the variable operations, we _must_ obviously avoid function calls to
 205    `scm_variable_ref ()', `scm_variable_bound_p ()' and friends which do
 206    nothing more than the corresponding macros.  */
 207 #define VARIABLE_REF(v)         SCM_VARIABLE_REF (v)
 208 #define VARIABLE_SET(v,o)       SCM_VARIABLE_SET (v, o)
 209 #define VARIABLE_BOUNDP(v)      (VARIABLE_REF (v) != SCM_UNDEFINED)
 210
 211 /* ref */
 212
 213 VM_DEFINE_INSTRUCTION (object_ref, "object-ref", 1, 0, 1)
 214 {
 215   register unsigned objnum = FETCH ();
 216   CHECK_OBJECT (objnum);
 217   PUSH (OBJECT_REF (objnum));
 218   NEXT;
 219 }
 220
 221 VM_DEFINE_INSTRUCTION (local_ref, "local-ref", 1, 0, 1)
 222 {
 223   PUSH (LOCAL_REF (FETCH ()));
 224   NEXT;
 225 }
 226
 227 VM_DEFINE_INSTRUCTION (external_ref, "external-ref", 1, 0, 1)
 228 {
 229   unsigned int i;
 230   SCM e = external;
 231   for (i = FETCH (); i; i--)
 232     {
 233       CHECK_EXTERNAL(e);
 234       e = SCM_CDR (e);
 235     }
 236   CHECK_EXTERNAL(e);
 237   PUSH (SCM_CAR (e));
 238   NEXT;
 239 }
 240
 241 VM_DEFINE_INSTRUCTION (variable_ref, "variable-ref", 0, 0, 1)
 242 {
 243   SCM x = *sp;
 244
 245   if (!VARIABLE_BOUNDP (x))
 246     {
 247       err_args = SCM_LIST1 (x);
 248       /* Was: err_args = SCM_LIST1 (SCM_CAR (x)); */
 249       goto vm_error_unbound;
 250     }
 251   else
 252     {
 253       SCM o = VARIABLE_REF (x);
 254       *sp = o;
 255     }
 256
 257   NEXT;
 258 }
 259
 260 VM_DEFINE_INSTRUCTION (late_variable_ref, "late-variable-ref", 1, 0, 1)
 261 {
 262   unsigned objnum = FETCH ();
 263   SCM pair_or_var;
 264   CHECK_OBJECT (objnum);
 265   pair_or_var = OBJECT_REF (objnum);
 266
 267   if (!SCM_VARIABLEP (pair_or_var))
 268     {
 269       SCM mod = scm_resolve_module (SCM_CAR (pair_or_var));
 270       /* module_lookup might longjmp */
 271       pair_or_var = scm_module_lookup (mod, SCM_CDR (pair_or_var));
 272       OBJECT_SET (objnum, pair_or_var);
 273       if (!VARIABLE_BOUNDP (pair_or_var))
 274         {
 275           err_args = SCM_LIST1 (pair_or_var);
 276           goto vm_error_unbound;
 277         }
 278     }
 279
 280   PUSH (VARIABLE_REF (pair_or_var));
 281   NEXT;
 282 }
 283
 284 /* set */
 285
 286 VM_DEFINE_INSTRUCTION (local_set, "local-set", 1, 1, 0)
 287 {
 288   LOCAL_SET (FETCH (), *sp);
 289   DROP ();
 290   NEXT;
 291 }
 292
 293 VM_DEFINE_INSTRUCTION (external_set, "external-set", 1, 1, 0)
 294 {
 295   unsigned int i;
 296   SCM e = external;
 297   for (i = FETCH (); i; i--)
 298     {
 299       CHECK_EXTERNAL(e);
 300       e = SCM_CDR (e);
 301     }
 302   CHECK_EXTERNAL(e);
 303   SCM_SETCAR (e, *sp);
 304   DROP ();
 305   NEXT;
 306 }
 307
 308 VM_DEFINE_INSTRUCTION (variable_set, "variable-set", 0, 1, 0)
 309 {
 310   VARIABLE_SET (sp[0], sp[-1]);
 311   scm_set_object_property_x (sp[-1], scm_sym_name, SCM_CAR (sp[0]));
 312   sp -= 2;
 313   NEXT;
 314 }
 315
 316 VM_DEFINE_INSTRUCTION (late_variable_set, "late-variable-set", 1, 1, 0)
 317 {
 318   unsigned objnum = FETCH ();
 319   SCM pair_or_var;
 320   CHECK_OBJECT (objnum);
 321   pair_or_var = OBJECT_REF (objnum);
 322
 323   if (!SCM_VARIABLEP (pair_or_var))
 324     {
 325       SCM mod = scm_resolve_module (SCM_CAR (pair_or_var));
 326       /* module_lookup might longjmp */
 327       pair_or_var = scm_module_lookup (mod, SCM_CDR (pair_or_var));
 328       OBJECT_SET (objnum, pair_or_var);
 329     }
 330
 331   VARIABLE_SET (pair_or_var, *sp);
 332   DROP ();
 333   NEXT;
 334 }
 335
 336 \f
 337 /*
 338  * branch and jump
 339  */
 340
 341 #define BR(p)                                   \
 342 {                                               \
 343   int h = FETCH ();                             \
 344   int l = FETCH ();                             \
 345   signed short offset = (h << 8) + l;           \
 346   if (p)                                        \
 347     ip += offset;                               \
 348   DROP ();                                      \
 349   NEXT;                                         \
 350 }
 351
 352 VM_DEFINE_INSTRUCTION (br, "br", 2, 0, 0)
 353 {
 354   int h = FETCH ();
 355   int l = FETCH ();
 356   ip += (signed short) (h << 8) + l;
 357   NEXT;
 358 }
 359
 360 VM_DEFINE_INSTRUCTION (br_if, "br-if", 2, 0, 0)
 361 {
 362   BR (!SCM_FALSEP (*sp));
 363 }
 364
 365 VM_DEFINE_INSTRUCTION (br_if_not, "br-if-not", 2, 0, 0)
 366 {
 367   BR (SCM_FALSEP (*sp));
 368 }
 369
 370 VM_DEFINE_INSTRUCTION (br_if_eq, "br-if-eq", 2, 0, 0)
 371 {
 372   BR (SCM_EQ_P (sp[0], sp--[1]));
 373 }
 374
 375 VM_DEFINE_INSTRUCTION (br_if_not_eq, "br-if-not-eq", 2, 0, 0)
 376 {
 377   BR (!SCM_EQ_P (sp[0], sp--[1]));
 378 }
 379
 380 VM_DEFINE_INSTRUCTION (br_if_null, "br-if-null", 2, 0, 0)
 381 {
 382   BR (SCM_NULLP (*sp));
 383 }
 384
 385 VM_DEFINE_INSTRUCTION (br_if_not_null, "br-if-not-null", 2, 0, 0)
 386 {
 387   BR (!SCM_NULLP (*sp));
 388 }
 389
 390 \f
 391 /*
 392  * Subprogram call
 393  */
 394
 395 VM_DEFINE_INSTRUCTION (make_closure, "make-closure", 0, 1, 1)
 396 {
 397   SYNC_BEFORE_GC ();
 398   *sp = scm_c_make_closure (*sp, external);
 399   NEXT;
 400 }
 401
 402 VM_DEFINE_INSTRUCTION (call, "call", 1, -1, 1)
 403 {
 404   SCM x;
 405   nargs = FETCH ();
 406
 407  vm_call:
 408   x = sp[-nargs];
 409
 410   /*
 411    * Subprogram call
 412    */
 413   if (SCM_PROGRAM_P (x))
 414     {
 415       program = x;
 416     vm_call_program:
 417       CACHE_PROGRAM ();
 418       INIT_ARGS ();
 419       NEW_FRAME ();
 420       ENTER_HOOK ();
 421       APPLY_HOOK ();
 422       NEXT;
 423     }
 424   /*
 425    * Function call
 426    */
 427   if (!SCM_FALSEP (scm_procedure_p (x)))
 428     {
 429       /* At this point, the stack contains the procedure and each one of its
 430          arguments.  */
 431       SCM args;
 432
 433 #if 1
 434       POP_LIST (nargs);
 435 #else
 436       /* Experimental:  Build the arglist on the VM stack.  XXX  */
 437       POP_LIST_ON_STACK (nargs);
 438 #endif
 439       POP (args);
 440       *sp = scm_apply (x, args, SCM_EOL);
 441       NEXT;
 442     }
 443   /*
 444    * Continuation call
 445    */
 446   if (SCM_VM_CONT_P (x))
 447     {
 448     vm_call_cc:
 449       /* Check the number of arguments */
 450       if (nargs != 1)
 451         scm_wrong_num_args (x);
 452
 453       /* Reinstate the continuation */
 454       EXIT_HOOK ();
 455       reinstate_vm_cont (vp, x);
 456       CACHE_REGISTER ();
 457       program = SCM_FRAME_PROGRAM (fp);
 458       CACHE_PROGRAM ();
 459       NEXT;
 460     }
 461
 462   program = x;
 463   goto vm_error_wrong_type_apply;
 464 }
 465
 466 VM_DEFINE_INSTRUCTION (tail_call, "tail-call", 1, -1, 1)
 467 {
 468   register SCM x;
 469   nargs = FETCH ();
 470   x = sp[-nargs];
 471
 472   SCM_TICK;     /* allow interrupt here */
 473
 474   /*
 475    * Tail recursive call
 476    */
 477   if (SCM_EQ_P (x, program))
 478     {
 479       int i;
 480
 481       /* Move arguments */
 482       INIT_ARGS ();
 483       sp -= bp->nargs - 1;
 484       for (i = 0; i < bp->nargs; i++)
 485         LOCAL_SET (i, sp[i]);
 486
 487       /* Drop the first argument and the program itself.  */
 488       sp -= 2;
 489
 490       /* Call itself */
 491       ip = bp->base;
 492       APPLY_HOOK ();
 493       NEXT;
 494     }
 495   /*
 496    * Proper tail call
 497    */
 498   if (SCM_PROGRAM_P (x))
 499     {
 500       EXIT_HOOK ();
 501       FREE_FRAME ();
 502       program = x;
 503       goto vm_call_program;
 504     }
 505   /*
 506    * Function call
 507    */
 508   if (!SCM_FALSEP (scm_procedure_p (x)))
 509     {
 510       SCM args;
 511       POP_LIST (nargs);
 512       POP (args);
 513       *sp = scm_apply (x, args, SCM_EOL);
 514       goto vm_return;
 515     }
 516   /*
 517    * Continuation call
 518    */
 519   if (SCM_VM_CONT_P (x))
 520     goto vm_call_cc;
 521
 522   program = x;
 523   goto vm_error_wrong_type_apply;
 524 }
 525
 526 VM_DEFINE_INSTRUCTION (apply, "apply", 1, -1, 1)
 527 {
 528   int len;
 529   SCM ls;
 530   POP (ls);
 531
 532   nargs = FETCH ();
 533   if (nargs < 2)
 534     goto vm_error_wrong_num_args;
 535
 536   len = scm_ilength (ls);
 537   if (len < 0)
 538     goto vm_error_wrong_type_arg;
 539
 540   for (; !SCM_NULLP (ls); ls = SCM_CDR (ls))
 541     PUSH (SCM_CAR (ls));
 542
 543   nargs += len - 2;
 544   goto vm_call;
 545 }
 546
 547 VM_DEFINE_INSTRUCTION (call_cc, "call/cc", 1, 1, 1)
 548 {
 549   SYNC_BEFORE_GC ();
 550   PUSH (capture_vm_cont (vp));
 551   POP (program);
 552   nargs = 1;
 553   goto vm_call;
 554 }
 555
 556 VM_DEFINE_INSTRUCTION (return, "return", 0, 0, 1)
 557 {
 558  vm_return:
 559   EXIT_HOOK ();
 560   RETURN_HOOK ();
 561   FREE_FRAME ();
 562
 563   /* Restore the last program */
 564   program = SCM_FRAME_PROGRAM (fp);
 565   CACHE_PROGRAM ();
 566   CACHE_EXTERNAL ();
 567   NEXT;
 568 }
 569
 570 /*
 571   Local Variables:
 572   c-file-style: "gnu"
 573   End:
 574 */