# *UPDATE* 'KDIR' below to point to the ARM Linux kernel source tree on your box

KDIR ?= ~/rpi_work/kernel_rpi/linux

else ifeq ($(ARCH),arm64)

# *UPDATE* 'KDIR' below to point to the ARM64 (Aarch64) Linux kernel source

# tree on your box

KDIR ?= ~/kernel/linux-4.14

# *UPDATE* 'KDIR' below to point to the PPC64 Linux kernel source tree on your box

KDIR ?= ~/kernel/linux-4.9.1

# 'KDIR' is the Linux 'kernel headers' package on your host system; this is

# usually an x86_64, but could be anything, really (f.e. building directly

# on a Raspberry Pi implies that it's the host)

KDIR ?= /lib/modules/$(shell uname -r)/build

FNAME_C := deadlock_eg_AB-BA

PWD := $(shell pwd)

obj-m += ${FNAME_C}.o

@echo

@echo '--- Building : KDIR=${KDIR} ARCH=${ARCH} CROSS_COMPILE=${CROSS_COMPILE} EXTRA_CFLAGS=${EXTRA_CFLAGS} ---'

@echo

@echo

@echo "--- installing ---"

@echo " [First, invoke the 'make' ]"

make

@echo

@echo " [Now for the 'sudo make install' ]"

sudo make -C $(KDIR) M=$(PWD) modules_install

sudo depmod

@echo

@echo "--- cleaning ---"

@echo

rm -f *~ # from 'indent'

INDENT := indent

code-style:

make indent

make checkpatch

indent:

@echo

@echo "--- applying kernel code style indentation with indent ---"

@echo

mkdir bkp 2> /dev/null; cp -f *.[chsS] bkp/

${INDENT} -linux --line-length95 *.[chsS]

# add source files as required

checkpatch:

make clean

@echo

@echo "--- kernel code style check with checkpatch.pl ---"

@echo

$(KDIR)/scripts/checkpatch.pl --no-tree -f --max-line-length=95 *.[ch]

# add source files as required

sa:

make sa_sparse

make sa_gcc

make sa_flawfinder

make sa_cppcheck

sa_sparse:

make clean

@echo

@echo "--- static analysis with sparse ---"

@echo

make C=2 CHECK="/usr/bin/sparse" -C $(KDIR) M=$(PWD) modules

sa_gcc:

make clean

@echo

@echo "--- static analysis with gcc ---"

@echo

make W=1 -C $(KDIR) M=$(PWD) modules

sa_flawfinder:

make clean

@echo

@echo "--- static analysis with flawfinder ---"

@echo

flawfinder *.[ch]

sa_cppcheck:

make clean

@echo

@echo "--- static analysis with cppcheck ---"

@echo

cppcheck -v --force --enable=all -i .tmp_versions/ -i *.mod.c -i bkp/ --suppress=missingIncludeSystem .

PKG_NAME := ${FNAME_C}

tarxz-pkg:

rm -f ../${PKG_NAME}.tar.xz 2>/dev/null

make clean

@echo

@echo "--- packaging ---"

@echo

tar caf ../${PKG_NAME}.tar.xz *

ls -l ../${PKG_NAME}.tar.xz

@echo '=== package created: ../$(PKG_NAME).tar.xz ==='

@echo 'Tip: when extracting, to extract into a dir of the same name as the tar file,'

@echo ' do: tar -xvf ${PKG_NAME}.tar.xz --one-top-level'

help:

@echo '=== Makefile Help : additional targets available ==='

@echo

@echo 'TIP: type make <tab><tab> to show all valid targets'

@echo

@echo '--- 'usual' kernel LKM targets ---'

@echo 'typing "make" or "all" target : builds the kernel module object (the .ko)'

@echo 'install : installs the kernel module(s) to INSTALL_MOD_PATH (default here: /lib/modules/$(shell uname -r)/)'

@echo 'clean : cleanup - remove all kernel objects, temp files/dirs, etc'

@echo

@echo '--- kernel code style targets ---'

@echo 'code-style : "wrapper" target over the following kernel code style targets'

@echo ' indent : run the $(INDENT) utility on source file(s) to indent them as per the kernel code style'

@echo ' checkpatch : run the kernel code style checker tool on source file(s)'

@echo

@echo '--- kernel static analyzer targets ---'

@echo 'sa : "wrapper" target over the following kernel static analyzer targets'

@echo ' sa_sparse : run the static analysis sparse tool on the source file(s)'

@echo ' sa_gcc : run gcc with option -W1 ("Generally useful warnings") on the source file(s)'

@echo ' sa_flawfinder : run the static analysis flawfinder tool on the source file(s)'

@echo ' sa_cppcheck : run the static analysis cppcheck tool on the source file(s)'

@echo 'TIP: use coccinelle as well (requires spatch): https://www.kernel.org/doc/html/v4.15/dev-tools/coccinelle.html'

@echo

@echo '--- kernel dynamic analysis targets ---'

@echo 'da_kasan : DUMMY target: this is to remind you to run your code with the dynamic analysis KASAN tool enabled; requires configuring the kernel with CONFIG_KASAN On, rebuild and boot it'

@echo 'da_lockdep : DUMMY target: this is to remind you to run your code with the dynamic analysis LOCKDEP tool (for deep locking issues analysis) enabled; requires configuring the kernel with CONFIG_PROVE_LOCKING On, rebuild and boot it'

@echo 'TIP: best to build a debug kernel with several kernel debug config options turned On, boot via it and run all your test cases'

@echo

@echo '--- misc targets ---'

@echo 'tarxz-pkg : tar and compress the LKM source files as a tar.xz into the dir above; allows one to transfer and build the module on another system'

@echo ' Tip: when extracting, to extract into a dir of the same name as the tar file,'

@echo ' do: tar -xvf ${PKG_NAME}.tar.xz --one-top-level'

@echo 'help : this help target'