From db3fd51be7e70023fcd6b60915a81c8d14c894dc Mon Sep 17 00:00:00 2001 From: Bert Hubert Date: Thu, 10 Jan 2002 19:47:41 +0000 Subject: [PATCH] lots of typos fixed --- manpages/tc-cbq-details.8 | 14 +++++------ manpages/tc-cbq.8 | 14 +++++------ manpages/tc-pfifo_fast.8 | 59 +++++++++++++++++++++++++++++++++++++++++++++++ manpages/tc-red.8 | 2 +- manpages/tc-sfq.8 | 4 ++-- manpages/tc-tbf.8 | 6 ++--- manpages/tc.8 | 4 ++-- 7 files changed, 81 insertions(+), 22 deletions(-) create mode 100644 manpages/tc-pfifo_fast.8 diff --git a/manpages/tc-cbq-details.8 b/manpages/tc-cbq-details.8 index 08fb90b..e47da62 100644 --- a/manpages/tc-cbq-details.8 +++ b/manpages/tc-cbq-details.8 @@ -71,7 +71,7 @@ When shaping a 10mbit/s connection to 1mbit/s, the link will be idle 90% of the time. If it isn't, it needs to be throttled so that it IS idle 90% of the time. -From the kernel's perspecive, this is hard to measure, so CBQ instead +From the kernel's perspective, this is hard to measure, so CBQ instead derives the idle time from the number of microseconds (in fact, jiffies) that elapse between requests from the device driver for more data. Combined with the knowledge of packet sizes, this is used to approximate how full or @@ -91,10 +91,10 @@ to userspace - which not defined. During operations, the effective idletime is measured using an exponential weighted moving average (EWMA), which considers recent -packets to be exponentially more important than past ones. The unix +packets to be exponentially more important than past ones. The Unix loadaverage is calculated in the same way. -The calculated idle time is substracted from the EWMA measured one, +The calculated idle time is subtracted from the EWMA measured one, the resulting number is called 'avgidle'. A perfectly loaded link has an avgidle of zero: packets arrive exactly at the calculated interval. @@ -210,14 +210,14 @@ Consult the map for a class for the priority. If found, choose it, and terminate. .TP (iii) -Choose the class at which breakout to the fallback algorithm occured. Terminate. +Choose the class at which break out to the fallback algorithm occured. Terminate. .P The packet is enqueued to the class which was chosen when either algorithm terminated. It is therefore possible for a packet to be enqueued *not* at a leaf node, but in the middle of the hierarchy. .SH LINK SHARING ALGORITHM -When dequeueing for sending to the network device, CBQ decides which of its +When dequeuing for sending to the network device, CBQ decides which of its classes will be allowed to send. It does so with a Weighted Round Robin process in which each class with packets gets a chance to send in turn. The WRR process starts by asking the highest priority classes (lowest numerically - @@ -294,7 +294,7 @@ major number of the qdisc to which it belongs. Optional, but needed if this class is going to have children. .TP weight weight -When dequeueing to the interface, classes are tried for traffic in a +When dequeuing to the interface, classes are tried for traffic in a round-robin fashion. Classes with a higher configured qdisc will generally have more traffic to offer during each round, so it makes sense to allow it to dequeue more traffic. All weights under a class are normalized, so @@ -401,7 +401,7 @@ IEEE/ACM Transactions on Networking, Vol.3, No.4, 1995 .TP o -Sally Floyd, "Notes on CBQ and Guaranted Service", 1995 +Sally Floyd, "Notes on CBQ and Guarantee Service", 1995 .TP o diff --git a/manpages/tc-cbq.8 b/manpages/tc-cbq.8 index 0a227b5..79fb93b 100644 --- a/manpages/tc-cbq.8 +++ b/manpages/tc-cbq.8 @@ -72,10 +72,10 @@ IS idle 90% of the time. During operations, the effective idletime is measured using an exponential weighted moving average (EWMA), which considers recent -packets to be exponentially more important than past ones. The unix +packets to be exponentially more important than past ones. The Unix loadaverage is calculated in the same way. -The calculated idle time is substracted from the EWMA measured one, +The calculated idle time is subtracted from the EWMA measured one, the resulting number is called 'avgidle'. A perfectly loaded link has an avgidle of zero: packets arrive exactly at the calculated interval. @@ -118,14 +118,14 @@ Otherwise, restart. .TP (ii) Consult the defmap for the priority assigned to this packet, which depends -on the TOS bits. Check if the referral is leafness, otherwise restart. +on the TOS bits. Check if the referral is leafless, otherwise restart. .TP (iii) Ask the defmap for instructions for the 'best effort' priority. Check the answer for leafness, otherwise restart. .TP (iv) -If none of the above returned with an instruction, enqeueue at this node. +If none of the above returned with an instruction, enqueue at this node. .P This algorithm makes sure that a packet always ends up somewhere, even while you are busy building your configuration. @@ -134,7 +134,7 @@ For more details, see .BR tc-cbq-details(8). .SH LINK SHARING ALGORITHM -When dequeueing for sending to the network device, CBQ decides which of its +When dequeuing for sending to the network device, CBQ decides which of its classes will be allowed to send. It does so with a Weighted Round Robin process in which each class with packets gets a chance to send in turn. The WRR process starts by asking the highest priority classes (lowest numerically - @@ -206,7 +206,7 @@ major number of the qdisc to which it belongs. Optional, but needed if this class is going to have children. .TP weight weight -When dequeueing to the interface, classes are tried for traffic in a +When dequeuing to the interface, classes are tried for traffic in a round-robin fashion. Classes with a higher configured qdisc will generally have more traffic to offer during each round, so it makes sense to allow it to dequeue more traffic. All weights under a class are normalized, so @@ -329,7 +329,7 @@ IEEE/ACM Transactions on Networking, Vol.3, No.4, 1995 .TP o -Sally Floyd, "Notes on CBQ and Guaranted Service", 1995 +Sally Floyd, "Notes on CBQ and Guaranteed Service", 1995 .TP o diff --git a/manpages/tc-pfifo_fast.8 b/manpages/tc-pfifo_fast.8 new file mode 100644 index 0000000..43ab166 --- /dev/null +++ b/manpages/tc-pfifo_fast.8 @@ -0,0 +1,59 @@ +.TH PFIFO_FAST 8 "10 January 2002" "iproute2" "Linux" +.SH NAME +pfifo_fast \- three-band first in, first out queue + +.SH DESCRIPTION +pfifo_fast is the default qdisc of each interface. + +Whenever an interface is created, the pfifo_fast qdisc is automatically used +as a queue. If another qdisc is attached, it preempts the default +pfifo_fast, which automatically returns to function when an existing qdisc +is detached. + +In this sense this qdisc is magic, and unlike other qdiscs. + +.SH ALGORITHM +The algorithm is very similar to that of the classful +.BR tc-prio (8) +qdisc. +.B pfifo_fast +is like three +.BR tc-pfifo (8) +queues side by side, where packets can be enqueued in any of the three bands +based on their Type of Service bits or assigned priority. + +Not all three bands are dequeued simultaneously - as long as lower bands +have traffic, higher bands are never dequeued. This can be used to +prioritize interactive traffic or penalize 'lowest cost' traffic. + +Each band can be txqueuelen packets long, as configured with +.BR ifconfig (8) +or +.BR ip (8). +Additional packets coming in are not enqueued but are instead dropped. + +See +.BR tc-prio (8) +for complete details on how TOS bits are translated into bands. +.SH PARAMETERS +.TP +txqueuelen +The length of the three bands depends on the interface txqueuelen, as +specified with +.BR ifconfig (8) +or +.BR ip (8). + +.SH BUGS +Does not maintain statistics and does not show up in tc qdisc ls. This is because +it is the automatic default in the absence of a configured qdisc. + +.SH SEE ALSO +.BR tc (8) + +.SH AUTHORS +Alexey N. Kuznetsov, + +This manpage maintained by bert hubert + + diff --git a/manpages/tc-red.8 b/manpages/tc-red.8 index a76584a..eba0597 100644 --- a/manpages/tc-red.8 +++ b/manpages/tc-red.8 @@ -38,7 +38,7 @@ The goal is the have a small queue size, which is good for interactivity while not disturbing TCP/IP traffic with too many sudden drops after a burst of traffic. -Depending on wether ECN is configured, marking either means dropping or +Depending on 08 ECN is configured, marking either means dropping or purely marking a packet as overlimit. .SH ALGORITHM The average queue size is used for determining the marking diff --git a/manpages/tc-sfq.8 b/manpages/tc-sfq.8 index bc626ed..337c795 100644 --- a/manpages/tc-sfq.8 +++ b/manpages/tc-sfq.8 @@ -43,7 +43,7 @@ get hashed to the same bucket, the hashing algorithm is perturbed at configurabl intervals so that the unfairness lasts only for a short while. Perturbation may however cause some inadvertent packet reordering to occur. -When dequeueing, each hasbucket with data is queried in a round robin fashion. +When dequeuing, each hashbucket with data is queried in a round robin fashion. The compile time maximum length of the SFQ is 128 packets, which can be spread over at most 128 buckets of 1024 available. In case of overflow, tail-drop is performed @@ -71,7 +71,7 @@ if it owns the queue. This is the case when the link speed equals the actually available bandwidth. This holds for regular phone modems, ISDN connections and direct non-switched ethernet links. .P -Most often, cablemodems and DSL devices do not fall into this category. The same holds +Most often, cable modems and DSL devices do not fall into this category. The same holds for when connected to a switch and trying to send data to a congested segment also connected to the switch. .P diff --git a/manpages/tc-tbf.8 b/manpages/tc-tbf.8 index 1191e84..3abb238 100644 --- a/manpages/tc-tbf.8 +++ b/manpages/tc-tbf.8 @@ -60,7 +60,7 @@ with a very small bucket, so that it doesn't burst. To achieve perfection, the second bucket may contain only a single packet, which leads to the earlier mentioned 1mbit/s limit. -This limit is caused by the fact that the kernel can only throttle for at mininum 1 'jiffy', which depends +This limit is caused by the fact that the kernel can only throttle for at minimum 1 'jiffy', which depends on HZ as 1/HZ. For perfect shaping, only a single packet can get sent per jiffy - for HZ=100, this means 100 packets of on average 1000 bytes each, which roughly corresponds to 1mbit/s. @@ -98,7 +98,7 @@ A zero-sized packet does not use zero bandwidth. For ethernet, no packet uses le determines the minimal token usage (specified in bytes) for a packet. Defaults to zero. .TP rate -The speedknob. See remarks above about limits! See +The speed knob. See remarks above about limits! See .BR tc (8) for units. .PP @@ -121,7 +121,7 @@ size. .SH EXAMPLE & USAGE To attach a TBF with a sustained maximum rate of 0.5mbit/s, a peakrate of 1.0mbit/s, -a 5kilobyte buffer, with a pre-bucket queuesize limit calculted so the TBF causes +a 5kilobyte buffer, with a pre-bucket queue size limit calculated so the TBF causes at most 70ms of latency, with perfect peakrate behaviour, issue: .P # tc qdisc add dev eth0 root tbf rate 0.5mbit \\ diff --git a/manpages/tc.8 b/manpages/tc.8 index b24e22e..e45c075 100644 --- a/manpages/tc.8 +++ b/manpages/tc.8 @@ -131,7 +131,7 @@ packets when nearing configured bandwidth allocation. Well suited to very large bandwidth applications. .TP sfq -Stochastic Faireness Queueing reorders queued traffic so each 'session' +Stochastic Fairness Queueing reorders queued traffic so each 'session' gets to send a packet in turn. .TP tbf @@ -162,7 +162,7 @@ The classful qdiscs are: CBQ Class Based Queueing implements a rich linksharing hierarchy of classes. It contains shaping elements as well as prioritizing capabilities. Shaping is -performed using link idle time calculations based on average packetsize and +performed using link idle time calculations based on average packet size and underlying link bandwidth. The latter may be ill-defined for some interfaces. .TP HTB -- 2.11.4.GIT