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