Replace compat features with breaking changes

MODULEINFO

@@ -31,10 +31,10 @@ Make: dmlc
     $(HOST)/bin/dml/python/__main__.py
     $(HOST)/bin/dml/python/dml/__init__.py
     $(HOST)/bin/dml/python/dml/ast.py
+    $(HOST)/bin/dml/python/dml/breaking_changes.py
     $(HOST)/bin/dml/python/dml/c_backend.py
     $(HOST)/bin/dml/python/dml/g_backend.py
     $(HOST)/bin/dml/python/dml/codegen.py
-    $(HOST)/bin/dml/python/dml/compat.py
     $(HOST)/bin/dml/python/dml/crep.py
     $(HOST)/bin/dml/python/dml/ctree.py
     $(HOST)/bin/dml/python/dml/dmllex.py

Makefile

@@ -10,10 +10,10 @@ LIBDIR := $(SIMICS_PROJECT)/$(HOST_TYPE)/bin
 
 PYFILES := dml/__init__.py			\
 	  dml/ast.py				\
+	  dml/breaking_changes.py		\
 	  dml/c_backend.py			\
 	  dml/g_backend.py			\
 	  dml/codegen.py			\
-          dml/compat.py				\
           dml/crep.py				\
           dml/ctree.py				\
           dml/template.py			\

deprecations_to_md.py

@@ -6,7 +6,7 @@
 [path_to_dml, header, outfile] = sys.argv[1:]
 sys.path.append(path_to_dml)
 
-from dml import compat
+from dml import breaking_changes as compat
 from dml.env import api_versions, default_api_version
 
 by_version = {}

dmlast.py

@@ -9,7 +9,7 @@ def create_dmlasts(dmlc_path, dmlast_path, dml_path, depfile):
     from dml.toplevel import produce_dmlast
     from dml.logging import ignore_warning
     import dml.globals
-    from dml import compat
+    from dml import breaking_changes as compat
 
     ignore_warning('WEXPERIMENTAL')
     dml.globals.enabled_compat.add(compat.warning_statement)
@@ -35,4 +35,3 @@ def create_dmlasts(dmlc_path, dmlast_path, dml_path, depfile):
     [dmlc_path, dmlast_path, dml_path, depfile] = map(Path, sys.argv[1:])
     create_dmlasts(dmlc_path.resolve(), dmlast_path.resolve(),
                    dml_path.resolve(), depfile)
-

py/dead_dml_methods.py

@@ -114,7 +114,7 @@ def method_locations(path):
     from dml.toplevel import parse_file, determine_version
     from dml import logging, messages
     import dml.globals
-    from dml import compat
+    from dml import breaking_changes as compat
     # needed to parse 1.2/utility.dml
     dml.globals.enabled_compat.add(compat.warning_statement)
     for warning in messages.warnings:

py/dml/compat.py → py/dml/breaking_changes.py

@@ -198,19 +198,7 @@ class suppress_WLOGMIXUP(CompatFeature):
     [Messages](messages.html) section.
 
     `WLOGMIXUP` is suppressed by default below Simics API version 7 in order
-    to avoid overwhelming users with warnings, as the faulty pattern that
-    `WLOGMIXUP` reports is very prevalent within existing code. Addressing
-    applications of the faulty pattern should be done before or as part of
-    migration to Simics API version 7.
-
-    Passing `--no-compat=suppress_WLOGMIXUP` to DMLC has almost the same effect
-    as passing `--warn=WLOGMIXUP`; either will cause DMLC to report the warning
-    even when the Simics API version in use is below 7. The only difference
-    between these two options is that if `--no-compat=suppress_WLOGMIXUP` is
-    used (and `--warn=WLOGMIXUP` is not), then `WLOGMIXUP` may still be
-    explicitly suppressed via `--no-warn=WLOGMIXUP`. In contrast,
-    `--warn=WLOGMIXUP` doesn't allow for `WLOGMIXUP` to be suppressed at
-    all.'''
+    to avoid overwhelming users with warnings.'''
     short = "Suppress the warning 'WLOGMIXUP' by default"
     last_api_version = api_6
 
