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
from som.vm.symbol_table         import SymbolTable
8
from som.vmobjects.abstract_object import AbstractObject
9
from som.vmobjects.object        import Object
10 11 12
from som.vmobjects.clazz         import Class
from som.vmobjects.array         import Array
from som.vmobjects.symbol        import Symbol
13
from som.vmobjects.method        import Method
Stefan Marr's avatar
Stefan Marr committed
14
from som.vmobjects.integer       import Integer
15
from som.vmobjects.string        import String
16
from som.vmobjects.block         import Block, block_evaluation_primitive
17
from som.vmobjects.biginteger    import BigInteger
18
from som.vmobjects.double        import Double
19

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

22 23
import som.compiler.sourcecode_compiler as sourcecode_compiler

24
import os
25 26
import time

27

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

31 32 33 34

class GlobalVersion(object):
    pass

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

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

54 55 56 57 58 59
        self.nilObject      = None
        self.trueObject     = None
        self.falseObject    = None
        self.objectClass    = None
        self.classClass     = None
        self.metaclassClass = None
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.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
    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
100
        invokable = clazz.get_class(self).lookup_invokable(self.symbol_for(selector))
101 102 103

        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
        bootstrap_method = self.new_method(self.symbol_for("bootstrap"), 1, [],
110 111
                                           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, None)
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
        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()
236 237

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

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

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

        # Load the generic block class
269
        self.blockClass = self.load_class(self.symbol_for("Block"))
270 271

        # Setup the true and false objects
272 273 274 275 276 277 278
        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)
279 280

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

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

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

300 301
        return system_object
    
302 303 304 305 306 307 308 309 310
    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
311 312
    
    def new_array_with_length(self, length):
313
        return Array(self.nilObject, length)
314 315 316 317 318 319 320 321
  
    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])
322

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

    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
340
        result = Class(self, class_class.get_number_of_instance_fields())
341 342 343
        result.set_class(class_class)
        return result

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

352
        result = Frame(self.nilObject, length, method, context, previous_frame)
353 354 355 356
        result.reset_stack_pointer()
        result.set_bytecode_index(0)
        return result

357
    def new_method(self, signature, num_bytecodes, literals,
358
                   num_locals, maximum_number_of_stack_elements):
359 360
        return Method(literals, num_locals, maximum_number_of_stack_elements,
                      num_bytecodes, signature)
361 362

    def new_instance(self, instance_class):
363
        result = Object(self.nilObject, instance_class.get_number_of_instance_fields())
364 365 366 367 368
        result.set_class(instance_class)
        return result

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

        # Setup the metaclass hierarchy
384
        result.get_class(self).set_class(result)
385 386 387

        # Return the freshly allocated metaclass class
        return result
388 389

    def new_string(self, embedded_string):
390
        return String(embedded_string)
391
    
392
    def new_symbol(self, string):
393
        result = Symbol(string)
394 395 396 397 398

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

        # Setup the metaclass hierarchy
        system_class.set_class(Class(self))
405
        system_class.get_class(self).set_class(self.metaclassClass)
406 407 408 409 410 411 412

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

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

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

        # Initialize the name of the system class
        system_class.set_name(self.symbol_for(name))
429
        system_class.get_class(self).set_name(self.symbol_for(name + " class"))
430 431 432 433 434 435 436

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

    @jit.elidable
    def _get_global(self, name, version):
443
        return self._globals.get(name, None)
444 445 446 447

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

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

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

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

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

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

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

493 494 495 496 497 498 499
        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)

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

                return result
            except IOError:
                # Continue trying different paths
                pass

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

531
def error_print(msg):
532
    os.write(2, msg or "")
533

534
def error_println(msg = ""):
535
    os.write(2, msg + "\n")
536

537
def std_print(msg):
538
    os.write(1, msg or "")
539

540 541
def std_println(msg = ""):
    os.write(1, msg + "\n")
542

543 544 545
# Global Universe instance
u = None

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

552 553 554
def get_current():
    return u

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