RecallReportPacker.cpp 13.2 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
/******************************************************************************
 *
 * 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
 *****************************************************************************/

#include "castor/tape/tapeserver/daemon/RecallReportPacker.hpp"
25
#include "castor/tape/tapeserver/daemon/TaskWatchDog.hpp"
26
#include "castor/log/Logger.hpp"
27
28
#include "log.h"
#include "serrno.h"
29

30
#include <signal.h>
31
#include <iostream>
32

33
namespace{
34
  struct failedReportRecallResult : public castor::exception::Exception{
35
36
37
38
    failedReportRecallResult(const std::string& s): Exception(s){}
  };
}

David COME's avatar
David COME committed
39
40
41
using castor::log::LogContext;
using castor::log::Param;

42
43
44
45
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
46
47
48
//------------------------------------------------------------------------------
//Constructor
//------------------------------------------------------------------------------
49
RecallReportPacker::RecallReportPacker(cta::RetrieveMount *retrieveMount, log::LogContext lc):
50
51
52
53
  ReportPackerInterface<detail::Recall>(lc),
  m_workerThread(*this), m_errorHappened(false), m_retrieveMount(retrieveMount),
  m_tapeThreadComplete(false), m_diskThreadComplete(false)
{
54
55

}
56
57
58
//------------------------------------------------------------------------------
//Destructor
//------------------------------------------------------------------------------
59
RecallReportPacker::~RecallReportPacker(){
60
  castor::server::MutexLocker ml(&m_producterProtection);
61
}
62
63
64
//------------------------------------------------------------------------------
//reportCompletedJob
//------------------------------------------------------------------------------
65
66
void RecallReportPacker::reportCompletedJob(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob){
  std::unique_ptr<Report> rep(new ReportSuccessful(std::move(successfulRetrieveJob)));
67
  castor::server::MutexLocker ml(&m_producterProtection);
68
69
  m_fifo.push(rep.release());
}
70
71
72
//------------------------------------------------------------------------------
//reportFailedJob
//------------------------------------------------------------------------------  
73
74
void RecallReportPacker::reportFailedJob(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob){
  std::unique_ptr<Report> rep(new ReportError(std::move(failedRetrieveJob)));
75
  castor::server::MutexLocker ml(&m_producterProtection);
76
77
  m_fifo.push(rep.release());
}
78
79
80
//------------------------------------------------------------------------------
//reportEndOfSession
//------------------------------------------------------------------------------
81
void RecallReportPacker::reportEndOfSession(){
82
  castor::server::MutexLocker ml(&m_producterProtection);
83
84
  m_fifo.push(new ReportEndofSession());
}
85
86

//------------------------------------------------------------------------------
Daniele Kruse's avatar
Daniele Kruse committed
87
//reportDriveStatus
88
//------------------------------------------------------------------------------
Daniele Kruse's avatar
Daniele Kruse committed
89
90
91
void RecallReportPacker::reportDriveStatus(cta::DriveStatus status) {
  castor::server::MutexLocker ml(&m_producterProtection);
  m_fifo.push(new ReportDriveStatus(status));
92
93
}

94
  
95
96
97
//------------------------------------------------------------------------------
//reportEndOfSessionWithErrors
//------------------------------------------------------------------------------
98
void RecallReportPacker::reportEndOfSessionWithErrors(const std::string msg,int error_code){
99
  castor::server::MutexLocker ml(&m_producterProtection);
100
101
  m_fifo.push(new ReportEndofSessionWithErrors(msg,error_code));
}
102

103
104
//------------------------------------------------------------------------------
//ReportSuccessful::execute
105
//------------------------------------------------------------------------------
106
void RecallReportPacker::ReportSuccessful::execute(RecallReportPacker& parent){
107
  m_successfulRetrieveJob->complete();
108
}
109

