Updated Rust bindings for SM 60

Author: Alan Jeffrey

.travis.yml

@@ -5,30 +5,36 @@ rust:
   - stable
 sudo: 9000
 dist: trusty
-
 os:
   - linux
   - osx
+osx_image: xcode9.3
 
 addons:
   apt:
     sources:
       - ubuntu-toolchain-r-test
       - llvm-toolchain-trusty-5.0
     packages:
+      - autoconf2.13
       - g++-6
       - clang-5.0
 
 env:
   - FEATURES=""
   - FEATURES="--features debugmozjs"
 
-script:
-  - cargo build --verbose --verbose $FEATURES
-  - cargo test $FEATURES
+before_script:
+  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then export CC=gcc-6; export CXX=g++-6; fi
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; brew install [email protected] ccache yasm; fi
 
-before_install:
-  if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; brew install yasm; fi
+script:
+  - ccache -z
+  - CCACHE=$(which ccache) travis_wait cargo build --verbose $FEATURES
+  - CCACHE=$(which ccache) RUST_BACKTRACE=1 cargo test --verbose $FEATURES
+  - ccache -s
 
 notifications:
   webhooks: http://build.servo.org:54856/travis
+
+cache: ccache

Cargo.toml

@@ -17,7 +17,6 @@ exclude = [
 
 [features]
 debugmozjs = []
-promises = []
 
 [lib]
 name = "mozjs_sys"

README.md

@@ -48,6 +48,12 @@ set MOZTOOLS_PATH=C:\mozilla-build\msys\bin;C:\mozilla-build\mozmake;C:\mozilla-
 set LIBCLANG_PATH=C:\Program Files\LLVM\lib
 ```
 
+5. Set environment variables so the build script can find Python 2.7 and Autoconf 2.13:
+```
+set AUTOCONF=C:\mozilla-build\msys\local\bin\autoconf-2.13
+set NATIVE_WIN32_PYTHON=C:\mozilla-build\python\python2.7.exe
+```
+
 You can now build and test the crate using cargo:
 ```
 cargo build
@@ -61,10 +67,22 @@ Upgrading
 
 In order to upgrade to a new version of SpiderMonkey:
 
-1. Download the tarball corresponding to the desired mozilla-central commit
-   from [treeherder's SM-tc(pkg) job][tc].
-2. Update `etc/COMMIT`.
-3. Run `python3 ./etc/update.py path/to/tarball`.
+1. Find the mozilla-release commit for the desired version of SpiderMonkey, at
+   https://treeherder.mozilla.org/#/jobs?repo=mozilla-release&filter-searchStr=spidermonkey%20pkg.
+   You are looking for an SM(pkg) tagged with FIREFOX_RELEASE.
+   Take a note of the commit number to the left (a hex number such as ac4fbb7aaca0).
+
+2. Click on the SM(pkg) link, which will open a panel with details of the
+   commit, including an artefact uploaded link, with a name of the form
+   mozjs-*version*.tar.bz2. Download it and save it locally.
+
+3. Look at the patches in `etc/patches/*.patch`, and remove any that no longer apply
+   (with a bit of luck this will be all of them).
+
+4. Run `python3 ./etc/update.py path/to/tarball`.
+
+5. Update `etc/COMMIT` with the commit number.
+
+6. Build and test the bindings as above, then submit a PR!
 
 [bindgen]: https://github.com/servo/rust-bindgen
-[tc]: https://treeherder.mozilla.org/#/jobs?repo=mozilla-central&filter-searchStr=Linux%20x64%20opt%20Spider%20Monkey,%20submitted%20by%20taskcluster%20%5BTC%5D%20Spidermonkey%20Package%20SM-tc(pkg)

appveyor.yml

@@ -26,9 +26,6 @@ environment:
     C:\\Program Files\\Git\\cmd;\
     C:\\Program Files\\Git\\usr\\bin;\
     C:\\Program Files\\AppVeyor\\BuildAgent;"
-  matrix:
-    - CARGO_OPTS: ""
-    - CARGO_OPTS: "--release"
 
 # Uncomment to enable RDP & wait for exit.  Connection info will be printed in the log.
 #init:
@@ -48,11 +45,12 @@ install:
   - call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
   - set MOZTOOLS_PATH=C:\mozilla-build\msys\bin;C:\mozilla-build\mozmake;C:\mozilla-build\yasm
   - set NATIVE_WIN32_PYTHON=C:/Python27/python.exe
+  - set AUTOCONF=C:/mozilla-build/msys/local/bin/autoconf-2.13
   - rustc -vV
   - cargo -vV
 
 build_script:
   - echo PATH %PATH%
   - echo VSINSTALLDIR %VSINSTALLDIR%
   - echo MOZTOOLS_PATH %MOZTOOLS_PATH%
-  - cd %APPVEYOR_BUILD_FOLDER% && cargo build --verbose --verbose %CARGO_OPTS% && cargo test %CARGO_OPTS%
+  - cd %APPVEYOR_BUILD_FOLDER% && cargo build --verbose --verbose && cargo test

build.rs

@@ -50,10 +50,14 @@ fn cc_flags() -> Vec<&'static str> {
         result.extend(&[
             "-std=c++14",
             "-DWIN32",
+	    // Don't use reinterpret_cast() in offsetof(),
+	    // since it's not a constant expression, so can't
+	    // be used in static_assert().
+	    "-D_CRT_USE_BUILTIN_OFFSETOF",
         ]);
     } else {
         result.extend(&[
-            "-std=gnu++11",
+            "-std=gnu++14",
             "-fno-sized-deallocation",
             "-Wno-unused-parameter",
             "-Wno-invalid-offsetof",
@@ -95,11 +99,18 @@ fn build_jsapi() {
         .expect("Failed to run `make`");
 
     assert!(result.success());
-    println!("cargo:rustc-link-search=native={}/js/src", out_dir);
+    println!("cargo:rustc-link-search=native={}/js/src/build", out_dir);
     println!("cargo:rustc-link-lib=static=js_static"); // Must come before c++
+    println!("cargo:rustc-link-search=native={}/mozglue/build", out_dir);
+    println!("cargo:rustc-link-lib=static=mozglue");
     if target.contains("windows") {
+        println!("cargo:rustc-link-search=native={}/dist/bin", out_dir);
         println!("cargo:rustc-link-lib=winmm");
         println!("cargo:rustc-link-lib=psapi");
+        println!("cargo:rustc-link-lib=user32");
+        println!("cargo:rustc-link-lib=Dbghelp");
+        println!("cargo:rustc-link-search=native={}/config/external/nspr/pr", out_dir);
+        println!("cargo:rustc-link-lib=nspr4");
         if target.contains("gnu") {
             println!("cargo:rustc-link-lib=stdc++");
         }
@@ -114,7 +125,7 @@ fn build_jsapi() {
 
 fn build_jsglue() {
     let out = PathBuf::from(env::var("OUT_DIR").unwrap());
-        
+
     let mut build = cc::Build::new();
     build.cpp(true);
 
@@ -132,6 +143,8 @@ fn build_jsglue() {
 
     build.file("src/jsglue.cpp");
     build.include(out.join("dist/include"));
+    build.include(out.join("js/src"));
+
     build.compile("jsglue");
 }
 
@@ -142,6 +155,7 @@ fn build_jsglue() {
 /// generated, see the `const` configuration variables below.
 fn build_jsapi_bindings() {
     let out = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let rustfmt_config = Some(PathBuf::from("rustfmt.toml"));
 
     // By default, constructors, destructors and methods declared in .h files are inlined,
     // so their symbols aren't available. Adding the -fkeep-inlined-functions option
@@ -160,7 +174,10 @@ fn build_jsapi_bindings() {
         .rustified_enum(".*")
         .enable_cxx_namespaces()
         .with_codegen_config(config)
+        .rustfmt_bindings(true)
+        .rustfmt_configuration_file(rustfmt_config)
         .clang_arg("-I").clang_arg(out.join("dist/include").to_str().expect("UTF-8"))
+        .clang_arg("-I").clang_arg(out.join("js/src").to_str().expect("UTF-8"))
         .clang_arg("-x").clang_arg("c++");
 
     if cfg!(windows) {
@@ -175,14 +192,20 @@ fn build_jsapi_bindings() {
         }
     }
 
+    if let Ok(flags) = env::var("CLANGFLAGS") {
+        for flag in flags.split_whitespace() {
+            builder = builder.clang_arg(flag);
+        }
+    }
+
     for flag in cc_flags() {
         builder = builder.clang_arg(flag);
     }
 
     builder = builder.clang_arg("-include");
     builder = builder.clang_arg(out.join("js/src/js-confdefs.h").to_str().expect("UTF-8"));
 
-    println!("Generting bindings {:?}.", builder.command_line_flags());
+    println!("Generting bindings {:?} {}.", builder.command_line_flags(), bindgen::clang_version().full);
 
     for ty in UNSAFE_IMPL_SYNC_TYPES {
         builder = builder.raw_line(format!("unsafe impl Sync for root::{} {{}}", ty));
@@ -218,7 +241,9 @@ fn build_jsapi_bindings() {
     bindings.write_to_file(out.join("jsapi.rs"))
         .expect("Should write bindings to file OK");
 
+    println!("cargo:rerun-if-changed=rustfmt.toml");
     println!("cargo:rerun-if-changed=src/jsglue.hpp");
+    println!("cargo:rerun-if-changed=src/jsglue.cpp");
 }
 
 /// JSAPI types for which we should implement `Sync`.
@@ -270,6 +295,7 @@ const WHITELIST_FUNCTIONS: &'static [&'static str] = &[
 const OPAQUE_TYPES: &'static [&'static str] = &[
     "JS::Auto.*Impl",
     "JS::Auto.*Vector.*",
+    "JS::PersistentRooted.*",
     "JS::ReadOnlyCompileOptions",
     "JS::Rooted<JS::Auto.*Vector.*>",
     "JS::detail::CallArgsBase.*",
@@ -279,6 +305,7 @@ const OPAQUE_TYPES: &'static [&'static str] = &[
     "mozilla::BufferList",
     "mozilla::Maybe.*",
     "mozilla::UniquePtr.*",
+    "mozilla::Variant",
 ];
 
 /// Types for which we should NEVER generate bindings, even if it is used within
@@ -289,6 +316,9 @@ const BLACKLIST_TYPES: &'static [&'static str] = &[
     // We provide our own definition because we need to express trait bounds in
     // the definition of the struct to make our Drop implementation correct.
     "JS::Heap",
+    // We provide our own definition because SM's use of templates
+    // is more than bindgen can cope with.
+    "JS::Rooted",
     // Bindgen generates bitfields with private fields, so they cannot
     // be used in const expressions.
     "JSJitInfo",
@@ -299,5 +329,6 @@ const MODULE_RAW_LINES: &'static [(&'static str, &'static str)] = &[
     ("root", "pub type FILE = ::libc::FILE;"),
     ("root", "pub type JSJitInfo = ::jsjit::JSJitInfo;"),
     ("root::JS", "pub type Heap<T> = ::jsgc::Heap<T>;"),
+    ("root::JS", "pub type Rooted<T> = ::jsgc::Rooted<T>;"),
     ("root::JS", "pub type AutoGCRooterTag = AutoGCRooter__bindgen_ty_1;"),
 ];

etc/patches/configure-with-android-sysroot.patch

@@ -0,0 +1,13 @@
+diff --git a/mozjs/build/moz.configure/android-ndk.configure b/mozjs/build/moz.configure/android-ndk.configure
+index 1067b86..5193332 100644
+--- a/mozjs/build/moz.configure/android-ndk.configure
++++ b/mozjs/build/moz.configure/android-ndk.configure
+@@ -301,6 +301,8 @@ def extra_toolchain_flags(android_system, android_sysroot, toolchain_dir,
+              android_system,
+              '-isystem',
+              os.path.join(android_sysroot, 'usr', 'include'),
++             '--sysroot',
++             android_sysroot,
+              '-gcc-toolchain',
+              toolchain_dir,
+              '-D__ANDROID_API__=%d' % android_version]

makefile.cargo

@@ -66,10 +66,6 @@ ifneq (,$(CARGO_FEATURE_DEBUGMOZJS))
 	CONFIGURE_FLAGS += --enable-debug --disable-optimize --enable-gczeal
 endif
 
-ifneq (,$(CARGO_FEATURE_PROMISES))
-	CONFIGURE_FLAGS += --enable-sm-promise
-endif
-
 ifneq (,$(CCACHE))
 	CONFIGURE_FLAGS += --with-ccache=$(CCACHE)
 endif

mozjs/build/moz.configure/android-ndk.configure

@@ -301,6 +301,8 @@ def extra_toolchain_flags(android_system, android_sysroot, toolchain_dir,
              android_system,
              '-isystem',
              os.path.join(android_sysroot, 'usr', 'include'),
+             '--sysroot',
+             android_sysroot,
              '-gcc-toolchain',
              toolchain_dir,
              '-D__ANDROID_API__=%d' % android_version]

rustfmt.toml

@@ -0,0 +1,2 @@
+# Try to get all function signatures to fit on one line, so the jsapi file can be post-processed more easily
+max_width = 500

src/jsgc.rs

@@ -12,10 +12,9 @@ use jsapi::JSScript;
 use jsapi::JSString;
 use jsapi::JSTracer;
 
-use libc::c_void;
-
 use std::cell::UnsafeCell;
 use std::mem;
+use std::os::raw::c_void;
 use std::ptr;
 
 /// A trait for JS types that can be registered as roots.
@@ -71,6 +70,15 @@ impl RootKind for JS::PropertyDescriptor {
     fn rootKind() -> JS::RootKind { JS::RootKind::Traceable }
 }
 
+// Annoyingly, bindgen can't cope with SM's use of templates, so we have to roll our own.
+#[repr(C)]
+#[derive(Debug)]
+pub struct Rooted<T> {
+    pub stack: *mut *mut Rooted<*mut c_void>,
+    pub prev: *mut Rooted<*mut c_void>,
+    pub ptr: T,
+}
+
 /// A trait for types which can place appropriate GC barriers.
 /// * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Internals/Garbage_collection#Incremental_marking
 /// * https://dxr.mozilla.org/mozilla-central/source/js/src/gc/Barrier.h
@@ -267,5 +275,16 @@ impl<T: IntoMutableHandle> From<T> for JS::MutableHandle<T::Target> {
 /// Methods for a CustomAutoRooter
 #[repr(C)]
 pub struct CustomAutoRooterVFTable {
+    #[cfg(windows)]
+    pub padding: [usize; 1],
+    #[cfg(not(windows))]
+    pub padding: [usize; 2],
     pub trace: unsafe extern "C" fn (this: *mut c_void, trc: *mut JSTracer),
 }
+
+impl CustomAutoRooterVFTable {
+    #[cfg(windows)]
+    pub const PADDING: [usize; 1] = [0];
+    #[cfg(not(windows))]
+    pub const PADDING: [usize; 2] = [0, 0];
+}