iproute2/tc
Michal Soltys 41f6004139 HFSC (7) & (8) documentation + assorted changes
This patch adds detailed documentation for HFSC scheduler. It roughly
follows HFSC paper, but tries to not rely too much on math side of things.
Post-paper/Linux specific subjects (timer resolution, ul service curve, etc.)
are also discussed.

I've read it many times over, but it's a lengthy chunk of text - so try
to be understanding in case I made some mistakes.

tc-hfsc(7): explains algorithm in detail (very long)
tc-hfsc(8): explains command line options briefly
tc(8): adds references to new man pages
Makefile: adds man7 directory to install target
q_hfsc.c: minimal help text changes, consistency with tc-hfsc(8)

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
2011-11-02 16:33:50 -07:00
..
.gitignore Add ignore files to make using git easier 2006-08-08 12:04:38 -07:00
Makefile tc: fix parallel build file with lex/yacc 2011-10-18 15:02:21 -07:00
README.last (Logical change 1.3) 2004-04-15 20:56:59 +00:00
em_cmp.c Fix wrong comparison in cmp_print_eopt() 2011-10-07 11:16:15 -07:00
em_meta.c tc: remove dlfcn.h from files that dont need it 2009-11-13 14:14:07 -08:00
em_nbyte.c tc: remove dlfcn.h from files that dont need it 2009-11-13 14:14:07 -08:00
em_u32.c tc: remove dlfcn.h from files that dont need it 2009-11-13 14:14:07 -08:00
emp_ematch.l fix build issues with flex ver 2.5 2010-04-22 15:27:42 -07:00
emp_ematch.y Thomas's ematch fixes for lex. 2005-07-08 22:08:47 +00:00
f_basic.c Update various classifiers' help output for expected CLASSID syntax 2008-02-13 12:36:38 -08:00
f_cgroup.c iproute2: Remove unreachable code 2011-07-11 10:13:51 -07:00
f_flow.c iproute2: tc: f_flow: add key rxhash 2010-11-30 09:57:36 -08:00
f_fw.c tc: remove stale code 2010-01-21 10:13:01 -08:00
f_route.c tc: remove stale code 2010-01-21 10:13:01 -08:00
f_rsvp.c tc: remove stale code 2010-01-21 10:13:01 -08:00
f_tcindex.c tc: remove stale code 2010-01-21 10:13:01 -08:00
f_u32.c tc filter: fix dport/sport in pretty print output 2011-05-19 09:19:17 -07:00
m_action.c tc: make symbols loaded from tc action modules global. 2010-08-02 09:54:59 -07:00
m_csum.c tc: add ACT_CSUM action support (csum) 2010-12-01 11:17:46 -08:00
m_ematch.c Fix NULL pointer reference when using basic match 2010-07-29 18:03:35 -07:00
m_ematch.h ematch related bugfix and cleanup 2008-05-29 11:54:19 -07:00
m_estimator.c Replace "usec" by "time" in function names 2007-03-13 14:42:17 -07:00
m_gact.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
m_ipt.c Fix memory leak of lname variable in get_target_name() 2011-10-07 11:17:10 -07:00
m_mirred.c Remove mirred debug message 2010-03-29 17:32:37 -07:00
m_nat.c tc: remove dlfcn.h from files that dont need it 2009-11-13 14:14:07 -08:00
m_pedit.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
m_pedit.h Remove trailing whitespace 2006-12-05 10:10:22 -08:00
m_police.c ATM cell alignment. 2008-04-17 10:04:31 -07:00
m_skbedit.c skbedit: fix set-never-used warning 2011-06-29 15:59:02 -07:00
m_xt.c xt: only unset fields if m is non NULL 2011-08-31 12:18:49 -07:00
m_xt_old.c Workaround missing ALIGN() macro. 2010-03-29 17:37:49 -07:00
p_icmp.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
p_ip.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
p_tcp.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
p_udp.c Remove trailing whitespace 2006-12-05 10:10:22 -08:00
q_atm.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_cbq.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_choke.c Fix wrong sanity check in choke_parse_opt() 2011-10-07 11:17:03 -07:00
q_drr.c iproute2: Remove unreachable code 2011-07-11 10:13:51 -07:00
q_dsmark.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_fifo.c tc: add new queue discipline: head drop fifo 2010-03-03 16:15:44 -08:00
q_gred.c Fix GRED options clearing 2010-08-25 09:04:55 -07:00
q_hfsc.c HFSC (7) & (8) documentation + assorted changes 2011-11-02 16:33:50 -07:00
q_htb.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_ingress.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_mqprio.c iproute2: improve mqprio inputs for queue offsets and counts 2011-04-26 14:59:32 -07:00
q_multiq.c iproute2: Remove unreachable code 2011-07-11 10:13:51 -07:00
q_netem.c Update email address of netem 2011-04-12 14:24:01 -07:00
q_prio.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_qfq.c Add QFQ scheduler 2011-07-13 13:46:34 -07:00
q_red.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_rr.c tc: remove stale code 2010-01-21 10:13:01 -08:00
q_sfb.c tc : SFB flow scheduler 2011-04-12 14:27:37 -07:00
q_sfq.c sfq: add divisor support 2011-02-25 12:59:53 -08:00
q_tbf.c tc: remove stale code 2010-01-21 10:13:01 -08:00
static-syms.c support static-only systems 2009-11-10 10:44:20 -08:00
tc.c Changing commandline help text to be more uniform... 2009-03-27 11:05:44 -07:00
tc_cbq.c Replace "usec" by "time" in function names 2007-03-13 14:42:17 -07:00
tc_cbq.h (Logical change 1.3) 2004-04-15 20:56:59 +00:00
tc_class.c Filter class output by classid 2009-05-26 15:20:26 -07:00
tc_common.h add generic size table for qdiscs 2008-09-17 21:57:15 -07:00
tc_core.c add generic size table for qdiscs 2008-09-17 21:57:15 -07:00
tc_core.h add generic size table for qdiscs 2008-09-17 21:57:15 -07:00
tc_estimator.c Introduce TIME_UNITS_PER_SEC to represent internal clock resolution 2007-03-13 14:42:16 -07:00
tc_filter.c tc: filter: fix default 'protocol all' on little-endian platforms 2011-08-31 10:55:13 -07:00
tc_monitor.c update rest to use nl_mgrp 2007-03-13 14:39:05 -07:00
tc_qdisc.c add generic size table for qdiscs 2008-09-17 21:57:15 -07:00
tc_red.c tc: fix set never used warning in red 2011-06-20 14:34:30 -07:00
tc_red.h (Logical change 1.3) 2004-04-15 20:56:59 +00:00
tc_stab.c add generic size table for qdiscs 2008-09-17 21:57:15 -07:00
tc_util.c iproute: DESTDIR vs LIBDIR. 2008-09-17 22:04:02 -07:00
tc_util.h add generic size table for qdiscs 2008-09-17 21:57:15 -07:00

