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

[PATCH] misra: add deviations of MISRA C Rule 5.5


  • To: "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
  • Date: Wed, 16 Jul 2025 18:08:25 +0000
  • Accept-language: en-US, uk-UA, ru-RU
  • Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=epam.com; dmarc=pass action=none header.from=epam.com; dkim=pass header.d=epam.com; arc=none
  • Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=XhJh5hGYMzBx0qp1vV4LaB8BjWjwnZSC+bBn/zZ+X4A=; b=Z+D+Cl+YX0ZDaRW6oxaSqUuksf0xQNrR+RmeKeY0oflSKke0lNgrqC3h4wE94lM8ZhfLY/49B55sRBCG21m6u2GmsIGMl0wpRnntYZtqE4rET/0f0rL0H1WKQaX7zON866Hylz0ZMhKaXwfG6YoXz4decclZ7hZEAwcn1tG09MqyOwQxp9VfpOyOgqKY8Ke3SG+ompBH7a8zHtjX9LzNMqy+PcgV79tHbmaPVdFbb8osyHa9oZAOWECsYOtoAX261+ZXrFswFbl3oSzMW0UK/gdIdh7ZbEVRz2Sk2xfK+zCWzF9KcfTfZ6ZexNF50fJ4ORBNS2ZEAjWPaeFzyPUZpQ==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=gggrt5fCwEBjmVzln0BgdCIsC4ImnMrsnRgm7eGnkKg1OalwtaQwiV58r8q0IxxNhnd+rUrAvj05AMVJTwi9DeQI+F7kGkN6UqDEVBZo9m+d9c2tDJiOWBvXUY8Rea7tf2tljjUYbKpuotQJCAuVPPdZLgcATGujnzyRY46/E1F9e9ppfXKlvvjakoxR7x3xfSxVCPZTrfG7Wi1QhsnTdbFh1hdGJyd4JTKYv71t39tsnSAiccYYuS8TJstCH7puerUBL/8WWBGH4cXe3T1tm6ezkVoiydMb7Kff1qw10bcifn/32IbgHE+RJeABKKwfZKa2LuQDHKuPjeqIebbfWQ==
  • Authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=epam.com;
  • Cc: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>, Nicola Vetrini <nicola.vetrini@xxxxxxxxxxx>, Doug Goldstein <cardoe@xxxxxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, 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>
  • Delivery-date: Wed, 16 Jul 2025 18:08:34 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHb9nyfKWuy2uMkq0ebdJsomrMUpg==
  • Thread-topic: [PATCH] misra: add deviations of MISRA C Rule 5.5

MISRA C Rule 5.5 states that: "Identifiers shall
be distinct from macro names".

Update ECLAIR configuration to deviate:
- clashes in 'xen/include/xen/bitops.h';
- clashes in 'xen/include/xen/irq.h';
- clashes in 'xen/common/grant_table.c'.

Signed-off-by: Dmytro Prokopchuk <dmytro_prokopchuk1@xxxxxxxx>
---
This patch makes MISRA Rule 5.5 "clean" for ARM only.

Was agreed to narrow deviation:
https://patchew.org/Xen/cover.1752096263.git.dmytro._5Fprokopchuk1@xxxxxxxx/e47d08e4465f913f03348830954e800f420c652d.1752096263.git.dmytro._5Fprokopchuk1@xxxxxxxx/

CI:
https://eclair-analysis-logs.xenproject.org/fs/var/local/eclair/xen-project.ecdf/xen-project/people/dimaprkp4k/xen/ECLAIR_normal/rule_5.5_deviation_final/ARM64/10706457595/PROJECT.ecd;/by_service.html#service&kind
---
 automation/eclair_analysis/ECLAIR/deviations.ecl | 7 +++++++
 docs/misra/deviations.rst                        | 7 +++++++
 2 files changed, 14 insertions(+)

diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl 
b/automation/eclair_analysis/ECLAIR/deviations.ecl
index 8504e850c1..3895148460 100644
--- a/automation/eclair_analysis/ECLAIR/deviations.ecl
+++ b/automation/eclair_analysis/ECLAIR/deviations.ecl
@@ -117,6 +117,13 @@ it defines would (in the common case) be already defined. 
Peer reviewed by the c
 -config=MC3A2.R5.5,reports+={deliberate, 
"any_area(decl(kind(function))||any_loc(macro(name(memcpy||memset||memmove))))&&any_area(any_loc(file(^xen/common/libelf/libelf-private\\.h$)))"}
 -doc_end
 
+-doc_begin="Clashes between function names and macros are deliberate and 
needed to have a function-like macro that acts as a wrapper for the function to 
be called.
+Before calling the function, the macro adds additional checks or adjusts the 
number of parameters depending on the configuration."
+-config=MC3A2.R5.5,reports+={deliberate, 
"any_area(all_loc(file(^xen/include/xen/bitops\\.h$)) && 
macro(name(__test_and_set_bit||__test_and_clear_bit||__test_and_change_bit||test_bit)))"}
+-config=MC3A2.R5.5,reports+={deliberate, 
"any_area(all_loc(file(^xen/common/grant_table\\.c$))&&macro(name(update_gnttab_par||parse_gnttab_limit)))"}
+-config=MC3A2.R5.5,reports+={deliberate, 
"any_area(all_loc(file(^xen/include/xen/irq\\.h$))&&macro(name(pirq_cleanup_check)))"}
+-doc_end
+
 -doc_begin="The type \"ret_t\" is deliberately defined multiple times,
 depending on the guest."
 -config=MC3A2.R5.6,reports+={deliberate,"any_area(any_loc(text(^.*ret_t.*$)))"}
diff --git a/docs/misra/deviations.rst b/docs/misra/deviations.rst
index 620e97f0bd..84bc933cbf 100644
--- a/docs/misra/deviations.rst
+++ b/docs/misra/deviations.rst
@@ -142,6 +142,13 @@ Deviations related to MISRA C:2012 Rules:
        memmove.
      - Tagged as `deliberate` for ECLAIR.
 
+   * - R5.5
+     - Clashes between function names and macros are deliberate and needed
+       to have a function-like macro that acts as a wrapper for the function 
to be
+       called. Before calling the function, the macro adds additional checks or
+       adjusts the number of parameters depending on the configuration.
+     - Tagged as `deliberate` for ECLAIR.
+
    * - R5.6
      - The type ret_t is deliberately defined multiple times depending on the
        type of guest to service.
-- 
2.43.0



 


Rackspace

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