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

[PATCH 1/3] misra: deviate MISRA C Rule 5.5 for 'hypfs_alloc_dyndata'


  • To: "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Dmytro Prokopchuk1 <dmytro_prokopchuk1@xxxxxxxx>
  • Date: Mon, 25 May 2026 12:05:09 +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=tfHfQaxeNdr+CpHuEaonZEFBu7gjFFMWoYmdCiLZ2tI=; b=Z+Dku5TtxQdE0DO48enxSegVvhsL2+bOIpG5uJzQ4QIVeVRTgT2Wi39op58Ii2PpWUi+l5x2J81+jFQmCUO7OPxTbpj3mpjf5d0tSJieGCn3Yvpsu2XgUXsvAXrnSxDS2VNsDbMQXfyWhvRNWapcWvTs1GzTmwcGThBFUii0rrYPAY5aE6tkfmasabVCP/3+fXbKYN+gdyUQFuNahKHHjQiYZMRNEE5CLRlBhkv/h2y4CDnPGDJn2+kFLQX3kM62ElLChOHohQBrjqPFlKKsfLuMrsAjcCQCpiUPsk0R7rGTQEzlMtl/sJtVCK78KVaSLb+2ueAc51YCyCBcM+5w6A==
  • Arc-seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=AK6ztw1xZoN/GsyUQ0/UjhX21tqNJClwKAen+sQ1t5wwhKGR31r+X8I13vpvNtZ2ew1pN8Lb0ymG2KTF+QPLLC/fINz5Gpgr0LM5lqncp70pRMQNql6IHrRGHsSYk9EYs+8XGTJzXgCfnFRd2K8kiRSeDgvsWFsdrUlKkjZhGWcqiZRHWU3GIcusIacWxlaHodjYaI6Z3HAY47V+INMt8YMlqukWGr8UJhb8uVfFPk/VpUhCGpvQoZ9HqeKhjCs2xHawC9SvYQaI4ajnolkRiAlc5GGWoA9idrjwLYMmPcKfSdOuvY6fNLXWXXjdJz4PACLNncVIgzF/dNLsec81/A==
  • Authentication-results: eu.smtp.expurgate.cloud; dkim=pass header.s=selector1 header.d=epam.com header.i="@epam.com" header.h="From:Date:Subject:Message-ID:Content-Type:MIME-Version:x-ms-exchange-senderadcheck"
  • 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: Mon, 25 May 2026 12:05:24 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>
  • Thread-index: AQHc7D673hceQskKjEuWuHstCHXB3g==
  • Thread-topic: [PATCH 1/3] misra: deviate MISRA C Rule 5.5 for 'hypfs_alloc_dyndata'

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

Update ECLAIR configuration to deviate intentional identifier and
macro name clashes by specifying the macros that should be ignored.
This includes 'hypfs_alloc_dyndata', where the real function takes
an allocation size and the same-named macro is a typed convenience
wrapper that expands calls using sizeof(type).

Update deviations.rst and rules.rst accordingly.

Signed-off-by: Dmytro Prokopchuk <dmytro_prokopchuk1@xxxxxxxx>
---
 automation/eclair_analysis/ECLAIR/deviations.ecl | 6 ++++++
 docs/misra/deviations.rst                        | 9 +++++++++
 docs/misra/rules.rst                             | 4 ++++
 3 files changed, 19 insertions(+)

diff --git a/automation/eclair_analysis/ECLAIR/deviations.ecl 
b/automation/eclair_analysis/ECLAIR/deviations.ecl
index 7d4b6f2948..13a34b7703 100644
--- a/automation/eclair_analysis/ECLAIR/deviations.ecl
+++ b/automation/eclair_analysis/ECLAIR/deviations.ecl
@@ -132,6 +132,12 @@ These macros address differences in argument count during 
compile-time, effectiv
 
-config=MC3A2.R5.5,ignored_macros+="name(update_gnttab_par||parse_gnttab_limit)&&loc(file(^xen/common/grant_table\\.c$))"
 -doc_end
 
+-doc_begin="Clash between 'hypfs_alloc_dyndata' function and macro name in 
'xen/include/xen/hypfs.h' is deliberate.
+The function is the allocator taking a size in bytes, while the macro is a 
typed convenience wrapper used by dynamic
+hypfs nodes to allocate per-request traversal data with the correct size and 
return type."
+-config=MC3A2.R5.5,ignored_macros+="name(hypfs_alloc_dyndata)&&loc(file(^xen/include/xen/hypfs\\.h$))"
+-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 b048309596..f5b4ce9315 100644
--- a/docs/misra/deviations.rst
+++ b/docs/misra/deviations.rst
@@ -176,6 +176,15 @@ Deviations related to MISRA C:2012 Rules:
        unused 2nd and 3rd parameters to avoid warnings or errors related to 
them.
      - ECLAIR has been configured to ignore these macros.
 
+   * - R5.5
+     - Clash between the 'hypfs_alloc_dyndata' function and macro name is
+       intentional. The function is the allocator taking a size in bytes, while
+       the macro is a typed convenience wrapper used by dynamic hypfs nodes to
+       allocate per-request traversal data with the correct size and return 
type.
+       The implementation explicitly undefines the macro before defining the 
real
+       function, so the name clash is controlled.
+     - ECLAIR has been configured to ignore this macro.
+
    * - R5.6
      - The type ret_t is deliberately defined multiple times depending on the
        type of guest to service.
diff --git a/docs/misra/rules.rst b/docs/misra/rules.rst
index b3e929307d..c0237725a9 100644
--- a/docs/misra/rules.rst
+++ b/docs/misra/rules.rst
@@ -222,6 +222,10 @@ maintainers if you want to suggest a change.
        Clashes between grant table functions and macro names are allowed
        because they are used for discarding unused parameters.
 
+       Clash between hypfs_alloc_dyndata function and macro names is allowed
+       because the macro is a typed convenience wrapper around the size-based
+       allocation function.
+
    * - `Rule 5.6 
<https://gitlab.com/MISRA/MISRA-C/MISRA-C-2012/Example-Suite/-/blob/master/R_05_06.c>`_
      - Required
      - A typedef name shall be a unique identifier
-- 
2.43.0



 


Rackspace

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