Version 1.4 downlink update

magnific0 · Dec 1, 2017 · eb061a0 · eb061a0
1 parent 0cf1da1
commit eb061a0
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 71 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,11 @@
+Changes since version 1.4
+    - download limiting has been added from (removed in 1.3), it had to be reworked
+      the script now directs ingress to ifb virtual interface where it is properly 
+      limited. Source for this work are:
+      - https://gist.github.com/ole1986/d9d6be5218affd41796610a35e3b069c
+      - https://wiki.archlinux.org/index.php/advanced_traffic_control
+    - make upload or download limiting optional
+
 Changes since version 1.3 (forked by Saimonn/Camptocamp):
 	- move from CBQ to HTB queing.
 	  CBQ didn't cope well on a ~100Mbps link : individual downloads

diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
-The Wonder Shaper 1.3
+The Wonder Shaper 1.4
 ==============
 
 Copyright
 -------------
 
 bert hubert <ahu@ds9a.nl> http://lartc.org/wondershaper (c) Copyright 2002
-magnific0 http://www.github.com/magnific0 (c) Copyright 2012
 Simon Séhier <simon@sehier.fr> - Camptocamp (c) Copyright 2015 - HTB
+magnific0 http://www.github.com/magnific0 (c) Copyright 2012-2017
 Licenced under the GPL
 
 About
@@ -34,7 +34,7 @@ The following command line options are allowed:
 
 - `-a <adapter>` Set the adpter
 
-- `-d <rate>` Set maximum download rate (in Kbps)
+- `-d <rate>` Set maximum download rate (in Kbps) and/or
 
 - `-u <rate>` Set maximum upload rate (in Kbps)
 
@@ -58,4 +58,6 @@ Some examples:
 
 	wondershaper -a eth1 -d 94000 -u 94000  # could be used on a 100Mbps link
 
+	wondershaper -a eth1 -u 94000  # only limit upload
+
 	wondershaper -c -a eth0
diff --git a/wondershaper b/wondershaper
@@ -23,7 +23,7 @@ Limit the bandwidth of an adapter
 OPTIONS:
    -h           Show this message
    -a <adapter> Set the adpter
-   -d <rate>    Set maximum download rate (in Kbps)
+   -d <rate>    Set maximum download rate (in Kbps) and/or
    -u <rate>    Set maximum upload rate (in Kbps)
    -p           Use presets in /etc/conf.d/wondershaper.conf
    -c           Clear the limits from adapter
@@ -36,6 +36,7 @@ MODES:
 
 EXAMPLES:
    wondershaper -a eth0 -d 1024 -u 512
+   wondershaper -a eth0 -u 512
    wondershaper -c -a eth0
 
 EOF
@@ -44,6 +45,7 @@ EOF
 DSPEED=
 USPEED=
 IFACE=
+IFB="ifb0"
 MODE=
 
 while getopts hd:u:a:pcs o
@@ -91,10 +93,12 @@ if [ "$MODE" = "clear" ]
 then
     tc qdisc del dev $IFACE root    2> /dev/null > /dev/null
     tc qdisc del dev $IFACE ingress 2> /dev/null > /dev/null
+    tc qdisc del dev $IFB   root    2> /dev/null > /dev/null
+    tc qdisc del dev $IFB   ingress 2> /dev/null > /dev/null
     exit
 fi
 
-if [[ -z $DSPEED ]] || [[ -z $USPEED ]] || [[ -z $IFACE ]]
+if ( [[ -z $DSPEED ]] && [[ -z $USPEED ]] ) || [[ -z $IFACE ]]
 then
     usage
     exit 1
@@ -113,8 +117,6 @@ NOPRIOPORTSRC=
 # low priority destination ports
 NOPRIOPORTDST=
 
-
-
 ###### uplink
 
 # install root HTB
@@ -125,81 +127,110 @@ tc qdisc add dev $IFACE root handle 1: htb \
 # shape everything at $USPEED speed - this prevents huge queues in your
 # DSL modem which destroy latency:
 # main class
