€•o`      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ./translations/zh_CN/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ./translations/zh_TW/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ./translations/it_IT/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ./translations/ja_JP/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ./translations/ko_KR/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ./translations/sp_SP/core-api/symbol-namespaces”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒSymbol Namespaces”h]”hŒSymbol Namespaces”…””}”(hh¨hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hh£hžhhŸŒH/var/lib/git/docbuild/linux/Documentation/core-api/symbol-namespaces.rst”h KubhŒ	paragraph”“”)”}”(hŒ©The following document describes how to use Symbol Namespaces to structure the
export surface of in-kernel symbols exported through the family of
EXPORT_SYMBOL() macros.”h]”hŒ©The following document describes how to use Symbol Namespaces to structure the
export surface of in-kernel symbols exported through the family of
EXPORT_SYMBOL() macros.”…””}”(hh¹hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khh£hžhubh¢)”}”(hhh]”(h§)”}”(hŒIntroduction”h]”hŒIntroduction”…””}”(hhÊhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhÇhžhhŸh¶h K
ubh¸)”}”(hX^  Symbol Namespaces have been introduced as a means to structure the export
surface of the in-kernel API. It allows subsystem maintainers to partition
their exported symbols into separate namespaces. That is useful for
documentation purposes (think of the SUBSYSTEM_DEBUG namespace) as well as for
limiting the availability of a set of symbols for use in other parts of the
kernel. As of today, modules that make use of symbols exported into namespaces,
are required to import the namespace. Otherwise the kernel will, depending on
its configuration, reject loading the module or warn about a missing import.”h]”hX^  Symbol Namespaces have been introduced as a means to structure the export
surface of the in-kernel API. It allows subsystem maintainers to partition
their exported symbols into separate namespaces. That is useful for
documentation purposes (think of the SUBSYSTEM_DEBUG namespace) as well as for
limiting the availability of a set of symbols for use in other parts of the
kernel. As of today, modules that make use of symbols exported into namespaces,
are required to import the namespace. Otherwise the kernel will, depending on
its configuration, reject loading the module or warn about a missing import.”…””}”(hhØhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubh¸)”}”(hŒ†Additionally, it is possible to put symbols into a module namespace, strictly
limiting which modules are allowed to use these symbols.”h]”hŒ†Additionally, it is possible to put symbols into a module namespace, strictly
limiting which modules are allowed to use these symbols.”…””}”(hhæhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KhhÇhžhubeh}”(h]”Œintroduction”ah ]”h"]”Œintroduction”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K
ubh¢)”}”(hhh]”(h§)”}”(hŒHow to define Symbol Namespaces”h]”hŒHow to define Symbol Namespaces”…””}”(hhÿhžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hhühžhhŸh¶h Kubh¸)”}”(hŒ¦Symbols can be exported into namespace using different methods. All of them are
changing the way EXPORT_SYMBOL and friends are instrumented to create ksymtab
entries.”h]”hŒ¦Symbols can be exported into namespace using different methods. All of them are
changing the way EXPORT_SYMBOL and friends are instrumented to create ksymtab
entries.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Khhühžhubh¢)”}”(hhh]”(h§)”}”(hŒUsing the EXPORT_SYMBOL macros”h]”hŒUsing the EXPORT_SYMBOL macros”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj  hžhhŸh¶h K ubh¸)”}”(hXÔ  In addition to the macros EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(), that allow
exporting of kernel symbols to the kernel symbol table, variants of these are
available to export symbols into a certain namespace: EXPORT_SYMBOL_NS() and
EXPORT_SYMBOL_NS_GPL(). They take one additional argument: the namespace as a
string constant. Note that this string must not contain whitespaces.
E.g. to export the symbol ``usb_stor_suspend`` into the
namespace ``USB_STORAGE``, use::”h]”(hX–  In addition to the macros EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(), that allow
exporting of kernel symbols to the kernel symbol table, variants of these are
available to export symbols into a certain namespace: EXPORT_SYMBOL_NS() and
EXPORT_SYMBOL_NS_GPL(). They take one additional argument: the namespace as a
string constant. Note that this string must not contain whitespaces.
E.g. to export the symbol ”…””}”(hj,  hžhhŸNh NubhŒliteral”“”)”}”(hŒ``usb_stor_suspend``”h]”hŒusb_stor_suspend”…””}”(hj6  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj,  ubhŒ into the
namespace ”…””}”(hj,  hžhhŸNh Nubj5  )”}”(hŒ``USB_STORAGE``”h]”hŒUSB_STORAGE”…””}”(hjH  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj,  ubhŒ, use:”…””}”(hj,  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K"hj  hžhubhŒliteral_block”“”)”}”(hŒ2EXPORT_SYMBOL_NS(usb_stor_suspend, "USB_STORAGE");”h]”hŒ2EXPORT_SYMBOL_NS(usb_stor_suspend, "USB_STORAGE");”…””}”hjb  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j`  hŸh¶h K*hj  hžhubh¸)”}”(hXQ  The corresponding ksymtab entry struct ``kernel_symbol`` will have the member
``namespace`` set accordingly. A symbol that is exported without a namespace will
refer to ``NULL``. There is no default namespace if none is defined. ``modpost``
and kernel/module/main.c make use the namespace at build time or module load
time, respectively.”h]”(hŒ'The corresponding ksymtab entry struct ”…””}”(hjr  hžhhŸNh Nubj5  )”}”(hŒ``kernel_symbol``”h]”hŒkernel_symbol”…””}”(hjz  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjr  ubhŒ will have the member
”…””}”(hjr  hžhhŸNh Nubj5  )”}”(hŒ``namespace``”h]”hŒ	namespace”…””}”(hjŒ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjr  ubhŒN set accordingly. A symbol that is exported without a namespace will
refer to ”…””}”(hjr  hžhhŸNh Nubj5  )”}”(hŒ``NULL``”h]”hŒNULL”…””}”(hjž  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjr  ubhŒ4. There is no default namespace if none is defined. ”…””}”(hjr  hžhhŸNh Nubj5  )”}”(hŒ``modpost``”h]”hŒmodpost”…””}”(hj°  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjr  ubhŒa
and kernel/module/main.c make use the namespace at build time or module load
time, respectively.”…””}”(hjr  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K,hj  hžhubeh}”(h]”Œusing-the-export-symbol-macros”ah ]”h"]”Œusing the export_symbol macros”ah$]”h&]”uh1h¡hhühžhhŸh¶h K ubh¢)”}”(hhh]”(h§)”}”(hŒ)Using the DEFAULT_SYMBOL_NAMESPACE define”h]”hŒ)Using the DEFAULT_SYMBOL_NAMESPACE define”…””}”(hjÓ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÐ  hžhhŸh¶h K3ubh¸)”}”(hX7  Defining namespaces for all symbols of a subsystem can be very verbose and may
become hard to maintain. Therefore a default define (DEFAULT_SYMBOL_NAMESPACE)
is been provided, that, if set, will become the default for all EXPORT_SYMBOL()
and EXPORT_SYMBOL_GPL() macro expansions that do not specify a namespace.”h]”hX7  Defining namespaces for all symbols of a subsystem can be very verbose and may
become hard to maintain. Therefore a default define (DEFAULT_SYMBOL_NAMESPACE)
is been provided, that, if set, will become the default for all EXPORT_SYMBOL()
and EXPORT_SYMBOL_GPL() macro expansions that do not specify a namespace.”…””}”(hjá  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K5hjÐ  hžhubh¸)”}”(hXd  There are multiple ways of specifying this define and it depends on the
subsystem and the maintainer's preference, which one to use. The first option
is to define the default namespace in the ``Makefile`` of the subsystem. E.g. to
export all symbols defined in usb-common into the namespace USB_COMMON, add a
line like this to drivers/usb/common/Makefile::”h]”(hŒÂThere are multiple ways of specifying this define and it depends on the
subsystem and the maintainerâ€™s preference, which one to use. The first option
is to define the default namespace in the ”…””}”(hjï  hžhhŸNh Nubj5  )”}”(hŒ``Makefile``”h]”hŒMakefile”…””}”(hj÷  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjï  ubhŒ— of the subsystem. E.g. to
export all symbols defined in usb-common into the namespace USB_COMMON, add a
line like this to drivers/usb/common/Makefile:”…””}”(hjï  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K:hjÐ  hžhubja  )”}”(hŒ6ccflags-y += -DDEFAULT_SYMBOL_NAMESPACE='"USB_COMMON"'”h]”hŒ6ccflags-y += -DDEFAULT_SYMBOL_NAMESPACE='"USB_COMMON"'”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h K@hjÐ  hžhubh¸)”}”(hX(  That will affect all EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL() statements. A
symbol exported with EXPORT_SYMBOL_NS() while this definition is present, will
still be exported into the namespace that is passed as the namespace argument
as this argument has preference over a default symbol namespace.”h]”hX(  That will affect all EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL() statements. A
symbol exported with EXPORT_SYMBOL_NS() while this definition is present, will
still be exported into the namespace that is passed as the namespace argument
as this argument has preference over a default symbol namespace.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KBhjÐ  hžhubh¸)”}”(hŒ’A second option to define the default namespace is directly in the compilation
unit as preprocessor statement. The above example would then read::”h]”hŒ‘A second option to define the default namespace is directly in the compilation
unit as preprocessor statement. The above example would then read:”…””}”(hj+  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KGhjÐ  hžhubja  )”}”(hŒ-#define DEFAULT_SYMBOL_NAMESPACE "USB_COMMON"”h]”hŒ-#define DEFAULT_SYMBOL_NAMESPACE "USB_COMMON"”…””}”hj9  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h KJhjÐ  hžhubh¸)”}”(hŒŽwithin the corresponding compilation unit before the #include for
<linux/export.h>. Typically it's placed before the first #include statement.”h]”hŒwithin the corresponding compilation unit before the #include for
<linux/export.h>. Typically itâ€™s placed before the first #include statement.”…””}”(hjG  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KLhjÐ  hžhubeh}”(h]”Œ)using-the-default-symbol-namespace-define”ah ]”h"]”Œ)using the default_symbol_namespace define”ah$]”h&]”uh1h¡hhühžhhŸh¶h K3ubh¢)”}”(hhh]”(h§)”}”(hŒ+Using the EXPORT_SYMBOL_FOR_MODULES() macro”h]”hŒ+Using the EXPORT_SYMBOL_FOR_MODULES() macro”…””}”(hj`  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj]  hžhhŸh¶h KPubh¸)”}”(hŒ¯Symbols exported using this macro are put into a module namespace. This
namespace cannot be imported. These exports are GPL-only as they are only
intended for in-tree modules.”h]”hŒ¯Symbols exported using this macro are put into a module namespace. This
namespace cannot be imported. These exports are GPL-only as they are only
intended for in-tree modules.”…””}”(hjn  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KRhj]  hžhubh¸)”}”(hŒ‹The macro takes a comma separated list of module names, allowing only those
modules to access this symbol. Simple tail-globs are supported.”h]”hŒ‹The macro takes a comma separated list of module names, allowing only those
modules to access this symbol. Simple tail-globs are supported.”…””}”(hj|  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KVhj]  hžhubh¸)”}”(hŒFor example::”h]”hŒFor example:”…””}”(hjŠ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KYhj]  hžhubja  )”}”(hŒ<EXPORT_SYMBOL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*")”h]”hŒ<EXPORT_SYMBOL_FOR_MODULES(preempt_notifier_inc, "kvm,kvm-*")”…””}”hj˜  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h K[hj]  hžhubh¸)”}”(hŒQwill limit usage of this symbol to modules whose name matches the given
patterns.”h]”hŒQwill limit usage of this symbol to modules whose name matches the given
patterns.”…””}”(hj¦  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K]hj]  hžhubeh}”(h]”Œ)using-the-export-symbol-for-modules-macro”ah ]”h"]”Œ+using the export_symbol_for_modules() macro”ah$]”h&]”uh1h¡hhühžhhŸh¶h KPubeh}”(h]”Œhow-to-define-symbol-namespaces”ah ]”h"]”Œhow to define symbol namespaces”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kubh¢)”}”(hhh]”(h§)”}”(hŒ)How to use Symbols exported in Namespaces”h]”hŒ)How to use Symbols exported in Namespaces”…””}”(hjÇ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjÄ  hžhhŸh¶h Kaubh¸)”}”(hX‘  In order to use symbols that are exported into namespaces, kernel modules need
to explicitly import these namespaces. Otherwise the kernel might reject to
load the module. The module code is required to use the macro MODULE_IMPORT_NS
for the namespaces it uses symbols from. E.g. a module using the
usb_stor_suspend symbol from above, needs to import the namespace USB_STORAGE
using a statement like::”h]”hX  In order to use symbols that are exported into namespaces, kernel modules need
to explicitly import these namespaces. Otherwise the kernel might reject to
load the module. The module code is required to use the macro MODULE_IMPORT_NS
for the namespaces it uses symbols from. E.g. a module using the
usb_stor_suspend symbol from above, needs to import the namespace USB_STORAGE
using a statement like:”…””}”(hjÕ  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KchjÄ  hžhubja  )”}”(hŒ MODULE_IMPORT_NS("USB_STORAGE");”h]”hŒ MODULE_IMPORT_NS("USB_STORAGE");”…””}”hjã  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h KjhjÄ  hžhubh¸)”}”(hŒ°This will create a ``modinfo`` tag in the module for each imported namespace.
This has the side effect, that the imported namespaces of a module can be
inspected with modinfo::”h]”(hŒThis will create a ”…””}”(hjñ  hžhhŸNh Nubj5  )”}”(hŒ``modinfo``”h]”hŒmodinfo”…””}”(hjù  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjñ  ubhŒ‘ tag in the module for each imported namespace.
This has the side effect, that the imported namespaces of a module can be
inspected with modinfo:”…””}”(hjñ  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KlhjÄ  hžhubja  )”}”(hŒR$ modinfo drivers/usb/storage/ums-karma.ko
[...]
import_ns:      USB_STORAGE
[...]”h]”hŒR$ modinfo drivers/usb/storage/ums-karma.ko
[...]
import_ns:      USB_STORAGE
[...]”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h KphjÄ  hžhubh¸)”}”(hŒŒIt is advisable to add the MODULE_IMPORT_NS() statement close to other module
metadata definitions like MODULE_AUTHOR() or MODULE_LICENSE().”h]”hŒŒIt is advisable to add the MODULE_IMPORT_NS() statement close to other module
metadata definitions like MODULE_AUTHOR() or MODULE_LICENSE().”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h KvhjÄ  hžhubeh}”(h]”Œ)how-to-use-symbols-exported-in-namespaces”ah ]”h"]”Œ)how to use symbols exported in namespaces”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kaubh¢)”}”(hhh]”(h§)”}”(hŒ+Loading Modules that use namespaced Symbols”h]”hŒ+Loading Modules that use namespaced Symbols”…””}”(hj8  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hj5  hžhhŸh¶h Kzubh¸)”}”(hXP  At module loading time (e.g. ``insmod``), the kernel will check each symbol
referenced from the module for its availability and whether the namespace it
might be exported to has been imported by the module. The default behaviour of
the kernel is to reject loading modules that don't specify sufficient imports.
An error will be logged and loading will be failed with EINVAL. In order to
allow loading of modules that don't satisfy this precondition, a configuration
option is available: Setting MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=y will
enable loading regardless, but will emit a warning.”h]”(hŒAt module loading time (e.g. ”…””}”(hjF  hžhhŸNh Nubj5  )”}”(hŒ
``insmod``”h]”hŒinsmod”…””}”(hjN  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hjF  ubhX-  ), the kernel will check each symbol
referenced from the module for its availability and whether the namespace it
might be exported to has been imported by the module. The default behaviour of
the kernel is to reject loading modules that donâ€™t specify sufficient imports.
An error will be logged and loading will be failed with EINVAL. In order to
allow loading of modules that donâ€™t satisfy this precondition, a configuration
option is available: Setting MODULE_ALLOW_MISSING_NAMESPACE_IMPORTS=y will
enable loading regardless, but will emit a warning.”…””}”(hjF  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K|hj5  hžhubeh}”(h]”Œ+loading-modules-that-use-namespaced-symbols”ah ]”h"]”Œ+loading modules that use namespaced symbols”ah$]”h&]”uh1h¡hh£hžhhŸh¶h Kzubh¢)”}”(hhh]”(h§)”}”(hŒ2Automatically creating MODULE_IMPORT_NS statements”h]”hŒ2Automatically creating MODULE_IMPORT_NS statements”…””}”(hjq  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h¦hjn  hžhhŸh¶h K†ubh¸)”}”(hXÇ  Missing namespaces imports can easily be detected at build time. In fact,
modpost will emit a warning if a module uses a symbol from a namespace
without importing it.
MODULE_IMPORT_NS() statements will usually be added at a definite location
(along with other module meta data). To make the life of module authors (and
subsystem maintainers) easier, a script and make target is available to fixup
missing imports. Fixing missing imports can be done with::”h]”hXÆ  Missing namespaces imports can easily be detected at build time. In fact,
modpost will emit a warning if a module uses a symbol from a namespace
without importing it.
MODULE_IMPORT_NS() statements will usually be added at a definite location
(along with other module meta data). To make the life of module authors (and
subsystem maintainers) easier, a script and make target is available to fixup
missing imports. Fixing missing imports can be done with:”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h Kˆhjn  hžhubja  )”}”(hŒ$ make nsdeps”h]”hŒ$ make nsdeps”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h Khjn  hžhubh¸)”}”(hŒ0A typical scenario for module authors would be::”h]”hŒ/A typical scenario for module authors would be:”…””}”(hj›  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K’hjn  hžhubja  )”}”(hŒÒ- write code that depends on a symbol from a not imported namespace
- ``make``
- notice the warning of modpost telling about a missing import
- run ``make nsdeps`` to add the import to the correct code location”h]”hŒÒ- write code that depends on a symbol from a not imported namespace
- ``make``
- notice the warning of modpost telling about a missing import
- run ``make nsdeps`` to add the import to the correct code location”…””}”hj©  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h K”hjn  hžhubh¸)”}”(hŒ­For subsystem maintainers introducing a namespace, the steps are very similar.
Again, ``make nsdeps`` will eventually add the missing namespace imports for
in-tree modules::”h]”(hŒVFor subsystem maintainers introducing a namespace, the steps are very similar.
Again, ”…””}”(hj·  hžhhŸNh Nubj5  )”}”(hŒ``make nsdeps``”h]”hŒmake nsdeps”…””}”(hj¿  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j4  hj·  ubhŒG will eventually add the missing namespace imports for
in-tree modules:”…””}”(hj·  hžhhŸNh Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K™hjn  hžhubja  )”}”(hX  - move or add symbols to a namespace (e.g. with EXPORT_SYMBOL_NS())
- ``make`` (preferably with an allmodconfig to cover all in-kernel
  modules)
- notice the warning of modpost telling about a missing import
- run ``make nsdeps`` to add the import to the correct code location”h]”hX  - move or add symbols to a namespace (e.g. with EXPORT_SYMBOL_NS())
- ``make`` (preferably with an allmodconfig to cover all in-kernel
  modules)
