#!/bin/bash
#
# Benchmark script:
#  - developed for benchmarking ingress qdisc path
#
# Script for injecting packets into RX path of the stack with pktgen
# "xmit_mode netif_receive".  With an invalid dst_mac this will only
# measure the ingress code path as packets gets dropped in ip_rcv().
#
# This script don't really need any hardware.  It benchmarks software
# RX path just after NIC driver level.  With bursting is also
# "removes" the SKB alloc/free overhead.
#
# Setup scenarios for measuring ingress qdisc (with invalid dst_mac):
# ------------------------------------------------------------------
# (1) no ingress (uses static_key_false(&ingress_needed))
#
# (2) ingress on other dev (change ingress_needed and calls
#     handle_ing() but exit early)
#
#  config:  tc qdisc add dev $SOMEDEV handle ffff: ingress
#
# (3) ingress on this dev, handle_ing() -> tc_classify()
#
#  config:  tc qdisc add dev $DEV handle ffff: ingress
#
# (4) ingress on this dev + drop at u32 classifier/action.
#
global basedir := $[dirname $0]
source $(basedir)/functions.sh
root_check_run_with_sudo @Argv

# Parameter parsing via include
source $(basedir)/parameters.sh
# Using invalid DST_MAC will cause the packets to get dropped in
# ip_rcv() which is part of the test
if test -z $DEST_IP {
    test -z $IP6 && global DEST_IP := '"198.18.0.42'" || global DEST_IP := '"FD00::1'"
}
test -z $DST_MAC && global DST_MAC := '"90:e2:ba:ff:ff:ff'"
test -z $BURST && global BURST := '1024'

# Base Config
global DELAY := '"0'"        # Zero means max speed
global COUNT := '"10000000'" # Zero means indefinitely

# General cleanup everything since last run
pg_ctrl "reset"

# Threads are specified with parameter -t value in $THREADS
for ((thread = 0; thread < $THREADS; thread++)); do
    # The device name is extended with @name, using thread number to
    # make then unique, but any name will do.
    dev=${DEV}@${thread}

    # Add remove all other devices and add_device $dev to thread
    pg_thread $thread "rem_device_all"
    pg_thread $thread "add_device" $dev

    # Base config of dev
    pg_set $dev "flag QUEUE_MAP_CPU"
    pg_set $dev "count $COUNT"
    pg_set $dev "pkt_size $PKT_SIZE"
    pg_set $dev "delay $DELAY"
    pg_set $dev "flag NO_TIMESTAMP"

    # Destination
    pg_set $dev "dst_mac $DST_MAC"
    pg_set $dev "dst$IP6 $DEST_IP"

    # Inject packet into RX path of stack
    pg_set $dev "xmit_mode netif_receive"

    # Burst allow us to avoid measuring SKB alloc/free overhead
    pg_set $dev "burst $BURST"
done

# start_run
echo "Running... ctrl^C to stop" > !2
pg_ctrl "start"
echo "Done" > !2

# Print results
for ((thread = 0; thread < $THREADS; thread++)); do
    dev=${DEV}@${thread}
    echo "Device: $dev"
    cat /proc/net/pktgen/$dev | grep -A2 "Result:"
