Changeset 70161 in vbox

Timestamp:

Dec 15, 2017 5:03:56 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

119723

Message:

Linux drivers: check for unresolved symbols at build time.
bugref:4567: Linux kernel driver maintenance
This change breaks the build if test builds of Linux kernel drivers contain
unresolved symbols. It saves the symbols produced during the vboxdrv and
vboxguest builds and makes them available during the host modules and
vboxsf builds respectively to prevent the IPRT symbols from coming up as
missing. It is not particularly elegant, in particular it uses the tst*.run
test build targets for saving symbols, but seems to do the job.

Location:

trunk

Files:

• Config.kmk (modified) (2 diffs)
• src/VBox/Additions/common/VBoxGuest/Makefile.kmk (modified) (1 diff)
• src/VBox/Additions/linux/Makefile.kmk (modified) (1 diff)
• src/VBox/HostDrivers/Makefile.kmk (modified) (1 diff)

trunk/Config.kmk

@@ -4227 +4227 @@
  # Using the extra expansion to replace $(module) before eval, thus everything
  # else needs escaped dollars.
+ #
+ # Since Linux KBuild will not abort due to undefined symbols when building
+ # external modules we need to grep the error output ourselves.  Since vboxdrv
+ # and vboxguest respectively provide symbols that other modules use, we use
+ # the rule target (tst*.run) to save those symbols so that KBuild can do its
+ # checking.  Note in this context the (unescaped) variables $(save_symvers)
+ # and $(use_symvers).
  define VBOX_LINUX_GENERATE_KMOD_TEST
   VBOX_TARGET_$(module) = $$(PATH_TARGET)/tst$(module)$(subst /,_,$(KERN_DIR))_mod.run
+  symvers_$(module)_dep = $$(if $(use_symvers),$$(if $$(eq $(use_symvers),$(module)),,\
+$$(PATH_TARGET)/tst$(use_symvers)$(subst /,_,$(KERN_DIR))_mod.run))
   TESTING      += $$(VBOX_TARGET_$(module))
   OTHERS       += $$(VBOX_TARGET_$(module))
   OTHERS_CLEAN += $$(VBOX_TARGET_$(module))
-  $$(VBOX_TARGET_$(module)): $$$$($(module)_2_STAGE_TARGETS)
+  $$(VBOX_TARGET_$(module)): $$$$($(module)_2_STAGE_TARGETS) $$(symvers_$(module)_dep)
         $(QUIET)$$(call MSG_L1,Doing a test build of the $(module) kernel module)
         $(QUIET)$$(RM) -f -- "$$@"
@@ -4240 +4249 @@
         $(QUIET)$$(CP) -R -- "$$(PATH_STAGE_BIN)/../$$($(module)_INST)" "$$(PATH_TARGET)/tst$(module)_mod/"
         + $(QUIET)make KBUILD_VERBOSE=$(KBUILD_VERBOSE) KERN_DIR=$(KERN_DIR) -C $$(PATH_TARGET)/tst$(module)_mod clean
-        + $(QUIET)make KBUILD_VERBOSE=$(KBUILD_VERBOSE) KERN_DIR=$(KERN_DIR) $(if-expr $(KMK_OPTS_JOBS) != 1,JOBS=$(KMK_OPTS_JOBS),) -C $$(PATH_TARGET)/tst$(module)_mod
+        $(QUIET)$$(if $$(eq $$(symvers_$(module)_dep),),,\
+$$(CP) $$(symvers_$(module)_dep) "$$(PATH_TARGET)/tst$(module)_mod/Module.symvers")
+        + $(QUIET)make KBUILD_VERBOSE=$(KBUILD_VERBOSE) KERN_DIR=$(KERN_DIR) $(if-expr $(KMK_OPTS_JOBS) != 1,JOBS=$(KMK_OPTS_JOBS),) -C $$(PATH_TARGET)/tst$(module)_mod \
+                2> "$$(PATH_TARGET)/tst$(module)_mod/make.err"
+        $(QUIET)! grep "^WARNING: .* undefined!$$$$" "$$(PATH_TARGET)/tst$(module)_mod/make.err"
   if1of ($(USERNAME), bird)
         - nm -u "$$(PATH_TARGET)/tst$(module)_mod/"*.ko | sort
   endif
+        $(QUIET)$$(if $$(eq $(save_symvers),$(module)),\
+$$(CP) "$$(PATH_TARGET)/tst$(module)_mod/Module.symvers" "$$@",\
+$(QUIET)$$(APPEND) -t "$$@" "done")
         $(QUIET)$$(RM) -Rf -- $$(PATH_TARGET)/tst$(module)_mod
-        $(QUIET)$$(APPEND) -t "$$@" "done"
  endef
 endif

trunk/src/VBox/Additions/common/VBoxGuest/Makefile.kmk

@@ -236 +236 @@
   && "$(KBUILD_HOST_ARCH)" == "$(KBUILD_TARGET_ARCH)"
   ifneq ($(KERN_DIR),)
+   save_symvers = vboxguest-src
    $(foreach module, vboxguest-src, $(evalcall2 VBOX_LINUX_GENERATE_KMOD_TEST))
   endif

trunk/src/VBox/Additions/linux/Makefile.kmk

@@ -364 +364 @@
  && "$(KBUILD_HOST_ARCH)" == "$(KBUILD_TARGET_ARCH)"
  ifneq ($(KERN_DIR),)
-  $(foreach module, vboxsf-src vboxvideo-src, $(evalcall2 VBOX_LINUX_GENERATE_KMOD_TEST))
+  use_symvers = vboxguest-src
+  module      = vboxsf-src
+  $(evalcall2 VBOX_LINUX_GENERATE_KMOD_TEST)
+  use_symvers =
+  module      = vboxvideo-src
+  $(evalcall2 VBOX_LINUX_GENERATE_KMOD_TEST)
  endif
 endif

trunk/src/VBox/HostDrivers/Makefile.kmk

@@ -78 +78 @@
 
  ifneq ($(KERN_DIR),)
+  save_symvers = vboxdrv-src
+  use_symvers  = vboxdrv-src
   $(foreach module, vboxdrv-src $(if $(VBOX_WITH_NETFLT),VBoxNetFlt-src) \
    $(if $(VBOX_WITH_NETADP),VBoxNetAdp-src) $(if $(VBOX_WITH_PCI_PASSTHROUGH),VBoxPci-src), \