1#	From: @(#)bsd.prog.mk	5.26 (Berkeley) 6/25/91
2# $FreeBSD: stable/10/sys/conf/kmod.mk 324643 2017-10-15 22:45:25Z brooks $
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# MFILES	Optionally a list of interfaces used by the module.
32#		This file contains a default list of interfaces.
33#
34# KMODISLOADED	Command to check whether a kernel module is
35#		loaded [/sbin/kldstat -q -n]
36#
37# PROG		The name of the kernel module to build.
38#		If not supplied, ${KMOD}.ko is used.
39#
40# SRCS		List of source files.
41#
42# FIRMWS	List of firmware images in format filename:shortname:version
43#
44# FIRMWARE_LICENSE
45#		Set to the name of the license the user has to agree on in
46#		order to use this firmware. See /usr/share/doc/legal
47#
48# DESTDIR	The tree where the module gets installed. [not set]
49#
50# +++ targets +++
51#
52# 	install:
53#               install the kernel module; if the Makefile
54#               does not itself define the target install, the targets
55#               beforeinstall and afterinstall may also be used to cause
56#               actions immediately before and after the install target
57#		is executed.
58#
59# 	load:
60#		Load a module.
61#
62# 	unload:
63#		Unload a module.
64#
65#	reload:
66#		Unload if loaded, then load.
67#
68
69# backwards compat option for older systems.
70MACHINE_CPUARCH?=${MACHINE_ARCH:C/mips(n32|64)?(el)?/mips/:C/arm(v6)?(eb)?/arm/:C/powerpc64/powerpc/}
71
72AWK?=		awk
73KMODLOAD?=	/sbin/kldload
74KMODUNLOAD?=	/sbin/kldunload
75KMODISLOADED?=	/sbin/kldstat -q -n
76OBJCOPY?=	objcopy
77
78.if defined(KMODDEPS)
79.error "Do not use KMODDEPS on 5.0+; use MODULE_VERSION/MODULE_DEPEND"
80.endif
81
82.include <bsd.init.mk>
83.include <bsd.compiler.mk>
84
85.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
86
87# amd64 and mips use direct linking for kmod, all others use shared binaries
88.if ${MACHINE_CPUARCH} != amd64 && ${MACHINE_CPUARCH} != mips
89__KLD_SHARED=yes
90.else
91__KLD_SHARED=no
92.endif
93
94.if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
95CFLAGS+=	-fno-strict-aliasing
96.endif
97WERROR?=	-Werror
98CFLAGS+=	${WERROR}
99CFLAGS+=	-D_KERNEL
100CFLAGS+=	-DKLD_MODULE
101
102# Don't use any standard or source-relative include directories.
103CSTD=		c99
104NOSTDINC=	-nostdinc
105CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
106.if defined(KERNBUILDDIR)
107CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
108.endif
109
110# Add -I paths for system headers.  Individual module makefiles don't
111# need any -I paths for this.  Similar defaults for .PATH can't be
112# set because there are no standard paths for non-headers.
113CFLAGS+=	-I. -I@
114
115# Add -I path for altq headers as they are included via net/if_var.h
116# for example.
117CFLAGS+=	-I@/contrib/altq
118
119.if ${COMPILER_TYPE} != "clang"
120CFLAGS+=	-finline-limit=${INLINE_LIMIT}
121CFLAGS+= --param inline-unit-growth=100
122CFLAGS+= --param large-function-growth=1000
123.endif
124
125# Disallow common variables, and if we end up with commons from
126# somewhere unexpected, allocate storage for them in the module itself.
127CFLAGS+=	-fno-common
128LDFLAGS+=	-d -warn-common
129
130CFLAGS+=	${DEBUG_FLAGS}
131.if ${MACHINE_CPUARCH} == amd64
132CFLAGS+=	-fno-omit-frame-pointer -mno-omit-leaf-frame-pointer
133.endif
134
135# Temporary workaround for PR 196407, which contains the fascinating details.
136# Don't allow clang to use fpu instructions or registers in kernel modules.
137.if ${MACHINE_CPUARCH} == arm
138CFLAGS.clang+=	-mllvm -arm-use-movt=0
139CFLAGS.clang+=	-mfpu=none
140.endif
141
142.if ${MACHINE_CPUARCH} == powerpc
143CFLAGS+=	-mlongcall -fno-omit-frame-pointer
144.endif
145
146.if ${MACHINE_CPUARCH} == mips
147CFLAGS+=	-G0 -fno-pic -mno-abicalls -mlong-calls
148.endif
149
150.if defined(DEBUG) || defined(DEBUG_FLAGS)
151CTFFLAGS+=	-g
152.endif
153
154.if defined(FIRMWS)
155.if !exists(@)
156${KMOD:S/$/.c/}: @
157.else
158${KMOD:S/$/.c/}: @/tools/fw_stub.awk
159.endif
160	${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
161	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
162
163SRCS+=	${KMOD:S/$/.c/}
164CLEANFILES+=	${KMOD:S/$/.c/}
165
166.for _firmw in ${FIRMWS}
167${_firmw:C/\:.*$/.fwo/:T}:	${_firmw:C/\:.*$//}
168	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
169	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
170		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
171		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
172	else							\
173		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
174		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
175		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
176		rm ${_firmw:C/\:.*$//};				\
177	fi
178
179OBJS+=	${_firmw:C/\:.*$/.fwo/:T}
180.endfor
181.endif
182
183OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
184
185.if !defined(PROG)
186PROG=	${KMOD}.ko
187.endif
188
189.if !defined(DEBUG_FLAGS)
190FULLPROG=	${PROG}
191.else
192FULLPROG=	${PROG}.debug
193${PROG}: ${FULLPROG} ${PROG}.symbols
194	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
195	    ${FULLPROG} ${.TARGET}
196${PROG}.symbols: ${FULLPROG}
197	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
198.endif
199
200.if ${__KLD_SHARED} == yes
201${FULLPROG}: ${KMOD}.kld
202	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
203.if !defined(DEBUG_FLAGS)
204	${OBJCOPY} --strip-debug ${.TARGET}
205.endif
206.endif
207
208EXPORT_SYMS?=	NO
209.if ${EXPORT_SYMS} != YES
210CLEANFILES+=	export_syms
211.endif
212
213.if ${__KLD_SHARED} == yes
214${KMOD}.kld: ${OBJS}
215.else
216${FULLPROG}: ${OBJS}
217.endif
218	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
219.if defined(MK_CTF) && ${MK_CTF} != "no"
220	${CTFMERGE} ${CTFFLAGS} -o ${.TARGET} ${OBJS}
221.endif
222.if defined(EXPORT_SYMS)
223.if ${EXPORT_SYMS} != YES
224.if ${EXPORT_SYMS} == NO
225	:> export_syms
226.elif !exists(${.CURDIR}/${EXPORT_SYMS})
227	echo ${EXPORT_SYMS} > export_syms
228.else
229	grep -v '^#' < ${EXPORT_SYMS} > export_syms
230.endif
231	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
232	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
233.endif
234.endif
235.if !defined(DEBUG_FLAGS) && ${__KLD_SHARED} == no
236	${OBJCOPY} --strip-debug ${.TARGET}
237.endif
238
239_ILINKS=@ machine
240.if ${MACHINE} != ${MACHINE_CPUARCH}
241_ILINKS+=${MACHINE_CPUARCH}
242.endif
243.if ${MACHINE_CPUARCH} == "i386" || ${MACHINE_CPUARCH} == "amd64"
244_ILINKS+=x86
245.endif
246
247all: objwarn ${PROG}
248
249beforedepend: ${_ILINKS}
250
251# Ensure that the links exist without depending on it when it exists which
252# causes all the modules to be rebuilt when the directory pointed to changes.
253.for _link in ${_ILINKS}
254.if !exists(${.OBJDIR}/${_link})
255${OBJS}: ${.OBJDIR}/${_link}
256.endif
257.endfor
258
259# Search for kernel source tree in standard places.
260.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
261.if !defined(SYSDIR) && exists(${_dir}/kern/)
262SYSDIR=	${_dir}
263.endif
264.endfor
265.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
266.error "can't find kernel source tree"
267.endif
268
269.for _link in ${_ILINKS}
270.PHONY: ${_link}
271${_link}: ${.OBJDIR}/${_link}
272
273${.OBJDIR}/${_link}:
274	@case ${.TARGET:T} in \
275	machine) \
276		path=${SYSDIR}/${MACHINE}/include ;; \
277	@) \
278		path=${SYSDIR} ;; \
279	*) \
280		path=${SYSDIR}/${.TARGET:T}/include ;; \
281	esac ; \
282	path=`(cd $$path && /bin/pwd)` ; \
283	${ECHO} ${.TARGET:T} "->" $$path ; \
284	ln -sf $$path ${.TARGET:T}
285.endfor
286
287CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
288
289.if defined(DEBUG_FLAGS)
290CLEANFILES+= ${FULLPROG} ${PROG}.symbols
291.endif
292
293.if !target(install)
294
295_INSTALLFLAGS:=	${INSTALLFLAGS}
296.for ie in ${INSTALLFLAGS_EDIT}
297_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
298.endfor
299
300.if !target(realinstall)
301realinstall: _kmodinstall
302.ORDER: beforeinstall _kmodinstall
303_kmodinstall:
304	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
305	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
306.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG) && ${MK_KERNEL_SYMBOLS} != "no"
307	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
308	    ${_INSTALLFLAGS} ${PROG}.symbols ${DESTDIR}${KMODDIR}
309.endif
310
311.include <bsd.links.mk>
312
313.if !defined(NO_XREF)
314afterinstall: _kldxref
315.ORDER: realinstall _kldxref
316.ORDER: _installlinks _kldxref
317_kldxref:
318	@if type kldxref >/dev/null 2>&1; then \
319		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
320		kldxref ${DESTDIR}${KMODDIR}; \
321	fi
322.endif
323.endif # !target(realinstall)
324
325.endif # !target(install)
326
327.if !target(load)
328load: ${PROG}
329	${KMODLOAD} -v ${.OBJDIR}/${PROG}
330.endif
331
332.if !target(unload)
333unload:
334	if ${KMODISLOADED} ${PROG} ; then ${KMODUNLOAD} -v ${PROG} ; fi
335.endif
336
337.if !target(reload)
338reload: unload load
339.endif
340
341.if defined(KERNBUILDDIR)
342.PATH: ${KERNBUILDDIR}
343CFLAGS+=	-I${KERNBUILDDIR}
344.for _src in ${SRCS:Mopt_*.h}
345CLEANFILES+=	${_src}
346.if !target(${_src})
347${_src}:
348	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
349.endif
350.endfor
351.else
352.for _src in ${SRCS:Mopt_*.h}
353CLEANFILES+=	${_src}
354.if !target(${_src})
355${_src}:
356	:> ${.TARGET}
357.endif
358.endfor
359.endif
360
361# Respect configuration-specific C flags.
362CFLAGS+=	${ARCH_FLAGS} ${CONF_CFLAGS}
363
364MFILES?= dev/acpica/acpi_if.m dev/acpi_support/acpi_wmi_if.m \
365	dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_if.m \
366	dev/fb/fb_if.m dev/gpio/gpio_if.m dev/gpio/gpiobus_if.m \
367	dev/hyperv/vmbus/vmbus_if.m \
368	dev/iicbus/iicbb_if.m dev/iicbus/iicbus_if.m \
369	dev/mmc/mmcbr_if.m dev/mmc/mmcbus_if.m \
370	dev/mii/miibus_if.m dev/mvs/mvs_if.m dev/ofw/ofw_bus_if.m \
371	dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
372	dev/pci/pcib_if.m dev/ppbus/ppbus_if.m \
373	dev/sdhci/sdhci_if.m dev/smbus/smbus_if.m dev/spibus/spibus_if.m \
374	dev/sound/pci/hda/hdac_if.m \
375	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
376	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
377	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
378	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
379	kern/bus_if.m kern/clock_if.m \
380	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
381	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
382	pc98/pc98/canbus_if.m dev/etherswitch/mdio_if.m
383
384.for _srcsrc in ${MFILES}
385.for _ext in c h
386.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
387CLEANFILES+=	${_src}
388.if !target(${_src})
389.if !exists(@)
390${_src}: @
391.else
392${_src}: @/tools/makeobjops.awk @/${_srcsrc}
393.endif
394	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
395.endif
396.endfor # _src
397.endfor # _ext
398.endfor # _srcsrc
399
400.if !empty(SRCS:Mvnode_if.c)
401CLEANFILES+=	vnode_if.c
402.if !exists(@)
403vnode_if.c: @
404.else
405vnode_if.c: @/tools/vnode_if.awk @/kern/vnode_if.src
406.endif
407	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -c
408.endif
409
410.if !empty(SRCS:Mvnode_if.h)
411CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
412.if !exists(@)
413vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @
414.else
415vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @/tools/vnode_if.awk \
416    @/kern/vnode_if.src
417.endif
418vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
419	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -h
420vnode_if_newproto.h:
421	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -p
422vnode_if_typedef.h:
423	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -q
424.endif
425
426.for _i in mii pccard
427.if !empty(SRCS:M${_i}devs.h)
428CLEANFILES+=	${_i}devs.h
429.if !exists(@)
430${_i}devs.h: @
431.else
432${_i}devs.h: @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
433.endif
434	${AWK} -f @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
435.endif
436.endfor # _i
437
438.if !empty(SRCS:Musbdevs.h)
439CLEANFILES+=	usbdevs.h
440.if !exists(@)
441usbdevs.h: @
442.else
443usbdevs.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
444.endif
445	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -h
446.endif
447
448.if !empty(SRCS:Musbdevs_data.h)
449CLEANFILES+=	usbdevs_data.h
450.if !exists(@)
451usbdevs_data.h: @
452.else
453usbdevs_data.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
454.endif
455	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -d
456.endif
457
458.if !empty(SRCS:Macpi_quirks.h)
459CLEANFILES+=	acpi_quirks.h
460.if !exists(@)
461acpi_quirks.h: @
462.else
463acpi_quirks.h: @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
464.endif
465	${AWK} -f @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
466.endif
467
468.if !empty(SRCS:Massym.s)
469CLEANFILES+=	assym.s genassym.o
470assym.s: genassym.o
471.if defined(KERNBUILDDIR)
472genassym.o: opt_global.h
473.endif
474.if !exists(@)
475assym.s: @
476.else
477assym.s: @/kern/genassym.sh
478.endif
479	sh @/kern/genassym.sh genassym.o > ${.TARGET}
480.if exists(@)
481genassym.o: @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
482.endif
483genassym.o: @ machine ${SRCS:Mopt_*.h}
484	${CC} -c ${CFLAGS:N-fno-common} \
485	    @/${MACHINE_CPUARCH}/${MACHINE_CPUARCH}/genassym.c
486.endif
487
488lint: ${SRCS}
489	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
490
491.if defined(KERNBUILDDIR)
492${OBJS}: opt_global.h
493.endif
494
495.include <bsd.dep.mk>
496
497cleandepend: cleanilinks
498# .depend needs include links so we remove them only together.
499cleanilinks:
500	rm -f ${_ILINKS}
501
502.if !exists(${.OBJDIR}/${DEPENDFILE})
503${OBJS}: ${SRCS:M*.h}
504.endif
505
506.include <bsd.obj.mk>
507.include "kern.mk"
508