universe.py 22.5 KB
Newer Older
1 2
from rpython.rlib.rrandom import Random

3
from som.interpreter.interpreter import Interpreter
Stefan Marr's avatar
Stefan Marr committed
4
from som.interpreter.bytecodes   import Bytecodes 
5 6
from som.vm.symbol_table         import SymbolTable
from som.vmobjects.object        import Object
7 8 9
from som.vmobjects.clazz         import Class
from som.vmobjects.array         import Array
from som.vmobjects.symbol        import Symbol
10
from som.vmobjects.method        import Method
Stefan Marr's avatar
Stefan Marr committed
11
from som.vmobjects.integer       import Integer
12
from som.vmobjects.string        import String
13
from som.vmobjects.block         import Block, block_evaluation_primitive
14
from som.vmobjects.frame         import Frame
15
from som.vmobjects.biginteger    import BigInteger
16
from som.vmobjects.double        import Double
17

Stefan Marr's avatar
Stefan Marr committed
18 19
from som.vm.shell import Shell

20 21
import som.compiler.sourcecode_compiler as sourcecode_compiler

22
import os
23 24
import time

25

26 27
from rlib.exit  import Exit
from rlib.osext import path_split
28 29 30

class Universe(object):
    
31
    def __init__(self, avoid_exit = False):
32 33 34 35 36
        self._interpreter    = Interpreter(self)
        self._symbol_table   = SymbolTable()
        
        self._globals        = {}
        
37 38 39 40 41 42
        self.nilObject      = None
        self.trueObject     = None
        self.falseObject    = None
        self.objectClass    = None
        self.classClass     = None
        self.metaclassClass = None
43
        
44 45 46 47 48 49 50 51 52 53 54 55
        self.nilClass       = None
        self.integerClass   = None
        self.bigintegerClass= None
        self.arrayClass     = None
        self.methodClass    = None
        self.symbolClass    = None
        self.frameClass     = None
        self.primitiveClass = None
        self.systemClass    = None
        self.blockClass     = None
        self.stringClass    = None
        self.doubleClass    = None
56 57
        
        self._last_exit_code = 0
58
        self._avoid_exit     = avoid_exit
59
        self._dump_bytecodes = False
Stefan Marr's avatar
Stefan Marr committed
60
        self.classpath       = None
61 62 63
        self.start_time      = time.time() # a float of the time in seconds
        self.random          = Random(abs(int(time.clock() * time.time())))

64

65 66 67 68
    def exit(self, error_code):
        if self._avoid_exit:
            self._last_exit_code = error_code
        else:
69
            raise Exit(error_code)
70 71 72 73
    
    def last_exit_code(self):
        return self._last_exit_code
    
74 75 76
    def get_interpreter(self):
        return self._interpreter
    
77 78 79 80 81 82 83 84 85 86
    def execute_method(self, class_name, selector):
        self._initialize_object_system()

        clazz = self.load_class(self.symbol_for(class_name))

        # Lookup the invokable on class
        invokable = clazz.get_class().lookup_invokable(self.symbol_for(selector))

        bootstrap_method = self._create_bootstrap_method()
        bootstrap_frame  = self._create_bootstrap_frame(bootstrap_method, clazz)
87
        
88
        return self.start(bootstrap_frame, invokable)
89
    
90 91 92 93 94 95
    def _create_bootstrap_method(self):
        # Create a fake bootstrap method to simplify later frame traversal
        bootstrap_method = self.new_method(self.symbol_for("bootstrap"), 1, 0)
        bootstrap_method.set_bytecode(0, Bytecodes.halt)
        bootstrap_method.set_number_of_locals(self.new_integer(0))
        bootstrap_method.set_maximum_number_of_stack_elements(self.new_integer(2))
96
        bootstrap_method.set_holder(self.systemClass)
97
        return bootstrap_method
98
    
99 100 101 102 103 104
    def _create_bootstrap_frame(self, bootstrap_method, receiver, arguments = None):
        # Create a fake bootstrap frame with the system object on the stack
        bootstrap_frame = self._interpreter.push_new_frame(bootstrap_method)
        bootstrap_frame.push(receiver)
        
        if arguments:
105
            bootstrap_frame.push(arguments)
106
        return bootstrap_frame
107 108
        
    
109 110
    def interpret(self, arguments):
        # Check for command line switches
111
        arguments = self.handle_arguments(arguments)
112 113

        # Initialize the known universe
114 115
        system_object = self._initialize_object_system()
        bootstrap_method = self._create_bootstrap_method()