@@ -263,9 +251,8 @@ class no_method_index_asserts(CompatFeature):
 
     Migrating away from this compatibility feature should be a priority. If
     its disablement makes the simulation crash due to an assertion failing,
-    then that **definitely signifies a bug in your model; a bug that would
-    very likely result in memory corruption if the assertion were not to
-    be made.**'''
+    then that signifies a bug in your model that could
+    lead to memory corruption without the range check.'''
     short = ("Disable assertions made by methods of object arrays that the "
              + "the object array indices are valid. Migrate away from this "
              + "ASAP!")

py/dml/c_backend.py

@@ -13,7 +13,8 @@
 from pathlib import Path
 
 from . import objects, logging, crep, output, ctree, serialize, structure
-from . import traits, compat
+from . import traits
+from . import breaking_changes as compat
 import dml.globals
 from .structure import get_attr_name, port_class_ident, need_port_proxy_attrs
 from .logging import *

py/dml/codegen.py

@@ -12,7 +12,8 @@
 import math
 
 from . import objects, crep, ctree, ast, int_register, logging, serialize
-from . import dmlparse, output, compat
+from . import dmlparse, output
+from . import breaking_changes as compat
 from .logging import *
 from .expr import *
 from .ctree import *

py/dml/crep.py

@@ -10,7 +10,7 @@
 from .logging import *
 from .expr_util import *
 from .messages import *
