infoout.h

Go to the documentation of this file.

// Copyright (C) 2024 The m-AIA AUTHORS
//
// This file is part of m-AIA (https://git.rwth-aachen.de/aia/m-AIA/m-AIA)
//
// SPDX-License-Identifier: LGPL-3.0-only
 
#ifndef INFOOUT_H
#define INFOOUT_H
 
#include <fstream> // Needed for ofstream
#include <sstream> // Needed for ostringstream
#include <vector>
#include "COMM/mpioverride.h" // Needed for MPI functionality
#include "INCLUDE/maiatypes.h"
 
#ifdef _SX
#include <sys/socket.h>
#endif
 
 
namespace MAIA_INFOOUT_FILETYPES {
const MInt MAIA_INFOOUT_MPI_FILE = 0;    
const MInt MAIA_INFOOUT_SIMPLE_FILE = 1; 
} // namespace MAIA_INFOOUT_FILETYPES
 
class InfoOut;
class InfoOut_buffer : public std::stringbuf {
  friend class InfoOut;
 
 protected:
  static const MInt m_fileFormatVersion = 1; 
  MBool m_rootOnly;                          
  MInt m_domainId;                           
  MInt m_noDomains;                          
  MInt m_minFlushSize;                       
  MString m_prefixMessage;                   
  MString m_suffixMessage;                   
  std::ostringstream m_tmpBuffer;            
  MString m_projectName;                     
 
  std::vector<std::pair<MString, MString>> m_prefixAttributes;
 
  virtual MString encodeXml(const std::string& str);
  virtual MString getXmlHeader();
  virtual MString getXmlFooter();
  virtual void createPrefixMessage();
  virtual void createSuffixMessage();
  virtual void flushBuffer() = 0;
 
 public:
  InfoOut_buffer();
  virtual MBool setRootOnly(MBool rootOnly = true);
  virtual MInt setMinFlushSize(MInt minFlushSize);
};
 
class InfoOut : public std::ostream {
  friend class InfoOut_buffer;
 
 protected:
  InfoOut_buffer* m_buffer = nullptr;
 
 public:
// Disable clang warning for ostream(m_buffer), although this is probably a compiler error
#if defined(MAIA_CLANG_COMPILER)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wuninitialized"
#endif
  InfoOut() : std::ostream(m_buffer){};
#if defined(MAIA_CLANG_COMPILER)
#pragma clang diagnostic pop
#endif
  virtual MBool setRootOnly(MBool rootOnly = true) = 0;
  MInt addAttribute(std::pair<MString, MString>);
  void eraseAttribute(MInt);
  void modifyAttribute(MInt, std::pair<MString, MString>);
};
 
class InfoOut_mpiFileBuffer : public InfoOut_buffer {
 private:
  static const MInt m_maxStringLength = 8192; 
  MInt m_maxMessageLength;                    
  MInt m_mpiWriteBufferSize;                  
  MChar* m_mpiWriteBuffer;                    
  MBool m_isOpen;                             
  MString m_filename;                         
  MPI_Comm m_mpiComm;                         
  MPI_File m_mpiFileHandle;                   
  MPI_Request m_mpiRequest;                   
 
 
  MInt setMpiWriteBuffer(MInt newBufferSize);
 
 protected:
  virtual MInt sync();
  virtual void flushBuffer();
 
 public:
  InfoOut_mpiFileBuffer();
  InfoOut_mpiFileBuffer(const MString& filename, const MString& projectName, MPI_Comm mpiComm = MPI_COMM_WORLD);
  ~InfoOut_mpiFileBuffer();
  void open(const MString& filename, const MString& projectName, MPI_Comm mpiComm = MPI_COMM_WORLD);
  void close(MBool forceClose = false);
  MInt setMinFlushSize(MInt minFlushSize);
};
 
class InfoOut_simpleFileBuffer : public InfoOut_buffer {
 private:
  MBool m_isOpen;            
  MBool m_rootOnlyHardwired; 
  MString m_filename;        
  std::ofstream m_file;      
  MPI_Comm m_mpiComm;        
 
 protected:
  virtual MInt sync();
  virtual void flushBuffer();
 
 public:
  InfoOut_simpleFileBuffer();
  InfoOut_simpleFileBuffer(const MString& filename, const MString& projectName, MPI_Comm mpiComm = MPI_COMM_WORLD,
                           MBool rootOnlyHardwired = false);
  ~InfoOut_simpleFileBuffer();
  void open(const MString& filename, const MString& projectName, MPI_Comm mpiComm = MPI_COMM_WORLD,
            MBool rootOnlyHardwired = false);
  void close(MBool forceClose = false);
};
 
 
class InfoOut_streamBuffer : public InfoOut_buffer {
 private:
  MBool m_isInitialized;  
  MBool m_printDomainId;  
  std::ostream* m_output; 
  MPI_Comm m_mpiComm;     
  MBool m_isDisabled;     
 
 protected:
  virtual MInt sync();
  virtual void flushBuffer();
  virtual MString addPrefix(const MString& str);
 
 public:
  InfoOut_streamBuffer();
  InfoOut_streamBuffer(std::ostream* os, MPI_Comm mpiComm = MPI_COMM_WORLD, MBool printDomainId = true);
  void initialize(std::ostream* os, MPI_Comm mpiComm = MPI_COMM_WORLD, MBool printDomainId = true);
};
 
class InfoOutFile : public InfoOut {
 private:
  MInt m_fileType; 
  MBool m_isOpen;  
 
 public:
  InfoOutFile();
  InfoOutFile(const MString& filename, const MString& projectName, MInt fileType = 0, MPI_Comm mpiComm = MPI_COMM_WORLD,
              MBool rootOnlyHardwired = false);
  ~InfoOutFile();
  void open(const MString& filename, const MString& projectName, MInt fileType = 0, MPI_Comm mpiComm = MPI_COMM_WORLD,
            MBool rootOnlyHardwired = false);
  void close(MBool forceClose = false);
  MBool setRootOnly(MBool rootOnly = true);
  MInt setMinFlushSize(MInt minFlushSize);
};
 
class InfoOutStream : public InfoOut {
 private:
  MBool m_isInitialized; 
 
 public:
  InfoOutStream();
  InfoOutStream(std::ostream* os, MPI_Comm mpiComm = MPI_COMM_WORLD, MBool printDomainId = true);
  ~InfoOutStream();
  void initialize(std::ostream* os, MPI_Comm mpiComm = MPI_COMM_WORLD, MBool printDomainId = true);
  MBool setRootOnly(MBool rootOnly = true);
};
 
#endif /* ifndef INFOOUT_H */