environment.h

/** @file
 * API signatures for managing the QuEST
 * execution environment.
 * 
 * @author Tyson Jones
 * @author Richard Meister (aided in design)
 * 
 * @defgroup environment Environment
 * @ingroup api
 * @brief Data structures for managing the QuEST execution environment.
 * @{
 */
 
#ifndef ENVIRONMENT_H
#define ENVIRONMENT_H
 
// enable invocation by both C and C++ binaries
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
/*
 * QuESTEnv is a struct of which there will be a single, immutable
 * main instance, statically instantiated inside environment.cpp,
 * accessible anywhere via a getter, and which is consulted for
 * determining the deployment configuration. Users can obtain a
 * local copy of this struct with getQuESTEnv().
 */
 
/// @notyetdoced
typedef struct {
 
    // deployment modes which can be runtime disabled
    int isMultithreaded;
    int isGpuAccelerated;
    int isDistributed;
 
    // deployment modes which cannot be directly changed after compilation
    int isCuQuantumEnabled;
 
    // deployment configurations which can be changed via environment variables
    int isGpuSharingEnabled;
 
    // distributed configuration
    int rank;
    int numNodes;
 
} QuESTEnv;
 
 
/// @notyetdoced
void initQuESTEnv();
 
/** @notyetdoced
 * 
 * @see
 * - [C](https://github.com/QuEST-Kit/QuEST/blob/devel/examples/isolated/reporting_environments.c) and
 *   [C++](https://github.com/QuEST-Kit/QuEST/blob/devel/examples/isolated/reporting_environments.cpp) examples
 */
void initCustomQuESTEnv(int useDistrib, int useGpuAccel, int useMultithread);
 
/// @notyetdoced
void finalizeQuESTEnv();
 
/// @notyetdoced
void syncQuESTEnv();
 
/** @notyetdoced
 * @notyettested
 * 
 * @see
 * - [C](https://github.com/QuEST-Kit/QuEST/blob/devel/examples/isolated/reporting_environments.c) and
 *   [C++](https://github.com/QuEST-Kit/QuEST/blob/devel/examples/isolated/reporting_environments.cpp) examples
 */
void reportQuESTEnv();
 
/// @notyetdoced
int isQuESTEnvInit();
 
/// @notyetdoced
QuESTEnv getQuESTEnv();
 
 
 
// end de-mangler
#ifdef __cplusplus
}
#endif
 
#endif // ENVIRONMENT_H
 
/** @} */ // (end file-wide doxygen defgroup)