file Backends/backend_info.hpp

[No description available] More…

Namespaces

Name
Gambit
TODO: see if we can use this one:
Gambit::Backends

Classes

Name
structGambit::Backends::backend_info
Structure providing some basic info on backend libraries.

Detailed Description

Author:

Date:

  • 2014 Aug
  • 2015 May
  • 2017 Dec
  • 2017 Jun
  • 2019 Jun

Container used for storing info about backends during initialisation time.

Authors (add name and date if you modify):

Source code 

//   GAMBIT: Global and Modular BSM Inference Tool
//   *********************************************
///  \file
///
///  Container used for storing info about
///  backends during initialisation time.
///
///  *********************************************
///
///  Authors (add name and date if you modify):
///
///  \author Pat Scott
///          (patscott@physics.mcgill.ca)
///  \date 2014 Aug
///  \date 2015 May
///  \date 2017 Dec
///
///  \author Tomas Gonzalo
///          (t.e.gonzalo@fys.uio.no)
///  \date 2017 Jun
///
///  \author Patrick Stoecker
///          (stoecker@physik.rwth-aachen.de)
///  \date 2019 Jun
///
///  *********************************************

#ifndef __backend_info_hpp__
#define __backend_info_hpp__

#include <map>

#include "gambit/Utils/util_types.hpp"
#include "gambit/cmake/cmake_variables.hpp"
#include "yaml-cpp/yaml.h"

// Forward declarations
#ifdef HAVE_MATHEMATICA
  #if MATHEMATICA_WSTP_VERSION_MAJOR > 4 || (MATHEMATICA_WSTP_VERSION_MAJOR == 4 && MATHEMATICA_WSTP_VERSION_MINOR > 25)
    #ifndef __MLINK__
      typedef struct MLink* WSLINK;
      #define __MLINK__
    #endif
  #else
    #ifndef __WSLINK__
      typedef struct WSLink* WSLINK;
      #define __WSLINK__
    #endif
  #endif
#endif
#ifdef HAVE_PYBIND11
  #include "gambit/Utils/begin_ignore_warnings_pybind11.hpp"
  #include <pybind11/pybind11.h>
  #include "gambit/Utils/end_ignore_warnings.hpp"
#endif


namespace Gambit
{

  namespace Backends
  {

    /// Structure providing some basic info on backend libraries
    struct backend_info
    {

      public:

        /// Constructor
        backend_info();

        /// Destructor
        ~backend_info();

        /// Indicate whether a custom backend locations file exists
        bool custom_locations_exist() const;

        /// Return the path to any custom user backend locations file
        str backend_locations() const;

        /// Return the path to the default backend locations file
        str default_backend_locations() const;

        /// Return the path to a backend library
        str path(str, str) const;

        /// Return the path to a backend library with GAMBIT_DIR expanded
        str corrected_path(str, str) const;

        /// Return the path to the folder in which a backend library resides
        str path_dir(str, str) const;

        /// Return the bare name of the library of a backend library, with no path or extension
        str lib_name(str, str) const;

        /// Key: backend name + version
        std::map<str,str> dlerrors;

        /// Key: backend name (map from BOSSed backend names to their default safe versions)
        std::map<str, str> default_safe_versions;

        /// Key: backend name + version
        std::map<str,bool> works;

        /// Key: backend name + version
        std::map<str,bool> needsMathematica;

        /// Key: backend name + version
        std::map<str,bool> needsPython;

        /// Key: backend name + version
        std::map<str,int> missingPythonVersion;

        /// Key: backend name + version
        std::map<str,bool> classloader;

        /// Key: backend name + version
        std::map<str,bool> classes_OK;

        /// Key: backend name + version
        std::map<str,std::set<str> > classes;

        /// Key: backend name + version + class name
        std::map<str,std::set<str> > factory_args;

        /// Key: backend name + version + class name + factory args
        std::map<str,str> constructor_status;

        /// Given a backend and a safe version (with no periods), return the true version
        str version_from_safe_version (str, str) const;

        /// Given a backend and a true version (with periods), return the safe version
        str safe_version_from_version (str, str) const;

        /// Link a backend's version and safe version
        void link_versions(str, str, str);

        /// Override a backend's config file location
        void override_path(const str&, const str&, str);

        /// Get the default version of a BOSSed backend.
        str default_version(const str& be) const;

        /// Get all versions of a given backend that are successfully loaded.
        std::vector<str> working_versions(const str&);

        /// Get all safe versions of a given backend that are successfully loaded.
        std::vector<str> working_safe_versions(const str&);

        /// Try to resolve a pointer to a partial path to a shared library and use it to override the stored backend path.
        void attempt_backend_path_override(const str&, const str&, const char*);

        /// Attempt to load a backend library.
        int loadLibrary(const str&, const str&, const str&, bool, const str&);

        /// C/C++/Fortran backends that have been successfully loaded (Key: name+version)
        std::map<str, void*> loaded_C_CXX_Fortran_backends;

        #ifdef HAVE_MATHEMATICA
          /// Python backends that have been successfully loaded (Key: name+version)
          std::map<str, WSLINK> loaded_mathematica_backends;
        #endif

        #ifdef HAVE_PYBIND11
          /// Python backends that have been successfully loaded (Key: name+version)
          std::map<str, pybind11::module*> loaded_python_backends;

          /// Return the python module corresponding to a given backend name and version, or the empty module if that backend is not loaded.
          pybind11::module& getPythonBackend(const str&, const str&);
        #endif

      private:

        /// Map from backend names to maps between version and safe version
        std::map<str,std::pair<std::map<str,str>,std::map<str,str> > > safe_version_map;

        /// Map from backend names to maps between version and paths found by dlinfo
        std::map<str, std::map<str, str> > bepathoverrides;

        /// Filename in which to find the user's custom backend locations configuration file.
        const str filename;

        /// Filename in which to find the default backend locations configuration file.
        const str default_filename;

        /// YAML node corresponding to user custom backend locations configuration file.
        YAML::Node bepathfile;

        /// YAML node corresponding to default backend locations configuration file.
        YAML::Node default_bepathfile;

        /// Flag indicating whether or not the user has a custom backend locations file
        bool custom_bepathfile_exists;

        /// Load a backend library written in C, C++ or Fortran
        void loadLibrary_C_CXX_Fortran(const str&, const str&, const str&, bool with_BOSS);

        /// Load a backend data library
        void loadLibrary_data(const str&, const str&, const str&);

        #ifdef HAVE_MATHEMATICA
          /// Load WSTP for Mathematica backends
          void loadLibrary_Mathematica(const str&, const str&, const str&);
        #endif

        #ifdef HAVE_PYBIND11
          /// Load a Python backend module
          void loadLibrary_Python(const str&, const str&, const str&, const str&);
        #endif

    };

  }

}


#endif // defined __backend_info_hpp__

Updated on 2024-07-18 at 13:53:35 +0000