Skip to contentSkip to conversation

headercheck - check dependencies on header files

ANNOUNCE Sam Ravnborg 3 participants 4 messages Apr 9, 2009 – Apr 10, 2009 Kbuild

lore
Share & tools
lore
#0 lore raw

We have at several occasions discussed if our header files should include their dependencies or not.

But we were lacking a tool to tell us if our header files included the headerfiles they needed or not.

headercheck can be used to do so.

headercheck use the existing Kbuild files in
include/ to determine which directories to visit.

And for each directory it create one .c file for each .h file and build it.

A .c file looks like this:

	$cat module.h.c
		#include <linux/module.h>

Building this file will tell us if module.h is missing any dependencies (but NOT if it has too many) with the current configuration.

We know that some header files are simply NOT supposed to be included direct and thus is not eligble to such a check.

To avoid checking these we can say in Kbuild:

	ignore-y += compiler-gcc.h

This tells headercheck to ignore compiler-gcc.h when performing the headercheck.

The current implementation leaves a lot of .c files. I will address this if the concept is considered acceptable.

To visit all relevant directories we need to adjust the Kbuild files but that can wait until we have the current pile fixed. Likewise it does not support arch specific include files. That can wait too.

I have tried running headercheck on an i386 defconfig and the result shows that a lot af headers does not include there dependencies.

The numbers (including sub-directories):

25 include/asm-generic
12 include/drm
282 include/linux
2 include/mtd
24 include/sound
12 include/video

Remember we do not visit all directories - only those listed in include/Kbuild.

To try it yourself apply following patch and on a configured kernel use:

make -k headercheck

Looking at the errors I would assume that at least 75% of the errors can be fixed in one day but the rest may be a bit more troublesome.

The open question is if this is worthwhile?

Sam

From a88159a3bcbae4e5748d25f71d761c142d89c85d Mon Sep 17 00:00:00 2001
From: Sam Ravnborg <[email protected]>
Date: Thu, 9 Apr 2009 21:56:03 +0200
Subject: [PATCH] kbuild: add headercheck

headercheck is used to check if all headerfiles include the files that is needed for a headerfile to build.

It visits all directories listed in include/Kbuild using header-y. And for each header file it creates a .c file that is then build.

---
 Makefile                   |    6 +++++
 include/linux/Kbuild       |    7 ++++++
 scripts/Kbuild.headercheck |   46 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 59 insertions(+), 0 deletions(-)
 create mode 100644 scripts/Kbuild.headercheck
Makefile +6 -0
index e5ad5fd..39ed688 100644
@@ -837,6 +837,9 @@ vmlinux: $(vmlinux-lds) $(vmlinux-init) $(vmlinux-main) vmlinux.o $(kallsyms.o)
 ifdef CONFIG_HEADERS_CHECK
 	$(Q)$(MAKE) -f $(srctree)/Makefile headers_check
 endif
+ifndef CONFIG_INCLUDE_HEADER_CHECK
+	$(Q)$(MAKE) -f $(srctree)/scripts/Kbuild.headercheck obj=include
+endif
 ifdef CONFIG_SAMPLES
 	$(Q)$(MAKE) $(build)=samples
 endif
@@ -1463,6 +1466,9 @@ namespacecheck:
 export_report:
 	$(PERL) $(srctree)/scripts/export_report.pl
 
+headercheck:
+	$(Q)$(MAKE) -f $(srctree)/scripts/Kbuild.headercheck obj=include
+
 endif #ifeq ($(config-targets),1)
 endif #ifeq ($(mixed-targets),1)
 
include/linux/Kbuild +7 -0
index ca9b9b9..49b61ff 100644
@@ -375,3 +375,10 @@ unifdef-y += xfrm.h
 objhdr-y += version.h
 header-y += wimax.h
 header-y += wimax/
+
+# header files that cannot be build alone
+# (not checked by make headercheck)
+ignore-y += compiler-intel.h
+ignore-y += compiler-gcc.h
+ignore-y += compiler-gcc3.h
+ignore-y += compiler-gcc4.h
scripts/Kbuild.headercheck new file +46 -0