-from . import compat
+from . import breaking_changes as compat
 
 __all__ = (
     'cname',

py/dml/ctree.py

@@ -21,7 +21,7 @@
 from .set import Set
 from .slotsmeta import auto_init
 from . import dmlparse, output
-from . import compat
+from . import breaking_changes as compat
 import dml.globals
 # set from codegen.py
 codegen_call_expr = None

py/dml/dmlc.py

@@ -12,7 +12,7 @@
 from . import serialize
 from . import dmlparse
 from . import output
-from . import compat
+from . import breaking_changes as compat
 
 import dml.c_backend
 import dml.info_backend

py/dml/dmlparse.py

@@ -13,7 +13,7 @@
 from . import dmllex12
 from . import dmllex14
 from . import provisional
-from . import compat
+from . import breaking_changes as compat
 
 assert lex.__version__ == yacc.__version__ == "3.4"
 

py/dml/globals.py

@@ -3,7 +3,7 @@
 
 # Global variables
 
-from . import compat
+from . import breaking_changes as compat
 
 # name -> Template instance. An object declaration in a file are
 # represented implicitly as a template, named @filename.dml.

py/dml/structure.py

@@ -32,7 +32,7 @@
 from .reginfo import explode_registers
 from . import dmlparse
 from .set import Set
-from . import compat
+from . import breaking_changes as compat
 from .slotsmeta import auto_init
 from . import provisional
 

py/dml/template.py

@@ -6,7 +6,7 @@
 import os
 import functools
 from . import ast, logging
-from . import compat
+from . import breaking_changes as compat
 from .logging import *
 from .messages import *
 from .set import Set

py/dml/toplevel.py

@@ -15,7 +15,7 @@
 from ply import lex, yacc
 
 from . import objects, logging, codegen, ctree, ast
-from . import compat
+from . import breaking_changes as compat
 from . import symtab
 from .messages import *
 from .logging import *

py/dml/traits.py

@@ -8,7 +8,8 @@
 import contextlib
 import abc
 import os
-from . import objects, logging, crep, codegen, toplevel, topsort, compat
+from . import objects, logging, crep, codegen, toplevel, topsort
+from . import breaking_changes as compat
 from .logging import *
 from .codegen import *
 from .symtab import *

py/dml/types.py

@@ -58,7 +58,7 @@
 from .output import out
 from .messages import *
 from .logging import *
-from . import compat
+from . import breaking_changes as compat
 from . import output
 import dml .globals
 import abc

test/1.2/errors/WREF.dml → test/1.2/errors/T_WREF.dml

@@ -8,6 +8,7 @@ device test;
 
 /// COMPILE-ONLY
 
+/// API-VERSION 5
 // Should be EREF in 6, SIMICS-9886
 /// WARNING WREF
 parameter p = $garbage;

test/1.4/errors/ETYPE_integer_t.dml → test/1.4/errors/T_ETYPE_integer_t.dml

@@ -6,6 +6,8 @@ dml 1.4;
 
 device test;
 
+/// API-VERSION 7
+
 /// ERROR ETYPE
 extern uinteger_t undef_uval;
 /// ERROR ETYPE

test/1.4/legacy/T_no_compat_5a.dml

@@ -0,0 +1,22 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+// 1.2 because some compat features are auto-disabled in DML 1.4
+dml 1.2;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 5
+/// DMLC-FLAG --no-compat=dml12_not,dml12_misc
+
+import "no_compat.dml";
+
+parameter enabled_5a = false;
+parameter enabled_5b = true;
+parameter enabled_6a = true;
+parameter enabled_6b = true;
+parameter enabled_7a = true;
+parameter enabled_7b = true;

test/1.4/legacy/T_no_compat_5b.dml

@@ -0,0 +1,22 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+// 1.2 because some compat features are auto-disabled in DML 1.4
+dml 1.2;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 5
+/// DMLC-FLAG --no-compat=port_obj_param,dml12_inline
+
+import "no_compat.dml";
+
+parameter enabled_5a = true;
+parameter enabled_5b = false;
+parameter enabled_6a = true;
+parameter enabled_6b = true;
+parameter enabled_7a = true;
+parameter enabled_7b = true;

test/1.4/legacy/T_no_compat_6a.dml

@@ -0,0 +1,21 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+dml 1.4;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 6
+/// DMLC-FLAG --no-compat=dml12_int,dml12_goto,io_memory
+
+import "no_compat.dml";
+
+param enabled_5a = false;
+param enabled_5b = false;
+param enabled_6a = false;
+param enabled_6b = true;
+param enabled_7a = true;
+param enabled_7b = true;

test/1.4/legacy/T_no_compat_6b.dml

@@ -0,0 +1,21 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+dml 1.4;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 6
+/// DMLC-FLAG --no-compat=shared_logs_on_device,suppress_WLOGMIXUP
+
+import "no_compat.dml";
+
+param enabled_5a = false;
+param enabled_5b = false;
+param enabled_6a = true;
+param enabled_6b = false;
+param enabled_7a = true;
+param enabled_7b = true;

test/1.4/legacy/T_no_compat_7a.dml

@@ -0,0 +1,21 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+dml 1.4;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 7
+/// DMLC-FLAG --no-compat=broken_conditional_is,broken_unused_types,no_method_index_asserts,warning_statement,lenient_typechecking,port_proxy_ifaces
+
+import "no_compat.dml";
+
+param enabled_5a = false;
+param enabled_5b = false;
+param enabled_6a = false;
+param enabled_6b = false;
+param enabled_7a = false;
+param enabled_7b = true;

test/1.4/legacy/T_no_compat_7b.dml

@@ -0,0 +1,21 @@
+/*
+  © 2025 Intel Corporation
+  SPDX-License-Identifier: MPL-2.0
+*/
+
+dml 1.4;
+
+device test;
+
+/// COMPILE-ONLY
+/// API-VERSION 7
+/// DMLC-FLAG --no-compat=function_in_extern_struct,port_proxy_attrs,meaningless_log_levels,optional_version_statement,experimental_vect,legacy_attributes
+
+import "no_compat.dml";
+
+param enabled_5a = false;
+param enabled_5b = false;
+param enabled_6a = false;
+param enabled_6b = false;
+param enabled_7a = true;
+param enabled_7b = false;