commit fa70f7577a39cc274411772af20259e5c2d56fe8 Author: Jan-Erik Rediger Date: Sun Jul 7 12:53:37 2024 +0200 init diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..c257317 --- /dev/null +++ b/COPYING @@ -0,0 +1,367 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..532452b --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +.POSIX: +.SUFFIXES: +HARE=hare +HAREFLAGS= + +DESTDIR= +PREFIX=/usr/local +SRCDIR=$(PREFIX)/src +HARESRCDIR=$(SRCDIR)/hare +THIRDPARTYDIR=$(HARESRCDIR)/third-party + +all: + # no-op + +clean: + # no-op + +check: + hare test + +install: + mkdir -p $(DESTDIR)$(THIRDPARTYDIR)/harena + install -m644 harena/* $(DESTDIR)$(THIRDPARTYDIR)/harena + +uninstall: + rm -rf $(DESTDIR)$(THIRDPARTYDIR)/harena + +.PHONY: all clean check install uninstall diff --git a/README.md b/README.md new file mode 100644 index 0000000..14b75c1 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +This module provides an implementation of an arena allocator. +It is based on [larena](https://github.com/linkdd/larena). diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..f7db9aa --- /dev/null +++ b/flake.lock @@ -0,0 +1,127 @@ +{ + "nodes": { + "hare-pkgs": { + "inputs": { + "hare-src": "hare-src", + "harec-src": "harec-src", + "linux-hare-src": "linux-hare-src", + "linux-harec-src": "linux-harec-src", + "nixpkgs": "nixpkgs" + }, + "locked": { + "lastModified": 1717281762, + "narHash": "sha256-NUMYwtqlN7NzDOC3wEQnYAlbZsSMkbnljE4nXdAarIo=", + "ref": "main", + "rev": "7c95e59ca463112e1c7b43f452dbfe864fd8468c", + "revCount": 21, + "type": "git", + "url": "https://git.fnordig.de/jer/hare-mac.git" + }, + "original": { + "ref": "main", + "type": "git", + "url": "https://git.fnordig.de/jer/hare-mac.git" + } + }, + "hare-src": { + "flake": false, + "locked": { + "lastModified": 1717279340, + "narHash": "sha256-c91H21fyzHVekAB5ePduxO8l/zZ86ov8KHa1HHC8Ywc=", + "owner": "badboy", + "repo": "harelang", + "rev": "287006499c2640c6e96b6fa5e0c99a2c193cc666", + "type": "github" + }, + "original": { + "owner": "badboy", + "repo": "harelang", + "type": "github" + } + }, + "harec-src": { + "flake": false, + "locked": { + "lastModified": 1715770447, + "narHash": "sha256-/n175ocvtzi1J+zB8+eW69YXolGFX15g9Ee0OE5jtGA=", + "owner": "badboy", + "repo": "harelang-harec", + "rev": "873311b721dca691706909964cc108139ebee0de", + "type": "github" + }, + "original": { + "owner": "badboy", + "repo": "harelang-harec", + "type": "github" + } + }, + "linux-hare-src": { + "flake": false, + "locked": { + "lastModified": 1717244404, + "narHash": "sha256-iEGez/JfWvAaHbYUQL/BeRPUH5d+xj7AyFM8CvA+oDU=", + "ref": "refs/heads/master", + "rev": "a3fd5ec812ee31a7ec4a07053518b64aaa0c3932", + "revCount": 3883, + "type": "git", + "url": "https://git.sr.ht/~sircmpwn/hare" + }, + "original": { + "type": "git", + "url": "https://git.sr.ht/~sircmpwn/hare" + } + }, + "linux-harec-src": { + "flake": false, + "locked": { + "lastModified": 1716809026, + "narHash": "sha256-z4D4MMVROoMFnqAjyWWCUdHwCfR14coGFUNdRGQktgQ=", + "ref": "refs/heads/master", + "rev": "42f9b39977ce8d94bab1655f07bb82eb08c85dda", + "revCount": 1914, + "type": "git", + "url": "https://git.sr.ht/~sircmpwn/harec" + }, + "original": { + "type": "git", + "url": "https://git.sr.ht/~sircmpwn/harec" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1716220750, + "narHash": "sha256-Lhhrd1ZBNXCbUupWGq6gRPIy1qMKEdcAXcjnwgVqe/U=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "641daa314d5bc1bca4b345da8eb08a130b109c79", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "type": "indirect" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1720181791, + "narHash": "sha256-i4vJL12/AdyuQuviMMd1Hk2tsGt02hDNhA0Zj1m16N8=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "4284c2b73c8bce4b46a6adf23e16d9e2ec8da4bb", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "type": "indirect" + } + }, + "root": { + "inputs": { + "hare-pkgs": "hare-pkgs", + "nixpkgs": "nixpkgs_2" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..3292fdb --- /dev/null +++ b/flake.nix @@ -0,0 +1,32 @@ +{ + description = "Hare for mac"; + + inputs = { + hare-pkgs = { + url = "git+https://git.fnordig.de/jer/hare-mac.git?ref=main"; + }; + }; + + outputs = { nixpkgs, hare-pkgs, ... }: + let + supportedSystems = [ "x86_64-darwin" "aarch64-darwin" "x86_64-linux" "aarch64-linux" ]; + forAllSystems = nixpkgs.lib.genAttrs supportedSystems; + in + { + devShells = forAllSystems (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + hare-pkgs' = hare-pkgs.packages.${system}; + harec = hare-pkgs'.harec; + hare = hare-pkgs'.hare; + in + { + default = pkgs.mkShell { + buildInputs = [ + harec + hare + ]; + }; + }); + }; +} diff --git a/harena/+test.ha b/harena/+test.ha new file mode 100644 index 0000000..07b1274 --- /dev/null +++ b/harena/+test.ha @@ -0,0 +1,66 @@ +use types::{SIZE_MAX}; +use errors::{overflow}; + +@test fn readme() void = { + let allocator = init_stdlib(); + let arena = arena_init(&allocator); + + let obj = halloc(&arena, 4)!; + + let ptr = object_deref(&obj): *int; + *ptr = 42; + + clear(&arena); + + let obj = halloc(&arena, 4)!; + assert(*(object_deref(&obj): *int) == 0); + + let objs = calloc(&arena, 2, 4)!; + + let ptrs = object_deref_slice(&objs, 2): []int; + ptrs[0] = 42; + ptrs[1] = 43; + + arena_free(&arena); +}; + +@test fn zero_sized_alloc() void = { + let allocator = init_stdlib(); + let arena = arena_init(&allocator); + + let obj_a = halloc(&arena, 4)!; + let obj_b = halloc(&arena, 0)!; + let obj_c = halloc(&arena, 4)!; + + assert(obj_b.ptr == obj_c.ptr); + + arena_free(&arena); +}; + +@test fn ub_alignment() void = { + let allocator = init_stdlib(); + let arena = arena_init(&allocator); + + let obj_a = halloc(&arena, 2)!; + let obj_b = halloc(&arena, 4)!; + + let ptr_a = object_deref(&obj_a): *u16; + let ptr_b = object_deref(&obj_b): *int; + + *ptr_a = 42; + *ptr_b = 42; + + arena_free(&arena); +}; + +@test fn int_overflow_large_alloc() void = { + let allocator = init_stdlib(); + let arena = arena_init(&allocator); + + let obj = match (halloc(&arena, SIZE_MAX - 100)) { + case overflow => assert(true); + case => assert(false); + }; + + arena_free(&arena); +}; diff --git a/harena/harena.ha b/harena/harena.ha new file mode 100644 index 0000000..68ef2e7 --- /dev/null +++ b/harena/harena.ha @@ -0,0 +1,140 @@ +use rt; +use types::{SIZE_MAX, slice}; +use errors::{overflow, nomem}; + +def LARENA_ALIGNMENT: size = 4096; +def MAX_ALIGN: size = 8; + +export type allocator = struct { + ualloc: *fn(sz: size, ctx: nullable *opaque) nullable *opaque, + realloc: *fn(ptr: nullable *opaque, oldsz: size, newsz: size, ctx: nullable *opaque) nullable *opaque, + dealloc: *fn(ptr: nullable *opaque, sz: size, ctx: nullable *opaque) void, + ctx: nullable *opaque, + +}; + +export type arena = struct { + allocator: *allocator, + offst: uintptr, + capacity: size, + data: nullable *opaque, +}; + +export type object = struct { + arena: *arena, + ptr: uintptr, +}; + +fn stdlib_alloc(sz: size, ctx: nullable *opaque) nullable *opaque = { + return rt::malloc(sz); +}; + +fn stdlib_realloc(ptr: nullable *opaque, oldsz: size, newsz: size, ctx: nullable *opaque) nullable *opaque = { + return rt::realloc(ptr, newsz); +}; + +fn stdlib_dealloc(ptr: nullable *opaque, sz: size, ctx: nullable *opaque) void = { + rt::free_(ptr); +}; + +fn align_size_forward(sz: size, alignment: size) size = { + if (alignment == 0) return sz; + let remainder = sz % alignment; + if (remainder == 0) return sz; + if (sz > SIZE_MAX - (alignment - remainder)) return 0; + return sz + alignment - remainder; +}; + +export fn init_stdlib() allocator = { + return allocator { + ualloc = &stdlib_alloc, + realloc = &stdlib_realloc, + dealloc = &stdlib_dealloc, + ctx = null, + }; +}; + + +export fn arena_init(allocator: *allocator) arena = { + return arena { + allocator = allocator, + offst = 0, + capacity = 0, + data = null, + }; +}; + +export fn halloc(self: *arena, sz: size) (object | overflow | nomem) = { + let obj = object { + arena = self, + ptr = 0, + }; + + if (sz == 0) { + obj.ptr = self.offst; + return obj; + }; + + sz = align_size_forward(sz, MAX_ALIGN); + if ((sz == 0) || (self.offst > SIZE_MAX - sz)) return overflow; + + if (self.offst + sz > self.capacity) { + let allocsz = align_size_forward( + (self.offst + sz) - self.capacity, + LARENA_ALIGNMENT + ); + + if (allocsz == 0) { + return overflow; + }; + + let newdata = self.allocator.realloc( + self.data, + self.capacity, + self.capacity + allocsz, + self.allocator.ctx + ); + + if (newdata == null) { + return nomem; + }; + + self.capacity += allocsz; + self.data = newdata; + }; + + rt::memset((self.data: uintptr + self.offst): *opaque, 0, sz); + obj.ptr = self.offst; + self.offst += sz: uintptr; + + return obj; +}; + +export fn calloc(self: *arena, count: size, sz: size) (object | overflow | nomem) = { + if (count > 0 && sz > SIZE_MAX / count) return overflow; + return halloc(self, count * sz); +}; + +export fn clear(self: *arena) void = { + self.offst = 0; +}; + +export fn arena_free(self: *arena) void = { + if (self.data != null) { + self.allocator.dealloc(self.data, self.capacity, self.allocator.ctx); + self.data = null; + }; +}; + +export fn object_deref(self: *object) *opaque = { + return ((self.arena.data: uintptr) + self.ptr): *opaque; +}; + +export fn object_deref_slice(self: *object, n: size) []opaque = { + let ptrs = object_deref(self): *opaque; + return *(&slice { + data = ptrs, + length = n, + capacity = n, + }: *[]opaque); +};