diff options
author | bd <bdunaisky@umass.edu> | 2025-04-21 20:00:58 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2025-04-21 20:00:58 +0000 |
commit | d933a0405b7a7dff3cf05839ac99d120cafa4d75 (patch) | |
tree | 43238110a03ce678f1a68b0b4175ae023527b070 | |
parent | cdc9d9c6195cf51e2d1ff10ff4f29797d3e51691 (diff) | |
parent | 7cad6f05ebed25557fe6a31bfdf6290c72506868 (diff) |
Merge pull request #57 from bdunahu/bdunahu
Initialize all pipe objects at once, thread safety,
50 files changed, 2827 insertions, 1065 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <https://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<https://www.gnu.org/licenses/>. + + 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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/gui/CMakeLists.txt b/gui/CMakeLists.txt index 0d73527..2c48beb 100644 --- a/gui/CMakeLists.txt +++ b/gui/CMakeLists.txt @@ -21,7 +21,7 @@ file(GLOB SRCS qt_add_resources(GUI_RESOURCES "resources.qrc") add_executable(risc_vector ${SRCS} ${GUI_RESOURCES}) -target_include_directories(${PROJECT_NAME} PRIVATE ${PROJECT_SOURCE_DIR}/inc) +target_include_directories(${PROJECT_NAME} PRIVATE ${PROJECT_SOURCE_DIR}/inc ${PROJECT_SOURCE_DIR}/gui) target_link_libraries(${PROJECT_NAME} PRIVATE ${PROJECT_NAME}_lib ram_lib Qt6::Widgets) set_target_properties(risc_vector PROPERTIES diff --git a/gui/digitlabel.cc b/gui/digitlabel.cc new file mode 100644 index 0000000..8314943 --- /dev/null +++ b/gui/digitlabel.cc @@ -0,0 +1,52 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + +#include "digitlabel.h" +#include "gui.h" + +DigitLabel::DigitLabel(QWidget *parent) : QLabel(parent) { setText(QString()); } + +void DigitLabel::clear() +{ + this->is_cleared = true; + setText(QString()); +} + +void DigitLabel::set_value(int v) +{ + this->is_cleared = false; + this->v = v; + update_display(); +} + +void DigitLabel::on_hex_toggle(bool is_hex) +{ + this->is_hex = is_hex; + update_display(); +} + +void DigitLabel::update_display() +{ + QString t; + if (this->is_cleared) { + setText(QString()); + } else { + t = (this->is_hex) ? QString::number(this->v, 16).toUpper() + : QString::number(this->v); + setText(t); + } +} diff --git a/gui/digitlabel.h b/gui/digitlabel.h new file mode 100644 index 0000000..68b01cb --- /dev/null +++ b/gui/digitlabel.h @@ -0,0 +1,69 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + +#ifndef DIGITLABEL_H +#define DIGITLABEL_H + +#include <QLabel> + +class DigitLabel : public QLabel +{ + Q_OBJECT + + public: + /** + * Constructor. + * @return a newly allocated DigitLabel. + */ + explicit DigitLabel(QWidget *parent); + + /** + * Sets the empty flag. + */ + void clear(); + /** + * @param the value to set `this->v' with. + */ + void set_value(int v); + + public slots: + /** + * Toggles the base this label displays in, by setting `this->is_hex'. + */ + void on_hex_toggle(bool is_hex); + + private: + /** + * Refreshes the display of this label, taking base into consideration.. + */ + void update_display(); + + /** + * The decimal value associated with this label. + */ + int v; + /** + * If this digit should display in hexidecinmal. + */ + int is_hex; + /** + * If this digit should not display. + */ + bool is_cleared = true; +}; + +#endif // DIGITLABEL_H diff --git a/gui/dynamicwaysentry.cc b/gui/dynamicwaysentry.cc new file mode 100644 index 0000000..e1f740e --- /dev/null +++ b/gui/dynamicwaysentry.cc @@ -0,0 +1,99 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + +#include "dynamicwaysentry.h" +#include <QLabel> +#include <QLineEdit> +#include <QStringList> +#include <QVBoxLayout> +#include <QVector> +#include <QWidget> + +DynamicWaysEntry::DynamicWaysEntry(QWidget *parent) : QWidget(parent) +{ + this->l = new QVBoxLayout(this); + this->l->setAlignment(Qt::AlignTop); + this->l->setSpacing(6); + this->l->setContentsMargins(0, 0, 0, 0); + this->setLayout(l); + this->add_field(); +} + +QStringList DynamicWaysEntry::get_entries() const { return this->entries; } + +int DynamicWaysEntry::parse_valid_way(QString t) +{ + bool s; + int i; + i = t.toInt(&s); + return (s && i >= 0 && 5 > i) ? i : -1; +} + +// TODO if you enter something valid and then make it invalid, +// the next box still shows +void DynamicWaysEntry::on_number_enter(const QString &t) +{ + int i; + QLineEdit *sender_field; + + sender_field = qobject_cast<QLineEdit *>(sender()); + i = fields.indexOf(sender_field); + entries[i] = t; + + if (i == this->fields.size() - 1 && !t.isEmpty() && + (this->parse_valid_way(t) > 0) && fields.size() < 4) + add_field(); + + // TODO, unlink, don't trash everything after + if (t.isEmpty()) { + while (this->fields.size() > i + 1) { + remove_last_field(); + } + while (entries.size() > fields.size()) { + entries.removeLast(); + } + } +} + +void DynamicWaysEntry::add_field() +{ + QLineEdit *f; + + f = new QLineEdit(this); + f->setPlaceholderText("# ways (a power of 2)"); + + this->l->addWidget(f);; + this->fields.append(f); + this->entries.append(QString()); + connect( + f, &QLineEdit::textChanged, this, &DynamicWaysEntry::on_number_enter); +} + +void DynamicWaysEntry::remove_last_field() +{ + QLineEdit *f; + + if (this->fields.isEmpty()) + return; + + f = this->fields.takeLast(); + this->l->removeWidget(f); + f->deleteLater(); + + if (!this->entries.isEmpty()) + entries.removeLast(); +} diff --git a/gui/dynamicwaysentry.h b/gui/dynamicwaysentry.h new file mode 100644 index 0000000..26b8b3e --- /dev/null +++ b/gui/dynamicwaysentry.h @@ -0,0 +1,51 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + +#ifndef DYNAMICWAYSENTRY_H +#define DYNAMICWAYSENTRY_H + + +#include <QLineEdit> +#include <QStringList> +#include <QVBoxLayout> +#include <QVector> +#include <QWidget> + +class DynamicWaysEntry : public QWidget +{ + public: + DynamicWaysEntry(QWidget *parent = nullptr); + QStringList get_entries() const; + /** + * Parses a string from this entry field, if it is valid. + * @param a string + * @param -1 if the string is not suitable as a way, an integer compatible + * with the cache constructor otherwise. + */ + int parse_valid_way(QString t); + private slots: + void on_number_enter(const QString &t); + + private: + QVBoxLayout *l; + QVector<QLineEdit *> fields; + QStringList entries; + void add_field(); + void remove_last_field(); +}; + +#endif // DYNAMICWAYSENTRY_H @@ -1,361 +1,395 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "gui.h" #include "./ui_gui.h" -// #include "byteswap.h" +#include "dynamicwaysentry.h" +#include "messages.h" +#include <QPixmap> +#include <QString> -GUI::GUI(QWidget *parent) - : QMainWindow(parent) - , ui(new Ui::GUI) +GUI::GUI(QWidget *parent) : QMainWindow(parent), ui(new Ui::GUI) { - ui->setupUi(this); - - ui->enabl_cache_checkbox->setChecked(true); - ui->enable_pipeline_checkbox->setChecked(true); + ui->setupUi(this); - worker = new Worker(); - worker->moveToThread(&workerThread); + /* setup the status bar */ + ui->statusBar->setFixedHeight(20); - // Connect worker thread lifecycle - connect(&workerThread, &QThread::started, worker, &Worker::doWork); + this->avatar = new QLabel(this); + this->status_label = new QLabel("", this); + QLabel *risc_vector = + new QLabel("RISC V[ECTOR], CS535 UMASS AMHERST", this); - // Display clock cycles and PC - connect(worker, &Worker::clock_cycles, this, &GUI::onWorkerClockCycles); + avatar->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed); + avatar->setObjectName("avatar_label"); + status_label->setObjectName("msg_label"); + risc_vector->setObjectName("info_label"); + ui->statusBar->setSizeGripEnabled(false); - connect(worker, &Worker::if_info, this, &GUI::onWorkerFetchInfo); + this->set_status(get_waiting, "idle.png"); + ui->statusBar->addWidget(avatar); + ui->statusBar->addWidget(status_label); + ui->statusBar->addPermanentWidget(risc_vector); - connect(worker, &Worker::id_info, this, &GUI::onWorkerDecodeInfo); + worker = new Worker(); + worker->moveToThread(&workerThread); - connect(worker, &Worker::ex_info, this, &GUI::onWorkerExecuteInfo); + // find all the labels + QList<DigitLabel*> labels = this->findChildren<DigitLabel*>(); + for (DigitLabel* label : labels) { + connect(this, &GUI::hex_toggled, label, &DigitLabel::on_hex_toggle); + } + emit this->hex_toggled(this->is_hex); - connect(worker, &Worker::mm_info, this, &GUI::onWorkerMemoryInfo); + // display clock cycles and PC + connect(worker, &Worker::clock_cycles, this, &GUI::on_worker_refresh_gui); - connect(worker, &Worker::wb_info, this, &GUI::onWorkerWriteBackInfo); + connect(worker, &Worker::if_info, this, &GUI::onWorkerFetchInfo); - // Display dram - connect(worker, &Worker::dram_storage, this, &GUI::onWorkerShowDram); + connect(worker, &Worker::id_info, this, &GUI::onWorkerDecodeInfo); - // Display cache - connect(worker, &Worker::cache_storage, this, &GUI::onWorkerShowCache); + connect(worker, &Worker::ex_info, this, &GUI::onWorkerExecuteInfo); - // Display registers - connect(worker, &Worker::register_storage, this, &GUI::onWorkerShowRegisters); + connect(worker, &Worker::mm_info, this, &GUI::onWorkerMemoryInfo); - // Refresh DRAM from worker thread - connect(this, &GUI::sendRefreshDram, worker, &Worker::refreshDram, Qt::QueuedConnection); + connect(worker, &Worker::wb_info, this, &GUI::onWorkerWriteBackInfo); - // Load program from worker thread - connect(this, &GUI::sendLoadProgram, worker, &Worker::loadProgram, Qt::QueuedConnection); + // Display dram + connect(worker, &Worker::dram_storage, this, &GUI::onWorkerShowDram); - // Configure pipeline - connect(this, &GUI::sendConfigure, worker, &Worker::configure, Qt::QueuedConnection); + // Display cache + connect(worker, &Worker::cache_storage, this, &GUI::onWorkerShowCache); - // Refresh Cache from worker thread - connect(this, &GUI::sendRefreshCache, worker, &Worker::refreshCache, Qt::QueuedConnection); + // Display registers + connect( + worker, &Worker::register_storage, this, &GUI::onWorkerShowRegisters); - // Refresh Registers from worker thread - connect(this, &GUI::sendRefreshRegisters, worker, &Worker::refreshRegisters, Qt::QueuedConnection); + // Configure pipeline + connect( + this, &GUI::sendConfigure, worker, &Worker::configure, + Qt::QueuedConnection); - // Advance controller by #steps - connect(this, &GUI::sendRunSteps, worker, &Worker::runSteps, Qt::QueuedConnection); + // Advance controller by some steps + connect( + this, &GUI::sendRunSteps, worker, &Worker::runSteps, + Qt::QueuedConnection); - // Advance controller by 1 step - connect(this, &GUI::sendRunStep, worker, &Worker::runStep, Qt::QueuedConnection); + // Update the step button with step amount + connect(ui->step_slider, &QSlider::valueChanged, this, [=](int index) { + int value = step_values[index]; + ui->step_btn->setText(QString("Step %1").arg(value)); + }); - // Proper cleanup when worker finishes - connect(worker, &Worker::finished, this, &GUI::onWorkerFinished); - connect(worker, &Worker::finished, &workerThread, &QThread::quit); - connect(&workerThread, &QThread::finished, worker, &QObject::deleteLater); + // Proper cleanup when worker finishes + connect(worker, &Worker::finished, this, &GUI::onWorkerFinished); + connect(worker, &Worker::finished, &workerThread, &QThread::quit); + connect(&workerThread, &QThread::finished, worker, &QObject::deleteLater); - workerThread.start(); // Start the worker thread + workerThread.start(); // Start the worker thread } GUI::~GUI() { - workerThread.quit(); - workerThread.wait(); // Ensure proper cleanup - delete ui; + workerThread.quit(); + workerThread.wait(); // Ensure proper cleanup + delete ui; } -void displayArrayHTML(QTextEdit *textEdit, const std::array<int, GPR_NUM> &data) { - textEdit->setReadOnly(false); - QString tableText = "<table border='1' cellspacing='0' cellpadding='8' style='border-collapse: collapse; width: 100%; border: 2px solid black;'>"; - - tableText += "<tr>"; - int index = 0; - for (int value : data) { - tableText += QString("<td align='center' style='border: 2px solid black; min-width: 60px; padding: 10px;'>" - "%1 <sup style='font-size: 10px; font-weight: bold; color: black;'>%2</sup>" - "</td>") - .arg(QString::asprintf("%04X", value)) - .arg(index); - index++; - } - tableText += "</tr>"; - tableText += "</table>"; - - textEdit->setHtml(tableText); - textEdit->setReadOnly(true); -} - -void displayTableHTML(QTextEdit *textEdit, const std::vector<std::array<signed int, LINE_SIZE>> &data) { - textEdit->setReadOnly(false); - QString tableText = "<table border='1' cellspacing='0' cellpadding='8' style='border-collapse: collapse; width: 100%; border: 2px solid black;'>"; - - int index = 0; - for (const auto &row : data) { - tableText += "<tr>"; - for (signed int value : row) { - tableText += QString("<td align='center' style='border: 2px solid black; min-width: 60px; padding: 10px;'>" - "%1 <sup style='font-size: 10px; font-weight: bold; color: black;'>%2</sup>" - "</td>") - .arg(QString::asprintf("%04X", value)) - .arg(index); - index++; - } - tableText += "</tr>"; - } - - tableText += "</table>"; - - textEdit->setHtml(tableText); - textEdit->setReadOnly(true); +void displayArrayHTML(QTextEdit *textEdit, const std::array<int, GPR_NUM> &data) +{ + textEdit->setReadOnly(false); + QString tableText = "<table border='1' cellspacing='0' cellpadding='8' " + "style='border-collapse: collapse; width: 100%; " + "border: 2px solid black;'>"; + + tableText += "<tr>"; + int index = 0; + for (int value : data) { + tableText += QString("<td align='center' style='border: 2px solid " + "black; min-width: 60px; padding: 10px;'>" + "%1 <sup style='font-size: 10px; font-weight: " + "bold; color: black;'>%2</sup>" + "</td>") + .arg(QString::asprintf("%04X", value)) + .arg(index); + index++; + } + tableText += "</tr>"; + tableText += "</table>"; + + textEdit->setHtml(tableText); + textEdit->setReadOnly(true); } -std::vector<signed int> browseAndRetrieveFile(QWidget* parent) { - QString filePath = QFileDialog::getOpenFileName(parent, "Open Binary File", QDir::homePath(), "Binary Files (*.bin *.rv);;All Files (*.*)"); - std::vector<signed int> program; - - - if (filePath.isEmpty()) return program; - - QFile file(filePath); - if (!file.open(QIODevice::ReadOnly)) { - QMessageBox::critical(parent, "File Upload", "Unable to open file!"); - return program; - } - - while (!file.atEnd()) { - char bytes[4]; - if (file.read(bytes, 4) == 4) { - uint32_t word = - (static_cast<uint8_t>(bytes[0]) << 24) | - (static_cast<uint8_t>(bytes[1]) << 16) | - (static_cast<uint8_t>(bytes[2]) << 8) | - (static_cast<uint8_t>(bytes[3])); - - program.push_back(static_cast<signed int>(word)); - } - } - - file.close(); - return program; +void displayTableHTML( + QTextEdit *textEdit, + const std::vector<std::array<signed int, LINE_SIZE>> &data) +{ + textEdit->setReadOnly(false); + QString tableText = "<table border='1' cellspacing='0' cellpadding='8' " + "style='border-collapse: collapse; width: 100%; " + "border: 2px solid black;'>"; + + int index = 0; + for (const auto &row : data) { + tableText += "<tr>"; + for (signed int value : row) { + tableText += QString("<td align='center' style='border: 2px solid " + "black; min-width: 60px; padding: 10px;'>" + "%1 <sup style='font-size: 10px; font-weight: " + "bold; color: black;'>%2</sup>" + "</td>") + .arg(QString::asprintf("%04X", value)) + .arg(index); + index++; + } + tableText += "</tr>"; + } + + tableText += "</table>"; + + textEdit->setHtml(tableText); + textEdit->setReadOnly(true); } -void GUI::onWorkerClockCycles(int cycles, int pc) { - QFont font = ui->cycles_label->font(); - font.setBold(true); - font.setItalic(true); - font.setPointSize(14); - ui->cycles_label->setFont(font); - ui->cycles_label->setText("Clock Cycles: " + QString::number(cycles) + "\t\t" + "PC: " + QString::number(pc)); +void GUI::on_worker_refresh_gui(int cycles, int pc) +{ + ui->p_counter->set_value(pc); + ui->cycle_counter->set_value(cycles); } -void GUI::onWorkerFetchInfo(const std::vector<int> info) { - //QString::asprintf("%04X", value) - if(!info.empty()) { - ui->fetch_pc->setText(QString::number(info[0])); - ui->fetch_instruction_bits->setText(QString::asprintf("%04X", info[1])); - } else { - ui->fetch_pc->clear(); - ui->fetch_instruction_bits->clear(); - } +void GUI::onWorkerFetchInfo(const std::vector<int> info) +{ + if (!info.empty()) { + ui->fetch_squashed->setText(QString::number(info[0])); + ui->fetch_bits->set_value(info[1]); + } else { + ui->fetch_squashed->clear(); + ui->fetch_bits->clear(); + } } -void GUI::onWorkerDecodeInfo(const std::vector<int> info) { - if(!info.empty()) { - // ui->decode_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); - ui->decode_pc->setText(QString::number(info[0])); - ui->decode_s1->setText(QString::asprintf("%04X", info[1])); - // ui->decode_s2->setText(QString::asprintf("%04X", info[3])); - // ui->decode_s3->setText(QString::asprintf("%04X", info[4])); - } else { - // ui->decode_mnemonic->clear(); - ui->decode_pc->clear(); - ui->decode_s1->clear(); - // ui->decode_s2->clear(); - // ui->decode_s3->clear(); - } +void GUI::onWorkerDecodeInfo(const std::vector<int> info) +{ + if (!info.empty()) { + ui->decode_squashed->setText(QString::number(info[0])); + ui->decode_bits->set_value(info[1]); + } else { + ui->decode_squashed->clear(); + ui->decode_bits->clear(); + } } -void GUI::onWorkerExecuteInfo(const std::vector<int> info) { - if(!info.empty()) { - ui->execute_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); - ui->execute_pc->setText(QString::number(info[1])); - ui->execute_s1->setText(QString::asprintf("%04X", info[2])); - ui->execute_s2->setText(QString::asprintf("%04X", info[3])); - ui->execute_s3->setText(QString::asprintf("%04X", info[4])); - } else { - ui->execute_mnemonic->clear(); - ui->execute_pc->clear(); - ui->execute_s1->clear(); - ui->execute_s2->clear(); - ui->execute_s3->clear(); - } +void GUI::onWorkerExecuteInfo(const std::vector<int> info) +{ + if (!info.empty()) { + ui->execute_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); + ui->execute_squashed->setText(QString::number(info[1])); + ui->execute_s1->set_value(info[2]); + ui->execute_s2->set_value(info[3]); + ui->execute_s3->set_value(info[4]); + } else { + ui->execute_mnemonic->clear(); + ui->execute_squashed->clear(); + ui->execute_s1->clear(); + ui->execute_s2->clear(); + ui->execute_s3->clear(); + } } -void GUI::onWorkerMemoryInfo(const std::vector<int> info) { - if(!info.empty()) { - ui->memory_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); - ui->memory_pc->setText(QString::number(info[1])); - ui->memory_s1->setText(QString::asprintf("%04X", info[2])); - ui->memory_s2->setText(QString::asprintf("%04X", info[3])); - ui->memory_s3->setText(QString::asprintf("%04X", info[4])); - } else { - ui->memory_mnemonic->clear(); - ui->memory_pc->clear(); - ui->memory_s1->clear(); - ui->memory_s2->clear(); - ui->memory_s3->clear(); - } +void GUI::onWorkerMemoryInfo(const std::vector<int> info) +{ + if (!info.empty()) { + std::cout << "this " << info[3] << std::endl; + ui->memory_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); + ui->memory_squashed->setText(QString::number(info[1])); + ui->memory_s1->set_value(info[2]); + ui->memory_s2->set_value(info[3]); + ui->memory_s3->set_value(info[4]); + } else { + ui->memory_mnemonic->clear(); + ui->memory_squashed->clear(); + ui->memory_s1->clear(); + ui->memory_s2->clear(); + ui->memory_s3->clear(); + } } -void GUI::onWorkerWriteBackInfo(const std::vector<int> info) { - if(!info.empty()) { - ui->wb_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); - ui->wb_pc->setText(QString::number(info[1])); - ui->wb_s1->setText(QString::asprintf("%04X", info[2])); - ui->wb_s2->setText(QString::asprintf("%04X", info[3])); - ui->wb_s3->setText(QString::asprintf("%04X", info[4])); - } else { - ui->wb_mnemonic->clear(); - ui->wb_pc->clear(); - ui->wb_s1->clear(); - ui->wb_s2->clear(); - ui->wb_s3->clear(); - } +void GUI::onWorkerWriteBackInfo(const std::vector<int> info) +{ + if (!info.empty()) { + ui->write_mnemonic->setText(mnemonicToString((Mnemonic)info[0])); + ui->write_s1->set_value(info[2]); + ui->write_s2->set_value(info[3]); + ui->write_s3->set_value(info[4]); + } else { + ui->write_mnemonic->clear(); + ui->write_s1->clear(); + ui->write_s2->clear(); + ui->write_s3->clear(); + } } -void GUI::onWorkerShowDram(const std::vector<std::array<signed int, LINE_SIZE>> data) { - displayTableHTML(ui->dram_table, data); +void GUI::onWorkerShowDram( + const std::vector<std::array<signed int, LINE_SIZE>> data) +{ + displayTableHTML(ui->dram_table, data); } -void GUI::onWorkerShowCache(const std::vector<std::array<signed int, LINE_SIZE>> data) { - displayTableHTML(ui->cache_table, data); +void GUI::onWorkerShowCache( + const std::vector<std::array<signed int, LINE_SIZE>> data) +{ + displayTableHTML(ui->cache_table, data); } -void GUI::onWorkerShowRegisters(const std::array<int, GPR_NUM> &data) { - displayArrayHTML(ui->register_table, data); +void GUI::onWorkerShowRegisters(const std::array<int, GPR_NUM> &data) +{ + displayArrayHTML(ui->register_table, data); } -void GUI::onWorkerFinished() { - qDebug() << "Worker has finished processing."; -} +void GUI::onWorkerFinished() { qDebug() << "Worker has finished processing."; } void GUI::on_upload_intructions_btn_clicked() { - qDebug() << "Upload intructions button clicked."; - std::vector<signed int> program; - program = browseAndRetrieveFile(ui->register_table); - if(program.empty()){ - QMessageBox::critical(ui->register_table, "File Upload", "Invalid Program File!"); - } - emit sendLoadProgram(program); - emit sendRefreshDram(); - QMessageBox::information(ui->register_table, "File Upload", "Instructions loaded successfully!"); + qDebug() << "Upload intructions button clicked."; + + // why register_table? + QString filePath = QFileDialog::getOpenFileName( + ui->register_table, "Open Binary File", QDir::homePath(), + "Binary Files (*.bin *.rv);;All Files (*.*)"); + QFile file(filePath); + if (filePath.isEmpty() || !file.open(QIODevice::ReadOnly)) { + this->set_status(get_no_instructions, "angry"); + return; + } + + this->p.clear(); + while (!file.atEnd()) { + char bytes[4]; + if (file.read(bytes, 4) == 4) { + uint32_t word = (static_cast<uint8_t>(bytes[0]) << 24) | + (static_cast<uint8_t>(bytes[1]) << 16) | + (static_cast<uint8_t>(bytes[2]) << 8) | + (static_cast<uint8_t>(bytes[3])); + + this->p.push_back(static_cast<signed int>(word)); + } + } + + if (this->p.empty()) + this->set_status(get_no_instructions, "angry"); + else + this->set_status(get_load_file, "happy"); + + file.close(); } - void GUI::on_upload_program_state_btn_clicked() { - //TODO:Upload and set program state ( have to decide how to use this) - qDebug() << "upload program state button is clicked."; + // TODO:Upload and set program state ( have to decide how to use this) + qDebug() << "upload program state button is clicked."; } -void GUI::on_set_levels_btn_clicked() +void GUI::on_enable_pipeline_checkbox_checkStateChanged( + const Qt::CheckState &arg1) { - qDebug() << "Set levels button clicked."; - bool ok; - int value = QInputDialog::getInt(this, "Enter Value", "Enter value:", - 0, - 0, 10, 1, &ok); - if (ok) { - cache_levels = value; - ui->cache_levels_dropdwn->clear(); // Clear previous entries - for (int i = 0; i < cache_levels; ++i) { - ui->cache_levels_dropdwn->addItem(QString::number(i)); - ways.push_back(2); - size.push_back(5); - } - } else { - qDebug() << "User cancelled input."; - } + this->is_pipelined = (arg1 == Qt::CheckState::Checked) ? true : false; } -void GUI::on_set_cache_btn_clicked() { - int current_cache = ui->cache_levels_dropdwn->currentIndex(); - // qDebug() << "current cache: " << current_cache; - int prevWays = ways[current_cache]; - int prevSize = size[current_cache]; - QString cache_ways = ui->cache_ways_inp->text(); - QString cache_size = ui->cache_size_inp->text(); - ways[current_cache] = cache_ways.isEmpty() ? prevWays : cache_ways.toInt(); - size[current_cache] = cache_size.isEmpty() ? prevSize : cache_size.toInt(); - QMessageBox::information(ui->register_table, "Cache Configuration", "Cache" + QString::number(current_cache) + " values set successfully! Please click on Configure button to configure the pipeline or configure other caches."); - // for(int i=0;i<ways.size();i++) { - // qDebug() << "ways: " << ways[i] << " size: " << size[i]; - // } +void GUI::on_base_toggle_checkbox_checkStateChanged(const Qt::CheckState &state) +{ + this->is_hex = (state == Qt::CheckState::Checked) ? false : true; + emit this->hex_toggled(this->is_hex); } - -void GUI::on_enable_pipeline_checkbox_checkStateChanged(const Qt::CheckState &arg1) +void GUI::on_step_btn_clicked() { - //TODO: handle pipeline enabling - if(arg1 == Qt::CheckState::Checked) { - qDebug() << "enable pipeline checkbox checked."; - is_pipelined = true; - } else { - qDebug() << "enable pipeline checkbox unchecked."; - is_pipelined = false; - } + qDebug() << "Run step button clicked."; + // try to configure first + if (!this->ready) + this->on_config_clicked(); + // try again + if (!this->ready) + return; + + this->set_status(get_running, "busy"); + int steps = step_values[ui->step_slider->value()]; + emit sendRunSteps(steps); + this->set_status(get_waiting, "idle"); } - -void GUI::on_enabl_cache_checkbox_checkStateChanged(const Qt::CheckState &arg1) +void GUI::on_save_program_state_btn_clicked() { - //TODO: handle cache enabling - if(arg1 == Qt::CheckState::Checked) { - qDebug() << "enable cache checkbox checked."; - is_cache_enabled = true; - } else { - qDebug() << "enable cache checkbox unchecked."; - is_cache_enabled = false; - } - + // TODO: save program state + qDebug() << "save program state button is clicked."; } - -void GUI::on_run_steps_btn_clicked() +void GUI::on_config_clicked() { - qDebug() << "Run steps button clicked."; - emit sendRunSteps(ui->number_steps_inp->text().toInt()); + std::vector<unsigned int> ways; + QStringList entries; + signed int i; + DynamicWaysEntry *dwe = ui->cache_way_selector; + + for (const QString &s : dwe->get_entries()) { + + if (s.isEmpty()) + continue; + + i = dwe->parse_valid_way(s); + if (i != -1) { + ways.push_back((unsigned int)i); + } else { + this->set_status(get_bad_cache, "angry"); + return; + } + } + + if (this->p.empty()) { + this->set_status(get_no_instructions, "angry"); + return; + } + + this->ready = true; + + // say something snarky + if (!is_pipelined) + this->set_status(get_no_pipeline, "angry"); + else if (ways.size() == 0) + this->set_status(get_no_cache, "angry"); + else + this->set_status(get_initialize, "happy"); + + emit sendConfigure(ways, this->p, is_pipelined); } - -void GUI::on_step_btn_clicked() +void GUI::set_status( + const std::function<std::string()> &func, const QString &img) { - qDebug() << "Run step button clicked."; - emit sendRunStep(); -} + this->status_label->setText( + "-> \"" + QString::fromStdString(func()) + "\""); + QString img_path = ":resources/" + img; + QPixmap pixmap(img_path); -void GUI::on_save_program_state_btn_clicked() -{ - //TODO: save program state - qDebug() << "save program state button is clicked."; -} + if (!pixmap) { + return; + } -void GUI::on_Configure_Btn_clicked() -{ - emit sendConfigure(ways, size, is_pipelined, is_cache_enabled); - QMessageBox::information(ui->register_table, "Pipeline Configuration", "Pipeline and memory subsystem configured successfully!"); + this->avatar->setPixmap(pixmap); + this->avatar->show(); } - @@ -1,131 +1,180 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef GUI_H #define GUI_H -#include <QMainWindow> -#include <QThread> -#include <QFileDialog> +#include "worker.h" #include <QFile> -#include <QTextStream> -#include <QTextEdit> -#include <QMessageBox> +#include <QFileDialog> #include <QInputDialog> -#include "worker.h" +#include <QLabel> +#include <QMainWindow> +#include <QTextEdit> +#include <QTextStream> +#include <QThread> +#include <functional> QT_BEGIN_NAMESPACE -namespace Ui { +namespace Ui +{ class GUI; } QT_END_NAMESPACE class GUI : public QMainWindow { - Q_OBJECT - -public: - GUI(QWidget *parent = nullptr); - ~GUI(); - bool is_pipelined = false; - bool is_cache_enabled = false; - int cache_levels = 0; - std::vector<int> ways; - std::vector<int> size; - -signals: - void sendRefreshDram(); - void sendRefreshCache(); - void sendRefreshRegisters(); - void sendRunSteps(int steps); - void sendRunStep(); - void sendLoadProgram(std::vector<signed int> program); - void sendConfigure(std::vector<int> ways, std::vector<int> size, bool is_pipelined, bool is_cache_enabled); - -private slots: - void onWorkerClockCycles(int value, int pc); - - void onWorkerFetchInfo(const std::vector<int> info); - - void onWorkerDecodeInfo(const std::vector<int> info); - - void onWorkerExecuteInfo(const std::vector<int> info); - - void onWorkerMemoryInfo(const std::vector<int> info); - - void onWorkerWriteBackInfo(const std::vector<int> info); - - void onWorkerShowDram(const std::vector<std::array<signed int, LINE_SIZE>> data); - - void onWorkerShowCache(const std::vector<std::array<signed int, LINE_SIZE>> data); - - void onWorkerShowRegisters(const std::array<int, GPR_NUM> &data); - - void onWorkerFinished(); - - void on_upload_intructions_btn_clicked(); - - void on_upload_program_state_btn_clicked(); - - void on_Configure_Btn_clicked(); - - void on_set_levels_btn_clicked(); - - void on_set_cache_btn_clicked(); - - void on_enable_pipeline_checkbox_checkStateChanged(const Qt::CheckState &arg1); - - void on_enabl_cache_checkbox_checkStateChanged(const Qt::CheckState &arg1); - - void on_run_steps_btn_clicked(); - - void on_step_btn_clicked(); - - void on_save_program_state_btn_clicked(); - -private: - Ui::GUI *ui; - QThread workerThread; - Worker *worker; - const std::map<Mnemonic, QString> mnemonicNameMap = { - {Mnemonic::ADD, "ADD"}, - {Mnemonic::SUB, "SUB"}, - {Mnemonic::MUL, "MUL"}, - {Mnemonic::QUOT, "QUOT"}, - {Mnemonic::SFTR, "SFTR"}, - {Mnemonic::SFTL, "SFTL"}, - {Mnemonic::AND, "AND"}, - {Mnemonic::OR, "OR"}, - {Mnemonic::NOT, "NOT"}, - {Mnemonic::XOR, "XOR"}, - {Mnemonic::ADDV, "ADDV"}, - {Mnemonic::SUBV, "SUBV"}, - {Mnemonic::MULV, "MULV"}, - {Mnemonic::DIVV, "DIVV"}, - {Mnemonic::CMP, "CMP"}, - {Mnemonic::CEV, "CEV"}, - {Mnemonic::LOAD, "LOAD"}, - {Mnemonic::LOADV, "LOADV"}, - {Mnemonic::ADDI, "ADDI"}, - {Mnemonic::SUBI, "SUBI"}, - {Mnemonic::SFTRI, "SFTRI"}, - {Mnemonic::SFTLI, "SFTLI"}, - {Mnemonic::ANDI, "ANDI"}, - {Mnemonic::ORI, "ORI"}, - {Mnemonic::XORI, "XORI"}, - {Mnemonic::STORE, "STORE"}, - {Mnemonic::STOREV, "STOREV"}, - {Mnemonic::JMP, "JMP"}, - {Mnemonic::JRL, "JRL"}, - {Mnemonic::JAL, "JAL"}, - {Mnemonic::BEQ, "BEQ"}, - {Mnemonic::BGT, "BGT"}, - {Mnemonic::BUF, "BUF"}, - {Mnemonic::BOF, "BOF"}, - {Mnemonic::PUSH, "PUSH"}, - {Mnemonic::POP, "POP"}, - {Mnemonic::NOP, "NOP"}, - }; - QString mnemonicToString(Mnemonic mnemonic) { - auto it = mnemonicNameMap.find(mnemonic); - return (it != mnemonicNameMap.end()) ? it->second : "Unknown"; - } + Q_OBJECT + + public: + /** + * Constructor. + * @return A newly allocated GUI object. + */ + GUI(QWidget *parent = nullptr); + ~GUI(); + + /** + * Uses `func' to set the current status. + * @param a function which returns a string. + * @param a path to the desired avatar + */ + void set_status( + const std::function<std::string()> &func, + const QString &img = "idle.png"); + + signals: + void hex_toggled(bool is_hex); + void sendRunSteps(int steps); + void sendConfigure( + std::vector<unsigned int> ways, vector<int> program, bool is_pipelined); + + private slots: + void on_worker_refresh_gui(int value, int pc); + + void onWorkerFetchInfo(const std::vector<int> info); + + void onWorkerDecodeInfo(const std::vector<int> info); + + void onWorkerExecuteInfo(const std::vector<int> info); + + void onWorkerMemoryInfo(const std::vector<int> info); + + void onWorkerWriteBackInfo(const std::vector<int> info); + + void + onWorkerShowDram(const std::vector<std::array<signed int, LINE_SIZE>> data); + + void onWorkerShowCache( + const std::vector<std::array<signed int, LINE_SIZE>> data); + + void onWorkerShowRegisters(const std::array<int, GPR_NUM> &data); + + void onWorkerFinished(); + + void on_upload_intructions_btn_clicked(); + + void on_upload_program_state_btn_clicked(); + + void + on_enable_pipeline_checkbox_checkStateChanged(const Qt::CheckState &arg1); + + void + on_base_toggle_checkbox_checkStateChanged(const Qt::CheckState &state); + + void on_step_btn_clicked(); + + void on_save_program_state_btn_clicked(); + + /** + * Validates that the user has provided a valid program and cache. + * If so, `this->ready' is set and the user options are passed to the + * worker. + * If not, rudely complains. + */ + void on_config_clicked(); + + private: + Ui::GUI *ui; + + /** + * Indicates if the program has been initialized. + */ + bool ready; + + /** + * Whether or not numerical values are currently displaying in hex. + */ + bool is_hex = true; + + /** + * The message displayed on the status bar. + */ + QLabel *status_label; + + /** + * The robot image displayed on the status bar. + */ + QLabel *avatar; + + /** + * The currently loaded program. + */ + std::vector<signed int> p; + + /** + * If this stage is pipelined or not. + */ + bool is_pipelined = true; + + /** + * The possible step slider values. + */ + QVector<int> step_values = {1, 5, 20, 50, 250, 1000, 10000}; + + QThread workerThread; + + Worker *worker; + + const std::map<Mnemonic, QString> mnemonicNameMap = { + {Mnemonic::ADD, "ADD"}, {Mnemonic::SUB, "SUB"}, + {Mnemonic::MUL, "MUL"}, {Mnemonic::QUOT, "QUOT"}, + {Mnemonic::SFTR, "SFTR"}, {Mnemonic::SFTL, "SFTL"}, + {Mnemonic::AND, "AND"}, {Mnemonic::OR, "OR"}, + {Mnemonic::NOT, "NOT"}, {Mnemonic::XOR, "XOR"}, + {Mnemonic::ADDV, "ADDV"}, {Mnemonic::SUBV, "SUBV"}, + {Mnemonic::MULV, "MULV"}, {Mnemonic::DIVV, "DIVV"}, + {Mnemonic::CMP, "CMP"}, {Mnemonic::CEV, "CEV"}, + {Mnemonic::LOAD, "LOAD"}, {Mnemonic::LOADV, "LOADV"}, + {Mnemonic::ADDI, "ADDI"}, {Mnemonic::SUBI, "SUBI"}, + {Mnemonic::SFTRI, "SFTRI"}, {Mnemonic::SFTLI, "SFTLI"}, + {Mnemonic::ANDI, "ANDI"}, {Mnemonic::ORI, "ORI"}, + {Mnemonic::XORI, "XORI"}, {Mnemonic::STORE, "STORE"}, + {Mnemonic::STOREV, "STOREV"}, {Mnemonic::JMP, "JMP"}, + {Mnemonic::JRL, "JRL"}, {Mnemonic::JAL, "JAL"}, + {Mnemonic::BEQ, "BEQ"}, {Mnemonic::BGT, "BGT"}, + {Mnemonic::BUF, "BUF"}, {Mnemonic::BOF, "BOF"}, + {Mnemonic::PUSH, "PUSH"}, {Mnemonic::POP, "POP"}, + {Mnemonic::NOP, "NOP"}, + }; + QString mnemonicToString(Mnemonic mnemonic) + { + auto it = mnemonicNameMap.find(mnemonic); + return (it != mnemonicNameMap.end()) ? it->second : "Unknown"; + } }; #endif // GUI_H @@ -6,8 +6,8 @@ <rect> <x>0</x> <y>0</y> - <width>1359</width> - <height>606</height> + <width>1499</width> + <height>621</height> </rect> </property> <property name="windowTitle"> @@ -16,628 +16,636 @@ <widget class="QWidget" name="centralwidget"> <layout class="QHBoxLayout" name="horizontalLayout_2"> <item> - <layout class="QGridLayout" name="gridLayout_2" rowstretch="0,0,0" columnstretch="0,3,0,1,0"> - <item row="0" column="1"> - <layout class="QVBoxLayout" name="verticalLayout_19" stretch="1,0,3"> + <layout class="QGridLayout" name="gridLayout_2" rowstretch="0" columnstretch="0"> + <item row="0" column="0"> + <layout class="QHBoxLayout" name="control_separator"> <item> - <layout class="QVBoxLayout" name="verticalLayout_20"> + <layout class="QVBoxLayout" name="storage_pipe_separator"> <item> - <widget class="QLabel" name="label_5"> - <property name="font"> - <font> - <bold>true</bold> - </font> - </property> - <property name="text"> - <string>Registers</string> - </property> - </widget> - </item> - <item> - <widget class="Line" name="line_25"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - <item> - <widget class="QTextEdit" name="register_table"/> + <layout class="QHBoxLayout" name="storage_view"> + <item> + <layout class="QVBoxLayout" name="registers"> + <item> + <widget class="QLabel" name="label_5"> + <property name="font"> + <font> + <bold>true</bold> + </font> + </property> + <property name="text"> + <string>Registers</string> + </property> + </widget> + </item> + <item> + <widget class="QTextEdit" name="register_table"/> + </item> + </layout> + </item> + <item> + <layout class="QVBoxLayout" name="dram"> + <item> + <widget class="QLabel" name="label_10"> + <property name="font"> + <font> + <bold>true</bold> + </font> + </property> + <property name="text"> + <string>DRAM</string> + </property> + </widget> + </item> + <item> + <widget class="QTextEdit" name="dram_table"> + <property name="minimumSize"> + <size> + <width>500</width> + <height>0</height> + </size> + </property> + </widget> + </item> + </layout> + </item> + <item> + <layout class="QVBoxLayout" name="cache"> + <item> + <widget class="QLabel" name="label_6"> + <property name="font"> + <font> + <bold>true</bold> + </font> + </property> + <property name="text"> + <string>Cache</string> + </property> + </widget> + </item> + <item> + <widget class="QTextEdit" name="cache_table"> + <property name="minimumSize"> + <size> + <width>500</width> + <height>0</height> + </size> + </property> + </widget> + </item> + </layout> + </item> + </layout> </item> - </layout> - </item> - <item> - <widget class="Line" name="line_26"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - <item> - <layout class="QHBoxLayout" name="horizontalLayout_7"> <item> - <layout class="QVBoxLayout" name="verticalLayout_21"> + <layout class="QHBoxLayout" name="pipe_view"> <item> - <widget class="QLabel" name="label_6"> - <property name="font"> - <font> - <bold>true</bold> - </font> + <widget class="QGroupBox" name="Fetch"> + <property name="minimumSize"> + <size> + <width>200</width> + <height>0</height> + </size> </property> - <property name="text"> - <string>Cache</string> + <property name="title"> + <string>Fetch</string> </property> + <property name="alignment"> + <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignTop</set> + </property> + <layout class="QVBoxLayout" name="verticalLayout"> + <item> + <widget class="DigitLabel" name="fetch_bits"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="fetch_squashed"> + <property name="text"> + <string/> + </property> + </widget> + </item> + </layout> </widget> </item> <item> - <widget class="Line" name="line_27"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> + <widget class="QGroupBox" name="Decode"> + <property name="minimumSize"> + <size> + <width>200</width> + <height>0</height> + </size> + </property> + <property name="title"> + <string>Decode</string> + </property> + <property name="alignment"> + <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignTop</set> </property> + <layout class="QVBoxLayout" name="verticalLayout_2"> + <item> + <widget class="DigitLabel" name="decode_bits"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="decode_squashed"> + <property name="text"> + <string/> + </property> + </widget> + </item> + </layout> </widget> </item> <item> - <widget class="QTextEdit" name="cache_table"/> - </item> - </layout> - </item> - <item> - <widget class="Line" name="line_28"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_22"> - <item> - <widget class="QLabel" name="label_10"> - <property name="font"> - <font> - <bold>true</bold> - </font> + <widget class="QGroupBox" name="Execute"> + <property name="minimumSize"> + <size> + <width>200</width> + <height>0</height> + </size> + </property> + <property name="title"> + <string>Execute</string> </property> - <property name="text"> - <string>DRAM</string> + <property name="alignment"> + <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignTop</set> </property> + <layout class="QVBoxLayout" name="verticalLayout_3"> + <item> + <widget class="DigitLabel" name="execute_s1"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="execute_s2"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="execute_s3"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="execute_mnemonic"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="execute_squashed"> + <property name="text"> + <string/> + </property> + <property name="textFormat"> + <enum>Qt::TextFormat::MarkdownText</enum> + </property> + </widget> + </item> + </layout> </widget> </item> <item> - <widget class="Line" name="line_29"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> + <widget class="QGroupBox" name="Memory"> + <property name="minimumSize"> + <size> + <width>200</width> + <height>0</height> + </size> + </property> + <property name="title"> + <string>Memory</string> </property> + <property name="alignment"> + <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignTop</set> + </property> + <layout class="QVBoxLayout" name="verticalLayout_4"> + <item> + <widget class="DigitLabel" name="memory_s1"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="memory_s2"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="memory_s3"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="memory_mnemonic"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="memory_squashed"> + <property name="text"> + <string/> + </property> + </widget> + </item> + </layout> </widget> </item> <item> - <widget class="QTextEdit" name="dram_table"/> + <widget class="QGroupBox" name="WriteBack"> + <property name="minimumSize"> + <size> + <width>200</width> + <height>0</height> + </size> + </property> + <property name="title"> + <string>Write Back</string> + </property> + <property name="alignment"> + <set>Qt::AlignmentFlag::AlignLeading|Qt::AlignmentFlag::AlignLeft|Qt::AlignmentFlag::AlignTop</set> + </property> + <layout class="QVBoxLayout" name="verticalLayout_5"> + <item> + <widget class="DigitLabel" name="write_s1"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="write_s2"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="write_s3"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="write_mnemonic"> + <property name="text"> + <string/> + </property> + </widget> + </item> + </layout> + </widget> </item> </layout> </item> </layout> </item> - </layout> - </item> - <item row="1" column="0" colspan="5"> - <layout class="QHBoxLayout" name="horizontalLayout"> - <item> - <widget class="QGroupBox" name="Fetch"> - <property name="title"> - <string>Fetch</string> - </property> - <layout class="QVBoxLayout" name="verticalLayout"> - <item> - <widget class="QLineEdit" name="fetch_instruction_bits"> - <property name="placeholderText"> - <string>Instruction Bits</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="fetch_pc"> - <property name="placeholderText"> - <string>Program Counter</string> - </property> - </widget> - </item> - </layout> - </widget> - </item> - <item> - <widget class="Line" name="line"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> - <item> - <widget class="QGroupBox" name="Decode"> - <property name="title"> - <string>Decode</string> - </property> - <layout class="QVBoxLayout" name="verticalLayout_2"> - <item> - <widget class="QLineEdit" name="decode_s1"> - <property name="placeholderText"> - <string>Instruction Bits</string> - </property> - </widget> - </item> - <!-- <item> - <widget class="QLineEdit" name="decode_s2"> - <property name="text"> - <string/> - </property> - <property name="placeholderText"> - <string>Program COunte</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="decode_s3"> - <property name="placeholderText"> - <string>s3</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="decode_mnemonic"> - <property name="placeholderText"> - <string>Mnemonic</string> - </property> - </widget> - </item> --> - <item> - <widget class="QLineEdit" name="decode_pc"> - <property name="placeholderText"> - <string>Program Counter</string> - </property> - </widget> - </item> - </layout> - </widget> - </item> - <item> - <widget class="Line" name="line_2"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> - <item> - <widget class="QGroupBox" name="Execute"> - <property name="title"> - <string>Execute</string> - </property> - <layout class="QVBoxLayout" name="verticalLayout_3"> - <item> - <widget class="QLineEdit" name="execute_s1"> - <property name="placeholderText"> - <string>s1</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="execute_s2"> - <property name="text"> - <string/> - </property> - <property name="placeholderText"> - <string>s2</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="execute_s3"> - <property name="placeholderText"> - <string>s3</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="execute_mnemonic"> - <property name="placeholderText"> - <string>Mnemonic</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="execute_pc"> - <property name="placeholderText"> - <string>Program Counter</string> - </property> - </widget> - </item> - </layout> - </widget> - </item> - <item> - <widget class="Line" name="line_3"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> - <item> - <widget class="QGroupBox" name="Memory"> - <property name="title"> - <string>Memory</string> - </property> - <layout class="QVBoxLayout" name="verticalLayout_4"> - <item> - <widget class="QLineEdit" name="memory_s1"> - <property name="placeholderText"> - <string>s1</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="memory_s2"> - <property name="text"> - <string/> - </property> - <property name="placeholderText"> - <string>s2</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="memory_s3"> - <property name="placeholderText"> - <string>s3</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="memory_mnemonic"> - <property name="placeholderText"> - <string>Mnemonic</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="memory_pc"> - <property name="placeholderText"> - <string>Program Counter</string> - </property> - </widget> - </item> - </layout> - </widget> - </item> - <item> - <widget class="Line" name="line_4"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> - <item> - <widget class="QGroupBox" name="WriteBack"> - <property name="title"> - <string>Write Back</string> - </property> - <layout class="QVBoxLayout" name="verticalLayout_5"> - <item> - <widget class="QLineEdit" name="wb_s1"> - <property name="placeholderText"> - <string>s1</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="wb_s2"> - <property name="text"> - <string/> - </property> - <property name="placeholderText"> - <string>s2</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="wb_s3"> - <property name="placeholderText"> - <string>s3</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="wb_mnemonic"> - <property name="placeholderText"> - <string>Mnemonic</string> - </property> - </widget> - </item> - <item> - <widget class="QLineEdit" name="wb_pc"> - <property name="placeholderText"> - <string>Program Counter</string> - </property> - </widget> - </item> - </layout> - </widget> - </item> - </layout> - </item> - <item row="0" column="3"> - <layout class="QVBoxLayout" name="verticalLayout_23"> <item> - <layout class="QVBoxLayout" name="verticalLayout_24"> + <layout class="QVBoxLayout" name="control_view"> <item> - <widget class="QLabel" name="label_12"> + <widget class="QLabel" name="label_13"> <property name="font"> <font> <bold>true</bold> </font> </property> <property name="text"> - <string>Upload Files</string> + <string>Controls</string> </property> </widget> </item> <item> - <widget class="Line" name="line_33"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> + <layout class="QHBoxLayout" name="cache_controls"> + <property name="sizeConstraint"> + <enum>QLayout::SizeConstraint::SetMinimumSize</enum> </property> - </widget> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_25"> <item> - <widget class="QPushButton" name="upload_intructions_btn"> - <property name="text"> - <string>Upload Instruction File</string> + <widget class="Line" name="line_8"> + <property name="orientation"> + <enum>Qt::Orientation::Vertical</enum> </property> </widget> </item> <item> - <layout class="QHBoxLayout" name="horizontalLayout_8"> + <layout class="QVBoxLayout" name="cache_way_text"> + <property name="sizeConstraint"> + <enum>QLayout::SizeConstraint::SetMinimumSize</enum> + </property> <item> - <widget class="QPushButton" name="upload_program_state_btn"> - <property name="text"> - <string>Upload Program State File</string> + <widget class="QLabel" name="label"> + <property name="maximumSize"> + <size> + <width>16777215</width> + <height>16777215</height> + </size> </property> - </widget> - </item> - </layout> - </item> - </layout> - </item> - <item> - <widget class="Line" name="line_34"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - </layout> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_26"> - <item> - <widget class="QLabel" name="label_13"> - <property name="font"> - <font> - <bold>true</bold> - </font> - </property> - <property name="text"> - <string>Controls</string> - </property> - </widget> - </item> - <item> - <widget class="Line" name="line_35"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_27"> - <item> - <layout class="QHBoxLayout" name="horizontalLayout_9"> - <item> - <widget class="QPushButton" name="set_levels_btn"> <property name="text"> - <string>Cache Levels</string> - </property> - </widget> - </item> - <item> - <widget class="QComboBox" name="cache_levels_dropdwn"/> - </item> - <item> - <widget class="QLineEdit" name="cache_size_inp"> - <property name="placeholderText"> - <string>size</string> + <string>C1 2^</string> </property> </widget> </item> <item> - <widget class="QLineEdit" name="cache_ways_inp"> - <property name="placeholderText"> - <string>ways</string> + <widget class="QLabel" name="label_2"> + <property name="maximumSize"> + <size> + <width>16777215</width> + <height>16777215</height> + </size> </property> - </widget> - </item> - <item> - <widget class="QPushButton" name="set_cache_btn"> <property name="text"> - <string>Cache Conf</string> + <string>C2 2^</string> </property> </widget> </item> - </layout> - </item> - <item> - <layout class="QHBoxLayout" name="horizontalLayout_10"> <item> - <widget class="QPushButton" name="Configure_Btn"> - <property name="text"> - <string>Configure</string> + <widget class="QLabel" name="label_3"> + <property name="minimumSize"> + <size> + <width>0</width> + <height>0</height> + </size> </property> - </widget> - </item> - <item> - <widget class="QCheckBox" name="enable_pipeline_checkbox"> - <property name="text"> - <string>Enable Pipeline</string> + <property name="maximumSize"> + <size> + <width>16777215</width> + <height>16777215</height> + </size> </property> - <!-- <property name="checkable"> - <bool>false</bool> + <property name="text"> + <string>C3 2^</string> </property> - <property name="checked"> - <bool>false</bool> - </property> --> </widget> </item> <item> - <widget class="QCheckBox" name="enabl_cache_checkbox"> + <widget class="QLabel" name="label_4"> + <property name="maximumSize"> + <size> + <width>16777215</width> + <height>16777215</height> + </size> + </property> <property name="text"> - <string>Enable Cache</string> + <string>C4 2^</string> </property> - <!-- <property name="checkable"> - <bool>false</bool> - </property> --> </widget> </item> </layout> </item> + <item> + <widget class="DynamicWaysEntry" name="cache_way_selector" native="true"> + <property name="minimumSize"> + <size> + <width>0</width> + <height>0</height> + </size> + </property> + </widget> + </item> </layout> </item> - </layout> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_28"> - <item> - <widget class="Line" name="line_36"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> <item> - <widget class="QLabel" name="label_14"> - <property name="font"> - <font> - <bold>true</bold> - </font> - </property> + <widget class="QCheckBox" name="enable_pipeline_checkbox"> <property name="text"> - <string>Run</string> + <string>Enable Pipeline</string> + </property> + <property name="checked"> + <bool>true</bool> </property> </widget> </item> <item> - <widget class="Line" name="line_37"> + <widget class="Line" name="line"> <property name="orientation"> - <enum>Qt::Horizontal</enum> + <enum>Qt::Orientation::Horizontal</enum> </property> </widget> </item> <item> - <layout class="QVBoxLayout" name="verticalLayout_29"> + <layout class="QVBoxLayout" name="file_controls"> <item> - <layout class="QHBoxLayout" name="horizontalLayout_11"> + <layout class="QVBoxLayout" name="verticalLayout_29"> + <item> + <layout class="QVBoxLayout" name="verticalLayout_24"> + <item> + <widget class="QLabel" name="label_12"> + <property name="font"> + <font> + <bold>true</bold> + </font> + </property> + <property name="text"> + <string>Upload Files</string> + </property> + </widget> + </item> + <item> + <layout class="QVBoxLayout" name="verticalLayout_25"> + <item> + <widget class="QPushButton" name="upload_intructions_btn"> + <property name="text"> + <string>Load Instructions</string> + </property> + </widget> + </item> + <item> + <widget class="QPushButton" name="upload_program_state_btn"> + <property name="text"> + <string>Upload Program State</string> + </property> + </widget> + </item> + <item> + <widget class="QPushButton" name="save_program_state_btn"> + <property name="text"> + <string>Save Program State</string> + </property> + </widget> + </item> + <item> + <layout class="QHBoxLayout" name="horizontalLayout_8"/> + </item> + <item> + <spacer name="verticalSpacer_2"> + <property name="orientation"> + <enum>Qt::Orientation::Vertical</enum> + </property> + <property name="sizeHint" stdset="0"> + <size> + <width>20</width> + <height>40</height> + </size> + </property> + </spacer> + </item> + </layout> + </item> + <item> + <widget class="QPushButton" name="config"> + <property name="text"> + <string>Initialize!</string> + </property> + </widget> + </item> + <item> + <spacer name="verticalSpacer"> + <property name="orientation"> + <enum>Qt::Orientation::Vertical</enum> + </property> + <property name="sizeHint" stdset="0"> + <size> + <width>20</width> + <height>40</height> + </size> + </property> + </spacer> + </item> + </layout> + </item> + </layout> + </item> + <item> + <layout class="QVBoxLayout" name="simulation_controls"> + <item> + <layout class="QHBoxLayout" name="horizontalLayout_13"> + <item> + <widget class="QLabel" name="state_header"> + <property name="font"> + <font> + <bold>true</bold> + </font> + </property> + <property name="text"> + <string>State</string> + </property> + </widget> + </item> + <item> + <widget class="QCheckBox" name="base_toggle_checkbox"> + <property name="enabled"> + <bool>true</bool> + </property> + <property name="text"> + <string>Decimal</string> + </property> + </widget> + </item> + </layout> + </item> + <item> + <layout class="QHBoxLayout" name="horizontalLayout_11"> + <item> + <widget class="QLabel" name="pc"> + <property name="text"> + <string>PC</string> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="p_counter"> + <property name="text"> + <string/> + </property> + </widget> + </item> + <item> + <widget class="QLabel" name="cycles"> + <property name="text"> + <string>Cycle</string> + </property> + </widget> + </item> + <item> + <widget class="DigitLabel" name="cycle_counter"> + <property name="text"> + <string/> + </property> + </widget> + </item> + </layout> + </item> <item> - <widget class="QLineEdit" name="number_steps_inp"> - <property name="placeholderText"> - <string># Steps</string> + <widget class="QSlider" name="step_slider"> + <property name="minimum"> + <number>0</number> + </property> + <property name="maximum"> + <number>6</number> + </property> + <property name="pageStep"> + <number>1</number> + </property> + <property name="orientation"> + <enum>Qt::Orientation::Horizontal</enum> + </property> + <property name="tickPosition"> + <enum>QSlider::TickPosition::NoTicks</enum> + </property> + <property name="tickInterval"> + <number>1</number> </property> </widget> </item> <item> - <widget class="QPushButton" name="run_steps_btn"> + <widget class="QPushButton" name="step_btn"> + <property name="minimumSize"> + <size> + <width>400</width> + <height>0</height> + </size> + </property> <property name="text"> - <string>Run Steps</string> + <string>Step 1</string> </property> </widget> </item> </layout> </item> - <item> - <widget class="QPushButton" name="step_btn"> - <property name="text"> - <string>Step</string> - </property> - </widget> - </item> </layout> </item> </layout> </item> - <item> - <widget class="Line" name="line_38"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - <item> - <layout class="QVBoxLayout" name="verticalLayout_30"> - <item> - <widget class="QLabel" name="label_15"> - <property name="font"> - <font> - <bold>true</bold> - </font> - </property> - <property name="text"> - <string>Program State</string> - </property> - </widget> - </item> - <item> - <widget class="Line" name="line_39"> - <property name="orientation"> - <enum>Qt::Horizontal</enum> - </property> - </widget> - </item> - <item> - <widget class="QLabel" name="cycles_label"> - <property name="text"> - <string>Clock Cycles</string> - </property> - </widget> - </item> - <item> - <widget class="QPushButton" name="save_program_state_btn"> - <property name="text"> - <string>Save Current Program State</string> - </property> - </widget> - </item> - </layout> - </item> </layout> </item> - <item row="0" column="2"> - <widget class="Line" name="line_5"> - <property name="orientation"> - <enum>Qt::Vertical</enum> - </property> - </widget> - </item> </layout> </item> </layout> </widget> - <widget class="QMenuBar" name="menubar"> - <property name="geometry"> - <rect> - <x>0</x> - <y>0</y> - <width>1359</width> - <height>26</height> - </rect> - </property> - </widget> - <widget class="QStatusBar" name="statusbar"/> + <widget class="QStatusBar" name="statusBar"/> </widget> -<resources/> + <customwidgets> + <customwidget> + <class>DynamicWaysEntry</class> + <extends>QWidget</extends> + <header>dynamicwaysentry.h</header> + <container>1</container> + </customwidget> + <customwidget> + <class>DigitLabel</class> + <extends>QLabel</extends> + <header location="global">digitlabel.h</header> + </customwidget> + </customwidgets> + <resources/> <connections/> </ui> diff --git a/gui/main.cc b/gui/main.cc index 5e45465..9877a3c 100644 --- a/gui/main.cc +++ b/gui/main.cc @@ -1,7 +1,26 @@ -#include "pipe_spec.h" +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "gui.h" #include "logger.h" +#include "pipe_spec.h" #include <QApplication> +#include <QFile> +#include <QFontDatabase> #include <getopt.h> #include <iostream> @@ -67,6 +86,16 @@ int main(int argc, char **argv) global_log->log(INFO, "Starting QT..."); QApplication a(argc, argv); + + int fId = QFontDatabase::addApplicationFont( + ":/resources/BigBlueTermPlusNerdFontMono-Regular.ttf"); + QFile ssf(":/resources/styles.qss"); + QString f = QFontDatabase::applicationFontFamilies(fId).at(0); + + ssf.open(QFile::ReadOnly); + QString ss = QLatin1String(ssf.readAll()); + a.setStyleSheet(ss); + GUI w; w.show(); return a.exec(); diff --git a/gui/messages.h b/gui/messages.h new file mode 100644 index 0000000..461c461 --- /dev/null +++ b/gui/messages.h @@ -0,0 +1,71 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + +#ifndef MESSAGES_H +#define MESSAGES_H +#include <string> +#include <vector> + +/** + * Humorous computer speak. + */ +#define RANDOM_MESSAGE(v) (v[std::rand() % v.size()]) + +const std::vector<std::string> waiting = { + "WAITING FOR USER", "IDLE", "BORED", "SLEEPING", + "TAKING A BREAK", "IDLING", "DAYDREAMING", "WAITING FOR INPUT"}; +const std::vector<std::string> running = { + "COMPUTING", "WORKING", "BUSY", "RUNNING"}; +const std::vector<std::string> load_file = { + "FILE LOADED", "FILE PARSED", "FILE READ", "READING... DONE"}; +const std::vector<std::string> no_instructions = { + "NO PROGRAM PROVIDED", "NOTHING TO DO, GIVING UP", "INSTRUCTIONS MISSING", + "404 INSTRUCTIONS NOT FOUND"}; +const std::vector<std::string> bad_cache = { + "WAYS CANNOT BE BELOW 0 OR ABOVE 4"}; +const std::vector<std::string> no_pipeline = { + "SIMULATION READY: NO PIPE", "PIPE OFF, SIMULATION READY"}; +const std::vector<std::string> no_cache = { + "SIMULATION READY: NO CACHE", "CACHE OFF, SIMULATION READY"}; +const std::vector<std::string> initialize = { + "SIMULATION READY", "ALL MODULES LOADED, SIMULATION READY"}; + +/** + * @return an unsolicited status messages + */ +std::string get_waiting() { return RANDOM_MESSAGE(waiting); } +std::string get_running() { return RANDOM_MESSAGE(running); } + +/** + * @return confirmation of file upload + */ +std::string get_load_file() { return RANDOM_MESSAGE(load_file); } + +/** + * @return a friendly reminder that the simulation is not configured yet + */ +std::string get_no_instructions() { return RANDOM_MESSAGE(no_instructions); } +std::string get_bad_cache() { return RANDOM_MESSAGE(bad_cache); } + +/** + * @return unsolicited complaints for successful initialization + */ +std::string get_no_pipeline() { return RANDOM_MESSAGE(no_pipeline); } +std::string get_no_cache() { return RANDOM_MESSAGE(no_cache); } +std::string get_initialize() { return RANDOM_MESSAGE(initialize); } + +#endif // MESSAGES_H diff --git a/gui/resources.qrc b/gui/resources.qrc index 8bfd4e7..569cc22 100644 --- a/gui/resources.qrc +++ b/gui/resources.qrc @@ -1,6 +1,11 @@ <!DOCTYPE RCC> <RCC version="1.0"> - <qresource prefix="/resources"> - <file alias="input.txt">resources/input.txt</file> + <qresource> + <file>resources/styles.qss</file> + <file>resources/idle.png</file> + <file>resources/angry.png</file> + <file>resources/happy.png</file> + <file>resources/busy.png</file> + <file>resources/BigBlueTermPlusNerdFontMono-Regular.ttf</file> </qresource> </RCC> diff --git a/gui/resources/BigBlueTermPlusNerdFont-Regular.ttf b/gui/resources/BigBlueTermPlusNerdFont-Regular.ttf Binary files differnew file mode 100644 index 0000000..d8ad007 --- /dev/null +++ b/gui/resources/BigBlueTermPlusNerdFont-Regular.ttf diff --git a/gui/resources/BigBlueTermPlusNerdFontMono-Regular.ttf b/gui/resources/BigBlueTermPlusNerdFontMono-Regular.ttf Binary files differnew file mode 100644 index 0000000..1757e92 --- /dev/null +++ b/gui/resources/BigBlueTermPlusNerdFontMono-Regular.ttf diff --git a/gui/resources/BigBlueTermPlusNerdFontPropo-Regular.ttf b/gui/resources/BigBlueTermPlusNerdFontPropo-Regular.ttf Binary files differnew file mode 100644 index 0000000..c30176d --- /dev/null +++ b/gui/resources/BigBlueTermPlusNerdFontPropo-Regular.ttf diff --git a/gui/resources/angry.png b/gui/resources/angry.png Binary files differnew file mode 100644 index 0000000..3299eb4 --- /dev/null +++ b/gui/resources/angry.png diff --git a/gui/resources/busy.png b/gui/resources/busy.png Binary files differnew file mode 100644 index 0000000..df1b36a --- /dev/null +++ b/gui/resources/busy.png diff --git a/gui/resources/happy.png b/gui/resources/happy.png Binary files differnew file mode 100644 index 0000000..6168e89 --- /dev/null +++ b/gui/resources/happy.png diff --git a/gui/resources/idle.png b/gui/resources/idle.png Binary files differnew file mode 100644 index 0000000..f894716 --- /dev/null +++ b/gui/resources/idle.png diff --git a/gui/resources/input.txt b/gui/resources/input.txt deleted file mode 100644 index fc1c3cf..0000000 --- a/gui/resources/input.txt +++ /dev/null @@ -1 +0,0 @@ -Lorem Ipsum
\ No newline at end of file diff --git a/gui/resources/styles.qss b/gui/resources/styles.qss new file mode 100644 index 0000000..dbaa623 --- /dev/null +++ b/gui/resources/styles.qss @@ -0,0 +1,167 @@ +* { + font-family: "BigBlueTermPlusNerdFontMono", "monospace"; + font-size: 20pt; + color: "#00cc00"; + background-color: "#000200"; + border: 0px solid "#000200"; +} + +QStatusBar { + font-size: 12pt; + color: "#000200"; + background-color: "#00cc00"; +} + +QLabel#msg_label { + font-size: 12pt; + color: "#000200"; + background-color: "#00cc00"; +} + +QLabel#info_label { + font-size: 12pt; + color: "#000200"; + background-color: "#00cc00"; +} + +QLabel#avatar_label { + background-color: "#00cc00"; +} + +/* main window */ +QWidget { +} + +QGroupBox { + text-decoration: underline "#00cc00"; + font-size: 17pt; + border: 4px solid ; + border-radius: 0px; + margin-top: 1ex; /* leave space at the top for the title */ +} + +QGroupBox::title { + subcontrol-origin: margin; + subcontrol-position: top left; + border-radius: 0px; + padding: 0 2px; +} + +QLabel { +} + +/* text entry */ +QLineEdit { + font-size: 18pt; + border-radius: 0px; + padding: 0 4px; + selection-background-color: "#00cc00"; +} + +QTextEdit, QListView { + font-size: 10pt; +} + +QPushButton { + color: "#000200"; + background-color: "#00cc00"; + border-radius: 0px; + padding: 1px; +} + + +QPushButton:pressed { + color: "#00cc00"; + background-color: "#000200"; +} + +QPushButton:flat { + border: none; /* no border for a flat push button */ +} + +QPushButton:default { + border-color: "#00cc00"; +} + +QMenuBar { + background-color: "#00cc00"; + spacing: 3px; /* spacing between menu bar items */ +} + +QMenuBar::item { + padding: 1px 4px; + background: transparent; + border-radius: 4px; +} + +QCheckBox { + spacing: 5px; +} + +QCheckBox::indicator { + width: 13px; + height: 13px; + border: 2px solid "#00cc00"; +} + +QCheckBox::indicator:unchecked { +} + +/* QCheckBox::indicator:unchecked:pressed { */ +/* image: url(:/images/checkbox_unchecked_pressed.png); */ +/* } */ + +QCheckBox::indicator:checked { + background: "#00cc00"; +} + +QSlider::groove:horizontal { + height: 10px; /* the groove expands to the size of the slider by default. by giving it a height, it has a fixed size */ + background: "#00cc00"; + margin: 50px 0; +} + +QSlider::handle:horizontal { + background: "#00cc00"; + width: 20px; + margin: -50px 0; /* handle is placed by default on the contents rect of the groove. Expand outside the groove */ + border-radius: 3px; +} + +QScrollBar:horizontal { + border: 4px solid "#00cc00"; +} + +QScrollBar::handle:horizontal { + height: 16px; + background-color: "#00cc00"; +} + +QScrollBar::add-line:horizontal { + border: 4px solid "#00cc00"; +} + +QScrollBar::sub-line:horizontal { + border: 4px solid "#00cc00"; +} + +QScrollBar:vertical { + border: 4px solid "#00cc00"; +} + +QScrollBar::handle:vertical { + width: 16px; + background-color: "#00cc00"; +} + +QScrollBar::add-line:vertical { + border: 4px solid "#00cc00"; +} + +QScrollBar::sub-line:vertical { + border: 4px solid "#00cc00"; +} + +/* Local Variables: */ +/* mode: css */ +/* End: */ diff --git a/gui/worker.cc b/gui/worker.cc index 2612eb1..ba0723e 100644 --- a/gui/worker.cc +++ b/gui/worker.cc @@ -1,58 +1,24 @@ -#include "worker.h" - -Worker::Worker(QObject *parent) : QObject(parent) {} - -void Worker::configure(std::vector<int> ways, std::vector<int> size, bool is_pipelined, bool is_cache_enabled) { - this->d = new Dram(ways.size()+10); - setWays(ways); - setSize(size); - qDebug() << "is cache enabled:" << is_cache_enabled; - qDebug() << "is pipelined:" << is_pipelined; - this->cache_enabled = is_cache_enabled; - if (!is_cache_enabled || ways.size() == 0) { - this->ct = new Controller(wb_stage, this->d, is_pipelined); - } else { - // 0th index cache has largest delay - for(int i=0;i<ways.size();i++) { - if(i==0){ - Cache* cache = new Cache(this->d, size[i], ways[i], ways.size()); - this->c.push_back(cache); - } else { - Cache* cache = new Cache(this->c[i-1], size[i], ways[i], ways.size()-i); - this->c.push_back(cache); - } - } - this->ct = new Controller(wb_stage, this->c.at(ways.size()-1), is_pipelined); - } - emit clock_cycles(this->ct->get_clock_cycle(), this->ct->get_pc()); -} +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu -void Worker::setWays(std::vector<int> ways) { - this->cache_ways = ways; -} +// 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. -void Worker::setSize(std::vector<int> size) { - this->cache_size = size; -} +// 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. -std::vector<int> Worker::getWays() { - return this->cache_ways; -} +// You should have received a copy of the GNU General Public License +// along with this program. If not, see <https://www.gnu.org/licenses/>. -std::vector<int> Worker::getSize() { - return this->cache_size; -} +#include "worker.h" +#include "storage.h" -void Worker::doWork() -{ - qDebug() << "Initializing..."; - - this->if_stage = new IF(nullptr); - this->id_stage = new ID(if_stage); - this->ex_stage = new EX(id_stage); - this->mm_stage = new MM(ex_stage); - this->wb_stage = new WB(mm_stage); -} +Worker::Worker(QObject *parent) : QObject(parent) {} Worker::~Worker() { @@ -60,62 +26,60 @@ Worker::~Worker() qDebug() << "Worker destructor called in thread:" << QThread::currentThread(); delete this->ct; - for(Cache *cache: this->c) { - delete cache; - } } -void Worker::loadProgram(std::vector<signed int> p) { - this->d->load(p); -} - -void Worker::refreshDram() +void Worker::configure( + std::vector<unsigned int> ways, + std::vector<signed int> program, + bool is_pipelined) { - qDebug() << "Refreshing Dram"; - emit dram_storage(this->d->view(0, 255)); -} + Dram *d; + Storage *s; + Stage *old; + int i; -void Worker::refreshCache() -{ - qDebug() << "Refreshing Cache"; - if(getWays().size() > 0) { - unsigned int size = this->c.at(getWays().size()-1)->get_size(); - emit cache_storage(this->c.at(getWays().size()-1)->view(0, 1<<size)); + this->ct_mutex.lock(); + if (ways.size() != 0) { + // TODO optimal proper sizes + this->size_inc = ((MEM_LINE_SPEC * 0.75) / ways.size()); } -} + d = new Dram(DRAM_DELAY); + s = static_cast<Storage *>(d); -void Worker::refreshRegisters() -{ - qDebug() << "Refreshing Registers"; - emit register_storage(this->ct->get_gprs()); -} + this->s.push_front(s); + d->load(program); -void Worker::runSteps(int steps) -{ - qDebug() << "Running for steps: " << steps; - this->ct->run_for(steps); - emit dram_storage(this->d->view(0, 255)); - if(this->cache_enabled && getWays().size() > 0) { - unsigned int size = this->c.at(getWays().size()-1)->get_size(); - emit cache_storage(this->c.at(getWays().size()-1)->view(0, 1<<size)); + for (i = ways.size(); i > 0; --i) { + s = static_cast<Storage *>(new Cache( + s, this->size_inc * (i), ways.at(i - 1), CACHE_DELAY + i)); + this->s.push_front(s); } - emit register_storage(this->ct->get_gprs()); + + this->if_stage = new IF(nullptr); + this->id_stage = new ID(if_stage); + this->ex_stage = new EX(id_stage); + this->mm_stage = new MM(ex_stage); + this->wb_stage = new WB(mm_stage); + + old = static_cast<Stage *>(this->ct); + this->ct = new Controller(wb_stage, s, is_pipelined); + if (old) + delete old; + this->ct_mutex.unlock(); + + std::cout << this->ct->get_clock_cycle() << ":" << this->ct->get_pc() << std::endl; emit clock_cycles(this->ct->get_clock_cycle(), this->ct->get_pc()); - emit if_info(this->if_stage->stage_info()); - emit id_info(this->id_stage->stage_info()); - emit ex_info(this->ex_stage->stage_info()); - emit mm_info(this->mm_stage->stage_info()); - emit wb_info(this->wb_stage->stage_info()); } -void Worker::runStep() +void Worker::runSteps(int steps) { - qDebug() << "Running for 1 step "; - this->ct->advance(WAIT); - emit dram_storage(this->d->view(0, 255)); - if(this->cache_enabled && getWays().size() > 0) { - unsigned int size = this->c.at(getWays().size()-1)->get_size(); - emit cache_storage(this->c.at(getWays().size()-1)->view(0, 1<<size)); + this->ct_mutex.lock(); + qDebug() << "Running for " << steps << "steps"; + this->ct->run_for(steps); + // TODO move these to separate functions + emit dram_storage(this->s.back()->view(0, 255)); + if (this->s.size() > 1) { + emit cache_storage(this->s.at(0)->view(0, 1 << this->size_inc)); } emit register_storage(this->ct->get_gprs()); emit clock_cycles(this->ct->get_clock_cycle(), this->ct->get_pc()); @@ -124,4 +88,5 @@ void Worker::runStep() emit ex_info(this->ex_stage->stage_info()); emit mm_info(this->mm_stage->stage_info()); emit wb_info(this->wb_stage->stage_info()); + this->ct_mutex.unlock(); } diff --git a/gui/worker.h b/gui/worker.h index fe539fe..62c8d84 100644 --- a/gui/worker.h +++ b/gui/worker.h @@ -1,64 +1,85 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef WORKER_H #define WORKER_H -#include <QObject> -#include <QThread> -#include <QDebug> - +#include "cache.h" #include "controller.h" #include "dram.h" -#include "cache.h" +#include "ex.h" #include "id.h" #include "if.h" -#include "ex.h" #include "mm.h" #include "wb.h" +#include <QDebug> +#include <QMutex> +#include <QObject> +#include <QThread> +#include <deque> + +class Worker : public QObject +{ + Q_OBJECT + + private: + /** + * The storage objects, stored smallest to largest. + */ + std::deque<Storage *> s; + IF *if_stage; + ID *id_stage; + EX *ex_stage; + MM *mm_stage; + WB *wb_stage; -class Worker : public QObject { - Q_OBJECT + Controller *ct = nullptr; + QMutex ct_mutex; -private: - std::vector<Cache*> c; - std::vector<int> cache_ways; - std::vector<int> cache_size; - bool cache_enabled = false; - Dram *d; - Controller *ct; - ID *id_stage; - IF *if_stage; - EX *ex_stage; - MM *mm_stage; - WB *wb_stage; + /** + * The size each progressive cache level increases by. + */ + unsigned int size_inc; -public: - explicit Worker(QObject *parent = nullptr); - ~Worker(); - std::vector<int> getWays(); - std::vector<int> getSize(); - void setWays(std::vector<int> ways); - void setSize(std::vector<int> size); + public: + explicit Worker(QObject *parent = nullptr); + ~Worker(); + QMutex &get_ct_mutex() { return ct_mutex; } -public slots: - void doWork(); - void refreshDram(); - void loadProgram(std::vector<signed int> p); - void configure(std::vector<int> ways, std::vector<int> size, bool is_pipelined, bool is_cache_enabled); - void refreshCache(); - void refreshRegisters(); - void runSteps(int steps); - void runStep(); + public slots: + void runSteps(int steps); + void configure( + std::vector<unsigned int> ways, + std::vector<signed int> program, + bool is_pipelined); -signals: - void clock_cycles(int value, int pc); - void dram_storage(const std::vector<std::array<signed int, LINE_SIZE>> data); - void cache_storage(const std::vector<std::array<signed int, LINE_SIZE>> data); - void register_storage(const std::array<int, GPR_NUM> data); - void if_info(const std::vector<int> info); - void id_info(const std::vector<int> info); - void ex_info(const std::vector<int> info); - void mm_info(const std::vector<int> info); - void wb_info(const std::vector<int> info); - void finished(); + signals: + void clock_cycles(int value, int pc); + void + dram_storage(const std::vector<std::array<signed int, LINE_SIZE>> data); + void + cache_storage(const std::vector<std::array<signed int, LINE_SIZE>> data); + void register_storage(const std::array<int, GPR_NUM> data); + void if_info(const std::vector<int> info); + void id_info(const std::vector<int> info); + void ex_info(const std::vector<int> info); + void mm_info(const std::vector<int> info); + void wb_info(const std::vector<int> info); + void finished(); }; -#endif // WORKER_H
\ No newline at end of file +#endif // WORKER_H diff --git a/inc/accessor.h b/inc/accessor.h index eb56785..67a68b9 100644 --- a/inc/accessor.h +++ b/inc/accessor.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef ACCESSOR_H #define ACCESSOR_H #include <iostream> diff --git a/inc/controller.h b/inc/controller.h index 778c5bc..b7fa835 100644 --- a/inc/controller.h +++ b/inc/controller.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef CONTROLLER_H #define CONTROLLER_H #include "instrDTO.h" @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef DUM_H #define DUM_H #include "instrDTO.h" @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef EX_H #define EX_H #include "instrDTO.h" @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef ID_H #define ID_H #include "instr.h" @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef IF_H #define IF_H #include "accessor.h" diff --git a/inc/instr.h b/inc/instr.h index 2b1807a..b5b782a 100644 --- a/inc/instr.h +++ b/inc/instr.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef INSTR_H #define INSTR_H #include <functional> diff --git a/inc/instrDTO.h b/inc/instrDTO.h index 72ea67d..d4af389 100644 --- a/inc/instrDTO.h +++ b/inc/instrDTO.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef INSTRDTO_H #define INSTRDTO_H #include "accessor.h" diff --git a/inc/logger.h b/inc/logger.h index 88f9e30..9df014b 100644 --- a/inc/logger.h +++ b/inc/logger.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef LOGGER_H #define LOGGER_H #include <fstream> @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef MM_H #define MM_H #include "instrDTO.h" diff --git a/inc/pipe_spec.h b/inc/pipe_spec.h index d211b72..0433f23 100644 --- a/inc/pipe_spec.h +++ b/inc/pipe_spec.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef PIPE_SPEC_H #define PIPE_SPEC_H #include "logger.h" @@ -49,6 +66,16 @@ #define MAX_INT 2147483647 /** + * The delay on DRAM objects. + */ +#define DRAM_DELAY 10 + +/** + * The (base) on cache objects. + */ +#define CACHE_DELAY 1 + +/** * Return the N least-significant bits from integer K using a bit mask * @param the integer to be parsed * @param the number of bits to be parsed diff --git a/inc/response.h b/inc/response.h index 05e9352..501923a 100644 --- a/inc/response.h +++ b/inc/response.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef RESPONSE_H #define RESPONSE_H #include <iostream> diff --git a/inc/stage.h b/inc/stage.h index 996c21c..448c61a 100644 --- a/inc/stage.h +++ b/inc/stage.h @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef STAGE_H #define STAGE_H #include "accessor.h" @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #ifndef WB_H #define WB_H #include "instrDTO.h" diff --git a/src/logger/logger.cc b/src/logger/logger.cc index b07e66f..a665dcd 100644 --- a/src/logger/logger.cc +++ b/src/logger/logger.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "logger.h" #include <ctime> #include <fstream> diff --git a/src/sim/controller.cc b/src/sim/controller.cc index db6106c..59fbbb7 100644 --- a/src/sim/controller.cc +++ b/src/sim/controller.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "controller.h" #include "ex.h" #include "response.h" diff --git a/src/sim/dum.cc b/src/sim/dum.cc index ab4eaa4..744c110 100644 --- a/src/sim/dum.cc +++ b/src/sim/dum.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "dum.h" #include "accessor.h" #include "instrDTO.h" diff --git a/src/sim/ex.cc b/src/sim/ex.cc index 62e39c1..f098917 100644 --- a/src/sim/ex.cc +++ b/src/sim/ex.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "ex.h" #include "accessor.h" #include "instrDTO.h" diff --git a/src/sim/id.cc b/src/sim/id.cc index d10d695..3753f83 100644 --- a/src/sim/id.cc +++ b/src/sim/id.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "id.h" #include "accessor.h" #include "instr.h" @@ -204,7 +221,7 @@ std::vector<int> ID::stage_info() { std::vector<int> info; if (this->curr_instr) { - info.push_back(this->curr_instr->get_pc()); + info.push_back(this->curr_instr->is_squashed()); info.push_back(this->curr_instr->get_instr_bits()); } return info; diff --git a/src/sim/if.cc b/src/sim/if.cc index 6494912..e8e7272 100644 --- a/src/sim/if.cc +++ b/src/sim/if.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "if.h" #include "accessor.h" #include "instrDTO.h" @@ -26,7 +43,7 @@ InstrDTO *IF::advance(Response p) std::vector<int> IF::stage_info() { std::vector<int> info; if(this->curr_instr){ - info.push_back(this->curr_instr->get_pc()); + info.push_back(this->curr_instr->is_squashed()); info.push_back(this->curr_instr->get_instr_bits()); } return info; diff --git a/src/sim/instr.cc b/src/sim/instr.cc index 8bbd0b5..c8d1039 100644 --- a/src/sim/instr.cc +++ b/src/sim/instr.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "instr.h" #include <functional> #include <map> diff --git a/src/sim/instrDTO.cc b/src/sim/instrDTO.cc index fb6c82b..00b6d5f 100644 --- a/src/sim/instrDTO.cc +++ b/src/sim/instrDTO.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "instrDTO.h" #include "accessor.h" diff --git a/src/sim/mm.cc b/src/sim/mm.cc index a02ca83..e1057d5 100644 --- a/src/sim/mm.cc +++ b/src/sim/mm.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "mm.h" #include "accessor.h" #include "instrDTO.h" diff --git a/src/sim/stage.cc b/src/sim/stage.cc index d65ca87..35c6936 100644 --- a/src/sim/stage.cc +++ b/src/sim/stage.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "stage.h" #include <array> #include <deque> @@ -59,7 +76,7 @@ std::vector<int> Stage::stage_info() std::vector<int> info; if (this->curr_instr) { info.push_back(this->curr_instr->get_mnemonic()); - info.push_back(this->curr_instr->get_pc()); + info.push_back(this->curr_instr->is_squashed()); info.push_back(this->curr_instr->get_s1()); info.push_back(this->curr_instr->get_s2()); info.push_back(this->curr_instr->get_s3()); diff --git a/src/sim/wb.cc b/src/sim/wb.cc index c62468c..fbbdd4c 100644 --- a/src/sim/wb.cc +++ b/src/sim/wb.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "wb.h" #include "accessor.h" #include "instrDTO.h" diff --git a/src/utils/accessor.cc b/src/utils/accessor.cc index 99347ed..c49a2b2 100644 --- a/src/utils/accessor.cc +++ b/src/utils/accessor.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "accessor.h" #include <iostream> diff --git a/src/utils/response.cc b/src/utils/response.cc index 3d6e439..d56419a 100644 --- a/src/utils/response.cc +++ b/src/utils/response.cc @@ -1,3 +1,20 @@ +// Simulator for the RISC-V[ECTOR] mini-ISA +// Copyright (C) 2025 Siddarth Suresh +// Copyright (C) 2025 bdunahu + +// 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 <https://www.gnu.org/licenses/>. + #include "response.h" #include <iostream> |