From 26296d7387ce01798076c7fa300a7acdde355136 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Mon, 21 Oct 2024 09:55:51 +0200 Subject: [PATCH 1/9] Include docs for compat and provisionals in 1.2 refman too The duplicated headers are unfortunate, and is there because one of them mentions "1.4" specifically. It's not a problem if we let the 1.2 versions rot. --- Makefile | 8 +++- doc/1.2/deprecations-header.md | 72 ++++++++++++++++++++++++++++++++++ doc/1.2/provisional-header.md | 29 ++++++++++++++ doc/1.2/toc.json | 6 +++ provisional_to_md.py | 9 +++-- py/dml/provisional.py | 2 + 6 files changed, 121 insertions(+), 5 deletions(-) create mode 100644 doc/1.2/deprecations-header.md create mode 100644 doc/1.2/provisional-header.md diff --git a/Makefile b/Makefile index 97192dfc2..2dd7bdc02 100644 --- a/Makefile +++ b/Makefile @@ -205,6 +205,10 @@ generated-md-1.2/grammar.md generated-md-1.4/grammar.md: generated-md-1.%/gramma $(PYTHON) $(SRC_BASE)/$(TARGET)/grammar_to_md.py $(PYTHONPATH) $< $@ generated-md-1.2/messages.md generated-md-1.4/messages.md: generated-md-%/messages.md: $(SRC_BASE)/$(TARGET)/messages_to_md.py $(DMLC_BIN) $(PYTHON) $< $(PYTHONPATH) $* $@ +generated-md-1.2/deprecations-auto.md: $(SRC_BASE)/$(TARGET)/deprecations_to_md.py $(SRC_BASE)/$(TARGET)/doc/1.2/deprecations-header.md $(DMLC_BIN) | generated-md-1.2 + $(PYTHON) $< $(PYTHONPATH) $(word 2,$^) $@ +generated-md-1.2/provisional-auto.md: $(SRC_BASE)/$(TARGET)/provisional_to_md.py $(SRC_BASE)/$(TARGET)/doc/1.2/provisional-header.md $(DMLC_BIN) | generated-md-1.2 + $(PYTHON) $< $(PYTHONPATH) $(word 2,$^) $@ 1.2 DOC_SRC_DIR_14 := $(SRC_BASE)/$(TARGET)/doc/1.4 DOC_FILES_14 := $(wildcard $(DOC_SRC_DIR_14)/*.md) $(DOC_SRC_DIR_14)/toc.json @@ -218,7 +222,7 @@ generated-md-1.4/changes-auto.md: $(SRC_BASE)/$(TARGET)/porting_to_md.py $(DMLC_ generated-md-1.4/deprecations-auto.md: $(SRC_BASE)/$(TARGET)/deprecations_to_md.py $(SRC_BASE)/$(TARGET)/doc/1.4/deprecations-header.md $(DMLC_BIN) | generated-md-1.4 $(PYTHON) $< $(PYTHONPATH) $(word 2,$^) $@ generated-md-1.4/provisional-auto.md: $(SRC_BASE)/$(TARGET)/provisional_to_md.py $(SRC_BASE)/$(TARGET)/doc/1.4/provisional-header.md $(DMLC_BIN) | generated-md-1.4 - $(PYTHON) $< $(PYTHONPATH) $(word 2,$^) $@ + $(PYTHON) $< $(PYTHONPATH) $(word 2,$^) $@ 1.4 generated-md-1.4/dml-builtins.md generated-md-1.4/utility.md: generated-md-1.4/%.md: $(DMLC_DIR)/lib/1.4/%.dml $(PYTHON) $(DMLC_DIR)/dmlcomments_to_md.py $< $@ @@ -236,7 +240,7 @@ DOC_FILES_12 := $(wildcard $(DOC_SRC_DIR_12)/*.md) $(DOC_SRC_DIR_12)/toc.json DOC_DEST_12 := $(SIMICS_PROJECT)/$(HOST_TYPE)/doc/html/dml-1.2-reference-manual DOC_MARKER_12 := $(DOC_DEST_12)/filelist.json -GENERATED_MD_FILES_12 = $(addprefix generated-md-1.2/,grammar.md messages.md) +GENERATED_MD_FILES_12 = $(addprefix generated-md-1.2/,grammar.md messages.md deprecations-auto.md provisional-auto.md) DOC_FILES_12 += $(GENERATED_MD_FILES_12) $(GENERATED_MD_FILES_12): | generated-md-1.2 $(DOC_MARKER_12): $(DOC_FILES_12) diff --git a/doc/1.2/deprecations-header.md b/doc/1.2/deprecations-header.md new file mode 100644 index 000000000..3c954bebb --- /dev/null +++ b/doc/1.2/deprecations-header.md @@ -0,0 +1,72 @@ + + +# Managing deprecated language features + +As the DML language evolves, we sometimes need to change the language in +incompatible ways, which requires DML users to migrate their code. This +appendix describes the mechanisms we provide to make this migration process +smooth for users with large DML code bases. + +In DML, deprecations can come in many forms. Deprecations in the form of +removed or renamed symbols in libraries are rather easy to manage, since they +give clear compile errors that often are straightforward to fix. A slightly +harder type of deprecation is when some language construct or API function +adjusts its semantics; this can make the model behave differently without +signalling error messages. A third kind of deprecation is when DML changes how +compiled models appear in Simics, typically to adjust changes in the Simics +API. Such changes add another dimension because they typically affect the +end-users of the DML models, rather than the authors of the models. Thus, as an +author of a model you may need to synchronize your migration of such features +with your end-users, to ease their transition to a new major version. + +## Deprecation mechanisms + +The simplest deprecation mechanism is Simics API versions: Each deprecated DML +feature is associated with a Simics API version, and each Simics version +supports a number of such API versions. Features reach end-of-life when moving +to a new Simics major version, the features belonging to a previous Simics API +version are dropped. Since Simics is currently the primary distribution channel +for DML, this deprecation scheme is used for DML features as well. + +This scheme allows users with a large code base to smoothly migrate from one +Simics major version, N, to the next, N+1: +* First, while still using version N, make sure all Simics modules are updated + to use API version N. Modules can be migrated one by one. +* Second, update the Simics version to N+1. This should normally have no + effect on DML, but may come with other challenges. +* Third, update modules to API N+1, one by one. Simics version N+1 will always + offers full support for API N, so there is no rush to update, but changing + the API version early makes sure deprecated features are not introduced in + new code. + +In addition to the API version, DML offers some compiler flags for selectively +disabling deprecated features that are normally part of the used API. This has +some uses, in particular: +* During migration to a new API version, disabling one deprecated feature at a + time can allow a smoother, more gradual, migration. +* If a legacy feature is still fully supported in the latest API version, then + it cannot be disabled by selecting an API version, so selectively disabling + it is the only way to turn it off. There are reasons to do this, e.g.: + * Disabling a feature before it is deprecated guarantees that it is not + relied upon in new code, which eases later migration. + * Avoiding a feature that has a newer replacement makes the code base + cleaner and more consistent. + * Some legacy features can also bloat models, by exposing features in a + redundant manner. This can also have a negative impact on performance. + +## Controlling deprecation on the DML command-line +DMLC provides a command-line flag `--api-version` to specify the API version to +be used for a model. When building with the standard Simics build system, this +is controlled by the `SIMICS_API_VERSION` variable in `make`, or the +`SIMICS_API`/`MODULE_SIMICS_API` variable in `CMake`. + +DMLC also provides the --no-compat=_tag_ flag, which disables the +feature represented by _`tag`_. The available tags are listed in the next +section. The tag also controls the name of a global boolean parameter that the +DML program may use to check whether the feature is available. The parameter's +name is the tag name preceded by `_compat_`. + +## List of deprecated features diff --git a/doc/1.2/provisional-header.md b/doc/1.2/provisional-header.md new file mode 100644 index 000000000..96f88067e --- /dev/null +++ b/doc/1.2/provisional-header.md @@ -0,0 +1,29 @@ + + +# Provisional language features + +Sometimes, we may choose to extend the DML compiler with a feature before it is +ready to be fully incorporated into the language. This can happen for different +reasons, e.g. if the design is not fully evaluated or if the feature is +backward incompatible. Currently, all provisional features are enabled on a +per-file basis, by adding provisional feature_name, +other_feature_name; just after the `dml 1.2;` statement. + +Provisional features can come in two flavours: + +* _Stable_ provisional features have a proven design and are + expected to remain pretty stable over time. Details in semantics may + still change between versions, but if we decide to make a + significant incompatible change to a supported provisional, then we + will create a second version of the provisional, under a new name, + and keep both versions in parallel for some time. It can make sense + to use supported provisional features in production code. + +* _Unstable_ provisional features are expected to undergo significant + incompatible changes over time, and are generally exposed to allow a + dedicated team of modelers to evaluate an early design. It can be used + to play around with, but should not be used in production code without + first communicating with the DML team. diff --git a/doc/1.2/toc.json b/doc/1.2/toc.json index c636a6ae8..dbc33ee4e 100644 --- a/doc/1.2/toc.json +++ b/doc/1.2/toc.json @@ -19,6 +19,12 @@ {"file": "messages.md", "numbering": true, "appendix": true}, + {"file": "provisional-auto.md", + "numbering": true, + "appendix": true}, + {"file": "deprecations-auto.md", + "numbering": true, + "appendix": true}, {"file": "grammar.md", "numbering": true, "appendix": true} diff --git a/provisional_to_md.py b/provisional_to_md.py index c74aa3f5f..e44784c09 100644 --- a/provisional_to_md.py +++ b/provisional_to_md.py @@ -3,17 +3,20 @@ import sys from pathlib import Path -[path_to_dml, header, outfile] = sys.argv[1:] +[path_to_dml, header, outfile, dml_version] = sys.argv[1:] sys.path.append(path_to_dml) +dml12_only = {'1.2': True, '1.4': False}[dml_version] from dml import provisional from dml.env import api_versions, default_api_version with open(outfile, 'w') as f: f.write(Path(header).read_text()) - stable = [feature for feature in provisional.features.values() + features = [feature for feature in provisional.features.values() + if not dml12_only or feature.dml12] + stable = [feature for feature in features if feature.stable] - unstable = [feature for feature in provisional.features.values() + unstable = [feature for feature in features if not feature.stable] for (heading, features) in [ ('List of stable provisional features', stable), diff --git a/py/dml/provisional.py b/py/dml/provisional.py index 06dc67889..e9dd017fb 100644 --- a/py/dml/provisional.py +++ b/py/dml/provisional.py @@ -18,6 +18,8 @@ def short(self) -> str: pass @abc.abstractproperty def stable(self) -> str: pass + # Whether the feature is included in 1.2 documentation + dml12 = False # tag -> feature features: dict[str, ProvisionalFeature] = {} From a4ee0d11610053fc8ff8ef6de68538e425669ada Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Mon, 21 Oct 2024 10:11:43 +0200 Subject: [PATCH 2/9] Allow provisional declarations in DML 1.2 --- py/dml/dmlparse.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/py/dml/dmlparse.py b/py/dml/dmlparse.py index a580ae743..66e870768 100644 --- a/py/dml/dmlparse.py +++ b/py/dml/dmlparse.py @@ -179,7 +179,7 @@ def top(t): t[0] = ast.dml(site(t), t[2], t[4]) -@prod_dml14 +@prod def maybe_provisional_yes(t): 'maybe_provisional : PROVISIONAL ident_list SEMI' t.parser.file_info.provisional = provisional.parse_provisional(t[2]) @@ -2241,22 +2241,22 @@ def statement_delay(t): f"expected time unit ({suggestions})") t[0] = ast.after(site(t), unit, t[2], t[5]) -@prod_dml14 +@prod def ident_list_empty(t): 'ident_list : ' t[0] = [] -@prod_dml14 +@prod def ident_list_nonempty(t): 'ident_list : nonempty_ident_list' t[0] = t[1] -@prod_dml14 +@prod def ident_list_one(t): 'nonempty_ident_list : ident' t[0] = [(site(t, 1), t[1])] -@prod_dml14 +@prod def ident_list_many(t): 'nonempty_ident_list : nonempty_ident_list COMMA ident' t[0] = t[1] + [(site(t, 3), t[3])] From f4f07b1e42dcd18c8229526cdfdfe43a1668db85 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Mon, 21 Oct 2024 10:13:12 +0200 Subject: [PATCH 3/9] Repair pickling of provisionals --- py/dml/logging.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/py/dml/logging.py b/py/dml/logging.py index 7f4f4edcc..da5fd9793 100644 --- a/py/dml/logging.py +++ b/py/dml/logging.py @@ -358,10 +358,14 @@ def set_name(self, name): def __getstate__(self): return (self.name, self.version, self.bitorder, self._line_offsets, - self.utf8_columns, self.provisional) + self.utf8_columns, {p.tag(): site + for (p, site) in self.provisional.items()}) def __setstate__(self, data): + from . import provisional (self.name, self.version, self.bitorder, self._line_offsets, - self.utf8_columns, self.provisional) = data + self.utf8_columns, provisionals) = data + self.provisional = {provisional.features[tag]: site + for (tag, site) in provisionals.items()} def loc_from_offset(self, offset): '''Calculate a file location as a (line, col) pair''' line = bisect.bisect_right(self._line_offsets, offset) - 1 From e0ff61b28dd6f6611f96455aa310715d5aa14001 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Fri, 18 Oct 2024 14:46:52 +0200 Subject: [PATCH 4/9] Create provisional and compat features around the `vect` type --- RELEASENOTES.md | 8 +++ lib/1.2/dml-builtins.dml | 2 + lib/1.4/dml-builtins.dml | 2 + py/dml/compat.py | 18 +++++ py/dml/dmlparse.py | 21 +++--- py/dml/messages.py | 6 ++ py/dml/provisional.py | 66 +++++++++++++++++++ test/1.2/errors/T_ECVECT.dml | 19 ++++++ .../T_c_vect_without_provisional_disabled.dml | 13 ++++ .../T_c_vect_without_provisional_enabled.dml} | 9 +-- test/1.4/provisional/T_c_vect.dml | 18 +++++ 11 files changed, 168 insertions(+), 14 deletions(-) create mode 100644 test/1.2/errors/T_ECVECT.dml create mode 100644 test/1.4/legacy/T_c_vect_without_provisional_disabled.dml rename test/1.4/{errors/T_WEXPERIMENTAL.dml => legacy/T_c_vect_without_provisional_enabled.dml} (58%) create mode 100644 test/1.4/provisional/T_c_vect.dml diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 8314c0082..60638e8c8 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -196,3 +196,11 @@ various operations that rely on the `register_view` interface, such as the `dev_util.bank_regs` function and the `write-device-reg` and `probe-address` CLI commands. +- `note 6` A new provisional feature `c_vect` has been added. When `provisional + c_vect;` appears in the top of a DML file, DMLC will no longer print warnings + when the `vect` syntax is used in that file. +- `note 6` A new compatibility feature `c_vect_without_provisional` has been + created. In files without a `provisional c_vect;` declaration, the `vect` + syntax is only permitted when this feature is enabled. his feature will be + disabled in Simics API versions \> 7, where all uses of `vect` instead require + explicit `provisional` declarations. diff --git a/lib/1.2/dml-builtins.dml b/lib/1.2/dml-builtins.dml index 9838cdf08..dcdefd312 100644 --- a/lib/1.2/dml-builtins.dml +++ b/lib/1.2/dml-builtins.dml @@ -5,6 +5,7 @@ dml 1.2; +provisional c_vect; bitorder le; loggroup Register_Read; @@ -222,6 +223,7 @@ template device { parameter _compat_dml12_goto auto; parameter _compat_dml12_misc auto; parameter _compat_dml12_int auto; + parameter _compat_c_vect_without_provisional auto; // automatic parameters parameter obj auto; diff --git a/lib/1.4/dml-builtins.dml b/lib/1.4/dml-builtins.dml index f18c02a2b..50dfc1821 100644 --- a/lib/1.4/dml-builtins.dml +++ b/lib/1.4/dml-builtins.dml @@ -5,6 +5,7 @@ dml 1.4; +provisional c_vect; bitorder le; loggroup Register_Read; @@ -624,6 +625,7 @@ template device { param _compat_dml12_goto auto; param _compat_dml12_misc auto; param _compat_dml12_int auto; + param _compat_c_vect_without_provisional auto; // automatic parameters param obj auto; diff --git a/py/dml/compat.py b/py/dml/compat.py index c4eb7b7a1..a0258b424 100644 --- a/py/dml/compat.py +++ b/py/dml/compat.py @@ -374,3 +374,21 @@ class dml12_int(CompatFeature): ''' short = "Use legacy integer semantics in DML 1.2" last_api_version = api_6 + + +@feature +class c_vect_without_provisional(CompatFeature): + ''' This compat feature + controls how DMLC reacts to uses of the `vect` syntax in files + where the [`c_vect` provisional feature](provisional-auto.html#c_vect) + is not enabled. + + When the `c_vect_without_provisional` compatibility feature is + enabled, such uses are permitted, and give a `WEXPERIMENTAL` + warning in DML 1.4 (but no warning in DML 1.2). When + `c_vect_without_provisional` is disabled, DMLC forbids the `vect` + syntax. + + ''' + short = "Permit vect syntax without 'provisional c_vect'" + last_api_version = api_7 diff --git a/py/dml/dmlparse.py b/py/dml/dmlparse.py index 66e870768..63dcea610 100644 --- a/py/dml/dmlparse.py +++ b/py/dml/dmlparse.py @@ -13,6 +13,7 @@ from . import dmllex12 from . import dmllex14 from . import provisional +from . import compat assert lex.__version__ == yacc.__version__ == "3.4" @@ -1327,18 +1328,18 @@ def cdecl2_ptr(t): 'cdecl2 : TIMES cdecl2' t[0] = ['pointer'] + t[2] -@prod_dml14 -def cdecl2_vect(t): - 'cdecl2 : VECT cdecl2' - # vect is actually experimental in 1.2 as well, but we will probably - # defensively keep it the way it is, because it's used a lot. - # TODO: improve how vect works in 1.4, and make it public (US325) - report(WEXPERIMENTAL(site(t), 'vect types')) - t[0] = ['vect'] + t[2] - -@prod_dml12 +@prod def cdecl2_vect(t): 'cdecl2 : VECT cdecl2' + if provisional.c_vect not in t.parser.file_info.provisional: + if compat.c_vect_without_provisional in dml.globals.enabled_compat: + vsite = site(t) + if vsite.dml_version() != (1, 2): + # defensively suppress warning in 1.2, for + # compatibility + report(WEXPERIMENTAL(site(t), 'vect types')) + else: + report(ECVECT(site(t))) t[0] = ['vect'] + t[2] @prod_dml12 diff --git a/py/dml/messages.py b/py/dml/messages.py index e4dc00006..73fd6718d 100644 --- a/py/dml/messages.py +++ b/py/dml/messages.py @@ -1891,6 +1891,12 @@ def log(self): "conflicting declaration, which specifies the type: " + self.other_type.describe()) + +class ECVECT(DMLError): + """`vect` types are only permitted if the [`c_vect` provisional + feature](provisional-auto.html#c_vect) is enabled.""" + fmt = "declaration of vect type without c_vect provisional" + # # WARNINGS (keep these as few as possible) # diff --git a/py/dml/provisional.py b/py/dml/provisional.py index e9dd017fb..17c9ef0c5 100644 --- a/py/dml/provisional.py +++ b/py/dml/provisional.py @@ -73,6 +73,72 @@ class explicit_param_decls(ProvisionalFeature): short = "Require := syntax for defining new params" stable = True + +@feature +class c_vect(ProvisionalFeature): + ''' + This feature enables the `vect` type, based on the + `VECT` macro from the Simics C API (`simics/util/vect.h`). + + This is a simple wrapping that behaves inconsistently in many + ways, and we plan to eventually introduce a cleaner mechanism for + vectors; the `c_vect` is supported as an interim solution until we + have that in place. + + The syntax is `BASETYPE vect`, e.g. `typedef int vect int_vect_t;` + to define a type for vectors of the `int` type. + + Some caveats: + + * `vect` types typically need to be `typedef`:ed before they are + used. This is because `int vect` is blindly expanded into + `VECT(int)` in C, which in turn expands into a `struct` + definition, meaning that saying `VECT(int)` twice yields two + incompatible types. This means, for instance, that `typeof` in + DML doesn't work properly for `vect` types unless `typedef`:ed + + * Importing `"internal.dml"` exposes various C macros from + `vect.h` to DML: `VINIT`, `VELEMSIZE`, `VRESIZE`, + `VRESIZE_FREE`, `VADD`, `VREMOVE`, `VDELETE_ORDER`, `VINSERT`, + `VSETLAST`, `VLEN`, `VVEC`, `VGROW`, `VSHRINK`, `VFREE`, + `VTRUNCATE`, `VCLEAR`, and `VCOPY`. + + * DML natively supports indexing syntax, which is translated to + `VGET`. For instance: + ``` + typedef int vect int_vect_t; + method first_element(int_vect_t v) -> (int) { + assert VLEN(v) > 0; + return v[0]; + } + ``` + + * DML natively supports `vect` types in `foreach` statements. + The loop variable must be declared outside the loop, and + must be a pointer to the vector's base type. For instance: + ``` + typedef int vect int_vect_t; + method sum(int_vect_t v) -> (int) { + local int *i; + local int ret = 0; + foreach i in (v) { + ret += *i; + } + return ret; + } + ``` + + Enabling the `c_vect` feature in a file only affects + the `vect` declarations in that file. + + When the `c_vect` feature is disabled, usage of `vect` is an + error unless the [`c_vect_without_provisional` compatibility + feature](deprecations-auto.html#c_vect_without_provisional) is enabled. + ''' + short = "Allow vect syntax based on the VECT macro" + stable = True + dml12 = True + def parse_provisional( provs: list[("Site", str)]) -> dict[ProvisionalFeature, "Site"]: ret = {} diff --git a/test/1.2/errors/T_ECVECT.dml b/test/1.2/errors/T_ECVECT.dml new file mode 100644 index 000000000..7394193e9 --- /dev/null +++ b/test/1.2/errors/T_ECVECT.dml @@ -0,0 +1,19 @@ +/* + © 2024 Intel Corporation + SPDX-License-Identifier: MPL-2.0 +*/ +dml 1.2; + +device test; + +/// COMPILE-ONLY + +// c_vect_without_provisional compat feature enabled +/// DMLC-FLAG --simics-api=7 + +// No complaint, even though the c_vect provisional is not enabled. +// This gives a warning in DML 1.4, see +// 1.4/legacy/c_vect_without_provisional_enabled, +// and an ECVECT with c_vect_without_provisional disabled, +// see 1.4/legacy/c_vect_without_provisional_disabled. +typedef int vect int_vect_t; diff --git a/test/1.4/legacy/T_c_vect_without_provisional_disabled.dml b/test/1.4/legacy/T_c_vect_without_provisional_disabled.dml new file mode 100644 index 000000000..382c8dddc --- /dev/null +++ b/test/1.4/legacy/T_c_vect_without_provisional_disabled.dml @@ -0,0 +1,13 @@ +/* + © 2024 Intel Corporation + SPDX-License-Identifier: MPL-2.0 +*/ + +dml 1.4; + +device test; + +/// DMLC-FLAG --simics-api=7 +/// DMLC-FLAG --no-compat=c_vect_without_provisional +/// ERROR ECVECT +typedef int vect x; diff --git a/test/1.4/errors/T_WEXPERIMENTAL.dml b/test/1.4/legacy/T_c_vect_without_provisional_enabled.dml similarity index 58% rename from test/1.4/errors/T_WEXPERIMENTAL.dml rename to test/1.4/legacy/T_c_vect_without_provisional_enabled.dml index 8e5cdf69d..c7df070d3 100644 --- a/test/1.4/errors/T_WEXPERIMENTAL.dml +++ b/test/1.4/legacy/T_c_vect_without_provisional_enabled.dml @@ -1,12 +1,13 @@ /* - © 2021 Intel Corporation + © 2024 Intel Corporation SPDX-License-Identifier: MPL-2.0 */ -dml 1.4; -/// COMPILE-ONLY +dml 1.4; device test; +/// COMPILE-ONLY +/// DMLC-FLAG --simics-api=7 /// WARNING WEXPERIMENTAL -session int vect x; +typedef int vect x; diff --git a/test/1.4/provisional/T_c_vect.dml b/test/1.4/provisional/T_c_vect.dml new file mode 100644 index 000000000..15ce3fbaf --- /dev/null +++ b/test/1.4/provisional/T_c_vect.dml @@ -0,0 +1,18 @@ +/* + © 2024 Intel Corporation + SPDX-License-Identifier: MPL-2.0 +*/ + +dml 1.4; + +provisional c_vect; + +device test; + +/// COMPILE-ONLY + +// Error reporting tested by 1.4/legacy/c_vect_without_provisional_*.dml + +/// DMLC-FLAG --no-compat=c_vect_without_provisional +// no warning +typedef int vect x; From 5af18dc163b7b04c46426868cbd7d7a719d3f475 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Mon, 21 Oct 2024 11:18:37 +0200 Subject: [PATCH 5/9] Dogfood the c_vect provisional --- test/1.2/errors/T_EIDENT.dml | 2 ++ test/1.2/errors/T_ETREC.dml | 2 ++ test/1.2/errors/T_strict.dml | 1 + test/1.2/internal/T_vect.dml | 1 + test/1.2/internal/T_vect_select.dml | 1 + test/1.2/statements/T_if_ambiguity.dml | 1 + test/1.4/errors/T_ECAST.dml | 3 +-- test/1.4/errors/T_EEXTERNINCOMP.dml | 3 +-- test/1.4/errors/T_ESERIALIZE.dml | 2 +- test/1.4/errors/T_EVOID.dml | 5 ++--- 10 files changed, 13 insertions(+), 8 deletions(-) diff --git a/test/1.2/errors/T_EIDENT.dml b/test/1.2/errors/T_EIDENT.dml index 86bec8c39..d6d0ba6c9 100644 --- a/test/1.2/errors/T_EIDENT.dml +++ b/test/1.2/errors/T_EIDENT.dml @@ -3,6 +3,8 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; + device test; port p { diff --git a/test/1.2/errors/T_ETREC.dml b/test/1.2/errors/T_ETREC.dml index e2becdc7f..b77fac156 100644 --- a/test/1.2/errors/T_ETREC.dml +++ b/test/1.2/errors/T_ETREC.dml @@ -3,6 +3,8 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; + device test; import "testing.dml"; diff --git a/test/1.2/errors/T_strict.dml b/test/1.2/errors/T_strict.dml index 311e6d191..7b0ba9773 100644 --- a/test/1.2/errors/T_strict.dml +++ b/test/1.2/errors/T_strict.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; /* */ diff --git a/test/1.2/internal/T_vect.dml b/test/1.2/internal/T_vect.dml index 8a2395ac5..44b5c33ad 100644 --- a/test/1.2/internal/T_vect.dml +++ b/test/1.2/internal/T_vect.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; device test; diff --git a/test/1.2/internal/T_vect_select.dml b/test/1.2/internal/T_vect_select.dml index 600c09eaa..7af737c07 100644 --- a/test/1.2/internal/T_vect_select.dml +++ b/test/1.2/internal/T_vect_select.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; device test; diff --git a/test/1.2/statements/T_if_ambiguity.dml b/test/1.2/statements/T_if_ambiguity.dml index 63beadb40..cdc2f86a2 100644 --- a/test/1.2/statements/T_if_ambiguity.dml +++ b/test/1.2/statements/T_if_ambiguity.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; +provisional c_vect; device test; diff --git a/test/1.4/errors/T_ECAST.dml b/test/1.4/errors/T_ECAST.dml index 15eb6f762..ac84107e7 100644 --- a/test/1.4/errors/T_ECAST.dml +++ b/test/1.4/errors/T_ECAST.dml @@ -3,14 +3,13 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; +provisional c_vect; device test; typedef struct { uint32 x; } s_t; typedef layout "little-endian" { uint32 x; } l_t; -/// WARNING WEXPERIMENTAL typedef int vect v_t; -/// WARNING WEXPERIMENTAL typedef int vect alt_v_t; typedef int a_t[1]; typedef void f_t(void); diff --git a/test/1.4/errors/T_EEXTERNINCOMP.dml b/test/1.4/errors/T_EEXTERNINCOMP.dml index 18cf295cd..eb0654173 100644 --- a/test/1.4/errors/T_EEXTERNINCOMP.dml +++ b/test/1.4/errors/T_EEXTERNINCOMP.dml @@ -3,11 +3,10 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; +provisional c_vect; device test; -/// WARNING WEXPERIMENTAL T_EEXTERNINCOMP.dml - typedef int vect int_vect_t; typedef object object_t; diff --git a/test/1.4/errors/T_ESERIALIZE.dml b/test/1.4/errors/T_ESERIALIZE.dml index e622e28e5..514a6c2cb 100644 --- a/test/1.4/errors/T_ESERIALIZE.dml +++ b/test/1.4/errors/T_ESERIALIZE.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; +provisional c_vect; device test; @@ -34,7 +35,6 @@ typedef void (*f)(); saved f f_ptr; // TODO: vectors should be serializable -/// WARNING WEXPERIMENTAL typedef int vect int_vect; /// ERROR ESERIALIZE saved int_vect x; diff --git a/test/1.4/errors/T_EVOID.dml b/test/1.4/errors/T_EVOID.dml index afb3ed2d4..fd6c167c4 100644 --- a/test/1.4/errors/T_EVOID.dml +++ b/test/1.4/errors/T_EVOID.dml @@ -3,6 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; +provisional c_vect; device test; @@ -34,9 +35,7 @@ typedef void void_t; extern typedef const void ext_void_t; /// ERROR EVOID -session void -/// WARNING WEXPERIMENTAL - vect v; +session void vect v; // this is allowed in 1.2, and even used by dml-builtins, unclear why /// ERROR EVOID From 4692105334e6fd92f61a5df7aa8570ee7a4031c3 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Tue, 22 Oct 2024 11:17:15 +0200 Subject: [PATCH 6/9] Deprecate the _warning statement --- RELEASENOTES.md | 3 +++ dmlast.py | 3 +++ lib/1.2/dml-builtins.dml | 1 + lib/1.2/utility.dml | 14 +++++++++++--- lib/1.4/dml-builtins.dml | 1 + py/dml/compat.py | 9 +++++++++ py/dml/dmlparse.py | 2 ++ test/1.4/legacy/T_warning_statement_disabled.dml | 14 ++++++++++++++ test/1.4/legacy/T_warning_statement_enabled.dml | 15 +++++++++++++++ test/tests.py | 1 + 10 files changed, 60 insertions(+), 3 deletions(-) create mode 100644 test/1.4/legacy/T_warning_statement_disabled.dml create mode 100644 test/1.4/legacy/T_warning_statement_enabled.dml diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 60638e8c8..b2d4bff15 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -204,3 +204,6 @@ syntax is only permitted when this feature is enabled. his feature will be disabled in Simics API versions \> 7, where all uses of `vect` instead require explicit `provisional` declarations. +- `note 6` The rarely used `_warning` statement has been deprecated, through + the introduction of a new compatibility feature `warning_statement`. + Warning statements will be illegal when Simics API 8 or newer is used. diff --git a/dmlast.py b/dmlast.py index a0faa97d3..dc765286a 100644 --- a/dmlast.py +++ b/dmlast.py @@ -8,8 +8,11 @@ def create_dmlasts(dmlc_path, dmlast_path, dml_path, depfile): sys.path.append(str(dmlc_path)) from dml.toplevel import produce_dmlast from dml.logging import ignore_warning + import dml.globals + from dml import compat ignore_warning('WEXPERIMENTAL') + dml.globals.enabled_compat.add(compat.warning_statement) dml_files_abs = list(dml_path.rglob('*.dml')) dml_files = [p.relative_to(dml_path) for p in dml_files_abs] assert dml_files diff --git a/lib/1.2/dml-builtins.dml b/lib/1.2/dml-builtins.dml index dcdefd312..e42a4d700 100644 --- a/lib/1.2/dml-builtins.dml +++ b/lib/1.2/dml-builtins.dml @@ -224,6 +224,7 @@ template device { parameter _compat_dml12_misc auto; parameter _compat_dml12_int auto; parameter _compat_c_vect_without_provisional auto; + parameter _compat_warning_statement auto; // automatic parameters parameter obj auto; diff --git a/lib/1.2/utility.dml b/lib/1.2/utility.dml index dd9f33842..bea077d3e 100644 --- a/lib/1.2/utility.dml +++ b/lib/1.2/utility.dml @@ -169,9 +169,12 @@ template write_only { log spec_viol, log_level, Register_Read: "Read from write-only register %s (returning 0).", $qname; log_level = 2; - } else { + } else if ($dev._compat_warning_statement) { _warning "The write_only template only makes sense on registers." + " For fields, use read_zero instead."; + } else { + error "The write_only template only makes sense on registers." + + " For fields, use read_zero instead."; } value = 0; } @@ -541,8 +544,13 @@ template _unimpl_base_write_warn { } $this = value; if (defined ($reg.limitations) - && $reg.limitations == "Not implemented.") - _warning "unimplemented template used in both field and register"; + && $reg.limitations == "Not implemented.") { + if ($dev._compat_warning_statement) { + _warning "unimplemented template used in both field and register"; + } else { + error "unimplemented template used in both field and register"; + } + } } } } diff --git a/lib/1.4/dml-builtins.dml b/lib/1.4/dml-builtins.dml index 50dfc1821..9cb2e593e 100644 --- a/lib/1.4/dml-builtins.dml +++ b/lib/1.4/dml-builtins.dml @@ -626,6 +626,7 @@ template device { param _compat_dml12_misc auto; param _compat_dml12_int auto; param _compat_c_vect_without_provisional auto; + param _compat_warning_statement auto; // automatic parameters param obj auto; diff --git a/py/dml/compat.py b/py/dml/compat.py index a0258b424..63815e950 100644 --- a/py/dml/compat.py +++ b/py/dml/compat.py @@ -392,3 +392,12 @@ class c_vect_without_provisional(CompatFeature): ''' short = "Permit vect syntax without 'provisional c_vect'" last_api_version = api_7 + + +@feature +class warning_statement(CompatFeature): + '''This compatibility feature enables the `_warning` statement. + This turned out to not be very useful, so in Simics API 8 and + newer the feature is no longer allowed.''' + short = "Allow the `_warning` statement" + last_api_version = api_7 diff --git a/py/dml/dmlparse.py b/py/dml/dmlparse.py index 63dcea610..2d8c45c07 100644 --- a/py/dml/dmlparse.py +++ b/py/dml/dmlparse.py @@ -2498,6 +2498,8 @@ def warning_statement(t): @prod def warning_stmt(t): 'warning_stmt : _WARNING bracketed_string_literal SEMI' + if compat.warning_statement not in dml.globals.enabled_compat: + raise ESYNTAX(site(t), '_warning', 'deprecated _warning statement') report(WEXPERIMENTAL(site(t), "_warning statement")) t[0] = ast.warning(site(t), t[2]) diff --git a/test/1.4/legacy/T_warning_statement_disabled.dml b/test/1.4/legacy/T_warning_statement_disabled.dml new file mode 100644 index 000000000..9599581e7 --- /dev/null +++ b/test/1.4/legacy/T_warning_statement_disabled.dml @@ -0,0 +1,14 @@ +/* + © 2024 Intel Corporation + SPDX-License-Identifier: MPL-2.0 +*/ +dml 1.4; +device test; + +/// DMLC-FLAG --simics-api=7 +/// DMLC-FLAG --no-compat=warning_statement + +method m() { + /// ERROR ESYNTAX + _warning "foo"; +} diff --git a/test/1.4/legacy/T_warning_statement_enabled.dml b/test/1.4/legacy/T_warning_statement_enabled.dml new file mode 100644 index 000000000..7b89132ea --- /dev/null +++ b/test/1.4/legacy/T_warning_statement_enabled.dml @@ -0,0 +1,15 @@ +/* + © 2024 Intel Corporation + SPDX-License-Identifier: MPL-2.0 +*/ +dml 1.4; +device test; + +/// COMPILE-ONLY +/// DMLC-FLAG --simics-api=7 + +method m() { + // method is dead, so no WWRNSTMT + /// WARNING WEXPERIMENTAL + _warning "foo"; +} diff --git a/test/tests.py b/test/tests.py index caa3a3e4d..90f58d43a 100644 --- a/test/tests.py +++ b/test/tests.py @@ -1452,6 +1452,7 @@ def test(self): ('utility.dml', None, 'PRENAME_TEMPLATE'), ('utility.dml', None, 'PABSTRACT_TEMPLATE'), ('utility.dml', None, 'PHASH'), + ('utility.dml', None, 'PHASHELSE'), ('utility.dml', None, 'PIFAND'), ('utility.dml', None, 'PANDOR'), ('utility.dml', None, 'PCHANGE_INARGS'), From 015229f5ce4f2a26d88e5b7b4a93232d300fa6ae Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Tue, 22 Oct 2024 12:51:02 +0200 Subject: [PATCH 7/9] Rename c_vect -> simics_util_vect On popular demand. Also, rename ECVECT -> EOLDVECT and c_vect_without_provisional -> experimental_vect --- RELEASENOTES.md | 10 +++++----- ...isabled.dml => T_experimental_vect_disabled.dml | 4 ++-- ..._enabled.dml => T_experimental_vect_enabled.dml | 0 lib/1.2/dml-builtins.dml | 4 ++-- lib/1.4/dml-builtins.dml | 4 ++-- py/dml/compat.py | 12 ++++++------ py/dml/dmlparse.py | 6 +++--- py/dml/messages.py | 8 ++++---- py/dml/provisional.py | 14 +++++++------- test/1.2/errors/T_EIDENT.dml | 2 +- test/1.2/errors/{T_ECVECT.dml => T_EOLDVECT.dml} | 2 +- test/1.2/errors/T_ETREC.dml | 2 +- test/1.2/errors/T_strict.dml | 2 +- test/1.2/internal/T_vect.dml | 2 +- test/1.2/internal/T_vect_select.dml | 2 +- test/1.2/statements/T_if_ambiguity.dml | 2 +- test/1.4/errors/T_ECAST.dml | 2 +- test/1.4/errors/T_EEXTERNINCOMP.dml | 2 +- test/1.4/errors/T_ESERIALIZE.dml | 2 +- test/1.4/errors/T_EVOID.dml | 2 +- .../{T_c_vect.dml => T_simics_util_vect.dml} | 6 +++--- 21 files changed, 45 insertions(+), 45 deletions(-) rename test/1.4/legacy/T_c_vect_without_provisional_disabled.dml => T_experimental_vect_disabled.dml (67%) rename test/1.4/legacy/T_c_vect_without_provisional_enabled.dml => T_experimental_vect_enabled.dml (100%) rename test/1.2/errors/{T_ECVECT.dml => T_EOLDVECT.dml} (87%) rename test/1.4/provisional/{T_c_vect.dml => T_simics_util_vect.dml} (50%) diff --git a/RELEASENOTES.md b/RELEASENOTES.md index b2d4bff15..a0a27dcd2 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -196,11 +196,11 @@ various operations that rely on the `register_view` interface, such as the `dev_util.bank_regs` function and the `write-device-reg` and `probe-address` CLI commands. -- `note 6` A new provisional feature `c_vect` has been added. When `provisional - c_vect;` appears in the top of a DML file, DMLC will no longer print warnings - when the `vect` syntax is used in that file. -- `note 6` A new compatibility feature `c_vect_without_provisional` has been - created. In files without a `provisional c_vect;` declaration, the `vect` +- `note 6` A new provisional feature `simics_util_vect` has been added. When + `provisional simics_util_vect;` appears in the top of a DML file, DMLC will + no longer print warnings when the `vect` syntax is used in that file. +- `note 6` A new compatibility feature `simics_util_vect_without_provisional` has been + created. In files without a `provisional simics_util_vect;` declaration, the `vect` syntax is only permitted when this feature is enabled. his feature will be disabled in Simics API versions \> 7, where all uses of `vect` instead require explicit `provisional` declarations. diff --git a/test/1.4/legacy/T_c_vect_without_provisional_disabled.dml b/T_experimental_vect_disabled.dml similarity index 67% rename from test/1.4/legacy/T_c_vect_without_provisional_disabled.dml rename to T_experimental_vect_disabled.dml index 382c8dddc..789763e44 100644 --- a/test/1.4/legacy/T_c_vect_without_provisional_disabled.dml +++ b/T_experimental_vect_disabled.dml @@ -8,6 +8,6 @@ dml 1.4; device test; /// DMLC-FLAG --simics-api=7 -/// DMLC-FLAG --no-compat=c_vect_without_provisional -/// ERROR ECVECT +/// DMLC-FLAG --no-compat=experimental_vect +/// ERROR EOLDVECT typedef int vect x; diff --git a/test/1.4/legacy/T_c_vect_without_provisional_enabled.dml b/T_experimental_vect_enabled.dml similarity index 100% rename from test/1.4/legacy/T_c_vect_without_provisional_enabled.dml rename to T_experimental_vect_enabled.dml diff --git a/lib/1.2/dml-builtins.dml b/lib/1.2/dml-builtins.dml index e42a4d700..07e2b95cb 100644 --- a/lib/1.2/dml-builtins.dml +++ b/lib/1.2/dml-builtins.dml @@ -5,7 +5,7 @@ dml 1.2; -provisional c_vect; +provisional simics_util_vect; bitorder le; loggroup Register_Read; @@ -223,7 +223,7 @@ template device { parameter _compat_dml12_goto auto; parameter _compat_dml12_misc auto; parameter _compat_dml12_int auto; - parameter _compat_c_vect_without_provisional auto; + parameter _compat_experimental_vect auto; parameter _compat_warning_statement auto; // automatic parameters diff --git a/lib/1.4/dml-builtins.dml b/lib/1.4/dml-builtins.dml index 9cb2e593e..a6caac2e3 100644 --- a/lib/1.4/dml-builtins.dml +++ b/lib/1.4/dml-builtins.dml @@ -5,7 +5,7 @@ dml 1.4; -provisional c_vect; +provisional simics_util_vect; bitorder le; loggroup Register_Read; @@ -625,7 +625,7 @@ template device { param _compat_dml12_goto auto; param _compat_dml12_misc auto; param _compat_dml12_int auto; - param _compat_c_vect_without_provisional auto; + param _compat_experimental_vect auto; param _compat_warning_statement auto; // automatic parameters diff --git a/py/dml/compat.py b/py/dml/compat.py index 63815e950..a7844b81b 100644 --- a/py/dml/compat.py +++ b/py/dml/compat.py @@ -377,20 +377,20 @@ class dml12_int(CompatFeature): @feature -class c_vect_without_provisional(CompatFeature): - ''' This compat feature +class experimental_vect(CompatFeature): + ''' This compat feature controls how DMLC reacts to uses of the `vect` syntax in files - where the [`c_vect` provisional feature](provisional-auto.html#c_vect) + where the [`simics_util_vect` provisional feature](provisional-auto.html#simics_util_vect) is not enabled. - When the `c_vect_without_provisional` compatibility feature is + When the `experimental_vect` compatibility feature is enabled, such uses are permitted, and give a `WEXPERIMENTAL` warning in DML 1.4 (but no warning in DML 1.2). When - `c_vect_without_provisional` is disabled, DMLC forbids the `vect` + `experimental_vect` is disabled, DMLC forbids the `vect` syntax. ''' - short = "Permit vect syntax without 'provisional c_vect'" + short = "Permit vect syntax without 'provisional simics_util_vect'" last_api_version = api_7 diff --git a/py/dml/dmlparse.py b/py/dml/dmlparse.py index 2d8c45c07..c1814cea3 100644 --- a/py/dml/dmlparse.py +++ b/py/dml/dmlparse.py @@ -1331,15 +1331,15 @@ def cdecl2_ptr(t): @prod def cdecl2_vect(t): 'cdecl2 : VECT cdecl2' - if provisional.c_vect not in t.parser.file_info.provisional: - if compat.c_vect_without_provisional in dml.globals.enabled_compat: + if provisional.simics_util_vect not in t.parser.file_info.provisional: + if compat.experimental_vect in dml.globals.enabled_compat: vsite = site(t) if vsite.dml_version() != (1, 2): # defensively suppress warning in 1.2, for # compatibility report(WEXPERIMENTAL(site(t), 'vect types')) else: - report(ECVECT(site(t))) + report(EOLDVECT(site(t))) t[0] = ['vect'] + t[2] @prod_dml12 diff --git a/py/dml/messages.py b/py/dml/messages.py index 73fd6718d..c8d87fafc 100644 --- a/py/dml/messages.py +++ b/py/dml/messages.py @@ -1892,10 +1892,10 @@ def log(self): + self.other_type.describe()) -class ECVECT(DMLError): - """`vect` types are only permitted if the [`c_vect` provisional - feature](provisional-auto.html#c_vect) is enabled.""" - fmt = "declaration of vect type without c_vect provisional" +class EOLDVECT(DMLError): + """`vect` types are only permitted if the [`simics_util_vect` provisional + feature](provisional-auto.html#simics_util_vect) is enabled.""" + fmt = "declaration of vect type without simics_util_vect provisional" # # WARNINGS (keep these as few as possible) diff --git a/py/dml/provisional.py b/py/dml/provisional.py index 17c9ef0c5..038631de2 100644 --- a/py/dml/provisional.py +++ b/py/dml/provisional.py @@ -75,14 +75,14 @@ class explicit_param_decls(ProvisionalFeature): @feature -class c_vect(ProvisionalFeature): - ''' +class simics_util_vect(ProvisionalFeature): + ''' This feature enables the `vect` type, based on the `VECT` macro from the Simics C API (`simics/util/vect.h`). This is a simple wrapping that behaves inconsistently in many ways, and we plan to eventually introduce a cleaner mechanism for - vectors; the `c_vect` is supported as an interim solution until we + vectors; the `simics_util_vect` is supported as an interim solution until we have that in place. The syntax is `BASETYPE vect`, e.g. `typedef int vect int_vect_t;` @@ -128,12 +128,12 @@ class c_vect(ProvisionalFeature): } ``` - Enabling the `c_vect` feature in a file only affects + Enabling the `simics_util_vect` feature in a file only affects the `vect` declarations in that file. - When the `c_vect` feature is disabled, usage of `vect` is an - error unless the [`c_vect_without_provisional` compatibility - feature](deprecations-auto.html#c_vect_without_provisional) is enabled. + When the `simics_util_vect` feature is disabled, usage of `vect` is an + error unless the [`experimental_vect` compatibility + feature](deprecations-auto.html#experimental_vect) is enabled. ''' short = "Allow vect syntax based on the VECT macro" stable = True diff --git a/test/1.2/errors/T_EIDENT.dml b/test/1.2/errors/T_EIDENT.dml index d6d0ba6c9..eb27eee0b 100644 --- a/test/1.2/errors/T_EIDENT.dml +++ b/test/1.2/errors/T_EIDENT.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.2/errors/T_ECVECT.dml b/test/1.2/errors/T_EOLDVECT.dml similarity index 87% rename from test/1.2/errors/T_ECVECT.dml rename to test/1.2/errors/T_EOLDVECT.dml index 7394193e9..b399cf4cb 100644 --- a/test/1.2/errors/T_ECVECT.dml +++ b/test/1.2/errors/T_EOLDVECT.dml @@ -14,6 +14,6 @@ device test; // No complaint, even though the c_vect provisional is not enabled. // This gives a warning in DML 1.4, see // 1.4/legacy/c_vect_without_provisional_enabled, -// and an ECVECT with c_vect_without_provisional disabled, +// and an EOLDVECT with c_vect_without_provisional disabled, // see 1.4/legacy/c_vect_without_provisional_disabled. typedef int vect int_vect_t; diff --git a/test/1.2/errors/T_ETREC.dml b/test/1.2/errors/T_ETREC.dml index b77fac156..8dd55463f 100644 --- a/test/1.2/errors/T_ETREC.dml +++ b/test/1.2/errors/T_ETREC.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; device test; import "testing.dml"; diff --git a/test/1.2/errors/T_strict.dml b/test/1.2/errors/T_strict.dml index 7b0ba9773..5a720aee4 100644 --- a/test/1.2/errors/T_strict.dml +++ b/test/1.2/errors/T_strict.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; /* */ diff --git a/test/1.2/internal/T_vect.dml b/test/1.2/internal/T_vect.dml index 44b5c33ad..6eb86af54 100644 --- a/test/1.2/internal/T_vect.dml +++ b/test/1.2/internal/T_vect.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.2/internal/T_vect_select.dml b/test/1.2/internal/T_vect_select.dml index 7af737c07..af7e05672 100644 --- a/test/1.2/internal/T_vect_select.dml +++ b/test/1.2/internal/T_vect_select.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.2/statements/T_if_ambiguity.dml b/test/1.2/statements/T_if_ambiguity.dml index cdc2f86a2..f2b357c3b 100644 --- a/test/1.2/statements/T_if_ambiguity.dml +++ b/test/1.2/statements/T_if_ambiguity.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.2; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.4/errors/T_ECAST.dml b/test/1.4/errors/T_ECAST.dml index ac84107e7..08495f1a8 100644 --- a/test/1.4/errors/T_ECAST.dml +++ b/test/1.4/errors/T_ECAST.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.4/errors/T_EEXTERNINCOMP.dml b/test/1.4/errors/T_EEXTERNINCOMP.dml index eb0654173..3f68ec360 100644 --- a/test/1.4/errors/T_EEXTERNINCOMP.dml +++ b/test/1.4/errors/T_EEXTERNINCOMP.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.4/errors/T_ESERIALIZE.dml b/test/1.4/errors/T_ESERIALIZE.dml index 514a6c2cb..2cd0d2cab 100644 --- a/test/1.4/errors/T_ESERIALIZE.dml +++ b/test/1.4/errors/T_ESERIALIZE.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.4/errors/T_EVOID.dml b/test/1.4/errors/T_EVOID.dml index fd6c167c4..b4a7d7e24 100644 --- a/test/1.4/errors/T_EVOID.dml +++ b/test/1.4/errors/T_EVOID.dml @@ -3,7 +3,7 @@ SPDX-License-Identifier: MPL-2.0 */ dml 1.4; -provisional c_vect; +provisional simics_util_vect; device test; diff --git a/test/1.4/provisional/T_c_vect.dml b/test/1.4/provisional/T_simics_util_vect.dml similarity index 50% rename from test/1.4/provisional/T_c_vect.dml rename to test/1.4/provisional/T_simics_util_vect.dml index 15ce3fbaf..be7e98120 100644 --- a/test/1.4/provisional/T_c_vect.dml +++ b/test/1.4/provisional/T_simics_util_vect.dml @@ -5,14 +5,14 @@ dml 1.4; -provisional c_vect; +provisional simics_util_vect; device test; /// COMPILE-ONLY -// Error reporting tested by 1.4/legacy/c_vect_without_provisional_*.dml +// Error reporting tested by 1.4/legacy/experimental_vect_*.dml -/// DMLC-FLAG --no-compat=c_vect_without_provisional +/// DMLC-FLAG --no-compat=experimental_vect // no warning typedef int vect x; From bafcd6ede68a3258d1c6fe9c854e66338b230e65 Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Tue, 22 Oct 2024 18:06:28 +0200 Subject: [PATCH 8/9] Avoid warning --- lib/1.2/utility.dml | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/1.2/utility.dml b/lib/1.2/utility.dml index bea077d3e..3f0fd7c8f 100644 --- a/lib/1.2/utility.dml +++ b/lib/1.2/utility.dml @@ -4,6 +4,7 @@ */ dml 1.2; +provisional simics_util_vect; template _reg_or_field { parameter is_register = ($objtype == "register"); From 72156e43a7eedad302f821a2e57f9266ef69037a Mon Sep 17 00:00:00 2001 From: Erik Carstensen Date: Tue, 22 Oct 2024 18:07:12 +0200 Subject: [PATCH 9/9] Adjust script to cope with warning statement --- py/dead_dml_methods.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/py/dead_dml_methods.py b/py/dead_dml_methods.py index 774e095ba..11fc562a3 100644 --- a/py/dead_dml_methods.py +++ b/py/dead_dml_methods.py @@ -112,6 +112,10 @@ def traverse_ast(ast): def method_locations(path): from dml.toplevel import parse_file, determine_version from dml import logging, messages + import dml.globals + from dml import compat + # needed to parse 1.2/utility.dml + dml.globals.enabled_compat.add(compat.warning_statement) for warning in messages.warnings: logging.ignore_warning(warning)