dfinity-radix-tree (empty) → 0.0.0
raw patch · 14 files changed
+2526/−0 lines, 14 filesdep +BoundedChandep +aesondep +base
Dependencies added: BoundedChan, aeson, base, base16-bytestring, bloomfilter, bytestring, cmdargs, conduit, containers, cryptohash-sha256, data-default-class, deepseq, dfinity-radix-tree, ghc-prim, lens-simple, leveldb-haskell, lrucaching, resourcet, semigroups, serialise, text, unordered-containers
Files
- LICENSE +674/−0
- benchmark/Main.hs +60/−0
- benchmark/dfinity-radix-tree-benchmarks.svg too large to diff
- dfinity-radix-tree.cabal +93/−0
- src/Network/DFINITY/RadixTree.hs +709/−0
- src/Network/DFINITY/RadixTree/Bits.hs +36/−0
- src/Network/DFINITY/RadixTree/Bloom.hs +34/−0
- src/Network/DFINITY/RadixTree/Lenses.hs +105/−0
- src/Network/DFINITY/RadixTree/Memory.hs +76/−0
- src/Network/DFINITY/RadixTree/Serialise.hs +38/−0
- src/Network/DFINITY/RadixTree/Types.hs +160/−0
- src/Network/DFINITY/RadixTree/Utilities.hs +28/−0
- test/Main.hs +121/−0
- test/tests.json +392/−0
+ LICENSE view
@@ -0,0 +1,674 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ Everyone is permitted to copy and distribute verbatim copies+ of this license document, but changing it is not allowed.++ Preamble++ The GNU General Public License is a free, copyleft license for+software and other kinds of works.++ The licenses for most software and other practical works are designed+to take away your freedom to share and change the works. By contrast,+the GNU General Public License is intended to guarantee your freedom to+share and change all versions of a program--to make sure it remains free+software for all its users. We, the Free Software Foundation, use the+GNU General Public License for most of our software; it applies also to+any other work released this way by its authors. You can apply it to+your programs, too.++ When we speak of free software, we are referring to freedom, not+price. Our General Public Licenses are designed to make sure that you+have the freedom to distribute copies of free software (and charge for+them if you wish), that you receive source code or can get it if you+want it, that you can change the software or use pieces of it in new+free programs, and that you know you can do these things.++ To protect your rights, we need to prevent others from denying you+these rights or asking you to surrender the rights. Therefore, you have+certain responsibilities if you distribute copies of the software, or if+you modify it: responsibilities to respect the freedom of others.++ For example, if you distribute copies of such a program, whether+gratis or for a fee, you must pass on to the recipients the same+freedoms that you received. You must make sure that they, too, receive+or can get the source code. And you must show them these terms so they+know their rights.++ Developers that use the GNU GPL protect your rights with two steps:+(1) assert copyright on the software, and (2) offer you this License+giving you legal permission to copy, distribute and/or modify it.++ For the developers' and authors' protection, the GPL clearly explains+that there is no warranty for this free software. For both users' and+authors' sake, the GPL requires that modified versions be marked as+changed, so that their problems will not be attributed erroneously to+authors of previous versions.++ Some devices are designed to deny users access to install or run+modified versions of the software inside them, although the manufacturer+can do so. This is fundamentally incompatible with the aim of+protecting users' freedom to change the software. The systematic+pattern of such abuse occurs in the area of products for individuals to+use, which is precisely where it is most unacceptable. Therefore, we+have designed this version of the GPL to prohibit the practice for those+products. If such problems arise substantially in other domains, we+stand ready to extend this provision to those domains in future versions+of the GPL, as needed to protect the freedom of users.++ Finally, every program is threatened constantly by software patents.+States should not allow patents to restrict development and use of+software on general-purpose computers, but in those that do, we wish to+avoid the special danger that patents applied to a free program could+make it effectively proprietary. To prevent this, the GPL assures that+patents cannot be used to render the program non-free.++ The precise terms and conditions for copying, distribution and+modification follow.++ TERMS AND CONDITIONS++ 0. Definitions.++ "This License" refers to version 3 of the GNU General Public License.++ "Copyright" also means copyright-like laws that apply to other kinds of+works, such as semiconductor masks.++ "The Program" refers to any copyrightable work licensed under this+License. Each licensee is addressed as "you". "Licensees" and+"recipients" may be individuals or organizations.++ To "modify" a work means to copy from or adapt all or part of the work+in a fashion requiring copyright permission, other than the making of an+exact copy. The resulting work is called a "modified version" of the+earlier work or a work "based on" the earlier work.++ A "covered work" means either the unmodified Program or a work based+on the Program.++ To "propagate" a work means to do anything with it that, without+permission, would make you directly or secondarily liable for+infringement under applicable copyright law, except executing it on a+computer or modifying a private copy. Propagation includes copying,+distribution (with or without modification), making available to the+public, and in some countries other activities as well.++ To "convey" a work means any kind of propagation that enables other+parties to make or receive copies. Mere interaction with a user through+a computer network, with no transfer of a copy, is not conveying.++ An interactive user interface displays "Appropriate Legal Notices"+to the extent that it includes a convenient and prominently visible+feature that (1) displays an appropriate copyright notice, and (2)+tells the user that there is no warranty for the work (except to the+extent that warranties are provided), that licensees may convey the+work under this License, and how to view a copy of this License. If+the interface presents a list of user commands or options, such as a+menu, a prominent item in the list meets this criterion.++ 1. Source Code.++ The "source code" for a work means the preferred form of the work+for making modifications to it. "Object code" means any non-source+form of a work.++ A "Standard Interface" means an interface that either is an official+standard defined by a recognized standards body, or, in the case of+interfaces specified for a particular programming language, one that+is widely used among developers working in that language.++ The "System Libraries" of an executable work include anything, other+than the work as a whole, that (a) is included in the normal form of+packaging a Major Component, but which is not part of that Major+Component, and (b) serves only to enable use of the work with that+Major Component, or to implement a Standard Interface for which an+implementation is available to the public in source code form. A+"Major Component", in this context, means a major essential component+(kernel, window system, and so on) of the specific operating system+(if any) on which the executable work runs, or a compiler used to+produce the work, or an object code interpreter used to run it.++ The "Corresponding Source" for a work in object code form means all+the source code needed to generate, install, and (for an executable+work) run the object code and to modify the work, including scripts to+control those activities. However, it does not include the work's+System Libraries, or general-purpose tools or generally available free+programs which are used unmodified in performing those activities but+which are not part of the work. For example, Corresponding Source+includes interface definition files associated with source files for+the work, and the source code for shared libraries and dynamically+linked subprograms that the work is specifically designed to require,+such as by intimate data communication or control flow between those+subprograms and other parts of the work.++ The Corresponding Source need not include anything that users+can regenerate automatically from other parts of the Corresponding+Source.++ The Corresponding Source for a work in source code form is that+same work.++ 2. Basic Permissions.++ All rights granted under this License are granted for the term of+copyright on the Program, and are irrevocable provided the stated+conditions are met. This License explicitly affirms your unlimited+permission to run the unmodified Program. The output from running a+covered work is covered by this License only if the output, given its+content, constitutes a covered work. This License acknowledges your+rights of fair use or other equivalent, as provided by copyright law.++ You may make, run and propagate covered works that you do not+convey, without conditions so long as your license otherwise remains+in force. You may convey covered works to others for the sole purpose+of having them make modifications exclusively for you, or provide you+with facilities for running those works, provided that you comply with+the terms of this License in conveying all material for which you do+not control copyright. Those thus making or running the covered works+for you must do so exclusively on your behalf, under your direction+and control, on terms that prohibit them from making any copies of+your copyrighted material outside their relationship with you.++ Conveying under any other circumstances is permitted solely under+the conditions stated below. Sublicensing is not allowed; section 10+makes it unnecessary.++ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.++ No covered work shall be deemed part of an effective technological+measure under any applicable law fulfilling obligations under article+11 of the WIPO copyright treaty adopted on 20 December 1996, or+similar laws prohibiting or restricting circumvention of such+measures.++ When you convey a covered work, you waive any legal power to forbid+circumvention of technological measures to the extent such circumvention+is effected by exercising rights under this License with respect to+the covered work, and you disclaim any intention to limit operation or+modification of the work as a means of enforcing, against the work's+users, your or third parties' legal rights to forbid circumvention of+technological measures.++ 4. Conveying Verbatim Copies.++ You may convey verbatim copies of the Program's source code as you+receive it, in any medium, provided that you conspicuously and+appropriately publish on each copy an appropriate copyright notice;+keep intact all notices stating that this License and any+non-permissive terms added in accord with section 7 apply to the code;+keep intact all notices of the absence of any warranty; and give all+recipients a copy of this License along with the Program.++ You may charge any price or no price for each copy that you convey,+and you may offer support or warranty protection for a fee.++ 5. Conveying Modified Source Versions.++ You may convey a work based on the Program, or the modifications to+produce it from the Program, in the form of source code under the+terms of section 4, provided that you also meet all of these conditions:++ a) The work must carry prominent notices stating that you modified+ it, and giving a relevant date.++ b) The work must carry prominent notices stating that it is+ released under this License and any conditions added under section+ 7. This requirement modifies the requirement in section 4 to+ "keep intact all notices".++ c) You must license the entire work, as a whole, under this+ License to anyone who comes into possession of a copy. This+ License will therefore apply, along with any applicable section 7+ additional terms, to the whole of the work, and all its parts,+ regardless of how they are packaged. This License gives no+ permission to license the work in any other way, but it does not+ invalidate such permission if you have separately received it.++ d) If the work has interactive user interfaces, each must display+ Appropriate Legal Notices; however, if the Program has interactive+ interfaces that do not display Appropriate Legal Notices, your+ work need not make them do so.++ A compilation of a covered work with other separate and independent+works, which are not by their nature extensions of the covered work,+and which are not combined with it such as to form a larger program,+in or on a volume of a storage or distribution medium, is called an+"aggregate" if the compilation and its resulting copyright are not+used to limit the access or legal rights of the compilation's users+beyond what the individual works permit. Inclusion of a covered work+in an aggregate does not cause this License to apply to the other+parts of the aggregate.++ 6. Conveying Non-Source Forms.++ You may convey a covered work in object code form under the terms+of sections 4 and 5, provided that you also convey the+machine-readable Corresponding Source under the terms of this License,+in one of these ways:++ a) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by the+ Corresponding Source fixed on a durable physical medium+ customarily used for software interchange.++ b) Convey the object code in, or embodied in, a physical product+ (including a physical distribution medium), accompanied by a+ written offer, valid for at least three years and valid for as+ long as you offer spare parts or customer support for that product+ model, to give anyone who possesses the object code either (1) a+ copy of the Corresponding Source for all the software in the+ product that is covered by this License, on a durable physical+ medium customarily used for software interchange, for a price no+ more than your reasonable cost of physically performing this+ conveying of source, or (2) access to copy the+ Corresponding Source from a network server at no charge.++ c) Convey individual copies of the object code with a copy of the+ written offer to provide the Corresponding Source. This+ alternative is allowed only occasionally and noncommercially, and+ only if you received the object code with such an offer, in accord+ with subsection 6b.++ d) Convey the object code by offering access from a designated+ place (gratis or for a charge), and offer equivalent access to the+ Corresponding Source in the same way through the same place at no+ further charge. You need not require recipients to copy the+ Corresponding Source along with the object code. If the place to+ copy the object code is a network server, the Corresponding Source+ may be on a different server (operated by you or a third party)+ that supports equivalent copying facilities, provided you maintain+ clear directions next to the object code saying where to find the+ Corresponding Source. Regardless of what server hosts the+ Corresponding Source, you remain obligated to ensure that it is+ available for as long as needed to satisfy these requirements.++ e) Convey the object code using peer-to-peer transmission, provided+ you inform other peers where the object code and Corresponding+ Source of the work are being offered to the general public at no+ charge under subsection 6d.++ A separable portion of the object code, whose source code is excluded+from the Corresponding Source as a System Library, need not be+included in conveying the object code work.++ A "User Product" is either (1) a "consumer product", which means any+tangible personal property which is normally used for personal, family,+or household purposes, or (2) anything designed or sold for incorporation+into a dwelling. In determining whether a product is a consumer product,+doubtful cases shall be resolved in favor of coverage. For a particular+product received by a particular user, "normally used" refers to a+typical or common use of that class of product, regardless of the status+of the particular user or of the way in which the particular user+actually uses, or expects or is expected to use, the product. A product+is a consumer product regardless of whether the product has substantial+commercial, industrial or non-consumer uses, unless such uses represent+the only significant mode of use of the product.++ "Installation Information" for a User Product means any methods,+procedures, authorization keys, or other information required to install+and execute modified versions of a covered work in that User Product from+a modified version of its Corresponding Source. The information must+suffice to ensure that the continued functioning of the modified object+code is in no case prevented or interfered with solely because+modification has been made.++ If you convey an object code work under this section in, or with, or+specifically for use in, a User Product, and the conveying occurs as+part of a transaction in which the right of possession and use of the+User Product is transferred to the recipient in perpetuity or for a+fixed term (regardless of how the transaction is characterized), the+Corresponding Source conveyed under this section must be accompanied+by the Installation Information. But this requirement does not apply+if neither you nor any third party retains the ability to install+modified object code on the User Product (for example, the work has+been installed in ROM).++ The requirement to provide Installation Information does not include a+requirement to continue to provide support service, warranty, or updates+for a work that has been modified or installed by the recipient, or for+the User Product in which it has been modified or installed. Access to a+network may be denied when the modification itself materially and+adversely affects the operation of the network or violates the rules and+protocols for communication across the network.++ Corresponding Source conveyed, and Installation Information provided,+in accord with this section must be in a format that is publicly+documented (and with an implementation available to the public in+source code form), and must require no special password or key for+unpacking, reading or copying.++ 7. Additional Terms.++ "Additional permissions" are terms that supplement the terms of this+License by making exceptions from one or more of its conditions.+Additional permissions that are applicable to the entire Program shall+be treated as though they were included in this License, to the extent+that they are valid under applicable law. If additional permissions+apply only to part of the Program, that part may be used separately+under those permissions, but the entire Program remains governed by+this License without regard to the additional permissions.++ When you convey a copy of a covered work, you may at your option+remove any additional permissions from that copy, or from any part of+it. (Additional permissions may be written to require their own+removal in certain cases when you modify the work.) You may place+additional permissions on material, added by you to a covered work,+for which you have or can give appropriate copyright permission.++ Notwithstanding any other provision of this License, for material you+add to a covered work, you may (if authorized by the copyright holders of+that material) supplement the terms of this License with terms:++ a) Disclaiming warranty or limiting liability differently from the+ terms of sections 15 and 16 of this License; or++ b) Requiring preservation of specified reasonable legal notices or+ author attributions in that material or in the Appropriate Legal+ Notices displayed by works containing it; or++ c) Prohibiting misrepresentation of the origin of that material, or+ requiring that modified versions of such material be marked in+ reasonable ways as different from the original version; or++ d) Limiting the use for publicity purposes of names of licensors or+ authors of the material; or++ e) Declining to grant rights under trademark law for use of some+ trade names, trademarks, or service marks; or++ f) Requiring indemnification of licensors and authors of that+ material by anyone who conveys the material (or modified versions of+ it) with contractual assumptions of liability to the recipient, for+ any liability that these contractual assumptions directly impose on+ those licensors and authors.++ All other non-permissive additional terms are considered "further+restrictions" within the meaning of section 10. If the Program as you+received it, or any part of it, contains a notice stating that it is+governed by this License along with a term that is a further+restriction, you may remove that term. If a license document contains+a further restriction but permits relicensing or conveying under this+License, you may add to a covered work material governed by the terms+of that license document, provided that the further restriction does+not survive such relicensing or conveying.++ If you add terms to a covered work in accord with this section, you+must place, in the relevant source files, a statement of the+additional terms that apply to those files, or a notice indicating+where to find the applicable terms.++ Additional terms, permissive or non-permissive, may be stated in the+form of a separately written license, or stated as exceptions;+the above requirements apply either way.++ 8. Termination.++ You may not propagate or modify a covered work except as expressly+provided under this License. Any attempt otherwise to propagate or+modify it is void, and will automatically terminate your rights under+this License (including any patent licenses granted under the third+paragraph of section 11).++ However, if you cease all violation of this License, then your+license from a particular copyright holder is reinstated (a)+provisionally, unless and until the copyright holder explicitly and+finally terminates your license, and (b) permanently, if the copyright+holder fails to notify you of the violation by some reasonable means+prior to 60 days after the cessation.++ Moreover, your license from a particular copyright holder is+reinstated permanently if the copyright holder notifies you of the+violation by some reasonable means, this is the first time you have+received notice of violation of this License (for any work) from that+copyright holder, and you cure the violation prior to 30 days after+your receipt of the notice.++ Termination of your rights under this section does not terminate the+licenses of parties who have received copies or rights from you under+this License. If your rights have been terminated and not permanently+reinstated, you do not qualify to receive new licenses for the same+material under section 10.++ 9. Acceptance Not Required for Having Copies.++ You are not required to accept this License in order to receive or+run a copy of the Program. Ancillary propagation of a covered work+occurring solely as a consequence of using peer-to-peer transmission+to receive a copy likewise does not require acceptance. However,+nothing other than this License grants you permission to propagate or+modify any covered work. These actions infringe copyright if you do+not accept this License. Therefore, by modifying or propagating a+covered work, you indicate your acceptance of this License to do so.++ 10. Automatic Licensing of Downstream Recipients.++ Each time you convey a covered work, the recipient automatically+receives a license from the original licensors, to run, modify and+propagate that work, subject to this License. You are not responsible+for enforcing compliance by third parties with this License.++ An "entity transaction" is a transaction transferring control of an+organization, or substantially all assets of one, or subdividing an+organization, or merging organizations. If propagation of a covered+work results from an entity transaction, each party to that+transaction who receives a copy of the work also receives whatever+licenses to the work the party's predecessor in interest had or could+give under the previous paragraph, plus a right to possession of the+Corresponding Source of the work from the predecessor in interest, if+the predecessor has it or can get it with reasonable efforts.++ You may not impose any further restrictions on the exercise of the+rights granted or affirmed under this License. For example, you may+not impose a license fee, royalty, or other charge for exercise of+rights granted under this License, and you may not initiate litigation+(including a cross-claim or counterclaim in a lawsuit) alleging that+any patent claim is infringed by making, using, selling, offering for+sale, or importing the Program or any portion of it.++ 11. Patents.++ A "contributor" is a copyright holder who authorizes use under this+License of the Program or a work on which the Program is based. The+work thus licensed is called the contributor's "contributor version".++ A contributor's "essential patent claims" are all patent claims+owned or controlled by the contributor, whether already acquired or+hereafter acquired, that would be infringed by some manner, permitted+by this License, of making, using, or selling its contributor version,+but do not include claims that would be infringed only as a+consequence of further modification of the contributor version. For+purposes of this definition, "control" includes the right to grant+patent sublicenses in a manner consistent with the requirements of+this License.++ Each contributor grants you a non-exclusive, worldwide, royalty-free+patent license under the contributor's essential patent claims, to+make, use, sell, offer for sale, import and otherwise run, modify and+propagate the contents of its contributor version.++ In the following three paragraphs, a "patent license" is any express+agreement or commitment, however denominated, not to enforce a patent+(such as an express permission to practice a patent or covenant not to+sue for patent infringement). To "grant" such a patent license to a+party means to make such an agreement or commitment not to enforce a+patent against the party.++ If you convey a covered work, knowingly relying on a patent license,+and the Corresponding Source of the work is not available for anyone+to copy, free of charge and under the terms of this License, through a+publicly available network server or other readily accessible means,+then you must either (1) cause the Corresponding Source to be so+available, or (2) arrange to deprive yourself of the benefit of the+patent license for this particular work, or (3) arrange, in a manner+consistent with the requirements of this License, to extend the patent+license to downstream recipients. "Knowingly relying" means you have+actual knowledge that, but for the patent license, your conveying the+covered work in a country, or your recipient's use of the covered work+in a country, would infringe one or more identifiable patents in that+country that you have reason to believe are valid.++ If, pursuant to or in connection with a single transaction or+arrangement, you convey, or propagate by procuring conveyance of, a+covered work, and grant a patent license to some of the parties+receiving the covered work authorizing them to use, propagate, modify+or convey a specific copy of the covered work, then the patent license+you grant is automatically extended to all recipients of the covered+work and works based on it.++ A patent license is "discriminatory" if it does not include within+the scope of its coverage, prohibits the exercise of, or is+conditioned on the non-exercise of one or more of the rights that are+specifically granted under this License. You may not convey a covered+work if you are a party to an arrangement with a third party that is+in the business of distributing software, under which you make payment+to the third party based on the extent of your activity of conveying+the work, and under which the third party grants, to any of the+parties who would receive the covered work from you, a discriminatory+patent license (a) in connection with copies of the covered work+conveyed by you (or copies made from those copies), or (b) primarily+for and in connection with specific products or compilations that+contain the covered work, unless you entered into that arrangement,+or that patent license was granted, prior to 28 March 2007.++ Nothing in this License shall be construed as excluding or limiting+any implied license or other defenses to infringement that may+otherwise be available to you under applicable patent law.++ 12. No Surrender of Others' Freedom.++ If conditions are imposed on you (whether by court order, agreement or+otherwise) that contradict the conditions of this License, they do not+excuse you from the conditions of this License. If you cannot convey a+covered work so as to satisfy simultaneously your obligations under this+License and any other pertinent obligations, then as a consequence you may+not convey it at all. For example, if you agree to terms that obligate you+to collect a royalty for further conveying from those to whom you convey+the Program, the only way you could satisfy both those terms and this+License would be to refrain entirely from conveying the Program.++ 13. Use with the GNU Affero General Public License.++ Notwithstanding any other provision of this License, you have+permission to link or combine any covered work with a work licensed+under version 3 of the GNU Affero General Public License into a single+combined work, and to convey the resulting work. The terms of this+License will continue to apply to the part which is the covered work,+but the special requirements of the GNU Affero General Public License,+section 13, concerning interaction through a network will apply to the+combination as such.++ 14. Revised Versions of this License.++ The Free Software Foundation may publish revised and/or new versions of+the GNU General Public License from time to time. Such new versions will+be similar in spirit to the present version, but may differ in detail to+address new problems or concerns.++ Each version is given a distinguishing version number. If the+Program specifies that a certain numbered version of the GNU General+Public License "or any later version" applies to it, you have the+option of following the terms and conditions either of that numbered+version or of any later version published by the Free Software+Foundation. If the Program does not specify a version number of the+GNU General Public License, you may choose any version ever published+by the Free Software Foundation.++ If the Program specifies that a proxy can decide which future+versions of the GNU General Public License can be used, that proxy's+public statement of acceptance of a version permanently authorizes you+to choose that version for the Program.++ Later license versions may give you additional or different+permissions. However, no additional obligations are imposed on any+author or copyright holder as a result of your choosing to follow a+later version.++ 15. Disclaimer of Warranty.++ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.++ 16. Limitation of Liability.++ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF+SUCH DAMAGES.++ 17. Interpretation of Sections 15 and 16.++ If the disclaimer of warranty and limitation of liability provided+above cannot be given local legal effect according to their terms,+reviewing courts shall apply local law that most closely approximates+an absolute waiver of all civil liability in connection with the+Program, unless a warranty or assumption of liability accompanies a+copy of the Program in return for a fee.++ END OF TERMS AND CONDITIONS++ How to Apply These Terms to Your New Programs++ If you develop a new program, and you want it to be of the greatest+possible use to the public, the best way to achieve this is to make it+free software which everyone can redistribute and change under these terms.++ To do so, attach the following notices to the program. It is safest+to attach them to the start of each source file to most effectively+state the exclusion of warranty; and each file should have at least+the "copyright" line and a pointer to where the full notice is found.++ <one line to give the program's name and a brief idea of what it does.>+ Copyright (C) <year> <name of author>++ This program is free software: you can redistribute it and/or modify+ it under the terms of the GNU General Public License as published by+ the Free Software Foundation, either version 3 of the License, or+ (at your option) any later version.++ This program is distributed in the hope that it will be useful,+ but WITHOUT ANY WARRANTY; without even the implied warranty of+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ GNU General Public License for more details.++ You should have received a copy of the GNU General Public License+ along with this program. If not, see <http://www.gnu.org/licenses/>.++Also add information on how to contact you by electronic and paper mail.++ If the program does terminal interaction, make it output a short+notice like this when it starts in an interactive mode:++ <program> Copyright (C) <year> <name of author>+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.+ This is free software, and you are welcome to redistribute it+ under certain conditions; type `show c' for details.++The hypothetical commands `show w' and `show c' should show the appropriate+parts of the General Public License. Of course, your program's commands+might be different; for a GUI interface, you would use an "about box".++ You should also get your employer (if you work as a programmer) or school,+if any, to sign a "copyright disclaimer" for the program, if necessary.+For more information on this, and how to apply and follow the GNU GPL, see+<http://www.gnu.org/licenses/>.++ The GNU General Public License does not permit incorporating your program+into proprietary programs. If your program is a subroutine library, you+may consider it more useful to permit linking proprietary applications with+the library. If this is what you want to do, use the GNU Lesser General+Public License instead of this License. But first, please read+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+ benchmark/Main.hs view
@@ -0,0 +1,60 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE RecordWildCards #-}++{-# OPTIONS -Wall #-}++module Main where++import Control.Monad (foldM)+import Control.Monad.IO.Class (MonadIO(..))+import Control.Monad.Trans.Resource (runResourceT)+import Crypto.Hash.SHA256 (hash)+import Data.ByteString.Char8 (ByteString, pack)+import Data.Default.Class (Default(..))+import System.Console.CmdArgs (Data, cmdArgs)++import Network.DFINITY.RadixTree++data Args+ = Args+ { database :: FilePath+ } deriving Data++instance Default Args where+ def = Args "benchmark/benchmarkdb"++step+ :: MonadIO m+ => (RadixTree -> ByteString -> m RadixTree)+ -> RadixTree+ -> Int+ -> m RadixTree+step action tree i =+ if mod i 1000 == 0+ then merkleizeRadixTree tree >>= flip action key . snd+ else action tree key+ where key = hash $ pack $ show i++foldInsert+ :: MonadIO m+ => RadixTree+ -> [Int]+ -> m RadixTree+foldInsert = foldM $ step $ flip $ \ key -> insertRadixTree key key++foldDelete+ :: MonadIO m+ => RadixTree+ -> [Int]+ -> m RadixTree+foldDelete = foldM $ step $ flip deleteRadixTree++main :: IO ()+main = do+ Args {..} <- cmdArgs def+ runResourceT $ do+ tree <- createRadixTree 1048576 6144 database Nothing+ tree' <- foldInsert tree keys+ tree'' <- foldDelete tree' keys+ liftIO $ print $ isEmptyRadixTree tree''+ where keys = [1..1000000]
+ benchmark/dfinity-radix-tree-benchmarks.svg view
file too large to diff
+ dfinity-radix-tree.cabal view
@@ -0,0 +1,93 @@+name: dfinity-radix-tree+version: 0.0.0+synopsis: A Merkleized key–value data store.+description: This library provides a simple data integrity layer for LevelDB.+homepage: https://github.com/dfinity-lab/hs-radix-tree+license: GPL-3+license-file: LICENSE+author: Enzo Haussecker <enzo@dfinity.org>+maintainer: DFINITY USA Research <team@dfinity.org>+copyright: 2018 DFINITY Stiftung+category: Blockchain, DFINITY, Database+build-type: Simple+cabal-version: >=1.10++library+ build-depends:+ BoundedChan,+ base >=4.10 && <5,+ base16-bytestring,+ bloomfilter,+ bytestring,+ conduit,+ containers,+ cryptohash-sha256,+ data-default-class,+ deepseq,+ ghc-prim,+ lens-simple,+ leveldb-haskell,+ lrucaching,+ resourcet,+ semigroups,+ serialise+ default-language:+ Haskell2010+ exposed-modules:+ Network.DFINITY.RadixTree+ ghc-options:+ -O2+ -Wall+ -fno-warn-missing-signatures+ hs-source-dirs:+ src+ other-modules:+ Network.DFINITY.RadixTree.Bits+ Network.DFINITY.RadixTree.Bloom+ Network.DFINITY.RadixTree.Lenses+ Network.DFINITY.RadixTree.Memory+ Network.DFINITY.RadixTree.Serialise+ Network.DFINITY.RadixTree.Types+ Network.DFINITY.RadixTree.Utilities++executable dfinity-radix-tree-unit-tests+ build-depends:+ aeson,+ base >=4.10 && <5,+ base16-bytestring,+ bytestring,+ cmdargs,+ data-default-class,+ dfinity-radix-tree,+ resourcet,+ text,+ unordered-containers+ default-language:+ Haskell2010+ ghc-options:+ -O2+ -Wall+ hs-source-dirs:+ test+ main-is:+ Main.hs++executable dfinity-radix-tree-benchmarks+ build-depends:+ base >=4.10 && <5,+ bytestring,+ cmdargs,+ cryptohash-sha256,+ data-default-class,+ dfinity-radix-tree,+ resourcet+ default-language:+ Haskell2010+ ghc-options:+ -O2+ -Wall+ -rtsopts+ hs-source-dirs:+ benchmark+ main-is:+ Main.hs
+ src/Network/DFINITY/RadixTree.hs view
@@ -0,0 +1,709 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE RecordWildCards #-}++{-# OPTIONS -Wall #-}+{-# OPTIONS -fno-warn-incomplete-patterns #-}++-- |+-- Module : Network.DFINITY.RadixTree+-- Copyright : 2018 DFINITY Stiftung+-- License : GPL-3+-- Maintainer : Enzo Haussecker <enzo@dfinity.org>+-- Stability : Stable+--+-- A Merkleized key–value data store.+module Network.DFINITY.RadixTree (++ -- ** Types+ RadixRoot+ , RadixTree+ , RadixError(..)++ -- ** Create+ , createRadixTree+ , subtreeRadixTree++ -- ** Insert+ , insertRadixTree++ -- ** Delete+ , deleteRadixTree++ -- ** Merkleize+ , merkleizeRadixTree++ -- ** Query+ , lookupMerkleizedRadixTree+ , lookupNonMerkleizedRadixTree++ -- ** Test+ , isEmptyRadixTree+ , isValidRadixRoot++ -- ** Stream+ , sourceMerkleizedRadixTree++ -- ** Debug+ , printMerkleizedRadixTree+ , printNonMerkleizedRadixTree++ ) where++import Codec.Serialise (deserialise)+import Control.Concurrent (forkIO, killThread)+import Control.Concurrent.BoundedChan (BoundedChan, readChan)+import Control.Concurrent.MVar (modifyMVar_, newMVar, readMVar)+import Control.Exception (throw)+import Control.Monad (forM_, forever, when)+import Control.Monad.IO.Class (MonadIO(..))+import Control.Monad.Trans.Resource (MonadResource, ResourceT, allocate, release)+import Data.BloomFilter as Bloom (elem, insert, insertList)+import Data.Bool (bool)+import Data.ByteString.Char8 (ByteString)+import Data.ByteString.Lazy (fromStrict)+import Data.ByteString.Short (fromShort)+import Data.Conduit (Source, yield)+import Data.Default.Class (def)+import Data.List.NonEmpty (NonEmpty(..), fromList)+import Data.LruCache as LRU (empty, insert, lookup)+import Data.Map.Strict as Map (empty)+import Data.Maybe (fromJust, isJust, isNothing, listToMaybe)+import Data.Tuple (swap)+import Database.LevelDB (Options(..), defaultReadOptions, get, open)++import Network.DFINITY.RadixTree.Bits+import Network.DFINITY.RadixTree.Bloom+import Network.DFINITY.RadixTree.Lenses+import Network.DFINITY.RadixTree.Memory+import Network.DFINITY.RadixTree.Types+import Network.DFINITY.RadixTree.Utilities++-- |+-- Create a radix tree.+createRadixTree+ :: MonadResource m+ => Int -- ^ Bloom filter size in bits.+ -> Int -- ^ LRU cache size in items.+ -> FilePath -- ^ LevelDB database.+ -> Maybe RadixRoot -- ^ Last valid state root.+ -> m RadixTree+{-# SPECIALISE createRadixTree+ :: Int+ -> Int+ -> FilePath+ -> Maybe RadixRoot+ -> ResourceT IO RadixTree #-}+createRadixTree bloomSize cacheSize file checkpoint+ | bloomSize <= 0 = throw $ InvalidArgument "invalid Bloom filter size"+ | cacheSize <= 0 = throw $ InvalidArgument "invalid LRU cache size"+ | otherwise = do+ database <- open file $ def {createIfMissing = True}+ (root, cache') <-+ case checkpoint of+ Nothing -> storeCold def cache database+ Just root -> do+ result <- loadCold root cache database+ case snd <$> result of+ Nothing -> throw $ StateRootDoesNotExist root+ Just cache' -> pure (root, cache')+ pure $ RadixTree bloom bloomSize Map.empty cache' cacheSize root database root+ where+ bloom = emptyRadixBloom bloomSize+ cache = LRU.empty cacheSize++-- |+-- Create a radix subtree from a radix tree.+subtreeRadixTree+ :: MonadIO m+ => RadixRoot -- ^ State root.+ -> RadixTree -- ^ Radix tree.+ -> m RadixTree+{-# SPECIALISE subtreeRadixTree+ :: RadixRoot+ -> RadixTree+ -> ResourceT IO RadixTree #-}+subtreeRadixTree root RadixTree {..} = do+ result <- loadCold root cache _radixDatabase+ case result of+ Nothing -> throw $ StateRootDoesNotExist root+ _ -> pure $ RadixTree bloom _radixBloomSize Map.empty cache _radixCacheSize root _radixDatabase root+ where+ bloom = emptyRadixBloom _radixBloomSize+ cache = LRU.empty _radixCacheSize++-- |+-- Check if a radix tree is empty.+isEmptyRadixTree+ :: RadixTree -- ^ Radix tree.+ -> Bool+{-# INLINE isEmptyRadixTree #-}+isEmptyRadixTree = (==) defaultRoot . _radixRoot++-- |+-- Check if a state root is valid.+isValidRadixRoot+ :: MonadIO m+ => RadixRoot -- ^ State root.+ -> RadixTree -- ^ Radix tree.+ -> m Bool+{-# SPECIALISE isValidRadixRoot+ :: RadixRoot+ -> RadixTree+ -> ResourceT IO Bool #-}+isValidRadixRoot root RadixTree {..} =+ isJust <$> get _radixDatabase defaultReadOptions key+ where+ key = fromShort root++-- |+-- Search for a value in a radix tree.+searchRadixTree+ :: MonadIO m+ => Bool -- ^ Overwrite state root?+ -> (RadixTree -> m (Maybe (RadixBranch, RadixCache))) -- ^ Loading strategy.+ -> ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Either RadixError RadixSearchResult)+{-# SPECIALISE searchRadixTree+ :: Bool+ -> (RadixTree -> ResourceT IO (Maybe (RadixBranch, RadixCache)))+ -> ByteString+ -> RadixTree+ -> ResourceT IO (Either RadixError RadixSearchResult) #-}+searchRadixTree flag load = \ key tree@RadixTree {..} -> do+ let key' = toBits key+ let tree' = tree `bool` setRoot _radixCheckpoint tree $ flag+ loop Nothing [] [] [] key' tree' where+ loop implicit branches roots prefixes key tree@RadixTree {..} = do+ -- Load the root branch.+ result <- load tree+ case result of+ Nothing -> pure $ Left $ StateRootDoesNotExist _radixRoot+ Just (branch@RadixBranch {..}, cache') -> do+ -- Calculate the prefix and overflow.+ let bits = maybe id (:) implicit $ maybe [] toBits _radixPrefix+ let prefix = matchBits bits key+ let n = length prefix+ let overflow = drop n bits+ -- Update the accumulators.+ let roots' = _radixRoot:roots+ let branches' = branch:branches+ let prefixes' = prefix:prefixes+ let key' = drop n key+ -- Check the termination criteria.+ let residue = not $ null overflow+ let bit = head key'+ let child = bool _radixLeft _radixRight bit+ if null key' || residue || isNothing child+ then pure $ Right (fromList roots', fromList branches', fromList prefixes', overflow, key', cache')+ else do+ -- Recurse.+ let root' = fromJust child+ let tree' = setCache cache' $ setRoot root' tree+ let implicit' = Just bit+ loop implicit' branches' roots' prefixes' key' tree'++-- |+-- Search for a value in a Merkleized radix tree.+searchMerkleizedRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Either RadixError RadixSearchResult)+{-# SPECIALISE searchMerkleizedRadixTree+ :: ByteString+ -> RadixTree+ -> ResourceT IO (Either RadixError RadixSearchResult) #-}+searchMerkleizedRadixTree =+ searchRadixTree True $ \ RadixTree {..} ->+ loadCold _radixRoot _radixCache _radixDatabase++-- |+-- Search for a value in a non-Merkleized radix tree.+searchNonMerkleizedRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Either RadixError RadixSearchResult)+{-# SPECIALISE searchNonMerkleizedRadixTree+ :: ByteString+ -> RadixTree+ -> ResourceT IO (Either RadixError RadixSearchResult) #-}+searchNonMerkleizedRadixTree =+ searchRadixTree False $ \ RadixTree {..} ->+ loadHot _radixRoot _radixBuffer _radixCache _radixDatabase++-- |+-- Insert a key and value into a radix tree.+insertRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> m RadixTree+{-# SPECIALISE insertRadixTree+ :: ByteString+ -> ByteString+ -> RadixTree+ -> ResourceT IO RadixTree #-}+insertRadixTree key value tree =+ if isEmptyRadixTree tree+ then pure $ initializeRadixTree key value tree+ else searchNonMerkleizedRadixTree key tree >>= \ case+ Left err -> throw err+ Right result@(_, _, _, [], [], _) ->+ pure $ insertRadixTreeAt result value tree+ Right result@(_, _, _, [], _, _) ->+ pure $ insertRadixTreeAfter result value tree+ Right result@(_, _, _, _, [], _) ->+ pure $ insertRadixTreeBefore result value tree+ Right result ->+ pure $ insertRadixTreeBetween result value tree++-- TODO (enzo): Documentation.+initializeRadixTree+ :: ByteString -- ^ Key.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE initializeRadixTree #-}+initializeRadixTree key value tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setRoot root tree+ where+ prefix = createPrefix $ toBits key+ branch = setPrefix prefix $ Just value `setLeaf` def+ root = createRoot branch+ bloom = Bloom.insert root _radixBloom+ buffer = storeHot root branch _radixBuffer++-- TODO (enzo): Documentation.+insertRadixTreeAt+ :: RadixSearchResult -- ^ Search result.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE insertRadixTreeAt #-}+insertRadixTreeAt (_:|roots, branch:|branches, prefix:|_, _, _, cache) value tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ branch' = Just value `setLeaf` branch+ root' = createRoot branch'+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root':roots+ buffer = merkleSpoof root' parent $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root' $ isNothing parent++-- TODO (enzo): Documentation.+insertRadixTreeAfter+ :: RadixSearchResult -- ^ Search result.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE insertRadixTreeAfter #-}+insertRadixTreeAfter (_:|roots, branch:|branches, prefix:|_, _, keyOverflow, cache) value tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ prefix' = createPrefix $ drop 1 keyOverflow+ branch' = setPrefix prefix' $ Just value `setLeaf` def+ root' = createRoot branch'+ branch'' = test `setChild` Just root' $ branch+ root'' = createRoot branch''+ test = head keyOverflow+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root'':root':roots+ buffer = merkleSpoof root'' parent $ storeHot root'' branch'' $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root'' $ isNothing parent++-- TODO (enzo): Documentation.+insertRadixTreeBefore+ :: RadixSearchResult -- ^ Search result.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE insertRadixTreeBefore #-}+insertRadixTreeBefore (_:|roots, branch:|branches, prefix:|_, prefixOverflow, _, cache) value tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ prefix' = createPrefix $ drop 1 prefixOverflow+ branch' = setPrefix prefix' branch+ root' = createRoot branch'+ prefix'' = createPrefix $ drop 1 prefix `bool` prefix $ isNothing parent+ branch'' = setPrefix prefix'' $ test `setChild` Just root' $ Just value `setLeaf` def+ root'' = createRoot branch''+ test = head prefixOverflow+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root'':root':roots+ buffer = merkleSpoof root'' parent $ storeHot root'' branch'' $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root'' $ isNothing parent++-- TODO (enzo): Documentation.+insertRadixTreeBetween+ :: RadixSearchResult -- ^ Search result.+ -> ByteString -- ^ Value.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE insertRadixTreeBetween #-}+insertRadixTreeBetween (_:|roots, branch:|branches, prefix:|_, prefixOverflow, keyOverflow, cache) value tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ prefix' = createPrefix $ drop 1 keyOverflow+ branch' = setPrefix prefix' $ Just value `setLeaf` def+ root' = createRoot branch'+ prefix'' = createPrefix $ drop 1 prefixOverflow+ branch'' = setPrefix prefix'' branch+ root'' = createRoot branch''+ prefix''' = createPrefix $ drop 1 prefix `bool` prefix $ isNothing parent+ branch''' = setPrefix prefix''' $ setChildren children def+ root''' = createRoot branch'''+ test = head keyOverflow+ children = bool id swap test (Just root', Just root'')+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root''':root'':root':roots+ buffer = merkleSpoof root''' parent $ storeHot root''' branch''' $ storeHot root'' branch'' $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root''' $ isNothing parent++-- |+-- Delete a value from a radix tree.+deleteRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m RadixTree+{-# SPECIALISE deleteRadixTree+ :: ByteString+ -> RadixTree+ -> ResourceT IO RadixTree #-}+deleteRadixTree key tree@RadixTree {..} =+ if isEmptyRadixTree tree+ then pure tree+ else searchNonMerkleizedRadixTree key tree >>= \ case+ Left err -> throw err+ Right result@(_, branches, prefix:|_, [], [], cache) ->+ case branches of+ -- No children and no parent.+ RadixBranch _ Nothing Nothing _:|[] ->+ pure $ deleteRadixTreeNoChildrenNoParent result tree+ -- No children and parent with leaf.+ RadixBranch _ Nothing Nothing _:|parent:_ | isJust $ getLeaf parent ->+ pure $ deleteRadixTreeNoChildrenParentWithLeaf result tree+ -- No children and parent without leaf.+ RadixBranch _ Nothing Nothing _:|parent:_ -> do+ let test = not $ head prefix+ let root = fromJust $ getChild test parent+ loadHot root _radixBuffer cache _radixDatabase >>= \ case+ Nothing -> throw $ StateRootDoesNotExist root+ Just (branch, cache') ->+ pure $ deleteRadixTreeNoChildrenParentWithoutLeaf result branch cache' test tree+ -- One left child.+ RadixBranch _ child Nothing _:|_ | isJust child -> do+ let test = False+ let root = fromJust child+ loadHot root _radixBuffer cache _radixDatabase >>= \ case+ Nothing -> throw $ StateRootDoesNotExist root+ Just (branch, cache') ->+ pure $ deleteRadixTreeOneChild result branch cache' test tree+ -- One right child.+ RadixBranch _ Nothing child _:|_ | isJust child -> do+ let test = True+ let root = fromJust child+ loadHot root _radixBuffer cache _radixDatabase >>= \ case+ Nothing -> throw $ StateRootDoesNotExist root+ Just (branch, cache') ->+ pure $ deleteRadixTreeOneChild result branch cache' test tree+ -- Two children.+ _ -> pure $ deleteRadixTreeTwoChildren result tree+ Right _ -> pure tree++-- TODO (enzo): Documentation.+deleteRadixTreeNoChildrenNoParent+ :: RadixSearchResult -- ^ Search result.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE deleteRadixTreeNoChildrenNoParent #-}+deleteRadixTreeNoChildrenNoParent (_, _, _, _, _, cache) tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ bloom = Bloom.insert defaultRoot _radixBloom+ buffer = storeHot defaultRoot def _radixBuffer+ state = defaultRoot++-- TODO (enzo): Documentation.+deleteRadixTreeNoChildrenParentWithLeaf+ :: RadixSearchResult -- ^ Search result.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE deleteRadixTreeNoChildrenParentWithLeaf #-}+deleteRadixTreeNoChildrenParentWithLeaf (_:|_:roots, _:|branch:branches, prefix:|prefixes, _, _, cache) tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ branch' = setChild test Nothing branch+ root' = createRoot branch'+ test = head prefix+ parent = listToMaybe $ zip3 roots branches $ map head prefixes+ bloom = flip insertList _radixBloom $ root':roots+ buffer = merkleSpoof root' parent $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root' $ isNothing parent++-- TODO (enzo): Documentation.+deleteRadixTreeNoChildrenParentWithoutLeaf+ :: RadixSearchResult -- ^ Search result.+ -> RadixBranch -- ^ Branch.+ -> RadixCache -- ^ Cache.+ -> Bool -- ^ Lineage.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE deleteRadixTreeNoChildrenParentWithoutLeaf #-}+deleteRadixTreeNoChildrenParentWithoutLeaf (_:|_:roots, _:|_:branches, _:|prefixes, _, _, _) branch@RadixBranch {..} cache test tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ prefix' = createPrefix $ drop 1 bits `bool` bits $ isNothing parent+ branch' = setPrefix prefix' branch+ root' = createRoot branch'+ bits = head prefixes ++ test:maybe [] toBits _radixPrefix+ parent = listToMaybe $ zip3 roots branches $ map head prefixes+ bloom = flip insertList _radixBloom $ root':roots+ buffer = merkleSpoof root' parent $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root' $ isNothing parent++-- TODO (enzo): Documentation.+deleteRadixTreeOneChild+ :: RadixSearchResult -- ^ Search result.+ -> RadixBranch -- ^ Branch.+ -> RadixCache -- ^ Cache.+ -> Bool -- ^ Lineage.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE deleteRadixTreeOneChild #-}+deleteRadixTreeOneChild (_:|roots, _:|branches, prefix:|_, _, _, _) branch@RadixBranch {..} cache test tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ prefix' = createPrefix $ drop 1 bits `bool` bits $ isNothing parent+ branch' = setPrefix prefix' branch+ root' = createRoot branch'+ bits = prefix ++ test:maybe [] toBits _radixPrefix+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root':roots+ buffer = merkleSpoof root' parent $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root' $ isNothing parent++-- TODO (enzo): Documentation.+deleteRadixTreeTwoChildren+ :: RadixSearchResult -- ^ Search result.+ -> RadixTree -- ^ Radix tree.+ -> RadixTree+{-# INLINE deleteRadixTreeTwoChildren #-}+deleteRadixTreeTwoChildren (_:|roots, branch:|branches, prefix:|_, _, _, cache) tree@RadixTree {..} =+ seq bloom $ setBloom bloom $ setBuffer buffer $ setCache cache $ setRoot state tree+ where+ branch' = setLeaf Nothing branch+ root' = createRoot branch'+ parent = listToMaybe $ zip3 roots branches prefix+ bloom = flip insertList _radixBloom $ root':roots+ buffer = merkleSpoof root' parent $ storeHot root' branch' _radixBuffer+ state = bool _radixRoot root' $ isNothing parent++-- |+-- Lookup a value in a radix tree.+lookupRadixTree+ :: MonadIO m+ => (ByteString -> RadixTree -> m (Either RadixError RadixSearchResult)) -- ^ Search algorithm.+ -> ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Maybe (ByteString, RadixTree))+{-# SPECIALISE lookupRadixTree+ :: (ByteString -> RadixTree -> ResourceT IO (Either RadixError RadixSearchResult))+ -> ByteString+ -> RadixTree+ -> ResourceT IO (Maybe (ByteString, RadixTree)) #-}+lookupRadixTree search key tree = do+ found <- search key tree+ case found of+ Left err -> throw err+ Right (_, RadixBranch {..}:|_, _, prefixOverflow, keyOverflow, cache') ->+ if not $ null prefixOverflow && null keyOverflow+ then pure Nothing+ else pure $ do+ value <- _radixLeaf+ let tree' = setCache cache' tree+ pure (value, tree')++-- |+-- Lookup a value in a Merkleized radix tree.+lookupMerkleizedRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Maybe (ByteString, RadixTree))+{-# SPECIALISE lookupMerkleizedRadixTree+ :: ByteString+ -> RadixTree+ -> ResourceT IO (Maybe (ByteString, RadixTree)) #-}+lookupMerkleizedRadixTree = lookupRadixTree searchMerkleizedRadixTree++-- |+-- Lookup a value in a non-Merkleized radix tree.+lookupNonMerkleizedRadixTree+ :: MonadIO m+ => ByteString -- ^ Key.+ -> RadixTree -- ^ Radix tree.+ -> m (Maybe (ByteString, RadixTree))+{-# SPECIALISE lookupNonMerkleizedRadixTree+ :: ByteString+ -> RadixTree+ -> ResourceT IO (Maybe (ByteString, RadixTree)) #-}+lookupNonMerkleizedRadixTree = lookupRadixTree searchNonMerkleizedRadixTree++-- |+-- Mask a branch in a Merkleized radix tree.+merkleSpoof+ :: RadixRoot -- ^ State root.+ -> Maybe (RadixRoot, RadixBranch, Bool) -- ^ Parent.+ -> RadixBuffer -- ^ Buffer.+ -> RadixBuffer+{-# INLINE merkleSpoof #-}+merkleSpoof mask = \ case+ Nothing -> id+ Just (root, branch, test) ->+ storeHot root $ test `setChild` Just mask $ branch++-- |+-- Merkleize a radix tree. This will flush the buffer to disk.+merkleizeRadixTree+ :: MonadIO m+ => RadixTree -- ^ Radix tree.+ -> m (RadixRoot, RadixTree)+{-# SPECIALISE merkleizeRadixTree+ :: RadixTree+ -> ResourceT IO (RadixRoot, RadixTree) #-}+merkleizeRadixTree RadixTree {..} = do+ (root, cache) <- loop _radixRoot _radixCache+ let tree = RadixTree bloom _radixBloomSize Map.empty cache _radixCacheSize root _radixDatabase root+ pure (root, tree)+ where+ bloom = emptyRadixBloom _radixBloomSize+ loop root cache =+ if not $ Bloom.elem root _radixBloom+ then pure (root, cache)+ else do+ -- Load the root branch.+ result <- loadHot root _radixBuffer cache _radixDatabase+ case result of+ Nothing -> throw $ StateRootDoesNotExist root+ Just (branch@RadixBranch {..}, cache') ->+ case (_radixLeft, _radixRight) of+ -- No children.+ (Nothing, Nothing) ->+ storeCold branch cache' _radixDatabase+ -- One left child.+ (Just child, Nothing) -> do+ (root', cache'') <- loop child cache'+ let branch' = False `setChild` Just root' $ branch+ storeCold branch' cache'' _radixDatabase+ -- One right child.+ (Nothing, Just child) -> do+ (root', cache'') <- loop child cache'+ let branch' = True `setChild` Just root' $ branch+ storeCold branch' cache'' _radixDatabase+ -- Two children.+ (Just left, Just right) -> do+ (root', cache'') <- loop left cache'+ (root'', cache''') <- loop right cache''+ let branch' = setChildren (Just root', Just root'') branch+ storeCold branch' cache''' _radixDatabase++-- |+-- Create a conduit from a Merkleized radix tree.+sourceMerkleizedRadixTree+ :: MonadResource m+ => [Bool] -- ^ Bit patten.+ -> Int -- ^ LRU cache size in items.+ -> BoundedChan RadixRoot -- ^ Terminal state root producer.+ -> RadixTree -- ^ Radix tree.+ -> Source m ByteString+{-# SPECIALISE sourceMerkleizedRadixTree+ :: [Bool]+ -> Int+ -> BoundedChan RadixRoot+ -> RadixTree+ -> Source (ResourceT IO) ByteString #-}+sourceMerkleizedRadixTree patten cacheSize chan+ | cacheSize <= 0 = throw $ InvalidArgument "invalid LRU cache size"+ | otherwise = \ tree -> do+ cache <- liftIO $ newMVar $ LRU.empty cacheSize+ (,) action _ <- flip allocate killThread $ forkIO $ forever $ do+ root <- readChan chan+ modifyMVar_ cache $ pure . LRU.insert root ()+ loop cache tree []+ release action+ where+ loop cache tree@RadixTree {..} roots = do+ seen <- liftIO $ readMVar cache+ let roots' = _radixCheckpoint:roots+ if flip any roots' $ isJust . flip LRU.lookup seen+ then pure ()+ else do+ let key = fromShort _radixCheckpoint+ result <- get _radixDatabase defaultReadOptions key+ case result of+ Nothing -> pure ()+ Just bytes -> do+ let RadixBranch {..} = deserialise $ fromStrict bytes+ let success = all id $ zipWith (==) patten $ toBits $ fromShort _radixCheckpoint+ when success $ yield bytes+ forM_ [_radixLeft, _radixRight] $ \ case+ Nothing -> pure ()+ Just root -> loop cache `flip` roots' $ setCheckpoint root tree++-- |+-- Print a radix tree.+printRadixTree+ :: MonadIO m+ => Bool -- ^ Overwrite state root?+ -> (RadixTree -> m (Maybe (RadixBranch, RadixCache))) -- ^ Loading strategy.+ -> RadixTree -- ^ Radix tree.+ -> m ()+{-# SPECIALISE printRadixTree+ :: Bool+ -> (RadixTree -> ResourceT IO (Maybe (RadixBranch, RadixCache)))+ -> RadixTree+ -> ResourceT IO () #-}+printRadixTree flag load = \ tree@RadixTree {..} -> do+ let tree' = tree `bool` setRoot _radixCheckpoint tree $ flag+ loop tree' 0 where+ loop tree@RadixTree {..} i = do+ result <- load tree+ case fst <$> result of+ Nothing -> throw $ StateRootDoesNotExist _radixRoot+ Just branch@RadixBranch {..} -> do+ let indent = (++) $ concat $ replicate i "｜"+ liftIO $ putStrLn $ indent $ show branch+ let j = i + 1+ forM_ [_radixLeft, _radixRight] $ \ case+ Nothing -> pure ()+ Just root -> setRoot root tree `loop` j++-- |+-- Print a Merkleized radix tree.+printMerkleizedRadixTree+ :: MonadIO m+ => RadixTree -- ^ Radix tree.+ -> m ()+{-# SPECIALISE printMerkleizedRadixTree+ :: RadixTree+ -> ResourceT IO () #-}+printMerkleizedRadixTree =+ printRadixTree True $ \ RadixTree {..} ->+ loadCold _radixRoot _radixCache _radixDatabase++-- |+-- Print a non-Merkleized radix tree.+printNonMerkleizedRadixTree+ :: MonadIO m+ => RadixTree -- ^ Radix tree.+ -> m ()+{-# SPECIALISE printNonMerkleizedRadixTree+ :: RadixTree+ -> ResourceT IO () #-}+printNonMerkleizedRadixTree =+ printRadixTree False $ \ RadixTree {..} ->+ loadHot _radixRoot _radixBuffer _radixCache _radixDatabase
+ src/Network/DFINITY/RadixTree/Bits.hs view
@@ -0,0 +1,36 @@+{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Bits+ ( Bitable(..)+ , matchBits+ ) where++import Data.Bits ((.|.), setBit, testBit)+import Data.Bool (bool)+import Data.ByteString (ByteString, pack, unpack)+import Data.Word (Word8)++class Bitable a where+ fromBits :: [Bool] -> a+ toBits :: a -> [Bool]++instance Bitable ByteString where+ fromBits = pack . go where+ go [] = []+ go xs = let (a, b) = splitAt 8 xs in toByte a : go b+ toBits = concatMap fromByte . unpack++matchBits :: [Bool] -> [Bool] -> [Bool]+matchBits x = map fst . zipWhile (==) x++zipWhile :: (a -> b -> Bool) -> [a] -> [b] -> [(a,b)]+zipWhile f x = takeWhile (uncurry f) . zip x++fromByte :: Word8 -> [Bool]+fromByte = flip map order . testBit++toByte :: [Bool] -> Word8+toByte = foldl (.|.) 0 . zipWith (bool 0 . setBit 0) order++order :: Enum a => Num a => [a]+order = [7, 6.. 0]
+ src/Network/DFINITY/RadixTree/Bloom.hs view
@@ -0,0 +1,34 @@+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE MagicHash #-}++{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Bloom+ ( emptyRadixBloom+ ) where++import Data.BloomFilter (empty)+import Data.ByteString.Short.Internal (ShortByteString(..))+import Data.Word (Word32)+import GHC.Prim (ByteArray#, Int#, (-#), indexWord32Array#, quotInt#, sizeofByteArray#)+import GHC.Word (Word32(..))++import Network.DFINITY.RadixTree.Types++emptyRadixBloom :: Int -> RadixBloom+emptyRadixBloom = empty hash ++hash :: RadixRoot -> [Word32]+hash = \ case+ SBS bytes# ->+ let n# = sizeofByteArray# bytes#+ m# = quotInt# n# 4#+ in hash# bytes# m#++hash# :: ByteArray# -> Int# -> [Word32]+hash# bytes# = \ case+ 0# -> []+ i# ->+ let j# = i# -# 1#+ w# = indexWord32Array# bytes# j#+ in W32# w# : hash# bytes# j#
+ src/Network/DFINITY/RadixTree/Lenses.hs view
@@ -0,0 +1,105 @@+{-# LANGUAGE TemplateHaskell #-}++{-# OPTIONS -Wall #-}+{-# OPTIONS -fno-warn-missing-signatures #-}+{-# OPTIONS -fno-warn-unused-top-binds #-}++module Network.DFINITY.RadixTree.Lenses+ ( getPrefix+ , getLeft+ , getRight+ , getChild+ , getChildren+ , getLeaf+ , getBloom+ , getBuffer+ , getCache+ , getCheckpoint+ , getRoot+ , setPrefix+ , setLeft+ , setRight+ , setChild+ , setChildren+ , setLeaf+ , setBloom+ , setBuffer+ , setCache+ , setCheckpoint+ , setRoot+ ) where++import Data.Bool (bool)+import Data.ByteString (ByteString)+import Lens.Simple (makeLenses, set, view)++import Network.DFINITY.RadixTree.Types++makeLenses ''RadixBranch+makeLenses ''RadixTree++getPrefix :: RadixBranch -> Maybe RadixPrefix+getPrefix = view radixPrefix++getLeft :: RadixBranch -> Maybe RadixRoot+getLeft = view radixLeft++getRight :: RadixBranch -> Maybe RadixRoot+getRight = view radixRight++getChild :: Bool -> RadixBranch -> Maybe RadixRoot+getChild = bool getLeft getRight++getChildren :: RadixBranch -> (Maybe RadixRoot, Maybe RadixRoot)+getChildren branch = (getLeft branch, getRight branch)++getLeaf :: RadixBranch -> Maybe ByteString+getLeaf = view radixLeaf++getBloom :: RadixTree -> RadixBloom+getBloom = view radixBloom++getBuffer :: RadixTree -> RadixBuffer+getBuffer = view radixBuffer++getCache :: RadixTree -> RadixCache+getCache = view radixCache++getCheckpoint :: RadixTree -> RadixRoot+getCheckpoint = view radixCheckpoint++getRoot :: RadixTree -> RadixRoot+getRoot = view radixRoot++setPrefix :: Maybe RadixPrefix -> RadixBranch -> RadixBranch+setPrefix = set radixPrefix++setLeft :: Maybe RadixRoot -> RadixBranch -> RadixBranch+setLeft = set radixLeft++setRight :: Maybe RadixRoot -> RadixBranch -> RadixBranch+setRight = set radixRight++setChild :: Bool -> Maybe RadixRoot -> RadixBranch -> RadixBranch+setChild = bool setLeft setRight++setChildren :: (Maybe RadixRoot, Maybe RadixRoot) -> RadixBranch -> RadixBranch+setChildren (left, right) = setLeft left . setRight right++setLeaf :: Maybe ByteString -> RadixBranch -> RadixBranch+setLeaf = set radixLeaf++setBloom :: RadixBloom -> RadixTree -> RadixTree+setBloom = set radixBloom++setBuffer :: RadixBuffer -> RadixTree -> RadixTree+setBuffer = set radixBuffer++setCache :: RadixCache -> RadixTree -> RadixTree+setCache = set radixCache++setCheckpoint :: RadixRoot -> RadixTree -> RadixTree+setCheckpoint = set radixCheckpoint++setRoot :: RadixRoot -> RadixTree -> RadixTree+setRoot = set radixRoot
+ src/Network/DFINITY/RadixTree/Memory.hs view
@@ -0,0 +1,76 @@+{-# LANGUAGE RecordWildCards #-}++{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Memory+ ( loadHot+ , loadCold+ , storeHot+ , storeCold+ ) where++import Codec.Serialise (deserialise, serialise)+import Control.Monad.IO.Class (MonadIO)+import Crypto.Hash.SHA256 (hash)+import Data.ByteString.Char8 as Byte (take)+import Data.ByteString.Lazy (fromStrict, toStrict)+import Data.ByteString.Short (fromShort, toShort)+import Data.LruCache as LRU (insert, lookup)+import Data.Map.Strict as Map (insert, lookup)+import Database.LevelDB (defaultReadOptions, defaultWriteOptions, get, put)++import Network.DFINITY.RadixTree.Types++loadHot+ :: MonadIO m+ => RadixRoot -- ^ State root.+ -> RadixBuffer -- ^ Buffer.+ -> RadixCache -- ^ Cache.+ -> RadixDatabase -- ^ Database.+ -> m (Maybe (RadixBranch, RadixCache))+loadHot root buffer cache database =+ case Map.lookup root buffer of+ Just branch -> pure $ Just (branch, cache)+ Nothing -> loadCold root cache database++loadCold+ :: MonadIO m+ => RadixRoot -- ^ State root.+ -> RadixCache -- ^ Cache.+ -> RadixDatabase -- ^ Database.+ -> m (Maybe (RadixBranch, RadixCache))+loadCold root cache database =+ case LRU.lookup root cache of+ Just (branch, cache') ->+ seq cache' $ seq branch $ pure $ Just (branch, cache')+ Nothing -> do+ let key = fromShort root+ result <- get database defaultReadOptions key+ case result of+ Just bytes -> do+ let branch = deserialise $ fromStrict bytes+ let cache' = LRU.insert root branch cache+ seq cache' $ seq branch $ pure $ Just (branch, cache')+ Nothing -> pure $ Nothing++storeHot+ :: RadixRoot -- ^ State root.+ -> RadixBranch -- ^ Branch.+ -> RadixBuffer -- ^ Buffer.+ -> RadixBuffer+storeHot = Map.insert++storeCold+ :: MonadIO m+ => RadixBranch -- ^ Branch.+ -> RadixCache -- ^ Cache.+ -> RadixDatabase -- ^ Database.+ -> m (RadixRoot, RadixCache)+storeCold branch cache database = do+ put database defaultWriteOptions key bytes+ seq cache' $ pure (root, cache')+ where+ bytes = toStrict $ serialise branch+ key = Byte.take 20 $ hash bytes+ root = toShort key+ cache' = LRU.insert root branch cache
+ src/Network/DFINITY/RadixTree/Serialise.hs view
@@ -0,0 +1,38 @@+{-# LANGUAGE LambdaCase #-}++{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Serialise+ ( decodeLeaf+ , decodeMaybe+ , decodeSide+ , encodeMaybe+ , encodeSide+ ) where++import Codec.Serialise (Serialise)+import Codec.Serialise.Decoding (Decoder, TokenType(..), decodeBytes, decodeNull, decodeTag, peekTokenType)+import Codec.Serialise.Encoding (Encoding, encodeBytes, encodeNull, encodeTag)+import Control.Monad (void)+import Data.ByteString.Char8 (ByteString)+import Data.Monoid ((<>))++decodeLeaf :: Int -> Decoder s (Maybe ByteString)+decodeLeaf = \ case+ 3 -> pure Nothing+ 4 -> pure <$> decodeBytes+ _ -> fail "decodeLeaf: invalid argument"++decodeMaybe :: Serialise a => Decoder s a -> Decoder s (Maybe a)+decodeMaybe value = peekTokenType >>= \ case+ TypeNull -> decodeNull >> pure Nothing+ _ -> pure <$> value++decodeSide :: Decoder s ByteString+decodeSide = void decodeTag >> decodeBytes++encodeMaybe :: Serialise a => (a -> Encoding) -> Maybe a -> Encoding+encodeMaybe = maybe encodeNull++encodeSide :: ByteString -> Encoding+encodeSide side = encodeTag 42 <> encodeBytes side
+ src/Network/DFINITY/RadixTree/Types.hs view
@@ -0,0 +1,160 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE RecordWildCards #-}++{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Types+ ( RadixBloom+ , RadixBranch(..)+ , RadixBuffer+ , RadixCache+ , RadixDatabase+ , RadixError(..)+ , RadixPrefix(..)+ , RadixRoot+ , RadixSearchResult+ , RadixTree(..)+ ) where++import Codec.Serialise as CBOR (Serialise(..), serialise)+import Codec.Serialise.Decoding (decodeBytes, decodeInt, decodeListLen)+import Codec.Serialise.Encoding (encodeBytes, encodeInt, encodeListLen)+import Crypto.Hash.SHA256 (hash)+import Control.DeepSeq (NFData(..))+import Control.Exception (Exception)+import Control.Monad (void)+import Data.BloomFilter (Bloom)+import Data.Bool (bool)+import Data.ByteString.Base16 as Base16 (encode)+import Data.ByteString.Char8 (ByteString, unpack)+import Data.ByteString.Lazy (toStrict)+import Data.ByteString.Short (ShortByteString, fromShort, toShort)+import Data.Data (Data)+import Data.Default.Class (Default(..))+import Data.List.NonEmpty (NonEmpty)+import Data.LruCache (LruCache)+import Data.Map.Strict (Map)+import Data.Maybe (isJust)+import Data.Monoid ((<>))+import Database.LevelDB (DB)+import Text.Printf (printf)++import Network.DFINITY.RadixTree.Bits+import Network.DFINITY.RadixTree.Serialise++type RadixBloom = Bloom RadixRoot++data RadixBranch+ = RadixBranch+ { _radixPrefix :: Maybe RadixPrefix+ , _radixLeft :: Maybe RadixRoot+ , _radixRight :: Maybe RadixRoot+ , _radixLeaf :: Maybe ByteString+ } deriving (Data, Eq)++instance NFData RadixBranch where+ rnf RadixBranch {..} =+ rnf _radixPrefix `seq`+ rnf _radixLeft `seq`+ rnf _radixRight `seq`+ rnf _radixLeaf `seq`+ ()++instance Default RadixBranch where+ def = RadixBranch Nothing Nothing Nothing Nothing++instance Serialise RadixBranch where+ encode RadixBranch {..} =+ encodeListLen len <>+ encodeMaybe CBOR.encode _radixPrefix <>+ encodeMaybe encodeSide left <>+ encodeMaybe encodeSide right <>+ maybe mempty encodeBytes _radixLeaf+ where+ len = bool 3 4 $ isJust _radixLeaf+ left = fromShort <$> _radixLeft+ right = fromShort <$> _radixRight+ decode = do+ len <- decodeListLen+ prefix <- decodeMaybe decode+ left <- decodeMaybe $ toShort <$> decodeSide+ right <- decodeMaybe $ toShort <$> decodeSide+ leaf <- decodeLeaf len+ pure $ RadixBranch prefix left right leaf++instance Show RadixBranch where+ show branch@RadixBranch {..} =+ case color 7 . unpack <$> _radixLeaf of+ Nothing -> printf "%s@[%s,%s,%s]" root prefix left right+ Just leaf -> printf "%s@[%s,%s,%s,%s]" root prefix left right leaf+ where+ color :: Int -> String -> String+ color = printf "\ESC[9%dm%s\ESC[0m"+ format = take 8 . unpack . Base16.encode+ root = color 4 $ format $ hash $ toStrict $ serialise branch+ prefix = color 7 $ maybe "null" show _radixPrefix+ left = color 4 $ maybe "null" format $ fromShort <$> _radixLeft+ right = color 4 $ maybe "null" format $ fromShort <$> _radixRight++type RadixBuffer = Map RadixRoot RadixBranch++type RadixCache = LruCache RadixRoot RadixBranch++type RadixDatabase = DB++data RadixError+ = InvalidArgument String+ | StateRootDoesNotExist RadixRoot+ deriving (Data, Eq, Show)++instance Exception RadixError++data RadixPrefix+ = RadixPrefix+ { _radixBitLen :: Int+ , _radixName :: ByteString+ } deriving (Data, Eq)++instance Bitable RadixPrefix where+ toBits RadixPrefix {..} = take _radixBitLen $ toBits _radixName+ fromBits bits = RadixPrefix bitLen name+ where+ bitLen = length bits+ name = fromBits bits++instance NFData RadixPrefix where+ rnf RadixPrefix {..} =+ rnf _radixBitLen `seq`+ rnf _radixName `seq`+ ()++instance Serialise RadixPrefix where+ encode RadixPrefix {..} =+ encodeListLen 2 <>+ encodeInt _radixBitLen <>+ encodeBytes _radixName+ decode = do+ void decodeListLen+ bitLen <- decodeInt+ name <- decodeBytes+ pure $ RadixPrefix bitLen name++instance Show RadixPrefix where+ show = map compress . toBits+ where compress = bool '0' '1'++type RadixRoot = ShortByteString++type RadixSearchResult = (NonEmpty RadixRoot, NonEmpty RadixBranch, NonEmpty [Bool], [Bool], [Bool], RadixCache)++data RadixTree+ = RadixTree+ { _radixBloom :: RadixBloom+ , _radixBloomSize :: Int+ , _radixBuffer :: RadixBuffer+ , _radixCache :: RadixCache+ , _radixCacheSize :: Int+ , _radixCheckpoint :: RadixRoot+ , _radixDatabase :: RadixDatabase+ , _radixRoot :: RadixRoot+ }
+ src/Network/DFINITY/RadixTree/Utilities.hs view
@@ -0,0 +1,28 @@+{-# OPTIONS -Wall #-}++module Network.DFINITY.RadixTree.Utilities+ ( createPrefix+ , createRoot+ , defaultRoot+ ) where++import Codec.Serialise (serialise)+import Crypto.Hash.SHA256 (hashlazy)+import Data.ByteString.Char8 as Byte (take)+import Data.ByteString.Short (toShort)+import Data.Default.Class (def)++import Network.DFINITY.RadixTree.Bits+import Network.DFINITY.RadixTree.Types++createPrefix :: [Bool] -> Maybe RadixPrefix+createPrefix bits =+ if null bits+ then Nothing+ else Just $ fromBits bits++createRoot :: RadixBranch -> RadixRoot+createRoot = toShort . Byte.take 20 . hashlazy . serialise++defaultRoot :: RadixRoot+defaultRoot = createRoot def
+ test/Main.hs view
@@ -0,0 +1,121 @@+{-# LANGUAGE DeriveDataTypeable #-}+{-# LANGUAGE LambdaCase #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE RecordWildCards #-}+{-# LANGUAGE ViewPatterns #-}++{-# OPTIONS -Wall #-}++module Main where++import Control.Monad (foldM_, mzero)+import Control.Monad.IO.Class (MonadIO(..))+import Control.Monad.Trans.Resource (runResourceT)+import Data.Aeson (FromJSON(..), Object, Value(..), eitherDecode)+import Data.ByteString.Base16 (decode, encode)+import Data.ByteString.Char8 (ByteString, unpack)+import Data.ByteString.Lazy.Char8 as Lazy (readFile)+import Data.ByteString.Short (fromShort)+import Data.Default.Class (Default(..))+import Data.HashMap.Strict as Map (elems, lookup)+import Data.Text as Text (Text, drop)+import Data.Text.Encoding (encodeUtf8)+import System.Console.CmdArgs (Data, cmdArgs)++import Network.DFINITY.RadixTree++data Args+ = Args+ { database :: FilePath+ , file :: FilePath+ , test :: String+ } deriving Data++instance Default Args where+ def = Args "test/testdb" "test/tests.json" "*"++data Op+ = Insert ByteString ByteString+ | Delete ByteString+ | Lookup ByteString ByteString+ | Merkleize ByteString++instance FromJSON Op where+ parseJSON = \ case+ Object object -> maybe mzero pure $ parse object+ _ -> mzero++instance Show Op where+ show = \ case+ Insert key value -> "Insert" ++ pretty key ++ pretty value+ Delete key -> "Delete" ++ pretty key+ Lookup key value -> "Lookup" ++ pretty key ++ pretty value+ Merkleize value -> "Merkleize" ++ pretty value+ where pretty = mappend " 0x" . unpack . encode++parse :: Object -> Maybe Op+parse object = do+ op <- Map.lookup "op" object+ case op of+ "set" -> Insert <$> get "key" object <*> get "value" object+ "delete" -> Delete <$> get "key" object+ "get" -> Lookup <$> get "key" object <*> get "value" object+ "stateRoot" -> Merkleize <$> get "value" object+ _ -> Nothing++get :: Text -> Object -> Maybe ByteString+get key object = do+ value <- Map.lookup key object+ case value of+ String text -> Just $ fst $ decode $ encodeUtf8 $ Text.drop 2 text+ _ -> Nothing++step :: MonadIO m => RadixTree -> Op -> m RadixTree+step tree op = do+ liftIO $ print op+ case op of+ Insert key value -> do+ tree' <- insertRadixTree key value tree+ printNonMerkleizedRadixTree tree'+ pure tree'+ Delete key -> do+ tree' <- deleteRadixTree key tree+ printNonMerkleizedRadixTree tree'+ pure tree'+ Lookup key value -> do+ result <- lookupNonMerkleizedRadixTree key tree+ case result of+ Just (value', tree') | value == value' -> pure tree'+ Just (value', _) -> throw+ [ "Expecting value "+ , ", but received value "+ , " for key "+ ] [value, value', key]+ Nothing -> throw+ [ "Expecting value "+ , ", but received no value for key "+ ] [value, key]+ Merkleize value -> do+ (fromShort -> value', tree') <- merkleizeRadixTree tree+ if value == value'+ then pure tree'+ else throw+ [ "Expecting state root "+ , ", but received state root "+ ] [value, value']+ where+ throw err = fail . concat . zipWith mappend err . map show++main :: IO ()+main = do+ Args {..} <- cmdArgs def+ contents <- Lazy.readFile file+ case eitherDecode contents of+ Left err -> fail err+ Right vctors -> runResourceT $ do+ tree <- createRadixTree 100 100 database Nothing+ if test == "*"+ then foldM_ step tree `mapM_` elems vctors+ else case Map.lookup test vctors of+ Nothing -> fail $ "unknown test vector: " ++ test+ Just ops -> foldM_ step tree $ concat [ops]
+ test/tests.json view
@@ -0,0 +1,392 @@+{+ "empty": [+ {+ "op": "stateRoot",+ "value": "0x4cf812be9be2c6008325050f43d06676a08612c7"+ }+ ],+ "setAndGet": [+ {+ "op": "set",+ "key": "0x74657374",+ "value": "0x636174"+ },+ {+ "op": "stateRoot",+ "value": "0x01cff22f1e93e25d8691d6238031d98885ab468f"+ },+ {+ "op": "get",+ "key": "0x74657374",+ "value": "0x636174"+ },+ {+ "op": "set",+ "key": "0x7465",+ "value": "0x626c6f70"+ },+ {+ "op": "get",+ "key": "0x74657374",+ "value": "0x636174"+ },+ {+ "op": "get",+ "key": "0x7465",+ "value": "0x626c6f70"+ },+ {+ "op": "set",+ "key": "0x726164",+ "value": "0x63617432"+ },+ {+ "op": "stateRoot",+ "value": "0x05213318991804dad6a926aacfd4ac3481161371"+ },+ {+ "op": "get",+ "key": "0x726164",+ "value": "0x63617432"+ },+ {+ "op": "set",+ "key": "0x74657374",+ "value": "0x636174313131"+ },+ {+ "op": "stateRoot",+ "value": "0x80a385b4f06471e95a5993ef0e3b7aa99b64241c"+ },+ {+ "op": "get",+ "key": "0x74657374",+ "value": "0x636174313131"+ }+ ],+ "insert_and_delete": [+ {+ "op": "set",+ "key": "0x666f6f",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x666f6f62",+ "value": "0x62617a"+ },+ {+ "op": "set",+ "key": "0x666f6f61",+ "value": "0x626172"+ },+ {+ "op": "stateRoot",+ "value": "0xbccc80ab0d248beb8e6ce7b81c78559c506cedac"+ },+ {+ "op": "delete",+ "key": "0x666f6f62"+ },+ {+ "op": "delete",+ "key": "0x666f6f62"+ },+ {+ "op": "get",+ "key": "0x666f6f",+ "value": "0x626172"+ },+ {+ "op": "stateRoot",+ "value": "0x3a6305b358770cafa44b3b358fa98746fbd8679f"+ }+ ],+ "insert_and_delete_2": [+ {+ "op": "set",+ "key": "0x20",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x00",+ "value": "0x62617a"+ },+ {+ "op": "set",+ "key": "0x00",+ "value": "0x626172"+ },+ {+ "op": "stateRoot",+ "value": "0x42c33979750064d830468c4cc954642a14d97497"+ },+ {+ "op": "delete",+ "key": "0x00"+ },+ {+ "op": "get",+ "key": "0x20",+ "value": "0x626172"+ },+ {+ "op": "stateRoot",+ "value": "0x52c8cef4b4014aba94b7bc1990919335b417cf13"+ }+ ],+ "delete_with_one_branch": [+ {+ "op": "set",+ "key": "0x00",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x01",+ "value": "0x62617a"+ },+ {+ "op": "set",+ "key": "0x0002",+ "value": "0x626172"+ },+ {+ "op": "delete",+ "key": "0x00"+ },+ {+ "op": "stateRoot",+ "value": "0xf47670c01ff5450ff83c1e7f46092e94fc2c0d0b"+ }+ ],+ "delete_with_two_branches": [+ {+ "op": "set",+ "key": "0x00",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x00f0",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x0000",+ "value": "0x626172"+ },+ {+ "op": "delete",+ "key": "0x00"+ },+ {+ "op": "stateRoot",+ "value": "0xf7d7490a412c72a2fa66bf3b85af4a1027f02058"+ }+ ],+ "delete_with_no_branches": [+ {+ "op": "set",+ "key": "0x00",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x00f0",+ "value": "0x626172"+ },+ {+ "op": "set",+ "key": "0x0000",+ "value": "0x626172"+ },+ {+ "op": "delete",+ "key": "0x0000"+ },+ {+ "op": "stateRoot",+ "value": "0x230a8e726c6444964d027d906fe0fdc361122163"+ }+ ],+ "saturatedTree": [+ {+ "op": "set",+ "key": "0x00",+ "value": "0x636174"+ },+ {+ "op": "set",+ "key": "0x01",+ "value": "0x63617431"+ },+ {+ "op": "set",+ "key": "0x02",+ "value": "0x63617432"+ },+ {+ "op": "set",+ "key": "0x03",+ "value": "0x63617433"+ },+ {+ "op": "set",+ "key": "0x04",+ "value": "0x63617434"+ },+ {+ "op": "set",+ "key": "0x05",+ "value": "0x63617435"+ },+ {+ "op": "set",+ "key": "0x06",+ "value": "0x63617436"+ },+ {+ "op": "set",+ "key": "0x07",+ "value": "0x63617437"+ },+ {+ "op": "set",+ "key": "0x08",+ "value": "0x63617438"+ },+ {+ "op": "set",+ "key": "0x09",+ "value": "0x63617439"+ },+ {+ "op": "set",+ "key": "0x0a",+ "value": "0x63617461"+ },+ {+ "op": "set",+ "key": "0x0b",+ "value": "0x63617462"+ },+ {+ "op": "stateRoot",+ "value": "0xc4bf5d2ff89e90cd9edd81e8e160953406ac446b"+ },+ {+ "op": "get",+ "key": "0x00",+ "value": "0x636174"+ },+ {+ "op": "get",+ "key": "0x01",+ "value": "0x63617431"+ },+ {+ "op": "get",+ "key": "0x02",+ "value": "0x63617432"+ },+ {+ "op": "get",+ "key": "0x03",+ "value": "0x63617433"+ },+ {+ "op": "get",+ "key": "0x04",+ "value": "0x63617434"+ },+ {+ "op": "get",+ "key": "0x05",+ "value": "0x63617435"+ },+ {+ "op": "get",+ "key": "0x06",+ "value": "0x63617436"+ },+ {+ "op": "get",+ "key": "0x07",+ "value": "0x63617437"+ },+ {+ "op": "get",+ "key": "0x08",+ "value": "0x63617438"+ },+ {+ "op": "get",+ "key": "0x09",+ "value": "0x63617439"+ },+ {+ "op": "get",+ "key": "0x0a",+ "value": "0x63617461"+ },+ {+ "op": "get",+ "key": "0x0b",+ "value": "0x63617462"+ },+ {+ "op": "delete",+ "key": "0x00"+ },+ {+ "op": "delete",+ "key": "0x01"+ },+ {+ "op": "delete",+ "key": "0x02"+ },+ {+ "op": "delete",+ "key": "0x03"+ },+ {+ "op": "delete",+ "key": "0x04"+ },+ {+ "op": "delete",+ "key": "0x05"+ },+ {+ "op": "delete",+ "key": "0x06"+ },+ {+ "op": "delete",+ "key": "0x07"+ },+ {+ "op": "delete",+ "key": "0x08"+ },+ {+ "op": "delete",+ "key": "0x09"+ },+ {+ "op": "delete",+ "key": "0x0a"+ },+ {+ "op": "delete",+ "key": "0x0b"+ },+ {+ "op": "stateRoot",+ "value": "0x4cf812be9be2c6008325050f43d06676a08612c7"+ }+ ]+}