RecallReportPacker.hpp 6.23 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
29
#include "castor/server/Threading.hpp"
#include "castor/server/BlockingQueue.hpp"
30
#include "scheduler/RetrieveJob.hpp"
31
#include "scheduler/RetrieveMount.hpp"
32

33
34
#include <memory>

35
36
37
38
39
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  
40
class RecallReportPacker : public ReportPackerInterface<detail::Recall> {
41
public:
42
43
  /**
   * Constructor
44
   * @param tg the client to whom we report the success/failures
45
46
   * @param lc log context, copied du to threads
   */
47
  RecallReportPacker(cta::RetrieveMount *retrieveMount, 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(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob);
58
59
  
  /**
60
   * Create into the MigrationReportPacker a report for the failed migration
61
   * of migratedFile
62
   * @param migratedFile the file which failed 
63
   * @param ex the reason for the failure
64
   */
65
  virtual void reportFailedJob(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob);
66
67
68
69
       
  /**
   * Create into the MigrationReportPacker a report for the nominal end of session
   */
70
  virtual void reportEndOfSession();
71
72
73
74
75
76
  
  /**
   * 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
   */
77
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code); 
78
79
80
81
82
83
  
  /**
   * 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.
   */
Daniele Kruse's avatar
Daniele Kruse committed
84
  virtual void reportDriveStatus(cta::DriveStatus status);
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
  
  /**
   * Flag disk thread as done.
   */
  virtual void setDiskDone();
  
  /**
   * Flag tape thread as done. Set the drive status to draining if needed.
   */
  virtual void setTapeDone();
  
  /**
   * Query the status of disk and tape threads (are they both done?).
   * @return true if both tape and disk threads are done.
   */
  virtual bool allThreadsDone();
101

102
103
104
  /**
   * Start the inner thread
   */
105
  void startThreads() { m_workerThread.start(); }
106
107
108
109
  
  /**
   * Stop the inner thread
   */
110
  void waitThread() { m_workerThread.wait(); }
111
  
112
113
114
115
116
  /**
   * Was there an error?
   */
  bool errorHappened();
  
117
private:
118
  //inner classes use to store content while receiving a report 
119
120
121
122
  class Report {
  public:
    virtual ~Report(){}
    virtual void execute(RecallReportPacker& packer)=0;
123
    virtual bool goingToEnd(RecallReportPacker& packer) {return false;};
124
125
  };
  class ReportSuccessful :  public Report {
126
    /**
127
     * The successful retrieve job to be reported immediately
128
129
     */
    std::unique_ptr<cta::RetrieveJob> m_successfulRetrieveJob;
130
  public:
131
    ReportSuccessful(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob): 
132
    m_successfulRetrieveJob(std::move(successfulRetrieveJob)){}
133
    virtual void execute(RecallReportPacker& reportPacker);
134
135
  };
  class ReportError : public Report {
136
137
138
139
    /**
     * The failed retrieve job to be reported immediately
     */
    std::unique_ptr<cta::RetrieveJob> m_failedRetrieveJob;
140
  public:
141
    ReportError(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob):
142
143
    m_failedRetrieveJob(std::move(failedRetrieveJob)) {
    }
144

145
    virtual void execute(RecallReportPacker& reportPacker);
146
  };
147
  
148
149
150
151
  class ReportDriveStatus : public Report {
    cta::DriveStatus m_status;
  public:
    ReportDriveStatus(cta::DriveStatus status): m_status(status) {}
Daniele Kruse's avatar
Daniele Kruse committed
152
153
    virtual void execute(RecallReportPacker& reportPacker);
    virtual bool goingToEnd(RecallReportPacker& packer);
154
155
  };
  
156
157
  class ReportEndofSession : public Report {
  public:
158
    ReportEndofSession(){}
159
    virtual void execute(RecallReportPacker& reportPacker);
160
161
    virtual bool goingToEnd(RecallReportPacker& packer);

162
163
164
165
166
167
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
    int m_error_code;
  public:
    ReportEndofSessionWithErrors(std::string msg,int error_code):
168
    m_message(msg),m_error_code(error_code){}
169
  
170
    virtual void execute(RecallReportPacker& reportPacker);
171
    virtual bool goingToEnd(RecallReportPacker& packer);
172
173
  };
  
174
  class WorkerThread: public castor::server::Thread {
175
176
177
178
179
180
    RecallReportPacker & m_parent;
  public:
    WorkerThread(RecallReportPacker& parent);
    virtual void run();
  } m_workerThread;
  
181
  castor::server::Mutex m_producterProtection;
182
183
184
185
  
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
186
  castor::server::BlockingQueue<Report*> m_fifo;
187
  
188
189
190
191
192
  /**
   * 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  
   */
193
  bool m_errorHappened;
194
195
196
197
198
  
  /**
   * The mount object used to send reports
   */
  cta::RetrieveMount * m_retrieveMount;
199
200
201
202
203
204
205
206
207
208
  
  /**
   * Tracking of the tape thread end
   */
  bool m_tapeThreadComplete;
  
  /**
   * Tracking of the disk thread end
   */
  bool m_diskThreadComplete;
209
210
211
212
213
};

}}}}