OVATION Installation Manual

---

1. Platform Specifications
   • Required Software
2. Environment Configuration
3. OVATION on Windows
   • Building ACE and TAO
   • Building the Visualizer
   • Building the Probe Framework
   • Testing OVATION on Windows
4. OVATION on Linux
   • Building ACE and TAO
   • Building the Visualizer
   • Building the Probe Framework
   • Testing OVATION on Linux

---

Platform Specifications

OVATION has been compiled and tested on Linux (RedHat 7.2, GNU g++ v2.95.3 compiler) and Windows (XP, Microsoft Visual C++ v6).

Required Software

The following software is need to compile the OVATION Probe Framework and Visualizer. 

Environment Configuration

This section discusses how to set up your environment to run OVATION. Unless stated otherwise, this discussion applies to both Linux and Windows. When referring to environment variables the Unix notation $ENV_VAR is used. For Windows this should be replaced with %ENV_VAR%. NOTE: We utilize the UNIX notation $ENV_VAR, even when referring to building and testing OVATION on Windows.

In addition, to these environment variables, the $PATH environment variable should be modified to include $JAVA_HOME/bin, $ANT_HOME/bin, $ACE_ROOT/bin, $OVATION_ROOT/bin,

The $LD_LIBRARY_PATH needs to be modified to include $ACE_ROOT/ace (for Linux only).

OVATION on Windows

Building ACE and TAO on Windows

In order to build and use ACE, the file $ACE_ROOT/ace/config.h needs to be created in order to be build on Windows. Below is a sample config.h used to build OVATION on Windows XP.

#ifndef ACE_CONFIG_H
#define ACE_CONFIG_H

#define ACE_DISABLE_WIN32_ERROR_WINDOWS 1
#define ACE_HAS_STANDARD_CPP_LIBRARY 1
#define FD_SETSIZE 4096

#include "ace/config-win32.h"

#if ! defined(ACE_DEFAULT_BACKLOG)
#define ACE_DEFAULT_BACKLOG 200
#endif

#endif

Compiling ACE and TAO on Windows

The required parts of ACE and TAO can be build by opening $ACE_ROOT/TAO/TAOACE.dsw and building the project Naming_Service. It is not necessary to explicitly build the Naming Service dependencies as Visual C++ will automatically do this for you.

Building the Visualizer on Windows

Once the support software installations and environment variable setup are complete, the OVATION Visualization (Java) components should be built. The $OVATION_ROOT directory contains a platform independent build script that can be executed from the command line using the ant program as follows:

As a result of a successful build, a file called ovation.jar should be found in the $OVATION_ROOT/lib directory. This file will be used both by the OVATION Collector and the OVATION Visualizer.

Building the ddb-convert.jar File

A utility has been provided to convert the older Distributed Debugger (DDB) log files into OVATION XML log files. This utility can be run from the command line once the ddb-convert.jar file has be built from the OVATION Java source code. To build this jar file, use the ant build task all.ddb as follows:

$OVATION_ROOT>ant all.ddb

Buildfile: build.xml

prepare:

    [mkdir] Created dir: C:\oci\ova\classes

    [mkdir] Created dir: C:\oci\ova\src\java\idl_output

    [mkdir] Created dir: C:\oci\ova\javadocs

    [mkdir] Created dir: C:\oci\ova\report

all.ddb:

    [mkdir] Created dir: C:\oci\ova\classes\ddb

    [javac] Compiling 73 source files to C:\oci\ova\classes\ddb

      [jar] Building jar: C:\oci\ova\lib\ddb-convert.jar

BUILD SUCCESSFUL

Total time: 6 seconds

As a result of a successful build, a file called ddb-convert.jar should be found in the $OVATION_ROOT/lib directory. be found in the This file will be used to convert DDB log files into OVATION XML log files. The $OVATION_ROOT/bin directory contains a script called convertLog (available as a Windows batch file) that will execute the conversion tool.

Post Installation Required Supporting Software

The GraphViz drawing toolkit is needed by the OVATION Visualizer to depict Event Channel data captured by the OVATION RTEC Probe. GraphViz can run on Microsoft Windows platforms (one of the two platforms currently supported by OVATION), and can be downloaded at the GraphViz website: http://www.research.att.com/sw/tools/graphviz/download.html . The website contains instructions for installing GraphViz on Windows platforms.

Building the Probe Framework and Probes on Windows

The Probe Framework and the Probes depend on ACE and TAO which must be installed prior to building OVATION. If using another ORB, the underlying ORB should be built and linked in correctly.

