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