DiskWriteTask.hpp 4.65 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
/******************************************************************************
 *
 * 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

David COME's avatar
David COME committed
26
#include "castor/tape/tapeserver/daemon/DataPipeline.hpp"
27
#include "castor/tape/tapeserver/daemon/RecallMemoryManager.hpp"
28
#include "castor/tape/tapeserver/daemon/DataConsumer.hpp"
29
#include "castor/tape/tapeserver/file/File.hpp"
30
#include "castor/tape/tapegateway/FileToRecallStruct.hpp"
31
#include "castor/tape/tapeserver/daemon/RecallReportPacker.hpp"
32
#include "castor/tape/tapeserver/daemon/DiskStats.hpp"
33
#include "castor/tape/tapeserver/daemon/TaskWatchDog.hpp"
34
#include <memory>
35
36
namespace {
  
37
  // TODO: merge with same function in File.hpp and move to tape/utils
38
39
40
41
  uint32_t blockID(const castor::tape::tapegateway::FileToRecallStruct& ftr)
  {
    return (ftr.blockId0() << 24) | (ftr.blockId1() << 16) |  (ftr.blockId2() << 8) | ftr.blockId3();
  }
42
 
43
}
David COME's avatar
David COME committed
44
45
46
47
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
48
  class MemBlock;
49
/**
50
51
52
 * 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?).
53
 */
54
class DiskWriteTask: public DataConsumer {
55
public:
56
57
  /**
   * Constructor
58
   * @param file: All we need to know about the file we  are recalling
59
60
   * @param mm: memory manager of the session
   */
61
62
  DiskWriteTask(cta::RetrieveJob *retrieveJob, RecallMemoryManager& mm);
  
63
  /**
64
   * Main routine: takes each memory block in the fifo and writes it to disk
65
   * @return true if the file has been successfully written false otherwise.
66
   */
67
  virtual bool execute(RecallReportPacker& reporter,log::LogContext& lc,
68
    diskFile::DiskFileFactory & fileFactory, RecallWatchDog & watchdog) ;
69
70
  
  /**
71
   * Allows client code to return a reusable memory block. Should not been called
72
73
   * @return the pointer to the memory block that can be reused
   */
74
  virtual MemBlock *getFreeBlock() ;
75
76
77
78
79
  
  /**
   * Function used to enqueue a new memory block holding data to be written to disk
   * @param mb: corresponding memory block
   */
80
  virtual void pushDataBlock(MemBlock *mb);
81

82
83
84
  /**
   * Destructor (also waiting for the end of the write operation)
   */
85
  virtual ~DiskWriteTask();
86
  
87
88
89
90
91
92
  /**
   * Return the stats of the tasks. Should be call after execute 
   * (otherwise, it is pointless)
   * @return 
   */
  const DiskStats getTaskStats() const;
93
private:
94
95
96
97
98
99
  
  /**
   * Stats to measue how long it takes to write on disk
   */
  DiskStats m_stats;
  
100
101
102
103
104
105
106
107
108
  /**
   * This function will check the consistency of the mem block and 
   * throw exception is something goes wrong
   * @param mb The mem block to check
   * @param blockId The block id the mem blopck should be at
   * @param lc FOr logging
   */
  void checkErrors(MemBlock* mb,int blockId,castor::log::LogContext& lc);
  
109
110
111
112
  /**
   * In case of error, it will spin on the blocks until we reach the end
   * in order to push them back into the memory manager
   */
113
  void releaseAllBlock();
114
  
115
  /**
116
   * The fifo containing the memory blocks holding data to be written to disk
117
   */
118
  castor::server::BlockingQueue<MemBlock *> m_fifo;
119
  
120
121
122
  /** 
   * All we need to know about the file we are currently recalling
   */
123
  std::unique_ptr<cta::RetrieveJob> m_retrieveJob;
124
    
125
  /**
126
   * Reference to the Memory Manager in use
127
   */
128
  RecallMemoryManager & m_memManager;
129
130
  
  /**
131
   * Mutex forcing serial access to the fifo
132
   */
133
  castor::server::Mutex m_producerProtection;
134
  
135
136
137
138
139
140
141
  /**
   * log into lc all m_stats parameters with the given message at the 
   * given level
   * @param level
   * @param message
   */
  void logWithStat(int level,const std::string& msg,log::LogContext& lc) ;
142
};
David COME's avatar
David COME committed
143
144

}}}}