use taglevel rather than subversion for minor release number
[iproute2.git] / tc-pbfifo.8
1 .TH PBFIFO 8 "10 January 2002" "iproute2" "Linux"
2 .SH NAME
3 pfifo \- Packet limited First In, First Out queue
4 .P
5 bfifo \- Byte limited First In, First Out queue
6
7 .SH SYNOPSIS
8 .B tc qdisc ... add pfifo
9 .B [ limit 
10 packets
11 .B ]
12 .P
13 .B tc qdisc ... add bfifo
14 .B [ limit 
15 bytes
16 .B ]
17
18 .SH DESCRIPTION
19 The pfifo and bfifo qdiscs are unadorned First In, First Out queues. They are the
20 simplest queues possible and therefore have no overhead. 
21 .B pfifo
22 constrains the queue size as measured in packets. 
23 .B bfifo
24 does so as measured in bytes.
25
26 Like all non-default qdiscs, they maintain statistics. This might be a reason to prefer 
27 pfifo or bfifo over the default.
28
29 .SH ALGORITHM
30 A list of packets is maintained, when a packet is enqueued it gets inserted at the tail of
31 a list. When a packet needs to be sent out to the network, it is taken from the head of the list. 
32
33 If the list is too long, no further packets are allowed on. This is called 'tail drop'.
34
35 .SH PARAMETERS
36 .TP 
37 limit
38 Maximum queue size. Specified in bytes for bfifo, in packets for pfifo. For pfifo, defaults 
39 to the interface txqueuelen, as specified with 
40 .BR ifconfig (8)
41 or
42 .BR ip (8).
43
44 For bfifo, it defaults to the txqueuelen multiplied by the interface MTU.
45
46 .SH OUTPUT
47 The output of 
48 .B tc -s qdisc ls
49 contains the limit, either in packets or in bytes, and the number of bytes 
50 and packets actually sent. An unsent and dropped packet only appears between braces 
51 and is not counted as 'Sent'.
52
53 In this example, the queue length is 100 packets, 45894 bytes were sent over 681 packets. 
54 No packets were dropped, and as the pfifo queue does not slow down packets, there were also no
55 overlimits:
56 .P
57 .nf
58 # tc -s qdisc ls dev eth0 
59 qdisc pfifo 8001: dev eth0 limit 100p
60  Sent 45894 bytes 681 pkts (dropped 0, overlimits 0) 
61 .fi
62
63 If a backlog occurs, this is displayed as well.
64 .SH SEE ALSO
65 .BR tc (8)
66
67 .SH AUTHORS
68 Alexey N. Kuznetsov, <kuznet@ms2.inr.ac.ru>
69
70 This manpage maintained by bert hubert <ahu@ds9a.nl>
71
72