S2sinstrument: Difference between revisions
No edit summary |
|||
Line 2: | Line 2: | ||
== The STRIDE Instrumentation Utility == | == The STRIDE Instrumentation Utility == | ||
The '''s2sinstrument | The '''s2sinstrument''' executable generates instrumentation code, also known as IM, or intercept module code. It is a command line utility that accepts the following input: | ||
* database (.sidb) file | * database (.sidb) file | ||
* intercept module name | * intercept module name | ||
Line 14: | Line 14: | ||
=== Syntax === | === Syntax === | ||
s2sinstrument [<i>options</i>] <i>database_file</i> | <pre>s2sinstrument [<i>options</i>] <i>database_file</i></pre> | ||
=== Options === | === Options === |
Revision as of 18:22, 1 October 2008
The STRIDE Instrumentation Utility
The s2sinstrument executable generates instrumentation code, also known as IM, or intercept module code. It is a command line utility that accepts the following input:
- database (.sidb) file
- intercept module name
- C/C++ code files, output location and C header files output location
- a set of configuration options
The resulting output files will be generated:
- a prototype header file <im_name>IM.h
- implementation files <im_name>IM.c(pp) and <im_name>IMEmtry.h
- a read-me file <im_name>IMReadMe.txt.
Syntax
s2sinstrument [<i>options</i>] <i>database_file</i>
Options
Option | Description |
---|---|
--im_name=<string> | The intercept module name. The default is the base name of the databaseFile. |
--im_suffix=<string> | The intercept module file name suffix. The default is "IM". |
--code_output=<path> | The location of the generated C or C++ files. The default is the current directory. |
--header_output=<path> | The location of the generated header files and text (read me) file. The default is the current directory. |
--strip_path | When present, the path information from include directives will be striped. |
--disable_access_class | When present, all interface SUIDs will be explicitly registered instead of using access class registration. |
--suppress_exception_handling | When present, C++ exceptions would not be handled as errors. |
--prototype=<tag> | Generate only prototype header files. <tag> is a unique tag that would be appended to the prototype header file name. |
--implement | Generate only implementation files. |
--default_mode=<mode>[#<group_id>] | Optional. When present, sets the default generation mode. If not present the <mode> is assumed to be "S" and <group_id> empty.
The format of the <mode> is "SP[Doued]", where:
The <group_id> is the delegate group id. Example: Dynamic delegate generation for the group_id MEM_ROUTINES --default_mode=Dd#MEM_ROUTINES |
--mode=<mode>[#<group_id>] (<interface>[,<interface>…]) | Interface specific generation mode. The <mode> and <group_id> are the same as above. The <interface> is an interface name. This option could be repeated as many times as needed. It overrides any --default_mode option otherwise in effect. Example: Generate proxy for functions f1 and f2 --mode=P(f1,f2) |
--options_file=<file> | A file that contains command line options. The format is the same as the command line with the only addition that it could be split on multiple lines. A line starting with "#" symbol is ignored.
This option is necessary if the length of the command line string exceeds system limits. Otherwise it is provided only as a convenience. |
Examples
Refer to the Intercept Module Generation section of the Build Tools Examples.