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