feat template: added initial template framework

CMakeLists.txt

@@ -25,6 +25,7 @@ set(BFDEV_ARCH generic)
 set(BFDEV_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
 set(BFDEV_HEADER_PATH ${PROJECT_SOURCE_DIR}/include)
 set(BFDEV_SOURCE_PATH ${PROJECT_SOURCE_DIR}/src)
+set(BFDEV_TEMPLATE_PATH ${PROJECT_SOURCE_DIR}/template)
 set(BFDEV_PORT_PATH ${PROJECT_SOURCE_DIR}/port)
 set(BFDEV_DOCUMENT_PATH ${PROJECT_SOURCE_DIR}/docs)
 set(BFDEV_GENERATED_PATH ${PROJECT_BINARY_DIR}/generated)
@@ -83,11 +84,19 @@ endif()
 include(${PROJECT_SOURCE_DIR}/build.cmake)
 add_subdirectory(${PROJECT_SOURCE_DIR}/scripts)
 
+packed_header(
+    bfdev/template/
+    _BFDEV_TEMPLATE_H_
+    ${BFDEV_GENERATED_PATH}/bfdev/template.h
+    ${BFDEV_HEADER_PATH}/bfdev/template
+)
+
 packed_header(
     bfdev/
     _BFDEV_H_
     ${BFDEV_GENERATED_PATH}/bfdev.h
     ${BFDEV_HEADER_PATH}/bfdev
+    ${BFDEV_GENERATED_PATH}/bfdev
 )
 
 add_custom_target(

build.cmake

@@ -60,6 +60,7 @@ include(${BFDEV_PORT_PATH}/build.cmake)
 
 include(${BFDEV_ARCH_PATH}/build.cmake)
 include(${BFDEV_SOURCE_PATH}/build.cmake)
+include(${BFDEV_TEMPLATE_PATH}/build.cmake)
 
 configure_file(
     ${BFDEV_MODULE_PATH}/config.h.in

examples/btree/benchmark.c

@@ -10,6 +10,7 @@
 #include <stdlib.h>
 #include <bfdev/log.h>
 #include <bfdev/btree.h>
+#include <bfdev/template/btree.h>
 #include "../time.h"
 
 #define BTREE_DEBUG 0

examples/btree/selftest.c

@@ -9,6 +9,7 @@
 #include <time.h>
 #include <string.h>
 #include <bfdev/btree.h>
+#include <bfdev/template/btree.h>
 #include <bfdev/list.h>
 
 #define TEST_LOOP 100

include/bfdev/btree.h

@@ -58,36 +58,17 @@ struct bfdev_btree_ops {
 #define BFDEV_BTREE_ROOT(name, layout, ops, pdata) \
     bfdev_btree_root_t name = BFDEV_BTREE_INIT(layout, ops, pdata)
 
-extern bfdev_btree_layout_t
-bfdev_btree_layout32;
-
-extern bfdev_btree_layout_t
-bfdev_btree_layout64;
-
-extern bfdev_btree_layout_t
-bfdev_btree_layoutptr;
-
 static inline void
 bfdev_btree_init(bfdev_btree_root_t *root, bfdev_btree_layout_t *layout,
                  bfdev_btree_ops_t *ops, void *pdata)
 {
     *root = BFDEV_BTREE_INIT(layout, ops, pdata);
 }
 
-extern long
-bfdev_btree_key_find(bfdev_btree_root_t *root, bfdev_uintptr_t *node,
-                     bfdev_uintptr_t *key);
-
 extern void
 bfdev_btree_key_copy(bfdev_btree_root_t *root, bfdev_uintptr_t *dest,
                      bfdev_uintptr_t *src);
 
-extern void *
-bfdev_btree_alloc(bfdev_btree_root_t *root);
-
-extern void
-bfdev_btree_free(bfdev_btree_root_t *root, void *node);
-
 extern void *
 bfdev_btree_lookup(bfdev_btree_root_t *root, bfdev_uintptr_t *key);
 

include/bfdev/template/btree.h

@@ -0,0 +1,35 @@
+/* SPDX-License-Identifier: LGPL-3.0-or-later */
+/*
+ * Copyright(c) 2025 John Sanpe <sanpeqf@gmail.com>
+ */
+
+#ifndef _BFDEV_TEMPLATE_BTREE_H_
+#define _BFDEV_TEMPLATE_BTREE_H_
+
+#include <bfdev/config.h>
+#include <bfdev/btree.h>
+
+BFDEV_BEGIN_DECLS
+
+extern bfdev_btree_layout_t
+bfdev_btree_layout32;
+
+extern bfdev_btree_layout_t
+bfdev_btree_layout64;
+
+extern bfdev_btree_layout_t
+bfdev_btree_layoutptr;
+
+extern long
+bfdev_btree_key_find(bfdev_btree_root_t *root, bfdev_uintptr_t *node,
+                     bfdev_uintptr_t *key);
+
+extern void *
+bfdev_btree_alloc(bfdev_btree_root_t *root);
+
+extern void
+bfdev_btree_free(bfdev_btree_root_t *root, void *node);
+
+BFDEV_END_DECLS
+
+#endif /* _BFDEV_TEMPLATE_BTREE_H_ */

scripts/packed-header.cmake

@@ -3,9 +3,7 @@
 # Copyright(c) 2023 John Sanpe <sanpeqf@gmail.com>
 #
 
-function(packed_header prefix name genfile source)
-    file(GLOB srclist ${source}/*.h)
-
+function(packed_header prefix name genfile)
     file(REMOVE ${genfile})
     file(WRITE ${genfile}
         "/*\n"
@@ -18,13 +16,16 @@ function(packed_header prefix name genfile source)
         "\n"
     )
 
-    foreach(srcpath ${srclist})
-        string(REGEX REPLACE ".+/(.+)" "\\1" filename ${srcpath})
-        message(STATUS "Packing header: " ${prefix} ${filename})
+    foreach(source ${ARGN})
+        file(GLOB srclist ${source}/*.h)
+        foreach(srcpath ${srclist})
+            string(REGEX REPLACE ".+/(.+)" "\\1" filename ${srcpath})
+            message(STATUS "Packing header: " ${prefix} ${filename})
 
-        file(APPEND ${genfile}
-            "#include <" ${prefix} ${filename} ">\n"
-        )
+            file(APPEND ${genfile}
+                "#include <" ${prefix} ${filename} ">\n"
+            )
+        endforeach()
     endforeach()
 
     file(APPEND ${genfile}

src/build.cmake

@@ -16,7 +16,6 @@ set(BFDEV_SOURCE
     ${CMAKE_CURRENT_LIST_DIR}/bloom.c
     ${CMAKE_CURRENT_LIST_DIR}/bsearch.c
     ${CMAKE_CURRENT_LIST_DIR}/btree.c
-    ${CMAKE_CURRENT_LIST_DIR}/btree-utils.c
     ${CMAKE_CURRENT_LIST_DIR}/dword.c
     ${CMAKE_CURRENT_LIST_DIR}/callback.c
     ${CMAKE_CURRENT_LIST_DIR}/errname.c

src/btree-utils.c → template/btree.c

@@ -4,13 +4,17 @@
  */
 
 #include <base.h>
-#include <bfdev/btree.h>
+#include <bfdev/template/btree.h>
 #include <export.h>
 
 #define BLOCK_SIZE 128
 #define NODE_SIZE (BLOCK_SIZE - sizeof(bfdev_btree_node_t))
-#define UINTPTR_PER_U32 BFDEV_DIV_ROUND_UP(BFDEV_BYTES_PER_U32, BFDEV_BYTES_PER_UINTPTR)
-#define UINTPTR_PER_U64 BFDEV_DIV_ROUND_UP(BFDEV_BYTES_PER_U64, BFDEV_BYTES_PER_UINTPTR)
+
+#define UINTPTR_PER_U32 \
+    BFDEV_DIV_ROUND_UP(BFDEV_BYTES_PER_U32, BFDEV_BYTES_PER_UINTPTR)
+
+#define UINTPTR_PER_U64 \
+    BFDEV_DIV_ROUND_UP(BFDEV_BYTES_PER_U64, BFDEV_BYTES_PER_UINTPTR)
 
 export bfdev_btree_layout_t
 bfdev_btree_layout32 = {

template/build.cmake

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+#
+# Copyright(c) 2025 John Sanpe <sanpeqf@gmail.com>
+#
+
+set(BFDEV_SOURCE
+    ${BFDEV_SOURCE}
+    ${CMAKE_CURRENT_LIST_DIR}/btree.c
+)