diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml index 9a39288..926dba3 100644 --- a/.github/workflows/c-cpp.yml +++ b/.github/workflows/c-cpp.yml @@ -29,5 +29,8 @@ jobs: ./scripts/build.sh sudo cp bin/flatcc /usr/bin + - name: make all + run: make + - name: make check run: make check diff --git a/LICENSE b/LICENSE index a22a2da..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1 +1,674 @@ -MIT + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile index b95fffa..56a1975 100644 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ CFLAGS = -Wall -Wno-misleading-indentation -Wno-unused-function -Werror -O2 -g -Ideps/secp256k1/include -Ideps/lmdb -Ideps/flatcc/include -HEADERS = sha256.h nostrdb.h cursor.h hex.h jsmn.h config.h sha256.h random.h memchr.h $(C_BINDINGS) +HEADERS = sha256.h nostrdb.h cursor.h hex.h jsmn.h config.h sha256.h random.h memchr.h cpu.h $(C_BINDINGS) FLATCC_SRCS=deps/flatcc/src/runtime/json_parser.c deps/flatcc/src/runtime/verifier.c deps/flatcc/src/runtime/builder.c deps/flatcc/src/runtime/emitter.c deps/flatcc/src/runtime/refmap.c SRCS = nostrdb.c sha256.c bech32.c $(FLATCC_SRCS) LDS = $(SRCS) $(ARS) @@ -18,7 +18,7 @@ BIN=ndb CHECKDATA=testdata/db/v0/data.mdb -all: $(BIN) lib bindings +all: $(BIN) lib bindings ndb lib: benches test @@ -136,9 +136,6 @@ deps/lmdb/liblmdb.a: deps/lmdb/lmdb.h bench: bench.c $(DEPS) $(CC) $(CFLAGS) bench.c $(LDS) -o $@ -bench-ingest: bench-ingest.c $(DEPS) - $(CC) $(CFLAGS) bench-ingest.c $(LDS) -o $@ - testdata/db/ndb-v0.tar.zst: curl https://cdn.jb55.com/s/ndb-v0.tar.zst -o $@ diff --git a/README.md b/README.md index 17a9c15..4c27ec3 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,50 @@ functionality (yet?) [1]: https://github.com/hoytech/strfry + +## API + +The API is *very* unstable. nostrdb is in heavy development mode so don't +expect any of the interfaces to be stable at this time. + +## CLI + +nostrdb comes with a handy `ndb` command line tool for interacting with nostrdb +databases. The tool is relatively new, and only supports a few commands. + +### Usage + +``` +usage: ndb [--skip-verification] [-d db_dir] + +commands + + stat + search [--oldest-first] [--limit 42] + import + +settings + + --skip-verification skip signature validation + -d set database directory +``` + +### Building + +```bash +$ make ndb +``` + +### Fulltext Queries + +nostrdb supports fulltext queries. You can import some test events like so: + +``` +$ make testdata/many-events.json +$ ndb --skip-verification import testdata/many-events.json +$ ndb search --limit 2 --oldest-first 'nosy ostrich' + +[01] K<'ostrich' 7 1671217526 note_id:253309> +Q: What do you call a nosy ostrich? +A: A nosTrich! +``` diff --git a/bench-ingest-many.c b/bench-ingest-many.c index 0c90c67..0b4c0df 100644 --- a/bench-ingest-many.c +++ b/bench-ingest-many.c @@ -27,18 +27,20 @@ int map_file(const char *filename, unsigned char **p, size_t *flen) static int bench_parser() { - int ingester_threads; long nanos, ms; - size_t written, mapsize; + size_t written; struct ndb *ndb; struct timespec t1, t2; char *json; int times = 1; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024ULL * 1024ULL * 400ULL * 10ULL; - ingester_threads = 8; - assert(ndb_init(&ndb, "testdata/db", mapsize, ingester_threads, - NDB_FLAG_SKIP_NOTE_VERIFY)); + ndb_config_set_mapsize(&config, 1024ULL * 1024ULL * 400ULL * 10ULL); + ndb_config_set_ingest_threads(&config, 8); + ndb_config_set_flags(&config, NDB_FLAG_SKIP_NOTE_VERIFY); + + assert(ndb_init(&ndb, "testdata/db", &config)); const char *filename = "testdata/many-events.json"; if (!map_file(filename, (unsigned char**)&json, &written)) { printf("mapping testdata/many-events.json failed\n"); diff --git a/bench-ingest.c b/bench-ingest.c deleted file mode 100644 index f374204..0000000 --- a/bench-ingest.c +++ /dev/null @@ -1,57 +0,0 @@ - - -#include "io.h" -#include "nostrdb.h" -#include -#include -#include -#include - -static int bench_parser(int times) -{ - char *json = malloc(1024 * 100); - int i, mapsize, written, ingester_threads; - long nanos, ms; - static const int alloc_size = 2 << 18; - struct ndb *ndb; - struct timespec t1, t2; - - written = 0; - mapsize = 1024 * 1024 * 100; - ingester_threads = 8; - assert(ndb_init(&ndb, "testdata/db", mapsize, ingester_threads, 0)); - read_file("testdata/contacts-event.json", (unsigned char*)json, alloc_size, &written); - - clock_gettime(CLOCK_MONOTONIC, &t1); - - for (i = 0; i < times; i++) { - ndb_process_event(ndb, json, written); - } - - free(json); - ndb_destroy(ndb); - - clock_gettime(CLOCK_MONOTONIC, &t2); - - nanos = (t2.tv_sec - t1.tv_sec) * (long)1e9 + (t2.tv_nsec - t1.tv_nsec); - ms = nanos / 1e6; - printf("ns/run\t%ld\nms/run\t%f\nns\t%ld\nms\t%ld\n", - nanos/times, (double)ms/(double)times, nanos, ms); - - return 1; -} - -int main(int argc, char *argv[], char **env) -{ - int times = 50000; - - if (argc >= 2) - times = atoi(argv[1]); - - fprintf(stderr, "benching %d duplicate contact events\n", times); - if (!bench_parser(times)) - return 2; - - return 0; -} - diff --git a/cpu.h b/cpu.h new file mode 100644 index 0000000..a51ff7b --- /dev/null +++ b/cpu.h @@ -0,0 +1,34 @@ + +#if defined(_WIN32) || defined(_WIN64) + #include +#elif defined(__linux__) + #include +#elif defined(__APPLE__) + #include + #include +#else + #error "Unsupported platform" +#endif + +static inline int get_cpu_cores() { + int num_cores = 0; + + // Windows + #if defined(_WIN32) || defined(_WIN64) + SYSTEM_INFO sysinfo; + GetSystemInfo(&sysinfo); + num_cores = sysinfo.dwNumberOfProcessors; // This returns logical processors + // Further use GetLogicalProcessorInformation for physical cores... + // Linux + #elif defined(__linux__) + num_cores = sysconf(_SC_NPROCESSORS_ONLN); // This returns logical processors + // macOS + #elif defined(__APPLE__) + size_t size = sizeof(num_cores); + sysctlbyname("hw.physicalcpu", &num_cores, &size, NULL, 0); + #else + num_cores = -1; // Unsupported platform + #endif + + return num_cores; +} diff --git a/ndb.c b/ndb.c index fb1ea2d..f978063 100644 --- a/ndb.c +++ b/ndb.c @@ -2,6 +2,7 @@ #include "nostrdb.h" #include +#include #include #include #include @@ -12,7 +13,7 @@ static int usage() printf("usage: ndb [--skip-verification] [-d db_dir] \n\n"); printf("commands\n\n"); printf(" stat\n"); - printf(" search \n"); + printf(" search [--oldest-first] [--limit 42] \n"); printf(" import \n\n"); printf("settings\n\n"); printf(" --skip-verification skip signature validation\n"); @@ -86,18 +87,58 @@ static void print_stats(struct ndb_stat *stat) } } +static void ndb_print_text_search_key(struct ndb_text_search_key *key) +{ + printf("K<'%.*s' %d %" PRIu64 " note_id:%" PRIu64 ">", key->str_len, key->str, + key->word_index, + key->timestamp, + key->note_id); +} + +static void print_hex(unsigned char* data, size_t size) { + size_t i; + for (i = 0; i < size; i++) { + printf("%02x", data[i]); + } +} + +static void ndb_print_text_search_result(struct ndb_txn *txn, + struct ndb_text_search_result *r) +{ + size_t len; + struct ndb_note *note; + + ndb_print_text_search_key(&r->key); + + if (!(note = ndb_get_note_by_key(txn, r->key.note_id, &len))) { + printf(": note not found"); + return; + } + + printf(" "); + print_hex(note->id, 32); + + printf("\n%s\n\n---\n", ndb_note_str(note, ¬e->content).str); +} + +int ndb_print_search_keys(struct ndb_txn *txn); + int main(int argc, char *argv[]) { struct ndb *ndb; - int threads = 6; - int i, flags; + int i, flags, limit; struct ndb_stat stat; struct ndb_txn txn; struct ndb_text_search_results results; + struct ndb_text_search_result *result; const char *dir; unsigned char *data; size_t data_len; - size_t mapsize = 1024ULL * 1024ULL * 1024ULL * 1024ULL; // 1 TiB + struct ndb_config config; + struct ndb_text_search_config search_config; + ndb_default_config(&config); + ndb_default_text_search_config(&search_config); + ndb_config_set_mapsize(&config, 1024ULL * 1024ULL * 1024ULL * 1024ULL /* 1 TiB */); if (argc < 2) { return usage(); @@ -118,15 +159,38 @@ int main(int argc, char *argv[]) } } + ndb_config_set_flags(&config, flags); + fprintf(stderr, "using db '%s'\n", dir); - if (!ndb_init(&ndb, dir, mapsize, threads, flags)) { + if (!ndb_init(&ndb, dir, &config)) { return 2; } - if (argc == 3 && !strcmp(argv[1], "search")) { + if (argc >= 3 && !strcmp(argv[1], "search")) { + for (i = 0; i < 2; i++) { + if (!strcmp(argv[2], "--oldest-first")) { + ndb_text_search_config_set_order(&search_config, NDB_ORDER_ASCENDING); + argv++; + argc--; + } else if (!strcmp(argv[2], "--limit")) { + limit = atoi(argv[3]); + ndb_text_search_config_set_limit(&search_config, limit); + argv += 2; + argc -= 2; + } + } + ndb_begin_query(ndb, &txn); - ndb_text_search(&txn, argv[2], &results); + ndb_text_search(&txn, argv[2], &results, &search_config); + + // print results for now + for (i = 0; i < results.num_results; i++) { + result = &results.results[i]; + printf("[%02d] ", i+1); + ndb_print_text_search_result(&txn, result); + } + ndb_end_query(&txn); } else if (argc == 2 && !strcmp(argv[1], "stat")) { if (!ndb_stat(ndb, &stat)) { @@ -137,6 +201,11 @@ int main(int argc, char *argv[]) } else if (argc == 3 && !strcmp(argv[1], "import")) { map_file(argv[2], &data, &data_len); ndb_process_events(ndb, (const char *)data, data_len); + ndb_process_client_events(ndb, (const char *)data, data_len); + } else if (argc == 2 && !strcmp(argv[1], "print-search-keys")) { + ndb_begin_query(ndb, &txn); + ndb_print_search_keys(&txn); + ndb_end_query(&txn); } else { return usage(); } diff --git a/nostrdb.c b/nostrdb.c index 2a8451f..f297bb6 100644 --- a/nostrdb.c +++ b/nostrdb.c @@ -7,6 +7,7 @@ #include "sha256.h" #include "lmdb.h" #include "util.h" +#include "cpu.h" #include "threadpool.h" #include "protected_queue.h" #include "memchr.h" @@ -115,6 +116,8 @@ struct ndb_ingester { uint32_t flags; struct threadpool tp; struct ndb_writer *writer; + void *filter_context; + ndb_ingest_filter_fn filter; }; @@ -174,7 +177,7 @@ static int ndb_make_text_search_key(unsigned char *buf, int bufsize, // TODO: need update this to uint64_t // we push this first because our query function can pull this off // quicky to check matches - if (!push_varint(&cur, (int)note_id)) + if (!push_varint(&cur, (int32_t)note_id)) return 0; // string length @@ -235,12 +238,14 @@ static int ndb_make_text_search_key_high(unsigned char *buf, int bufsize, int *keysize) { uint64_t timestamp, note_id; - timestamp = UINT64_MAX; - note_id = UINT64_MAX; + timestamp = INT32_MAX; + note_id = INT32_MAX; return ndb_make_text_search_key(buf, bufsize, 0, wordlen, word, timestamp, note_id, keysize); } +typedef int (*ndb_text_search_key_order_fn)(unsigned char *buf, int bufsize, int wordlen, const char *word, int *keysize); + /** From LMDB: Compare two items lexically */ static int mdb_cmp_memn(const MDB_val *a, const MDB_val *b) { int diff; @@ -1577,16 +1582,23 @@ static int ndb_ingester_process_note(secp256k1_context *ctx, struct ndb_note *note, size_t note_size, struct ndb_writer_msg *out, - uint32_t flags) + struct ndb_ingester *ingester) { - //printf("ndb_ingester_process_note "); - //print_hex(note->id, 32); - //printf("\n"); + enum ndb_ingest_filter_action action; + action = NDB_INGEST_ACCEPT; + + if (ingester->filter) + action = ingester->filter(ingester->filter_context, note); + + if (action == NDB_INGEST_REJECT) + return 0; // some special situations we might want to skip sig validation, // like during large imports - if (!(flags & NDB_FLAG_SKIP_NOTE_VERIFY)) { - // Verify! If it's an invalid note we don't need to + if (action == NDB_INGEST_SKIP_VALIDATION || (ingester->flags & NDB_FLAG_SKIP_NOTE_VERIFY)) { + // if we're skipping validation we don't need to verify + } else { + // verify! If it's an invalid note we don't need to // bother writing it to the database if (!ndb_note_verify(ctx, note->pubkey, note->id, note->sig)) { ndb_debug("signature verification failed\n"); @@ -1678,7 +1690,7 @@ static int ndb_ingester_process_event(secp256k1_context *ctx, } if (!ndb_ingester_process_note(ctx, note, note_size, - out, ingester->flags)) { + out, ingester)) { goto cleanup; } else { // we're done with the original json, free it @@ -1699,7 +1711,7 @@ static int ndb_ingester_process_event(secp256k1_context *ctx, } if (!ndb_ingester_process_note(ctx, note, note_size, - out, ingester->flags)) { + out, ingester)) { goto cleanup; } else { // we're done with the original json, free it @@ -2453,16 +2465,60 @@ static int prefix_count(const char *str1, int len1, const char *str2, int len2) return count; } +static void ndb_print_text_search_key(struct ndb_text_search_key *key) +{ + printf("K<'%.*s' %d %" PRIu64 " note_id:%" PRIu64 ">", key->str_len, key->str, + key->word_index, + key->timestamp, + key->note_id); +} + +static int ndb_prefix_matches(struct ndb_text_search_result *result, + struct ndb_word *search_word) +{ + // Empty strings shouldn't happen but let's + if (result->key.str_len < 2 || search_word->word_len < 2) + return 0; + + // make sure we at least have two matching prefix characters. exact + // matches are nice but range searches allow us to match prefixes as + // well. A double-char prefix is suffient, but maybe we could up this + // in the future. + // + // TODO: How are we handling utf-8 prefix matches like + // japanese? + // + if ( result->key.str[0] != tolower(search_word->word[0]) + && result->key.str[1] != tolower(search_word->word[1]) + ) + return 0; + + // count the number of prefix-matched characters. This will be used + // for ranking search results + result->prefix_chars = prefix_count(result->key.str, + result->key.str_len, + search_word->word, + search_word->word_len); + + if (result->prefix_chars <= (int)((double)search_word->word_len / 1.5)) + return 0; + + return 1; +} // This is called when scanning the full text search index. Scanning stops // when we no longer have a prefix match for the word static int ndb_text_search_next_word(MDB_cursor *cursor, MDB_cursor_op op, MDB_val *k, struct ndb_word *search_word, struct ndb_text_search_result *last_result, - struct ndb_text_search_result *result) + struct ndb_text_search_result *result, + MDB_cursor_op order_op) { struct cursor key_cursor; + //struct ndb_text_search_key search_key; MDB_val v; + int retries; + retries = -1; make_cursor(k->mv_data, k->mv_data + k->mv_size, &key_cursor); @@ -2471,8 +2527,27 @@ static int ndb_text_search_next_word(MDB_cursor *cursor, MDB_cursor_op op, // key. // // Subsequent searches should use MDB_NEXT - if (mdb_cursor_get(cursor, k, &v, op)) - return 0; + if (mdb_cursor_get(cursor, k, &v, op)) { + // we should only do this if we're going in reverse + if (op == MDB_SET_RANGE && order_op == MDB_PREV) { + // if set range worked and our key exists, it should be + // the one right before this one + if (mdb_cursor_get(cursor, k, &v, MDB_PREV)) + return 0; + } else { + return 0; + } + } + +retry: + retries++; + /* + printf("continuing from "); + if (ndb_unpack_text_search_key(k->mv_data, k->mv_size, &search_key)) { + ndb_print_text_search_key(&search_key); + } else { printf("??"); } + printf("\n"); + */ make_cursor(k->mv_data, k->mv_data + k->mv_size, &key_cursor); @@ -2502,32 +2577,17 @@ static int ndb_text_search_next_word(MDB_cursor *cursor, MDB_cursor_op op, return 0; } - // Empty strings shouldn't happen but let's - if (result->key.str_len < 2 || search_word->word_len < 2) - return 0; - - // make sure we at least have two matching prefix characters. exact - // matches are nice but range searches allow us to match prefixes as - // well. A double-char prefix is suffient, but maybe we could up this - // in the future. - // - // TODO: How are we handling utf-8 prefix matches like - // japanese? - // - if ( result->key.str[0] != tolower(search_word->word[0]) - && result->key.str[1] != tolower(search_word->word[1]) - ) - return 0; - - // count the number of prefix-matched characters. This will be used - // for ranking search results - result->prefix_chars = prefix_count(result->key.str, - result->key.str_len, - search_word->word, - search_word->word_len); - - if (result->prefix_chars <= (int)((double)search_word->word_len / 1.5)) - return 0; + if (!ndb_prefix_matches(result, search_word)) { + // we should only do this if we're going in reverse + if (retries == 0 && op == MDB_SET_RANGE && order_op == MDB_PREV) { + // if set range worked and our key exists, it should be + // the one right before this one + if (mdb_cursor_get(cursor, k, &v, MDB_PREV)) + goto retry; + } else { + return 0; + } + } // Unpack the remaining text search key, we will need this information // when building up our search results. @@ -2551,57 +2611,65 @@ static int ndb_text_search_next_word(MDB_cursor *cursor, MDB_cursor_op op, return 1; } -static void ndb_print_text_search_key(struct ndb_text_search_key *key) -{ - printf("K<'%.*s' %d %" PRIu64 " note_id:%" PRIu64 ">", key->str_len, key->str, - key->word_index, - key->timestamp, - key->note_id); +static void ndb_text_search_results_init( + struct ndb_text_search_results *results) { + results->num_results = 0; } -static void ndb_print_text_search_result(struct ndb_txn *txn, - struct ndb_text_search_result *r) +void ndb_default_text_search_config(struct ndb_text_search_config *cfg) { - size_t len; - struct ndb_note *note; - - ndb_print_text_search_key(&r->key); - - if (!(note = ndb_get_note_by_key(txn, r->key.note_id, &len))) { - printf(": note not found"); - return; - } + cfg->order = NDB_ORDER_DESCENDING; + cfg->limit = MAX_TEXT_SEARCH_RESULTS; +} - printf("\n%s\n\n---\n", ndb_note_str(note, ¬e->content).str); +void ndb_text_search_config_set_order(struct ndb_text_search_config *cfg, + enum ndb_search_order order) +{ + cfg->order = order; } -static void ndb_text_search_results_init( - struct ndb_text_search_results *results) { - results->num_results = 0; +void ndb_text_search_config_set_limit(struct ndb_text_search_config *cfg, int limit) +{ + cfg->limit = limit; } int ndb_text_search(struct ndb_txn *txn, const char *query, - struct ndb_text_search_results *results) + struct ndb_text_search_results *results, + struct ndb_text_search_config *config) { unsigned char buffer[1024], *buf; unsigned char saved_buf[1024], *saved; struct ndb_text_search_result *result, *last_result; struct ndb_text_search_result candidate, last_candidate; struct ndb_search_words search_words; + //struct ndb_text_search_key search_key; struct ndb_word *search_word; struct cursor cur; + ndb_text_search_key_order_fn key_order_fn; MDB_dbi text_db; MDB_cursor *cursor; MDB_val k, v; - int i, j, keysize, saved_size; - MDB_cursor_op op; + int i, j, keysize, saved_size, limit; + MDB_cursor_op op, order_op; //int num_note_ids; saved = NULL; ndb_text_search_results_init(results); ndb_search_words_init(&search_words); + + // search config + limit = MAX_TEXT_SEARCH_RESULTS; + order_op = MDB_PREV; + key_order_fn = ndb_make_text_search_key_high; + if (config) { + if (config->order == NDB_ORDER_ASCENDING) { + order_op = MDB_NEXT; + key_order_fn = ndb_make_text_search_key_low; + } + limit = min(limit, config->limit); + } + // end search config - //num_note_ids = 0; text_db = txn->lmdb->dbs[NDB_DB_NOTE_TEXT]; make_cursor((unsigned char *)query, (unsigned char *)query + strlen(query), &cur); @@ -2614,24 +2682,14 @@ int ndb_text_search(struct ndb_txn *txn, const char *query, return 0; } - fprintf(stderr, "search query: '%s'\n", query); - - // for each word, we recursively find all of the submatches - while (results->num_results < MAX_TEXT_SEARCH_RESULTS) { + while (results->num_results < limit) { last_result = NULL; result = &results->results[results->num_results]; // if we have saved, then we continue from the last root search // sequence if (saved) { - /* - fprintf(stderr, "continuing from "); - if (ndb_unpack_text_search_key(saved_buf, saved_size, &search_key)) { - ndb_print_text_search_key(&search_key); - } - fprintf(stderr, "\n"); - */ buf = saved_buf; saved = NULL; keysize = saved_size; @@ -2643,16 +2701,15 @@ int ndb_text_search(struct ndb_txn *txn, const char *query, if (mdb_cursor_get(cursor, &k, &v, MDB_SET_RANGE)) break; - op = MDB_NEXT; + op = order_op; } else { // construct a packed fulltext search key using this // word this key doesn't contain any timestamp or index // info, so it should range match instead of exact // match - if (!ndb_make_text_search_key_low( - buffer, sizeof(buffer), - search_words.words[0].word_len, - search_words.words[0].word, &keysize)) + if (!key_order_fn(buffer, sizeof(buffer), + search_words.words[0].word_len, + search_words.words[0].word, &keysize)) { // word is too big to fit in 1024-sized key continue; @@ -2699,7 +2756,8 @@ int ndb_text_search(struct ndb_txn *txn, const char *query, if (!ndb_text_search_next_word(cursor, op, &k, search_word, last_result, - &candidate)) { + &candidate, + order_op)) { break; } @@ -2728,13 +2786,6 @@ int ndb_text_search(struct ndb_txn *txn, const char *query, } - // print results for now - for (j = 0; j < results->num_results; j++) { - result = &results->results[j]; - printf("[%02d] ", j+1); - ndb_print_text_search_result(txn, result); - } - mdb_cursor_close(cursor); return 1; @@ -2773,8 +2824,8 @@ static uint64_t ndb_write_note(struct ndb_txn *txn, if (!ndb_write_note_kind_index(txn, note->note, note_key)) return 0; - // only do fulltext index on kind1 notes - if (note->note->kind == 1) { + // only do fulltext index on text and longform notes + if (note->note->kind == 1 || note->note->kind == 30023) { if (!ndb_write_note_fulltext_index(txn, note->note, note_key)) return 0; } @@ -3000,8 +3051,8 @@ static int ndb_writer_init(struct ndb_writer *writer, struct ndb_lmdb *lmdb) // initialize the ingester queue and then spawn the thread static int ndb_ingester_init(struct ndb_ingester *ingester, - struct ndb_writer *writer, int num_threads, - int flags) + struct ndb_writer *writer, + struct ndb_config *config) { int elem_size, num_elems; static struct ndb_ingester_msg quit_msg = { .type = NDB_INGEST_QUIT }; @@ -3011,10 +3062,13 @@ static int ndb_ingester_init(struct ndb_ingester *ingester, num_elems = DEFAULT_QUEUE_SIZE; ingester->writer = writer; - ingester->flags = flags; + ingester->flags = config->flags; + ingester->filter = config->ingest_filter; + ingester->filter_context = config->filter_context; - if (!threadpool_init(&ingester->tp, num_threads, elem_size, num_elems, - &quit_msg, ingester, ndb_ingester_thread)) + if (!threadpool_init(&ingester->tp, config->ingester_threads, + elem_size, num_elems, &quit_msg, ingester, + ndb_ingester_thread)) { fprintf(stderr, "ndb ingester threadpool failed to init\n"); return 0; @@ -3221,20 +3275,20 @@ static int ndb_run_migrations(struct ndb *ndb) return 1; } -int ndb_init(struct ndb **pndb, const char *filename, size_t mapsize, int ingester_threads, int flags) +int ndb_init(struct ndb **pndb, const char *filename, struct ndb_config *config) { struct ndb *ndb; //MDB_dbi ind_id; // TODO: ind_pk, etc ndb = *pndb = calloc(1, sizeof(struct ndb)); - ndb->flags = flags; + ndb->flags = config->flags; if (ndb == NULL) { fprintf(stderr, "ndb_init: malloc failed\n"); return 0; } - if (!ndb_init_lmdb(filename, &ndb->lmdb, mapsize)) + if (!ndb_init_lmdb(filename, &ndb->lmdb, config->mapsize)) return 0; if (!ndb_writer_init(&ndb->writer, &ndb->lmdb)) { @@ -3242,14 +3296,14 @@ int ndb_init(struct ndb **pndb, const char *filename, size_t mapsize, int ingest return 0; } - if (!ndb_ingester_init(&ndb->ingester, &ndb->writer, ingester_threads, - ndb->flags)) { + if (!ndb_ingester_init(&ndb->ingester, &ndb->writer, config)) { fprintf(stderr, "failed to initialize %d ingester thread(s)\n", - ingester_threads); + config->ingester_threads); return 0; } - if (!ndb_flag_set(flags, NDB_FLAG_NOMIGRATE) && !ndb_run_migrations(ndb)) { + if (!ndb_flag_set(config->flags, NDB_FLAG_NOMIGRATE) && + !ndb_run_migrations(ndb)) { fprintf(stderr, "failed to run migrations\n"); return 0; } @@ -4380,4 +4434,64 @@ inline int ndb_builder_push_tag_str(struct ndb_builder *builder, return ndb_builder_finalize_tag(builder, pstr); } +// +// CONFIG +// +void ndb_default_config(struct ndb_config *config) +{ + int cores = get_cpu_cores(); + config->mapsize = 1024UL * 1024UL * 1024UL * 32UL; // 32 GiB + config->ingester_threads = cores == -1 ? 4 : cores; + config->flags = 0; + config->ingest_filter = NULL; + config->filter_context = NULL; +} + +void ndb_config_set_ingest_threads(struct ndb_config *config, int threads) +{ + config->ingester_threads = threads; +} + +void ndb_config_set_flags(struct ndb_config *config, int flags) +{ + config->flags = flags; +} + +void ndb_config_set_mapsize(struct ndb_config *config, size_t mapsize) +{ + config->mapsize = mapsize; +} + +void ndb_config_set_ingest_filter(struct ndb_config *config, + ndb_ingest_filter_fn fn, void *filter_ctx) +{ + config->ingest_filter = fn; + config->filter_context = filter_ctx; +} + +// used by ndb.c +int ndb_print_search_keys(struct ndb_txn *txn) +{ + MDB_cursor *cur; + MDB_val k, v; + int i; + struct ndb_text_search_key search_key; + + if (mdb_cursor_open(txn->mdb_txn, txn->lmdb->dbs[NDB_DB_NOTE_TEXT], &cur)) + return 0; + + i = 1; + while (mdb_cursor_get(cur, &k, &v, MDB_NEXT) == 0) { + if (!ndb_unpack_text_search_key(k.mv_data, k.mv_size, &search_key)) { + fprintf(stderr, "error decoding key %d\n", i); + continue; + } + ndb_print_text_search_key(&search_key); + printf("\n"); + + i++; + } + + return 1; +} diff --git a/nostrdb.h b/nostrdb.h index 8934775..c21b4b1 100644 --- a/nostrdb.h +++ b/nostrdb.h @@ -105,6 +105,12 @@ enum tce_type { NDB_TCE_EOSE = 0x4, }; +enum ndb_ingest_filter_action { + NDB_INGEST_REJECT, + NDB_INGEST_ACCEPT, + NDB_INGEST_SKIP_VALIDATION +}; + // function pointer for controlling what to do after we parse an id typedef enum ndb_idres (*ndb_id_fn)(void *, const char *); @@ -233,6 +239,8 @@ struct ndb_note { #pragma pack(pop) +typedef enum ndb_ingest_filter_action (*ndb_ingest_filter_fn)(void *, struct ndb_note *); + struct ndb_builder { struct cursor mem; struct cursor note_cur; @@ -269,6 +277,11 @@ enum ndb_generic_element_type { NDB_ELEMENT_ID = 2, }; +enum ndb_search_order { + NDB_ORDER_DESCENDING, + NDB_ORDER_ASCENDING, +}; + union ndb_filter_element { const char *string; const unsigned char *id; @@ -295,6 +308,25 @@ struct ndb_filter { struct ndb_filter_elements *elements[NDB_NUM_FILTERS]; }; +struct ndb_config { + int flags; + int ingester_threads; + size_t mapsize; + void *filter_context; + ndb_ingest_filter_fn ingest_filter; +}; + +struct ndb_text_search_config { + enum ndb_search_order order; + int limit; +}; + +// CONFIG +void ndb_default_config(struct ndb_config *); +void ndb_config_set_ingest_threads(struct ndb_config *config, int threads); +void ndb_config_set_flags(struct ndb_config *config, int flags); +void ndb_config_set_mapsize(struct ndb_config *config, size_t mapsize); +void ndb_config_set_ingest_filter(struct ndb_config *config, ndb_ingest_filter_fn fn, void *); // HELPERS int ndb_calculate_id(struct ndb_note *note, unsigned char *buf, int buflen); @@ -304,7 +336,7 @@ int ndb_decode_key(const char *secstr, struct ndb_keypair *keypair); int ndb_note_verify(void *secp_ctx, unsigned char pubkey[32], unsigned char id[32], unsigned char signature[64]); // NDB -int ndb_init(struct ndb **ndb, const char *dbdir, size_t mapsize, int ingester_threads, int flags); +int ndb_init(struct ndb **ndb, const char *dbdir, struct ndb_config *); int ndb_db_version(struct ndb *ndb); int ndb_process_event(struct ndb *, const char *json, int len); int ndb_process_events(struct ndb *, const char *ldjson, size_t len); @@ -354,9 +386,11 @@ void ndb_filter_reset(struct ndb_filter *); void ndb_filter_end_field(struct ndb_filter *); void ndb_filter_free(struct ndb_filter *filter); - // FULLTEXT SEARCH -int ndb_text_search(struct ndb_txn *txn, const char *query, struct ndb_text_search_results *); +int ndb_text_search(struct ndb_txn *txn, const char *query, struct ndb_text_search_results *, struct ndb_text_search_config *); +void ndb_default_text_search_config(struct ndb_text_search_config *); +void ndb_text_search_config_set_order(struct ndb_text_search_config *, enum ndb_search_order); +void ndb_text_search_config_set_limit(struct ndb_text_search_config *, int limit); // stats int ndb_stat(struct ndb *ndb, struct ndb_stat *stat); diff --git a/test.c b/test.c index ea5b168..897a7f3 100644 --- a/test.c +++ b/test.c @@ -118,15 +118,12 @@ static void test_filters() static void test_fetched_at() { struct ndb *ndb; - size_t mapsize; - int ingester_threads; struct ndb_txn txn; uint64_t fetched_at, t1, t2; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); const unsigned char pubkey[] = { 0x87, 0xfb, 0xc6, 0xd5, 0x98, 0x31, 0xa8, 0x23, 0xa4, 0x5d, 0x10, 0x1f, 0x86, 0x94, 0x2c, 0x41, 0xcd, 0xe2, 0x90, 0x23, 0xf4, 0x09, 0x20, 0x24, @@ -174,22 +171,21 @@ static void test_reaction_counter() static const int alloc_size = 1024 * 1024; char *json = malloc(alloc_size); struct ndb *ndb; - size_t mapsize, len; + size_t len; void *root; - int written, ingester_threads, reactions; + int written, reactions; NdbEventMeta_table_t meta; struct ndb_txn txn; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/reactions.json", (unsigned char*)json, alloc_size, &written); assert(ndb_process_client_events(ndb, json, written)); ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); assert(ndb_begin_query(ndb, &txn)); @@ -247,16 +243,15 @@ static void test_profile_updates() static const int alloc_size = 1024 * 1024; char *json = malloc(alloc_size); struct ndb *ndb; - size_t mapsize, len; + size_t len; void *record; - int written, ingester_threads; + int written; struct ndb_txn txn; uint64_t key; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/profile-updates.json", (unsigned char*)json, alloc_size, &written); @@ -264,7 +259,7 @@ static void test_profile_updates() ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); assert(ndb_begin_query(ndb, &txn)); const unsigned char pk[32] = { @@ -293,12 +288,11 @@ static void test_load_profiles() static const int alloc_size = 1024 * 1024; char *json = malloc(alloc_size); struct ndb *ndb; - size_t mapsize; - int written, ingester_threads; + int written; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/profiles.json", (unsigned char*)json, alloc_size, &written); @@ -306,7 +300,7 @@ static void test_load_profiles() ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); unsigned char id[32] = { 0x22, 0x05, 0x0b, 0x6d, 0x97, 0xbb, 0x9d, 0xa0, 0x9e, 0x90, 0xed, 0x0c, 0x6d, 0xd9, 0x5e, 0xed, 0x1d, 0x42, 0x3e, 0x27, 0xd5, 0xcb, 0xa5, 0x94, @@ -330,26 +324,31 @@ static void test_load_profiles() static void test_fuzz_events() { struct ndb *ndb; const char *str = "[\"EVENT\"\"\"{\"content\"\"created_at\":0 \"id\"\"5086a8f76fe1da7fb56a25d1bebbafd70fca62e36a72c6263f900ff49b8f8604\"\"kind\":0 \"pubkey\":9c87f94bcbe2a837adc28d46c34eeaab8fc2e1cdf94fe19d4b99ae6a5e6acedc \"sig\"\"27374975879c94658412469cee6db73d538971d21a7b580726a407329a4cafc677fb56b946994cea59c3d9e118fef27e4e61de9d2c46ac0a65df14153 ea93cf5\"\"tags\"[[][\"\"]]}]"; + struct ndb_config config; + ndb_default_config(&config); - ndb_init(&ndb, test_dir, 1024 * 1024, 1, 0); + ndb_init(&ndb, test_dir, &config); ndb_process_event(ndb, str, strlen(str)); ndb_destroy(ndb); } static void test_migrate() { static const char *v0_dir = "testdata/db/v0"; - size_t mapsize = 1024ULL * 1024ULL * 1024ULL * 32ULL; - int threads = 2; struct ndb *ndb; + struct ndb_config config; + ndb_default_config(&config); + ndb_config_set_flags(&config, NDB_FLAG_NOMIGRATE); fprintf(stderr, "testing migrate on v0\n"); - assert(ndb_init(&ndb, v0_dir, mapsize, threads, NDB_FLAG_NOMIGRATE)); + assert(ndb_init(&ndb, v0_dir, &config)); assert(ndb_db_version(ndb) == 0); ndb_destroy(ndb); - assert(ndb_init(&ndb, v0_dir, mapsize, threads, 0)); + ndb_config_set_flags(&config, 0); + + assert(ndb_init(&ndb, v0_dir, &config)); ndb_destroy(ndb); - assert(ndb_init(&ndb, v0_dir, mapsize, threads, 0)); + assert(ndb_init(&ndb, v0_dir, &config)); assert(ndb_db_version(ndb) == 3); test_profile_search(ndb); @@ -548,18 +547,18 @@ static void test_replacement() char *json = malloc(alloc_size); unsigned char *buf = malloc(alloc_size); struct ndb *ndb; - size_t mapsize, len; - int written, ingester_threads; + size_t len; + int written; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/old-new.json", (unsigned char*)json, alloc_size, &written); assert(ndb_process_events(ndb, json, written)); ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); struct ndb_txn txn; assert(ndb_begin_query(ndb, &txn)); @@ -590,19 +589,19 @@ static void test_fetch_last_noteid() char *json = malloc(alloc_size); unsigned char *buf = malloc(alloc_size); struct ndb *ndb; - size_t mapsize, len; - int written, ingester_threads; + size_t len; + int written; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/random.json", (unsigned char*)json, alloc_size, &written); assert(ndb_process_events(ndb, json, written)); ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); unsigned char id[32] = { 0xdc, 0x96, 0x4f, 0x4c, 0x89, 0x83, 0x64, 0x13, 0x8e, 0x81, 0x96, 0xf0, 0xc7, 0x33, 0x38, 0xc8, 0xcc, 0x3e, 0xbf, 0xa3, 0xaf, 0xdd, 0xbc, 0x7d, 0xd1, 0x58, 0xb4, 0x84, 0x7c, 0x1e, 0xbf, 0xa0 }; @@ -945,25 +944,26 @@ static void test_fast_strchr() static void test_fulltext() { struct ndb *ndb; - size_t mapsize; - int ingester_threads; struct ndb_txn txn; int written; static const int alloc_size = 2 << 18; char *json = malloc(alloc_size); struct ndb_text_search_results results; + struct ndb_config config; + ndb_default_config(&config); - mapsize = 1024 * 1024 * 100; - ingester_threads = 1; - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); read_file("testdata/search.json", (unsigned char*)json, alloc_size, &written); assert(ndb_process_client_events(ndb, json, written)); ndb_destroy(ndb); - assert(ndb_init(&ndb, test_dir, mapsize, ingester_threads, 0)); + assert(ndb_init(&ndb, test_dir, &config)); ndb_begin_query(ndb, &txn); - ndb_text_search(&txn, "Jump Over", &results); + ndb_text_search(&txn, "Jump Over", &results, NULL); + fprintf(stderr, "num results %d\n", results.num_results); + assert(results.num_results == 2); + assert(!strcmp(results.results[0].key.str, "jumped")); ndb_end_query(&txn); ndb_destroy(ndb); diff --git a/testdata/search.json b/testdata/search.json new file mode 100644 index 0000000..a93e7dc --- /dev/null +++ b/testdata/search.json @@ -0,0 +1,3 @@ +["EVENT",{"id":"8f68cdc0c72dcf5c37868428cb477f28b13b1561e717f92053921b3b3c4ab712","pubkey":"ba4b26df771a0839d5a26550ada6ac19547e164136994951d2d5c5815993a28e","created_at":1701187327,"kind":1,"tags":[],"content":"a quick brown fox jumped over the lazy dog","sig":"3cca4157e92df32f42e3df5a63e2438676557e53d9136fedc6f3a23f6fad083748af19dfb3fa5949654c4b5623342e70cb74d56cf6e6e8a347a3ab2c3adf1654"}] +["EVENT",{"id":"b17a540710fe8495b16bfbaf31c6962c4ba8387f3284a7973ad523988095417e","pubkey":"df51637b1a19115d6c532081461a3e24f19b02f15815771dd26de2617fe2ea90","created_at":1701187337,"kind":1,"tags":[],"content":"a quick brown fox barked at the lazy dog","sig":"e171df376d6efd3f8dc072715d14387c3446785d1b8c5809b4871a9dc925c39a7b475fcebc8c98bbd5363ba1ed0a7d6420ad796fcda24f3d6f820b433af92ee2"}] +["EVENT",{"id":"35c717f1d905b05e16868107f78ec013399b01e9dcdd40fcaf8112b3d1f63ad4","pubkey":"381eac026b7d3053236eef30c1a3cd0674809d050b1ba9f05c694efb5ea002d4","created_at":1701188103,"kind":1,"tags":[],"content":"a quick brown fox jumped over the lazy cat","sig":"fed2e4c1d34ad79004468f676310d366c0104d2d01f1778fc7f308fca52892ad3b8f83d6e0219fcfbcc2d3123d4ad0a733b69123414ce4b117e44041600045a0"}]