RecallReportPacker.hpp 7.19 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

#include "castor/tape/tapeserver/daemon/ReportPackerInterface.hpp"
Victor Kotlyar's avatar
Victor Kotlyar committed
27
#include "common/log/LogContext.hpp"
28
29
#include "common/threading/Threading.hpp"
#include "common/threading/BlockingQueue.hpp"
30
#include "scheduler/RetrieveJob.hpp"
31
#include "scheduler/RetrieveMount.hpp"
32

33
#include <memory>
34
35
// TODO: remove (RecallReportPacker::ReportDriveStatus allocation debug)
#include <iostream>
36

37
38
39
40
41
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
  
42
class RecallReportPacker : public ReportPackerInterface<detail::Recall> {
43
public:
44
45
  /**
   * Constructor
46
   * @param tg the client to whom we report the success/failures
47
48
   * @param lc log context, copied du to threads
   */
Victor Kotlyar's avatar
Victor Kotlyar committed
49
  RecallReportPacker(cta::RetrieveMount *retrieveMount, cta::log::LogContext lc);
50
  
51
  virtual ~RecallReportPacker();
52
  
53
 /**
54
55
56
   * Create into the MigrationReportPacker a report for the successful migration
   * of migratedFile
   * @param migratedFile the file successfully migrated
57
   * @param checksum the checksum the DWT has computed for the file 
58
   */
59
  virtual void reportCompletedJob(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob);
60
61
  
  /**
62
   * Create into the MigrationReportPacker a report for the failed migration
63
   * of migratedFile
64
   * @param migratedFile the file which failed 
65
   * @param ex the reason for the failure
66
   */
67
  virtual void reportFailedJob(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob);
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
  /**
   * Function for testing purposes. It is used to tell the report packer that this is the last report
   */
  virtual void reportTestGoingToEnd();
  
79
80
81
82
83
  /**
   * 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
   */
84
  virtual void reportEndOfSessionWithErrors(const std::string msg,int error_code); 
85
86
87
88
89
90
  
  /**
   * 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.
   */
91
  virtual void reportDriveStatus(cta::common::dataStructures::DriveStatus status);
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
  
  /**
   * 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();
108

109
110
111
  /**
   * Start the inner thread
   */
112
  void startThreads() { m_workerThread.start(); }
113
114
115
116
  
  /**
   * Stop the inner thread
   */
117
  void waitThread() { m_workerThread.wait(); }
118
  
119
120
121
122
123
  /**
   * Was there an error?
   */
  bool errorHappened();
  
124
private:
125
  //inner classes use to store content while receiving a report 
126
127
128
129
  class Report {
  public:
    virtual ~Report(){}
    virtual void execute(RecallReportPacker& packer)=0;
130
    virtual bool goingToEnd() {return false;}
131
132
133
134
  };
  class ReportTestGoingToEnd :  public Report {
  public:
    ReportTestGoingToEnd() {}
135
    void execute(RecallReportPacker& reportPacker) override {
136
137
    reportPacker.m_retrieveMount->diskComplete();
    reportPacker.m_retrieveMount->tapeComplete();}
138
    bool goingToEnd() override {return true;}
139
140
  };
  class ReportSuccessful :  public Report {
141
    /**
142
     * The successful retrieve job to be reported immediately
143
144
     */
    std::unique_ptr<cta::RetrieveJob> m_successfulRetrieveJob;
145
  public:
146
    ReportSuccessful(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob): 
147
    m_successfulRetrieveJob(std::move(successfulRetrieveJob)){}
148
    void execute(RecallReportPacker& reportPacker) override;
149
150
  };
  class ReportError : public Report {
151
152
153
154
    /**
     * The failed retrieve job to be reported immediately
     */
    std::unique_ptr<cta::RetrieveJob> m_failedRetrieveJob;
155
  public:
156
    ReportError(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob):
157
158
    m_failedRetrieveJob(std::move(failedRetrieveJob)) {
    }
159

160
    void execute(RecallReportPacker& reportPacker) override;
161
  };
162
  
163
  class ReportDriveStatus : public Report {
164
    cta::common::dataStructures::DriveStatus m_status;
165
    
166
  public:
167
168
169
170
    ReportDriveStatus(cta::common::dataStructures::DriveStatus status): m_status(status) {
      // TODO: remove when not needed (debug printf for intermittent memory leak in CI)
      std::cout << ">>>> Allocated a RecallReportPacker::ReportDriveStatus:" << std::hex << this << std::endl;
    }
171
172
    void execute(RecallReportPacker& reportPacker) override;
    bool goingToEnd() override;
173
174
175
176
    // TODO: remove when not needed (debug printf for intermittent memory leak in CI)
    virtual ~ReportDriveStatus() {  
      std::cout << "<<<< Deleted a RecallReportPacker::ReportDriveStatus:" << std::hex << this << std::endl;
    }
177
178
  };
  
179
180
  class ReportEndofSession : public Report {
  public:
181
    ReportEndofSession(){}
182
183
    void execute(RecallReportPacker& reportPacker) override;
    bool goingToEnd() override;
184

185
186
187
188
189
190
  };
  class ReportEndofSessionWithErrors : public Report {
    std::string m_message;
    int m_error_code;
  public:
    ReportEndofSessionWithErrors(std::string msg,int error_code):
191
    m_message(msg),m_error_code(error_code){}
192
  
193
194
    void execute(RecallReportPacker& reportPacker) override;
    bool goingToEnd() override;
195
196
  };
  
197
  class WorkerThread: public cta::threading::Thread {
198
199
200
    RecallReportPacker & m_parent;
  public:
    WorkerThread(RecallReportPacker& parent);
201
    void run() override;
202
203
  } m_workerThread;
  
204
  cta::threading::Mutex m_producterProtection;
205
206
207
208
  
  /** 
   * m_fifo is holding all the report waiting to be processed
   */
209
  cta::threading::BlockingQueue<Report*> m_fifo;
210
  
211
212
213
214
215
  /**
   * 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  
   */
216
  bool m_errorHappened;
217
218
219
220
221
  
  /**
   * The mount object used to send reports
   */
  cta::RetrieveMount * m_retrieveMount;
222
223
224
225
226
227
228
229
230
231
  
  /**
   * Tracking of the tape thread end
   */
  bool m_tapeThreadComplete;
  
  /**
   * Tracking of the disk thread end
   */
  bool m_diskThreadComplete;
232
233
234
235
236
};

}}}}