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 get_details(self): 310 return self.__class__, self.attr, self.working, self.target, self.source 311 312 def copy(self): 313 return self.__class__(self.attr, self.working, self.target, self.source) 314 315 def __repr__(self): 316 return "%s(%s%s%s%s)" % (self.__class__.__name__, 317 self.format_operand(), 318 self.format_working(), 319 self.format_source(), 320 self.format_target()) 321 322 def __hash__(self): 323 return hash(self.get_details()) 324 325 def __eq__(self, other): 326 return self.get_details() == other.get_details() 327 328 def __ne__(self, other): 329 return not self.__eq__(other) 330 331 def format_operand(self): 332 operand = self.get_operand() 333 return repr(operand) 334 335 def format_working(self): 336 return self.working != "working" and (", working=%r" % self.working) or "" 337 338 def format_source(self): 339 return self.source is not None and (", source=%r" % self.source) or "" 340 341 def format_target(self): 342 return self.target != "working" and (", target=%r" % self.target) or "" 343 344 def get_operand(self): 345 return None 346 347 class FrameRelativeInstruction(Instruction): 348 349 "An instruction operating on the current frame." 350 351 def get_operand(self): 352 return self.attr.position 353 354 FR = FrameRelativeInstruction 355 356 class AddressRelativeInstruction(Instruction): 357 358 "An instruction accessing an object's attribute." 359 360 def format_operand(self): 361 return "%s, name=%r" % (Instruction.format_operand(self), name(self.attr)) 362 363 def get_operand(self): 364 return self.attr.position 365 366 AR = AddressRelativeInstruction 367 368 class AddressInstruction(Instruction): 369 370 "An instruction loading an address directly." 371 372 def format_operand(self): 373 location, position, result = self.get_operands() 374 if location is not None: 375 return "%s, location=%s, position=%s, name=%s" % ( 376 result, location, position, name(self.attr)) 377 elif result is not None: 378 return "%s, name=%s" % (result, name(self.attr)) 379 else: 380 return "name=%s" % name(self.attr) 381 382 def get_operands(self): 383 if isinstance(self.attr, Attr): 384 position = self.attr.position 385 location = self.attr.parent.location 386 387 # NOTE: Unpositioned attributes are handled here. 388 389 if location is not None and position is not None: 390 result = location + position + 1 391 else: 392 location = self.attr.parent.name 393 position = self.attr.name 394 result = None 395 return location, position, result 396 else: 397 return None, None, self.attr.location 398 399 def get_operand(self): 400 return self.get_operands()[-1] 401 402 Address = AddressInstruction 403 404 class TargetInstruction(Instruction): 405 406 "An instruction loading the address of an invocation target." 407 408 def format_operand(self): 409 return "%s, name=%r" % (Instruction.format_operand(self), name(self.attr)) 410 411 def get_operand(self): 412 return self.attr.code_body_location 413 414 Target = TargetInstruction 415 416 class ImmediateInstruction(Instruction): 417 418 "An instruction employing a constant." 419 420 def get_operand(self): 421 return self.attr 422 423 Immediate = ImmediateInstruction 424 425 # Low-level instructions. 426 427 class Transfer(Instruction): 428 "Transfer a register's contents into another." 429 cost = 1 430 431 class LoadMemory(Instruction): 432 "Load a value from a memory address given by a register, optionally adding the operand." 433 cost = 1 434 435 class Add(Instruction): 436 "Add the value given by the working register to the operand." 437 cost = 1 438 439 class Multiply(Instruction): 440 "Multiply the value given by the working register by the operand." 441 cost = 1 442 443 # Access to stored constant data. 444 445 class LoadConst(Address): 446 "Load the constant or module from the specified location." 447 cost = 1 448 449 class LoadClass(Address): 450 "Load the class from the specified location." 451 cost = 1 452 453 class LoadFunction(Address): 454 "Load the function from the specified location." 455 cost = 1 456 457 # Access within an invocation frame. 458 459 class LoadName(FR): 460 "Load the current value from the given local attribute/variable." 461 cost = 2 462 463 class StoreName(FR): 464 "Store the source value into the given local attribute/variable." 465 cost = 2 466 467 class LoadTemp(Immediate): 468 "Load the current value from the given temporary location." 469 cost = 2 470 471 class StoreTemp(Immediate): 472 "Store the current value into the given temporary location." 473 cost = 2 474 475 # Access to static data. 476 477 class LoadAddress(Address): 478 "Load the current value from the given fixed attribute address." 479 cost = 1 480 481 class StoreAddress(Address): 482 "Store the source value into the given fixed attribute address." 483 cost = 1 484 485 class LoadAddressContext(Address): 486 "Load the current value from the given fixed attribute address, using the current value as context." 487 cost = 2 488 489 class StoreAddressContext(Address): 490 "Store the current value into the given fixed attribute address, using the current value as context." 491 cost = 2 492 493 class LoadAddressContextCond(Address): 494 """ 495 Load the current value from the given fixed attribute address, only using the current value as 496 context if the attribute is compatible. 497 """ 498 cost = 4 499 500 class MakeInstance(Immediate): 501 "Make a new instance using the current value as a reference to a template." 502 cost = 5 503 504 class MakeFragment(Immediate): 505 "Make a new list fragment." 506 cost = 5 507 508 # Access to address-relative data. (LoadAttrIndexContext not defined.) 509 510 class LoadAttr(AR): 511 "Load into the current value the given attribute of the object referenced by the current value." 512 cost = 2 513 514 class StoreAttr(AR): 515 "Store the source value into the given attribute of the object referenced by the current value." 516 cost = 2 517 518 class LoadAttrIndex(Immediate): 519 "Load into the current value the attribute of the current value with the given index." 520 cost = 6 521 522 class StoreAttrIndex(Immediate): 523 "Store the source value into the attribute of the current value with the given index." 524 cost = 6 525 526 class LoadAttrIndexContextCond(Immediate): 527 """ 528 Load into the current value the attribute of the current value with the given index, only making the 529 current value the context if the attribute is compatible. 530 """ 531 cost = 8 532 533 # Access to object details. 534 535 class LoadCallable(Instruction): 536 "Load the target of an invocation." 537 cost = 2 538 539 class StoreCallable(Instruction): 540 "Store the source value into the object referenced by the current value." 541 cost = 3 542 543 # Access to invocation frames in preparation. 544 545 class MakeFrame(Immediate): 546 "Make a new invocation frame." 547 cost = 2 548 549 class AdjustFrame(Immediate): 550 "Adjust the current invocation frame for corrected invocations." 551 cost = 2 552 553 class DropFrame(Instruction): 554 "Drop an invocation frame." 555 cost = 2 556 557 class StoreFrame(Immediate): 558 "Store the current value as an argument for the parameter with the given position." 559 cost = 2 560 561 class StoreFrameIndex(Immediate): 562 "Store the source value as an argument of the current value for the parameter with the given index." 563 cost = 6 564 565 # Context-related tests. 566 567 class CheckContext(Instruction): 568 "Check to see if the context is valid." 569 cost = 2 570 571 class CheckClass(Instruction): 572 "Check the current value to determine whether it is a class." 573 cost = 2 574 575 class CheckInstance(Instruction): 576 """ 577 Check the current value as an instance of a class or its subclasses (used with 'self' in an 578 invocation). 579 """ 580 cost = 6 581 582 # Access to frames upon invocation. 583 584 class CheckFrame(Immediate): 585 "Check the frame for the correct number of arguments." 586 cost = 3 587 588 class CheckExtra(Immediate): 589 "Ensure that the frame can provide extra arguments." 590 cost = 3 591 592 class FillDefaults(Immediate): 593 "Fill frame positions with defaults, if appropriate." 594 cost = 8 # variable 595 596 class ExtendFrame(Immediate): 597 "Extend the current frame for temporary storage use." 598 cost = 1 599 600 class CopyExtra(Immediate): 601 "Copy extra arguments into a separate sequence, starting from the given position." 602 cost = 10 603 604 # Invocation-related instructions, using a special result "register". 605 606 class JumpInFrame(Instruction): 607 "Jump, using the current locals, to the current callable." 608 cost = 2 609 610 class JumpWithFrame(Instruction): 611 "Jump, adopting the invocation frame, to the current callable." 612 cost = 3 613 614 class JumpWithFrameDirect(Target): 615 "Jump to the specified address, adopting the invocation frame." 616 cost = 3 617 618 class Return(Instruction): 619 "Return from a subprogram." 620 cost = 2 621 622 # Branch-related instructions. 623 624 class Jump(Address): 625 "Jump unconditionally." 626 cost = 1 627 628 class JumpIfFalse(Address): 629 "Jump if the last evaluation gave a false result." 630 cost = 2 631 632 class JumpIfTrue(Address): 633 "Jump if the last evaluation gave a true result." 634 cost = 2 635 636 # Exception-related instructions, using a special exception "register". 637 638 class RaiseException(Instruction): 639 "Raise an exception, jumping to the active handler." 640 cost = 2 641 642 class PushHandler(Address): 643 "Push an exception handler onto the handler stack." 644 cost = 3 645 646 class PopHandler(Immediate): 647 "Pop exception handlers from the handler stack." 648 cost = 3 649 650 class CheckException(Instruction): 651 "Check the raised exception against another." 652 cost = 6 653 654 class ClearException(Instruction): 655 "Clear any raised exception." 656 cost = 1 657 658 # Test instructions, operating on the boolean status register. 659 660 class TestIdentity(Instruction): 661 "Test whether the current value is identical to the source value, setting the boolean status." 662 cost = 2 663 664 class TestIdentityAddress(Address): 665 "Test whether the current value is identical to the given address, setting the boolean status." 666 cost = 2 667 668 class InvertBoolean(Instruction): 669 "Invert the boolean status." 670 cost = 1 671 672 # Instructions which can affect the current value. (LoadAttrIndexContext not defined.) 673 674 current_value_instructions = ( 675 Transfer, 676 LoadConst, LoadClass, LoadFunction, 677 LoadName, LoadTemp, 678 LoadAddress, LoadAddressContext, LoadAddressContextCond, 679 LoadAttr, LoadAttrIndex, LoadAttrIndexContextCond, 680 LoadCallable, 681 MakeInstance, MakeFragment, 682 CopyExtra, 683 CheckClass, CheckContext, CheckException, CheckInstance, CheckFrame, CheckExtra 684 ) 685 686 # vim: tabstop=4 expandtab shiftwidth=4