| 1 |
.TH DCB-APP 8 "6 December 2020" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
dcb-app \- show / manipulate application priority table of |
| 4 |
the DCB (Data Center Bridging) subsystem |
| 5 |
.SH SYNOPSIS |
| 6 |
.sp |
| 7 |
.ad l |
| 8 |
.in +8 |
| 9 |
|
| 10 |
.ti -8 |
| 11 |
.B dcb |
| 12 |
.RI "[ " OPTIONS " ] " |
| 13 |
.B app |
| 14 |
.RI "{ " COMMAND " | " help " }" |
| 15 |
.sp |
| 16 |
|
| 17 |
.ti -8 |
| 18 |
.B dcb app " { " show " | " flush " } " dev |
| 19 |
.RI DEV |
| 20 |
.RB "[ " default-prio " ]" |
| 21 |
.RB "[ " ethtype-prio " ]" |
| 22 |
.RB "[ " stream-port-prio " ]" |
| 23 |
.RB "[ " dgram-port-prio " ]" |
| 24 |
.RB "[ " port-prio " ]" |
| 25 |
.RB "[ " dscp-prio " ]" |
| 26 |
.RB "[ " pcp-prio " ]" |
| 27 |
|
| 28 |
.ti -8 |
| 29 |
.B dcb app " { " add " | " del " | " replace " } " dev |
| 30 |
.RI DEV |
| 31 |
.RB "[ " default-prio " " \fIPRIO-LIST\fB " ]" |
| 32 |
.RB "[ " ethtype-prio " " \fIET-MAP\fB " ]" |
| 33 |
.RB "[ " stream-port-prio " " \fIPORT-MAP\fB " ]" |
| 34 |
.RB "[ " dgram-port-prio " " \fIPORT-MAP\fB " ]" |
| 35 |
.RB "[ " port-prio " " \fIPORT-MAP\fB " ]" |
| 36 |
.RB "[ " dscp-prio " " \fIDSCP-MAP\fB " ]" |
| 37 |
.RB "[ " pcp-prio " " \fIPCP-MAP\fB " ]" |
| 38 |
|
| 39 |
.ti -8 |
| 40 |
.IR PRIO-LIST " := [ " PRIO-LIST " ] " PRIO |
| 41 |
|
| 42 |
.ti -8 |
| 43 |
.IR ET-MAP " := [ " ET-MAP " ] " ET-MAPPING |
| 44 |
|
| 45 |
.ti -8 |
| 46 |
.IR ET-MAPPING " := " ET\fB:\fIPRIO\fR |
| 47 |
|
| 48 |
.ti -8 |
| 49 |
.IR PORT-MAP " := [ " PORT-MAP " ] " PORT-MAPPING |
| 50 |
|
| 51 |
.ti -8 |
| 52 |
.IR PORT-MAPPING " := " PORT\fB:\fIPRIO\fR |
| 53 |
|
| 54 |
.ti -8 |
| 55 |
.IR DSCP-MAP " := [ " DSCP-MAP " ] " DSCP-MAPPING |
| 56 |
|
| 57 |
.ti -8 |
| 58 |
.IR DSCP-MAPPING " := { " DSCP " | " \fBall " }" \fB:\fIPRIO\fR |
| 59 |
|
| 60 |
.ti -8 |
| 61 |
.IR PCP-MAP " := [ " PCP-MAP " ] " PCP-MAPPING |
| 62 |
|
| 63 |
.ti -8 |
| 64 |
.IR PCP-MAPPING " := " PCP\fB:\fIPRIO\fR |
| 65 |
|
| 66 |
.ti -8 |
| 67 |
.IR ET " := { " \fB0x600\fR " .. " \fB0xffff\fR " }" |
| 68 |
|
| 69 |
.ti -8 |
| 70 |
.IR PORT " := { " \fB1\fR " .. " \fB65535\fR " }" |
| 71 |
|
| 72 |
.ti -8 |
| 73 |
.IR DSCP " := { " \fB0\fR " .. " \fB63\fR " }" |
| 74 |
|
| 75 |
.ti -8 |
| 76 |
.IR PCP " := { " \fB0(nd/de)\fR " .. " \fB7(nd/de)\fR " }" |
| 77 |
|
| 78 |
.ti -8 |
| 79 |
.IR PRIO " := { " \fB0\fR " .. " \fB7\fR " }" |
| 80 |
|
| 81 |
.SH DESCRIPTION |
| 82 |
|
| 83 |
.B dcb app |
| 84 |
is used to configure the APP table, or application priority table in the DCB (Data |
| 85 |
Center Bridging) subsystem. The APP table is used to assign priority to traffic |
| 86 |
based on values in one of several headers: EtherType, L4 destination port, or |
| 87 |
DSCP. It also allows configuration of port-default priority that is chosen if no |
| 88 |
other prioritization rule applies. |
| 89 |
|
| 90 |
DCB APP entries are 3-tuples of selector, protocol ID, and priority. Selector is |
| 91 |
an enumeration that picks one of the prioritization namespaces. Currently it |
| 92 |
mostly corresponds to configurable parameters described below. Protocol ID is a |
| 93 |
value in the selector namespace. E.g. for EtherType selector, protocol IDs are |
| 94 |
the individual EtherTypes, for DSCP they are individual code points. The |
| 95 |
priority is the priority that should be assigned to traffic that matches the |
| 96 |
selector and protocol ID. |
| 97 |
|
| 98 |
The APP table is a set of DCB APP entries. The only requirement is that |
| 99 |
duplicate entries are not added. Notably, it is valid to have conflicting |
| 100 |
priority assignment for the same selector and protocol ID. For example, the set |
| 101 |
of two APP entries (DSCP, 10, 1) and (DSCP, 10, 2), where packets with DSCP of |
| 102 |
10 should get priorities 1 and 2, form a well-defined APP table. The |
| 103 |
.B dcb app |
| 104 |
tool allows low-level management of the app table by adding and deleting |
| 105 |
individual APP 3-tuples through |
| 106 |
.B add |
| 107 |
and |
| 108 |
.B del |
| 109 |
commands. On the other hand, the command |
| 110 |
.B replace |
| 111 |
does what one would typically want in this situation--first adds the new |
| 112 |
configuration, and then removes the obsolete one, so that only one |
| 113 |
prioritization is in effect for a given selector and protocol ID. |
| 114 |
|
| 115 |
.SH COMMANDS |
| 116 |
|
| 117 |
.TP |
| 118 |
.B show |
| 119 |
Displays all entries with a given selector. When no selector is given, shows all |
| 120 |
APP table entries categorized per selector. |
| 121 |
|
| 122 |
.TP |
| 123 |
.B flush |
| 124 |
Removes all entries with a given selector. When no selector is given, removes all |
| 125 |
APP table entries. |
| 126 |
|
| 127 |
.TP |
| 128 |
.B add |
| 129 |
.TQ |
| 130 |
.B del |
| 131 |
Add and, respectively, remove individual APP 3-tuples to and from the DCB APP |
| 132 |
table. |
| 133 |
|
| 134 |
.TP |
| 135 |
.B replace |
| 136 |
Takes the list of entries mentioned as parameter, and adds those that are not |
| 137 |
present in the APP table yet. Then removes those entries, whose selector and |
| 138 |
protocol ID have been mentioned as parameter, but not with the exact same |
| 139 |
priority. This has the effect of, for the given selector and protocol ID, |
| 140 |
ensuring that the table only contains the priority (or priorities) given as |
| 141 |
parameter. |
| 142 |
|
| 143 |
.SH PARAMETERS |
| 144 |
|
| 145 |
The following table shows parameters in a way that they would be used with |
| 146 |
\fBadd\fR, \fBdel\fR and \fBreplace\fR commands. For \fBshow\fR and \fBflush\fR, |
| 147 |
the parameter name is to be used as a simple keyword without further arguments. |
| 148 |
|
| 149 |
.TP |
| 150 |
.B default-prio \fIPRIO-LIST |
| 151 |
The priority to be used for traffic whose priority is otherwise |
| 152 |
unspecified. The argument is a list of individual priorities. Note that |
| 153 |
.B default-prio |
| 154 |
rules are configured as triplets (\fBEtherType\fR, \fB0\fR, \fIPRIO\fR). |
| 155 |
.B dcb app |
| 156 |
translates these rules to the symbolic name |
| 157 |
.B default-prio |
| 158 |
and back. |
| 159 |
|
| 160 |
.TP |
| 161 |
.B ethtype-prio \fIET-MAP |
| 162 |
\fIET-MAP\fR uses the array parameter syntax, see |
| 163 |
.BR dcb (8) |
| 164 |
for details. Keys are EtherType values. Values are priorities to be assigned to |
| 165 |
traffic with the matching EtherType. |
| 166 |
|
| 167 |
.TP |
| 168 |
.B stream-port-prio \fIPORT-MAP |
| 169 |
.TQ |
| 170 |
.B dgram-port-prio \fIPORT-MAP |
| 171 |
.TQ |
| 172 |
.B port-prio \fIPORT-MAP |
| 173 |
\fIPORT-MAP\fR uses the array parameter syntax, see |
| 174 |
.BR dcb (8) |
| 175 |
for details. Keys are L4 destination port numbers that match on, respectively, |
| 176 |
TCP and SCTP traffic, UDP and DCCP traffic, and either of those. Values are |
| 177 |
priorities that should be assigned to matching traffic. |
| 178 |
|
| 179 |
.TP |
| 180 |
.B dscp-prio \fIDSCP-MAP |
| 181 |
\fIDSCP-MAP\fR uses the array parameter syntax, see |
| 182 |
.BR dcb (8) |
| 183 |
for details. Keys are DSCP points, values are priorities assigned to |
| 184 |
traffic with matching DSCP. DSCP points can be written either directly as |
| 185 |
numeric values, or using symbolic names specified in |
| 186 |
.B /etc/iproute2/rt_dsfield |
| 187 |
(however note that the file specifies full 8-bit dsfield values, whereas |
| 188 |
.B dcb app |
| 189 |
will only use the higher six bits). |
| 190 |
.B dcb app show |
| 191 |
will similarly format DSCP values as symbolic names if possible. The |
| 192 |
command line option |
| 193 |
.B -N |
| 194 |
turns the show translation off. |
| 195 |
|
| 196 |
.TP |
| 197 |
.B pcp-prio \fIPCP-MAP |
| 198 |
\fIPCP-MAP\fR uses the array parameter syntax, see |
| 199 |
.BR dcb (8) |
| 200 |
for details. Keys are PCP/DEI. Values are priorities assigned to traffic with |
| 201 |
matching PCP/DEI. PCP/DEI values are written as a combination of numeric and |
| 202 |
symbolic values, to accommodate both. PCP is always in numerical form, e.g., |
| 203 |
0 .. 7 and DEI in symbolic form, e.g., 'de' (drop-eligible), indicating that the |
| 204 |
DEI bit is 1 or 'nd' (not-drop-eligible), indicating that the DEI bit is 0. |
| 205 |
In combination 2de:1 translates to a mapping of PCP=2 and DEI=1 to priority 1. |
| 206 |
|
| 207 |
.SH EXAMPLE & USAGE |
| 208 |
|
| 209 |
Prioritize traffic with DSCP 0 to priority 0, 24 to 3 and 48 to 6: |
| 210 |
|
| 211 |
.P |
| 212 |
# dcb app add dev eth0 dscp-prio 0:0 24:3 48:6 |
| 213 |
|
| 214 |
Add another rule to configure DSCP 24 to priority 2 and show the result: |
| 215 |
|
| 216 |
.P |
| 217 |
# dcb app add dev eth0 dscp-prio 24:2 |
| 218 |
.br |
| 219 |
# dcb app show dev eth0 dscp-prio |
| 220 |
.br |
| 221 |
dscp-prio 0:0 CS3:2 CS3:3 CS6:6 |
| 222 |
.br |
| 223 |
# dcb -N app show dev eth0 dscp-prio |
| 224 |
.br |
| 225 |
dscp-prio 0:0 24:2 24:3 48:6 |
| 226 |
|
| 227 |
Reconfigure the table so that the only rule for DSCP 24 is for assignment of |
| 228 |
priority 4: |
| 229 |
|
| 230 |
.P |
| 231 |
# dcb app replace dev eth0 dscp-prio 24:4 |
| 232 |
.br |
| 233 |
# dcb app -N show dev eth0 dscp-prio |
| 234 |
.br |
| 235 |
dscp-prio 0:0 24:4 48:6 |
| 236 |
|
| 237 |
Flush all DSCP rules: |
| 238 |
|
| 239 |
.P |
| 240 |
# dcb app flush dev eth0 dscp-prio |
| 241 |
.br |
| 242 |
# dcb app show dev eth0 dscp-prio |
| 243 |
.br |
| 244 |
(nothing) |
| 245 |
|
| 246 |
Add a rule to map traffic with PCP 1 and DEI 0 to priority 1 and PCP 2 and DEI 1 |
| 247 |
to priority 2: |
| 248 |
|
| 249 |
.P |
| 250 |
# dcb app add dev eth0 pcp-prio 1nd:1 2de:2 |
| 251 |
.br |
| 252 |
# dcb app show dev eth0 pcp-prio |
| 253 |
.br |
| 254 |
pcp-prio 1nd:1 2de:2 |
| 255 |
|
| 256 |
.SH EXIT STATUS |
| 257 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 258 |
|
| 259 |
.SH SEE ALSO |
| 260 |
.BR dcb (8) |
| 261 |
|
| 262 |
.SH REPORTING BUGS |
| 263 |
Report any bugs to the Network Developers mailing list |
| 264 |
.B <[email protected]> |
| 265 |
where the development and maintenance is primarily done. |
| 266 |
You do not have to be subscribed to the list to send a message there. |
| 267 |
|
| 268 |
.SH AUTHOR |
| 269 |
Petr Machata <[email protected]> |