lsst.base g2d94c5dfbc+62d12e78cb
LSST Data Management Base Package
Loading...
Searching...
No Matches
Namespaces | Classes | Functions | Variables
lsst::base Namespace Reference

Namespaces

namespace  version
 

Classes

class  LibraryException
 Unable to load library. More...
 
class  ModuleImporter
 Base class that defines an interface for importing Python modules. More...
 
class  NoThreadsException
 No threading library is available. More...
 

Functions

std::string libraryExtension ()
 Return filename extension for libraries. More...
 
std::string getLibraryFilename (std::string const &name)
 Get filename for library. More...
 
bool canLoadLibrary (std::string const &libName)
 Return whether we can load a library. More...
 
template<typename T >
T * loadSymbol (std::string const &libName, std::string const &symName)
 Load a symbol from a dynamic library. More...
 
bool haveThreads ()
 Are threaded packages available? More...
 
void setNumThreads (unsigned int numThreads)
 Set number of threads to use. More...
 
unsigned int getNumThreads ()
 Get maximum number of threads we might use. More...
 
bool disableImplicitThreading ()
 Disable threading that has not been set explicitly. More...
 

Variables

bool const haveOpenBlas = loadOpenBlas()
 Is OpenBLAS available? More...
 
bool const haveMkl = loadMkl()
 Is MKL available? More...
 
std::string const allowEnvvar = "LSST_ALLOW_IMPLICIT_THREADS"
 Environment variable to allow implicit threading. More...
 

Function Documentation

◆ canLoadLibrary()

bool lsst::base::canLoadLibrary ( std::string const &  libName)

Return whether we can load a library.

The proper filename extension will be added to the library name unless one is specified.

Parameters
libNameLibrary name

Definition at line 37 of file library.cc.

◆ disableImplicitThreading()

bool lsst::base::disableImplicitThreading ( )

Disable threading that has not been set explicitly.

Some threaded packages implicitly use multiple threads if the user doesn't explicitly state the number of desired threads. However, this can interfere with operations that are parallelised at a higher level. This function will disable threading unless the user has explicitly specified the number of desired threads through environment variables.

This behavior may be disabled by setting the environment variable specified by allowEnvvar.

This is principally intended for Linux machines (we explicitly load .so dynamic libraries); MacOS has its own way of doing threading (Grand Central Dispatch) that throttles threads to avoid overwhelming the machine.

@ return whether we disabled threading

Definition at line 132 of file threads.cc.

◆ getLibraryFilename()

std::string lsst::base::getLibraryFilename ( std::string const &  name)

Get filename for library.

We'll add the typical filename extension for the platform unless the user specifies a ".so" or ".dylib" extension.

Definition at line 27 of file library.cc.

◆ getNumThreads()

unsigned int lsst::base::getNumThreads ( )

Get maximum number of threads we might use.

Returns the maximum value of the number of threads being used by the threading libraries that are available.

Definition at line 120 of file threads.cc.

◆ haveThreads()

bool lsst::base::haveThreads ( )

Are threaded packages available?

Definition at line 26 of file threads.h.

◆ libraryExtension()

std::string lsst::base::libraryExtension ( )

Return filename extension for libraries.

Typically ".so" for Linux and ".dylib" for Mac.

Definition at line 17 of file library.cc.

◆ loadSymbol()

template<typename T >
T * lsst::base::loadSymbol ( std::string const &  libName,
std::string const &  symName 
)

Load a symbol from a dynamic library.

The proper filename extension will be added to the library name unless one is specified.

No mangling is performed on the symbol name.

Parameters
libNameLibrary name (NOT including ".so" or ".dylib")
symNameSymbol name

Definition at line 51 of file library.h.

◆ setNumThreads()

void lsst::base::setNumThreads ( unsigned int  numThreads)

Set number of threads to use.

Exceptions
NoThreadsExceptionif no threading library is available

Definition at line 107 of file threads.cc.

Variable Documentation

◆ allowEnvvar

std::string const lsst::base::allowEnvvar = "LSST_ALLOW_IMPLICIT_THREADS"

Environment variable to allow implicit threading.

Used by disableImplicitThreading.

Definition at line 16 of file threads.h.

◆ haveMkl

bool const lsst::base::haveMkl = loadMkl()
extern

Is MKL available?

Definition at line 105 of file threads.cc.

◆ haveOpenBlas

bool const lsst::base::haveOpenBlas = loadOpenBlas()
extern

Is OpenBLAS available?

Definition at line 104 of file threads.cc.