Debian Codegraph @

upstream/debian-unstable/man8/dcb-buffer.8

raw
1 .TH DCB-BUFFER 8 "12 November 2020" "iproute2" "Linux"
2 .SH NAME
3 dcb-buffer \- show / manipulate port buffer settings 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 buffer
14 .RI "{ " COMMAND " | " help " }"
15 .sp
16
17 .ti -8
18 .B dcb buffer show dev
19 .RI DEV
20 .RB "[ " prio-buffer " ]"
21 .RB "[ " buffer-size " ]"
22 .RB "[ " total-size " ]"
23
24 .ti -8
25 .B dcb buffer set dev
26 .RI DEV
27 .RB "[ " prio-buffer " " \fIPRIO-MAP " ]"
28 .RB "[ " buffer-size " " \fISIZE-MAP " ]"
29
30 .ti -8
31 .IR PRIO-MAP " := [ " PRIO-MAP " ] " PRIO-MAPPING
32
33 .ti -8
34 .IR PRIO-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fIBUFFER\fR
35
36 .ti -8
37 .IR SIZE-MAP " := [ " SIZE-MAP " ] " SIZE-MAPPING
38
39 .ti -8
40 .IR SIZE-MAPPING " := { " BUFFER " | " \fBall " }" \fB:\fISIZE\fR
41
42 .ti -8
43 .IR PRIO " := { " \fB0\fR " .. " \fB7\fR " }"
44
45 .ti -8
46 .IR BUFFER " := { " \fB0\fR " .. " \fB7\fR " }"
47
48 .ti -8
49 .IR SIZE " := { " INTEGER " | " INTEGER\fBK\fR " | " INTEGER\fBM\fR " | " ... " }"
50
51 .SH DESCRIPTION
52
53 .B dcb buffer
54 is used to configure assignment of traffic to port buffers based on traffic
55 priority, and sizes of those buffers. It can also be used to inspect the current
56 configuration, as well as total device memory that the port buffers take.
57
58 .SH PARAMETERS
59
60 For read-write parameters, the following describes only the write direction,
61 i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the
62 parameter name is to be used as a simple keyword without further arguments. This
63 instructs the tool to show the value of a given parameter. When no parameters
64 are given, the tool shows the complete buffer configuration.
65
66 .TP
67 .B total-size
68 A read-only property that shows the total device memory taken up by port
69 buffers. This might be more than a simple sum of individual buffer sizes if
70 there are any hidden or internal buffers.
71
72 .TP
73 .B prio-buffer \fIPRIO-MAP
74 \fIPRIO-MAP\fR uses the array parameter syntax, see
75 .BR dcb (8)
76 for details. Keys are priorities, values are buffer indices. For each priority,
77 sets a buffer where traffic with that priority is directed to.
78
79 .TP
80 .B buffer-size \fISIZE-MAP
81 \fISIZE-MAP\fR uses the array parameter syntax, see
82 .BR dcb (8)
83 for details. Keys are buffer indices, values are sizes of that buffer in bytes.
84 The sizes can use the notation documented in section PARAMETERS at
85 .BR tc (8).
86 Note that the size requested by the tool can be rounded or capped by the driver
87 to satisfy the requirements of the device.
88
89 .SH EXAMPLE & USAGE
90
91 Configure the priomap in a one-to-one fashion:
92
93 .P
94 # dcb buffer set dev eth0 prio-buffer 0:0 1:1 2:2 3:3 4:4 5:5 6:6 7:7
95
96 Set sizes of all buffers to 10KB, except for buffer 6, which will have the size
97 1MB:
98
99 .P
100 # dcb buffer set dev eth0 buffer-size all:10K 6:1M
101
102 Show what was set:
103
104 .P
105 # dcb buffer show dev eth0
106 .br
107 prio-buffer 0:0 1:1 2:2 3:3 4:4 5:5 6:6 7:7
108 .br
109 buffer-size 0:10Kb 1:10Kb 2:10Kb 3:10Kb 4:10Kb 5:10Kb 6:1Mb 7:10Kb
110 .br
111 total-size 1222Kb
112
113 .SH EXIT STATUS
114 Exit status is 0 if command was successful or a positive integer upon failure.
115
116 .SH SEE ALSO
117 .BR dcb (8)
118
119 .SH REPORTING BUGS
120 Report any bugs to the Network Developers mailing list
121 .B <[email protected]>
122 where the development and maintenance is primarily done.
123 You do not have to be subscribed to the list to send a message there.
124
125 .SH AUTHOR
126 Petr Machata <[email protected]>