diff options
Diffstat (limited to 'usr/src/man/man7ipp')
| -rw-r--r-- | usr/src/man/man7ipp/Makefile | 32 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/dlcosmk.7ipp | 59 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/dscpmk.7ipp | 66 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/flowacct.7ipp | 68 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/ipgpc.7ipp | 94 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/ipqos.7ipp | 187 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/tokenmt.7ipp | 172 | ||||
| -rw-r--r-- | usr/src/man/man7ipp/tswtclmt.7ipp | 76 |
8 files changed, 754 insertions, 0 deletions
diff --git a/usr/src/man/man7ipp/Makefile b/usr/src/man/man7ipp/Makefile new file mode 100644 index 0000000000..fbf8694fbb --- /dev/null +++ b/usr/src/man/man7ipp/Makefile @@ -0,0 +1,32 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +# Copyright 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 7ipp + +MANFILES = dlcosmk.7ipp \ + dscpmk.7ipp \ + flowacct.7ipp \ + ipgpc.7ipp \ + ipqos.7ipp \ + tokenmt.7ipp \ + tswtclmt.7ipp + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) + + diff --git a/usr/src/man/man7ipp/dlcosmk.7ipp b/usr/src/man/man7ipp/dlcosmk.7ipp new file mode 100644 index 0000000000..8146421276 --- /dev/null +++ b/usr/src/man/man7ipp/dlcosmk.7ipp @@ -0,0 +1,59 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dlcosmk 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +dlcosmk \- Data Layer Class of Service Marker +.SH DESCRIPTION +.sp +.LP +The \fBdlcosmk\fR marker is an action module that is executed as a result of +classifying or metering packets. It marks the packet with a user priority +defined by the\fI IEEE 801.D\fR standard. This feature is only possible on a +\fBVLAN\fR device. +.sp +.LP +The 3-bit user priority is part of the \fI802.1Q\fR \fBVLAN\fR header tag that +is part of the ethernet header (carrying the IP packet). +.SH STATISTICS +.sp +.LP +The \fBdlcosmk\fR module exports the following statistics through \fBkstat\fR: +.sp +.LP +Global statistics: +.sp +.in +2 +.nf +module: dlcosmk instance: <action id> + name: dlcosmk statistics class <action name> + crtime + snaptime + b_band <b_band value> + dl_max <dl_max value> + usr_pri <configured CoS> + npackets <number of packets> + epackets <number of packets in error> + ipackets <number of packets not processed> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/dlcosmk\fR\fR +.ad +.sp .6 +.RS 4n +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdscpmk\fR(7ipp), \fBflowacct\fR(7ipp), +\fBipqos\fR(7ipp), \fBipgpc\fR(7ipp), \fBtokenmt\fR(7ipp), \fBtswtclmt\fR(7ipp) diff --git a/usr/src/man/man7ipp/dscpmk.7ipp b/usr/src/man/man7ipp/dscpmk.7ipp new file mode 100644 index 0000000000..89eb3b1717 --- /dev/null +++ b/usr/src/man/man7ipp/dscpmk.7ipp @@ -0,0 +1,66 @@ +'\" te +.\" Copyright (c) 2003, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dscpmk 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +dscpmk \- Differentiated Services Code Point Marker +.SH DESCRIPTION +.sp +.LP +The \fBdscpmk\fR marker is an action module that is executed as a result of +classifying or metering packets. It sets a codepoint in the IP header as +defined in \fIRFC-2474: Definition of the Differentiated Services Field (DS +Field) in the IPv4 and IPv6 Headers\fR. +.SH STATISTICS +.sp +.LP +The \fBdscpmk\fR module exports the following statistics available through +\fBkstat\fR: +.sp +.LP +Global statistics: +.sp +.in +2 +.nf +module: dscpmk instance: <action id> + name: dscpmk stats class <action name> + crtime + snaptime + npackets <number of packets> + epackets <number of packets in error> + ipackets <number of packets not processed> + dscp_unchanged <number of packets with DSCP unchanged> + dscp_changed <number of packets with DSCP changed> + +Also, for each DSCP the following is exported: + module: dscpmk instance: <action id> + name: dscpmk_dscp0x<DSCP> value class: <action name> + dscp <DSCP value> + npackets <number of packets for this DSCP> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/dscpmk\fR\fR +.ad +.RS 30n +.rt +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBflowacct\fR(7ipp), +\fBipqos\fR(7ipp), \fBipgpc\fR(7ipp), \fBtokenmt\fR(7ipp), \fBtswtclmt\fR(7ipp) +.sp +.LP +\fIRFC 2474, Definition of the Differentiated Services Field (DS Field) in the +IPv4 and IPv6 Headers\fR K. Nichols, S. Blake, F. Baker, D. Black \(em The +Internet Society, 1998 diff --git a/usr/src/man/man7ipp/flowacct.7ipp b/usr/src/man/man7ipp/flowacct.7ipp new file mode 100644 index 0000000000..84d1b8dee0 --- /dev/null +++ b/usr/src/man/man7ipp/flowacct.7ipp @@ -0,0 +1,68 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH flowacct 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +flowacct \- Flow Accouting module +.SH DESCRIPTION +.sp +.LP +The flow accounting module \fBflowacct\fR enables you to record flow details. +You use flow details to gather statistics and/or for billing purposes. +Accounting consists of recording flow details in a location you designate and +in a format that you can retrieve at a later stage. IPQoS accounting relies on +the exacct mechanism to store and retrieve flow information. +.sp +.LP +A flow is defined by the 5-tuple - saddr, sport, daddr, dport and protocol. +.sp +.LP +Typically, the accounting module is the last datapath element in a sequence of +actions. Flow attributes include ToS/DS, user id, project id, creation time +(time the flow was created), last seen (when pkts for the flow were last seen), +action name (instance that recorded the flow information), nbytes and npackets. +Attributes are split into groups entitled \fBbasic\fR and \fBextended\fR. The +basic group records only the nbytes, npackets and action name, while the +extended group is a superset of the basic group and records all attributes. The +attributes to be recorded, in addition to the accounting file that contains +flow details, are selected using \fBacctadm\fR(1M). The \fBflowacct\fR module +does not provide a mechanism to retrieve flow information from the accounting +file nor to interpret the retrieved information. +.SH STATISTICS +.sp +.LP +The flowacct module exports the following statistics available through kstat: +.sp +.in +2 +.nf +module: flowacct instance: <action id> + name: Flowacct statistics class <action name> + bytes_in_tbl <bytes in the flow table> + epackets <packets in error> + flows_in_tbl <flow records in the flow table> + nbytes <number of bytes through this instance> + npackets <number of packets> + usedmem <memory, in bytes, used by the flow table> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/flowacct\fR\fR +.ad +.sp .6 +.RS 4n +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBacctadm\fR(1M), \fBlibexacct3LIB\fR, +\fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), \fBipqos\fR(7ipp), \fBipgpc\fR(7ipp), +\fBtokenmt\fR(7ipp), \fBtswtclmt\fR(7ipp) diff --git a/usr/src/man/man7ipp/ipgpc.7ipp b/usr/src/man/man7ipp/ipgpc.7ipp new file mode 100644 index 0000000000..7ddea8dd06 --- /dev/null +++ b/usr/src/man/man7ipp/ipgpc.7ipp @@ -0,0 +1,94 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ipgpc 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +ipgpc \- IP Generic Packet Classifier +.SH DESCRIPTION +.sp +.LP +The IP Generic Packet Classifier (\fBipgpc\fR) module provides packet +classification at the Solaris IP layer. \fBipgpc\fR is an implementation of the +Multi-Field (MF) classifier as described in \fIRFC2475: An Architecture for +Differentiated Services\fR. +.sp +.LP +The classifier is configured, at startup or dynamically, using a set of +"filters." Filters describe selectors that are matched against input packets +that are processed by the classifier. Some selectors feature exact matching +data points, while others utilize non-exact or wildcard data points. +.sp +.LP +Each filter is associated with a class describing the next actions to process a +packet. There is a many-to-one (M-to-1) mapping relationship between filters +and a class. Additionally, each class is aware of which filters are associated +with it. A class is configured with a class name and a next action. +.sp +.LP +Unlike traditional classifiers used in edge routers, \fBipgpc\fR is designed +for a host or server device. A host-based classifier provides access to more +resources and data than edge routers. User, project, and interface information +are available at the host. +.SH STATISTICS +.sp +.LP +The \fBipgpc\fR module exports global and per-class statistics (available +through kstat:) +.sp +.LP +Global statistics: +.sp +.in +2 +.nf +module: ipgpc instance:<action id> +name: ipgpc global stats class: <action name> + crtime + snaptime + nbytes <number of classified bytes> + nclasses <number of classes> + nfilters <number of filters> + npackets <number of classified packets> + epackets <number of packets in error> +.fi +.in -2 + +.sp +.LP +Per-class statistics: +.sp +.in +2 +.nf +module: ipgpc instance:<action id> +name: <class name> class: <action name> + crtime + snaptime + last match <time of last match> + nbytes <number of classified bytes> + npackets <number of classified packets> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/ipgpc\fR\fR +.ad +.RS 29n +.rt +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), +\fBflowacct\fR(7ipp), \fBipqos\fR(7ipp), \fBtokenmt\fR(7ipp), +\fBtswtclmt\fR(7ipp) +.sp +.LP +\fIRFC 2475, An Architecture for Differentiated Services\fR S. Blake, D. Black, +M. Carlson, E. Davies, Z. Wang, W. Weiss \(em The Internet Society, 1998 diff --git a/usr/src/man/man7ipp/ipqos.7ipp b/usr/src/man/man7ipp/ipqos.7ipp new file mode 100644 index 0000000000..bf2ab82e2d --- /dev/null +++ b/usr/src/man/man7ipp/ipqos.7ipp @@ -0,0 +1,187 @@ +'\" te +.\" Copyright (c) 2002, Sun Microsystems Inc. +.\" All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ipqos 7ipp "25 Feb 2002" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +ipqos \- IP Quality of Service +.SH DESCRIPTION +.sp +.LP +\fBipqos\fR is an implementation of the Differentiated Services model defined +in \fIRFC2475: An Architecture for Differentiated Services\fR, which defines +the following entities: multi-field classifier, meter, marker, and dropper. The +Solaris implementation of \fBipqos\fR adds a flow accounting entity. +.sp +.LP +These entities can be combined into processing paths that constitute a series +of actions that are performed on groups of flows. The classifier groups +together flows and directs them in a given processing path. Classifier +configuration and path construction are achieved using the \fBipqosconf\fR(1M) +command. +.sp +.LP +A summary of the \fBipqos\fR entities follows. For more information, refer to +the corresponding man page for each entity. +.sp +.ne 2 +.mk +.na +\fBipgpc\fR +.ad +.RS 21n +.rt +An implementation of the classifier defined in the model. \fBipgpc\fR has been +extended and is able to select traffic based on IP header parameters, user id, +project id, interface name, interface group and direction. +.RE + +.sp +.ne 2 +.mk +.na +\fBtokenmt, tswtclmt\fR +.ad +.RS 21n +.rt +These modules implement different metering algorithms. \fBtokenmt\fR implements +both \fIRFC2697: A Single Rate Three Color Marker \fR and \fIRFC 2698: A Two +Rate Three Color Marker\fR. \fItswtclmt\fR implements \fIRFC2859: A Time +Sliding Window Three Color Marker\fR. These modules only implement the metering +functions defined in the RFCs. +.RE + +.sp +.ne 2 +.mk +.na +\fBdlcosmk\fR +.ad +.RS 21n +.rt +A marker entity that allows the setting of the user priority field of Ethernet +frames as defined in the \fIIEEE 802.1D\fR specification. \fBdlcosmk\fR is only +available with VLAN capable network interfaces. +.RE + +.sp +.ne 2 +.mk +.na +\fBdscpmk\fR +.ad +.RS 21n +.rt +A marker entity that enables the setting of the Differentiated Services Code +Point Value in the IP header as defined in \fIRFC 2474: Definition of the +Differentiated Services Field (DS Field)\fR in the IPv4 and IPv6 headers. +.RE + +.sp +.ne 2 +.mk +.na +\fBflowacct\fR +.ad +.RS 21n +.rt +An accounting module that utilizes the Solaris extended accounting facility. +\fBflowacct\fR logs all flows with parameters used to build a charge back +mechanism. +.RE + +.SH STATISTICS +.sp +.LP +\fBipqos\fR modules export statistics through the \fBkstat\fR facility. +Exported statistics contain the following common parameters: +.sp +.ne 2 +.mk +.na +\fBmodule\fR +.ad +.RS 12n +.rt +module name +.RE + +.sp +.ne 2 +.mk +.na +\fBinstance\fR +.ad +.RS 12n +.rt +dynamic parameter identifying a specific instance +.RE + +.sp +.ne 2 +.mk +.na +\fBname\fR +.ad +.RS 12n +.rt +a string for global statistics (for example, ipgpc global stat) or a class +name for per-class statistics for a classifier action +.RE + +.sp +.LP +To verify classifier configuration, generate traffic for each of the configured +classes and check that the statistic counters for the expected class are +increased. If you're unsure about the parameters for your traffic, you can use +\fBsnoop\fR(1M) to determine them. +.sp +.LP +Some actions have the instance id of the next configured action in their +statistics. This instance id can be used to follow the action processing path. +Instance id's -1 and -2 are the built-in actions continue and drop, +respectively. +.sp +.LP +Examples: +.sp +.LP +To retrieve all statistics for ipgpc: +.sp +.LP + \fBkstat -m ipgpc\fR +.sp +.LP +To retrieve statistics for the class http: +.sp +.LP + \fBkstat -m ipgpc -c http\fR +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), +\fBflowacct\fR(7ipp), \fBipgpc\fR(7ipp), \fBtokenmt\fR(7ipp), +\fBtswtclmt\fR(7ipp) +.sp +.LP +\fIRFC 2475, An Architecture for Differentiated Services\fR S. Blake, D. Black, +M. Carlson, E. Davies, Z. Wang, W. Weiss \(em The Internet Society, 1998 +.sp +.LP +\fIRFC 2474, Definition of the Differentiated Services Field (DS Field) in the +IPv4 and IPv6 Headers\fR K. Nichols, S. Blake, F. Baker, D. Black \(em The +Internet Society, 1998 +.sp +.LP +\fIRFC 2697, A Single Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em +The Internet Society, 1999 +.sp +.LP +\fIRFC 2698, A Two Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em The +Internet Society, 1999 +.sp +.LP +\fIRFC 2859, A Time Sliding Window Three Colour Marker (TSWTCM)\fR W. Fang, N. +Seddigh, B. Nandy \(em The Internet Society, 2000 diff --git a/usr/src/man/man7ipp/tokenmt.7ipp b/usr/src/man/man7ipp/tokenmt.7ipp new file mode 100644 index 0000000000..94e8bc49bc --- /dev/null +++ b/usr/src/man/man7ipp/tokenmt.7ipp @@ -0,0 +1,172 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH tokenmt 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +tokenmt \- Single and Two Rate Three Conformance Level Meter +.SH DESCRIPTION +.sp +.LP +The \fBtokenmt\fR module can be configured as a Single or a Two Rate meter. +Packets are deemed to belong to one of the three levels - Red, Yellow or Green +- depending on the configured rate(s) and the burst sizes. When configured as a +Single Rate meter, \fBtokenmt\fR can operate with just the Green and Red +levels. +.sp +.LP +Configuration parameters for \fBtokenmt\fR correspond to definitions in \fIRFC- +2697\fR and \fIRFC- 2698\fR as follows: +.sp +.LP +Configuring \fBtokenmt\fR as a Single Rate meter (from \fIRFC- 2697\fR): +.br +.in +2 +committed_rate - CIR +.in -2 +.br +.in +2 +committed_burst - CBS +.in -2 +.br +.in +2 +peak_burst - EBS +.in -2 +.sp +.LP +(thus 'peak_burst' for a single rate meter is actually the 'excess burst' in +the RFC. However, throughout the text the parameter name "peak burst" is used.) +.sp +.LP +Configuring tokenmt as a Two Rate meter (from \fIRFC- 2698\fR): +.br +.in +2 +committed_rate - CIR +.in -2 +.br +.in +2 +peak_rate - PIR +.in -2 +.br +.in +2 +committed_burst - CBS +.in -2 +.br +.in +2 +peak_burst - PBS +.in -2 +.sp +.LP +The meter is implemented using token buckets C and P, which initially hold +tokens equivalent to committed and peak burst sizes (bits) respectively. When a +packet of size \fI B\fR bits arrive at time \fI t\fR, the following occurs: +.sp +.in +2 +.nf +When operating as a Single Rate meter, the outcome (level) +is decided as follows: + - Update tokens in C and P + o Compute no. of tokens accumulated since the + last time packet was seen at the committed rate as + T(t) = committed rate * (t - t') + (where t' is the time the last packet was seen) + o Add T tokens to C up to a maximum of committed burst + size. Add remaining tokens ((C+T) - Commited Burst), + if any, to P, to a maximum of peak burst size. + - Decide outcome + o If not color aware + o If B <= C, outcome is GREEN and C -= B. + o Else, if B <= P, outcome is YELLOW and P -= B. + o Else, outcome is Red. + o Else, + o obtain DSCP from packet + o obtain color from color_map, color_map[DSCP] + o if (color is GREEN) and (B <= C), outcome is + GREEN and C -= B. + o Else, if (color is GREEN or YELLOW) and + (B <= P), outcome is YELLOW and P -= B. + o Else, outcome is RED. + Note that if peak_burst and yellow_next_actions are + not specified (that is, a single rate meter with two + outcomes), the outcome is never YELLOW. +.fi +.in -2 + +.sp +.LP +When operating as a Two Rate meter, the outcome (level) is decided as follows: +.sp +.in +2 +.nf +- Update tokens in C and P + o Compute no. of tokens accumulated since the last time a + packet was seen at the committed and peak rates as + Tc(t) = committed rate * (t - t') + Tp(t) = peak rate * (t - t') + (where t' is the time the last packet was seen) + o Add Tc to C up to a maximum of committed burst size + o Add Tp to P up to a maximum of peak burst size + - Decide outcome + o If not color aware + o If B > P, outcome is RED. + o Else, if B > C, outcome is YELLOW and P -= B + o Else, outcome is GREEN and C -= B & P -= B + o Else, + o obtain DSCP from packet + o obtain color from color_map, color_map[DSCP] + o if (color is RED) or (B > P), outcome is RED + o Else, if (color is YELLOW) or (B > C), + outcome is YELLOW and P -= B + o Else, outcome is GREEN and C -= B & P -= B +.fi +.in -2 + +.SH STATISTICS +.sp +.LP +The \fBtokenmt\fR module exports the following statistics through \fBkstat\fR: +.sp +.LP +Global statistics: +.sp +.in +2 +.nf +module: tokenmt instance: <action id> + name: tokenmt statistics class <action name> + epackets <number of packets in error> + green_bits <number of bits in green> + green_packets <number of packets in green> + red_bits <number of bits in red> + red_packets <number of packets in red> + yellow_bits <number of bits in yellow> + yellow packets <number of packets in yellow> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/tokenmt\fR\fR +.ad +.sp .6 +.RS 4n +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), +\fBflowacct\fR(7ipp), \fBipqos\fR(7ipp), \fBipgpc\fR(7ipp), +\fBtswtclmt\fR(7ipp) +.sp +.LP +\fIRFC 2697, A Single Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em +The Internet Society, 1999 +.sp +.LP +\fIRFC 2698, A Two Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em The +Internet Society, 1999 diff --git a/usr/src/man/man7ipp/tswtclmt.7ipp b/usr/src/man/man7ipp/tswtclmt.7ipp new file mode 100644 index 0000000000..e5d9b31dfa --- /dev/null +++ b/usr/src/man/man7ipp/tswtclmt.7ipp @@ -0,0 +1,76 @@ +'\" te +.\" Copyright (c) 2004, Sun Microsystems Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH tswtclmt 7ipp "29 Sep 2004" "SunOS 5.11" "IP Quality of Service Modules" +.SH NAME +tswtclmt \- Time Sliding Window Three Conformance Level Meter +.SH DESCRIPTION +.sp +.LP +The Time Sliding Window Three Conformance level meter (\fBtswtcl\fR) meters a +traffic stream and determines the conformance level of its packets. +.sp +.LP +Packets are deemed to belong to one of the three levels, Red, Yellow or Green, +depending on the committed and peak rate. +.sp +.LP +The meter provides an estimate of the running average bandwidth. It takes into +account burstiness and smoothes out its estimate to approximate the +longer-term measured sending rate of the traffic stream. +.sp +.LP +The estimated bandwidth approximates the running average bandwidth of the +traffic stream over a specific window (time interval). \fBtswtcl\fR estimates +the average bandwidth using a time-based estimator. When a packet arrives for a +class, \fBtswtcl\fR re-computes the average rate by using the rate in the last +window (time interval) and the size of the arriving packet. The window is then +slid to start at the current time (the packet arrival time). If the computed +rate is less than the committed configuration parameter, the packet is deemed +Green; else if the rate is less than the peak rate, it is Yellow; else Red. To +avoid dropping multiple packets within a TCP window, \fBtswtcl\fR +probabilistically assigns one of the three conformance level to the packet. +.SH STATISTICS +.sp +.LP +The \fBtswtcl\fR module exports global and per-class statistics through kstat: +.sp +.LP +Global statistics: +.sp +.in +2 +.nf +module: tswtclmt instance: <action id> + name: tswtclmt statistics class <action name> + green_bits <number of bit in green> + green_packets <number of packets in green> + red_bits <number of bits in red> + red_packets <number of packets in red> + yellow_bits <number of bits in yellow> + yellow_packets <number of packets in yellow> +.fi +.in -2 + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/kernel/ipp/sparcv9/tswtclmt\fR\fR +.ad +.sp .6 +.RS 4n +64-bit module (SPARC only.) +.RE + +.SH SEE ALSO +.sp +.LP +\fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), +\fBflowacct\fR(7ipp), \fBipqos\fR(7ipp), \fBipgpc\fR(7ipp), \fBtokenmt\fR(7ipp) +.sp +.LP +\fIRFC 2859, A Time Sliding Window Three Colour Marker (TSWTCM)\fR W. Fang, N. +Seddigh, B. Nandy \(em The Internet Society, 2000 |