| Michal Soltys | 9bac173 | 2011-10-31 22:56:38 +0100 | [diff] [blame] | 1 | .TH HFSC 8 "31 October 2011" iproute2 Linux |
| Michal Soltys | 41f6004 | 2011-10-26 04:15:21 -0400 | [diff] [blame] | 2 | . |
| 3 | .SH NAME |
| 4 | HFSC \- Hierarchical Fair Service Curve's control under linux |
| 5 | . |
| 6 | .SH SYNOPSIS |
| 7 | .nf |
| 8 | tc qdisc add ... hfsc [ \fBdefault\fR CLASSID ] |
| 9 | |
| 10 | tc class add ... hfsc [ [ \fBrt\fR SC ] [ \fBls\fR SC ] | [ \fBsc\fR SC ] ] [ \fBul\fR SC ] |
| 11 | |
| 12 | \fBrt\fR : realtime service curve |
| 13 | \fBls\fR : linkshare service curve |
| 14 | \fBsc\fR : rt+ls service curve |
| 15 | \fBul\fR : upperlimit service curve |
| 16 | |
| 17 | \(bu at least one of \fBrt\fR, \fBls\fR or \fBsc\fR must be specified |
| 18 | \(bu \fBul\fR can only be specified with \fBls\fR or \fBsc\fR |
| 19 | . |
| 20 | .IP "SC := [ [ \fBm1\fR BPS ] \fBd\fR SEC ] \fBm2\fR BPS" |
| 21 | \fBm1\fR : slope of the first segment |
| 22 | \fBd\fR : x\-coordinate of intersection |
| 23 | \fBm2\fR : slope of the second segment |
| 24 | .PP |
| 25 | .IP "SC := [ [ \fBumax\fR BYTE ] \fBdmax\fR SEC ] \fBrate\fR BPS" |
| 26 | \fBumax\fR : maximum unit of work |
| 27 | \fBdmax\fR : maximum delay |
| 28 | \fBrate\fR : rate |
| 29 | .PP |
| 30 | .fi |
| 31 | For description of BYTE, BPS and SEC \- please see \fBUNITS\fR |
| 32 | section of \fBtc\fR(8). |
| 33 | . |
| 34 | .SH DESCRIPTION (qdisc) |
| Pavel Šimerda | a89d532 | 2015-04-07 08:41:36 -0700 | [diff] [blame] | 35 | HFSC qdisc has only one optional parameter \- \fBdefault\fR. CLASSID specifies |
| Michal Soltys | 41f6004 | 2011-10-26 04:15:21 -0400 | [diff] [blame] | 36 | the minor part of the default classid, where packets not classified by other |
| 37 | means (e.g. u32 filter, CLASSIFY target of iptables) will be enqueued. If |
| 38 | \fBdefault\fR is not specified, unclassified packets will be dropped. |
| 39 | . |
| 40 | .SH DESCRIPTION (class) |
| 41 | HFSC class is used to create a class hierarchy for HFSC scheduler. For |
| 42 | explanation of the algorithm, and the meaning behind \fBrt\fR, \fBls\fR, |
| 43 | \fBsc\fR and \fBul\fR service curves \- please refer to \fBtc\-hfsc\fR(7). |
| 44 | |
| 45 | As you can see in \fBSYNOPSIS\fR, service curve (SC) can be specified in two |
| 46 | ways. Either as maximum delay for certain amount of work, or as a bandwidth |
| 47 | assigned for certain amount of time. Obviously, \fBm1\fR is simply |
| 48 | \fBumax\fR/\fBdmax\fR. |
| 49 | |
| 50 | Both \fBm2\fR and \fBrate\fR are mandatory. If you omit other |
| 51 | parameters, you will specify linear service curve. |
| 52 | . |
| 53 | .SH "SEE ALSO" |
| 54 | . |
| 55 | \fBtc\fR(8), \fBtc\-hfsc\fR(7), \fBtc\-stab\fR(8) |
| 56 | |
| Michal Soltys | 509dcd4 | 2016-07-02 13:03:12 +0200 | [diff] [blame] | 57 | Please direct bugreports and patches to: <netdev@vger.kernel.org> |
| Michal Soltys | 41f6004 | 2011-10-26 04:15:21 -0400 | [diff] [blame] | 58 | . |
| 59 | .SH "AUTHOR" |
| 60 | . |
| Michal Soltys | 509dcd4 | 2016-07-02 13:03:12 +0200 | [diff] [blame] | 61 | Manpage created by Michal Soltys (soltys@ziu.info) |