116
        
117 118 119 120 121 122 123
        # Start the shell if no filename is given
        if len(arguments) == 0:
            shell = Shell(self, self._interpreter)
            shell.set_bootstrap_method(bootstrap_method)
            shell.start()
            return
        else:
124 125 126
            # Convert the arguments into an array
            arguments_array = self.new_array_with_strings(arguments)
            bootstrap_frame = self._create_bootstrap_frame(bootstrap_method, system_object, arguments_array)
127
            # Lookup the initialize invokable on the system class
128
            initialize = self.systemClass.lookup_invokable(self.symbol_for("initialize:"))
129 130 131 132 133 134 135 136 137

            self.start(bootstrap_frame, initialize)
    
    def start(self, bootstrap_frame, invokable):
        # Invoke the initialize invokable
        invokable.invoke(bootstrap_frame, self._interpreter)

        # Start the interpreter
        return self._interpreter.start()
138
    
139
    def handle_arguments(self, arguments):
140 141 142 143 144 145 146 147
        got_classpath  = False
        remaining_args = []

        i = 0
        while i < len(arguments):
            if arguments[i] == "-cp":
                if i + 1 >= len(arguments):
                    self._print_usage_and_exit()
148
                self.setup_classpath(arguments[i + 1])
149 150 151 152
                i += 1    # skip class path
                got_classpath = True
            elif arguments[i] == "-d":
                self._dump_bytecodes = True
Tobias Pape's avatar
Tobias Pape committed
153 154
            elif arguments[i] in ["-h", "--help", "-?"]:
                self._print_usage_and_exit()
155 156
            else:
                remaining_args.append(arguments[i])
Tobias Pape's avatar
Tobias Pape committed
157
            i += 1
158 159 160
    
        if not got_classpath:
            # Get the default class path of the appropriate size
161
            self.classpath = self._setup_default_classpath()
162 163 164 165 166 167 168

        # check remaining args for class paths, and strip file extension
        i = 0
        while i < len(remaining_args):
            split = self._get_path_class_ext(remaining_args[i])

            if split[0] != "":  # there was a path
169
                self.classpath.insert(0, split[0])
170 171 172 173 174 175
        
            remaining_args[i] = split[1]
            i += 1
        
        return remaining_args
    
176
    def setup_classpath(self, cp):
177
        self.classpath = cp.split(os.pathsep)
178
    
179 180 181
    def _setup_default_classpath(self):
        return ['.']
    
182 183 184
    # take argument of the form "../foo/Test.som" and return
    # "../foo", "Test", "som"
    def _get_path_class_ext(self, path):
185
        return path_split(path)
186 187 188
    
    def _print_usage_and_exit(self):
        # Print the usage
189 190 191 192
        std_println("Usage: som [-options] [args...]                          ")
        std_println("                                                         ")
        std_println("where options include:                                   ")
        std_println("    -cp <directories separated by " + os.pathsep     + ">")
Tobias Pape's avatar
Tobias Pape committed
193 194 195
        std_println("        set search path for application classes")
        std_println("    -d  enable disassembling")
        std_println("    -h  print this help")
196 197 198

        # Exit
        self.exit(0)
199

200
    def _initialize_object_system(self):
201
        # Allocate the nil object
202
        self.nilObject = Object(None)
203 204

        # Allocate the Metaclass classes
205
        self.metaclassClass = self.new_metaclass_class()
206 207

        # Allocate the rest of the system classes
208 209 210 211 212 213 214 215 216 217 218 219
        self.objectClass     = self.new_system_class()
        self.nilClass        = self.new_system_class()
        self.classClass      = self.new_system_class()
        self.arrayClass      = self.new_system_class()
        self.symbolClass     = self.new_system_class()
        self.methodClass     = self.new_system_class()
        self.integerClass    = self.new_system_class()
        self.bigintegerClass = self.new_system_class()
        self.frameClass      = self.new_system_class()
        self.primitiveClass  = self.new_system_class()
        self.stringClass     = self.new_system_class()
        self.doubleClass     = self.new_system_class()
220 221

        # Setup the class reference for the nil object
222
        self.nilObject.set_class(self.nilClass)
223 224

        # Initialize the system classes
