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

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

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

21 22
import som.compiler.sourcecode_compiler as sourcecode_compiler

23
import os
24 25
import time

26

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

30 31 32 33

class GlobalVersion(object):
    pass

34
class Universe(object):
35
    _immutable_fields_ = [
36 37 38 39 40 41 42
            "nilObject",
            "trueObject",
            "falseObject",
            "objectClass",
            "integerClass",
            "doubleClass",
            "primitiveClass",
43 44 45
            "_global_version?",
            ]

46
    def __init__(self, avoid_exit = False):
47 48 49 50
        self._interpreter    = Interpreter(self)
        self._symbol_table   = SymbolTable()
        
        self._globals        = {}
51 52
        self._global_version = GlobalVersion()

53 54 55 56 57 58
        self.nilObject      = None
        self.trueObject     = None
        self.falseObject    = None
        self.objectClass    = None
        self.classClass     = None
        self.metaclassClass = None
59
        
60 61 62 63 64 65 66 67 68 69
        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
70
        self.blockClasses   = None
71 72
        self.stringClass    = None
        self.doubleClass    = None
73 74
        
        self._last_exit_code = 0
75
        self._avoid_exit     = avoid_exit
76
        self._dump_bytecodes = False
Stefan Marr's avatar
Stefan Marr committed
77
        self.classpath       = None
78 79 80
        self.start_time      = time.time() # a float of the time in seconds
        self.random          = Random(abs(int(time.clock() * time.time())))

81

82 83 84 85
    def exit(self, error_code):
        if self._avoid_exit:
            self._last_exit_code = error_code
        else:
86
            raise Exit(error_code)
87 88 89 90
    
    def last_exit_code(self):
        return self._last_exit_code
    
91 92 93
    def get_interpreter(self):
        return self._interpreter
    
94 95 96 97 98 99 100 101 102 103
    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)
104
        
105
        return self.start(bootstrap_frame, invokable)
106
    
107 108
    def _create_bootstrap_method(self):
        # Create a fake bootstrap method to simplify later frame traversal
109 110 111
        bootstrap_method = self.new_method(self.symbol_for("bootstrap"), 1, 0,
                                           self.new_integer(0),
                                           self.new_integer(2))
112
        bootstrap_method.set_bytecode(0, Bytecodes.halt)
113
        bootstrap_method.set_holder(self.systemClass)
114
        return bootstrap_method
115
    
116 117
    def _create_bootstrap_frame(self, bootstrap_method, receiver, arguments = None):
        # Create a fake bootstrap frame with the system object on the stack
118
        bootstrap_frame = self._interpreter.push_new_frame(bootstrap_method, self.nilObject)
119 120 121
        bootstrap_frame.push(receiver)
        
        if arguments:
122
            bootstrap_frame.push(arguments)
123
        return bootstrap_frame
124 125
        
    
126 127
    def interpret(self, arguments):
        # Check for command line switches
128
        arguments = self.handle_arguments(arguments)
129 130

        # Initialize the known universe
131 132
        system_object = self._initialize_object_system()
        bootstrap_method = self._create_bootstrap_method()
133
        
134 135 136 137 138 139 140
        # 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:
141 142 143
            # 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)
144
            # Lookup the initialize invokable on the system class
145
            initialize = self.systemClass.lookup_invokable(self.symbol_for("initialize:"))
146 147 148 149 150 151 152 153 154

            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()
155
    
156
    def handle_arguments(self, arguments):
157 158 159 160 161 162 163 164
        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()
165
                self.setup_classpath(arguments[i + 1])
166 167 168 169
                i += 1    # skip class path
                got_classpath = True
            elif arguments[i] == "-d":
                self._dump_bytecodes = True
Tobias Pape's avatar
Tobias Pape committed
170 171
            elif arguments[i] in ["-h", "--help", "-?"]:
                self._print_usage_and_exit()
172 173
            else:
                remaining_args.append(arguments[i])
Tobias Pape's avatar
Tobias Pape committed
174
            i += 1
175 176 177
    
        if not got_classpath:
            # Get the default class path of the appropriate size
178
            self.classpath = self._setup_default_classpath()
179 180 181 182 183 184 185

        # 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
186
                self.classpath.insert(0, split[0])
187 188 189 190 191 192
        
            remaining_args[i] = split[1]
            i += 1
        
        return remaining_args
    
