Updating julia_version

README.md

@@ -1,8 +1,23 @@
 ## An MMTk binding for the Julia programming language.
 
+### Quick Building Guide
+
+```
+git clone https://github.com/mmtk/mmtk-julia
+git clone https://github.com/mmtk/julia
+(cd julia && git checkout dev && echo 'WITH_MMTK=1' > Make.user)
+export JULIA_PATH=`pwd`/julia
+export MMTK_JULIA_DIR=`pwd`/mmtk-julia
+(cd mmtk-julia/mmtk && cargo build --features immix --release)   # or drop "--release" for a debug build
+MMTK_PLAN=Immix MMTK_BUILD=release MMTK_JULIA_DIR=`pwd`/mmtk-julia make -C julia  # or "MMTK_BUILD=debug"
+```
+
+If you would like debugging information in your release build of MMTk, add `debug = true` under `[profile.release]` in `mmtk/Cargo.toml`.
+
 ### Checking out and Building Julia with MMTk
 
-Besides checking out the binding, it is also necessary to checkout a fork containing a modified version of the Julia repository (https://github.com/mmtk/julia).
+Besides checking out the binding (this repository), it is also necessary to checkout a fork containing a modified version of the Julia repository (https://github.com/mmtk/julia).
+_Use the `dev` branch of the Julia repository._
 For example, we check out the fork as a sibling of `mmtk-julia`.
 For step-by-step instructions, read the section "Quick Building Guide".
 
@@ -19,39 +34,41 @@ Your working directory/
 
 #### Build Julia binding in Rust
 
-Before building Julia, build the binding in `mmtk-julia/mmtk`. Note that we currently support either immix or stickyimmix implementations in mmtk-core (build it with `cargo build --features immix` or `cargo build --features stickyimmix`). Add `--release` at the end if you would like to have a release build, otherwise it is a debug build.
+Before building Julia, build the binding in `mmtk-julia/mmtk`. You must have already checked out Julia, set `JULIA_PATH` to point to the checkout (remember to check out the `dev` branch!) and set `MMTK_JULIA_DIR` to the binding's top-level directory.
+
+In `mmtk-core` we currently support either Immix or StickyImmix implementations.
+Build it with `cargo build --features immix` or `cargo build --features stickyimmix`.
+Add `--release` at the end if you would like to have a release build, otherwise it is a debug build.
+For a release build with debugging information, first add `debug = true` under `[profile.release]` in `mmtk/Cargo.toml`.
 
 #### Build Julia with MMTk
 
-To build Julia with MMTk, create a `Make.user` file in the top-level directory of the Julia repository and add an entry `WITH_MMTK=1`. Finally, set the following environment variables:
+To build Julia with MMTk, first ensure you have the prerequisites for building both [Julia](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/build.md#required-build-tools-and-external-libraries) and [MMTk](https://github.com/mmtk/mmtk-core#requirements).
+
+Next create a `Make.user` file in the top-level directory of the Julia repository consisting of the line `WITH_MMTK=1`.
+
+Finally, set the following environment variables:
 
 ```
 export MMTK_BUILD=release # or debug depending on how you build the Julia binding in Rust
 export MMTK_JULIA_DIR=<path-to-mmtk-julia>
 ```
+... and run `make`.
+
+Alternatively you can set the environment variables in your `Make.user` 
 
-Then run `make` with the environment variables mentioned above. Please also make sure to install any dependency considering any particular requirement from both [Julia](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/build.md#required-build-tools-and-external-libraries) and [MMTk](https://github.com/mmtk/mmtk-core#requirements). 
+```
+export MMTK_BUILD := release
+export MMTK_JULIA_DIR := <path-to-mmtk-julia>
+export MMTK_PLAN := Immix
+```
 
 ### Heap Size
 
 Currently MMTk supports a fixed heap limit or variable heap within an interval. The default is a variable heap with the minimum heap size set to Julia's [`default_collection_interval`](https://github.com/mmtk/julia/blob/847cddeb7b9ddb5d6b66bec4c19d3a711748a45b/src/gc.c#L651) and the maximum size set to 70% of the free memory available. To change these values set the environment variables `MMTK_MIN_HSIZE` and `MMTK_MAX_HSIZE` to set the mininum and maximum size in megabytes, or `MMTK_MIN_HSIZE_G` and `MMTK_MAX_HSIZE_G` to set the size in gigabytes. If both environment variables are set, MMTk will use the size in megabytes. To set a fixed heap size, simply set only the variables `MMTK_MAX_HSIZE` or `MMTK_MAX_HSIZE_G`, or set `MMTK_MIN_HSIZE` or `MMTK_MIN_HSIZE_G` to 0. Note that these values can be decimal numbers, e.g. `MMTK_MAX_HSIZE_G=1.5`.
 
 These environment variables are set during julia initialization time, so they can be set per-julia process.
 
-### Quick Building Guide
-
-(1) Clone this repo: https://github.com/mmtk/mmtk-julia (run `git clone https://github.com/mmtk/mmtk-julia`)
-
-(2) Clone this repo: https://github.com/mmtk/julia (run `git clone https://github.com/mmtk/julia.git`)
-
-(3) In `mmtk-julia/mmtk`, run `cargo build --features immix --release`
-
-(4) In `julia`, create a file `Make.user`, and add `WITH_MMTK=1`.
-
-(5) In `julia`, run `MMTK_PLAN=Immix MMTK_BUILD=release MMTK_JULIA_DIR=/absolute/path/mmtk-julia make` (or with `MMTK_PLAN=StickyImmix`).
-
-If you would like to have a debug build, remove `--release` from Step (3) and use `MMTK_BUILD=debug` in Step (5)
-
 ### Further information
 
 More about MMTk: https://github.com/mmtk/mmtk-core

mmtk/Cargo.toml

@@ -11,14 +11,14 @@ edition = "2018"
 [package.metadata.julia]
 # Our CI matches the following line and extract mmtk/julia. If this line is updated, please check ci yaml files and make sure it works.
 julia_repo = "https://github.com/mmtk/julia.git"
-julia_version = "67b2ec10542c9e80d1f5b4aeddb8bf9d3c4f6ba1"
+julia_version = "bc08a9bc1b8574c6aa153656d5758153a5700912"
 
 [lib]
 crate-type = ["cdylib"]
 
 [build-dependencies]
 cc = "*"
-built = "*"
+built = { version = "*", features = ["git2"] }
 bindgen = "*"
 
 [profile.release]

mmtk/api/mmtk.h

@@ -50,6 +50,7 @@ extern void mmtk_runtime_panic(void);
 extern void mmtk_unreachable(void);
 extern unsigned char mmtk_pin_object(void* obj);
 extern bool mmtk_is_pinned(void* obj);
+extern const char* get_mmtk_version(void);
 
 extern void mmtk_set_vm_space(void* addr, size_t size);
 extern void mmtk_immortal_region_post_alloc(void* addr, size_t size);

mmtk/build.rs

@@ -67,4 +67,6 @@ fn main() {
     bindings
         .write_to_file("src/julia_types.rs")
         .expect("Couldn't write bindings!");
+
+    built::write_built_file().expect("Failed to acquire build-time information");
 }

mmtk/src/api.rs

@@ -504,3 +504,10 @@ pub extern "C" fn mmtk_unpin_object(_object: ObjectReference) -> bool {
 pub extern "C" fn mmtk_is_pinned(_object: ObjectReference) -> bool {
     false
 }
+
+#[no_mangle]
+pub extern "C" fn get_mmtk_version() -> *const c_char {
+    crate::build_info::MMTK_JULIA_FULL_VERSION_STRING
+        .as_c_str()
+        .as_ptr() as _
+}

mmtk/src/build_info.rs

@@ -0,0 +1,18 @@
+use std::ffi::CString;
+
+mod raw {
+    // The include imports a full list of the constants in built.rs from https://docs.rs/built/latest/built/index.html
+    include!(concat!(env!("OUT_DIR"), "/built.rs"));
+}
+
+lazy_static! {
+    // Owned string for the binding version, such as MMTk Julia 0.14.0 (cfc755f-dirty)
+    static ref BINDING_VERSION_STRING: String = match (raw::GIT_COMMIT_HASH, raw::GIT_DIRTY) {
+        (Some(hash), Some(dirty)) => format!("Built with MMTk Julia {} ({}{})", raw::PKG_VERSION, hash.split_at(7).0, if dirty { "-dirty" } else { "" }),
+        (Some(hash), None) => format!("Built with MMTk Julia {} ({}{})", raw::PKG_VERSION, hash.split_at(7).0, "-?"),
+        _ => format!("Built with MMTk Julia {}", raw::PKG_VERSION),
+    };
+    // Owned string for both binding and core version.
+    #[derive(Debug)]
+    pub static ref MMTK_JULIA_FULL_VERSION_STRING: CString = CString::new(format!("{}, using {}", *BINDING_VERSION_STRING, *mmtk::build_info::MMTK_FULL_BUILD_INFO)).unwrap();
+}

mmtk/src/lib.rs

@@ -17,6 +17,7 @@ use std::sync::{Arc, Condvar, Mutex, RwLock};
 
 pub mod active_plan;
 pub mod api;
+mod build_info;
 pub mod collection;
 pub mod object_model;
 pub mod reference_glue;