Adios2StManImpl.h

Go to the documentation of this file.

// # Adios2StManImpl.h: Implementation class definition of the ADIOS2 Storage Manager
//
// # ICRAR - International Centre for Radio Astronomy Research
// # (c) UWA - The University of Western Australia, 2018
// # Copyright by UWA (in the framework of the ICRAR)
// #
// # This library is free software; you can redistribute it and/or modify it
// # under the terms of the GNU Library General Public License as published by
// # the Free Software Foundation; either version 2 of the License, or (at your
// # option) any later version.
// #
// # This library is distributed in the hope that it will be useful, but WITHOUT
// # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
// # License for more details.
// #
// # You should have received a copy of the GNU Library General Public License
// # along with this library; if not, write to the Free Software Foundation,
// # Inc., 675 Massachusettes Ave, Cambridge, MA 02139, USA.
// #
// # Correspondence concerning AIPS++ should be addressed as follows:
// #        Internet email: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
// #
 
#ifndef ADIOS2STMANIMPL_H
#define ADIOS2STMANIMPL_H
 
#include <adios2.h>
 
#include "Adios2StMan.h"
 
namespace casacore {
 
class Adios2StManColumn;
 
class Adios2StMan::impl {
 public:
  impl(Adios2StMan &parent, void *mpiComm, std::string engineType,
       std::map<std::string, std::string> engineParams,
       std::vector<std::map<std::string, std::string>> transportParams,
       std::vector<std::map<std::string, std::string>> operatorParams, std::string configFile);
 
  ~impl();
 
#ifdef HAVE_MPI
  void checkMPI() const;
#endif
  DataManager *clone() const;
  String dataManagerType() const;
  String dataManagerName() const;
  void setDataManagerName(const String &aName);
  void create64(rownr_t aNrRows);
  rownr_t open64(rownr_t aRowNr, AipsIO &ios);
  rownr_t resync64(rownr_t aRowNr);
  Bool flush(AipsIO &ios, Bool doFsync);
  DataManagerColumn *makeColumnCommon(const String &aName, int aDataType,
                                      const String &aDataTypeID);
  DataManagerColumn *makeScalarColumn(const String &aName, int aDataType,
                                      const String &aDataTypeID);
  DataManagerColumn *makeDirArrColumn(const String &aName, int aDataType,
                                      const String &aDataTypeID);
  DataManagerColumn *makeIndArrColumn(const String &aName, int aDataType,
                                      const String &aDataTypeID);
  void deleteManager();
  void addRow64(rownr_t aNrRows);
  static DataManager *makeObject(const String &aDataManType, const Record &spec);
  Record dataManagerSpec() const;
  rownr_t getNrRows();
 
 private:
  Adios2StMan &parent;
  String itsDataManName = "Adios2StMan";
  rownr_t itsRows{0};
  Block<Adios2StManColumn *> itsColumnPtrBlk;
 
  std::shared_ptr<adios2::ADIOS> itsAdios;
  std::shared_ptr<adios2::IO> itsAdiosIO;
  std::shared_ptr<adios2::Engine> itsAdiosEngine;
 
#ifdef HAVE_MPI
  // MPI communicator to be used by all instances of this storage manager
  static MPI_Comm itsMpiComm;
#endif
 
  // The ADIOS2 Engine type
  std::string itsAdiosEngineType;
  // Parameters for the ADIOS2 engine
  adios2::Params itsAdiosEngineParams;
  // Parameters for the ADIOS2 transports
  std::vector<adios2::Params> itsAdiosTransportParamsVec;
  // Parameters for the ADIOS2 operators (compressors)
  std::vector<adios2::Params> itsAdiosOperatorParamsVec;
  // The ADIOS2 XML configuration file
  std::string itsAdiosConfigFile;
 
  // The type of this storage manager
  static constexpr const char *DATA_MANAGER_TYPE = "Adios2StMan";
  // The name of the specification field for the ADIOS2 XML configuration file
  static constexpr const char *SPEC_FIELD_XML_FILE = "XMLFILE";
  // The name of the specification field for the ADIOS2 engine type
  static constexpr const char *SPEC_FIELD_ENGINE_TYPE = "ENGINETYPE";
  // The name of the specification field for the ADIOS2 engine parameters
  static constexpr const char *SPEC_FIELD_ENGINE_PARAMS = "ENGINEPARAMS";
  // The name of the specification field for the ADIOS2 transport parameters
  static constexpr const char *SPEC_FIELD_TRANSPORT_PARAMS = "TRANSPORTPARAMS";
  // The name of the specification field for the ADIOS2 operator parameters
  static constexpr const char *SPEC_FIELD_OPERATOR_PARAMS = "OPERATORPARAMS";
 
  void configureAdios();
  uInt ncolumn() const { return parent.ncolumn(); }
  String fileName() const { return parent.fileName(); }
};
 
}  // namespace casacore
 
#endif  // ADIOS2STMANIMPL_H