floppyfw
tweak
wshaper

Archival page … no longer updated.

How to tweak Wondershaper

  • This how to is for advanced tweaking of a test version of the wshaper.htb script.

  • What you will need

  • I used floppyfw-3.0.12 for testing. Any stable version 3.0.5 and after have wshaper_r24 built in and should work fine.
  • A linux system with subversion installed is indespensible to access the various floppyfw subversion revisions available at http://www.zelow.no/svn/.
  • A certain amount of geek factor is required for this how to. Created for the advanced user, to squeeze the last drop of performance from their system.

  • Configuration Procedure

  • Download the wondershaper version you'd like to use as a base script from floppyfw svn repository.
  • The following example svn command will download svn version 107 of wshaper.htb (version 21) of wshaper.htb and save it in your current working directory as wshaper_r21.htb.
  • svn cat --revision 107 http://www.zelow.no/svn/floppyfw-3.0/scripts/wshaper.htb > wshaper_r21.htb
  • Edit the wshaper_r21.htb file to your liking for test purposes and save it as "wshaper_test.htb".
  • Place the wshaper_test.htb file you edited above on your floppyfw boot media /packages directory.
  • Create a "pre-wshp.ini" file with the content shown below
    	#!/bin/sh
	echo "copy my wondershaper voip script over original"
	cp /mnt/tmp/packages/wshaper_test.htb /sbin/wshaper.htb
	chmod 755 /sbin/wshaper.htb

. . . and place it on your floppyfw boot media /packages directory.
  • Reboot your system with the wshaper_test.htb and pre-wshp.ini files on the /packages directory and test it.
  • To revert to your original version, remove the pre-wshp.ini and wshaper_test.htb files from the /packages directory and reboot.

  • A roadmap to the wondershaper versions available in svn follows:

  • svn 1-79: wondershaper original version (r1)
# Some small things changed by Thomas Lundquist <thomasez@zelow.no>
# to make it work with floppyfw
# Basically, it's grabbing values from files in /etc and changing the
# calculations from bash'ism to using expr.
  • svn 80-87: r12
# 060605 r12 thomasez: s/SERVER_IP/PHONE_IP/
  • svn 88-98: r13
# 060606 r13 moved some vars to config for better utility
# 060606 r13 added logic to test if PHONE_IP is empty in config
  • svn 99-107: r21
# 060622 r21 added WARNING message if no voip ports are entered in config.
  • svn 108-110: r23
# r23 060711 removed class 40 and re-distributed its percentage to class 20 and 30
  • svn 111-244: r24
# r24 060815 added INGRESS_COP var and "nocop" arg for policer on/off sw
  • --------------------------------------------------------------------------------
development only versions follow - not in svn
--------------------------------------------------------------------------------
# Brad Skiff added mods for VoIP class <bbbrad2dbone@hotmail.com>
# adapted portions from Kristian Kielhofner's htb script <kris@krisk.org>

# 060530 r2 dropped r2q 100 part and changed default class to 30 from 20.
# 060530 r2 added "...Stopped - exit" message.
# 060530 r3 added dst $SERVER_IP/32 to voip "tos" selection
# 060531 r4 added r2q calc (r2q = 125*${UPLINK}kbit/mtu)
# 060531 r5 added fixed rate values and calc'd ceil values to prio 1-4
# 060531 r6 upped ingress burst from 10K to 20K - boosted download speed
# 060531 r7 cleanup and tweaking - removed 90% and 80% CUTTED values
# 060601 r8 added calc'd quantum to classes
# 060601 r9 added kog script suggestions correctly
# 060602 r10 calculating more stuff to make it easier to tweak
# 060602 r11 made for-do loop for stochastic fairness
# see r12 and r13 in svn list above
# 060608 r14 put RT20, RT30, RT40 back in here as calc'd values
# 060608 r15 fixed err on class 40 - missing "kbit" on UPLINK var
# 060612 r16 add count function and replace VOIPPORTS with LO_RTPPORT, HI_RTPPORT
# 060616 r17 added logic to check for empty ports vars in config - more flexible
# 060616 r17 put SIP ports in class 10 since some (asterisk) use them for RTP too.
# 060616 r18 added logic to eliminate the VoIP class if RT10= is blank in config.
# 060617 r19 revised r18 and added PHONE_IP to the disqualifiers with RT10.
# 060621 r20 removed some redundant/dead code.
# see r21 in svn list above
# 060630 r22 commented out ICMP and made it a test template.
# see r23 and r24 in svn list above

 wsmenu  is a small menu package used to facilitate testing wondershaper and more…

wsmenu r03

It is available from the floppyfw sites 3.0.x packages directories in .bz2 or .ffw format. The "r03" version is part of the standard package build in floppyfw 3.0.2 and later. The "show or >Do" indicates which menu selections take ACTION or ">Do" something (those preceded by the greater-than ">" symbol) and which menu selections only "show" or DISPLAY information. Add the wsmenu package to your /packages directory and reboot to install. Delete it and reboot to remove.

The test data shown below shows the impact on download rate with the ingress policer turned ON, OFF and with wondershaper disabled entirely.

dslreports speed test results

Some useful references:
floppyfw
voip howto

Updated: 03-Jan-2012