[RFC] linux: translate config to structured config by teto · Pull Request #41393 · NixOS/nixpkgs

teto · 2018-06-02T17:12:24Z

Follow up of #12158 @copumpkin . I am looking for comments before polishing as compiling kernels is not especially fast here.

The set is then converted into a string so backwards compatibility kinda applies (users can still specify their kernel extraConfig as a string) but it should be deprecated in favor of sets.

Motivation for this change

I want to be able to convert "module" answers into "yes" and vice-versa
with the current kernel config system, the first defined is taken into account so

extraConfig = ''
OPENVSWITCH y 
OPENVSWITCH m
'';

will end up with yes. Even though this PR doesn't solve this problem, it paves the way for some kind of mkMerge mechanism.

Things done

added structuredExtraConfig and mkValuePreprocess to buildLinux args, I kept extraConfig as a string for backawards compatibility, structuredExtraConfig must be a flat set e.g. { BPF = yes; BPF_SYSCALL = y; }
mkValuePreprocess allows to override each setting, aka convert 'yes' into 'modules' or vice-versa

I test the changes with this overlay expression and tried compiling a few kernels (can't do all though with my poor machine).

  linux_test = prev.linux_4_16.override {
    ignoreConfigErrors=true;
    autoModules = false;
    kernelPreferBuiltin = true;
  };

Future work
[ ] Convert patches to this new format
[ ] make packages describe their kernel requirements (bcc needs BPF, openvswitch needs OPENVSWITCH etc)
For instance the openvswitch package could contain hints to the configuration:

 with lib.kernel;
   passthru.kernelExtraConfig = with callPackage ./lib/kernel.nix { version = kernel.version; }; {
     OPENVSWITCH  = whenAtLeast "2.0" yes;
   };

and have the module actually enforce that configuration:

    boot.kernelPatches = [ {
         name = "openvswitch";
         patch = null;
         extraConfig = lib.kernel.generateKConf pkgs.openvswitch.passthru.kernelExtraConfig;
       }
     ];

Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
Built on platform(s)
- NixOS
- macOS
- other Linux distributions
Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
Tested execution of all binary files (usually in ./result/bin/)
Fits CONTRIBUTING.md.

GrahamcOfBorg · 2018-06-02T17:28:42Z

Success on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

/nix/store/si1gisyb8ly0vnrhgdx5qxdzngyvsi5v-linux-4.14.47

GrahamcOfBorg · 2018-06-03T12:41:55Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

these paths will be fetched (48.28 MiB download, 78.80 MiB unpacked):
  /nix/store/swwnj5b8jfz1bi6fvvfvlcgqwwsbkzni-linux-4.14.47
copying path '/nix/store/swwnj5b8jfz1bi6fvvfvlcgqwwsbkzni-linux-4.14.47' from 'https://cache.nixos.org'...
warning: SQLite database '/nix/var/nix/db/db.sqlite' is busy
/nix/store/swwnj5b8jfz1bi6fvvfvlcgqwwsbkzni-linux-4.14.47

GrahamcOfBorg · 2018-06-14T16:28:40Z

Success on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

/nix/store/nn55hl7zxl8cx9xl0bv7ra8jz2bqjczr-linux-4.14.49

GrahamcOfBorg · 2018-06-14T16:28:56Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

these paths will be fetched (48.27 MiB download, 78.79 MiB unpacked):
  /nix/store/6wpbdldldwn76lxq1m3vjrgp9a15aqxz-linux-4.14.49
copying path '/nix/store/6wpbdldldwn76lxq1m3vjrgp9a15aqxz-linux-4.14.49' from 'https://cache.nixos.org'...
/nix/store/6wpbdldldwn76lxq1m3vjrgp9a15aqxz-linux-4.14.49

teto · 2018-06-17T15:11:10Z

I updated the default config so that it reflects exaclty (notwithstanding my mistakes) the current common-config.nix.
When I try to run nox-review wip --against=upstream/master I get this kind of error http://nixpaste.lbr.uno/-fsL_q4k?nix so I accept any tip on how to tackle this kind of "infinite recursion" problem

GrahamcOfBorg · 2018-06-17T15:47:10Z

Success on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
/nix/store/cv3cfq0axhlcqg0khw1lrxddxsg03nyb-linux-4.14.50

GrahamcOfBorg · 2018-06-17T15:53:20Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
cannot find section .dynamic
/nix/store/bja0q8gf2bxv798kxmqhjw3sqzlhxadv-linux-4.14.50

GrahamcOfBorg · 2018-06-18T08:15:50Z

Success on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

/nix/store/cv3cfq0axhlcqg0khw1lrxddxsg03nyb-linux-4.14.50

teto · 2018-06-18T08:55:05Z

I've updated common-config to reflect all the changes since copumpkin PRs and was able to compile 4.17. I updated the initial message too, removing out of scope changes. It should be ready for review (apart from the messy history)

GrahamcOfBorg · 2018-06-18T09:21:48Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
cannot find section .dynamic
/nix/store/bja0q8gf2bxv798kxmqhjw3sqzlhxadv-linux-4.14.50

teto · 2018-06-18T09:25:59Z

lib/kernel.nix

todo remove

teto · 2018-06-18T09:26:23Z

pkgs/os-specific/linux/kernel/generic.nix

remove comment

teto · 2018-06-18T09:26:39Z

pkgs/os-specific/linux/kernel/manual-config.nix

add "extraConfig"

GrahamcOfBorg · 2018-06-20T04:52:48Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
cannot find section .dynamic
/nix/store/bja0q8gf2bxv798kxmqhjw3sqzlhxadv-linux-4.14.50

GrahamcOfBorg · 2018-06-20T05:03:18Z

Failure on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

  CC [M]  drivers/staging/speakup/fakekey.o
  CC [M]  drivers/staging/speakup/main.o
  CC [M]  drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.o
  CC [M]  drivers/staging/rtlwifi/halmac/halmac_88xx/halmac_api_88xx_usb.o
  CC [M]  drivers/staging/rtlwifi/halmac/halmac_88xx/halmac_api_88xx_sdio.o
  CC [M]  drivers/staging/rtl8723bs/os_dep/ioctl_linux.o
  CC [M]  drivers/staging/speakup/keyhelp.o
  CC [M]  drivers/staging/speakup/kobjects.o
building of '/nix/store/24plzvpzg33v84pmfd7miq69imcyd8ff-linux-4.14.50.drv' timed out after 1800 seconds
error: build of '/nix/store/24plzvpzg33v84pmfd7miq69imcyd8ff-linux-4.14.50.drv' failed

NeQuissimus

What happens to dependencies? If I set module A to "n" but module B to "y" despite B depending on A, the kernel config will error out, correct?
Is there something simple we can do to detect this? (I can't see a simple way)

NeQuissimus · 2018-06-20T16:39:31Z

pkgs/os-specific/linux/kernel/common-config.nix

Since there are no kernels <4.4, should we maybe just remove all the options for really old kernels?
And things such as whenAtLeast "3.4" yes may as well just be yes

Now that it's there I would say keep it, some people might run their own 3.X kernel and might appreciate it ? I am good either way.

Maybe we will do that in a future PR. I highly doubt somebody uses master / future-18.09 with a 3.x kernel :D

NeQuissimus · 2018-06-20T16:40:34Z

pkgs/os-specific/linux/kernel/common-config.nix

We may want to add the other governors as options here

Let's do such changes separately from the structured-options refactoring; that way it is much easier to verify there weren't unintended changes.

agreed, I had to remove some copumpkin CONFIG_ additions that would generate errors on recent kernels.

teto · 2018-06-22T06:05:57Z

What happens to dependencies? If I set module A to "n" but module B to "y" despite B depending on A, > the kernel config will error out, correct?
Is there something simple we can do to detect this? (I can't see a simple way)
This is the current behavior and the PR doesn't change that.

I discovered yesterday https://github.com/ulfalizer/Kconfiglib which might help in that regard at a later date, I am not sure. The kernel has also a script to merge different configs https://github.com/torvalds/linux/blob/master/scripts/kconfig/merge_config.sh, I wonder if this could be used to fix some of our dependencies problem. But I would rather leave this exploration to future PRs.

dezgeg · 2018-06-22T12:38:25Z

I noticed some minor differences in the configs, feel free to squash the fixes from https://github.com/NixOS/nixpkgs/compare/master...dezgeg:structured-kernel-conf-fixes?expand=1

teto · 2018-06-22T15:50:11Z

wow thanks that's super nice, you caught quite a few ones. I squashed and rebased. I added a commit to remove references to any kernel < 4.4 so that it can be reverted later.
I was able to compile the config for 4.4 and 4.16 (haven't tested any other)

GrahamcOfBorg · 2018-06-22T16:27:24Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
cannot find section .dynamic
/nix/store/g3cq7wr2g5hqm8rvj6gky6x7qa1lgjn4-linux-4.14.51

GrahamcOfBorg · 2018-06-22T16:37:30Z

Failure on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

  CC [M]  drivers/staging/rtl8192e/rtl8192e/rtl_pm.o
  CC [M]  drivers/video/fbdev/sstfb.o
  CC [M]  drivers/staging/rtl8712/usb_halinit.o
  CC [M]  drivers/staging/rtl8192u/r8190_rtl8256.o
  CC [M]  drivers/staging/rtl8192e/rtl8192e/rtl_ps.o
  CC [M]  drivers/video/fbdev/cirrusfb.o
  CC [M]  drivers/staging/rtl8712/usb_ops.o
  CC [M]  drivers/staging/rtl8192u/r819xU_phy.o
building of '/nix/store/kvi48kp4zzpbaqyvv313kpjygxwc2sra-linux-4.14.51.drv' timed out after 1800 seconds
error: build of '/nix/store/kvi48kp4zzpbaqyvv313kpjygxwc2sra-linux-4.14.51.drv' failed

Instead of using a string to describe kernel config, use a nix attribute set, then converted to a string. - allows to override the config, aka convert 'yes' into 'modules' or vice-versa - while for now merging different configs is still crude (last spec wins), at least there should be only one CONFIG_XYZ value compared to the current string config where the first defined would be used and others ignored.

The oldest kernel in nixpkgs being 4.4, we get rid of checks for older kernels.

dezgeg · 2018-06-23T22:51:01Z

pkgs/os-specific/linux/kernel/common-config.nix

+with import ../../../../lib/kernel.nix { inherit (stdenv) lib; inherit version; };
+
+let
+  # temporary hack


Hmm, what's this for?

when reworking the original PR, the features system had changed a bit and I came up with the hack to remove later. I had forgotten about it; I pushed a 3rd commit which uses features.xdom0 instead. It should fix it.

GrahamcOfBorg · 2018-06-24T16:09:31Z

Success on aarch64-linux (full log)

Attempted: linux

Partial log (click to expand)

wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
wrong ELF type
cannot find section .dynamic
/nix/store/qp98m3d4xa1f7x8xbnvwa7wczfbllav7-linux-4.14.51

GrahamcOfBorg · 2018-06-24T16:19:40Z

Failure on x86_64-linux (full log)

Attempted: linux

Partial log (click to expand)

  CC [M]  drivers/usb/storage/isd200.o
  CC [M]  drivers/usb/storage/jumpshot.o
  CC [M]  drivers/usb/storage/karma.o
  CC [M]  drivers/usb/storage/onetouch.o
  CC [M]  drivers/usb/storage/realtek_cr.o
  CC [M]  drivers/usb/storage/sddr09.o
  CC [M]  drivers/usb/storage/sddr55.o
  CC [M]  drivers/usb/storage/shuttle_usbat.o
building of '/nix/store/qq0jx495ka6g8s75h3zn3nhby0gc3nbv-linux-4.14.51.drv' timed out after 1800 seconds
error: build of '/nix/store/qq0jx495ka6g8s75h3zn3nhby0gc3nbv-linux-4.14.51.drv' failed

dezgeg · 2018-06-30T13:03:29Z

I verified with scripts that after a minor fix I squashed in there's no change to the effective configs on x86_64, i686, aarch64 and armv7l. So merged.

teto · 2019-01-25T06:31:42Z

@dezgeg mind sharing these scripts please :) ? I want to do the same in #42838

teto requested review from edolstra and nbp as code owners June 2, 2018 17:12

teto force-pushed the kernel_config branch from a2d99b8 to ed86292 Compare June 2, 2018 17:14

This was referenced Jun 8, 2018

[RDY] kernel doc: explain how to configure custom kernel #29944

Merged

mininet: init at 2.3.0d4 #41261

Merged

teto force-pushed the kernel_config branch from ed86292 to 3955bad Compare June 14, 2018 16:03

GrahamcOfBorg added the 2.status: merge conflict This PR has merge conflicts with the target branch label Jun 17, 2018

teto force-pushed the kernel_config branch from c854636 to dccf2f0 Compare June 17, 2018 14:54

GrahamcOfBorg removed the 2.status: merge conflict This PR has merge conflicts with the target branch label Jun 17, 2018

GrahamcOfBorg added 10.rebuild-linux: 501+ This PR causes many rebuilds on Linux and should normally target the staging branches. and removed 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Jun 17, 2018

teto force-pushed the kernel_config branch from dccf2f0 to f798c6a Compare June 18, 2018 07:54

GrahamcOfBorg removed 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Jun 18, 2018

teto changed the title ~~[wip] linux: translate config to structured config~~ [RFC] linux: translate config to structured config Jun 18, 2018

teto commented Jun 18, 2018

View reviewed changes

lib/kernel.nix Outdated

Copy link

Member Author

teto Jun 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

todo remove

teto reacted with thumbs up emoji

teto commented Jun 18, 2018

View reviewed changes

pkgs/os-specific/linux/kernel/generic.nix Outdated

Copy link

Member Author

teto Jun 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove comment

teto reacted with thumbs up emoji

teto commented Jun 18, 2018

View reviewed changes

pkgs/os-specific/linux/kernel/manual-config.nix Outdated

Copy link

Member Author

teto Jun 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add "extraConfig"

teto reacted with thumbs up emoji

teto force-pushed the kernel_config branch from f798c6a to 469404f Compare June 20, 2018 04:07

teto mentioned this pull request Jun 20, 2018

[WIP] linux: translate kernel config to structured config #12158

Closed

NeQuissimus reviewed Jun 20, 2018

View reviewed changes

teto force-pushed the kernel_config branch from 469404f to 83410b9 Compare June 22, 2018 15:48

NeQuissimus approved these changes Jun 22, 2018

View reviewed changes

copumpkin and others added 2 commits June 23, 2018 08:41

kernel: remove conditions based on 3.X kernels

83410b9

The oldest kernel in nixpkgs being 4.4, we get rid of checks for older kernels.

dezgeg reviewed Jun 23, 2018

View reviewed changes

teto mentioned this pull request Jun 24, 2018

There should be an easy method to add extra kernel config in your configuration.nix file. #20187

Open

linux: fix features system

e066237

dezgeg closed this Jun 30, 2018

teto deleted the kernel_config branch June 30, 2018 15:06

teto mentioned this pull request Jul 14, 2018

[RFC] add ability to merge structured configs #42838

Merged

9 tasks

Uh oh!

Conversation

teto commented Jun 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation for this change

Things done

Uh oh!

GrahamcOfBorg commented Jun 2, 2018

Uh oh!

GrahamcOfBorg commented Jun 3, 2018

Uh oh!

GrahamcOfBorg commented Jun 14, 2018

Uh oh!

GrahamcOfBorg commented Jun 14, 2018

Uh oh!

teto commented Jun 17, 2018

Uh oh!

GrahamcOfBorg commented Jun 17, 2018

Uh oh!

GrahamcOfBorg commented Jun 17, 2018

Uh oh!

GrahamcOfBorg commented Jun 18, 2018

Uh oh!

teto commented Jun 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GrahamcOfBorg commented Jun 18, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GrahamcOfBorg commented Jun 20, 2018

Uh oh!

GrahamcOfBorg commented Jun 20, 2018

Uh oh!

NeQuissimus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

teto commented Jun 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dezgeg commented Jun 22, 2018

Uh oh!

teto commented Jun 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GrahamcOfBorg commented Jun 22, 2018

Uh oh!

GrahamcOfBorg commented Jun 22, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GrahamcOfBorg commented Jun 24, 2018

Uh oh!

GrahamcOfBorg commented Jun 24, 2018

Uh oh!

dezgeg commented Jun 30, 2018

Uh oh!

teto commented Jan 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

teto commented Jun 2, 2018 •

edited

Loading

teto commented Jun 18, 2018 •

edited

Loading

teto commented Jun 22, 2018 •

edited

Loading

teto commented Jun 22, 2018 •

edited

Loading

teto commented Jan 25, 2019 •

edited

Loading