RecallReportPacker.hpp 5.94 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
/******************************************************************************
 *
 * 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
 *****************************************************************************/

24
#pragma once
25
26
27

#include "castor/tape/tapeserver/daemon/ReportPackerInterface.hpp"
#include "castor/log/LogContext.hpp"
28
#include "castor/tape/tapeserver/client/ClientInterface.hpp"
29
30
#include "castor/server/Threading.hpp"
#include "castor/server/BlockingQueue.hpp"
31
#include "scheduler/RetrieveMount.hpp"
32
33
34
35
36
37

namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  
38
class RecallReportPacker : public ReportPackerInterface<detail::Recall> {
39
public:
40
41
42
43
44
45
  /**
   * Constructor
   * @param tg the client to whom we report the success/failures 
   * @param reportFilePeriod how often  do we report to the client
   * @param lc log context, copied du to threads
   */
46
  RecallReportPacker(cta::RetrieveMount *retrieveMount, unsigned int reportFilePeriod, 
47
    log::LogContext lc);
48
  
49
  virtual ~RecallReportPacker();
50
  
51
 /**
52
53
54
   * Create into the MigrationReportPacker a report for the successful migration
   * of migratedFile
   * @param migratedFile the file successfully migrated
55
   * @param checksum the checksum the DWT has computed for the file 
56
   */
57
  virtual void reportCompletedJob(const FileStruct& recalledFile,
58
  u_int32_t checksum, u_int64_t size);
59
60
  
  /**
61
   * Create into the MigrationReportPacker a report for the failed migration
62
   * of migratedFile
63
   * @param migratedFile the file which failed 
64
65
   * @param msg the message error with the failure 
   * @param error_code the error code with the failure 
66
   */
67
  virtual void reportFailedJob(const FileStruct & recalledFile,const std::string& msg,int error_code);
68
69
70
71
       
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
   */
72
  virtual void reportEndOfSession();
73
74
75
76
77
78
  
  /**
   * 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
   */
79
80
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code); 

81
82
83
  /**
   * Start the inner thread
   */
84
  void startThreads() { m_workerThread.start(); }
85
86
87
88
  
  /**
   * Stop the inner thread
   */
89
  void waitThread() { m_workerThread.wait(); }
90
  
91
92
93
94
95
  /**
   * Was there an error?
   */
  bool errorHappened();
  
96
private:
97
  //inner classes use to store content while receiving a report 
98
  class Report {
99
    const bool m_endNear;
100
  public:
101
    Report(bool b):m_endNear(b){}
102
103
    virtual ~Report(){}
    virtual void execute(RecallReportPacker& packer)=0;
104
    bool goingToEnd() const {return m_endNear;};
105
106
  };
  class ReportSuccessful :  public Report {
107
    const FileStruct m_recalledFile;
108
109
    u_int32_t m_checksum;
    u_int64_t m_size;
110
111
112
113
114
    
    /**
     * The successful retrieve job to be pushed in the report packer queue and reported later
     */
    std::unique_ptr<cta::RetrieveJob> m_successfulRetrieveJob;
115
  public:
116
117
118
    ReportSuccessful(const FileStruct& file,u_int32_t checksum,
      u_int64_t size): 
    Report(false),m_recalledFile(file),m_checksum(checksum),m_size(size){}
119
    virtual void execute(RecallReportPacker& reportPacker);
120
121
  };
  class ReportError : public Report {
122
    const FileStruct m_recalledFile;
123
124
    const std::string m_error_msg;
    const int m_error_code;
125
126
127
128
129
    
    /**
     * The failed retrieve job to be reported immediately
     */
    std::unique_ptr<cta::RetrieveJob> m_failedRetrieveJob;
130
131
  public:
    ReportError(const FileStruct& file,std::string msg,int error_code):
132
    Report(false),m_recalledFile(file),m_error_msg(msg),m_error_code(error_code){}
133

134
    virtual void execute(RecallReportPacker& reportPacker);
135
  };
136
  
137
138
  class ReportEndofSession : public Report {
  public:
139
    ReportEndofSession():Report(true){}
140
    virtual void execute(RecallReportPacker& reportPacker);
141
142
143
144
145
146
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
    int m_error_code;
  public:
    ReportEndofSessionWithErrors(std::string msg,int error_code):
147
    Report(true),m_message(msg),m_error_code(error_code){}
148
  
149
    virtual void execute(RecallReportPacker& reportPacker);
150
151
  };
  
152
  class WorkerThread: public castor::server::Thread {
153
154
155
156
157
158
    RecallReportPacker & m_parent;
  public:
    WorkerThread(RecallReportPacker& parent);
    virtual void run();
  } m_workerThread;
  
159
160
161
  /**
   * Function periodically called to report the results to the client
   */
162
163
  void flush();
  
164
  castor::server::Mutex m_producterProtection;
165
166
167
168
  
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
169
  castor::server::BlockingQueue<Report*> m_fifo;
170
  
171
172
173
  /**
   How often do we report to the client
   */
174
  unsigned int m_reportFilePeriod;
175
176
177
178
179
180
  
  /**
   * Is set as true as soon as we process a reportFailedJob
   * That we can do a sanity check to make sure we always call 
   * the right end of the session  
   */
181
  bool m_errorHappened;
182
183
184
185
186
187
188
189
190
191
  
  /**
   * The mount object used to send reports
   */
  cta::RetrieveMount * m_retrieveMount;
  
  /**
   * The successful retrieve jobs to be reported when flushing
   */
  std::queue<std::unique_ptr<cta::RetrieveJob> > m_successfulRetrieveJobs;
192
193
194
195
196
};

}}}}