xref: /freebsd/sys/conf/kmod.mk (revision 273c26a3c3bea87a241d6879abd4f991db180bf0) 
1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD$
3#
4# The include file <bsd.kmod.mk> handles building and installing loadable
5# kernel modules.
6#
7#
8# +++ variables +++
9#
10# CLEANFILES	Additional files to remove for the clean and cleandir targets.
11#
12# EXPORT_SYMS	A list of symbols that should be exported from the module,
13#		or the name of a file containing a list of symbols, or YES
14#		to export all symbols.  If not defined, no symbols are
15#		exported.
16#
17# KMOD		The name of the kernel module to build.
18#
19# KMODDIR	Base path for kernel modules (see kld(4)). [/boot/kernel]
20#
21# KMODOWN	Module file owner. [${BINOWN}]
22#
23# KMODGRP	Module file group. [${BINGRP}]
24#
25# KMODMODE	Module file mode. [${BINMODE}]
26#
27# KMODLOAD	Command to load a kernel module [/sbin/kldload]
28#
29# KMODUNLOAD	Command to unload a kernel module [/sbin/kldunload]
30#
31# KMODISLOADED	Command to check whether a kernel module is
32#		loaded [/sbin/kldstat -q -n]
33#
34# PROG		The name of the kernel module to build.
35#		If not supplied, ${KMOD}.ko is used.
36#
37# SRCS		List of source files.
38#
39# FIRMWS	List of firmware images in format filename:shortname:version
40#
41# FIRMWARE_LICENSE
42#		Set to the name of the license the user has to agree on in
43#		order to use this firmware. See /usr/share/doc/legal
44#
45# DESTDIR	The tree where the module gets installed. [not set]
46#
47# +++ targets +++
48#
49# 	install:
50#               install the kernel module; if the Makefile
51#               does not itself define the target install, the targets
52#               beforeinstall and afterinstall may also be used to cause
53#               actions immediately before and after the install target
54#		is executed.
55#
56# 	load:
57#		Load a module.
58#
59# 	unload:
60#		Unload a module.
61#
62#	reload:
63#		Unload if loaded, then load.
64#
65
66AWK?=		awk
67KMODLOAD?=	/sbin/kldload
68KMODUNLOAD?=	/sbin/kldunload
69KMODISLOADED?=	/sbin/kldstat -q -n
70OBJCOPY?=	objcopy
71
72.include <bsd.init.mk>
73# Grab all the options for a kernel build. For backwards compat, we need to
74# do this after bsd.own.mk.
75.include "kern.opts.mk"
76.include <bsd.compiler.mk>
77.include "config.mk"
78
79# Search for kernel source tree in standard places.
80.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
81.if !defined(SYSDIR) && exists(${_dir}/kern/)
82SYSDIR=	${_dir:tA}
83.endif
84.endfor
85.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
86.error "can't find kernel source tree"
87.endif
88
89.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S .m
90
91# amd64 and mips use direct linking for kmod, all others use shared binaries
92.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
93__KLD_SHARED=yes
94.else
95__KLD_SHARED=no
96.endif
97
98.if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
99CFLAGS+=	-fno-strict-aliasing
100.endif
101WERROR?=	-Werror
102CFLAGS+=	${WERROR}
103CFLAGS+=	-D_KERNEL
104CFLAGS+=	-DKLD_MODULE
105
106# Don't use any standard or source-relative include directories.
107NOSTDINC=	-nostdinc
108CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
109.if defined(KERNBUILDDIR)
110CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
111.endif
112
113# Add -I paths for system headers.  Individual module makefiles don't
114# need any -I paths for this.  Similar defaults for .PATH can't be
115# set because there are no standard paths for non-headers.
116CFLAGS+=	-I. -I${SYSDIR}
117
118CFLAGS.gcc+=	-finline-limit=${INLINE_LIMIT}
119CFLAGS.gcc+=	-fms-extensions
120CFLAGS.gcc+= --param inline-unit-growth=100
121CFLAGS.gcc+= --param large-function-growth=1000
122
123# Disallow common variables, and if we end up with commons from
124# somewhere unexpected, allocate storage for them in the module itself.
125CFLAGS+=	-fno-common
126LDFLAGS+=	-d -warn-common
127
128CFLAGS+=	${DEBUG_FLAGS}
129.if ${MACHINE_CPUARCH} == amd64
130CFLAGS+=	-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
131.endif
132
133.if ${MACHINE_CPUARCH} == "aarch64" || ${MACHINE_CPUARCH} == "riscv"
134CFLAGS+=	-fPIC
135.endif
136
137# Temporary workaround for PR 196407, which contains the fascinating details.
138# Don't allow clang to use fpu instructions or registers in kernel modules.
139.if ${MACHINE_CPUARCH} == arm
140.if ${COMPILER_VERSION} < 30800
141CFLAGS.clang+=	-mllvm -arm-use-movt=0
142.else
143CFLAGS.clang+=	-mno-movt
144.endif
145CFLAGS.clang+=	-mfpu=none
146CFLAGS+=	-funwind-tables
147.endif
148
149.if ${MACHINE_CPUARCH} == powerpc
150CFLAGS+=	-mlongcall -fno-omit-frame-pointer
151.endif
152
153.if ${MACHINE_CPUARCH} == mips
154CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
155.endif
156
157.if defined(DEBUG) || defined(DEBUG_FLAGS)
158CTFFLAGS+=	-g
159.endif
160
161.if defined(FIRMWS)
162${KMOD:S/$/.c/}: ${SYSDIR}/tools/fw_stub.awk
163	${AWK} -f ${SYSDIR}/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
164	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
165
166SRCS+=	${KMOD:S/$/.c/}
167CLEANFILES+=	${KMOD:S/$/.c/}
168
169.for _firmw in ${FIRMWS}
170${_firmw:C/\:.*$/.fwo/:T}:	${_firmw:C/\:.*$//}
171	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
172	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
173		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
174		    -m ${LD_EMULATION} -r -d			\
175		    -o ${.TARGET} ${_firmw:C/\:.*$//};		\
176	else							\
177		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
178		${LD} -b binary --no-warn-mismatch ${_LDFLAGS}	\
179		    -m ${LD_EMULATION} -r -d			\
180		    -o ${.TARGET} ${_firmw:C/\:.*$//};		\
181		rm ${_firmw:C/\:.*$//};				\
182	fi
183
184OBJS+=	${_firmw:C/\:.*$/.fwo/:T}
185.endfor
186.endif
187
188# Conditionally include SRCS based on kernel config options.
189.for _o in ${KERN_OPTS}
190SRCS+=${SRCS.${_o}}
191.endfor
192
193OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
194
195.if !defined(PROG)
196PROG=	${KMOD}.ko
197.endif
198
199.if !defined(DEBUG_FLAGS)
200FULLPROG=	${PROG}
201.else
202FULLPROG=	${PROG}.full
203${PROG}: ${FULLPROG} ${PROG}.debug
204	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.debug \
205	    ${FULLPROG} ${.TARGET}
206${PROG}.debug: ${FULLPROG}
207	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
208.endif
209
210.if ${__KLD_SHARED} == yes
211${FULLPROG}: ${KMOD}.kld
212.if ${MACHINE_CPUARCH} != "aarch64"
213	${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${KMOD}.kld
214.else
215#XXXKIB Relocatable linking in aarch64 ld from binutils 2.25.1 does
216#       not work.  The linker corrupts the references to the external
217#       symbols which are defined by other object in the linking set
218#       and should therefore loose the GOT entry.  The problem seems
219#       to be fixed in the binutils-gdb git HEAD as of 2015-10-04.  Hack
220#       below allows to get partially functioning modules for now.
221	${LD} -Bshareable ${_LDFLAGS} -o ${.TARGET} ${OBJS}
222.endif
223.if !defined(DEBUG_FLAGS)
224	${OBJCOPY} --strip-debug ${.TARGET}
225.endif
226.endif
227
228EXPORT_SYMS?=	NO
229.if ${EXPORT_SYMS} != YES
230CLEANFILES+=	export_syms
231.endif
232
233.if ${__KLD_SHARED} == yes
234${KMOD}.kld: ${OBJS}
235.else
236${FULLPROG}: ${OBJS}
237.endif
238	${LD} ${_LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
239.if ${MK_CTF} != "no"
240	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
241.endif
242.if defined(EXPORT_SYMS)
243.if ${EXPORT_SYMS} != YES
244.if ${EXPORT_SYMS} == NO
245	:> export_syms
246.elif !exists(${.CURDIR}/${EXPORT_SYMS})
247	echo ${EXPORT_SYMS} > export_syms
248.else
249	grep -v '^#' < ${EXPORT_SYMS} > export_syms
250.endif
251	${AWK} -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
252	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
253.endif
254.endif
255.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
256	${OBJCOPY} --strip-debug ${.TARGET}
257.endif
258
259_ILINKS=machine
260.if ${MACHINE} != ${MACHINE_CPUARCH} && ${MACHINE} != "arm64"
261_ILINKS+=${MACHINE_CPUARCH}
262.endif
263.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
264_ILINKS+=x86
265.endif
266CLEANFILES+=${_ILINKS}
267
268all: ${PROG}
269
270beforedepend: ${_ILINKS}
271beforebuild: ${_ILINKS}
272
273# Ensure that the links exist without depending on it when it exists which
274# causes all the modules to be rebuilt when the directory pointed to changes.
275.for _link in ${_ILINKS}
276.if !exists(${.OBJDIR}/${_link})
277${OBJS}: ${_link}
278.endif
279.endfor
280
281.NOPATH: ${_ILINKS}
282
283${_ILINKS}:
284	@case ${.TARGET} in \
285	machine) \
286		path=${SYSDIR}/${MACHINE}/include ;; \
287	*) \
288		path=${SYSDIR}/${.TARGET:T}/include ;; \
289	esac ; \
290	path=`(cd $$path && /bin/pwd)` ; \
291	${ECHO} ${.TARGET:T} "->" $$path ; \
292	ln -fhs $$path ${.TARGET:T}
293
294CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
295
296.if defined(DEBUG_FLAGS)
297CLEANFILES+= ${FULLPROG} ${PROG}.debug
298.endif
299
300.if !target(install)
301
302_INSTALLFLAGS:=	${INSTALLFLAGS}
303.for ie in ${INSTALLFLAGS_EDIT}
304_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
305.endfor
306
307.if !target(realinstall)
308KERN_DEBUGDIR?=	${DEBUGDIR}
309realinstall: _kmodinstall
310.ORDER: beforeinstall _kmodinstall
311_kmodinstall: .PHONY
312	${INSTALL} -T release -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
313	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}/
314.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
315	${INSTALL} -T debug -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
316	    ${_INSTALLFLAGS} ${PROG}.debug ${DESTDIR}${KERN_DEBUGDIR}${KMODDIR}/
317.endif
318
319.include <bsd.links.mk>
320
321.if !defined(NO_XREF)
322afterinstall: _kldxref
323.ORDER: realinstall _kldxref
324.ORDER: _installlinks _kldxref
325_kldxref: .PHONY
326	@if type kldxref >/dev/null 2>&1; then \
327		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
328		kldxref ${DESTDIR}${KMODDIR}; \
329	fi
330.endif
331.endif # !target(realinstall)
332
333.endif # !target(install)
334
335.if !target(load)
336load: ${PROG} .PHONY
337	${KMODLOAD} -v ${.OBJDIR}/${PROG}
338.endif
339
340.if !target(unload)
341unload: .PHONY
342	if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
343.endif
344
345.if !target(reload)
346reload: unload load .PHONY
347.endif
348
349.if defined(KERNBUILDDIR)
350.PATH: ${KERNBUILDDIR}
351CFLAGS+=	-I${KERNBUILDDIR}
352.for _src in ${SRCS:Mopt_*.h}
353CLEANFILES+=	${_src}
354.if !target(${_src})
355${_src}:
356	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
357.endif
358.endfor
359.else
360.for _src in ${SRCS:Mopt_*.h}
361CLEANFILES+=	${_src}
362.if !target(${_src})
363${_src}:
364	:> ${.TARGET}
365.endif
366.endfor
367.endif
368
369# Respect configuration-specific C flags.
370CFLAGS+=	${CONF_CFLAGS}
371
372.if !empty(SRCS:Mvnode_if.c)
373CLEANFILES+=	vnode_if.c
374vnode_if.c: ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src
375	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -c
376.endif
377
378.if !empty(SRCS:Mvnode_if.h)
379CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
380vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: ${SYSDIR}/tools/vnode_if.awk \
381    ${SYSDIR}/kern/vnode_if.src
382vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
383	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -h
384vnode_if_newproto.h:
385	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -p
386vnode_if_typedef.h:
387	${AWK} -f ${SYSDIR}/tools/vnode_if.awk ${SYSDIR}/kern/vnode_if.src -q
388.endif
389
390# Build _if.[ch] from _if.m, and clean them when we're done.
391# __MPATH defined in config.mk
392_MFILES=${__MPATH:T:O}
393_MPATH=${__MPATH:H:O:u}
394.PATH.m: ${_MPATH}
395.for _i in ${SRCS:M*_if.[ch]}
396_MATCH=M${_i:R:S/$/.m/}
397_MATCHES=${_MFILES:${_MATCH}}
398.if !empty(_MATCHES)
399CLEANFILES+=	${_i}
400.endif
401.endfor # _i
402.m.c:	${SYSDIR}/tools/makeobjops.awk
403	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -c
404
405.m.h:	${SYSDIR}/tools/makeobjops.awk
406	${AWK} -f ${SYSDIR}/tools/makeobjops.awk ${.IMPSRC} -h
407
408.for _i in mii pccard
409.if !empty(SRCS:M${_i}devs.h)
410CLEANFILES+=	${_i}devs.h
411${_i}devs.h: ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
412	${AWK} -f ${SYSDIR}/tools/${_i}devs2h.awk ${SYSDIR}/dev/${_i}/${_i}devs
413.endif
414.endfor # _i
415
416.if !empty(SRCS:Mbhnd_nvram_map.h)
417CLEANFILES+=	bhnd_nvram_map.h
418bhnd_nvram_map.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
419    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
420    ${SYSDIR}/dev/bhnd/nvram/nvram_map
421bhnd_nvram_map.h:
422	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
423	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -h
424.endif
425
426.if !empty(SRCS:Mbhnd_nvram_map_data.h)
427CLEANFILES+=	bhnd_nvram_map_data.h
428bhnd_nvram_map_data.h: ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.awk \
429    ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
430    ${SYSDIR}/dev/bhnd/nvram/nvram_map
431bhnd_nvram_map_data.h:
432	sh ${SYSDIR}/dev/bhnd/tools/nvram_map_gen.sh \
433	    ${SYSDIR}/dev/bhnd/nvram/nvram_map -d
434.endif
435
436.if !empty(SRCS:Musbdevs.h)
437CLEANFILES+=	usbdevs.h
438usbdevs.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
439	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -h
440.endif
441
442.if !empty(SRCS:Musbdevs_data.h)
443CLEANFILES+=	usbdevs_data.h
444usbdevs_data.h: ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs
445	${AWK} -f ${SYSDIR}/tools/usbdevs2h.awk ${SYSDIR}/dev/usb/usbdevs -d
446.endif
447
448.if !empty(SRCS:Macpi_quirks.h)
449CLEANFILES+=	acpi_quirks.h
450acpi_quirks.h: ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
451	${AWK} -f ${SYSDIR}/tools/acpi_quirks2h.awk ${SYSDIR}/dev/acpica/acpi_quirks
452.endif
453
454.if !empty(SRCS:Massym.s)
455CLEANFILES+=	assym.s genassym.o
456assym.s: genassym.o
457.if defined(KERNBUILDDIR)
458genassym.o: opt_global.h
459.endif
460assym.s: ${SYSDIR}/kern/genassym.sh
461	sh ${SYSDIR}/kern/genassym.sh genassym.o > ${.TARGET}
462genassym.o: ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
463genassym.o: ${SRCS:Mopt_*.h}
464	${CC} -c ${CFLAGS:N-fno-common} \
465	    ${SYSDIR}/${MACHINE}/${MACHINE}/genassym.c
466.endif
467
468lint: ${SRCS}
469	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
470
471.if defined(KERNBUILDDIR)
472${OBJS}: opt_global.h
473.endif
474
475CLEANDEPENDFILES+=	${_ILINKS}
476# .depend needs include links so we remove them only together.
477cleanilinks:
478	rm -f ${_ILINKS}
479
480OBJS_DEPEND_GUESS+= ${SRCS:M*.h}
481
482.include <bsd.dep.mk>
483.include <bsd.clang-analyze.mk>
484.include <bsd.obj.mk>
485.include "kern.mk"
486