Merge remote-tracking branch 'embecosm/improve-online-change-flag-behavior' into embecosm-online-chane

Author: ghaith

compiler/plc_driver/src/cli.rs

@@ -5,7 +5,8 @@ use encoding_rs::Encoding;
 use plc_diagnostics::diagnostics::{diagnostics_registry::DiagnosticsConfiguration, Diagnostic};
 use std::{env, ffi::OsStr, num::ParseIntError, path::PathBuf};
 
-use plc::{output::FormatOption, ConfigFormat, DebugLevel, ErrorFormat, Target, Threads};
+use plc::output::FormatOption;
+use plc::{ConfigFormat, DebugLevel, ErrorFormat, Target, Threads, DEFAULT_GOT_LAYOUT_FILE};
 
 pub type ParameterError = clap::Error;
 
@@ -117,9 +118,12 @@ pub struct CompileParameters {
     Save information about the generated custom GOT layout to the given file.
     Format is detected by extension.
     Supported formats : json, toml",
-    parse(try_from_str = validate_config)
+        default_value = DEFAULT_GOT_LAYOUT_FILE,
+        parse(try_from_str = validate_config),
+        // FIXME: For some reason, this does not work at the moment but it really should
+        // requires = "online_change"
     ) ]
-    pub got_layout_file: Option<String>,
+    pub got_layout_file: String,
 
     #[clap(
         name = "optimization",
@@ -214,6 +218,12 @@ pub struct CompileParameters {
     #[clap(name = "check", long, help = "Check only, do not generate any output", global = true)]
     pub check_only: bool,
 
+    #[clap(
+        long,
+        help = "Emit a binary with specific compilation information, suitable for online changes when ran under a conforming runtime"
+    )]
+    pub online_change: bool,
+
     #[clap(subcommand)]
     pub commands: Option<SubCommands>,
 }
