From c0392d2502762f2077b9d342d634f479626ee577 Mon Sep 17 00:00:00 2001
From: Samir Rashid <samirsgotmail@gmail.com>
Date: Mon, 30 Oct 2023 15:20:11 -0700
Subject: [PATCH] shell.nix: Add nix shell

Specifies a Nix shell that creates a deterministic development
environment. This is based on the Tock Nix shell but is modified to
combine the required dependencies between the dual stable and nightly
toolchains. This `shell.nix` is meant for developing, so it uses the nightly
Rust version in order to be able to use Miri.

Co-authored-by: Anthony Tarbinian <atar137h@gmail.com>
---
 shell.nix | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 112 insertions(+)
 create mode 100644 shell.nix

diff --git a/shell.nix b/shell.nix
new file mode 100644
index 00000000..41bb96f1
--- /dev/null
+++ b/shell.nix
@@ -0,0 +1,112 @@
+# Licensed under the Apache License, Version 2.0 or the MIT License.
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+# Copyright Tock Contributors 2022.
+
+# Shell expression for the Nix package manager
+#
+# This nix expression creates an environment with necessary packages installed:
+#
+#  * `tockloader`
+#  * rust
+#
+# To use:
+#
+#  $ nix-shell
+#
+
+{ pkgs ? import <nixpkgs> { }, withUnfreePkgs ? false }:
+
+with builtins;
+let
+  inherit (pkgs) stdenv lib;
+
+  # Tockloader v1.11.0
+  tockloader = import (pkgs.fetchFromGitHub {
+    owner = "tock";
+    repo = "tockloader";
+    rev = "v1.11.0";
+    sha256 = "sha256-bPEfpfOZOjOiazqRgn1cnqe4ohLPvocuENKoZx/Qw80=";
+  }) { inherit pkgs withUnfreePkgs; };
+
+  # Rust toolchain overlay
+  rust_overlay = import "${pkgs.fetchFromGitHub {
+    owner = "nix-community";
+    repo = "fenix";
+    # Revision hash must correspond with the same date as the nightly version.
+    rev = "ffa0a8815be591767f82d42c63d88bfa4026a967"; 
+    sha256 = "sha256-JOrXleSdEKuymCyxg7P4GTTATDhBdfeyWcd1qQQlIYw=";
+  }}/overlay.nix";
+
+  nixpkgs = import <nixpkgs> { overlays = [ rust_overlay ]; };
+  stable = (lib.importTOML ./rust-toolchain.toml).toolchain;
+  nightly = (lib.importTOML ./nightly/rust-toolchain.toml).toolchain;
+
+  # Use nightly development toolchain because Miri is not supported
+  # by the MSRV (Minimum Supported Rust Version) toolchain.
+  nightlyToolchain = nixpkgs.fenix.fromToolchainName {
+    name = nightly.channel;
+    sha256 = "sha256-R/ONZzJaWQr0pl5RoXFIbnxIE3m6oJWy/rr2W0wXQHQ=";
+  };
+
+  # Combine the components from the stable and nightly toolchains.
+  combinedToolchain =
+    nightlyToolchain.withComponents (
+      nightly.components ++
+      stable.components ++
+      [ "cargo" ]
+    );
+  # Add the cross-compile target platforms to the environment.
+  rustBuild =
+    nixpkgs.fenix.combine (
+      foldl'
+        (acc: item: acc ++ [ nixpkgs.fenix.targets.${item}.latest.rust-std ])
+        [ combinedToolchain ]
+        stable.targets
+    );
+
+in
+  pkgs.mkShell {
+    name = "tock-dev";
+
+    buildInputs = with pkgs; [
+      # --- Toolchains ---
+      rustBuild
+      openocd
+
+      # --- Convenience and support packages ---
+      python3Full
+      tockloader
+
+      # Required for tools/print_tock_memory_usage.py
+      python3Packages.cxxfilt
+
+
+      # --- CI support packages ---
+      qemu
+
+      # --- Flashing tools ---
+      # If your board requires J-Link to flash and you are on NixOS,
+      # add these lines to your system wide configuration.
+
+      # Enable udev rules from segger-jlink package
+      # services.udev.packages = [
+      #     pkgs.segger-jlink
+      # ];
+
+      # Add "segger-jlink" to your system packages and accept the EULA:
+      # nixpkgs.config.segger-jlink.acceptLicense = true;
+    ];
+
+    LD_LIBRARY_PATH = "${stdenv.cc.cc.lib}/lib64:$LD_LIBRARY_PATH";
+
+    # Instruct the Tock gnumake-based build system to not check for rustup and
+    # assume all requirend tools are installed and available in the $PATH
+    NO_RUSTUP = "1";
+
+    # The defaults "objcopy" and "objdump" are wrong (stem from the standard
+    # environment for x86), use "llvm-obj{copy,dump}" as defined in the makefile
+    shellHook = ''
+      unset OBJCOPY
+      unset OBJDUMP
+    '';
+  }