+if [[ ! -z $USPEED ]]
+then
 
-tc class add dev $IFACE parent 1: classid 1:1 htb \
-    rate ${USPEED}kbit \
-    prio 5 $COMMONOPTIONS
+    tc class add dev $IFACE parent 1: classid 1:1 htb \
+        rate ${USPEED}kbit \
+        prio 5 $COMMONOPTIONS
 
-# high prio class 1:10:
+    # high prio class 1:10:
 
-tc class add dev $IFACE parent 1:1 classid 1:10 htb \
-    rate $[40*$USPEED/100]kbit ceil $[95*$USPEED/100]kbit \
-    prio 1 $COMMONOPTIONS
+    tc class add dev $IFACE parent 1:1 classid 1:10 htb \
+        rate $[40*$USPEED/100]kbit ceil $[95*$USPEED/100]kbit \
+        prio 1 $COMMONOPTIONS
 
-# bulk and default class 1:20 - gets slightly less traffic,
-#  and a lower priority:
+    # bulk and default class 1:20 - gets slightly less traffic,
+    #  and a lower priority:
 
-tc class add dev $IFACE parent 1:1 classid 1:20 htb \
-    rate $[40*$USPEED/100]kbit ceil $[95*$USPEED/100]kbit \
-    prio 2 $COMMONOPTIONS
+    tc class add dev $IFACE parent 1:1 classid 1:20 htb \
+        rate $[40*$USPEED/100]kbit ceil $[95*$USPEED/100]kbit \
+        prio 2 $COMMONOPTIONS
 
-# 'traffic we hate'
+    # 'traffic we hate'
 
-tc class add dev $IFACE parent 1:1 classid 1:30 htb \
-    rate $[20*$USPEED/100]kbit ceil $[90*$USPEED/100]kbit \
-    prio 3 $COMMONOPTIONS
+    tc class add dev $IFACE parent 1:1 classid 1:30 htb \
+        rate $[20*$USPEED/100]kbit ceil $[90*$USPEED/100]kbit \
+        prio 3 $COMMONOPTIONS
 
-# all get Stochastic Fairness:
-tc qdisc add dev $IFACE parent 1:10 handle 10: sfq perturb 10 quantum $QUANTUM
-tc qdisc add dev $IFACE parent 1:20 handle 20: sfq perturb 10 quantum $QUANTUM
-tc qdisc add dev $IFACE parent 1:30 handle 30: sfq perturb 10 quantum $QUANTUM
+    # all get Stochastic Fairness:
+    tc qdisc add dev $IFACE parent 1:10 handle 10: sfq perturb 10 quantum $QUANTUM
+    tc qdisc add dev $IFACE parent 1:20 handle 20: sfq perturb 10 quantum $QUANTUM
+    tc qdisc add dev $IFACE parent 1:30 handle 30: sfq perturb 10 quantum $QUANTUM
 
-# start filters
-# TOS Minimum Delay (ssh, NOT scp) in 1:10:
-tc filter add dev $IFACE parent 1: protocol ip prio 10 u32 \
-      match ip tos 0x10 0xff  flowid 1:10
+    # start filters
+    # TOS Minimum Delay (ssh, NOT scp) in 1:10:
+    tc filter add dev $IFACE parent 1: protocol ip prio 10 u32 \
+        match ip tos 0x10 0xff  flowid 1:10
 
-# ICMP (ip protocol 1) in the interactive class 1:10 so we
-# can do measurements & impress our friends:
-tc filter add dev $IFACE parent 1: protocol ip prio 11 u32 \
+    # ICMP (ip protocol 1) in the interactive class 1:10 so we
+    # can do measurements & impress our friends:
+    tc filter add dev $IFACE parent 1: protocol ip prio 11 u32 \
         match ip protocol 1 0xff flowid 1:10
 
