Skip to content

Latest commit

 

History

History
199 lines (143 loc) · 7.51 KB

dependencies.md

File metadata and controls

199 lines (143 loc) · 7.51 KB
Raw

OpenDDS Dependencies

Table of Contents:

Required to Build the Core OpenDDS Libraries

NOTE: Perl is required to run the configure script; MPC, ACE, and TAO will be downloaded automatically by the configure script by default.

Perl

Perl is an interpreted language used in the configure script, the tests, and most other scripting in OpenDDS codebase. Even if the configure script is not used, it is also required to run MPC, so it is required to build OpenDDS.

Testing scripts are written in Perl and use the common PerlACE modules provided by ACE. For scripts that will be part of automated testing, don't assume the presence of any non-standard (CPAN) modules. Perl offers many facilities for portability. Shell scripts are by definition non-portable and should not to be committed to the OpenDDS repository.

Perl core modules are a required part of Perl. Some Linux distributions install the Perl interpreter without including core modules. Using OpenDDS with this sort of partial Perl installation may fail unexpectedly when using configure, MPC, "make depend", or test scripts.

MPC

MPC is the build system used by OpenDDS, used to configure the build and generate platform specific build files (Makefiles, VS solution files, etc.).

The official repository is hosted on Github at DOCGroup/MPC.

ACE

ACE is the platform abstraction layer used by OpenDDS. It is used both directly and through TAO. Facilities not provided by the C++ 2003 standard library, for example sockets, threads, and dynamic library loading, are provided by ACE.

Some other features OpenDDS relies on ACE for:

  • ACE provides the gnuace type used by MPC for generating Makefiles for OpenDDS
  • ACE contains a script, generate_export_file.pl, which is used (along with MPC) to manage shared libraries' symbol visibility (also known as export/import)
    • See ACE documentation and usage guidelines for details
  • ACE logging is used (ACE_Log_Msg and related classes).
    • This is used through the ACE_DEBUG and ACE_ERROR macros.
    • ACE logging uses a formatting string that works like std::printf() but not all of the formatting specifiers are the same as printf(). Please read the ACE_Log_Msg documentation before using.
    • The most commonly misused formating specifier is %s. In printf this is for char* C strings, but in ACE_Log_Msg this is for ACE_TCHAR* C strings. ACE_TCHAR can be char or a wide character depending on how ACE was built (see next point). %C should be used for strings that are always char*, like std::string::c_str().
  • ACE has classes and macros for wide/narrow string conversion. See docs/design/WCHAR in the OpenDDS repository for details.
  • ACE provides support for platforms that have a non-standard program entry point (main). All of our main functions are int ACE_TMAIN(int argc, ACE_TCHAR* argv[]).

The OCI page for ACE is https://objectcomputing.com/products/ace.

The upstream DOC Group repository is hosted on Github at DOCGroup/ACE_TAO, which it shares with TAO.

TAO

TAO is a C++ CORBA Implementation built on ACE.

  • TAO provides the tao_idl IDL compiler and non-generated classes which implement the IDL-to-C++ mapping.
  • TAO ORBs are only created for interaction with the DCPSInfoRepo, all other uses of TAO are basic types and local interfaces.
  • A separate library, OpenDDS_InfoRepoDiscovery, encapsulates the participant process's use of the ORB
    • This is the only library which depends on TAO_PortableServer

The OCI page for TAO is https://objectcomputing.com/products/tao.

The upstream DOC Group repository is hosted on Github at DOCGroup/ACE_TAO, which it shares with ACE.

Optional Dependencies

CMake

OpenDDS has a CMake FindPackage module included. See cmake.md for how to make OpenDDS applications with CMake and without the need to use MPC in your application.

CMake is required to build Google Test for OpenDDS tests if a prebuilt Google Test is not found or provided.

See ../tests/gtest_setup.txt for details.

A recent release of CMake from the 3.x series should be used.

Google Test

Google Test is required for OpenDDS tests.

Google Test is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.

If OpenDDS was downloaded from opendds.org or another source that's not a git repository, Google Test will have to be downloaded separately and configured manually.

Google Test is available as package, at least in Debian based Linux distributions.

See ../tests/gtest_setup.txt for details.

Java

OpenDDS has optional Java bindings. It requires the Java Development Kit (JDK). See ../java/README.

There is also support for Java Message Server (JMS) v1.1. In addition to the JDK, it requires Ant and JBoss 4.2.x. See ../java/jms.

Qt

Qt5 is used for the monitor utility program and the ishapes RTPS demo.

See qt.md for details on configuring OpenDDS to use Qt.

Wireshark

A Wireshark dissector plugin for OpenDDS' non-RTPS transports is included with OpenDDS. The dissector supports Wireshark 1.2 and onwards and supports displaying and filtering by sample contents and from Wireshark 1.12 onwards.

Because of Wireshark's use of Glib, Glib is also required to build the dissector.

See ../tools/dissector/README.md for details.

RapidJSON

RapidJSON is a C++ JSON Library used for sample dissection in the Wireshark dissector and RapidJSON type support. Support for RapidJSON, if available, is enabled by default unless --no-rapidjson was passed.

RapidJSON is a git submodule that will be downloaded automatically if the repository was recursively cloned or submodules were initialized separately.

If OpenDDS was downloaded from opendds.org or another source that's not a git repository, RapidJSON will have to be downloaded separately and configured manually.

RapidJSON is also available as package, at least in Debian-based Linux distributions.

Xerces

Apache Xerces ("Xerces 3 C++" specifically) is used for parsing QoS XML and security XML configuration files.

OpenSSL

OpenSSL is used for DDS Security for verifying security configurations and encryption and decryption. Versions 1.0, 1.1 and 3.0 (3.0.1 or later) are supported.

Python

Python is used for some scripts where Perl isn't as suitable. Most notably this includes the Sphinx-based documentation and processing the results of the CMake tests in auto_run_tests.pl if --cmake is passed.

Unless noted otherwise, Python should be version 3.6 or later. Because it's an optional dependency, Python should not be required for any script used for building and testing the core functionality of OpenDDS. Right now only Perl can be used for situations like that.