Debian Codegraph @

batchfiles/batchfile.example

raw
1 # -*- mode:conf -*-
2
3 # The batch file is parsed as an ini file, and can have three types of sections:
4 # commands, batches and args. Each section also has a name. Type and name are
5 # separated with two colons.
6 #
7 # Sections of the same type can inherit from each other. Args are used for the
8 # loop facility (explained below). All variables are recursively substituted by
9 # using the${varname} syntax. These three operations are resolved in this order
10 # (inheritance, arg interpolation and variable substitution).
11
12
13
14 # These are commands to be executed before or after each test run. Any number of
15 # commands can be specified; which ones are run (and the order) is specified
16 # below in the batch sections.
17 #
18 # The part after the :: is the name of the command, which is used to refer to
19 # the command in the batch sections below, and so should be unique for each
20 # command.
21 [Command::setup_qdisc]
22 # Any command. Subject to variable substitution - in this case ${filename} is
23 # the filename Flent will generate for the test being run (sans the extension).
24 exec = ./setup_qdisc.sh ${qdisc}
25 # type can be pre, post or monitor
26 type = pre
27
28 # An essential pre command will cause the test to be aborted if it fails
29 # (returncode non-zero)
30 essential = yes
31
32
33 # A 'batch' is a named test to be run. It can specify normal Flent parameters as
34 # well as any other variables that can be used for substitution. When executing
35 # Flent in batch mode, -B specifies the batch file (this file), while -b
36 # specified which batch to run. The special argument ALL to -b will run all
37 # defined batches that are not set as inactive.
38 #
39 # Batches can inherit from each other, so it can be a good idea to have a
40 # 'global' batch that sets most parameters, and then override things in
41 # sub-batches.
42 [Batch::global]
43 # These are all Flent parameters that correspond to command line options.
44 extended_metadata = yes
45 debug_error = yes
46 debug_log = yes
47 title = ${batch_title} qdisc:${qdisc} ecn:${ecn} rep:${repetition}
48 output_path = batch-${batch_time}-${batch_title}/${batch_name}
49 ip_version = 4
50 length = 30
51 hosts = test-target-host
52
53 # This is a special variable that specifies things to *append* to the filename
54 # Flent generates (based on time etc). The first part of the filename will be
55 # the same for every test in a batch, so the idea is to use this variable to
56 # disambiguate subsequent test runs (so putting 'repetition' in there is
57 # generally a good idea).
58 #
59 # The 'repetition' variable is another special variable that will get assigned
60 # the current repetition for each run.
61 filename_extra = ${qdisc}-${repetition}
62
63 # These are the commands to run; must be specified as command type sections
64 # (i.e. this one corresponds to [Command::setup_qdisc] above).
65 commands = setup_qdisc
66
67 # This is a special variable that causes the test in the batch to be repeated
68 # this many times (setting the ${repetition} variable for each).
69 repetitions = 1
70
71 # Special variable - how long to pause after each test run before proceeding to
72 # the next one.
73 pause = 5
74
75 # Special variable. A batch can be disabled in two ways: Setting 'disabled=yes'
76 # which does what one would expect, and by setting 'abstract=yes'. The
77 # difference is that when another batch inherits from this one, the value of
78 # 'disabled' is inherited, while the value of 'abstract' isn't.
79 abstract = yes
80
81 # These are variables that are used for variable expansion in settings above.
82 # The idea is that other batches can override these to change part of the
83 # configuration.
84 batch_title = untitled
85 # not used
86 ecn = noecn
87
88 # This is the loop mechanism of the batch facility. Each variable that starts
89 # with for_ defines a loop (Flent doesn't care about the part after for_, but
90 # they matter when inheriting). The batch will then be repeated for each of the
91 # values of this variable. Each value must be defined in the batch file as a
92 # heading of type [Arg::name]. The variables in each [Arg] section will then be
93 # applied on top of the batch containing the loop before the test run
94 # corresponding to that arg.
95 #
96 # When multiple for_ statements are present, the cross product of all of them
97 # will be run. Likewise with repetitions (each arg will be repeated as many
98 # times as specified).
99 #
100 # The example here is used to repeat each test run with different qdiscs.
101 for_qdisc = pfifo_fast, codel, fq_codel
102
103 # Other examples:
104 #for_ecn = ecn, noecn
105 #for_delay = 10ms, 100ms
106
107
108 # These are the actual batches that will be run. Each of them just inherits from
109 # 'global' and overrides some variables.
110 [Batch::tcp-upload]
111 inherits = global
112 test_name = tcp_1up_noping
113 disabled = no
114
115 [Batch::rrul]
116 inherits = global
117 test_name = rrul
118 disabled = no
119
120
121 # These are the args used for loops in the batches specified above. The arg name
122 # (the part after ::) is what is put into the for_ variables. Args can inherit
123 # from each other just like batches (but none of these do). In that case, arg
124 # inheritance is performed before the values are interpolated onto the batch.
125 #
126 # These args all just set a single variable (which is then used in the commands
127 # defined at the top of the file).
128
129 [Arg::pfifo_fast]
130 qdisc = pfifo_fast
131
132 [Arg::codel]
133 qdisc = codel
134
135 [Arg::fq_codel]
136 qdisc = fq_codel
137
138 [Arg::ecn]
139 ecn = ecn
140
141 [Arg::noecn]
142 ecn = noecn
143
144 [Arg::10ms]
145 base_delay = 5ms
146
147 [Arg::100ms]
148 base_delay = 50ms