MigrationReportPacker.hpp 7.49 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 "castor/server/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.
   */
45
  MigrationReportPacker(cta::ArchiveMount *archiveMount, 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
   */
58
  virtual void reportCompletedJob(std::unique_ptr<cta::ArchiveJob> successfulArchiveJob);
59
60
61
62
63
  
  /**
   * Create into the MigrationReportPacker a report for the failled migration
   * of migratedFile
   * @param migratedFile the file which failled 
64
   * @param ex the reason for the failure 
65
   */
66
  virtual void reportFailedJob(std::unique_ptr<cta::ArchiveJob> failedArchiveJob, const castor::exception::Exception& ex);
67
68
     
   /**
69
70
71
72
    * Create into the MigrationReportPacker a report for the signaling a flusing on tape
    * @param compressStats 
    * 
    */
73
74
75
76
77
78
  virtual void reportFlush(drive::compressionStats compressStats);
  
  /**
   * Create into the MigrationReportPacker a report of reaching the end of the tape.
   */
  virtual void reportTapeFull();
Daniele Kruse's avatar
Daniele Kruse committed
79
80
81
82
83
84
  
  /**
   * 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.
   */
85
  virtual void reportDriveStatus(cta::common::DriveStatus status);
86
87
88
89
  
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
   */
90
  virtual void reportEndOfSession();
91
  
92
93
94
95
96
  /**
   * Function for testing purposes. It is used to tell the report packer that this is the last report
   */
  virtual void reportTestGoingToEnd();
  
97
98
99
100
101
  /**
   * 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
   */
102
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code);
103

104
105
106
107
108
  /**
   * Immediately report the end of session to the client.
   * @param msg The error message 
   * @param error_code The error code given by the drive
   */
109
  virtual void synchronousReportEndWithErrors(const std::string msg,int error_code);
110
  
111
112
  void startThreads() { m_workerThread.start(); }
  void waitThread() { m_workerThread.wait(); }
113
  
114
115
116
private:
  class Report {
  public:
117
118
    virtual ~Report(){}
    virtual void execute(MigrationReportPacker& packer)=0;
119
  };
120
  class ReportSuccessful :  public Report {
121
122
123
124
    /**
     * The successful archive job to be pushed in the report packer queue and reported later
     */
    std::unique_ptr<cta::ArchiveJob> m_successfulArchiveJob;
125
  public:
126
127
    ReportSuccessful(std::unique_ptr<cta::ArchiveJob> successfulArchiveJob): 
    m_successfulArchiveJob(std::move(successfulArchiveJob)) {}
128
    virtual void execute(MigrationReportPacker& reportPacker);
129
  };
130
131
132
  class ReportTestGoingToEnd :  public Report {
  public:
    ReportTestGoingToEnd() {}
133
    virtual void execute(MigrationReportPacker& reportPacker) {reportPacker.m_continue=false;reportPacker.m_archiveMount->complete();}
134
  };
Daniele Kruse's avatar
Daniele Kruse committed
135
136
  
  class ReportDriveStatus : public Report {
137
    cta::common::DriveStatus m_status;
Daniele Kruse's avatar
Daniele Kruse committed
138
  public:
139
    ReportDriveStatus(cta::common::DriveStatus status): m_status(status) {}
Daniele Kruse's avatar
Daniele Kruse committed
140
141
142
    virtual void execute(MigrationReportPacker& reportPacker);
  };
  
143
  class ReportFlush : public Report {
144
    drive::compressionStats m_compressStats;
145
    
146
    public:
147
148
149
150
151
    /* 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
     *  */
152
      ReportFlush(drive::compressionStats compressStats):m_compressStats(compressStats){}
153
      
154
      void execute(MigrationReportPacker& reportPacker);
155
  };
156
157
158
159
160
  class ReportTapeFull: public Report {
    public:
      ReportTapeFull() {}
      void execute(MigrationReportPacker& reportPacker);
  };
161
  class ReportError : public Report {
162
    const castor::exception::Exception m_ex;
163
164
165
166
167
    
    /**
     * The failed archive job to be reported immediately
     */
    std::unique_ptr<cta::ArchiveJob> m_failedArchiveJob;
168
  public:
169
170
    ReportError(std::unique_ptr<cta::ArchiveJob> failedArchiveJob, const castor::exception::Exception &ex):
    m_ex(ex), m_failedArchiveJob(std::move(failedArchiveJob)){}
171
    
172
    virtual void execute(MigrationReportPacker& reportPacker);
173
  };
174
  class ReportEndofSession : public Report {
175
  public:
176
    virtual void execute(MigrationReportPacker& reportPacker);
177
178
179
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
180
    int m_errorCode;
181
  public:
182
183
    ReportEndofSessionWithErrors(std::string msg,int errorCode):
    m_message(msg),m_errorCode(errorCode){}
184
    
185
    virtual void execute(MigrationReportPacker& reportPacker);
186
187
  };
  
188
  class WorkerThread: public castor::server::Thread {
189
    MigrationReportPacker & m_parent;
190
191
192
  public:
    WorkerThread(MigrationReportPacker& parent);
    virtual void run();
193
  } m_workerThread;
194
  
195
196
197
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
198
  castor::server::BlockingQueue<Report*> m_fifo;
199

200

201
  castor::server::Mutex m_producterProtection;
202
203
204
205
206
207
208
  
  /** 
   * 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;
  
209
210
211
  /* bool to keep the inner thread running. Is set at false 
   * when a end of session (with error) is called
   */
212
  bool m_continue;
213
214
215
216
217
218
219
220
221
222
  
  /**
   * 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;
223
};
224
225

}}}}