tbb::interface6::runtime_loader Class Reference - Hhvm

Public Types | Public Member Functions | List of all members

tbb::interface6::runtime_loader Class Reference

Load TBB at runtime. More...

#include <runtime_loader.h>

Inheritance diagram for tbb::interface6::runtime_loader:

Public Types

| | enum | error_mode { em_status, em_throw, em_abort } | | | Error mode constants. More...
| | | | enum | error_code {
ec_ok, ec_bad_call, ec_bad_arg, ec_bad_lib,
ec_bad_ver, ec_no_lib
} | | | Error codes. More...
| | |

Public Member Functions

Detailed Description

Load TBB at runtime.

Usage:

In source code:

#include "tbb/runtime_loader.h"

char const * path[] = { "<install dir>/lib/ia32", NULL };

tbb::runtime_loader loader( path );

// Now use TBB.

Link with tbbproxy.lib (or libtbbproxy.a) instead of tbb.lib (libtbb.dylib, libtbb.so).

TBB library will be loaded at runtime from `` <install dir>="">/lib/ia32 directory.

Attention:

All runtime_loader objects (in the same module, i.e. exe or dll) share some global state. The most noticeable piece of global state is loaded TBB library. There are some implications:

- Only one TBB library can be loaded per module.

- If one object has already loaded TBB library, another object will not load TBB.
    If the loaded TBB library is suitable for the second object, both will use TBB
    cooperatively, otherwise the second object will report an error.

- \c runtime_loader objects will not work (correctly) in parallel due to absence of
    synchronization.

Member Enumeration Documentation

| enum tbb::interface6::runtime_loader::error_code |

Error codes.

Enumerator
ec_ok

No errors.

| | ec_bad_call |

Invalid function call (e. g. load() called when TBB is already loaded).

| | ec_bad_arg |

Invalid argument passed.

| | ec_bad_lib |

Invalid library found (e. g. TBB_runtime_version symbol not found).

| | ec_bad_ver |

TBB found but version is not suitable.

| | ec_no_lib |

No suitable TBB library found.

| enum tbb::interface6::runtime_loader::error_mode |

Error mode constants.

Enumerator
em_status

Save status of operation and continue.

| | em_throw |

Throw an exception of tbb::runtime_loader::error_code type.

| | em_abort |

Print message to stderr and call abort().

Constructor & Destructor Documentation

Initialize object and load TBB.

See load() for details.

If error mode is em_status, call status() to check whether TBB was loaded or not.

Parameters

Member Function Documentation

| error_code tbb::interface6::runtime_loader::load | ( | char const * | path[], | | | | int | min_ver = TBB_INTERFACE_VERSION, | | | | int | max_ver = INT_MAX | | | ) | | |

Load TBB.

The method searches the directories specified in path[] array for the TBB library. When the library is found, it is loaded and its version is checked. If the version is not suitable, the library is unloaded, and the search continues.

Note:

For security reasons, avoid using relative directory names. For example, never load TBB from current ("."), parent ("..") or any other relative directory (like "lib" ). Use only absolute directory names (e. g. "/usr/local/lib").

For the same security reasons, avoid using system default directories ("") on Windows. (See http://www.microsoft.com/technet/security/advisory/2269637.mspx for details.)

Neglecting these rules may cause your program to execute 3-rd party malicious code.

Errors:

ec_bad_call - TBB already loaded by this object.
ec_bad_arg - min_ver and/or max_ver negative or zero, or min_ver > max_ver.
ec_bad_ver - TBB of unsuitable version already loaded by another object.
ec_no_lib - No suitable library found.

Parameters

| error_code tbb::interface6::runtime_loader::status | ( | | ) | |

Report status.

If error mode is em_status, the function returns status of the last operation.

The documentation for this class was generated from the following file:

runtime_loader.h

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.