1 #!/usr/bin/env python 2 3 """ 4 RSVP instruction and serialisation classes. 5 6 Copyright (C) 2007, 2008, 2009, 2010, 2011 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 from micropython.data import Attr, Const, Class, Function, Module 23 from micropython.program import Block, DataObject, DataValue, PlaceholderContext 24 from micropython.raw import RawObject 25 26 def name(attr): 27 if isinstance(attr, Attr): 28 return attr.name or "<unnamed>" 29 elif isinstance(attr, (Block, Const)): 30 return attr 31 else: 32 return attr.full_name() or "<unnamed>" 33 34 # Serialisation-related classes. 35 36 class RSVPObject(RawObject): 37 38 "A generic data object wrapper." 39 40 def _finalise_location(self, with_builtins): 41 42 """ 43 Set the code body location for items now that the code blocks have been 44 positioned. 45 """ 46 47 item = self.item 48 49 if not self.is_generated(with_builtins): 50 item.code_body_location = item.full_name() 51 else: 52 item.code_body_location = item.get_body_block().location 53 54 class RSVPAttr(RSVPObject): 55 56 "A wrapper for attributes/values." 57 58 def as_raw(self, objtable, paramtable, with_builtins): 59 item = self.item 60 return [ 61 DataValue( 62 item.get_context() and item.get_context().location, 63 item.get_value() and item.get_value().location 64 ) 65 ] 66 67 class RSVPBlock(RSVPObject): 68 69 "A wrapper for blocks." 70 71 def set_location(self, location, objtable, with_builtins): 72 item = self.item 73 item.location = location 74 return location + len(item.code) 75 76 def as_raw(self, objtable, paramtable, with_builtins): 77 return self.item.code 78 79 class RSVPClass(RSVPObject): 80 81 "A wrapper for classes." 82 83 def set_location(self, location, objtable, with_builtins): 84 self.item.instance_template_location = location 85 86 # Include the instance template and __class__ attribute in the size. 87 88 return RSVPObject.set_location(self, location + 1, objtable, with_builtins) 89 90 def finalise_location(self, with_builtins): 91 self._finalise_location(with_builtins) 92 93 def as_raw(self, objtable, paramtable, with_builtins): 94 item = self.item 95 classcode = objtable.as_list().get_code(item.full_name()) 96 attrcode = objtable.get_index(item.full_name()) 97 98 # Include a template of an instance for use when instantiating classes. 99 100 call_method = item.all_class_attributes().get("__call__") 101 call_method_value = call_method and call_method.get_value() 102 call_method_code_location = call_method_value and call_method_value.code_location 103 call_method_funccode = call_method_value and paramtable.as_list().get_code(call_method_value.full_name()) 104 105 instantiator_funccode = paramtable.as_list().get_code(item.get_instantiator().full_name()) 106 107 # NOTE: The instantiator code is the first block of the class. 108 109 if not self.is_generated(with_builtins): 110 instantiator_code_location = item.full_name() 111 else: 112 instantiator_code_location = item.get_instantiator().blocks[0].location 113 114 return [ 115 116 # Template instance... 117 118 DataObject( 119 classcode, 120 attrcode, # is instance 121 call_method_code_location, 122 item.full_name(), 123 len(item.instance_attributes()), # size (excluding __class__) 124 call_method_funccode # funccode 125 ), 126 127 # Class... 128 129 DataObject( 130 classcode, 131 None, # is not instance 132 instantiator_code_location, 133 item.full_name(), 134 len(item.class_attributes()) + 1, # size 135 instantiator_funccode # funccode 136 ) 137 ] 138 139 class RSVPConst(RSVPObject): 140 141 "A wrapper for constants." 142 143 def set_location(self, location, objtable, with_builtins): 144 item = self.item 145 value = item.get_value() 146 type_name = self.type_name(item.value_type_name(), value, objtable) 147 148 location = RSVPObject.set_location(self, location, objtable, with_builtins) 149 return location + self.raw_size(type_name, value) 150 151 def as_raw(self, objtable, paramtable, with_builtins): 152 item = self.item 153 value = item.get_value() 154 type_name = self.type_name(item.value_type_name(), value, objtable) 155 raw_data = self.raw_data(type_name, value, objtable) 156 size = self.raw_size(type_name, value) + 1 157 158 # Generate the footprint of the constant. 159 160 classcode = objtable.as_list().get_code(type_name) 161 attrcode = objtable.get_index(type_name) 162 163 return [ 164 DataObject( 165 classcode, 166 attrcode, # is instance 167 None, 168 type_name, 169 size # header plus data 170 ) 171 172 # NOTE: The RSVP library needs changing if more attributes are added 173 # NOTE: here (such as a __class__ attribute for all instances). 174 175 ] + raw_data 176 177 def type_name(self, type_name, value, objtable): 178 179 # Change the type of string constants if they might be used as attribute 180 # accessors. 181 182 accessor_cls = "__builtins__._accessor" 183 184 if type_name == "__builtins__.str" and value in objtable.attribute_names() and \ 185 accessor_cls in objtable.object_names(): 186 187 return accessor_cls 188 else: 189 return type_name 190 191 def raw_data(self, type_name, value, objtable): 192 193 # NOTE: Start simple and use single entries for most types, even though 194 # NOTE: a concrete representation may use multiple memory words to 195 # NOTE: represent the data. 196 197 if type_name in ("__builtins__.tuple", "__builtins__.list"): 198 return [len(value)] + list(value) 199 elif type_name == "__builtins__._accessor": 200 return [value, objtable.get_index(value)] 201 else: 202 return [value] 203 204 def raw_size(self, type_name, value): 205 if type_name in ("__builtins__.tuple", "__builtins__.list"): 206 return 1 + len(value) 207 elif type_name == "__builtins__._accessor": 208 return 2 209 else: 210 return 1 211 212 class RSVPFunction(RSVPObject): 213 214 "A wrapper for functions." 215 216 def set_location(self, location, objtable, with_builtins): 217 item = self.item 218 location = RSVPObject.set_location(self, location, objtable, with_builtins) 219 220 # Set the code location only where the code has been 221 # generated. 222 223 if not self.is_generated(with_builtins): 224 item.code_location = item.full_name() 225 226 # Skip any defaults for static functions. 227 228 elif not item.is_dynamic(): 229 item.code_location = location + len(item.defaults) 230 231 # Skip any defaults for dynamic functions. 232 233 else: 234 item.code_location = location 235 236 return location 237 238 def finalise_location(self, with_builtins): 239 self._finalise_location(with_builtins) 240 241 def as_raw(self, objtable, paramtable, with_builtins): 242 item = self.item 243 # NOTE: Need class and parameter details! Should arguably be an instance of types.FunctionType. 244 return [ 245 DataObject( 246 objtable.as_list().get_code("__builtins__.function"), 247 objtable.get_index("__builtins__.function"), # is instance 248 item.code_location, 249 "__builtins__.function", 250 len(item.defaults) + 1, # size (not accurate for lambda functions before instantiation) 251 paramtable.as_list().get_code(item.full_name()) # funccode 252 ) 253 ] 254 255 class RSVPModule(RSVPObject): 256 257 "A wrapper for modules." 258 259 def as_raw(self, objtable, paramtable, with_builtins): 260 item = self.item 261 return [ 262 DataObject( 263 objtable.as_list().get_code(item.full_name()), 264 None, # modules treated like classes 265 None, 266 item.full_name(), 267 len(item.module_attributes()) + 1 # size 268 ) 269 ] 270 271 # Serialisation-related data and functions. 272 273 def get_object(item): 274 if isinstance(item, Attr): 275 cls = RSVPAttr 276 elif isinstance(item, Block): 277 cls = RSVPBlock 278 elif isinstance(item, Class): 279 cls = RSVPClass 280 elif isinstance(item, Const): 281 cls = RSVPConst 282 elif isinstance(item, Function): 283 cls = RSVPFunction 284 elif isinstance(item, Module): 285 cls = RSVPModule 286 else: 287 cls = None 288 289 if cls is not None: 290 return cls(item) 291 else: 292 return None 293 294 # Instruction-related classes. 295 296 class Instruction: 297 298 "A generic instruction." 299 300 # NOTE: Ultimately, instructions apart from Transfer will use specific 301 # NOTE: registers such as "working_value" and "working_context". 302 303 def __init__(self, attr=None, working="working", target="working", source=None): 304 self.attr = attr 305 self.working = working 306 self.target = target 307 self.source = source 308 309 def copy(self): 310 return self.__class__(self.attr, self.working, self.target, self.source) 311 312 def __repr__(self): 313 return "%s(%s%s%s%s)" % (self.__class__.__name__, 314 self.format_operand(), 315 self.format_working(), 316 self.format_source(), 317 self.format_target()) 318 319 def format_operand(self): 320 operand = self.get_operand() 321 return repr(operand) 322 323 def format_working(self): 324 return self.working != "working" and (", working=%r" % self.working) or "" 325 326 def format_source(self): 327 return self.source is not None and (", source=%r" % self.source) or "" 328 329 def format_target(self): 330 return self.target != "working" and (", target=%r" % self.target) or "" 331 332 def get_operand(self): 333 return None 334 335 class FrameRelativeInstruction(Instruction): 336 337 "An instruction operating on the current frame." 338 339 def get_operand(self): 340 return self.attr.position 341 342 FR = FrameRelativeInstruction 343 344 class AddressRelativeInstruction(Instruction): 345 346 "An instruction accessing an object's attribute." 347 348 def format_operand(self): 349 return "%s, name=%r" % (Instruction.format_operand(self), name(self.attr)) 350 351 def get_operand(self): 352 return self.attr.position 353 354 AR = AddressRelativeInstruction 355 356 class AddressInstruction(Instruction): 357 358 "An instruction loading an address directly." 359 360 def format_operand(self): 361 location, position, result = self.get_operands() 362 if location is not None: 363 return "%s, location=%s, position=%s, name=%s" % ( 364 result, location, position, name(self.attr)) 365 elif result is not None: 366 return "%s, name=%s" % (result, name(self.attr)) 367 else: 368 return "name=%s" % name(self.attr) 369 370 def get_operands(self): 371 if isinstance(self.attr, Attr): 372 position = self.attr.position 373 location = self.attr.parent.location 374 375 # NOTE: Unpositioned attributes are handled here. 376 377 if location is not None and position is not None: 378 result = location + position + 1 379 else: 380 location = self.attr.parent.name 381 position = self.attr.name 382 result = None 383 return location, position, result 384 else: 385 return None, None, self.attr.location 386 387 def get_operand(self): 388 return self.get_operands()[-1] 389 390 Address = AddressInstruction 391 392 class TargetInstruction(Instruction): 393 394 "An instruction loading the address of an invocation target." 395 396 def format_operand(self): 397 return "%s, name=%r" % (Instruction.format_operand(self), name(self.attr)) 398 399 def get_operand(self): 400 return self.attr.code_body_location 401 402 Target = TargetInstruction 403 404 class ImmediateInstruction(Instruction): 405 406 "An instruction employing a constant." 407 408 def get_operand(self): 409 return self.attr 410 411 Immediate = ImmediateInstruction 412 413 # Low-level instructions. 414 415 class Transfer(Instruction): 416 "Transfer a register's contents into another." 417 cost = 1 418 419 # Access to stored constant data. 420 421 class LoadConst(Address): 422 "Load the constant or module from the specified location." 423 cost = 1 424 425 class LoadClass(Address): 426 "Load the class from the specified location." 427 cost = 1 428 429 class LoadFunction(Address): 430 "Load the function from the specified location." 431 cost = 1 432 433 # Access within an invocation frame. 434 435 class LoadName(FR): 436 "Load the current value from the given local attribute/variable." 437 cost = 2 438 439 class StoreName(FR): 440 "Store the source value into the given local attribute/variable." 441 cost = 2 442 443 class LoadTemp(Immediate): 444 "Load the current value from the given temporary location." 445 cost = 2 446 447 class StoreTemp(Immediate): 448 "Store the current value into the given temporary location." 449 cost = 2 450 451 # Access to static data. 452 453 class LoadAddress(Address): 454 "Load the current value from the given fixed attribute address." 455 cost = 1 456 457 class StoreAddress(Address): 458 "Store the source value into the given fixed attribute address." 459 cost = 1 460 461 class LoadAddressContext(Address): 462 "Load the current value from the given fixed attribute address, using the current value as context." 463 cost = 2 464 465 class StoreAddressContext(Address): 466 "Store the current value into the given fixed attribute address, using the current value as context." 467 cost = 2 468 469 class LoadAddressContextCond(Address): 470 """ 471 Load the current value from the given fixed attribute address, only using the current value as 472 context if the attribute is compatible. 473 """ 474 cost = 4 475 476 class MakeInstance(Immediate): 477 "Make a new instance using the current value as a reference to a template." 478 cost = 5 479 480 class MakeFragment(Immediate): 481 "Make a new list fragment." 482 cost = 5 483 484 # Access to address-relative data. (LoadAttrIndexContext not defined.) 485 486 class LoadAttr(AR): 487 "Load into the current value the given attribute of the object referenced by the current value." 488 cost = 2 489 490 class StoreAttr(AR): 491 "Store the source value into the given attribute of the object referenced by the current value." 492 cost = 2 493 494 class LoadAttrIndex(Immediate): 495 "Load into the current value the attribute of the current value with the given index." 496 cost = 6 497 498 class StoreAttrIndex(Immediate): 499 "Store the source value into the attribute of the current value with the given index." 500 cost = 6 501 502 class LoadAttrIndexContextCond(Immediate): 503 """ 504 Load into the current value the attribute of the current value with the given index, only making the 505 current value the context if the attribute is compatible. 506 """ 507 cost = 8 508 509 # Access to object details. 510 511 class LoadCallable(Instruction): 512 "Load the target of an invocation." 513 cost = 2 514 515 class StoreCallable(Instruction): 516 "Store the source value into the object referenced by the current value." 517 cost = 3 518 519 # Access to invocation frames in preparation. 520 521 class MakeFrame(Immediate): 522 "Make a new invocation frame." 523 cost = 2 524 525 class AdjustFrame(Immediate): 526 "Adjust the current invocation frame for corrected invocations." 527 cost = 2 528 529 class DropFrame(Instruction): 530 "Drop an invocation frame." 531 cost = 2 532 533 class StoreFrame(Immediate): 534 "Store the current value as an argument for the parameter with the given position." 535 cost = 2 536 537 class StoreFrameIndex(Immediate): 538 "Store the source value as an argument of the current value for the parameter with the given index." 539 cost = 6 540 541 # Context-related tests. 542 543 class CheckContext(Instruction): 544 "Check to see if the context is valid." 545 cost = 2 546 547 class CheckClass(Instruction): 548 "Check the current value to determine whether it is a class." 549 cost = 2 550 551 class CheckInstance(Instruction): 552 """ 553 Check the current value as an instance of a class or its subclasses (used with 'self' in an 554 invocation). 555 """ 556 cost = 6 557 558 # Access to frames upon invocation. 559 560 class CheckFrame(Immediate): 561 "Check the frame for the correct number of arguments." 562 cost = 3 563 564 class CheckExtra(Immediate): 565 "Ensure that the frame can provide extra arguments." 566 cost = 3 567 568 class FillDefaults(Immediate): 569 "Fill frame positions with defaults, if appropriate." 570 cost = 8 # variable 571 572 class ExtendFrame(Immediate): 573 "Extend the current frame for temporary storage use." 574 cost = 1 575 576 class CopyExtra(Immediate): 577 "Copy extra arguments into a separate sequence, starting from the given position." 578 cost = 10 579 580 # Invocation-related instructions, using a special result "register". 581 582 class JumpInFrame(Instruction): 583 "Jump, using the current locals, to the current callable." 584 cost = 2 585 586 class JumpWithFrame(Instruction): 587 "Jump, adopting the invocation frame, to the current callable." 588 cost = 3 589 590 class JumpWithFrameDirect(Target): 591 "Jump to the specified address, adopting the invocation frame." 592 cost = 3 593 594 class Return(Instruction): 595 "Return from a subprogram." 596 cost = 2 597 598 # Branch-related instructions. 599 600 class Jump(Address): 601 "Jump unconditionally." 602 cost = 1 603 604 class JumpIfFalse(Address): 605 "Jump if the last evaluation gave a false result." 606 cost = 2 607 608 class JumpIfTrue(Address): 609 "Jump if the last evaluation gave a true result." 610 cost = 2 611 612 # Exception-related instructions, using a special exception "register". 613 614 class RaiseException(Instruction): 615 "Raise an exception, jumping to the active handler." 616 cost = 2 617 618 class PushHandler(Address): 619 "Push an exception handler onto the handler stack." 620 cost = 3 621 622 class PopHandler(Immediate): 623 "Pop exception handlers from the handler stack." 624 cost = 3 625 626 class CheckException(Instruction): 627 "Check the raised exception against another." 628 cost = 6 629 630 class ClearException(Instruction): 631 "Clear any raised exception." 632 cost = 1 633 634 # Test instructions, operating on the boolean status register. 635 636 class TestIdentity(Instruction): 637 "Test whether the current value is identical to the source value, setting the boolean status." 638 cost = 2 639 640 class TestIdentityAddress(Address): 641 "Test whether the current value is identical to the given address, setting the boolean status." 642 cost = 2 643 644 class InvertBoolean(Instruction): 645 "Invert the boolean status." 646 cost = 1 647 648 # Instructions which can affect the current value. (LoadAttrIndexContext not defined.) 649 650 current_value_instructions = ( 651 Transfer, 652 LoadConst, LoadClass, LoadFunction, 653 LoadName, LoadTemp, 654 LoadAddress, LoadAddressContext, LoadAddressContextCond, 655 LoadAttr, LoadAttrIndex, LoadAttrIndexContextCond, 656 LoadCallable, 657 MakeInstance, MakeFragment, 658 CopyExtra, 659 CheckClass, CheckContext, CheckException, CheckInstance, CheckFrame, CheckExtra 660 ) 661 662 # vim: tabstop=4 expandtab shiftwidth=4