Update uses of enabled_compat to use breaking_changes instead

Author: mandolaerik

dmlast.py

@@ -9,10 +9,11 @@ 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 breaking_changes as compat
+    from dml import breaking_changes
 
     ignore_warning('WEXPERIMENTAL')
-    dml.globals.enabled_compat.add(compat.warning_statement)
+    # disable breaking change dml_forbid_warning_statement
+    breaking_changes.BreakingChange.enabled_breaking_changes = set()
     dml_files_abs = list(dml_path.rglob('*.dml'))
     dml_files = [p.relative_to(dml_path) for p in dml_files_abs]
     assert dml_files

lib/1.4/dml-builtins.dml

@@ -705,7 +705,7 @@ template device {
     param be_bitorder             default _be_bitorder;
     param log_group                 = undefined;
 
-    param use_io_memory             default _compat_io_memory;
+    param use_io_memory             default !_breaking_change_dml_transaction_by_default;
     // this was available in DML 1.2; defensively reserved in 1.4
     param banks                     = undefined;
     // this carried semantics in DML 1.2; deprecated in 1.4
@@ -1596,7 +1596,8 @@ template port is object {
     param _is_simics_object = true;
     // limitations for ports are not recognized
     param limitations = undefined;
-    param obj = dev._compat_port_obj_param #? dev.obj #: _port_obj();
+    param obj = dev._breaking_change_dml_remove_port_obj_param
+        #? _port_obj() #: dev.obj;
 
     #if (parent.objtype == "group"
          #? parent._simics_namespace_clash #: false) {
@@ -1945,7 +1946,8 @@ template bank is (object, shown_desc) {
     // compatibility: referencing 'obj' in a bank method must evaluate to
     // dev.obj in code that can compile on both 5 and 6
     // TODO: we should probably make obj an immutable session variable
-    param obj = dev._compat_port_obj_param #? dev.obj #: _bank_obj();
+    param obj = dev._breaking_change_dml_remove_port_obj_param
+        #? _bank_obj() #: dev.obj;
     param partial : bool;
     param overlapping : bool;
     param _le_byte_order : bool;

py/dml/c_backend.py

@@ -14,7 +14,7 @@
 
 from . import objects, logging, crep, output, ctree, serialize, structure
 from . import traits
-from . import breaking_changes as compat
+from . import breaking_changes
 import dml.globals
 from .structure import get_attr_name, port_class_ident, need_port_proxy_attrs
 from .logging import *
@@ -261,7 +261,7 @@ def generate_hfile(device, headers, filename):
     out("/* Generated by dmlc, do not edit! */\n\n")
     emit_guard_start(filename)
     out('#define DML_PREFIX(x) '+crep.cname(device)+'_##x\n\n')
-    legacy_attrs = int(compat.legacy_attributes in dml.globals.enabled_compat)
+    legacy_attrs = int(not breaking_changes.dml_remove_legacy_attributes.enabled)
     out(f'#define DML_LEGACY_ATTRS {legacy_attrs}\n')
 
     with allow_linemarks():
@@ -893,7 +893,7 @@ def generate_implement(code, device, impl):
         # descendants of the device object
         if (port.parent is dml.globals.device
             and port.objtype in {'port', 'bank'}
-            and compat.port_proxy_ifaces in dml.globals.enabled_compat):
+            and not breaking_changes.dml_remove_port_proxy_ifaces.enabled):
             if port.local_dimensions() == 0:
                 code.out("static const %s = %s;\n" % (
                     ifacetype.declaration('port_iface'),
@@ -1684,7 +1684,7 @@ def generate_pre_delete(device):
             + 'NULL);\n')
         out('}\n', preindent=-1)
 
-    if dml.globals.api_version < compat.api_7:
+    if dml.globals.api_version < breaking_changes.api_7:
         out(f'{crep.cname(device)}_deinit(_obj);\n')
     out('}\n\n', preindent = -1)
 
@@ -1938,7 +1938,7 @@ def generate_init_data_objs(device):
     for (start, end) in [('A', 'Z'), ('a', 'z'), ('0', '9'), ('_', '_')]
     for i in range(ord(start), ord(end) + 1))
 def init_function_name(device, outprefix):
-    if dml.globals.api_version <= compat.api_4_8:
+    if dml.globals.api_version <= breaking_changes.api_4_8:
         return 'initialize_' + crep.cname(device)
     return '_initialize_' + ''.join(
         (ch if ch in ident_chars else '_') for ch in outprefix)
@@ -1966,7 +1966,7 @@ def generate_init(device, initcode, outprefix):
     out('.init = '+crep.cname(device)+'_init,\n')
     out('.finalize = '+crep.cname(device)+'_finalize,\n')
     out('.objects_finalized = '+crep.cname(device)+'_objects_finalized,\n')
-    if dml.globals.api_version >= compat.api_7:
+    if dml.globals.api_version >= breaking_changes.api_7:
         out('.deinit = '+crep.cname(device)+'_deinit,\n')
     out('.dealloc = '+crep.cname(device)+'_dealloc,\n')
     out('.description = '+doc.read()+',\n')
@@ -2166,7 +2166,7 @@ def generate_port_object_assocs_array():
                        else node.object_parent)
         if (object_node is not dml.globals.device
             # Anonymous banks
-            and (compat.dml12_misc not in dml.globals.enabled_compat
+            and (breaking_changes.dml12_remove_misc_quirks.enabled
                  or object_node.ident is not None)):
             port_obj_offset = (
                 f'offsetof({crep.structtype(dml.globals.device)}, '
@@ -3276,8 +3276,9 @@ def generate_cfile(device, footers,
                    full_module):
     global c_file
 
-    sym = 'SIMICS_%s_API' % ('4_8' if dml.globals.api_version == compat.api_4_8
-                             else dml.globals.api_version.str)
+    sym = 'SIMICS_%s_API' % (
+        '4_8' if dml.globals.api_version == breaking_changes.api_4_8
+        else dml.globals.api_version.str)
     api_define = '#ifndef %s\n#define %s\n#endif\n' % (
         sym, sym)
 
@@ -3336,8 +3337,8 @@ def generate_cfile_body(device, footers, full_module, filename_prefix):
     generate_events(device)
     generate_identity_data_decls()
     generate_object_vtables_array()
-    if not (dml.globals.dml_version == (1, 2)
-            and compat.shared_logs_on_device in dml.globals.enabled_compat):
+    if (dml.globals.dml_version != (1, 2)
+        or breaking_changes.dml_shared_logs_locally.enabled):
         generate_port_object_assocs_array()
     generate_class_var_decl()
     generate_startup_calls_entry_function(device)
@@ -3470,7 +3471,7 @@ def generate_cfile_body(device, footers, full_module, filename_prefix):
 
     if full_module:
         # caught as error earlier on
-        assert dml.globals.api_version == compat.api_4_8
+        assert dml.globals.api_version == breaking_changes.api_4_8
         out('\n')
         out('EXPORTED void\n')
         out('init_local(void)\n')

py/dml/codegen.py

@@ -13,7 +13,7 @@
 
 from . import objects, crep, ctree, ast, int_register, logging, serialize
 from . import dmlparse, output
-from . import breaking_changes as compat
+from . import breaking_changes
 from .logging import *
 from .expr import *
 from .ctree import *
@@ -1101,7 +1101,7 @@ def subast_has_dollar(expr_ast):
 @expression_dispatcher
 def expr_unop(tree, location, scope):
     [op, rh_ast] = tree.args
-    if (compat.dml12_misc in dml.globals.enabled_compat
+    if (not breaking_changes.dml12_remove_misc_quirks.enabled
         and op == 'sizeof' and rh_ast.kind == 'variable_dml12'):
         var = rh_ast.args[0]
         if var in typedefs and scope.lookup(var) is None:
@@ -1142,7 +1142,7 @@ def expr_unop(tree, location, scope):
                     return ctree.AddressOfMethod(tree.site, func)
         raise rh.exc()
     if   op == '!':
-        if compat.dml12_not in dml.globals.enabled_compat:
+        if not breaking_changes.dml12_not_typecheck.enabled:
             t = rh.ctype()
             if isinstance(safe_realtype(t), TInt) and subast_has_dollar(rh_ast):
                 # A previous bug caused DMLC to permit expressions on
@@ -1164,7 +1164,7 @@ def expr_unop(tree, location, scope):
     elif op == 'post++':  return mkPostInc(tree.site, rh)
     elif op == 'post--':  return mkPostDec(tree.site, rh)
     elif op == 'sizeof':
-        if (compat.dml12_misc not in dml.globals.enabled_compat
+        if (breaking_changes.dml12_remove_misc_quirks.enabled
             and not rh.addressable):
             raise ERVAL(rh.site, 'sizeof')
         return codegen_sizeof(tree.site, rh)
@@ -1464,8 +1464,8 @@ def eval_type(asttype, site, location, scope, extern=False, typename=None,
                 (member_struct_defs, member_type) = eval_type(
                     type_ast, msite, location, scope, extern)
                 if isinstance(member_type, TFunction):
-                    if (compat.function_in_extern_struct
-                        in dml.globals.enabled_compat
+                    if (not (breaking_changes
+                             .dml_forbid_function_in_extern_struct.enabled)
                         and extern):
                         member_type = TPtr(member_type)
                     else:
@@ -1535,7 +1535,7 @@ def eval_type(asttype, site, location, scope, extern=False, typename=None,
                 else:
                     raise expr.exc()
             elif (not expr.addressable
-                  and compat.dml12_misc not in dml.globals.enabled_compat):
+                  and breaking_changes.dml12_remove_misc_quirks.enabled):
                 raise ERVAL(expr.site, 'typeof')
             else:
                 etype = expr.ctype().clone()
@@ -1662,7 +1662,7 @@ def declaration(self):
 
     def with_expr(self, expr):
         assert (self.typ is None
-                or compat.dml12_inline in dml.globals.enabled_compat)
+                or not breaking_changes.dml12_disable_inline_constants.enabled)
         return MethodInParam(self.site, self.ident, self.typ, expr)
 
     def with_type(self, typ):
@@ -2049,7 +2049,7 @@ def convert_decl(decl_ast):
         name = ident_ast.args[0] if ident_ast.kind == 'variable' else None
         if (name is not None
             and dml.globals.dml_version == (1, 2)
-            and compat.dml12_misc not in dml.globals.enabled_compat):
+            and breaking_changes.dml12_remove_misc_quirks.enabled):
             check_varname(stmt.site, name)
         (struct_decls, etype) = eval_type(asttype, stmt.site, location, scope)
         stmts.extend(mkStructDefinition(site, t) for (site, t) in struct_decls)
@@ -2679,7 +2679,7 @@ def stmt_assert(stmt, location, scope):
 @statement_dispatcher
 def stmt_goto(stmt, location, scope):
     [label] = stmt.args
-    if compat.dml12_goto not in dml.globals.enabled_compat:
+    if breaking_changes.dml12_remove_goto.enabled:
         report(ESYNTAX(stmt.site, 'goto', 'goto statement not allowed'))
     return [mkGoto(stmt.site, label)]
 
@@ -2773,11 +2773,11 @@ def stmt_log(stmt, location, scope):
                        and (not level.constant or level.value != 1))
 
     # This correction must be done independently of
-    # compat.meaningless_log_levels, otherwise existing usages of
+    # breaking_changes.dml_meaningless_log_levels, otherwise existing usages of
     # e.g. log error, 2: "..." will become noops
     if bad_error_level:
         adjusted_level = mkIntegerLiteral(site, 1)
-    if compat.meaningless_log_levels not in dml.globals.enabled_compat:
+    if breaking_changes.dml_restrict_log_levels.enabled:
         if bad_error_level:
             report(ELLEV(level.site, "1"))
     elif level.constant and not (1 <= level.value <= 4):
@@ -2793,9 +2793,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 = (log_object(site, dml.globals.device, ())
-                  if compat.shared_logs_on_device in dml.globals.enabled_compat
-                  else PortObjectFromObjIdentity(site, identity))
+        logobj = (PortObjectFromObjIdentity(site, identity)
+                  if breaking_changes.dml_shared_logs_locally.enabled
+                  else log_object(site, dml.globals.device, ()))
 
     log_wrapper = lambda stmt: stmt
 
@@ -2806,8 +2806,7 @@ def stmt_log(stmt, location, scope):
             later_level.value == level.value):
             report(WREDUNDANTLEVEL(site))
         if (error_logkind
-            and (compat.meaningless_log_levels
-                 not in dml.globals.enabled_compat)):
+            and breaking_changes.dml_restrict_log_levels.enabled):
             if not later_level.constant or later_level.value not in {1, 5}:
                 report(ELLEV(later_level.site, "a 1 or 5 constant"))
                 adjusted_later_level = mkIntegerLiteral(site, 1)
@@ -3225,7 +3224,7 @@ def stmt_select(stmt, location, scope):
                 if_chain = mkIf(cond.site, cond, stmt, if_chain)
             return [if_chain]
         raise lst.exc()
-    elif (compat.dml12_misc in dml.globals.enabled_compat
+    elif (not breaking_changes.dml12_remove_misc_quirks.enabled
           and isinstance(lst.ctype(), TVector)
           and itername is not None):
         itervar = lookup_var(stmt.site, scope, itername)
@@ -3501,17 +3500,20 @@ def common_inline(site, method, indices, inargs, outargs):
 
     if dml.globals.debuggable:
         if method.fully_typed and (
-                compat.dml12_inline not in dml.globals.enabled_compat
+                breaking_changes.dml12_disable_inline_constants.enabled
                 or all(not arg.constant for arg in inargs)):
             # call method instead of inlining it
             func = method_instance(method)
         else:
             # create a specialized method instance based on parameter
             # types, and call that
             intypes = tuple(
-                arg if ((p.typ is None
-                         or compat.dml12_inline in dml.globals.enabled_compat)
-                        and (arg.constant or undefined(arg)))
+                arg if (
+                    (p.typ is None
+                     or not (
+                         breaking_changes
+                         .dml12_disable_inline_constants.enabled))
+                    and (arg.constant or undefined(arg)))
                 else methfunc_param(p.typ, arg)
                 for (p, arg) in zip(method.inp, inargs))
             outtypes = tuple(methfunc_param(ptype, arg)
@@ -3763,7 +3765,8 @@ def codegen_inline(site, meth_node, indices, inargs, outargs,
                 param_scope.add(ExpressionSymbol(p.ident, arg, arg.site))
             elif arg.constant and (
                     p.inlined
-                    or compat.dml12_inline in dml.globals.enabled_compat):
+                    or not (breaking_changes
+                            .dml12_disable_inline_constants.enabled)):
                 # Constants must be passed directly to
                 # provide constant folding.  Other values are stored in a
                 # local variable to improve type checking and variable
@@ -3979,7 +3982,7 @@ def codegen_method_func(func):
         e = p.expr
         if (p.ident is not None
             and dml.globals.dml_version == (1, 2)
-            and compat.dml12_misc not in dml.globals.enabled_compat):
+            and breaking_changes.dml12_remove_misc_quirks.enabled):
             check_varname(p.site, p.ident)
         if e and p.ident is not None:
             inlined_arg = (
@@ -4104,8 +4107,7 @@ def prelude():
             with fail_handler, exit_handler:
                 body = ([mkIndicesAssert(site, location.node,
                                          location.indices)]
-                        if ((compat.no_method_index_asserts
-                             not in dml.globals.enabled_compat)
+                        if (breaking_changes.dml_range_check_method_indices.enabled
                             and location.method() and location.node.dimsizes)
                         else [])
                 body.extend(prelude())
@@ -4201,7 +4203,7 @@ def codegen_call(site, meth_node, indices, inargs, outargs):
     if (site.dml_version() == (1, 2) and logging.show_porting):
         report_pevent_data_arg(meth_node, site, inargs)
 
-    if compat.dml12_misc in dml.globals.enabled_compat:
+    if not breaking_changes.dml12_remove_misc_quirks.enabled:
         # For backward compatibility. See bug 21367.
         inargs = [mkCast(site, arg, TPtr(TNamed('char')))
                   if isinstance(arg, StringConstant) else arg

py/dml/crep.py

@@ -10,7 +10,7 @@
 from .logging import *
 from .expr_util import *
 from .messages import *
-from . import breaking_changes as compat
+from . import breaking_changes
 
 __all__ = (
     'cname',
@@ -74,8 +74,7 @@ def cname(node):
     elif node.objtype == 'interface':
         # this is weird... kept for compatibility
         name = param_str(node, 'c_name').replace('-', '_')
-        if name != node.name and (
-                compat.dml12_misc not in dml.globals.enabled_compat):
+        if name != node.name and breaking_changes.dml12_remove_misc_quirks.enabled:
             report(WDEPRECATED(param_expr_site(node, 'c_name'),
                                'parameter c_name'))
         return name
@@ -178,7 +177,7 @@ def node_storage_type_dml12(node, site):
         else:
             return None
     elif node.objtype == 'implement':
-        if compat.dml12_misc in dml.globals.enabled_compat:
+        if not breaking_changes.dml12_remove_misc_quirks.enabled:
             typename = param_str(node, 'c_type')
             t = TNamed(typename)
             t.declaration_site = node.site
@@ -228,7 +227,7 @@ def conf_object(site, node, indices):
                            cref_portobj(node, indices[:node.dimensions]))
 
 def cloggroup(name):
-    if compat.dml12_misc in dml.globals.enabled_compat:
+    if not breaking_changes.dml12_remove_misc_quirks.enabled:
         return name
     else:
         return '_dml_loggroup_' + name