├── .project ├── Changes ├── LICENSE ├── README.md ├── old-htb-variant └── supershaper.init └── supershaper.init /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | SuperShaper 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /Changes: -------------------------------------------------------------------------------- 1 | 2017-09-03: 2.0 2 | Switched scheduler from HTB to HFSC. 3 | Added support for exporting flow definitions to a CSV file. 4 | Now prints flow definition rates and percentages on startup. 5 | Fixed a bug in the stop function not checking the specified interface. 6 | Updated README. 7 | 8 | 2017-09-03: 1.6 9 | Rewritten flow and filter definitions to use bash functions, 10 | avoiding cargo-culting and allowing for easier 11 | definitions of new flows and filters. 12 | Stopped using deprecated bash feature for calculations. 13 | Switched HTB leaf scheduler from SFQ to fq_codel. 14 | Added support for Lync (Skype for Business), cloud 15 | backup, VPN client, small ICMP/DNS packets, 16 | HTTP reverse proxy and OpenVPN server. 17 | Added detection of small packets in general, which should 18 | detect most interactive traffic automatically. 19 | Removed all filters based on TOS/DSCP bits, as most 20 | software don't set these bits on outbound traffic. 21 | Removed support for Emule, DirectConnect, Kazaa, Gnutella, 22 | MeetCon, LG/Goldstar iPECS MFIM (VoIP phone), SquidCam, 23 | Shoutcast, World of Warcraft. 24 | Updated comments and documentation, should be easier to 25 | understand now. 26 | Updated changelog with missing details from previous version. 27 | Changed syntax of changelog. 28 | 29 | 2013-08-13: 1.5 30 | Added init info so it's usable as a typical init script. 31 | Moved default bucket above P2P bucket. 32 | Added another BitTorrent port. 33 | Added static Skype port to VoIP bucket. 34 | Added LG iPECS MFIM VoIP phone. 35 | Added MeetCon video conferencing (by destination IP). 36 | Added UseNet (with and without SSL) to download bucket. 37 | Improved console output. 38 | Cleaned up licensing info and contact details. 39 | 40 | 2009-07-08: 1.4 41 | Cleaned up documentation. 42 | 43 | 2009-04-08: 1.3 44 | Converted to init script that should work in /etc/init.d/. 45 | 46 | 2008-08-05: 1.2 47 | Added SIP skinny packets, SquidCam, World Of Warcraft, 48 | UseNet, and custom BitTorrent and ED2k ports. 49 | 50 | 2004-09-26: 1.1 51 | Added 1412 as DirectConnect default port. 52 | 53 | 2004-09-24: 1.0 54 | Initial version. 55 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SuperShaper-SOHO 2 | 3 | SuperShaper-SOHO is a traffic shaping setup for DSL connections which 4 | prioritizes VoIP and interactive traffic, and makes sure P2P traffic doesn't 5 | saturate your uplink. With this setup you should get very low latency on 6 | interactive traffic (e.g. SSH) while having e.g. your cloud backup fully 7 | saturate your upstream. You should no longer need to set any upload limits 8 | in your applications. 9 | 10 | You might've heard references here and there to the LARTC Wondershaper 11 | script which used the even older CBQ scheduler. You could think of this 12 | as a modern and improved replacement for that script. 13 | 14 | ## Requirements 15 | 16 | * iproute2 (tc command) 17 | * Linux kernel with support for HFSC and fq_codel schedulers 18 | (3.6 should work, but use 3.12 or later for best performance) 19 | 20 | Ubuntu 14.04 is known to work and is the author's primary development 21 | platform. It's been in daily use by the author for a number of years. 22 | 23 | ## Installation 24 | 25 | Modify the variables on top of `supershaper.init` and copy this file to 26 | `/etc/init.d/supershaper`. Make sure that the file has executable bits set. 27 | Then make sure it starts up automatically at startup. 28 | 29 | On Ubuntu this is usually done like this: 30 | 31 | $ sudo cp supershaper.init /etc/init.d/supershaper 32 | $ sudo chown root:root /etc/init.d/supershaper 33 | $ sudo chmod 0755 /etc/init.d/supershaper 34 | $ sudo update-rc.d supershaper defaults 35 | 36 | If you're using a PPP-based connection you might also want to ensure it is 37 | started every time your connection is established by symlinking it into 38 | `/etc/ppp/ip-up.d/`. There shouldn't be any need to run it when the 39 | connection is ended, as queueing disciplines are automatically removed when 40 | an interface is destroyed. 41 | 42 | On Ubuntu this is usually done like this: 43 | 44 | $ sudo ln -sf /etc/init.d/supershaper /etc/ppp/ip-up.d/supershaper 45 | 46 | ## Support 47 | 48 | If you require support for this product or have other contracting 49 | assignments, please contact the author directly via email. 50 | 51 | ## Author, copyright and license 52 | 53 | See the main script and the file LICENSE for details. 54 | -------------------------------------------------------------------------------- /old-htb-variant/supershaper.init: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ### BEGIN INIT INFO 4 | # Provides: supershaper 5 | # Required-Start: $remote_fs $syslog $network 6 | # Required-Stop: $remote_fs $syslog $network 7 | # Default-Start: 2 3 4 5 8 | # Default-Stop: 0 1 6 9 | # Short-Description: traffic shaping rules for DSL 10 | # Description: traffic shaping rules for DSL 11 | ### END INIT INFO 12 | 13 | ############################################################################## 14 | # 15 | # SuperShaper-SOHO 2.0 16 | # 17 | # Bandwidth shaper for home DSL connection. 18 | # 19 | # Copyright (C) 2005-2017 Robin Smidsrød 20 | # 21 | # License details and more available at: 22 | # https://github.com/robinsmidsrod/SuperShaper-SOHO 23 | # 24 | # Contact information available at: 25 | # http://robin.smidsrod.no/contact/ 26 | # 27 | # This script is designed to shape your upstream bandwidth to 28 | # minimize latency for interactive applications like SSH and making 29 | # sure P2P applications doesn't saturate your upstream. Standard surfing/mail 30 | # software is also given priority over P2P to make them snappy. 31 | # Typical VoIP traffic (SIP/RTP/Skype) is given priority to make sure IP 32 | # telephony doesn't suffer even on a very congested link. 33 | # 34 | # Ingress (inbound) policing is not set up at all, as it is questionable how 35 | # well it works. Only egress (outbound) shaping, which is known to be effective, is 36 | # set up. 37 | # 38 | # This script needs iproute2 (tc) and HTB/FQ_CODEL Linux kernel netfilter 39 | # schedulers. The fq_codel scheduler was shipped with Linux kernel and 40 | # iproute2 3.6, but is most effective with kernels from 3.12 onwards. See 41 | # https://www.bufferbloat.net/projects/codel/wiki/ for more details. The 42 | # HTB scheduler has been part of Linux since the 2.x versions, so no current 43 | # systems should miss it. If you don't have access to fq_codel it is viable 44 | # to replace it with the SFQ scheduler. 45 | # 46 | # The TC filter howto can be found here: http://lartc.org/howto/lartc.qdisc.filters.html 47 | # Man page for u32 classifier can be found here: http://man7.org/linux/man-pages/man8/tc-u32.8.html 48 | # 49 | ############################################################################## 50 | 51 | # Change these values to reflect your own setup. Make sure to comment out 52 | # filter commands in the advanced section if you don't use all features 53 | # mentioned below. 54 | 55 | # Your outbound interface 56 | DEV=ppp0 57 | 58 | # Your downstream capacity in kilobits/second 59 | # Not currently used for anything 60 | DOWNLOAD_BW=24490 # 24.5Mbps, measured 2017-08-31 61 | 62 | # Your upstream capacity in kilobits/second 63 | UPLINK_BW=3422 # 3.4Mbps, measured 2017-08-31 64 | 65 | # DSL modems usually have large queues that break latency. This phenomenon 66 | # is called "bufferbloat". Set this value high as your DSL modem can 67 | # handle without queuing packets itself. The value is in percent. I 68 | # usually saturate the upstream with traffic/uploads and use iptraf to 69 | # measure the outbound traffic on the interface to determine when the 70 | # shaping takes effect. If iptraf reports higher bandwidth than your 71 | # calculated bandwidth (see UPLINK below) you modem is probably still 72 | # queuing packets. This can only be set by trial an error, but 90% is 73 | # probably a good ballpark number. 74 | UPLINK_PERCENT=90 75 | 76 | # Skype normally uses a random UDP/TCP port, but specify it manually to be 77 | # able to control it better 78 | PORT_SKYPE=15000 79 | 80 | # Additional BitTorrent port (the standard BitTorrent port is already defined) 81 | PORT_BT=50000 82 | 83 | # This is the source port for the internal OpenVPN server 84 | PORT_OPENVPN=1194 85 | 86 | # IP address where your work VPN client traffic goes to 87 | WORK_VPN_IP=1.2.3.4 88 | 89 | # IP address where your Lync (Skype for Business) traffic goes to. 90 | # You can (usually) get hold of this information by holding Ctrl down while 91 | # right-clicking the Lync tray icon, then you'll find an option called 92 | # "Configuration information". You might also need to check for established 93 | # connections using the "conntrack -L" command while doing a "Check call 94 | # quality" action in Lync. That might indicate an additional IP address. 95 | # If so you might need to add another IP in a separate environment variable 96 | # and add another entry in the advanced section. 97 | LYNC_IP=1.2.3.5 98 | #LYNC_IP2=1.2.3.6 99 | 100 | # The IP address your cloud backup traffic goes to 101 | CLOUD_BACKUP_IP=1.2.3.7 102 | 103 | # Set full path to TC command, unless it's in PATH 104 | TC=tc 105 | 106 | ############################################################################## 107 | ######## Nothing to change below this line unless you're adventurous ######### 108 | ############################################################################## 109 | 110 | # Calculate actual max bandwidth 111 | UPLINK=$((UPLINK_PERCENT*UPLINK_BW/100)) 112 | 113 | # Which qdisc to use for HTB leaves 114 | # fq_codel seems to be better (if you have it), but use the one that suits you. 115 | #LEAF_QDISC="sfq perturb 10" 116 | LEAF_QDISC="fq_codel noecn" 117 | 118 | filter_prio=1 119 | function filter_for_flow { 120 | #echo "$@" 121 | flowid="$1"; shift 122 | $TC filter add dev $DEV parent 1: protocol ip prio $((filter_prio++)) u32 "$@" flowid "1:$flowid" 123 | } 124 | 125 | flow_prio=0 126 | function define_flow { 127 | #echo "$@" 128 | flowid="$1"; rate_percent="$2"; ceil_percent="$3"; shift 3 129 | rate=$((rate_percent*UPLINK/100)) 130 | ceil=$((ceil_percent*UPLINK/100)) 131 | $TC class add dev $DEV parent 1:1 classid "1:$flowid" htb rate "${rate}kbit" ceil "${ceil}kbit" prio $((flow_prio++)) 132 | $TC qdisc add dev $DEV parent "1:$flowid" handle "$flowid:" $LEAF_QDISC 133 | } 134 | 135 | function bin2dec { 136 | printf '0x%x' "$((2#$1))" 137 | } 138 | 139 | function start_me { 140 | stop_me quiet # Remove existing flows and filters 141 | 142 | printf "Turning on packet shaping on $DEV\n" 143 | 144 | ################### FLOW DEFINITIONS ################### 145 | 146 | # Add root qdisc and class 147 | $TC qdisc add dev $DEV root handle 1: htb default 50 148 | $TC class add dev $DEV parent 1: classid 1:1 htb rate "${UPLINK}kbit" 149 | 150 | # Remember that flows are defined in terms of priority, the first flow 151 | # defined has the highest priority and the last one defined has the lowest 152 | # priority. 153 | 154 | # define_flow 155 | # rate_percent is how much bandwidth to use for each flow 156 | # ceil_percent is the same as above, but for ceiling, 157 | # ie. how much a flow is allowed to borrow from another flow 158 | define_flow 10 100 100 # TCP/ACK (small packets) 159 | define_flow 11 100 100 # ICMP (small packets) 160 | define_flow 12 100 100 # DNS (small packets) 161 | define_flow 13 100 100 # Small packets < 128 162 | define_flow 14 100 100 # Small packets < 256 163 | define_flow 20 100 100 # VoIP (SIP packets) 164 | define_flow 21 100 100 # VoIP (RTP packets) 165 | define_flow 22 100 100 # VoIP (Skype) 166 | define_flow 23 100 100 # VoIP (Lync/Skype for Business) 167 | define_flow 30 100 100 # VPN 168 | define_flow 40 90 90 # SMTP 169 | define_flow 41 90 90 # IMAP/POP3 170 | define_flow 45 90 90 # HTTP (browsing) 171 | define_flow 48 90 90 # FTP 172 | define_flow 50 50 80 # unclassified traffic 173 | define_flow 51 20 50 # HTTP reverse proxy 174 | define_flow 52 20 50 # OpenVPN server 175 | define_flow 60 20 50 # Usenet 176 | define_flow 61 20 50 # BitTorrent 177 | define_flow 70 10 60 # Cloud backup 178 | 179 | ################### FLOW FILTERS ################### 180 | 181 | # Remember that filters for flows are defined in order of how they 182 | # should match IP packet data. It's crucial that you match on very 183 | # narrow terms first and leave the broad matches for last. 184 | 185 | # Cloud backup 186 | filter_for_flow 70 match ip dst $CLOUD_BACKUP_IP 187 | 188 | # Skype for Business / Lync 189 | filter_for_flow 23 match ip dst $LYNC_IP 190 | #filter_for_flow 23 match ip dst $LYNC_IP2 191 | 192 | # VPN 193 | filter_for_flow 30 match ip dst $WORK_VPN_IP 194 | 195 | # Usenet (with and without SSL) 196 | filter_for_flow 60 match ip dport 119 0xffff 197 | filter_for_flow 60 match ip dport 563 0xffff 198 | 199 | # BitTorrent uploads 200 | filter_for_flow 61 match ip sport 6881 0xffff 201 | filter_for_flow 61 match ip sport $PORT_BT 0xffff 202 | 203 | # TCP/ACK (small packets) 204 | # IP protocol == 6 205 | # IP header length == 5 206 | # IP packet total length < 64 207 | # TCP flags == 0x10 (only ACK bit set) 208 | filter_for_flow 10 \ 209 | match ip protocol 6 0xff \ 210 | match u8 5 0x0f at 0 \ 211 | match u16 0x0000 0xffc0 at 2 \ 212 | match u8 0x10 0xff at 33 213 | 214 | # ICMP (small packets) 215 | # IP protocol == ICMP 216 | # IP packet total length < 128 217 | filter_for_flow 11 \ 218 | match ip protocol 1 0xff \ 219 | match u16 0x0000 0xff80 at 2 220 | 221 | # DNS (small packets) 222 | # IP dst port == 53 223 | # IP packet total length < 128 224 | filter_for_flow 12 \ 225 | match ip dport 53 0xffff \ 226 | match u16 0x0000 0xff80 at 2 227 | 228 | # VoIP (SIP packets) 229 | filter_for_flow 20 match ip sport 5060 0xffff 230 | filter_for_flow 20 match ip dport 5060 0xffff 231 | filter_for_flow 20 match ip sport 5061 0xffff # With TLS 232 | filter_for_flow 20 match ip dport 5061 0xffff # With TLS 233 | 234 | # VoIP (RTP data) 235 | filter_for_flow 21 match ip sport 16384 0xffff 236 | 237 | # Skype VoIP (UDP/TCP data) 238 | filter_for_flow 22 match ip sport $PORT_SKYPE 0xffff 239 | 240 | # SMTP (with and without SSL) 241 | filter_for_flow 40 match ip dport 25 0xffff 242 | filter_for_flow 40 match ip dport 465 0xffff 243 | filter_for_flow 40 match ip dport 587 0xffff 244 | 245 | # IMAP (with and without SSL) 246 | filter_for_flow 41 match ip dport 143 0xffff 247 | filter_for_flow 41 match ip dport 993 0xffff 248 | 249 | # POP3 (with and without SSL) 250 | filter_for_flow 41 match ip dport 110 0xffff 251 | filter_for_flow 41 match ip dport 995 0xffff 252 | 253 | # HTTP (browsing) (with and without SSL) 254 | filter_for_flow 45 match ip dport 80 0xffff 255 | filter_for_flow 45 match ip dport 443 0xffff 256 | 257 | # FTP (with and without SSL) 258 | filter_for_flow 48 match ip dport 20 0xffff 259 | filter_for_flow 48 match ip dport 21 0xffff 260 | filter_for_flow 48 match ip dport 989 0xffff 261 | filter_for_flow 48 match ip dport 990 0xffff 262 | 263 | # HTTP/HTTPS reverse proxy 264 | filter_for_flow 51 match ip sport 80 0xffff 265 | filter_for_flow 51 match ip sport 443 0xffff 266 | 267 | # OpenVPN server 268 | filter_for_flow 52 match ip sport $PORT_OPENVPN 0xffff 269 | 270 | # NB: These filters should be last because they match on very broad terms 271 | 272 | # Small packets < 128 bytes 273 | # IP packet total length < 128 274 | filter_for_flow 13 \ 275 | match u16 0x0000 0xff80 at 2 276 | 277 | # Small packets < 256 bytes 278 | # IP packet total length < 256 279 | filter_for_flow 14 \ 280 | match u16 0x0000 0xff00 at 2 281 | } 282 | 283 | function stop_me { 284 | # Remove existing qdisc 285 | active_qdisc=$(tc qdisc show dev $DEV| head -n 1 | cut -d" " -f 2) 286 | if [ -n "$active_qdisc" -a "$active_qdisc" = "htb" ]; then 287 | if [ -z "$1" -o "$1" != "quiet" ]; then 288 | printf "Turning off packet shaping on $DEV\n" 289 | fi 290 | $TC qdisc del dev $DEV root 2>&1 >/dev/null 291 | fi 292 | } 293 | 294 | function status_me { 295 | # Report settings 296 | printf "************************* QDISC ******************************\n" 297 | $TC qdisc show dev $DEV 298 | printf "************************* CLASS ******************************\n" 299 | $TC -s class show dev $DEV | grep -v 'tokens:' | grep -v 'lended:' 300 | } 301 | 302 | function filter_me { 303 | # Report filter settings 304 | printf "************************* FILTER *****************************\n" 305 | $TC -p filter show dev $DEV 306 | } 307 | 308 | case "$1" in 309 | start) 310 | start_me 311 | ;; 312 | stop) 313 | stop_me 314 | ;; 315 | restart) 316 | stop_me 317 | start_me 318 | ;; 319 | status) 320 | status_me 321 | ;; 322 | filter) 323 | filter_me 324 | ;; 325 | *) 326 | printf "Usage: $0 {start|stop|restart|status|filter}\n" >&2 327 | exit 1 328 | esac 329 | 330 | exit 0 331 | -------------------------------------------------------------------------------- /supershaper.init: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ### BEGIN INIT INFO 4 | # Provides: supershaper 5 | # Required-Start: $remote_fs $syslog $network 6 | # Required-Stop: $remote_fs $syslog $network 7 | # Default-Start: 2 3 4 5 8 | # Default-Stop: 0 1 6 9 | # Short-Description: traffic shaping rules for DSL 10 | # Description: traffic shaping rules for DSL 11 | ### END INIT INFO 12 | 13 | ############################################################################## 14 | # 15 | # SuperShaper-SOHO 2.0 16 | # 17 | # Bandwidth shaper for small/home office DSL connection. 18 | # 19 | # Copyright (C) 2004-2017 Robin Smidsrød 20 | # 21 | # License details and more available at: 22 | # https://github.com/robinsmidsrod/SuperShaper-SOHO 23 | # 24 | # Contact information available at: 25 | # http://robin.smidsrod.no/contact/ 26 | # 27 | # This script is designed to shape your upstream bandwidth to 28 | # minimize latency for interactive applications like SSH and making 29 | # sure P2P applications doesn't saturate your upstream. Standard surfing/mail 30 | # software is also given priority over P2P to make them snappy. 31 | # Typical VoIP traffic (SIP/RTP/Skype) is given priority to make sure IP 32 | # telephony doesn't suffer even on a very congested link. 33 | # 34 | # Ingress (inbound) policing is not set up at all, as it is questionable how 35 | # well it works. Only egress (outbound) shaping, which is known to be effective, is 36 | # set up. 37 | # 38 | # This script needs iproute2 (tc) and HTB/FQ_CODEL Linux kernel netfilter 39 | # schedulers. The fq_codel scheduler was shipped with Linux kernel and 40 | # iproute2 3.6, but is most effective with kernels from 3.12 onwards. See 41 | # https://www.bufferbloat.net/projects/codel/wiki/ for more details. The 42 | # HTB scheduler has been part of Linux since the 2.x versions, so no current 43 | # systems should miss it. If you don't have access to fq_codel it is viable 44 | # to replace it with the SFQ scheduler. 45 | # 46 | # The TC filter howto can be found here: http://lartc.org/howto/lartc.qdisc.filters.html 47 | # Man page for u32 classifier can be found here: http://man7.org/linux/man-pages/man8/tc-u32.8.html 48 | # 49 | ############################################################################## 50 | 51 | # Change these values to reflect your own setup. Make sure to comment out 52 | # filter commands in the advanced section if you don't use all features 53 | # mentioned below. 54 | 55 | # Your outbound interface 56 | DEV=ppp0 57 | 58 | # Your downstream capacity in kilobits/second 59 | # Not currently used for anything 60 | DOWNLOAD_BW=24490 # 24.5Mbps, measured 2017-08-31 61 | 62 | # Your upstream capacity in kilobits/second 63 | # Run speedtest.net while pinging upstream first hop and look at max latency 64 | # and packet loss summary after test is complete 65 | UPLINK_BW=3422 # 3.4Mbps, measured 2017-08-31 66 | 67 | # DSL modems usually have large queues that break latency. This phenomenon 68 | # is called "bufferbloat". Set this value high as your DSL modem can 69 | # handle without queuing packets itself. The value is in percent. I 70 | # usually saturate the upstream with traffic/uploads and use iptraf to 71 | # measure the outbound traffic on the interface to determine when the 72 | # shaping takes effect. If iptraf reports higher bandwidth than your 73 | # calculated bandwidth (see UPLINK below) you modem is probably still 74 | # queuing packets. This can only be set by trial an error, but 90% is 75 | # probably a good ballpark number. 76 | UPLINK_PERCENT=90 77 | 78 | # Skype normally uses a random UDP/TCP port, but specify it manually to be 79 | # able to control it better 80 | PORT_SKYPE=15000 81 | 82 | # Additional BitTorrent port (the standard BitTorrent port is already defined) 83 | PORT_BT=50000 84 | 85 | # This is the source port for the internal OpenVPN server 86 | PORT_OPENVPN=1194 87 | 88 | # IP address where your work VPN client traffic goes to 89 | WORK_VPN_IP=1.2.3.4 90 | 91 | # IP address where your Lync (Skype for Business) traffic goes to. 92 | # You can (usually) get hold of this information by holding Ctrl down while 93 | # right-clicking the Lync tray icon, then you'll find an option called 94 | # "Configuration information". You might also need to check for established 95 | # connections using the "conntrack -L" command while doing a "Check call 96 | # quality" action in Lync. That might indicate an additional IP address. 97 | # If so you might need to add another IP in a separate environment variable 98 | # and add another entry in the advanced section. 99 | LYNC_IP=1.2.3.5 100 | #LYNC_IP2=1.2.3.6 101 | 102 | # The IP address your cloud backup traffic goes to 103 | CLOUD_BACKUP_IP=74.126.144.105 # SpiderOakOne 104 | 105 | # Set full path to TC command, unless it's in PATH 106 | TC=tc 107 | 108 | # Where to store flow labels, accessible for other tools 109 | FLOWS_FILENAME="/run/tc-flows.csv" 110 | 111 | ############################################################################## 112 | ######## Nothing to change below this line unless you're adventurous ######### 113 | ############################################################################## 114 | 115 | # Calculate actual max bandwidth 116 | UPLINK=$((UPLINK_PERCENT*UPLINK_BW/100)) 117 | 118 | # Which qdisc to use for HFSC leaves 119 | # Turns out that the old sfq seems to work better than fq_codel in 120 | # conjunction with HFSC Try out both and decide for yourself 121 | LEAF_QDISC="sfq divisor 65536 headdrop" 122 | #LEAF_QDISC="fq_codel noecn" 123 | 124 | filter_prio=1 125 | function filter_for_flow { 126 | flowid="$1"; shift 127 | $TC filter add dev $DEV parent 1: protocol ip prio $((filter_prio++)) u32 "$@" flowid "1:$flowid" 128 | } 129 | 130 | used_bw_percent=0 131 | function define_ls_flow { 132 | flowid="$1"; min_bw_percent="$2"; label="$3"; shift 3 133 | min_bw=$((min_bw_percent*UPLINK/100)) 134 | $TC class add dev $DEV parent 1:1 classid "1:$flowid" hfsc ls m2 "${min_bw}kbit" 135 | $TC qdisc add dev $DEV parent "1:$flowid" handle "$flowid:" $LEAF_QDISC 136 | used_bw_percent=$((used_bw_percent+min_bw_percent)) 137 | printf "Flow 1:$flowid allocates a minimum rate of %4d Kbps (%2d%%) - %s\n" $min_bw $min_bw_percent "$label" 138 | printf "$DEV|hfsc|1:$flowid|$label\n" >> "$FLOWS_FILENAME" 139 | printf "$DEV|sfq|$flowid:|$label\n" >> "$FLOWS_FILENAME" 140 | } 141 | 142 | function start_me { 143 | stop_me quiet # Remove existing flows and filters 144 | 145 | printf "Turning on packet shaping on $DEV at rate ${UPLINK} Kbps\n" 146 | 147 | ################### FLOW DEFINITIONS ################### 148 | 149 | # Add root qdisc 150 | $TC qdisc add dev $DEV root handle 1: hfsc default 50 151 | 152 | # Add main class, setting interface rate limit (your upstream max bandwidth) 153 | $TC class add dev $DEV parent 1: classid 1:1 hfsc ls m2 "${UPLINK}kbit" ul m2 "${UPLINK}kbit" 154 | printf "$DEV|hfsc|1:1|Main\n" >> "$FLOWS_FILENAME" 155 | 156 | # define_ls_flow