Gate fix behind --no-compat=shared_logs_on_device

Author: lwaern-intel

RELEASENOTES-1.4.docu

@@ -518,4 +518,7 @@
       as the log object instead of the configuration object of the nearest
       enclosing <tt>device</tt>, <tt>port</tt>, <tt>bank</tt> or
       <tt>subdevice</tt> <bug number="SIMICS-11346"/>.
+      This fix is only enabled by default with Simics API version 7 or above.
+      With version 6 or below it must be explicitly enabled by passing
+      <tt>--no-compat=shared_logs_on_device</tt> to DMLC.</add-note></build-id>
 </rn>

lib/1.2/dml-builtins.dml

@@ -210,6 +210,7 @@ template device {
     parameter _compat_port_proxy_attrs auto;
     parameter _compat_port_obj_param auto;
     parameter _compat_io_memory auto;
+    parameter _compat_shared_logs_on_device auto;
     parameter _compat_dml12_inline auto;
     parameter _compat_dml12_not auto;
     parameter _compat_dml12_goto auto;

lib/1.4/dml-builtins.dml

@@ -544,6 +544,7 @@ template device {
     param _compat_port_proxy_attrs auto;
     param _compat_port_obj_param auto;
     param _compat_io_memory auto;
+    param _compat_shared_logs_on_device auto;
     param _compat_dml12_inline auto;
     param _compat_dml12_not auto;
     param _compat_dml12_goto auto;

py/dml/c_backend.py

@@ -3328,7 +3328,8 @@ def generate_cfile_body(device, footers, full_module, filename_prefix):
     generate_events(device)
     generate_identity_data_decls()
     generate_object_vtables_array()
-    generate_log_object_assocs_array()
+    if compat.shared_logs_on_device not in dml.globals.enabled_compat:
+        generate_log_object_assocs_array()
     generate_class_var_decl()
     generate_startup_calls_entry_function(device)
     generate_init_data_objs(device)

py/dml/codegen.py

@@ -2647,7 +2647,9 @@ def stmt_log(stmt, location, scope):
         logobj = log_object(site, location.node, location.indices)
     else:
         identity = TraitObjIdentity(site, lookup_var(site, scope, "this"))
-        logobj = LogObjectFromObjIdentity(site, identity)
+        logobj = (log_object(site, dml.globals.device, ())
+                  if compat.shared_logs_on_device in dml.globals.enabled_compat
+                  else LogObjectFromObjIdentity(site, identity))
 
     if later_level is not None:
         adjusted_later_level = later_level = ctree.as_int(codegen_expression(

py/dml/compat.py

@@ -105,6 +105,19 @@ class port_obj_param(CompatFeature):
     last_api_version = api_5
 
 
+@feature
+class shared_logs_on_device(CompatFeature):
+    '''This compatibility feature changes the semantics of log statements
+    inside shared methods so that they always log on the device object, instead
+    of the nearest enclosing configuration object like with non-shared methods.
+    This behaviour was a bug present since the very introduction of shared
+    methods, which has lead to plenty of script code having become reliant
+    on it, especially in regards to how banks log. This feature preserves the
+    bugged behaviour.'''
+    short = "Make logs inside shared methods always log on the device object"
+    last_api_version = api_6
+
+
 @feature
 class dml12_inline(CompatFeature):
     '''When using `inline` to inline a method in a DML 1.2 device,

test/1.4/legacy/T_shared_logs_on_device_disabled.dml

@@ -0,0 +1,44 @@
+/*
+  © 2023 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+dml 1.4;
+
+device test;
+
+/// DMLC-FLAG --simics-api=6
+/// DMLC-FLAG --no-compat=shared_logs_on_device
+
+template t is _qname {
+    shared method hello() {
+        log info: "hello from %s", _qname();
+    }
+}
+
+is t;
+group g is t {
+    in each object { is t; }
+
+    group c[i < 2];
+
+    subdevice s[i < 3] {
+        group c[j < 5][k < 7] is t {
+            subdevice s;
+        }
+    }
+}
+
+method init() {
+    /// GREP \[obj info\] hello from test
+    hello();
+    /// GREP \[obj info\] hello from g
+    g.hello();
+    /// GREP \[obj info\] hello from g.c\[1\]
+    g.c[1].hello();
+    /// GREP \[obj\.g\.s\[2\] info\] hello from g\.s\[2\]
+    g.s[2].hello();
+    /// GREP \[obj\.g\.s\[2\] info\] hello from g\.s\[2\]\.c\[3\]\[5\]
+    g.s[2].c[3][5].hello();
+    /// GREP \[obj\.g\.s\[2\]\.c\[3\]\[5\]\.s info\] hello from g\.s\[2\]\.c\[3\]\[5\]\.s
+    g.s[2].c[3][5].s.hello();
+}

test/1.4/legacy/T_shared_logs_on_device_enabled.dml

@@ -0,0 +1,43 @@
+/*
+  © 2023 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+dml 1.4;
+
+device test;
+
+/// DMLC-FLAG --simics-api=6
+
+template t is _qname {
+    shared method hello() {
+        log info: "hello from %s", _qname();
+    }
+}
+
+is t;
+group g is t {
+    in each object { is t; }
+
+    group c[i < 2];
+
+    subdevice s[i < 3] {
+        group c[j < 5][k < 7] is t {
+            subdevice s;
+        }
+    }
+}
+
+method init() {
+    /// GREP \[obj info\] hello from test
+    hello();
+    /// GREP \[obj info\] hello from g
+    g.hello();
+    /// GREP \[obj info\] hello from g.c\[1\]
+    g.c[1].hello();
+    /// GREP \[obj info\] hello from g\.s\[2\]
+    g.s[2].hello();
+    /// GREP \[obj info\] hello from g\.s\[2\]\.c\[3\]\[5\]
+    g.s[2].c[3][5].hello();
+    /// GREP \[obj info\] hello from g\.s\[2\]\.c\[3\]\[5\]\.s
+    g.s[2].c[3][5].s.hello();
+}

test/1.4/lib/T_map_target_connect.dml

@@ -6,6 +6,8 @@ dml 1.4;
 
 device test;
 
+/// DMLC-FLAG --no-compat=shared_logs_on_device
+
 import "utility.dml";
 import "simics/simulator-api.dml";
 

test/1.4/lib/T_unmapped_access.dml

@@ -5,6 +5,8 @@
 dml 1.4;
 device test;
 
+/// DMLC-FLAG --no-compat=shared_logs_on_device
+
 import "utility.dml";
 
 template partially_mapped_register is (register, unmapped) {