225 226 227 228 229 230 231 232 233 234 235 236 237
        self._initialize_system_class(self.objectClass,                 None, "Object")
        self._initialize_system_class(self.classClass,      self.objectClass, "Class")
        self._initialize_system_class(self.metaclassClass,   self.classClass, "Metaclass")
        self._initialize_system_class(self.nilClass,        self.objectClass, "Nil")
        self._initialize_system_class(self.arrayClass,      self.objectClass, "Array")
        self._initialize_system_class(self.methodClass,      self.arrayClass, "Method")
        self._initialize_system_class(self.symbolClass,     self.objectClass, "Symbol")
        self._initialize_system_class(self.integerClass,    self.objectClass, "Integer")
        self._initialize_system_class(self.bigintegerClass, self.objectClass, "BigInteger")
        self._initialize_system_class(self.frameClass,       self.arrayClass, "Frame")
        self._initialize_system_class(self.primitiveClass,  self.objectClass, "Primitive")
        self._initialize_system_class(self.stringClass,     self.objectClass, "String")
        self._initialize_system_class(self.doubleClass,     self.objectClass, "Double")
238 239

        # Load methods and fields into the system classes
240 241 242 243 244 245 246 247 248 249 250 251 252
        self._load_system_class(self.objectClass)
        self._load_system_class(self.classClass)
        self._load_system_class(self.metaclassClass)
        self._load_system_class(self.nilClass)
        self._load_system_class(self.arrayClass)
        self._load_system_class(self.methodClass)
        self._load_system_class(self.symbolClass)
        self._load_system_class(self.integerClass)
        self._load_system_class(self.bigintegerClass)
        self._load_system_class(self.frameClass)
        self._load_system_class(self.primitiveClass)
        self._load_system_class(self.stringClass)
        self._load_system_class(self.doubleClass)
253 254

        # Load the generic block class
255
        self.blockClass = self.load_class(self.symbol_for("Block"))
256 257

        # Setup the true and false objects
258 259
        self.trueObject  = self.new_instance(self.load_class(self.symbol_for("True")))
        self.falseObject = self.new_instance(self.load_class(self.symbol_for("False")))
260 261

        # Load the system class and create an instance of it
262 263
        self.systemClass = self.load_class(self.symbol_for("System"))
        system_object = self.new_instance(self.systemClass)
264 265

        # Put special objects and classes into the dictionary of globals
266 267 268
        self.set_global(self.symbol_for("nil"),    self.nilObject)
        self.set_global(self.symbol_for("true"),   self.trueObject)
        self.set_global(self.symbol_for("false"),  self.falseObject)
269
        self.set_global(self.symbol_for("system"), system_object)
270 271
        self.set_global(self.symbol_for("System"), self.systemClass)
        self.set_global(self.symbol_for("Block"),  self.blockClass)
272 273
        return system_object
    
274 275 276 277 278 279 280 281 282
    def symbol_for(self, string):
        # Lookup the symbol in the symbol table
        result = self._symbol_table.lookup(string)
        if result:
            return result
        
        # Create a new symbol and return it
        result = self.new_symbol(string)
        return result
283 284 285
    
    def new_array_with_length(self, length):
        # Allocate a new array and set its class to be the array class
286 287
        result = Array(self.nilObject)
        result.set_class(self.arrayClass)
288 289

        # Set the number of indexable fields to the given value (length)
290
        result.set_number_of_indexable_fields_and_clear(length, self.nilObject)
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315

        # Return the freshly allocated array
        return result
  
    def new_array_from_list(self, values):
        # Allocate a new array with the same length as the list
        result = self.new_array_with_length(len(values))

        # Copy all elements from the list into the array
        for i in range(len(values)):
            result.set_indexable_field(i, values[i])
    
        # Return the allocated and initialized array
        return result
  
    def new_array_with_strings(self, strings):
        # Allocate a new array with the same length as the string array
        result = self.new_array_with_length(len(strings))

        # Copy all elements from the string array into the array
        for i in range(len(strings)):
            result.set_indexable_field(i, self.new_string(strings[i]))
    
        # Return the allocated and initialized array
        return result
316
    
317 318
    def new_block(self, method, context_frame, arguments):
        # Allocate a new block and set its class to be the block class
319
        result = Block(self.nilObject)
320 321 322 323 324 325 326 327 328 329 330
        result.set_class(self._get_block_class(arguments))

        # Set the method and context of block
        result.set_method(method)
        result.set_context(context_frame)

        # Return the freshly allocated block
        return result

    def new_class(self, class_class):
        # Allocate a new class and set its class to be the given class class
Stefan Marr's avatar
Stefan Marr committed
331
        result = Class(self, class_class.get_number_of_instance_fields())
