2. Manager Command Line Arguments¶
The manager provides built-in help output for the command line arguments it
supports if you run firesim --help
usage: firesim [-h] [-c RUNTIMECONFIGFILE] [-b BUILDCONFIGFILE]
[-r BUILDRECIPESCONFIGFILE] [-a HWDBCONFIGFILE]
[-x OVERRIDECONFIGDATA] [-f TERMINATESOMEF116]
[-g TERMINATESOMEF12] [-i TERMINATESOMEF14]
[-m TERMINATESOMEM416] [-q]
{managerinit,buildafi,launchrunfarm,infrasetup,boot,kill,terminaterunfarm,runworkload,shareagfi,runcheck}
FireSim Simulation Manager.
positional arguments:
{managerinit,buildafi,launchrunfarm,infrasetup,boot,kill,terminaterunfarm,runworkload,shareagfi,runcheck}
Management task to run.
optional arguments:
-h, --help show this help message and exit
-c RUNTIMECONFIGFILE, --runtimeconfigfile RUNTIMECONFIGFILE
Optional custom runtime/workload config file. Defaults
to config_runtime.ini.
-b BUILDCONFIGFILE, --buildconfigfile BUILDCONFIGFILE
Optional custom build config file. Defaults to
config_build.ini.
-r BUILDRECIPESCONFIGFILE, --buildrecipesconfigfile BUILDRECIPESCONFIGFILE
Optional custom build recipe config file. Defaults to
config_build_recipes.ini.
-a HWDBCONFIGFILE, --hwdbconfigfile HWDBCONFIGFILE
Optional custom HW database config file. Defaults to
config_hwdb.ini.
-x OVERRIDECONFIGDATA, --overrideconfigdata OVERRIDECONFIGDATA
Override a single value from one of the the RUNTIME
e.g.: --overrideconfigdata "targetconfig linklatency
6405".
-f TERMINATESOMEF116, --terminatesomef116 TERMINATESOMEF116
Only used by terminatesome. Terminates this many of
the previously launched f1.16xlarges.
-g TERMINATESOMEF12, --terminatesomef12 TERMINATESOMEF12
Only used by terminatesome. Terminates this many of
the previously launched f1.2xlarges.
-i TERMINATESOMEF14, --terminatesomef14 TERMINATESOMEF14
Only used by terminatesome. Terminates this many of
the previously launched f1.4xlarges.
-m TERMINATESOMEM416, --terminatesomem416 TERMINATESOMEM416
Only used by terminatesome. Terminates this many of
the previously launched m4.16xlarges.
-q, --forceterminate For terminaterunfarm, force termination without
prompting user for confirmation. Defaults to False
On this page, we will go through some of these options – others are more complicated, so we will give them their own section on the following pages.
2.1. --runtimeconfigfile
FILENAME
¶
This lets you specify a custom runtime config file. By default, config_runtime.ini
is used. See config_runtime.ini for what this config file does.
2.2. --buildconfigfile
FILENAME
¶
This lets you specify a custom build config file. By default, config_build.ini
is used. See config_build.ini for what this config file does.
2.3. --buildrecipesconfigfile
FILENAME
¶
This lets you specify a custom build recipes config file. By default,
config_build_recipes.ini
is used. See config_build_recipes.ini for what
this config file does.
2.4. --hwdbconfigfile
FILENAME
¶
This lets you specify a custom hardware database config file. By default,
config_hwdb.ini
is used. See config_hwdb.ini for what this config file does.
2.5. --overrideconfigdata
SECTION
PARAMETER
VALUE
¶
This lets you override a single value from the runtime config file. For
example, if you want to use a link latency of 3003 cycles for a particular run
(and your config_runtime.ini
file specifies differently), you can pass
--overrideconfigdata targetconfig linklatency 6405
to the manager. This
can be used with any task that uses the runtime config.
2.6. --launchtime
TIMESTAMP
¶
Specifies the “Y-m-d–H-M-S” timestamp to be used as the prefix in results-build directories. Useful when wanting to run tar2afi after an aborted buildafi was manually fixed.
2.7. TASK
¶
This is the only required/positional command line argument to the manager. It tells the manager what it should be doing. See the next section for a list of tasks and what they do. Some tasks also take other command line arguments, which are specified with those tasks.