git: b691e485bda5 - main - inet.4 tcp.4 udp.4: Replace *CTL_* OID macro names with sysctl names
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 14 Jul 2022 13:51:59 UTC
The branch main has been updated by karels:
URL: https://cgit.FreeBSD.org/src/commit/?id=b691e485bda51ac847ed9c41fb28e961e0fa4de8
commit b691e485bda51ac847ed9c41fb28e961e0fa4de8
Author: Mike Karels <karels@FreeBSD.org>
AuthorDate: 2022-07-13 17:50:23 +0000
Commit: Mike Karels <karels@FreeBSD.org>
CommitDate: 2022-07-14 13:50:13 +0000
inet.4 tcp.4 udp.4: Replace *CTL_* OID macro names with sysctl names
Older sysctls with constant OID macros were identified with those
in inet.4, tcp.4, and udp.4; newer sysctls with automatic numbering
were identified by sysctl names. No one remembers the OID macros,
or knows what they are; sysctls are always done by name now, usually
via sysctl(8).
Replace the OID macro names with sysctl names so that there is one
uniform identifier type; sysctl names were previously in parens.
Make the formatting a little more consistent in this area. In inet.4
and udp.4, move the "ip." or "udp." prefix from each entry into the
top-level name at the start of the section, as they are all the same.
Reviewed by: rpokala
Differential Revision: https://reviews.freebsd.org/D35806
---
share/man/man4/inet.4 | 58 +++++++++++++++++++++++++--------------------------
share/man/man4/tcp.4 | 14 +++++--------
share/man/man4/udp.4 | 19 +++++++----------
3 files changed, 41 insertions(+), 50 deletions(-)
diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4
index 60b2e588500d..2dc2a21b852f 100644
--- a/share/man/man4/inet.4
+++ b/share/man/man4/inet.4
@@ -158,38 +158,36 @@ preferred way is to use
API.
.El
.Ss MIB Variables
-A number of variables are implemented in the net.inet branch of the
+In addition to the variables supported by the transport protocols in
+.Va net.inet
+(for which the respective manual pages may be consulted),
+there are a number of general variables implemented in the
+.Va net.inet.ip
+branch of the
.Xr sysctl 3
MIB.
-In addition to the variables supported by the transport protocols
-(for which the respective manual pages may be consulted),
-the following general variables are defined:
-.Bl -tag -width IPCTL_ACCEPTSOURCEROUTE
-.It Dv IPCTL_FORWARDING
-.Pq ip.forwarding
+The following general variabls are defined:
+.Bl -tag -width ".Va accept_sourceroute"
+.It Va forwarding
Boolean: enable/disable forwarding of IP packets.
Defaults to off.
-.It Dv IPCTL_SENDREDIRECTS
-.Pq ip.redirect
+.It Va redirect
Boolean: enable/disable sending of ICMP redirects in response to
.Tn IP
packets for which a better, and for the sender directly reachable, route
and next hop is known.
Defaults to on.
-.It Dv IPCTL_DEFTTL
-.Pq ip.ttl
+.It Va ttl
Integer: default time-to-live
.Pq Dq TTL
to use for outgoing
.Tn IP
packets.
-.It Dv IPCTL_ACCEPTSOURCEROUTE
-.Pq ip.accept_sourceroute
+.It Va accept_sourceroute
Boolean: enable/disable accepting of source-routed IP packets (default false).
-.It Dv IPCTL_SOURCEROUTE
-.Pq ip.sourceroute
+.It Va sourceroute
Boolean: enable/disable forwarding of source-routed IP packets (default false).
-.It Va ip.process_options
+.It Va process_options
Integer: control IP options processing.
By setting this variable to 0, all IP options in the incoming packets
will be ignored, and the packets will be passed unmodified.
@@ -204,9 +202,9 @@ This
.Xr sysctl 8
variable affects packets destined for a local host as well as packets
forwarded to some other host.
-.It Va ip.rfc1122_strong_es
+.It Va rfc1122_strong_es
Boolean: in non-forwarding mode
-.Pq ip.forwarding is disabled
+.Pq forwarding is disabled
partially implement the Strong End System model per RFC1122.
If a packet with destination address that is local arrives on a different
interface than the interface the address belongs to, the packet would be
@@ -219,7 +217,7 @@ or destination address rewriting
.Xr pfil 4
filters may override and bypass this check.
Disabled by default.
-.It Va ip.source_address_validation
+.It Va source_address_validation
Boolean: perform source address validation for packets destined for the local
host.
Consider this as following Section 3.2 of RFC3704/BCP84, where we treat local
@@ -227,7 +225,7 @@ host as our own infrastructure.
This has no effect on packets to be forwarded, so don't consider it as
anti-spoof feature for a router.
Enabled by default.
-.It Va ip.rfc6864
+.It Va rfc6864
Boolean: control IP IDs generation behaviour.
True value enables RFC6864 support, which specifies that IP ID field of
.Em atomic
@@ -235,14 +233,14 @@ datagrams can be set to any value.
The
.Fx implementation sets it to zero.
Enabled by default.
-.It Va ip.random_id
+.It Va random_id
Boolean: control IP IDs generation behaviour.
Setting this
.Xr sysctl 8
to 1 causes the ID field in
.Em non-atomic
IP datagrams (or all IP datagrams, if
-.Va ip.rfc6864
+.Va rfc6864
is disabled) to be randomized instead of incremented by 1 with each packet
generated.
This closes a minor information leak which allows remote observers to
@@ -252,21 +250,21 @@ At the same time, on high-speed links, it can decrease the ID reuse
cycle greatly.
Default is 0 (sequential IP IDs).
IPv6 flow IDs and fragment IDs are always random.
-.It Va ip.maxfrags
+.It Va maxfrags
Integer: maximum number of fragments the host will accept and simultaneously
hold across all reassembly queues in all VNETs.
If set to 0, reassembly is disabled.
If set to -1, this limit is not applied.
This limit is recalculated when the number of mbuf clusters is changed.
This is a global limit.
-.It Va ip.maxfragpackets
+.It Va maxfragpackets
Integer: maximum number of fragmented packets the host will accept and
simultaneously hold in the reassembly queue for a particular VNET.
0 means that the host will not accept any fragmented packets for that VNET.
\-1 means that the host will not apply this limit for that VNET.
This limit is recalculated when the number of mbuf clusters is changed.
This is a per-VNET limit.
-.It Va ip.maxfragbucketsize
+.It Va maxfragbucketsize
Integer: maximum number of reassembly queues per bucket.
Fragmented packets are hashed to buckets.
Each bucket has a list of reassembly queues.
@@ -276,21 +274,21 @@ To preserve system resources, the system limits the number of reassembly
queues allowed in each bucket.
This limit is recalculated when the number of mbuf clusters is changed or
when the value of
-.Va ip.maxfragpackets
+.Va maxfragpackets
changes.
This is a per-VNET limit.
-.It Va ip.maxfragsperpacket
+.It Va maxfragsperpacket
Integer: maximum number of fragments the host will accept and hold
in the reassembly queue for a packet.
0 means that the host will not accept any fragmented packets for the VNET.
This is a per-VNET limit.
-.It Va ip.allow_net0
+.It Va allow_net0
Boolean: allow experimental use of addresses in 0.0.0.0/8 as endpoints,
and allow forwarding of packets with these addresses.
-.It Va ip.allow_net240
+.It Va allow_net240
Boolean: allow experimental use of addresses in 240.0.0.0/4 as endpoints,
and allow forwarding of packets with these addresses.
-.It Va ip.loopback_prefixlen
+.It Va loopback_prefixlen
Integer: prefix length of the address space reserved for loopback purposes.
The default is 8, meaning that 127.0.0.0/8 is reserved for loopback,
and cannot be sent, received, or forwarded on a non-loopback interface.
diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4
index d103293132ba..9e080bc143c9 100644
--- a/share/man/man4/tcp.4
+++ b/share/man/man4/tcp.4
@@ -421,9 +421,8 @@ protocol implements a number of variables in the
branch of the
.Xr sysctl 3
MIB.
-.Bl -tag -width ".Va TCPCTL_DO_RFC1323"
-.It Dv TCPCTL_DO_RFC1323
-.Pq Va rfc1323
+.Bl -tag -width ".Va v6pmtud_blackhole_mss"
+.It Va rfc1323
Implement the window scaling and timestamp options of RFC 1323/RFC 7323
(default is true).
.It Va tolerate_missing_ts
@@ -437,18 +436,15 @@ timestamps has been negotiated.
As of June 2021, several TCP stacks are known to violate RFC 7323, including
modern widely deployed ones.
Therefore the default is 1, i.e., the missing of timestamps is tolerated.
-.It Dv TCPCTL_MSSDFLT
-.Pq Va mssdflt
+.It Va mssdflt
The default value used for the maximum segment size
.Pq Dq MSS
when no advice to the contrary is received from MSS negotiation.
-.It Dv TCPCTL_SENDSPACE
-.Pq Va sendspace
+.It Va sendspace
Maximum
.Tn TCP
send window.
-.It Dv TCPCTL_RECVSPACE
-.Pq Va recvspace
+.It Va recvspace
Maximum
.Tn TCP
receive window.
diff --git a/share/man/man4/udp.4 b/share/man/man4/udp.4
index 3d869c38339b..b50bc0411670 100644
--- a/share/man/man4/udp.4
+++ b/share/man/man4/udp.4
@@ -114,24 +114,21 @@ from RFC 3948, defined in
The
.Nm
protocol implements a number of variables in the
-.Li net.inet
+.Va net.inet.udp
branch of the
.Xr sysctl 3
-MIB.
-.Bl -tag -width UDPCTL_RECVSPACEX
-.It UDPCTL_CHECKSUM
-.Pq udp.checksum
+MIB:
+.Bl -tag -width ".Va log_in_vain"
+.It Va checksum
Enable udp checksums (enabled by default).
-.It UDPCTL_MAXDGRAM
-.Pq udp.maxdgram
+.It Va maxdgram
Maximum outgoing UDP datagram size
-.It UDPCTL_RECVSPACE
-.Pq udp.recvspace
+.It Va recvspace
Maximum space for incoming UDP datagrams
-.It udp.log_in_vain
+.It Va log_in_vain
For all udp datagrams, to ports on which there is no socket
listening, log the connection attempt (disabled by default).
-.It udp.blackhole
+.It Va blackhole
When a datagram is received on a port where there is no socket
listening, do not return an ICMP port unreachable message.
(Disabled by default.