From a97fde9f8671c65992779751a3b0b0d4eea0a331 Mon Sep 17 00:00:00 2001 From: ALittlePatate Date: Thu, 18 Jan 2024 16:01:04 +0100 Subject: [PATCH] first commit of the recode 70% of the code was re-writter from scratch --- .gitignore | 8 + LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++ Makefile | 40 +++ README.md | 36 +++ api.c | 32 ++ api.h | 12 + docs/documentation.md | 114 +++++++ examples/test.pasm | 16 + file_utils.c | 50 ++++ file_utils.h | 5 + include/pasm.h | 5 + instructions.c | 284 ++++++++++++++++++ instructions.h | 61 ++++ interpreter_states.c | 143 +++++++++ interpreter_states.h | 71 +++++ pasm.c | 114 +++++++ tests/Makefile | 22 ++ tests/interpreter.c | 12 + tests/lib_use.c | 11 + 19 files changed, 1710 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 api.c create mode 100644 api.h create mode 100644 docs/documentation.md create mode 100644 examples/test.pasm create mode 100644 file_utils.c create mode 100644 file_utils.h create mode 100644 include/pasm.h create mode 100644 instructions.c create mode 100644 instructions.h create mode 100644 interpreter_states.c create mode 100644 interpreter_states.h create mode 100644 pasm.c create mode 100644 tests/Makefile create mode 100644 tests/interpreter.c create mode 100644 tests/lib_use.c diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..380da6e --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +.vs +.git +x64/ +build/ +*.a +*.o +pasm +lib_use \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5e552e6 --- /dev/null +++ b/Makefile @@ -0,0 +1,40 @@ +SRC = pasm.c \ + file_utils.c \ + interpreter_states.c \ + instructions.c \ + api.c +OBJ = $(SRC:.c=.o) +NAME = pasm +CFLAGS = -Wall -Wextra -Wpedantic -Iinclude +CLIBS = + +all: $(NAME) + +lib: $(OBJ) + ar rc lib$(NAME).a $(OBJ) + +$(NAME): fclean +$(NAME): lib +$(NAME): CLIBS += lib$(NAME).a +$(NAME): + gcc tests/interpreter.c $(CFLAGS) $(CLIBS) -o $(NAME) + +interpreter: $(NAME) + +debug: fclean +debug: CFLAGS += -DDEBUG -g3 +debug: $(NAME) + +clean: + rm -f $(OBJ) + cd tests && $(MAKE) clean + +fclean: clean + rm -f $(NAME) + find . -name "lib$(NAME).a" -delete + cd tests && $(MAKE) fclean + +re: fclean +re: $(NAME) + +.PHONY : all $(NAME) clean fclean re interpreter lib debug diff --git a/README.md b/README.md new file mode 100644 index 0000000..68a1e48 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# pasm +PASM is a Scripting language that i made for fun with a few constraints : +- the interpreter should be as small as possible and written without the CRT (currently 17ko WITH CRT) +- the language should be able to call Windows API's + +PASM is meant for being used in C2 agents as its interpreter is small.
+It can be used with an interpreter to execute local files or as a library in another program to execute files or directly code inside buffers, see [Usage](#Usage).
+ +# What pasm is not +PASM is not a language that you daily use, it is not meant for big projects but rather for scripting using existing API (here the Windows API's but it can get extended). + +# Current state +PASM is in a working state, see [code examples](#code-examples). +The interpreter works for linux as well, but some API's are Windows only (for now). + +TODO : +- get rid of the CRT (so we can get a smaller PE) + +# Documentation +The documentation is available [here](https://github.com/ALittlePatate/pasm/blob/main/docs/documentation.md), it *should* cover everything you have to know before writing scripts. + +# Usage +## Interpreter +``` +make interpreter +pasm.exe code.pasm +``` + +## As a library +``` +make lib +``` +Then link the library to your program, see [this example](https://github.com/ALittlePatate/pasm/blob/main/tests/lib_use.c).
+ +# Code examples : +- [functions test](https://github.com/ALittlePatate/pasm/blob/main/examples/test.pasm) diff --git a/api.c b/api.c new file mode 100644 index 0000000..467d520 --- /dev/null +++ b/api.c @@ -0,0 +1,32 @@ +#include "api.h" +#include "interpreter_states.h" + +#ifdef _WIN32 //windows only apis +#include +#endif + +#include + +void api_put() { + int mode = state->STACK[state->STACK_IDX--]; // 1 for char, 2 for num + if (mode != 1 && mode != 2) return; + + if (mode == 1) { + char c = state->STACK[state->STACK_IDX--]; + if (c == '\0') c = ' '; + + printf("%c", c); //using printf and not write because of the buffer + } + else { + printf("%d", state->STACK[state->STACK_IDX--]); + } +} + +void api_getasynckeystate() { + #ifdef _WIN32 + eax = GetAsyncKeyState(state->STACK[STACK_IDX--]); + #else + state->STACK_IDX--; + state->registers->eax = 1; + #endif +} diff --git a/api.h b/api.h new file mode 100644 index 0000000..63967b8 --- /dev/null +++ b/api.h @@ -0,0 +1,12 @@ +#pragma once +#include "instructions.h" + +void api_put(); +void api_getasynckeystate(); + +static const command_t api_map[] = { + {.command = "put", .fptr = api_put}, + {.command = "GetAsyncKeyState", .fptr = api_getasynckeystate}, + + {.command = NULL, .fptr = NULL} +}; diff --git a/docs/documentation.md b/docs/documentation.md new file mode 100644 index 0000000..29aa3a7 --- /dev/null +++ b/docs/documentation.md @@ -0,0 +1,114 @@ +# Docs +This is the documentation for the PASM scripting language.
+Please note it is still in a very early stages so a lot of features you'd except in a scripting language like this one may not be present at the moment.
+For more informations please read the [readme](https://github.com/ALittlePatate/pasm/blob/main/README.md). + +# Table of Contents +1. [Creating a script](#creating-a-script)
+ a. [Scripts structure](#scripts-structure)
+ b. [Registers](#registers)
+ c. [Syntax](#syntax)
+ c bis. [Note about return](#note-about-return)
+ d. [Calling APIs](#calling-apis)
+2. [Errors](#errors)
+3. [Debugging](#debugging)
+4. [Running a script](#running-a-script)
+5. [Contributing](#contributing)
+ +## Creating a script +The PASM interpreter will try to run any file even without the `.pasm` extension but for good practice it is good to only code inside of `.pasm` files. + +### Scripts structure +Function are defined with a "label" (ex `main:`) to which you can jump (`jmp`) at any point.
+The execution always starts at the `main:` label.
+Labels must have been seen at least once during execution to be defined. Example :
+ +Bad : +```asm +settoa: +add a1, 65 +ret + +main: +mov a1, 0 +jmp settoa + +jmp printa1 ; printa1 is not defined + +printa1: +push a1 +call put +``` + +Good : +```asm +settoa: +add a1, 65 +ret + +main: +mov a1, 0 +jmp settoa + +printa1: +push a1 +call put + +jmp printa1 ; will print "A" indefinitely +``` + +Please note that the execution will ignore labels, thus in this example printa1 will be executed even before the jump (`jmp`) occurs. + +### Registers +There are in total 9 multi purpose registers you can use : `a1` to `a9`.
+The `eax` register can be used like any other register but it is meant for holding return values can be overwritten by API calls (see [#Calling APIs](#calling-apis)) and regular operands (see the table below). + +### Syntax +The syntax is very close to x86 Intel Assembly. Here is a list of the operands and their effects : +| Operand | Effect | Sets EAX ? | +| :---: | :----: | :---: | +| **add** a1, a2 | Adds a2 to a1 | no | +| **sub** a1, a2 | Substract a2 from a1 | no | +| **mul** a1, a2 | Multiplies a2 with a1 | no | +| **div** a1, a2 | Divides a2 from a1 | no | +| **and** a1, a2 | Performs a bitwise AND between a1 and a2. Stores the result in eax. | yes | +| **xor** a1, a2 | Performs a XOR opration between a1 and a2. Stores the result in eax.| yes | +| **mov** a1, a2 | Moves the value stored in a2 in a1 | no | +| **cmp** a1, a2 | Compares a1 and a2. Sets the internal flags [last_cmp_code](https://github.com/ALittlePatate/pasm/blob/main/src/instructions.h#L6) | no | +| **je** foo | Jumps to `foo` if `cmp` returned `CMP_EQUAL` | no | +| **jne** foo | Jumps to `foo` if `cmp` didn't return `CMP_EQUAL` | no | +| **jb** foo | Jumps to `foo` if `cmp` returned `CMP_BELOW` | no | +| **jnb** foo | Jumps to `foo` if `cmp` didn't return `CMP_BELOW` | no | +| **ja** foo | Jumps to `foo` if `cmp` returned `CMP_ABOVE` | no | +| **jna** foo | Jumps to `foo` if `cmp` didn't return `CMP_ABOVE` | no | +| **jmp** foo | Jumps to `foo` | no | +| **ret** | Returns from the callee to the caller | no | +| **end** | Ends the program | no | +| **pop** a1 | Pops the first element of the stack into a1 | no | +| **push** 69 | Pushes the value 69 to the top of the stack | no | +| **call** put | Calls the `put` API | yes/no | + +All the operands are case-sensitive, meaning that `ADD` will be an invalid operand.
+Please note that additional operands will be added in the future. + +### Calling APIs +APIs can be added in the [api.c](https://github.com/ALittlePatate/pasm/blob/main/src/api.c) and [api.h](https://github.com/ALittlePatate/pasm/blob/main/src/api.h) files. +For the moment only `put` and `GetAsyncKeyState` can be called.
+APIs behave like normal functions and are called using the `call` operand. + +## Errors +Here is a list of all the errors you can encounter and how to fix them : + +* `invalid operand on line X` : you did not use an operand that was present in [the table](#syntax). +* `wrong number of arguments on line X` : you have more or less arguments needed for an operand, see [table](#syntax). +* `arg1/arg2 is invalid on line X` : the operand used can't work with the type of argument provided (register/number/char) +* `X is not a valid label/api` : you tried to jump (`jmp`) or `call` an undefined label or non-existing API. Check [Scripts structure](scripts-structure). +* `stack overflow on line X` : you pushed to many times without poping or you reached the recursion depth limit. +* `stack underflow on line X` : you poped to many times without pushing. + +## Running a script +Usage : `pasm.exe script.pasm`. + +## Contributing +Please message me over on discord at `_.patate` if you want me to add anything to the docs.
+Feel free to create a pull request as well. diff --git a/examples/test.pasm b/examples/test.pasm new file mode 100644 index 0000000..e49c1a7 --- /dev/null +++ b/examples/test.pasm @@ -0,0 +1,16 @@ +iterate: +add a1, 1 +cmp a1, 42 +jne iterate +ret + +test: +push a +push 1 +call put +ret + +main: +mov a1, 0 +jmp iterate +jmp test \ No newline at end of file diff --git a/file_utils.c b/file_utils.c new file mode 100644 index 0000000..576cc8d --- /dev/null +++ b/file_utils.c @@ -0,0 +1,50 @@ +#include +#include +#include + +#include "interpreter_states.h" + +#define MAX_LINE 1024 + +size_t line_count = 0; +int read_script(const char *filename, char ***buf, size_t *lines) { + FILE *script = fopen(filename, "r"); + if (script == NULL) { + fprintf(stderr, "Could not open %s.\n", filename); + return 1; + } + + char line[MAX_LINE]; + while (fgets(line, sizeof(line), script) != NULL) { + size_t length = strlen(line); + if (line[length - 1] == '\n') { + line[length - 1] = '\0'; + } + char *line_copy = strdup(line); + char **temp = realloc(*buf, (line_count + 1) * sizeof(char*)); + if (temp == NULL) { + fprintf(stderr, "Error allocating memory.\n"); + return 1; + } + *buf = temp; + (*buf)[line_count++] = line_copy; + } + if (line_count == 0) { + fprintf(stderr, "%s is an empty file.\n", filename); + return 1; + } + + *lines = line_count; + fclose(script); + return 0; +} + +void free_script(char **buf) { + if (!buf) + return; + for (size_t i = 0; i < line_count; ++i) + if (buf[i]) + free(buf[i]); + free(buf); + free_state(); +} diff --git a/file_utils.h b/file_utils.h new file mode 100644 index 0000000..93bd6b1 --- /dev/null +++ b/file_utils.h @@ -0,0 +1,5 @@ +#pragma once +#include + +int read_script(const char *filename, char ***buf, size_t *lines); +void free_script(char **buf); diff --git a/include/pasm.h b/include/pasm.h new file mode 100644 index 0000000..bc1d0fd --- /dev/null +++ b/include/pasm.h @@ -0,0 +1,5 @@ +#pragma once +#include +#include + +int pasm_run_script(const char *filename, char **file, size_t lines, FILE* _fstream); diff --git a/instructions.c b/instructions.c new file mode 100644 index 0000000..6c9317d --- /dev/null +++ b/instructions.c @@ -0,0 +1,284 @@ +#include "instructions.h" +#include "interpreter_states.h" +#include "api.h" +#include +#include + +bool is_reg(char* arg) { + return (strcmp(arg, "eax") == 0) || (((arg[0] == 'a' && + ('0' <= arg[1] && arg[1] <= '9'))) && strlen(arg) == 2); +} + +bool is_num(char* arg) { + return (atoi(arg) != 0 || (arg[0] == '0' && strlen(arg) == 1)); +} + +bool check_args(s_arguments *args, int num_in_first, int num_args) { + int arg_num = strcmp(args->arg2, "") != 0; + arg_num += strcmp(args->arg1, "") != 0; + if (arg_num != num_args) { + state->last_check_args_code = WRONG_NUMBER; + return false; + } + if (!(((num_in_first && is_num(args->arg1)) || (is_reg(args->arg1))))) { + state->last_check_args_code = ARG1_WRONG; + return false; + } + + if ((!is_num(args->arg2) && !is_reg(args->arg2))) { + state->last_check_args_code = ARG2_WRONG; + return false; + } + return true; +} + +int* get_reg(char* reg_char) { + switch (reg_char[1]) { + case '1' : + return &state->registers->a1; + case '2' : + return &state->registers->a2; + case '3' : + return &state->registers->a3; + case '4' : + return &state->registers->a4; + case '5' : + return &state->registers->a5; + case '6' : + return &state->registers->a6; + case '7' : + return &state->registers->a7; + case '8' : + return &state->registers->a8; + case '9' : + return &state->registers->a9; + case 'a' : //eax + return &state->registers->eax; + default : + return NULL; //should never happen + } +} + +int get_value(char* arg) { + int ret = 0; + + if (is_reg(arg)) { + ret = *get_reg(arg); + } + else { + ret = atoi(arg); + } + return ret; +} + +const command_t *find_command(const command_t *commands, char *func) +{ + if (func == NULL) + return NULL; + for (int index = 0; commands[index].fptr != NULL; index += 1) { + if (strcmp(func, commands[index].command) == 0) { + return &commands[index]; + } + } + return NULL; +} + +void cmp() { + if (!check_args(state->args, 1, 2)) { + state->last_cmp_code = CMP_ERROR; + return; + } + + int a1_ = get_value(state->args->arg1); + int a2_ = get_value(state->args->arg2); + + if (a1_ == a2_) state->last_cmp_code = CMP_EQUAL; + else if (a1_ > a2_) state->last_cmp_code = CMP_ABOVE; + else if (a2_ > a1_) state->last_cmp_code = CMP_BELOW; + return; +} + +int check_ret_stack() { + if (state->RET_STACK_IDX > STACK_SIZE) { + state->last_stack_code = OVERFLOW; + return 0; + } + if (state->RET_STACK_IDX < 0) { + state->last_stack_code = UNDERFLOW; + return 0; + } + return 1; +} + +void ret() { + if (!check_ret_stack()) return; + + if (state->RET_STACK[state->RET_STACK_IDX] == -1) { + state->should_exit = 1; + return; + } + + state->curr_line = state->RET_STACK[state->RET_STACK_IDX--]; +} + +void jmp() { + if (state->RET_STACK_IDX != -1 && !check_ret_stack()) return; + + if (strcmp(state->args->arg1, "return") == 0) { + ret(); + return; + } + + state->registers->eax = 0; + for (int i = 0; i < state->num_labels; i++) { + if (state->labels[i] == NULL) break; + if (strlen(state->labels[i]) - 1 != strlen(state->args->arg1)) + continue; + if (strncmp(state->args->arg1, state->labels[i], strlen(state->labels[i]) - 1) == 0) { + state->RET_STACK[++state->RET_STACK_IDX] = state->curr_line; + state->curr_line = state->labels_values[i]; + return; + } + } + + state->last_jmp_code = 1; + return; +} + +void jna() { + if (state->last_cmp_code != CMP_ABOVE) jmp(); +} + +void ja() { + if (state->last_cmp_code == CMP_ABOVE) jmp(); +} + +void jnb() { + if (state->last_cmp_code != CMP_BELOW) jmp(); +} + +void jb() { + if (state->last_cmp_code == CMP_BELOW) jmp(); +} + +void jne() { + if (state->last_cmp_code != CMP_EQUAL) jmp(); +} + +void je() { + if (state->last_cmp_code == CMP_EQUAL) jmp(); +} + +void sub() { + if (!check_args(state->args, 0, 2)) { + return; + } + *get_reg(state->args->arg1) -= get_value(state->args->arg2); +} + +void add() { + if (!check_args(state->args, 0, 2)) { + return; + } + + *get_reg(state->args->arg1) += get_value(state->args->arg2); +} + +void mul() { + if (!check_args(state->args, 0, 2)) { + return; + } + + *get_reg(state->args->arg1) *= get_value(state->args->arg2); +} + +void _div() { + if (!check_args(state->args, 0, 2)) { + return; + } + + *get_reg(state->args->arg1) /= get_value(state->args->arg2); +} + +void mov() { + if (!check_args(state->args, 0, 2)) { + return; + } + + *get_reg(state->args->arg1) = get_value(state->args->arg2); +} + +void call() { + const command_t* com = find_command(api_map, state->args->arg1); + if (com != NULL) { + com->fptr(); + } + else { + state->last_jmp_code = 1; + } +} + +void push() { + if (state->STACK_IDX == STACK_SIZE) { //stack overflow + state->last_stack_code = OVERFLOW; + return; + } + + int value = get_value(state->args->arg1); + if (value == 0) { + if (state->args->arg1[0] == '\\') { + switch (state->args->arg1[1]) { + case 'n': + value = (int)'\n'; + break; + case 't': + value = (int)'\t'; + break; + case 'r': + value = (int)'\r'; + break; + default: + break; + } + } + else { + value = (int)state->args->arg1[0]; + } + } + + state->STACK[++state->STACK_IDX] = value; +} + +void pop() { + if (!is_reg(state->args->arg1)) { + state->last_check_args_code = ARG1_WRONG; + return; + } + + if (state->STACK_IDX == -1) { //stack underflow + state->last_stack_code = UNDERFLOW; + return; + } + + *get_reg(state->args->arg1) = state->STACK[state->STACK_IDX--]; +} + +void _and() { + if (!check_args(state->args, 1, 2)) { + return; + } + + state->registers->eax = get_value(state->args->arg1) & get_value(state->args->arg2); +} + +void _xor() { + if (!check_args(state->args, 1, 2)) { + return; + } + + state->registers->eax = get_value(state->args->arg1) ^ get_value(state->args->arg2); +} + +void end() { + state->should_exit = 1; +} diff --git a/instructions.h b/instructions.h new file mode 100644 index 0000000..fa6debd --- /dev/null +++ b/instructions.h @@ -0,0 +1,61 @@ +#pragma once +#include +#include +#include "interpreter_states.h" + +typedef struct command_s { + char *command; + void (*fptr)(); +} command_t; + +bool is_reg(char* arg); +bool check_args(s_arguments *args, int num_in_first, int num_args); +int* get_reg(char* arg); + +void add(); +void sub(); +void mul(); +void _div(); +void mov(); +void cmp(); +void je(); +void jne(); +void jb(); +void jnb(); +void ja(); +void jna(); +void jmp(); +void ret(); +void pop(); +void push(); +void call(); +void _and(); +void _xor(); +void end(); + +static const command_t command_map[] = { + {.command = "add", .fptr = add}, + {.command = "sub", .fptr = sub}, + {.command = "mul", .fptr = mul}, + {.command = "div", .fptr = _div}, + {.command = "mov", .fptr = mov}, + {.command = "cmp", .fptr = cmp}, + {.command = "je", .fptr = je}, + {.command = "jne", .fptr = jne}, + {.command = "jb", .fptr = jb}, + {.command = "jnb", .fptr = jnb}, + {.command = "ja", .fptr = ja}, + {.command = "jna", .fptr = jna}, + {.command = "jmp", .fptr = jmp}, + {.command = "ret", .fptr = ret}, + {.command = "pop", .fptr = pop}, + {.command = "push", .fptr = push}, + {.command = "call", .fptr = call}, + {.command = "and", .fptr = _and}, + {.command = "xor", .fptr = _xor}, + {.command = "end", .fptr = end}, + + {.command = NULL, .fptr = NULL} +}; + +const command_t *find_command(const command_t *commands, char *func); diff --git a/interpreter_states.c b/interpreter_states.c new file mode 100644 index 0000000..dea9fbf --- /dev/null +++ b/interpreter_states.c @@ -0,0 +1,143 @@ +#include "interpreter_states.h" +#include +#include +#include + +s_state *state = NULL; +int init_state() { + state = malloc(sizeof(s_state)); + if (state == NULL) + return 1; + memset(state, 0, sizeof(s_state)); + state->registers = malloc(sizeof(s_registers)); + if (state->registers == NULL) { + free(state); + return 1; + } + memset(state->registers, 0, sizeof(s_registers)); + state->args = malloc(sizeof(s_arguments)); + if (state->args == NULL) { + free(state); + free(state->registers); + return 1; + } + state->args->arg1 = malloc(sizeof(char) * MAX_ARG_SIZE); + state->args->arg2 = malloc(sizeof(char) * MAX_ARG_SIZE); + if (state->args->arg1 == NULL || state->args->arg2 == NULL) { + free(state); + free(state->registers); + return 1; + } + memset(state->args->arg1, 0, sizeof(char) * MAX_ARG_SIZE); + memset(state->args->arg2, 0, sizeof(char) * MAX_ARG_SIZE); + state->labels_values = malloc(sizeof(int) * MAX_LABELS); + if (state->labels_values == NULL) { + free(state); + free(state->registers); + free(state->args->arg1); + free(state->args->arg2); + return 1; + } + memset(state->labels_values, 0, sizeof(int) * MAX_LABELS); + memset(state->RET_STACK, -1, sizeof(int) * STACK_SIZE); + memset(state->STACK, 0, sizeof(int) * STACK_SIZE); + state->RET_STACK_IDX = -1; + state->STACK_IDX = -1; + state->last_stack_code = STACK_OK; + state->last_check_args_code = OK; + return 0; +} + +void free_state() { + for (int i = 0; i < state->num_labels; i++) { + if (state->labels[i]) + free(state->labels[i]); + } + free(state->labels); + free(state->labels_values); + free(state->registers); + free(state->args->arg1); + free(state->args->arg2); + free(state->args); + + free(state); +} + +void set_exit_state(int exit_state) { + state->should_exit = exit_state; +} + +int get_exit_state() { + return state->should_exit; +} + +LABEL_ERR add_label(char *label, int line) { + if (label == NULL) + return LABEL_INVALID; + if (state->num_labels == MAX_LABELS) + return LABEL_MAX; + + for (int i = 0; i < state->num_labels; i++) + if (strcmp(label, state->labels[i]) == 0) + return LABEL_ALREADY_EXISTS; + + char *line_copy = strdup(label); + if (line_copy == NULL) { + fprintf(fstream, "Error allocating memory.\n"); + return LABEL_ERROR; + } + char **temp = realloc(state->labels, (state->num_labels + 1) * sizeof(char*)); + if (temp == NULL) { + fprintf(fstream, "Error allocating memory.\n"); + return LABEL_ERROR; + } + state->labels = temp; + state->labels_values[state->num_labels] = line; + state->labels[state->num_labels++] = line_copy; + return LABEL_OK; +} + +char *extract_arg(char *ptr, int a) { + char *arg = 0; + char *ptr2 = strstr(ptr, ";"); + if (ptr2) + ptr2[0] = '\0'; + if (a == 0) { + arg = strtok(ptr, ","); + } else { + arg = strtok(NULL, ","); + } + if (arg == NULL) + return NULL; + if (arg[0] == ' ') + arg++; + ptr2 = strstr(arg, " "); + if (ptr2) + ptr2[0] = '\0'; + return arg; +} + +int parse_arguments(char *line) { + strcpy(state->args->arg1, ""); + strcpy(state->args->arg2, ""); + + char *line_cpy = strdup(line); + char *ptr = strstr(line_cpy, " "); + char *arg = 0; + if (!ptr) { + free(line_cpy); + return 0; + } + if ((arg = extract_arg(ptr, 0)) == NULL) { + free(line_cpy); + return 0; + } + strcpy(state->args->arg1, arg); + if ((arg = extract_arg(ptr, 1)) == NULL) { + free(line_cpy); + return 0; + } + strcpy(state->args->arg2, arg); + free(line_cpy); + return 0; +} diff --git a/interpreter_states.h b/interpreter_states.h new file mode 100644 index 0000000..d8aa291 --- /dev/null +++ b/interpreter_states.h @@ -0,0 +1,71 @@ +#pragma once +#include + +#define MAX_LABELS 256 +#define MAX_ARG_SIZE 25 +#define STACK_SIZE 50 + +extern FILE *fstream; + +typedef enum cmp_return_codes { + CMP_ERROR = -1, //unused + CMP_EQUAL, + CMP_BELOW, + CMP_ABOVE, +} cmp_return_codes; + +typedef enum check_args_codes { + ARG1_WRONG, + ARG2_WRONG, + WRONG_NUMBER, + OK +} check_args_codes ; + +typedef enum stack_codes { + OVERFLOW, + UNDERFLOW, + STACK_OK +} stack_codes; + +typedef struct t_arguments { + char* arg1; + char* arg2; +} s_arguments; + +typedef struct t_registers { + int a1, a2, a3, a4, a5, a6, a7, a8, a9, eax; +} s_registers; + +typedef struct t_state { + int curr_line; + int num_labels; + char **labels; + int *labels_values; + s_arguments *args; + s_registers *registers; + int should_exit; + int RET_STACK[STACK_SIZE]; + int RET_STACK_IDX; + int STACK_IDX; + int STACK[STACK_SIZE]; + int last_jmp_code; + stack_codes last_stack_code; + cmp_return_codes last_cmp_code; + check_args_codes last_check_args_code; +} s_state; +extern s_state *state; + +typedef enum E_LABEL_ERR { + LABEL_OK, + LABEL_ALREADY_EXISTS, + LABEL_INVALID, + LABEL_MAX, + LABEL_ERROR +} LABEL_ERR; + +int init_state(); +void free_state(); +void set_exit_state(int exit_state); +int get_exit_state(); +LABEL_ERR add_label(char *label, int line); +int parse_arguments(char *args); diff --git a/pasm.c b/pasm.c new file mode 100644 index 0000000..4dbbbc1 --- /dev/null +++ b/pasm.c @@ -0,0 +1,114 @@ +#include +#include + +#include "file_utils.h" +#include "interpreter_states.h" +#include "instructions.h" + +FILE *fstream = NULL; +void show_error(size_t line, char *line_) { + int wrote = fprintf(fstream, "%ld| ", line + 1); + fprintf(fstream, "%s\n", line_); + fprintf(fstream, "%*s\n", wrote + 1, "^"); + fprintf(fstream, "%*s\n", wrote + 1, "|"); + for (int i = 0; i < wrote; i++) + fprintf(fstream, " "); +} + +void show_states() { + printf("\n\n--------PASM STATE--------\n"); + printf("a1: %-3d | ", state->registers->a1); + printf("a2: %-3d | ", state->registers->a2); + printf("a3: %-3d\n", state->registers->a3); + printf("a4: %-3d | ", state->registers->a4); + printf("a5: %-3d | ", state->registers->a5); + printf("a6: %-3d\n", state->registers->a6); + printf("a7: %-3d | ", state->registers->a7); + printf("a8: %-3d | ", state->registers->a8); + printf("a9: %-3d\n", state->registers->a9); + printf("eax: %-3d\n", state->registers->eax); +} + +int check_errors(char *line) { + if (state->last_check_args_code != OK) { + show_error(state->curr_line, line); + + switch ((int)state->last_check_args_code) { + case WRONG_NUMBER : + fprintf(fstream, "wrong number of arguments on line %d\n", state->curr_line + 1); + break; + case ARG1_WRONG : + fprintf(fstream, "arg1 is invalid on line %d\n", state->curr_line + 1); + break; + case ARG2_WRONG : + fprintf(fstream, "arg2 is invalid on line %d\n", state->curr_line + 1); + break; + } + return 1; + } + + if (state->last_jmp_code) { + show_error(state->curr_line, line); + fprintf(fstream, "%s is not a valid label/api", state->args->arg1); + return 1; + } + + if (state->last_stack_code != STACK_OK) { + show_error(state->curr_line, line); + fprintf(fstream, "stack %s on line %d", + state->last_stack_code == OVERFLOW ? "overflow" : "underflow", state->curr_line + 1); + return 1; + } + return 0; +} + +int pasm_run_script(const char *filename, char **file, size_t lines, FILE *_fstream) { + fstream = _fstream; + + if (filename && read_script(filename, &file, &lines) == 1) + return 1; + if (init_state() == 1) { + fprintf(fstream, "Failed to initialize the interpreter.\n"); + free_script(file); + return 1; + } + + int found_main = 0; + for (state->curr_line = 0; state->curr_line < (int)lines && get_exit_state() == 0 ; ++state->curr_line) { + char *line = strdup(file[state->curr_line]); + if (line[0] == ';' || line[0] == '\0') { + free(line); + continue; + } + const command_t *com = find_command(command_map, strtok(line, " ")); + if (com == NULL || com->fptr == NULL) { + if (file[state->curr_line][strlen(line) - 1] != ':') { + show_error(state->curr_line, file[state->curr_line]); + fprintf(fstream, "%s \"%s\"\n", "unknown expression", strtok(file[state->curr_line], " ")); + set_exit_state(-1); + free(line); + break; + } + add_label(line, state->curr_line); + if (!found_main && strcmp(line, "main:") == 0) + found_main = 1; + free(line); + continue; + } + parse_arguments(file[state->curr_line]); + if (found_main) + com->fptr(); + if (check_errors(file[state->curr_line])) { + set_exit_state(-1); + break; + } + free(line); + } + + int ret_code = get_exit_state(); +#ifdef DEBUG + show_states(); +#endif + free_script(file); + return ret_code; +} diff --git a/tests/Makefile b/tests/Makefile new file mode 100644 index 0000000..5f39b40 --- /dev/null +++ b/tests/Makefile @@ -0,0 +1,22 @@ +SRC = lib_use.c +OBJ = $(SRC:.c=.o) +NAME = lib_use +CFLAGS = -Wall -Wextra -Wpedantic -I../include +CLIBS = ../libpasm.a + +all: $(NAME) + +$(NAME): $(OBJ) + cd .. && $(MAKE) lib + gcc $(SRC) $(CFLAGS) $(CLIBS) -o $(NAME) + +clean: + rm -f $(OBJ) + +fclean: clean + rm -f $(NAME) + +re: fclean +re: $(NAME) + +.PHONY : all $(NAME) clean fclean re diff --git a/tests/interpreter.c b/tests/interpreter.c new file mode 100644 index 0000000..3d95cd5 --- /dev/null +++ b/tests/interpreter.c @@ -0,0 +1,12 @@ +#include "../include/pasm.h" +#include +#include +#include + +int main(int argc, char **argv) { + if (argc != 2 || strcmp(argv[1], "-h") == 0) { + fprintf(stderr, "Usage : %s filename\n", argv[0]); + return 1; + } + return pasm_run_script(argv[1], 0, 0, stderr); +} diff --git a/tests/lib_use.c b/tests/lib_use.c new file mode 100644 index 0000000..5ee7bea --- /dev/null +++ b/tests/lib_use.c @@ -0,0 +1,11 @@ +#include "../include/pasm.h" + +int main(void) { + char output[1024] = {0}; + FILE *memfile = fmemopen(output, sizeof(output), "w"); + + pasm_run_script("../examples/test.pasm", 0, 0, memfile); + fclose(memfile); + printf("%s", output); + return 0; +}