usr/src/man/man7ipp/tokenmt.7ipp

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH TOKENMT 7IPP "April 9, 2016"
   7 .SH NAME
   8 tokenmt \- Single and Two Rate Three Conformance Level Meter
   9 .SH DESCRIPTION
  10 .LP
  11 The \fBtokenmt\fR module can be configured as a Single or a Two Rate meter.
  12 Packets are deemed to belong to one of the three levels - Red, Yellow or Green
  13 - depending on the configured rate(s) and the burst sizes. When configured as a
  14 Single Rate meter, \fBtokenmt\fR can operate with just the Green and Red
  15 levels.
  16 .sp
  17 .LP
  18 Configuration parameters for \fBtokenmt\fR correspond to definitions in \fIRFC-
  19 2697\fR and \fIRFC- 2698\fR as follows:
  20 .sp
  21 .LP
  22 Configuring \fBtokenmt\fR as a Single Rate meter (from \fIRFC- 2697\fR):
  23 .br
  24 .in +2
  25 committed_rate - CIR
  26 .in -2
  27 .br
  28 .in +2
  29 committed_burst - CBS
  30 .in -2
  31 .br
  32 .in +2
  33 peak_burst - EBS
  34 .in -2
  35 .sp
  36 .LP
  37 (thus 'peak_burst' for a single rate meter is actually the 'excess  burst' in
  38 the RFC. However, throughout the text the parameter name "peak burst" is used.)
  39 .sp
  40 .LP
  41 Configuring tokenmt as a Two Rate meter (from \fIRFC- 2698\fR):
  42 .br
  43 .in +2
  44 committed_rate - CIR
  45 .in -2
  46 .br
  47 .in +2
  48 peak_rate - PIR
  49 .in -2
  50 .br
  51 .in +2
  52 committed_burst - CBS
  53 .in -2
  54 .br
  55 .in +2
  56 peak_burst - PBS
  57 .in -2
  58 .sp
  59 .LP
  60 The meter is implemented using token buckets C and P, which initially hold
  61 tokens equivalent to committed and peak burst sizes (bits) respectively. When a
  62 packet of size \fI B\fR bits arrive at time \fI t\fR, the following occurs:
  63 .sp
  64 .in +2
  65 .nf
  66 When operating as a Single Rate meter, the outcome (level)
  67 is decided as follows:
  68         - Update tokens in C and P
  69               o Compute no. of tokens accumulated since the
  70                 last time packet was seen at the committed rate as
  71                 T(t) = committed rate * (t - t')
  72                 (where t' is the time the last packet was seen)
  73               o Add T tokens to C up to a maximum of committed burst
  74                 size. Add remaining tokens ((C+T) - Committed Burst),
  75                 if any, to P, to a maximum of peak burst size.
  76         - Decide outcome
  77               o If not color aware
  78                       o If B <= C, outcome is GREEN and C -= B.
  79                       o Else, if B <= P, outcome is YELLOW and P -= B.
  80                       o Else, outcome is Red.
  81               o Else,
  82                       o obtain DSCP from packet
  83                       o obtain color from color_map, color_map[DSCP]
  84                       o if (color is GREEN) and (B <= C), outcome is
  85                         GREEN and C -= B.
  86                       o Else, if (color is GREEN or YELLOW) and
  87                         (B <= P), outcome is YELLOW and  P -= B.
  88                       o Else, outcome is RED.
  89      Note that if peak_burst and yellow_next_actions are
  90      not specified (that is, a single rate meter with two
  91      outcomes), the outcome is never YELLOW.
  92 .fi
  93 .in -2
  94
  95 .sp
  96 .LP
  97 When operating as a Two Rate meter, the outcome (level) is decided as follows:
  98 .sp
  99 .in +2
 100 .nf
 101 - Update tokens in C and P
 102                   o Compute no. of tokens accumulated since the last time a
 103                     packet was seen at the committed and peak rates as
 104                     Tc(t) = committed rate * (t - t')
 105                     Tp(t) = peak rate * (t - t')
 106                     (where t' is the time the last packet was seen)
 107                   o Add Tc to C up to a maximum of committed burst size
 108                   o Add Tp to P up to a maximum of peak burst size
 109              - Decide outcome
 110                   o If not color aware
 111                         o If B > P, outcome is RED.
 112                         o Else, if B > C, outcome is YELLOW and P -= B
 113                         o Else, outcome is GREEN and C -= B & P -= B
 114                   o Else,
 115                         o obtain DSCP from packet
 116                         o obtain color from color_map, color_map[DSCP]
 117                         o if (color is RED) or (B > P), outcome is RED
 118                         o Else, if (color is YELLOW) or (B > C),
 119                           outcome is YELLOW and P -= B
 120                         o Else, outcome is GREEN and C -= B & P -= B
 121 .fi
 122 .in -2
 123
 124 .SH STATISTICS
 125 .LP
 126 The \fBtokenmt\fR module exports the following statistics through \fBkstat\fR:
 127 .sp
 128 .LP
 129 Global statistics:
 130 .sp
 131 .in +2
 132 .nf
 133 module: tokenmt                          instance: <action id>
 134   name: tokenmt statistics               class <action name>
 135         epackets                         <number of packets in error>
 136         green_bits                       <number of bits in green>
 137         green_packets                    <number of packets in green>
 138         red_bits                         <number of bits in red>
 139         red_packets                      <number of packets in red>
 140         yellow_bits                      <number of bits in yellow>
 141         yellow packets                   <number of packets in yellow>
 142 .fi
 143 .in -2
 144
 145 .SH FILES
 146 .ne 2
 147 .na
 148 \fB\fB/kernel/ipp/sparcv9/tokenmt\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 64-bit module (SPARC only.)
 153 .RE
 154
 155 .SH SEE ALSO
 156 .LP
 157 \fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp),
 158 \fBflowacct\fR(7ipp), \fBipqos\fR(7ipp), \fBipgpc\fR(7ipp),
 159 \fBtswtclmt\fR(7ipp)
 160 .sp
 161 .LP
 162 \fIRFC 2697, A Single Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em
 163 The Internet Society, 1999
 164 .sp
 165 .LP
 166 \fIRFC 2698, A Two Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em The
 167 Internet Society, 1999