8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man7ipp / ipgpc.7ipp
blob367b9711182c58bca77253fe0d101965db1a81c9
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 IPGPC 7IPP "Sep 29, 2004"
7 .SH NAME
8 ipgpc \- IP Generic Packet Classifier
9 .SH DESCRIPTION
10 .sp
11 .LP
12 The IP Generic Packet Classifier (\fBipgpc\fR) module provides packet
13 classification at the Solaris IP layer. \fBipgpc\fR is an implementation of the
14 Multi-Field (MF) classifier as described in \fIRFC2475: An Architecture for
15 Differentiated Services\fR.
16 .sp
17 .LP
18 The classifier is configured, at startup or dynamically, using a set of
19 "filters." Filters describe selectors that are matched against input packets
20 that are processed by the classifier. Some selectors feature exact matching
21 data points, while others utilize non-exact or wildcard data points.
22 .sp
23 .LP
24 Each filter is associated with a class describing the next actions to process a
25 packet. There is a many-to-one (M-to-1) mapping relationship between filters
26 and a class. Additionally, each class is aware of which filters are associated
27 with it. A class is configured with a class name and a next action.
28 .sp
29 .LP
30 Unlike traditional classifiers used in edge routers, \fBipgpc\fR is designed
31 for a host or server device. A host-based classifier provides access to more
32 resources and data than edge routers. User, project, and interface information
33 are available at the host.
34 .SH STATISTICS
35 .sp
36 .LP
37 The \fBipgpc\fR module exports global and per-class statistics (available
38 through kstat:)
39 .sp
40 .LP
41 Global statistics:
42 .sp
43 .in +2
44 .nf
45 module: ipgpc                           instance:<action id>
46 name:   ipgpc global stats              class: <action name>
47         crtime
48         snaptime
49         nbytes                          <number of classified bytes>
50         nclasses                        <number of classes>
51         nfilters                        <number of filters>
52         npackets                        <number of classified packets>
53         epackets                        <number of packets in error>
54 .fi
55 .in -2
57 .sp
58 .LP
59 Per-class statistics:
60 .sp
61 .in +2
62 .nf
63 module: ipgpc                           instance:<action id>
64 name:   <class name>                    class: <action name>
65         crtime
66         snaptime
67         last match                      <time of last match>
68         nbytes                          <number of classified bytes>
69         npackets                        <number of classified packets>
70 .fi
71 .in -2
73 .SH FILES
74 .sp
75 .ne 2
76 .na
77 \fB\fB/kernel/ipp/sparcv9/ipgpc\fR\fR
78 .ad
79 .RS 29n
80 64-bit module (SPARC only.)
81 .RE
83 .SH SEE ALSO
84 .sp
85 .LP
86 \fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp),
87 \fBflowacct\fR(7ipp), \fBipqos\fR(7ipp), \fBtokenmt\fR(7ipp),
88 \fBtswtclmt\fR(7ipp)
89 .sp
90 .LP
91 \fIRFC 2475, An Architecture for Differentiated Services\fR S. Blake, D. Black,
92 M. Carlson, E. Davies, Z. Wang, W. Weiss \(em The Internet Society, 1998