Page MenuHomeFreeBSD
Differential D11616 Diff 40348 share/man/man4/cc_newreno.4

Changeset View

Standalone View

View Options

share/man/man4/cc_newreno.4

Context not available.
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd September 15, 2011 .Dd March 16, 2018
.Dt CC_NEWRENO 4 .Dt CC_NEWRENO 4
.Os .Os
.Sh NAME .Sh NAME
.Nm cc_newreno .Nm cc_newreno
.Nd NewReno Congestion Control Algorithm .Nd NewReno Congestion Control Algorithm
.Sh SYNOPSIS
.In netinet/cc/cc_newreno.h
lstewartUnsubmitted
Done
Inline Actions

Please do the following:

  • Bump the document date .Dd field.
  • Add a "SEE ALSO" section with a reference to the ABE draft (as an example, you can copy from cc_cubic for draft-rhee-tcpm-cubic-02.txt). While you're at it, perhaps also add a normative reference to RFC 5681 as the first ref in SEE ALSO.
  • Add a new ".Ss Socket options" sub-section above the "MIB Variables" sub-section to document "struct cc_newreno_opts" (see mod_cc(9) for an example of documenting a struct in a man page) and to document the 2 socket options added. You should also reference TCP_CCALGOOPT from tcp(4) and mod_cc(4).

FYI, "man mdoc" has details on all the mdoc macros you might need.

lstewart: Please do the following: - Bump the document date .Dd field. - Add a "SEE ALSO" section with…
.Sh DESCRIPTION .Sh DESCRIPTION
The NewReno congestion control algorithm is the default for TCP. The NewReno congestion control algorithm is the default for TCP.
Details about the algorithm can be found in RFC5681. Details about the algorithm can be found in RFC5681.
.Sh Socket Options
The
.Nm
module supports a number of socket options under TCP_CC_ALGOOPT (refer to
.Xr tcp 4
lstewartUnsubmitted
Done
Inline Actions

You should use the longest MIB variable name here for width sizing i.e. beta_ecn

lstewart: You should use the longest MIB variable name here for width sizing i.e. beta_ecn
and
.Xr moc_cc 9 for details)
which can
lstewartUnsubmitted
Done
Inline Actions

I wonder where these were copied from... please be mindful of paying more attention to detail.

How about (note man page style is to start new sentences on a new line):

Multiplicative window decrease factor, specified as a percentage, applied to the congestion window in response to a congestion signal per: cwnd = (cwnd * beta) / 100.
Default is 50.

lstewart: I wonder where these were copied from... please be mindful of paying more attention to detail.
be set with
.Xr setsockopt 2
and tested with
.Xr getsockopt 2 .
The
lstewartUnsubmitted
Done
Inline Actions

ABE should be explicitly referenced here. Perhaps something like:

Multiplicative window decrease factor, specified as a percentage, applied to the congestion window in response to an ECN congestion signal when
.Va net.inet.tcp.abe=1
per: cwnd = (cwnd * beta_ecn) / 100.
Default is 80.

lstewart: ABE should be explicitly referenced here. Perhaps something like: Multiplicative window…
.Nm
socket options use this structure defined in
wblockUnsubmitted
Not Done
Inline Actions
socket options use this structure defined in
wblock: ```socket options use this structure defined in```
<sys/netinet/cc/cc_newreno.h>:
lstewartUnsubmitted
Done
Inline Actions

Feel free to give yourself/the funding project some kudos in the "HISTORY" and/or "AUTHORS" sections for adding ABE support if you wish.

lstewart: Feel free to give yourself/the funding project some kudos in the "HISTORY" and/or "AUTHORS"…
wblockUnsubmitted
Not Done
Inline Actions
<sys/netinet/cc/cc_newreno.h>:
wblock: ```<sys/netinet/cc/cc_newreno.h>:```
.Bd -literal
struct cc_newreno_opts {
int name;
uint32_t val;
}
.Ed
.Bl -tag -width ".Va CC_NEWRENO_BETA_ECN"
.It Va CC_NEWRENO_BETA
Multiplicative window decrease factor, specified as a percentage, applied to
the congestion window in response to a congestion signal per: cwnd = (cwnd *
CC_NEWRENO_BETA) / 100.
Default is 50.
.It Va CC_NEWRENO_BETA_ECN
Multiplicative window decrease factor, specified as a percentage, applied to
the congestion window in response to an ECN congestion signal when
.Va net.inet.tcp.abe=1
per: cwnd = (cwnd * CC_NEWRENO_BETA_ECN) / 100.
Default is 80.
.Sh MIB Variables .Sh MIB Variables
There are currently no tunable MIB variables. The algorithm exposes these variables in the
.Va net.inet.tcp.cc.newreno
branch of the
.Xr sysctl 3
MIB:
.Bl -tag -width ".Va beta_ecn"
.It Va beta
Multiplicative window decrease factor, specified as a percentage, applied to
the congestion window in response to a congestion signal per: cwnd = (cwnd *
beta) / 100.
Default is 50.
.It Va beta_ecn
Multiplicative window decrease factor, specified as a percentage, applied to
the congestion window in response to an ECN congestion signal when
.Va net.inet.tcp.abe=1
per: cwnd = (cwnd * beta_ecn) / 100.
Default is 80.
wblockUnsubmitted
Not Done
Inline Actions

s/the following/these/

wblock: s/the following/these/
.Sh SEE ALSO .Sh SEE ALSO
.Xr cc_chd 4 , .Xr cc_chd 4 ,
.Xr cc_cubic 4 , .Xr cc_cubic 4 ,
Context not available.
.Xr mod_cc 4 , .Xr mod_cc 4 ,
.Xr tcp 4 , .Xr tcp 4 ,
.Xr mod_cc 9 .Xr mod_cc 9
.Rs
.%A "Mark Allman"
.%A "Vern Paxson"
.%A "Ethan Blanton"
.%T "TCP Congestion Control"
.%O "RFC 5681"
.Re
.Rs
.%A "Naeem Khademi"
.%A "Michael Welzl"
.%A "Grenville Armitage"
.%A "Gorry Fairhurst"
.%T "TCP Alternative Backoff with ECN (ABE)"
.%R "internet draft"
.%D "May 2017"
.%N "draft-ietf-tcpm-alternativebackoff-ecn"
.%O "work in progress"
.Re
.Sh ACKNOWLEDGEMENTS .Sh ACKNOWLEDGEMENTS
Development and testing of this software were made possible in part by grants Development and testing of this software were made possible in part by grants
from the FreeBSD Foundation and Cisco University Research Program Fund at from the FreeBSD Foundation and Cisco University Research Program Fund at
Context not available.
and and
.An David Hayes Aq Mt david.hayes@ieee.org . .An David Hayes Aq Mt david.hayes@ieee.org .
.Pp .Pp
Support for TCP ABE was added by
.An Tom Jones Aq Mt tj@enoti.me .
.Pp
This manual page was written by This manual page was written by
.An Lawrence Stewart Aq Mt lstewart@FreeBSD.org . .An Lawrence Stewart Aq Mt lstewart@FreeBSD.org .
Context not available.