xref: /openbmc/linux/samples/pktgen/parameters.sh (revision 40f843ee5e17673780c0969c8248b31a8d926b17)
1b64b0d1eSJesper Dangaard Brouer#
2b2441318SGreg Kroah-Hartman# SPDX-License-Identifier: GPL-2.0
3b64b0d1eSJesper Dangaard Brouer# Common parameter parsing for pktgen scripts
4b64b0d1eSJesper Dangaard Brouer#
5b64b0d1eSJesper Dangaard Brouer
6b64b0d1eSJesper Dangaard Brouerfunction usage() {
7b64b0d1eSJesper Dangaard Brouer    echo ""
8b64b0d1eSJesper Dangaard Brouer    echo "Usage: $0 [-vx] -i ethX"
9b64b0d1eSJesper Dangaard Brouer    echo "  -i : (\$DEV)       output interface/device (required)"
10b64b0d1eSJesper Dangaard Brouer    echo "  -s : (\$PKT_SIZE)  packet size"
11*40f843eeSDaniel T. Lee    echo "  -d : (\$DEST_IP)   destination IP. CIDR (e.g. 198.18.0.0/15) is also allowed"
12b64b0d1eSJesper Dangaard Brouer    echo "  -m : (\$DST_MAC)   destination MAC-addr"
136e32a74aSDaniel T. Lee    echo "  -p : (\$DST_PORT)  destination PORT range (e.g. 433-444) is also allowed"
14b64b0d1eSJesper Dangaard Brouer    echo "  -t : (\$THREADS)   threads to start"
15e0e16672STariq Toukan    echo "  -f : (\$F_THREAD)  index of first thread (zero indexed CPU number)"
16b64b0d1eSJesper Dangaard Brouer    echo "  -c : (\$SKB_CLONE) SKB clones send before alloc new SKB"
1769137ea6STariq Toukan    echo "  -n : (\$COUNT)     num messages to send per thread, 0 means indefinitely"
18b64b0d1eSJesper Dangaard Brouer    echo "  -b : (\$BURST)     HW level bursting of SKBs"
19b64b0d1eSJesper Dangaard Brouer    echo "  -v : (\$VERBOSE)   verbose"
20b64b0d1eSJesper Dangaard Brouer    echo "  -x : (\$DEBUG)     debug"
210f06a678SMartin KaFai Lau    echo "  -6 : (\$IP6)       IPv6"
22b64b0d1eSJesper Dangaard Brouer    echo ""
23b64b0d1eSJesper Dangaard Brouer}
24b64b0d1eSJesper Dangaard Brouer
25b64b0d1eSJesper Dangaard Brouer##  --- Parse command line arguments / parameters ---
26b64b0d1eSJesper Dangaard Brouer## echo "Commandline options:"
276e32a74aSDaniel T. Leewhile getopts "s:i:d:m:p:f:t:c:n:b:vxh6" option; do
28b64b0d1eSJesper Dangaard Brouer    case $option in
29b64b0d1eSJesper Dangaard Brouer        i) # interface
30b64b0d1eSJesper Dangaard Brouer          export DEV=$OPTARG
31b64b0d1eSJesper Dangaard Brouer	  info "Output device set to: DEV=$DEV"
32b64b0d1eSJesper Dangaard Brouer          ;;
33b64b0d1eSJesper Dangaard Brouer        s)
34b64b0d1eSJesper Dangaard Brouer          export PKT_SIZE=$OPTARG
35b64b0d1eSJesper Dangaard Brouer	  info "Packet size set to: PKT_SIZE=$PKT_SIZE bytes"
36b64b0d1eSJesper Dangaard Brouer          ;;
37b64b0d1eSJesper Dangaard Brouer        d) # destination IP
38b64b0d1eSJesper Dangaard Brouer          export DEST_IP=$OPTARG
39b64b0d1eSJesper Dangaard Brouer	  info "Destination IP set to: DEST_IP=$DEST_IP"
40b64b0d1eSJesper Dangaard Brouer          ;;
41b64b0d1eSJesper Dangaard Brouer        m) # MAC
42b64b0d1eSJesper Dangaard Brouer          export DST_MAC=$OPTARG
43b64b0d1eSJesper Dangaard Brouer	  info "Destination MAC set to: DST_MAC=$DST_MAC"
44b64b0d1eSJesper Dangaard Brouer          ;;
456e32a74aSDaniel T. Lee        p) # PORT
466e32a74aSDaniel T. Lee          export DST_PORT=$OPTARG
476e32a74aSDaniel T. Lee	  info "Destination PORT set to: DST_PORT=$DST_PORT"
486e32a74aSDaniel T. Lee          ;;
49e0e16672STariq Toukan        f)
50e0e16672STariq Toukan	  export F_THREAD=$OPTARG
51e0e16672STariq Toukan	  info "Index of first thread (zero indexed CPU number): $F_THREAD"
52e0e16672STariq Toukan          ;;
53b64b0d1eSJesper Dangaard Brouer        t)
54b64b0d1eSJesper Dangaard Brouer	  export THREADS=$OPTARG
55e0e16672STariq Toukan	  info "Number of threads to start: $THREADS"
56b64b0d1eSJesper Dangaard Brouer          ;;
57b64b0d1eSJesper Dangaard Brouer        c)
58b64b0d1eSJesper Dangaard Brouer	  export CLONE_SKB=$OPTARG
59b64b0d1eSJesper Dangaard Brouer	  info "CLONE_SKB=$CLONE_SKB"
60b64b0d1eSJesper Dangaard Brouer          ;;
6169137ea6STariq Toukan        n)
6269137ea6STariq Toukan	  export COUNT=$OPTARG
6369137ea6STariq Toukan	  info "COUNT=$COUNT"
6469137ea6STariq Toukan          ;;
65b64b0d1eSJesper Dangaard Brouer        b)
66b64b0d1eSJesper Dangaard Brouer	  export BURST=$OPTARG
67b64b0d1eSJesper Dangaard Brouer	  info "SKB bursting: BURST=$BURST"
68b64b0d1eSJesper Dangaard Brouer          ;;
69b64b0d1eSJesper Dangaard Brouer        v)
70b64b0d1eSJesper Dangaard Brouer          export VERBOSE=yes
71b64b0d1eSJesper Dangaard Brouer          info "Verbose mode: VERBOSE=$VERBOSE"
72b64b0d1eSJesper Dangaard Brouer          ;;
73b64b0d1eSJesper Dangaard Brouer        x)
74b64b0d1eSJesper Dangaard Brouer          export DEBUG=yes
75b64b0d1eSJesper Dangaard Brouer          info "Debug mode: DEBUG=$DEBUG"
76b64b0d1eSJesper Dangaard Brouer          ;;
770f06a678SMartin KaFai Lau	6)
780f06a678SMartin KaFai Lau	  export IP6=6
790f06a678SMartin KaFai Lau	  info "IP6: IP6=$IP6"
800f06a678SMartin KaFai Lau	  ;;
81b64b0d1eSJesper Dangaard Brouer        h|?|*)
82b64b0d1eSJesper Dangaard Brouer          usage;
83b64b0d1eSJesper Dangaard Brouer          err 2 "[ERROR] Unknown parameters!!!"
84b64b0d1eSJesper Dangaard Brouer    esac
85b64b0d1eSJesper Dangaard Brouerdone
86b64b0d1eSJesper Dangaard Brouershift $(( $OPTIND - 1 ))
87b64b0d1eSJesper Dangaard Brouer
88b64b0d1eSJesper Dangaard Brouerif [ -z "$PKT_SIZE" ]; then
89b64b0d1eSJesper Dangaard Brouer    # NIC adds 4 bytes CRC
90b64b0d1eSJesper Dangaard Brouer    export PKT_SIZE=60
91b64b0d1eSJesper Dangaard Brouer    info "Default packet size set to: set to: $PKT_SIZE bytes"
92b64b0d1eSJesper Dangaard Brouerfi
93b64b0d1eSJesper Dangaard Brouer
94e0e16672STariq Toukanif [ -z "$F_THREAD" ]; then
95e0e16672STariq Toukan    # First thread (F_THREAD) reference the zero indexed CPU number
96e0e16672STariq Toukan    export F_THREAD=0
97e0e16672STariq Toukanfi
98e0e16672STariq Toukan
99b64b0d1eSJesper Dangaard Brouerif [ -z "$THREADS" ]; then
100b64b0d1eSJesper Dangaard Brouer    export THREADS=1
101b64b0d1eSJesper Dangaard Brouerfi
102b64b0d1eSJesper Dangaard Brouer
103e0e16672STariq Toukanexport L_THREAD=$(( THREADS + F_THREAD - 1 ))
104e0e16672STariq Toukan
105b64b0d1eSJesper Dangaard Brouerif [ -z "$DEV" ]; then
106b64b0d1eSJesper Dangaard Brouer    usage
107b64b0d1eSJesper Dangaard Brouer    err 2 "Please specify output device"
108b64b0d1eSJesper Dangaard Brouerfi
109b64b0d1eSJesper Dangaard Brouer
110b64b0d1eSJesper Dangaard Brouerif [ -z "$DST_MAC" ]; then
111b64b0d1eSJesper Dangaard Brouer    warn "Missing destination MAC address"
112b64b0d1eSJesper Dangaard Brouerfi
113b64b0d1eSJesper Dangaard Brouer
114b64b0d1eSJesper Dangaard Brouerif [ -z "$DEST_IP" ]; then
115b64b0d1eSJesper Dangaard Brouer    warn "Missing destination IP address"
116b64b0d1eSJesper Dangaard Brouerfi
117b64b0d1eSJesper Dangaard Brouer
118b64b0d1eSJesper Dangaard Brouerif [ ! -d /proc/net/pktgen ]; then
119b64b0d1eSJesper Dangaard Brouer    info "Loading kernel module: pktgen"
120b64b0d1eSJesper Dangaard Brouer    modprobe pktgen
121b64b0d1eSJesper Dangaard Brouerfi
122