FilesMonitorCollection.h

Go to the documentation of this file.

// $Id: FilesMonitorCollection.h,v 1.17 2011/07/07 09:22:44 mommsen Exp $

#ifndef EventFilter_StorageManager_FilesMonitorCollection_h
#define EventFilter_StorageManager_FilesMonitorCollection_h

#include <iomanip>
#include <sstream>
#include <stdint.h>
#include <vector>

#include <boost/circular_buffer.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/shared_ptr.hpp>

#include "xdata/UnsignedInteger32.h"

#include "EventFilter/StorageManager/interface/MonitorCollection.h"


namespace stor {

  class FilesMonitorCollection : public MonitorCollection
  {
  public:

    struct FileRecord
    {
      enum ClosingReason
      {
        notClosed = 0,
        runEnded,
        LSended,
        timeout,
        size,
        truncated,
        inaccessible
      };

      enum FileStatus
      {
        open,
        closed,
        current
      };

      uint32_t           entryCounter;      // file counter
      uint32_t           runNumber;         // run number
      uint32_t           lumiSection;       // luminosity section 
      std::string        streamLabel;       // datastream label
      std::string        baseFilePath;      // file path w/o the working directory
      std::string        coreFileName;      // file name w/o instance & file ending
      uint32_t           fileCounter;       // counter of number of coreFileNames used
      ClosingReason      whyClosed;         // reason why the given file was closed
      bool               isOpen;            // true if file is in open directory
      uint64_t           fileSize;          // file size in bytes
      uint32_t           eventCount;        // number of events
      uint32_t           adler32;           // Adler32 checksum
      std::string closingReason();          // reason why file was closed
      std::string fileName();               // full file name
      std::string filePath(FileStatus status=current); // complete file path for the given file status
      std::string completeFileName(FileStatus status=current)
      { return ( filePath(status) + "/" + fileName() ); }

    };

    // We do not know how many files there will be.
    // Thus, we need a vector of them.
    typedef boost::shared_ptr<FileRecord> FileRecordPtr;
    typedef boost::circular_buffer<FileRecordPtr> FileRecordList;


    explicit FilesMonitorCollection(const utils::Duration_t& updateInterval);

    const FileRecordPtr getNewFileRecord();

    void getFileRecords(FileRecordList&) const;


  private:

    //Prevent copying of the FilesMonitorCollection
    FilesMonitorCollection(FilesMonitorCollection const&);
    FilesMonitorCollection& operator=(FilesMonitorCollection const&);

    virtual void do_calculateStatistics();
    virtual void do_reset();
    virtual void do_appendInfoSpaceItems(InfoSpaceItems&);
    virtual void do_updateInfoSpaceItems();

    FileRecordList fileRecords_;
    mutable boost::mutex fileRecordsMutex_;

    const unsigned int maxFileEntries_; // maximum number of files to remember
    uint32_t entryCounter_;

    xdata::UnsignedInteger32 closedFiles_;                 // number of closed files
    xdata::UnsignedInteger32 openFiles_;                   // number of open files

  };
  
} // namespace stor

#endif // EventFilter_StorageManager_FilesMonitorCollection_h