63 lines
2.3 KiB
Go
63 lines
2.3 KiB
Go
// Copyright (c) 2026 Karl Gaissmaier
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
// Package bart provides high-performance Balanced Routing Tables (BART)
|
|
// for fast IP-to-CIDR lookups on IPv4 and IPv6 addresses.
|
|
//
|
|
// BART offers three table variants optimized for different use cases:
|
|
//
|
|
// - Lite: Memory-optimized with popcount-compressed sparse arrays
|
|
// - Table: Full-featured with popcount-compressed sparse arrays
|
|
// - Fast: Speed-optimized with additional rank caching
|
|
//
|
|
// The implementation is based on Knuth's ART algorithm with novel
|
|
// optimizations for memory efficiency and lookup speed.
|
|
//
|
|
// `Table` and `Lite` use popcount compression for memory efficiency, while
|
|
// `Fast` trades additional memory and slower updates for maximum lookup
|
|
// speed: a child-rank cache is maintained on every insert/delete, so
|
|
// lookups avoid popcount but updates pay the caching cost.
|
|
//
|
|
// BART excels at efficient set operations on routing tables including Union,
|
|
// Overlaps, Equal, Subnets, and Supernets with optimal complexity, making it
|
|
// ideal for large-scale IP prefix matching in ACLs, RIBs, FIBs, firewalls,
|
|
// and routers.
|
|
//
|
|
// All variants also support copy-on-write persistence.
|
|
//
|
|
// For complex or pointer value types, you must provide custom deep cloning
|
|
// using Go's structural typing, implementing the following method on your
|
|
// value type V:
|
|
//
|
|
// func (v V) Clone() V
|
|
//
|
|
// For custom Equality implement the following method on your value type V:
|
|
//
|
|
// func (v V) Equal(other V) bool
|
|
//
|
|
// The bart package detects the interface satisfaction automatically at
|
|
// runtime using type assertions.
|
|
package bart
|
|
|
|
import (
|
|
"net/netip"
|
|
|
|
"github.com/gaissmai/bart/internal/nodes"
|
|
|
|
// inlining hint, see also the TestInlineBitSet256Functions.
|
|
// without this silent import the BitSet256 functions are not inlined
|
|
_ "github.com/gaissmai/bart/internal/bitset"
|
|
)
|
|
|
|
// stridePath is required in many places in the bart package and in
|
|
// internal/nodes. Aliased to keep the code readable.
|
|
type stridePath = nodes.StridePath
|
|
|
|
// DumpListNode contains CIDR, Value and Subnets, representing the trie
|
|
// in a sorted, recursive representation, especially useful for serialization.
|
|
type DumpListNode[V any] struct {
|
|
CIDR netip.Prefix `json:"cidr"`
|
|
Value V `json:"value"`
|
|
Subnets []DumpListNode[V] `json:"subnets,omitempty"`
|
|
}
|