From 887a9f559e71d8a788fbfe210f126eda5ba7969b Mon Sep 17 00:00:00 2001
From: Jonathan Bradley <jcb@pikum.xyz>
Date: Fri, 11 Oct 2024 18:41:47 -0400
Subject: initial commit: macros, memory, tests

---
 pkmem-types.h | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 pkmem-types.h

(limited to 'pkmem-types.h')

diff --git a/pkmem-types.h b/pkmem-types.h
new file mode 100644
index 0000000..27f6f50
--- /dev/null
+++ b/pkmem-types.h
@@ -0,0 +1,65 @@
+#ifndef PK_MEM_TYPES_H
+#define PK_MEM_TYPES_H
+
+#include <stdint.h>
+
+typedef uint32_t pk_handle_bucket_index_T;
+typedef uint32_t pk_handle_item_index_T;
+
+enum PK_HANDLE_VALIDATION : uint8_t {
+	PK_HANDLE_VALIDATION_VALID                      = 0,
+	PK_HANDLE_VALIDATION_BUCKET_INDEX_TOO_HIGH      = 1,
+	PK_HANDLE_VALIDATION_ITEM_INDEX_TOO_HIGH        = 2,
+	PK_HANDLE_VALIDATION_VALUE_MAX                  = 3,
+};
+
+struct pk_handle {
+	pk_handle_bucket_index_T bucketIndex;
+	pk_handle_item_index_T itemIndex;
+};
+
+const struct pk_handle pk_handle_MAX = (struct pk_handle){ .bucketIndex = 0xFFFFFFFF, .itemIndex = 0xFFFFFFFF };
+
+static inline enum PK_HANDLE_VALIDATION
+pk_handle_validate(const struct pk_handle handle, const struct pk_handle bucketHandle, const uint64_t maxItems)
+{
+	if (handle.bucketIndex == pk_handle_MAX.bucketIndex && handle.itemIndex == pk_handle_MAX.itemIndex)
+		return PK_HANDLE_VALIDATION_VALUE_MAX;
+	if (handle.bucketIndex > bucketHandle.bucketIndex)
+		return PK_HANDLE_VALIDATION_BUCKET_INDEX_TOO_HIGH;
+	if (handle.itemIndex > maxItems)
+		return PK_HANDLE_VALIDATION_ITEM_INDEX_TOO_HIGH;
+	if (handle.bucketIndex == bucketHandle.bucketIndex && handle.itemIndex > bucketHandle.itemIndex)
+		return PK_HANDLE_VALIDATION_ITEM_INDEX_TOO_HIGH;
+	return PK_HANDLE_VALIDATION_VALID;
+}
+
+#if defined(__cplusplus)
+
+constexpr struct pk_handle pk_handle_MAX_constexpr = (struct pk_handle){ .bucketIndex = 0xFFFFFFFF, .itemIndex = 0xFFFFFFFF };
+
+inline constexpr bool
+operator==(const pk_handle& lhs, const pk_handle& rhs)
+{
+	return lhs.bucketIndex == rhs.bucketIndex && lhs.itemIndex == rhs.itemIndex;
+}
+
+template<const pk_handle handle, const pk_handle bucketHandle, const uint64_t maxItems>
+inline constexpr enum PK_HANDLE_VALIDATION
+pk_handle_validate_constexpr()
+{
+	if constexpr (handle == pk_handle_MAX_constexpr)
+		return PK_HANDLE_VALIDATION_VALUE_MAX;
+	if constexpr (handle.bucketIndex > bucketHandle.bucketIndex)
+		return PK_HANDLE_VALIDATION_BUCKET_INDEX_TOO_HIGH;
+	if constexpr (handle.itemIndex > maxItems)
+		return PK_HANDLE_VALIDATION_ITEM_INDEX_TOO_HIGH;
+	if constexpr (handle.bucketIndex == bucketHandle.bucketIndex && handle.itemIndex > bucketHandle.itemIndex)
+		return PK_HANDLE_VALIDATION_ITEM_INDEX_TOO_HIGH;
+	return PK_HANDLE_VALIDATION_VALID;
+}
+#endif /* __cplusplus */
+
+struct pk_membucket;
+
+#endif /* PK_MEM_TYPES_H */
-- 
cgit v1.2.3