The required parts of the Probe Framework can be build with the $OVATION_ROOT/OVATION.dsw. The workspace has two project files for each of the probes, one for the DLL and another for the static build. It also has two projects for OVATION Probeframework, ovation and for the static build. The individual probes can be built as needed for the application. The probes are all dependent on ovation project file. At the end of a successful build, the DLLs are copied to $OVATION_ROOT/bin and the libraries are copied to $OVATION_ROOT/lib.

Testing OVATION on Windows

OVATION provides several examples and tests to show and to test. The examples are in $OVATION_ROOT/examples directory. An Examples.dsw workspace is present in this directory. As a first step for testing, the project files in this workspace are to be built. There is a README in the same directory which describes each one of the examples. There are READMEs in the individual directories which give instructions on running them.

OVATION on Linux

Building ACE and TAO for Linux

Building ACE and TAO on Linux requires two files, the platform_macros.GNU (in $ACE_ROOT/include/makeinclude) and config.h (in $ACE_ROOT/ace). 

#Example config.h for Linux build of ACE/TAO
#include <ace/config-linux.h>
#define ACE_NDEBUG 1
#define ACE_NTRACE 1


# Example platform_macros.GNU for Linux build of ACE/TAO
exceptions=1
inline=1
ami=1
rt_corba=1
smart_proxies=1
interceptors=1
interface_repo=1
corba_messaging=1
probe=0
profile=0
fakesvcconf=0
shared_libs_only=1
debug=1
optimize=0
include $(ACE_ROOT)/include/makeinclude/platform_linux.GNU


Before building ACE and TAO, make sure the relevent environment variables are defined ($ACE_ROOT and $TAO_ROOT). The required parts of ACE and TAO can be build by running GNU Make (gmake) in the following directories relative to $ACE_ROOT, in the order given:

• ace
• ACEXML
• apps/gperf/src
• TAO/TAO_IDL
• TAO/tao
• TAO/orbsvcs/orbsvcs
• TAO/orbsvcs/Naming_Service
• TAO/utils/nslist

Alternatively, you can run GNU Make from the $ACE_ROOT directory and the $TAO_ROOT directories. This will also compile additional code such as test example code.

Building the Visualizer on Linux

Build Execution

With the support software installations and environment variable setup complete, the OVATION Java components can now be built. The $OVATION_ROOT directory contains a platform independent build script that can be executed from the command line using the 'ant' command as follows:
As a result of a successful build, a file called ovation.jar should be found in the <OVATION_ROOT>/lib directory. This file will be used both by the OVATION Collector and the OVATION Visualizer.

Building the ddb-convert.jar File

A utility has been provided to convert the older Distributed Debugger (DDB) log files into OVATION XML log files. This utility can be run from the command line once the ddb-convert.jar file has be built from the OVATION Java source code. To build this jar file, use the ant build task all.ddb as follows:

$OVATION_ROOT>ant all.ddb

Buildfile: build.xml

prepare:

    [mkdir] Created dir: C:\oci\ova\classes

    [mkdir] Created dir: C:\oci\ova\src\java\idl_output

    [mkdir] Created dir: C:\oci\ova\javadocs

    [mkdir] Created dir: C:\oci\ova\report

all.ddb:

    [mkdir] Created dir: C:\oci\ova\classes\ddb

    [javac] Compiling 73 source files to C:\oci\ova\classes\ddb

      [jar] Building jar: C:\oci\ova\lib\ddb-convert.jar

BUILD SUCCESSFUL

Total time: 6 seconds

As a result of a successful build, a file called ddb-convert.jar should be found in the $OVATION_ROOT/lib directory. be found in the This file will be used to convert DDB log files into OVATION XML log files. The $OVATION_ROOT/bin directory contains a script called convertLog (available as a Windows batch file) that will execute the conversion tool.

Post Installation Required Supporting Software

The GraphViz drawing toolkit is needed by the OVATION Visualizer to depict Event Channel data captured by the OVATION RTEC Probe. GraphViz can run on Linux platforms (one of the two platforms currently supported by OVATION), and can be downloaded at the GraphViz website: http://www.research.att.com/sw/tools/graphviz/download.html . The website contains instructions for installing GraphViz Linux platforms.

Building the Probe Framework and Probes on Linux

OVATION comes with a top level makefile in $OVATION_ROOT. This makefile builds the Probe Framework and all the Probes that are supplied by default. Individual makefiles are provided in the respective directories. The Probe Framework's makefile is in $OVATION_ROOT/src/cplusplus/probefwk and the makefiles for the probes are in the individual directories below $OVATION_ROOT/src/cplusplus/probes. Each of them can be built individually, if needed. The libraries are copied to $OVATION_ROOT/lib on successful build. 

Testing OVATION on Linux

The top level makefile in $OVATION_ROOT also builds the examples. Again, there are individual makefiles for the examples in the directories below $OVATION_ROOT/examples. The READMEs in the directories describe the steps for running the examples and tests.