All of lore.kernel.org
 help / color / mirror / Atom feed
From: Vishal Chourasia <vishalc@linux.ibm.com>
To: bpf@vger.kernel.org, daniel@iogearbox.net,
	maciej.fijalkowski@intel.com, sdf@fomichev.me,
	netdev@vger.kernel.org, sdf@google.com, kuba@kernel.org,
	yoong.siang.song@intel.com, ast@kernel.org
Subject: [RFC] Fix mismatch in if_xdp.h between tools and kernel UAPI
Date: Mon, 13 Jan 2025 15:28:39 +0530	[thread overview]
Message-ID: <Z4TjzzB8NSnTy_Wa@linux.ibm.com> (raw)

Hello all,

While building libbpf, I encountered the following warning:

Warning: Kernel ABI header at 'tools/include/uapi/linux/if_xdp.h' differs from latest version at 'include/uapi/linux/if_xdp.h'

A brief diff shows discrepancies in the doc comments regarding `union
xsk_tx_metadata` vs. `struct xsk_tx_metadata` references. Below is the
relevant snippet:
$ diff tools/include/uapi/linux/if_xdp.h include/uapi/linux/if_xdp.h
120c120
<  * field of union xsk_tx_metadata.
---
>  * field of struct xsk_tx_metadata.
125c125
<  * are communicated via csum_start and csum_offset fields of union
---
>  * are communicated via csum_start and csum_offset fields of struct

This patch aligns the documentation in
`tools/include/uapi/linux/if_xdp.h` with the kernel UAPI header in
`include/uapi/linux/if_xdp.h` to remove the mismatch and associated
warning.

Please consider applying this fix. Let me know if there are any
questions or if additional changes are needed.

vishal.c

diff --git a/tools/include/uapi/linux/if_xdp.h b/tools/include/uapi/linux/if_xdp.h
index 2f082b01ff228..42ec5ddaab8dc 100644
--- a/tools/include/uapi/linux/if_xdp.h
+++ b/tools/include/uapi/linux/if_xdp.h
@@ -117,12 +117,12 @@ struct xdp_options {
        ((1ULL << XSK_UNALIGNED_BUF_OFFSET_SHIFT) - 1)

 /* Request transmit timestamp. Upon completion, put it into tx_timestamp
- * field of union xsk_tx_metadata.
+ * field of struct xsk_tx_metadata.
  */
 #define XDP_TXMD_FLAGS_TIMESTAMP               (1 << 0)

 /* Request transmit checksum offload. Checksum start position and offset
- * are communicated via csum_start and csum_offset fields of union
+ * are communicated via csum_start and csum_offset fields of struct
  * xsk_tx_metadata.
  */
 #define XDP_TXMD_FLAGS_CHECKSUM                        (1 << 1)

             reply	other threads:[~2025-01-13  9:59 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-01-13  9:58 Vishal Chourasia [this message]
2025-01-14  1:05 ` [RFC] Fix mismatch in if_xdp.h between tools and kernel UAPI Song, Yoong Siang
2025-01-14 10:40   ` Vishal Chourasia

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Z4TjzzB8NSnTy_Wa@linux.ibm.com \
    --to=vishalc@linux.ibm.com \
    --cc=ast@kernel.org \
    --cc=bpf@vger.kernel.org \
    --cc=daniel@iogearbox.net \
    --cc=kuba@kernel.org \
    --cc=maciej.fijalkowski@intel.com \
    --cc=netdev@vger.kernel.org \
    --cc=sdf@fomichev.me \
    --cc=sdf@google.com \
    --cc=yoong.siang.song@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.