~ubuntu-branches/ubuntu/quantal/iproute/quantal

« back to all changes in this revision

Viewing changes to man/man8/tc-sfq.8

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2011-11-23 22:15:38 UTC
  • mfrom: (1.1.14) (23.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20111123221538-vle47e8mp5375ruq
Tags: 20111117-1
* Imported Upstream version 3.1.0 (aka snapshot 20111117)
* Update download location in debian/copyright
  - tarballs now available from kernel.org
* Drop debian/patches/xt-v6.diff, fixed upstream.
* Refresh patches: debian/patches/moo.diff and txtdocs.diff

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
.SH NAME
3
3
sfq \- Stochastic Fairness Queueing
4
4
.SH SYNOPSIS
5
 
.B tc qdisc ... perturb
 
5
.B tc qdisc ...
 
6
.B divisor
 
7
hashtablesize
 
8
.B limit
 
9
packets
 
10
.B perturb
6
11
seconds
7
12
.B quantum
8
13
bytes
22
27
 
23
28
SFQ is work-conserving and therefore always delivers a packet if it has one available.
24
29
.SH ALGORITHM
25
 
On enqueueing, each packet is assigned to a hash bucket, based on
 
30
On enqueueing, each packet is assigned to a hash bucket, based on the packets hash value.
 
31
This hash value is either obtained from an external flow classifier (use
 
32
.B
 
33
tc filter
 
34
to set them), or a default internal classifier if no external classifier has been configured.
 
35
 
 
36
When the internal classifier is used, sfq uses
26
37
.TP
27
38
(i)
28
39
Source address
39
50
connection.
40
51
 
41
52
Each of these buckets should represent a unique flow. Because multiple flows may
42
 
get hashed to the same bucket, the hashing algorithm is perturbed at configurable 
 
53
get hashed to the same bucket, sfqs internal hashing algorithm may be perturbed at configurable 
43
54
intervals so that the unfairness lasts only for a short while. Perturbation may 
44
55
however cause some inadvertent packet reordering to occur.
45
56
 
50
61
on the fullest bucket, thus maintaining fairness.
51
62
 
52
63
.SH PARAMETERS
 
64
.TP
 
65
divisor
 
66
Can be used to set a different hash table size, available from kernel 2.6.39 onwards.
 
67
The specified divisor must be a power of two and cannot be larger than 65536.
 
68
Default value: 1024.
53
69
.TP 
54
70
limit
55
71
Upper limit of the SFQ. Can be used to reduce the default length of 128 packets.
58
74
Interval in seconds for queue algorithm perturbation. Defaults to 0, which means that 
59
75
no perturbation occurs. Do not set too low for each perturbation may cause some packet
60
76
reordering. Advised value: 10
 
77
This value has no effect when external flow classification is used.
61
78
.TP 
62
79
quantum
63
80
Amount of bytes a flow is allowed to dequeue during a round of the round robin process.
83
100
.P
84
101
Embed SFQ in a classful qdisc to make sure it owns the queue.
85
102
 
 
103
It is possible to use external classifiers with sfq, for example to hash traffic based only
 
104
on source/destination ip addresses:
 
105
.P
 
106
# tc filter add ... flow hash keys src,dst perturb 30 divisor 1024
 
107
Note that the given divisor should match the one used by sfq. If you have
 
108
changed the sfq default of 1024, use the same value for the flow hash filter, too.
 
109
 
 
110
 
86
111
.SH SOURCE
87
112
.TP 
88
113
o