46 lines not on this page · raw message

Signature · 1 line
1.6.0.2.GIT
#1 lore raw

Hello Sam,

Quoted 11 lines · Sam Ravnborg

We have at several occasions discussed if our header files should include their dependencies or not.

But we were lacking a tool to tell us if our header files included the headerfiles they needed or not.

headercheck can be used to do so.

headercheck use the existing Kbuild files in include/ to determine which directories to visit.

Quoted 8 lines

And for each directory it create one .c file for each .h file and build it.

A .c file looks like this:

	$cat module.h.c
		#include <linux/module.h>

Is it possible to check that which header files are included in source file.

I mean how many header files are included for kernel/module.c and in which order and we can also check that same file is requested how many times, like:

linux/module.h (requested count, included or not) +linux/list.h
++linux/stddef.h

and so on.

Thanks,
--
JSR

#2 lore raw
Quoted 26 lines · Jaswinder Singh Rajput

Hello Sam,

Quoted 11 lines · Sam Ravnborg

We have at several occasions discussed if our header files should include their dependencies or not.

But we were lacking a tool to tell us if our header files included the headerfiles they needed or not.

headercheck can be used to do so.

headercheck use the existing Kbuild files in include/ to determine which directories to visit.

Quoted 8 lines

And for each directory it create one .c file for each .h file and build it.

A .c file looks like this:

	$cat module.h.c
		#include <linux/module.h>

Is it possible to check that which header files are included in source file.

Quoted 7 lines

I mean how many header files are included for kernel/module.c and in which order and we can also check that same file is requested how many times, like:

linux/module.h (requested count, included or not) +linux/list.h
++linux/stddef.h

Try to take a look at:
http://www.kernel.org/pub/linux/kernel/people/rayl/headergraphs/

and

http://www.kernel.org/pub/linux/kernel/people/acme/hviz

Sam

#3 lore raw
In reply to Sam Ravnborg
Quoted 57 lines · Sam Ravnborg

We have at several occasions discussed if our header files should include their dependencies or not.

But we were lacking a tool to tell us if our header files included the headerfiles they needed or not.

headercheck can be used to do so.

headercheck use the existing Kbuild files in
include/ to determine which directories to visit.

And for each directory it create one .c file for each .h file and build it.

A .c file looks like this:

	$cat module.h.c
		#include <linux/module.h>

Building this file will tell us if module.h is missing any dependencies (but NOT if it has too many) with the current configuration.

We know that some header files are simply NOT supposed to be included direct and thus is not eligble to such a check.

To avoid checking these we can say in Kbuild:

	ignore-y += compiler-gcc.h

This tells headercheck to ignore compiler-gcc.h when performing the headercheck.

The current implementation leaves a lot of .c files. I will address this if the concept is considered acceptable.

To visit all relevant directories we need to adjust the Kbuild files but that can wait until we have the current pile fixed. Likewise it does not support arch specific include files. That can wait too.

I have tried running headercheck on an i386 defconfig and the result shows that a lot af headers does not include there dependencies.

The numbers (including sub-directories):

25 include/asm-generic
12 include/drm
282 include/linux
2 include/mtd
24 include/sound
12 include/video

Remember we do not visit all directories - only those listed in include/Kbuild.

Quoted 8 lines

To try it yourself apply following patch and on a configured kernel use:

make -k headercheck

Looking at the errors I would assume that at least 75% of the errors can be fixed in one day but the rest may be a bit more troublesome.

The open question is if this is worthwhile?

Definitely a good idea IMHO. The current practice of 'include enough .h files in the .c file to make it build' has resulted in perversely long #include line sections in .c files.

For example arch/x86/kernel/setup.c has 76 headers (!) at the moment, and you have to go down 4 pages in the file before you see the first line of substantial code.

Or arch/x86/mm/fault.c had 32 headers - i recently cut that down to 11 only.

Nice would be to have a tool that lists the minimum set of required headers for any given .c file, for a current .config. If we run that in allyesconfig we get a pretty good approximation of the headers needed.

Ingo