MigrationReportPacker.hpp 9.42 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

26
#include "common/threading/BlockingQueue.hpp"
27
#include "castor/tape/tapeserver/daemon/ReportPackerInterface.hpp"
28
#include "castor/tape/tapeserver/drive/DriveInterface.hpp"
29
#include "scheduler/ArchiveMount.hpp"
30
#include "scheduler/ArchiveJob.hpp"
31
#include <list>
32
#include <memory>
33

34
35
36
37
38
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
 
39
class MigrationReportPacker : public ReportPackerInterface<detail::Migration> {
40
public:
41
42
43
44
  /**
   * @param tg The client who is asking for a migration of his files 
   * and to whom we have to report to the status of the operations.
   */
Victor Kotlyar's avatar
Victor Kotlyar committed
45
  MigrationReportPacker(cta::ArchiveMount *archiveMount, cta::log::LogContext&  lc);
46
  
47
48
  ~MigrationReportPacker();
    
49
50
51
52
  /**
   * Create into the MigrationReportPacker a report for the successful migration
   * of migratedFile
   * @param migratedFile the file successfully migrated
53
   * @param checksum the checksum we computed of the file we have just migrated
54
55
56
   * @param blockId The tape logical object ID of the first block of the header
   * of the file. This is 0 (instead of 1) for the first file on the tape (aka
   * fseq = 1).
57
   * @param lc log context provided by the calling thread.
58
   */
59
  virtual void reportCompletedJob(std::unique_ptr<cta::ArchiveJob> successfulArchiveJob, cta::log::LogContext & lc);
60
  
61
62
63
64
65
66
67
68
  /**
   * Create into the MigrationReportPacker a report for a skipped file. We left a placeholder on tape, so
   * writing can carry on, but this fSeq holds no data. In the mean time, the job has to count a failure.
   * @param skippedArchiveJob the failed file
   * @param ex the reason for the failure
   * @param lc log context provided by the calling thread.
   */
  virtual void reportSkippedJob(std::unique_ptr<cta::ArchiveJob> skippedArchiveJob, const std::string& failure, cta::log::LogContext & lc);
69
70
71
72
  /**
   * Create into the MigrationReportPacker a report for the failled migration
   * of migratedFile
   * @param migratedFile the file which failled 
73
74
   * @param ex the reason for the failure
   * @param lc log context provided by the calling thread.
75
   */
76
  virtual void reportFailedJob(std::unique_ptr<cta::ArchiveJob> failedArchiveJob, const cta::exception::Exception& ex, cta::log::LogContext & lc);
77
78
     
   /**
79
80
    * Create into the MigrationReportPacker a report for the signaling a flusing on tape
    * @param compressStats 
81
82
    * @param lc log context provided by the calling thread.
    *
83
    */
84
  virtual void reportFlush(drive::compressionStats compressStats, cta::log::LogContext & lc);
85
86
87
  
  /**
   * Create into the MigrationReportPacker a report of reaching the end of the tape.
88
   * @param lc log context provided by the calling thread.
89
   */
90
  virtual void reportTapeFull(cta::log::LogContext & lc);
Daniele Kruse's avatar
Daniele Kruse committed
91
92
93
94
95
  
  /**
   * Report the drive state and set it in the central drive register. This
   * function is to be used by the tape thread when running.
   * @param state the new drive state.
96
   * @param lc log context provided by the calling thread.
Daniele Kruse's avatar
Daniele Kruse committed
97
   */
98
  virtual void reportDriveStatus(cta::common::dataStructures::DriveStatus status, cta::log::LogContext & lc);
99
100
101
  
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
102
   * @param lc log context provided by the calling thread.
103
   */
104
  virtual void reportEndOfSession(cta::log::LogContext & lc);
105
  
106
107
  /**
   * Function for testing purposes. It is used to tell the report packer that this is the last report
108
   * @param lc log context provided by the calling thread.
109
   */
110
  virtual void reportTestGoingToEnd(cta::log::LogContext & lc);
111
  
112
113
114
115
  /**
   * Create into the MigrationReportPacker a report for an erroneous end of session
   * @param msg The error message 
   * @param error_code The error code given by the drive
116
   * @param lc log context provided by the calling thread.
117
   */
118
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code, cta::log::LogContext & lc);
119

120
121
122
123
  /**
   * Immediately report the end of session to the client.
   * @param msg The error message 
   * @param error_code The error code given by the drive
124
   * @param lc log context provided by the calling thread.
125
   */
126
  virtual void synchronousReportEndWithErrors(const std::string msg,int error_code, cta::log::LogContext & lc);
127
  
128
129
  void startThreads() { m_workerThread.start(); }
  void waitThread() { m_workerThread.wait(); }
130
  
131
132
133
private:
  class Report {
  public:
134
135
    virtual ~Report(){}
    virtual void execute(MigrationReportPacker& packer)=0;
136
  };