193
    def setup_classpath(self, cp):
194
        self.classpath = cp.split(os.pathsep)
195
    
196 197 198
    def _setup_default_classpath(self):
        return ['.']
    
199 200 201
    # take argument of the form "../foo/Test.som" and return
    # "../foo", "Test", "som"
    def _get_path_class_ext(self, path):
202
        return path_split(path)
203 204 205
    
    def _print_usage_and_exit(self):
        # Print the usage
206 207 208 209
        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
210 211 212
        std_println("        set search path for application classes")
        std_println("    -d  enable disassembling")
        std_println("    -h  print this help")
213 214 215

        # Exit
        self.exit(0)
216

217
    def _initialize_object_system(self):
218
        # Allocate the nil object
219
        self.nilObject = Object(None)
220 221

        # Allocate the Metaclass classes
222
        self.metaclassClass = self.new_metaclass_class()
223 224

        # Allocate the rest of the system classes
225 226 227 228 229 230 231 232 233 234 235 236
        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()
237 238

        # Setup the class reference for the nil object
239
        self.nilObject.set_class(self.nilClass)
240 241

        # Initialize the system classes
242 243 244 245 246 247 248 249 250 251 252 253 254
        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")
255 256

        # Load methods and fields into the system classes
257 258 259 260 261 262 263 264 265 266 267 268 269
        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)
270 271

        # Load the generic block class
272
        self.blockClass = self.load_class(self.symbol_for("Block"))
273 274

        # Setup the true and false objects
275 276 277 278 279 280 281
        trueClassName    = self.symbol_for("True")
        trueClass        = self.load_class(trueClassName)
        self.trueObject  = self.new_instance(trueClass)
        
        falseClassName   = self.symbol_for("False")
        falseClass       = self.load_class(falseClassName)
        self.falseObject = self.new_instance(falseClass)
282 283

        # Load the system class and create an instance of it
284 285
        self.systemClass = self.load_class(self.symbol_for("System"))
        system_object = self.new_instance(self.systemClass)
286 287

        # Put special objects and classes into the dictionary of globals
288 289 290
        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)
291
        self.set_global(self.symbol_for("system"), system_object)
292 293
        self.set_global(self.symbol_for("System"), self.systemClass)
        self.set_global(self.symbol_for("Block"),  self.blockClass)
294 295 296 297 298
        
        self.set_global(self.symbol_for("Nil"),    self.nilClass)
        
        self.set_global( trueClassName,  trueClass)
        self.set_global(falseClassName, falseClass)
299 300 301 302

        self.blockClasses = [self.blockClass] + \
                [self._make_block_class(i) for i in [1, 2, 3]]

303 304
        return system_object
    
305 306 307 308 309 310 311 312 313
    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
314 315 316
    
    def new_array_with_length(self, length):
        # Allocate a new array and set its class to be the array class
317
        result = Array(self.nilObject, length)
318
        result.set_class(self.arrayClass)
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343

        # 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
344
    
345 346
    def new_block(self, method, context_frame, arguments):
        # Allocate a new block and set its class to be the block class
347
        result = Block(self.nilObject, method, context_frame)
348 349 350 351 352 353 354
        result.set_class(self._get_block_class(arguments))

        # 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
355
        result = Class(self, class_class.get_number_of_instance_fields())
356 357 358 359 360
        result.set_class(class_class)

        # Return the freshly allocated class
        return result

361
    def new_frame(self, previous_frame, method, context):
362 363 364 365 366 367 368
        # 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)

369 370 371
        # Allocate a new frame and set its class to be the frame class
        result = Frame(self.nilObject, length, method, context, previous_frame)
        result.set_class(self.frameClass)
372 373 374 375 376 377 378 379

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

        # Return the freshly allocated frame
        return result

380 381
    def new_method(self, signature, num_bytecodes, num_literals,
                   num_locals, maximum_number_of_stack_elements):
382
        # Allocate a new method and set its class to be the method class
383 384 385 386 387 388
        result = Method(self.nilObject,
                        num_literals,
                        num_locals,
                        maximum_number_of_stack_elements,
                        num_bytecodes,
                        signature)
389
        result.set_class(self.methodClass)
390 391 392 393 394 395

        # 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
396
        result = Object(self.nilObject, instance_class.get_number_of_instance_fields())
