#!/bin/sh

################################################################################
# Modification History;
#
# Date------ Author----- Description--------------------------------------------
# 2007/11/26 M. Pepin    Initial creation (adapted from BCM 4.0)
#
################################################################################

TC=/sbin/tc

# We always expect 11 parameters (0..10) where the first $0 parameter is the script path name
if [ $# -ne 10 ];
then
        echo "Usage: "
        echo ""
        echo "  $0 <DEV> <SPEED> <Q1_RATE> <Q1_CEIL> <Q2_RATE> <Q2_CEIL> <Q3_RATE> <Q3_CEIL> <Q4_RATE> <Q4_CEIL>"
        echo "     where:"
        echo "          <DEV>       -- net device name to be configured with PRIO queuing discipline"
        echo "          <SPEED>     -- link speed in kilo-bits per second"
        echo "          <Q?_RATE>   -- minimum guaranteed bandwidth (value in %)"
        echo "          <Q?_CEIL>   -- maximum allowed bandwidth including borrowing (value in %)"
        echo ""
        echo "Example:"
        echo ""
        echo "  $0 eth1 100000 70 70 10 100 10 100 10 100"
        echo ""
        echo "To print network device statistics use the 'tc' utility instead:"
        echo ""
        echo "  $TC -s qdisc show dev eth1"
        echo "  $TC -s class show dev eth1"

        exit 1
fi

EXIT_CODE=0

################################################################################
# ***************************** computation start ******************************
#
# Link speed we receive as parameter for this script is expected in Kilo bits / second!
# Convert all kbits values into bytes per second
DEV=$1

LINK_SPEED=$(( (($2*1000)/8) ))

# Configure each queue based on its average frame size (mtu value in HTB)
PARENT_MTU=256
PREMIUM_MTU=256
NETWORK_MTU=512
PLATINUM_MTU=512
STANDARD_MTU=512

# Here we have to check if the egress device is a wan interface. 
# If the case, then we must adjust the layer2 frame header length.
# In BCM, the wanx network devices use an "ethernet" header at the
# IP networking level (which is 14 bytes long not counting the FCS).
# In reality, a normal wan network device would use a 6-byte long
# Q.922 header with FCS to carry IP PDUs. The adjustment is based
# on the average frame size per queue. The parent queue will also
# need to be adjusted based on the sum of adjustments of each queue.
#
# Here are the adjustments per average frame size:
#   Formula:  adjustment = (8/frame size) where
#             14-6=8 (eth hdr - fcs - Q.922 hdr with fcs)
#
#   Size:  64   Adjustment: 1.125 [x * 1125/1000]
#   Size: 256   Adjustment: 1.031 [x * 1031/1000]
#   Size: 512   Adjustment: 1.015 [x * 1015/1000]
#
#   However, by experimenting with traffic generators, 
#   queue #1 gets better results if we use 2.6% increase
#   in bandwidth when the average frame size is 256. 
#   Queues #2 to #4 get better results if there is no 
#   adjustment in bandwidth. 
#
# There is another adjustment that needs to be implemented
# for the voice traffic queue #1. The lowest average frame
# size value that can be programmed is 256. However, the 
# target value is 64 bytes long frames on average. To 
# compensate for this difference, we need to increase the
# rate and ceil values by a linear factor.
#
# Similarly, there are adjustments required on the non-WAN interfaces.
#
# However, by experimenting with a traffic generator, 
# it was found that theoritical queue adjustments did not 
# necessarily matched the practical ones. The exact values
# are defined in the constants below.

RATE_INCREASE=0
TMP_RATE=0
TMP_CEIL=0
WAN_HEADER_ADJ_64=112
WAN_HEADER_ADJ_256=31
WAN_HEADER_ADJ_512=7
WAN_HEADER_ADJ_DIVIDER=1000
OTHER_HEADER_ADJ_64=-60
OTHER_HEADER_ADJ_256=-15
OTHER_HEADER_ADJ_512=-15
OTHER_HEADER_ADJ_DIVIDER=1000

if [ "$1" = "wan1" ] || [ "$1" = "wan2" ]
then
   # Adjustements are required to rates and ceil values.

   RATE_TMP=$(( (${3}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${4}*$LINK_SPEED)/100 ))
   PREMIUM_RATE=$(( $RATE_TMP+($WAN_HEADER_ADJ_64*($RATE_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   PREMIUM_CEIL=$(( $CEIL_TMP+($WAN_HEADER_ADJ_64*($CEIL_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($PREMIUM_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${5}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${6}*$LINK_SPEED)/100 ))
   NETWORK_RATE=$(( $RATE_TMP+($WAN_HEADER_ADJ_512*($RATE_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   NETWORK_CEIL=$(( $CEIL_TMP+($WAN_HEADER_ADJ_512*($CEIL_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($NETWORK_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${7}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${8}*$LINK_SPEED)/100 ))
   PLATINUM_RATE=$(( $RATE_TMP+($WAN_HEADER_ADJ_512*($RATE_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   PLATINUM_CEIL=$(( $CEIL_TMP+($WAN_HEADER_ADJ_512*($CEIL_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($PLATINUM_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${9}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${10}*$LINK_SPEED)/100 ))
   STANDARD_RATE=$(( $RATE_TMP+($WAN_HEADER_ADJ_512*($RATE_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   STANDARD_CEIL=$(( $CEIL_TMP+($WAN_HEADER_ADJ_512*($CEIL_TMP)/$WAN_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($STANDARD_RATE-$RATE_TMP)+$RATE_INCREASE ))
else
   # Adjustements are required to rates and ceil values.

   RATE_TMP=$(( (${3}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${4}*$LINK_SPEED)/100 ))
   PREMIUM_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_256*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   PREMIUM_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_256*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($PREMIUM_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${5}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${6}*$LINK_SPEED)/100 ))
   NETWORK_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   NETWORK_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($NETWORK_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${7}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${8}*$LINK_SPEED)/100 ))
   PLATINUM_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   PLATINUM_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($PLATINUM_RATE-$RATE_TMP)+$RATE_INCREASE ))

   RATE_TMP=$(( (${9}*$LINK_SPEED)/100 ))
   CEIL_TMP=$(( (${10}*$LINK_SPEED)/100 ))
   STANDARD_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   STANDARD_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
   RATE_INCREASE=$(( ($STANDARD_RATE-$RATE_TMP)+$RATE_INCREASE ))
fi

HTB_QUEUES_RATE=$(( ($LINK_SPEED+RATE_INCREASE) ))

HTB_QUEUES_RATE=${HTB_QUEUES_RATE}bps

PREMIUM_RATE=${PREMIUM_RATE}bps
NETWORK_RATE=${NETWORK_RATE}bps
PLATINUM_RATE=${PLATINUM_RATE}bps
GOLD_RATE=${GOLD_RATE}bps
SILVER_RATE=${SILVER_RATE}bps
BRONZE_RATE=${BRONZE_RATE}bps
STANDARD_RATE=${STANDARD_RATE}bps

PREMIUM_CEIL=${PREMIUM_CEIL}bps
NETWORK_CEIL=${NETWORK_CEIL}bps
PLATINUM_CEIL=${PLATINUM_CEIL}bps
GOLD_CEIL=${GOLD_CEIL}bps
SILVER_CEIL=${SILVER_CEIL}bps
BRONZE_CEIL=${BRONZE_CEIL}bps
STANDARD_CEIL=${STANDARD_CEIL}bps 

LINK_SPEED=${LINK_SPEED}bps

DROP_RATE=4bps
DROP_CEIL=4bps
DROP_MTU=256


# Adjust the parameters in case all traffic must be dropped on a given queue.
# Also set the rate or ceil values to the lowest possible value in case
# they are set to "0".
if [ "$PREMIUM_RATE" = "0bps" ]
then
  PREMIUM_RATE=${DROP_RATE}
  PREMIUM_MTU=${DROP_MTU}
  if  [ "$PREMIUM_CEIL" = "0bps" ]
  then   
    PREMIUM_CEIL=${DROP_CEIL}
  fi
fi
if [ "$NETWORK_RATE" = "0bps" ]
then
  NETWORK_RATE=${DROP_RATE}
  NETWORK_MTU=${DROP_MTU}
  if  [ "$NETWORK_CEIL" = "0bps" ]
  then   
    NETWORK_CEIL=${DROP_CEIL}
  fi
fi
if [ "$PLATINUM_RATE" = "0bps" ]
then
  PLATINUM_RATE=${DROP_RATE}
  PLATINUM_MTU=${DROP_MTU}
  if  [ "$PLATINUM_CEIL" = "0bps" ]
  then   
    PLATINUM_CEIL=${DROP_CEIL}
  fi
fi
if [ "$STANDARD_RATE" = "0bps" ]
then
  STANDARD_RATE=${DROP_RATE}
  STANDARD_MTU=${DROP_MTU}
  if  [ "$STANDARD_CEIL" = "0bps" ]
  then   
    STANDARD_CEIL=${DROP_CEIL}
  fi
fi

# ***************************** computation end ********************************
################################################################################


#Free pevious QoS Settings
$TC qdisc del dev $DEV root handle 1: prio  2> /dev/null
$TC qdisc del  dev $DEV root handle 1: htb default 4 2> /dev/null

#Attach HTB to <network device>
$TC qdisc add dev $DEV root handle 1: htb default 4 ; EXIT_CODE=$(($EXIT_CODE+$?))


$TC class add dev $DEV parent 1: classid 1:100 htb rate $HTB_QUEUES_RATE ceil $HTB_QUEUES_RATE mtu $PARENT_MTU; EXIT_CODE=$(($EXIT_CODE+$?))


#Create the other 4 classes :PREMIUM,NETWORK,PLATINUM ....
$TC class add dev $DEV parent 1:100 classid 1:1 htb rate $PREMIUM_RATE ceil $PREMIUM_CEIL mtu $PREMIUM_MTU  prio 0 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:2 htb rate $NETWORK_RATE ceil $NETWORK_CEIL mtu $NETWORK_MTU  prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:3 htb rate $PLATINUM_RATE ceil $PLATINUM_CEIL mtu $PLATINUM_MTU prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:4 htb rate $STANDARD_RATE ceil $STANDARD_CEIL mtu $STANDARD_MTU prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))

#Attach queuing disciplines to the leaf classes
$TC qdisc add dev $DEV parent 1:1 handle 10: pfifo limit 600; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:2 handle 20: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:3 handle 30: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:4 handle 40: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))

exit $EXIT_CODE
