Add atomics-contract template

Author: xxuejie

atomics-contract/.gitignore

@@ -0,0 +1,2 @@
+/build
+/target

atomics-contract/Cargo.toml

@@ -0,0 +1,11 @@
+[package]
+name = "{{project-name}}"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+ckb-std = "0.15.0"
+log = { version = "0.4.20", default-features = false }
+
+[build-dependencies]
+cc = "1.0"

atomics-contract/Makefile

@@ -0,0 +1,76 @@
+# We cannot use $(shell pwd), which will return unix path format on Windows,
+# making it hard to use.
+cur_dir = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+
+TOP := $(cur_dir)
+# RUSTFLAGS that are likely to be tweaked by developers. For example,
+# while we enable debug logs by default here, some might want to strip them
+# for minimal code size / consumed cycles.
+CUSTOM_RUSTFLAGS := --cfg debug_assertions
+# RUSTFLAGS that are less likely to be tweaked by developers. Most likely
+# one would want to keep the default values here.
+FULL_RUSTFLAGS := -C target-feature=+zba,+zbb,+zbc,+zbs,-a $(CUSTOM_RUSTFLAGS)
+# Additional cargo args to append here. For example, one can use
+# make test CARGO_ARGS="-- --nocapture" so as to inspect data emitted to
+# stdout in unit tests
+CARGO_ARGS :=
+MODE := release
+# Tweak this to change the clang version to use for building C code. By default
+# we use a bash script with somes heuristics to find clang in current system.
+CLANG := $(shell $(TOP)/scripts/find_clang)
+# When this is set to some value, the generated binaries will be copied over
+BUILD_DIR :=
+# Generated binaries to copy. By convention, a Rust crate's directory name will
+# likely match the crate name, which is also the name of the final binary.
+# However if this is not the case, you can tweak this variable. As the name hints,
+# more than one binary is supported here.
+BINARIES := $(notdir $(shell pwd))
+
+ifeq (release,$(MODE))
+	MODE_ARGS := --release
+endif
+
+default: build test
+
+build:
+	RUSTFLAGS="$(FULL_RUSTFLAGS)" TARGET_CC="$(CLANG)" \
+		cargo build --target=riscv64imac-unknown-none-elf $(MODE_ARGS) $(CARGO_ARGS)
+	@set -eu; \
+	if [ "x$(BUILD_DIR)" != "x" ]; then \
+		for binary in $(BINARIES); do \
+			echo "Copying binary $$binary to build directory"; \
+			cp $(TOP)/target/riscv64imac-unknown-none-elf/$(MODE)/$$binary $(TOP)/$(BUILD_DIR); \
+		done \
+	fi
+
+# test, check, clippy and fmt here are provided for completeness,
+# there is nothing wrong invoking cargo directly instead of make.
+test:
+	cargo test $(CARGO_ARGS)
+
+check:
+	cargo check $(CARGO_ARGS)
+
+clippy:
+	cargo clippy $(CARGO_ARGS)
+
+fmt:
+	cargo fmt $(CARGO_ARGS)
+
+# Arbitrary cargo command is supported here. For example:
+#
+# make cargo CARGO_CMD=expand CARGO_ARGS="--ugly"
+# 
+# Invokes:
+# cargo expand --ugly
+CARGO_CMD :=
+cargo:
+	cargo $(CARGO_CMD) $(CARGO_ARGS)
+
+clean:
+	cargo clean
+
+prepare:
+	rustup target add riscv64imac-unknown-none-elf
+
+.PHONY: build test check clippy fmt cargo clean prepare

atomics-contract/build.rs

@@ -0,0 +1,36 @@
+fn main() {
+    let top = match std::env::var("TOP") {
+        Ok(top) => top,
+        Err(_) => "../..".to_string(),
+    };
+
+    println!("cargo:rerun-if-changed={}/deps/lib-dummy-atomics/atomics.c", top);
+
+    let target_arch = std::env::var("CARGO_CFG_TARGET_ARCH").unwrap();
+    if target_arch == "riscv64" {
+        let mut build = cc::Build::new();
+        assert!(
+            build.get_compiler().is_like_clang(),
+            "Clang must be used as the compiler!"
+        );
+        build
+            .file(format!("{}/deps/lib-dummy-atomics/atomics.c", top))
+            .static_flag(true)
+            .include(format!("{}/deps/ckb-c-stdlib", top))
+            .include(format!("{}/deps/ckb-c-stdlib/libc", top))
+            .no_default_flags(true)
+            .flag("--target=riscv64")
+            .flag("-march=rv64imc_zba_zbb_zbc_zbs")
+            .flag("-O3")
+            .flag("-nostdinc")
+            .flag("-nostdlib")
+            .flag("-fvisibility=hidden")
+            .flag("-fdata-sections")
+            .flag("-ffunction-sections")
+            .flag("-Wall")
+            .flag("-Werror")
+            .flag("-Wno-unused-parameter")
+            .define("CKB_DECLARATION_ONLY", None)
+            .compile("dummy-atomics");
+    }
+}

atomics-contract/src/main.rs

@@ -0,0 +1,18 @@
+#![no_std]
+#![cfg_attr(not(test), no_main)]
+
+#[cfg(test)]
+extern crate alloc;
+
+#[cfg(not(test))]
+use ckb_std::default_alloc;
+#[cfg(not(test))]
+ckb_std::entry!(program_entry);
+#[cfg(not(test))]
+default_alloc!();
+
+pub fn program_entry() -> i8 {
+    log::error!("Just a log line");
+
+    0
+}