diff mbox series

[v6,05/30] doc/guides: replace packed attributes

Message ID	1732668761-5556-6-git-send-email-andremue@linux.microsoft.com (mailing list archive)
State	Superseded
Delegated to:	David Marchand
Headers	From: Andre Muezerie <andremue@linux.microsoft.com> To: roretzla@linux.microsoft.com Cc: aman.deep.singh@intel.com, anatoly.burakov@intel.com, bruce.richardson@intel.com, byron.marohn@intel.com, conor.walsh@intel.com, cristian.dumitrescu@intel.com, david.hunt@intel.com, dev@dpdk.org, dsosnowski@nvidia.com, gakhil@marvell.com, jerinj@marvell.com, jingjing.wu@intel.com, kirill.rybalchenko@intel.com, konstantin.v.ananyev@yandex.ru, matan@nvidia.com, orika@nvidia.com, radu.nicolau@intel.com, ruifeng.wang@arm.com, sameh.gobriel@intel.com, sivaprasad.tummala@amd.com, skori@marvell.com, stephen@networkplumber.org, suanmingm@nvidia.com, vattunuru@marvell.com, viacheslavo@nvidia.com, vladimir.medvedkin@intel.com, yipeng1.wang@intel.com, Andre Muezerie <andremue@linux.microsoft.com> Subject: [PATCH v6 05/30] doc/guides: replace packed attributes Date: Tue, 26 Nov 2024 16:52:16 -0800 Message-Id: <1732668761-5556-6-git-send-email-andremue@linux.microsoft.com> In-Reply-To: <1732668761-5556-1-git-send-email-andremue@linux.microsoft.com> References: <1710968771-16435-1-git-send-email-roretzla@linux.microsoft.com> <1732668761-5556-1-git-send-email-andremue@linux.microsoft.com> Precedence: list Errors-To: dev-bounces@dpdk.org
Series	fix packing of structs when building with MSVC \| [v6,00/30] fix packing of structs when building with MSVC [v6,01/30] devtools: check packed attributes [v6,02/30] eal/include: add new packing macros [v6,03/30] app/test-pmd: remove unnecessary packed attributes [v6,04/30] app/test: replace packed attributes [v6,05/30] doc/guides: replace packed attributes [v6,06/30] drivers/baseband: replace packed attributes [v6,07/30] drivers/bus: replace packed attributes [v6,08/30] drivers/common: replace packed attributes [v6,09/30] drivers/compress: replace packed attributes [v6,10/30] drivers/crypto: replace packed attributes [v6,11/30] drivers/dma: replace packed attributes [v6,12/30] drivers/event: replace packed attributes [v6,13/30] drivers/mempool: replace packed attributes [v6,14/30] drivers/net: replace packed attributes [v6,15/30] drivers/raw: replace packed attributes [v6,16/30] drivers/regex: replace packed attributes [v6,17/30] drivers/vdpa: replace packed attributes [v6,18/30] examples/common: replace packed attributes [v6,19/30] examples/ip-pipeline: remove packed attributes [v6,20/30] examples/ipsec_secgw: replace packed attributes [v6,21/30] examples/l3fwd-power: replace packed attributes [v6,22/30] examples/l3fwd: replace packed attributes [v6,23/30] examples/ptpclient: replace packed attributes [v6,24/30] examples/vhost_blk: replace packed attributes [v6,25/30] lib/eal: replace packed attributes [v6,26/30] lib/ipsec: replace packed attributes [v6,27/30] lib/net: replace packed attributes [v6,28/30] lib/pipeline: replace packed attributes [v6,29/30] lib/vhost: replace packed attributes [v6,30/30] lib/eal: remove __rte_packed

Checks

Context	Check	Description
ci/checkpatch	success	coding style OK

Commit Message

Andre Muezerie Nov. 27, 2024, 12:52 a.m. UTC

MSVC struct packing is not compatible with GCC. Replace macro
__rte_packed with __rte_packed_begin to push existing pack value
and set packing to 1-byte and macro __rte_packed_end to restore
the pack value prior to the push.

Macro __rte_packed_end is deliberately utilized to trigger a
MSVC compiler warning if no existing packing has been pushed allowing
easy identification of locations where the __rte_packed_begin is
missing.

Signed-off-by: Andre Muezerie <andremue@linux.microsoft.com>
---
 doc/guides/nics/ark.rst                              | 3 ++-
 doc/guides/prog_guide/packet_classif_access_ctrl.rst | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

Comments

Tyler Retzlaff Dec. 5, 2024, 12:12 a.m. UTC | #1

On Tue, Nov 26, 2024 at 04:52:16PM -0800, Andre Muezerie wrote:
> MSVC struct packing is not compatible with GCC. Replace macro
> __rte_packed with __rte_packed_begin to push existing pack value
> and set packing to 1-byte and macro __rte_packed_end to restore
> the pack value prior to the push.
> 
> Macro __rte_packed_end is deliberately utilized to trigger a
> MSVC compiler warning if no existing packing has been pushed allowing
> easy identification of locations where the __rte_packed_begin is
> missing.
> 
> Signed-off-by: Andre Muezerie <andremue@linux.microsoft.com>
> ---

Acked-by: Tyler Retzlaff <roretzla@linux.microsoft.com>

diff mbox series

Patch

diff --git a/doc/guides/nics/ark.rst b/doc/guides/nics/ark.rst
index a9f6d4cdb8..0cb5460199 100644
--- a/doc/guides/nics/ark.rst
+++ b/doc/guides/nics/ark.rst
@@ -172,10 +172,11 @@  during RX from user meta data coming from FPGA hardware.
    };
 
    /* RX tuser field based on user's hardware */
+   __rte_packed_begin
    struct user_rx_meta {
       uint64_t timestamp;
       uint32_t rss;
-   } __rte_packed;
+   } __rte_packed_end;
 
    /* Create ark_user_extension object for use in other hook functions */
    void *rte_pmd_ark_dev_init(struct rte_eth_dev * dev,
diff --git a/doc/guides/prog_guide/packet_classif_access_ctrl.rst b/doc/guides/prog_guide/packet_classif_access_ctrl.rst
index c8844d0616..55db983a05 100644
--- a/doc/guides/prog_guide/packet_classif_access_ctrl.rst
+++ b/doc/guides/prog_guide/packet_classif_access_ctrl.rst
@@ -154,6 +154,7 @@  To define classification for the IPv6 2-tuple: <protocol, IPv6 source address> o
 
 .. code-block:: c
 
+    __rte_packed_begin
     struct rte_ipv6_hdr {
         uint32_t vtc_flow;     /* IP version, traffic class & flow label. */
         uint16_t payload_len;  /* IP packet length - includes sizeof(ip_header). */
@@ -161,7 +162,7 @@  To define classification for the IPv6 2-tuple: <protocol, IPv6 source address> o
         uint8_t hop_limits;    /* Hop limits. */
         uint8_t src_addr[16];  /* IP address of source host. */
         uint8_t dst_addr[16];  /* IP address of destination host(s). */
-    } __rte_packed;
+    } __rte_packed_end;
 
 The following array of field definitions can be used: