MigrationReportPacker.hpp 7.67 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/client/ClientInterface.hpp"
28
#include "castor/tape/tapegateway/FileToMigrateStruct.hpp"
29
#include "castor/tape/tapeserver/daemon/ReportPackerInterface.hpp"
30
#include "castor/tape/tapeserver/drive/DriveInterface.hpp"
31
#include "scheduler/ArchiveMount.hpp"
32
#include <list>
33
#include <memory>
34

35
36
37
38
39
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
 
40
class MigrationReportPacker : public ReportPackerInterface<detail::Migration> {
41
public:
42
43
44
45
  /**
   * @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.
   */
46
  MigrationReportPacker(cta::ArchiveMount *archiveMount, log::LogContext lc);
47
  
48
49
  ~MigrationReportPacker();
    
50
51
52
53
  /**
   * Create into the MigrationReportPacker a report for the successful migration
   * of migratedFile
   * @param migratedFile the file successfully migrated
54
   * @param checksum the checksum we computed of the file we have just migrated
55
56
57
   * @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).
58
   */
David COME's avatar
David COME committed
59
  void reportCompletedJob(const tapegateway::FileToMigrateStruct& migratedFile,
60
  u_int32_t checksum, u_int32_t blockId);
61
62
63
64
65
  
  /**
   * Create into the MigrationReportPacker a report for the failled migration
   * of migratedFile
   * @param migratedFile the file which failled 
66
67
   * @param msg the error message to the failure 
   * @param error_code the error code related to the failure 
68
69
70
71
   */
  void reportFailedJob(const tapegateway::FileToMigrateStruct& migratedFile,const std::string& msg,int error_code);
     
   /**
72
73
74
75
    * Create into the MigrationReportPacker a report for the signaling a flusing on tape
    * @param compressStats 
    * 
    */
76
  void reportFlush(drive::compressionStats compressStats);
77
78
79
80
81
82
83
84
85
86
87
88
  
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
   */
  void reportEndOfSession();
  
  /**
   * 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
   */
  void reportEndOfSessionWithErrors(const std::string msg,int error_code);
89

90
91
92
93
94
95
96
  /**
   * Immediately report the end of session to the client.
   * @param msg The error message 
   * @param error_code The error code given by the drive
   */
  void synchronousReportEndWithErrors(const std::string msg,int error_code);
  
97
98
  void startThreads() { m_workerThread.start(); }
  void waitThread() { m_workerThread.wait(); }
99
  
100
101
102
private:
  class Report {
  public:
103
104
    virtual ~Report(){}
    virtual void execute(MigrationReportPacker& packer)=0;
105
106
107
108
109
110
111
  protected:
    /**
     * Utility function to be shared by both ReportEndofSession and
     * ReportEndofSessionWithErrors: if an error for a given file is 
     * recorded, we will transmit it to the client before signaling the
     * end of the session.
     */
112
    //virtual void reportFileErrors(MigrationReportPacker& reportPacker);
113
  };
114
  class ReportSuccessful :  public Report {
115
    const FileStruct m_migratedFile;
David COME's avatar
David COME committed
116
    const unsigned long m_checksum;
117
    const uint32_t m_blockId;
118
119
120
121
122
    
    /**
     * The successful archive job to be pushed in the report packer queue and reported later
     */
    std::unique_ptr<cta::ArchiveJob> m_successfulArchiveJob;
123
  public:
124
125
126
    ReportSuccessful(const FileStruct& file,unsigned long checksum,
            u_int32_t blockId): 
    m_migratedFile(file),m_checksum(checksum),m_blockId(blockId){}
127
    virtual void execute(MigrationReportPacker& reportPacker);
128
129
  };
  class ReportFlush : public Report {
130
    drive::compressionStats m_compressStats;
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
    
    /**
     * This function will approximate the compressed size of the files which 
     * have been migrated. The idea is to compute the average ration 
     * logicalSize/nbByteWritenWithCompression for the whole batch 
     * and apply that ratio to the whole set of files
     * We currently computing it only to the file that have been successfully 
     * migrated
     * @param beg Beginning of the upper class' successfulMigrations()
     * @param end End of upper class' successfulMigrations()
     */
    void computeCompressedSize(
    std::vector<tapegateway::FileMigratedNotificationStruct*>::iterator beg,
    std::vector<tapegateway::FileMigratedNotificationStruct*>::iterator end);
    
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
  class ReportError : public Report {
157
    const FileStruct m_migratedFile;
158
159
    const std::string m_error_msg;
    const int m_error_code;
160
161
162
163
164
    
    /**
     * The failed archive job to be reported immediately
     */
    std::unique_ptr<cta::ArchiveJob> m_failedArchiveJob;
165
  public:
166
    ReportError(const FileStruct& file,std::string msg,int error_code):
167
168
    m_migratedFile(file),m_error_msg(msg),m_error_code(error_code){}
    
169
    virtual void execute(MigrationReportPacker& reportPacker);
170
  };
171
  class ReportEndofSession : public Report {
172
  public:
173
    virtual void execute(MigrationReportPacker& reportPacker);
174
175
176
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
177
    int m_errorCode;
178
  public:
179
180
    ReportEndofSessionWithErrors(std::string msg,int errorCode):
    m_message(msg),m_errorCode(errorCode){}
181

182
    virtual void execute(MigrationReportPacker& reportPacker);
183
184
  };
  
185
  class WorkerThread: public castor::server::Thread {
186
    MigrationReportPacker & m_parent;
187
188
189
  public:
    WorkerThread(MigrationReportPacker& parent);
    virtual void run();
190
  } m_workerThread;
191
  
192
193
194
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
195
  castor::server::BlockingQueue<Report*> m_fifo;
196

197

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

}}}}