sys/conf/kmod.mk

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