Skip to contentSkip to conversation

make headers_install

GIT * David Woodhouse 2 participants 3 messages Jun 27, 2006 – Jun 29, 2006

lore
Share & tools
lore
#0 lore raw

Linus, please pull from git://git.infradead.org/hdrinstall-2.6.git

This contains an implementation of a 'make headers_install' target for the kernel -- based on original work by Arnd Bergmann, modifed my myself and then cleaned up by Sam. This copies _selected_ kernel headers out to a separate directory, passing them through sed and BSD's 'unifdef' tool to remove parts which userspace should not see.

(The BSD 'unifdef' tool is available at least in Fedora and Debian through their standard package management tools. I believe that Sam intends to follow up with a patch to add our own copy of unifdef into the kernel scripts/ directory, as soon as he's fixed the dependency issues with that.)

This isn't a departure from our current policy that random userspace must not poke at kernel private headers. It's just an attempt to impose some control over those places where we have to accept that people _do_ use the kernel's headers -- when building system libraries and tools, and when building compilers.

Currently, the compiler-build scripts just use 'cp -a', while the distributions tend to do their own thing to make it _slightly_ saner than that, although it's a lot of work to do so. The result is wildly inconsistent and often exposes things which we really don't want userspace to have copies of.

By adding a 'make headers_install' target to the kernel, we regulate those people who really do have to use kernel headers, and we can ensure that we have a _consistent_ set of headers across all distributions, which contains only what we _need_ to expose; ioctl definitions, etc.

An additional benefit is that comparing the results of 'make headers_install' from one kernel release to the next allows us to spot kernel<->user ABI changes in isolation and give them the extra review that they deserve. I've already caught and fixed one potential problem with 32-bit userspace on a 64-bit kernel this way.

The result of this export is already being used in the Fedora Core 6 test releases, and other distributions are either looking at switching over to it or have done so already.

Ignoring the new Kbuild files which just list the files to be exported from each directory under include/, the diffstat is as follows:

 Makefile                              |   17 ++++
 scripts/Makefile.headersinst          |  158 +++++++++++++++++++++++++++++++++
 scripts/hdrcheck.sh                   |    8 ++
 49 files changed, 399 insertions(+), 0 deletions(-)

David S. Miller:
Restrict headers exported to userspace for SPARC and SPARC64

David Woodhouse:
Basic implementation of 'make headers_install'
Basic implementation of 'make headers_check'
Add generic Kbuild files for 'make headers_install'
Add Kbuild file for PowerPC 'make headers_install'
Add Kbuild file for x86_64 'make headers_install'
Add Kbuild file for i386 'make headers_install'
Add Kbuild file for S390 'make headers_install'
Add Kbuild file for IA64 'make headers_install'
Add Kbuild file for SPARC 'make headers_install'
Add Kbuild file for Alpha 'make headers_install'
Add empty Kbuild files for 'make headers_install' in remaining arches.

Jean Delvare:
Remove <linux/i2c-id.h> and <linux/i2c-algo-ite.h> from userspace export

Signature · 1 line
dwmw2
#1 lore raw
Quoted 37 lines · David Woodhouse

Linus, please pull from git://git.infradead.org/hdrinstall-2.6.git

This contains an implementation of a 'make headers_install' target for the kernel -- based on original work by Arnd Bergmann, modifed my myself and then cleaned up by Sam. This copies _selected_ kernel headers out to a separate directory, passing them through sed and BSD's 'unifdef' tool to remove parts which userspace should not see.

(The BSD 'unifdef' tool is available at least in Fedora and Debian through their standard package management tools. I believe that Sam intends to follow up with a patch to add our own copy of unifdef into the kernel scripts/ directory, as soon as he's fixed the dependency issues with that.)

This isn't a departure from our current policy that random userspace must not poke at kernel private headers. It's just an attempt to impose some control over those places where we have to accept that people _do_ use the kernel's headers -- when building system libraries and tools, and when building compilers.

Currently, the compiler-build scripts just use 'cp -a', while the distributions tend to do their own thing to make it _slightly_ saner than that, although it's a lot of work to do so. The result is wildly inconsistent and often exposes things which we really don't want userspace to have copies of.

By adding a 'make headers_install' target to the kernel, we regulate those people who really do have to use kernel headers, and we can ensure that we have a _consistent_ set of headers across all distributions, which contains only what we _need_ to expose; ioctl definitions, etc.

An additional benefit is that comparing the results of 'make headers_install' from one kernel release to the next allows us to spot kernel<->user ABI changes in isolation and give them the extra review that they deserve. I've already caught and fixed one potential problem with 32-bit userspace on a 64-bit kernel this way.

Quoted 6 lines

The result of this export is already being used in the Fedora Core 6 test releases, and other distributions are either looking at switching over to it or have done so already.

Ignoring the new Kbuild files which just list the files to be exported from each directory under include/, the diffstat is as follows:

Thanks for the time you've been pouring into this. Copying kernel header into applications clearly didn't work too well, especially for arch stuff (two dozen and counting ...) it was a pain and each distribution had different sets of hacked kernel headers. So I hope this will restore some sanity - and same for klibc.

Ralf

#2 lore raw
Quoted 4 lines · Ralf Baechle

Thanks for the time you've been pouring into this. Copying kernel header into applications clearly didn't work too well, especially for arch stuff (two dozen and counting ...) it was a pain and each distribution had different sets of hacked kernel headers.

The technical part wasn't very time-consuming at all. Arnd provided the basic implementation, and I just tweaked it a little to use unifdef and be a bit more selective about what we export. It's probably taken less time than it would have done to get Fedora's 'glibc-kernheaders' package into shape manually the way it always used to be done -- and it'll _certainly_ be a Godsend for future updates.

The time-consuming part was chasing up those who look after similar packages in other distributions and making sure they were happy enough with the principle too -- tracking them down on IRC when they ignored my emails.

The current hurdle seems to be getting Linus to take it or at least comment, now that everyone _else_ seems to be fairly much in agreement. I'm hoping we don't have to let it drag on till the Kernel Summit.

Signature · 1 line
dwmw2