This work partially funded by NASA GSRP (NGT 5-50165) and does not represent the position or opinions of the United States Government

---

Requirements

The IDB Automated Instrumentation Tool makes use of the Motif library. It is also compatible with Lesstif and OpenMotif.

Installation

The IDB Automated Instrumentation Tool uses the GNU autoconf package to automatically configure itself according to your system. This allows for an easy install on most UNIX systems. For a normal installation, simply run the following commands in the probelib directory:

./configure
make
make install

Several arguments can be passed to the configure script to customize behavior:

--prefix=PREFIX

By default, the prefix is /usr/local and IDB installs the probe library at /usr/local/lib and the headers at /usr/local/include. You may specify a different prefix if so desired.

--with-debug

Enable compilation of debugging symbols

--with-gcc

Use GCC instead of the default system compiler

--with-motif-includes=DIR

If the configure script is unable to find your Motif installation, you may specify the path of the Motif include files here.

--with-motif-libraries=DIR

If the configure script is unable to find your Motif installation, you may specify the path of the Motif library files here.

Usage

Files Selection Window

The File Selection Window is displayed when the Automated Instrumentation Tool is started. The user can select files to be instrumented in this window. Enter a base directory in the directory entry box or use the browse feature to select one. The Automated Instrumentation Tool will created an instrumented/ directory within the base directory and place annotated files there. Files to be instrumented must be within the base directory. Multiple base directories may be selected by clicking the Add button instead of the Change button.

Once the base directories are added, the individual files to be instrumented can be selected. Left click on a directory to open or close it, and left click on a file to select or de-select it. Right clicking on a file will allow you to view additional information about the file, and right clicking on a directory will enable functions such as selecting all files within a directory.

When all the files to be instrumented are selected, the Next button may be used to begin parsing the selected files. In addition, the save function in the file menu may be used at any time to save your current work as an EDF file. The load function may also be used to load a previously saved EDF file.

Parsing Status Window

The Parsing Status Window is displayed while the program is parsing the selected files. It shows what files is being parsed and whether the file had any parsing errors. If no errors are present, the window will close automatically. If there were errors, you will be able to see which files the errors were in. Details about the errors are printed on standard output.

Instrumentation Selection Window

Once parsing is done, the user can select portions of the source code to be instrumented. The interface presented allows you to select critical events such as functions, loops or function calls to be instrumented. To select a function to be instrumented, left click on the function name. To highlight a function without selecting it for instrumentation, right click on it. The list of loops and function calls within a function will only appear when a function is highlighted. The source code of the function will appear in the file source view window as well. To view the context around the function, select the Entire File option instead of Function Only.

Similarly, loops and function calls can be selected or highlighted. When they are highlighted, the corresponding code in the source view will be highlighted as well. Additionally, a loop instrumentation can be specified to be inside or outside the loop. An instrumentation inside the loop will be probed once per iteration, while an instrumentation outside the loop will be probed only once per invocation. Click on the corresponding button on top of the loop window while a loop is highlighted to select inside or outside instrumentation.

An additional hardware instrumentation window allows the user to easily specify hardware instrumentation options. First, change the preset pulldown list to match the architecture where the instrumentation will be ran on. This will limit the list of hardware counters to only those supported by the architecture. Free can be chosen if you wish all known hardware counters to be displayed.

If a large number of functions are present, it may take some time to find a function in the list. To simplify the task, the Find and Goto feature are available. The Find feature searches for a string within the list of functions, and the Goto feature allows you to select a function by its file and a line number.

Finally...

When all the functions are selected, hit next to begin annotating the source files. The final display shows you the location of the original and annotated files. Hit exit to quit the program.

See Also

IDB Probe Library