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", 1, -1, 1)
 153 {
 154   int n = FETCH ();
 155   POP_LIST (n);
 156   NEXT;
 157 }
 158
 159 VM_DEFINE_INSTRUCTION (vector, "vector", 1, -1, 1)
 160 {
 161   int n = FETCH ();
 162   POP_LIST (n);
 163   *sp = scm_vector (*sp);
 164   NEXT;
 165 }
 166
 167 VM_DEFINE_INSTRUCTION (list_mark, "list-mark", 0, 0, 0)
 168 {
 169   POP_LIST_MARK ();
 170   NEXT;
 171 }
 172
 173 VM_DEFINE_INSTRUCTION (vector_mark, "vector-mark", 0, 0, 0)
 174 {
 175   POP_LIST_MARK ();
 176   *sp = scm_vector (*sp);
 177   NEXT;
 178 }
 179
 180 VM_DEFINE_INSTRUCTION (list_break, "list-break", 0, 0, 0)
 181 {
 182   SCM l;
 183   POP (l);
 184   for (; !SCM_NULLP (l); l = SCM_CDR (l))
 185     PUSH (SCM_CAR (l));
 186   NEXT;
 187 }
 188
 189 \f
 190 /*
 191  * Variable access
 192  */
 193
 194 #define OBJECT_REF(i)           objects[i]
 195 #define OBJECT_SET(i,o)         objects[i] = o
 196
 197 #define LOCAL_REF(i)            SCM_FRAME_VARIABLE (fp, i)
 198 #define LOCAL_SET(i,o)          SCM_FRAME_VARIABLE (fp, i) = o
 199
 200 /* For the variable operations, we _must_ obviously avoid function calls to
 201    `scm_variable_ref ()', `scm_variable_bound_p ()' and friends which do
 202    nothing more than the corresponding macros.  */
 203 #define VARIABLE_REF(v)         SCM_VARIABLE_REF (v)
 204 #define VARIABLE_SET(v,o)       SCM_VARIABLE_SET (v, o)
 205 #define VARIABLE_BOUNDP(v)      (VARIABLE_REF (v) != SCM_UNDEFINED)
 206
 207 /* ref */
 208
 209 VM_DEFINE_INSTRUCTION (object_ref, "object-ref", 1, 0, 1)
 210 {
 211   PUSH (OBJECT_REF (FETCH ()));
 212   NEXT;
 213 }
 214
 215 VM_DEFINE_INSTRUCTION (local_ref, "local-ref", 1, 0, 1)
 216 {
 217   PUSH (LOCAL_REF (FETCH ()));
 218   NEXT;
 219 }
 220
 221 VM_DEFINE_INSTRUCTION (external_ref, "external-ref", 1, 0, 1)
 222 {
 223   unsigned int i;
 224   SCM e = external;
 225   for (i = FETCH (); i; i--)
 226     {
 227       CHECK_EXTERNAL(e);
 228       e = SCM_CDR (e);
 229     }
 230   CHECK_EXTERNAL(e);
 231   PUSH (SCM_CAR (e));
 232   NEXT;
 233 }
 234
 235 VM_DEFINE_INSTRUCTION (variable_ref, "variable-ref", 0, 0, 1)
 236 {
 237   SCM x = *sp;
 238
 239   if (!VARIABLE_BOUNDP (x))
 240     {
 241       err_args = SCM_LIST1 (x);
 242       /* Was: err_args = SCM_LIST1 (SCM_CAR (x)); */
 243       goto vm_error_unbound;
 244     }
 245   else
 246     {
 247       SCM o = VARIABLE_REF (x);
 248       *sp = o;
 249     }
 250
 251   NEXT;
 252 }
 253
 254 /* set */
 255
 256 VM_DEFINE_INSTRUCTION (local_set, "local-set", 1, 1, 0)
 257 {
 258   LOCAL_SET (FETCH (), *sp);
 259   DROP ();
 260   NEXT;
 261 }
 262
 263 VM_DEFINE_INSTRUCTION (external_set, "external-set", 1, 1, 0)
 264 {
 265   unsigned int i;
 266   SCM e = external;
 267   for (i = FETCH (); i; i--)
 268     {
 269       CHECK_EXTERNAL(e);
 270       e = SCM_CDR (e);
 271     }
 272   CHECK_EXTERNAL(e);
 273   SCM_SETCAR (e, *sp);
 274   DROP ();
 275   NEXT;
 276 }
 277
 278 VM_DEFINE_INSTRUCTION (variable_set, "variable-set", 0, 1, 0)
 279 {
 280   VARIABLE_SET (sp[0], sp[-1]);
 281   scm_set_object_property_x (sp[-1], scm_sym_name, SCM_CAR (sp[0]));
 282   sp -= 2;
 283   NEXT;
 284 }
 285
 286 \f
 287 /*
 288  * branch and jump
 289  */
 290
 291 #define BR(p)                                   \
 292 {                                               \
 293   int h = FETCH ();                             \
 294   int l = FETCH ();                             \
 295   signed short offset = (h << 8) + l;           \
 296   if (p)                                        \
 297     ip += offset;                               \
 298   DROP ();                                      \
 299   NEXT;                                         \
 300 }
 301
 302 VM_DEFINE_INSTRUCTION (br, "br", 2, 0, 0)
 303 {
 304   int h = FETCH ();
 305   int l = FETCH ();
 306   ip += (signed short) (h << 8) + l;
 307   NEXT;
 308 }
 309
 310 VM_DEFINE_INSTRUCTION (br_if, "br-if", 2, 0, 0)
 311 {
 312   BR (!SCM_FALSEP (*sp));
 313 }
 314
 315 VM_DEFINE_INSTRUCTION (br_if_not, "br-if-not", 2, 0, 0)
 316 {
 317   BR (SCM_FALSEP (*sp));
 318 }
 319
 320 VM_DEFINE_INSTRUCTION (br_if_eq, "br-if-eq", 2, 0, 0)
 321 {
 322   BR (SCM_EQ_P (sp[0], sp--[1]));
 323 }
 324
 325 VM_DEFINE_INSTRUCTION (br_if_not_eq, "br-if-not-eq", 2, 0, 0)
 326 {
 327   BR (!SCM_EQ_P (sp[0], sp--[1]));
 328 }
 329
 330 VM_DEFINE_INSTRUCTION (br_if_null, "br-if-null", 2, 0, 0)
 331 {
 332   BR (SCM_NULLP (*sp));
 333 }
 334
 335 VM_DEFINE_INSTRUCTION (br_if_not_null, "br-if-not-null", 2, 0, 0)
 336 {
 337   BR (!SCM_NULLP (*sp));
 338 }
 339
 340 \f
 341 /*
 342  * Subprogram call
 343  */
 344
 345 VM_DEFINE_INSTRUCTION (make_closure, "make-closure", 0, 1, 1)
 346 {
 347   SYNC_BEFORE_GC ();
 348   *sp = scm_c_make_closure (*sp, external);
 349   NEXT;
 350 }
 351
 352 VM_DEFINE_INSTRUCTION (call, "call", 1, -1, 1)
 353 {
 354   SCM x;
 355   nargs = FETCH ();
 356
 357  vm_call:
 358   x = sp[-nargs];
 359
 360   /*
 361    * Subprogram call
 362    */
 363   if (SCM_PROGRAM_P (x))
 364     {
 365       program = x;
 366     vm_call_program:
 367       CACHE_PROGRAM ();
 368       INIT_ARGS ();
 369       NEW_FRAME ();
 370       ENTER_HOOK ();
 371       APPLY_HOOK ();
 372       NEXT;
 373     }
 374   /*
 375    * Function call
 376    */
 377   if (!SCM_FALSEP (scm_procedure_p (x)))
 378     {
 379       /* At this point, the stack contains the procedure and each one of its
 380          arguments.  */
 381       SCM args;
 382
 383 #if 1
 384       POP_LIST (nargs);
 385 #else
 386       /* Experimental:  Build the arglist on the VM stack.  XXX  */
 387       POP_LIST_ON_STACK (nargs);
 388 #endif
 389       POP (args);
 390       *sp = scm_apply (x, args, SCM_EOL);
 391       NEXT;
 392     }
 393   /*
 394    * Continuation call
 395    */
 396   if (SCM_VM_CONT_P (x))
 397     {
 398     vm_call_cc:
 399       /* Check the number of arguments */
 400       if (nargs != 1)
 401         scm_wrong_num_args (x);
 402
 403       /* Reinstate the continuation */
 404       EXIT_HOOK ();
 405       reinstate_vm_cont (vp, x);
 406       CACHE_REGISTER ();
 407       program = SCM_FRAME_PROGRAM (fp);
 408       CACHE_PROGRAM ();
 409       NEXT;
 410     }
 411
 412   program = x;
 413   goto vm_error_wrong_type_apply;
 414 }
 415
 416 VM_DEFINE_INSTRUCTION (tail_call, "tail-call", 1, -1, 1)
 417 {
 418   register SCM x;
 419   nargs = FETCH ();
 420   x = sp[-nargs];
 421
 422   SCM_TICK;     /* allow interrupt here */
 423
 424   /*
 425    * Tail recursive call
 426    */
 427   if (SCM_EQ_P (x, program))
 428     {
 429       int i;
 430
 431       /* Move arguments */
 432       INIT_ARGS ();
 433       sp -= bp->nargs - 1;
 434       for (i = 0; i < bp->nargs; i++)
 435         LOCAL_SET (i, sp[i]);
 436
 437       /* Drop the first argument and the program itself.  */
 438       sp -= 2;
 439
 440       /* Call itself */
 441       ip = bp->base;
 442       APPLY_HOOK ();
 443       NEXT;
 444     }
 445   /*
 446    * Proper tail call
 447    */
 448   if (SCM_PROGRAM_P (x))
 449     {
 450       EXIT_HOOK ();
 451       FREE_FRAME ();
 452       program = x;
 453       goto vm_call_program;
 454     }
 455   /*
 456    * Function call
 457    */
 458   if (!SCM_FALSEP (scm_procedure_p (x)))
 459     {
 460       SCM args;
 461       POP_LIST (nargs);
 462       POP (args);
 463       *sp = scm_apply (x, args, SCM_EOL);
 464       goto vm_return;
 465     }
 466   /*
 467    * Continuation call
 468    */
 469   if (SCM_VM_CONT_P (x))
 470     goto vm_call_cc;
 471
 472   program = x;
 473   goto vm_error_wrong_type_apply;
 474 }
 475
 476 VM_DEFINE_INSTRUCTION (apply, "apply", 1, -1, 1)
 477 {
 478   int len;
 479   SCM ls;
 480   POP (ls);
 481
 482   nargs = FETCH ();
 483   if (nargs < 2)
 484     goto vm_error_wrong_num_args;
 485
 486   len = scm_ilength (ls);
 487   if (len < 0)
 488     goto vm_error_wrong_type_arg;
 489
 490   for (; !SCM_NULLP (ls); ls = SCM_CDR (ls))
 491     PUSH (SCM_CAR (ls));
 492
 493   nargs += len - 2;
 494   goto vm_call;
 495 }
 496
 497 VM_DEFINE_INSTRUCTION (call_cc, "call/cc", 1, 1, 1)
 498 {
 499   SYNC_BEFORE_GC ();
 500   PUSH (capture_vm_cont (vp));
 501   POP (program);
 502   nargs = 1;
 503   goto vm_call;
 504 }
 505
 506 VM_DEFINE_INSTRUCTION (return, "return", 0, 0, 1)
 507 {
 508  vm_return:
 509   EXIT_HOOK ();
 510   RETURN_HOOK ();
 511   FREE_FRAME ();
 512
 513   /* Restore the last program */
 514   program = SCM_FRAME_PROGRAM (fp);
 515   CACHE_PROGRAM ();
 516   CACHE_EXTERNAL ();
 517   NEXT;
 518 }
 519
 520 /*
 521   Local Variables:
 522   c-file-style: "gnu"
 523   End:
 524 */