README.last

Kernel code and interface.
--------------------------

* Compile time switches

There is only one, but very important, compile time switch.
It is not settable by "make config", but should be selected
manually and after a bit of thinking in <include/net/pkt_sched.h>

PSCHED_CLOCK_SOURCE can take three values:

	PSCHED_GETTIMEOFDAY
	PSCHED_JIFFIES
	PSCHED_CPU


 PSCHED_GETTIMEOFDAY

Default setting is the most conservative PSCHED_GETTIMEOFDAY.
It is very slow both because of weird slowness of do_gettimeofday()
and because it forces code to use unnatural "timeval" format,
where microseconds and seconds fields are separate.
Besides that, it will misbehave, when delays exceed 2 seconds
(f.e. very slow links or classes bounded to small slice of bandwidth)
To resume: as only you will get it working, select correct clock
source and forget about PSCHED_GETTIMEOFDAY forever.


 PSCHED_JIFFIES

Clock is derived from jiffies. On architectures with HZ=100
granularity of this clock is not enough to make reasonable
bindings to real time. However, taking into account Linux
architecture problems, which force us to use artificial
integrated clock in any case, this switch is not so bad
for schduling even on high speed networks, though policing
is not reliable.


 PSCHED_CPU

It is available only for alpha and pentiums with correct
CPU timestamp. It is the fastest way, use it when it is available,
but remember: not all pentiums have this facility, and
a lot of them have clock, broken by APM etc. etc.