[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v1] misra: add deviation for rules 21.1 and 21.2


  • To: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
  • From: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
  • Date: Wed, 02 Jul 2025 12:17:16 +0200
  • Arc-authentication-results: i=1; bugseng.com; arc=none smtp.remote-ip=162.55.131.47
  • Arc-message-signature: i=1; d=bugseng.com; s=openarc; a=rsa-sha256; c=relaxed/relaxed; t=1751451437; h=DKIM-Signature:MIME-Version:Date:From:To:Cc:Subject:In-Reply-To: References:Message-ID:X-Sender:Organization:Content-Type: Content-Transfer-Encoding; bh=nwttDMvK/94FjAwGtt4ykSygR63H3NXsgEVfT0u/9DY=; b=4DrgGyoOvBUpoZB0482IWFVA9aVR7V7BF/cyMXSkFTq5yuS57yQn0u8XQdyC3hf+youD WwKXDrn1ITZSvZ5gzPZNmqZt8W+1jwRMW7N/iyiLxOzf/a0TuHv3jUFfyuHxS7RKLQ9Ed Jp9Xe/BDQtikNtQBnaebTCpVrBH1OQITLiDIpBdnGyGhKTsWmRT7EOTN9ibzEEetS9CJY mCw8MVy126Ic6bGJZ6qRRZ9/8gidggIA+RIRyrek++pWqzV31wT6+TPXxfqXvn/9eUQCM qp1O/cX0xPH+JeTSVRxdVLRBU9mqGmTnlF4e9HCGCNPu+ZMDy0jxjDk+lK+UvwnWkHnkR 5Rm5q0GcfB1rcm65p2CpbB/nBpst7YhraURBlvRS6zjGwDlQOjRy8c8+sVpvDm8IW1AD7 R1CRSBhVNJ1nwpaJ/aXFUXn/jJLSEYkTS3yln7F0ZYSDaAHTUs6E55/0jW4mq5EBYMrQn YDaejShqDLSKIoYa38BN0DhH76k0xSVSS6BF5VlMtcEkdl700rmBayDNnCBg/4sU37qkC RVIdZtaUvNaqZqoLjw7HmV3Cjs1Em4vvhvzXjAV5pp9KeBudBH7vDHeqqA3/cFqISSi4N xVwNorKCN2x4mBtbTJT+VK+tlie5PZtReM4kfX7CqW867WpCOY6ckvJML+2o2IU=
  • Arc-seal: i=1; d=bugseng.com; s=openarc; a=rsa-sha256; cv=none; t=1751451437; b=iqtXSYiT6gp8n12eu/7r874L7xg4O3JmYbKK6UCz0Bo+kt9lU2K2vbHrjKund5M0GdM6 S8/GBQ7AQm0y0PxWZ5Md5IHgONULL8J9tQmbk/Y6djCDeZDOwt3HzrvL3M4ZfQIj2YTCs DDd4sLRXSbrgA5X7BJhN5SJPWIeeWV0VXRvDm+0qpTtQFm6Wi5onqhYfS8mObFF96R5Rx bL+1Ey1yz2ogLiI+GlWK626oIkCs+1Qeq8z2h3dVtjKCmGiUP7YXx+t+C/1xs+e9X8ttv 4eaJY1+aiZlEJFh6YYb4DFSjCsPLJUYtegH5+SyF7ibKKwss09MRh0pEH/rojpvYbx5cs UqlElwME+vOB1GFUJWK87iDwZPCoXgzWwxG6vE4AxVSK1imddK5GDWJpLDe+gleFyWfcl jBsReC3O3FQN2veOPmoILUDEvodKMLmPccxVRJGM82cNg6bnUIFU8PuupK16nIjpJfTdr EReQqfbYJWzkbCjF33Mj5/5Fb4xPUNLZD9oLZmsk2xbReFk8wtiPw0aaK/eozNX5tbadZ 4oEcM5BtnPtS8DDcuPOKQedzodL6V4h5Fg9lQ+svTX5ZIazDWruOwdqgzPkPWKjXy1TEe KI/3HtQzAPdcQlhFaAfqQEsiYiHDxNR6mFsXqqifSIVbrAOXdAYbYMAAsX5DkGs=
  • Authentication-results: bugseng.com; arc=none smtp.remote-ip=162.55.131.47
  • Cc: xen-devel@xxxxxxxxxxxxxxxxxxxx, victorm.lira@xxxxxxx, Federico Serafini <federico.serafini@xxxxxxxxxxx>, Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Jan Beulich <jbeulich@xxxxxxxx>, Julien Grall <julien@xxxxxxx>, Roger Pau Monné <roger.pau@xxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Bertrand Marquis <bertrand.marquis@xxxxxxx>
  • Delivery-date: Wed, 02 Jul 2025 10:17:26 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

