turn lz4e compress and decompress into submodules, rename module dir to lz4e_bdev. Add more Makefile targets, add target for building lib without block device

Author: bygu4

.clang-format-ignore

@@ -1,3 +1,3 @@
 # Do not format lz4 library sources
 lz4e/*
-include/lz4e/*
+lz4e/include/*

Kbuild

@@ -1,13 +1,4 @@
 include $(PWD)/flags.mk
 
-lz4e-y := module/lz4e_module.o \
-	module/lz4e_dev.o \
-	module/lz4e_under_dev.o \
-	module/lz4e_req.o \
-	module/lz4e_chunk.o \
-	module/lz4e_stats.o
-
-lz4e-y += lz4e/lz4e_compress.o \
-	lz4e/lz4e_decompress.o
-
-obj-m := lz4e.o
+obj-m += lz4e/
+obj-m += lz4e_bdev/

Makefile

@@ -1,16 +1,87 @@
 KERNEL_VERSION := $(shell uname -r)
 KERNEL_SOURCES_DIR := /lib/modules/$(KERNEL_VERSION)/build
 
-OUTPUT_DIR := $(PWD)/build
-COMPILE_COMMANDS := $(PWD)/compile_commands.json
+LIB_NAME := lz4e
+COMPRESS_NAME := $(LIB_NAME)_compress
+DECOMPRESS_NAME := $(LIB_NAME)_decompress
+BDEV_NAME := $(LIB_NAME)_bdev
+
+ALL := $(PWD)
+LIB := $(ALL)/$(LIB_NAME)
+BDEV := $(ALL)/$(BDEV_NAME)
+
+OUTPUT_ALL := $(PWD)/build
+OUTPUT_LIB := $(OUTPUT_ALL)/$(LIB_NAME)
+OUTPUT_BDEV := $(OUTPUT_ALL)/$(BDEV_NAME)
+
+COMPRESS_OBJ := $(OUTPUT_LIB)/$(COMPRESS_NAME).ko
+DECOMPRESS_OBJ := $(OUTPUT_LIB)/$(DECOMPRESS_NAME).ko
+BDEV_OBJ := $(OUTPUT_BDEV)/$(BDEV_NAME).ko
+
+TEST_ALL := $(PWD)/test/test_all.sh
+
+# ---------------- All, lib and block dev----------------
 
 .PHONY: all
-all: build
+all:
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(ALL) MO=$(OUTPUT_ALL) modules
 
-.PHONY: build
-build:
-	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(PWD) MO=$(OUTPUT_DIR) modules
+.PHONY: install
+install:
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(ALL) MO=$(OUTPUT_ALL) modules_install
 
 .PHONY: clean
 clean:
-	rm -rf $(OUTPUT_DIR) $(COMPILE_COMMANDS)
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(ALL) MO=$(OUTPUT_ALL) clean
+	rm -rf $(OUTPUT_ALL)
+
+.PHONY: insert
+insert:
+	insmod $(COMPRESS_OBJ)
+	insmod $(DECOMPRESS_OBJ)
+	insmod $(BDEV_OBJ)
+
+.PHONY: remove
+remove:
+	rmmod $(BDEV_NAME) || true
+	rmmod $(DECOMPRESS_NAME) || true
+	rmmod $(COMPRESS_NAME) || true
+
+.PHONY: reinsert
+reinsert:
+	$(MAKE) remove && $(MAKE) insert
+
+# ---------------- Lib only ----------------
+
+.PHONY: lib
+lib:
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(LIB) MO=$(OUTPUT_LIB) modules
+
+.PHONY: lib_install
+lib_install:
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(LIB) MO=$(OUTPUT_LIB) modules_install
+
+.PHONY: lib_clean
+lib_clean:
+	$(MAKE) -j -C $(KERNEL_SOURCES_DIR) M=$(LIB) MO=$(OUTPUT_LIB) clean
+	rm -rf $(OUTPUT_LIB)
+
+.PHONY: lib_insert
+lib_insert:
+	insmod $(COMPRESS_OBJ)
+	insmod $(DECOMPRESS_OBJ)
+
+.PHONY: lib_remove
+lib_remove:
+	rmmod $(DECOMPRESS_NAME) || true
+	rmmod $(COMPRESS_NAME) || true
+
+.PHONY: lib_reinsert
+lib_reinsert:
+	$(MAKE) lib_remove && $(MAKE) lib_insert
+
+# ---------------- Testing ----------------
+
+.PHONY: test
+test:
+	$(MAKE) && $(SHELL) $(TEST_ALL)

include/lz4e/.clang-tidy

@@ -0,0 +1,4 @@
+include $(PWD)/flags.mk
+
+obj-m += lz4e_compress.o
+obj-m += lz4e_decompress.o

lz4e/Kbuild

@@ -35,11 +35,12 @@
  **************************************/
 #include <linux/bio.h>
 #include <linux/bvec.h>
+#include <linux/export.h>
 #include <linux/module.h>
 #include <linux/kernel.h>
 
-#include "include/lz4e/lz4e.h"
-#include "include/lz4e/lz4e_defs.h"
+#include "include/lz4e.h"
+#include "include/lz4e_defs.h"
 
 /*-******************************
  *	Compression functions
@@ -565,3 +566,8 @@ int LZ4E_compress_default(const struct bio_vec *src, struct bio_vec *dst,
 	return LZ4E_compress_fast_extState(wrkmem, src, dst, srcIter,
 		dstIter, LZ4E_ACCELERATION_DEFAULT);
 }
+EXPORT_SYMBOL(LZ4E_compress_default);
+
+MODULE_AUTHOR("Alexander Bugaev");
+MODULE_DESCRIPTION("LZ4 compression for scatter-gather buffers");
+MODULE_LICENSE("GPL");

include/lz4e/lz4e.h lz4e/include/lz4e.hinclude/lz4e/lz4e.h renamed to lz4e/include/lz4e.h

@@ -33,13 +33,14 @@
 /*-************************************
  *	Dependencies
  **************************************/
+#include <linux/export.h>
 #include <linux/init.h>
 #include <linux/module.h>
 #include <linux/kernel.h>
 #include <linux/unaligned.h>
 
-#include "include/lz4e/lz4e.h"
-#include "include/lz4e/lz4e_defs.h"
+#include "include/lz4e.h"
+#include "include/lz4e_defs.h"
 
 /*-*****************************
  *	Decompression functions
@@ -466,3 +467,8 @@ int LZ4E_decompress_safe(const char *source, char *dest,
 				      endOnInputSize, decode_full_block,
 				      noDict, (BYTE *)dest, NULL, 0);
 }
+EXPORT_SYMBOL(LZ4E_decompress_safe);
+
+MODULE_AUTHOR("");
+MODULE_DESCRIPTION("LZ4 decompression for scatter-gather buffers");
+MODULE_LICENSE("GPL");

include/lz4e/lz4e_defs.h lz4e/include/lz4e_defs.hinclude/lz4e/lz4e_defs.h renamed to lz4e/include/lz4e_defs.h

@@ -0,0 +1,10 @@
+include $(PWD)/flags.mk
+
+lz4e_bdev-y := lz4e_module.o \
+	lz4e_dev.o \
+	lz4e_under_dev.o \
+	lz4e_req.o \
+	lz4e_chunk.o \
+	lz4e_stats.o
+
+obj-m := lz4e_bdev.o