From 89847cfdb4036dca08966610e5147c58e45424bc Mon Sep 17 00:00:00 2001 From: xinyangli Date: Wed, 10 Apr 2024 20:12:41 +0800 Subject: [PATCH] feat(npc): difftest execution abstraction layer --- nemu/src/cpu/difftest/ref.c | 2 +- npc/LICENSE | 674 +++++++++++++++++++ npc/csrc/Flow/CMakeLists.txt | 2 +- npc/csrc/Flow/main.cpp | 70 +- npc/include/components.hpp | 8 - npc/include/difftest.hpp | 130 ---- npc/include/trm_difftest.hpp | 93 +++ npc/include/trm_interface.hpp | 139 ++++ npc/include/types.h | 13 +- npc/include/vl_wrapper.hpp | 3 +- npc/utils/CMakeLists.txt | 1 - npc/utils/disasm/CMakeLists.txt | 5 +- npc/utils/sdb/CMakeLists.txt | 9 +- npc/utils/{disasm => sdb}/disasm.cpp | 0 npc/utils/{disasm => sdb}/include/disasm.hpp | 0 npc/utils/sdb/include/sdb.hpp | 125 +--- npc/utils/sdb/sdb.cpp | 78 ++- 17 files changed, 1076 insertions(+), 276 deletions(-) create mode 100644 npc/LICENSE delete mode 100644 npc/include/difftest.hpp create mode 100644 npc/include/trm_difftest.hpp create mode 100644 npc/include/trm_interface.hpp rename npc/utils/{disasm => sdb}/disasm.cpp (100%) rename npc/utils/{disasm => sdb}/include/disasm.hpp (100%) diff --git a/nemu/src/cpu/difftest/ref.c b/nemu/src/cpu/difftest/ref.c index 7d59b4a..3f44732 100644 --- a/nemu/src/cpu/difftest/ref.c +++ b/nemu/src/cpu/difftest/ref.c @@ -25,7 +25,7 @@ __EXPORT void difftest_memcpy(paddr_t addr, void *buf, size_t n, if (direction == DIFFTEST_TO_REF) { memcpy(guest_to_host(addr), buf, n); } else { - assert(0); + memcpy(buf, guest_to_host(addr), n); } } diff --git a/npc/LICENSE b/npc/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/npc/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/npc/csrc/Flow/CMakeLists.txt b/npc/csrc/Flow/CMakeLists.txt index ad8d2e9..a50b3b6 100644 --- a/npc/csrc/Flow/CMakeLists.txt +++ b/npc/csrc/Flow/CMakeLists.txt @@ -1,6 +1,6 @@ include(ChiselBuild) add_executable(V${TOPMODULE} config.cpp main.cpp) -target_link_libraries(V${TOPMODULE} PRIVATE disasm sdb) +target_link_libraries(V${TOPMODULE} PRIVATE sdb) verilate(V${TOPMODULE} TRACE COVERAGE THREADS TOP_MODULE ${TOPMODULE} diff --git a/npc/csrc/Flow/main.cpp b/npc/csrc/Flow/main.cpp index b1c37c9..f2933b4 100644 --- a/npc/csrc/Flow/main.cpp +++ b/npc/csrc/Flow/main.cpp @@ -7,13 +7,19 @@ #include #include #include -#include +#include +#include #include +#include +#include #include using VlModule = VlModuleInterfaceCommon; using Registers = _RegistersVPI; +// SDB::SDB sdb_dut; +using CPUState = CPUStateBase; +CPUState npc_cpu; extern "C" { void *pmem_get() { static auto pmem = new Memory(config.memory_file, @@ -36,16 +42,21 @@ void pmem_write(int waddr, int wdata, char wmask) { } } -Disassembler d{"riscv32-pc-linux-gnu"}; - VlModule *top; Registers *regs; vpiHandle pc = nullptr; -void difftest_memcpy(paddr_t, void *, size_t, bool){}; -void difftest_regcpy(void *p, bool direction) { +namespace NPC { +void npc_memcpy(paddr_t addr, void *buf, size_t sz, bool direction) { + if (direction == TRM_FROM_MACHINE) { + memcpy(buf, static_cast *>(pmem_get())->mem.data(), + sz); + } +}; - if (direction == DIFFTEST_FROM_REF) { +void npc_regcpy(void *p, bool direction) { + + if (direction == TRM_FROM_MACHINE) { ((CPUState *)p)->pc = regs->get_pc(); for (int i = 0; i < 32; i++) { ((CPUState *)p)->reg[i] = (*regs)[i]; @@ -53,7 +64,7 @@ void difftest_regcpy(void *p, bool direction) { } } -void difftest_exec(uint64_t n) { +void npc_exec(uint64_t n) { while (n--) { for (int i = 0; i < 2; i++) { if (top->is_posedge()) { @@ -64,22 +75,38 @@ void difftest_exec(uint64_t n) { } } } -// std::cout << d.disassemble(top->rootp->Flow__DOT__pc__DOT__pc_reg, (uint8_t *)&top->rootp->Flow__DOT___ram_inst, 4) << std::endl; -void difftest_init(int port) { +void npc_init(int port) { // top = std::make_unique(config.do_trace, config.wavefile); top = new VlModule{config.do_trace, config.wavefile}; regs = new Registers("TOP.Flow.reg_0.regFile_", "TOP.Flow.pc.out"); top->reset_eval(10); } -DifftestInterface dut_interface = DifftestInterface{ - &difftest_memcpy, &difftest_regcpy, &difftest_exec, &difftest_init}; +class DutTrmInterface : public TrmInterface { +public: + DutTrmInterface(memcpy_t f_memcpy, regcpy_t f_regcpy, exec_t f_exec, + init_t f_init, void *cpu_state) + : TrmInterface{f_memcpy, f_regcpy, f_exec, f_init, cpu_state} {} + word_t at(std::string name) const override { + return ((CPUState *)cpu_state)->at(name); + } + + word_t at(paddr_t addr) const override { + word_t buf; + this->memcpy(addr, &buf, sizeof(word_t), TRM_FROM_MACHINE); + return buf; + } + void print(std::ostream &os) const override {} +}; + +DutTrmInterface npc_interface = + DutTrmInterface{&npc_memcpy, &npc_regcpy, &npc_exec, &npc_init, &npc_cpu}; +}; // namespace NPC -SDB::SDB sdb_dut; extern "C" { word_t reg_str2val(const char *name, bool *success) { - return sdb_dut.reg_str2val(name, success); + return npc_cpu.reg_str2val(name, success); } } @@ -88,20 +115,13 @@ int main(int argc, char **argv, char **env) { /* -- Difftest -- */ std::filesystem::path ref{config.lib_ref}; - DifftestInterface ref_interface = DifftestInterface{ref}; + RefTrmInterface ref_interface{ref}; + DifftestTrmInterface diff_interface{NPC::npc_interface, ref_interface, + pmem_get(), 128}; + SDB::SDB sdb_diff{diff_interface}; - Difftest> diff{dut_interface, ref_interface, - pmem_get(), 128}; int t = 8; - sdb_dut.main_loop(); - while (t--) { - if (!diff.step(1)) { - uint32_t pc = regs->get_pc(); - uint32_t inst = pmem_read(pc); - std::cout << diff << d.disassemble(pc, (uint8_t *)&inst, 4) << std::endl; - return EXIT_FAILURE; - } - } + sdb_diff.main_loop(); return 0; } diff --git a/npc/include/components.hpp b/npc/include/components.hpp index fced1af..9b5f546 100644 --- a/npc/include/components.hpp +++ b/npc/include/components.hpp @@ -11,14 +11,6 @@ #include #include -const std::map riscv32_regs_by_name{ - {"$0", 0}, {"ra", 1}, {"sp", 2}, {"gp", 3}, {"tp", 4}, {"t0", 5}, - {"t1", 6}, {"t2", 7}, {"s0", 8}, {"s1", 9}, {"a0", 10}, {"a1", 11}, - {"a2", 12}, {"a3", 13}, {"a4", 14}, {"a5", 15}, {"a6", 16}, {"a7", 17}, - {"s2", 18}, {"s3", 19}, {"s4", 20}, {"s5", 21}, {"s6", 22}, {"s7", 23}, - {"s8", 24}, {"s9", 25}, {"s10", 26}, {"s11", 27}, {"t3", 28}, {"t4", 29}, - {"t5", 30}, {"t6", 31}}; - template class _RegistersBase { std::array regs; T pc; diff --git a/npc/include/difftest.hpp b/npc/include/difftest.hpp deleted file mode 100644 index 7349004..0000000 --- a/npc/include/difftest.hpp +++ /dev/null @@ -1,130 +0,0 @@ -#ifndef _DIFFTEST_DIFFTEST_H_ -#define _DIFFTEST_DIFFTEST_H_ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -using paddr_t = uint32_t; -enum { DIFFTEST_FROM_REF, DIFFTEST_TO_REF }; - -struct DifftestInterface { - using memcpy_t = void (*)(paddr_t, void *, size_t, bool); - using regcpy_t = void (*)(void *, bool); - using exec_t = void (*)(uint64_t); - using init_t = void (*)(int); - std::function memcpy; - std::function regcpy; - std::function exec; - std::function init; - - DifftestInterface(memcpy_t memcpy, regcpy_t regcpy, exec_t exec, init_t init) - : memcpy(memcpy), regcpy(regcpy), exec(exec), init(init){}; - - // using fs = std::filesystem::path; - DifftestInterface(std::filesystem::path lib_file) { - void *handle = dlopen(lib_file.c_str(), RTLD_LAZY); - assert(handle != nullptr); - memcpy = (memcpy_t)dlsym(handle, "difftest_memcpy"); - assert(memcpy); - regcpy = (regcpy_t)dlsym(handle, "difftest_regcpy"); - assert(regcpy); - exec = (exec_t)dlsym(handle, "difftest_exec"); - assert(exec); - init = (init_t)dlsym(handle, "difftest_init"); - assert(init); - } -}; - -template class Difftest { - const DifftestInterface &ref; - std::unique_ptr ref_state; - const DifftestInterface &dut; - std::unique_ptr dut_state; - -public: - Difftest(const DifftestInterface &dut, const DifftestInterface &ref, - void *mem, size_t n, std::unique_ptr ref_state = nullptr, - std::unique_ptr dut_state = nullptr) - : ref(ref), dut(dut), ref_state(std::move(ref_state)), - dut_state(std::move(dut_state)) { - if (ref_state == nullptr) - this->ref_state = std::make_unique(); - if (dut_state == nullptr) - this->dut_state = std::make_unique(); - ref.init(0); - dut.init(0); - fetch_state(); - paddr_t reset_vector = 0x80000000; - ref.memcpy(reset_vector, mem, n, DIFFTEST_TO_REF); - dut.memcpy(reset_vector, mem, n, DIFFTEST_TO_REF); - }; - - void fetch_state() { - ref.regcpy(ref_state.get(), DIFFTEST_FROM_REF); - dut.regcpy(dut_state.get(), DIFFTEST_FROM_REF); - } - - bool step(uint64_t n) { - ref.exec(n); - dut.exec(n); - fetch_state(); - return *ref_state == *dut_state; - } - - friend std::ostream &operator<<(std::ostream &os, const Difftest &d) { - os << "REF state:\n" - << *d.ref_state << "DUT state:\n" - << *d.dut_state << std::endl; - return os; - } -}; - -template struct CPUStateBase { - R reg[nr_reg] = {0}; - paddr_t pc = 0x80000000; - static const std::map inline regs_by_name = - riscv32_regs_by_name; - CPUStateBase() { - for (int i = 0; i < nr_reg; i++) - reg[i] = 0; - } - bool operator==(const CPUStateBase &other) const { - if (pc != other.pc) - return false; - for (int i = 0; i < nr_reg; ++i) { - if (reg[i] != other.reg[i]) - return false; - } - return true; - } - bool operator!=(const CPUStateBase &other) const { - return !(*this == other); // Reuse the == operator for != implementation - } - - /* This does not update the register!!! */ - R at(std::string name) { return reg[regs_by_name.at(name)]; } -}; - -template -std::ostream &operator<<(std::ostream &os, const CPUStateBase &cpu) { - os << "PC: " << std::hex << cpu.pc << std::endl; - for (int i = 0; i < nr_reg; i++) { - os << "reg " << std::dec << std::setw(2) << i << ":" << std::hex - << std::setw(10) << cpu.reg[i]; - if (i % 4 == 3) { - os << std::endl; - } else { - os << " | "; - } - } - return os; -} - -#endif \ No newline at end of file diff --git a/npc/include/trm_difftest.hpp b/npc/include/trm_difftest.hpp new file mode 100644 index 0000000..dc75c4d --- /dev/null +++ b/npc/include/trm_difftest.hpp @@ -0,0 +1,93 @@ +#ifndef _DIFFTEST_DIFFTEST_H_ +#define _DIFFTEST_DIFFTEST_H_ +#include "disasm.hpp" +#include "types.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +Disassembler d{"riscv32-linux-pc-gnu"}; + +using paddr_t = uint32_t; +struct DifftestTrmInterface : public TrmInterface { + TrmInterface &dut; + TrmInterface &ref; + + DifftestTrmInterface(TrmInterface &dut, TrmInterface &ref, void *mem, + size_t mem_size) + : dut(dut), ref(ref) { + init = [this, mem, mem_size](int n) { + this->ref.init(n); + this->dut.init(n); + paddr_t reset_vector = 0x80000000; + this->ref.memcpy(reset_vector, mem, mem_size, TRM_TO_MACHINE); + this->dut.memcpy(reset_vector, mem, mem_size, TRM_TO_MACHINE); + fetch_state(); + }; + exec = [this](uint64_t n) { + while (n--) { + + word_t pc = this->ref.at("pc"); + word_t inst = this->ref.at(pc); + std::cout << d.disassemble(pc, (uint8_t *)&inst, WORD_BYTES) + << std::endl; + this->ref.exec(1); + this->dut.exec(1); + this->ref.fetch_state(); + this->dut.fetch_state(); + if (*(CPUState *)this->ref.cpu_state != + *(CPUState *)this->dut.cpu_state) { + throw std::runtime_error("Difftest failed"); + } + } + }; + + // NOTE: Different from normal Trm, we copy 2 * sizeof(CPUState) to/from p, + // which represents ref_state and dut state + regcpy = [this](void *p, bool direction) { + // this->ref.regcpy(p, direction); + // this->dut.regcpy(p, direction); + }; + + memcpy = [this](paddr_t paddr, void *p, size_t n, bool direction) { + this->dut.memcpy(paddr, p, n, direction); + this->ref.memcpy(paddr, (uint8_t *)p + n, n, direction); + }; + } + + word_t at(std::string name) const override { + if (name.empty()) { + throw std::runtime_error("Empty register name"); + } else if (name[0] == 'r') { + std::cout << name.substr(1) << std::endl; + this->ref.at(name.substr(1)); + } else if (name[0] == 'd') { + this->dut.at(name.substr(1)); + } else { + throw std::runtime_error("Register name provided to difftest interface " + "must start with r or d."); + } + return 0; + } + + word_t at(paddr_t addr) const override { + std::cout << ref.at(addr) << "\t" << dut.at(addr) << std::endl; + return dut.at(addr); + } + + void print(std::ostream &os) const override { + os << "REF state:\n" + << *(CPUState *)ref.cpu_state << "DUT state:\n" + << *(CPUState *)dut.cpu_state << std::endl; + } +}; +#endif \ No newline at end of file diff --git a/npc/include/trm_interface.hpp b/npc/include/trm_interface.hpp new file mode 100644 index 0000000..22a37cf --- /dev/null +++ b/npc/include/trm_interface.hpp @@ -0,0 +1,139 @@ +#ifndef _NPC_TRM_INTERFACE_HEADER_FILE_ +#define _NPC_TRM_INTERFACE_HEADER_FILE_ +#include +#include +#include +#include +#include +#include + +template struct CPUStateBase { + R reg[nr_reg] = {0}; + word_t pc = 0x80000000; + + static const std::map inline regs_by_name = + riscv32_regs_by_name; + CPUStateBase() { + for (int i = 0; i < nr_reg; i++) + reg[i] = 0; + } + + bool operator==(const CPUStateBase &other) const { + if (pc != other.pc) + return false; + for (int i = 0; i < nr_reg; ++i) { + if (reg[i] != other.reg[i]) + return false; + } + return true; + } + + bool operator!=(const CPUStateBase &other) const { + return !(*this == other); // Reuse the == operator for != implementation + } + + /* This does not update the register!!! */ + R at(std::string name) { + return name == "pc" ? pc : reg[regs_by_name.at(name)]; + } + + uint32_t reg_str2val(const char *name, bool *success) { + try { + *success = true; + return this->at(name); + } catch (std::runtime_error) { + *success = false; + return 0; + } + } +}; + +template +std::ostream &operator<<(std::ostream &os, const CPUStateBase &cpu) { + os << "PC: " << std::hex << cpu.pc << std::endl; + for (int i = 0; i < nr_reg; i++) { + os << "reg " << std::dec << std::setw(2) << i << ":" << std::hex + << std::setw(10) << cpu.reg[i]; + if (i % 4 == 3) { + os << std::endl; + } else { + os << " | "; + } + } + return os; +} + +using CPUState = CPUStateBase; + +enum { TRM_FROM_MACHINE, TRM_TO_MACHINE }; + +class TrmInterface { +protected: + using memcpy_t = void (*)(paddr_t, void *, size_t, bool); + using regcpy_t = void (*)(void *, bool); + using exec_t = void (*)(uint64_t); + using init_t = void (*)(int); + std::function regcpy; + +public: + std::function exec; + std::function init; + // TODO: paddr_t can probably changed to (void *)? + std::function memcpy; + // Managed by callee + void *cpu_state; + + TrmInterface() {} + TrmInterface(memcpy_t f_memcpy, regcpy_t f_regcpy, exec_t f_exec, + init_t f_init, void *cpu_state) + : memcpy(f_memcpy), regcpy(f_regcpy), exec(f_exec), init(f_init), + cpu_state(cpu_state) {} + + void fetch_state() { this->regcpy(cpu_state, TRM_FROM_MACHINE); } + void push_state() { this->regcpy(cpu_state, TRM_TO_MACHINE); } + virtual word_t at(std::string) const = 0; + virtual word_t at(word_t addr) const = 0; + virtual void print(std::ostream &os) const = 0; +}; + +struct RefTrmInterface : TrmInterface { + RefTrmInterface(std::filesystem::path lib_file) { + void *handle = dlopen(lib_file.c_str(), RTLD_LAZY); + if (handle == nullptr) { + throw std::runtime_error("Failed to open diff library file"); + }; + memcpy = (memcpy_t)dlsym(handle, "difftest_memcpy"); + if (handle == nullptr) { + throw std::runtime_error("Failed to find `difftest_memcpy`"); + }; + regcpy = (regcpy_t)dlsym(handle, "difftest_regcpy"); + if (handle == nullptr) { + throw std::runtime_error("Failed to find `difftest_regcpy`"); + }; + exec = (exec_t)dlsym(handle, "difftest_exec"); + if (handle == nullptr) { + throw std::runtime_error("Failed to find `difftest_exec`"); + }; + init = (init_t)dlsym(handle, "difftest_init"); + if (handle == nullptr) { + throw std::runtime_error("Failed to find `difftest_init`"); + }; + cpu_state = new CPUState{}; + } + + ~RefTrmInterface() { delete (CPUState *)cpu_state; } + + word_t at(std::string name) const override { + return ((CPUState *)cpu_state)->at(name); + } + + word_t at(paddr_t addr) const override { + word_t buf; + this->memcpy(addr, &buf, sizeof(word_t), TRM_FROM_MACHINE); + return buf; + } + + void print(std::ostream &os) const override { os << *(CPUState *)cpu_state; } +}; + +#endif \ No newline at end of file diff --git a/npc/include/types.h b/npc/include/types.h index f6a8d87..6f78cc1 100644 --- a/npc/include/types.h +++ b/npc/include/types.h @@ -8,6 +8,7 @@ static const word_t WORD_T_MAX = UINT32_MAX; static const sword_t SWORD_T_MAX = INT32_MAX; static const sword_t SWORD_T_MIN = INT32_MIN; #define WORD_BYTES 4 +#define REG_COUNT 32 #define FMT_WORD "0x%08x" typedef uint32_t vaddr_t; @@ -16,8 +17,16 @@ typedef uint32_t paddr_t; typedef uint16_t ioaddr_t; #ifdef __cplusplus -#include -using CPUState = CPUStateBase; +#include +#include + +const std::map riscv32_regs_by_name{ + {"$0", 0}, {"ra", 1}, {"sp", 2}, {"gp", 3}, {"tp", 4}, {"t0", 5}, + {"t1", 6}, {"t2", 7}, {"s0", 8}, {"s1", 9}, {"a0", 10}, {"a1", 11}, + {"a2", 12}, {"a3", 13}, {"a4", 14}, {"a5", 15}, {"a6", 16}, {"a7", 17}, + {"s2", 18}, {"s3", 19}, {"s4", 20}, {"s5", 21}, {"s6", 22}, {"s7", 23}, + {"s8", 24}, {"s9", 25}, {"s10", 26}, {"s11", 27}, {"t3", 28}, {"t4", 29}, + {"t5", 30}, {"t6", 31}}; #endif #endif \ No newline at end of file diff --git a/npc/include/vl_wrapper.hpp b/npc/include/vl_wrapper.hpp index 4d42b55..b84d745 100644 --- a/npc/include/vl_wrapper.hpp +++ b/npc/include/vl_wrapper.hpp @@ -19,8 +19,7 @@ public: ~Tracer() { m_trace->close(); } /** - * Dump signals to waveform file. Must be called once after every top->eval() - * call. + * @brief: Dump signals to waveform file. Must be called once after every top->eval() call. */ void update() { m_trace->dump(cycle++); } }; diff --git a/npc/utils/CMakeLists.txt b/npc/utils/CMakeLists.txt index 017313c..d61f3d8 100644 --- a/npc/utils/CMakeLists.txt +++ b/npc/utils/CMakeLists.txt @@ -1,4 +1,3 @@ -add_subdirectory(disasm) if (ENABLE_SDB) add_subdirectory(sdb) endif() diff --git a/npc/utils/disasm/CMakeLists.txt b/npc/utils/disasm/CMakeLists.txt index e019bf7..8b13789 100644 --- a/npc/utils/disasm/CMakeLists.txt +++ b/npc/utils/disasm/CMakeLists.txt @@ -1,4 +1 @@ -add_library(disasm disasm.cpp) -target_include_directories(disasm PUBLIC include) -llvm_map_components_to_libnames(LLVM_LIBS ${LLVM_TARGETS_TO_BUILD}) -target_link_libraries(disasm PUBLIC ${LLVM_LIBS}) + diff --git a/npc/utils/sdb/CMakeLists.txt b/npc/utils/sdb/CMakeLists.txt index 6b1cb2c..240dbac 100644 --- a/npc/utils/sdb/CMakeLists.txt +++ b/npc/utils/sdb/CMakeLists.txt @@ -4,11 +4,14 @@ find_package(BISON REQUIRED) set(PARSER_DIR "${CMAKE_CURRENT_BINARY_DIR}") set(LEXER_OUT "${PARSER_DIR}/lexer.c") set(PARSER_OUT "${PARSER_DIR}/parser.c") -flex_target(LEXER addrexp.l "${LEXER_OUT}" DEFINES_FILE "${PARSER_DIR}/addrexp_lex.h") -bison_target(PARSER addrexp.y "${PARSER_OUT}" DEFINES_FILE "${PARSER_DIR}/addrexp.h") +flex_target(LEXER addrexp.l "${LEXER_OUT}" DEFINES_FILE "${PARSER_DIR}/include/addrexp_lex.h") +bison_target(PARSER addrexp.y "${PARSER_OUT}" DEFINES_FILE "${PARSER_DIR}/include/addrexp.h") add_flex_bison_dependency(LEXER PARSER) -add_library(sdb sdb.cpp console.cpp "${LEXER_OUT}" "${PARSER_OUT}") +add_library(sdb sdb.cpp console.cpp disasm.cpp "${LEXER_OUT}" "${PARSER_OUT}") +llvm_map_components_to_libnames(LLVM_LIBS ${LLVM_TARGETS_TO_BUILD}) +target_link_libraries(sdb PUBLIC ${LLVM_LIBS}) target_link_libraries(sdb PRIVATE ${Readline_LIBRARY}) +target_include_directories(sdb PRIVATE ${PARSER_DIR}/include) target_include_directories(sdb PRIVATE ${Readline_INCLUDE_DIR}) target_include_directories(sdb PUBLIC include) diff --git a/npc/utils/disasm/disasm.cpp b/npc/utils/sdb/disasm.cpp similarity index 100% rename from npc/utils/disasm/disasm.cpp rename to npc/utils/sdb/disasm.cpp diff --git a/npc/utils/disasm/include/disasm.hpp b/npc/utils/sdb/include/disasm.hpp similarity index 100% rename from npc/utils/disasm/include/disasm.hpp rename to npc/utils/sdb/include/disasm.hpp diff --git a/npc/utils/sdb/include/sdb.hpp b/npc/utils/sdb/include/sdb.hpp index 18aae8a..54ec69b 100644 --- a/npc/utils/sdb/include/sdb.hpp +++ b/npc/utils/sdb/include/sdb.hpp @@ -3,9 +3,9 @@ #include #include -#include #include #include +#include #include namespace cr = CppReadline; @@ -13,122 +13,53 @@ using ret = cr::Console::ReturnCode; namespace SDB { -enum SDBStatus { - SDB_SUCCESS, - SDB_WRONG_ARGUMENT, -}; +enum SDBStatus { SDB_SUCCESS, SDB_WRONG_ARGUMENT, SDB_DIFFTEST_FAILED }; + +class SDBHandlers; struct Handler { const std::vector names; - cr::Console::CommandFunction f; + // cr::Console::CommandFunction f; + std::function f; }; -template class _SDBHandlers { - using CPUState = CPUStateBase; - +class SDBHandlers { private: - std::vector all_handlers; + const TrmInterface &funcs; + std::vector all_handlers = { + Handler{{"c", "continue"}, &SDBHandlers::cmd_continue}, + Handler{{"si", "step-instruction"}, &SDBHandlers::cmd_step}, + Handler{{"info-r"}, &SDBHandlers::cmd_info_registers}, + Handler{{"p", "print"}, &SDBHandlers::cmd_print}, + }; + int cmd_continue(const cr::Console::Arguments &input); + int cmd_step(const std::vector &input); + int cmd_info_registers(const std::vector &input); + int cmd_print(const std::vector &input); public: - static CPUState cpu; - -private: - static _SDBHandlers *instance; - static int cmd_continue(const cr::Console::Arguments &input); - static int cmd_step(const std::vector &input); - static int cmd_info_registers(const std::vector &input); - static int cmd_print(const std::vector &input); - _SDBHandlers(std::vector all_handlers) - : all_handlers(all_handlers){}; - -public: - _SDBHandlers(const _SDBHandlers &) = delete; - _SDBHandlers operator=(const _SDBHandlers &) = delete; - - static _SDBHandlers *getInstance() { - if (instance == nullptr) { - std::vector all_handlers{ - Handler{{"c", "continue"}, &_SDBHandlers::cmd_continue}, - Handler{{"si", "step-instruction"}, &_SDBHandlers::cmd_step}, - }; - instance = new _SDBHandlers(all_handlers); - } - return instance; - } - + SDBHandlers(const TrmInterface &funcs) : funcs(funcs){}; void registerHandlers(cr::Console *c); }; -template -_SDBHandlers *_SDBHandlers::instance = nullptr; - -template -CPUState _SDBHandlers::cpu = CPUState(); - -template -int _SDBHandlers::cmd_continue(const cr::Console::Arguments &input) { - if (input.size() > 1) - return SDB_WRONG_ARGUMENT; - funcs.exec(-1); - return SDB_SUCCESS; -} - -template -int _SDBHandlers::cmd_step(const std::vector &input) { - if (input.size() > 2) { - return SDB_WRONG_ARGUMENT; - } - uint64_t step_count = input.size() == 2 ? std::stoull(input[1]) : 1; - funcs.exec(step_count); - return SDB_SUCCESS; -} - -template -int _SDBHandlers::cmd_info_registers( - const std::vector &input) { - if (input.size() > 1) - return SDB_WRONG_ARGUMENT; - std::cout << _SDBHandlers::getInstance()->cpu << std::endl; - return SDB_SUCCESS; -} - -template -int _SDBHandlers::cmd_print(const std::vector &input) { - exit(1); -} - -template -void _SDBHandlers::registerHandlers(cr::Console *c) { - for (auto &h : this->all_handlers) { - for (auto &name : h.names) { - c->registerCommand(name, h.f); - } - } -} - -template class SDB { +class SDB { private: std::unique_ptr c; - using SDBHandlers = _SDBHandlers; + const TrmInterface &funcs; + SDBHandlers handlers; public: - SDB(std::string const &greeting = "\033[1;34m(npc)\033[0m ") { + SDB(const TrmInterface &funcs, + std::string const &greeting = "\033[1;34m(npc)\033[0m ") + : handlers(SDBHandlers{funcs}), funcs(funcs) { c = std::make_unique(greeting); - SDBHandlers::getInstance()->registerHandlers(c.get()); - }; - word_t reg_str2val(const char *name, bool *success) { - try { - *success = true; - return SDBHandlers::getInstance()->cpu.at(name); - } catch (std::runtime_error) { - *success = false; - return 0; - } - } + handlers.registerHandlers(c.get()); + }; int main_loop() { int retCode; + funcs.init(0); do { retCode = c->readLine(); // We can also change the prompt based on last return value: diff --git a/npc/utils/sdb/sdb.cpp b/npc/utils/sdb/sdb.cpp index 9bfa6b5..61c8853 100644 --- a/npc/utils/sdb/sdb.cpp +++ b/npc/utils/sdb/sdb.cpp @@ -1,10 +1,84 @@ #include #include -#include +#include #include +#include +#include #include +extern "C" { +#include +#include +} namespace cr = CppReadline; using ret = cr::Console::ReturnCode; -namespace SDB {} +std::ostream &operator<<(std::ostream &os, const TrmInterface &d) { + d.print(os); + return os; +}; + +namespace SDB { + +int SDBHandlers::cmd_continue(const cr::Console::Arguments &input) { + if (input.size() > 1) + return SDB_WRONG_ARGUMENT; + this->funcs.exec(-1); + return SDB_SUCCESS; +} + +int SDBHandlers::cmd_step(const std::vector &input) { + if (input.size() > 2) { + return SDB_WRONG_ARGUMENT; + } + uint64_t step_count = input.size() == 2 ? std::stoull(input[1]) : 1; + try { + this->funcs.exec(step_count); + } catch (std::runtime_error) { + std::cout << "Difftest Failed" << std::endl << funcs << std::endl; + return SDB_DIFFTEST_FAILED; + } + // std::cout << funcs << std::endl; + return SDB_SUCCESS; +} + +int SDBHandlers::cmd_info_registers(const std::vector &input) { + if (input.size() > 1) + return SDB_WRONG_ARGUMENT; + std::cout << this->funcs << std::endl; + return SDB_SUCCESS; +} + +word_t parse_expr(const char *arg) { + if (arg == NULL) { + puts("Invalid expr argument."); + return 0; + } else { + word_t res; + yy_scan_string(arg); + yyparse(&res); + yylex_destroy(); + return res; + } +} + +int SDBHandlers::cmd_print(const std::vector &input) { + word_t buf[2]; + word_t addr = parse_expr(input[1].c_str()); + this->funcs.memcpy(addr, &buf, sizeof(word_t), TRM_FROM_MACHINE); + // TODO: Difftest only + std::cout << std::hex << "dut: 0x" << buf[0] << ' ' << "ref: 0x" << buf[1] + << std::dec << std::endl; + return SDB_SUCCESS; +} + +void SDBHandlers::registerHandlers(cr::Console *c) { + for (auto &h : this->all_handlers) { + for (auto &name : h.names) { + std::function)> f{ + std::bind(h.f, this, std::placeholders::_1)}; + c->registerCommand(name, f); + } + } +} +} // namespace SDB