universe.py 20.3 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
from som.interpreter.frame       import Frame 
7 8
from som.vm.symbol_table         import SymbolTable
from som.vmobjects.object        import Object
9 10 11
from som.vmobjects.clazz         import Class
from som.vmobjects.array         import Array
from som.vmobjects.symbol        import Symbol
12
from som.vmobjects.method        import Method
Stefan Marr's avatar
Stefan Marr committed
13
from som.vmobjects.integer       import Integer
14
from som.vmobjects.string        import String
15
from som.vmobjects.block         import Block, block_evaluation_primitive
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 36 37
    
    CURRENT = None
    
38
    _immutable_fields_ = [
39 40 41 42 43 44 45
            "nilObject",
            "trueObject",
            "falseObject",
            "objectClass",
            "integerClass",
            "doubleClass",
            "primitiveClass",
46 47 48
            "_global_version?",
            ]

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

56 57 58 59 60 61
        self.nilObject      = None
        self.trueObject     = None
        self.falseObject    = None
        self.objectClass    = None
        self.classClass     = None
        self.metaclassClass = None
62
        
63 64 65 66 67 68 69 70 71
        self.nilClass       = None
        self.integerClass   = None
        self.bigintegerClass= None
        self.arrayClass     = None
        self.methodClass    = None
        self.symbolClass    = None
        self.primitiveClass = None
        self.systemClass    = None
        self.blockClass     = None
72
        self.blockClasses   = None
73 74
        self.stringClass    = None
        self.doubleClass    = None
75 76
        
        self._last_exit_code = 0
77
        self._avoid_exit     = avoid_exit
78
        self._dump_bytecodes = False
Stefan Marr's avatar
Stefan Marr committed
79
        self.classpath       = None
80 81 82
        self.start_time      = time.time() # a float of the time in seconds
        self.random          = Random(abs(int(time.clock() * time.time())))

83
        CURRENT = self
84

85 86 87 88
    def exit(self, error_code):
        if self._avoid_exit:
            self._last_exit_code = error_code
        else:
89
            raise Exit(error_code)
90 91 92 93
    
    def last_exit_code(self):
        return self._last_exit_code
    
94 95 96
    def get_interpreter(self):
        return self._interpreter
    
97 98 99 100 101 102
    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
103
        invokable = clazz.get_class(self).lookup_invokable(self.symbol_for(selector))
104 105 106

        bootstrap_method = self._create_bootstrap_method()
        bootstrap_frame  = self._create_bootstrap_frame(bootstrap_method, clazz)
107
        
108
        return self.start(bootstrap_frame, invokable)
109
    
110 111
    def _create_bootstrap_method(self):
        # Create a fake bootstrap method to simplify later frame traversal
112
        bootstrap_method = self.new_method(self.symbol_for("bootstrap"), 1, [],
113 114
                                           self.new_integer(0),
                                           self.new_integer(2))
115
        bootstrap_method.set_bytecode(0, Bytecodes.halt)
116
        bootstrap_method.set_holder(self.systemClass)
117
        return bootstrap_method
118
    
119 120
    def _create_bootstrap_frame(self, bootstrap_method, receiver, arguments = None):
        # Create a fake bootstrap frame with the system object on the stack
121
        bootstrap_frame = self._interpreter.push_new_frame(bootstrap_method, None)
122 123 124
        bootstrap_frame.push(receiver)
        
        if arguments:
125
            bootstrap_frame.push(arguments)
126
        return bootstrap_frame
127 128
        
    
129 130
    def interpret(self, arguments):
        # Check for command line switches
131
        arguments = self.handle_arguments(arguments)
132 133

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

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

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

        # Exit
        self.exit(0)
219

220
    def _initialize_object_system(self):
221
        # Allocate the nil object
222
        self.nilObject = Object(None)
223 224

        # Allocate the Metaclass classes
225
        self.metaclassClass = self.new_metaclass_class()
226 227

        # Allocate the rest of the system classes
228 229 230 231 232 233 234 235 236 237 238
        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.primitiveClass  = self.new_system_class()
        self.stringClass     = self.new_system_class()
        self.doubleClass     = self.new_system_class()
239 240

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

        # Initialize the system classes
244 245 246 247 248 249 250 251 252 253 254 255
        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.primitiveClass,  self.objectClass, "Primitive")
        self._initialize_system_class(self.stringClass,     self.objectClass, "String")
        self._initialize_system_class(self.doubleClass,     self.objectClass, "Double")
256 257

        # Load methods and fields into the system classes
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.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
    
    def new_array_with_length(self, length):
316
        return Array(self.nilObject, length)
317 318 319 320 321 322 323 324
  
    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])
325

326 327 328 329 330 331 332 333 334 335 336
        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 result
337
    
338
    def new_block(self, method, context_frame, arguments):
339
        return Block(method, context_frame)
340 341 342

    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
343
        result = Class(self, class_class.get_number_of_instance_fields())
