Skip to contentSkip to conversation

kbuild: clarify the difference between obj-y and obj-m w.r.t. descending

PATCH In review Masahiro Yamada 3 participants 5 messages Dec 19, 2019 – Dec 21, 2019

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kbuild: clarify the difference between obj-y and obj-m w.r.t. descending

Kbuild descends into a directory by either 'y' or 'm', but there is an important difference.

Kbuild combines the built-in objects into built-in.a in each directory. The built-in.a in the directory visited by obj-y is merged into the built-in.a in the parent directory. This merge happens recursively when Kbuild is ascending back towards the top directory, so built-in objects are linked into vmlinux eventually. This works properly only when the Makefile that specifies obj-y is reachable by the chain of obj-y.

On the other hand, Kbuild does not take built-in.a from the directory visited by obj-m. This it, all the objects in that directory are supposed to be modular. If Kbuild descends into a directory by obj-m, but the Makefile in the sub-directory specifies obj-y, those objects are just left orphan.

The current statement "Kbuild only uses this information to decide that it needs to visit the directory" is misleading. Clarify the difference.

---

 Documentation/kbuild/makefiles.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)
Documentation/kbuild/makefiles.rst +13 -3
index b9b50553bfc5..d7e6534a8505 100644
@@ -297,9 +297,19 @@ more details, with real examples.
 	If CONFIG_EXT2_FS is set to either 'y' (built-in) or 'm' (modular)
 	the corresponding obj- variable will be set, and kbuild will descend
 	down in the ext2 directory.
-	Kbuild only uses this information to decide that it needs to visit
-	the directory, it is the Makefile in the subdirectory that
-	specifies what is modular and what is built-in.
+
+	Kbuild uses this information not only to decide that it needs to visit
+	the directory, but also to decide whether or not to link objects from
+	the directory into vmlinux.
+
+	When Kbuild descends into the directory with 'y', all built-in objects
+	from that directory are combined into the built-in.a, which will be
+	eventually linked into vmlinux.
+
+	When Kbuild descends into the directory with 'm', in contrast, nothing
+	from that directory will be linked into vmlinux. If the Makefile in
+	that directory specifies obj-y, those objects will be left orphan.
+	It is very likely a bug of the Makefile or of dependencies in Kconfig.
 
 	It is good practice to use a `CONFIG_` variable when assigning directory
 	names. This allows kbuild to totally skip the directory if the
Signature · 1 line
2.17.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 16 lines · Masahiro Yamada

Kbuild descends into a directory by either 'y' or 'm', but there is an important difference.

Kbuild combines the built-in objects into built-in.a in each directory. The built-in.a in the directory visited by obj-y is merged into the built-in.a in the parent directory. This merge happens recursively when Kbuild is ascending back towards the top directory, so built-in objects are linked into vmlinux eventually. This works properly only when the Makefile that specifies obj-y is reachable by the chain of obj-y.

On the other hand, Kbuild does not take built-in.a from the directory visited by obj-m. This it, all the objects in that directory are supposed to be modular. If Kbuild descends into a directory by obj-m, but the Makefile in the sub-directory specifies obj-y, those objects are just left orphan.

Quoted 5 lines

The current statement "Kbuild only uses this information to decide that it needs to visit the directory" is misleading. Clarify the difference.

Looks good! Thanks for fixing this.

Quoted 32 lines

---

 Documentation/kbuild/makefiles.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)
Documentation/kbuild/makefiles.rst +13 -3
index b9b50553bfc5..d7e6534a8505 100644
@@ -297,9 +297,19 @@ more details, with real examples.
 	If CONFIG_EXT2_FS is set to either 'y' (built-in) or 'm' (modular)
 	the corresponding obj- variable will be set, and kbuild will descend
 	down in the ext2 directory.
-	Kbuild only uses this information to decide that it needs to visit
-	the directory, it is the Makefile in the subdirectory that
-	specifies what is modular and what is built-in.
+
+	Kbuild uses this information not only to decide that it needs to visit
+	the directory, but also to decide whether or not to link objects from
+	the directory into vmlinux.
+
+	When Kbuild descends into the directory with 'y', all built-in objects
+	from that directory are combined into the built-in.a, which will be
+	eventually linked into vmlinux.
+
+	When Kbuild descends into the directory with 'm', in contrast, nothing
+	from that directory will be linked into vmlinux. If the Makefile in
+	that directory specifies obj-y, those objects will be left orphan.
+	It is very likely a bug of the Makefile or of dependencies in Kconfig.
 
 	It is good practice to use a `CONFIG_` variable when assigning directory
 	names. This allows kbuild to totally skip the directory if the
#2 lore raw
Quoted 21 lines · Johan Hovold
Quoted 19 lines · Masahiro Yamada

Kbuild descends into a directory by either 'y' or 'm', but there is an important difference.

Kbuild combines the built-in objects into built-in.a in each directory. The built-in.a in the directory visited by obj-y is merged into the built-in.a in the parent directory. This merge happens recursively when Kbuild is ascending back towards the top directory, so built-in objects are linked into vmlinux eventually. This works properly only when the Makefile that specifies obj-y is reachable by the chain of obj-y.

On the other hand, Kbuild does not take built-in.a from the directory visited by obj-m. This it, all the objects in that directory are supposed to be modular. If Kbuild descends into a directory by obj-m, but the Makefile in the sub-directory specifies obj-y, those objects are just left orphan.

