| 1 |
# -*- mode:conf -*- |
| 2 |
|
| 3 |
# This is a fully functional example of a batch fild. It was used to perform the |
| 4 |
# experiments in the paper describing Flent. The paper is called simply "Flent: |
| 5 |
# The FLExible Network Tester". See https://www.cs.kau.se/tohojo/flent/ and |
| 6 |
# http://urn.kb.se/resolve?urn=urn%3Anbn%3Ase%3Akau%3Adiva-64766 |
| 7 |
# |
| 8 |
# The batch file is parsed as an ini file, and can have three types of sections: |
| 9 |
# commands, batches and args. Each section also has a name. Type and name are |
| 10 |
# separated with two colons. |
| 11 |
# |
| 12 |
# Sections of the same type can inherit from each other. Args are used for the |
| 13 |
# loop facility (explained below). All variables are recursively substituted by |
| 14 |
# using the ${varname} syntax. These three operations are resolved in this order |
| 15 |
# (inheritance, arg interpolation and variable substitution). |
| 16 |
|
| 17 |
|
| 18 |
# Setup command to be run before each test run. The script is simply: |
| 19 |
### Start script setup_qdisc.sh |
| 20 |
# #!/bin/sh |
| 21 |
# |
| 22 |
# set -o errexit |
| 23 |
# set -o nounset |
| 24 |
# |
| 25 |
# IFACE=enp5s0 |
| 26 |
# QDISC=$1 |
| 27 |
# sudo ethtool -K $IFACE gso off tso off gro off |
| 28 |
# sudo sysctl -w net.ipv4.tcp_no_metrics_save=1 |
| 29 |
# sudo tc qdisc replace dev $IFACE root $QDISC |
| 30 |
### End script setup_qdisc.sh |
| 31 |
# |
| 32 |
# The user running Flent must have sufficient permissions to run the sudo |
| 33 |
# commands specified, and the IFACE needs to be adjusted to match the system. |
| 34 |
|
| 35 |
[Command::setup_qdisc] |
| 36 |
exec = ./setup_qdisc.sh ${qdisc} |
| 37 |
type = pre |
| 38 |
|
| 39 |
# An essential pre command will cause the test to be aborted if it fails |
| 40 |
# (returncode non-zero) |
| 41 |
essential = yes |
| 42 |
|
| 43 |
|
| 44 |
# A 'batch' is a named test to be run. It can specify normal Flent parameters as |
| 45 |
# well as any other variables that can be used for substitution. When executing |
| 46 |
# Flent in batch mode, -B specifies the batch file (this file), while -b |
| 47 |
# specified which batch to run. The special argument ALL to -b will run all |
| 48 |
# defined batches that are not set as inactive. |
| 49 |
# |
| 50 |
# Batches can inherit from each other, so it can be a good idea to have a |
| 51 |
# 'global' batch that sets most parameters, and then override things in |
| 52 |
# sub-batches. |
| 53 |
[Batch::global] |
| 54 |
# These are all Flent parameters that correspond to command line options. |
| 55 |
extended_metadata = yes |
| 56 |
socket_stats = yes |
| 57 |
debug_error = yes |
| 58 |
debug_log = yes |
| 59 |
title = ${batch_title} qdisc:${qdisc} cc:${cc} rep:${repetition} |
| 60 |
output_path = batch-${batch_time}-${batch_title}/${batch_name} |
| 61 |
ip_version = 4 |
| 62 |
length = 140 |
| 63 |
hosts = netperf-eu.bufferbloat.net |
| 64 |
test_parameters= tcp_cong_control=${cc}; |
| 65 |
|
| 66 |
# This is a special variable that specifies things to *append* to the filename |
| 67 |
# Flent generates (based on time etc). The first part of the filename will be |
| 68 |
# the same for every test in a batch, so the idea is to use this variable to |
| 69 |
# disambiguate subsequent test runs (so putting 'repetition' in there is |
| 70 |
# generally a good idea). |
| 71 |
# |
| 72 |
# The 'repetition' variable is another special variable that will get assigned |
| 73 |
# the current repetition for each run. |
| 74 |
filename_extra = ${qdisc}-${cc}-${repetition} |
| 75 |
|
| 76 |
# These are the commands to run; must be specified as command type sections |
| 77 |
# (i.e. this one corresponds to [Command::setup_qdisc] above). |
| 78 |
commands = setup_qdisc |
| 79 |
|
| 80 |
# This is a special variable that causes the test in the batch to be repeated |
| 81 |
# this many times (setting the ${repetition} variable for each). |
| 82 |
repetitions = 1 |
| 83 |
|
| 84 |
# Special variable - how long to pause after each test run before proceeding to |
| 85 |
# the next one. |
| 86 |
pause = 5 |
| 87 |
|
| 88 |
# Special variable. A batch can be disabled in two ways: Setting 'disabled=yes' |
| 89 |
# which does what one would expect, and by setting 'abstract=yes'. The |
| 90 |
# difference is that when another batch inherits from this one, the value of |
| 91 |
# 'disabled' is inherited, while the value of 'abstract' isn't. |
| 92 |
abstract = yes |
| 93 |
|
| 94 |
# These are variables that are used for variable expansion in settings above. |
| 95 |
# The idea is that other batches can override these to change part of the |
| 96 |
# configuration. |
| 97 |
batch_title = untitled |
| 98 |
qdisc = fq |
| 99 |
|
| 100 |
# This is the loop mechanism of the batch facility. Each variable that starts |
| 101 |
# with for_ defines a loop (Flent doesn't care about the part after for_, but |
| 102 |
# they matter when inheriting). The batch will then be repeated for each of the |
| 103 |
# values of this variable. Each value must be defined in the batch file as a |
| 104 |
# heading of type [Arg::name]. The variables in each [Arg] section will then be |
| 105 |
# applied on top of the batch containing the loop before the test run |
| 106 |
# corresponding to that arg. |
| 107 |
# |
| 108 |
# When multiple for_ statements are present, the cross product of all of them |
| 109 |
# will be run. Likewise with repetitions (each arg will be repeated as many |
| 110 |
# times as specified). |
| 111 |
# |
| 112 |
# The example here is used to repeat each test run with different congestion |
| 113 |
# control algorithms. |
| 114 |
for_cc = cubic, cubic_nopacing, bbr |
| 115 |
|
| 116 |
|
| 117 |
# These are the actual batches that will be run. Each of them just inherits from |
| 118 |
# 'global' and overrides some variables. |
| 119 |
[Batch::tcp-upload] |
| 120 |
inherits = global |
| 121 |
test_name = tcp_1up_noping |
| 122 |
disabled = no |
| 123 |
|
| 124 |
[Batch::rrul] |
| 125 |
inherits = global |
| 126 |
test_name = rrul |
| 127 |
disabled = no |
| 128 |
|
| 129 |
|
| 130 |
# These are the args used for loops in the batches specified above. The arg name |
| 131 |
# (the part after ::) is what is put into the for_ variables. Args can inherit |
| 132 |
# from each other just like batches (but none of these do). In that case, arg |
| 133 |
# inheritance is performed before the values are interpolated onto the batch. |
| 134 |
# |
| 135 |
# These args all just set a single variable (which is then used in the commands |
| 136 |
# defined at the top of the file). |
| 137 |
|
| 138 |
[Arg::cubic_nopacing] |
| 139 |
cc = cubic |
| 140 |
# The fq_codel qdisc doesn't do pacing for CUBIC |
| 141 |
qdisc = fq_codel |
| 142 |
# This host does not run sch_fq either |
| 143 |
hosts = vlan820-28.cs.kau.se |
| 144 |
|
| 145 |
[Arg::cubic] |
| 146 |
cc = cubic |
| 147 |
|
| 148 |
[Arg::bbr] |
| 149 |
cc = bbr |
| 150 |
|