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