110
111
112
//------------------------------------------------------------------------------
//ReportEndofSession::execute
//------------------------------------------------------------------------------
113
void RecallReportPacker::ReportEndofSession::execute(RecallReportPacker& parent){
114
115
  if(!parent.errorHappened()){
    parent.m_retrieveMount->diskComplete();
116
    parent.m_retrieveMount->tapeComplete();
117
118
119
120
121
122
123
    parent.m_lc.log(LOG_INFO,"Nominal RecallReportPacker::EndofSession has been reported");
    if (parent.m_watchdog) {
      parent.m_watchdog->addParameter(log::Param("status","success"));
      // We have a race condition here between the processing of this message by
      // the initial process and the printing of the end-of-session log, triggered
      // by the end our process. To delay the latter, we sleep half a second here.
      usleep(500*1000);
124
    }
125
126
127
128
129
  }
  else {
    const std::string& msg ="RecallReportPacker::EndofSession has been reported  but an error happened somewhere in the process";
    parent.m_lc.log(LOG_ERR,msg);
    parent.m_retrieveMount->diskComplete();
130
    parent.m_retrieveMount->tapeComplete();
131
132
133
134
135
136
    if (parent.m_watchdog) {
      parent.m_watchdog->addParameter(log::Param("status","failure"));
      // We have a race condition here between the processing of this message by
      // the initial process and the printing of the end-of-session log, triggered
      // by the end our process. To delay the latter, we sleep half a second here.
      usleep(500*1000);
137
    }
138
139
140
141
142
143
144
145
  }
}

//------------------------------------------------------------------------------
//ReportEndofSession::goingToEnd
//------------------------------------------------------------------------------
bool RecallReportPacker::ReportEndofSession::goingToEnd(RecallReportPacker& packer) {
  return packer.allThreadsDone();
146
}
147

Daniele Kruse's avatar
Daniele Kruse committed
148
149
150
151
152
153
154
155
156
157
158
159
160
161
//------------------------------------------------------------------------------
//ReportDriveStatus::execute
//------------------------------------------------------------------------------
void RecallReportPacker::ReportDriveStatus::execute(RecallReportPacker& parent){
  parent.m_retrieveMount->setDriveStatus(m_status);
}

//------------------------------------------------------------------------------
//ReportDriveStatus::goingToEnd
//------------------------------------------------------------------------------
bool RecallReportPacker::ReportDriveStatus::goingToEnd(RecallReportPacker& packer) {
  return false;
}

162
163
164
//------------------------------------------------------------------------------
//ReportEndofSessionWithErrors::execute
//------------------------------------------------------------------------------
165
166
void RecallReportPacker::ReportEndofSessionWithErrors::execute(RecallReportPacker& parent){
  if(parent.m_errorHappened) {
167
    parent.m_retrieveMount->diskComplete();
168
    parent.m_retrieveMount->tapeComplete();
169
170
    LogContext::ScopedParam(parent.m_lc,Param("errorCode",m_error_code));
    parent.m_lc.log(LOG_ERR,m_message);
171
172
  }
  else{
173
174
175
176
    const std::string& msg ="RecallReportPacker::EndofSessionWithErrors has been reported  but NO error was detected during the process";
    parent.m_lc.log(LOG_ERR,msg);  
    parent.m_retrieveMount->diskComplete();
    parent.m_retrieveMount->tapeComplete();
177
  }
178
179
  if (parent.m_watchdog) {
    parent.m_watchdog->addParameter(log::Param("status","failure"));
180
181
182
183
    // We have a race condition here between the processing of this message by
    // the initial process and the printing of the end-of-session log, triggered
    // by the end our process. To delay the latter, we sleep half a second here.
    usleep(500*1000);
184
  }
185
}
186
187
188
189
190
191
192
193

//------------------------------------------------------------------------------
//ReportEndofSessionWithErrors::goingToEnd
//------------------------------------------------------------------------------
bool RecallReportPacker::ReportEndofSessionWithErrors::goingToEnd(RecallReportPacker& packer) {
  return packer.allThreadsDone();
}

194
195
196
//------------------------------------------------------------------------------
//ReportError::execute
//------------------------------------------------------------------------------
197
198
void RecallReportPacker::ReportError::execute(RecallReportPacker& parent){
  parent.m_errorHappened=true;
199
200
  parent.m_lc.log(LOG_ERR,m_failedRetrieveJob->failureMessage);
  m_failedRetrieveJob->failed();
201
}
202

