DiskWriteTask.hpp

/******************************************************************************
 *                      DiskWriteFileTask.hpp
 *
 * This file is part of the Castor project.
 * See http://castor.web.cern.ch/castor
 *
 * Copyright (C) 2003  CERN
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * 
 *
 * @author Castor Dev team, castor-dev@cern.ch
 *****************************************************************************/

#pragma once

#include "castor/tape/tapeserver/daemon/DiskWriteTask.hpp"
#include "castor/tape/tapeserver/daemon/DataFifo.hpp"
#include "castor/tape/tapeserver/daemon/MemManager.hpp"
#include "castor/tape/tapeserver/daemon/DataConsumer.hpp"
#include "castor/tape/tapeserver/file/File.hpp"
#include "castor/tape/tapegateway/FileToRecallStruct.hpp"

namespace {
  
  uint32_t blockID(const castor::tape::tapegateway::FileToRecallStruct& ftr)
  {
    return (ftr.blockId0() << 24) | (ftr.blockId1() << 16) |  (ftr.blockId2() << 8) | ftr.blockId3();
  }
  
  /*Use RAII to make sure the memory block is released  
   *(ie pushed back to the memory manager) in any case (exception or not)
   */
  class AutoReleaseBlock{
    castor::tape::tapeserver::daemon::MemBlock *block;
    castor::tape::tapeserver::daemon::MemoryManager& memManager;
  public:
    AutoReleaseBlock(castor::tape::tapeserver::daemon::MemBlock* mb, 
            castor::tape::tapeserver::daemon::MemoryManager& mm):
    block(mb),memManager(mm){}
    
    ~AutoReleaseBlock(){
      memManager.releaseBlock(block);
    }
  };
}
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  
/**
 * The DiskWriteFileTask is responsible to write a single file onto disk as part of a recall
 * session. Being a consumer of memory blocks, it inherits from the DataConsumer class. It also
 * inherits several methods from the DiskWriteTask (TODO: do we really need this base class?).
 */
class DiskWriteTask: public DiskWriteTaskInterface, public DataConsumer {
public:
  /**
   * Constructor
   * @param fileId: file id of the file to write to disk
   * @param blockCount: number of memory blocks that will be used
   * @param mm: memory manager of the session
   */
  DiskWriteTask(const tape::tapegateway::FileToRecallStruct& file,MemoryManager& mm): 
  m_blockCount(blockID(file)),m_fifo(m_blockCount),m_recallingFile(file),m_memManager(mm){
    mm.addClient(&m_fifo); 
  }
  
  /**
   * Return the number of files to write to disk
   * @return always 1
   */
  virtual int files() { return 1; };
  
  /**
   * @return the number of memory blocks to be used
   */
  virtual int blocks() { return m_blockCount; }
  
  /**
   * Main routine: takes each memory block in the fifo and writes it to disk
   */
  virtual void execute(RecallReportPacker& reporter,log::LogContext& lc) {
    using log::LogContext;
    using log::Param;
    try{
      tape::diskFile::WriteFile writer(m_recallingFile.path());
      int blockId  = 0;
      
      while(!m_fifo.finished()) {
        MemBlock *mb = m_fifo.popDataBlock();
        AutoReleaseBlock releaser(mb,m_memManager);
        
        if(m_recallingFile.fileid() != static_cast<unsigned int>(mb->m_fileid)
                || blockId != mb->m_fileBlock){
          LogContext::ScopedParam sp[]={
            LogContext::ScopedParam(lc, Param("expectedFILEID",m_recallingFile.fileid())),
            LogContext::ScopedParam(lc, Param("receivedFILEID", mb->m_fileid)),
            LogContext::ScopedParam(lc, Param("expectedFBLOCKId", blockId)),
            LogContext::ScopedParam(lc, Param("receivedFBLOCKId", mb->m_fileBlock)),
        };
        tape::utils::suppresUnusedVariable(sp);
          lc.log(LOG_ERR,"received a bad block for writing");
          throw castor::tape::Exception("received a bad block for writing");
        }
        writer.write(mb->m_payload.get(),mb->m_payload.size());
      }
      writer.close();
      //a log is done in m_reporter while processing reportCompletedJob
      reporter.reportCompletedJob(m_recallingFile);
    }
    catch(const castor::exception::Exception& e){
      //a log is done in m_reporter while processing reportFailedJob    
      reporter.reportFailedJob(m_recallingFile,e.getMessageValue(),e.code());
    }
  }
  
  /**
   * Allows client code to return a reusable memory block
   * @return the pointer to the memory block that can be reused
   */
  virtual MemBlock *getFreeBlock() { return m_fifo.getFreeBlock(); }
  
  /**
   * Function used to enqueue a new memory block holding data to be written to disk
   * @param mb: corresponding memory block
   */
  virtual void pushDataBlock(MemBlock *mb) {
    castor::tape::threading::MutexLocker ml(&m_producerProtection);
    m_fifo.pushDataBlock(mb);
  }
  
  /**
   * Function used to wait until the end of the write
   */
  virtual void waitCompletion() { 
    volatile castor::tape::threading::MutexLocker ml(&m_producerProtection); 
  }
  
  /**
   * Destructor (also waiting for the end of the write operation)
   */
  virtual ~DiskWriteTask() { 
    volatile castor::tape::threading::MutexLocker ml(&m_producerProtection); 
  }
  
private:
  /**
   * Number of blocks in the fifo
   */
  const int m_blockCount;
  
  /**
   * The fifo containing the memory blocks holding data to be written to disk
   */
  DataFifo m_fifo;
  
  /** 
   * All we need to know about the file we are currently recalling
   */
  tape::tapegateway::FileToRecallStruct m_recallingFile;
    
  /**
   * Reference to the Memory Manager in use
   */
  MemoryManager & m_memManager;
  
  /**
   * Mutex forcing serial access to the fifo
   */
  castor::tape::threading::Mutex m_producerProtection;
  
};

}}}}