- notice the warning of modpost telling about a missing import
- run ``make nsdeps`` to add the import to the correct code location”…””}”hj×  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h Khjn  hžhubh¸)”}”(hŒHYou can also run nsdeps for external module builds. A typical usage is::”h]”hŒGYou can also run nsdeps for external module builds. A typical usage is:”…””}”(hjå  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K£hjn  hžhubja  )”}”(hŒ,$ make -C <path_to_kernel_src> M=$PWD nsdeps”h]”hŒ,$ make -C <path_to_kernel_src> M=$PWD nsdeps”…””}”hjó  sbah}”(h]”h ]”h"]”h$]”h&]”jp  jq  uh1j`  hŸh¶h K¥hjn  hžhubh¸)”}”(hŒŠNote: it will happily generate an import statement for the module namespace;
which will not work and generates build and runtime failures.”h]”hŒŠNote: it will happily generate an import statement for the module namespace;
which will not work and generates build and runtime failures.”…””}”(hj  hžhhŸNh Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h·hŸh¶h K§hjn  hžhubeh}”(h]”Œ2automatically-creating-module-import-ns-statements”ah ]”h"]”Œ2automatically creating module_import_ns statements”ah$]”h&]”uh1h¡hh£hžhhŸh¶h K†ubeh}”(h]”Œsymbol-namespaces”ah ]”h"]”Œsymbol namespaces”ah$]”h&]”uh1h¡hhhžhhŸh¶h Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”h¶uh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(h¦NŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jB  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h¶Œ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j  j  hùhöjÁ  j¾  jÍ  jÊ  jZ  jW  j¹  j¶  j2  j/  jk  jh  j  j  uŒ	nametypes”}”(j  ‰hù‰jÁ  ‰jÍ  ‰jZ  ‰j¹  ‰j2  ‰jk  ‰j  ‰uh}”(j  h£höhÇj¾  hüjÊ  j  jW  jÐ  j¶  j]  j/  jÄ  jh  j5  j  jn  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nhžhub.