nixpkgs/system/system-options.nix

# this file contains all extendable options originally defined in system.nix
# TODO: split it to make it readable.
{pkgs, config, ...}:

###### interface
let
  inherit (pkgs.lib) mkOption;

  option = {
    system = {
      build = mkOption {
        default = {};
        description = ''
          Attribute set of derivation used to setup the system.  The system
          is built by aggregating all derivations.
        '';
        apply = components: components // {
          # all components have to build directories
          result = pkgs.buildEnv {
            name = "system";
            paths = pkgs.lib.mapRecordFlatten (n: v: v) components;
          };
        };
      };

      shell = mkOption {
        default = "/var/run/current-system/sw/bin/bash";
        description = ''
          This option defines the path to the Bash shell.  It should
          generally not be overriden.
        '';
        merge = list:
          assert list != [] && builtins.tail list == [];
          builtins.head list;
      };

      overridePath = mkOption {
        default = [];
        description = ''
          You should not redefine this option unless you have trouble with a
          package define in <varname>path</varname>.
        '';
      };

      path = mkOption {
        default = [];
        description = ''
          The packages you want in the boot environment.
        '';
        apply = list: pkgs.buildEnv {
          name = "system-path";
          paths = config.system.overridePath ++ list;

          # Note: We need `/lib' to be among `pathsToLink' for NSS modules
          # to work.
          inherit (config.environment) pathsToLink;

          ignoreCollisions = true;
        };
      };

    };
  };
in

###### implementation
let
  inherit (pkgs.stringsWithDeps) noDepEntry fullDepEntry packEntry;
  inherit (pkgs.lib) mapRecordFlatten;
in

{
  require = [
    option

    # config.system.activationScripts
    # ../system/activate-configuration.nix
  ];

  system = {
    build = {
      binsh = pkgs.bashInteractive;
    };

    activationScripts = {
      systemConfig = noDepEntry ''
        systemConfig="$1"
        if test -z "$systemConfig"; then
          systemConfig="/system" # for the installation CD
        fi
      '';

      defaultPath =
        let path = [
          pkgs.coreutils pkgs.gnugrep pkgs.findutils
          pkgs.glibc # needed for getent
          pkgs.pwdutils
          pkgs.nettools # needed for hostname
        ]; in noDepEntry ''
          export PATH=/empty
          for i in ${toString path}; do
            PATH=$PATH:$i/bin:$i/sbin;
          done
        '';

      stdio = fullDepEntry ''
        # Needed by some programs.
        ln -sfn /proc/self/fd /dev/fd
        ln -sfn /proc/self/fd/0 /dev/stdin
        ln -sfn /proc/self/fd/1 /dev/stdout
        ln -sfn /proc/self/fd/2 /dev/stderr
      '' [
        "defaultPath" # path to ln
      ];

      binsh = fullDepEntry ''
        # Create the required /bin/sh symlink; otherwise lots of things
        # (notably the system() function) won't work.
        mkdir -m 0755 -p $mountPoint/bin
        ln -sfn ${config.system.build.binsh}/bin/sh $mountPoint/bin/sh
      '' [
        "defaultPath" # path to ln & mkdir
        "stdio" # ?
      ];

      modprobe = fullDepEntry ''
        # Allow the kernel to find our wrapped modprobe (which searches in the
        # right location in the Nix store for kernel modules).  We need this
        # when the kernel (or some module) auto-loads a module.
        # !!! maybe this should only happen at boot time, since we shouldn't
        # use modules that don't match the running kernel.
        echo ${config.system.sbin.modprobe}/sbin/modprobe > /proc/sys/kernel/modprobe
      '' [
        # ?
      ];

      var = fullDepEntry ''
        # Various log/runtime directories.
        mkdir -m 0755 -p /var/run
        mkdir -m 0755 -p /var/run/console # for pam_console

        touch /var/run/utmp # must exist
        chmod 644 /var/run/utmp

        mkdir -m 0755 -p /var/run/nix/current-load # for distributed builds
        mkdir -m 0700 -p /var/run/nix/remote-stores

        mkdir -m 0755 -p /var/log

        touch /var/log/wtmp # must exist
        chmod 644 /var/log/wtmp

        touch /var/log/lastlog
        chmod 644 /var/log/lastlog

        mkdir -m 1777 -p /var/tmp


        # Empty, read-only home directory of many system accounts.
        mkdir -m 0555 -p /var/empty
      '' [
        "defaultPath" # path to mkdir & touch & chmod
      ];

      rootPasswd = fullDepEntry ''
        # If there is no password file yet, create a root account with an
        # empty password.
        if ! test -e /etc/passwd; then
            rootHome=/root
            touch /etc/passwd; chmod 0644 /etc/passwd
            touch /etc/group; chmod 0644 /etc/group
            touch /etc/shadow; chmod 0600 /etc/shadow
            # Can't use useradd, since it complains that it doesn't know us
            # (bootstrap problem!).
            echo "root:x:0:0:System administrator:$rootHome:${config.system.shell}" >> /etc/passwd
            echo "root::::::::" >> /etc/shadow
            echo | passwd --stdin root
        fi
      '' [
        "defaultPath" # path to touch & passwd
        "etc" # for /etc
        # ?
      ];

      nix = fullDepEntry ''
        # Set up Nix.
        mkdir -p /nix/etc/nix
        ln -sfn /etc/nix.conf /nix/etc/nix/nix.conf
        chown root.nixbld /nix/store
        chmod 1775 /nix/store

        # Nix initialisation.
        mkdir -m 0755 -p \
            /nix/var/nix/gcroots \
            /nix/var/nix/temproots \
            /nix/var/nix/manifests \
            /nix/var/nix/userpool \
            /nix/var/nix/profiles \
            /nix/var/nix/db \
            /nix/var/log/nix/drvs \
            /nix/var/nix/channel-cache \
            /nix/var/nix/chroots
        mkdir -m 1777 -p /nix/var/nix/gcroots/per-user
        mkdir -m 1777 -p /nix/var/nix/profiles/per-user

        ln -sf /nix/var/nix/profiles /nix/var/nix/gcroots/
        ln -sf /nix/var/nix/manifests /nix/var/nix/gcroots/
      '' [
        "defaultPath"
        "etc" # /etc/nix.conf
        "users" # nixbld group
      ];

      hostname = fullDepEntry ''
        # Set the host name.  Don't clear it if it's not configured in the
        # NixOS configuration, since it may have been set by dhclient in the
        # meantime.
        ${if config.networking.hostName != "" then
            ''hostname "${config.networking.hostName}"''
        else ''
            # dhclient won't do anything if the hostname isn't empty.
            if test "$(hostname)" = "(none)"; then
              hostname ""
            fi
        ''}
      '' [ "defaultPath" ];

      # The activation has to be done at the end. This is forced at the apply
      # function of activationScripts option
      activate = noDepEntry ''
        # Make this configuration the current configuration.
        # The readlink is there to ensure that when $systemConfig = /system
        # (which is a symlink to the store), /var/run/current-system is still
        # used as a garbage collection root.
        ln -sfn "$(readlink -f "$systemConfig")" /var/run/current-system

        # Prevent the current configuration from being garbage-collected.
        ln -sfn /var/run/current-system /nix/var/nix/gcroots/current-system
      '';
    };
  };
}