From 723180da5978dcc980d754534061238273453b45 Mon Sep 17 00:00:00 2001
From: Vincenzo Maffione <vmaffione@FreeBSD.org>
Date: Fri, 7 Feb 2020 19:26:26 +0000
Subject: [PATCH] netmap: improve netmap(4) and vale(4) man pages

Clean up obsolete sysctl descriptions and add missing ones.

PR:		243838
Reviewed by:	bcr
MFC after:	1 week
Differential Revision:	https://reviews.freebsd.org/D23546
---
 share/man/man4/netmap.4      | 27 ++++++++++++++++++++-------
 share/man/man4/vale.4        | 20 ++++++--------------
 sys/dev/netmap/netmap_kern.h |  2 --
 3 files changed, 26 insertions(+), 23 deletions(-)

diff --git a/share/man/man4/netmap.4 b/share/man/man4/netmap.4
index 91c0e3728cda..8ea34cdac22f 100644
--- a/share/man/man4/netmap.4
+++ b/share/man/man4/netmap.4
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 8, 2019
+.Dd February 6, 2020
 .Dt NETMAP 4
 .Os
 .Sh NAME
@@ -694,7 +694,7 @@ or
 are called with a write event (POLLOUT/wfdset) or a full ring.
 .Pp
 When registering a virtual interface that is dynamically created to a
-.Xr vale 4
+.Nm VALE
 switch, we can specify the desired number of rings (1 by default,
 and currently up to 16) on it using nr_tx_rings and nr_rx_rings fields.
 .It Dv NIOCTXSYNC
@@ -861,8 +861,10 @@ The sysctl variable
 .Va dev.netmap.admode
 globally controls how netmap mode is implemented.
 .Sh SYSCTL VARIABLES AND MODULE PARAMETERS
-Some aspect of the operation of
+Some aspects of the operation of
 .Nm
+and
+.Nm VALE
 are controlled through sysctl variables on
 .Fx
 .Em ( dev.netmap.* )
@@ -883,15 +885,14 @@ Number of rings used for emulated netmap mode
 Ring size used for emulated netmap mode
 .It Va dev.netmap.generic_mit: 100000
 Controls interrupt moderation for emulated mode
-.It Va dev.netmap.mmap_unreg: 0
 .It Va dev.netmap.fwd: 0
 Forces NS_FORWARD mode
-.It Va dev.netmap.flags: 0
 .It Va dev.netmap.txsync_retry: 2
+Number of txsync loops in the
+.Nm VALE
+flush function
 .It Va dev.netmap.no_pendintr: 1
 Forces recovery of transmit buffers on system calls
-.It Va dev.netmap.mitigate: 1
-Propagates interrupt mitigation to user processes
 .It Va dev.netmap.no_timestamp: 0
 Disables the update of the timestamp in the netmap ring
 .It Va dev.netmap.verbose: 0
@@ -914,6 +915,18 @@ as it impacts the total amount of memory used by netmap.
 .It Va dev.netmap.if_curr_num: 0
 .It Va dev.netmap.if_curr_size: 0
 Actual values in use.
+.It Va dev.netmap.priv_buf_num: 4098
+.It Va dev.netmap.priv_buf_size: 2048
+.It Va dev.netmap.priv_ring_num: 4
+.It Va dev.netmap.priv_ring_size: 20480
+.It Va dev.netmap.priv_if_num: 2
+.It Va dev.netmap.priv_if_size: 1024
+Sizes and number of objects (netmap_if, netmap_ring, buffers)
+for private memory regions.
+A separate memory region is used for each
+.Nm VALE
+port and each pair of
+.Nm netmap pipes .
 .It Va dev.netmap.bridge_batch: 1024
 Batch size used when moving packets across a
 .Nm VALE
diff --git a/share/man/man4/vale.4 b/share/man/man4/vale.4
index a3b1bce09857..9128ce68e794 100644
--- a/share/man/man4/vale.4
+++ b/share/man/man4/vale.4
@@ -28,7 +28,7 @@
 .\" $FreeBSD$
 .\" $Id: $
 .\"
-.Dd January 9, 2019
+.Dd February 6, 2020
 .Dt VALE 4
 .Os
 .Sh NAME
@@ -77,21 +77,13 @@ See
 for details on the API.
 .Ss LIMITS
 .Nm
-currently supports up to 4 switches, 16 ports per switch, with
-1024 buffers per port.
-These hard limits will be
-changed to sysctl variables in future releases.
+currently supports up to 8 switches, with 254 ports per switch.
 .Sh SYSCTL VARIABLES
+See
+.Xr netmap 4
+for a list of sysctl variables that affect
 .Nm
-uses the following sysctl variables to control operation:
-.Bl -tag -width dev.netmap.verbose
-.It dev.netmap.bridge_batch
-The maximum number of packets processed internally
-in each iteration.
-Defaults to 1024, use lower values to trade latency
-with throughput.
-.It dev.netmap.verbose
-Set to non-zero values to enable in-kernel diagnostics.
+bridges.
 .El
 .Sh EXAMPLES
 Create one switch, with a traffic generator connected to one
diff --git a/sys/dev/netmap/netmap_kern.h b/sys/dev/netmap/netmap_kern.h
index 690d45def356..14896ebaa6a5 100644
--- a/sys/dev/netmap/netmap_kern.h
+++ b/sys/dev/netmap/netmap_kern.h
@@ -1591,7 +1591,6 @@ int netmap_adapter_put(struct netmap_adapter *na);
 #define NETMAP_BUF_BASE(_na)	((_na)->na_lut.lut[0].vaddr)
 #define NETMAP_BUF_SIZE(_na)	((_na)->na_lut.objsize)
 extern int netmap_no_pendintr;
-extern int netmap_mitigate;
 extern int netmap_verbose;
 #ifdef CONFIG_NETMAP_DEBUG
 extern int netmap_debug;		/* for debugging */
@@ -1613,7 +1612,6 @@ enum {                                  /* debug flags */
 };
 
 extern int netmap_txsync_retry;
-extern int netmap_flags;
 extern int netmap_generic_hwcsum;
 extern int netmap_generic_mit;
 extern int netmap_generic_ringsize;