nixos/rshim: init

- [v2rayA](https://v2raya.org), a Linux web GUI client of Project V which supports V2Ray, Xray, SS, SSR, Trojan and Pingtunnel. Available as [services.v2raya](options.html#opt-services.v2raya.enable).

- [rshim](https://github.com/Mellanox/rshim-user-space), the user-space rshim driver for the BlueField SoC. Available as [services.rshim](options.html#opt-services.rshim.enable).

- [wstunnel](https://github.com/erebe/wstunnel), a proxy tunnelling arbitrary TCP or UDP traffic through a WebSocket connection. Instances may be configured via [services.wstunnel](options.html#opt-services.wstunnel.enable).

- [ulogd](https://www.netfilter.org/projects/ulogd/index.html), a userspace logging daemon for netfilter/iptables related logging. Available as [services.ulogd](options.html#opt-services.ulogd.enable).

  ./services/misc/ripple-data-api.nix

  ./services/misc/rippled.nix

  ./services/misc/rmfakecloud.nix

  ./services/misc/rshim.nix

  ./services/misc/safeeyes.nix

  ./services/misc/sdrplay.nix

  ./services/misc/serviio.nix

{ config, lib, pkgs, ... }:

let

  cfg = config.services.rshim;

  rshimCommand = lib.escapeShellArgs ([ "${cfg.package}/bin/rshim" ]

    ++ lib.optionals (cfg.backend != null) [ "--backend ${cfg.backend}" ]

    ++ lib.optionals (cfg.device != null) [ "--device ${cfg.device}" ]

    ++ lib.optionals (cfg.index != null) [ "--index ${builtins.toString cfg.index}" ]

    ++ [ "--log-level ${builtins.toString cfg.log-level}" ])

  ;

in

{

  options.services.rshim = {

    enable = lib.mkEnableOption (lib.mdDoc "User-space rshim driver for the BlueField SoC");

    package = lib.mkPackageOptionMD pkgs "rshim-user-space" { };

    backend = lib.mkOption {

      type = with lib.types; nullOr (enum [ "usb" "pcie" "pcie_lf" ]);

      description = lib.mdDoc ''

        Specify the backend to attach. If not specified, the driver will scan

        all rshim backends unless the `device` option is given with a device

        name specified.

      '';

      default = null;

      example = "pcie";

    };

    device = lib.mkOption {

      type = with lib.types; nullOr str;

      description = lib.mdDoc ''

        Specify the device name to attach. The backend driver can be deduced

        from the device name, thus the `backend` option is not needed.

      '';

      default = null;

      example = "pcie-04:00.2";

    };

    index = lib.mkOption {

      type = with lib.types; nullOr int;

      description = lib.mdDoc ''

        Specify the index to create device path `/dev/rshim<index>`. It's also

        used to create network interface name `tmfifo_net<index>`. This option

        is needed when multiple rshim instances are running.

      '';

      default = null;

      example = 1;

    };

    log-level = lib.mkOption {

      type = lib.types.int;

      description = lib.mdDoc ''

        Specify the log level (0:none, 1:error, 2:warning, 3:notice, 4:debug).

      '';

      default = 2;

      example = 4;

    };

    config = lib.mkOption {

      type = with lib.types; attrsOf (oneOf [ int str ]);

      description = lib.mdDoc ''

        Structural setting for the rshim configuration file

        (`/etc/rshim.conf`). It can be used to specify the static mapping

        between rshim devices and rshim names. It can also be used to ignore

        some rshim devices.

      '';

      default = { };

      example = {

        DISPLAY_LEVEL = 0;

        rshim0 = "usb-2-1.7";

        none = "usb-1-1.4";

      };

    };

  };

  config = lib.mkIf cfg.enable {

    environment.etc = lib.mkIf (cfg.config != { }) {

      "rshim.conf".text = lib.generators.toKeyValue

        { mkKeyValue = lib.generators.mkKeyValueDefault { } " "; }

        cfg.config;

    };

    systemd.services.rshim = {

      after = [ "network.target" ];

      serviceConfig = {

        Restart = "always";

        Type = "forking";

        ExecStart = [

          (lib.concatStringsSep " \\\n" rshimCommand)

        ];

        KillMode = "control-group";

      };

      wantedBy = [ "multi-user.target" ];

    };

  };

  meta.maintainers = with lib.maintainers; [ nikstur ];

}

{ stdenv

, lib

, fetchFromGitHub

, autoreconfHook

, autoconf

, automake

, pkg-config

  };

  nativeBuildInputs = [

    autoreconfHook

    autoconf

    automake

    pkg-config