From: Willem de Bruijn <willemdebruijn.kernel@gmail.com>
To: linux-man@vger.kernel.org
Cc: mtk.manpages@gmail.com, alx.manpages@gmail.com,
pabeni@redhat.comm, netdev@vger.kernel.org,
Willem de Bruijn <willemb@google.com>
Subject: [PATCH manpages 1/2] udp.7: add UDP_SEGMENT
Date: Wed, 1 Mar 2023 16:11:45 -0500 [thread overview]
Message-ID: <20230301211146.1974507-1-willemdebruijn.kernel@gmail.com> (raw)
From: Willem de Bruijn <willemb@google.com>
UDP_SEGMENT was added in commit bec1f6f69736
("udp: generate gso with UDP_SEGMENT")
$ git describe --contains bec1f6f69736
linux/v4.18-rc1~114^2~377^2~8
Kernel source has example code in tools/testing/selftests/net/udpgso*
Per https://www.kernel.org/doc/man-pages/patches.html,
"Describe how you obtained the information in your patch":
I am the author of the above commit and follow-ons.
Signed-off-by: Willem de Bruijn <willemb@google.com>
---
man7/udp.7 | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/man7/udp.7 b/man7/udp.7
index 5822bc551fdf..ec16306df605 100644
--- a/man7/udp.7
+++ b/man7/udp.7
@@ -204,6 +204,31 @@ portable.
.\" UDP_ENCAP_ESPINUDP draft-ietf-ipsec-udp-encaps-06
.\" UDP_ENCAP_L2TPINUDP rfc2661
.\" FIXME Document UDP_NO_CHECK6_TX and UDP_NO_CHECK6_RX, added in Linux 3.16
+.TP
+.BR UDP_SEGMENT " (since Linux 4.18)"
+Enables UDP segmentation offload.
+Segmentation offload reduces
+.BR send(2)
+cost by transferring multiple datagrams worth of data as a single
+large packet through the kernel transmit path, even when that
+exceeds MTU.
+As late as possible, the large packet is split by segment size into a
+series of datagrams.
+This segmentation offload step is deferred to hardware if supported,
+else performed in software.
+This option takes a value between 0 and USHRT_MAX that sets the
+segment size: the size of datagram payload, excluding the UDP header.
+The segment size must be chosen such that at most 64 datagrams are
+sent in a single call and that the datagrams after segmentation meet
+the same MTU rules that apply to datagrams sent without this option.
+Segmentation offload depends on checksum offload, as datagram
+checksums are computed after segmentation.
+The option may also be set for individual
+.BR sendmsg(2)
+calls by passing it as a
+.BR cmsg(7).
+A value of zero disables the feature.
+This option should not be used in code intended to be portable.
.SS Ioctls
These ioctls can be accessed using
.BR ioctl (2).
--
2.39.2.722.g9855ee24e9-goog
next reply other threads:[~2023-03-01 21:11 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-01 21:11 Willem de Bruijn [this message]
2023-03-01 21:11 ` [PATCH manpages 2/2] udp.7: add UDP_GRO Willem de Bruijn
2023-03-01 21:35 ` [PATCH manpages 1/2] udp.7: add UDP_SEGMENT Alejandro Colomar
2023-03-01 22:22 ` Willem de Bruijn
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=20230301211146.1974507-1-willemdebruijn.kernel@gmail.com \
--to=willemdebruijn.kernel@gmail.com \
--cc=alx.manpages@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.comm \
--cc=willemb@google.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox