Differential D31902 Diff 94956 share/man/man4/dummynet.4

Changeset View

Standalone View

share/man/man4/dummynet.4

	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd October 28, 2002			.Dd September 10, 2021
	.Dt DUMMYNET 4			.Dt DUMMYNET 4
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm dummynet			.Nm dummynet
	.Nd traffic shaper, bandwidth manager and delay emulator			.Nd traffic shaper, bandwidth manager and delay emulator
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The			The
	.Nm			.Nm
	system facility permits the control of traffic			system facility permits the control of traffic
	going through the various network interfaces, by applying bandwidth			going through the various network interfaces, by applying bandwidth
	and queue size limitations, implementing different scheduling and queue			and queue size limitations, implementing different scheduling and queue
	management policies, and emulating delays and losses.			management policies, and emulating delays and losses.
	.Pp			.Pp
	The user interface for			The user interface for
	.Nm			.Nm
	is implemented by the			is implemented by the
	.Xr ipfw 8			.Xr dnctl 8
	utility, so please refer to the			utility, so please refer to the
	.Xr ipfw 8			.Xr dnctl 8
	manpage for a complete description of the			manpage for a complete description of the
	.Nm			.Nm
	capabilities and how to use it.			capabilities and how to use it.
	.Ss Kernel Options			.Ss Kernel Options
	The following options in the kernel configuration file are related to			The following options in the kernel configuration file are related to
	.Nm			.Nm
	operation:			operation:
	.Pp			.Pp
	.Bl -tag -width ".Dv IPFIREWALL_VERBOSE_LIMIT" -offset indent -compact			.Bl -tag -width ".Dv IPFIREWALL_VERBOSE_LIMIT" -offset indent -compact
	.It Dv IPFIREWALL			.It Dv IPFIREWALL
	enable ipfirewall (required for			enable ipfirewall (required for
	.Nm )			.Nm )
	.It Dv IPFIREWALL_VERBOSE			.It Dv IPFIREWALL_VERBOSE
	enable firewall output			enable firewall output
	.It Dv IPFIREWALL_VERBOSE_LIMIT			.It Dv IPFIREWALL_VERBOSE_LIMIT
	limit firewall output			limit firewall output
				donnerUnsubmitted Not Done Inline Actions Is this still needed? donner: Is this still needed?
				kpAuthorUnsubmitted Not Done Inline Actions Yes and no. It's still relevant if you want ipfw, which is now one of two ways to use dummynet. kp: Yes and no. It's still relevant if you want ipfw, which is now one of two ways to use dummynet.
	.It Dv DUMMYNET			.It Dv DUMMYNET
	enable			enable
	.Nm			.Nm
	operation			operation
	.It Dv HZ			.It Dv HZ
	set the timer granularity			set the timer granularity
	.El			.El
	.Pp			.Pp
	Generally, the following options are required:			Generally, the following options are required:
	.Bd -literal -offset indent			.Bd -literal -offset indent
	options IPFIREWALL			options IPFIREWALL
				donnerUnsubmitted Not Done Inline Actions dito donner: dito
	options DUMMYNET			options DUMMYNET
	options HZ=1000 # strongly recommended			options HZ=1000 # strongly recommended
	.Ed			.Ed
	.Pp			.Pp
	Additionally, one may want to increase the number			Additionally, one may want to increase the number
	of mbuf clusters (used to store network packets) according to the			of mbuf clusters (used to store network packets) according to the
	sum of the bandwidth-delay products and queue sizes of all configured			sum of the bandwidth-delay products and queue sizes of all configured
	pipes.			pipes.
	.Sh SEE ALSO			.Sh SEE ALSO
	.Xr setsockopt 2 ,			.Xr setsockopt 2 ,
	.Xr if_bridge 4 ,			.Xr if_bridge 4 ,
	.Xr ip 4 ,			.Xr ip 4 ,
	.Xr ipfw 8 ,			.Xr ipfw 8 ,
				donnerUnsubmitted Not Done Inline Actions dito donner: dito
				kpAuthorUnsubmitted Done Inline Actions This one we absolutely want to keep. Both ipfw and pf can be used to send traffic to dummynet, so we want to point at both. kp: This one we absolutely want to keep. Both ipfw and pf can be used to send traffic to dummynet…
				.Xr dnctl 8 ,
	.Xr sysctl 8			.Xr sysctl 8
	.Sh HISTORY			.Sh HISTORY
	The			The
	.Nm			.Nm
	facility			facility
	was initially implemented as a testing tool for			was initially implemented as a testing tool for
	.Tn TCP			.Tn TCP
	congestion control by			congestion control by
	.An Luigi Rizzo Aq Mt luigi@iet.unipi.it ,			.An Luigi Rizzo Aq Mt luigi@iet.unipi.it ,
	as described on ACM Computer Communication Review, Jan.97 issue.			as described on ACM Computer Communication Review, Jan.97 issue.
	Later it has been modified to work at the			Later it has been modified to work at the
	.Tn IP			.Tn IP
	and bridging levels, integrated with the			and bridging levels, integrated with the
	.Xr ipfw 4			.Xr ipfw 4
	packet filter, and extended to			packet filter, and extended to
	support multiple queueing and scheduling policies.			support multiple queueing and scheduling policies.