{"id":27696777,"url":"https://github.com/raezil/atomicarena","last_synced_at":"2025-06-14T02:33:48.848Z","repository":{"id":289539514,"uuid":"971601849","full_name":"Raezil/atomicarena","owner":"Raezil","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-23T20:01:50.000Z","size":16,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T20:27:03.049Z","etag":null,"topics":["golang","library","memoryarena"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Raezil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-23T19:13:44.000Z","updated_at":"2025-04-23T20:06:53.000Z","dependencies_parsed_at":"2025-04-23T20:37:31.991Z","dependency_job_id":null,"html_url":"https://github.com/Raezil/atomicarena","commit_stats":null,"previous_names":["raezil/atomicarena"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raezil%2Fatomicarena","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raezil%2Fatomicarena/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raezil%2Fatomicarena/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Raezil%2Fatomicarena/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Raezil","download_url":"https://codeload.github.com/Raezil/atomicarena/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250597723,"owners_count":21456424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","library","memoryarena"],"created_at":"2025-04-25T15:13:02.513Z","updated_at":"2025-06-14T02:33:48.837Z","avatar_url":"https://github.com/Raezil.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AtomicArena\n[![Go Report Card](https://goreportcard.com/badge/github.com/Raezil/atomicarena)](https://goreportcard.com/report/github.com/Raezil/atomicarena)\n\n`AtomicArena` is a lock-free, thread-safe generic arena allocator for Go. It provides a fixed-capacity container of atomic pointers, allowing you to allocate objects of any type **T** up to a maximum element count without locks or garbage collection overhead.\n\n## Features\n\n- **Generic**: Works with any Go type `T` whose size is known at compile time.\n- **Lock-Free**: Uses atomic operations (`atomic.Uintptr`, `atomic.Pointer[T]`) for high concurrency without mutexes.\n- **Fixed Capacity**: Pre-allocates a buffer for `maxElems` objects to avoid slice growth and dynamic allocations after initialization.\n- **Resettable**: Clear the arena in constant time, reusing all slots immediately.\n- **Bulk Allocation**: Easily append multiple values at once using `AppendSlice`.\n\n## Installation\n\n```bash\ngo get github.com/Raezil/atomicarena\n```\n\n## Usage\n\n```go\npackage main\n\nimport (\n    \"fmt\"\n    \"github.com/Raezil/atomicarena\"\n)\n\nfunc main() {\n    // Create an arena for 100 integers\n    arena := atomicarena.NewAtomicArena[int](100)\n\n    // Allocate a single value\n    ptr, err := arena.Alloc(42)\n    if err != nil {\n        panic(err)\n    }\n    fmt.Println(\"Allocated:\", *ptr)\n\n    // Bulk allocate a slice of values\n    inputs := []int{1, 2, 3, 4, 5}\n    ptrs, err := arena.AppendSlice(inputs)\n    if err != nil {\n        panic(err)\n    }\n    for i, p := range ptrs {\n        fmt.Printf(\"Value %d allocated: %d\\n\", i, *p)\n    }\n\n    // Reset to reuse all slots\n    arena.Reset()\n}\n```\n\n## API\n\n### `NewAtomicArena[T any](maxElems uintptr) *AtomicArena[T]`\nCreates a new arena capable of holding up to `maxElems` values of type `T`.\n\n### `(a *AtomicArena[T]) Alloc(obj T) (*T, error)`\nAtomically reserves a slot and stores `obj`. Returns an error if capacity is exhausted.\n\n### `(a *AtomicArena[T]) AppendSlice(objs []T) ([]*T, error)`\nAtomically reserves slots for each element in `objs`, storing them in the arena. Returns a slice of pointers to the stored values in the same order. If there is insufficient capacity to store all elements, no values are stored and an error is returned.\n\n### `(a *AtomicArena[T]) Reset(release bool)`\nClears all allocations, setting the element count back to zero.\nIf release is true, Reset additionally zeroes out the raw storage (memset-style) before resetting the count and pointers.\n\n## Example: Structs\n\n```go\n// Define a struct\n type Point struct { X, Y float64 }\n\n// Arena for 10 points\na := atomicarena.NewAtomicArena[Point](10)\n\n// Allocate two points\np1, _ := a.Alloc(Point{1, 2})\np2, _ := a.Alloc(Point{3, 4})\n\nfmt.Println(*p1, *p2)\n```\n\n## Testing\n\nA comprehensive test suite covers:\n\n- Allocating basic types (`int`, `string`, etc.) and structs\n- Bulk allocations via `AppendSlice`\n- Error on exceeding `maxElems`\n- `Reset()` correctness\n- High-concurrency allocations (data-race free)\n\nRun tests with:\n\n```bash\ngo test --bench=. --cover --race\n```\n\n![Screenshot from 2025-04-29 17-34-57](https://github.com/user-attachments/assets/9d263d80-8519-4118-be5d-1e7a53828f59)\n![output](https://github.com/user-attachments/assets/9fee7895-bd30-40b3-be3a-6af614c341e9)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraezil%2Fatomicarena","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraezil%2Fatomicarena","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraezil%2Fatomicarena/lists"}