aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Kandaurov <pluknet@FreeBSD.org>2014-07-22 22:16:23 +0000
committerSergey Kandaurov <pluknet@FreeBSD.org>2014-07-22 22:16:23 +0000
commit814de630439fb42903b19883ad59ec5f75979107 (patch)
tree4b63a18686e54659e1cfa5b16489d450ba3a247f
parentfc6840cc0280caddc6e5fe8136404d128c248645 (diff)
downloadsrc-814de630439fb42903b19883ad59ec5f75979107.tar.gz
src-814de630439fb42903b19883ad59ec5f75979107.zip
s/PCBGROUPS/PCBGROUP/ manpage to match "options PCBGROUP".
Notes
Notes: svn path=/head/; revision=268995
-rw-r--r--ObsoleteFiles.inc2
-rw-r--r--share/man/man9/Makefile2
-rw-r--r--share/man/man9/PCBGROUP.9 (renamed from share/man/man9/PCBGROUPS.9)32
3 files changed, 19 insertions, 17 deletions
diff --git a/ObsoleteFiles.inc b/ObsoleteFiles.inc
index dd1bf4d713f3..27f01c9091be 100644
--- a/ObsoleteFiles.inc
+++ b/ObsoleteFiles.inc
@@ -38,6 +38,8 @@
# xargs -n1 | sort | uniq -d;
# done
+# 20140723: renamed to PCBGROUP.9
+OLD_FILES+=usr/share/man/man9/PCBGROUPS.9.gz
# 20140719: libsbuf version bump
OLD_LIBS+=lib/libsbuf.so.6
# 20140718: Remove obsolete man pages
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 73f1c68b619d..7df2df9d97be 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -188,7 +188,7 @@ MAN= accept_filter.9 \
osd.9 \
panic.9 \
pbuf.9 \
- PCBGROUPS.9 \
+ PCBGROUP.9 \
p_candebug.9 \
p_cansee.9 \
pci.9 \
diff --git a/share/man/man9/PCBGROUPS.9 b/share/man/man9/PCBGROUP.9
index 098c632464af..55760a4a5579 100644
--- a/share/man/man9/PCBGROUPS.9
+++ b/share/man/man9/PCBGROUP.9
@@ -27,10 +27,10 @@
.\" $FreeBSD$
.\"
.Dd July 18, 2014
-.Dt PCBGROUPS 9
+.Dt PCBGROUP 9
.Os
.Sh NAME
-.Nm PCBGROUPS
+.Nm PCBGROUP
.Nd Distributed Protocol Control Block Groups
.Sh SYNOPSIS
.Ft void
@@ -58,16 +58,16 @@
.Fa "struct inpcbinfo *pcbinfo" "u_int hashtype" "uint32_t hash"
.Fc
.Pp
-.Cd "options PCBGROUPS"
+.Cd "options PCBGROUP"
.Sh DESCRIPTION
-PCBGROUPS, or "connection groups", are based on Willman, Rixner, and Cox's
+PCBGROUP, or "connection groups", are based on Willman, Rixner, and Cox's
2006 USENIX paper,
.Qo
An Evaluation of Network Stack Parallelization Strategies in Modern
Operating Systems
.Qc .
.Pp
-The PCBGROUPS paper describes two main kind of connection groups.
+The PCBGROUP paper describes two main kind of connection groups.
The first, called ConnP-T, uses a pool of worker threads which
implement the network stack.
Serialization occurs when queuing work into and completing work from
@@ -102,7 +102,7 @@ Connection establishment and teardown can be signficantly more
expensive than without connection groups, but that steady-state
processing can be significantly faster.
.Pp
-Enabling PCBGROUPS in the kernel only provides the infrastructure
+Enabling PCBGROUP in the kernel only provides the infrastructure
required to create and manage multiple PCB groups.
An implementation needs to fill in a few functions to provide PCB
group hash information in order for PCBs to be placed in a PCB group.
@@ -133,9 +133,9 @@ wildcard table.
The PCBGROUP tables operate in conjunction with the normal single PCB list
in a PCB info block.
Thus, inserting and removing a PCB will still incur the same costs
-as without PCBGROUPS.
-A protocol which uses PCBGROUPS should fall back to the normal PCB list
-lookup if a call to the PCBGROUPS layer does not yield a lookup hit.
+as without PCBGROUP.
+A protocol which uses PCBGROUP should fall back to the normal PCB list
+lookup if a call to the PCBGROUP layer does not yield a lookup hit.
.Ss Usage
Initialize a PCBGROUP in a PCB info block
.Pq Vt "struct pcbinfo"
@@ -165,7 +165,7 @@ The PCB code in
.Pa sys/netinet
and
.Pa sys/netinet6
-is aware of PCBGROUPS and will call into the PCBGROUPS code to do
+is aware of PCBGROUP and will call into the PCBGROUP code to do
PCBGROUP assignment and lookup, preferring a PCBGROUP lookup to the
default global PCB info table.
.Pp
@@ -201,10 +201,10 @@ receive path in
.Xr netisr 9 ,
.Xr RSS 9
.Sh HISTORY
-PCBGROUPS first appeared in
+PCBGROUP first appeared in
.Fx 9.0 .
.Pp
-The PCBGROUPS implementation is inspired by Willman, Rixner, and Cox's
+The PCBGROUP implementation is inspired by Willman, Rixner, and Cox's
2006 USENIX paper,
.Qo
An Evaluation of Network Stack Parallelization Strategies in Modern
@@ -213,7 +213,7 @@ Operating Systems
.Li http://www.ece.rice.edu/~willmann/pubs/paranet_usenix.pdf
.Sh AUTHORS
.An -nosplit
-The PCBGROUPS implementation was written by
+The PCBGROUP implementation was written by
.An Robert N. M. Watson Aq Mt rwatson@FreeBSD.org
under contract to Juniper Networks, Inc.
.Pp
@@ -224,12 +224,12 @@ The
.Xr RSS 9
implementation currently uses
.Ic #ifdef
-blocks to tie into PCBGROUPS.
+blocks to tie into PCBGROUP.
This is a sign that a more abstract programming API is needed.
.Pp
-There is currently no support for re-balancing the PCBGROUPS assignment,
+There is currently no support for re-balancing the PCBGROUP assignment,
nor is there any support for overriding which PCBGROUP a socket/PCB
should be in.
.Pp
-No statistics are kept to indicate how often PCBGROUPS lookups
+No statistics are kept to indicate how often PCBGROUP lookups
succeed or fail.