done
(CommandList
  children: [
    (Assignment
      keyword: Assign_None
      pairs: [
        (assign_pair
          lhs: (LhsName name:basedir)
          op: Equal
          rhs: 
            {
              (CommandSubPart
                command_list: (CommandList children:[(C {(dirname)} {($ VSub_Number "$0")})])
                left_token: <Left_Backtick "`">
                spids: [85 89]
              )
            }
          spids: [84]
        )
      ]
      spids: [84]
    )
    (C {(source)} {(${ VSub_Name basedir) (/functions.sh)})
    (C {(root_check_run_with_sudo)} {(DQ ($ VSub_At "$@"))})
    (C {(source)} {(${ VSub_Name basedir) (/parameters.sh)})
    (If
      arms: [
        (if_arm
          cond: [
            (Sentence
              child: (C {(Lit_Other "[")} {(-z)} {(DQ ($ VSub_Name "$DEST_IP"))} {(Lit_Other "]")})
              terminator: <Op_Semi ";">
            )
          ]
          action: [
            (AndOr
              children: [
                (C {(Lit_Other "[")} {(-z)} {(DQ ($ VSub_Name "$IP6"))} {(Lit_Other "]")})
                (AndOr
                  children: [
                    (Assignment
                      keyword: Assign_None
                      pairs: [
                        (assign_pair
                          lhs: (LhsName name:DEST_IP)
                          op: Equal
                          rhs: {(DQ (198.18.0.42))}
                          spids: [149]
                        )
                      ]
                      spids: [149]
                    )
                    (Assignment
                      keyword: Assign_None
                      pairs: [
                        (assign_pair
                          lhs: (LhsName name:DEST_IP)
                          op: Equal
                          rhs: {(DQ ("FD00::1"))}
                          spids: [156]
                        )
                      ]
                      spids: [156]
                    )
                  ]
                  op_id: Op_DPipe
                )
              ]
              op_id: Op_DAmp
            )
          ]
          spids: [-1 134]
        )
      ]
      spids: [-1 161]
    )
    (AndOr
      children: [
        (C {(Lit_Other "[")} {(-z)} {(DQ ($ VSub_Name "$DST_MAC"))} {(Lit_Other "]")})
        (Assignment
          keyword: Assign_None
          pairs: [
            (assign_pair
              lhs: (LhsName name:DST_MAC)
              op: Equal
              rhs: {(DQ ("90:e2:ba:ff:ff:ff"))}
              spids: [175]
            )
          ]
          spids: [175]
        )
      ]
      op_id: Op_DAmp
    )
    (AndOr
      children: [
        (C {(Lit_Other "[")} {(-z)} {(DQ ($ VSub_Name "$BURST"))} {(Lit_Other "]")})
        (Assignment
          keyword: Assign_None
          pairs: [(assign_pair lhs:(LhsName name:BURST) op:Equal rhs:{(1024)} spids:[192])]
          spids: [192]
        )
      ]
      op_id: Op_DAmp
    )
    (Assignment
      keyword: Assign_None
      pairs: [(assign_pair lhs:(LhsName name:DELAY) op:Equal rhs:{(DQ (0))} spids:[199])]
      spids: [199]
    )
    (Assignment
      keyword: Assign_None
      pairs: [(assign_pair lhs:(LhsName name:COUNT) op:Equal rhs:{(DQ (10000000))} spids:[207])]
      spids: [207]
    )
    (C {(pg_ctrl)} {(DQ (reset))})
    (ForExpr
      init: 
        (BinaryAssign
          op_id: Arith_Equal
          left: (LhsName name:thread)
          right: (ArithWord w:{(Lit_Digits 0)})
        )
      cond: 
        (ArithBinary
          op_id: Arith_Less
          left: (ArithVarRef name:thread)
          right: (ArithWord w:{($ VSub_Name "$THREADS")})
        )
      update: (UnaryAssign op_id:Node_PostDPlus child:(LhsName name:thread))
      body: 
        (DoGroup
          children: [
            (Assignment
              keyword: Assign_None
              pairs: [
                (assign_pair
                  lhs: (LhsName name:dev)
                  op: Equal
                  rhs: {(${ VSub_Name DEV) (Lit_Other "@") (${ VSub_Name thread)}
                  spids: [263]
                )
              ]
              spids: [263]
            )
            (C {(pg_thread)} {($ VSub_Name "$thread")} {(DQ (rem_device_all))})
            (C {(pg_thread)} {($ VSub_Name "$thread")} {(DQ (add_device))} {($ VSub_Name "$dev")})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("flag QUEUE_MAP_CPU"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("count ") ($ VSub_Name "$COUNT"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("pkt_size ") ($ VSub_Name "$PKT_SIZE"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("delay ") ($ VSub_Name "$DELAY"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("flag NO_TIMESTAMP"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("dst_mac ") ($ VSub_Name "$DST_MAC"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} 
              {(DQ (dst) ($ VSub_Name "$IP6") (" ") ($ VSub_Name "$DEST_IP"))}
            )
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("xmit_mode netif_receive"))})
            (C {(pg_set)} {($ VSub_Name "$dev")} {(DQ ("burst ") ($ VSub_Name "$BURST"))})
          ]
          spids: [252 406]
        )
    )
    (SimpleCommand
      words: [{(echo)} {(DQ ("Running... ctrl^C to stop"))}]
      redirects: [(Redir op_id:Redir_GreatAnd fd:-1 arg_word:{(2)} spids:[418])]
    )
    (C {(pg_ctrl)} {(DQ (start))})
    (SimpleCommand
      words: [{(echo)} {(DQ (Done))}]
      redirects: [(Redir op_id:Redir_GreatAnd fd:-1 arg_word:{(2)} spids:[433])]
    )
    (ForExpr
      init: 
        (BinaryAssign
          op_id: Arith_Equal
          left: (LhsName name:thread)
          right: (ArithWord w:{(Lit_Digits 0)})
        )
      cond: 
        (ArithBinary
          op_id: Arith_Less
          left: (ArithVarRef name:thread)
          right: (ArithWord w:{($ VSub_Name "$THREADS")})
        )
      update: (UnaryAssign op_id:Node_PostDPlus child:(LhsName name:thread))
      body: 
        (DoGroup
          children: [
            (Assignment
              keyword: Assign_None
              pairs: [
                (assign_pair
                  lhs: (LhsName name:dev)
                  op: Equal
                  rhs: {(${ VSub_Name DEV) (Lit_Other "@") (${ VSub_Name thread)}
                  spids: [466]
                )
              ]
              spids: [466]
            )
            (C {(echo)} {(DQ ("Device: ") ($ VSub_Name "$dev"))})
            (Pipeline
              children: [
                (C {(cat)} {(/proc/net/pktgen/) ($ VSub_Name "$dev")})
                (C {(grep)} {(-A2)} {(DQ ("Result:"))})
              ]
              negated: False
            )
          ]
          spids: [463 499]
        )
    )
  ]
)