397 398 399 400 401 402 403
        result.set_class(instance_class)
 
        # Return the freshly allocated instance
        return result

 
    def new_integer(self, value):
Tobias Pape's avatar
Tobias Pape committed
404
        assert isinstance(value, int)
405
        # Allocate a new integer and set its class to be the integer class
406
        result = Integer(self.nilObject, value)
407
        result.set_class(self.integerClass)
408 409 410 411
     
        # Return the freshly allocated integer
        return result
 
412
    def new_biginteger(self, value):
413
        # Allocate a new integer and set its class to be the integer class
414
        result = BigInteger(self.nilObject, value)
415
        result.set_class(self.bigintegerClass)
416 417 418 419 420 421 422
 
        # 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
423
        result = Double(self.nilObject, value)
424
        result.set_class(self.doubleClass)
425 426 427 428
 
        # Return the freshly allocated double
        return result
    
429 430 431 432 433 434 435 436 437 438
    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
439 440 441

    def new_string(self, embedded_string):
        # Allocate a new string and set its class to be the string class
442
        result = String(self.nilObject, embedded_string)
443
        result.set_class(self.stringClass)
444
  
445 446
        # Return the freshly allocated string
        return result
447
    
448 449
    def new_symbol(self, string):
        # Allocate a new symbol and set its class to be the symbol class
450
        result = Symbol(self.nilObject, string)
451
        result.set_class(self.symbolClass)
452 453 454 455 456 457 458

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

        # Return the freshly allocated symbol
        return result
      
459 460 461 462 463 464
    def new_system_class(self):
        # Allocate the new system class
        system_class = Class(self)

        # Setup the metaclass hierarchy
        system_class.set_class(Class(self))
465
        system_class.get_class().set_class(self.metaclassClass)
466 467 468 469 470 471 472

        # 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:
473
            system_class.set_super_class(super_class)
474 475
            system_class.get_class().set_super_class(super_class.get_class())
        else:
476
            system_class.get_class().set_super_class(self.classClass)
477 478 479 480 481 482 483 484 485 486 487 488
    

        # 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))
489
        system_class.get_class().set_name(self.symbol_for(name + " class"))
490 491 492 493 494 495 496

        # 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
497 498 499 500 501 502
        # if not, return None
        jit.promote(self)
        return self._get_global(name, self._global_version)

    @jit.elidable
    def _get_global(self, name, version):
503
        return self._globals.get(name, None)
504 505 506 507

    def set_global(self, name, value):
        # Insert the given value into the dictionary of globals
        self._globals[name] = value
508
        self._global_version = GlobalVersion()
509 510 511 512

    def has_global(self, name):
        # Returns if the universe has a value for the global of the given name
        return name in self._globals
513 514 515 516 517

    def _get_block_class(self, number_of_arguments):
        return self.blockClasses[number_of_arguments]

    def _make_block_class(self, number_of_arguments):
518 519 520 521 522
        # Compute the name of the block class with the given number of
        # arguments
        name = self.symbol_for("Block" + str(number_of_arguments))

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

        # Add the appropriate value primitive to the block class
526
        result.add_instance_primitive(block_evaluation_primitive(number_of_arguments, self))
527 528 529 530 531 532 533 534 535

        # 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
536 537 538
        result = self.get_global(name)
        if result is not None:
            return result
539 540 541 542 543 544 545 546 547 548 549 550 551 552

        # 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)

553 554 555 556 557 558 559
        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)

560 561 562 563 564 565
        # 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
566
        for cpEntry in self.classpath:
567 568
            try:
                # Load the class from a file and return the loaded class
569
                result = sourcecode_compiler.compile_class_from_file(cpEntry, name.get_string(), system_class, self)
570
                if self._dump_bytecodes:
571 572 573
                    from som.compiler.disassembler import dump
                    dump(result.get_class())
                    dump(result)
574 575 576 577 578 579 580 581

                return result
            except IOError:
                # Continue trying different paths
                pass

        # The class could not be found.
        return None
582 583 584 585
    
    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
586
        if self._dump_bytecodes:
587 588
            from som.compiler.disassembler import dump
            dump(result)
589 590
        return result

591
def error_print(msg):
592
    os.write(2, msg or "")
593

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

597
def std_print(msg):
598
    os.write(1, msg or "")
599

600 601
def std_println(msg = ""):
    os.write(1, msg + "\n")
602

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

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