-# prioritize small packets (<64 bytes)
-
-tc filter add dev $IFACE parent 1: protocol ip prio 12 u32 \
-   match ip protocol 6 0xff \
-   match u8 0x05 0x0f at 0 \
-   match u16 0x0000 0xffc0 at 2 \
-   flowid 1:10
-
-
-# some traffic however suffers a worse fate
-for a in $NOPRIOPORTDST
-do
-	tc filter add dev $IFACE parent 1: protocol ip prio 14 u32 \
-	   match ip dport $a 0xffff flowid 1:30
-done
-
-for a in $NOPRIOPORTSRC
-do
- 	tc filter add dev $IFACE parent 1: protocol ip prio 15 u32 \
-	   match ip sport $a 0xffff flowid 1:30
-done
-
-for a in $NOPRIOHOSTSRC
-do
- 	tc filter add dev $IFACE parent 1: protocol ip prio 16 u32 \
-	   match ip src $a flowid 1:30
-done
-
-for a in $NOPRIOHOSTDST
-do
- 	tc filter add dev $IFACE parent 1: protocol ip prio 17 u32 \
-	   match ip dst $a flowid 1:30
-done
-
-# rest is 'non-interactive' ie 'bulk' and ends up in 1:20
+    # prioritize small packets (<64 bytes)
+
+    tc filter add dev $IFACE parent 1: protocol ip prio 12 u32 \
+        match ip protocol 6 0xff \
+        match u8 0x05 0x0f at 0 \
+        match u16 0x0000 0xffc0 at 2 \
+        flowid 1:10
+
+
+    # some traffic however suffers a worse fate
+    for a in $NOPRIOPORTDST
+    do
+        tc filter add dev $IFACE parent 1: protocol ip prio 14 u32 \
+            match ip dport $a 0xffff flowid 1:30
+    done
+
+    for a in $NOPRIOPORTSRC
+    do
+        tc filter add dev $IFACE parent 1: protocol ip prio 15 u32 \
+            match ip sport $a 0xffff flowid 1:30
+    done
+
+    for a in $NOPRIOHOSTSRC
+    do
+        tc filter add dev $IFACE parent 1: protocol ip prio 16 u32 \
+            match ip src $a flowid 1:30
+    done
+
+    for a in $NOPRIOHOSTDST
+    do
+        tc filter add dev $IFACE parent 1: protocol ip prio 17 u32 \
+            match ip dst $a flowid 1:30
+    done
+
+    # rest is 'non-interactive' ie 'bulk' and ends up in 1:20
+
+    tc filter add dev $IFACE parent 1: protocol ip prio 18 u32 \
+        match ip dst 0.0.0.0/0 flowid 1:20
+
+fi
 
-tc filter add dev $IFACE parent 1: protocol ip prio 18 u32 \
-   match ip dst 0.0.0.0/0 flowid 1:20
+########## downlink #############
+# slow downloads down to somewhat less than the real speed  to prevent
+# queuing at our ISP. Tune to see how high you can set it.
+# ISPs tend to have *huge* queues to make sure big downloads are fast
+#
+# attach ingress policer:
+if [[ ! -z $DSPEED ]]
+then
 
+    # Add the IFB interface
+    modprobe ifb numifbs=1
+    ip link set dev $IFB up
+
+    # Redirect ingress (incoming) to egress ifb0
+    tc qdisc add dev $IFACE handle ffff: ingress
+    tc filter add dev $IFACE parent ffff: protocol ip u32 match u32 0 0 action mirred egress redirect dev $IFB
+
+    # Add class and rules for virtual
+    tc qdisc add dev $IFB root handle 2: htb
+    tc class add dev $IFB parent 2: classid 2:1 htb rate ${DSPEED}kbit
+
+    # Add filter to rule for IP address
+    tc filter add dev $IFB protocol ip parent 2: prio 1 u32 match ip src 0.0.0.0/0 flowid 2:1
+
+fi