xref: /freebsd/sys/conf/kmod.mk (revision 39beb93c3f8bdbf72a61fda42300b5ebed7390c8) 
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# MFILES	Optionally a list of interfaces used by the module.
32#		This file contains a default list of interfaces.
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
63AWK?=		awk
64KMODLOAD?=	/sbin/kldload
65KMODUNLOAD?=	/sbin/kldunload
66OBJCOPY?=	objcopy
67
68.if defined(KMODDEPS)
69.error "Do not use KMODDEPS on 5.0+; use MODULE_VERSION/MODULE_DEPEND"
70.endif
71
72.include <bsd.init.mk>
73
74.SUFFIXES: .out .o .c .cc .cxx .C .y .l .s .S
75
76.if ${CC} == "icc"
77CFLAGS:=	${CFLAGS:C/(-x[^M^K^W]+)[MKW]+|-x[MKW]+/\1/}
78.else
79. if !empty(CFLAGS:M-O[23s]) && empty(CFLAGS:M-fno-strict-aliasing)
80CFLAGS+=	-fno-strict-aliasing
81. endif
82WERROR?=	-Werror
83.endif
84CFLAGS+=	${WERROR}
85CFLAGS+=	-D_KERNEL
86CFLAGS+=	-DKLD_MODULE
87
88# Don't use any standard or source-relative include directories.
89.if ${CC} == "icc"
90NOSTDINC=	-X
91.else
92CSTD=		c99
93NOSTDINC=	-nostdinc
94.endif
95CFLAGS:=	${CFLAGS:N-I*} ${NOSTDINC} ${INCLMAGIC} ${CFLAGS:M-I*}
96.if defined(KERNBUILDDIR)
97CFLAGS+=	-DHAVE_KERNEL_OPTION_HEADERS -include ${KERNBUILDDIR}/opt_global.h
98.endif
99
100# Add -I paths for system headers.  Individual module makefiles don't
101# need any -I paths for this.  Similar defaults for .PATH can't be
102# set because there are no standard paths for non-headers.
103CFLAGS+=	-I. -I@
104
105# Add -I path for altq headers as they are included via net/if_var.h
106# for example.
107CFLAGS+=	-I@/contrib/altq
108
109.if ${CC} != "icc"
110CFLAGS+=	-finline-limit=${INLINE_LIMIT}
111CFLAGS+= --param inline-unit-growth=100
112CFLAGS+= --param large-function-growth=1000
113.endif
114
115# Disallow common variables, and if we end up with commons from
116# somewhere unexpected, allocate storage for them in the module itself.
117.if ${CC} != "icc"
118CFLAGS+=	-fno-common
119.endif
120LDFLAGS+=	-d -warn-common
121
122CFLAGS+=	${DEBUG_FLAGS}
123.if ${MACHINE_ARCH} == amd64
124CFLAGS+=	-fno-omit-frame-pointer
125.endif
126
127.if ${MACHINE_ARCH} == "powerpc"
128CFLAGS+=	-mlongcall -fno-omit-frame-pointer
129.endif
130
131.if defined(FIRMWS)
132.if !exists(@)
133${KMOD:S/$/.c/}: @
134.else
135${KMOD:S/$/.c/}: @/tools/fw_stub.awk
136.endif
137	${AWK} -f @/tools/fw_stub.awk ${FIRMWS} -m${KMOD} -c${KMOD:S/$/.c/g} \
138	    ${FIRMWARE_LICENSE:C/.+/-l/}${FIRMWARE_LICENSE}
139
140SRCS+=	${KMOD:S/$/.c/}
141CLEANFILES+=	${KMOD:S/$/.c/}
142
143.for _firmw in ${FIRMWS}
144${_firmw:C/\:.*$/.fwo/}:	${_firmw:C/\:.*$//}
145	@${ECHO} ${_firmw:C/\:.*$//} ${.ALLSRC:M*${_firmw:C/\:.*$//}}
146	@if [ -e ${_firmw:C/\:.*$//} ]; then			\
147		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
148		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
149	else							\
150		ln -s ${.ALLSRC:M*${_firmw:C/\:.*$//}} ${_firmw:C/\:.*$//}; \
151		${LD} -b binary --no-warn-mismatch ${LDFLAGS}	\
152		    -r -d -o ${.TARGET}	${_firmw:C/\:.*$//};	\
153		rm ${_firmw:C/\:.*$//};				\
154	fi
155
156OBJS+=	${_firmw:C/\:.*$/.fwo/}
157.endfor
158.endif
159
160OBJS+=	${SRCS:N*.h:R:S/$/.o/g}
161
162.if !defined(PROG)
163PROG=	${KMOD}.ko
164.endif
165
166.if !defined(DEBUG_FLAGS)
167FULLPROG=	${PROG}
168.else
169FULLPROG=	${PROG}.debug
170${PROG}: ${FULLPROG} ${PROG}.symbols
171	${OBJCOPY} --strip-debug --add-gnu-debuglink=${PROG}.symbols\
172	    ${FULLPROG} ${.TARGET}
173${PROG}.symbols: ${FULLPROG}
174	${OBJCOPY} --only-keep-debug ${FULLPROG} ${.TARGET}
175.endif
176
177.if ${MACHINE_ARCH} != amd64
178${FULLPROG}: ${KMOD}.kld
179	${LD} -Bshareable ${LDFLAGS} -o ${.TARGET} ${KMOD}.kld
180.if !defined(DEBUG_FLAGS)
181	${OBJCOPY} --strip-debug ${.TARGET}
182.endif
183.endif
184
185EXPORT_SYMS?=	NO
186.if ${EXPORT_SYMS} != YES
187CLEANFILES+=	export_syms
188.endif
189
190.if ${MACHINE_ARCH} != amd64
191${KMOD}.kld: ${OBJS}
192.else
193${FULLPROG}: ${OBJS}
194.endif
195	${LD} ${LDFLAGS} -r -d -o ${.TARGET} ${OBJS}
196.if defined(EXPORT_SYMS)
197.if ${EXPORT_SYMS} != YES
198.if ${EXPORT_SYMS} == NO
199	:> export_syms
200.elif !exists(${.CURDIR}/${EXPORT_SYMS})
201	echo ${EXPORT_SYMS} > export_syms
202.else
203	grep -v '^#' < ${EXPORT_SYMS} > export_syms
204.endif
205	awk -f ${SYSDIR}/conf/kmod_syms.awk ${.TARGET} \
206	    export_syms | xargs -J% ${OBJCOPY} % ${.TARGET}
207.endif
208.endif
209.if !defined(DEBUG_FLAGS) && ${MACHINE_ARCH} == amd64
210	${OBJCOPY} --strip-debug ${.TARGET}
211.endif
212
213_ILINKS=@ machine
214.if ${MACHINE} != ${MACHINE_ARCH}
215_ILINKS+=${MACHINE_ARCH}
216.endif
217
218all: objwarn ${PROG}
219
220beforedepend: ${_ILINKS}
221
222# Ensure that the links exist without depending on it when it exists which
223# causes all the modules to be rebuilt when the directory pointed to changes.
224.for _link in ${_ILINKS}
225.if !exists(${.OBJDIR}/${_link})
226${OBJS}: ${_link}
227.endif
228.endfor
229
230# Search for kernel source tree in standard places.
231.for _dir in ${.CURDIR}/../.. ${.CURDIR}/../../.. /sys /usr/src/sys
232.if !defined(SYSDIR) && exists(${_dir}/kern/)
233SYSDIR=	${_dir}
234.endif
235.endfor
236.if !defined(SYSDIR) || !exists(${SYSDIR}/kern/)
237.error "can't find kernel source tree"
238.endif
239
240${_ILINKS}:
241	@case ${.TARGET} in \
242	${MACHINE_ARCH}) \
243		path=${SYSDIR}/${MACHINE_ARCH}/include ;; \
244	machine) \
245		path=${SYSDIR}/${MACHINE}/include ;; \
246	@) \
247		path=${SYSDIR} ;; \
248	esac ; \
249	path=`(cd $$path && /bin/pwd)` ; \
250	${ECHO} ${.TARGET} "->" $$path ; \
251	ln -sf $$path ${.TARGET}
252
253CLEANFILES+= ${PROG} ${KMOD}.kld ${OBJS}
254
255.if defined(DEBUG_FLAGS)
256CLEANFILES+= ${FULLPROG} ${PROG}.symbols
257.endif
258
259.if !target(install)
260
261_INSTALLFLAGS:=	${INSTALLFLAGS}
262.for ie in ${INSTALLFLAGS_EDIT}
263_INSTALLFLAGS:=	${_INSTALLFLAGS${ie}}
264.endfor
265
266.if !target(realinstall)
267realinstall: _kmodinstall
268.ORDER: beforeinstall _kmodinstall
269_kmodinstall:
270	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
271	    ${_INSTALLFLAGS} ${PROG} ${DESTDIR}${KMODDIR}
272.if defined(DEBUG_FLAGS) && !defined(INSTALL_NODEBUG)
273	${INSTALL} -o ${KMODOWN} -g ${KMODGRP} -m ${KMODMODE} \
274	    ${_INSTALLFLAGS} ${PROG}.symbols ${DESTDIR}${KMODDIR}
275.endif
276
277.include <bsd.links.mk>
278
279.if !defined(NO_XREF)
280afterinstall: _kldxref
281.ORDER: realinstall _kldxref
282.ORDER: _installlinks _kldxref
283_kldxref:
284	@if type kldxref >/dev/null 2>&1; then \
285		${ECHO} kldxref ${DESTDIR}${KMODDIR}; \
286		kldxref ${DESTDIR}${KMODDIR}; \
287	fi
288.endif
289.endif # !target(realinstall)
290
291.endif # !target(install)
292
293.if !target(load)
294load: ${PROG}
295	${KMODLOAD} -v ${.OBJDIR}/${PROG}
296.endif
297
298.if !target(unload)
299unload:
300	${KMODUNLOAD} -v ${PROG}
301.endif
302
303.if defined(KERNBUILDDIR)
304.PATH: ${KERNBUILDDIR}
305CFLAGS+=	-I${KERNBUILDDIR}
306.for _src in ${SRCS:Mopt_*.h}
307CLEANFILES+=	${_src}
308.if !target(${_src})
309${_src}:
310	ln -sf ${KERNBUILDDIR}/${_src} ${.TARGET}
311.endif
312.endfor
313.else
314.for _src in ${SRCS:Mopt_*.h}
315CLEANFILES+=	${_src}
316.if !target(${_src})
317${_src}:
318	:> ${.TARGET}
319.endif
320.endfor
321.endif
322
323MFILES?= dev/acpica/acpi_if.m dev/agp/agp_if.m dev/ata/ata_if.m dev/eisa/eisa_if.m \
324	dev/iicbus/iicbb_if.m dev/iicbus/iicbus_if.m \
325	dev/mmc/mmcbr_if.m dev/mmc/mmcbus_if.m \
326	dev/mii/miibus_if.m dev/ofw/ofw_bus_if.m \
327	dev/pccard/card_if.m dev/pccard/power_if.m dev/pci/pci_if.m \
328	dev/pci/pcib_if.m dev/ppbus/ppbus_if.m dev/smbus/smbus_if.m \
329	dev/sound/pcm/ac97_if.m dev/sound/pcm/channel_if.m \
330	dev/sound/pcm/feeder_if.m dev/sound/pcm/mixer_if.m \
331	dev/sound/midi/mpu_if.m dev/sound/midi/mpufoi_if.m \
332	dev/sound/midi/synth_if.m dev/usb/usb_if.m isa/isa_if.m \
333	kern/bus_if.m kern/clock_if.m \
334	kern/cpufreq_if.m kern/device_if.m kern/serdev_if.m \
335	libkern/iconv_converter_if.m opencrypto/cryptodev_if.m \
336	pc98/pc98/canbus_if.m
337
338.for _srcsrc in ${MFILES}
339.for _ext in c h
340.for _src in ${SRCS:M${_srcsrc:T:R}.${_ext}}
341CLEANFILES+=	${_src}
342.if !target(${_src})
343.if !exists(@)
344${_src}: @
345.else
346${_src}: @/tools/makeobjops.awk @/${_srcsrc}
347.endif
348	${AWK} -f @/tools/makeobjops.awk @/${_srcsrc} -${_ext}
349.endif
350.endfor # _src
351.endfor # _ext
352.endfor # _srcsrc
353
354.if !empty(SRCS:Mvnode_if.c)
355CLEANFILES+=	vnode_if.c
356.if !exists(@)
357vnode_if.c: @
358.else
359vnode_if.c: @/tools/vnode_if.awk @/kern/vnode_if.src
360.endif
361	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -c
362.endif
363
364.if !empty(SRCS:Mvnode_if.h)
365CLEANFILES+=	vnode_if.h vnode_if_newproto.h vnode_if_typedef.h
366.if !exists(@)
367vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @
368.else
369vnode_if.h vnode_if_newproto.h vnode_if_typedef.h: @/tools/vnode_if.awk \
370    @/kern/vnode_if.src
371.endif
372vnode_if.h: vnode_if_newproto.h vnode_if_typedef.h
373	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -h
374vnode_if_newproto.h:
375	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -p
376vnode_if_typedef.h:
377	${AWK} -f @/tools/vnode_if.awk @/kern/vnode_if.src -q
378.endif
379
380.for _i in mii pccard
381.if !empty(SRCS:M${_i}devs.h)
382CLEANFILES+=	${_i}devs.h
383.if !exists(@)
384${_i}devs.h: @
385.else
386${_i}devs.h: @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
387.endif
388	${AWK} -f @/tools/${_i}devs2h.awk @/dev/${_i}/${_i}devs
389.endif
390.endfor # _i
391
392.if !empty(SRCS:Musbdevs.h)
393CLEANFILES+=	usbdevs.h
394.if !exists(@)
395usbdevs.h: @
396.else
397usbdevs.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
398.endif
399	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -h
400.endif
401
402.if !empty(SRCS:Musbdevs_data.h)
403CLEANFILES+=	usbdevs_data.h
404.if !exists(@)
405usbdevs_data.h: @
406.else
407usbdevs_data.h: @/tools/usbdevs2h.awk @/dev/usb/usbdevs
408.endif
409	${AWK} -f @/tools/usbdevs2h.awk @/dev/usb/usbdevs -d
410.endif
411
412.if !empty(SRCS:Macpi_quirks.h)
413CLEANFILES+=	acpi_quirks.h
414.if !exists(@)
415acpi_quirks.h: @
416.else
417acpi_quirks.h: @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
418.endif
419	${AWK} -f @/tools/acpi_quirks2h.awk @/dev/acpica/acpi_quirks
420.endif
421
422.if !empty(SRCS:Massym.s)
423CLEANFILES+=	assym.s genassym.o
424assym.s: genassym.o
425.if defined(KERNBUILDDIR)
426genassym.o: opt_global.h
427.endif
428.if !exists(@)
429assym.s: @
430.else
431assym.s: @/kern/genassym.sh
432.endif
433	sh @/kern/genassym.sh genassym.o > ${.TARGET}
434.if exists(@)
435genassym.o: @/${MACHINE_ARCH}/${MACHINE_ARCH}/genassym.c
436.endif
437genassym.o: @ machine ${SRCS:Mopt_*.h}
438	${CC} -c ${CFLAGS:N-fno-common} \
439	    @/${MACHINE_ARCH}/${MACHINE_ARCH}/genassym.c
440.endif
441
442lint: ${SRCS}
443	${LINT} ${LINTKERNFLAGS} ${CFLAGS:M-[DILU]*} ${.ALLSRC:M*.c}
444
445.if defined(KERNBUILDDIR)
446${OBJS}: opt_global.h
447.endif
448
449.include <bsd.dep.mk>
450
451cleandepend: cleanilinks
452# .depend needs include links so we remove them only together.
453cleanilinks:
454	rm -f ${_ILINKS}
455
456.if !exists(${.OBJDIR}/${DEPENDFILE})
457${OBJS}: ${SRCS:M*.h}
458.endif
459
460.include <bsd.obj.mk>
461.include "kern.mk"
462