#!/bin/sh

################################################################################
# Modification History;
#
# Date------ Author----- Description--------------------------------------------
# 2007/11/26 M. Pepin    Initial creation (adapted from BCM 4.0)
# 2008/09/12 M. Pepin    Support 8 queues instead of 4
#
################################################################################

TC=/sbin/tc

# We always expect either 3 or 19 parameters (0..18) where the first $0 parameter is the script path name
if [[ $# -ne 2 && $# -ne 18 ]];
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 "                   <Q5_RATE> <Q5_CEIL> <Q6_RATE> <Q6_CEIL> <Q7_RATE> <Q7_CEIL> <Q8_RATE> <Q8_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"
        echo "  $0 eth1 100000 1 100 5 100 50 50 10 100 10 100 5 100 15 100 4 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


################################################################################
# **************************** get the parameter values ************************

# 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) ))

if [ $# -eq 2 ];
then

source /nn/etc/qos/tchtb_default_settings.conf

else

Q1_RATE=$3
Q1_CEIL=$4
Q2_RATE=$5
Q2_CEIL=$6
Q3_RATE=$7
Q3_CEIL=$8
Q4_RATE=$9
Q4_CEIL=$10
Q5_RATE=$11
Q5_CEIL=$12
Q6_RATE=$13
Q6_CEIL=$14
Q7_RATE=$15
Q7_CEIL=$16
Q8_RATE=$17
Q8_CEIL=$18

fi

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

# ***************************** computation start ******************************

# There is an adjustment that needs to be implemented
# for all the queues depending on their target frame size.
# The lowest target MTU that can be programmed for HTB is 256.
#
# However, by experimenting with a traffic generator, 
# it was found that theoritical queue adjustments did not 
# necessarily match the practical ones. The exact values
# are defined in the constants below.

RATE_INCREASE=0
TMP_RATE=0
TMP_CEIL=0
OTHER_HEADER_ADJ_64=-60
OTHER_HEADER_ADJ_256=-15
OTHER_HEADER_ADJ_512=-15
OTHER_HEADER_ADJ_DIVIDER=1000

# Adjustements are required to rates and ceil values.

RATE_TMP=$(( (${Q1_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q1_CEIL}*$LINK_SPEED)/100 ))
CRITICAL_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
CRITICAL_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
RATE_INCREASE=$(( ($CRITICAL_RATE-$RATE_TMP)+$RATE_INCREASE ))

RATE_TMP=$(( (${Q2_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q2_CEIL}*$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=$(( (${Q3_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q3_CEIL}*$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=$(( (${Q4_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q4_CEIL}*$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=$(( (${Q5_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q5_CEIL}*$LINK_SPEED)/100 ))
GOLD_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
GOLD_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
RATE_INCREASE=$(( ($GOLD_RATE-$RATE_TMP)+$RATE_INCREASE ))

RATE_TMP=$(( (${Q6_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q6_CEIL}*$LINK_SPEED)/100 ))
SILVER_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
SILVER_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
RATE_INCREASE=$(( ($SILVER_RATE-$RATE_TMP)+$RATE_INCREASE ))

RATE_TMP=$(( (${Q7_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q7_CEIL}*$LINK_SPEED)/100 ))
BRONZE_RATE=$(( $RATE_TMP+($OTHER_HEADER_ADJ_512*($RATE_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
BRONZE_CEIL=$(( $CEIL_TMP+($OTHER_HEADER_ADJ_512*($CEIL_TMP)/$OTHER_HEADER_ADJ_DIVIDER) ))
RATE_INCREASE=$(( ($BRONZE_RATE-$RATE_TMP)+$RATE_INCREASE ))

RATE_TMP=$(( (${Q8_RATE}*$LINK_SPEED)/100 ))
CEIL_TMP=$(( (${Q8_CEIL}*$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 ))


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

HTB_QUEUES_RATE=${HTB_QUEUES_RATE}bps

CRITICAL_RATE=${CRITICAL_RATE}bps
NETWORK_RATE=${NETWORK_RATE}bps
PREMIUM_RATE=${PREMIUM_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

CRITICAL_CEIL=${CRITICAL_CEIL}bps
NETWORK_CEIL=${NETWORK_CEIL}bps
PREMIUM_CEIL=${PREMIUM_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 [ "$CRITICAL_RATE" = "0bps" ]
then
  CRITICAL_RATE=${DROP_RATE}
  CRITICAL_MTU=${DROP_MTU}
  if  [ "$CRITICAL_CEIL" = "0bps" ]
  then   
    CRITICAL_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 [ "$PREMIUM_RATE" = "0bps" ]
then
  PREMIUM_RATE=${DROP_RATE}
  PREMIUM_MTU=${DROP_MTU}
  if  [ "$PREMIUM_CEIL" = "0bps" ]
  then   
    PREMIUM_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 [ "$GOLD_RATE" = "0bps" ]
then
  GOLD_RATE=${DROP_RATE}
  GOLD_MTU=${DROP_MTU}
  if  [ "$GOLD_CEIL" = "0bps" ]
  then   
    GOLD_CEIL=${DROP_CEIL}
  fi
fi
if [ "$SILVER_RATE" = "0bps" ]
then
  SILVER_RATE=${DROP_RATE}
  SILVER_MTU=${DROP_MTU}
  if  [ "$SILVER_CEIL" = "0bps" ]
  then   
    SILVER_CEIL=${DROP_CEIL}
  fi
fi
if [ "$BRONZE_RATE" = "0bps" ]
then
  BRONZE_RATE=${DROP_RATE}
  BRONZE_MTU=${DROP_MTU}
  if  [ "$BRONZE_CEIL" = "0bps" ]
  then   
    BRONZE_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 classes 
# Note the VoIP queue (PREMIUM) using priority 0 to keep the latency low by getting served faster compared to the other queues
$TC class add dev $DEV parent 1:100 classid 1:1 htb rate $CRITICAL_RATE ceil $CRITICAL_CEIL mtu $CRITICAL_MTU  prio 1 ; 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 $PREMIUM_RATE ceil $PREMIUM_CEIL mtu $PREMIUM_MTU  prio 0 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:4 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:5 htb rate $GOLD_RATE ceil $GOLD_CEIL mtu $GOLD_MTU  prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:6 htb rate $SILVER_RATE ceil $SILVER_CEIL mtu $SILVER_MTU  prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:7 htb rate $BRONZE_RATE ceil $BRONZE_CEIL mtu $BRONZE_MTU  prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))
$TC class add dev $DEV parent 1:100 classid 1:8 htb rate $STANDARD_RATE ceil $STANDARD_CEIL mtu $STANDARD_MTU prio 1 ; EXIT_CODE=$(($EXIT_CODE+$?))

# Attach queuing disciplines to the leaf classes
# Note the VoIP queue (PREMIUM) using a longer queue to handle more small packets compared to the other queues
$TC qdisc add dev $DEV parent 1:1 handle 10: pfifo limit 100; 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 600; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:4 handle 40: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:5 handle 50: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:6 handle 60: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:7 handle 70: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))
$TC qdisc add dev $DEV parent 1:8 handle 80: pfifo limit 100; EXIT_CODE=$(($EXIT_CODE+$?))

exit $EXIT_CODE
