From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: passt.top; dmarc=none (p=none dis=none) header.from=gibson.dropbear.id.au Authentication-Results: passt.top; dkim=pass (2048-bit key; secure) header.d=gibson.dropbear.id.au header.i=@gibson.dropbear.id.au header.a=rsa-sha256 header.s=202510 header.b=Q7PkFanm; dkim-atps=neutral Received: from mail.ozlabs.org (gandalf.ozlabs.org [150.107.74.76]) by passt.top (Postfix) with ESMTPS id 54FC15A0619 for ; Mon, 13 Oct 2025 01:49:45 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gibson.dropbear.id.au; s=202510; t=1760312983; bh=ubPmLZlBlsySZk2I8UjxyBmrpZhap7qUGy40jUEminU=; h=From:To:Cc:Subject:Date:From; b=Q7PkFanmDa8lIA3vsT9uph0LetVMsASVf5CKXF020Xujmpgi4cnnkhhL6RqmQlXL8 KwBQInnkjCaZnYTmHGk9YgVvb3yi76B1CZsIcoca0Ivb6VfT4xGwekzdHMPI1E5rrC ikp6K4v701Z3/bCf8qG5BC2sPd4Q1Rn8hQVhwhERISUOaBw4AsN4Y0CZOqc2OpqbG6 dtiiTLNN9JnHtFgnMIONionJk8VJdogRFauHXbl1GWt6ROpC47QE+bucSZTGbYOVMl TPzUYntF91LLmCHXECUKLjet7SEj6Z0T02K8gl+ohJfePcOS9FFAWPFvLJWtysGvYB UN0dJX7KT+qvw== Received: by gandalf.ozlabs.org (Postfix, from userid 1007) id 4clHJl1Jncz4w9m; Mon, 13 Oct 2025 10:49:43 +1100 (AEDT) From: David Gibson To: passt-dev@passt.top, Jon Maloy , Stefano Brivio Subject: [PATCH v2] tap: Update some function comments for accuracy Date: Mon, 13 Oct 2025 10:49:41 +1100 Message-ID: <20251012234941.1433683-1-david@gibson.dropbear.id.au> X-Mailer: git-send-email 2.51.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Message-ID-Hash: MOWRMIFPFX52PH42ZTXQ5JNBGBJGOT3D X-Message-ID-Hash: MOWRMIFPFX52PH42ZTXQ5JNBGBJGOT3D X-MailFrom: dgibson@gandalf.ozlabs.org X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: David Gibson X-Mailman-Version: 3.3.8 Precedence: list List-Id: Development discussion and patches for passt Archived-At: Archived-At: List-Archive: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Several of the tap_push_*() functions have doc comments claiming they take the context pointer, but don't. Some (tap_push_uh[46]) were broken fairly recently, but others (tap_push_ip[46]h) have been broken for a long time. Regardless, fix all the doc comments. Reported-by: Stefano Brivio Fixes: 82a839be9 ("tap: break out building of udp header from tap_udp4_send function") Fixes: 87e6a4644 ("tap: break out building of udp header from tap_udp6_send function") Fixes: 2dbc622f5 ("tap: Split tap_ip4_send() into UDP and ICMP variants") Fixes: 9d8dd8b6f ("tap: Split tap_ip6_send() into UDP and ICMP variants") Signed-off-by: David Gibson --- tap.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) v2: * Added missing "Fixes" tags from v1's commit message. diff --git a/tap.c b/tap.c index 95d309bd..f3d1f660 100644 --- a/tap.c +++ b/tap.c @@ -188,7 +188,7 @@ void *tap_push_l2h(const struct ctx *c, void *buf, uint16_t proto) /** * tap_push_ip4h() - Build IPv4 header for inbound packet, with checksum - * @c: Execution context + * @ip4h: Buffer in which to build the IPv4 header * @src: IPv4 source address * @dst: IPv4 destination address * @l4len: IPv4 payload length @@ -217,7 +217,7 @@ void *tap_push_ip4h(struct iphdr *ip4h, struct in_addr src, /** * tap_push_uh4() - Build UDPv4 header with checksum - * @c: Execution context + * @uh: Buffer in which to build the UDP header * @src: IPv4 source address * @sport: UDP source port * @dst: IPv4 destination address @@ -293,7 +293,7 @@ void tap_icmp4_send(const struct ctx *c, struct in_addr src, struct in_addr dst, /** * tap_push_ip6h() - Build IPv6 header for inbound packet - * @c: Execution context + * @ip6h: Buffer in which to build the IPv6 header * @src: IPv6 source address * @dst: IPv6 destination address * @l4len: L4 payload length @@ -319,7 +319,7 @@ void *tap_push_ip6h(struct ipv6hdr *ip6h, /** * tap_push_uh6() - Build UDPv6 header with checksum - * @c: Execution context + * @uh: Buffer in which to build the UDP header * @src: IPv6 source address * @sport: UDP source port * @dst: IPv6 destination address -- 2.51.0