The current statement "Kbuild only uses this information to decide that it needs to visit the directory" is misleading. Clarify the difference.

Quoted 6 lines
Quoted 2 lines

Looks good! Thanks for fixing this.

Applied to linux-kbuild.

Quoted 32 lines
Quoted 32 lines

---

 Documentation/kbuild/makefiles.rst | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)
Documentation/kbuild/makefiles.rst +13 -3
index b9b50553bfc5..d7e6534a8505 100644
@@ -297,9 +297,19 @@ more details, with real examples.
      If CONFIG_EXT2_FS is set to either 'y' (built-in) or 'm' (modular)
      the corresponding obj- variable will be set, and kbuild will descend
      down in the ext2 directory.
-     Kbuild only uses this information to decide that it needs to visit
-     the directory, it is the Makefile in the subdirectory that
-     specifies what is modular and what is built-in.
+
+     Kbuild uses this information not only to decide that it needs to visit
+     the directory, but also to decide whether or not to link objects from
+     the directory into vmlinux.
+
+     When Kbuild descends into the directory with 'y', all built-in objects
+     from that directory are combined into the built-in.a, which will be
+     eventually linked into vmlinux.
+
+     When Kbuild descends into the directory with 'm', in contrast, nothing
+     from that directory will be linked into vmlinux. If the Makefile in
+     that directory specifies obj-y, those objects will be left orphan.
+     It is very likely a bug of the Makefile or of dependencies in Kconfig.
 
      It is good practice to use a `CONFIG_` variable when assigning directory
      names. This allows kbuild to totally skip the directory if the
Signature · 2 lines
Best Regards
Masahiro Yamada
#3 lore raw
In reply to Masahiro Yamada
Quoted 21 lines · Masahiro Yamada

Kbuild descends into a directory by either 'y' or 'm', but there is an important difference.

Kbuild combines the built-in objects into built-in.a in each directory. The built-in.a in the directory visited by obj-y is merged into the built-in.a in the parent directory. This merge happens recursively when Kbuild is ascending back towards the top directory, so built-in objects are linked into vmlinux eventually. This works properly only when the Makefile that specifies obj-y is reachable by the chain of obj-y.

On the other hand, Kbuild does not take built-in.a from the directory visited by obj-m. This it, all the objects in that directory are supposed to be modular. If Kbuild descends into a directory by obj-m, but the Makefile in the sub-directory specifies obj-y, those objects are just left orphan.

The current statement "Kbuild only uses this information to decide that it needs to visit the directory" is misleading. Clarify the difference.

Documentation/kbuild/makefiles.rst +2 -0
+	Kbuild uses this information not only to decide that it needs to visit
+	the directory, but also to decide whether or not to link objects from

Documentation/kbuild/makefiles.rst more details, with real examples. · line 312

Quoted 10 lines
Documentation/kbuild/makefiles.rst +10 -0
+	the directory into vmlinux.
+
+	When Kbuild descends into the directory with 'y', all built-in objects
+	from that directory are combined into the built-in.a, which will be
+	eventually linked into vmlinux.
+
+	When Kbuild descends into the directory with 'm', in contrast, nothing
+	from that directory will be linked into vmlinux. If the Makefile in
+	that directory specifies obj-y, those objects will be left orphan.
+	It is very likely a bug of the Makefile or of dependencies in Kconfig.

Perhaps the implementation should be changed to match the documentation? This seems like a very subtle point for people to know.

#4 lore raw
Quoted 21 lines · Matthew Wilcox
Quoted 18 lines · Masahiro Yamada

Kbuild descends into a directory by either 'y' or 'm', but there is an important difference.

Kbuild combines the built-in objects into built-in.a in each directory. The built-in.a in the directory visited by obj-y is merged into the built-in.a in the parent directory. This merge happens recursively when Kbuild is ascending back towards the top directory, so built-in objects are linked into vmlinux eventually. This works properly only when the Makefile that specifies obj-y is reachable by the chain of obj-y.

On the other hand, Kbuild does not take built-in.a from the directory visited by obj-m. This it, all the objects in that directory are supposed to be modular. If Kbuild descends into a directory by obj-m, but the Makefile in the sub-directory specifies obj-y, those objects are just left orphan.

The current statement "Kbuild only uses this information to decide that it needs to visit the directory" is misleading. Clarify the difference.

Quoted 15 lines

Documentation/kbuild/makefiles.rst more details, with real examples. · line 312

Quoted 12 lines
Documentation/kbuild/makefiles.rst +12 -0
+     Kbuild uses this information not only to decide that it needs to visit
+     the directory, but also to decide whether or not to link objects from
+     the directory into vmlinux.
+
+     When Kbuild descends into the directory with 'y', all built-in objects
+     from that directory are combined into the built-in.a, which will be
+     eventually linked into vmlinux.
+
+     When Kbuild descends into the directory with 'm', in contrast, nothing
+     from that directory will be linked into vmlinux. If the Makefile in
+     that directory specifies obj-y, those objects will be left orphan.
+     It is very likely a bug of the Makefile or of dependencies in Kconfig.

Perhaps the implementation should be changed to match the documentation? This seems like a very subtle point for people to know.

I also considered this, but
I do not think the current behavior is too odd.
So, I am not changing it.

Signature · 2 lines
Best Regards
Masahiro Yamada