Difference between revisions of "Running gem5"

From gem5
Jump to: navigation, search
(Clean up)
(Move stuff more specific to scripting to that page)
Line 1: Line 1:
M5 uses script files to specify simulated system configurations and simulation options. Running M5 is as simple as giving the name of a script file (ending in '.py') as a command-line argument.
 
 
The script file documentation page ([[Configuration Files Explained]]) has details on script file format and interpretation. The easiest way to get started is to use an existing script file. Several examples are provided in the src/configs directory.
 
 
 
The m5 command line has two parts: (1) the simulator section which includes the simulator executable and its options, and (2) the script section, which includes the script file and its options.  The usage is:
 
The m5 command line has two parts: (1) the simulator section which includes the simulator executable and its options, and (2) the script section, which includes the script file and its options.  The usage is:
  
 
<pre>
 
<pre>
% build/ALPHA_SE/m5.debug [m5 options] script.py [script options]
+
% m5 [m5 options] <script.py> [script options]
 
</pre>
 
</pre>
  
The build/ALPHA_SE/m5.debug part is the m5 executabe, and the [m5 options] part are all of the options that the simulator itself understands.  Running m5 with the "-h" flag prints a help messag that includes all of the supported simulator options. Here's a snippet:
+
The m5 executable is any of the version you may have built (See [[Compiling M5]]) such as ALPHA_SE/m5.debug, and the [m5 options] part are all of the options that the simulator itself understands.  Running m5 with the "-h" flag prints a help messag that includes all of the supported simulator options. Here's a snippet:
  
 
<pre>
 
<pre>
Line 40: Line 36:
 
</pre>
 
</pre>
  
The script section of the command line begins with a path to your script file. M5 runs the script in almost exactly the same way python itself would run your script directly (e.g. "python myscript.py [ myscript options ]".  The key difference being that m5 executable provides the m5 package and some debugging hooks.  This means that you can pass your script options on the command line just like a normal script wouldMore details can be found in the [[Configuration Files Explained#Options|Options]] section.
+
The script section of the command line begins with a path to your script file and includes any options that you'd like to pass to that script. Since M5 runs the script in a way similar to python itself (i.e. it's similar to running "python myscript.py [ options ]"), you can pass your script options on the command line to make your script flexibleThe script file documentation page ([[Configuration Files Explained]]) has details on how to write scripts for M5, and the [[Configuration Files Explained#Options|Options]] section of that page gives a bit of detail on how your scripts can have their own options.

Revision as of 21:39, 19 August 2006

The m5 command line has two parts: (1) the simulator section which includes the simulator executable and its options, and (2) the script section, which includes the script file and its options. The usage is:

% m5 [m5 options] <script.py> [script options]

The m5 executable is any of the version you may have built (See Compiling M5) such as ALPHA_SE/m5.debug, and the [m5 options] part are all of the options that the simulator itself understands. Running m5 with the "-h" flag prints a help messag that includes all of the supported simulator options. Here's a snippet:

% build/ALPHA_SE/m5.debug -h
Usage
=====
  m5.debug [m5 options] script.py [script options]

 Copyright (c) 2001-2006 The Regents of The University of Michigan All Rights
Reserved

options
=======
--version               show program's version number and exit
--help, -h              show this help message and exit
--authors, -A           Show author information
--copyright, -C         Show full copyright information
--readme, -R            Show the readme
--release-notes, -N     Show the release notes
--outdir=DIR, -d DIR    Set the output directory to DIR [Default: .]
--interactive, -i       Invoke the interactive interpreter after running the
                        script
--pdb                   Invoke the python debugger before running the script
--path=PATH[:PATH], -p PATH[:PATH]
                        Prepend PATH to the system path when invoking the
                        script
--quiet, -q             Reduce verbosity
--verbose, -v           Increase verbosity
...

The script section of the command line begins with a path to your script file and includes any options that you'd like to pass to that script. Since M5 runs the script in a way similar to python itself (i.e. it's similar to running "python myscript.py [ options ]"), you can pass your script options on the command line to make your script flexible. The script file documentation page (Configuration Files Explained) has details on how to write scripts for M5, and the Options section of that page gives a bit of detail on how your scripts can have their own options.