203
//------------------------------------------------------------------------------
204
205
//WorkerThread::WorkerThread
//------------------------------------------------------------------------------
206
207
208
RecallReportPacker::WorkerThread::WorkerThread(RecallReportPacker& parent):
m_parent(parent) {
}
209
210
211
//------------------------------------------------------------------------------
//WorkerThread::run
//------------------------------------------------------------------------------
212
void RecallReportPacker::WorkerThread::run(){
213
214
  m_parent.m_lc.pushOrReplace(Param("thread", "RecallReportPacker"));
  m_parent.m_lc.log(LOG_DEBUG, "Starting RecallReportPacker thread");
215
  bool endFound = false;
216
  try{
217
    while(1) {    
Daniele Kruse's avatar
Daniele Kruse committed
218
      std::unique_ptr<Report> rep(m_parent.m_fifo.pop());
219
220
      rep->execute(m_parent);

221
      if(rep->goingToEnd(m_parent)) {
222
        endFound = true;
223
224
        break;
      }
225
    }
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
  } catch(const castor::exception::Exception& e){
    //we get there because to tried to close the connection and it failed
    //either from the catch a few lines above or directly from rep->execute
    std::stringstream ssEx;
    ssEx << "Tried to report and got a castor exception, cant do much more. The exception is the following: " << e.getMessageValue();
    m_parent.m_lc.log(LOG_ERR, ssEx.str());
    if (m_parent.m_watchdog) {
      m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
      m_parent.m_watchdog->addParameter(log::Param("status","failure"));
    }
  } catch(const cta::exception::Exception& e){
    //we get there because to tried to close the connection and it failed
    //either from the catch a few lines above or directly from rep->execute
    std::stringstream ssEx;
    ssEx << "Tried to report and got a CTA exception, cant do much more. The exception is the following: " << e.getMessageValue();
    m_parent.m_lc.log(LOG_ERR, ssEx.str());
    if (m_parent.m_watchdog) {
      m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
      m_parent.m_watchdog->addParameter(log::Param("status","failure"));
    }
  } catch(const std::exception& e){
    //we get there because to tried to close the connection and it failed
    //either from the catch a few lines above or directly from rep->execute
    std::stringstream ssEx;
    ssEx << "Tried to report and got a standard exception, cant do much more. The exception is the following: " << e.what();
    m_parent.m_lc.log(LOG_ERR, ssEx.str());
    if (m_parent.m_watchdog) {
      m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
      m_parent.m_watchdog->addParameter(log::Param("status","failure"));
    }
  } catch(...){
257
258
    //we get there because to tried to close the connection and it failed
    //either from the catch a few lines above or directly from rep->execute
259
260
261
    std::stringstream ssEx;
    ssEx << "Tried to report and got an unknown exception, cant do much more.";
    m_parent.m_lc.log(LOG_ERR, ssEx.str());
262
263
264
265
    if (m_parent.m_watchdog) {
      m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
      m_parent.m_watchdog->addParameter(log::Param("status","failure"));
    }
266
  }
267
268
269
270
  // Drain the fifo in case we got an exception
  if (!endFound) {
    while (1) {
      std::unique_ptr<Report> report(m_parent.m_fifo.pop());
271
      if (report->goingToEnd(m_parent))
272
273
274
        break;
    }
  }
275
  m_parent.m_lc.log(LOG_DEBUG, "Finishing RecallReportPacker thread");
276
}
277
278
279
280
281
282
283
284

//------------------------------------------------------------------------------
//errorHappened()
//------------------------------------------------------------------------------
bool RecallReportPacker::errorHappened() {
  return m_errorHappened || (m_watchdog && m_watchdog->errorHappened());
}

285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
//------------------------------------------------------------------------------
//reportTapeDone()
//------------------------------------------------------------------------------
void RecallReportPacker::setTapeDone() {
  m_tapeThreadComplete = true;
}

//------------------------------------------------------------------------------
//reportDiskDone()
//------------------------------------------------------------------------------
void RecallReportPacker::setDiskDone() {
  m_diskThreadComplete = true;
}

//------------------------------------------------------------------------------
//reportDiskDone()
//------------------------------------------------------------------------------
bool RecallReportPacker::allThreadsDone() {
  return m_tapeThreadComplete && m_diskThreadComplete;
}

306
}}}}