Skip to content

Symbol Namespaces

Matthias Maennich cocci kernel-janitors linux-amlogic linux-arch linux-aspeed linux-kbuild linux-m68k linux-mediatek linux-modules linux-samsung-soc linux-scsi linux-tegra linux-usb linux-watchdog lkml openbmc 4 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest11 patches 3 repliesIn review
  2. v412 patches 14 repliesSuperseded
  3. v311 patches 27 repliesSuperseded
Earlier versions · 1
VersionPostedPatchesRepliesStatus
v210 patches25 repliesSuperseded

Changes in v5 from the cover letter

- Makefile: let 'nsdeps' depend on 'modules' to allow
make clean; make nsdeps to work
- scripts/nsdeps: drop 'exit on first error' again as it just makes more problems than it solves
- drop the watchdog RFC patch for now

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/11module: support reading multiple values per modinfo tagkernel/module.c+15 -20 replies
2/11export: explicitly align struct kernel_symbolarch/m68k/include/asm/export.h include/asm-generic/export.h include/linux/export.h+5 -70 replies
3/11module: add support for symbol namespaces.include/asm-generic/export.h include/linux/export.h include/linux/module.h +1 more+123 -190 replies
4/11modpost: add support for symbol namespacesDocumentation/kbuild/modules.rst scripts/export_report.pl scripts/mod/modpost.c +1 more+101 -196 replies
5/11module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTSinit/Kconfig kernel/module.c+22 -20 replies
6/11export: allow definition default namespaces in Makefiles or sourcesinclude/linux/export.h+6 -00 replies
7/11modpost: add support for generating namespace dependencies.gitignore Makefile scripts/mod/modpost.c +1 more+53 -60 replies
8/11scripts: Coccinelle script for namespace dependencies.MAINTAINERS Makefile scripts/Makefile.modpost +2 more+101 -10 replies
9/11docs: Add documentation for Symbol NamespacesDocumentation/kbuild/namespaces.rst Documentation/kernel-hacking/hacking.rst+172 -00 replies
10/11usb-storage: remove single-use define for debuggingdrivers/usb/storage/debug.h drivers/usb/storage/scsiglue.c+1 -32 replies
11/11usb-storage: export symbols in USB_STORAGE namespacedrivers/usb/storage/Makefile drivers/usb/storage/alauda.c drivers/usb/storage/cypress_atacb.c +12 more+16 -00 replies

Reviews trailers per patch

All 11 patches have a Reviewed-by or Acked-by.

PatchJoel Fernandes (Google)Martijn CoenenGreg Kroah-HartmanJulia Lawall
1/11R-b R-b R-b
2/11R-b
3/11R-b
4/11R-b R-b T-b
5/11R-b R-b
6/11R-b R-b
7/11R-b
8/11R-b A-b
9/11R-b
10/11R-b
11/11R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v5 thread

Cover letter [PATCH v5 00/11] Symbol Namespaces

As of Linux 5.3-rc7, there are 31207 [1] exported symbols in the kernel. That is a growth of roughly 1000 symbols since 4.17 (30206 [2]). There seems to be some consensus amongst kernel devs that the export surface is too large, and hard to reason about.

Generally, these symbols fall in one of these categories:
1) Symbols actually meant for drivers
2) Symbols that are only exported because functionality is split over multiple modules, yet they really shouldn't be used by modules outside of their own subsystem
3) Symbols really only meant for in-tree use

When module developers try to upstream their code, it regularly turns out that they are using exported symbols that they really shouldn't be using. This problem is even bigger for drivers that are currently out-of-tree, which may be using many symbols that they shouldn't be using, and that break when those symbols are removed or modified.

This patch allows subsystem maintainers to partition their exported symbols into separate namespaces, and module authors to import such namespaces only when needed.

This allows subsystem maintainers to more easily limit availability of these namespaced symbols to other parts of the kernel. It can also be used to partition the set of exported symbols for documentation purposes; for example, a set of symbols that is really only used for debugging could be in a "SUBSYSTEM_DEBUG" namespace.

I continued the work mainly done by Martijn Coenen.

Changes in v2:
- Rather than adding and evaluating separate sections __knsimport_NS, use modinfo tags to declare the namespaces a module introduces. Adjust modpost and the module loader accordingly.
- Also add support for reading multiple modinfo values for the same tag to allow list-like access to modinfo tags.
- The macros in export.h have been cleaned up to avoid redundancy in the macro parameters (ns, nspost, nspost2).
- The introduction of relative references in the ksymtab entries caused a rework of the macros to accommodate that configuration as well.
- Alignment of kernel_symbol in the ksymtab needed to be fixed to allow growing the kernel_symbol struct.
- Modpost does now also append the namespace suffix to the symbol entries in Module.symvers.
- The configuration option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS allows relaxing the enforcement of properly declared namespace imports at module loading time.
- Symbols can be collectively exported into a namespace by defining DEFAULT_SYMBOL_NAMESPACE in the corresponding Makefile.
- The requirement for a very recent coccinelle spatch has been lifted by simplifying the script.
- nsdeps does now ensures MODULE_IMPORT_NS statements are sorted when patching the module source files.
- Some minor bugs have been addressed in nsdeps to allow it to work with modules that have more than one source file.
- The RFC for the usb-storage symbols has been simplified by using DEFAULT_SYMBOL_NAMESPACE=USB_STORAGE rather than explicitly exporting each and every symbol into that new namespace.