332 333 334 335 336 337 338
        result.set_class(class_class)

        # Return the freshly allocated class
        return result

    def new_frame(self, previous_frame, method):
        # Allocate a new frame and set its class to be the frame class
339 340
        result = Frame(self.nilObject)
        result.set_class(self.frameClass)
341 342 343 344 345 346 347

        # Compute the maximum number of stack locations (including arguments,
        # locals and extra buffer to support doesNotUnderstand) and set the
        # number of indexable fields accordingly
        length = (method.get_number_of_arguments() +
                  method.get_number_of_locals().get_embedded_integer() +
                  method.get_maximum_number_of_stack_elements().get_embedded_integer() + 2)
348
        result.set_number_of_indexable_fields_and_clear(length, self.nilObject)
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

        # Set the method of the frame and the previous frame
        result.set_method(method)
        if previous_frame:
            result.set_previous_frame(previous_frame)

        # Reset the stack pointer and the bytecode index
        result.reset_stack_pointer()
        result.set_bytecode_index(0)

        # Return the freshly allocated frame
        return result

    def new_method(self, signature, num_bytecodes, num_literals):
        # Allocate a new method and set its class to be the method class
364 365
        result = Method(self.nilObject)
        result.set_class(self.methodClass)
366 367 368 369

        # Set the signature and the number of bytecodes
        result.set_signature(signature)
        result.set_number_of_bytecodes(num_bytecodes)
370
        result.set_number_of_indexable_fields_and_clear(num_literals, self.nilObject)
371 372 373 374 375 376

        # Return the freshly allocated method
        return result

    def new_instance(self, instance_class):
        # Allocate a new instance and set its class to be the given class
377
        result = Object(self.nilObject, instance_class.get_number_of_instance_fields())
378 379 380 381 382 383 384 385
        result.set_class(instance_class)
 
        # Return the freshly allocated instance
        return result

 
    def new_integer(self, value):
        # Allocate a new integer and set its class to be the integer class
386 387
        result = Integer(self.nilObject)
        result.set_class(self.integerClass)
388 389 390 391 392 393 394
     
        # Set the embedded integer of the newly allocated integer
        result.set_embedded_integer(value)
     
        # Return the freshly allocated integer
        return result
 
395
    def new_biginteger(self, value):
396
        # Allocate a new integer and set its class to be the integer class
397 398
        result = BigInteger(self.nilObject)
        result.set_class(self.bigintegerClass)
399 400
 
        # Set the embedded integer of the newly allocated integer
401
        result.set_embedded_biginteger(value)
402 403 404 405 406 407 408
 
        # Return the freshly allocated integer
        return result
 
 
    def new_double(self, value):
        # Allocate a new integer and set its class to be the double class
409 410
        result = Double(self.nilObject)
        result.set_class(self.doubleClass)
411 412 413 414 415 416 417
 
        # Set the embedded double of the newly allocated double
        result.set_embedded_double(value)
 
        # Return the freshly allocated double
        return result
    
418 419 420 421 422 423 424 425 426 427
    def new_metaclass_class(self):
        # Allocate the metaclass classes
        result = Class(self)
        result.set_class(Class(self))

        # Setup the metaclass hierarchy
        result.get_class().set_class(result)

        # Return the freshly allocated metaclass class
        return result
428 429 430

    def new_string(self, embedded_string):
        # Allocate a new string and set its class to be the string class
431 432
        result = String(self.nilObject)
        result.set_class(self.stringClass)
433 434 435 436 437 438
 
        # Put the embedded string into the new string
        result.set_embedded_string(embedded_string)
 
        # Return the freshly allocated string
        return result
439
    
440 441
    def new_symbol(self, string):
        # Allocate a new symbol and set its class to be the symbol class
442 443
        result = Symbol(self.nilObject)
        result.set_class(self.symbolClass)
444 445 446 447 448 449 450 451 452 453

        # Put the string into the symbol
        result.set_string(string)

        # Insert the new symbol into the symbol table
        self._symbol_table.insert(result)

        # Return the freshly allocated symbol
        return result
      
454 455 456 457 458 459
    def new_system_class(self):
        # Allocate the new system class
        system_class = Class(self)

        # Setup the metaclass hierarchy
        system_class.set_class(Class(self))
460
        system_class.get_class().set_class(self.metaclassClass)
461 462 463 464 465 466 467

        # Return the freshly allocated system class
        return system_class
    
    def _initialize_system_class(self, system_class, super_class, name):
        # Initialize the superclass hierarchy
        if super_class:
468
            system_class.set_super_class(super_class)
469 470
            system_class.get_class().set_super_class(super_class.get_class())
        else:
471
            system_class.get_class().set_super_class(self.classClass)
472 473 474 475 476 477 478 479 480 481 482 483
    

        # Initialize the array of instance fields
        system_class.set_instance_fields(self.new_array_with_length(0))
        system_class.get_class().set_instance_fields(self.new_array_with_length(0))

        # Initialize the array of instance invokables
        system_class.set_instance_invokables(self.new_array_with_length(0))
        system_class.get_class().set_instance_invokables(self.new_array_with_length(0))

        # Initialize the name of the system class
        system_class.set_name(self.symbol_for(name))
484
        system_class.get_class().set_name(self.symbol_for(name + " class"))
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505

        # Insert the system class into the dictionary of globals
        self.set_global(system_class.get_name(), system_class)
    
    
    def get_global(self, name):
        # Return the global with the given name if it's in the dictionary of globals
        if self.has_global(name):
            return self._globals[name]

        # Global not found
        return None

    def set_global(self, name, value):
        # Insert the given value into the dictionary of globals
        self._globals[name] = value
  

    def has_global(self, name):
        # Returns if the universe has a value for the global of the given name
        return name in self._globals
506
    
507
    def _get_block_class(self, number_of_arguments = None):
508 509
        if not number_of_arguments:
            # Get the generic block class
510
            return self.blockClass
511 512 513 514 515 516 517 518 519 520 521
        
        # Compute the name of the block class with the given number of
        # arguments
        name = self.symbol_for("Block" + str(number_of_arguments))

        # Lookup the specific block class in the dictionary of globals and
        # return it
        if self.has_global(name):
            return self.get_global(name)

        # Get the block class for blocks with the given number of arguments
Stefan Marr's avatar
Stefan Marr committed
522
        result = self._load_class(name, None)
523 524

        # Add the appropriate value primitive to the block class
525
        result.add_instance_primitive(block_evaluation_primitive(number_of_arguments, self))
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550

        # Insert the block class into the dictionary of globals
        self.set_global(name, result)

        # Return the loaded block class
        return result

    def load_class(self, name):
        # Check if the requested class is already in the dictionary of globals
        if self.has_global(name):
            return self.get_global(name)

        # Load the class
        result = self._load_class(name, None)

        # Load primitives (if necessary) and return the resulting class
        if result and result.has_primitives():
            result.load_primitives()
    
        return result

    def _load_system_class(self, system_class):
        # Load the system class
        result = self._load_class(system_class.get_name(), system_class)

551 552 553 554 555 556 557
        if not result:
            error_println(system_class.get_name().get_string()
                   + " class could not be loaded. It is likely that the "
                   + " class path has not been initialized properly. "
                   + "Please make sure that the '-cp' parameter is given on the command-line.")
            self.exit(200)

558 559 560 561 562 563
        # Load primitives if necessary
        if result.has_primitives():
            result.load_primitives()

    def _load_class(self, name, system_class):
        # Try loading the class from all different paths
564
        for cpEntry in self.classpath:
565 566
            try:
                # Load the class from a file and return the loaded class
567
                result = sourcecode_compiler.compile_class_from_file(cpEntry, name.get_string(), system_class, self)
568
                if self._dump_bytecodes:
569 570 571
                    from som.compiler.disassembler import dump
                    dump(result.get_class())
                    dump(result)
572 573 574 575 576 577 578 579

                return result
            except IOError:
                # Continue trying different paths
                pass

        # The class could not be found.
        return None
580 581 582 583
    
    def load_shell_class(self, stmt):
        # Load the class from a stream and return the loaded class
        result = sourcecode_compiler.compile_class_from_string(stmt, None, self)
Stefan Marr's avatar
Stefan Marr committed
584
        if self._dump_bytecodes:
585 586
            from som.compiler.disassembler import dump
            dump(result)
587 588
        return result

589
def error_print(msg):
590
    os.write(2, msg)
591

592
def error_println(msg = ""):
593
    os.write(2, msg + "\n")
594

595
def std_print(msg):
596
    print msg,
597

598
def std_println(msg=""):
599 600
    print msg

601 602 603 604 605 606
def main(args):
    u = Universe()
    u.interpret(args[1:])
    u.exit(0)

if __name__ == '__main__':
607 608 609 610 611
    import sys
    try:
        main(sys.argv)
    except Exit as e:
        sys.exit(e.code)