137
  class ReportSuccessful :  public Report {
138
139
140
141
    /**
     * The successful archive job to be pushed in the report packer queue and reported later
     */
    std::unique_ptr<cta::ArchiveJob> m_successfulArchiveJob;
142
  public:
143
144
    ReportSuccessful(std::unique_ptr<cta::ArchiveJob> successfulArchiveJob): 
    m_successfulArchiveJob(std::move(successfulArchiveJob)) {}
145
    void execute(MigrationReportPacker& reportPacker) override;
146
  };
147
148
149
150
151
152
153
154
155
156
157
158
159
  
  class ReportSkipped : public Report{
    const std::string m_failureLog;
    /**
     * The failed archive job we skipped
     */
    std::unique_ptr<cta::ArchiveJob> m_skippedArchiveJob;
  public:
    ReportSkipped(std::unique_ptr<cta::ArchiveJob> skippedArchiveJob, std::string &failureLog):
    m_failureLog(failureLog), m_skippedArchiveJob(std::move(skippedArchiveJob)) {}
    void execute(MigrationReportPacker& reportPacker) override;
  };
  
160
161
162
  class ReportTestGoingToEnd :  public Report {
  public:
    ReportTestGoingToEnd() {}
163
    virtual void execute(MigrationReportPacker& reportPacker) override {
164
165
166
      reportPacker.m_continue=false;
      reportPacker.m_lc.log(cta::log::DEBUG, "In MigrationReportPacker::ReportTestGoingToEnd::execute(): Reporting session complete.");
      reportPacker.m_archiveMount->complete();
167
    }
168
  };
Daniele Kruse's avatar
Daniele Kruse committed
169
170
  
  class ReportDriveStatus : public Report {
171
    cta::common::dataStructures::DriveStatus m_status;
Daniele Kruse's avatar
Daniele Kruse committed
172
  public:
173
    ReportDriveStatus(cta::common::dataStructures::DriveStatus status): m_status(status) {}
174
    void execute(MigrationReportPacker& reportPacker) override;
Daniele Kruse's avatar
Daniele Kruse committed
175
176
  };
  
177
  class ReportFlush : public Report {
178
    drive::compressionStats m_compressStats;
179
    
180
    public:
181
182
183
184
185
    /* We only can compute the compressed size once we have flushed on the drive
     * We can get from the drive the number of byte it really wrote to tape
     * @param nbByte the number of byte it really wrote to tape between 
     * this flush and the previous one
     *  */
186
      ReportFlush(drive::compressionStats compressStats):m_compressStats(compressStats){}
187
      
188
      void execute(MigrationReportPacker& reportPacker) override;
189
  };
190
191
192
  class ReportTapeFull: public Report {
    public:
      ReportTapeFull() {}
193
      void execute(MigrationReportPacker& reportPacker) override;
194
  };
195
  class ReportError : public Report {
196
    const std::string m_failureLog;
197
198
199
200
201
    
    /**
     * The failed archive job to be reported immediately
     */
    std::unique_ptr<cta::ArchiveJob> m_failedArchiveJob;
202
  public:
203
204
    ReportError(std::unique_ptr<cta::ArchiveJob> failedArchiveJob, std::string &failureLog):
    m_failureLog(failureLog), m_failedArchiveJob(std::move(failedArchiveJob)){}
205
    
206
    void execute(MigrationReportPacker& reportPacker) override;
207
  };
208
  class ReportEndofSession : public Report {
209
  public:
210
    virtual void execute(MigrationReportPacker& reportPacker) override;
211
212
213
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
214
    int m_errorCode;
215
  public:
216
217
    ReportEndofSessionWithErrors(std::string msg,int errorCode):
    m_message(msg),m_errorCode(errorCode){}
218
    
219
    void execute(MigrationReportPacker& reportPacker) override;
220
221
  };
  
222
  class WorkerThread: public cta::threading::Thread {
223
    MigrationReportPacker & m_parent;
224
225
226
  public:
    WorkerThread(MigrationReportPacker& parent);
    virtual void run();
227
  } m_workerThread;
228
  
229
230
231
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
232
  cta::threading::BlockingQueue<Report*> m_fifo;
233

234
  
235
  cta::threading::Mutex m_producterProtection;
236
237
238
239
240
241
242
  
  /** 
   * Sanity check variable to register if an error has happened 
   * Is set at true as soon as a ReportError has been processed.
   */
  bool m_errorHappened;
  
243
244
245
  /* bool to keep the inner thread running. Is set at false 
   * when a end of session (with error) is called
   */
246
  bool m_continue;
247
248
249
250
251
252
253
254
255
256
  
  /**
   * The mount object used to send reports
   */
  cta::ArchiveMount * m_archiveMount;
  
  /**
   * The successful archive jobs to be reported when flushing
   */
  std::queue<std::unique_ptr<cta::ArchiveJob> > m_successfulArchiveJobs;
257
};
258
259

}}}}