doc/packages/linux.section.md

   1 # Linux kernel {#sec-linux-kernel}
   2
   3 The Nix expressions to build the Linux kernel are in [`pkgs/os-specific/linux/kernel`](https://github.com/NixOS/nixpkgs/blob/master/pkgs/os-specific/linux/kernel).
   4
   5 The function [`pkgs.buildLinux`](https://github.com/NixOS/nixpkgs/blob/d77bda728d5041c1294a68fb25c79e2d161f62b9/pkgs/os-specific/linux/kernel/generic.nix) builds a kernel with [common configuration values](https://github.com/NixOS/nixpkgs/blob/d77bda728d5041c1294a68fb25c79e2d161f62b9/pkgs/os-specific/linux/kernel/common-config.nix).
   6 This is the preferred option unless you have a very specific use case.
   7 Most kernels packaged in Nixpkgs are built that way, and it will also generate kernels suitable for NixOS.
   8 [`pkgs.linuxManualConfig`](https://github.com/NixOS/nixpkgs/blob/d77bda728d5041c1294a68fb25c79e2d161f62b9/pkgs/os-specific/linux/kernel/manual-config.nix) requires a complete configuration to be passed.
   9 It has fewer additional features than `pkgs.buildLinux`, which provides common configuration values and exposes the `features` attribute, as explained below.
  10
  11 Both functions have an argument `kernelPatches` which should be a list of `{name, patch, extraConfig}` attribute sets, where `name` is the name of the patch (which is included in the kernel’s `meta.description` attribute), `patch` is the patch itself (possibly compressed), and `extraConfig` (optional) is a string specifying extra options to be concatenated to the kernel configuration file (`.config`).
  12
  13 The kernel derivation created with `pkgs.buildLinux` exports an attribute `features` specifying whether optional functionality is or isn’t enabled. This is used in NixOS to implement kernel-specific behaviour.
  14
  15 If you are using a kernel packaged in Nixpkgs, you can customize it by overriding its arguments. For details on how each argument affects the generated kernel, refer to [the `pkgs.buildLinux` source code](https://github.com/NixOS/nixpkgs/blob/d77bda728d5041c1294a68fb25c79e2d161f62b9/pkgs/os-specific/linux/kernel/generic.nix).
  16
  17 :::{.example #ex-overriding-kernel-derivation}
  18
  19 # Overriding the kernel derivation
  20
  21 Assuming you are using the kernel from `pkgs.linux_latest`:
  22
  23 ```nix
  24 pkgs.linux_latest.override {
  25   ignoreConfigErrors = true;
  26   autoModules = false;
  27   kernelPreferBuiltin = true;
  28   extraStructuredConfig = with lib.kernel; {
  29     DEBUG_KERNEL = yes;
  30     FRAME_POINTER = yes;
  31     KGDB = yes;
  32     KGDB_SERIAL_CONSOLE = yes;
  33     DEBUG_INFO = yes;
  34   };
  35 }
  36 ```
  37
  38 :::
  39
  40 ## Manual kernel configuration {#sec-manual-kernel-configuration}
  41
  42 Sometimes it may not be desirable to use kernels built with `pkgs.buildLinux`, especially if most of the common configuration has to be altered or disabled to achieve a kernel as expected by the target use case.
  43 An example of this is building a kernel for use in a VM or micro VM. You can use `pkgs.linuxPackages_custom` in these cases. It requires the `src`, `version`, and `configfile` attributes to be specified.
  44
  45 :::{.example #ex-using-linux-manual-config}
  46
  47 # Using `pkgs.linuxPackages_custom` with a specific source, version, and config file
  48
  49 ```nix
  50 { pkgs, ... }:
  51 pkgs.linuxPackages_custom {
  52   version = "6.1.55";
  53   src = pkgs.fetchurl {
  54     url = "https://cdn.kernel.org/pub/linux/kernel/v6.x/linux-${version}.tar.xz";
  55     hash = "sha256-qH4kHsFdU0UsTv4hlxOjdp2IzENrW5jPbvsmLEr/FcA=";
  56   };
  57   configfile = ./path_to_config_file;
  58 }
  59 ```
  60
  61 If necessary, the version string can be slightly modified to explicitly mark it as a custom version. If you do so, ensure the `modDirVersion` attribute matches the source's version, otherwise the build will fail.
  62
  63 ```nix
  64 { pkgs, ... }:
  65 pkgs.linuxPackages_custom {
  66   version = "6.1.55-custom";
  67   modDirVersion = "6.1.55";
  68   src = pkgs.fetchurl {
  69     url = "https://cdn.kernel.org/pub/linux/kernel/v6.x/linux-${modDirVersion}.tar.xz";
  70     hash = "sha256-qH4kHsFdU0UsTv4hlxOjdp2IzENrW5jPbvsmLEr/FcA=";
  71   };
  72   configfile = ./path_to_config_file;
  73 }
  74 ```
  75
  76 :::
  77
  78 Additional attributes can be used with `linuxManualConfig` for further customisation instead of `linuxPackages_custom`. You're encouraged to read [the `pkgs.linuxManualConfig` source code](https://github.com/NixOS/nixpkgs/blob/d77bda728d5041c1294a68fb25c79e2d161f62b9/pkgs/os-specific/linux/kernel/manual-config.nix) to understand how to use them.
  79
  80 To edit the `.config` file for Linux X.Y from within Nix, proceed as follows:
  81
  82 ```ShellSession
  83 $ nix-shell '<nixpkgs>' -A linuxKernel.kernels.linux_X_Y.configEnv
  84 $ unpackPhase
  85 $ cd linux-*
  86 $ make nconfig
  87 ```
  88
  89 ## Developing kernel modules {#sec-linux-kernel-developing-modules}
  90
  91 When developing kernel modules it's often convenient to run the edit-compile-run loop as quickly as possible.
  92 See the snippet below as an example.
  93
  94 :::{.example #ex-edit-compile-run-kernel-modules}
  95
  96 # Edit-compile-run loop when developing `mellanox` drivers
  97
  98 ```ShellSession
  99 $ nix-build '<nixpkgs>' -A linuxPackages.kernel.dev
 100 $ nix-shell '<nixpkgs>' -A linuxPackages.kernel
 101 $ unpackPhase
 102 $ cd linux-*
 103 $ make -C $dev/lib/modules/*/build M=$(pwd)/drivers/net/ethernet/mellanox modules
 104 # insmod ./drivers/net/ethernet/mellanox/mlx5/core/mlx5_core.ko
 105 ```
 106
 107 :::