On 2025-07-02 11:55, Dmytro Prokopchuk1 wrote:
Hello, Nicola!

Would you mind if I take part of your patch (related to MISRA C Rule
21.1) and upstream it?

BR, Dmytro.


Hi Dmytro,

I don't mind, though some concerns were raised about the current form of the patch (see in particular the last email in the thread). If you are able to address those concerns, then maybe this can be upstreamed.

Thanks,
 Nicola

On 4/23/25 20:54, victorm.lira@xxxxxxx wrote:
From: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>

MISRA C Rules 21.1 ("#define and #undef shall not be used on a
reserved identifier or reserved macro name") and R21.2 ("A reserved
identifier or reserved macro name shall not be declared") violations
are not problematic for Xen, as it does not use the C or POSIX
libraries.

Xen uses -fno-builtin and -nostdinc to ensure this, but there are still
__builtin_* functions from the compiler that are available so
a deviation is formulated for all identifiers not starting with
"__builtin_".

The missing text of a deviation for Rule 21.2 is added to
docs/misra/deviations.rst.

To avoid regressions, tag both rules as clean and add them to the
monitored set.

Signed-off-by: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
Signed-off-by: Federico Serafini <federico.serafini@xxxxxxxxxxx>
Signed-off-by: Victor Lira <victorm.lira@xxxxxxx>
---
Cc: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
Cc: Anthony PERARD <anthony.perard@xxxxxxxxxx>
Cc: Michal Orzel <michal.orzel@xxxxxxx>
Cc: Jan Beulich <jbeulich@xxxxxxxx>
Cc: Julien Grall <julien@xxxxxxx>
Cc: Roger Pau Monné <roger.pau@xxxxxxxxxx>
Cc: Stefano Stabellini <sstabellini@xxxxxxxxxx>
Cc: Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>
Cc: Federico Serafini <federico.serafini@xxxxxxxxxxx>
Cc: Bertrand Marquis <bertrand.marquis@xxxxxxx>
---
  .../eclair_analysis/ECLAIR/deviations.ecl     |  9 ++++++-
  .../eclair_analysis/ECLAIR/monitored.ecl      |  2 ++
  automation/eclair_analysis/ECLAIR/tagging.ecl |  2 ++
docs/misra/deviations.rst | 26 ++++++++++++++++++-
  4 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl b/automation/eclair_analysis/ECLAIR/deviations.ecl
index 2c8fb92713..ffa23b53b7 100644
--- a/automation/eclair_analysis/ECLAIR/deviations.ecl
+++ b/automation/eclair_analysis/ECLAIR/deviations.ecl
@@ -639,8 +639,15 @@ in the expansion."
  # Series 21.
  #

+-doc_begin="Xen does not use C and POSIX libraries:
+identifiers reserved by these libraries can be used safely, except for those
+beginning with '__builtin_'."
+-config=MC3A2.R21.1,macros={safe, "!^__builtin_.*$"}
+-config=MC3A2.R21.2,declarations={safe, "!^__builtin_.*$"}
+-doc_end
+
-doc_begin="or, and and xor are reserved identifiers because they constitute alternate -spellings for the corresponding operators (they are defined as macros by iso646.h). +spellings for the corresponding logical operators (as defined in header 'iso646.h'). However, Xen doesn't use standard library headers, so there is no risk of overlap." -config=MC3A2.R21.2,reports+={safe, "any_area(stmt(ref(kind(label)&&^(or|and|xor|not)$)))"}
  -doc_end
diff --git a/automation/eclair_analysis/ECLAIR/monitored.ecl b/automation/eclair_analysis/ECLAIR/monitored.ecl
index 8351996ec8..da229a0d84 100644
--- a/automation/eclair_analysis/ECLAIR/monitored.ecl
+++ b/automation/eclair_analysis/ECLAIR/monitored.ecl
@@ -79,6 +79,8 @@
  -enable=MC3A2.R20.12
  -enable=MC3A2.R20.13
  -enable=MC3A2.R20.14
+-enable=MC3A2.R21.1
+-enable=MC3A2.R21.2
  -enable=MC3A2.R21.3
  -enable=MC3A2.R21.4
  -enable=MC3A2.R21.5
diff --git a/automation/eclair_analysis/ECLAIR/tagging.ecl b/automation/eclair_analysis/ECLAIR/tagging.ecl
index 1d078d8905..3292bf751e 100644
--- a/automation/eclair_analysis/ECLAIR/tagging.ecl
+++ b/automation/eclair_analysis/ECLAIR/tagging.ecl
@@ -88,6 +88,8 @@ MC3A2.R20.11||
  MC3A2.R20.12||
  MC3A2.R20.13||
  MC3A2.R20.14||
+MC3A2.R21.1||
+MC3A2.R21.2||
  MC3A2.R21.3||
  MC3A2.R21.4||
  MC3A2.R21.5||
diff --git a/docs/misra/deviations.rst b/docs/misra/deviations.rst
index fe0b1e10a2..88328eaa8a 100644
--- a/docs/misra/deviations.rst
+++ b/docs/misra/deviations.rst
@@ -587,7 +587,31 @@ Deviations related to MISRA C:2012 Rules:
construct is deviated only in Translation Units that present a violation
         of the Rule due to uses of this macro.
       - Tagged as `deliberate` for ECLAIR.
-
+
+   * - R21.1
+ - Rule 21.1 reports identifiers reserved for the C and POSIX standard + libraries. Xen does not use such libraries and all translation units + are compiled with option '-nostdinc', therefore there is no reason to + avoid to use `#define` or `#undef` on such identifiers except for those + beginning with `__builtin_` for which compilers may perform (wrong)
+       optimizations.
+     - Tagged as `safe` for ECLAIR.
+
+   * - R21.2
+ - Rule 21.2 reports identifiers reserved for the C and POSIX standard + libraries. Xen does not use such libraries and all translation units + are compiled with option '-nostdinc', therefore there is no reason to + avoid declaring such identifiers except for those beginning with + `__builtin_` for which compilers may perform (wrong) optimizations.
+     - Tagged as `safe` for ECLAIR.
+
+   * - R21.2
+ - `or`, `and` and `xor` are reserved identifiers because they constitute
+       alternate spellings for the corresponding logical operators
+ (as defined in Standard Library header `\<iso646.h\>`). Xen does not use
+       Standard library headers, so there is no risk of overlap.
+     - Tagged as `safe` for ECLAIR.
+
     * - R21.9
- Xen does not use the `bsearch` and `qsort` functions provided by the C Standard Library, but provides in source form its own implementation,
--
2.47.0



--
Nicola Vetrini, B.Sc.
Software Engineer
BUGSENG (https://bugseng.com)
LinkedIn: https://www.linkedin.com/in/nicola-vetrini-a42471253



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.