@@ -329,9 +339,7 @@ pub fn get_config_format(name: &str) -> Option<ConfigFormat> {
 
 impl CompileParameters {
     pub fn parse<T: AsRef<OsStr> + AsRef<str>>(args: &[T]) -> Result<CompileParameters, ParameterError> {
-        CompileParameters::try_parse_from(args).and_then(|mut result| {
-            result.got_layout_file = Some(String::from("tmp.json"));
-
+        CompileParameters::try_parse_from(args).and_then(|result| {
             if result.sysroot.len() > result.target.len() {
                 let mut cmd = CompileParameters::command();
                 Err(cmd.error(
@@ -402,8 +410,9 @@ impl CompileParameters {
         self.hardware_config.as_deref().and_then(get_config_format)
     }
 
-    pub fn got_layout_format(&self) -> Option<ConfigFormat> {
-        self.got_layout_file.as_deref().and_then(get_config_format)
+    pub fn got_layout_format(&self) -> ConfigFormat {
+        // It is safe to unwrap here, since the provided argument to `--got-online-change` has been checked with `validate_config`
+        get_config_format(&self.got_layout_file).unwrap()
     }
 
     /// Returns the location where the build artifacts should be stored / output

compiler/plc_driver/src/lib.rs

@@ -19,8 +19,8 @@ use std::{
 
 use cli::{CompileParameters, ParameterError, SubCommands};
 use plc::{
-    codegen::CodegenContext, linker::LinkerType, output::FormatOption, ConfigFormat, DebugLevel,
-    ErrorFormat, OptimizationLevel, Target, Threads,
+    codegen::CodegenContext, linker::LinkerType, output::FormatOption, DebugLevel, ErrorFormat,
+    OnlineChange, OptimizationLevel, Target, Threads,
 };
 
 use plc_diagnostics::{diagnostician::Diagnostician, diagnostics::Diagnostic};
@@ -50,12 +50,11 @@ pub struct CompileOptions {
     /// The name of the resulting compiled file
     pub output: String,
     pub output_format: FormatOption,
-    pub got_layout_file: Option<String>,
-    pub got_layout_format: Option<ConfigFormat>,
     pub optimization: OptimizationLevel,
     pub error_format: ErrorFormat,
     pub debug_level: DebugLevel,
     pub single_module: bool,
+    pub online_change: OnlineChange,
 }
 
 impl Default for CompileOptions {
@@ -65,12 +64,11 @@ impl Default for CompileOptions {
             build_location: None,
             output: String::new(),
             output_format: Default::default(),
-            got_layout_file: None,
-            got_layout_format: None,
             optimization: OptimizationLevel::None,
             error_format: ErrorFormat::None,
             debug_level: DebugLevel::None,
             single_module: false,
+            online_change: OnlineChange::Disabled,
         }
     }
 }
@@ -176,12 +174,15 @@ pub fn get_compilation_context<T: AsRef<str> + AsRef<OsStr> + Debug>(
         build_location: compile_parameters.get_build_location(),
         output: project.get_output_name(),
         output_format,
-        got_layout_file: compile_parameters.got_layout_file.clone(),
-        got_layout_format: compile_parameters.got_layout_format(),
         optimization: compile_parameters.optimization,
         error_format: compile_parameters.error_format,
         debug_level: compile_parameters.debug_level(),
         single_module: compile_parameters.single_module,
+        online_change: if compile_parameters.online_change {
+            OnlineChange::Enabled((compile_parameters.got_layout_file.clone(),compile_parameters.got_layout_format()))
+        } else {
+            OnlineChange::Disabled
+        },
     };
 
     let libraries =

compiler/plc_driver/src/pipelines.rs

@@ -24,7 +24,7 @@ use plc::{
         TypeAnnotator,
     },
     validation::Validator,
-    ConfigFormat, Target,
+    ConfigFormat, OnlineChange, Target,
 };
 use plc_diagnostics::{
     diagnostician::Diagnostician,
@@ -309,27 +309,19 @@ impl<T: SourceContainer + Sync> AnnotatedProject<T> {
     }
 
     pub fn codegen_to_string(&self, compile_options: &CompileOptions) -> Result<Vec<String>, Diagnostic> {
-        let got_layout = compile_options
-            .got_layout_file
-            .as_ref()
-            .map(|path| read_got_layout(path, ConfigFormat::JSON))
-            .transpose()?;
-
+        let got_layout = if let OnlineChange::Enabled((file, format)) = &compile_options.online_change {
+            read_got_layout(file, *format)?
+        } else {
+            HashMap::default()
+        };
         let got_layout = Mutex::new(got_layout);
 
         self.units
             .iter()
             .map(|AnnotatedUnit { unit, dependencies, literals }| {
                 let context = CodegenContext::create();
-                self.generate_module(
-                    &context,
-                    compile_options,
-                    unit,
-                    dependencies,
-                    literals,
-                    &got_layout
-                )
-                .map(|it| it.persist_to_string())
+                self.generate_module(&context, compile_options, unit, dependencies, literals, &got_layout)
+                    .map(|it| it.persist_to_string())
             })
             .collect()
     }
@@ -339,26 +331,18 @@ impl<T: SourceContainer + Sync> AnnotatedProject<T> {
         context: &'ctx CodegenContext,
         compile_options: &CompileOptions,
     ) -> Result<Option<GeneratedModule<'ctx>>, Diagnostic> {
-        let got_layout = compile_options
-            .got_layout_file
-            .as_ref()
-            .map(|path| read_got_layout(path, ConfigFormat::JSON))
-            .transpose()?;
-
+        let got_layout = if let OnlineChange::Enabled((file, format)) = &compile_options.online_change {
+            read_got_layout(file, *format)?
+        } else {
+            HashMap::default()
+        };
         let got_layout = Mutex::new(got_layout);
 
         let Some(module) = self
             .units
             .iter()
             .map(|AnnotatedUnit { unit, dependencies, literals }| {
-                self.generate_module(
-                    context,
-                    compile_options,
-                    unit,
-                    dependencies,
-                    literals,
-                    &got_layout
-                )
+                self.generate_module(context, compile_options, unit, dependencies, literals, &got_layout)
             })
             .reduce(|a, b| {
                 let a = a?;
@@ -378,15 +362,16 @@ impl<T: SourceContainer + Sync> AnnotatedProject<T> {
         unit: &CompilationUnit,
         dependencies: &FxIndexSet<Dependency>,
         literals: &StringLiterals,
-        got_layout: &Mutex<Option<HashMap<String, u64>>>,
+        got_layout: &Mutex<HashMap<String, u64>>,
     ) -> Result<GeneratedModule<'ctx>, Diagnostic> {
         let mut code_generator = plc::codegen::CodeGen::new(
             context,
             compile_options.root.as_deref(),
             &unit.file_name,
-            compile_options.got_layout_file.clone().zip(compile_options.got_layout_format),
             compile_options.optimization,
             compile_options.debug_level,
+            //(compile_options.got_layout_file.clone(), compile_options.got_layout_format),
+            compile_options.online_change.clone(),
         );
         //Create a types codegen, this contains all the type declarations
         //Associate the index type with LLVM types
@@ -444,12 +429,11 @@ impl<T: SourceContainer + Sync> AnnotatedProject<T> {
         ensure_compile_dirs(targets, &compile_directory)?;
         let targets = if targets.is_empty() { &[Target::System] } else { targets };
 
-        let got_layout = compile_options
-            .got_layout_file
-            .as_ref()
-            .map(|path| read_got_layout(path, ConfigFormat::JSON))
-            .transpose()?;
-
+        let got_layout = if let OnlineChange::Enabled((file, format)) = &compile_options.online_change {
+            read_got_layout(file, *format)?
+        } else {
+            HashMap::default()
+        };
         let got_layout = Mutex::new(got_layout);
 
         let res = targets
@@ -516,9 +500,9 @@ impl<T: SourceContainer + Sync> AnnotatedProject<T> {
             })
             .collect::<Result<Vec<_>, Diagnostic>>()?;
 
-        compile_options.got_layout_file.as_ref().map(|path| {
-            write_got_layout(got_layout.into_inner().unwrap().unwrap(), path, ConfigFormat::JSON)
-        });
+        if let OnlineChange::Enabled((file, format)) = &compile_options.online_change {
+            write_got_layout(got_layout.into_inner().unwrap(), file, *format)?;
+        }
 
         Ok(res)
     }

compiler/plc_driver/src/tests/snapshots/plc_driver__tests__external_files__external_file_function_call.snap

@@ -5,7 +5,7 @@ expression: "results.join(\"\\n\")"
 ; ModuleID = 'main.st'
 source_filename = "main.st"
 
-define i16 @main() section "$RUSTY$fn-main:i16[]" {
+define i16 @main() {
 entry:
   %main = alloca i16, align 2
   store i16 0, i16* %main, align 2
@@ -14,17 +14,17 @@ entry:
   ret i16 %main_ret
 }
 
-declare i16 @external() section "$RUSTY$fn-external:i16[]"
+declare i16 @external()
 
 ; ModuleID = 'external.st'
 source_filename = "external.st"
 
-declare i16 @external() section "$RUSTY$fn-external:i16[]"
+declare i16 @external()
 
 ; ModuleID = '__init___TestProject'
 source_filename = "__init___TestProject"
 
-define void @__init___TestProject() section "$RUSTY$fn-__init___testproject:v[]" {
+define void @__init___TestProject() {
 entry:
   ret void
 }

compiler/plc_driver/src/tests/snapshots/plc_driver__tests__external_files__external_file_global_var.snap

@@ -8,7 +8,7 @@ source_filename = "main.st"
 @x = external global i16, section "$RUSTY$var-x:i16"
 @y = external global i16, section "$RUSTY$var-y:i16"
 
-define i16 @main() section "$RUSTY$fn-main:i16[]" {
+define i16 @main() {
 entry:
   %main = alloca i16, align 2
   store i16 0, i16* %main, align 2
@@ -19,20 +19,20 @@ entry:
   ret i16 %main_ret
 }
 
-declare i16 @external() section "$RUSTY$fn-external:i16[]"
+declare i16 @external()
 
 ; ModuleID = 'external.st'
 source_filename = "external.st"
 
 @x = external global i16, section "$RUSTY$var-x:i16"
 @y = external global i16, section "$RUSTY$var-y:i16"
 
-declare i16 @external() section "$RUSTY$fn-external:i16[]"
+declare i16 @external()
 
 ; ModuleID = '__init___TestProject'
 source_filename = "__init___TestProject"
 
-define void @__init___TestProject() section "$RUSTY$fn-__init___testproject:v[]" {
+define void @__init___TestProject() {
 entry:
   ret void
 }

compiler/plc_driver/src/tests/snapshots/plc_driver__tests__multi_files__multiple_files_in_different_locations_with_debug_info.snap

@@ -9,7 +9,7 @@ source_filename = "app/file1.st"
 
 @mainProg_instance = external global %mainProg, section "$RUSTY$var-mainprog_instance:r0", !dbg !0
 
-define i16 @main() section "$RUSTY$fn-main:i16[]" !dbg !10 {
+define i16 @main() !dbg !10 {
 entry:
   %main = alloca i16, align 2, !dbg !14
   call void @llvm.dbg.declare(metadata i16* %main, metadata !15, metadata !DIExpression()), !dbg !17
@@ -19,7 +19,7 @@ entry:
   ret i16 %main_ret, !dbg !14
 }
 
-declare !dbg !18 void @mainProg(%mainProg*) section "$RUSTY$fn-mainprog:v[]"
+declare !dbg !18 void @mainProg(%mainProg*)
 
 ; Function Attrs: nofree nosync nounwind readnone speculatable willreturn
 declare void @llvm.dbg.declare(metadata, metadata, metadata) #0
@@ -56,7 +56,7 @@ source_filename = "lib/file2.st"
 
 @mainProg_instance = global %mainProg zeroinitializer, section "$RUSTY$var-mainprog_instance:r0", !dbg !0
 
-define void @mainProg(%mainProg* %0) section "$RUSTY$fn-mainprog:v[]" !dbg !10 {
+define void @mainProg(%mainProg* %0) !dbg !10 {
 entry:
   call void @llvm.dbg.declare(metadata %mainProg* %0, metadata !13, metadata !DIExpression()), !dbg !14
   ret void, !dbg !14
@@ -93,15 +93,15 @@ source_filename = "__initializers"
 
 @mainProg_instance = external global %mainProg, section "$RUSTY$var-mainprog_instance:r0", !dbg !0
 
-define void @__init_mainprog(%mainProg* %0) section "$RUSTY$fn-__init_mainprog:v[pr0]" !dbg !10 {
+define void @__init_mainprog(%mainProg* %0) !dbg !10 {
 entry:
   %self = alloca %mainProg*, align 8, !dbg !14
   call void @llvm.dbg.declare(metadata %mainProg** %self, metadata !15, metadata !DIExpression()), !dbg !14
   store %mainProg* %0, %mainProg** %self, align 8, !dbg !14
   ret void, !dbg !14
 }
 
-declare !dbg !16 void @mainProg(%mainProg*) section "$RUSTY$fn-mainprog:v[]"
+declare !dbg !16 void @mainProg(%mainProg*)
 
 ; Function Attrs: nofree nosync nounwind readnone speculatable willreturn
 declare void @llvm.dbg.declare(metadata, metadata, metadata) #0
@@ -138,15 +138,15 @@ source_filename = "__init___TestProject"
 
 @mainProg_instance = external global %mainProg, section "$RUSTY$var-mainprog_instance:r0", !dbg !0
 
-define void @__init___TestProject() section "$RUSTY$fn-__init___testproject:v[]" !dbg !10 {
+define void @__init___TestProject() !dbg !10 {
 entry:
   call void @__init_mainprog(%mainProg* @mainProg_instance), !dbg !14
   ret void, !dbg !14
 }
 
-declare !dbg !15 void @__init_mainprog(%mainProg*) section "$RUSTY$fn-__init_mainprog:v[pr0]"
+declare !dbg !15 void @__init_mainprog(%mainProg*)
 
-declare !dbg !19 void @mainProg(%mainProg*) section "$RUSTY$fn-mainprog:v[]"
+declare !dbg !19 void @mainProg(%mainProg*)
 
 !llvm.module.flags = !{!5, !6}
 !llvm.dbg.cu = !{!7}