├── .gitignore ├── COPYING ├── README.org ├── code ├── application.lisp ├── compile.lisp ├── inspect.lisp └── package.lisp ├── documentation └── screenshot.png └── sbcl-ir-visualizer.asd /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scymtym/sbcl-ir-visualizer/5bb9d57759ec696d29243ec028e81c082170de6b/.gitignore -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | * Introduction 2 | 3 | *This system only works in SBCL* 4 | 5 | Usage: 6 | 7 | #+BEGIN_SRC lisp 8 | (ql:quickload :sbcl-ir-visualizer) 9 | (sbcl-ir-visualizer:run) 10 | #+END_SRC 11 | 12 | [[file:documentation/screenshot.png]] 13 | 14 | Then edit the form and/or change the optimization settings and watch 15 | the intermediate representations change. 16 | 17 | Click objects to expand and collapse. IR1 blocks and IR2 blocks have 18 | context menu (right pointer button click) entries "Organize slots by 19 | class" and "Flat list of slots" which display the instance slots of 20 | the respective object an addition to the specialized default 21 | presentation. 22 | -------------------------------------------------------------------------------- /code/application.lisp: -------------------------------------------------------------------------------- 1 | ;;;; application.lisp --- Application frame. 2 | ;;;; 3 | ;;;; Copyright (C) 2020-2023 Jan Moringen 4 | ;;;; 5 | ;;;; Author: Jan Moringen 6 | 7 | (cl:in-package #:sbcl-ir-visualizer) 8 | 9 | ;;; Form 10 | 11 | (defclass form-editor (clim:outlined-pane 12 | clim:value-gadget) 13 | () 14 | (:default-initargs 15 | :thickness 2 16 | :background clim:+black+)) 17 | 18 | (defmethod initialize-instance :after ((instance form-editor) &key value) 19 | (flet ((value-changed (gadget new-value) 20 | (declare (ignore gadget)) 21 | (setf (clim:gadget-value instance :invoke-callback t) 22 | (handler-case 23 | (prog1 24 | (string->form new-value) 25 | (setf (clim:pane-background instance) clim:+black+) 26 | (clim:repaint-sheet instance clim:+everywhere+)) 27 | (error (condition) 28 | (princ condition *trace-output*) ; TODO show in user interface 29 | (terpri *trace-output*) 30 | 31 | (setf (clim:pane-background instance) clim:+dark-red+) 32 | (clim:repaint-sheet instance clim:+everywhere+) 33 | (princ-to-string condition)))))) 34 | (let ((editor (clim:make-pane :text-editor 35 | :client instance 36 | :value value 37 | :value-changed-callback #'value-changed 38 | :text-style (clim:make-text-style :fix nil nil) 39 | :nlines 12))) 40 | (clim:sheet-adopt-child instance editor)))) 41 | 42 | ;;; Optimization quality button 43 | 44 | (defun make-optimization-quality-pane (frame quality label) 45 | (clim:horizontally () 46 | (1/2 (clim:labelling (:label label))) 47 | (1/2 (clim:make-pane :slider :client frame 48 | :min-value 0 49 | :max-value 3 50 | :value 1 51 | :decimal-places 0 52 | :number-of-quanta 3 53 | :orientation :horizontal 54 | :show-value-p t 55 | :value-changed-callback 56 | (lambda (gadget value) 57 | (let* ((frame (clim:gadget-client gadget)) 58 | (policy (policy frame)) 59 | (cell (find quality policy :key #'first))) 60 | (setf (second cell) (floor value)) 61 | (setf (policy frame) policy))))))) 62 | 63 | (defun make-optimization-button (frame label policy &key background) 64 | (apply #'clim:make-pane :push-button 65 | :client frame 66 | :label label 67 | :activate-callback 68 | (lambda (gadget) 69 | (let ((frame (clim:gadget-client gadget))) 70 | (setf (policy frame) (copy-list policy)))) 71 | (when background 72 | (list :background background)))) 73 | 74 | ;;; Output 75 | 76 | (defclass output-pane (clim:application-pane 77 | clouseau::scroll-position-preserving-mixin) 78 | ()) 79 | 80 | ;;; Frame 81 | 82 | (defvar *example-lambda-expression* 83 | (format nil "~0@T(lambda (x y)~@ 84 | ~0@T (declare (type (integer 0 10) x y))~@ 85 | ~0@T (labels ((rec (x)~@ 86 | ~0@T (abs (rec x))))~@ 87 | ~0@T (if (plusp (rec x))~@ 88 | ~0@T (+ x y)~@ 89 | ~0@T (list x))))")) 90 | 91 | (clim:define-application-frame ir-inspector () 92 | (;; Input 93 | (%form :accessor form) 94 | (%source-info :accessor source-info) 95 | (%source-paths :accessor source-paths) 96 | ;; Parameters 97 | (%policy :accessor policy 98 | :initform (list (list 'speed 1) 99 | (list 'safety 1) 100 | (list 'debug 1) 101 | (list 'space 1) 102 | (list 'compilation-speed 1))) 103 | ;; Output 104 | (%output :accessor output 105 | :initform nil) 106 | (%disassembly :accessor disassembly 107 | :initform nil)) 108 | (:panes 109 | (form-editor form-editor 110 | :value *example-lambda-expression* 111 | :value-changed-callback 112 | (lambda (gadget value) 113 | (setf (form (clim:gadget-client gadget)) value))) 114 | (speed (make-optimization-quality-pane clim:*application-frame* 'speed "Speed")) 115 | (safety (make-optimization-quality-pane clim:*application-frame* 'safety "Safety")) 116 | (debug (make-optimization-quality-pane clim:*application-frame* 'debug "Debug")) 117 | (space (make-optimization-quality-pane clim:*application-frame* 'space "Space")) 118 | (compilation-speed (make-optimization-quality-pane clim:*application-frame* 'compilation-speed "Compilation Speed")) 119 | (safe (make-optimization-button 120 | clim:*application-frame* "Safe" 121 | '((speed 0) (safety 3) (debug 3) (space 0) (compilation-speed 0)) 122 | :background clim:+light-green+)) 123 | (default (make-optimization-button 124 | clim:*application-frame* "Default" 125 | '((speed 1) (safety 1) (debug 1) (space 1) (compilation-speed 1)))) 126 | (fast (make-optimization-button 127 | clim:*application-frame* "Fast" 128 | '((speed 3) (safety 0) (debug 0) (space 0) (compilation-speed 0)) 129 | :background clim:+salmon+)) 130 | (ir clouseau:inspector-pane) 131 | (output output-pane :display-function 'display-output 132 | :end-of-page-action :allow) 133 | (disassembly output-pane :display-function 'display-disassembly 134 | :end-of-page-action :allow)) 135 | (:layouts 136 | (default 137 | (clim:spacing (:thickness 4) 138 | (clim:vertically (:spacing 8) 139 | (clim:horizontally (:spacing 8) 140 | (:fill (clim:labelling (:label "Lambda Expression") 141 | form-editor)) 142 | (clim:vertically (:spacing 8) 143 | speed 144 | safety 145 | debug 146 | space 147 | compilation-speed 148 | (clim:horizontally (:spacing 8) 149 | safe default fast) 150 | :fill)) 151 | (:fill (clim-tab-layout:with-tab-layout ('clim-tab-layout:tab-page) 152 | ("Output" 153 | (clim:scrolling () output)) 154 | ("Intermediate Representation" 155 | (clim:scrolling (:scroll-bars :both) ir)) 156 | ("Disassembly" 157 | (clim:scrolling () disassembly)))))))) 158 | (:menu-bar nil) 159 | (:pointer-documentation t) 160 | (:command-table (ir-inspector-command-table 161 | :inherit-from (clouseau:inspector-command-table))) 162 | (:pretty-name (format nil "IR Visualizer ~A@~A" 163 | (lisp-implementation-type) 164 | (lisp-implementation-version)))) 165 | 166 | (defun update (frame form policy) 167 | (a:when-let ((ir (clim:find-pane-named frame 'ir))) 168 | (handler-case 169 | (setf (values (clouseau:root-object ir :run-hook-p t) 170 | (output frame) 171 | (disassembly frame) 172 | (source-info frame) 173 | (source-paths frame)) 174 | (form->component (instrument-form form policy))) 175 | (error (condition) 176 | (princ condition *trace-output*))))) 177 | 178 | (defmethod (setf form) :after ((new-value t) (frame ir-inspector)) 179 | (update frame new-value (policy frame))) 180 | 181 | (defmethod (setf policy) :after ((new-value t) (frame ir-inspector)) 182 | (labels ((update-slider (quality) 183 | (let ((slider (first (clim:sheet-children 184 | (clim:find-pane-named frame quality))))) 185 | (setf (clim:gadget-value slider :value-changed-callback nil) 186 | (second (find quality new-value :key #'first)))))) 187 | (map nil #'update-slider '(speed safety debug space compilation-speed))) 188 | (update frame (form frame) new-value)) 189 | 190 | (defmethod (setf output) :after ((new-value t) (frame ir-inspector)) 191 | (a:when-let ((output (clim:find-pane-named frame 'output))) 192 | (clim:redisplay-frame-pane frame output :force-p t))) 193 | 194 | (defun display-output (frame pane) 195 | (a:if-let ((output (output frame))) 196 | (clim:with-drawing-options (pane :text-family :fix :text-size :smaller) 197 | (write-string output pane)) 198 | (clim:with-drawing-options (pane :text-face :italic :ink clim:+gray40+) 199 | (write-string "no output produced" pane)))) 200 | 201 | (defmethod (setf disassembly) :after ((new-value t) (frame ir-inspector)) 202 | (a:when-let ((disassembly (clim:find-pane-named frame 'disassembly))) 203 | (clim:redisplay-frame-pane frame disassembly :force-p t))) 204 | 205 | (defun display-disassembly (frame pane) 206 | (a:if-let ((disassembly (disassembly frame))) 207 | (clim:with-drawing-options (pane :text-family :fix :text-size :smaller) 208 | (write-string disassembly pane)) 209 | (clim:with-drawing-options (pane :text-face :italic :ink clim:+gray40+) 210 | (write-string "no disassembly produced" pane)))) 211 | 212 | ;;; Interface 213 | 214 | (defun run (&key new-process) 215 | (let ((frame (clim:make-application-frame 'ir-inspector))) 216 | (flet ((do-it () 217 | (clim:run-frame-top-level frame))) 218 | (if new-process 219 | (bt:make-thread #'do-it) 220 | (do-it))) 221 | frame)) 222 | -------------------------------------------------------------------------------- /code/compile.lisp: -------------------------------------------------------------------------------- 1 | ;;;; compile.lisp --- Form reading and hook into compiler. 2 | ;;;; 3 | ;;;; Copyright (C) 2020-2023 Jan Moringen 4 | ;;;; 5 | ;;;; Author: Jan Moringen 6 | 7 | (cl:in-package #:sbcl-ir-visualizer) 8 | 9 | (defvar *inspect* nil) 10 | 11 | (defun maybe-inspect-component (component) 12 | (when *inspect* 13 | (let ((cell *inspect*)) 14 | (setf (first cell) component 15 | (second cell) sb-c::*source-info* 16 | (third cell) sb-c::*source-paths*)))) 17 | (setf sb-c::*compile-component-hook* 'maybe-inspect-component) 18 | 19 | (defun string->form (string) 20 | (eclector.reader:read-from-string string)) 21 | 22 | (defun instrument-form (form policy) 23 | (destructuring-bind (lambda lambda-list &rest body) form 24 | `(,lambda ,lambda-list 25 | (declare (optimize ,@policy)) 26 | ,@body))) 27 | 28 | (defun form->component (form) 29 | (let* ((cell (list nil nil nil)) 30 | (output (make-string-output-stream)) 31 | (function (let ((*inspect* cell) 32 | (*standard-output* output) 33 | (*error-output* output) 34 | (*trace-output* output)) 35 | (compile nil form)))) 36 | (values (first cell) 37 | (let ((string (get-output-stream-string output))) 38 | (if (a:emptyp string) nil string)) 39 | (with-output-to-string (stream) 40 | (sb-disassem:disassemble-code-component 41 | function :stream stream)) 42 | (second cell) 43 | (third cell)))) 44 | 45 | (defun string->component (string policy) 46 | (form->component (instrument-form (string->form string) policy))) 47 | -------------------------------------------------------------------------------- /code/inspect.lisp: -------------------------------------------------------------------------------- 1 | ;;;; inspect.lisp --- Clouseau extensions for SBCL IR objects. 2 | ;;;; 3 | ;;;; Copyright (C) 2020-2023 Jan Moringen 4 | ;;;; 5 | ;;;; Author: Jan Moringen 6 | 7 | (cl:in-package #:sbcl-ir-visualizer) 8 | 9 | ;;; Utilities 10 | 11 | (defun inspect-part (container part stream) 12 | (clouseau:formatting-place 13 | (container 'clouseau:pseudo-place part nil present-object) 14 | (present-object stream))) 15 | 16 | ;;; lvar utilities 17 | 18 | (defvar *lvar-numbers*) 19 | 20 | (defun lvar-number (lvar) 21 | (let ((numbers *lvar-numbers*)) 22 | (a:ensure-gethash lvar numbers (1+ (hash-table-count numbers))))) 23 | 24 | (defun lvar-ink (lvar) 25 | (let ((number (typecase lvar 26 | (integer lvar) 27 | (t (lvar-number lvar))))) 28 | (clim:make-contrasting-inks 8 (mod number 8)))) 29 | 30 | (defun inspect-lvar (container lvar stream) ; TODO remove 31 | (inspect-part container lvar stream)) 32 | 33 | ;;; Type utilities 34 | 35 | (deftype single-value-type-specifier () 36 | '(cons (eql values) (cons t (cons (eql &optional) null)))) 37 | 38 | (defun print-ctype (ctype stream) 39 | (let* ((specifier (sb-c::type-specifier ctype)) 40 | (specifier (if (typep specifier 'single-value-type-specifier) 41 | (second specifier) 42 | specifier))) 43 | (let ((*print-right-margin* most-positive-fixnum)) 44 | (princ specifier stream)))) 45 | 46 | (defun print-type-annotation (ctype stream) 47 | (clim:with-drawing-options (stream :text-size :tiny :ink clim:+dark-green+) 48 | (write-char #\Space stream) 49 | (print-ctype ctype stream))) 50 | 51 | (defgeneric inferred-type (object)) 52 | 53 | ;;; Control arc helpers 54 | 55 | (defun draw-control-arc (stream from to x1 y1 x2 y2 56 | &rest args &key &allow-other-keys) 57 | (cond ((< x2 x1) 58 | (multiple-value-bind (x2 y2) 59 | (clim:with-bounding-rectangle* (x1 y1 x2 y2) from 60 | (declare (ignore y2)) 61 | (values (/ (+ x1 x2) 2) y1)) 62 | (multiple-value-bind (x1 y1) 63 | (clim:with-bounding-rectangle* (x1 y1 x2 y2) to 64 | (declare (ignore y2)) 65 | (values (/ (+ x1 x2) 2) y1)) 66 | (let* ((margin 100) 67 | (y0 (- (min y1 y2) margin))) 68 | (apply #'clim:draw-line* stream x2 y2 x2 y0 args) 69 | (apply #'clim:draw-line* stream x1 y0 x2 y0 args) 70 | (apply #'clim:draw-arrow* stream x1 y0 x1 y1 args))))) 71 | (t 72 | (apply #'clim:draw-arrow* stream x1 y1 x2 y2 args)))) 73 | 74 | (defun draw-ir1-control-arc (stream from to x1 y1 x2 y2) 75 | (let* ((from* (clim:graph-node-object from)) 76 | (to* (clim:graph-node-object to)) 77 | (last (sb-c::block-last from*)) 78 | (ink (cond ((not (typep last 'sb-c::cif)) 79 | nil) 80 | ((eq (sb-c::if-consequent last) to*) 81 | clim:+green+) 82 | ((eq (sb-c::if-alternative last) to*) 83 | clim:+red+)))) 84 | (apply #'draw-control-arc stream from to x1 y1 x2 y2 85 | (when ink (list :ink ink))))) 86 | 87 | ;;; 88 | 89 | (defclass inspected-ir-instance (clouseau:inspected-instance) 90 | ()) 91 | 92 | ;;; `component' 93 | 94 | ;;; IR1 95 | 96 | (defclass inspected-component (inspected-ir-instance) 97 | ()) 98 | 99 | (defmethod clouseau:object-state-class ((object sb-c::component) (place t)) 100 | 'inspected-component) 101 | 102 | (defmethod clouseau:make-object-state ((object sb-c::component) (place t)) 103 | ;; Do not show instance slots by default. 104 | (let ((class (clouseau:object-state-class object place))) 105 | (make-instance class :place place 106 | :slot-style nil))) 107 | 108 | (defmethod clouseau:inspect-object-using-state ((object sb-c::component) 109 | (state inspected-component) 110 | (style (eql :expanded-body)) 111 | (stream clim:extended-output-stream)) 112 | (let ((*lvar-numbers* (make-hash-table :test #'eq))) 113 | ;; IR1 114 | (clouseau:with-section (stream) "IR1 Control Flow Graph" 115 | (clim:format-graph-from-root 116 | (sb-c::component-head object) 117 | (lambda (node stream) 118 | (clouseau:formatting-place 119 | (object 'clouseau:pseudo-place node nil present-object) 120 | (present-object stream))) 121 | (lambda (node) 122 | (sb-c::block-succ node)) 123 | :merge-duplicates t :duplicate-test #'eq 124 | :maximize-generations t 125 | :stream stream 126 | :arc-drawer 'draw-ir1-control-arc)) 127 | ;; IR2 128 | (clouseau:with-section (stream) "IR2 Control Flow Graph" 129 | (clim:format-graph-from-roots 130 | (map 'list #'sb-c::block-info 131 | (sb-c::block-succ (sb-c::component-head object))) 132 | (lambda (node stream) 133 | (clouseau:formatting-place 134 | (object 'clouseau:pseudo-place node nil present-object) 135 | (present-object stream))) 136 | (lambda (node) 137 | (map 'list #'sb-c::block-info ; TODO is this the best way? 138 | (sb-c::block-succ (sb-c::ir2-block-block node)))) 139 | :merge-duplicates t :duplicate-test #'eq 140 | :maximize-generations t 141 | :stream stream 142 | :arc-drawer 'draw-control-arc)) 143 | ;; Instance slots 144 | (call-next-method))) 145 | 146 | ;;; `cblock' 147 | 148 | (defun block-head? (block) 149 | (eq block (sb-c::component-head (sb-c::block-component block)))) 150 | 151 | (defun block-tail? (block) 152 | (eq block (sb-c::component-tail (sb-c::block-component block)))) 153 | 154 | (defmethod clouseau:object-state-class ((object sb-c::cblock) (place t)) 155 | 'inspected-ir-instance) 156 | 157 | (defmethod clouseau:make-object-state ((object sb-c::cblock) (place t)) 158 | ;; When the block is inspected as the content of a slot, use 159 | ;; defaults. Otherwise pre-expand. 160 | (if (typep place 'clouseau:pseudo-place) 161 | (let ((class (clouseau:object-state-class object place)) 162 | (style (if (or (block-head? object) (block-tail? object)) 163 | :collapsed 164 | :expanded))) 165 | (make-instance class :place place 166 | :style style 167 | :slot-style nil)) 168 | (call-next-method))) 169 | 170 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cblock) 171 | (state inspected-ir-instance) 172 | (style (eql :collapsed)) 173 | (stream clim:extended-output-stream)) 174 | (cond ((block-head? object) 175 | (clim:with-room-for-graphics (stream) 176 | (clim:draw-circle* stream 0 0 5 :filled nil))) 177 | ((block-tail? object) 178 | (clim:with-room-for-graphics (stream) 179 | (clim:draw-circle* stream 0 0 5 :filled t))) 180 | (t 181 | (assert (sb-c::block-start object)) 182 | (format stream "#<~A ~A>" 183 | (symbol-name (class-name (class-of object))) 184 | (sb-c::block-number object))))) 185 | 186 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cblock) 187 | (state inspected-ir-instance) 188 | (style (eql :expanded-header)) 189 | (stream clim:extended-output-stream)) 190 | (clouseau::inspect-class-as-name (class-of object) stream) 191 | (format stream " ~A " (sb-c::block-number object))) 192 | 193 | (defun inspect-nodes (block start-node stream) 194 | (labels ((do-it (ctran) 195 | (when ctran 196 | (let ((node (sb-c::ctran-next ctran))) 197 | (fresh-line stream) 198 | (clouseau:formatting-place 199 | (block 'clouseau:pseudo-place node nil present-object) 200 | (present-object stream)) 201 | (do-it (sb-c::node-next node)))))) 202 | (do-it start-node))) 203 | 204 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cblock) 205 | (state inspected-ir-instance) 206 | (style (eql :expanded-body)) 207 | (stream clim:extended-output-stream)) 208 | 209 | (a:when-let ((start (sb-c::block-start object))) 210 | (clouseau:with-section (stream) "Nodes" 211 | (inspect-nodes object start stream)) 212 | (terpri stream)) 213 | ;; Instance slots 214 | (call-next-method)) 215 | 216 | ;;; `node' 217 | 218 | (defmethod source-form ((object sb-c::node)) 219 | (sb-c::node-source-form object)) 220 | 221 | (defmethod inferred-type ((object sb-c::valued-node)) 222 | (sb-c::node-derived-type object)) 223 | 224 | (defmethod clouseau:object-state-class ((object sb-c::node) (place t)) 225 | 'inspected-ir-instance) 226 | 227 | (defmethod clouseau:inspect-object-using-state ((object sb-c::node) 228 | (state inspected-ir-instance) 229 | (style (eql :collapsed)) 230 | (stream clim:extended-output-stream)) 231 | (clim:with-drawing-options (stream :text-family :fix :ink clim:+dark-blue+) 232 | (format stream "~(~A~)" (symbol-name (class-name (class-of object)))))) 233 | 234 | (defmethod clouseau:inspect-object-using-state ((object sb-c::bind) 235 | (state inspected-ir-instance) 236 | (style (eql :collapsed)) 237 | (stream clim:extended-output-stream)) 238 | (call-next-method) 239 | (let ((lambda (sb-c::bind-lambda object))) 240 | (format stream " ~A" (sb-c::functional-debug-name lambda)))) 241 | 242 | (defmethod clouseau:inspect-object-using-state :after ((object sb-c::valued-node) 243 | (state inspected-ir-instance) 244 | (style (eql :collapsed)) 245 | (stream clim:extended-output-stream)) 246 | ;; Result lvar. 247 | (a:when-let ((result (sb-c::node-lvar object))) 248 | (write-string " → " stream) 249 | (inspect-lvar object result stream)) 250 | ;; Derived type. 251 | (print-type-annotation (inferred-type object) stream)) 252 | 253 | (defmethod clouseau:inspect-object-using-state ((object sb-c::ref) 254 | (state inspected-ir-instance) 255 | (style (eql :collapsed)) 256 | (stream clim:extended-output-stream)) 257 | (call-next-method) 258 | ;; Try to present the referenced leaf nicely. 259 | (let ((leaf (sb-c::ref-leaf object))) 260 | (write-char #\Space stream) 261 | (cond ((sb-c::constant-p leaf) 262 | (clim:with-drawing-options (stream :ink clim:+gray40+) 263 | (let ((value (sb-c::constant-value leaf))) 264 | (cond ((and (listp value) (sb-c::lambda-p (first value))) 265 | (princ (sb-c::lambda-%debug-name (first value)) stream)) 266 | ((and (listp value) (sb-c::optional-dispatch-p (first value))) 267 | (write-string "optional dispatch" stream)) 268 | (t 269 | (prin1 value stream)))))) 270 | ((sb-c::global-var-p leaf) 271 | (clouseau::with-preserved-cursor-y (stream) 272 | (clim:surrounding-output-with-border (stream :shape :underline) 273 | (clim:with-drawing-options (stream :text-face :bold) 274 | (princ (sb-c::global-var-%source-name leaf) stream))))) 275 | ((sb-c::lambda-p leaf) 276 | (clim:with-drawing-options (stream :text-face :italic) 277 | (princ (sb-c::lambda-%debug-name leaf) stream))) 278 | ((sb-c::lambda-var-p leaf) 279 | (clim:with-drawing-options (stream :text-face :bold) 280 | (inspect-part object leaf stream))) 281 | (t 282 | (princ (sb-c::ref-%source-name object) stream))))) 283 | 284 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cset) 285 | (state inspected-ir-instance) 286 | (style (eql :collapsed)) 287 | (stream clim:extended-output-stream)) 288 | (call-next-method) 289 | (write-char #\Space stream) 290 | (inspect-part object (sb-c::set-var object) stream) 291 | (write-string " ← " stream) 292 | (inspect-lvar object (sb-c::set-value object) stream)) 293 | 294 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cast) 295 | (state inspected-ir-instance) 296 | (style (eql :collapsed)) 297 | (stream clim:extended-output-stream)) 298 | (call-next-method) 299 | ;; Input value. 300 | (write-char #\Space stream) 301 | (inspect-lvar object (sb-c::cast-value object) stream) 302 | ;; Asserted type. 303 | (clim:with-drawing-options (stream :text-size :tiny :ink clim:+dark-green+) 304 | (print-ctype (sb-c::cast-asserted-type object) stream) 305 | (write-char #\! stream))) 306 | 307 | (defmethod clouseau:inspect-object-using-state ((object sb-c::basic-combination) 308 | (state inspected-ir-instance) 309 | (style (eql :collapsed)) 310 | (stream clim:extended-output-stream)) 311 | ;; Function lvar. Print the function name if possible. 312 | (let* ((fun (sb-c::basic-combination-fun object)) 313 | (name (sb-c::lvar-fun-name* fun))) 314 | (write-char #\Space stream) 315 | (inspect-lvar object fun stream) 316 | (when name 317 | (clim:with-drawing-options (stream :text-size :tiny :ink clim:+gray40+) 318 | (format stream "~A" name)))) 319 | ;; Argument lvars. 320 | (map nil (lambda (lvar) 321 | (write-char #\Space stream) 322 | (inspect-lvar object lvar stream)) 323 | (sb-c::basic-combination-args object))) 324 | 325 | (defmethod clouseau:inspect-object-using-state ((object sb-c::combination) 326 | (state inspected-ir-instance) 327 | (style (eql :collapsed)) 328 | (stream clim:extended-output-stream)) 329 | ;; Combination kind and possibly "tail" annotation. 330 | (clim:with-drawing-options (stream :text-size :tiny :ink clim:+dark-red+) 331 | (when (sb-c::combination-tail-p object) 332 | (let* ((text "tail") 333 | #+later (height (nth-value 1 (clim:text-size stream text)))) 334 | (clouseau:with-preserved-cursor-y (stream) 335 | (clouseau:with-preserved-cursor-x (stream) 336 | ;; TODO dy should be something like (- (+ height 2)) but 337 | ;; moving the cursor closes the current text output record 338 | ;; which in turn messes with the baseline so that doesn't 339 | ;; work. 340 | (clim:stream-increment-cursor-position stream 0 -2) 341 | (write-string text stream))))) 342 | (format stream "~(~A~)" (sb-c::combination-kind object)) 343 | (write-char #\Space stream)) 344 | (call-next-method)) 345 | 346 | (defmethod clouseau:inspect-object-using-state ((object sb-c::mv-combination) 347 | (state inspected-ir-instance) 348 | (style (eql :collapsed)) 349 | (stream clim:extended-output-stream)) 350 | (clim:with-drawing-options (stream :text-size :tiny :ink clim:+dark-red+) 351 | (let ((text "mv")) 352 | (clouseau:with-preserved-cursor-y (stream) 353 | (clouseau:with-preserved-cursor-x (stream) 354 | (clim:stream-increment-cursor-position stream 0 -2) 355 | (write-string text stream)))) 356 | (format stream "~(~A~)" (sb-c::mv-combination-kind object)) 357 | (write-char #\Space stream)) 358 | (call-next-method)) 359 | 360 | (defmethod clouseau:inspect-object-using-state ((object sb-c::cif) 361 | (state inspected-ir-instance) 362 | (style (eql :collapsed)) 363 | (stream clim:extended-output-stream)) 364 | (call-next-method) 365 | ;; Test lvar 366 | (write-char #\Space stream) 367 | (inspect-lvar object (sb-c::if-test object) stream)) 368 | 369 | (defmethod inferred-type ((object sb-c::creturn)) 370 | (sb-c::return-result-type object)) 371 | 372 | (defmethod clouseau:inspect-object-using-state :after ((object sb-c::creturn) 373 | (state inspected-ir-instance) 374 | (style (eql :collapsed)) 375 | (stream clim:extended-output-stream)) 376 | ;; Result lvar 377 | (write-char #\Space stream) 378 | (inspect-lvar object (sb-c::return-result object) stream) 379 | ;; Result type 380 | (print-type-annotation (inferred-type object) stream)) 381 | 382 | ;;; `lvar' 383 | ;;; 384 | ;;; We just make up a number and corresponding color. 385 | 386 | (defmethod clouseau:object-state-class ((object sb-c::lvar) (place t)) 387 | 'inspected-ir-instance) 388 | 389 | (defmethod clouseau:inspect-object-using-state ((object sb-c::lvar) 390 | (state inspected-ir-instance) 391 | (style (eql :collapsed)) 392 | (stream clim:extended-output-stream)) 393 | (let ((number (lvar-number object))) 394 | (clim:with-drawing-options (stream :ink (lvar-ink number)) 395 | (format stream "~D" number)))) 396 | 397 | ;;; `lambda-var' 398 | 399 | (defmethod clouseau:object-state-class ((object sb-c::lambda-var) (place t)) 400 | 'inspected-ir-instance) 401 | 402 | (defmethod clouseau:inspect-object-using-state ((object sb-c::lambda-var) 403 | (state inspected-ir-instance) 404 | (style (eql :collapsed)) 405 | (stream clim:extended-output-stream)) 406 | (prin1 (sb-c::lambda-var-%source-name object) stream)) 407 | 408 | ;;; `ir2block' 409 | 410 | (defmethod clouseau:object-state-class ((object sb-c::ir2-block) (place t)) 411 | 'inspected-ir-instance) 412 | 413 | (defmethod clouseau:make-object-state ((object sb-c::ir2-block) (place t)) 414 | ;; When the block is inspected as the content of a slot, use 415 | ;; defaults. Otherwise pre-expand. 416 | (if (typep place 'clouseau:pseudo-place) 417 | (let ((class (clouseau:object-state-class object place))) 418 | (make-instance class :place place 419 | :style :expanded 420 | :slot-style nil)) 421 | (call-next-method))) 422 | 423 | (defmethod clouseau:inspect-object-using-state ((object sb-c::ir2-block) 424 | (state inspected-ir-instance) 425 | (style (eql :collapsed)) 426 | (stream clim:extended-output-stream)) 427 | (format stream "#<~A ~A>" 428 | (symbol-name (class-name (class-of object))) 429 | (sb-c::ir2-block-number object))) 430 | 431 | (defmethod clouseau:inspect-object-using-state ((object sb-c::ir2-block) 432 | (state inspected-ir-instance) 433 | (style (eql :expanded-header)) 434 | (stream clim:extended-output-stream)) 435 | (clouseau::inspect-class-as-name (class-of object) stream) 436 | (format stream " ~A " (sb-c::ir2-block-number object))) 437 | 438 | (defmethod clouseau:inspect-object-using-state ((object sb-c::ir2-block) 439 | (state inspected-ir-instance) 440 | (style (eql :expanded-body)) 441 | (stream clim:extended-output-stream)) 442 | (clouseau:with-section (stream) "VOPs" 443 | (labels ((do-it (current) 444 | (when current 445 | (fresh-line stream) 446 | (clouseau:formatting-place 447 | (object 'clouseau:pseudo-place current nil present-object) 448 | (present-object stream)) 449 | (do-it (sb-c::vop-next current))))) 450 | (do-it (sb-c::ir2-block-start-vop object)))) 451 | (terpri stream) 452 | 453 | (call-next-method)) 454 | 455 | ;;; `vop' 456 | 457 | (defmethod source-form ((object sb-c::vop)) 458 | (source-form (sb-c::vop-node object))) 459 | 460 | (defmethod clouseau:object-state-class ((object sb-c::vop) (place t)) 461 | 'inspected-ir-instance) 462 | 463 | (defmethod clouseau:inspect-object-using-state ((object sb-c::vop) 464 | (state inspected-ir-instance) 465 | (style (eql :collapsed)) 466 | (stream clim:extended-output-stream)) 467 | (let ((info (sb-c::vop-info object))) 468 | (clim:with-drawing-options (stream :text-family :fix :ink clim:+dark-blue+) 469 | (format stream "~(~A~)" (sb-c::vop-info-name info))) 470 | (labels ((collect (ref) 471 | (when ref 472 | (list* (sb-c::tn-number (sb-c:tn-ref-tn ref)) 473 | (collect (sb-c::tn-ref-across ref)))))) 474 | (format stream "~@[ ~{~A~^ ~}~]~@[ → ~{~A~^ ~}~]" 475 | (collect (sb-c::vop-args object)) 476 | (collect (sb-c::vop-results object)))))) 477 | 478 | (defmethod clouseau:inspect-object-using-state ((object sb-c::vop) 479 | (state inspected-ir-instance) 480 | (style (eql :expanded-header)) 481 | (stream clim:extended-output-stream)) 482 | (let ((info (sb-c::vop-info object))) 483 | (format stream "~A" (sb-c::vop-info-name info)))) 484 | 485 | (defmethod clouseau:inspect-object-using-state ((object sb-c::vop) 486 | (state inspected-ir-instance) 487 | (style (eql :expanded-body)) 488 | (stream clim:extended-output-stream)) 489 | (call-next-method)) 490 | 491 | ;;; `tn' 492 | 493 | (defmethod clouseau:inspect-object-using-state ((object sb-c::tn) 494 | (state inspected-ir-instance) 495 | (style (eql :collapsed)) 496 | (stream clim:extended-output-stream)) 497 | (format stream "~D" (sb-c::tn-number object))) 498 | 499 | ;; Display source form on hover 500 | 501 | (flet ((draw-source-form (stream object source-form) 502 | (clim:with-output-to-output-record (stream) 503 | (clim:surrounding-output-with-border 504 | (stream :shape :rectangle 505 | :outline clim:+black+ 506 | :background clim:+white+ 507 | :shadow clim:+gray50+) 508 | (print source-form stream) 509 | (terpri stream) 510 | (ignore-errors (print-type-annotation (inferred-type object) stream)))))) 511 | 512 | (clim:define-presentation-method clim:highlight-presentation 513 | ((type inspected-ir-instance) 514 | (record t) 515 | (stream clim:extended-output-stream) 516 | (state t)) 517 | (let* ((state1 (clim:presentation-object record)) 518 | (object (clouseau:object state1)) 519 | (frame (clim:pane-frame stream)) 520 | (source-form (let ((sb-c::*source-info* (source-info frame)) 521 | (sb-c::*source-paths* (source-paths frame))) 522 | (ignore-errors (source-form object))))) 523 | (when source-form 524 | (clim:with-bounding-rectangle* (x1 :y2 y2) record 525 | (let ((highlight-record (draw-source-form stream object source-form))) 526 | (setf (clim:output-record-position highlight-record) 527 | (values x1 (+ y2 20))) 528 | (ecase state 529 | (:highlight 530 | (clim:replay-output-record highlight-record stream)) 531 | (:unhighlight 532 | (clim:repaint-sheet stream (clim:bounding-rectangle highlight-record)))))))) 533 | (call-next-method))) 534 | -------------------------------------------------------------------------------- /code/package.lisp: -------------------------------------------------------------------------------- 1 | ;;;; package.lisp --- Package definition for the sbcl-ir-visualizer system. 2 | ;;;; 3 | ;;;; Copyright (C) 2020 Jan Moringen 4 | ;;;; 5 | ;;;; Author: Jan Moringen 6 | 7 | (cl:defpackage #:sbcl-ir-visualizer 8 | (:use 9 | #:cl) 10 | 11 | (:local-nicknames 12 | (#:a #:alexandria)) 13 | 14 | (:export 15 | #:run)) 16 | -------------------------------------------------------------------------------- /documentation/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/scymtym/sbcl-ir-visualizer/5bb9d57759ec696d29243ec028e81c082170de6b/documentation/screenshot.png -------------------------------------------------------------------------------- /sbcl-ir-visualizer.asd: -------------------------------------------------------------------------------- 1 | ;;;; sbcl-ir-visualizer.asd --- System definition for the sbcl-ir-visualizer system. 2 | ;;;; 3 | ;;;; Copyright (C) 2020, 2021 Jan Moringen 4 | ;;;; 5 | ;;;; Author: Jan Moringen 6 | 7 | (defsystem "sbcl-ir-visualizer" 8 | :description "A simple interactive visualizer for SBCL's intermediate representations" 9 | :license "GPLv3" ; see COPYING file for details 10 | 11 | :version "0.1" 12 | :depends-on ("alexandria" 13 | 14 | "eclector" 15 | 16 | "mcclim" 17 | "clouseau") 18 | 19 | :components ((:module "code" 20 | :serial t 21 | :components ((:file "package") 22 | (:file "compile") 23 | (:file "inspect") 24 | (:file "application")))) 25 | 26 | :perform (prepare-op :before (operation component) 27 | #-sbcl (error "This system only works on SBCL"))) 28 | --------------------------------------------------------------------------------