address violations of MISRA C Rule 20.7
v2 cover address violations of MISRA C Rule 20.7
Hi all,
this series aims to refactor some macros that cause violations of MISRA C Rule 20.7 ("Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses"). All the macros touched by these patches are in some way involved in violations, and the strategy adopted to bring them into compliance is to add parentheses around macro arguments where needed.
Patch 1/3 is derived from that of v1; patches 2 and 3 are new to this series.
Nicola Vetrini (3):
drivers: char: address violation of MISRA C Rule 20.7 xen/unaligned: address violation of MISRA C Rule 20.7 xen/pci: address violations of MISRA C Rule 20.7
tools/include/xen-tools/common-macros.h | 2 +- xen/drivers/char/omap-uart.c | 5 +++-- xen/include/xen/pci_regs.h | 6 +++--- xen/include/xen/unaligned.h | 2 +- xen/include/xen/vpci.h | 2 +- 5 files changed, 9 insertions(+), 8 deletions(-)
Signature · 1 line
2.34.1
PATCH v2 1/3 drivers: char: address violation of MISRA C Rule 20.7
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional chage.
---
Changes in v2:
- drop excess parentheses from val parameter.
--- xen/drivers/char/omap-uart.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
xen/drivers/char/omap-uart.c +3 -2
@@ -48,8 +48,9 @@/* System configuration register */ #define UART_OMAP_SYSC_DEF_CONF 0x0d/* autoidle mode, wakeup is enabled */ -#define omap_read (uart, off) readl((uart)->regs + (off<<REG_SHIFT)) -#define omap_write (uart, off, val) writel((val), (uart)->regs + (off<<REG_SHIFT)) +#define omap_read (uart, off) readl((uart)->regs + ((off) << REG_SHIFT)) +#define omap_write (uart, off, val) writel(val, (uart)->regs + \ + ((off) << REG_SHIFT)) static struct omap_uart { u32 baud, clock_hz, data_bits, parity, stop_bits, fifo_size;
Signature · 1 line
2.34.1
Re: [XEN PATCH v2 1/3] drivers: char: address violation of MISRA C Rule 20.7
Quoted 9 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional chage.
Signed-off-by Nicola Vetrini <[email protected]>
Quoted 12 lines
---
Changes in v2:
- drop excess parentheses from val parameter.--- xen/drivers/char/omap-uart.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)xen/drivers/char/omap-uart.c +0
-0
xen/drivers/char/omap-uart.c line 53
Quoted 8 lines
xen/drivers/char/omap-uart.c +3
-2@@ -48,8 +48,9 @@/* System configuration register */ #define UART_OMAP_SYSC_DEF_CONF 0x0d/* autoidle mode, wakeup is enabled */ -#define omap_read (uart, off) readl((uart)->regs + (off<<REG_SHIFT)) -#define omap_write (uart, off, val) writel((val), (uart)->regs + (off<<REG_SHIFT)) +#define omap_read (uart, off) readl((uart)->regs + ((off) << REG_SHIFT)) +#define omap_write (uart, off, val) writel(val, (uart)->regs + \ + ((off) << REG_SHIFT))
the alignment looks off but could be fixed on commit
Quoted 2 lines
xen/drivers/char/omap-uart.c +0
-0static struct omap_uart { u32 baud, clock_hz, data_bits, parity, stop_bits, fifo_size;
Re: [XEN PATCH v2 1/3] drivers: char: address violation of MISRA C Rule 20.7
Quoted 30 lines · Stefano Stabellini
Quoted 9 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional chage.
Signed-off-by Nicola Vetrini <[email protected]>Reviewed-by Stefano Stabellini <[email protected]>Quoted 16 lines
---
Changes in v2:
- drop excess parentheses from val parameter.--- xen/drivers/char/omap-uart.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)xen/drivers/char/omap-uart.c +0
-0@@ -48,8 +48,9 @@/* System configuration register */ #define UART_OMAP_SYSC_DEF_CONF 0x0d/* autoidle mode, wakeup is enabled */
Quoted 11 lines
xen/drivers/char/omap-uart.c line 53
Quoted 8 lines
-#define
omap_read(uart, off)readl((uart)->regs +
(off<<REG_SHIFT))
-#defineomap_write(uart, off, val)writel((val), (uart)->regs + (off<<REG_SHIFT))
+#defineomap_read(uart, off)readl((uart)->regs + ((off) <<REG_SHIFT))xen/drivers/char/omap-uart.c +2
-0+#define omap_write (uart, off, val) writel(val, (uart)->regs + \ + ((off) << REG_SHIFT))the alignment looks off but could be fixed on commit
Can you clarify what you mean here? I aligned readl and writeln and the operands in writel to avoid the line being too long.
Thanks,
Signature · 2 lines
Nicola Vetrini, BSc Software Engineer, BUGSENG srl (https://bugseng.com)
Re: [XEN PATCH v2 1/3] drivers: char: address violation of MISRA C Rule 20.7
Quoted 45 lines · Nicola Vetrini
Quoted 32 lines · Stefano Stabellini
Quoted 10 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all
current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.No functional chage.
Signed-off-by Nicola Vetrini <[email protected]>Reviewed-by Stefano Stabellini <[email protected]>Quoted 17 lines
---
Changes in v2:
- drop excess parentheses from val parameter.--- xen/drivers/char/omap-uart.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)xen/drivers/char/omap-uart.c +0
-0@@ -48,8 +48,9 @@/* System configuration register */ #define UART_OMAP_SYSC_DEF_CONF 0x0d/* autoidle mode, wakeup is enabled */
Quoted 11 lines
xen/drivers/char/omap-uart.c line 53
Quoted 8 lines
-#define
omap_read(uart, off)readl((uart)->regs +
(off<<REG_SHIFT))
-#defineomap_write(uart, off, val)writel((val), (uart)->regs + (off<<REG_SHIFT))
+#defineomap_read(uart, off)readl((uart)->regs + ((off) <<REG_SHIFT))xen/drivers/char/omap-uart.c +2
-0+#define omap_write (uart, off, val) writel(val, (uart)->regs + \ + ((off) << REG_SHIFT))the alignment looks off but could be fixed on commit
Quoted 2 lines
Can you clarify what you mean here? I aligned readl and writeln and the operands in writel to avoid the line being too long.
#define omap_write(uart, off, val) writel(val, \
(uart)->regs + ((off) << REG_SHIFT))The main point being that before you start splitting an argument following another one on the same line, you'd move that argument to a new line.
Jan
Re: [XEN PATCH v2 1/3] drivers: char: address violation of MISRA C Rule 20.7
Quoted 51 lines · Jan Beulich
Quoted 47 lines · Nicola Vetrini
Quoted 33 lines · Stefano Stabellini
Quoted 10 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all
current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.No functional chage.
Signed-off-by Nicola Vetrini <[email protected]>Reviewed-by Stefano Stabellini <[email protected]>Quoted 18 lines
---
Changes in v2:
- drop excess parentheses from val parameter.--- xen/drivers/char/omap-uart.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)xen/drivers/char/omap-uart.c +0
-0@@ -48,8 +48,9 @@/* System configuration register */ #define UART_OMAP_SYSC_DEF_CONF 0x0d/* autoidle mode, wakeup is
enabled */Quoted 12 lines
Quoted 9 lines
-#define
omap_read(uart, off)readl((uart)->regs +
(off<<REG_SHIFT))
-#defineomap_write(uart, off, val)writel((val), (uart)->regs + (off<<REG_SHIFT))
+#defineomap_read(uart, off)readl((uart)->regs + ((off) <<REG_SHIFT))xen/drivers/char/omap-uart.c +2
-0+#define omap_write (uart, off, val) writel(val, (uart)->regs + \ + ((off) <<
REG_SHIFT))the alignment looks off but could be fixed on commit
Quoted 2 lines
Can you clarify what you mean here? I aligned readl and writeln and the operands in writel to avoid the line being too long.
Quoted 8 lines
#define omap_write(uart, off, val) writel(val, \ (uart)->regs + ((off) <<
REG_SHIFT))The main point being that before you start splitting an argument following another one on the same line, you'd move that argument to a new line.
Jan
Oh, ok. Didn't think of that. Thanks, can amend it
Signature · 2 lines
Nicola Vetrini, BSc Software Engineer, BUGSENG srl (https://bugseng.com)
PATCH v2 2/3 xen/unaligned: address violation of MISRA C Rule 20.7
In reply to Nicola VetriniMISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional change.
---
Somewhat surprisingly, the change in the tools directory is also needed, otherwise some CI build jobs fail (see e.g. [1]). This is not undefined behaviour as long as the two definitions are kept in sync, following section 6.10.3p2 of the C99 standard, but having the definition in common-macros.h is still a potential problem.
[1] https://gitlab.com/xen-project/people/bugseng/xen/-/jobs/6742878558
--- tools/include/xen-tools/common-macros.h | 2 +- xen/include/xen/unaligned.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
tools/include/xen-tools/common-macros.h +1 -1
@@ -102,7 +102,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \ } while (0)#define get_unaligned (ptr) get_unaligned_t(typeof(*(ptr)), ptr)
xen/include/xen/unaligned.h +1 -1
@@ -19,7 +19,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \ } while (0)#define get_unaligned (ptr) get_unaligned_t(typeof(*(ptr)), ptr)
Signature · 1 line
2.34.1
Re: [XEN PATCH v2 2/3] xen/unaligned: address violation of MISRA C Rule 20.7
Quoted 9 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional change.
Signed-off-by Nicola Vetrini <[email protected]>
Quoted 8 lines
---
Somewhat surprisingly, the change in the tools directory is also needed, otherwise some CI build jobs fail (see e.g. [1]). This is not undefined behaviour as long as the two definitions are kept in sync, following section 6.10.3p2 of the C99 standard, but having the definition incommon-macros.his still a potential problem.[1] https://gitlab.com/xen-project/people/bugseng/xen/-/jobs/6742878558
This is pretty absurd, and the use of the Xen header in xg_dom_decompress_unsafe_zstd.c should probably have gone away with the introduction of the unaligned macros into ...
tools/include/xen-tools/common-macros.h line 108
Quoted 11 lines
tools/include/xen-tools/common-macros.h +1
-1@@ -102,7 +102,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \ } while (0)#define get_unaligned (ptr) get_unaligned_t(typeof(*(ptr)), ptr)
... here. We simply cannot assume the two definitions can indefinitely be kept in sync.
xen/include/xen/unaligned.h line 22
Quoted 8 lines
xen/include/xen/unaligned.h +1
-1@@ -19,7 +19,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \
Nit: One of the padding tabs then wants dropping.
Jan
Re: [XEN PATCH v2 2/3] xen/unaligned: address violation of MISRA C Rule 20.7
Quoted 17 lines · Jan Beulich
Quoted 16 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional change.
Signed-off-by Nicola Vetrini <[email protected]>---
Somewhat surprisingly, the change in the tools directory is also needed, otherwise some CI build jobs fail (see e.g. [1]). This is not undefined behaviour as long as the two definitions are kept in sync, following section 6.10.3p2 of the C99 standard, but having the definition incommon-macros.his still a potential problem.
Quoted 6 lines
Quoted 1 line
[1] https://gitlab.com/xen-project/people/bugseng/xen/-/jobs/6742878558
This is pretty absurd, and the use of the Xen header in
xg_dom_decompress_unsafe_zstd.cshould probably have gone away with the introduction of the unaligned macros into ...
I agree. I assumed it was known/deliberate.
Quoted 27 lines
tools/include/xen-tools/common-macros.h line 108
Quoted 11 lines
tools/include/xen-tools/common-macros.h +1
-1@@ -102,7 +102,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \ } while (0)#define get_unaligned (ptr) get_unaligned_t(typeof(*(ptr)), ptr)... here. We simply cannot assume the two definitions can indefinitely be kept in sync.
xen/include/xen/unaligned.h line 22
Quoted 8 lines
xen/include/xen/unaligned.h +1
-1@@ -19,7 +19,7 @@#define put_unaligned_t (type, val, ptr) do { \ struct { type x; } __packed *ptr_ = (typeof(ptr_))(ptr); \ - ptr_->x = val; \ + ptr_->x = (val); \Nit: One of the padding tabs then wants dropping.
Jan
Signature · 2 lines
Nicola Vetrini, BSc Software Engineer, BUGSENG srl (https://bugseng.com)
PATCH v2 3/3 xen/pci: address violations of MISRA C Rule 20.7
In reply to Nicola VetriniMISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional change.
--- xen/include/xen/pci_regs.h | 6 +++--- xen/include/xen/vpci.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-)
xen/include/xen/pci_regs.h +3 -3
@@ -445,9 +445,9 @@#define PCI_EXP_RTSTA 32/* Root Status */ /* Extended Capabilities (PCI-X 2.0 and Express) */ -#define PCI_EXT_CAP_ID (header) (header & 0x0000ffff) -#define PCI_EXT_CAP_VER (header) ((header >> 16) & 0xf) -#define PCI_EXT_CAP_NEXT (header) ((header >> 20) & 0xffc) +#define PCI_EXT_CAP_ID (header) ((header) & 0x0000ffff) +#define PCI_EXT_CAP_VER (header) (((header) >> 16) & 0xf) +#define PCI_EXT_CAP_NEXT (header) (((header) >> 20) & 0xffc)#define PCI_EXT_CAP_ID_ERR 1#define PCI_EXT_CAP_ID_VC 2
xen/include/xen/vpci.h +1 -1
@@ -23,7 +23,7 @@ typedef int vpci_register_init_t(struct pci_dev *dev);#define REGISTER_VPCI_INIT (x, p) \ static vpci_register_init_t *const x##_entry \ - __used_section(".data.vpci." p) = x + __used_section(".data.vpci." p) = (x)/* Assign vPCI to device by adding handlers. */ int __must_check vpci_assign_device (struct pci_dev *pdev);
Signature · 1 line
2.34.1
Re: [XEN PATCH v2 3/3] xen/pci: address violations of MISRA C Rule 20.7
Quoted 9 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
No functional change.
Signed-off-by Nicola Vetrini <[email protected]>
Re: [XEN PATCH v2 3/3] xen/pci: address violations of MISRA C Rule 20.7
In reply to Nicola VetriniQuoted 6 lines · Nicola Vetrini
MISRA C Rule 20.7 states: "Expressions resulting from the expansion of macro parameters shall be enclosed in parentheses". Therefore, some macro definitions should gain additional parentheses to ensure that all current and future users will be safe with respect to expansions that can possibly alter the semantics of the passed-in macro parameter.
Quoted 7 lines
No functional change.
Signed-off-by Nicola Vetrini <[email protected]>--- xen/include/xen/pci_regs.h | 6 +++--- xen/include/xen/vpci.h | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-)
I notice you committed this with just my ack. I'm pretty sure Roger doesn't mind, but formally his ack would have been required (hence why I didn't commit it already before my vacation).
Jan