Do not add Graal at runtime, and instead require including it at buil…

…d time * Remove 'jt install graal', it's nothing more than 'jt build --graal' now. * Remove the --no-graal option for 'jt benchmark'. Whether Graal is included is decided by what is built. * Update documentation.
kirs · May 21, 2019 · 14f7836 · 14f7836
1 parent 7dc9597
commit 14f7836
Show file tree

Hide file tree

Showing 18 changed files with 57 additions and 201 deletions.
diff --git a/bench/optcarrot/README.md b/bench/optcarrot/README.md
@@ -9,7 +9,7 @@ The code is imported from revision `898783836dfcec04d25a8e7d4b1ce3ce3bbcebdd`.
 
 The emulator can be run with the SDL2 GUI with:
 ```
-$ jt install graal
+$ jt build --graal
 
-$ jt ruby --graal bench/optcarrot/bin/optcarrot --sdl2 --audio=none bench/optcarrot/examples/Lan_Master.nes
+$ jt ruby bench/optcarrot/bin/optcarrot --sdl2 --audio=none bench/optcarrot/examples/Lan_Master.nes
 ```
diff --git a/ci.jsonnet b/ci.jsonnet
@@ -136,14 +136,9 @@ local part_definitions = {
   graal: {
     core: {
       is_after+:: ["$.use.build"],
-      setup+: [
-        ["cd", "../graal/compiler"],
-        ["mx", "build"],
-        ["cd", "../../main"],
-      ],
+      setup+: jt(["build", "--graal"]),
 
       environment+: {
-        GRAAL_HOME: "../graal/compiler",
         HOST_VM: "server",
         HOST_VM_CONFIG: "graal-core",
       },
@@ -153,7 +148,6 @@ local part_definitions = {
       environment+: {
         HOST_VM: "server",
         HOST_VM_CONFIG: "default",
-        MX_NO_GRAAL: "true",
       },
     },
 
@@ -170,14 +164,9 @@ local part_definitions = {
         ["git", "-C", repo, "checkout", find_commit_importing_truffle],
       ],
 
-      setup+: self.clone + [
-        ["cd", "../graal-enterprise/graal-enterprise"],
-        ["mx", "build"],
-        ["cd", "../../main"],
-      ],
+      setup+: self.clone + jt(["build", "--dy", "/graal-enterprise"]),
 
       environment+: {
-        GRAAL_HOME: "$BUILD_DIR/graal-enterprise/graal-enterprise",
         HOST_VM: "server",
         HOST_VM_CONFIG: "graal-enterprise",
       },
@@ -201,7 +190,6 @@ local part_definitions = {
 
       environment+: {
         HOST_VM_CONFIG: "graal-core",
-        GRAAL_HOME: "$BUILD_DIR/graal/compiler",
         VM_SUITE_HOME: "$BUILD_DIR/graal/vm",
       },
     },
@@ -215,7 +203,6 @@ local part_definitions = {
 
       environment+: {
         HOST_VM_CONFIG: "graal-enterprise",
-        GRAAL_HOME: "$BUILD_DIR/graal-enterprise/graal-enterprise",
         VM_SUITE_HOME: "$BUILD_DIR/graal-enterprise/vm-enterprise",
       },
     },
@@ -441,9 +428,9 @@ local part_definitions = {
     compiler_metrics: {
       # Run all metrics benchmarks: hello and compile-mandelbrot
       benchmarks+:: [
-        ["allocation", "--", "--graal"],
-        ["minheap", "--", "--graal"],
-        ["time", "--", "--graal"],
+        "allocation",
+        "minheap",
+        "time",
       ]
     },
 

diff --git a/doc/contributor/benchmarking.md b/doc/contributor/benchmarking.md
@@ -2,6 +2,14 @@
 
 ## Benchmarking with the GraalVM Compiler
 
+First build TruffleRuby and include the GraalVM Compiler:
+
+```bash
+$ jt build --graal
+```
+
+Then run the benchmark, for instance:
+
 ```bash
 $ jt benchmark bench/classic/mandelbrot.rb --simple
 ```
@@ -11,10 +19,16 @@ for the first few iterations).
 
 # Benchmarking without the GraalVM Compiler
 
-You can turn off the GraalVM Compiler if you want using `--no-graal`.
+You can turn off the GraalVM Compiler if you want, by not including it in the GraalVM build:
 
 ```bash
-$ jt benchmark --no-graal bench/classic/mandelbrot.rb --simple
+$ jt build
+```
+
+It's the same command to run the benchmark, for instance:
+
+```bash
+$ jt benchmark bench/classic/mandelbrot.rb --simple
 ```
 
 You can benchmark an entirely different implementation using the

diff --git a/doc/contributor/building-graal.md b/doc/contributor/building-graal.md
@@ -6,32 +6,16 @@ when developing TruffleRuby, or possibly to modify them, or to use developer
 tools that come with Graal such as the Ideal Graph Visualizer, then you should
 install Graal locally.
 
-## Installing Graal with jt
+## Building Graal with jt
 
-Our workflow tool can install Graal automatically under the directory
-`../graal/compiler` with:
+Our workflow tool can build Graal automatically with:
 
 ```bash
-$ jt install graal
+$ jt build --graal
 ```
 
-You can then use `jt` to run TruffleRuby with Graal.
+You can then use `jt` as normal to run TruffleRuby with Graal.
 
 ```bash
-$ jt ruby --graal ...
-```
-
-## Building Graal manually
-
-If you want to build the GraalVM Compiler by yourself, follow the instructions
-in the Graal repository.
-
-https://github.com/oracle/graal
-
-You can then set the `GRAAL_HOME` environment variable to the location of the
-`compiler` directory inside the `graal` repository and use `jt` to run
-TruffleRuby.
-
-```bash
-$ GRAAL_HOME=.../graal/compiler jt ruby --graal ...
+$ jt ruby ...
 ```
diff --git a/doc/contributor/workflow.md b/doc/contributor/workflow.md
@@ -140,8 +140,8 @@ Ruby command line options and arguments can also be set in `RUBYOPT`.
 
 ## Running with Graal
 
-See the document on [build graal](building-graal.md), and then run `jt ruby`
-with the `--graal` option.
+See the document on [building graal](building-graal.md), and then run `jt ruby`
+as normal.
 
 We have flags in `jt` to set some options, such as `--trace` for
 `--vm.Dgraal.TraceTruffleCompilation=true` and `--igv` for

diff --git a/doc/samples/can-we-fold-yet.rb b/doc/samples/can-we-fold-yet.rb
@@ -10,10 +10,7 @@
 
 require 'readline'
 
-unless TruffleRuby.jit?
-  puts 'You need the GraalVM Compiler to run this'
-  exit
-end
+abort 'You need the GraalVM Compiler to run this' unless TruffleRuby.jit?
 
 puts 'Can Truffle constant fold yet?'
 

diff --git a/mx.truffleruby/mx_truffleruby_benchmark.py b/mx.truffleruby/mx_truffleruby_benchmark.py
@@ -269,8 +269,6 @@ def filterLines(self, lines):
 
     def runBenchmark(self, benchmark, bmSuiteArgs):
         arguments = ['benchmark']
-        if 'MX_NO_GRAAL' in os.environ:
-            arguments.extend(['--no-graal'])
         arguments.extend(['--simple', '--elapsed', '--iterations'])
         arguments.extend(['--time', str(self.time())])
         if ':' in benchmark:
@@ -586,8 +584,8 @@ def name(self):
 
     def runBenchmark(self, benchmark, bmSuiteArgs):
         arguments = ['ruby']
-        if 'MX_NO_GRAAL' not in os.environ and not bmSuiteArgs:
-            arguments.extend(['--graal', '--vm.Dgraal.TruffleCompilationExceptionsAreFatal=true'])
+        if not bmSuiteArgs:
+            arguments.extend(['--vm.Dgraal.TruffleCompilationExceptionsAreFatal=true'])
         arguments.extend(['bench/servers/' + benchmark + '.rb'])
 
         server = BackgroundJT(arguments + bmSuiteArgs)

diff --git a/test/truffle/compiler/can-we-fold-yet.sh b/test/truffle/compiler/can-we-fold-yet.sh
@@ -2,7 +2,7 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --vm.Dgraal.TruffleIterativePartialEscape=true doc/samples/can-we-fold-yet.rb < test/truffle/compiler/can-we-fold-yet/input.txt > actual.txt
+jt ruby --vm.Dgraal.TruffleIterativePartialEscape=true doc/samples/can-we-fold-yet.rb < test/truffle/compiler/can-we-fold-yet/input.txt > actual.txt
 
 if ! cmp test/truffle/compiler/can-we-fold-yet/expected.txt actual.txt
 then

diff --git a/test/truffle/compiler/compile-immediately.sh b/test/truffle/compiler/compile-immediately.sh
@@ -2,4 +2,4 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --stress --trace -e "puts 'hello'"
+jt ruby --stress --trace -e "abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?; puts 'hello'"
diff --git a/test/truffle/compiler/osr.sh b/test/truffle/compiler/osr.sh
@@ -2,4 +2,4 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/osr/osr.rb
+jt ruby --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/osr/osr.rb
diff --git a/test/truffle/compiler/osr/osr.rb b/test/truffle/compiler/osr/osr.rb
@@ -6,6 +6,8 @@
 # GNU General Public License version 2, or
 # GNU Lesser General Public License version 2.1.
 
+abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?
+
 timeout = Time.now + 30
 
 begin

diff --git a/test/truffle/compiler/pe.sh b/test/truffle/compiler/pe.sh
@@ -2,4 +2,4 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --vm.Dgraal.TruffleCompilationExceptionsAreThrown=true --vm.Dgraal.TruffleIterativePartialEscape=true --experimental-options --basic-ops-inline=false test/truffle/compiler/pe/pe.rb "$@"
+jt ruby --vm.Dgraal.TruffleCompilationExceptionsAreThrown=true --vm.Dgraal.TruffleIterativePartialEscape=true --experimental-options --basic-ops-inline=false test/truffle/compiler/pe/pe.rb "$@"
diff --git a/test/truffle/compiler/pe/pe.rb b/test/truffle/compiler/pe/pe.rb
@@ -26,10 +26,7 @@
 #
 #   jt ruby --graal --vm.Dgraal.TraceTruffleCompilation=true --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true --vm.Dgraal.TruffleIterativePartialEscape=true test.rb
 
-unless TruffleRuby.jit?
-  puts 'not running the GraalVM Compiler'
-  exit 1
-end
+abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?
 
 TIMEOUT = 10
 

diff --git a/test/truffle/compiler/stf-optimises.sh b/test/truffle/compiler/stf-optimises.sh
@@ -2,4 +2,4 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/stf-optimises/stf-optimises.rb
+jt ruby --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/stf-optimises/stf-optimises.rb
diff --git a/test/truffle/compiler/stf-optimises/stf-optimises.rb b/test/truffle/compiler/stf-optimises/stf-optimises.rb
@@ -6,13 +6,15 @@
 # GNU General Public License version 2, or
 # GNU Lesser General Public License version 2.1.
 
+abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?
+
 def foo
   var = 14
   var * 2
 end
 
 set_trace_func proc { |event, file, line, id, binding, classname|
-  if event == 'line' && file == __FILE__ && line == 11
+  if event == 'line' && file == __FILE__ && line == 13
     binding.local_variable_set(:var, 100)
   end
 }

diff --git a/test/truffle/compiler/tp-optimises.sh_excluded b/test/truffle/compiler/tp-optimises.sh_excluded
@@ -2,4 +2,4 @@
 
 source test/truffle/common.sh.inc
 
-jt ruby --graal --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/tp-optimises/tp-optimises.rb
+jt ruby --vm.Dgraal.TruffleCompilationExceptionsAreFatal=true test/truffle/compiler/tp-optimises/tp-optimises.rb
diff --git a/test/truffle/compiler/tp-optimises/tp-optimises.rb b/test/truffle/compiler/tp-optimises/tp-optimises.rb
@@ -6,13 +6,15 @@
 # GNU General Public License version 2, or
 # GNU Lesser General Public License version 2.1.
 
+abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?
+
 def foo
   var = 14
   var * 2
 end
 
 tp = TracePoint.new(:line) do |tp|
-  if tp.path == __FILE__ && tp.lineno == 11
+  if tp.path == __FILE__ && tp.lineno == 13
     tp.binding.local_variable_set(:var, 100)
   end
 end
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		source test/truffle/common.sh.inc

		jt ruby --graal --stress --trace -e "puts 'hello'"
		jt ruby --stress --trace -e "abort 'not running the GraalVM Compiler' unless TruffleRuby.jit?; puts 'hello'"