RecallReportPacker.cpp 13.7 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"
Victor Kotlyar's avatar
Victor Kotlyar committed
26
#include "common/log/Logger.hpp"
27

28
#include <signal.h>
29
#include <iostream>
30

31
namespace{
32
  struct failedReportRecallResult : public cta::exception::Exception{
33
34
35
36
    failedReportRecallResult(const std::string& s): Exception(s){}
  };
}

Victor Kotlyar's avatar
Victor Kotlyar committed
37
38
using cta::log::LogContext;
using cta::log::Param;
David COME's avatar
David COME committed
39

40
41
42
43
namespace castor {
namespace tape {
namespace tapeserver {
namespace daemon {
44
45
46
//------------------------------------------------------------------------------
//Constructor
//------------------------------------------------------------------------------
Victor Kotlyar's avatar
Victor Kotlyar committed
47
RecallReportPacker::RecallReportPacker(cta::RetrieveMount *retrieveMount, cta::log::LogContext lc):
48
49
50
51
  ReportPackerInterface<detail::Recall>(lc),
  m_workerThread(*this), m_errorHappened(false), m_retrieveMount(retrieveMount),
  m_tapeThreadComplete(false), m_diskThreadComplete(false)
{
52
  
53
}
54
55
56
//------------------------------------------------------------------------------
//Destructor
//------------------------------------------------------------------------------
57
RecallReportPacker::~RecallReportPacker(){
58
  cta::threading::MutexLocker ml(m_producterProtection);
59
}
60
61
62
//------------------------------------------------------------------------------
//reportCompletedJob
//------------------------------------------------------------------------------
63
64
void RecallReportPacker::reportCompletedJob(std::unique_ptr<cta::RetrieveJob> successfulRetrieveJob){
  std::unique_ptr<Report> rep(new ReportSuccessful(std::move(successfulRetrieveJob)));
65
  cta::threading::MutexLocker ml(m_producterProtection);
66
67
  m_fifo.push(rep.release());
}
68
69
70
//------------------------------------------------------------------------------
//reportFailedJob
//------------------------------------------------------------------------------  
71
72
void RecallReportPacker::reportFailedJob(std::unique_ptr<cta::RetrieveJob> failedRetrieveJob){
  std::unique_ptr<Report> rep(new ReportError(std::move(failedRetrieveJob)));
73
  cta::threading::MutexLocker ml(m_producterProtection);
74
75
  m_fifo.push(rep.release());
}
76
77
78
//------------------------------------------------------------------------------
//reportEndOfSession
//------------------------------------------------------------------------------
79
void RecallReportPacker::reportEndOfSession(){
80
  cta::threading::MutexLocker ml(m_producterProtection);
81
82
  m_fifo.push(new ReportEndofSession());
}
83
84

//------------------------------------------------------------------------------
Daniele Kruse's avatar
Daniele Kruse committed
85
//reportDriveStatus
86
//------------------------------------------------------------------------------
87
void RecallReportPacker::reportDriveStatus(cta::common::dataStructures::DriveStatus status) {
88
  cta::threading::MutexLocker ml(m_producterProtection);
Daniele Kruse's avatar
Daniele Kruse committed
89
  m_fifo.push(new ReportDriveStatus(status));
90
91
}

92
  
93
94
95
//------------------------------------------------------------------------------
//reportEndOfSessionWithErrors
//------------------------------------------------------------------------------
96
void RecallReportPacker::reportEndOfSessionWithErrors(const std::string msg,int error_code){
97
  cta::threading::MutexLocker ml(m_producterProtection);
98
99
  m_fifo.push(new ReportEndofSessionWithErrors(msg,error_code));
}
100

101
102
103
104
105
  
//------------------------------------------------------------------------------
//reportTestGoingToEnd
//------------------------------------------------------------------------------
void RecallReportPacker::reportTestGoingToEnd(){
106
  cta::threading::MutexLocker ml(m_producterProtection);
107
108
109
  m_fifo.push(new ReportTestGoingToEnd());
}

110
111
//------------------------------------------------------------------------------
//ReportSuccessful::execute
112
//------------------------------------------------------------------------------
113
void RecallReportPacker::ReportSuccessful::execute(RecallReportPacker& parent){
114
  m_successfulRetrieveJob->complete();
115
}
116

117
118
119
//------------------------------------------------------------------------------
//ReportEndofSession::execute
//------------------------------------------------------------------------------
120
void RecallReportPacker::ReportEndofSession::execute(RecallReportPacker& parent){
121
  if(!parent.errorHappened()){
Victor Kotlyar's avatar
Victor Kotlyar committed
122
    parent.m_lc.log(cta::log::INFO,"Nominal RecallReportPacker::EndofSession has been reported");
123
    if (parent.m_watchdog) {
Victor Kotlyar's avatar
Victor Kotlyar committed
124
      parent.m_watchdog->addParameter(cta::log::Param("status","success"));
125
126
127
128
      // 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);
129
    }
130
131
132
  }
  else {
    const std::string& msg ="RecallReportPacker::EndofSession has been reported  but an error happened somewhere in the process";
Victor Kotlyar's avatar
Victor Kotlyar committed
133
    parent.m_lc.log(cta::log::ERR,msg);
134
    if (parent.m_watchdog) {
Victor Kotlyar's avatar
Victor Kotlyar committed
135
      parent.m_watchdog->addParameter(cta::log::Param("status","failure"));
136
137
138
139
      // 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);
140
    }
141
142
143
144
145
146
  }
}

//------------------------------------------------------------------------------
//ReportEndofSession::goingToEnd
//------------------------------------------------------------------------------
147
bool RecallReportPacker::ReportEndofSession::goingToEnd() {
148
  return true;
149
}
150

Daniele Kruse's avatar
Daniele Kruse committed
151
152
153
154
155
//------------------------------------------------------------------------------
//ReportDriveStatus::execute
//------------------------------------------------------------------------------
void RecallReportPacker::ReportDriveStatus::execute(RecallReportPacker& parent){
  parent.m_retrieveMount->setDriveStatus(m_status);
156
  if(m_status==cta::common::dataStructures::DriveStatus::Unmounting) {
157
158
159
    parent.m_retrieveMount->diskComplete();
    parent.m_retrieveMount->tapeComplete();
  }
Daniele Kruse's avatar
Daniele Kruse committed
160
161
162
163
164
}

//------------------------------------------------------------------------------
//ReportDriveStatus::goingToEnd
//------------------------------------------------------------------------------
165
bool RecallReportPacker::ReportDriveStatus::goingToEnd() {
Daniele Kruse's avatar
Daniele Kruse committed
166
167
168
  return false;
}

169
170
171
//------------------------------------------------------------------------------
//ReportEndofSessionWithErrors::execute
//------------------------------------------------------------------------------
172
173
void RecallReportPacker::ReportEndofSessionWithErrors::execute(RecallReportPacker& parent){
  if(parent.m_errorHappened) {
174
    LogContext::ScopedParam(parent.m_lc,Param("errorCode",m_error_code));
Victor Kotlyar's avatar
Victor Kotlyar committed
175
    parent.m_lc.log(cta::log::ERR,m_message);
176
177
  }
  else{
178
    const std::string& msg ="RecallReportPacker::EndofSessionWithErrors has been reported  but NO error was detected during the process";
Victor Kotlyar's avatar
Victor Kotlyar committed
179
    parent.m_lc.log(cta::log::ERR,msg);
180
  }
181
  if (parent.m_watchdog) {
Victor Kotlyar's avatar
Victor Kotlyar committed
182
    parent.m_watchdog->addParameter(cta::log::Param("status","failure"));
183
184
185
186
    // 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);
187
  }
188
}
189
190
191
192

//------------------------------------------------------------------------------
//ReportEndofSessionWithErrors::goingToEnd
//------------------------------------------------------------------------------
193
bool RecallReportPacker::ReportEndofSessionWithErrors::goingToEnd() {
194
  return true;
195
196
}

197
198
199
//------------------------------------------------------------------------------
//ReportError::execute
//------------------------------------------------------------------------------
200
201
void RecallReportPacker::ReportError::execute(RecallReportPacker& parent){
  parent.m_errorHappened=true;
Victor Kotlyar's avatar
Victor Kotlyar committed
202
  parent.m_lc.log(cta::log::ERR,m_failedRetrieveJob->failureMessage);
203
  m_failedRetrieveJob->failed();
204
}
205

206
//------------------------------------------------------------------------------
207
208
//WorkerThread::WorkerThread
//------------------------------------------------------------------------------
209
210
211
RecallReportPacker::WorkerThread::WorkerThread(RecallReportPacker& parent):
m_parent(parent) {
}
212
213
214
//------------------------------------------------------------------------------
//WorkerThread::run
//------------------------------------------------------------------------------
215
void RecallReportPacker::WorkerThread::run(){
216
  m_parent.m_lc.pushOrReplace(Param("thread", "RecallReportPacker"));
Victor Kotlyar's avatar
Victor Kotlyar committed
217
  m_parent.m_lc.log(cta::log::DEBUG, "Starting RecallReportPacker thread");
218
  bool endFound = false;
219
220
221
222
223
224
  while(1) {
    std::string debugType;
    std::unique_ptr<Report> rep(m_parent.m_fifo.pop());
    {
      cta::log::ScopedParamContainer spc(m_parent.m_lc);
      spc.add("ReportType", debugType=typeid(*rep).name());
225
      if (rep->goingToEnd())
226
227
        spc.add("goingToEnd", "true");
      m_parent.m_lc.log(cta::log::DEBUG, "Popping report");
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
257
258
259
260
261
262
263
264
265
266
    // Record whether we found end before calling the potentially exception
    // throwing execute().)
    if (rep->goingToEnd())
      endFound=true;
    // We can afford to see any report to fail and keep passing the following ones
    // as opposed to migrations where one failure fails the session.
    try {
      rep->execute(m_parent);
    } 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
      cta::log::ScopedParamContainer params(m_parent.m_lc);
      params.add("exceptionWhat", e.getMessageValue())
            .add("exceptionType", typeid(e).name());
      m_parent.m_lc.log(cta::log::ERR, "Tried to report and got a CTA exception.");
      if (m_parent.m_watchdog) {
        m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
        m_parent.m_watchdog->addParameter(cta::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
      cta::log::ScopedParamContainer params(m_parent.m_lc);
      params.add("exceptionWhat", e.what())
            .add("exceptionType", typeid(e).name());
      m_parent.m_lc.log(cta::log::ERR, "Tried to report and got a standard exception.");
      if (m_parent.m_watchdog) {
        m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
        m_parent.m_watchdog->addParameter(cta::log::Param("status","failure"));
      }
    } catch(...){
      //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
      m_parent.m_lc.log(cta::log::ERR, "Tried to report and got an unknown exception.");
      if (m_parent.m_watchdog) {
        m_parent.m_watchdog->addToErrorCount("Error_clientCommunication");
        m_parent.m_watchdog->addParameter(cta::log::Param("status","failure"));
      }
267
    }
268
    if (endFound) break;
269
  }
270
271
272
273
  // Drain the fifo in case we got an exception
  if (!endFound) {
    while (1) {
      std::unique_ptr<Report> report(m_parent.m_fifo.pop());
274
      if (report->goingToEnd())
275
276
277
        break;
    }
  }
278
279
280
  // Cross check that the queue is indeed empty.
  while (m_parent.m_fifo.size()) {
    // There is at least one extra report we missed.
Victor Kotlyar's avatar
Victor Kotlyar committed
281
    cta::log::ScopedParamContainer spc(m_parent.m_lc);
282
283
284
285
    std::unique_ptr<Report> missedReport(m_parent.m_fifo.pop());
    spc.add("ReportType", typeid(*missedReport).name());
    if (missedReport->goingToEnd())
      spc.add("goingToEnd", "true");
Victor Kotlyar's avatar
Victor Kotlyar committed
286
    m_parent.m_lc.log(cta::log::ERR, "Popping missed report (memory leak)");
287
  }
Victor Kotlyar's avatar
Victor Kotlyar committed
288
  m_parent.m_lc.log(cta::log::DEBUG, "Finishing RecallReportPacker thread");
289
}
290
291
292
293
294
295
296
297

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

298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
//------------------------------------------------------------------------------
//reportTapeDone()
//------------------------------------------------------------------------------
void RecallReportPacker::setTapeDone() {
  m_tapeThreadComplete = true;
}

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

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

319
}}}}