First commit, Vystem v0.1

shelter/lib/include/memory/pez/radix.h

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: MPL-2.0
+#ifndef SH_LIB_RADIX_H
+#define SH_LIB_RADIX_H
+#include "std/type.h"
+#include "memory/page.h"
+struct sh_slab_radix_node_SLAB_ALLOCATOR;
+#define SH_RADIX_NODE_SIZE_BYTES 128
+// Radix node structure
+typedef struct {
+  sh_page_VIRTUAL_ADDRESS ptr[16];
+} sh_radix_NODE;
+// Radix tree structure
+typedef struct {
+  sh_radix_NODE *root_node;
+  sh_uint8 depth;
+} sh_radix_TREE;
+// Return the value at the indicated index. Return SH_STATUS_NOT_FOUND if index indicate an empty ptr. Automatically fill the 16 higher bits in the returned value if index=0, no matter that provided node is a intermediary node or a leaf
+SH_STATUS sh_radix_node_read_value(sh_radix_NODE *node,sh_uint8 index,sh_page_VIRTUAL_ADDRESS* value);
+// Modify the value at the indicated index. Update the bitmap accordingly, all non-zero value corresponding to 1 in the bitmap, otherwise 0.
+SH_STATUS sh_radix_node_set_value(struct sh_slab_radix_node_SLAB_ALLOCATOR *alloc,sh_radix_NODE *node,sh_uint8 index,sh_page_VIRTUAL_ADDRESS value);
+// Initialize a radix tree. Fail if depth is greater than 16
+SH_STATUS sh_radix_tree_init(struct sh_slab_radix_node_SLAB_ALLOCATOR *alloc,sh_page_PAGE_TABLE_POOL *ptp,sh_radix_TREE *tree,sh_uint8 depth);
+// Search in a straight line for a key inside the tree. Stop and return SH_STATUS_NOT_FOUND as soon as it hit a empty ptr where there should be one
+SH_STATUS sh_radix_tree_get_value(sh_radix_TREE *tree,sh_uint64 key,sh_page_VIRTUAL_ADDRESS *value);
+// Insert a value inside the tree. Can allocate new nodes if necessary. Will overwrite previous value if there was one already inserted. Automatically update bitmap on his path
+SH_STATUS sh_radix_tree_insert_value(struct sh_slab_radix_node_SLAB_ALLOCATOR *alloc,sh_page_PAGE_TABLE_POOL *ptp,sh_radix_TREE *tree,sh_uint64 key,sh_page_VIRTUAL_ADDRESS value);
+// Delete a value and deallocates all nodes (including leaf) that form a path to it if this deletion make them empty
+SH_STATUS sh_radix_tree_delete_value(struct sh_slab_radix_node_SLAB_ALLOCATOR *alloc,sh_radix_TREE *tree,sh_uint64 key);
+// Return the value that has the smallest key equal or greater than the provided key. Can't allocate new nodes.
+SH_STATUS sh_radix_tree_search_smallest_min_bound(struct sh_slab_radix_node_SLAB_ALLOCATOR *alloc,sh_radix_TREE *tree,sh_uint64 lower_bound_key,sh_page_VIRTUAL_ADDRESS *value);
+#endif