Add build info (#638)

This PR adds build info to mmtk-core, including mmtk-core version, git hash, and features. `built` is used to collect those information. This closes #634.

* use Rust build script to invoke `built`.
* add a public `mmtk::build_info` module.
* CI invokes setup scripts based on the architecture triple.

Author: qinsoon

.github/scripts/ci-setup-i686-unknown-linux-gnu.sh

@@ -0,0 +1,9 @@
+set -xe
+
+sudo apt-get update
+sudo apt-get install build-essential gcc-multilib -y
+
+# Necessary libraries for 32bit mmtk build
+sudo dpkg --add-architecture i386
+sudo apt-get update
+sudo apt-get install zlib1g-dev:i386

.github/scripts/ci-setup-x86_64-unknown-linux-gnu.sh

@@ -0,0 +1,4 @@
+set -xe
+
+sudo apt-get update
+sudo apt-get install build-essential gcc-multilib -y

.github/scripts/ci-setup.sh

@@ -45,7 +45,7 @@ jobs:
 
       # Setup Environments
       - name: Setup Environments
-        run: ./.github/scripts/ci-setup.sh
+        run: ./.github/scripts/ci-setup-${{ matrix.target.triple }}.sh
 
       # Build
       - name: Build

.github/workflows/pre-review-ci.yml

@@ -11,6 +11,7 @@ readme = "README.md"
 categories = ["memory-management"]
 keywords = ["gc", "garbage", "collection", "garbage-collection", "allocation"]
 rust-version = "1.57.0"
+build = "build.rs"
 
 [lib]
 name = "mmtk"
@@ -43,6 +44,9 @@ strum_macros = "0.24"
 [dev-dependencies]
 rand = "0.7.3"
 
+[build-dependencies]
+built = { version = "0.5.1", features = ["git2"] }
+
 [features]
 default = []
 

Cargo.toml

@@ -0,0 +1,3 @@
+fn main() {
+    built::write_built_file().expect("Failed to acquire build-time information");
+}

build.rs

@@ -0,0 +1,55 @@
+mod raw {
+    // This includes a full list of the constants in built.rs generated by the 'built' crate.
+    // https://docs.rs/built/latest/built/index.html
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
+/// MMTk crate version such as 0.14.0
+pub const MMTK_PKG_VERSION: &str = raw::PKG_VERSION;
+
+/// Comma separated features enabled for this build
+pub const MMTK_FEATURES: &str = raw::FEATURES_STR;
+
+lazy_static! {
+    /// Git version as short commit hash, such as a96e8f9, or a96e8f9, or unknown-git-version if MMTk
+    /// is not built from a git repo.
+    pub static ref MMTK_GIT_VERSION: &'static str = &MMTK_GIT_VERSION_STRING;
+    // Owned string
+    static ref MMTK_GIT_VERSION_STRING: String = match (raw::GIT_COMMIT_HASH, raw::GIT_DIRTY) {
+        (Some(hash), Some(dirty)) => format!("{}{}", hash.split_at(7).0, if dirty { "-dirty" } else { "" }),
+        (Some(hash), None) => format!("{}{}", hash.split_at(7).0, "-?"),
+        _ => "unknown-git-version".to_string(),
+    };
+
+    /// Full build info, including MMTk's name, version, git, and features in the build,
+    /// such as MMTk 0.14.0 (43e0ce8-dirty, DEFAULT, EXTREME_ASSERTIONS)
+    pub static ref MMTK_FULL_BUILD_INFO: &'static str = &MMTK_FULL_BUILD_INFO_STRING;
+    // Owned string
+    static ref MMTK_FULL_BUILD_INFO_STRING: String = format!("MMTk {} ({}, {})", MMTK_PKG_VERSION, *MMTK_GIT_VERSION, MMTK_FEATURES);
+}
+
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn test_git_version() {
+        println!("Git version: {}", *crate::build_info::MMTK_GIT_VERSION);
+    }
+
+    #[test]
+    fn test_full_build_version() {
+        println!(
+            "Full build version: {}",
+            *crate::build_info::MMTK_FULL_BUILD_INFO
+        );
+    }
+
+    #[test]
+    fn test_pkg_version() {
+        println!("Package version: {}", crate::build_info::MMTK_PKG_VERSION);
+    }
+
+    #[test]
+    fn test_features() {
+        println!("Features: {}", crate::build_info::MMTK_FEATURES);
+    }
+}

src/build_info.rs

@@ -51,6 +51,7 @@ pub use mmtk::MMTK;
 
 mod policy;
 
+pub mod build_info;
 pub mod memory_manager;
 pub mod plan;
 pub mod scheduler;