├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── autotest ├── .gitignore ├── README.md └── autotest ├── docker ├── .gitignore ├── Dockerfile ├── Makefile └── update-alternatives-clang.sh └── koopac ├── .gitignore ├── .rustfmt.toml ├── Cargo.lock ├── Cargo.toml ├── README.md └── src ├── main.rs └── reorder_alloc.rs /.gitignore: -------------------------------------------------------------------------------- 1 | # macOS 2 | *.DS_Store 3 | 4 | # Debugging 5 | debug 6 | 7 | # Python 8 | __pycache__ 9 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # 变更日志 2 | 3 | 关于 `compiler-dev` Docker 镜像的所有变更将陈列至此. 4 | 5 | ## 未发布 6 | 7 | ### 变更 8 | 9 | * [PR #3](https://github.com/pku-minic/compiler-dev/pull/3): enabled Ubuntu-Ports mirror for arm64, armhf, PowerPC, ppc64el, s390x. 10 | * [PR #5](https://github.com/pku-minic/compiler-dev/pull/5): Change tuna mirror to llvm.org source. 11 | 12 | ## 0.0.8 - 2023-06-02 13 | 14 | ### 变更 15 | 16 | * 将 `libkoopa` 和 `koopac` 的 `koopa` 依赖更新到 0.0.7 版本. 17 | * 将 Rust 工具链更新至 1.70.0, 同时启用 sparse registry. 18 | 19 | ## 0.0.7 - 2023-01-12 20 | 21 | ### 变更 22 | 23 | * 将 `libkoopa` 和 `koopac` 的 `koopa` 依赖更新到 0.0.6 版本. 24 | 25 | ### 修复 26 | 27 | * `koopac` 代码中的一些过时的写法. 28 | 29 | ## 0.0.6 - 2022-05-07 30 | 31 | ### 变更 32 | 33 | * 目前的 `autotest` 在执行 `make` 构建时会指定 `DEBUG=0`. 34 | 35 | ### 修复 36 | 37 | * `autotest` 中关于提示信息的一些笔误. 38 | 39 | ## 0.0.5 - 2022-03-14 40 | 41 | ### 新增 42 | 43 | * 目前的 `koopac` 会将输入 Koopa IR 中所有的 `alloc` 指令提升至入口基本块. 44 | 45 | ## 0.0.4 - 2022-03-10 46 | 47 | ### 变更 48 | 49 | * 将 `libkoopa` 和 `koopac` 的 `koopa` 依赖更新到 0.0.5 版本. 50 | 51 | ### 修复 52 | 53 | * `autotest` 脚本中关于 `Popen` 相关操作的问题. 54 | 55 | ## 0.0.3 - 2022-03-05 56 | 57 | ### 变更 58 | 59 | * 将测试用例 `multiple_returns` 从 `lv4` 目录移到了 `lv6` 目录. 60 | 61 | ## 0.0.2 - 2022-02-28 62 | 63 | ### 修复 64 | 65 | * 测试用例 (`compiler-dev-test-cases`) 中存在的部分问题. 66 | 67 | ## 0.0.1 - 2022-02-22 68 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | CoolPepper 635 | Copyright (C) 2018 ustb-nscscc-team 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 | CoolPepper Copyright (C) 2018 ustb-nscscc-team 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.md: -------------------------------------------------------------------------------- 1 | # compiler-dev 2 | 3 | 北大编译实践教学用编译器开发环境 (Compiler Development Environment). 4 | 5 | 该仓库的内容将被打包为 Docker 镜像, 所以不建议直接使用该仓库, 具体使用方法见[使用方法](#使用方法)一节. 6 | 7 | ## 使用方法 8 | 9 | ### 从 Docker Hub 获取 10 | 11 | 推荐使用该方法. 12 | 13 | ```sh 14 | docker run -it --rm maxxing/compiler-dev bash 15 | ``` 16 | 17 | ### 从仓库构建 18 | 19 | ```sh 20 | cd docker 21 | make # or `sudo make` 22 | docker run -it --rm compiler-dev bash 23 | ``` 24 | 25 | ## 镜像中包含的内容 26 | 27 | * 必要的工具: `git`, `flex`, `bison`, `python3` (用于运行测试脚本). 28 | * 构建工具: `make`, `cmake`. 29 | * 运行工具: `qemu-user-static`. 30 | * 编译工具链: Rust 工具链, LLVM 工具链. 31 | * Koopa IR 相关工具: `libkoopa`, `koopac`. 32 | * 测试脚本: `autotest`. 33 | 34 | ## 变更日志 35 | 36 | 见 [CHANGELOG.md](CHANGELOG.md). 37 | -------------------------------------------------------------------------------- /autotest/.gitignore: -------------------------------------------------------------------------------- 1 | * 2 | !.gitignore 3 | !autotest 4 | !README.md 5 | -------------------------------------------------------------------------------- /autotest/README.md: -------------------------------------------------------------------------------- 1 | # autotest 2 | 3 | 编译器自动测试脚本. 4 | 5 | ## 用法 6 | 7 | ```sh 8 | ./autotest [-koopa|-riscv|-perf] [-t TEST_CASE_DIR] [-w WORKING_DIR] REPO_DIR 9 | ``` 10 | 11 | 参数: 12 | 13 | * `-koopa|-riscv|-perf`: 可选, 指定对编译器进行何种测试, 可为 Koopa IR 测试 (`-koopa`), RISC-V 测试 (`-riscv`) 和性能测试 (`-perf`). 默认为 `-koopa`. 14 | * `-t TEST_CASE_DIR`: 可选, 指定测试用例目录, 目录内须包含若干 `.c`/`.sy` 文件 (也可位于子目录中). 其中, 每个 `.c`/`.sy` 文件应当有一个位于相同目录中且同名的 `.out` 文件, 对应该 SysY 程序的预期输出/返回值; 每个 `.c`/`.sy` 文件还可以有一个位于相同目录中且同名的 `.in` 文件, 对应该 SysY 程序的输入, 如果程序不会从 `stdin` 读取输入, 则该文件应该省略. (参考[开放测试用例](https://github.com/pku-minic/open-test-cases)的写法). 默认为脚本目录下的 `testcases` 目录. 15 | * `-w WORKING_DIR`: 可选, 指定工作目录. 脚本会把编译生成的文件以及其他各类文件存入工作目录, 而默认情况下, 工作目录是一个临时目录, 脚本运行结束后会将其删除. 如果你不想每次都让脚本重新编译你的项目, 而是需要增量编译, 你可以指定一个工作目录, 此时脚本退出前不会删除这个目录. 16 | * `-s WORKING_DIR`: 可选, 指定运行测试用例目录下的子目录中的测试用例. 17 | * `REPO_DIR`: 必选, 指定编译器仓库的目录. 目录内须包含 `Makefile`/`CMakeLists.txt`/`Cargo.toml` 文件之一, 脚本将自动使用 `make`/`CMake`/`Cargo` 构建编译器, 并对其进行测试. 18 | 19 | ## 对编译器的要求 20 | 21 | * **Koopa IR 测试:** 编译器需支持形如 `./compiler -koopa INPUT -o OUTPUT` 的命令行参数, 其中 `INPUT` 为 SysY 的输入文件, `OUTPUT` 为 Koopa IR 的输出文件. 22 | * **RISC-V 测试:** 编译器需支持形如 `./compiler -riscv INPUT -o OUTPUT` 的命令行参数, 其中 `INPUT` 为 SysY 的输入文件, `OUTPUT` 为 RISC-V 的输出文件. 23 | * **性能测试:** 编译器需支持形如 `./compiler -perf INPUT -o OUTPUT` 的命令行参数, 其中 `INPUT` 为 SysY 的输入文件, `OUTPUT` 为 RISC-V 的输出文件. 24 | -------------------------------------------------------------------------------- /autotest/autotest: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from dataclasses import dataclass 4 | from enum import Enum, auto, unique 5 | import multiprocessing 6 | import os 7 | import re 8 | import shlex 9 | import shutil 10 | import subprocess 11 | import sys 12 | import tempfile 13 | from typing import List, Optional, Tuple 14 | import uuid 15 | 16 | 17 | # some parameters 18 | LIBRARY_PATH = os.environ['CDE_LIBRARY_PATH'] 19 | INCLUDE_PATH = os.environ['CDE_INCLUDE_PATH'] 20 | TEMP_OUTPUT_FILE = f'{str(uuid.uuid4()).replace("-", "")}.S' 21 | TEMP_OBJECT_FILE = f'{str(uuid.uuid4()).replace("-", "")}.o' 22 | TEMP_EXECUTABLE_FILE = f'{str(uuid.uuid4()).replace("-", "")}' 23 | COMP_TIMEOUT_SEC = 300 24 | ASM_TIMEOUT_SEC = 60 25 | RUN_TIMEOUT_SEC = 120 26 | RE_TOTAL_TIME = re.compile(r'TOTAL: (\d+H-\d+M-\d+S-\d+us)') 27 | 28 | 29 | @unique 30 | class TestMode(Enum): 31 | ''' 32 | Test mode. 33 | ''' 34 | KOOPA = auto() 35 | RISCV = auto() 36 | PERF = auto() 37 | 38 | def to_opt(self) -> str: 39 | ''' 40 | Converts the current test mode to command line option. 41 | ''' 42 | return { 43 | TestMode.KOOPA: '-koopa', 44 | TestMode.RISCV: '-riscv', 45 | TestMode.PERF: '-perf', 46 | }[self] 47 | 48 | 49 | @dataclass(frozen=True) 50 | class CompilerInfo: 51 | ''' 52 | Compiler related information. 53 | ''' 54 | working_dir: str 55 | compile_cmd: str 56 | clean_wd: bool 57 | 58 | def clean(self): 59 | ''' 60 | Deletes the working directory. 61 | ''' 62 | if self.clean_wd: 63 | shutil.rmtree(self.working_dir) 64 | 65 | 66 | @dataclass(frozen=True) 67 | class TestCase: 68 | ''' 69 | Test case information. 70 | ''' 71 | name: str 72 | source_file: str 73 | output_file: str 74 | input_file: Optional[str] 75 | 76 | 77 | @unique 78 | class TestStatus(Enum): 79 | ''' 80 | Status of a test. 81 | ''' 82 | PASSED = auto() 83 | COMP_ERROR = auto() 84 | COMP_TIME_EXCEEDED = auto() 85 | OUTPUT_NOT_FOUND = auto() 86 | ASM_ERROR = auto() 87 | ASM_TIME_EXCEEDED = auto() 88 | RUN_ERROR = auto() 89 | RUN_TIME_EXCEEDED = auto() 90 | WRONG_ANSWER = auto() 91 | 92 | def to_msg(self): 93 | ''' 94 | Converts the current test status to `eprint` message. 95 | ''' 96 | return { 97 | TestStatus.PASSED: '\033[0;32mPASSED\033[0m', 98 | TestStatus.COMP_ERROR: '\033[0;35mCASE COMPILE ERROR\033[0m', 99 | TestStatus.COMP_TIME_EXCEEDED: '\033[0;34mCASE COMPILE TIME EXCEEDED\033[0m', 100 | TestStatus.OUTPUT_NOT_FOUND: '\033[0;31mOUTPUT NOT FOUND\033[0m', 101 | TestStatus.ASM_ERROR: '\033[0;35mCASE ASSEMBLE ERROR\033[0m', 102 | TestStatus.ASM_TIME_EXCEEDED: '\033[0;34mCASE ASSEMBLE TIME EXCEEDED\033[0m', 103 | TestStatus.RUN_ERROR: '\033[0;35mRUNTIME ERROR\033[0m', 104 | TestStatus.RUN_TIME_EXCEEDED: '\033[0;34mTIME LIMIT EXCEEDED\033[0m', 105 | TestStatus.WRONG_ANSWER: '\033[0;31mWRONG ANSWER\033[0m', 106 | }[self] 107 | 108 | 109 | @dataclass(frozen=True) 110 | class TestResult: 111 | ''' 112 | Result of a single test. 113 | ''' 114 | status: TestStatus 115 | answer: str = '' 116 | time: Optional[str] = None 117 | output_error: Optional[Tuple[str, str]] = None 118 | 119 | def show_details(self): 120 | ''' 121 | Prints the details of the current test result to `stderr`. 122 | ''' 123 | eprint(self.status.to_msg()) 124 | if self.status == TestStatus.WRONG_ANSWER: 125 | eprint('your answer:') 126 | eprint(self.answer) 127 | elif self.status != TestStatus.PASSED and self.output_error: 128 | eprint('stdout:') 129 | eprint(self.output_error[0]) 130 | eprint('stderr:') 131 | eprint(self.output_error[1]) 132 | 133 | def show_perf(self): 134 | ''' 135 | Prints the performance test result to `stderr`. 136 | ''' 137 | eprint(f'time elapsed: {self.time}') 138 | 139 | 140 | def eprint(*args, **kwargs): 141 | ''' 142 | Prints to `stderr`. 143 | ''' 144 | print(*args, file=sys.stderr, **kwargs) 145 | sys.stderr.flush() 146 | 147 | 148 | def files_exists(base_dir: str, *files: str) -> Optional[str]: 149 | ''' 150 | Checks if the specific files exists. 151 | 152 | Returns file path if exists, otherwise returns `None`. 153 | ''' 154 | for file in files: 155 | file = os.path.join(base_dir, file) 156 | if os.path.exists(file): 157 | return file 158 | return None 159 | 160 | 161 | def decode_bytes(b: bytes) -> str: 162 | ''' 163 | Decodes bytes to UTF-8 string. 164 | ''' 165 | try: 166 | return b.decode('utf-8') 167 | except UnicodeDecodeError: 168 | return str(b) 169 | 170 | 171 | def decode_result(result: 'subprocess.CompletedProcess[bytes]') -> Tuple[str, str]: 172 | ''' 173 | Decodes result returned by `subprocess.run`, extracts `stdout` and `stderr`. 174 | ''' 175 | return (decode_bytes(result.stdout), decode_bytes(result.stderr)) 176 | 177 | 178 | def execute(cmd: str, timeout: int, error_status: TestStatus, 179 | timeout_status: TestStatus, 180 | pipe_cmd: Optional[str] = None) -> Optional[TestResult]: 181 | ''' 182 | Executes the given command line, returns test result if failed. 183 | ''' 184 | try: 185 | if pipe_cmd: 186 | pipe = subprocess.Popen(shlex.split(pipe_cmd), stdout=subprocess.PIPE, 187 | stderr=subprocess.PIPE) 188 | result = subprocess.run(shlex.split(cmd), timeout=timeout, stdin=pipe.stdout, 189 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) 190 | if pipe.wait(): 191 | return TestResult(error_status, 192 | output_error=(decode_bytes(pipe.stdout.read()), 193 | decode_bytes(pipe.stderr.read()))) 194 | else: 195 | result = subprocess.run(shlex.split(cmd), timeout=timeout, 196 | stdout=subprocess.PIPE, stderr=subprocess.PIPE) 197 | if result.returncode: 198 | return TestResult(error_status, output_error=decode_result(result)) 199 | except subprocess.TimeoutExpired: 200 | return TestResult(timeout_status) 201 | return None 202 | 203 | 204 | def parse_time_info(stderr: str) -> str: 205 | ''' 206 | Parses time information from the given `stderr`. 207 | ''' 208 | time = RE_TOTAL_TIME.findall(stderr) 209 | if time: 210 | time = time[0] 211 | else: 212 | time = 'time information not found' 213 | return time 214 | 215 | 216 | def remove_prefix(s: str, prefix: str) -> str: 217 | ''' 218 | Removes the prefix from the given string. 219 | ''' 220 | if s.startswith(prefix): 221 | return s[len(prefix):] 222 | return s 223 | 224 | 225 | def scan_test_cases(test_case_dir: str) -> List[TestCase]: 226 | ''' 227 | Scans all test cases recursively in the given test case directory. 228 | 229 | Returns the list of test case paths. 230 | ''' 231 | cases = [] 232 | # walk in test case directory 233 | for root, _, files in os.walk(test_case_dir): 234 | prefix = remove_prefix(root, test_case_dir).lstrip('/') 235 | files = set(files) 236 | for file in files: 237 | # check if is SysY source file 238 | if file.endswith('.c') or file.endswith('.sy'): 239 | name = os.path.splitext(file)[0] 240 | out_file = f'{name}.out' 241 | # check if output file exists 242 | if out_file in files: 243 | source_file = os.path.join(root, file) 244 | output_file = os.path.join(root, out_file) 245 | in_file = f'{name}.in' 246 | input_file = os.path.join( 247 | root, in_file) if in_file in files else None 248 | # add to cases list 249 | name = os.path.join(prefix, name) 250 | cases.append(TestCase(name, source_file, output_file, input_file)) 251 | cases.sort(key=lambda x: x.source_file) 252 | return cases 253 | 254 | 255 | def build_make_project(repo_dir: str, working_dir: str) -> Tuple[str, str]: 256 | ''' 257 | Returns build command and compile command of the given Make project. 258 | ''' 259 | flags = f'LIB_DIR="{LIBRARY_PATH}/native" INC_DIR="{INCLUDE_PATH}"' 260 | build_cmd = f'make DEBUG=0 BUILD_DIR="{working_dir}" {flags} -C "{repo_dir}"' 261 | comp_cmd = os.path.join(working_dir, 'compiler') 262 | return (build_cmd, f'"{comp_cmd}"') 263 | 264 | 265 | def build_cmake_project(repo_dir: str, workding_dir: str) -> Tuple[str, str]: 266 | ''' 267 | Returns build command and compile command of the given CMake project. 268 | ''' 269 | # generate build configuration 270 | flags = f'-DLIB_DIR="{LIBRARY_PATH}/native" -DINC_DIR="{INCLUDE_PATH}"' 271 | gen_cmd = f'cmake -S "{repo_dir}" -B "{workding_dir}" {flags}' 272 | result = subprocess.run(shlex.split(gen_cmd)) 273 | if result.returncode: 274 | msg = f'failed to generate the build configuration of repository with CMake\n' 275 | msg += f'CMake command: {gen_cmd}' 276 | raise RuntimeError(msg) 277 | # get command lines 278 | build_cmd = f'cmake --build "{workding_dir}" -j {multiprocessing.cpu_count()}' 279 | comp_cmd = os.path.join(workding_dir, 'compiler') 280 | return (build_cmd, f'"{comp_cmd}"') 281 | 282 | 283 | def build_cargo_project(manifest: str, workding_dir: str) -> Tuple[str, str]: 284 | ''' 285 | Returns build command and compile command of the given Cargo project. 286 | ''' 287 | flags = f'--manifest-path="{manifest}" --target-dir="{workding_dir}" --release' 288 | return (f'cargo build {flags}', f'cargo run {flags} -q --') 289 | 290 | 291 | def build_repo(repo_dir: str, 292 | working_dir: Optional[str] = None) -> Optional[CompilerInfo]: 293 | ''' 294 | Builds the given repository. 295 | 296 | Returns compiler information. 297 | ''' 298 | # initialize working directory 299 | if not working_dir: 300 | working_dir = tempfile.mkdtemp() 301 | clean_wd = True 302 | else: 303 | working_dir = os.path.abspath(working_dir) 304 | clean_wd = False 305 | eprint(f'working directory: {working_dir}') 306 | try: 307 | # check if is Make/CMake/Cargo project 308 | if files_exists(repo_dir, 'Makefile', 'makefile'): 309 | (build_cmd, compile_cmd) = build_make_project(repo_dir, working_dir) 310 | elif files_exists(repo_dir, 'CMakeLists.txt'): 311 | (build_cmd, compile_cmd) = build_cmake_project(repo_dir, working_dir) 312 | elif manifest := files_exists(repo_dir, 'Cargo.toml'): 313 | (build_cmd, compile_cmd) = build_cargo_project(manifest, working_dir) 314 | else: 315 | eprint(f'repository "{repo_dir}" does not contain ' + 316 | 'any build configurations') 317 | return None 318 | # build repository 319 | result = subprocess.run(shlex.split(build_cmd)) 320 | if result.returncode: 321 | eprint('failed to build the repository') 322 | eprint(f'compilation command: {build_cmd}') 323 | return None 324 | # check if the compiler has been generated properly 325 | if compile_cmd.startswith('"'): 326 | compiler_file = compile_cmd.strip('"') 327 | if not os.path.exists(compiler_file): 328 | eprint(f'compiler "{compile_cmd}" not found') 329 | eprint('please check your Make/CMake build configuration') 330 | return None 331 | return CompilerInfo(working_dir, compile_cmd, clean_wd) 332 | except Exception as e: 333 | eprint(e) 334 | # delete the working directory 335 | if clean_wd: 336 | shutil.rmtree(working_dir) 337 | return None 338 | 339 | 340 | def asm_koopa(output: str, obj: str, exe: str) -> Optional[TestResult]: 341 | ''' 342 | Converts Koopa IR to executable. 343 | ''' 344 | if result := execute(f'llc --filetype=obj -o {obj}', ASM_TIMEOUT_SEC, 345 | TestStatus.ASM_ERROR, TestStatus.ASM_TIME_EXCEEDED, 346 | pipe_cmd=f'koopac {output}'): 347 | return result 348 | lib_flags = f'-L{LIBRARY_PATH}/native -lsysy' 349 | cmd = f'clang {obj} {lib_flags} -o {exe}' 350 | if result := execute(cmd, ASM_TIMEOUT_SEC, TestStatus.ASM_ERROR, 351 | TestStatus.ASM_TIME_EXCEEDED): 352 | return result 353 | return None 354 | 355 | 356 | def asm_riscv(output: str, obj: str, exe: str) -> Optional[TestResult]: 357 | ''' 358 | Converts RISC-V assembly to executable. 359 | ''' 360 | asm_flags = '-target riscv32-unknown-linux-elf -march=rv32im -mabi=ilp32' 361 | cmd = f'clang {output} -c -o {obj} {asm_flags}' 362 | if result := execute(cmd, ASM_TIMEOUT_SEC, TestStatus.ASM_ERROR, 363 | TestStatus.ASM_TIME_EXCEEDED): 364 | return result 365 | lib_flags = f'-L{LIBRARY_PATH}/riscv32 -lsysy' 366 | cmd = f'ld.lld {obj} {lib_flags} -o {exe}' 367 | if result := execute(cmd, ASM_TIMEOUT_SEC, TestStatus.ASM_ERROR, 368 | TestStatus.ASM_TIME_EXCEEDED): 369 | return result 370 | return None 371 | 372 | 373 | def run_output(mode: TestMode, case: TestCase, exe: str) -> TestResult: 374 | ''' 375 | Runs the generated output executable and checks the result. 376 | ''' 377 | # execute output file 378 | inputs = None 379 | if case.input_file: 380 | with open(case.input_file, 'r') as f: 381 | inputs = f.read().encode('utf-8') 382 | if mode != TestMode.KOOPA: 383 | exe = f'qemu-riscv32-static {exe}' 384 | try: 385 | result = subprocess.run(shlex.split(exe), timeout=RUN_TIMEOUT_SEC, 386 | stdout=subprocess.PIPE, stderr=subprocess.PIPE, 387 | input=inputs) 388 | except subprocess.TimeoutExpired: 389 | return TestResult(TestStatus.RUN_TIME_EXCEEDED) 390 | # get actual output 391 | (stdout, stderr) = decode_result(result) 392 | if not stdout or stdout.endswith('\n'): 393 | out = f'{stdout}{result.returncode}' 394 | else: 395 | out = f'{stdout}\n{result.returncode}' 396 | # get expected output 397 | with open(case.output_file, mode='r', newline='') as f: 398 | ref = f.read().rstrip() 399 | # get time information 400 | time = None 401 | if mode == TestMode.PERF: 402 | time = parse_time_info(stderr) 403 | # generate result 404 | status = TestStatus.PASSED if out == ref else TestStatus.WRONG_ANSWER 405 | return TestResult(status, out, time, (stdout, stderr)) 406 | 407 | 408 | def run_test(mode: TestMode, compiler: CompilerInfo, case: TestCase) -> TestResult: 409 | ''' 410 | Runs the test for the given compiler by using the given test case. 411 | 412 | Returns test result. 413 | ''' 414 | output = os.path.join(compiler.working_dir, TEMP_OUTPUT_FILE) 415 | obj = os.path.join(compiler.working_dir, TEMP_OBJECT_FILE) 416 | exe = os.path.join(compiler.working_dir, TEMP_EXECUTABLE_FILE) 417 | # compile test case 418 | cmd = f'{compiler.compile_cmd} {mode.to_opt()} {case.source_file} -o {output}' 419 | if result := execute(cmd, COMP_TIMEOUT_SEC, TestStatus.COMP_ERROR, 420 | TestStatus.COMP_TIME_EXCEEDED): 421 | return result 422 | # check output file 423 | if not os.path.exists(output): 424 | return TestResult(TestStatus.OUTPUT_NOT_FOUND) 425 | # assembly output file 426 | asm = asm_koopa if mode == TestMode.KOOPA else asm_riscv 427 | if result := asm(output, obj, exe): 428 | return result 429 | return run_output(mode, case, exe) 430 | 431 | 432 | def run_tests(mode: TestMode, compiler: CompilerInfo, cases: List[TestCase]): 433 | ''' 434 | Runs test for all test cases. 435 | 436 | Prints test results to `stderr` when necessary. 437 | ''' 438 | passed = 0 439 | # run all tests 440 | for case in cases: 441 | eprint(f'running test "{case.name}" ... ', end='') 442 | result = run_test(mode, compiler, case) 443 | result.show_details() 444 | if result.status == TestStatus.PASSED: 445 | if mode == TestMode.PERF: 446 | result.show_perf() 447 | passed += 1 448 | # print test result 449 | total = len(cases) 450 | status = TestStatus.PASSED if passed == total else TestStatus.WRONG_ANSWER 451 | eprint(f'{status.to_msg()} ({passed}/{total})') 452 | 453 | 454 | if __name__ == '__main__': 455 | # initialize argument parser 456 | import argparse 457 | parser = argparse.ArgumentParser( 458 | description='An automated testing script for PKU compiler course.') 459 | group = parser.add_mutually_exclusive_group() 460 | group.add_argument('-koopa', action='store_const', const=TestMode.KOOPA, 461 | dest='mode', help='run SysY to Koopa IR test') 462 | group.add_argument('-riscv', action='store_const', const=TestMode.RISCV, 463 | dest='mode', help='run SysY to RISC-V assembly test') 464 | group.add_argument('-perf', action='store_const', const=TestMode.PERF, 465 | dest='mode', help='run performance test') 466 | parser.set_defaults(mode=TestMode.KOOPA) 467 | parser.add_argument('-t', '--test_case_dir', 468 | default=os.path.join(os.path.dirname( 469 | os.path.realpath(__file__)), 'testcases'), 470 | help='specify test case directory, ' + 471 | 'default to SCRIPT_DIR/testcases') 472 | parser.add_argument('-w', '--working_dir', 473 | default=None, 474 | help='specify working directory, ' + 475 | 'default to a temporary directory') 476 | parser.add_argument('-s', '--sub_dir', 477 | default=None, 478 | help='run testcases in the specific sub directory') 479 | parser.add_argument('repo_dir', type=str, 480 | help='compiler repository directory') 481 | 482 | # parse arguments 483 | args = parser.parse_args() 484 | eprint(f'run test in "{args.mode.to_opt()}" mode') 485 | 486 | # scan test cases 487 | test_case_dir = os.path.abspath(args.test_case_dir) 488 | if args.sub_dir: 489 | test_case_dir = os.path.join(test_case_dir, args.sub_dir) 490 | cases = scan_test_cases(test_case_dir) 491 | if not cases: 492 | eprint(f'no test cases found in directory "{test_case_dir}"') 493 | sys.exit(-1) 494 | 495 | # compile the repository 496 | compiler = build_repo(args.repo_dir, args.working_dir) 497 | if not compiler: 498 | eprint(f'failed to compile the repository "{args.repo_dir}"') 499 | sys.exit(-1) 500 | 501 | # run test 502 | try: 503 | run_tests(args.mode, compiler, cases) 504 | except KeyboardInterrupt: 505 | eprint(f'\033[0;33mINTERRUPTED\033[0m') 506 | finally: 507 | compiler.clean() 508 | -------------------------------------------------------------------------------- /docker/.gitignore: -------------------------------------------------------------------------------- 1 | * 2 | !.gitignore 3 | !Dockerfile 4 | !Makefile 5 | !update-alternatives-clang.sh 6 | -------------------------------------------------------------------------------- /docker/Dockerfile: -------------------------------------------------------------------------------- 1 | # base image 2 | FROM ubuntu:20.04 as compiler-dev-base 3 | 4 | # some arguments 5 | ARG KOOPA_REPO_URL=https://github.com/pku-minic/koopa.git 6 | ARG KOOPAC=koopac.tar.gz 7 | ARG SYSYRT_REPO_URL=https://github.com/pku-minic/sysy-runtime-lib.git 8 | ARG AUTOTEST=autotest 9 | ARG INSTALL_DIR=/opt 10 | ARG LIB_INSTALL_DIR=${INSTALL_DIR}/lib 11 | ARG INC_INSTALL_DIR=${INSTALL_DIR}/include 12 | ARG BIN_INSTALL_DIR=${INSTALL_DIR}/bin 13 | 14 | # setup APT mirror 15 | RUN sed -i "s@http://.*archive.ubuntu.com@http://mirrors.tuna.tsinghua.edu.cn@g" /etc/apt/sources.list && \ 16 | sed -i "s@http://.*security.ubuntu.com@http://mirrors.tuna.tsinghua.edu.cn@g" /etc/apt/sources.list 17 | 18 | # setup ca-certificates for https mirror 19 | RUN apt update 20 | RUN apt upgrade ca-certificates --fix-missing -y 21 | 22 | # setup APT mirror for arm64, armhf, PowerPC, ppc64el, s390x 23 | RUN cat <<'EOF' > /etc/apt/sources.list 24 | deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu-ports/ focal main restricted universe multiverse 25 | deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu-ports/ focal-updates main restricted universe multiverse 26 | deb https://mirrors.tuna.tsinghua.edu.cn/ubuntu-ports/ focal-backports main restricted universe multiverse 27 | deb http://ports.ubuntu.com/ubuntu-ports/ focal-security main restricted universe multiverse 28 | EOF 29 | 30 | # install LLVM's APT 31 | RUN apt update && \ 32 | DEBIAN_FRONTEND="noninteractive" apt install -y wget gnupg && \ 33 | wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | apt-key add - && \ 34 | echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal main" >> /etc/apt/sources.list && \ 35 | echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-12 main" >> /etc/apt/sources.list && \ 36 | echo "deb http://apt.llvm.org/focal/ llvm-toolchain-focal-13 main" >> /etc/apt/sources.list 37 | 38 | # install necessary packages 39 | RUN apt update && DEBIAN_FRONTEND="noninteractive" apt install -y \ 40 | git flex bison python3 \ 41 | make cmake \ 42 | qemu-user-static \ 43 | clang-13 lldb-13 lld-13 44 | 45 | # setup LLVM toolchain 46 | WORKDIR /root 47 | COPY update-alternatives-clang.sh . 48 | RUN bash update-alternatives-clang.sh 13 100 && \ 49 | rm update-alternatives-clang.sh 50 | 51 | # install Rust toolchain 52 | RUN wget -O - https://sh.rustup.rs | sh -s -- -y && \ 53 | mkdir -p ~/.cargo && \ 54 | echo "[source.crates-io]" > ~/.cargo/config && \ 55 | echo "replace-with = 'tuna'" >> ~/.cargo/config && \ 56 | echo "[source.tuna]" >> ~/.cargo/config && \ 57 | echo "registry = \"sparse+https://mirrors.tuna.tsinghua.edu.cn/crates.io-index/\"" >> ~/.cargo/config 58 | ENV RUSTUP_UPDATE_ROOT=https://mirrors.tuna.tsinghua.edu.cn/rustup/rustup 59 | ENV RUSTUP_DIST_SERVER=https://mirrors.tuna.tsinghua.edu.cn/rustup 60 | ENV PATH="/root/.cargo/bin:${PATH}" 61 | 62 | # setup install directories 63 | RUN mkdir -p ${LIB_INSTALL_DIR} ${BIN_INSTALL_DIR} 64 | ENV CDE_LIBRARY_PATH="${LIB_INSTALL_DIR}" 65 | ENV CDE_INCLUDE_PATH="${INC_INSTALL_DIR}" 66 | ENV PATH="${BIN_INSTALL_DIR}:${PATH}" 67 | 68 | # install libkoopa 69 | WORKDIR ${LIB_INSTALL_DIR} 70 | RUN git clone --single-branch --depth 1 ${KOOPA_REPO_URL} koopa && \ 71 | cargo build --release --manifest-path koopa/crates/libkoopa/Cargo.toml && \ 72 | mkdir -p native && \ 73 | cp koopa/crates/libkoopa/target/release/libkoopa.a native && \ 74 | mkdir -p ${INC_INSTALL_DIR} && \ 75 | cp -R koopa/crates/libkoopa/include/* ${INC_INSTALL_DIR}/. && \ 76 | rm -rf koopa /root/.cargo/registry 77 | 78 | # install koopac 79 | WORKDIR ${INSTALL_DIR} 80 | COPY ${KOOPAC} . 81 | RUN mkdir kpc && tar xzf ${KOOPAC} -C kpc && \ 82 | cargo install --path kpc --root ${INSTALL_DIR} --no-track && \ 83 | rm -rf ${KOOPAC} kpc /root/.cargo/registry 84 | 85 | # install SysY runtime library 86 | WORKDIR ${LIB_INSTALL_DIR} 87 | RUN git clone --single-branch --depth 1 ${SYSYRT_REPO_URL} sysyrt && \ 88 | make -C sysyrt libsysy && \ 89 | mkdir -p native && cp sysyrt/build/libsysy.a native && \ 90 | make NO_LIBC=1 \ 91 | ADD_CFLAGS="-target riscv32-unknown-linux-elf -march=rv32im -mabi=ilp32" \ 92 | -C sysyrt clean libsysy && \ 93 | mkdir -p riscv32 && cp sysyrt/build/libsysy.a riscv32 && \ 94 | rm -rf sysyrt 95 | 96 | 97 | # compiler development environment image 98 | FROM compiler-dev-base as compiler-dev 99 | 100 | # some arguments 101 | ARG TEST_CASES_REPO_URL=https://github.com/pku-minic/compiler-dev-test-cases.git 102 | 103 | # install autotest and test cases 104 | WORKDIR ${BIN_INSTALL_DIR} 105 | COPY ${AUTOTEST} . 106 | RUN git clone --single-branch --depth 1 ${TEST_CASES_REPO_URL} cd-test-cases && \ 107 | make LIB_DIR=${LIB_INSTALL_DIR}/native INSTALL_DIR=${BIN_INSTALL_DIR}/testcases \ 108 | -C cd-test-cases install -j`nproc` && \ 109 | rm -rf cd-test-cases 110 | 111 | WORKDIR /root 112 | -------------------------------------------------------------------------------- /docker/Makefile: -------------------------------------------------------------------------------- 1 | # parameters 2 | DOCKER ?= docker 3 | DOCKER_BUILD_TARGET ?= compiler-dev 4 | DOCKER_IMAGE_NAME ?= compiler-dev 5 | DOCKER_BUILD_OPTS ?= 6 | 7 | # directories 8 | TOP_DIR := $(shell pwd) 9 | REPO_DIR := $(realpath $(TOP_DIR)/..) 10 | KOOPAC_DIR := $(REPO_DIR)/koopac 11 | KOOPAC_DIR_NAME := koopac 12 | 13 | # files 14 | KOOPAC_SRCS := $(shell find $(KOOPAC_DIR)/src -name "*.rs") 15 | KOOPAC_SRCS += $(KOOPAC_DIR)/Cargo.toml 16 | AUTOTEST_SRC := $(REPO_DIR)/autotest/autotest 17 | 18 | # targets 19 | KOOPAC_NAME := koopac.tar.gz 20 | KOOPAC := $(TOP_DIR)/$(KOOPAC_NAME) 21 | AUTOTEST_NAME := autotest 22 | AUTOTEST := $(TOP_DIR)/$(AUTOTEST_NAME) 23 | BUILD_CONTEXT := $(TOP_DIR)/update-alternatives-clang.sh 24 | BUILD_CONTEXT += $(KOOPAC) $(AUTOTEST) 25 | 26 | # docker 27 | DOCKER_BUILD_FLAGS := --target $(DOCKER_BUILD_TARGET) -t $(DOCKER_IMAGE_NAME) 28 | DOCKER_BUILD_FLAGS += $(DOCKER_BUILD_OPTS) --build-arg KOOPAC=$(KOOPAC_NAME) 29 | DOCKER_BUILD_FLAGS += --build-arg AUTOTEST=$(AUTOTEST_NAME) 30 | 31 | .PHONY: docker clean 32 | 33 | docker: $(TOP_DIR)/Dockerfile $(BUILD_CONTEXT) 34 | $(DOCKER) build $(DOCKER_BUILD_FLAGS) . 35 | 36 | clean: 37 | -rm $(KOOPAC) $(AUTOTEST) 38 | 39 | $(KOOPAC): $(KOOPAC_SRCS) 40 | cd .. && git archive --format=tar.gz -o $@ HEAD:$(KOOPAC_DIR_NAME) 41 | 42 | $(AUTOTEST): $(AUTOTEST_SRC) 43 | cp $^ $@ 44 | -------------------------------------------------------------------------------- /docker/update-alternatives-clang.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # Reference: https://gist.github.com/junkdog/70231d6953592cd6f27def59fe19e50d 4 | 5 | # --slave /usr/bin/$1 $1 /usr/bin/$1-\${version} \\ 6 | 7 | function register_clang_version { 8 | local version=$1 9 | local priority=$2 10 | 11 | update-alternatives \ 12 | --install /usr/bin/llvm-config llvm-config /usr/bin/llvm-config-${version} ${priority} \ 13 | --slave /usr/bin/llvm-ar llvm-ar /usr/bin/llvm-ar-${version} \ 14 | --slave /usr/bin/llvm-as llvm-as /usr/bin/llvm-as-${version} \ 15 | --slave /usr/bin/llvm-bcanalyzer llvm-bcanalyzer /usr/bin/llvm-bcanalyzer-${version} \ 16 | --slave /usr/bin/llvm-cov llvm-cov /usr/bin/llvm-cov-${version} \ 17 | --slave /usr/bin/llvm-diff llvm-diff /usr/bin/llvm-diff-${version} \ 18 | --slave /usr/bin/llvm-dis llvm-dis /usr/bin/llvm-dis-${version} \ 19 | --slave /usr/bin/llvm-dwarfdump llvm-dwarfdump /usr/bin/llvm-dwarfdump-${version} \ 20 | --slave /usr/bin/llvm-extract llvm-extract /usr/bin/llvm-extract-${version} \ 21 | --slave /usr/bin/llvm-link llvm-link /usr/bin/llvm-link-${version} \ 22 | --slave /usr/bin/llvm-mc llvm-mc /usr/bin/llvm-mc-${version} \ 23 | --slave /usr/bin/llvm-mcmarkup llvm-mcmarkup /usr/bin/llvm-mcmarkup-${version} \ 24 | --slave /usr/bin/llvm-nm llvm-nm /usr/bin/llvm-nm-${version} \ 25 | --slave /usr/bin/llvm-objdump llvm-objdump /usr/bin/llvm-objdump-${version} \ 26 | --slave /usr/bin/llvm-ranlib llvm-ranlib /usr/bin/llvm-ranlib-${version} \ 27 | --slave /usr/bin/llvm-readobj llvm-readobj /usr/bin/llvm-readobj-${version} \ 28 | --slave /usr/bin/llvm-rtdyld llvm-rtdyld /usr/bin/llvm-rtdyld-${version} \ 29 | --slave /usr/bin/llvm-size llvm-size /usr/bin/llvm-size-${version} \ 30 | --slave /usr/bin/llvm-stress llvm-stress /usr/bin/llvm-stress-${version} \ 31 | --slave /usr/bin/llvm-symbolizer llvm-symbolizer /usr/bin/llvm-symbolizer-${version} \ 32 | --slave /usr/bin/llvm-tblgen llvm-tblgen /usr/bin/llvm-tblgen-${version} 33 | 34 | update-alternatives \ 35 | --install /usr/bin/clang clang /usr/bin/clang-${version} ${priority} \ 36 | --slave /usr/bin/clang++ clang++ /usr/bin/clang++-${version} \ 37 | --slave /usr/bin/asan_symbolize asan_symbolize /usr/bin/asan_symbolize-${version} \ 38 | --slave /usr/bin/c-index-test c-index-test /usr/bin/c-index-test-${version} \ 39 | --slave /usr/bin/clang-check clang-check /usr/bin/clang-check-${version} \ 40 | --slave /usr/bin/clang-cl clang-cl /usr/bin/clang-cl-${version} \ 41 | --slave /usr/bin/clang-cpp clang-cpp /usr/bin/clang-cpp-${version} \ 42 | --slave /usr/bin/clang-format clang-format /usr/bin/clang-format-${version} \ 43 | --slave /usr/bin/clang-format-diff clang-format-diff /usr/bin/clang-format-diff-${version} \ 44 | --slave /usr/bin/clang-import-test clang-import-test /usr/bin/clang-import-test-${version} \ 45 | --slave /usr/bin/clang-include-fixer clang-include-fixer /usr/bin/clang-include-fixer-${version} \ 46 | --slave /usr/bin/clang-offload-bundler clang-offload-bundler /usr/bin/clang-offload-bundler-${version} \ 47 | --slave /usr/bin/clang-query clang-query /usr/bin/clang-query-${version} \ 48 | --slave /usr/bin/clang-rename clang-rename /usr/bin/clang-rename-${version} \ 49 | --slave /usr/bin/clang-reorder-fields clang-reorder-fields /usr/bin/clang-reorder-fields-${version} \ 50 | --slave /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-${version} \ 51 | --slave /usr/bin/lldb lldb /usr/bin/lldb-${version} \ 52 | --slave /usr/bin/lldb-server lldb-server /usr/bin/lldb-server-${version} \ 53 | --slave /usr/bin/ld.lld ld.lld /usr/bin/ld.lld-${version} \ 54 | --slave /usr/bin/lli lli /usr/bin/lli-${version} \ 55 | --slave /usr/bin/llc llc /usr/bin/llc-${version} \ 56 | --slave /usr/bin/opt opt /usr/bin/opt-${version} 57 | } 58 | 59 | register_clang_version $1 $2 60 | -------------------------------------------------------------------------------- /koopac/.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | -------------------------------------------------------------------------------- /koopac/.rustfmt.toml: -------------------------------------------------------------------------------- 1 | tab_spaces = 2 2 | -------------------------------------------------------------------------------- /koopac/Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "atty" 7 | version = "0.2.14" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8" 10 | dependencies = [ 11 | "hermit-abi", 12 | "libc", 13 | "winapi", 14 | ] 15 | 16 | [[package]] 17 | name = "colored" 18 | version = "2.0.0" 19 | source = "registry+https://github.com/rust-lang/crates.io-index" 20 | checksum = "b3616f750b84d8f0de8a58bda93e08e2a81ad3f523089b05f1dffecab48c6cbd" 21 | dependencies = [ 22 | "atty", 23 | "lazy_static", 24 | "winapi", 25 | ] 26 | 27 | [[package]] 28 | name = "hermit-abi" 29 | version = "0.1.19" 30 | source = "registry+https://github.com/rust-lang/crates.io-index" 31 | checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33" 32 | dependencies = [ 33 | "libc", 34 | ] 35 | 36 | [[package]] 37 | name = "key-node-list" 38 | version = "0.0.5" 39 | source = "registry+https://github.com/rust-lang/crates.io-index" 40 | checksum = "653fee522596ae32adbb1ca91b9553be5b2d8e34556c6148899c9132a7a46295" 41 | 42 | [[package]] 43 | name = "koopa" 44 | version = "0.0.7" 45 | source = "registry+https://github.com/rust-lang/crates.io-index" 46 | checksum = "95041421f66312c40f397fcbbdbaed68f1090131f8e7e6b01d8cc896a598605b" 47 | dependencies = [ 48 | "colored", 49 | "key-node-list", 50 | ] 51 | 52 | [[package]] 53 | name = "koopac" 54 | version = "0.0.4" 55 | dependencies = [ 56 | "koopa", 57 | ] 58 | 59 | [[package]] 60 | name = "lazy_static" 61 | version = "1.4.0" 62 | source = "registry+https://github.com/rust-lang/crates.io-index" 63 | checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646" 64 | 65 | [[package]] 66 | name = "libc" 67 | version = "0.2.112" 68 | source = "registry+https://github.com/rust-lang/crates.io-index" 69 | checksum = "1b03d17f364a3a042d5e5d46b053bbbf82c92c9430c592dd4c064dc6ee997125" 70 | 71 | [[package]] 72 | name = "winapi" 73 | version = "0.3.9" 74 | source = "registry+https://github.com/rust-lang/crates.io-index" 75 | checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" 76 | dependencies = [ 77 | "winapi-i686-pc-windows-gnu", 78 | "winapi-x86_64-pc-windows-gnu", 79 | ] 80 | 81 | [[package]] 82 | name = "winapi-i686-pc-windows-gnu" 83 | version = "0.4.0" 84 | source = "registry+https://github.com/rust-lang/crates.io-index" 85 | checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" 86 | 87 | [[package]] 88 | name = "winapi-x86_64-pc-windows-gnu" 89 | version = "0.4.0" 90 | source = "registry+https://github.com/rust-lang/crates.io-index" 91 | checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" 92 | -------------------------------------------------------------------------------- /koopac/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "koopac" 3 | version = "0.0.4" 4 | authors = ["MaxXing "] 5 | edition = "2021" 6 | description = "Koopa IR to LLVM IR converter." 7 | 8 | [[bin]] 9 | name = "koopac" 10 | 11 | [dependencies] 12 | koopa = "0.0.7" 13 | -------------------------------------------------------------------------------- /koopac/README.md: -------------------------------------------------------------------------------- 1 | # koopac 2 | 3 | `koopac`: Koopa IR to LLVM IR converter. 4 | 5 | Koopa IR 到 LLVM IR 的转换器, 用于支持 Koopa IR 程序的运行. 6 | 7 | ## 用法 8 | 9 | 命令行: `koopac [INPUT] [-o OUTPUT] [-h|--help]`. 10 | 11 | 选项: 12 | 13 | * `INPUT`: 输入的 Koopa IR 文件, 默认为标准输入 (`stdin`). 14 | * `OUTPUT`: 输出的 LLVM IR 文件, 默认为标准输出 (`stdout`). 15 | * `-h` 或 `--help`: 查看帮助信息. 16 | -------------------------------------------------------------------------------- /koopac/src/main.rs: -------------------------------------------------------------------------------- 1 | mod reorder_alloc; 2 | 3 | use koopa::back::LlvmGenerator; 4 | use koopa::front::{span::Span, Driver}; 5 | use koopa::opt::PassManager; 6 | use std::env::args; 7 | use std::fmt; 8 | use std::io::{stdin, stdout, Error as IoError}; 9 | use std::process::exit; 10 | 11 | fn main() { 12 | match try_main() { 13 | Err(Error::Parse) => exit(Span::error_num() as i32), 14 | Err(error) => { 15 | eprintln!("{}", error); 16 | exit(-1); 17 | } 18 | _ => {} 19 | } 20 | } 21 | 22 | fn try_main() -> Result<(), Error> { 23 | let mut input = None; 24 | let mut output = None; 25 | // parse command line arguments 26 | let mut args = args(); 27 | args.next(); 28 | loop { 29 | match (args.next(), args.next()) { 30 | (Some(h), _) if h == "-h" => return Err(Error::InvalidArguments), 31 | (Some(help), _) if help == "--help" => return Err(Error::InvalidArguments), 32 | (Some(file), None) => input = Some(file), 33 | (Some(file), Some(o)) if o == "-o" => { 34 | input = Some(file); 35 | match args.next() { 36 | Some(file) => output = Some(file), 37 | _ => return Err(Error::InvalidArguments), 38 | } 39 | } 40 | (Some(o), Some(file)) if o == "-o" => output = Some(file), 41 | (None, None) => break, 42 | _ => return Err(Error::InvalidArguments), 43 | } 44 | } 45 | // read Koopa IR program from input 46 | let mut program = match input { 47 | Some(file) => Driver::from_path(file) 48 | .map_err(Error::InvalidInputFile)? 49 | .generate_program(), 50 | _ => Driver::from(stdin()).generate_program(), 51 | } 52 | .map_err(|_| Error::Parse)?; 53 | // run passes 54 | let mut passes = PassManager::new(); 55 | passes.register(reorder_alloc::ReorderAlloc::new_pass()); 56 | passes.run_passes(&mut program); 57 | // generate LLVM IR and write to output 58 | match output { 59 | Some(file) => LlvmGenerator::from_path(file) 60 | .map_err(Error::InvalidOutputFile)? 61 | .generate_on(&program), 62 | _ => LlvmGenerator::new(stdout()).generate_on(&program), 63 | } 64 | .map_err(Error::Generate) 65 | } 66 | 67 | enum Error { 68 | InvalidArguments, 69 | InvalidInputFile(IoError), 70 | Parse, 71 | InvalidOutputFile(IoError), 72 | Generate(IoError), 73 | } 74 | 75 | impl fmt::Display for Error { 76 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 77 | match self { 78 | Error::InvalidArguments => write!( 79 | f, 80 | r#"Usage: koopac [INPUT] [-o OUTPUT] [-h|--help] 81 | 82 | Options: 83 | INPUT: input file, default to stdin 84 | OUTPUT: output file, default to stdout 85 | -h, --help: display this message"# 86 | ), 87 | Error::InvalidInputFile(e) => write!(f, "invalid input: {}", e), 88 | Error::Parse => Ok(()), 89 | Error::InvalidOutputFile(e) => write!(f, "invalid output: {}", e), 90 | Error::Generate(e) => write!(f, "I/O error: {}", e), 91 | } 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /koopac/src/reorder_alloc.rs: -------------------------------------------------------------------------------- 1 | use koopa::ir::{Function, FunctionData, ValueKind}; 2 | use koopa::opt::{FunctionPass, Pass}; 3 | 4 | /// A pass that reorders all allocations to the entry basic block. 5 | pub struct ReorderAlloc; 6 | 7 | impl ReorderAlloc { 8 | pub fn new_pass() -> Pass { 9 | Pass::Function(Box::new(Self)) 10 | } 11 | } 12 | 13 | impl FunctionPass for ReorderAlloc { 14 | fn run_on(&mut self, _: Function, data: &mut FunctionData) { 15 | // get the entry basic block 16 | let entry = match data.layout().entry_bb() { 17 | Some(bb) => bb, 18 | // skip function declarations 19 | _ => return, 20 | }; 21 | // get all allocations that are not in the entry basic block 22 | let alloc_bbs = data 23 | .dfg() 24 | .values() 25 | .iter() 26 | .filter_map(|(&v, value)| match value.kind() { 27 | ValueKind::Alloc(_) => { 28 | let bb = data.layout().parent_bb(v).unwrap(); 29 | (bb != entry).then_some((v, bb)) 30 | } 31 | _ => None, 32 | }) 33 | .collect::>(); 34 | for (alloc, bb) in alloc_bbs { 35 | // remove the allocation from the parent basic block 36 | data.layout_mut().bb_mut(bb).insts_mut().remove(&alloc); 37 | // insert at the beginning of the entry basic block 38 | let insts = data.layout_mut().bb_mut(entry).insts_mut(); 39 | insts.cursor_front_mut().insert_key_before(alloc).unwrap(); 40 | } 41 | } 42 | } 43 | --------------------------------------------------------------------------------