From b18489743e4a5e75219272854518b4fca1ac0d6a Mon Sep 17 00:00:00 2001 From: vincent Date: Mon, 25 May 2020 09:34:42 +0800 Subject: [PATCH 01/15] rust: add evmc client binding --- Cargo.toml | 1 + bindings/rust/evmc-client/.gitignore | 3 + bindings/rust/evmc-client/Cargo.toml | 16 + bindings/rust/evmc-client/LICENSE | 661 ++++++++++++++++++++++++ bindings/rust/evmc-client/src/host.rs | 320 ++++++++++++ bindings/rust/evmc-client/src/lib.rs | 176 +++++++ bindings/rust/evmc-client/src/loader.rs | 85 +++ bindings/rust/evmc-client/src/types.rs | 29 ++ 8 files changed, 1291 insertions(+) create mode 100644 bindings/rust/evmc-client/.gitignore create mode 100644 bindings/rust/evmc-client/Cargo.toml create mode 100644 bindings/rust/evmc-client/LICENSE create mode 100644 bindings/rust/evmc-client/src/host.rs create mode 100644 bindings/rust/evmc-client/src/lib.rs create mode 100644 bindings/rust/evmc-client/src/loader.rs create mode 100644 bindings/rust/evmc-client/src/types.rs diff --git a/Cargo.toml b/Cargo.toml index 0e0e1b774..1747c137c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ members = [ "bindings/rust/evmc-sys", "bindings/rust/evmc-vm", + "bindings/rust/evmc-client", "bindings/rust/evmc-declare", "bindings/rust/evmc-declare-tests", "bindings/rust/evmc-loader", diff --git a/bindings/rust/evmc-client/.gitignore b/bindings/rust/evmc-client/.gitignore new file mode 100644 index 000000000..84c47ed70 --- /dev/null +++ b/bindings/rust/evmc-client/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +/Cargo.lock diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml new file mode 100644 index 000000000..dc17eb899 --- /dev/null +++ b/bindings/rust/evmc-client/Cargo.toml @@ -0,0 +1,16 @@ +# EVMC: Ethereum Client-VM Connector API. +# Copyright 2019 The EVMC Authors. +# Licensed under the Apache License, Version 2.0. + +[package] +name = "evmc-client" +version = "6.3.1" +authors = ["Zigang Lin "] +license = "Apache-2.0" +repository = "https://github.com/ethereum/evmc" +description = "Bindings to EVMC (Client/Host specific)" +edition = "2018" + +[dependencies] +evmc-sys = { path = "../evmc-sys" } +libloading = "0.5" \ No newline at end of file diff --git a/bindings/rust/evmc-client/LICENSE b/bindings/rust/evmc-client/LICENSE new file mode 100644 index 000000000..be3f7b28e --- /dev/null +++ b/bindings/rust/evmc-client/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs new file mode 100644 index 000000000..950035ba1 --- /dev/null +++ b/bindings/rust/evmc-client/src/host.rs @@ -0,0 +1,320 @@ +// Copyright (C) 2020 Second State. +// This file is part of Rust-SSVM. + +// Rust-SSVM is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. + +// Rust-SSVM 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 Affero General Public License for more details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +use crate::types::*; +use evmc_sys as ffi; +use std::mem; + +pub trait HostInterface { + fn account_exists(&mut self, addr: &Address) -> bool; + fn get_storage(&mut self, addr: &Address, key: &Bytes32) -> Bytes32; + fn set_storage(&mut self, addr: &Address, key: &Bytes32, value: &Bytes32) -> StorageStatus; + fn get_balance(&mut self, addr: &Address) -> Bytes32; + fn get_code_size(&mut self, addr: &Address) -> usize; + fn get_code_hash(&mut self, addr: &Address) -> Bytes32; + fn copy_code( + &mut self, + addr: &Address, + offset: &usize, + buffer_data: &*mut u8, + buffer_size: &usize, + ) -> usize; + fn selfdestruct(&mut self, addr: &Address, beneficiary: &Address); + fn get_tx_context(&mut self) -> (Bytes32, Address, Address, i64, i64, i64, Bytes32, Bytes32); + fn get_block_hash(&mut self, number: i64) -> Bytes32; + fn emit_log(&mut self, addr: &Address, topics: &Vec, data: &Bytes); + fn call( + &mut self, + kind: CallKind, + destination: &Address, + sender: &Address, + value: &Bytes32, + input: &Bytes, + gas: i64, + depth: i32, + is_static: bool, + ) -> (Vec, i64, Address, StatusCode); +} + +struct Callback { + host_interface: ::std::option::Option>, +} + +static mut CALLBACK: Callback = Callback { host_interface: None }; + +pub fn set_host_interface(interface: Option>) { + unsafe { + CALLBACK.host_interface = interface; + } +} + +pub fn get_evmc_host_context() -> ffi::evmc_host_context { + ffi::evmc_host_context {_bindgen_opaque_blob:[0u8; 0]} +} + +pub fn get_evmc_host_interface() -> ffi::evmc_host_interface { + ffi::evmc_host_interface { + account_exists: Some(account_exists), + get_storage: Some(get_storage), + set_storage: Some(set_storage), + get_balance: Some(get_balance), + get_code_size: Some(get_code_size), + get_code_hash: Some(get_code_hash), + copy_code: Some(copy_code), + selfdestruct: Some(selfdestruct), + call: Some(call), + get_tx_context: Some(get_tx_context), + get_block_hash: Some(get_block_hash), + emit_log: Some(emit_log), + } +} + +unsafe extern "C" fn account_exists( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, +) -> bool { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return host_interface.account_exists(&(*address).bytes); + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_storage( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, + key: *const ffi::evmc_bytes32, +) -> ffi::evmc_bytes32 { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return ffi::evmc_bytes32 { + bytes: host_interface.get_storage(&(*address).bytes, &(*key).bytes), + }; + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn set_storage( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, + key: *const ffi::evmc_bytes32, + value: *const ffi::evmc_bytes32, +) -> ffi::evmc_storage_status { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return host_interface.set_storage(&(*address).bytes, &(*key).bytes, &(*value).bytes); + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_balance( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, +) -> ffi::evmc_uint256be { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return ffi::evmc_uint256be { + bytes: host_interface.get_balance(&(*address).bytes), + }; + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_code_size( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, +) -> usize { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return host_interface.get_code_size(&(*address).bytes); + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_code_hash( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, +) -> ffi::evmc_bytes32 { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return ffi::evmc_bytes32 { + bytes: host_interface.get_code_hash(&(*address).bytes), + }; + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn copy_code( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, + code_offset: usize, + buffer_data: *mut u8, + buffer_size: usize, +) -> usize { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return host_interface.copy_code( + &(*address).bytes, + &code_offset, + &buffer_data, + &buffer_size, + ); + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn selfdestruct( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, + beneficiary: *const ffi::evmc_address, +) { + match &mut CALLBACK.host_interface { + Some(host_interface) => host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes), + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_tx_context(_context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + let (gas_price, origin, coinbase, number, timestamp, gas_limit, difficulty, chain_id) = + host_interface.get_tx_context(); + return ffi::evmc_tx_context { + tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, + tx_origin: evmc_sys::evmc_address { bytes: origin }, + block_coinbase: evmc_sys::evmc_address { bytes: coinbase }, + block_number: number, + block_timestamp: timestamp, + block_gas_limit: gas_limit, + block_difficulty: evmc_sys::evmc_bytes32 { bytes: difficulty }, + chain_id: evmc_sys::evmc_bytes32 { bytes: chain_id }, + }; + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn get_block_hash( + _context: *mut ffi::evmc_host_context, + number: i64, +) -> ffi::evmc_bytes32 { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + return ffi::evmc_bytes32 { + bytes: host_interface.get_block_hash(number), + }; + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn emit_log( + _context: *mut ffi::evmc_host_context, + address: *const ffi::evmc_address, + data: *const u8, + data_size: usize, + topics: *const ffi::evmc_bytes32, + topics_count: usize, +) { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + let ts = &std::slice::from_raw_parts(topics, topics_count) + .iter() + .map(|topic| topic.bytes) + .collect::>(); + host_interface.emit_log( + &(*address).bytes, + &ts, + &std::slice::from_raw_parts(data, data_size), + ); + } + None => { + panic!("Host context not implemented"); + } + } +} + +unsafe extern "C" fn release(result: *const ffi::evmc_result) { + drop(std::slice::from_raw_parts( + (*result).output_data, + (*result).output_size, + )); +} + +pub unsafe extern "C" fn call( + _context: *mut ffi::evmc_host_context, + msg: *const ffi::evmc_message, +) -> ffi::evmc_result { + match &mut CALLBACK.host_interface { + Some(host_interface) => { + let msg = *msg; + let (output, gas_left, create_address, status_code) = host_interface.call( + msg.kind, + &msg.destination.bytes, + &msg.sender.bytes, + &msg.value.bytes, + &std::slice::from_raw_parts(msg.input_data, msg.input_size), + msg.gas, + msg.depth, + msg.flags != 0, + ); + let ptr = output.as_ptr(); + let len = output.len(); + mem::forget(output); + return ffi::evmc_result { + status_code: status_code, + gas_left: gas_left, + output_data: ptr, + output_size: len, + release: Some(release), + create_address: ffi::evmc_address { + bytes: create_address, + }, + padding: [0u8; 4], + }; + } + None => { + panic!("Host context not implemented"); + } + } +} diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs new file mode 100644 index 000000000..e0d1ab011 --- /dev/null +++ b/bindings/rust/evmc-client/src/lib.rs @@ -0,0 +1,176 @@ +// Copyright (C) 2020 Second State. +// This file is part of Rust-SSVM. + +// Rust-SSVM is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. + +// Rust-SSVM 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 Affero General Public License for more details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +pub mod host; +mod loader; +pub mod types; +pub use self::loader::EvmcLoaderErrorCode; + +use crate::loader::evmc_load_and_create; +use crate::types::*; +use evmc_sys as ffi; +use std::ffi::CStr; + +extern "C" { + fn evmc_create() -> *mut ffi::evmc_vm; +} + +fn error(err: EvmcLoaderErrorCode) -> Result { + match err { + EvmcLoaderErrorCode::EvmcLoaderSucces => Ok(EvmcLoaderErrorCode::EvmcLoaderSucces), + EvmcLoaderErrorCode::EvmcLoaderCannotOpen => Err("evmc loader: library cannot open"), + EvmcLoaderErrorCode::EvmcLoaderSymbolNotFound => { + Err("evmc loader: the EVMC create function not found") + } + EvmcLoaderErrorCode::EvmcLoaderInvalidArgument => { + panic!("evmc loader: filename argument is invalid") + } + EvmcLoaderErrorCode::EvmcLoaderInstanceCreationFailure => { + Err("evmc loader: VM instance creation failure") + } + EvmcLoaderErrorCode::EvmcLoaderAbiVersionMismatch => { + Err("evmc loader: ABI version mismatch") + } + _ => Err("evmc loader: unexpected error"), + } +} + +pub struct EvmcVm { + handle: *mut ffi::evmc_vm, + host_context: *mut ffi::evmc_host_context, + host_interface: *mut ffi::evmc_host_interface, +} + +impl EvmcVm { + pub fn get_abi_version(&self) -> i32 { + unsafe { + let version: i32 = (*self.handle).abi_version; + version + } + } + + pub fn get_name(&self) -> &str { + unsafe { + let c_str: &CStr = CStr::from_ptr((*self.handle).name); + c_str.to_str().unwrap() + } + } + + pub fn get_version(&self) -> &str { + unsafe { + let c_str: &CStr = CStr::from_ptr((*self.handle).version); + c_str.to_str().unwrap() + } + } + + pub fn destroy(&self) { + unsafe { ((*self.handle).destroy.unwrap())(self.handle) } + } + + pub fn execute( + &self, + host_interface: Box, + rev: Revision, + kind: CallKind, + is_static: bool, + depth: i32, + gas: i64, + destination: &Address, + sender: &Address, + input: &Bytes, + value: &Bytes32, + code: &Bytes, + create2_salt: &Bytes32, + ) -> (&Bytes, i64, StatusCode) { + host::set_host_interface(Some(host_interface)); + let evmc_destination = ffi::evmc_address { + bytes: *destination, + }; + let evmc_sender = ffi::evmc_address { bytes: *sender }; + let evmc_value = ffi::evmc_uint256be { bytes: *value }; + let evmc_create2_salt = ffi::evmc_bytes32 { + bytes: *create2_salt, + }; + let mut evmc_flags: u32 = 0; + unsafe { + if is_static { + evmc_flags |= + std::mem::transmute::(ffi::evmc_flags::EVMC_STATIC); + } + } + let evmc_message = Box::into_raw(Box::new({ + ffi::evmc_message { + kind: kind, + flags: evmc_flags, + depth: depth, + gas: gas, + destination: evmc_destination, + sender: evmc_sender, + input_data: input.as_ptr(), + input_size: input.len(), + value: evmc_value, + create2_salt: evmc_create2_salt, + } + })); + + unsafe { + let result = ((*self.handle).execute.unwrap())( + self.handle, + self.host_interface, + self.host_context, + rev, + evmc_message, + code.as_ptr(), + code.len(), + ); + host::set_host_interface(None); + return ( + std::slice::from_raw_parts(result.output_data, result.output_size), + result.gas_left, + result.status_code, + ); + } + } + + pub fn has_capability(&self, capability: Capabilities) -> bool { + unsafe { + std::mem::transmute::(capability) + == ((*self.handle).get_capabilities.unwrap())(self.handle) + } + } +} + +pub fn load(fname: &str) -> (EvmcVm, Result) { + let (instance, ec) = evmc_load_and_create(fname); + ( + EvmcVm { + handle: instance, + host_context: Box::into_raw(Box::new(host::get_evmc_host_context())), + host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), + }, + error(ec), + ) +} + +pub fn create() -> EvmcVm { + unsafe { + EvmcVm { + handle: evmc_create(), + host_context: Box::into_raw(Box::new(host::get_evmc_host_context())), + host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), + } + } +} diff --git a/bindings/rust/evmc-client/src/loader.rs b/bindings/rust/evmc-client/src/loader.rs new file mode 100644 index 000000000..d96cf2299 --- /dev/null +++ b/bindings/rust/evmc-client/src/loader.rs @@ -0,0 +1,85 @@ +// Copyright (C) 2020 Second State. +// This file is part of Rust-SSVM. + +// Rust-SSVM is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. + +// Rust-SSVM 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 Affero General Public License for more details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +use evmc_sys as ffi; +use libloading::{Library, Symbol}; +use std::ptr; +use std::str; + +type EvmcCreate = extern "C" fn() -> *mut ffi::evmc_vm; + +#[derive(Debug)] +pub enum EvmcLoaderErrorCode { + /** The loader succeeded. */ + EvmcLoaderSucces = 0, + + /** The loader cannot open the given file name. */ + EvmcLoaderCannotOpen = 1, + + /** The VM create function not found. */ + EvmcLoaderSymbolNotFound = 2, + + /** The invalid argument value provided. */ + EvmcLoaderInvalidArgument = 3, + + /** The creation of a VM instance has failed. */ + EvmcLoaderInstanceCreationFailure = 4, + + /** The ABI version of the VM instance has mismatched. */ + EvmcLoaderAbiVersionMismatch = 5, + + /** The VM option is invalid. */ + EvmcLoaderInvalidOptionName = 6, + + /** The VM option value is invalid. */ + EvmcLoaderInvalidOptionValue = 7, +} + +pub fn evmc_load_and_create(fname: &str) -> (*mut ffi::evmc_vm, EvmcLoaderErrorCode) { + unsafe { + let mut instance: *mut ffi::evmc_vm = ptr::null_mut(); + + let library: Library = match Library::new(fname) { + Ok(lib) => lib, + Err(_) => { + return (instance, EvmcLoaderErrorCode::EvmcLoaderCannotOpen); + } + }; + + let evmc_create_fn: Symbol = match library.get(b"evmc_create\0") { + Ok(symbol) => symbol, + Err(_) => { + return (instance, EvmcLoaderErrorCode::EvmcLoaderSymbolNotFound); + } + }; + + instance = evmc_create_fn(); + + if instance.is_null() { + return ( + instance, + EvmcLoaderErrorCode::EvmcLoaderInstanceCreationFailure, + ); + } + + if (*instance).abi_version + != std::mem::transmute::(ffi::EVMC_ABI_VERSION) + { + return (instance, EvmcLoaderErrorCode::EvmcLoaderAbiVersionMismatch); + } + return (instance, EvmcLoaderErrorCode::EvmcLoaderSucces); + } +} diff --git a/bindings/rust/evmc-client/src/types.rs b/bindings/rust/evmc-client/src/types.rs new file mode 100644 index 000000000..1c41cf066 --- /dev/null +++ b/bindings/rust/evmc-client/src/types.rs @@ -0,0 +1,29 @@ +// Copyright (C) 2020 Second State. +// This file is part of Rust-SSVM. + +// Rust-SSVM is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. + +// Rust-SSVM 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 Affero General Public License for more details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +pub use evmc_sys as ffi; + +pub const ADDRESS_LENGTH: usize = 20; +pub const BYTES32_LENGTH: usize = 32; +pub type Address = [u8; ADDRESS_LENGTH]; +pub type Bytes32 = [u8; BYTES32_LENGTH]; +pub type Bytes = [u8]; + +pub type StorageStatus = ffi::evmc_storage_status; +pub type CallKind = ffi::evmc_call_kind; +pub type Revision = ffi::evmc_revision; +pub type StatusCode = ffi::evmc_status_code; +pub type Capabilities = ffi::evmc_capabilities; From 0bf0f82e377645639a734f2da1465dbb63011ca0 Mon Sep 17 00:00:00 2001 From: vincent Date: Fri, 26 Jun 2020 14:58:26 +0800 Subject: [PATCH 02/15] license: consistent with official used --- bindings/rust/evmc-client/Cargo.toml | 4 +- bindings/rust/evmc-client/LICENSE | 661 ------------------------ bindings/rust/evmc-client/src/host.rs | 31 +- bindings/rust/evmc-client/src/lib.rs | 21 +- bindings/rust/evmc-client/src/loader.rs | 19 +- bindings/rust/evmc-client/src/types.rs | 19 +- 6 files changed, 28 insertions(+), 727 deletions(-) delete mode 100644 bindings/rust/evmc-client/LICENSE diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index dc17eb899..7ee5c48e6 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -4,7 +4,7 @@ [package] name = "evmc-client" -version = "6.3.1" +version = "7.4.0" authors = ["Zigang Lin "] license = "Apache-2.0" repository = "https://github.com/ethereum/evmc" @@ -12,5 +12,5 @@ description = "Bindings to EVMC (Client/Host specific)" edition = "2018" [dependencies] -evmc-sys = { path = "../evmc-sys" } +evmc-sys = { path = "../evmc-sys", version = "7.4.0" } libloading = "0.5" \ No newline at end of file diff --git a/bindings/rust/evmc-client/LICENSE b/bindings/rust/evmc-client/LICENSE deleted file mode 100644 index be3f7b28e..000000000 --- a/bindings/rust/evmc-client/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 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 Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are 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. - - 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. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - 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 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 work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - 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 AGPL, see -. diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 950035ba1..d8c65754f 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -1,18 +1,7 @@ -// Copyright (C) 2020 Second State. -// This file is part of Rust-SSVM. - -// Rust-SSVM is free software: you can redistribute it and/or modify -// it under the terms of the GNU Affero General Public License as -// published by the Free Software Foundation, either version 3 of the -// License, or (at your option) any later version. - -// Rust-SSVM 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 Affero General Public License for more details. - -// You should have received a copy of the GNU Affero General Public License -// along with this program. If not, see . +/* EVMC: Ethereum Client-VM Connector API. + * Copyright 2019 The EVMC Authors. + * Licensed under the Apache License, Version 2.0. + */ use crate::types::*; use evmc_sys as ffi; @@ -53,7 +42,9 @@ struct Callback { host_interface: ::std::option::Option>, } -static mut CALLBACK: Callback = Callback { host_interface: None }; +static mut CALLBACK: Callback = Callback { + host_interface: None, +}; pub fn set_host_interface(interface: Option>) { unsafe { @@ -62,7 +53,9 @@ pub fn set_host_interface(interface: Option>) { } pub fn get_evmc_host_context() -> ffi::evmc_host_context { - ffi::evmc_host_context {_bindgen_opaque_blob:[0u8; 0]} + ffi::evmc_host_context { + _bindgen_opaque_blob: [0u8; 0], + } } pub fn get_evmc_host_interface() -> ffi::evmc_host_interface { @@ -203,7 +196,9 @@ unsafe extern "C" fn selfdestruct( beneficiary: *const ffi::evmc_address, ) { match &mut CALLBACK.host_interface { - Some(host_interface) => host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes), + Some(host_interface) => { + host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes) + } None => { panic!("Host context not implemented"); } diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index e0d1ab011..d74585f21 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -1,18 +1,7 @@ -// Copyright (C) 2020 Second State. -// This file is part of Rust-SSVM. - -// Rust-SSVM is free software: you can redistribute it and/or modify -// it under the terms of the GNU Affero General Public License as -// published by the Free Software Foundation, either version 3 of the -// License, or (at your option) any later version. - -// Rust-SSVM 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 Affero General Public License for more details. - -// You should have received a copy of the GNU Affero General Public License -// along with this program. If not, see . +/* EVMC: Ethereum Client-VM Connector API. + * Copyright 2019 The EVMC Authors. + * Licensed under the Apache License, Version 2.0. + */ pub mod host; mod loader; @@ -50,7 +39,7 @@ fn error(err: EvmcLoaderErrorCode) -> Result pub struct EvmcVm { handle: *mut ffi::evmc_vm, - host_context: *mut ffi::evmc_host_context, + host_context: *mut ffi::evmc_host_context, host_interface: *mut ffi::evmc_host_interface, } diff --git a/bindings/rust/evmc-client/src/loader.rs b/bindings/rust/evmc-client/src/loader.rs index d96cf2299..0bba06c9a 100644 --- a/bindings/rust/evmc-client/src/loader.rs +++ b/bindings/rust/evmc-client/src/loader.rs @@ -1,18 +1,7 @@ -// Copyright (C) 2020 Second State. -// This file is part of Rust-SSVM. - -// Rust-SSVM is free software: you can redistribute it and/or modify -// it under the terms of the GNU Affero General Public License as -// published by the Free Software Foundation, either version 3 of the -// License, or (at your option) any later version. - -// Rust-SSVM 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 Affero General Public License for more details. - -// You should have received a copy of the GNU Affero General Public License -// along with this program. If not, see . +/* EVMC: Ethereum Client-VM Connector API. + * Copyright 2019 The EVMC Authors. + * Licensed under the Apache License, Version 2.0. + */ use evmc_sys as ffi; use libloading::{Library, Symbol}; diff --git a/bindings/rust/evmc-client/src/types.rs b/bindings/rust/evmc-client/src/types.rs index 1c41cf066..ea95d976a 100644 --- a/bindings/rust/evmc-client/src/types.rs +++ b/bindings/rust/evmc-client/src/types.rs @@ -1,18 +1,7 @@ -// Copyright (C) 2020 Second State. -// This file is part of Rust-SSVM. - -// Rust-SSVM is free software: you can redistribute it and/or modify -// it under the terms of the GNU Affero General Public License as -// published by the Free Software Foundation, either version 3 of the -// License, or (at your option) any later version. - -// Rust-SSVM 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 Affero General Public License for more details. - -// You should have received a copy of the GNU Affero General Public License -// along with this program. If not, see . +/* EVMC: Ethereum Client-VM Connector API. + * Copyright 2019 The EVMC Authors. + * Licensed under the Apache License, Version 2.0. + */ pub use evmc_sys as ffi; From 38591e24b41b6a11d6c560ec07cf0563c9f60750 Mon Sep 17 00:00:00 2001 From: vincent Date: Sat, 27 Jun 2020 12:38:27 +0800 Subject: [PATCH 03/15] rust: reorganize alias types 1. remove duplicate types 2. add an alias type Capabilities in evmc-vm --- bindings/rust/evmc-client/Cargo.toml | 3 ++- bindings/rust/evmc-client/src/host.rs | 2 +- bindings/rust/evmc-client/src/lib.rs | 2 +- bindings/rust/evmc-client/src/types.rs | 8 +------- bindings/rust/evmc-vm/src/types.rs | 19 +++++++++++++++++++ 5 files changed, 24 insertions(+), 10 deletions(-) diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index 7ee5c48e6..7e252a227 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -13,4 +13,5 @@ edition = "2018" [dependencies] evmc-sys = { path = "../evmc-sys", version = "7.4.0" } -libloading = "0.5" \ No newline at end of file +evmc-vm = { path = "../evmc-vm", version = "7.4.0" } +libloading = "0.5" diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index d8c65754f..728525348 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -27,7 +27,7 @@ pub trait HostInterface { fn emit_log(&mut self, addr: &Address, topics: &Vec, data: &Bytes); fn call( &mut self, - kind: CallKind, + kind: MessageKind, destination: &Address, sender: &Address, value: &Bytes32, diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index d74585f21..666d2d1cd 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -73,7 +73,7 @@ impl EvmcVm { &self, host_interface: Box, rev: Revision, - kind: CallKind, + kind: MessageKind, is_static: bool, depth: i32, gas: i64, diff --git a/bindings/rust/evmc-client/src/types.rs b/bindings/rust/evmc-client/src/types.rs index ea95d976a..5489ba52b 100644 --- a/bindings/rust/evmc-client/src/types.rs +++ b/bindings/rust/evmc-client/src/types.rs @@ -3,16 +3,10 @@ * Licensed under the Apache License, Version 2.0. */ -pub use evmc_sys as ffi; +pub use evmc_vm::{Capabilities, MessageKind, Revision, StatusCode, StorageStatus}; pub const ADDRESS_LENGTH: usize = 20; pub const BYTES32_LENGTH: usize = 32; pub type Address = [u8; ADDRESS_LENGTH]; pub type Bytes32 = [u8; BYTES32_LENGTH]; pub type Bytes = [u8]; - -pub type StorageStatus = ffi::evmc_storage_status; -pub type CallKind = ffi::evmc_call_kind; -pub type Revision = ffi::evmc_revision; -pub type StatusCode = ffi::evmc_status_code; -pub type Capabilities = ffi::evmc_capabilities; diff --git a/bindings/rust/evmc-vm/src/types.rs b/bindings/rust/evmc-vm/src/types.rs index 336400a57..ebb04f03c 100644 --- a/bindings/rust/evmc-vm/src/types.rs +++ b/bindings/rust/evmc-vm/src/types.rs @@ -15,6 +15,9 @@ pub type MessageKind = ffi::evmc_call_kind; /// EVMC message (call) flags. pub type MessageFlags = ffi::evmc_flags; +/// EVMC VM capabilities. +pub type Capabilities = ffi::evmc_capabilities; + /// EVMC status code. pub type StatusCode = ffi::evmc_status_code; @@ -72,6 +75,22 @@ mod tests { assert_eq!(MessageFlags::EVMC_STATIC, ffi::evmc_flags::EVMC_STATIC); } + #[test] + fn capabilities() { + assert_eq!( + Capabilities::EVMC_CAPABILITY_EVM1, + ffi::evmc_capabilities::EVMC_CAPABILITY_EVM1 + ); + assert_eq!( + Capabilities::EVMC_CAPABILITY_EWASM, + ffi::evmc_capabilities::EVMC_CAPABILITY_EWASM + ); + assert_eq!( + Capabilities::EVMC_CAPABILITY_PRECOMPILES, + ffi::evmc_capabilities::EVMC_CAPABILITY_PRECOMPILES + ); + } + #[test] fn status_code() { assert_eq!( From 9ae61b217d5a62e5fb6e9fa2193a99ad6cc95915 Mon Sep 17 00:00:00 2001 From: vincent Date: Mon, 29 Jun 2020 15:21:22 +0800 Subject: [PATCH 04/15] rust: make evmc-client thread safety with HostContext Refine this module make it more like geth client binding implementation. --- bindings/rust/evmc-client/Cargo.toml | 1 + bindings/rust/evmc-client/src/host.rs | 339 ++++++++++++-------------- bindings/rust/evmc-client/src/lib.rs | 38 ++- 3 files changed, 171 insertions(+), 207 deletions(-) diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index 7e252a227..63e7abae3 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -15,3 +15,4 @@ edition = "2018" evmc-sys = { path = "../evmc-sys", version = "7.4.0" } evmc-vm = { path = "../evmc-vm", version = "7.4.0" } libloading = "0.5" +lazy_static = "1.4.0" diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 728525348..464445fca 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -5,9 +5,37 @@ use crate::types::*; use evmc_sys as ffi; +use lazy_static::lazy_static; +use std::collections::HashMap; use std::mem; +use std::sync::Mutex; -pub trait HostInterface { +#[repr(C)] +pub(crate) struct ExtendedContext { + pub index: i64, +} + +static mut HOST_CONTEXT_COUNTER: i64 = 0; + +lazy_static! { + static ref HOST_CONTEXT_MAP: Mutex>> = + Mutex::new(HashMap::new()); +} + +pub(crate) unsafe fn add_host_context(ctx: Box) -> i64 { + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let id = HOST_CONTEXT_COUNTER; + HOST_CONTEXT_COUNTER += 1; + map.insert(id, ctx); + return id; +} + +pub(crate) fn remove_host_context(id: i64) { + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + map.remove(&id); +} + +pub trait HostContext { fn account_exists(&mut self, addr: &Address) -> bool; fn get_storage(&mut self, addr: &Address, key: &Bytes32) -> Bytes32; fn set_storage(&mut self, addr: &Address, key: &Bytes32, value: &Bytes32) -> StorageStatus; @@ -38,27 +66,7 @@ pub trait HostInterface { ) -> (Vec, i64, Address, StatusCode); } -struct Callback { - host_interface: ::std::option::Option>, -} - -static mut CALLBACK: Callback = Callback { - host_interface: None, -}; - -pub fn set_host_interface(interface: Option>) { - unsafe { - CALLBACK.host_interface = interface; - } -} - -pub fn get_evmc_host_context() -> ffi::evmc_host_context { - ffi::evmc_host_context { - _bindgen_opaque_blob: [0u8; 0], - } -} - -pub fn get_evmc_host_interface() -> ffi::evmc_host_interface { +pub(crate) fn get_evmc_host_interface() -> ffi::evmc_host_interface { ffi::evmc_host_interface { account_exists: Some(account_exists), get_storage: Some(get_storage), @@ -76,197 +84,159 @@ pub fn get_evmc_host_interface() -> ffi::evmc_host_interface { } unsafe extern "C" fn account_exists( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> bool { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return host_interface.account_exists(&(*address).bytes); - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return host_interface.account_exists(&(*address).bytes); } unsafe extern "C" fn get_storage( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, key: *const ffi::evmc_bytes32, ) -> ffi::evmc_bytes32 { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return ffi::evmc_bytes32 { - bytes: host_interface.get_storage(&(*address).bytes, &(*key).bytes), - }; - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return ffi::evmc_bytes32 { + bytes: host_interface.get_storage(&(*address).bytes, &(*key).bytes), + }; } unsafe extern "C" fn set_storage( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, key: *const ffi::evmc_bytes32, value: *const ffi::evmc_bytes32, ) -> ffi::evmc_storage_status { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return host_interface.set_storage(&(*address).bytes, &(*key).bytes, &(*value).bytes); - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return host_interface.set_storage(&(*address).bytes, &(*key).bytes, &(*value).bytes); } unsafe extern "C" fn get_balance( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> ffi::evmc_uint256be { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return ffi::evmc_uint256be { - bytes: host_interface.get_balance(&(*address).bytes), - }; - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return ffi::evmc_uint256be { + bytes: host_interface.get_balance(&(*address).bytes), + }; } unsafe extern "C" fn get_code_size( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> usize { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return host_interface.get_code_size(&(*address).bytes); - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return host_interface.get_code_size(&(*address).bytes); } unsafe extern "C" fn get_code_hash( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> ffi::evmc_bytes32 { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return ffi::evmc_bytes32 { - bytes: host_interface.get_code_hash(&(*address).bytes), - }; - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return ffi::evmc_bytes32 { + bytes: host_interface.get_code_hash(&(*address).bytes), + }; } unsafe extern "C" fn copy_code( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, code_offset: usize, buffer_data: *mut u8, buffer_size: usize, ) -> usize { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return host_interface.copy_code( - &(*address).bytes, - &code_offset, - &buffer_data, - &buffer_size, - ); - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return host_interface.copy_code(&(*address).bytes, &code_offset, &buffer_data, &buffer_size); } unsafe extern "C" fn selfdestruct( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, beneficiary: *const ffi::evmc_address, ) { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes) - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes) } -unsafe extern "C" fn get_tx_context(_context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - let (gas_price, origin, coinbase, number, timestamp, gas_limit, difficulty, chain_id) = - host_interface.get_tx_context(); - return ffi::evmc_tx_context { - tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, - tx_origin: evmc_sys::evmc_address { bytes: origin }, - block_coinbase: evmc_sys::evmc_address { bytes: coinbase }, - block_number: number, - block_timestamp: timestamp, - block_gas_limit: gas_limit, - block_difficulty: evmc_sys::evmc_bytes32 { bytes: difficulty }, - chain_id: evmc_sys::evmc_bytes32 { bytes: chain_id }, - }; - } - None => { - panic!("Host context not implemented"); - } - } +unsafe extern "C" fn get_tx_context(context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + let (gas_price, origin, coinbase, number, timestamp, gas_limit, difficulty, chain_id) = + host_interface.get_tx_context(); + return ffi::evmc_tx_context { + tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, + tx_origin: evmc_sys::evmc_address { bytes: origin }, + block_coinbase: evmc_sys::evmc_address { bytes: coinbase }, + block_number: number, + block_timestamp: timestamp, + block_gas_limit: gas_limit, + block_difficulty: evmc_sys::evmc_bytes32 { bytes: difficulty }, + chain_id: evmc_sys::evmc_bytes32 { bytes: chain_id }, + }; } unsafe extern "C" fn get_block_hash( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, number: i64, ) -> ffi::evmc_bytes32 { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - return ffi::evmc_bytes32 { - bytes: host_interface.get_block_hash(number), - }; - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + return ffi::evmc_bytes32 { + bytes: host_interface.get_block_hash(number), + }; } unsafe extern "C" fn emit_log( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, data: *const u8, data_size: usize, topics: *const ffi::evmc_bytes32, topics_count: usize, ) { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - let ts = &std::slice::from_raw_parts(topics, topics_count) - .iter() - .map(|topic| topic.bytes) - .collect::>(); - host_interface.emit_log( - &(*address).bytes, - &ts, - &std::slice::from_raw_parts(data, data_size), - ); - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + let ts = &std::slice::from_raw_parts(topics, topics_count) + .iter() + .map(|topic| topic.bytes) + .collect::>(); + host_interface.emit_log( + &(*address).bytes, + &ts, + &std::slice::from_raw_parts(data, data_size), + ); } unsafe extern "C" fn release(result: *const ffi::evmc_result) { @@ -277,39 +247,36 @@ unsafe extern "C" fn release(result: *const ffi::evmc_result) { } pub unsafe extern "C" fn call( - _context: *mut ffi::evmc_host_context, + context: *mut ffi::evmc_host_context, msg: *const ffi::evmc_message, ) -> ffi::evmc_result { - match &mut CALLBACK.host_interface { - Some(host_interface) => { - let msg = *msg; - let (output, gas_left, create_address, status_code) = host_interface.call( - msg.kind, - &msg.destination.bytes, - &msg.sender.bytes, - &msg.value.bytes, - &std::slice::from_raw_parts(msg.input_data, msg.input_size), - msg.gas, - msg.depth, - msg.flags != 0, - ); - let ptr = output.as_ptr(); - let len = output.len(); - mem::forget(output); - return ffi::evmc_result { - status_code: status_code, - gas_left: gas_left, - output_data: ptr, - output_size: len, - release: Some(release), - create_address: ffi::evmc_address { - bytes: create_address, - }, - padding: [0u8; 4], - }; - } - None => { - panic!("Host context not implemented"); - } - } + let mut map = HOST_CONTEXT_MAP.lock().unwrap(); + let host_interface = map + .get_mut(&(*(context as *const ExtendedContext)).index) + .unwrap(); + let msg = *msg; + let (output, gas_left, create_address, status_code) = host_interface.call( + msg.kind, + &msg.destination.bytes, + &msg.sender.bytes, + &msg.value.bytes, + &std::slice::from_raw_parts(msg.input_data, msg.input_size), + msg.gas, + msg.depth, + msg.flags != 0, + ); + let ptr = output.as_ptr(); + let len = output.len(); + mem::forget(output); + return ffi::evmc_result { + status_code: status_code, + gas_left: gas_left, + output_data: ptr, + output_size: len, + release: Some(release), + create_address: ffi::evmc_address { + bytes: create_address, + }, + padding: [0u8; 4], + }; } diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index 666d2d1cd..c1f895805 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -7,7 +7,6 @@ pub mod host; mod loader; pub mod types; pub use self::loader::EvmcLoaderErrorCode; - use crate::loader::evmc_load_and_create; use crate::types::*; use evmc_sys as ffi; @@ -39,7 +38,6 @@ fn error(err: EvmcLoaderErrorCode) -> Result pub struct EvmcVm { handle: *mut ffi::evmc_vm, - host_context: *mut ffi::evmc_host_context, host_interface: *mut ffi::evmc_host_interface, } @@ -71,7 +69,7 @@ impl EvmcVm { pub fn execute( &self, - host_interface: Box, + ctx: Box, rev: Revision, kind: MessageKind, is_static: bool, @@ -84,15 +82,12 @@ impl EvmcVm { code: &Bytes, create2_salt: &Bytes32, ) -> (&Bytes, i64, StatusCode) { - host::set_host_interface(Some(host_interface)); - let evmc_destination = ffi::evmc_address { - bytes: *destination, - }; - let evmc_sender = ffi::evmc_address { bytes: *sender }; - let evmc_value = ffi::evmc_uint256be { bytes: *value }; - let evmc_create2_salt = ffi::evmc_bytes32 { - bytes: *create2_salt, - }; + let ext_ctx: *mut host::ExtendedContext; + unsafe { + ext_ctx = Box::into_raw(Box::new(host::ExtendedContext { + index: host::add_host_context(ctx), + })); + } let mut evmc_flags: u32 = 0; unsafe { if is_static { @@ -106,26 +101,29 @@ impl EvmcVm { flags: evmc_flags, depth: depth, gas: gas, - destination: evmc_destination, - sender: evmc_sender, + destination: ffi::evmc_address { + bytes: *destination, + }, + sender: ffi::evmc_address { bytes: *sender }, input_data: input.as_ptr(), input_size: input.len(), - value: evmc_value, - create2_salt: evmc_create2_salt, + value: ffi::evmc_uint256be { bytes: *value }, + create2_salt: ffi::evmc_bytes32 { + bytes: *create2_salt, + }, } })); - unsafe { let result = ((*self.handle).execute.unwrap())( self.handle, self.host_interface, - self.host_context, + ext_ctx as *mut ffi::evmc_host_context, rev, evmc_message, code.as_ptr(), code.len(), ); - host::set_host_interface(None); + host::remove_host_context((*ext_ctx).index); return ( std::slice::from_raw_parts(result.output_data, result.output_size), result.gas_left, @@ -147,7 +145,6 @@ pub fn load(fname: &str) -> (EvmcVm, Result) ( EvmcVm { handle: instance, - host_context: Box::into_raw(Box::new(host::get_evmc_host_context())), host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), }, error(ec), @@ -158,7 +155,6 @@ pub fn create() -> EvmcVm { unsafe { EvmcVm { handle: evmc_create(), - host_context: Box::into_raw(Box::new(host::get_evmc_host_context())), host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), } } From 4d33088563680f0fb8d4934f6eeb565d3abb4e4f Mon Sep 17 00:00:00 2001 From: vincent Date: Mon, 20 Jul 2020 15:30:04 +0800 Subject: [PATCH 05/15] rust: use evmc c loader replace pure rust version --- bindings/rust/evmc-client/Cargo.toml | 11 ++-- bindings/rust/evmc-client/build.rs | 30 +++++++++++ bindings/rust/evmc-client/src/lib.rs | 29 ++--------- bindings/rust/evmc-client/src/loader.rs | 68 ++++++++++++------------- 4 files changed, 75 insertions(+), 63 deletions(-) create mode 100644 bindings/rust/evmc-client/build.rs diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index 63e7abae3..ad4f82e91 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -10,9 +10,14 @@ license = "Apache-2.0" repository = "https://github.com/ethereum/evmc" description = "Bindings to EVMC (Client/Host specific)" edition = "2018" +build = "build.rs" [dependencies] -evmc-sys = { path = "../evmc-sys", version = "7.4.0" } -evmc-vm = { path = "../evmc-vm", version = "7.4.0" } -libloading = "0.5" +evmc-sys = { path = "../evmc-sys" } +evmc-vm = { path = "../evmc-vm" } +enum_primitive = "0.1.1" +num = "0.3" lazy_static = "1.4.0" + +[build-dependencies] +cmake = "0.1.44" diff --git a/bindings/rust/evmc-client/build.rs b/bindings/rust/evmc-client/build.rs new file mode 100644 index 000000000..07b68b437 --- /dev/null +++ b/bindings/rust/evmc-client/build.rs @@ -0,0 +1,30 @@ +// Copyright (C) 2020 Second State. +// This file is part of EVMC-Client. + +// EVMC-Client is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as +// published by the Free Software Foundation, either version 3 of the +// License, or (at your option) any later version. + +// EVMC-Client 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 Affero General Public License for more details. + +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +use std::path::Path; +extern crate cmake; +use cmake::Config; + +fn build_link_evmc_tools() { + let dst = Config::new("../../../").build(); + let evmc_path = Path::new(&dst).join("build/lib/loader"); + println!("cargo:rustc-link-search=native={}", evmc_path.display()); + println!("cargo:rustc-link-lib=static=evmc-loader"); +} + +fn main() { + build_link_evmc_tools(); +} diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index c1f895805..c71a5ebf1 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -3,11 +3,12 @@ * Licensed under the Apache License, Version 2.0. */ +#[macro_use] +extern crate enum_primitive; pub mod host; mod loader; pub mod types; -pub use self::loader::EvmcLoaderErrorCode; -use crate::loader::evmc_load_and_create; +pub use crate::loader::{load_and_create, EvmcLoaderErrorCode}; use crate::types::*; use evmc_sys as ffi; use std::ffi::CStr; @@ -16,26 +17,6 @@ extern "C" { fn evmc_create() -> *mut ffi::evmc_vm; } -fn error(err: EvmcLoaderErrorCode) -> Result { - match err { - EvmcLoaderErrorCode::EvmcLoaderSucces => Ok(EvmcLoaderErrorCode::EvmcLoaderSucces), - EvmcLoaderErrorCode::EvmcLoaderCannotOpen => Err("evmc loader: library cannot open"), - EvmcLoaderErrorCode::EvmcLoaderSymbolNotFound => { - Err("evmc loader: the EVMC create function not found") - } - EvmcLoaderErrorCode::EvmcLoaderInvalidArgument => { - panic!("evmc loader: filename argument is invalid") - } - EvmcLoaderErrorCode::EvmcLoaderInstanceCreationFailure => { - Err("evmc loader: VM instance creation failure") - } - EvmcLoaderErrorCode::EvmcLoaderAbiVersionMismatch => { - Err("evmc loader: ABI version mismatch") - } - _ => Err("evmc loader: unexpected error"), - } -} - pub struct EvmcVm { handle: *mut ffi::evmc_vm, host_interface: *mut ffi::evmc_host_interface, @@ -141,13 +122,13 @@ impl EvmcVm { } pub fn load(fname: &str) -> (EvmcVm, Result) { - let (instance, ec) = evmc_load_and_create(fname); + let (instance, ec) = load_and_create(fname); ( EvmcVm { handle: instance, host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), }, - error(ec), + ec, ) } diff --git a/bindings/rust/evmc-client/src/loader.rs b/bindings/rust/evmc-client/src/loader.rs index 0bba06c9a..6d4879b5f 100644 --- a/bindings/rust/evmc-client/src/loader.rs +++ b/bindings/rust/evmc-client/src/loader.rs @@ -4,12 +4,22 @@ */ use evmc_sys as ffi; -use libloading::{Library, Symbol}; -use std::ptr; +use std::ffi::{CStr, CString}; +use std::os::raw::c_char; use std::str; +extern crate num; +use num::FromPrimitive; + +#[link(name = "evmc-loader")] +extern "C" { + fn evmc_load_and_create( + filename: *const c_char, + evmc_loader_error_code: *mut i32, + ) -> *mut ffi::evmc_vm; + fn evmc_last_error_msg() -> *const c_char; +} -type EvmcCreate = extern "C" fn() -> *mut ffi::evmc_vm; - +enum_from_primitive! { #[derive(Debug)] pub enum EvmcLoaderErrorCode { /** The loader succeeded. */ @@ -36,39 +46,25 @@ pub enum EvmcLoaderErrorCode { /** The VM option value is invalid. */ EvmcLoaderInvalidOptionValue = 7, } +} -pub fn evmc_load_and_create(fname: &str) -> (*mut ffi::evmc_vm, EvmcLoaderErrorCode) { - unsafe { - let mut instance: *mut ffi::evmc_vm = ptr::null_mut(); - - let library: Library = match Library::new(fname) { - Ok(lib) => lib, - Err(_) => { - return (instance, EvmcLoaderErrorCode::EvmcLoaderCannotOpen); - } - }; - - let evmc_create_fn: Symbol = match library.get(b"evmc_create\0") { - Ok(symbol) => symbol, - Err(_) => { - return (instance, EvmcLoaderErrorCode::EvmcLoaderSymbolNotFound); - } - }; - - instance = evmc_create_fn(); - - if instance.is_null() { - return ( - instance, - EvmcLoaderErrorCode::EvmcLoaderInstanceCreationFailure, - ); - } +fn error(err: EvmcLoaderErrorCode) -> Result { + match err { + EvmcLoaderErrorCode::EvmcLoaderSucces => Ok(EvmcLoaderErrorCode::EvmcLoaderSucces), + _ => unsafe { Err(CStr::from_ptr(evmc_last_error_msg()).to_str().unwrap()) }, + } +} - if (*instance).abi_version - != std::mem::transmute::(ffi::EVMC_ABI_VERSION) - { - return (instance, EvmcLoaderErrorCode::EvmcLoaderAbiVersionMismatch); - } - return (instance, EvmcLoaderErrorCode::EvmcLoaderSucces); +pub fn load_and_create( + fname: &str, +) -> (*mut ffi::evmc_vm, Result) { + let c_str = CString::new(fname).unwrap(); + unsafe { + let mut error_code: i32 = 0; + let instance = evmc_load_and_create(c_str.as_ptr() as *const c_char, &mut error_code); + return ( + instance, + error(EvmcLoaderErrorCode::from_i32(error_code).unwrap()), + ); } } From f66ff922459da9b472b17c7109886ca27fe08c17 Mon Sep 17 00:00:00 2001 From: vincent Date: Thu, 30 Jul 2020 07:47:13 +0800 Subject: [PATCH 06/15] rust: refactor avoid hostcontext with lifetime issue 1. A global static variable requires static lifetime. 2. Box with a trait object requires static lifetime. Avoid host context contain a outside variable with conflict lifetime issue. # Conflicts: # bindings/rust/evmc-client/src/host.rs # bindings/rust/evmc-client/src/lib.rs --- bindings/rust/evmc-client/Cargo.toml | 1 - bindings/rust/evmc-client/src/host.rs | 141 +++++++++----------------- bindings/rust/evmc-client/src/lib.rs | 15 ++- 3 files changed, 53 insertions(+), 104 deletions(-) diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index ad4f82e91..a4fe0b5fa 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -17,7 +17,6 @@ evmc-sys = { path = "../evmc-sys" } evmc-vm = { path = "../evmc-vm" } enum_primitive = "0.1.1" num = "0.3" -lazy_static = "1.4.0" [build-dependencies] cmake = "0.1.44" diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 464445fca..4bc7a1efe 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -5,34 +5,11 @@ use crate::types::*; use evmc_sys as ffi; -use lazy_static::lazy_static; -use std::collections::HashMap; use std::mem; -use std::sync::Mutex; #[repr(C)] -pub(crate) struct ExtendedContext { - pub index: i64, -} - -static mut HOST_CONTEXT_COUNTER: i64 = 0; - -lazy_static! { - static ref HOST_CONTEXT_MAP: Mutex>> = - Mutex::new(HashMap::new()); -} - -pub(crate) unsafe fn add_host_context(ctx: Box) -> i64 { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let id = HOST_CONTEXT_COUNTER; - HOST_CONTEXT_COUNTER += 1; - map.insert(id, ctx); - return id; -} - -pub(crate) fn remove_host_context(id: i64) { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - map.remove(&id); +pub(crate) struct ExtendedContext<'a> { + pub hctx: &'a mut dyn HostContext, } pub trait HostContext { @@ -87,11 +64,9 @@ unsafe extern "C" fn account_exists( context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> bool { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); - return host_interface.account_exists(&(*address).bytes); + return (*(context as *mut ExtendedContext)) + .hctx + .account_exists(&(*address).bytes); } unsafe extern "C" fn get_storage( @@ -99,12 +74,10 @@ unsafe extern "C" fn get_storage( address: *const ffi::evmc_address, key: *const ffi::evmc_bytes32, ) -> ffi::evmc_bytes32 { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); return ffi::evmc_bytes32 { - bytes: host_interface.get_storage(&(*address).bytes, &(*key).bytes), + bytes: (*(context as *mut ExtendedContext)) + .hctx + .get_storage(&(*address).bytes, &(*key).bytes), }; } @@ -114,23 +87,21 @@ unsafe extern "C" fn set_storage( key: *const ffi::evmc_bytes32, value: *const ffi::evmc_bytes32, ) -> ffi::evmc_storage_status { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); - return host_interface.set_storage(&(*address).bytes, &(*key).bytes, &(*value).bytes); + return (*(context as *mut ExtendedContext)).hctx.set_storage( + &(*address).bytes, + &(*key).bytes, + &(*value).bytes, + ); } unsafe extern "C" fn get_balance( context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> ffi::evmc_uint256be { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); return ffi::evmc_uint256be { - bytes: host_interface.get_balance(&(*address).bytes), + bytes: (*(context as *mut ExtendedContext)) + .hctx + .get_balance(&(*address).bytes), }; } @@ -138,23 +109,19 @@ unsafe extern "C" fn get_code_size( context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> usize { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); - return host_interface.get_code_size(&(*address).bytes); + return (*(context as *mut ExtendedContext)) + .hctx + .get_code_size(&(*address).bytes); } unsafe extern "C" fn get_code_hash( context: *mut ffi::evmc_host_context, address: *const ffi::evmc_address, ) -> ffi::evmc_bytes32 { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); return ffi::evmc_bytes32 { - bytes: host_interface.get_code_hash(&(*address).bytes), + bytes: (*(context as *mut ExtendedContext)) + .hctx + .get_code_hash(&(*address).bytes), }; } @@ -165,11 +132,12 @@ unsafe extern "C" fn copy_code( buffer_data: *mut u8, buffer_size: usize, ) -> usize { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); - return host_interface.copy_code(&(*address).bytes, &code_offset, &buffer_data, &buffer_size); + return (*(context as *mut ExtendedContext)).hctx.copy_code( + &(*address).bytes, + &code_offset, + &buffer_data, + &buffer_size, + ); } unsafe extern "C" fn selfdestruct( @@ -177,20 +145,14 @@ unsafe extern "C" fn selfdestruct( address: *const ffi::evmc_address, beneficiary: *const ffi::evmc_address, ) { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); - host_interface.selfdestruct(&(*address).bytes, &(*beneficiary).bytes) + (*(context as *mut ExtendedContext)) + .hctx + .selfdestruct(&(*address).bytes, &(*beneficiary).bytes) } unsafe extern "C" fn get_tx_context(context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); let (gas_price, origin, coinbase, number, timestamp, gas_limit, difficulty, chain_id) = - host_interface.get_tx_context(); + (*(context as *mut ExtendedContext)).hctx.get_tx_context(); return ffi::evmc_tx_context { tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, tx_origin: evmc_sys::evmc_address { bytes: origin }, @@ -207,12 +169,10 @@ unsafe extern "C" fn get_block_hash( context: *mut ffi::evmc_host_context, number: i64, ) -> ffi::evmc_bytes32 { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); return ffi::evmc_bytes32 { - bytes: host_interface.get_block_hash(number), + bytes: (*(context as *mut ExtendedContext)) + .hctx + .get_block_hash(number), }; } @@ -224,15 +184,11 @@ unsafe extern "C" fn emit_log( topics: *const ffi::evmc_bytes32, topics_count: usize, ) { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); let ts = &std::slice::from_raw_parts(topics, topics_count) .iter() .map(|topic| topic.bytes) .collect::>(); - host_interface.emit_log( + (*(context as *mut ExtendedContext)).hctx.emit_log( &(*address).bytes, &ts, &std::slice::from_raw_parts(data, data_size), @@ -250,21 +206,18 @@ pub unsafe extern "C" fn call( context: *mut ffi::evmc_host_context, msg: *const ffi::evmc_message, ) -> ffi::evmc_result { - let mut map = HOST_CONTEXT_MAP.lock().unwrap(); - let host_interface = map - .get_mut(&(*(context as *const ExtendedContext)).index) - .unwrap(); let msg = *msg; - let (output, gas_left, create_address, status_code) = host_interface.call( - msg.kind, - &msg.destination.bytes, - &msg.sender.bytes, - &msg.value.bytes, - &std::slice::from_raw_parts(msg.input_data, msg.input_size), - msg.gas, - msg.depth, - msg.flags != 0, - ); + let (output, gas_left, create_address, status_code) = + (*(context as *mut ExtendedContext)).hctx.call( + msg.kind, + &msg.destination.bytes, + &msg.sender.bytes, + &msg.value.bytes, + &std::slice::from_raw_parts(msg.input_data, msg.input_size), + msg.gas, + msg.depth, + msg.flags != 0, + ); let ptr = output.as_ptr(); let len = output.len(); mem::forget(output); diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index c71a5ebf1..dce83bb22 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -50,7 +50,7 @@ impl EvmcVm { pub fn execute( &self, - ctx: Box, + ctx: &mut dyn host::HostContext, rev: Revision, kind: MessageKind, is_static: bool, @@ -63,12 +63,7 @@ impl EvmcVm { code: &Bytes, create2_salt: &Bytes32, ) -> (&Bytes, i64, StatusCode) { - let ext_ctx: *mut host::ExtendedContext; - unsafe { - ext_ctx = Box::into_raw(Box::new(host::ExtendedContext { - index: host::add_host_context(ctx), - })); - } + let ext_ctx = host::ExtendedContext { hctx: ctx }; let mut evmc_flags: u32 = 0; unsafe { if is_static { @@ -98,13 +93,15 @@ impl EvmcVm { let result = ((*self.handle).execute.unwrap())( self.handle, self.host_interface, - ext_ctx as *mut ffi::evmc_host_context, + // ext_ctx as *mut ffi::evmc_host_context, + std::mem::transmute::<&host::ExtendedContext, *mut ffi::evmc_host_context>( + &ext_ctx, + ), rev, evmc_message, code.as_ptr(), code.len(), ); - host::remove_host_context((*ext_ctx).index); return ( std::slice::from_raw_parts(result.output_data, result.output_size), result.gas_left, From 869a21e03a60581598daaa11829d43791a1ca0a4 Mon Sep 17 00:00:00 2001 From: vincent Date: Thu, 30 Jul 2020 07:54:04 +0800 Subject: [PATCH 07/15] rust: call add salt supported --- bindings/rust/evmc-client/src/host.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 4bc7a1efe..7e62e4544 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -40,6 +40,7 @@ pub trait HostContext { gas: i64, depth: i32, is_static: bool, + salt: &Bytes32, ) -> (Vec, i64, Address, StatusCode); } @@ -217,6 +218,7 @@ pub unsafe extern "C" fn call( msg.gas, msg.depth, msg.flags != 0, + &msg.create2_salt.bytes, ); let ptr = output.as_ptr(); let len = output.len(); From 0d9d57a232482fa0979ef1fa913b6af0c1eda1d1 Mon Sep 17 00:00:00 2001 From: vincent Date: Thu, 4 Feb 2021 15:27:38 +0800 Subject: [PATCH 08/15] rust: use git clone evmc source before build and link loader --- bindings/rust/evmc-client/build.rs | 39 +++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/bindings/rust/evmc-client/build.rs b/bindings/rust/evmc-client/build.rs index 07b68b437..02f7be8fb 100644 --- a/bindings/rust/evmc-client/build.rs +++ b/bindings/rust/evmc-client/build.rs @@ -14,17 +14,48 @@ // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . -use std::path::Path; +use std::env; +use std::path::{Path, PathBuf}; +use std::process::Command; extern crate cmake; use cmake::Config; -fn build_link_evmc_tools() { - let dst = Config::new("../../../").build(); +macro_rules! get(($name:expr) => (ok!(env::var($name)))); +macro_rules! ok(($expression:expr) => ($expression.unwrap())); + +const REPOSITORY: &'static str = "https://github.com/second-state/evmc.git"; +const TAG: &'static str = "v7.4.0-rust-evmc-client-rc.2"; + +fn run(name: &str, mut configure: F) +where + F: FnMut(&mut Command) -> &mut Command, +{ + let mut command = Command::new(name); + let configured = configure(&mut command); + if !ok!(configured.status()).success() { + panic!("failed to execute {:?}", configured); + } +} + +fn build_from_src() { + let source = PathBuf::from(&get!("CARGO_MANIFEST_DIR")).join(format!("target/evmc-{}", TAG)); + if !Path::new(&source.join(".git")).exists() { + run("git", |command| { + command + .arg("clone") + .arg(format!("--branch={}", TAG)) + .arg("--recursive") + .arg(REPOSITORY) + .arg(&source) + }); + } + + let dst = Config::new(source).build(); let evmc_path = Path::new(&dst).join("build/lib/loader"); println!("cargo:rustc-link-search=native={}", evmc_path.display()); println!("cargo:rustc-link-lib=static=evmc-loader"); } fn main() { - build_link_evmc_tools(); + build_from_src(); } From c7cf763b6319fa8ce89d7bc4ec9ec7062c84bcb4 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Fri, 6 May 2022 20:45:31 +0200 Subject: [PATCH 09/15] Recent EVMC changes --- bindings/rust/evmc-client/src/host.rs | 13 ++++++++----- bindings/rust/evmc-client/src/lib.rs | 8 +++++--- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 7e62e4544..6c30186da 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -27,13 +27,13 @@ pub trait HostContext { buffer_size: &usize, ) -> usize; fn selfdestruct(&mut self, addr: &Address, beneficiary: &Address); - fn get_tx_context(&mut self) -> (Bytes32, Address, Address, i64, i64, i64, Bytes32, Bytes32); + fn get_tx_context(&mut self) -> (Bytes32, Address, Address, i64, i64, i64, Bytes32, Bytes32, Bytes32); fn get_block_hash(&mut self, number: i64) -> Bytes32; fn emit_log(&mut self, addr: &Address, topics: &Vec, data: &Bytes); fn call( &mut self, kind: MessageKind, - destination: &Address, + recipient: &Address, sender: &Address, value: &Bytes32, input: &Bytes, @@ -58,6 +58,8 @@ pub(crate) fn get_evmc_host_interface() -> ffi::evmc_host_interface { get_tx_context: Some(get_tx_context), get_block_hash: Some(get_block_hash), emit_log: Some(emit_log), + access_account: None, // TODO + access_storage: None, // TODO } } @@ -152,7 +154,7 @@ unsafe extern "C" fn selfdestruct( } unsafe extern "C" fn get_tx_context(context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { - let (gas_price, origin, coinbase, number, timestamp, gas_limit, difficulty, chain_id) = + let (gas_price, origin, coinbase, number, timestamp, gas_limit, prev_randao, chain_id, base_fee) = (*(context as *mut ExtendedContext)).hctx.get_tx_context(); return ffi::evmc_tx_context { tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, @@ -161,8 +163,9 @@ unsafe extern "C" fn get_tx_context(context: *mut ffi::evmc_host_context) -> ffi block_number: number, block_timestamp: timestamp, block_gas_limit: gas_limit, - block_difficulty: evmc_sys::evmc_bytes32 { bytes: difficulty }, + block_prev_randao: evmc_sys::evmc_bytes32 { bytes: prev_randao }, chain_id: evmc_sys::evmc_bytes32 { bytes: chain_id }, + block_base_fee: evmc_sys::evmc_bytes32 { bytes: base_fee }, }; } @@ -211,7 +214,7 @@ pub unsafe extern "C" fn call( let (output, gas_left, create_address, status_code) = (*(context as *mut ExtendedContext)).hctx.call( msg.kind, - &msg.destination.bytes, + &msg.recipient.bytes, &msg.sender.bytes, &msg.value.bytes, &std::slice::from_raw_parts(msg.input_data, msg.input_size), diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index dce83bb22..2a4fea76a 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -56,12 +56,13 @@ impl EvmcVm { is_static: bool, depth: i32, gas: i64, - destination: &Address, + recipient: &Address, sender: &Address, input: &Bytes, value: &Bytes32, code: &Bytes, create2_salt: &Bytes32, + code_address: &Address, ) -> (&Bytes, i64, StatusCode) { let ext_ctx = host::ExtendedContext { hctx: ctx }; let mut evmc_flags: u32 = 0; @@ -77,8 +78,8 @@ impl EvmcVm { flags: evmc_flags, depth: depth, gas: gas, - destination: ffi::evmc_address { - bytes: *destination, + recipient: ffi::evmc_address { + bytes: *recipient, }, sender: ffi::evmc_address { bytes: *sender }, input_data: input.as_ptr(), @@ -87,6 +88,7 @@ impl EvmcVm { create2_salt: ffi::evmc_bytes32 { bytes: *create2_salt, }, + code_address: ffi::evmc_address { bytes: *code_address }, } })); unsafe { From 04af1b1707b0e0554e2b19eb0202c03a38486a63 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:40:51 +0200 Subject: [PATCH 10/15] Remove evmc_create --- bindings/rust/evmc-client/src/lib.rs | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index 2a4fea76a..0d9fa6ad4 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -13,10 +13,6 @@ use crate::types::*; use evmc_sys as ffi; use std::ffi::CStr; -extern "C" { - fn evmc_create() -> *mut ffi::evmc_vm; -} - pub struct EvmcVm { handle: *mut ffi::evmc_vm, host_interface: *mut ffi::evmc_host_interface, @@ -130,12 +126,3 @@ pub fn load(fname: &str) -> (EvmcVm, Result) ec, ) } - -pub fn create() -> EvmcVm { - unsafe { - EvmcVm { - handle: evmc_create(), - host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), - } - } -} From 09a05fcfdfca29b98185e85be4303d4693f4f8bc Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:40:59 +0200 Subject: [PATCH 11/15] Run cargo fmt --- bindings/rust/evmc-client/src/host.rs | 27 ++++++++++++++++++++++++--- bindings/rust/evmc-client/src/lib.rs | 8 ++++---- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/bindings/rust/evmc-client/src/host.rs b/bindings/rust/evmc-client/src/host.rs index 6c30186da..678d46de8 100644 --- a/bindings/rust/evmc-client/src/host.rs +++ b/bindings/rust/evmc-client/src/host.rs @@ -27,7 +27,19 @@ pub trait HostContext { buffer_size: &usize, ) -> usize; fn selfdestruct(&mut self, addr: &Address, beneficiary: &Address); - fn get_tx_context(&mut self) -> (Bytes32, Address, Address, i64, i64, i64, Bytes32, Bytes32, Bytes32); + fn get_tx_context( + &mut self, + ) -> ( + Bytes32, + Address, + Address, + i64, + i64, + i64, + Bytes32, + Bytes32, + Bytes32, + ); fn get_block_hash(&mut self, number: i64) -> Bytes32; fn emit_log(&mut self, addr: &Address, topics: &Vec, data: &Bytes); fn call( @@ -154,8 +166,17 @@ unsafe extern "C" fn selfdestruct( } unsafe extern "C" fn get_tx_context(context: *mut ffi::evmc_host_context) -> ffi::evmc_tx_context { - let (gas_price, origin, coinbase, number, timestamp, gas_limit, prev_randao, chain_id, base_fee) = - (*(context as *mut ExtendedContext)).hctx.get_tx_context(); + let ( + gas_price, + origin, + coinbase, + number, + timestamp, + gas_limit, + prev_randao, + chain_id, + base_fee, + ) = (*(context as *mut ExtendedContext)).hctx.get_tx_context(); return ffi::evmc_tx_context { tx_gas_price: evmc_sys::evmc_bytes32 { bytes: gas_price }, tx_origin: evmc_sys::evmc_address { bytes: origin }, diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index 0d9fa6ad4..12ac29447 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -74,9 +74,7 @@ impl EvmcVm { flags: evmc_flags, depth: depth, gas: gas, - recipient: ffi::evmc_address { - bytes: *recipient, - }, + recipient: ffi::evmc_address { bytes: *recipient }, sender: ffi::evmc_address { bytes: *sender }, input_data: input.as_ptr(), input_size: input.len(), @@ -84,7 +82,9 @@ impl EvmcVm { create2_salt: ffi::evmc_bytes32 { bytes: *create2_salt, }, - code_address: ffi::evmc_address { bytes: *code_address }, + code_address: ffi::evmc_address { + bytes: *code_address, + }, } })); unsafe { From 6f3119d81fdd3c6f81a855795ac28a39c401718d Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:50:39 +0200 Subject: [PATCH 12/15] use evmc_loader --- bindings/rust/evmc-client/Cargo.toml | 1 + bindings/rust/evmc-client/src/lib.rs | 17 ++++++++--------- bindings/rust/evmc-loader/src/lib.rs | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index a4fe0b5fa..e3551c795 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -13,6 +13,7 @@ edition = "2018" build = "build.rs" [dependencies] +evmc-loader = { path = "../evmc-loader" } evmc-sys = { path = "../evmc-sys" } evmc-vm = { path = "../evmc-vm" } enum_primitive = "0.1.1" diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index 12ac29447..72e8065dc 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -10,6 +10,7 @@ mod loader; pub mod types; pub use crate::loader::{load_and_create, EvmcLoaderErrorCode}; use crate::types::*; +use evmc_loader; use evmc_sys as ffi; use std::ffi::CStr; @@ -116,13 +117,11 @@ impl EvmcVm { } } -pub fn load(fname: &str) -> (EvmcVm, Result) { - let (instance, ec) = load_and_create(fname); - ( - EvmcVm { - handle: instance, - host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), - }, - ec, - ) +pub fn load_and_configure( + config: &str, +) -> Result { + Ok(EvmcVm { + handle: evmc_loader::load_and_configure(config)? as *mut ffi::evmc_vm, + host_interface: Box::into_raw(Box::new(host::get_evmc_host_interface())), + }) } diff --git a/bindings/rust/evmc-loader/src/lib.rs b/bindings/rust/evmc-loader/src/lib.rs index 21b70066a..cd592f006 100644 --- a/bindings/rust/evmc-loader/src/lib.rs +++ b/bindings/rust/evmc-loader/src/lib.rs @@ -4,7 +4,7 @@ use std::ffi::{CStr, CString}; -mod sys; +pub mod sys; pub fn load_and_configure( config: &str, From a372ce3d6f1b4037b97d35cfc636e4ab27ae48e8 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:51:06 +0200 Subject: [PATCH 13/15] Drop builtin loader --- bindings/rust/evmc-client/Cargo.toml | 4 -- bindings/rust/evmc-client/build.rs | 61 --------------------- bindings/rust/evmc-client/src/lib.rs | 2 - bindings/rust/evmc-client/src/loader.rs | 70 ------------------------- 4 files changed, 137 deletions(-) delete mode 100644 bindings/rust/evmc-client/build.rs delete mode 100644 bindings/rust/evmc-client/src/loader.rs diff --git a/bindings/rust/evmc-client/Cargo.toml b/bindings/rust/evmc-client/Cargo.toml index e3551c795..cb40019c6 100644 --- a/bindings/rust/evmc-client/Cargo.toml +++ b/bindings/rust/evmc-client/Cargo.toml @@ -10,7 +10,6 @@ license = "Apache-2.0" repository = "https://github.com/ethereum/evmc" description = "Bindings to EVMC (Client/Host specific)" edition = "2018" -build = "build.rs" [dependencies] evmc-loader = { path = "../evmc-loader" } @@ -18,6 +17,3 @@ evmc-sys = { path = "../evmc-sys" } evmc-vm = { path = "../evmc-vm" } enum_primitive = "0.1.1" num = "0.3" - -[build-dependencies] -cmake = "0.1.44" diff --git a/bindings/rust/evmc-client/build.rs b/bindings/rust/evmc-client/build.rs deleted file mode 100644 index 02f7be8fb..000000000 --- a/bindings/rust/evmc-client/build.rs +++ /dev/null @@ -1,61 +0,0 @@ -// Copyright (C) 2020 Second State. -// This file is part of EVMC-Client. - -// EVMC-Client is free software: you can redistribute it and/or modify -// it under the terms of the GNU Affero General Public License as -// published by the Free Software Foundation, either version 3 of the -// License, or (at your option) any later version. - -// EVMC-Client 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 Affero General Public License for more details. - -// You should have received a copy of the GNU Affero General Public License -// along with this program. If not, see . - -use std::env; -use std::path::{Path, PathBuf}; -use std::process::Command; -extern crate cmake; -use cmake::Config; - -macro_rules! get(($name:expr) => (ok!(env::var($name)))); -macro_rules! ok(($expression:expr) => ($expression.unwrap())); - -const REPOSITORY: &'static str = "https://github.com/second-state/evmc.git"; -const TAG: &'static str = "v7.4.0-rust-evmc-client-rc.2"; - -fn run(name: &str, mut configure: F) -where - F: FnMut(&mut Command) -> &mut Command, -{ - let mut command = Command::new(name); - let configured = configure(&mut command); - if !ok!(configured.status()).success() { - panic!("failed to execute {:?}", configured); - } -} - -fn build_from_src() { - let source = PathBuf::from(&get!("CARGO_MANIFEST_DIR")).join(format!("target/evmc-{}", TAG)); - if !Path::new(&source.join(".git")).exists() { - run("git", |command| { - command - .arg("clone") - .arg(format!("--branch={}", TAG)) - .arg("--recursive") - .arg(REPOSITORY) - .arg(&source) - }); - } - - let dst = Config::new(source).build(); - let evmc_path = Path::new(&dst).join("build/lib/loader"); - println!("cargo:rustc-link-search=native={}", evmc_path.display()); - println!("cargo:rustc-link-lib=static=evmc-loader"); -} - -fn main() { - build_from_src(); -} diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index 72e8065dc..abd77c5ba 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -6,9 +6,7 @@ #[macro_use] extern crate enum_primitive; pub mod host; -mod loader; pub mod types; -pub use crate::loader::{load_and_create, EvmcLoaderErrorCode}; use crate::types::*; use evmc_loader; use evmc_sys as ffi; diff --git a/bindings/rust/evmc-client/src/loader.rs b/bindings/rust/evmc-client/src/loader.rs deleted file mode 100644 index 6d4879b5f..000000000 --- a/bindings/rust/evmc-client/src/loader.rs +++ /dev/null @@ -1,70 +0,0 @@ -/* EVMC: Ethereum Client-VM Connector API. - * Copyright 2019 The EVMC Authors. - * Licensed under the Apache License, Version 2.0. - */ - -use evmc_sys as ffi; -use std::ffi::{CStr, CString}; -use std::os::raw::c_char; -use std::str; -extern crate num; -use num::FromPrimitive; - -#[link(name = "evmc-loader")] -extern "C" { - fn evmc_load_and_create( - filename: *const c_char, - evmc_loader_error_code: *mut i32, - ) -> *mut ffi::evmc_vm; - fn evmc_last_error_msg() -> *const c_char; -} - -enum_from_primitive! { -#[derive(Debug)] -pub enum EvmcLoaderErrorCode { - /** The loader succeeded. */ - EvmcLoaderSucces = 0, - - /** The loader cannot open the given file name. */ - EvmcLoaderCannotOpen = 1, - - /** The VM create function not found. */ - EvmcLoaderSymbolNotFound = 2, - - /** The invalid argument value provided. */ - EvmcLoaderInvalidArgument = 3, - - /** The creation of a VM instance has failed. */ - EvmcLoaderInstanceCreationFailure = 4, - - /** The ABI version of the VM instance has mismatched. */ - EvmcLoaderAbiVersionMismatch = 5, - - /** The VM option is invalid. */ - EvmcLoaderInvalidOptionName = 6, - - /** The VM option value is invalid. */ - EvmcLoaderInvalidOptionValue = 7, -} -} - -fn error(err: EvmcLoaderErrorCode) -> Result { - match err { - EvmcLoaderErrorCode::EvmcLoaderSucces => Ok(EvmcLoaderErrorCode::EvmcLoaderSucces), - _ => unsafe { Err(CStr::from_ptr(evmc_last_error_msg()).to_str().unwrap()) }, - } -} - -pub fn load_and_create( - fname: &str, -) -> (*mut ffi::evmc_vm, Result) { - let c_str = CString::new(fname).unwrap(); - unsafe { - let mut error_code: i32 = 0; - let instance = evmc_load_and_create(c_str.as_ptr() as *const c_char, &mut error_code); - return ( - instance, - error(EvmcLoaderErrorCode::from_i32(error_code).unwrap()), - ); - } -} From 5c60abfbc6d818019dbb1755a8d047384dc660f4 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:54:05 +0200 Subject: [PATCH 14/15] implement drop instead of manual destroy --- bindings/rust/evmc-client/src/lib.rs | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/bindings/rust/evmc-client/src/lib.rs b/bindings/rust/evmc-client/src/lib.rs index abd77c5ba..3f7b471a7 100644 --- a/bindings/rust/evmc-client/src/lib.rs +++ b/bindings/rust/evmc-client/src/lib.rs @@ -17,6 +17,13 @@ pub struct EvmcVm { host_interface: *mut ffi::evmc_host_interface, } +impl Drop for EvmcVm { + fn drop(&mut self) { + debug_assert!(!self.handle.is_null()); + unsafe { ((*self.handle).destroy.unwrap())(self.handle) } + } +} + impl EvmcVm { pub fn get_abi_version(&self) -> i32 { unsafe { @@ -39,10 +46,6 @@ impl EvmcVm { } } - pub fn destroy(&self) { - unsafe { ((*self.handle).destroy.unwrap())(self.handle) } - } - pub fn execute( &self, ctx: &mut dyn host::HostContext, From 34a5f672ea37a6b337c9c9411b6ece663dc5b396 Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Sat, 21 May 2022 15:58:00 +0200 Subject: [PATCH 15/15] Drop const --- bindings/rust/evmc-client/src/types.rs | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/bindings/rust/evmc-client/src/types.rs b/bindings/rust/evmc-client/src/types.rs index 5489ba52b..15fcec4d9 100644 --- a/bindings/rust/evmc-client/src/types.rs +++ b/bindings/rust/evmc-client/src/types.rs @@ -5,8 +5,6 @@ pub use evmc_vm::{Capabilities, MessageKind, Revision, StatusCode, StorageStatus}; -pub const ADDRESS_LENGTH: usize = 20; -pub const BYTES32_LENGTH: usize = 32; -pub type Address = [u8; ADDRESS_LENGTH]; -pub type Bytes32 = [u8; BYTES32_LENGTH]; +pub type Address = [u8; 20]; +pub type Bytes32 = [u8; 32]; pub type Bytes = [u8];