344 345 346
        result.set_class(class_class)
        return result

347
    def new_frame(self, previous_frame, method, context):
348 349 350 351 352 353 354
        # 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)

355
        result = Frame(self.nilObject, length, method, context, previous_frame)
356 357 358 359
        result.reset_stack_pointer()
        result.set_bytecode_index(0)
        return result

360
    def new_method(self, signature, num_bytecodes, literals,
361
                   num_locals, maximum_number_of_stack_elements):
362 363
        return Method(literals, num_locals, maximum_number_of_stack_elements,
                      num_bytecodes, signature)
364 365

    def new_instance(self, instance_class):
366
        result = Object(self.nilObject, instance_class.get_number_of_instance_fields())
367 368 369 370 371
        result.set_class(instance_class)
        return result

 
    def new_integer(self, value):
Tobias Pape's avatar
Tobias Pape committed
372
        assert isinstance(value, int)
373
        return Integer(value)
374
 
375
    def new_biginteger(self, value):
376
        return BigInteger(value)
377 378
 
    def new_double(self, value):
379
        return Double(value)
380
    
381 382 383 384 385 386
    def new_metaclass_class(self):
        # Allocate the metaclass classes
        result = Class(self)
        result.set_class(Class(self))

        # Setup the metaclass hierarchy
387
        result.get_class(self).set_class(result)
388 389 390

        # Return the freshly allocated metaclass class
        return result
391 392

    def new_string(self, embedded_string):
393
        return String(embedded_string)
394
    
395
    def new_symbol(self, string):
396
        result = Symbol(string)
397 398 399 400 401

        # Insert the new symbol into the symbol table
        self._symbol_table.insert(result)
        return result
      
402 403 404 405 406 407
    def new_system_class(self):
        # Allocate the new system class
        system_class = Class(self)

        # Setup the metaclass hierarchy
        system_class.set_class(Class(self))
408
        system_class.get_class(self).set_class(self.metaclassClass)
409 410 411 412 413 414 415

        # 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:
416
            system_class.set_super_class(super_class)
417
            system_class.get_class(self).set_super_class(super_class.get_class(self))
418
        else:
419
            system_class.get_class(self).set_super_class(self.classClass)
420 421 422 423
    

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

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

        # Initialize the name of the system class
        system_class.set_name(self.symbol_for(name))
432
        system_class.get_class(self).set_name(self.symbol_for(name + " class"))
433 434 435 436 437 438 439

        # 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
440 441 442 443 444 445
        # if not, return None
        jit.promote(self)
        return self._get_global(name, self._global_version)

    @jit.elidable
    def _get_global(self, name, version):
446
        return self._globals.get(name, None)
447 448 449 450

    def set_global(self, name, value):
        # Insert the given value into the dictionary of globals
        self._globals[name] = value
451
        self._global_version = GlobalVersion()
452 453 454 455

    def has_global(self, name):
        # Returns if the universe has a value for the global of the given name
        return name in self._globals
456 457 458 459 460

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

    def _make_block_class(self, number_of_arguments):
461 462 463 464 465
        # 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
466
        result = self._load_class(name, None)
467 468

        # Add the appropriate value primitive to the block class
469
        result.add_instance_primitive(block_evaluation_primitive(number_of_arguments, self))
470 471 472 473 474 475 476 477 478

        # 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
479 480 481
        result = self.get_global(name)
        if result is not None:
            return result
482 483 484 485 486 487 488 489 490 491 492 493 494 495

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

496 497 498 499 500 501 502
        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)

503 504 505 506 507 508
        # 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
509
        for cpEntry in self.classpath:
510 511
            try:
                # Load the class from a file and return the loaded class
512
                result = sourcecode_compiler.compile_class_from_file(cpEntry, name.get_string(), system_class, self)
513
                if self._dump_bytecodes:
514
                    from som.compiler.disassembler import dump
515
                    dump(result.get_class(self))
516
                    dump(result)
517 518 519 520 521 522 523 524

                return result
            except IOError:
                # Continue trying different paths
                pass

        # The class could not be found.
        return None
525 526 527 528
    
    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
529
        if self._dump_bytecodes:
530 531
            from som.compiler.disassembler import dump
            dump(result)
532 533
        return result

534
def error_print(msg):
535
    os.write(2, msg or "")
536

537
def error_println(msg = ""):
538
    os.write(2, msg + "\n")
539

540
def std_print(msg):
541
    os.write(1, msg or "")
542

543 544
def std_println(msg = ""):
    os.write(1, msg + "\n")
545

546 547 548 549 550
def main(args):
    u = Universe()
    u.interpret(args[1:])
    u.exit(0)

551
def get_current():
552
    return Universe.CURRENT
553

554
if __name__ == '__main__':
555 556 557 558 559
    import sys
    try:
        main(sys.argv)
    except Exit as e:
        sys.exit(e.code)