Changes in v3:
- Reword the documentation for the MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS option for clarification.
- Fix printed required version of spatch in coccinelle script.
- Adopt kbuild changes for modpost: .mod files are no longer generated in .tmp_versions. Similarely, generate the .ns_deps files in the tree along with the .mod files. Also, nsdeps now uses modules.order as source for the list modules to consider.
- Add an RFC patch to introduce the namespace WATCHDOG_CORE for symbols exported in watchdog_core.c.

Changes in v4:
- scripts/nsdeps:
- exit on first error
- support out-of-tree builds O=...
- scripts/export_report.pl: update for new Module.symvers format
- scripts/mod/modpost: make the namespace a separate field when exporting to Module.symvers (rather than symbol.NS)
- include/linux/export.h: fixed style nits
- kernel/module.c: ensure namespaces are imported before taking a reference to the owner module
- Documentation: document the Symbol Namespace feature and update references to Module.symvers and EXPORT_SYMBOL*

Changes in v5:
- Makefile: let 'nsdeps' depend on 'modules' to allow
make clean; make nsdeps to work
- scripts/nsdeps: drop 'exit on first error' again as it just makes more problems than it solves
- drop the watchdog RFC patch for now

This patch series was developed against v5.3-rc7.

[1] git grep "^EXPORT_SYMBOL\w*(" v5.3-rc7 | wc -l
[2] git grep "^EXPORT_SYMBOL\w*(" v4.17 | wc -l

Matthias Maennich (11):
module: support reading multiple values per modinfo tag
export: explicitly align struct kernel_symbol
module: add support for symbol namespaces.
modpost: add support for symbol namespaces
module: add config option MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS
export: allow definition default namespaces in Makefiles or sources
modpost: add support for generating namespace dependencies
scripts: Coccinelle script for namespace dependencies.
docs: Add documentation for Symbol Namespaces
usb-storage: remove single-use define for debugging
usb-storage: export symbols in USB_STORAGE namespace

 .gitignore                                  |   1 +
 Documentation/kbuild/modules.rst            |   7 +-
 Documentation/kbuild/namespaces.rst         | 154 ++++++++++++++++++++
 Documentation/kernel-hacking/hacking.rst    |  18 +++
 MAINTAINERS                                 |   5 +
 Makefile                                    |  14 +-
 arch/m68k/include/asm/export.h              |   1 -
 drivers/usb/storage/Makefile                |   2 +
 drivers/usb/storage/alauda.c                |   1 +
 drivers/usb/storage/cypress_atacb.c         |   1 +
 drivers/usb/storage/datafab.c               |   1 +
 drivers/usb/storage/debug.h                 |   2 -
 drivers/usb/storage/ene_ub6250.c            |   1 +
 drivers/usb/storage/freecom.c               |   1 +
 drivers/usb/storage/isd200.c                |   1 +
 drivers/usb/storage/jumpshot.c              |   1 +
 drivers/usb/storage/karma.c                 |   1 +
 drivers/usb/storage/onetouch.c              |   1 +
 drivers/usb/storage/realtek_cr.c            |   1 +
 drivers/usb/storage/scsiglue.c              |   2 +-
 drivers/usb/storage/sddr09.c                |   1 +
 drivers/usb/storage/sddr55.c                |   1 +
 drivers/usb/storage/shuttle_usbat.c         |   1 +
 drivers/usb/storage/uas.c                   |   1 +
 include/asm-generic/export.h                |  14 +-
 include/linux/export.h                      |  98 +++++++++++--
 include/linux/module.h                      |   2 +
 init/Kconfig                                |  13 ++
 kernel/module.c                             |  67 ++++++++-
 scripts/Makefile.modpost                    |   4 +-
 scripts/coccinelle/misc/add_namespace.cocci |  23 +++
 scripts/export_report.pl                    |   2 +-
 scripts/mod/modpost.c                       | 150 ++++++++++++++++---
 scripts/mod/modpost.h                       |   9 ++
 scripts/nsdeps                              |  58 ++++++++
 35 files changed, 608 insertions(+), 52 deletions(-)
 create mode 100644 Documentation/kbuild/namespaces.rst
 create mode 100644 scripts/coccinelle/misc/add_namespace.cocci
 create mode 100644 scripts/nsdeps
Signature · 1 line
2.23.0.187.g17f5b7556c-goog