Reference-counted, deduplicated string store.
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

Initial commit.

Translating my Zig library to C for practice.

jeremia.dev 0c0dedfe

+1888
+674
COPYING
··· 1 + GNU GENERAL PUBLIC LICENSE 2 + Version 3, 29 June 2007 3 + 4 + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 5 + Everyone is permitted to copy and distribute verbatim copies 6 + of this license document, but changing it is not allowed. 7 + 8 + Preamble 9 + 10 + The GNU General Public License is a free, copyleft license for 11 + software and other kinds of works. 12 + 13 + The licenses for most software and other practical works are designed 14 + to take away your freedom to share and change the works. By contrast, 15 + the GNU General Public License is intended to guarantee your freedom to 16 + share and change all versions of a program--to make sure it remains free 17 + software for all its users. We, the Free Software Foundation, use the 18 + GNU General Public License for most of our software; it applies also to 19 + any other work released this way by its authors. You can apply it to 20 + your programs, too. 21 + 22 + When we speak of free software, we are referring to freedom, not 23 + price. Our General Public Licenses are designed to make sure that you 24 + have the freedom to distribute copies of free software (and charge for 25 + them if you wish), that you receive source code or can get it if you 26 + want it, that you can change the software or use pieces of it in new 27 + free programs, and that you know you can do these things. 28 + 29 + To protect your rights, we need to prevent others from denying you 30 + these rights or asking you to surrender the rights. Therefore, you have 31 + certain responsibilities if you distribute copies of the software, or if 32 + you modify it: responsibilities to respect the freedom of others. 33 + 34 + For example, if you distribute copies of such a program, whether 35 + gratis or for a fee, you must pass on to the recipients the same 36 + freedoms that you received. You must make sure that they, too, receive 37 + or can get the source code. And you must show them these terms so they 38 + know their rights. 39 + 40 + Developers that use the GNU GPL protect your rights with two steps: 41 + (1) assert copyright on the software, and (2) offer you this License 42 + giving you legal permission to copy, distribute and/or modify it. 43 + 44 + For the developers' and authors' protection, the GPL clearly explains 45 + that there is no warranty for this free software. For both users' and 46 + authors' sake, the GPL requires that modified versions be marked as 47 + changed, so that their problems will not be attributed erroneously to 48 + authors of previous versions. 49 + 50 + Some devices are designed to deny users access to install or run 51 + modified versions of the software inside them, although the manufacturer 52 + can do so. This is fundamentally incompatible with the aim of 53 + protecting users' freedom to change the software. The systematic 54 + pattern of such abuse occurs in the area of products for individuals to 55 + use, which is precisely where it is most unacceptable. Therefore, we 56 + have designed this version of the GPL to prohibit the practice for those 57 + products. If such problems arise substantially in other domains, we 58 + stand ready to extend this provision to those domains in future versions 59 + of the GPL, as needed to protect the freedom of users. 60 + 61 + Finally, every program is threatened constantly by software patents. 62 + States should not allow patents to restrict development and use of 63 + software on general-purpose computers, but in those that do, we wish to 64 + avoid the special danger that patents applied to a free program could 65 + make it effectively proprietary. To prevent this, the GPL assures that 66 + patents cannot be used to render the program non-free. 67 + 68 + The precise terms and conditions for copying, distribution and 69 + modification follow. 70 + 71 + TERMS AND CONDITIONS 72 + 73 + 0. Definitions. 74 + 75 + "This License" refers to version 3 of the GNU General Public License. 76 + 77 + "Copyright" also means copyright-like laws that apply to other kinds of 78 + works, such as semiconductor masks. 79 + 80 + "The Program" refers to any copyrightable work licensed under this 81 + License. Each licensee is addressed as "you". "Licensees" and 82 + "recipients" may be individuals or organizations. 83 + 84 + To "modify" a work means to copy from or adapt all or part of the work 85 + in a fashion requiring copyright permission, other than the making of an 86 + exact copy. The resulting work is called a "modified version" of the 87 + earlier work or a work "based on" the earlier work. 88 + 89 + A "covered work" means either the unmodified Program or a work based 90 + on the Program. 91 + 92 + To "propagate" a work means to do anything with it that, without 93 + permission, would make you directly or secondarily liable for 94 + infringement under applicable copyright law, except executing it on a 95 + computer or modifying a private copy. Propagation includes copying, 96 + distribution (with or without modification), making available to the 97 + public, and in some countries other activities as well. 98 + 99 + To "convey" a work means any kind of propagation that enables other 100 + parties to make or receive copies. Mere interaction with a user through 101 + a computer network, with no transfer of a copy, is not conveying. 102 + 103 + An interactive user interface displays "Appropriate Legal Notices" 104 + to the extent that it includes a convenient and prominently visible 105 + feature that (1) displays an appropriate copyright notice, and (2) 106 + tells the user that there is no warranty for the work (except to the 107 + extent that warranties are provided), that licensees may convey the 108 + work under this License, and how to view a copy of this License. If 109 + the interface presents a list of user commands or options, such as a 110 + menu, a prominent item in the list meets this criterion. 111 + 112 + 1. Source Code. 113 + 114 + The "source code" for a work means the preferred form of the work 115 + for making modifications to it. "Object code" means any non-source 116 + form of a work. 117 + 118 + A "Standard Interface" means an interface that either is an official 119 + standard defined by a recognized standards body, or, in the case of 120 + interfaces specified for a particular programming language, one that 121 + is widely used among developers working in that language. 122 + 123 + The "System Libraries" of an executable work include anything, other 124 + than the work as a whole, that (a) is included in the normal form of 125 + packaging a Major Component, but which is not part of that Major 126 + Component, and (b) serves only to enable use of the work with that 127 + Major Component, or to implement a Standard Interface for which an 128 + implementation is available to the public in source code form. A 129 + "Major Component", in this context, means a major essential component 130 + (kernel, window system, and so on) of the specific operating system 131 + (if any) on which the executable work runs, or a compiler used to 132 + produce the work, or an object code interpreter used to run it. 133 + 134 + The "Corresponding Source" for a work in object code form means all 135 + the source code needed to generate, install, and (for an executable 136 + work) run the object code and to modify the work, including scripts to 137 + control those activities. However, it does not include the work's 138 + System Libraries, or general-purpose tools or generally available free 139 + programs which are used unmodified in performing those activities but 140 + which are not part of the work. For example, Corresponding Source 141 + includes interface definition files associated with source files for 142 + the work, and the source code for shared libraries and dynamically 143 + linked subprograms that the work is specifically designed to require, 144 + such as by intimate data communication or control flow between those 145 + subprograms and other parts of the work. 146 + 147 + The Corresponding Source need not include anything that users 148 + can regenerate automatically from other parts of the Corresponding 149 + Source. 150 + 151 + The Corresponding Source for a work in source code form is that 152 + same work. 153 + 154 + 2. Basic Permissions. 155 + 156 + All rights granted under this License are granted for the term of 157 + copyright on the Program, and are irrevocable provided the stated 158 + conditions are met. This License explicitly affirms your unlimited 159 + permission to run the unmodified Program. The output from running a 160 + covered work is covered by this License only if the output, given its 161 + content, constitutes a covered work. This License acknowledges your 162 + rights of fair use or other equivalent, as provided by copyright law. 163 + 164 + You may make, run and propagate covered works that you do not 165 + convey, without conditions so long as your license otherwise remains 166 + in force. You may convey covered works to others for the sole purpose 167 + of having them make modifications exclusively for you, or provide you 168 + with facilities for running those works, provided that you comply with 169 + the terms of this License in conveying all material for which you do 170 + not control copyright. Those thus making or running the covered works 171 + for you must do so exclusively on your behalf, under your direction 172 + and control, on terms that prohibit them from making any copies of 173 + your copyrighted material outside their relationship with you. 174 + 175 + Conveying under any other circumstances is permitted solely under 176 + the conditions stated below. Sublicensing is not allowed; section 10 177 + makes it unnecessary. 178 + 179 + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 + 181 + No covered work shall be deemed part of an effective technological 182 + measure under any applicable law fulfilling obligations under article 183 + 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 + similar laws prohibiting or restricting circumvention of such 185 + measures. 186 + 187 + When you convey a covered work, you waive any legal power to forbid 188 + circumvention of technological measures to the extent such circumvention 189 + is effected by exercising rights under this License with respect to 190 + the covered work, and you disclaim any intention to limit operation or 191 + modification of the work as a means of enforcing, against the work's 192 + users, your or third parties' legal rights to forbid circumvention of 193 + technological measures. 194 + 195 + 4. Conveying Verbatim Copies. 196 + 197 + You may convey verbatim copies of the Program's source code as you 198 + receive it, in any medium, provided that you conspicuously and 199 + appropriately publish on each copy an appropriate copyright notice; 200 + keep intact all notices stating that this License and any 201 + non-permissive terms added in accord with section 7 apply to the code; 202 + keep intact all notices of the absence of any warranty; and give all 203 + recipients a copy of this License along with the Program. 204 + 205 + You may charge any price or no price for each copy that you convey, 206 + and you may offer support or warranty protection for a fee. 207 + 208 + 5. Conveying Modified Source Versions. 209 + 210 + You may convey a work based on the Program, or the modifications to 211 + produce it from the Program, in the form of source code under the 212 + terms of section 4, provided that you also meet all of these conditions: 213 + 214 + a) The work must carry prominent notices stating that you modified 215 + it, and giving a relevant date. 216 + 217 + b) The work must carry prominent notices stating that it is 218 + released under this License and any conditions added under section 219 + 7. This requirement modifies the requirement in section 4 to 220 + "keep intact all notices". 221 + 222 + c) You must license the entire work, as a whole, under this 223 + License to anyone who comes into possession of a copy. This 224 + License will therefore apply, along with any applicable section 7 225 + additional terms, to the whole of the work, and all its parts, 226 + regardless of how they are packaged. This License gives no 227 + permission to license the work in any other way, but it does not 228 + invalidate such permission if you have separately received it. 229 + 230 + d) If the work has interactive user interfaces, each must display 231 + Appropriate Legal Notices; however, if the Program has interactive 232 + interfaces that do not display Appropriate Legal Notices, your 233 + work need not make them do so. 234 + 235 + A compilation of a covered work with other separate and independent 236 + works, which are not by their nature extensions of the covered work, 237 + and which are not combined with it such as to form a larger program, 238 + in or on a volume of a storage or distribution medium, is called an 239 + "aggregate" if the compilation and its resulting copyright are not 240 + used to limit the access or legal rights of the compilation's users 241 + beyond what the individual works permit. Inclusion of a covered work 242 + in an aggregate does not cause this License to apply to the other 243 + parts of the aggregate. 244 + 245 + 6. Conveying Non-Source Forms. 246 + 247 + You may convey a covered work in object code form under the terms 248 + of sections 4 and 5, provided that you also convey the 249 + machine-readable Corresponding Source under the terms of this License, 250 + in one of these ways: 251 + 252 + a) Convey the object code in, or embodied in, a physical product 253 + (including a physical distribution medium), accompanied by the 254 + Corresponding Source fixed on a durable physical medium 255 + customarily used for software interchange. 256 + 257 + b) Convey the object code in, or embodied in, a physical product 258 + (including a physical distribution medium), accompanied by a 259 + written offer, valid for at least three years and valid for as 260 + long as you offer spare parts or customer support for that product 261 + model, to give anyone who possesses the object code either (1) a 262 + copy of the Corresponding Source for all the software in the 263 + product that is covered by this License, on a durable physical 264 + medium customarily used for software interchange, for a price no 265 + more than your reasonable cost of physically performing this 266 + conveying of source, or (2) access to copy the 267 + Corresponding Source from a network server at no charge. 268 + 269 + c) Convey individual copies of the object code with a copy of the 270 + written offer to provide the Corresponding Source. This 271 + alternative is allowed only occasionally and noncommercially, and 272 + only if you received the object code with such an offer, in accord 273 + with subsection 6b. 274 + 275 + d) Convey the object code by offering access from a designated 276 + place (gratis or for a charge), and offer equivalent access to the 277 + Corresponding Source in the same way through the same place at no 278 + further charge. You need not require recipients to copy the 279 + Corresponding Source along with the object code. If the place to 280 + copy the object code is a network server, the Corresponding Source 281 + may be on a different server (operated by you or a third party) 282 + that supports equivalent copying facilities, provided you maintain 283 + clear directions next to the object code saying where to find the 284 + Corresponding Source. Regardless of what server hosts the 285 + Corresponding Source, you remain obligated to ensure that it is 286 + available for as long as needed to satisfy these requirements. 287 + 288 + e) Convey the object code using peer-to-peer transmission, provided 289 + you inform other peers where the object code and Corresponding 290 + Source of the work are being offered to the general public at no 291 + charge under subsection 6d. 292 + 293 + A separable portion of the object code, whose source code is excluded 294 + from the Corresponding Source as a System Library, need not be 295 + included in conveying the object code work. 296 + 297 + A "User Product" is either (1) a "consumer product", which means any 298 + tangible personal property which is normally used for personal, family, 299 + or household purposes, or (2) anything designed or sold for incorporation 300 + into a dwelling. In determining whether a product is a consumer product, 301 + doubtful cases shall be resolved in favor of coverage. For a particular 302 + product received by a particular user, "normally used" refers to a 303 + typical or common use of that class of product, regardless of the status 304 + of the particular user or of the way in which the particular user 305 + actually uses, or expects or is expected to use, the product. A product 306 + is a consumer product regardless of whether the product has substantial 307 + commercial, industrial or non-consumer uses, unless such uses represent 308 + the only significant mode of use of the product. 309 + 310 + "Installation Information" for a User Product means any methods, 311 + procedures, authorization keys, or other information required to install 312 + and execute modified versions of a covered work in that User Product from 313 + a modified version of its Corresponding Source. The information must 314 + suffice to ensure that the continued functioning of the modified object 315 + code is in no case prevented or interfered with solely because 316 + modification has been made. 317 + 318 + If you convey an object code work under this section in, or with, or 319 + specifically for use in, a User Product, and the conveying occurs as 320 + part of a transaction in which the right of possession and use of the 321 + User Product is transferred to the recipient in perpetuity or for a 322 + fixed term (regardless of how the transaction is characterized), the 323 + Corresponding Source conveyed under this section must be accompanied 324 + by the Installation Information. But this requirement does not apply 325 + if neither you nor any third party retains the ability to install 326 + modified object code on the User Product (for example, the work has 327 + been installed in ROM). 328 + 329 + The requirement to provide Installation Information does not include a 330 + requirement to continue to provide support service, warranty, or updates 331 + for a work that has been modified or installed by the recipient, or for 332 + the User Product in which it has been modified or installed. Access to a 333 + network may be denied when the modification itself materially and 334 + adversely affects the operation of the network or violates the rules and 335 + protocols for communication across the network. 336 + 337 + Corresponding Source conveyed, and Installation Information provided, 338 + in accord with this section must be in a format that is publicly 339 + documented (and with an implementation available to the public in 340 + source code form), and must require no special password or key for 341 + unpacking, reading or copying. 342 + 343 + 7. Additional Terms. 344 + 345 + "Additional permissions" are terms that supplement the terms of this 346 + License by making exceptions from one or more of its conditions. 347 + Additional permissions that are applicable to the entire Program shall 348 + be treated as though they were included in this License, to the extent 349 + that they are valid under applicable law. If additional permissions 350 + apply only to part of the Program, that part may be used separately 351 + under those permissions, but the entire Program remains governed by 352 + this License without regard to the additional permissions. 353 + 354 + When you convey a copy of a covered work, you may at your option 355 + remove any additional permissions from that copy, or from any part of 356 + it. (Additional permissions may be written to require their own 357 + removal in certain cases when you modify the work.) You may place 358 + additional permissions on material, added by you to a covered work, 359 + for which you have or can give appropriate copyright permission. 360 + 361 + Notwithstanding any other provision of this License, for material you 362 + add to a covered work, you may (if authorized by the copyright holders of 363 + that material) supplement the terms of this License with terms: 364 + 365 + a) Disclaiming warranty or limiting liability differently from the 366 + terms of sections 15 and 16 of this License; or 367 + 368 + b) Requiring preservation of specified reasonable legal notices or 369 + author attributions in that material or in the Appropriate Legal 370 + Notices displayed by works containing it; or 371 + 372 + c) Prohibiting misrepresentation of the origin of that material, or 373 + requiring that modified versions of such material be marked in 374 + reasonable ways as different from the original version; or 375 + 376 + d) Limiting the use for publicity purposes of names of licensors or 377 + authors of the material; or 378 + 379 + e) Declining to grant rights under trademark law for use of some 380 + trade names, trademarks, or service marks; or 381 + 382 + f) Requiring indemnification of licensors and authors of that 383 + material by anyone who conveys the material (or modified versions of 384 + it) with contractual assumptions of liability to the recipient, for 385 + any liability that these contractual assumptions directly impose on 386 + those licensors and authors. 387 + 388 + All other non-permissive additional terms are considered "further 389 + restrictions" within the meaning of section 10. If the Program as you 390 + received it, or any part of it, contains a notice stating that it is 391 + governed by this License along with a term that is a further 392 + restriction, you may remove that term. If a license document contains 393 + a further restriction but permits relicensing or conveying under this 394 + License, you may add to a covered work material governed by the terms 395 + of that license document, provided that the further restriction does 396 + not survive such relicensing or conveying. 397 + 398 + If you add terms to a covered work in accord with this section, you 399 + must place, in the relevant source files, a statement of the 400 + additional terms that apply to those files, or a notice indicating 401 + where to find the applicable terms. 402 + 403 + Additional terms, permissive or non-permissive, may be stated in the 404 + form of a separately written license, or stated as exceptions; 405 + the above requirements apply either way. 406 + 407 + 8. Termination. 408 + 409 + You may not propagate or modify a covered work except as expressly 410 + provided under this License. Any attempt otherwise to propagate or 411 + modify it is void, and will automatically terminate your rights under 412 + this License (including any patent licenses granted under the third 413 + paragraph of section 11). 414 + 415 + However, if you cease all violation of this License, then your 416 + license from a particular copyright holder is reinstated (a) 417 + provisionally, unless and until the copyright holder explicitly and 418 + finally terminates your license, and (b) permanently, if the copyright 419 + holder fails to notify you of the violation by some reasonable means 420 + prior to 60 days after the cessation. 421 + 422 + Moreover, your license from a particular copyright holder is 423 + reinstated permanently if the copyright holder notifies you of the 424 + violation by some reasonable means, this is the first time you have 425 + received notice of violation of this License (for any work) from that 426 + copyright holder, and you cure the violation prior to 30 days after 427 + your receipt of the notice. 428 + 429 + Termination of your rights under this section does not terminate the 430 + licenses of parties who have received copies or rights from you under 431 + this License. If your rights have been terminated and not permanently 432 + reinstated, you do not qualify to receive new licenses for the same 433 + material under section 10. 434 + 435 + 9. Acceptance Not Required for Having Copies. 436 + 437 + You are not required to accept this License in order to receive or 438 + run a copy of the Program. Ancillary propagation of a covered work 439 + occurring solely as a consequence of using peer-to-peer transmission 440 + to receive a copy likewise does not require acceptance. However, 441 + nothing other than this License grants you permission to propagate or 442 + modify any covered work. These actions infringe copyright if you do 443 + not accept this License. Therefore, by modifying or propagating a 444 + covered work, you indicate your acceptance of this License to do so. 445 + 446 + 10. Automatic Licensing of Downstream Recipients. 447 + 448 + Each time you convey a covered work, the recipient automatically 449 + receives a license from the original licensors, to run, modify and 450 + propagate that work, subject to this License. You are not responsible 451 + for enforcing compliance by third parties with this License. 452 + 453 + An "entity transaction" is a transaction transferring control of an 454 + organization, or substantially all assets of one, or subdividing an 455 + organization, or merging organizations. If propagation of a covered 456 + work results from an entity transaction, each party to that 457 + transaction who receives a copy of the work also receives whatever 458 + licenses to the work the party's predecessor in interest had or could 459 + give under the previous paragraph, plus a right to possession of the 460 + Corresponding Source of the work from the predecessor in interest, if 461 + the predecessor has it or can get it with reasonable efforts. 462 + 463 + You may not impose any further restrictions on the exercise of the 464 + rights granted or affirmed under this License. For example, you may 465 + not impose a license fee, royalty, or other charge for exercise of 466 + rights granted under this License, and you may not initiate litigation 467 + (including a cross-claim or counterclaim in a lawsuit) alleging that 468 + any patent claim is infringed by making, using, selling, offering for 469 + sale, or importing the Program or any portion of it. 470 + 471 + 11. Patents. 472 + 473 + A "contributor" is a copyright holder who authorizes use under this 474 + License of the Program or a work on which the Program is based. The 475 + work thus licensed is called the contributor's "contributor version". 476 + 477 + A contributor's "essential patent claims" are all patent claims 478 + owned or controlled by the contributor, whether already acquired or 479 + hereafter acquired, that would be infringed by some manner, permitted 480 + by this License, of making, using, or selling its contributor version, 481 + but do not include claims that would be infringed only as a 482 + consequence of further modification of the contributor version. For 483 + purposes of this definition, "control" includes the right to grant 484 + patent sublicenses in a manner consistent with the requirements of 485 + this License. 486 + 487 + Each contributor grants you a non-exclusive, worldwide, royalty-free 488 + patent license under the contributor's essential patent claims, to 489 + make, use, sell, offer for sale, import and otherwise run, modify and 490 + propagate the contents of its contributor version. 491 + 492 + In the following three paragraphs, a "patent license" is any express 493 + agreement or commitment, however denominated, not to enforce a patent 494 + (such as an express permission to practice a patent or covenant not to 495 + sue for patent infringement). To "grant" such a patent license to a 496 + party means to make such an agreement or commitment not to enforce a 497 + patent against the party. 498 + 499 + If you convey a covered work, knowingly relying on a patent license, 500 + and the Corresponding Source of the work is not available for anyone 501 + to copy, free of charge and under the terms of this License, through a 502 + publicly available network server or other readily accessible means, 503 + then you must either (1) cause the Corresponding Source to be so 504 + available, or (2) arrange to deprive yourself of the benefit of the 505 + patent license for this particular work, or (3) arrange, in a manner 506 + consistent with the requirements of this License, to extend the patent 507 + license to downstream recipients. "Knowingly relying" means you have 508 + actual knowledge that, but for the patent license, your conveying the 509 + covered work in a country, or your recipient's use of the covered work 510 + in a country, would infringe one or more identifiable patents in that 511 + country that you have reason to believe are valid. 512 + 513 + If, pursuant to or in connection with a single transaction or 514 + arrangement, you convey, or propagate by procuring conveyance of, a 515 + covered work, and grant a patent license to some of the parties 516 + receiving the covered work authorizing them to use, propagate, modify 517 + or convey a specific copy of the covered work, then the patent license 518 + you grant is automatically extended to all recipients of the covered 519 + work and works based on it. 520 + 521 + A patent license is "discriminatory" if it does not include within 522 + the scope of its coverage, prohibits the exercise of, or is 523 + conditioned on the non-exercise of one or more of the rights that are 524 + specifically granted under this License. You may not convey a covered 525 + work if you are a party to an arrangement with a third party that is 526 + in the business of distributing software, under which you make payment 527 + to the third party based on the extent of your activity of conveying 528 + the work, and under which the third party grants, to any of the 529 + parties who would receive the covered work from you, a discriminatory 530 + patent license (a) in connection with copies of the covered work 531 + conveyed by you (or copies made from those copies), or (b) primarily 532 + for and in connection with specific products or compilations that 533 + contain the covered work, unless you entered into that arrangement, 534 + or that patent license was granted, prior to 28 March 2007. 535 + 536 + Nothing in this License shall be construed as excluding or limiting 537 + any implied license or other defenses to infringement that may 538 + otherwise be available to you under applicable patent law. 539 + 540 + 12. No Surrender of Others' Freedom. 541 + 542 + If conditions are imposed on you (whether by court order, agreement or 543 + otherwise) that contradict the conditions of this License, they do not 544 + excuse you from the conditions of this License. If you cannot convey a 545 + covered work so as to satisfy simultaneously your obligations under this 546 + License and any other pertinent obligations, then as a consequence you may 547 + not convey it at all. For example, if you agree to terms that obligate you 548 + to collect a royalty for further conveying from those to whom you convey 549 + the Program, the only way you could satisfy both those terms and this 550 + License would be to refrain entirely from conveying the Program. 551 + 552 + 13. Use with the GNU Affero General Public License. 553 + 554 + Notwithstanding any other provision of this License, you have 555 + permission to link or combine any covered work with a work licensed 556 + under version 3 of the GNU Affero General Public License into a single 557 + combined work, and to convey the resulting work. The terms of this 558 + License will continue to apply to the part which is the covered work, 559 + but the special requirements of the GNU Affero General Public License, 560 + section 13, concerning interaction through a network will apply to the 561 + combination as such. 562 + 563 + 14. Revised Versions of this License. 564 + 565 + The Free Software Foundation may publish revised and/or new versions of 566 + the GNU General Public License from time to time. Such new versions will 567 + be similar in spirit to the present version, but may differ in detail to 568 + address new problems or concerns. 569 + 570 + Each version is given a distinguishing version number. If the 571 + Program specifies that a certain numbered version of the GNU General 572 + Public License "or any later version" applies to it, you have the 573 + option of following the terms and conditions either of that numbered 574 + version or of any later version published by the Free Software 575 + Foundation. If the Program does not specify a version number of the 576 + GNU General Public License, you may choose any version ever published 577 + by the Free Software Foundation. 578 + 579 + If the Program specifies that a proxy can decide which future 580 + versions of the GNU General Public License can be used, that proxy's 581 + public statement of acceptance of a version permanently authorizes you 582 + to choose that version for the Program. 583 + 584 + Later license versions may give you additional or different 585 + permissions. However, no additional obligations are imposed on any 586 + author or copyright holder as a result of your choosing to follow a 587 + later version. 588 + 589 + 15. Disclaimer of Warranty. 590 + 591 + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 + OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 + PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 + IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 + ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 + 600 + 16. Limitation of Liability. 601 + 602 + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 + WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 + THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 + GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 + USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 + DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 + EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 + SUCH DAMAGES. 611 + 612 + 17. Interpretation of Sections 15 and 16. 613 + 614 + If the disclaimer of warranty and limitation of liability provided 615 + above cannot be given local legal effect according to their terms, 616 + reviewing courts shall apply local law that most closely approximates 617 + an absolute waiver of all civil liability in connection with the 618 + Program, unless a warranty or assumption of liability accompanies a 619 + copy of the Program in return for a fee. 620 + 621 + END OF TERMS AND CONDITIONS 622 + 623 + How to Apply These Terms to Your New Programs 624 + 625 + If you develop a new program, and you want it to be of the greatest 626 + possible use to the public, the best way to achieve this is to make it 627 + free software which everyone can redistribute and change under these terms. 628 + 629 + To do so, attach the following notices to the program. It is safest 630 + to attach them to the start of each source file to most effectively 631 + state the exclusion of warranty; and each file should have at least 632 + the "copyright" line and a pointer to where the full notice is found. 633 + 634 + <one line to give the program's name and a brief idea of what it does.> 635 + Copyright (C) <year> <name of author> 636 + 637 + This program is free software: you can redistribute it and/or modify 638 + it under the terms of the GNU General Public License as published by 639 + the Free Software Foundation, either version 3 of the License, or 640 + (at your option) any later version. 641 + 642 + This program is distributed in the hope that it will be useful, 643 + but WITHOUT ANY WARRANTY; without even the implied warranty of 644 + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 + GNU General Public License for more details. 646 + 647 + You should have received a copy of the GNU General Public License 648 + along with this program. If not, see <https://www.gnu.org/licenses/>. 649 + 650 + Also add information on how to contact you by electronic and paper mail. 651 + 652 + If the program does terminal interaction, make it output a short 653 + notice like this when it starts in an interactive mode: 654 + 655 + <program> Copyright (C) <year> <name of author> 656 + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 + This is free software, and you are welcome to redistribute it 658 + under certain conditions; type `show c' for details. 659 + 660 + The hypothetical commands `show w' and `show c' should show the appropriate 661 + parts of the General Public License. Of course, your program's commands 662 + might be different; for a GUI interface, you would use an "about box". 663 + 664 + You should also get your employer (if you work as a programmer) or school, 665 + if any, to sign a "copyright disclaimer" for the program, if necessary. 666 + For more information on this, and how to apply and follow the GNU GPL, see 667 + <https://www.gnu.org/licenses/>. 668 + 669 + The GNU General Public License does not permit incorporating your program 670 + into proprietary programs. If your program is a subroutine library, you 671 + may consider it more useful to permit linking proprietary applications with 672 + the library. If this is what you want to do, use the GNU Lesser General 673 + Public License instead of this License. But first, please read 674 + <https://www.gnu.org/licenses/why-not-lgpl.html>.
+165
COPYING.LESSER
··· 1 + GNU LESSER GENERAL PUBLIC LICENSE 2 + Version 3, 29 June 2007 3 + 4 + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> 5 + Everyone is permitted to copy and distribute verbatim copies 6 + of this license document, but changing it is not allowed. 7 + 8 + 9 + This version of the GNU Lesser General Public License incorporates 10 + the terms and conditions of version 3 of the GNU General Public 11 + License, supplemented by the additional permissions listed below. 12 + 13 + 0. Additional Definitions. 14 + 15 + As used herein, "this License" refers to version 3 of the GNU Lesser 16 + General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 + General Public License. 18 + 19 + "The Library" refers to a covered work governed by this License, 20 + other than an Application or a Combined Work as defined below. 21 + 22 + An "Application" is any work that makes use of an interface provided 23 + by the Library, but which is not otherwise based on the Library. 24 + Defining a subclass of a class defined by the Library is deemed a mode 25 + of using an interface provided by the Library. 26 + 27 + A "Combined Work" is a work produced by combining or linking an 28 + Application with the Library. The particular version of the Library 29 + with which the Combined Work was made is also called the "Linked 30 + Version". 31 + 32 + The "Minimal Corresponding Source" for a Combined Work means the 33 + Corresponding Source for the Combined Work, excluding any source code 34 + for portions of the Combined Work that, considered in isolation, are 35 + based on the Application, and not on the Linked Version. 36 + 37 + The "Corresponding Application Code" for a Combined Work means the 38 + object code and/or source code for the Application, including any data 39 + and utility programs needed for reproducing the Combined Work from the 40 + Application, but excluding the System Libraries of the Combined Work. 41 + 42 + 1. Exception to Section 3 of the GNU GPL. 43 + 44 + You may convey a covered work under sections 3 and 4 of this License 45 + without being bound by section 3 of the GNU GPL. 46 + 47 + 2. Conveying Modified Versions. 48 + 49 + If you modify a copy of the Library, and, in your modifications, a 50 + facility refers to a function or data to be supplied by an Application 51 + that uses the facility (other than as an argument passed when the 52 + facility is invoked), then you may convey a copy of the modified 53 + version: 54 + 55 + a) under this License, provided that you make a good faith effort to 56 + ensure that, in the event an Application does not supply the 57 + function or data, the facility still operates, and performs 58 + whatever part of its purpose remains meaningful, or 59 + 60 + b) under the GNU GPL, with none of the additional permissions of 61 + this License applicable to that copy. 62 + 63 + 3. Object Code Incorporating Material from Library Header Files. 64 + 65 + The object code form of an Application may incorporate material from 66 + a header file that is part of the Library. You may convey such object 67 + code under terms of your choice, provided that, if the incorporated 68 + material is not limited to numerical parameters, data structure 69 + layouts and accessors, or small macros, inline functions and templates 70 + (ten or fewer lines in length), you do both of the following: 71 + 72 + a) Give prominent notice with each copy of the object code that the 73 + Library is used in it and that the Library and its use are 74 + covered by this License. 75 + 76 + b) Accompany the object code with a copy of the GNU GPL and this license 77 + document. 78 + 79 + 4. Combined Works. 80 + 81 + You may convey a Combined Work under terms of your choice that, 82 + taken together, effectively do not restrict modification of the 83 + portions of the Library contained in the Combined Work and reverse 84 + engineering for debugging such modifications, if you also do each of 85 + the following: 86 + 87 + a) Give prominent notice with each copy of the Combined Work that 88 + the Library is used in it and that the Library and its use are 89 + covered by this License. 90 + 91 + b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 + document. 93 + 94 + c) For a Combined Work that displays copyright notices during 95 + execution, include the copyright notice for the Library among 96 + these notices, as well as a reference directing the user to the 97 + copies of the GNU GPL and this license document. 98 + 99 + d) Do one of the following: 100 + 101 + 0) Convey the Minimal Corresponding Source under the terms of this 102 + License, and the Corresponding Application Code in a form 103 + suitable for, and under terms that permit, the user to 104 + recombine or relink the Application with a modified version of 105 + the Linked Version to produce a modified Combined Work, in the 106 + manner specified by section 6 of the GNU GPL for conveying 107 + Corresponding Source. 108 + 109 + 1) Use a suitable shared library mechanism for linking with the 110 + Library. A suitable mechanism is one that (a) uses at run time 111 + a copy of the Library already present on the user's computer 112 + system, and (b) will operate properly with a modified version 113 + of the Library that is interface-compatible with the Linked 114 + Version. 115 + 116 + e) Provide Installation Information, but only if you would otherwise 117 + be required to provide such information under section 6 of the 118 + GNU GPL, and only to the extent that such information is 119 + necessary to install and execute a modified version of the 120 + Combined Work produced by recombining or relinking the 121 + Application with a modified version of the Linked Version. (If 122 + you use option 4d0, the Installation Information must accompany 123 + the Minimal Corresponding Source and Corresponding Application 124 + Code. If you use option 4d1, you must provide the Installation 125 + Information in the manner specified by section 6 of the GNU GPL 126 + for conveying Corresponding Source.) 127 + 128 + 5. Combined Libraries. 129 + 130 + You may place library facilities that are a work based on the 131 + Library side by side in a single library together with other library 132 + facilities that are not Applications and are not covered by this 133 + License, and convey such a combined library under terms of your 134 + choice, if you do both of the following: 135 + 136 + a) Accompany the combined library with a copy of the same work based 137 + on the Library, uncombined with any other library facilities, 138 + conveyed under the terms of this License. 139 + 140 + b) Give prominent notice with the combined library that part of it 141 + is a work based on the Library, and explaining where to find the 142 + accompanying uncombined form of the same work. 143 + 144 + 6. Revised Versions of the GNU Lesser General Public License. 145 + 146 + The Free Software Foundation may publish revised and/or new versions 147 + of the GNU Lesser General Public License from time to time. Such new 148 + versions will be similar in spirit to the present version, but may 149 + differ in detail to address new problems or concerns. 150 + 151 + Each version is given a distinguishing version number. If the 152 + Library as you received it specifies that a certain numbered version 153 + of the GNU Lesser General Public License "or any later version" 154 + applies to it, you have the option of following the terms and 155 + conditions either of that published version or of any later version 156 + published by the Free Software Foundation. If the Library as you 157 + received it does not specify a version number of the GNU Lesser 158 + General Public License, you may choose any version of the GNU Lesser 159 + General Public License ever published by the Free Software Foundation. 160 + 161 + If the Library as you received it specifies that a proxy can decide 162 + whether future versions of the GNU Lesser General Public License shall 163 + apply, that proxy's public statement of acceptance of any version is 164 + permanent authorization for you to choose that version for the 165 + Library.
+5
Makefile
··· 1 + main: include/textstore.h src/textstore.c example/main.c 2 + cc -Iinclude/ -Wall -pedantic example/main.c src/textstore.c -o main 3 + 4 + cleanup: 5 + rm main
+3
README.md
··· 1 + # textstore 2 + 3 + A data structure for storing reference-counted, de-duplicated strings for access by other structures.
+94
example/main.c
··· 1 + /** 2 + * Runs a tests to make sure the text-store works. 3 + */ 4 + 5 + #include <stdio.h> 6 + #include <string.h> 7 + #include <textstore.h> 8 + 9 + int main(int argc, char **argv) { 10 + textstore_t store; 11 + if(textstore_init(&store, 64)) { 12 + fprintf(stderr, "ERROR: textstore_init() failed.\n"); 13 + return 1; 14 + } 15 + 16 + // A reference counted string handle. 17 + char *handle1_expected = "Hello world!"; 18 + textstore_handle handle1 = textstore_intern(&store, handle1_expected); 19 + if (strcmp(textstore_string(&store, handle1), handle1_expected) != 0) { 20 + fprintf(stderr, "ERROR: handle1 does not equal \"%s\"\n", handle1_expected); 21 + return 1; 22 + } 23 + 24 + char *handle2_expected = "A different string!"; 25 + textstore_handle handle2 = textstore_intern(&store, handle2_expected); 26 + if (strcmp(textstore_string(&store, handle2), handle2_expected)) { 27 + fprintf(stderr, "ERROR: handle2 does not equal \"%s\"\n", handle2_expected); 28 + return 1; 29 + } 30 + 31 + // A handle may become invalidated after all references to it are released. 32 + textstore_release(&store, handle1); 33 + if (textstore_gc(&store) != 0) { 34 + fprintf(stderr, "ERROR: Garbage collector failed.\n"); 35 + return 1; 36 + } 37 + 38 + // Trying to get the data of an inactive handle should return null. 39 + char *invalid_string = textstore_string(&store, handle1); 40 + if (invalid_string != NULL) { 41 + fprintf(stderr, "ERROR: handle1 should be null, but isn't: \"%s\"\n", invalid_string); 42 + return 1; 43 + } 44 + 45 + // Interning new strings may re-use previously gc'd handle indexes. 46 + // But they are not equal due to their cycle bits. 47 + textstore_handle handle3 = textstore_intern(&store, "Hello world."); 48 + if (handle1 == handle3) { 49 + fprintf(stderr, "ERROR: handle1 and handle3 should not be equal.\n"); 50 + return 1; 51 + } 52 + 53 + // And trying to access a previously gc'd handle will still return an error, 54 + // even if its index is in use. 55 + invalid_string = textstore_string(&store, handle1); 56 + if (invalid_string != NULL) { 57 + fprintf(stderr, "ERROR: handle1 should be null, but isn't: \"%s\"\n", invalid_string); 58 + return 1; 59 + } 60 + 61 + // Likewise, interning the same string will result in identical handles. 62 + textstore_handle handle4 = textstore_intern(&store, "Hello world."); 63 + if (handle3 != handle4) { 64 + fprintf(stderr, "ERROR: handle3 and handle4 should be equal.\n"); 65 + return 1; 66 + } 67 + 68 + { 69 + textstore_handle temp_handle; 70 + temp_handle = textstore_intern(&store, "blah blah"); 71 + textstore_release(&store, temp_handle); 72 + temp_handle = textstore_intern(&store, "random text"); 73 + textstore_release(&store, temp_handle); 74 + temp_handle = textstore_intern(&store, "text"); 75 + textstore_release(&store, temp_handle); 76 + temp_handle = textstore_intern(&store, "random text2"); 77 + textstore_release(&store, temp_handle); 78 + } 79 + 80 + textstore_handle handle5 = textstore_intern(&store, "All your bases..."); 81 + textstore_gc(&store); 82 + // Even after a GC and the underlying text being invalidated and shifted 83 + // about, valid handles can still be used. 84 + if (strcmp(textstore_string(&store, handle5), "All your bases...") != 0) { 85 + fprintf(stderr, "ERROR: handle5 is wrong? \"%s\"\n", textstore_string(&store, handle5)); 86 + return 1; 87 + } 88 + 89 + textstore_free(&store); 90 + 91 + printf("All tests passed.\n"); 92 + return 0; 93 + } 94 +
+113
include/textstore.h
··· 1 + /* text-store - A store for storing reference-counted, de-duplicated strings. 2 + * Copyright (C) 2025 Jeremia Dominguez <me@jeremia.dev> 3 + * 4 + * This program is free software: you can redistribute it and/or modify 5 + * it under the terms of the GNU General Public License as published by 6 + * the Free Software Foundation, either version 3 of the License, or 7 + * (at your option) any later version. 8 + * 9 + * This program is distributed in the hope that it will be useful, 10 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 + * GNU General Public License for more details. 13 + * 14 + * You should have received a copy of the GNU General Public License 15 + * along with this program. If not, see <https://www.gnu.org/licenses/>. 16 + */ 17 + 18 + 19 + #ifndef TEXTSTORE_H 20 + #define TEXTSTORE_H 21 + 22 + #include <assert.h> 23 + #include <stdbool.h> 24 + #include <stddef.h> 25 + #include <stdint.h> 26 + 27 + /** 28 + * A handle used to reference a string within the text store. 29 + */ 30 + typedef uint64_t textstore_handle; 31 + #define TEXTSTORE_HANDLE_ERROR UINT64_MAX 32 + 33 + typedef struct { 34 + uint32_t offset; 35 + uint32_t len; 36 + } textstore_slice; 37 + 38 + /** 39 + * A store containing all string data. 40 + */ 41 + typedef struct textstore_t { 42 + char *buffer; /* Buffer of all allocated text. 43 + Pointers to this buffer are considered volatile. */ 44 + uint32_t length; /* Length of currently used buffer. */ 45 + uint32_t buffer_cap; /* The current capacity of the buffer. */ 46 + uint32_t available; /* Count of available free handles. */ 47 + 48 + uint32_t *map; /* The hashmap's indexes into the tables below. */ 49 + textstore_slice *key; /* The slice a handle represents within the buffer */ 50 + uint32_t *ref; /* The reference counter for a given string. */ 51 + uint32_t *generation; /* The current/last active generation of a handle. */ 52 + bool *active; /* Whether the given handle is currently active. */ 53 + 54 + uint32_t count; /* The number of string entries. */ 55 + uint32_t capacity; /* The current capacity of the hashmap. */ 56 + } textstore_t; 57 + 58 + int textstore_init(textstore_t *store, uint32_t initial_buffer); 59 + void textstore_free(textstore_t *store); 60 + int textstore_gc(textstore_t *store); 61 + textstore_handle textstore_intern(textstore_t *store, char *str); 62 + textstore_handle textstore_intern_len(textstore_t *store, char *str, uint32_t len); 63 + 64 + static inline uint32_t textstore_as_index(textstore_handle handle) { 65 + return (uint32_t) (handle & 0xFFFFFFFF); 66 + } 67 + static inline uint32_t textstore_as_generation(textstore_handle handle) { 68 + return (uint32_t) (handle >> 32); 69 + } 70 + 71 + static inline char *textstore_string(textstore_t *store, textstore_handle handle) { 72 + textstore_t sstore = *store; 73 + uint32_t index = textstore_as_index(handle); 74 + if (index > sstore.count || !sstore.active[index]) return NULL; 75 + 76 + uint32_t generation = textstore_as_generation(handle); 77 + if (generation != sstore.generation[index]) return NULL; 78 + 79 + return sstore.buffer + sstore.key[index].offset; 80 + } 81 + 82 + static inline uint32_t textstore_length(textstore_t *store, textstore_handle handle) { 83 + textstore_t sstore = *store; 84 + uint32_t index = textstore_as_index(handle); 85 + if (index == 0 || index > sstore.count || !sstore.active[index]) return 0; 86 + 87 + uint32_t generation = textstore_as_generation(handle); 88 + if (generation != sstore.generation[index]) return 0; 89 + 90 + return sstore.key[index].len; 91 + } 92 + 93 + static inline void textstore_retain(textstore_t *store, textstore_handle handle) { 94 + uint32_t index = textstore_as_index(handle); 95 + assert(index < store->count); 96 + assert(store->active[index]); 97 + 98 + store->ref[index] += 1; 99 + } 100 + 101 + static inline void textstore_release(textstore_t *store, textstore_handle handle) { 102 + uint32_t index = textstore_as_index(handle); 103 + assert(index < store->count); 104 + assert(store->active[index]); 105 + 106 + // Avoid underflow. 107 + uint32_t ref = store->ref[index]; 108 + if (ref) { 109 + store->ref[index] = ref - 1; 110 + } 111 + } 112 + 113 + #endif // TEXTSTORE_H
+568
src/rapidhash.h
··· 1 + /* 2 + * rapidhash V3 - Very fast, high quality, platform-independent hashing algorithm. 3 + * 4 + * Based on 'wyhash', by Wang Yi <godspeed_china@yeah.net> 5 + * 6 + * Copyright (C) 2025 Nicolas De Carli 7 + * 8 + * Permission is hereby granted, free of charge, to any person obtaining a copy 9 + * of this software and associated documentation files (the "Software"), to deal 10 + * in the Software without restriction, including without limitation the rights 11 + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 12 + * copies of the Software, and to permit persons to whom the Software is 13 + * furnished to do so, subject to the following conditions: 14 + * 15 + * The above copyright notice and this permission notice shall be included in all 16 + * copies or substantial portions of the Software. 17 + * 18 + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19 + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20 + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 21 + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 22 + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 23 + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 24 + * SOFTWARE. 25 + * 26 + * You can contact the author at: 27 + * - rapidhash source repository: https://github.com/Nicoshev/rapidhash 28 + */ 29 + 30 + #pragma once 31 + 32 + /* 33 + * Includes. 34 + */ 35 + #include <stdint.h> 36 + #include <string.h> 37 + #if defined(_MSC_VER) 38 + # include <intrin.h> 39 + # if defined(_M_X64) && !defined(_M_ARM64EC) 40 + # pragma intrinsic(_umul128) 41 + # endif 42 + #endif 43 + 44 + /* 45 + * C/C++ macros. 46 + */ 47 + 48 + #ifdef _MSC_VER 49 + # define RAPIDHASH_ALWAYS_INLINE __forceinline 50 + #elif defined(__GNUC__) 51 + # define RAPIDHASH_ALWAYS_INLINE inline __attribute__((__always_inline__)) 52 + #else 53 + # define RAPIDHASH_ALWAYS_INLINE inline 54 + #endif 55 + 56 + #ifdef __cplusplus 57 + # define RAPIDHASH_NOEXCEPT noexcept 58 + # define RAPIDHASH_CONSTEXPR constexpr 59 + # ifndef RAPIDHASH_INLINE 60 + # define RAPIDHASH_INLINE RAPIDHASH_ALWAYS_INLINE 61 + # endif 62 + # if __cplusplus >= 201402L && !defined(_MSC_VER) 63 + # define RAPIDHASH_INLINE_CONSTEXPR RAPIDHASH_ALWAYS_INLINE constexpr 64 + # else 65 + # define RAPIDHASH_INLINE_CONSTEXPR RAPIDHASH_ALWAYS_INLINE 66 + # endif 67 + #else 68 + # define RAPIDHASH_NOEXCEPT 69 + # define RAPIDHASH_CONSTEXPR static const 70 + # ifndef RAPIDHASH_INLINE 71 + # define RAPIDHASH_INLINE static RAPIDHASH_ALWAYS_INLINE 72 + # endif 73 + # define RAPIDHASH_INLINE_CONSTEXPR RAPIDHASH_INLINE 74 + #endif 75 + 76 + /* 77 + * Unrolled macro. 78 + * Improves large input speed, but increases code size and worsens small input speed. 79 + * 80 + * RAPIDHASH_COMPACT: Normal behavior. 81 + * RAPIDHASH_UNROLLED: 82 + * 83 + */ 84 + #ifndef RAPIDHASH_UNROLLED 85 + # define RAPIDHASH_COMPACT 86 + #elif defined(RAPIDHASH_COMPACT) 87 + # error "cannot define RAPIDHASH_COMPACT and RAPIDHASH_UNROLLED simultaneously." 88 + #endif 89 + 90 + /* 91 + * Protection macro, alters behaviour of rapid_mum multiplication function. 92 + * 93 + * RAPIDHASH_FAST: Normal behavior, max speed. 94 + * RAPIDHASH_PROTECTED: Extra protection against entropy loss. 95 + */ 96 + #ifndef RAPIDHASH_PROTECTED 97 + # define RAPIDHASH_FAST 98 + #elif defined(RAPIDHASH_FAST) 99 + # error "cannot define RAPIDHASH_PROTECTED and RAPIDHASH_FAST simultaneously." 100 + #endif 101 + 102 + /* 103 + * Likely and unlikely macros. 104 + */ 105 + #if defined(__GNUC__) || defined(__INTEL_COMPILER) || defined(__clang__) 106 + # define _likely_(x) __builtin_expect(x,1) 107 + # define _unlikely_(x) __builtin_expect(x,0) 108 + #else 109 + # define _likely_(x) (x) 110 + # define _unlikely_(x) (x) 111 + #endif 112 + 113 + /* 114 + * Endianness macros. 115 + */ 116 + #ifndef RAPIDHASH_LITTLE_ENDIAN 117 + # if defined(_WIN32) || defined(__LITTLE_ENDIAN__) || (defined(__BYTE_ORDER__) && __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) 118 + # define RAPIDHASH_LITTLE_ENDIAN 119 + # elif defined(__BIG_ENDIAN__) || (defined(__BYTE_ORDER__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) 120 + # define RAPIDHASH_BIG_ENDIAN 121 + # else 122 + # warning "could not determine endianness! Falling back to little endian." 123 + # define RAPIDHASH_LITTLE_ENDIAN 124 + # endif 125 + #endif 126 + 127 + /* 128 + * Default secret parameters. 129 + */ 130 + RAPIDHASH_CONSTEXPR uint64_t rapid_secret[8] = { 131 + 0x2d358dccaa6c78a5ull, 132 + 0x8bb84b93962eacc9ull, 133 + 0x4b33a62ed433d4a3ull, 134 + 0x4d5a2da51de1aa47ull, 135 + 0xa0761d6478bd642full, 136 + 0xe7037ed1a0b428dbull, 137 + 0x90ed1765281c388cull, 138 + 0xaaaaaaaaaaaaaaaaull}; 139 + 140 + /* 141 + * 64*64 -> 128bit multiply function. 142 + * 143 + * @param A Address of 64-bit number. 144 + * @param B Address of 64-bit number. 145 + * 146 + * Calculates 128-bit C = *A * *B. 147 + * 148 + * When RAPIDHASH_FAST is defined: 149 + * Overwrites A contents with C's low 64 bits. 150 + * Overwrites B contents with C's high 64 bits. 151 + * 152 + * When RAPIDHASH_PROTECTED is defined: 153 + * Xors and overwrites A contents with C's low 64 bits. 154 + * Xors and overwrites B contents with C's high 64 bits. 155 + */ 156 + RAPIDHASH_INLINE_CONSTEXPR void rapid_mum(uint64_t *A, uint64_t *B) RAPIDHASH_NOEXCEPT { 157 + #if defined(__SIZEOF_INT128__) 158 + __uint128_t r=*A; r*=*B; 159 + #ifdef RAPIDHASH_PROTECTED 160 + *A^=(uint64_t)r; *B^=(uint64_t)(r>>64); 161 + #else 162 + *A=(uint64_t)r; *B=(uint64_t)(r>>64); 163 + #endif 164 + #elif defined(_MSC_VER) && (defined(_WIN64) || defined(_M_HYBRID_CHPE_ARM64)) 165 + #if defined(_M_X64) 166 + #ifdef RAPIDHASH_PROTECTED 167 + uint64_t a, b; 168 + a=_umul128(*A,*B,&b); 169 + *A^=a; *B^=b; 170 + #else 171 + *A=_umul128(*A,*B,B); 172 + #endif 173 + #else 174 + #ifdef RAPIDHASH_PROTECTED 175 + uint64_t a, b; 176 + b = __umulh(*A, *B); 177 + a = *A * *B; 178 + *A^=a; *B^=b; 179 + #else 180 + uint64_t c = __umulh(*A, *B); 181 + *A = *A * *B; 182 + *B = c; 183 + #endif 184 + #endif 185 + #else 186 + uint64_t ha=*A>>32, hb=*B>>32, la=(uint32_t)*A, lb=(uint32_t)*B; 187 + uint64_t rh=ha*hb, rm0=ha*lb, rm1=hb*la, rl=la*lb, t=rl+(rm0<<32), c=t<rl; 188 + uint64_t lo=t+(rm1<<32); 189 + c+=lo<t; 190 + uint64_t hi=rh+(rm0>>32)+(rm1>>32)+c; 191 + #ifdef RAPIDHASH_PROTECTED 192 + *A^=lo; *B^=hi; 193 + #else 194 + *A=lo; *B=hi; 195 + #endif 196 + #endif 197 + } 198 + 199 + /* 200 + * Multiply and xor mix function. 201 + * 202 + * @param A 64-bit number. 203 + * @param B 64-bit number. 204 + * 205 + * Calculates 128-bit C = A * B. 206 + * Returns 64-bit xor between high and low 64 bits of C. 207 + */ 208 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapid_mix(uint64_t A, uint64_t B) RAPIDHASH_NOEXCEPT { rapid_mum(&A,&B); return A^B; } 209 + 210 + /* 211 + * Read functions. 212 + */ 213 + #ifdef RAPIDHASH_LITTLE_ENDIAN 214 + RAPIDHASH_INLINE uint64_t rapid_read64(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint64_t v; memcpy(&v, p, sizeof(uint64_t)); return v;} 215 + RAPIDHASH_INLINE uint64_t rapid_read32(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint32_t v; memcpy(&v, p, sizeof(uint32_t)); return v;} 216 + #elif defined(__GNUC__) || defined(__INTEL_COMPILER) || defined(__clang__) 217 + RAPIDHASH_INLINE uint64_t rapid_read64(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint64_t v; memcpy(&v, p, sizeof(uint64_t)); return __builtin_bswap64(v);} 218 + RAPIDHASH_INLINE uint64_t rapid_read32(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint32_t v; memcpy(&v, p, sizeof(uint32_t)); return __builtin_bswap32(v);} 219 + #elif defined(_MSC_VER) 220 + RAPIDHASH_INLINE uint64_t rapid_read64(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint64_t v; memcpy(&v, p, sizeof(uint64_t)); return _byteswap_uint64(v);} 221 + RAPIDHASH_INLINE uint64_t rapid_read32(const uint8_t *p) RAPIDHASH_NOEXCEPT { uint32_t v; memcpy(&v, p, sizeof(uint32_t)); return _byteswap_ulong(v);} 222 + #else 223 + RAPIDHASH_INLINE uint64_t rapid_read64(const uint8_t *p) RAPIDHASH_NOEXCEPT { 224 + uint64_t v; memcpy(&v, p, 8); 225 + return (((v >> 56) & 0xff)| ((v >> 40) & 0xff00)| ((v >> 24) & 0xff0000)| ((v >> 8) & 0xff000000)| ((v << 8) & 0xff00000000)| ((v << 24) & 0xff0000000000)| ((v << 40) & 0xff000000000000)| ((v << 56) & 0xff00000000000000)); 226 + } 227 + RAPIDHASH_INLINE uint64_t rapid_read32(const uint8_t *p) RAPIDHASH_NOEXCEPT { 228 + uint32_t v; memcpy(&v, p, 4); 229 + return (((v >> 24) & 0xff)| ((v >> 8) & 0xff00)| ((v << 8) & 0xff0000)| ((v << 24) & 0xff000000)); 230 + } 231 + #endif 232 + 233 + /* 234 + * rapidhash main function. 235 + * 236 + * @param key Buffer to be hashed. 237 + * @param len @key length, in bytes. 238 + * @param seed 64-bit seed used to alter the hash result predictably. 239 + * @param secret Triplet of 64-bit secrets used to alter hash result predictably. 240 + * 241 + * Returns a 64-bit hash. 242 + */ 243 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhash_internal(const void *key, size_t len, uint64_t seed, const uint64_t* secret) RAPIDHASH_NOEXCEPT { 244 + const uint8_t *p=(const uint8_t *)key; 245 + seed ^= rapid_mix(seed ^ secret[2], secret[1]); 246 + uint64_t a=0, b=0; 247 + size_t i = len; 248 + if (_likely_(len <= 16)) { 249 + if (len >= 4) { 250 + seed ^= len; 251 + if (len >= 8) { 252 + const uint8_t* plast = p + len - 8; 253 + a = rapid_read64(p); 254 + b = rapid_read64(plast); 255 + } else { 256 + const uint8_t* plast = p + len - 4; 257 + a = rapid_read32(p); 258 + b = rapid_read32(plast); 259 + } 260 + } else if (len > 0) { 261 + a = (((uint64_t)p[0])<<45)|p[len-1]; 262 + b = p[len>>1]; 263 + } else 264 + a = b = 0; 265 + } else { 266 + if (len > 112) { 267 + uint64_t see1 = seed, see2 = seed; 268 + uint64_t see3 = seed, see4 = seed; 269 + uint64_t see5 = seed, see6 = seed; 270 + #ifdef RAPIDHASH_COMPACT 271 + do { 272 + seed = rapid_mix(rapid_read64(p) ^ secret[0], rapid_read64(p + 8) ^ seed); 273 + see1 = rapid_mix(rapid_read64(p + 16) ^ secret[1], rapid_read64(p + 24) ^ see1); 274 + see2 = rapid_mix(rapid_read64(p + 32) ^ secret[2], rapid_read64(p + 40) ^ see2); 275 + see3 = rapid_mix(rapid_read64(p + 48) ^ secret[3], rapid_read64(p + 56) ^ see3); 276 + see4 = rapid_mix(rapid_read64(p + 64) ^ secret[4], rapid_read64(p + 72) ^ see4); 277 + see5 = rapid_mix(rapid_read64(p + 80) ^ secret[5], rapid_read64(p + 88) ^ see5); 278 + see6 = rapid_mix(rapid_read64(p + 96) ^ secret[6], rapid_read64(p + 104) ^ see6); 279 + p += 112; 280 + i -= 112; 281 + } while(i > 112); 282 + #else 283 + while (i > 224) { 284 + seed = rapid_mix(rapid_read64(p) ^ secret[0], rapid_read64(p + 8) ^ seed); 285 + see1 = rapid_mix(rapid_read64(p + 16) ^ secret[1], rapid_read64(p + 24) ^ see1); 286 + see2 = rapid_mix(rapid_read64(p + 32) ^ secret[2], rapid_read64(p + 40) ^ see2); 287 + see3 = rapid_mix(rapid_read64(p + 48) ^ secret[3], rapid_read64(p + 56) ^ see3); 288 + see4 = rapid_mix(rapid_read64(p + 64) ^ secret[4], rapid_read64(p + 72) ^ see4); 289 + see5 = rapid_mix(rapid_read64(p + 80) ^ secret[5], rapid_read64(p + 88) ^ see5); 290 + see6 = rapid_mix(rapid_read64(p + 96) ^ secret[6], rapid_read64(p + 104) ^ see6); 291 + seed = rapid_mix(rapid_read64(p + 112) ^ secret[0], rapid_read64(p + 120) ^ seed); 292 + see1 = rapid_mix(rapid_read64(p + 128) ^ secret[1], rapid_read64(p + 136) ^ see1); 293 + see2 = rapid_mix(rapid_read64(p + 144) ^ secret[2], rapid_read64(p + 152) ^ see2); 294 + see3 = rapid_mix(rapid_read64(p + 160) ^ secret[3], rapid_read64(p + 168) ^ see3); 295 + see4 = rapid_mix(rapid_read64(p + 176) ^ secret[4], rapid_read64(p + 184) ^ see4); 296 + see5 = rapid_mix(rapid_read64(p + 192) ^ secret[5], rapid_read64(p + 200) ^ see5); 297 + see6 = rapid_mix(rapid_read64(p + 208) ^ secret[6], rapid_read64(p + 216) ^ see6); 298 + p += 224; 299 + i -= 224; 300 + } 301 + if (i > 112) { 302 + seed = rapid_mix(rapid_read64(p) ^ secret[0], rapid_read64(p + 8) ^ seed); 303 + see1 = rapid_mix(rapid_read64(p + 16) ^ secret[1], rapid_read64(p + 24) ^ see1); 304 + see2 = rapid_mix(rapid_read64(p + 32) ^ secret[2], rapid_read64(p + 40) ^ see2); 305 + see3 = rapid_mix(rapid_read64(p + 48) ^ secret[3], rapid_read64(p + 56) ^ see3); 306 + see4 = rapid_mix(rapid_read64(p + 64) ^ secret[4], rapid_read64(p + 72) ^ see4); 307 + see5 = rapid_mix(rapid_read64(p + 80) ^ secret[5], rapid_read64(p + 88) ^ see5); 308 + see6 = rapid_mix(rapid_read64(p + 96) ^ secret[6], rapid_read64(p + 104) ^ see6); 309 + p += 112; 310 + i -= 112; 311 + } 312 + #endif 313 + seed ^= see1; 314 + see2 ^= see3; 315 + see4 ^= see5; 316 + seed ^= see6; 317 + see2 ^= see4; 318 + seed ^= see2; 319 + } 320 + if (i > 16) { 321 + seed = rapid_mix(rapid_read64(p) ^ secret[2], rapid_read64(p + 8) ^ seed); 322 + if (i > 32) { 323 + seed = rapid_mix(rapid_read64(p + 16) ^ secret[2], rapid_read64(p + 24) ^ seed); 324 + if (i > 48) { 325 + seed = rapid_mix(rapid_read64(p + 32) ^ secret[1], rapid_read64(p + 40) ^ seed); 326 + if (i > 64) { 327 + seed = rapid_mix(rapid_read64(p + 48) ^ secret[1], rapid_read64(p + 56) ^ seed); 328 + if (i > 80) { 329 + seed = rapid_mix(rapid_read64(p + 64) ^ secret[2], rapid_read64(p + 72) ^ seed); 330 + if (i > 96) { 331 + seed = rapid_mix(rapid_read64(p + 80) ^ secret[1], rapid_read64(p + 88) ^ seed); 332 + } 333 + } 334 + } 335 + } 336 + } 337 + } 338 + a=rapid_read64(p+i-16) ^ i; b=rapid_read64(p+i-8); 339 + } 340 + a ^= secret[1]; 341 + b ^= seed; 342 + rapid_mum(&a, &b); 343 + return rapid_mix(a ^ secret[7], b ^ secret[1] ^ i); 344 + } 345 + 346 + /* 347 + * rapidhashMicro main function. 348 + * 349 + * @param key Buffer to be hashed. 350 + * @param len @key length, in bytes. 351 + * @param seed 64-bit seed used to alter the hash result predictably. 352 + * @param secret Triplet of 64-bit secrets used to alter hash result predictably. 353 + * 354 + * Returns a 64-bit hash. 355 + */ 356 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashMicro_internal(const void *key, size_t len, uint64_t seed, const uint64_t* secret) RAPIDHASH_NOEXCEPT { 357 + const uint8_t *p=(const uint8_t *)key; 358 + seed ^= rapid_mix(seed ^ secret[2], secret[1]); 359 + uint64_t a=0, b=0; 360 + size_t i = len; 361 + if (_likely_(len <= 16)) { 362 + if (len >= 4) { 363 + seed ^= len; 364 + if (len >= 8) { 365 + const uint8_t* plast = p + len - 8; 366 + a = rapid_read64(p); 367 + b = rapid_read64(plast); 368 + } else { 369 + const uint8_t* plast = p + len - 4; 370 + a = rapid_read32(p); 371 + b = rapid_read32(plast); 372 + } 373 + } else if (len > 0) { 374 + a = (((uint64_t)p[0])<<45)|p[len-1]; 375 + b = p[len>>1]; 376 + } else 377 + a = b = 0; 378 + } else { 379 + if (i > 80) { 380 + uint64_t see1 = seed, see2 = seed; 381 + uint64_t see3 = seed, see4 = seed; 382 + do { 383 + seed = rapid_mix(rapid_read64(p) ^ secret[0], rapid_read64(p + 8) ^ seed); 384 + see1 = rapid_mix(rapid_read64(p + 16) ^ secret[1], rapid_read64(p + 24) ^ see1); 385 + see2 = rapid_mix(rapid_read64(p + 32) ^ secret[2], rapid_read64(p + 40) ^ see2); 386 + see3 = rapid_mix(rapid_read64(p + 48) ^ secret[3], rapid_read64(p + 56) ^ see3); 387 + see4 = rapid_mix(rapid_read64(p + 64) ^ secret[4], rapid_read64(p + 72) ^ see4); 388 + p += 80; 389 + i -= 80; 390 + } while(i > 80); 391 + seed ^= see1; 392 + see2 ^= see3; 393 + seed ^= see4; 394 + seed ^= see2; 395 + } 396 + if (i > 16) { 397 + seed = rapid_mix(rapid_read64(p) ^ secret[2], rapid_read64(p + 8) ^ seed); 398 + if (i > 32) { 399 + seed = rapid_mix(rapid_read64(p + 16) ^ secret[2], rapid_read64(p + 24) ^ seed); 400 + if (i > 48) { 401 + seed = rapid_mix(rapid_read64(p + 32) ^ secret[1], rapid_read64(p + 40) ^ seed); 402 + if (i > 64) { 403 + seed = rapid_mix(rapid_read64(p + 48) ^ secret[1], rapid_read64(p + 56) ^ seed); 404 + } 405 + } 406 + } 407 + } 408 + a=rapid_read64(p+i-16) ^ i; b=rapid_read64(p+i-8); 409 + } 410 + a ^= secret[1]; 411 + b ^= seed; 412 + rapid_mum(&a, &b); 413 + return rapid_mix(a ^ secret[7], b ^ secret[1] ^ i); 414 + } 415 + 416 + /* 417 + * rapidhashNano main function. 418 + * 419 + * @param key Buffer to be hashed. 420 + * @param len @key length, in bytes. 421 + * @param seed 64-bit seed used to alter the hash result predictably. 422 + * @param secret Triplet of 64-bit secrets used to alter hash result predictably. 423 + * 424 + * Returns a 64-bit hash. 425 + */ 426 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashNano_internal(const void *key, size_t len, uint64_t seed, const uint64_t* secret) RAPIDHASH_NOEXCEPT { 427 + const uint8_t *p=(const uint8_t *)key; 428 + seed ^= rapid_mix(seed ^ secret[2], secret[1]); 429 + uint64_t a=0, b=0; 430 + size_t i = len; 431 + if (_likely_(len <= 16)) { 432 + if (len >= 4) { 433 + seed ^= len; 434 + if (len >= 8) { 435 + const uint8_t* plast = p + len - 8; 436 + a = rapid_read64(p); 437 + b = rapid_read64(plast); 438 + } else { 439 + const uint8_t* plast = p + len - 4; 440 + a = rapid_read32(p); 441 + b = rapid_read32(plast); 442 + } 443 + } else if (len > 0) { 444 + a = (((uint64_t)p[0])<<45)|p[len-1]; 445 + b = p[len>>1]; 446 + } else 447 + a = b = 0; 448 + } else { 449 + if (i > 48) { 450 + uint64_t see1 = seed, see2 = seed; 451 + do { 452 + seed = rapid_mix(rapid_read64(p) ^ secret[0], rapid_read64(p + 8) ^ seed); 453 + see1 = rapid_mix(rapid_read64(p + 16) ^ secret[1], rapid_read64(p + 24) ^ see1); 454 + see2 = rapid_mix(rapid_read64(p + 32) ^ secret[2], rapid_read64(p + 40) ^ see2); 455 + p += 48; 456 + i -= 48; 457 + } while(i > 48); 458 + seed ^= see1; 459 + seed ^= see2; 460 + } 461 + if (i > 16) { 462 + seed = rapid_mix(rapid_read64(p) ^ secret[2], rapid_read64(p + 8) ^ seed); 463 + if (i > 32) { 464 + seed = rapid_mix(rapid_read64(p + 16) ^ secret[2], rapid_read64(p + 24) ^ seed); 465 + } 466 + } 467 + a=rapid_read64(p+i-16) ^ i; b=rapid_read64(p+i-8); 468 + } 469 + a ^= secret[1]; 470 + b ^= seed; 471 + rapid_mum(&a, &b); 472 + return rapid_mix(a ^ secret[7], b ^ secret[1] ^ i); 473 + } 474 + 475 + /* 476 + * rapidhash seeded hash function. 477 + * 478 + * @param key Buffer to be hashed. 479 + * @param len @key length, in bytes. 480 + * @param seed 64-bit seed used to alter the hash result predictably. 481 + * 482 + * Calls rapidhash_internal using provided parameters and default secrets. 483 + * 484 + * Returns a 64-bit hash. 485 + */ 486 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhash_withSeed(const void *key, size_t len, uint64_t seed) RAPIDHASH_NOEXCEPT { 487 + return rapidhash_internal(key, len, seed, rapid_secret); 488 + } 489 + 490 + /* 491 + * rapidhash general purpose hash function. 492 + * 493 + * @param key Buffer to be hashed. 494 + * @param len @key length, in bytes. 495 + * 496 + * Calls rapidhash_withSeed using provided parameters and the default seed. 497 + * 498 + * Returns a 64-bit hash. 499 + */ 500 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhash(const void *key, size_t len) RAPIDHASH_NOEXCEPT { 501 + return rapidhash_withSeed(key, len, 0); 502 + } 503 + 504 + /* 505 + * rapidhashMicro seeded hash function. 506 + * 507 + * Designed for HPC and server applications, where cache misses make a noticeable performance detriment. 508 + * Clang-18+ compiles it to ~140 instructions without stack usage, both on x86-64 and aarch64. 509 + * Faster for sizes up to 512 bytes, just 15%-20% slower for inputs above 1kb. 510 + * 511 + * @param key Buffer to be hashed. 512 + * @param len @key length, in bytes. 513 + * @param seed 64-bit seed used to alter the hash result predictably. 514 + * 515 + * Calls rapidhash_internal using provided parameters and default secrets. 516 + * 517 + * Returns a 64-bit hash. 518 + */ 519 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashMicro_withSeed(const void *key, size_t len, uint64_t seed) RAPIDHASH_NOEXCEPT { 520 + return rapidhashMicro_internal(key, len, seed, rapid_secret); 521 + } 522 + 523 + /* 524 + * rapidhashMicro hash function. 525 + * 526 + * @param key Buffer to be hashed. 527 + * @param len @key length, in bytes. 528 + * 529 + * Calls rapidhash_withSeed using provided parameters and the default seed. 530 + * 531 + * Returns a 64-bit hash. 532 + */ 533 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashMicro(const void *key, size_t len) RAPIDHASH_NOEXCEPT { 534 + return rapidhashMicro_withSeed(key, len, 0); 535 + } 536 + 537 + /* 538 + * rapidhashNano seeded hash function. 539 + * 540 + * @param key Buffer to be hashed. 541 + * @param len @key length, in bytes. 542 + * @param seed 64-bit seed used to alter the hash result predictably. 543 + * 544 + * Calls rapidhash_internal using provided parameters and default secrets. 545 + * 546 + * Returns a 64-bit hash. 547 + */ 548 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashNano_withSeed(const void *key, size_t len, uint64_t seed) RAPIDHASH_NOEXCEPT { 549 + return rapidhashNano_internal(key, len, seed, rapid_secret); 550 + } 551 + 552 + /* 553 + * rapidhashNano hash function. 554 + * 555 + * Designed for Mobile and embedded applications, where keeping a small code size is a top priority. 556 + * Clang-18+ compiles it to less than 100 instructions without stack usage, both on x86-64 and aarch64. 557 + * The fastest for sizes up to 48 bytes, but may be considerably slower for larger inputs. 558 + * 559 + * @param key Buffer to be hashed. 560 + * @param len @key length, in bytes. 561 + * 562 + * Calls rapidhash_withSeed using provided parameters and the default seed. 563 + * 564 + * Returns a 64-bit hash. 565 + */ 566 + RAPIDHASH_INLINE_CONSTEXPR uint64_t rapidhashNano(const void *key, size_t len) RAPIDHASH_NOEXCEPT { 567 + return rapidhashNano_withSeed(key, len, 0); 568 + }
+266
src/textstore.c
··· 1 + /* text-store - A store for storing reference-counted, de-duplicated strings. 2 + * Copyright (C) 2025 Jeremia Dominguez <me@jeremia.dev> 3 + * 4 + * This program is free software: you can redistribute it and/or modify 5 + * it under the terms of the GNU General Public License as published by 6 + * the Free Software Foundation, either version 3 of the License, or 7 + * (at your option) any later version. 8 + * 9 + * This program is distributed in the hope that it will be useful, 10 + * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 + * GNU General Public License for more details. 13 + * 14 + * You should have received a copy of the GNU General Public License 15 + * along with this program. If not, see <https://www.gnu.org/licenses/>. 16 + */ 17 + 18 + #include <alloca.h> 19 + #include <stdalign.h> 20 + #include <stdbool.h> 21 + #include <stddef.h> 22 + #include <stdint.h> 23 + #include <stdlib.h> 24 + #include <string.h> 25 + 26 + #include <textstore.h> 27 + 28 + #include "rapidhash.h" 29 + 30 + /* Size of struct-of-array member's items. */ 31 + #define SoASize (sizeof(uint32_t) + sizeof(textstore_slice) + (sizeof(uint32_t) * 2) + sizeof(bool)) 32 + 33 + static inline textstore_handle to_handle(uint32_t index, uint32_t generation) { 34 + uint64_t handle = (uint64_t)generation << 32; 35 + handle += index; 36 + return handle; 37 + } 38 + 39 + /** 40 + * Allocates enough room on the hash map for n items, and sets the store's pointers. 41 + * 42 + * Note: Use on a temporary copy. 43 + */ 44 + static inline void textstore_alloc(textstore_t *store, size_t n) { 45 + store->map = (uint32_t *)aligned_alloc(alignof(uint32_t), SoASize * n); 46 + store->key = (textstore_slice *)(store->map + n); 47 + store->ref = (uint32_t *)(store->key + n); 48 + store->generation = (uint32_t *)(store->ref + n); 49 + store->active = (bool *)(store->generation + n); 50 + } 51 + 52 + static void textstore_put(textstore_t *store, char *str, uint32_t len, uint32_t value) { 53 + uint32_t *map = store->map; 54 + uint32_t capacity = store->capacity; 55 + uint32_t idx = rapidhash(str, len) % capacity; 56 + while (map[idx] != 0) { /* The 0 index is already reserved for empty string. */ 57 + idx = (idx + 1) % capacity; 58 + } 59 + map[idx] = value; 60 + } 61 + 62 + static void textstore_rehash(textstore_t *store) { 63 + char *buffer = store->buffer; 64 + textstore_slice *slices = store->key + 1; /* Skip index 0, empty string. */ 65 + bool *active = store->active + 1; 66 + uint32_t count = store->count - 1; 67 + memset(store->map, 0, sizeof(uint32_t) * store->capacity); 68 + for (uint32_t i = 0; i < count; i++) { 69 + if (active[i]) { 70 + textstore_slice slice = slices[i]; 71 + textstore_put(store, &buffer[slice.offset], slice.len, i + 1); 72 + } 73 + } 74 + } 75 + 76 + static textstore_handle textstore_find(textstore_t *store, char *str, uint32_t len) { 77 + assert(str != NULL); 78 + assert(len != 0); 79 + 80 + char *buffer = store->buffer; 81 + uint32_t capacity = store->capacity; 82 + uint32_t *map = store->map; 83 + textstore_slice *key = store->key; 84 + bool *active = store->active; 85 + 86 + uint32_t index = rapidhash(str, len) % capacity; 87 + while (map[index] != 0) { 88 + uint32_t idx = map[index]; 89 + if (key[idx].len != len || !active[idx]) { 90 + index = (index + 1) % capacity; 91 + continue; 92 + } 93 + if (strcmp(str, &buffer[key[idx].offset]) == 0) { 94 + return to_handle(idx, store->generation[idx]); 95 + } 96 + } 97 + 98 + return TEXTSTORE_HANDLE_ERROR; 99 + } 100 + 101 + /** 102 + * Appends text to the store's buffer. 103 + */ 104 + static void textstore_append(textstore_t *store, char *str, uint32_t len) { 105 + if (len + 1 + store->length > store->buffer_cap) { 106 + /* Unfortunately, there isn't an aligned_realloc */ 107 + uint32_t new_capacity= store->buffer_cap * 2; 108 + while (new_capacity < len + 1 + store->length) { 109 + new_capacity *= 2; 110 + } 111 + char *new_buffer = aligned_alloc(sizeof(uint32_t), new_capacity); 112 + memcpy(new_buffer, store->buffer, store->length); 113 + free(store->buffer); 114 + store->buffer = new_buffer; 115 + store->buffer_cap = new_capacity; 116 + } 117 + memcpy(&store->buffer[store->length], str, len); 118 + store->buffer[store->length + len] = 0; 119 + store->length += len + 1; 120 + } 121 + 122 + textstore_handle textstore_intern(textstore_t *store, char *str) { 123 + return textstore_intern_len(store, str, strlen(str)); 124 + } 125 + 126 + textstore_handle textstore_intern_len(textstore_t *store, char *str, uint32_t len) { 127 + textstore_handle handle = to_handle(0, 0); 128 + uint32_t index; 129 + 130 + if (len == 0) { /* Special case empty string. */ 131 + textstore_retain(store, handle); 132 + return handle; 133 + } 134 + if (str == NULL) return TEXTSTORE_HANDLE_ERROR; 135 + 136 + handle = textstore_find(store, str, len); 137 + if (handle != TEXTSTORE_HANDLE_ERROR) { 138 + textstore_retain(store, handle); 139 + return handle; 140 + } 141 + 142 + uint32_t offset = store->length; 143 + textstore_append(store, str, len); 144 + 145 + 146 + if (store->available > 0) { 147 + /* Pop a freed handle index off the end of the queue. */ 148 + index = ((uint32_t *)store->buffer)[--store->available]; 149 + store->generation[index]++; 150 + } else { 151 + index = store->count++; 152 + store->generation[index] = 0; 153 + } 154 + 155 + textstore_put(store, str, len, index); 156 + handle = to_handle(index, store->generation[index]); 157 + store->key[index] = (textstore_slice){offset, len}; 158 + store->ref[index] = 1; 159 + store->active[index] = true; 160 + 161 + if (index > ((store->capacity/4)*3)) { 162 + /* At 3/4 capacity, grow the hash-table. */ 163 + textstore_t copy = *store; 164 + textstore_alloc(&copy, copy.capacity * 2); 165 + memcpy(copy.key, store->key, copy.count * sizeof(textstore_slice)); 166 + memcpy(copy.ref, store->ref, copy.count * sizeof(uint32_t)); 167 + memcpy(copy.generation, store->generation, copy.count * sizeof(uint32_t)); 168 + memcpy(copy.active, store->active, copy.count * sizeof(bool)); 169 + copy.capacity *= 2; 170 + free(store->map); 171 + *store = copy; 172 + textstore_rehash(store); 173 + } 174 + 175 + return handle; 176 + } 177 + 178 + int textstore_gc(textstore_t *store) { 179 + textstore_slice *strings = store->key; 180 + uint32_t *refs = store->ref; 181 + bool *actives = store->active; 182 + uint32_t count = store->count; 183 + 184 + // Pass 1: Count how many strings need to be collected, and determine how 185 + // much space is needed for the new buffer. 186 + uint32_t collect = store->available; 187 + uint32_t new_length = collect * sizeof(uint32_t); 188 + for (uint32_t i = 0; i < count; i++) { 189 + if (actives[i]) { 190 + if (refs[i] > 0) { 191 + new_length += strings[i].len; 192 + } else { 193 + collect += 1; 194 + new_length += sizeof(uint32_t); 195 + } 196 + } 197 + } 198 + 199 + // If no strings are in need of collecting, stop early. 200 + if (collect == 0) return 0; 201 + 202 + // Pass 2: Generate new buffer from the active strings. 203 + char *new_buffer = aligned_alloc(alignof(uint32_t), new_length); 204 + if (new_buffer == NULL) return 1; 205 + memset(new_buffer, 0, new_length); 206 + uint32_t new_offset = collect * sizeof(uint32_t); 207 + // copy existing free queue to the new one. 208 + memcpy(new_buffer, store->buffer, store->available * sizeof(uint32_t)); 209 + uint32_t *queue_buffer = (uint32_t *)new_buffer; 210 + uint32_t queue_offset = store->available; 211 + 212 + // char * text_buffer = (char *)(&queue_buffer[collect]); 213 + // uint32_t text_length = new_length - (sizeof(uint32_t) * collect); 214 + 215 + for (uint32_t i = 0; i < count; i++) { 216 + if (actives[i]) { 217 + if (refs[i] == 0) { 218 + queue_buffer[queue_offset++] = i; 219 + actives[i] = false; 220 + strings[i] = (textstore_slice){0}; 221 + continue; 222 + } 223 + memcpy(&new_buffer[new_offset], &store->buffer[strings[i].offset], strings[i].len); 224 + strings[i].offset = new_offset; 225 + new_offset += strings[i].len + 1; 226 + } 227 + } 228 + 229 + free(store->buffer); 230 + store->buffer = new_buffer; 231 + store->available = collect; 232 + 233 + textstore_rehash(store); 234 + return 0; 235 + } 236 + 237 + int textstore_init(textstore_t *store, uint32_t initial_buffer) { 238 + textstore_t temp = {0}; 239 + if (initial_buffer == 0) initial_buffer = 1; 240 + /* The buffer contains the sequence of available freed handle indexes at the start. 241 + Hence, this allocation is aligned to those indexes. */ 242 + temp.buffer = (char *)aligned_alloc(alignof(uint32_t), initial_buffer); 243 + if (temp.buffer == NULL) return 1; 244 + temp.buffer_cap = initial_buffer; 245 + memset(temp.buffer, 0, initial_buffer); 246 + 247 + temp.capacity = 8; 248 + textstore_alloc(&temp, temp.capacity); 249 + 250 + /* Special-case empty string ("") for index 0. */ 251 + temp.key[0] = (textstore_slice){ 0, 0 }; 252 + temp.ref[0] = 1; 253 + temp.active[0] = true; 254 + temp.length++; 255 + temp.count++; 256 + 257 + *store = temp; 258 + return 0; 259 + } 260 + 261 + void textstore_free(textstore_t *store) { 262 + free(store->buffer); 263 + free(store->map); 264 + 265 + *store = (textstore_t){0}; 266 + }