v5_DataWriter.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/

 
 
#ifndef OFFLINE_EVENTSTORAGE_V5_DATAWRITER_H
#define OFFLINE_EVENTSTORAGE_V5_DATAWRITER_H
 
#include <string>
#include <fstream>
#include <sys/uio.h>
#include <stdint.h>
#include <zlib.h>
#include <boost/shared_ptr.hpp>
#include <boost/utility.hpp>
 
#include "EventStorage/DWError.h"
#include "ByteStreamCnvSvcLegacy/offline_EventStorage/v5_EventStorageRecords.h"
#include "EventStorage/FileNameCallback.h"
#include "EventStorage/RawFileName.h"
 
 
namespace EventStorage {
  class DataWriterCallBack;
}
 
namespace offline_EventStorage_v5 {
  
  class DataBuffer;
 
  enum FileStatus { FINISHED, UNFINISHED };
 
class DataWriter : boost::noncopyable
{
public:
  using iovec_const = offline_EventStorage_v5::iovec_const;

  DataWriter(const std::string& writingPath,     
         const std::string& fileNameCore,    
         const run_parameters_record& rPar, 
         const std::vector<std::string>& fmdStrings, 
         const unsigned int startIndex = 1,
         const CompressionType compression = NONE,
         const unsigned int compLevel = 1); 
 
 
 
  DataWriter(const std::string& writingPath,   
         boost::shared_ptr<EventStorage::FileNameCallback> theFNCB,
         const run_parameters_record& rPar, 
         const std::string& project,
         const std::string& streamType,
         const std::string& streamName,
         const std::string& stream,
         const unsigned int lumiBlockNumber,
         const std::string& applicationName,
         const std::vector<std::string>& fmdStrings,
         const CompressionType compression = NONE,
         const unsigned int compLevel = 1);
 
  DataWriter(const std::string& writingPath,   
         const std::string& fileNameCore,     
         const run_parameters_record& rPar, 
         const std::string& project,
         const std::string& streamType,
         const std::string& streamName,
         const std::string& stream,
         const unsigned int lumiBlockNumber,
         const std::string& applicationName,
         const std::vector<std::string>& fmdStrings,
         const CompressionType compression = NONE,
         const unsigned int compLevel = 1);
 
 
private:
  DataWriter();
 
 
  void initDW(const std::string& writingPath,   
          boost::shared_ptr<EventStorage::FileNameCallback> theFNCB,
          const run_parameters_record& rPar, 
          const std::string& project,
          const std::string& streamType,
          const std::string& streamName,
          const std::string& stream,
          const unsigned int lumiBlockNumber,
          const std::string& applicationName,
          const std::vector<std::string>& fmdStrings,
          const CompressionType compression,
          const unsigned int compLevel);
 
 
  EventStorage::DWError putData_implementation(const unsigned int& entries,
                 const iovec_const * my_iovec, 
                 uint32_t& sizeToDisk,
                 bool precompressed = false);
  
public:
  ~DataWriter();
        
  EventStorage::DWError setMaxFileNE(const unsigned int& maxFileNE);
 
  EventStorage::DWError setMaxFileMB(const unsigned int& maxFileMB);
  
  void setGUID(const std::string& GUID);
  

  bool good() const; // check if open and last write went OK

  void cd(const std::string& writingPath);

  bool inTransition() const;

  EventStorage::DWError putData(const unsigned int& dataSize, const void *event);
 

  EventStorage::DWError putPrecompressedData(const unsigned int& dataSize,
                   const void *event);

  EventStorage::DWError putPrecompressedData(const unsigned int& entries,
                   const iovec_const* my_iovec);
 

  EventStorage::DWError putData(const unsigned int& entries, const struct iovec* my_iovec);
 

  EventStorage::DWError putData(const unsigned int& dataSize, const void *event, uint32_t& sizeToDisk);

  EventStorage::DWError putData(const unsigned int& entries, const iovec_const* my_iovec,
          uint32_t& sizeToDisk);
 

  EventStorage::DWError closeFile();

  EventStorage::DWError nextFile();

  std::string nameFile(const FileStatus& fs) const;

  int64_t getPosition() const;

  unsigned int eventsInFile() const; 

  unsigned int eventsInFileSequence() const;
 
  unsigned int dataMB_InFile() const; 

  unsigned int dataMB_InFileSequence() const; 
 
  void registerCallBack(EventStorage::DataWriterCallBack *pUserCBclass);

  CompressionType getCompression() const;

  void setGuid(const std::string& Guid);
 
 private:
  // date and time utility, other private methods
  void date_timeAsInt(uint32_t &getDate, uint32_t &getTime) const;
  void openNextFile();
  bool fileExists(const std::string& name) const;
  void setRunParamsRecord(const run_parameters_record& rPar);
 
  //methods to write records to files
  void file_record(void *ri, const void *pi);
  void file_record(const file_name_strings& nst);
  void file_record(const freeMetaDataStrings& fmdStrings);
 
  // some parsing is needed to fill metadata
  std::string getAppName(const std::string& fileNameCore) const;
  std::string getElement(const std::string& fileNameCore, 
             const std::string& element) const;
  uint64_t getFileSize(const std::string& fileNameCore) const;
 
  //methods to add the Global Unique ID to the files
  void spaceForGuid();
  void replaceGuid();
 
 private: //data members
 
 
  std::fstream m_cFile;   // current file
 
  bool m_cFileOpen;        // Is a file open at the moment?
  bool m_openFailed;       // Has the lest open operation failed?
    
  file_start_record m_file_start_record;          // parameters of the current file
  file_name_strings m_file_name_strings;          // two significant strings in file name 
  internal_run_parameters_record m_internal_run_parameters_record;  // parameters of the run
  file_end_record m_file_end_record;              // more parameters of the file
 
  std::string m_guid; //the GUID
  std::string m_next_guid;
 
  std::string m_writePath;       // path to write
  std::string m_nextWritePath;   // next path to write
  std::string m_fileNameCore;    // most of the file name 
 
  std::string        m_project;           // fields needed at some point
  std::string        m_streamType;        //
  std::string        m_streamName;        //
  std::string        m_stream;
  unsigned int       m_lumiBlockNumber;
  std::string        m_applicationName;
 
  CompressionType    m_compression;
  unsigned int       m_complevel;
  DataBuffer         *m_compressed;
  
  double             m_cFileMB; // megabytes so far in the file, for adding up
  long double        m_runMB;   // megabytes so far in the run
  uLong              m_check;   //running checksum
 
  int64_t            m_latestPosition; // offset of the latest written event
 
  EventStorage::DataWriterCallBack *m_callBack; // pointer to call-back, for reporting file names
 
  freeMetaDataStrings m_fmdStrings; // optional vector of strings, not written out if empty  
 
  boost::shared_ptr<EventStorage::FileNameCallback> m_filenamecallback;
};
 
}
#endif // OFFLINE_EVENTSTORAGE_V5_DATAWRITER_H