Initial work towards optimising STG (#158)

-- feature: some more advanced settings (`--stg-xxx`) have been exposed to control the behaviour of the internal STG compiler and evaluator, to allow easier benchmarking and performance comparison. These are heavily subject to change.

Author: gmorpheme

src/driver/eval.rs

@@ -8,7 +8,7 @@ use crate::{
     driver::{error::EucalyptError, options::EucalyptOptions, source::SourceLoader},
     eval::{
         error::ExecutionError,
-        machines::stg::{self, dump_runtime, RenderType, StgSettings},
+        machines::stg::{self, make_standard_runtime},
     },
     export,
 };
@@ -51,7 +51,6 @@ fn determine_format(opt: &EucalyptOptions, loader: &SourceLoader) -> String {
     opt_format
         .or(target_format)
         .or(main_format)
-        .clone()
         .unwrap_or(&"yaml".to_string())
         .to_string()
 }
@@ -134,36 +133,15 @@ impl<'a> Executor<'a> {
         let mut emitter = export::create_emitter(&format, output.as_mut())
             .ok_or_else(|| ExecutionError::UnknownFormat(format.to_string()))?;
 
-        let render_type = if opt.is_fragment() {
-            RenderType::RenderFragment
-        } else {
-            RenderType::RenderDoc
-        };
-
-        let settings = if opt.debug() {
-            eprintln!("Running in DEBUG mode");
-            StgSettings {
-                generate_annotations: true,
-                render_type,
-                trace_steps: true,
-                suppress_updates: false,
-            }
-        } else {
-            StgSettings {
-                generate_annotations: true,
-                render_type,
-                trace_steps: false,
-                suppress_updates: false,
-            }
-        };
+        let rt = make_standard_runtime(&mut self.source_map);
 
         if opt.dump_runtime() {
-            println!("{}", dump_runtime());
+            println!("{}", prettify::prettify(rt.as_ref()));
             Ok(None)
         } else {
             let syn = {
                 let t = Instant::now();
-                let syn = stg::compile(&settings, self.evaluand.clone())?;
+                let syn = stg::compile(opt.stg_settings(), self.evaluand.clone(), rt.as_ref())?;
                 stats.timings_mut().record("stg-compile", t.elapsed());
                 syn
             };
@@ -174,7 +152,7 @@ impl<'a> Executor<'a> {
             } else {
                 emitter.stream_start();
                 let mut machine =
-                    stg::standard_machine(&settings, syn, emitter, &mut self.source_map)?;
+                    stg::standard_machine(opt.stg_settings(), syn, emitter, rt.as_ref())?;
 
                 let ret = {
                     let t = Instant::now();

src/driver/options.rs

@@ -1,6 +1,9 @@
 //! Command line argument handling.
-use crate::driver::error::EucalyptError;
-use crate::syntax::input::{Input, Locator};
+use crate::{driver::error::EucalyptError, eval::machines::stg::StgSettings};
+use crate::{
+    eval::machines::stg::RenderType,
+    syntax::input::{Input, Locator},
+};
 use atty::Stream;
 use std::path::PathBuf;
 use std::str::FromStr;
@@ -86,6 +89,9 @@ pub struct EucalyptOptions {
     #[structopt(short = "x", long)]
     export_type: Option<String>,
 
+    #[structopt(flatten)]
+    stg_settings: StgSettings,
+
     /// Source code / data inputs (in order)
     inputs: Vec<Input>,
 }
@@ -394,6 +400,10 @@ impl EucalyptOptions {
         self.statistics
     }
 
+    pub fn stg_settings(&self) -> &StgSettings {
+        &self.stg_settings
+    }
+
     /// Prepend an input if it is not already in the input list
     fn prepend_input(&mut self, input: Input) {
         if !self.inputs.iter().any(|i| i == &input) {
@@ -479,6 +489,15 @@ impl EucalyptOptions {
             )));
         }
 
+        // Set default STG settings based on debug & other settings
+        self.stg_settings.generate_annotations = true;
+        if self.debug() {
+            self.stg_settings.trace_steps = true;
+        }
+        if self.is_fragment() && self.stg_settings.render_type != RenderType::Headless {
+            self.stg_settings.render_type = RenderType::RenderFragment;
+        }
+
         Ok(())
     }
 }

src/eval/machines/stg/arith.rs

@@ -286,7 +286,7 @@ pub mod tests {
                 env,
                 machine::Machine,
                 panic::Panic,
-                runtime,
+                runtime::{self, Runtime},
                 syntax::{dsl::*, StgSyn},
             },
         },
@@ -297,6 +297,7 @@ pub mod tests {
             let mut rt = runtime::StandardRuntime::default();
             rt.add(Box::new(Add));
             rt.add(Box::new(Panic));
+            rt.prepare(&mut SourceMap::default());
             Box::new(rt)
         };
     }
@@ -307,7 +308,7 @@ pub mod tests {
         Machine::new(
             syntax,
             Rc::new(env),
-            RUNTIME.globals(&mut SourceMap::default()),
+            RUNTIME.globals(),
             RUNTIME.intrinsics(),
             Box::new(DebugEmitter::default()),
             true,