diff options
62 files changed, 3091 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e14702f --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.* +!.gitignore + +# Qt stuff +*.pro.user* +*.qbs.user* + +# Common test directory +test_dir diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..f223231 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "compiler/crosstool-ng"] + path = compiler/crosstool-ng + url = https://github.com/crosstool-ng/crosstool-ng @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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: + + {project} Copyright (C) {year} {fullname} + 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 +<http://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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb60441 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +QtMips +====== +MIPS CPU simulator for education purposes. + +Dependencies +------------ +* Qt 5 (version 4 is not tested but it might work) +* libelf + +Compilation +----------- +To compile whole project just run these commands: +``` +qmake /path/to/qtmips +make +``` +Where `/path/to/qtmips` is path to this project root. + +Running +------- +Because simulator it self is implemented as library you need to have that library +in common path where loader can found it. Which is not commonly a case, so you can +also run it using this command (in case of cli version, gui version is the same) +``` +LD_LIBRARY_PATH=qtmips_machine qtmips_cli/qtmips_cli +``` + +Tests +----- +There are two types of tests in QtMips. One type are unit tests for simulator it +self and second one are integration tests with command line client and real +compiled elf binaries. All these tests can be executed using script +`tests/run-all.sh` or one by one by running respective `test.sh` scripts. + +Source files for unit tests can be found in path `qtmips_machine/tests` and +integration tests are located in `tests` directory. + +Not implemented features +------------------------ +These are features that are not implemented and are not currently being planned as +being so. + +* Privileged instructions and all features dependent on it +* Coprocessors (so no floating point unit nor any other type) +* Peripherals @@ -0,0 +1,4 @@ +* Firm endianity support +* Gui +* Full unprivileged instructions support +* Windows support diff --git a/compiler/compile.sh b/compiler/compile.sh new file mode 100755 index 0000000..2fb5f1d --- /dev/null +++ b/compiler/compile.sh @@ -0,0 +1,40 @@ +#!/bin/sh +# This script compiles compilation tools for mips to be used with qtmips +set -e + +INST_PREFIX="$(pwd)" + +INST_CT_PREFIX="$INST_PREFIX/ct-ng" +mkdir -p "$INST_CT_PREFIX" + +# First update git submodule +pushd "$(dirname "$0")" >/dev/null +git submodule update crosstool-ng + +pushd crosstool-ng >/dev/null + +# Now compile it +# TODO don't compile it in place? +./bootstrap +./configure --prefix="$INST_CT_PREFIX" +make +make install +# TODO do cleanups? + +popd >/dev/null + +popd >/dev/null + +# Copy configuration +cp "$(dirname "$0")/config" ct-ng/.config + +pushd ct-ng >/dev/null + +# And compile +./bin/ct-ng oldconfig +CT_PREFIX="$INST_PREFIX" ./bin/ct-ng build + +popd >/dev/null + +# Cleanup installed crosstool-ng +rm -rf ct-ng diff --git a/compiler/config b/compiler/config new file mode 100644 index 0000000..3e135f0 --- /dev/null +++ b/compiler/config @@ -0,0 +1,461 @@ +# +# Automatically generated file; DO NOT EDIT. +# Crosstool-NG Configuration +# +CT_CONFIGURE_has_static_link=y +CT_CONFIGURE_has_wget=y +CT_CONFIGURE_has_curl=y +CT_CONFIGURE_has_stat_flavor_GNU=y +CT_CONFIGURE_has_make_3_81_or_newer=y +CT_CONFIGURE_has_libtool_2_4_or_newer=y +CT_CONFIGURE_has_libtoolize_2_4_or_newer=y +CT_CONFIGURE_has_autoconf_2_63_or_newer=y +CT_CONFIGURE_has_autoreconf_2_63_or_newer=y +CT_CONFIGURE_has_automake_1_15_or_newer=y +CT_CONFIGURE_has_gnu_m4_1_4_12_or_newer=y +CT_CONFIGURE_has_svn=y +CT_CONFIGURE_has_git=y +CT_MODULES=y + +# +# Paths and misc options +# + +# +# crosstool-NG behavior +# +# CT_OBSOLETE is not set +# CT_EXPERIMENTAL is not set +# CT_DEBUG_CT is not set + +# +# Paths +# +CT_LOCAL_TARBALLS_DIR="${HOME}/src" +CT_SAVE_TARBALLS=y +CT_WORK_DIR="${CT_TOP_DIR}/.build" +CT_BUILD_TOP_DIR="${CT_WORK_DIR}/${CT_HOST:+HOST-${CT_HOST}/}${CT_TARGET}" +CT_PREFIX_DIR="${CT_PREFIX:-${HOME}/x-tools}/${CT_HOST:+HOST-${CT_HOST}/}${CT_TARGET}" +CT_RM_RF_PREFIX_DIR=y +CT_REMOVE_DOCS=y +CT_PREFIX_DIR_RO=y +CT_STRIP_HOST_TOOLCHAIN_EXECUTABLES=y +# CT_STRIP_TARGET_TOOLCHAIN_EXECUTABLES is not set + +# +# Downloading +# +CT_DOWNLOAD_AGENT_WGET=y +# CT_DOWNLOAD_AGENT_CURL is not set +# CT_DOWNLOAD_AGENT_NONE is not set +# CT_FORBID_DOWNLOAD is not set +# CT_FORCE_DOWNLOAD is not set +CT_CONNECT_TIMEOUT=10 +CT_DOWNLOAD_WGET_OPTIONS="--passive-ftp --tries=3 -nc --progress=dot:binary" +# CT_ONLY_DOWNLOAD is not set +# CT_USE_MIRROR is not set + +# +# Extracting +# +# CT_FORCE_EXTRACT is not set +CT_OVERRIDE_CONFIG_GUESS_SUB=y +# CT_ONLY_EXTRACT is not set +CT_PATCH_BUNDLED=y +# CT_PATCH_LOCAL is not set +# CT_PATCH_BUNDLED_LOCAL is not set +# CT_PATCH_LOCAL_BUNDLED is not set +# CT_PATCH_BUNDLED_FALLBACK_LOCAL is not set +# CT_PATCH_LOCAL_FALLBACK_BUNDLED is not set +# CT_PATCH_NONE is not set +CT_PATCH_ORDER="bundled" + +# +# Build behavior +# +CT_PARALLEL_JOBS=0 +CT_LOAD="" +CT_USE_PIPES=y +CT_EXTRA_CFLAGS_FOR_BUILD="" +CT_EXTRA_LDFLAGS_FOR_BUILD="" +CT_EXTRA_CFLAGS_FOR_HOST="" +CT_EXTRA_LDFLAGS_FOR_HOST="" +# CT_CONFIG_SHELL_SH is not set +# CT_CONFIG_SHELL_ASH is not set +CT_CONFIG_SHELL_BASH=y +# CT_CONFIG_SHELL_CUSTOM is not set +CT_CONFIG_SHELL="${bash}" + +# +# Logging +# +# CT_LOG_ERROR is not set +# CT_LOG_WARN is not set +# CT_LOG_INFO is not set +CT_LOG_EXTRA=y +# CT_LOG_ALL is not set +# CT_LOG_DEBUG is not set +CT_LOG_LEVEL_MAX="EXTRA" +# CT_LOG_SEE_TOOLS_WARN is not set +CT_LOG_PROGRESS_BAR=y +CT_LOG_TO_FILE=y +CT_LOG_FILE_COMPRESS=y + +# +# Target options +# +CT_ARCH="mips" +# CT_ARCH_alpha is not set +# CT_ARCH_arm is not set +# CT_ARCH_avr is not set +# CT_ARCH_m68k is not set +CT_ARCH_mips=y +# CT_ARCH_nios2 is not set +# CT_ARCH_powerpc is not set +# CT_ARCH_s390 is not set +# CT_ARCH_sh is not set +# CT_ARCH_sparc is not set +# CT_ARCH_x86 is not set +# CT_ARCH_xtensa is not set +CT_ARCH_alpha_AVAILABLE=y +CT_ARCH_arm_AVAILABLE=y +CT_ARCH_avr_AVAILABLE=y +CT_ARCH_m68k_AVAILABLE=y +CT_ARCH_microblaze_AVAILABLE=y +CT_ARCH_mips_AVAILABLE=y +CT_ARCH_nios2_AVAILABLE=y +CT_ARCH_powerpc_AVAILABLE=y +CT_ARCH_s390_AVAILABLE=y +CT_ARCH_sh_AVAILABLE=y +CT_ARCH_sparc_AVAILABLE=y +CT_ARCH_x86_AVAILABLE=y +CT_ARCH_xtensa_AVAILABLE=y +CT_ARCH_SUFFIX="" + +# +# Generic target options +# +# CT_MULTILIB is not set +CT_DEMULTILIB=y +CT_ARCH_USE_MMU=y +CT_ARCH_SUPPORTS_BOTH_ENDIAN=y +CT_ARCH_DEFAULT_BE=y +CT_ARCH_BE=y +# CT_ARCH_LE is not set +CT_ARCH_ENDIAN="big" +CT_ARCH_SUPPORTS_32=y +CT_ARCH_SUPPORTS_64=y +CT_ARCH_DEFAULT_32=y +CT_ARCH_BITNESS=32 +CT_ARCH_32=y +# CT_ARCH_64 is not set + +# +# Target optimisations +# +CT_ARCH_SUPPORTS_WITH_ARCH=y +CT_ARCH_SUPPORTS_WITH_TUNE=y +CT_ARCH_SUPPORTS_WITH_FLOAT=y +CT_ARCH_ARCH="" +CT_ARCH_TUNE="" +# CT_ARCH_FLOAT_AUTO is not set +# CT_ARCH_FLOAT_HW is not set +CT_ARCH_FLOAT_SW=y +CT_TARGET_CFLAGS="" +CT_TARGET_LDFLAGS="" +CT_ARCH_FLOAT="soft" +# CT_ARCH_ALPHA_EV4 is not set +# CT_ARCH_ALPHA_EV45 is not set +# CT_ARCH_ALPHA_EV5 is not set +# CT_ARCH_ALPHA_EV56 is not set +# CT_ARCH_ALPHA_EV6 is not set +# CT_ARCH_ALPHA_EV67 is not set + +# +# mips other options +# +CT_ARCH_mips_o32=y +CT_ARCH_mips_ABI="32" + +# +# Toolchain options +# + +# +# General toolchain options +# +CT_WANTS_STATIC_LINK=y +CT_WANTS_STATIC_LINK_CXX=y +CT_STATIC_TOOLCHAIN=y +CT_TOOLCHAIN_PKGVERSION="" +CT_TOOLCHAIN_BUGURL="" + +# +# Tuple completion and aliasing +# +CT_TARGET_VENDOR="qtmips" +CT_TARGET_ALIAS_SED_EXPR="" +CT_TARGET_ALIAS="" + +# +# Toolchain type +# +CT_CROSS=y +# CT_CANADIAN is not set +CT_TOOLCHAIN_TYPE="cross" + +# +# Build system +# +CT_BUILD="" +CT_BUILD_PREFIX="" +CT_BUILD_SUFFIX="" + +# +# Misc options +# +# CT_TOOLCHAIN_ENABLE_NLS is not set + +# +# Operating System +# +CT_BARE_METAL=y +CT_KERNEL="bare-metal" +CT_KERNEL_bare_metal=y +# CT_KERNEL_linux is not set +CT_KERNEL_bare_metal_AVAILABLE=y +CT_KERNEL_linux_AVAILABLE=y +CT_KERNEL_windows_AVAILABLE=y + +# +# Common kernel options +# + +# +# Binary utilities +# +CT_ARCH_BINFMT_ELF=y +CT_BINUTILS="binutils" +CT_BINUTILS_binutils=y + +# +# GNU binutils +# +CT_BINUTILS_VERSION="2.28" +# CT_BINUTILS_SHOW_LINARO is not set +CT_BINUTILS_V_2_28=y +# CT_BINUTILS_V_2_27 is not set +# CT_BINUTILS_V_2_26 is not set +CT_BINUTILS_2_27_or_later=y +CT_BINUTILS_2_26_or_later=y +CT_BINUTILS_2_25_1_or_later=y +CT_BINUTILS_2_25_or_later=y +CT_BINUTILS_2_24_or_later=y +CT_BINUTILS_2_23_2_or_later=y +CT_BINUTILS_HAS_HASH_STYLE=y +CT_BINUTILS_HAS_GOLD=y +CT_BINUTILS_HAS_PLUGINS=y +CT_BINUTILS_HAS_PKGVERSION_BUGURL=y +CT_BINUTILS_LINKER_LD=y +CT_BINUTILS_LINKERS_LIST="ld" +CT_BINUTILS_LINKER_DEFAULT="bfd" +CT_BINUTILS_EXTRA_CONFIG_ARRAY="" + +# +# binutils other options +# + +# +# C-library +# +CT_LIBC="newlib" +CT_LIBC_VERSION="2.5.0.20170323" +CT_LIBC_newlib=y +# CT_LIBC_none is not set +CT_LIBC_avr_libc_AVAILABLE=y +CT_LIBC_glibc_AVAILABLE=y +CT_THREADS="none" +CT_LIBC_mingw_AVAILABLE=y +CT_LIBC_musl_AVAILABLE=y +CT_LIBC_newlib_AVAILABLE=y +# CT_CC_NEWLIB_SHOW_LINARO is not set +CT_LIBC_NEWLIB_V_2_5_0=y +# CT_LIBC_NEWLIB_V_2_4_0 is not set +# CT_LIBC_NEWLIB_V_2_3_0 is not set +# CT_LIBC_NEWLIB_V_2_2_0 is not set +# CT_LIBC_NEWLIB_V_2_1_0 is not set +# CT_LIBC_NEWLIB_V_2_0_0 is not set +# CT_LIBC_NEWLIB_V_1_20_0 is not set +# CT_LIBC_NEWLIB_V_1_19_0 is not set +# CT_LIBC_NEWLIB_V_1_18_0 is not set +# CT_LIBC_NEWLIB_V_1_17_0 is not set +CT_LIBC_NEWLIB_2_5=y +CT_LIBC_NEWLIB_2_5_or_later=y +CT_LIBC_NEWLIB_2_4_or_later=y +CT_LIBC_NEWLIB_2_3_or_later=y +CT_LIBC_NEWLIB_2_2_or_later=y +CT_LIBC_NEWLIB_2_1_or_later=y +CT_LIBC_NEWLIB_2_0_or_later=y +CT_LIBC_NEWLIB_TARGET_CFLAGS="" +CT_LIBC_none_AVAILABLE=y +CT_LIBC_uClibc_AVAILABLE=y +CT_LIBC_SUPPORT_THREADS_NONE=y +CT_LIBC_PROVIDES_CXA_ATEXIT=y + +# +# Common C library options +# +CT_THREADS_NONE=y + +# +# newlib other options +# +# CT_LIBC_NEWLIB_IO_C99FMT is not set +# CT_LIBC_NEWLIB_IO_LL is not set +# CT_LIBC_NEWLIB_IO_FLOAT is not set +# CT_LIBC_NEWLIB_IO_POS_ARGS is not set +CT_LIBC_NEWLIB_FVWRITE_IN_STREAMIO=y +CT_LIBC_NEWLIB_UNBUF_STREAM_OPT=y +CT_LIBC_NEWLIB_FSEEK_OPTIMIZATION=y +# CT_LIBC_NEWLIB_DISABLE_SUPPLIED_SYSCALLS is not set +# CT_LIBC_NEWLIB_REGISTER_FINI is not set +CT_LIBC_NEWLIB_ATEXIT_DYNAMIC_ALLOC=y +# CT_LIBC_NEWLIB_GLOBAL_ATEXIT is not set +# CT_LIBC_NEWLIB_LITE_EXIT is not set +# CT_LIBC_NEWLIB_REENT_SMALL is not set +CT_LIBC_NEWLIB_MULTITHREAD=y +# CT_LIBC_NEWLIB_EXTRA_SECTIONS is not set +CT_LIBC_NEWLIB_WIDE_ORIENT=y +CT_LIBC_NEWLIB_ENABLE_TARGET_OPTSPACE=y +# CT_LIBC_NEWLIB_NANO_MALLOC is not set +# CT_LIBC_NEWLIB_NANO_FORMATTED_IO is not set +CT_LIBC_NEWLIB_EXTRA_CONFIG_ARRAY="" + +# +# C compiler +# +CT_CC="gcc" +CT_CC_CORE_PASS_2_NEEDED=y +CT_CC_gcc=y +CT_CC_GCC_VERSION="6.3.0" +# CT_CC_GCC_SHOW_LINARO is not set +CT_CC_GCC_V_6_3_0=y +# CT_CC_GCC_V_5_4_0 is not set +# CT_CC_GCC_V_4_9_4 is not set +CT_CC_GCC_4_8_or_later=y +CT_CC_GCC_4_9_or_later=y +CT_CC_GCC_5_or_later=y +CT_CC_GCC_6=y +CT_CC_GCC_6_or_later=y +CT_CC_GCC_HAS_LIBMPX=y +CT_CC_GCC_ENABLE_CXX_FLAGS="" +CT_CC_GCC_CORE_EXTRA_CONFIG_ARRAY="" +CT_CC_GCC_EXTRA_CONFIG_ARRAY="" +# CT_CC_GCC_TARGET_FINAL is not set +CT_CC_GCC_STATIC_LIBSTDCXX=y +# CT_CC_GCC_SYSTEM_ZLIB is not set +CT_CC_GCC_CONFIG_TLS=m + +# +# Optimisation features +# +CT_CC_GCC_USE_GRAPHITE=y + +# +# Settings for libraries running on target +# +CT_CC_GCC_ENABLE_TARGET_OPTSPACE=y +# CT_CC_GCC_LIBMUDFLAP is not set +# CT_CC_GCC_LIBSSP is not set +# CT_CC_GCC_LIBQUADMATH is not set + +# +# Misc. obscure options. +# +CT_CC_CXA_ATEXIT=y +# CT_CC_GCC_DISABLE_PCH is not set +CT_CC_GCC_LDBL_128=m +# CT_CC_GCC_BUILD_ID is not set +CT_CC_GCC_LNK_HASH_STYLE_DEFAULT=y +# CT_CC_GCC_LNK_HASH_STYLE_SYSV is not set +# CT_CC_GCC_LNK_HASH_STYLE_GNU is not set +# CT_CC_GCC_LNK_HASH_STYLE_BOTH is not set +CT_CC_GCC_LNK_HASH_STYLE="" +CT_CC_GCC_DEC_FLOAT_AUTO=y +# CT_CC_GCC_DEC_FLOAT_BID is not set +# CT_CC_GCC_DEC_FLOAT_DPD is not set +# CT_CC_GCC_DEC_FLOATS_NO is not set +CT_CC_GCC_HAS_ARCH_OPTIONS=y + +# +# archictecture-specific options +# +CT_CC_GCC_mips_llsc=m +CT_CC_GCC_mips_synci=m +# CT_CC_GCC_mips_plt is not set +CT_CC_SUPPORT_CXX=y +CT_CC_SUPPORT_FORTRAN=y +CT_CC_SUPPORT_JAVA=y +CT_CC_SUPPORT_ADA=y +CT_CC_SUPPORT_OBJC=y +CT_CC_SUPPORT_OBJCXX=y +CT_CC_SUPPORT_GOLANG=y + +# +# Additional supported languages: +# +# CT_CC_LANG_CXX is not set +# CT_CC_LANG_FORTRAN is not set + +# +# Debug facilities +# +# CT_DEBUG_gdb is not set +# CT_DEBUG_ltrace is not set +# CT_DEBUG_strace is not set + +# +# Companion libraries +# +CT_COMPLIBS_NEEDED=y +CT_GMP_NEEDED=y +CT_MPFR_NEEDED=y +CT_ISL_NEEDED=y +CT_MPC_NEEDED=y +CT_COMPLIBS=y +# CT_LIBICONV is not set +# CT_GETTEXT is not set +CT_GMP=y +CT_MPFR=y +CT_ISL=y +CT_MPC=y +# CT_ZLIB is not set +CT_GMP_V_6_1_2=y +CT_GMP_5_0_2_or_later=y +CT_GMP_VERSION="6.1.2" +CT_MPFR_V_3_1_5=y +CT_MPFR_VERSION="3.1.5" +CT_ISL_V_0_16_1=y +# CT_ISL_V_0_15 is not set +CT_ISL_V_0_16_or_later=y +CT_ISL_V_0_15_or_later=y +CT_ISL_V_0_14_or_later=y +CT_ISL_V_0_12_or_later=y +CT_ISL_VERSION="0.16.1" +CT_MPC_V_1_0_3=y +CT_MPC_VERSION="1.0.3" + +# +# Companion libraries common options +# +# CT_COMPLIBS_CHECK is not set + +# +# Companion tools +# +# CT_COMP_TOOLS_FOR_HOST is not set +# CT_COMP_TOOLS_autoconf is not set +# CT_COMP_TOOLS_automake is not set +# CT_COMP_TOOLS_libtool is not set +# CT_COMP_TOOLS_m4 is not set +# CT_COMP_TOOLS_make is not set diff --git a/compiler/crosstool-ng b/compiler/crosstool-ng new file mode 160000 +Subproject 368a0169a27313cca60cf7d7358b6f3ef12122e diff --git a/qtmips.pro b/qtmips.pro new file mode 100644 index 0000000..f339831 --- /dev/null +++ b/qtmips.pro @@ -0,0 +1,11 @@ +TEMPLATE = subdirs + +SUBDIRS += \ + qtmips_machine \ + qtmips_machine/tests \ + qtmips_cli \ + qtmips_gui + +qtmips_cli.depends = qtmips_machine +qtmips_gui.depends = qtmips_machine +qtmips_machine-tests.depends = qtmips_machine diff --git a/qtmips_cli/machineapp.cpp b/qtmips_cli/machineapp.cpp new file mode 100644 index 0000000..09fcd3e --- /dev/null +++ b/qtmips_cli/machineapp.cpp @@ -0,0 +1,11 @@ +#include "machineapp.h" +#include <iostream> + +MachineApp::MachineApp(int argc, char **argv) : QCoreApplication(argc, argv) { + connect(this, SIGNAL(aboutToQuit()), this, SLOT(quit())); + // TODO drop hello + std::cout << "Hello\n"; + std::cout.flush(); + // TODO check argc + this->machine = new QtMipsMachine(argv[1]); +} diff --git a/qtmips_cli/machineapp.h b/qtmips_cli/machineapp.h new file mode 100644 index 0000000..6587154 --- /dev/null +++ b/qtmips_cli/machineapp.h @@ -0,0 +1,16 @@ +#ifndef MACHINEAPP_H +#define MACHINEAPP_H + +#include <QCoreApplication> + +#include "qtmipsmachine.h" +#include "programloader.h" + +class MachineApp : public QCoreApplication { +public: + MachineApp(int argc, char **argv); +private: + QtMipsMachine *machine; +}; + +#endif // MACHINEAPP_H diff --git a/qtmips_cli/main.cpp b/qtmips_cli/main.cpp new file mode 100644 index 0000000..780f782 --- /dev/null +++ b/qtmips_cli/main.cpp @@ -0,0 +1,12 @@ +#include <QCoreApplication> +#include <iostream> +#include "machineapp.h" + +#include "instructions/arithmetic.h" + +int main(int argc, char *argv[]) +{ + MachineApp app(argc, argv); + + return app.exec(); +} diff --git a/qtmips_cli/qtmips_cli.pro b/qtmips_cli/qtmips_cli.pro new file mode 100644 index 0000000..a541451 --- /dev/null +++ b/qtmips_cli/qtmips_cli.pro @@ -0,0 +1,22 @@ +QT += core +QT -= gui + +TARGET = qtmips_cli +CONFIG += console +CONFIG -= app_bundle +CONFIG += c++11 + +TEMPLATE = app + +LIBS += -L$$OUT_PWD/../qtmips_machine/ -lqtmips_machine +INCLUDEPATH += $$PWD/../qtmips_machine +DEPENDPATH += $$PWD/../qtmips_machine +QMAKE_CXXFLAGS += -std=c++0x + +DEFINES += QT_DEPRECATED_WARNINGS + +SOURCES += main.cpp \ + machineapp.cpp + +HEADERS += \ + machineapp.h diff --git a/qtmips_gui/main.cpp b/qtmips_gui/main.cpp new file mode 100644 index 0000000..b48f94e --- /dev/null +++ b/qtmips_gui/main.cpp @@ -0,0 +1,11 @@ +#include "mainwindow.h" +#include <QApplication> + +int main(int argc, char *argv[]) +{ + QApplication a(argc, argv); + MainWindow w; + w.show(); + + return a.exec(); +} diff --git a/qtmips_gui/mainwindow.cpp b/qtmips_gui/mainwindow.cpp new file mode 100644 index 0000000..49d64fc --- /dev/null +++ b/qtmips_gui/mainwindow.cpp @@ -0,0 +1,14 @@ +#include "mainwindow.h" +#include "ui_mainwindow.h" + +MainWindow::MainWindow(QWidget *parent) : + QMainWindow(parent), + ui(new Ui::MainWindow) +{ + ui->setupUi(this); +} + +MainWindow::~MainWindow() +{ + delete ui; +} diff --git a/qtmips_gui/mainwindow.h b/qtmips_gui/mainwindow.h new file mode 100644 index 0000000..a3948a9 --- /dev/null +++ b/qtmips_gui/mainwindow.h @@ -0,0 +1,22 @@ +#ifndef MAINWINDOW_H +#define MAINWINDOW_H + +#include <QMainWindow> + +namespace Ui { +class MainWindow; +} + +class MainWindow : public QMainWindow +{ + Q_OBJECT + +public: + explicit MainWindow(QWidget *parent = 0); + ~MainWindow(); + +private: + Ui::MainWindow *ui; +}; + +#endif // MAINWINDOW_H diff --git a/qtmips_gui/mainwindow.ui b/qtmips_gui/mainwindow.ui new file mode 100644 index 0000000..6050363 --- /dev/null +++ b/qtmips_gui/mainwindow.ui @@ -0,0 +1,24 @@ +<ui version="4.0"> + <class>MainWindow</class> + <widget class="QMainWindow" name="MainWindow" > + <property name="geometry" > + <rect> + <x>0</x> + <y>0</y> + <width>400</width> + <height>300</height> + </rect> + </property> + <property name="windowTitle" > + <string>MainWindow</string> + </property> + <widget class="QMenuBar" name="menuBar" /> + <widget class="QToolBar" name="mainToolBar" /> + <widget class="QWidget" name="centralWidget" /> + <widget class="QStatusBar" name="statusBar" /> + </widget> + <layoutDefault spacing="6" margin="11" /> + <pixmapfunction></pixmapfunction> + <resources/> + <connections/> +</ui> diff --git a/qtmips_gui/qtmips_gui.pro b/qtmips_gui/qtmips_gui.pro new file mode 100644 index 0000000..7dfb53c --- /dev/null +++ b/qtmips_gui/qtmips_gui.pro @@ -0,0 +1,23 @@ +QT += core gui widgets + +TARGET = qtmips_gui +CONFIG += c++11 + +TEMPLATE = app + +LIBS += -L$$OUT_PWD/../qtmips_machine/ -lqtmips_machine +INCLUDEPATH += $$PWD/../qtmips_machine +DEPENDPATH += $$PWD/../qtmips_machine +QMAKE_CXXFLAGS += -std=c++0x + +DEFINES += QT_DEPRECATED_WARNINGS + +SOURCES += \ + main.cpp \ + mainwindow.cpp + +HEADERS += \ + mainwindow.h + +FORMS += \ + mainwindow.ui diff --git a/qtmips_machine/cache.cpp b/qtmips_machine/cache.cpp new file mode 100644 index 0000000..05b26b0 --- /dev/null +++ b/qtmips_machine/cache.cpp @@ -0,0 +1 @@ +#include "cache.h" diff --git a/qtmips_machine/cache.h b/qtmips_machine/cache.h new file mode 100644 index 0000000..280ac05 --- /dev/null +++ b/qtmips_machine/cache.h @@ -0,0 +1,18 @@ +#ifndef CACHE_H +#define CACHE_H + +#include "memory.h" + +class Cache : public MemoryAccess { +public: + Cache(Memory *m); +}; + +class CacheAssociative : public Cache { +public: + CacheAssociative(Memory *m); +}; + +// TODO other chaches + +#endif // CACHE_H diff --git a/qtmips_machine/core.cpp b/qtmips_machine/core.cpp new file mode 100644 index 0000000..a6c92b5 --- /dev/null +++ b/qtmips_machine/core.cpp @@ -0,0 +1,5 @@ +#include "core.h" + +Core::Core() { + +} diff --git a/qtmips_machine/core.h b/qtmips_machine/core.h new file mode 100644 index 0000000..2fd0a40 --- /dev/null +++ b/qtmips_machine/core.h @@ -0,0 +1,21 @@ +#ifndef CORE_H +#define CORE_H + +#include <QObject> +#include "instruction.h" +#include "registers.h" +#include "memory.h" +#include "programloader.h" +#include "programmemory.h" + +class Core : public QObject { + Q_OBJECT +public: + Core(); + +signals: + +public slots: +}; + +#endif // CORE_H diff --git a/qtmips_machine/instruction.cpp b/qtmips_machine/instruction.cpp new file mode 100644 index 0000000..159d443 --- /dev/null +++ b/qtmips_machine/instruction.cpp @@ -0,0 +1,81 @@ +#include "instruction.h" +#include <sstream> +#include <iostream> + +InstructionR::InstructionR(std::uint8_t rs, std::uint8_t rd, std::uint8_t rt, std::uint8_t sa) { + this->rs = rs; + this->rd = rd; + this->rt = rt; + this->sa = sa; +} + +// TODO for registers output as register ($0)! + +std::vector<std::string> InstructionR::to_strs() { + std::vector<std::string> str; + // Instruction name + str.push_back("unknown"); // unknown instruction, should be replaced by child + + std::stringstream ss; + // Source register + ss << std::hex << (unsigned) this->rs; + str.push_back(ss.str()); + ss.str(""); + // Target register + ss << std::hex << (unsigned) this->rt; + str.push_back(ss.str()); + ss.str(""); + // Destination register + ss << std::hex << (unsigned) this->rd; + str.push_back(ss.str()); + ss.str(""); + // Shift amount + ss << std::hex << (unsigned) this->sa; + str.push_back(ss.str()); + + return str; +} + +InstructionI::InstructionI(std::uint8_t rs, std::uint8_t rt, std::uint16_t immediate) { + this->rs = rs; + this->rt = rt; + this->immediage = immediate; +} + +std::vector<std::string> InstructionI::to_strs() { + std::vector<std::string> str; + // Instruction name + str.push_back("unknown"); // unknown instruction, should be replaced by child + + std::stringstream ss; + // Source register + ss << std::hex << (unsigned) this->rs; + str.push_back(ss.str()); + ss.str(""); + // Destination register + ss << std::hex << (unsigned) this->rt; + str.push_back(ss.str()); + ss.str(""); + // Immediate value + ss << std::hex << (unsigned) this->immediage; + str.push_back(ss.str()); + + return str; +} + +InstructionJ::InstructionJ(std::uint32_t address) { + this->address = address; +} + +std::vector<std::string> InstructionJ::to_strs() { + std::vector<std::string> str; + // Instruction name + str.push_back("unknown"); // unknown instruction, should be replaced by child + + std::stringstream ss; + // Source register + ss << std::hex << (unsigned) this->address; + str.push_back(ss.str()); + + return str; +} diff --git a/qtmips_machine/instruction.h b/qtmips_machine/instruction.h new file mode 100644 index 0000000..6ab7015 --- /dev/null +++ b/qtmips_machine/instruction.h @@ -0,0 +1,48 @@ +#ifndef INSTRUCTION_H +#define INSTRUCTION_H + +#include <vector> +#include <string> +#include "registers.h" +#include "memory.h" + +class Instruction { +public: + // TODO return types should be according to what instruction can pass from this stage + //virtual void decode(Registers *regs) = 0; // Read and prepare instructions + //virtual void execute() = 0; // ALU operations + //virtual void memory(Memory *mem) = 0; // Read or write to memory + //virtual void write_back(Registers *regs) = 0; // Write results to registers + + virtual std::vector<std::string> to_strs() = 0; // Returns all fields of instructions in string +}; + +class InstructionR : public Instruction { +public: + InstructionR(std::uint8_t rs, std::uint8_t rd, std::uint8_t rt, std::uint8_t sa); + + std::vector<std::string> to_strs(); +protected: + std::uint8_t rs, rd, rt, sa; +}; + +class InstructionI : public Instruction { +public: + InstructionI(std::uint8_t rs, std::uint8_t rt, std::uint16_t immediate); + + std::vector<std::string> to_strs(); +protected: + std::uint8_t rs, rt; + std::uint16_t immediage; +}; + +class InstructionJ : public Instruction { +public: + InstructionJ(std::uint32_t address); + + std::vector<std::string> to_strs(); +protected: + std::uint32_t address; +}; + +#endif // INSTRUCTION_H diff --git a/qtmips_machine/instructions/arithmetic.cpp b/qtmips_machine/instructions/arithmetic.cpp new file mode 100644 index 0000000..8c8f40e --- /dev/null +++ b/qtmips_machine/instructions/arithmetic.cpp @@ -0,0 +1,87 @@ +#include "instructions/arithmetic.h" +#include <iostream> + +InstructionArithmetic::InstructionArithmetic(enum InstructionArithmeticT type, std::uint8_t rs, std::uint8_t rd, std::uint8_t rt) + : InstructionR(rs, rd, rt, 0) { + this->type = type; +} + +std::vector<std::string> InstructionArithmetic::to_strs() { + std::vector<std::string> str = this->InstructionR::to_strs(); + str.erase(str.begin() + 4); // Drop sa field + switch (this->type) { + case IAT_ADD: + str[0] = "add"; + break; + case IAT_ADDU: + str[0] = "addu"; + break; + case IAT_SUB: + str[0] = "sub"; + break; + case IAT_SUBU: + str[0] = "subu"; + break; + case IAT_AND: + str[0] = "and"; + break; + case IAT_OR: + str[0] = "or"; + break; + case IAT_XOR: + str[0] = "xor"; + break; + case IAT_NOR: + str[0] = "nor"; + break; + case IAT_SLT: + str[0] = "slt"; + break; + case IAT_SLTU: + str[0] = "sltu"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} + +InstructionArithmeticImmediate::InstructionArithmeticImmediate(enum InstructionArithmeticImmediateT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t value) + : InstructionI(rs, rt, value) { + this->type = type; +} + +std::vector<std::string> InstructionArithmeticImmediate::to_strs() { + std::vector<std::string> str = this->InstructionI::to_strs(); + switch (this->type) { + case IAT_ADDI: + str[0] = "addi"; + break; + case IAT_ADDIU: + str[0] = "addiu"; + break; + case IAT_ANDI: + str[0] = "andi"; + break; + case IAT_ORI: + str[0] = "ori"; + break; + case IAT_XORI: + str[0] = "xori"; + break; + case IAT_SLTI: + str[0] = "slti"; + break; + case IAT_SLTIU: + str[0] = "sltiu"; + break; + case IAT_LUI: + str[0] = "lu"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} diff --git a/qtmips_machine/instructions/arithmetic.h b/qtmips_machine/instructions/arithmetic.h new file mode 100644 index 0000000..29f89d2 --- /dev/null +++ b/qtmips_machine/instructions/arithmetic.h @@ -0,0 +1,46 @@ +#ifndef ARITHMETIC_H +#define ARITHMETIC_H + +#include "instruction.h" + +enum InstructionArithmeticT { + IAT_ADD, // Add + IAT_ADDU, // Add unsigned + IAT_SUB, // Subtract + IAT_SUBU, // Subtract unsigned + IAT_AND, + IAT_OR, + IAT_XOR, + IAT_NOR, + IAT_SLT, // set on less than + IAT_SLTU, // set on less than unsigned +}; + +class InstructionArithmetic : public InstructionR { +public: + InstructionArithmetic(enum InstructionArithmeticT type, std::uint8_t rs, std::uint8_t rd, std::uint8_t rt); + std::vector<std::string> to_strs(); +private: + enum InstructionArithmeticT type; +}; + +enum InstructionArithmeticImmediateT { + IAT_ADDI, + IAT_ADDIU, + IAT_ANDI, + IAT_ORI, + IAT_XORI, + IAT_SLTI, + IAT_SLTIU, + IAT_LUI +}; + +class InstructionArithmeticImmediate : public InstructionI { +public: + InstructionArithmeticImmediate(enum InstructionArithmeticImmediateT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t value); + std::vector<std::string> to_strs(); +private: + enum InstructionArithmeticImmediateT type; +}; + +#endif // ARITHMETIC_H diff --git a/qtmips_machine/instructions/jumpbranch.cpp b/qtmips_machine/instructions/jumpbranch.cpp new file mode 100644 index 0000000..2ede399 --- /dev/null +++ b/qtmips_machine/instructions/jumpbranch.cpp @@ -0,0 +1,30 @@ +#include "jumpbranch.h" + +InstructionJump::InstructionJump(bool link, std::uint32_t address) + : InstructionJ(address) { + this->link = link; +} + +std::vector<std::string> InstructionJump::to_strs() { + std::vector<std::string> str = this->InstructionJ::to_strs(); + if (link) + str[0] = "j"; + else + str[0] = "jal"; + return str; +} + +InstructionJumpRegister::InstructionJumpRegister(bool link, std::uint8_t rs) + : InstructionR(rs, 0, 0, 0) { + this->link = link; +} + +std::vector<std::string> InstructionJumpRegister::to_strs() { + std::vector<std::string> str = this->InstructionR::to_strs(); + str.erase(str.begin() + 2, str.end()); // Drop every field after rs + if (link) + str[0] = "j"; + else + str[0] = "jal"; + return str; +} diff --git a/qtmips_machine/instructions/jumpbranch.h b/qtmips_machine/instructions/jumpbranch.h new file mode 100644 index 0000000..b8dee5c --- /dev/null +++ b/qtmips_machine/instructions/jumpbranch.h @@ -0,0 +1,34 @@ +#ifndef JUMPBRANCH_H +#define JUMPBRANCH_H + +#include "instruction.h" + +class InstructionJump : InstructionJ { +public: + InstructionJump(bool link, std::uint32_t address); + std::vector<std::string> to_strs(); +private: + bool link; +}; + +class InstructionJumpRegister : InstructionR { +public: + InstructionJumpRegister(bool link, std::uint8_t rs); + std::vector<std::string> to_strs(); +private: + bool link; +}; + +enum InstructionBranchT { + +}; + +class InstructionBranch : InstructionI { +public: + InstructionBranch(); + std::vector<std::string> to_strs(); +private: + // TODO +}; + +#endif // JUMPBRANCH_H diff --git a/qtmips_machine/instructions/loadstore.cpp b/qtmips_machine/instructions/loadstore.cpp new file mode 100644 index 0000000..c83eae4 --- /dev/null +++ b/qtmips_machine/instructions/loadstore.cpp @@ -0,0 +1,67 @@ +#include "loadstore.h" + +InstructionLoad::InstructionLoad(enum InstructionLoadStoreT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t offset) + : InstructionI(rs, rt, offset) { + this->type = type; +} + +std::vector<std::string> InstructionLoad::to_strs() { + std::vector<std::string> str = this->InstructionI::to_strs(); + switch (this->type) { + case ILST_B: + str[0] = "lb"; + break; + case ILST_HW: + str[0] = "lh"; + break; + case ILST_WL: + str[0] = "lwl"; + break; + case ILST_W: + str[0] = "lw"; + break; + case ILST_BU: + str[0] = "lbu"; + break; + case ILST_HU: + str[0] = "lhu"; + break; + case ILST_WR: + str[0] = "lwr"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} + +InstructionStore::InstructionStore(enum InstructionLoadStoreT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t offset) + : InstructionI(rs, rt, offset) { + this->type = type; +} + +std::vector<std::string> InstructionStore::to_strs() { + std::vector<std::string> str = this->InstructionI::to_strs(); + switch (this->type) { + case ILST_B: + str[0] = "sb"; + break; + case ILST_HW: + str[0] = "sh"; + break; + case ILST_WL: + str[0] = "swl"; + break; + case ILST_W: + str[0] = "sw"; + break; + case ILST_WR: + str[0] = "swr"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} diff --git a/qtmips_machine/instructions/loadstore.h b/qtmips_machine/instructions/loadstore.h new file mode 100644 index 0000000..9741bd7 --- /dev/null +++ b/qtmips_machine/instructions/loadstore.h @@ -0,0 +1,32 @@ +#ifndef LOADSTORE_H +#define LOADSTORE_H + +#include "instruction.h" + +enum InstructionLoadStoreT { + ILST_B, // Byte + ILST_HW, // Half word + ILST_WL, // Word left + ILST_W, // Word + ILST_BU, // Byte unsigned + ILST_HU, // Half word unsigned + ILST_WR // Word right +}; + +class InstructionLoad : public InstructionI { +public: + InstructionLoad(enum InstructionLoadStoreT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t offset); + std::vector<std::string> to_strs(); +private: + enum InstructionLoadStoreT type; +}; + +class InstructionStore : public InstructionI { +public: + InstructionStore(enum InstructionLoadStoreT type, std::uint8_t rs, std::uint8_t rt, std::uint16_t offset); + std::vector<std::string> to_strs(); +private: + enum InstructionLoadStoreT type; +}; + +#endif // LOADSTORE_H diff --git a/qtmips_machine/instructions/nop.cpp b/qtmips_machine/instructions/nop.cpp new file mode 100644 index 0000000..5fd5e47 --- /dev/null +++ b/qtmips_machine/instructions/nop.cpp @@ -0,0 +1,7 @@ +#include "nop.h" + +std::vector<std::string> InstructionNop::to_strs() { + std::vector<std::string> str; + str.push_back("nop"); + return str; +} diff --git a/qtmips_machine/instructions/nop.h b/qtmips_machine/instructions/nop.h new file mode 100644 index 0000000..b098b11 --- /dev/null +++ b/qtmips_machine/instructions/nop.h @@ -0,0 +1,11 @@ +#ifndef NOP_H +#define NOP_H + +#include "instruction.h" + +class InstructionNop : public Instruction { +public: + std::vector<std::string> to_strs(); +}; + +#endif // NOP_H diff --git a/qtmips_machine/instructions/shift.cpp b/qtmips_machine/instructions/shift.cpp new file mode 100644 index 0000000..a8c6e41 --- /dev/null +++ b/qtmips_machine/instructions/shift.cpp @@ -0,0 +1,51 @@ +#include "shift.h" + +InstructionShift::InstructionShift(enum InstructionShiftT type, std::uint8_t rt, std::uint8_t rd, std::uint8_t sa) + : InstructionR(0, rt, rd, sa) { + this->type = type; +} + +std::vector<std::string> InstructionShift::to_strs() { + std::vector<std::string> str = this->InstructionR::to_strs(); + str.erase(str.begin() + 1); // Drop rs field + switch (this->type) { + case IST_LL: + str[0] = "sll"; + break; + case IST_RL: + str[0] = "srl"; + break; + case IST_RA: + str[0] = "sra"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} + +InstructionShiftVariable::InstructionShiftVariable(enum InstructionShiftT type, std::uint8_t rs, std::uint8_t rt, std::uint8_t rd) + : InstructionR(rs, rt, rd, 0) { + this->type = type; +} + +std::vector<std::string> InstructionShiftVariable::to_strs() { + std::vector<std::string> str = this->InstructionR::to_strs(); + str.erase(str.begin() + 4); // Drop sa field + switch (this->type) { + case IST_LL: + str[0] = "sllv"; + break; + case IST_RL: + str[0] = "srlv"; + break; + case IST_RA: + str[0] = "srav"; + break; + default: + // TODO different exception + throw std::exception(); + } + return str; +} diff --git a/qtmips_machine/instructions/shift.h b/qtmips_machine/instructions/shift.h new file mode 100644 index 0000000..9ce29e0 --- /dev/null +++ b/qtmips_machine/instructions/shift.h @@ -0,0 +1,28 @@ +#ifndef SHIFT_H +#define SHIFT_H + +#include "instruction.h" + +enum InstructionShiftT { + IST_LL, // Left logical + IST_RL, // Right logical + IST_RA // Right arithmetic +}; + +class InstructionShift : public InstructionR { +public: + InstructionShift(enum InstructionShiftT type, std::uint8_t rt, std::uint8_t rd, std::uint8_t sa); + std::vector<std::string> to_strs(); +private: + enum InstructionShiftT type; +}; + +class InstructionShiftVariable : public InstructionR { +public: + InstructionShiftVariable(enum InstructionShiftT type, std::uint8_t rs, std::uint8_t rt, std::uint8_t rd); + std::vector<std::string> to_strs(); +private: + enum InstructionShiftT type; +}; + +#endif // SHIFT_H diff --git a/qtmips_machine/memory.cpp b/qtmips_machine/memory.cpp new file mode 100644 index 0000000..25deab0 --- /dev/null +++ b/qtmips_machine/memory.cpp @@ -0,0 +1,137 @@ +#include "memory.h" + +void MemoryAccess::write_hword(std::uint32_t offset, std::uint16_t value) { + this->write_byte(offset++, (std::uint8_t)value); + this->write_byte(offset, (std::uint8_t)(value >> 8)); +} + +void MemoryAccess::write_word(std::uint32_t offset, std::uint32_t value) { + this->write_byte(offset++, (std::uint8_t)value); + this->write_byte(offset++, (std::uint8_t)(value >> 8)); + this->write_byte(offset++, (std::uint8_t)(value >> 16)); + this->write_byte(offset++, (std::uint8_t)(value >> 24)); +} + +std::uint16_t MemoryAccess::read_hword(std::uint32_t offset) { + std::uint16_t dt = 0; + dt |= this->read_byte(offset++); + dt |= (this->read_byte(offset) << 8); + return dt; +} + +std::uint32_t MemoryAccess::read_word(std::uint32_t offset) { + std::uint32_t dt = 0; + dt |= this->read_byte(offset++); + dt |= (this->read_byte(offset++) << 8); + dt |= (this->read_byte(offset++) << 16); + dt |= (this->read_byte(offset) << 24); + return dt; +} + +MemorySection::MemorySection(std::uint32_t length) { + this->length = length; + this->dt = new std::uint8_t[length]; +} + +MemorySection::~MemorySection() { + delete this->dt; +} + +using namespace std; + +void MemorySection::write_byte(std::uint32_t offset, std::uint8_t value) { + if (offset >= this->length) + throw QTMIPS_EXCEPTION(OutOfMemoryAccess, "Trying to write outside of the memory section", std::string("Accessing using offset: ") + std::to_string(offset)); + this->dt[offset] = value; +} + +std::uint8_t MemorySection::read_byte(std::uint32_t offset) { + if (offset >= this->length) + throw QTMIPS_EXCEPTION(OutOfMemoryAccess, "Trying to read outside of the memory section", std::string("Accessing using offset: ") + std::to_string(offset)); + return this->dt[offset]; +} + +// Number of bites per row on lookup tree +#define MEMORY_TREE_ROW ((32 - MEMORY_SECTION_BITS) / MEMORY_TREE_H) +// Size of row in memory lookup tree +#define MEMORY_TREE_LEN (1 << MEMORY_TREE_ROW) +// Just do some sanity checks +#if (MEMORY_TREE_LEN == 0) +#error Nonzero memory tree row size +#endif +#if (((32 - MEMORY_SECTION_BITS) % MEMORY_TREE_H) != 0) +#error Memory tree is not fully divisible by memory tree height +#endif +#if (MEMORY_TREE_H < 2) +#error Memory tree have to be higher or in limit equal to two +#endif + +union MemoryTree { + union MemoryTree *mt; + MemorySection *sec; +}; + +Memory::Memory() { + this->mt_root = allocate_section_tree(); +} + +Memory::~Memory() { + // Free up memory tree + // TODO +} + +union MemoryTree *Memory::allocate_section_tree() { + union MemoryTree *mt = new union MemoryTree[MEMORY_TREE_LEN]; + for (size_t i = 0; i < MEMORY_TREE_LEN; i++) + // Note that this also nulls sec pointer as those are both pointers and so they have same size + mt[i].mt = nullptr; + return mt; +} + +// Create address mask with section length +#define ADDRESS_MASK(LEN) ((1 << LEN) - 1) + +// Get index in tree node from address, length of row and tree depth +// ADDR is expected to be and address with lowest bites removed (MEMORY_SECTION_BITS) +#define ADDRESS_TREE_INDEX(DEPTH, ADDR) ((ADDR >> (DEPTH * MEMORY_TREE_ROW)) & ADDRESS_MASK(MEMORY_TREE_ROW)) + + +MemorySection *Memory::get_section(std::uint32_t address, bool create) { + std::uint32_t addr = address >> MEMORY_SECTION_BITS; // drop all bits for addressing inside of the section + union MemoryTree *w = this->mt_root; + size_t ii; + for (int i = 0; i < (MEMORY_TREE_H - 1); i++) { + ii = ADDRESS_TREE_INDEX(i, addr); + if (w[ii].mt == nullptr) { // We don't have this tree so allocate it + if (!create) // If we shouldn't be creating it than just return null + return nullptr; + w[ii].mt = allocate_section_tree(); + } + w = w[ii].mt; + } + // Now expand last level + ii = ADDRESS_TREE_INDEX((MEMORY_TREE_H - 1), addr); + if (w[ii].sec == nullptr) { + if (!create) + return nullptr; + w[ii].sec = new MemorySection(1 << MEMORY_SECTION_BITS); + } + return w[ii].sec; +} + +// Note about this address magic: we want to mask upper bits in address as those were used +// for section lookup. We do it using (2^BITS - 1). +#define SECTION_ADDRESS(ADDR) (ADDR & ADDRESS_MASK(MEMORY_SECTION_BITS)) + +void Memory::write_byte(std::uint32_t address, std::uint8_t value) { + MemorySection *section = this->get_section(address, true); + section->write_byte(SECTION_ADDRESS(address), value); +} + +std::uint8_t Memory::read_byte(std::uint32_t address) { + MemorySection *section = this->get_section(address, true); + if (section == nullptr) + return 0; + else + return section->read_byte(SECTION_ADDRESS(address)); +} diff --git a/qtmips_machine/memory.h b/qtmips_machine/memory.h new file mode 100644 index 0000000..1df23ae --- /dev/null +++ b/qtmips_machine/memory.h @@ -0,0 +1,60 @@ +#ifndef MEMORY_H +#define MEMORY_H + +#include <QObject> +#include <vector> +#include <cstdint> +#include "qtmipsexception.h" + +// Virtual class for common memory access +class MemoryAccess : public QObject { + Q_OBJECT +public: + virtual void write_byte(std::uint32_t offset, std::uint8_t value) = 0; + void write_hword(std::uint32_t offset, std::uint16_t value); + void write_word(std::uint32_t offset, std::uint32_t value); + + virtual std::uint8_t read_byte(std::uint32_t offset) = 0; + std::uint16_t read_hword(std::uint32_t offset); + std::uint32_t read_word(std::uint32_t offset); + +signals: + // TODO trigger + void byte_change(std::uint32_t address, std::uint32_t value); +}; + +class MemorySection : public MemoryAccess { +public: + MemorySection(std::uint32_t length); + ~MemorySection(); + void write_byte(std::uint32_t offset, std::uint8_t value); + std::uint8_t read_byte(std::uint32_t offset); +private: + std::uint32_t length; + std::uint8_t *dt; +}; + +////////////////////////////////////////////////////////////////////////////// +/// Some optimalization options +// How big memory sections will be (2^8=256) +#define MEMORY_SECTION_BITS 8 +// How deep memory lookup tree will be +#define MEMORY_TREE_H 4 +////////////////////////////////////////////////////////////////////////////// + +union MemoryTree; + +class Memory : public MemoryAccess { + Q_OBJECT +public: + Memory(); + ~Memory(); + MemorySection *get_section(std::uint32_t address, bool create); // returns section containing given address + void write_byte(std::uint32_t address, std::uint8_t value); + std::uint8_t read_byte(std::uint32_t address); +private: + union MemoryTree *mt_root; + static union MemoryTree *allocate_section_tree(); +}; + +#endif // MEMORY_H diff --git a/qtmips_machine/programloader.cpp b/qtmips_machine/programloader.cpp new file mode 100644 index 0000000..0b0e294 --- /dev/null +++ b/qtmips_machine/programloader.cpp @@ -0,0 +1,81 @@ +#include "programloader.h" +#include <exception> +#include <unistd.h> +#include <fcntl.h> +#include <iostream> +#include <errno.h> +#include <cstring> +#include "qtmipsexception.h" + +ProgramLoader::ProgramLoader(char *file) { + // Initialize elf library + if (elf_version(EV_CURRENT) == EV_NONE) + throw QTMIPS_EXCEPTION(Input, "Elf library initialization failed", elf_errmsg(-1)); + // Open source file + if ((this->fd = open(file, O_RDONLY, 0)) < 0) + throw QTMIPS_EXCEPTION(Input, "Can't open input elf file for reading", std::strerror(errno)); + // Initialize elf + if (!(this->elf = elf_begin(this->fd, ELF_C_READ, NULL))) + throw QTMIPS_EXCEPTION(Input, "Elf read begin failed", elf_errmsg(-1)); + // Check elf kind + if (elf_kind(this->elf) != ELF_K_ELF) + throw QTMIPS_EXCEPTION(Input, "Invalid input file elf format, plain elf file expected", ""); + + if (!gelf_getehdr(this->elf, &this->hdr)) + throw QTMIPS_EXCEPTION(Input, "Getting elf file header failed", elf_errmsg(-1)); + // Check elf file format, executable expected, nothing else. + if (this->hdr.e_type != ET_EXEC) + throw QTMIPS_EXCEPTION(Input, "Invalid input file type", ""); + // Check elf file architecture, of course only mips is supported. + if (this->hdr.e_machine != EM_MIPS) + throw QTMIPS_EXCEPTION(Input, "Invalid input file architecture", ""); + // Check elf file class, only 32bit architecture is supported. + int elf_class; + if ((elf_class = gelf_getclass(this->elf)) == ELFCLASSNONE) + throw QTMIPS_EXCEPTION(Input, "Getting elf class failed", elf_errmsg(-1)); + if (elf_class != ELFCLASS32) + throw QTMIPS_EXCEPTION(Input, "Only supported architecture is 32bit", ""); + // TODO check endianity! + + // Get number of program sections in elf file + if (elf_getphdrnum(this->elf, &this->n_secs)) + throw QTMIPS_EXCEPTION(Input, "Elf program sections count query failed", elf_errmsg(-1)); + // Get program sections headers + if (!(this->phdrs = elf32_getphdr(this->elf))) + throw QTMIPS_EXCEPTION(Input, "Elf program sections get failed", elf_errmsg(-1)); + // We want only LOAD sections so we create map of those sections + for (unsigned i = 1; i < this->n_secs; i++) { + // TODO handle endianity + if (this->phdrs[i].p_type != PT_LOAD) + continue; + this->map.push_back(i); + } + // TODO instead of direct access should we be using sections and elf_data? And if so how to link program header and section? +} + +ProgramLoader::~ProgramLoader() { + // Close elf + elf_end(this->elf); + // Close file + close(this->fd); +} + +size_t ProgramLoader::get_nsec() { + return this->map.size(); +} + +std::uint32_t ProgramLoader::get_address(size_t sec) { + SANITY_ASSERT(sec > this->get_nsec(), "Requesting too big section"); + return this->phdrs[this->map[sec]].p_vaddr; +} + +std::vector<std::uint8_t> ProgramLoader::get_data(size_t sec) { + SANITY_ASSERT(sec > this->get_nsec(), "Requesting too big section"); + std::vector<std::uint8_t> d; + char *f = elf_rawfile(this->elf, NULL); + size_t phdrs_i = this->map[sec]; + for (unsigned i = 0; i < this->phdrs[phdrs_i].p_filesz; i++) { + d.push_back((std::uint8_t) f[this->phdrs[phdrs_i].p_offset + i]); + } + return d; +} diff --git a/qtmips_machine/programloader.h b/qtmips_machine/programloader.h new file mode 100644 index 0000000..058e5c1 --- /dev/null +++ b/qtmips_machine/programloader.h @@ -0,0 +1,28 @@ +#ifndef PROGRAM_H +#define PROGRAM_H + +#include <unistd.h> +#include <libelf.h> +#include <gelf.h> +#include <cstdint> +#include <vector> + + +class ProgramLoader { +public: + ProgramLoader(char *file); + ~ProgramLoader(); + + size_t get_nsec(); // Returns number of loadable sections + std::uint32_t get_address(size_t sec); // Get target address for given section + std::vector<std::uint8_t> get_data(size_t sec); // Returns bytes of given section +private: + int fd; + Elf *elf; + GElf_Ehdr hdr; // elf file header + size_t n_secs; // number of sections in elf program header + Elf32_Phdr *phdrs; // program section headers + std::vector<size_t> map; // external index to phdrs index +}; + +#endif // PROGRAM_H diff --git a/qtmips_machine/programmemory.cpp b/qtmips_machine/programmemory.cpp new file mode 100644 index 0000000..c5ef53a --- /dev/null +++ b/qtmips_machine/programmemory.cpp @@ -0,0 +1,111 @@ +#include "programmemory.h" +#include <sstream> +#include "qtmipsexception.h" +#include "instructions/arithmetic.h" +#include "instructions/loadstore.h" +#include "instructions/nop.h" +#include "instructions/shift.h" + +ProgramMemory::ProgramMemory(ProgramLoader *loader, MemoryAccess *memory) { + this->memory = memory; + // Load program to memory (just dump it byte by byte, decode is done on demand) + for (int i = 0; i < loader->get_nsec(); i++) { + std::uint32_t base_address = loader->get_address(i); + std::vector<std::uint8_t> data = loader->get_data(i); + for (auto it = data.begin(); it < data.end(); it++) { + memory->write_byte(base_address + i, *it); + } + } +} + +#define MASKSUB(VAR, LEN, OFFSET) ((VAR & ~((1 << (LEN+OFFSET+1)) - 1)) >> OFFSET) + +Instruction *ProgramMemory::at(std::uint32_t address) { + if (address % 4) + // TODO different exception (unaligned address) + throw std::exception(); + // Read instruction from memory + std::uint32_t dt = this->memory->read_word(address); + + // Decode instruction + Instruction *inst; + std::uint8_t opcode = dt >> 26; // upper 6 bits + if (opcode == 0) { // Arithmetic and shift instructions + return this->decode_r(dt); + } else if (opcode == 2 || opcode == 3) { // Jump instructions + return decode_j(dt); + } else { + return decode_i(dt); + } +} + +// TODO implement +#define I_UNKNOWN(DATA) do { std::stringstream ss; ss << std::hex << DATA; throw QTMIPS_EXCEPTION(UnsupportedInstruction, "Unknown instruction, can't decode", ss.str()); } while(false); +#define I_UNSUPPORTED(INST) throw QTMIPS_EXCEPTION(UnsupportedInstruction, "Decoded unsupported unstruction", #INST) + +Instruction *ProgramMemory::decode_r(std::uint32_t dt) { + std::uint8_t func = MASKSUB(dt, 6, 0); + if (!func) + return new InstructionNop(); + + std::uint8_t rs, rt, rd, sa; + rs = MASKSUB(dt, 5, 21); + rt = MASKSUB(dt, 5, 16); + rd = MASKSUB(dt, 5, 11); + sa = MASKSUB(dt, 5, 6); + + if (func < 8) { // Shift instructions + bool variable = false; + enum InstructionShiftT t; + switch (func) { + case 0: + t = IST_LL; + break; + case 2: + t = IST_RL; + break; + case 3: + t = IST_RA; + break; + case 4: + t = IST_LL; + variable = true; + break; + case 6: + t = IST_RL; + variable = true; + break; + case 7: + t = IST_RA; + variable = true; + break; + default: + I_UNKNOWN(dt); + } + if (variable) + return new InstructionShiftVariable(t, rs, rt, rd); + else + return new InstructionShift(t, rt, rd, sa); + } else if (func < 10) { // Jump instructions + // TODO + I_UNKNOWN(dt); + } else { // TODO filter rest + I_UNKNOWN(dt); + } +} + +Instruction *ProgramMemory::decode_j(std::uint32_t dt) { + std::uint32_t address = MASKSUB(dt, 26, 0); + // TODO + I_UNKNOWN(dt); +} + +Instruction *ProgramMemory::decode_i(std::uint32_t dt) { + // InstructionI + std::uint8_t rs, rt; + rs = MASKSUB(dt, 5, 21); + rt = MASKSUB(dt, 5, 16); + std::uint16_t immediate = MASKSUB(dt, 16, 0); + // TODO + I_UNKNOWN(dt); +} diff --git a/qtmips_machine/programmemory.h b/qtmips_machine/programmemory.h new file mode 100644 index 0000000..84b2f31 --- /dev/null +++ b/qtmips_machine/programmemory.h @@ -0,0 +1,22 @@ +#ifndef PROGRAMMEMORY_H +#define PROGRAMMEMORY_H + +#include <vector> +#include "programloader.h" +#include "memory.h" +#include "instruction.h" + +class ProgramMemory { +public: + ProgramMemory(ProgramLoader *loader, MemoryAccess *memory); + + Instruction *at(std::uint32_t address); // return instruction isntance for given address + +private: + MemoryAccess *memory; + Instruction *decode_r(std::uint32_t dt); + Instruction *decode_j(std::uint32_t dt); + Instruction *decode_i(std::uint32_t dt); +}; + +#endif // PROGRAMMEMORY_H diff --git a/qtmips_machine/qtmips_machine.pro b/qtmips_machine/qtmips_machine.pro new file mode 100644 index 0000000..66cb37c --- /dev/null +++ b/qtmips_machine/qtmips_machine.pro @@ -0,0 +1,46 @@ +QT -= gui + +TARGET = qtmips_machine +CONFIG += c++11 + +TEMPLATE = lib + +LIBS += -lelf +QMAKE_CXXFLAGS += -std=c++0x + +DEFINES += QTMIPS_MACHINE_LIBRARY +DEFINES += QT_DEPRECATED_WARNINGS + +SOURCES += \ + qtmipsmachine.cpp \ + qtmipsexception.cpp \ + core.cpp \ + memory.cpp \ + instruction.cpp \ + registers.cpp \ + programloader.cpp \ + programmemory.cpp \ + instructions/arithmetic.cpp \ + instructions/loadstore.cpp \ + instructions/shift.cpp \ + instructions/nop.cpp \ + instructions/jumpbranch.cpp \ + utils.cpp \ + cache.cpp + +HEADERS += \ + qtmipsmachine.h \ + qtmipsexception.h \ + core.h \ + memory.h \ + instruction.h \ + registers.h \ + programloader.h \ + programmemory.h \ + instructions/arithmetic.h \ + instructions/loadstore.h \ + instructions/shift.h \ + instructions/nop.h \ + instructions/jumpbranch.h \ + utils.h \ + cache.h diff --git a/qtmips_machine/qtmips_machine_global.h b/qtmips_machine/qtmips_machine_global.h new file mode 100644 index 0000000..14cb0ac --- /dev/null +++ b/qtmips_machine/qtmips_machine_global.h @@ -0,0 +1,12 @@ +#ifndef QTMIPS_MACHINE_GLOBAL_H +#define QTMIPS_MACHINE_GLOBAL_H + +#include <QtCore/qglobal.h> + +#if defined(QTMIPS_MACHINE_LIBRARY) +# define QTMIPS_MACHINESHARED_EXPORT Q_DECL_EXPORT +#else +# define QTMIPS_MACHINESHARED_EXPORT Q_DECL_IMPORT +#endif + +#endif // QTMIPS_MACHINE_GLOBAL_H diff --git a/qtmips_machine/qtmipsexception.cpp b/qtmips_machine/qtmipsexception.cpp new file mode 100644 index 0000000..2ce7ae5 --- /dev/null +++ b/qtmips_machine/qtmipsexception.cpp @@ -0,0 +1,60 @@ +#include "qtmipsexception.h" +#include <iostream> +#include <cstring> + +QtMipsException::QtMipsException(QTMIPS_ARGS_COMMON) { + this->reason = reason; + this->ext = ext; + this->file = file; + this->line = line; +} + +const char *QtMipsException::what() const throw() { + std::string message = this->msg(true); + char * cstr = new char [message.length()+1]; + std::strcpy (cstr, message.c_str()); + return cstr; +} + +std::string QtMipsException::msg(bool pos) const { + std::string message; + if (pos) + message += std::string("(") + std::string(this->file) + std::string(":") + std::to_string(this->line) + std::string(") "); + message += this->reason; + if (!this->ext.empty()) { + message += std::string(": "); + message += this->ext; + } + return message; +} + + +QtMipsExceptionInput::QtMipsExceptionInput(QTMIPS_ARGS_COMMON) + : QtMipsException(reason, ext, file, line) { + return; +} + +QtMipsExceptionRuntime::QtMipsExceptionRuntime(QTMIPS_ARGS_COMMON) + : QtMipsException(reason, ext, file, line) { + return; +} + +QtMipsExceptionUnsupportedInstruction::QtMipsExceptionUnsupportedInstruction(QTMIPS_ARGS_COMMON) + : QtMipsExceptionRuntime(reason, ext, file, line) { + return; +} + +QtMipsExceptionUnalignedJump::QtMipsExceptionUnalignedJump(QTMIPS_ARGS_COMMON) + : QtMipsExceptionRuntime(reason, ext, file, line) { + return; +} + +QtMipsExceptionOutOfMemoryAccess::QtMipsExceptionOutOfMemoryAccess(QTMIPS_ARGS_COMMON) + : QtMipsExceptionRuntime(reason, ext, file, line) { + return; +} + +QtMipsExceptionSanity::QtMipsExceptionSanity(QTMIPS_ARGS_COMMON) + : QtMipsException(reason, ext, file, line) { + return; +} diff --git a/qtmips_machine/qtmipsexception.h b/qtmips_machine/qtmipsexception.h new file mode 100644 index 0000000..bfaa788 --- /dev/null +++ b/qtmips_machine/qtmipsexception.h @@ -0,0 +1,63 @@ +#ifndef QTMIPSEXCEPTION_H +#define QTMIPSEXCEPTION_H + +#include <exception> +#include <string> + +#define QTMIPS_EXCEPTION(TYPE, REASON, EXT) (QtMipsException ## TYPE (std::string(REASON), std::string(EXT), std::string(__FILE__), __LINE__)) +#define QTMIPS_ARGS_COMMON std::string reason, std::string ext, std::string file, int line + +// Base exception for all machine ones +class QtMipsException : public std::exception { +public: + QtMipsException(QTMIPS_ARGS_COMMON); + const char *what() const throw(); + std::string msg(bool pos) const; +protected: + std::string reason, ext, file; + int line; +}; + +// Exception durring input loading +class QtMipsExceptionInput : public QtMipsException { +public: + QtMipsExceptionInput(QTMIPS_ARGS_COMMON); +}; + +// Exceptions caused by machine invalid input or unsupported action +class QtMipsExceptionRuntime : public QtMipsException { +public: + QtMipsExceptionRuntime(QTMIPS_ARGS_COMMON); +}; + +// Decoded instruction is not supported. +// This can be cause by really using some unimplemented instruction or because of problems in instruction decode. +class QtMipsExceptionUnsupportedInstruction : public QtMipsExceptionRuntime { +public: + QtMipsExceptionUnsupportedInstruction(QTMIPS_ARGS_COMMON); +}; + +// Instruction is jumping to unaligned address (ADDR%4!=0) +// This can be caused by bug or by user program as it can be jumping relative to register +// This shouldn't be happening with non-register jumps as those should be verified by compiler +class QtMipsExceptionUnalignedJump : public QtMipsExceptionRuntime { +public: + QtMipsExceptionUnalignedJump(QTMIPS_ARGS_COMMON); +}; + +// Trying to access address outside of the memory +// As we are simulating whole 32bit memory address space then this is most probably QtMips bug if raised not program. +class QtMipsExceptionOutOfMemoryAccess : public QtMipsExceptionRuntime { +public: + QtMipsExceptionOutOfMemoryAccess(QTMIPS_ARGS_COMMON); +}; + +// This is sanity check exception +class QtMipsExceptionSanity : public QtMipsException { +public: + QtMipsExceptionSanity(QTMIPS_ARGS_COMMON); +}; + +#define SANITY_ASSERT(COND, MSG) do { if (!(COND)) throw QTMIPS_EXCEPTION(Sanity, "Sanity check failed (" #COND ")", MSG); } while (false) + +#endif // QTMIPSEXCEPTION_H diff --git a/qtmips_machine/qtmipsmachine.cpp b/qtmips_machine/qtmipsmachine.cpp new file mode 100644 index 0000000..0fc207c --- /dev/null +++ b/qtmips_machine/qtmipsmachine.cpp @@ -0,0 +1,5 @@ +#include "qtmipsmachine.h" + +QtMipsMachine::QtMipsMachine(char *file) { + this->loader = new ProgramLoader(file); +} diff --git a/qtmips_machine/qtmipsmachine.h b/qtmips_machine/qtmipsmachine.h new file mode 100644 index 0000000..af981b3 --- /dev/null +++ b/qtmips_machine/qtmipsmachine.h @@ -0,0 +1,25 @@ +#ifndef QTMIPSMACHINE_H +#define QTMIPSMACHINE_H + +#include <QObject> + +#include "qtmipsexception.h" +#include "programloader.h" +#include "core.h" +// TODO piplined core + +class QtMipsMachine : QObject { + Q_OBJECT +public: + QtMipsMachine(char *file); + + // TODO handle speed + void play(); + void pause(); + void step(); + void restart(); +private: + ProgramLoader *loader; +}; + +#endif // QTMIPSMACHINE_H diff --git a/qtmips_machine/registers.cpp b/qtmips_machine/registers.cpp new file mode 100644 index 0000000..514987a --- /dev/null +++ b/qtmips_machine/registers.cpp @@ -0,0 +1,66 @@ +#include "registers.h" +#include "qtmipsexception.h" +#include "utils.h" + +// TODO should this be configurable? +////////////////////////////////////////////////////////////////////////////// +/// Program counter initial value +#define PC_INIT 0x80020000 +////////////////////////////////////////////////////////////////////////////// + +Registers::Registers() { + this->pc = PC_INIT; // Initialize to beginning program section + for (int i = 0; i < 31; i++) + this->gp[i] = 0; + this->hi = this->lo = 0; +} + +std::uint32_t Registers::read_pc() { + return this->pc; +} + +std::uint32_t Registers::pc_inc() { + this->pc += 4; + return this->pc; +} + +std::uint32_t Registers::pc_jmp(std::int32_t offset) { + if (offset % 4) + throw QTMIPS_EXCEPTION(UnalignedJump, "Trying to jump by unaligned offset", to_string_hex(offset)); + this->pc += offset; + return this->pc; +} + +void Registers::pc_abs_jmp(std::uint32_t address) { + if (address % 4) + throw QTMIPS_EXCEPTION(UnalignedJump, "Trying to jump to unaligned address", to_string_hex(address)); + this->pc = address; +} + +std::uint32_t Registers::read_gp(std::uint8_t i) { + SANITY_ASSERT(i < 32, std::string("Trying to read from register ") + std::to_string(i)); + if (!i) // $0 always reads as 0 + return 0; + return this->gp[i - 1]; +} + +void Registers::write_gp(std::uint8_t i, std::uint32_t value) { + SANITY_ASSERT(i < 32, std::string("Trying to write to register ") + std::to_string(i)); + if (i == 0) // Skip write to $0 + return; + this->gp[i - 1] = value; +} + +std::uint32_t Registers::read_hi_lo(bool hi) { + if (hi) + return this->hi; + else + return this->lo; +} + +void Registers::write_hi_lo(bool hi, std::uint32_t value) { + if (hi) + this->hi = value; + else + this->lo = value; +} diff --git a/qtmips_machine/registers.h b/qtmips_machine/registers.h new file mode 100644 index 0000000..a550f4a --- /dev/null +++ b/qtmips_machine/registers.h @@ -0,0 +1,31 @@ +#ifndef REGISTERS_H +#define REGISTERS_H + +#include <QObject> +#include <cstdint> + +class Registers : public QObject { + Q_OBJECT +public: + Registers(); + + std::uint32_t read_pc(); // Return current value of program counter + std::uint32_t pc_inc(); // Increment program counter by four bytes + std::uint32_t pc_jmp(std::int32_t offset); // Relative jump from current location in program counter + void pc_abs_jmp(std::uint32_t address); // Absolute jump in program counter (write to pc) + + std::uint32_t read_gp(std::uint8_t i); // Read general-purpose register + void write_gp(std::uint8_t i, std::uint32_t value); // Write general-purpose register + std::uint32_t read_hi_lo(bool hi); // true - read HI / false - read LO + void write_hi_lo(bool hi, std::uint32_t value); + +signals: + // TODO signals + +private: + std::uint32_t gp[31]; // general-purpose registers ($0 is intentionally skipped) + std::uint32_t hi, lo; + std::uint32_t pc; // program counter +}; + +#endif // REGISTERS_H diff --git a/qtmips_machine/tests/testmemory.cpp b/qtmips_machine/tests/testmemory.cpp new file mode 100644 index 0000000..991e1f1 --- /dev/null +++ b/qtmips_machine/tests/testmemory.cpp @@ -0,0 +1,61 @@ +#include "tst_machine.h" +#include "memory.h" + +void MachineTests::memory_data() { + QTest::addColumn<std::uint32_t>("address"); + + QTest::newRow("memory begin") << (std::uint32_t)0x00; + QTest::newRow("memory end") << (std::uint32_t)0xFFFFFFFC; + QTest::newRow("memory midle start") << (std::uint32_t)0xFFFF00; + QTest::newRow("memory midle end") << (std::uint32_t)0xFFFFFF; +} + +void MachineTests::memory() { + Memory m; + + QFETCH(std::uint32_t, address); + + // Uninitialize memory should read as zero + QCOMPARE(m.read_byte(address), (std::uint8_t)0); + QCOMPARE(m.read_hword(address), (std::uint16_t)0); + QCOMPARE(m.read_word(address), (std::uint32_t)0); + // Just a byte + m.write_byte(address, 0x42); + QCOMPARE(m.read_byte(address), (std::uint8_t)0x42); + // Half word + m.write_hword(address, 0x4243); + QCOMPARE(m.read_hword(address), (std::uint16_t)0x4243); + // Word + m.write_word(address, 0x42434445); + QCOMPARE(m.read_word(address), (std::uint32_t)0x42434445); +} + +void MachineTests::memory_section_data() { + QTest::addColumn<std::uint32_t>("address"); + + QTest::newRow("memory begin") << (std::uint32_t)0x00; + QTest::newRow("memory end") << (std::uint32_t)0xFFFFFFFF; + QTest::newRow("memory midle start") << (std::uint32_t)0xFFFF00; + QTest::newRow("memory midle end") << (std::uint32_t)0xFFFFFF; +} + +void MachineTests::memory_section() { + Memory m; + + QFETCH(std::uint32_t, address); + + // First section shouldn't exists + QCOMPARE(m.get_section(address, false), (MemorySection*)nullptr); + // Create section + MemorySection *s = m.get_section(address, true); + QVERIFY(s != nullptr); + + // Write some data to memory + m.write_byte(address, 0x42); + // Read it trough section (mask bits outside of the memory section) + QCOMPARE(s->read_byte(address & ((1 << MEMORY_SECTION_BITS) - 1)), (std::uint8_t)0x42); + // Write some other data trough section + s->write_byte(address & ((1 << MEMORY_SECTION_BITS) - 1), 0x66); + // Read trough memory + QCOMPARE(m.read_byte(address), (std::uint8_t)0x66); +} diff --git a/qtmips_machine/tests/testregisters.cpp b/qtmips_machine/tests/testregisters.cpp new file mode 100644 index 0000000..4430beb --- /dev/null +++ b/qtmips_machine/tests/testregisters.cpp @@ -0,0 +1,39 @@ +#include "tst_machine.h" +#include <qtmipsexception.h> +#include <registers.h> + +void MachineTests::registers_gp0() { + Registers r; + QCOMPARE(r.read_gp(0), (unsigned)0); + r.write_gp(0, 0xff); + QCOMPARE(r.read_gp(0), (unsigned)0); +} + +void MachineTests::registers_rw_gp() { + Registers r; + for (int i = 1; i < 32; i++) { + r.write_gp(i, 0xf00 + i); + QCOMPARE(r.read_gp(i), (unsigned)(0xf00 + i)); + } +} + +void MachineTests::registers_rw_hi_lo() { + Registers r; + r.write_hi_lo(false, 0xee); + r.write_hi_lo(true, 0xaa); + QCOMPARE(r.read_hi_lo(false), (unsigned)0xee); + QCOMPARE(r.read_hi_lo(true), (unsigned)0xaa); +} + +void MachineTests::registers_pc() { + Registers r; + QCOMPARE(r.read_pc(), (unsigned)0x80020000); // Check initial pc address + QCOMPARE(r.pc_inc(), (unsigned)0x80020004); + QCOMPARE(r.pc_inc(), (unsigned)0x80020008); + QCOMPARE(r.pc_jmp(-0x8), (unsigned)0x80020000); + QCOMPARE(r.pc_jmp(0xC), (unsigned)0x8002000C); + r.pc_abs_jmp(0x80020100); + QCOMPARE(r.read_pc(), (unsigned)0x80020100); + QVERIFY_EXCEPTION_THROWN(r.pc_jmp(0x1), QtMipsExceptionUnalignedJump); + QVERIFY_EXCEPTION_THROWN(r.pc_abs_jmp(0x80020101), QtMipsExceptionUnalignedJump); +} diff --git a/qtmips_machine/tests/tests.pro b/qtmips_machine/tests/tests.pro new file mode 100644 index 0000000..9477e08 --- /dev/null +++ b/qtmips_machine/tests/tests.pro @@ -0,0 +1,24 @@ +QT += testlib +QT -= gui + +TARGET = tst_machine +CONFIG += console +CONFIG -= app_bundle +CONFIG += c++11 + +TEMPLATE = app + +LIBS += -L$$OUT_PWD/../ -lqtmips_machine +INCLUDEPATH += $$PWD/.. +DEPENDPATH += $$PWD/.. +QMAKE_CXXFLAGS += -std=c++0x + +DEFINES += QT_DEPRECATED_WARNINGS + +SOURCES += tst_machine.cpp \ + testmemory.cpp \ + testregisters.cpp + +HEADERS += tst_machine.h + +DEFINES += SRCDIR=\\\"$$PWD/\\\" diff --git a/qtmips_machine/tests/tst_machine.cpp b/qtmips_machine/tests/tst_machine.cpp new file mode 100644 index 0000000..d5fc354 --- /dev/null +++ b/qtmips_machine/tests/tst_machine.cpp @@ -0,0 +1,3 @@ +#include "tst_machine.h" + +QTEST_GUILESS_MAIN(MachineTests) diff --git a/qtmips_machine/tests/tst_machine.h b/qtmips_machine/tests/tst_machine.h new file mode 100644 index 0000000..214ab88 --- /dev/null +++ b/qtmips_machine/tests/tst_machine.h @@ -0,0 +1,21 @@ +#ifndef TST_MACHINE_H +#define TST_MACHINE_H + +#include <QtTest> + +class MachineTests : public QObject { + Q_OBJECT +private Q_SLOTS: + // Registers + void registers_gp0(); + void registers_rw_gp(); + void registers_rw_hi_lo(); + void registers_pc(); + // Memory + void memory(); + void memory_data(); + void memory_section(); + void memory_section_data(); +}; + +#endif // TST_MACHINE_H diff --git a/qtmips_machine/utils.cpp b/qtmips_machine/utils.cpp new file mode 100644 index 0000000..dfe8c2a --- /dev/null +++ b/qtmips_machine/utils.cpp @@ -0,0 +1,30 @@ +#include "utils.h" +#include <sstream> + +#define TO_STR_HEX do { std::stringstream ss; ss << std::hex << v; return std::string(ss.str()); } while (false) + +std::string to_string_hex(int v) { + TO_STR_HEX; +} + +std::string to_string_hex(unsigned v) { + TO_STR_HEX; +} + +std::string to_string_hex(long v) { + TO_STR_HEX; +} + +std::string to_string_hex(unsigned long v) { + TO_STR_HEX; +} + +std::string to_string_hex(long long v) { + TO_STR_HEX; +} + +std::string to_string_hex(unsigned long long v) { + TO_STR_HEX; +} + +#undef TO_STR_HEX diff --git a/qtmips_machine/utils.h b/qtmips_machine/utils.h new file mode 100644 index 0000000..151e1d0 --- /dev/null +++ b/qtmips_machine/utils.h @@ -0,0 +1,13 @@ +#ifndef UTILS_H +#define UTILS_H + +#include <string> + +std::string to_string_hex(int); +std::string to_string_hex(unsigned); +std::string to_string_hex(long); +std::string to_string_hex(unsigned long); +std::string to_string_hex(long long); +std::string to_string_hex(unsigned long long); + +#endif // UTILS_H diff --git a/tests/machine-unit-tests/test.sh b/tests/machine-unit-tests/test.sh new file mode 100755 index 0000000..c916f74 --- /dev/null +++ b/tests/machine-unit-tests/test.sh @@ -0,0 +1,11 @@ +#!/bin/sh +TEST_NAME="machine-unit-test" + +# Load common test shell functions +. "$(dirname "$0")/../test.sh" + +# Build tests binary +qtmips_make sub-qtmips_machine-tests + +# Run unit tests +qtmips_run qtmips_machine/tests/tst_machine || echo_fail "Test $TEST_NAME failed!" diff --git a/tests/registers/Makefile b/tests/registers/Makefile new file mode 100644 index 0000000..4b5ebdc --- /dev/null +++ b/tests/registers/Makefile @@ -0,0 +1,5 @@ +include ../test.mk + +SRC_registers = registers.S + +$(eval $(call MIPS_ELF,registers)) diff --git a/tests/registers/registers.S b/tests/registers/registers.S new file mode 100644 index 0000000..64ff5ac --- /dev/null +++ b/tests/registers/registers.S @@ -0,0 +1,8 @@ +.text +.globl _start + +_start: + j main + +main: + addi $1, $0, 6 diff --git a/tests/registers/test.sh b/tests/registers/test.sh new file mode 100755 index 0000000..2ace7cd --- /dev/null +++ b/tests/registers/test.sh @@ -0,0 +1,15 @@ +#!/bin/sh +TEST_NAME="registers" + +# Load common test shell functions +. "$(dirname "$0")/../test.sh" + +# Build cli binary +qtmips_make sub-qtmips_cli + +# Compile mips binary +mips_make_test + +# Run test +qtmips_run qtmips_cli/qtmips_cli "$TEST_DIR/registers" \ + || echo_fail "Test $TEST_NAME failed!" diff --git a/tests/run-all.sh b/tests/run-all.sh new file mode 100755 index 0000000..9c57391 --- /dev/null +++ b/tests/run-all.sh @@ -0,0 +1,7 @@ +#!/bin/sh +# Run all tests +set -e + +for T in $(find "$(dirname "$0")" -name test.sh -type f -executable); do + timeout -k 120 60 "$T" +done diff --git a/tests/test.mk b/tests/test.mk new file mode 100644 index 0000000..c05a72b --- /dev/null +++ b/tests/test.mk @@ -0,0 +1,39 @@ +MAKEFLAGS += --no-builtin-rules + +# Output path +O ?= . + +#MIPS_CFLAGS += -Wall +MIPS_LDFLAGS += -nostdlib -nodefaultlibs -nostartfiles -Wl,-Ttext,0x80020000 + +.PHONY: all +all:: + @ + +.PHONY: clean +clean:: + @ + + +define MIPS_ELF + +ifndef MIPS_PREFIX + $$(error Toolchain prefix have to be passed in MIPS_PREFIX variable) +endif + +OBJ_$(1):=$$(patsubst %.S,$$(O)/%.o,$$(SRC_$(1))) +$$(info $$(OBJ_$(1))) + +all:: $$(O)/$(1) + +$$(O)/$(1): $$(OBJ_$(1)) + $$(MIPS_PREFIX)-gcc $$(MIPS_LDFLAGS) -o $$@ $$^ + +$$(OBJ_$(1)): $$(O)/%.o: %.S + $$(MIPS_PREFIX)-gcc $$(MIPS_CFLAGS) -c -x assembler-with-cpp -o $$@ $$< + +clean:: + $(RM) $$(OBJ_$(1)) + $(RM) $$(O)/$(1) + +endef diff --git a/tests/test.sh b/tests/test.sh new file mode 100644 index 0000000..7145a0c --- /dev/null +++ b/tests/test.sh @@ -0,0 +1,99 @@ +# Enable shell exit on failure +set -e + +## Colored echo function ######################################################## + +echo_head() { + echo -e "\e[1;34m-- $@ --\e[0m" >&2 +} + +echo_msg() { + echo -e "\e[1;33m$@\e[0m" >&2 +} + +echo_fail() { + echo -e "\e[1;31m$@\e[0m" >&2 + exit 1 +} + +## Check and init test ########################################################## + +# Check if test name is defined +[ -n "$TEST_NAME" ] || echo_fail "Test name is not defined! Define TEST_NAME variable in test script." +# Report user what test is going to be executed +echo_head "Running test $TEST_NAME" + +## Define some variables ######################################################## + +# Store base directory from which we started test script +PWD_DIR="$(pwd)" +# Define path to test sources +TEST_SRC="$(dirname "$(readlink -f "$0")")" + +# Get project root. +# As we want to have script calling this anywhere, we have to do some more work to +# get project root. But we know content of root and so we can use that to locate +# it and we know that test source directory is part of tree so it's under root. +PROJECT_ROOT="$TEST_SRC" +while [ -n "$PROJECT_ROOT" ] && ! [ \ + -f "$PROJECT_ROOT/LICENSE" -a \ + -f "$PROJECT_ROOT/README.md" -a \ + -d "$PROJECT_ROOT/qtmips_gui" -a \ + -d "$PROJECT_ROOT/qtmips_cli" -a \ + -d "$PROJECT_ROOT/qtmips_machine" \ + ]; do + PROJECT_ROOT="${PROJECT_ROOT%/*}" +done +[ -n "$PROJECT_ROOT" ] || echo_fail "Project root not found!!" + +# Define root for all tests +# We are little bit clever about it. If we detect that we are in project tree we +# will use same directory every time. Otherwise we use current working directory +# where we create test_dir directory. +if [ -n "${PWD_DIR#$PROJECT_ROOT}" ]; then + TEST_DIR_ROOT="$PROJECT_ROOT/test_dir" +else + TEST_DIR_ROOT="$PWD_DIR/test_dir" +fi + +# Directory where qtmips will be build +BUILD_DIR="$TEST_DIR_ROOT/build" + +# Directory where test should be build and executed +TEST_DIR="$TEST_DIR_ROOT/$TEST_NAME" + +## Helper functions for building and running project ############################ + +qtmips_make() { + mkdir -p "$BUILD_DIR" + pushd "$BUILD_DIR" >/dev/null + /usr/lib64/qt5/bin/qmake "$PROJECT_ROOT" || echo_fail "QtMips qmake failed!" + make "$@" || echo_fail "QtMips build failed! (target: $@)" + popd >/dev/null +} + +qtmips_run() { + local BIN="$BUILD_DIR/$1" + shift + LD_LIBRARY_PATH="$BUILD_DIR/qtmips_machine" "$BIN" "$@" +} + +## Mips elf binary compilation ################################################## + +MIPS_COMPILER="$TEST_DIR_ROOT/mips-qtmips-elf" + +mips_compiler() { + # Skip if we have compiler already + [ ! -d "$MIPS_COMPILER" ] || return 0 + # Otherwise compile it + mkdir -p "$TEST_DIR_ROOT" + pushd "$TEST_DIR_ROOT" >/dev/null + "$PROJECT_ROOT"/compiler/compile.sh + popd >/dev/null +} + +mips_make_test() { + mips_compiler + mkdir -p "$TEST_DIR" + PATH="$PATH:$MIPS_COMPILER/bin" make -C "$TEST_SRC" O="$TEST_DIR" MIPS_PREFIX="mips-qtmips-elf" "$@" +} |