#!/bin/sh

# Wonder Shaper
# please read the README before filling out these values 
#
# Set the following values to somewhat less than your actual download
# and uplink speed. In kilobits. Also set the device that is to be shaped.
#DOWNLINK=
#UPLINK=
#DEV=

usage()
{
    echo "usage: $(basename ${0}) -i|--interface dev -d|--down kbps -u|--up kbps start"
    echo "       $(basename ${0}) -i|--interface dev stop"
    echo "       $(basename ${0}) -i|--interface dev status"
    exit 1
}

# if number of options/arguments >= 1, then
if [ ${#} -ge 3 ]; then
    # process options/arguments
    while getopts i:u:d:-: FLAG
      do
      case ${FLAG} in
          i)
              DEV=${OPTARG}
              ;;
          u)
              UPLINK=${OPTARG}
              ;;
          d)
              DOWNLINK=${OPTARG}
              ;;
          -)
              case ${OPTARG} in
                  interface)
                      shift $((${OPTIND} - 1))
                      if [ ${#} -lt 1 ]; then
                        echo 'No arg for --interface option'
                        usage
                      fi
                      DEV=${1}
                      shift 1
                      OPTIND=1
                      ;;
                  up)
                      shift $((${OPTIND} - 1))
                      if [ ${#} -lt 1 ]; then
                        echo 'No arg for --up option'
                        usage
                      fi
                      UPLINK=${1}
                      shift 1
                      OPTIND=1
                      ;;
                  down)
                      shift $((${OPTIND} - 1))
                      if [ ${#} -lt 1 ]; then
                        echo 'No arg for --down option'
                        usage
                      fi
                      DOWNLINK=${1}
                      shift 1
                      OPTIND=1
                      ;;
                  *)
                      echo "unknown option: --${OPTARG}"
                      usage
                      ;;
              esac;;
          \?)
              usage
              ;;
          *)
              echo "unknown option: -${FLAG}"
              usage
              ;;
      esac
    done
    shift $((${OPTIND} - 1))
    OPTIND=1
else
    # if no options/arguments, then display usage
    usage
fi

case "${1}" in
  start)
    if [ -z "${DEV}" ]; then
      echo 'No --dev option for start action'
      usage
    fi
    if [ -z "${UPLINK}" ]; then
      echo 'No --up option for start action'
      usage
    fi
    if [ -z "${DOWNLINK}" ]; then
      echo 'No --down option for start action'
      usage
    fi
    ;;
  stop)
    if [ -z "${DEV}" ]; then
      echo 'No --dev option for stop action'
      usage
    fi
    ;;
  status)
    if [ -z "${DEV}" ]; then
      echo 'No --dev option for status action'
      usage
    fi
    ;;
  "")
    echo "No action for $(basename ${0}) command"
    usage
    ;;
  *)
    echo "Illegal action ${1}"
    usage
    ;;
esac

# low priority OUTGOING traffic - you can leave this blank if you want
# low priority source netmasks
NOPRIOHOSTSRC=

# low priority destination netmasks
NOPRIOHOSTDST=

# low priority source ports
NOPRIOPORTSRC=

# low priority destination ports
NOPRIOPORTDST=

# Now remove the following two lines :-)

#echo Please read the documentation in 'README' first :-\)
#exit

#########################################################

if [ "${1}" = "status" ]
then
	tc -s qdisc ls dev ${DEV}
	tc -s class ls dev ${DEV}
	exit
fi


# clean existing down- and uplink qdiscs, hide errors
tc qdisc del dev ${DEV} root    2> /dev/null > /dev/null
tc qdisc del dev ${DEV} ingress 2> /dev/null > /dev/null

if [ "${1}" = "stop" ] 
then 
	exit
fi

###### uplink

# install root CBQ

tc qdisc add dev ${DEV} root handle 1: cbq avpkt 1000 bandwidth 10mbit 

# shape everything at ${UPLINK} speed - this prevents huge queues in your
# DSL modem which destroy latency:
# main class

tc class add dev ${DEV} parent 1: classid 1:1 cbq rate ${UPLINK}kbit \
allot 1500 prio 5 bounded isolated 

# high prio class 1:10:

tc class add dev ${DEV} parent 1:1 classid 1:10 cbq rate ${UPLINK}kbit \
   allot 1600 prio 1 avpkt 1000

# bulk and default class 1:20 - gets slightly less traffic, 
#  and a lower priority:

tc class add dev ${DEV} parent 1:1 classid 1:20 cbq rate $((9*${UPLINK}/10))kbit \
   allot 1600 prio 2 avpkt 1000

# 'traffic we hate'

tc class add dev ${DEV} parent 1:1 classid 1:30 cbq rate $((8*${UPLINK}/10))kbit \
   allot 1600 prio 2 avpkt 1000

# all get Stochastic Fairness:
tc qdisc add dev ${DEV} parent 1:10 handle 10: sfq perturb 10
tc qdisc add dev ${DEV} parent 1:20 handle 20: sfq perturb 10
tc qdisc add dev ${DEV} parent 1:30 handle 30: sfq perturb 10

# start filters
# TOS Minimum Delay (ssh, NOT scp) in 1:10:
tc filter add dev ${DEV} parent 1:0 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 ${DEV} parent 1:0 protocol ip prio 11 u32 \
        match ip protocol 1 0xff flowid 1:10

# prioritize small packets (<64 bytes)

tc filter add dev ${DEV} 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 PORT in ${NOPRIOPORTDST}
do
	tc filter add dev ${DEV} parent 1: protocol ip prio 14 u32 \
	   match ip dport ${PORT} 0xffff flowid 1:30
done

for PORT in ${NOPRIOPORTSRC}
do
 	tc filter add dev ${DEV} parent 1: protocol ip prio 15 u32 \
	   match ip sport ${PORT} 0xffff flowid 1:30
done

for PORT in ${NOPRIOHOSTSRC}
do
 	tc filter add dev ${DEV} parent 1: protocol ip prio 16 u32 \
	   match ip src ${PORT} flowid 1:30
done

for PORT in ${NOPRIOHOSTDST}
do
 	tc filter add dev ${DEV} parent 1: protocol ip prio 17 u32 \
	   match ip dst ${PORT} flowid 1:30
done

# rest is 'non-interactive' ie 'bulk' and ends up in 1:20

tc filter add dev ${DEV} 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:

tc qdisc add dev ${DEV} handle ffff: ingress

# filter *everything* to it (0.0.0.0/0), drop everything that's
# coming in too fast:

tc filter add dev ${DEV} parent ffff: protocol ip prio 50 u32 match ip src \
   0.0.0.0/0 police rate ${DOWNLINK}kbit burst 10k drop flowid :1

exit 0