/
msgchan.c
557 lines (513 loc) · 17.6 KB
/
msgchan.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2009 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2013 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
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
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/*
* BAREOS Director -- msgchan.c -- handles the message channel
* to the Storage daemon and the File daemon.
*
* Kern Sibbald, August MM
*
* This routine runs as a thread and must be thread reentrant.
*
* Basic tasks done here:
* Open a message channel with the Storage daemon
* to authenticate ourself and to pass the JobId.
* Create a thread to interact with the Storage daemon
* who returns a job status and requests Catalog services, etc.
*/
#include "bareos.h"
#include "dird.h"
static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
/* Commands sent to Storage daemon */
static char jobcmd[] =
"JobId=%s job=%s job_name=%s client_name=%s "
"type=%d level=%d FileSet=%s NoAttr=%d SpoolAttr=%d FileSetMD5=%s "
"SpoolData=%d PreferMountedVols=%d SpoolSize=%s "
"rerunning=%d VolSessionId=%d VolSessionTime=%d Quota=%llu "
"Protocol=%d BackupFormat=%s DumpLevel=%d\n";
static char use_storage[] =
"use storage=%s media_type=%s pool_name=%s "
"pool_type=%s append=%d copy=%d stripe=%d\n";
static char use_device[] =
"use device=%s\n";
//static char query_device[] =
// "query device=%s";
/* Response from Storage daemon */
static char OKbootstrap[] =
"3000 OK bootstrap\n";
static char OK_job[] =
"3000 OK Job SDid=%d SDtime=%d Authorization=%100s\n";
static char OK_nextrun[] =
"3000 OK Job Authorization=%100s\n";
static char OK_device[] =
"3000 OK use device device=%s\n";
/* Storage Daemon requests */
static char Job_start[] =
"3010 Job %127s start\n";
static char Job_end[] =
"3099 Job %127s end JobStatus=%d JobFiles=%d JobBytes=%lld JobErrors=%u\n";
/* Forward referenced functions */
extern "C" void *msg_thread(void *arg);
/*
* Here we ask the SD to send us the info for a
* particular device resource.
*/
#ifdef xxx
bool update_device_res(JCR *jcr, DEVICERES *dev)
{
POOL_MEM device_name;
BSOCK *sd;
if (!connect_to_storage_daemon(jcr, 5, 30, false)) {
return false;
}
sd = jcr->store_bsock;
pm_strcpy(device_name, dev->name());
bash_spaces(device_name);
sd->fsend(query_device, device_name.c_str());
Dmsg1(100, ">stored: %s\n", sd->msg);
/* The data is returned through Device_update */
if (bget_dirmsg(sd) <= 0) {
return false;
}
return true;
}
#endif
/*
* Send bootstrap file to Storage daemon.
* This is used for restore, verify VolumeToCatalog, migration,
* and copy Jobs.
*/
static inline bool send_bootstrap_file_to_sd(JCR *jcr, BSOCK *sd)
{
FILE *bs;
char buf[1000];
const char *bootstrap = "bootstrap\n";
Dmsg1(400, "send_bootstrap_file_to_sd: %s\n", jcr->RestoreBootstrap);
if (!jcr->RestoreBootstrap) {
return true;
}
bs = fopen(jcr->RestoreBootstrap, "rb");
if (!bs) {
berrno be;
Jmsg(jcr, M_FATAL, 0, _("Could not open bootstrap file %s: ERR=%s\n"),
jcr->RestoreBootstrap, be.bstrerror());
jcr->setJobStatus(JS_ErrorTerminated);
return false;
}
sd->fsend(bootstrap);
while (fgets(buf, sizeof(buf), bs)) {
sd->fsend("%s", buf);
}
sd->signal(BNET_EOD);
fclose(bs);
if (jcr->unlink_bsr) {
secure_erase(jcr, jcr->RestoreBootstrap);
jcr->unlink_bsr = false;
}
return true;
}
/*
* Start a job with the Storage daemon
*/
bool start_storage_daemon_job(JCR *jcr, alist *rstore, alist *wstore, bool send_bsr)
{
bool ok = true;
STORERES *storage;
char auth_key[100];
const char *fileset_md5;
POOL_MEM store_name, device_name, pool_name, pool_type, media_type, backup_format;
POOL_MEM job_name, client_name, fileset_name;
int copy = 0;
int stripe = 0;
uint64_t remainingquota = 0;
char ed1[30], ed2[30];
BSOCK *sd = jcr->store_bsock;
/*
* Before actually starting a new Job on the SD make sure we send any specific plugin options for this Job.
*/
if (!do_storage_plugin_options(jcr)) {
Jmsg(jcr, M_FATAL, 0, _("Storage daemon rejected Plugin Options command: %s\n"), sd->msg);
return false;
}
/*
* Now send JobId and permissions, and get back the authorization key.
*/
pm_strcpy(job_name, jcr->res.job->name());
bash_spaces(job_name);
if (jcr->res.client) {
pm_strcpy(client_name, jcr->res.client->name());
} else {
pm_strcpy(client_name, "**None**");
}
bash_spaces(client_name);
if (jcr->res.fileset) {
pm_strcpy(fileset_name, jcr->res.fileset->name());
} else {
pm_strcpy(fileset_name, "**None**");
}
bash_spaces(fileset_name);
pm_strcpy(backup_format, jcr->backup_format);
bash_spaces(backup_format);
if (jcr->res.fileset && jcr->res.fileset->MD5[0] == 0) {
bstrncpy(jcr->res.fileset->MD5, "**Dummy**", sizeof(jcr->res.fileset->MD5));
fileset_md5 = jcr->res.fileset->MD5;
} else if (jcr->res.fileset) {
fileset_md5 = jcr->res.fileset->MD5;
} else {
fileset_md5 = "**Dummy**";
}
/*
* If rescheduling, cancel the previous incarnation of this job
* with the SD, which might be waiting on the FD connection.
* If we do not cancel it the SD will not accept a new connection
* for the same jobid.
*/
if (jcr->reschedule_count) {
sd->fsend("cancel Job=%s\n", jcr->Job);
while (sd->recv() >= 0) {
continue;
}
}
/*
* Retrieve available quota 0 bytes means dont perform the check
*/
remainingquota = fetch_remaining_quotas(jcr);
Dmsg1(50,"Remainingquota: %llu\n", remainingquota);
sd->fsend(jobcmd, edit_int64(jcr->JobId, ed1), jcr->Job,
job_name.c_str(), client_name.c_str(),
jcr->getJobType(), jcr->getJobLevel(),
fileset_name.c_str(), !jcr->res.pool->catalog_files,
jcr->res.job->SpoolAttributes, fileset_md5, jcr->spool_data,
jcr->res.job->PreferMountedVolumes, edit_int64(jcr->spool_size, ed2),
jcr->rerunning, jcr->VolSessionId, jcr->VolSessionTime, remainingquota,
jcr->getJobProtocol(), backup_format.c_str(), jcr->DumpLevel);
Dmsg1(100, ">stored: %s", sd->msg);
if (bget_dirmsg(sd) > 0) {
Dmsg1(100, "<stored: %s", sd->msg);
if (sscanf(sd->msg, OK_job, &jcr->VolSessionId,
&jcr->VolSessionTime, &auth_key) != 3) {
Dmsg1(100, "BadJob=%s\n", sd->msg);
Jmsg(jcr, M_FATAL, 0, _("Storage daemon rejected Job command: %s\n"), sd->msg);
return false;
} else {
bfree_and_null(jcr->sd_auth_key);
jcr->sd_auth_key = bstrdup(auth_key);
Dmsg1(150, "sd_auth_key=%s\n", jcr->sd_auth_key);
}
} else {
Jmsg(jcr, M_FATAL, 0, _("<stored: bad response to Job command: %s\n"),
sd->bstrerror());
return false;
}
if (send_bsr && (!send_bootstrap_file_to_sd(jcr, sd) ||
!response(jcr, sd, OKbootstrap, "Bootstrap", DISPLAY_ERROR))) {
return false;
}
/*
* We have two loops here. The first comes from the
* Storage = associated with the Job, and we need
* to attach to each one.
* The inner loop loops over all the alternative devices
* associated with each Storage. It selects the first
* available one.
*
*/
/* Do read side of storage daemon */
if (ok && rstore) {
/* For the moment, only migrate, copy and vbackup have rpool */
if (jcr->is_JobType(JT_MIGRATE) || jcr->is_JobType(JT_COPY) ||
(jcr->is_JobType(JT_BACKUP) && jcr->is_JobLevel(L_VIRTUAL_FULL))) {
pm_strcpy(pool_type, jcr->res.rpool->pool_type);
pm_strcpy(pool_name, jcr->res.rpool->name());
} else {
pm_strcpy(pool_type, jcr->res.pool->pool_type);
pm_strcpy(pool_name, jcr->res.pool->name());
}
bash_spaces(pool_type);
bash_spaces(pool_name);
foreach_alist(storage, rstore) {
Dmsg1(100, "Rstore=%s\n", storage->name());
pm_strcpy(store_name, storage->name());
bash_spaces(store_name);
pm_strcpy(media_type, storage->media_type);
bash_spaces(media_type);
sd->fsend(use_storage, store_name.c_str(), media_type.c_str(),
pool_name.c_str(), pool_type.c_str(), 0, copy, stripe);
Dmsg1(100, "rstore >stored: %s", sd->msg);
DEVICERES *dev;
/* Loop over alternative storage Devices until one is OK */
foreach_alist(dev, storage->device) {
pm_strcpy(device_name, dev->name());
bash_spaces(device_name);
sd->fsend(use_device, device_name.c_str());
Dmsg1(100, ">stored: %s", sd->msg);
}
sd->signal(BNET_EOD); /* end of Devices */
}
sd->signal(BNET_EOD); /* end of Storages */
if (bget_dirmsg(sd) > 0) {
Dmsg1(100, "<stored: %s", sd->msg);
/* ****FIXME**** save actual device name */
ok = sscanf(sd->msg, OK_device, device_name.c_str()) == 1;
} else {
ok = false;
}
if (ok) {
Jmsg(jcr, M_INFO, 0, _("Using Device \"%s\" to read.\n"), device_name.c_str());
}
}
/* Do write side of storage daemon */
if (ok && wstore) {
pm_strcpy(pool_type, jcr->res.pool->pool_type);
pm_strcpy(pool_name, jcr->res.pool->name());
bash_spaces(pool_type);
bash_spaces(pool_name);
foreach_alist(storage, wstore) {
pm_strcpy(store_name, storage->name());
bash_spaces(store_name);
pm_strcpy(media_type, storage->media_type);
bash_spaces(media_type);
sd->fsend(use_storage, store_name.c_str(), media_type.c_str(),
pool_name.c_str(), pool_type.c_str(), 1, copy, stripe);
Dmsg1(100, "wstore >stored: %s", sd->msg);
DEVICERES *dev;
/* Loop over alternative storage Devices until one is OK */
foreach_alist(dev, storage->device) {
pm_strcpy(device_name, dev->name());
bash_spaces(device_name);
sd->fsend(use_device, device_name.c_str());
Dmsg1(100, ">stored: %s", sd->msg);
}
sd->signal(BNET_EOD); /* end of Devices */
}
sd->signal(BNET_EOD); /* end of Storages */
if (bget_dirmsg(sd) > 0) {
Dmsg1(100, "<stored: %s", sd->msg);
/* ****FIXME**** save actual device name */
ok = sscanf(sd->msg, OK_device, device_name.c_str()) == 1;
} else {
ok = false;
}
if (ok) {
Jmsg(jcr, M_INFO, 0, _("Using Device \"%s\" to write.\n"), device_name.c_str());
}
}
if (!ok) {
POOL_MEM err_msg;
if (sd->msg[0]) {
pm_strcpy(err_msg, sd->msg); /* save message */
Jmsg(jcr, M_FATAL, 0, _("\n"
" Storage daemon didn't accept Device \"%s\" because:\n %s"),
device_name.c_str(), err_msg.c_str()/* sd->msg */);
} else {
Jmsg(jcr, M_FATAL, 0, _("\n"
" Storage daemon didn't accept Device \"%s\" command.\n"),
device_name.c_str());
}
}
return ok;
}
/*
* Start a thread to handle Storage daemon messages and
* Catalog requests.
*/
bool start_storage_daemon_message_thread(JCR *jcr)
{
int status;
pthread_t thid;
jcr->inc_use_count(); /* mark in use by msg thread */
jcr->sd_msg_thread_done = false;
jcr->SD_msg_chan_started = false;
Dmsg0(100, "Start SD msg_thread.\n");
if ((status = pthread_create(&thid, NULL, msg_thread, (void *)jcr)) != 0) {
berrno be;
Jmsg1(jcr, M_ABORT, 0, _("Cannot create message thread: %s\n"), be.bstrerror(status));
}
/* Wait for thread to start */
while (!jcr->SD_msg_chan_started) {
bmicrosleep(0, 50);
if (job_canceled(jcr) || jcr->sd_msg_thread_done) {
return false;
}
}
Dmsg1(100, "SD msg_thread started. use=%d\n", jcr->use_count());
return true;
}
extern "C" void msg_thread_cleanup(void *arg)
{
JCR *jcr = (JCR *)arg;
db_end_transaction(jcr, jcr->db); /* terminate any open transaction */
jcr->lock();
jcr->sd_msg_thread_done = true;
jcr->SD_msg_chan_started = false;
jcr->unlock();
pthread_cond_broadcast(&jcr->nextrun_ready); /* wakeup any waiting threads */
pthread_cond_broadcast(&jcr->term_wait); /* wakeup any waiting threads */
Dmsg2(100, "=== End msg_thread. JobId=%d usecnt=%d\n", jcr->JobId, jcr->use_count());
db_thread_cleanup(jcr->db); /* remove thread specific data */
free_jcr(jcr); /* release jcr */
}
/*
* Handle the message channel (i.e. requests from the
* Storage daemon).
* Note, we are running in a separate thread.
*/
extern "C" void *msg_thread(void *arg)
{
JCR *jcr = (JCR *)arg;
BSOCK *sd;
int JobStatus;
int n;
char auth_key[100];
char Job[MAX_NAME_LENGTH];
uint32_t JobFiles, JobErrors;
uint64_t JobBytes;
pthread_detach(pthread_self());
set_jcr_in_tsd(jcr);
jcr->SD_msg_chan = pthread_self();
jcr->SD_msg_chan_started = true;
pthread_cleanup_push(msg_thread_cleanup, arg);
sd = jcr->store_bsock;
/*
* Read the Storage daemon's output.
*/
Dmsg0(100, "Start msg_thread loop\n");
n = 0;
while (!job_canceled(jcr) && (n=bget_dirmsg(sd)) >= 0) {
Dmsg1(400, "<stored: %s", sd->msg);
/*
* Check for "3000 OK Job Authorization="
* Returned by a rerun cmd.
*/
if (sscanf(sd->msg, OK_nextrun, &auth_key) == 1) {
if (jcr->sd_auth_key) {
free(jcr->sd_auth_key);
}
jcr->sd_auth_key = bstrdup(auth_key);
pthread_cond_broadcast(&jcr->nextrun_ready); /* wakeup any waiting threads */
continue;
}
/*
* Check for "3010 Job <jobid> start"
*/
if (sscanf(sd->msg, Job_start, Job) == 1) {
continue;
}
/*
* Check for "3099 Job <JobId> end JobStatus= JobFiles= JobBytes= JobErrors="
*/
if (sscanf(sd->msg, Job_end, Job, &JobStatus, &JobFiles,
&JobBytes, &JobErrors) == 5) {
jcr->SDJobStatus = JobStatus; /* termination status */
jcr->SDJobFiles = JobFiles;
jcr->SDJobBytes = JobBytes;
jcr->SDErrors = JobErrors;
break;
}
Dmsg1(400, "end loop use=%d\n", jcr->use_count());
}
if (n == BNET_HARDEOF) {
/*
* This probably should be M_FATAL, but I am not 100% sure
* that this return *always* corresponds to a dropped line.
*/
Qmsg(jcr, M_ERROR, 0, _("Director's comm line to SD dropped.\n"));
}
if (is_bnet_error(sd)) {
jcr->SDJobStatus = JS_ErrorTerminated;
}
pthread_cleanup_pop(1); /* remove and execute the handler */
return NULL;
}
void wait_for_storage_daemon_termination(JCR *jcr)
{
int cancel_count = 0;
/* Now wait for Storage daemon to terminate our message thread */
while (!jcr->sd_msg_thread_done) {
struct timeval tv;
struct timezone tz;
struct timespec timeout;
gettimeofday(&tv, &tz);
timeout.tv_nsec = 0;
timeout.tv_sec = tv.tv_sec + 5; /* wait 5 seconds */
Dmsg0(400, "I'm waiting for message thread termination.\n");
P(mutex);
pthread_cond_timedwait(&jcr->term_wait, &mutex, &timeout);
V(mutex);
if (jcr->is_canceled()) {
if (jcr->SD_msg_chan_started) {
jcr->store_bsock->set_timed_out();
jcr->store_bsock->set_terminated();
sd_msg_thread_send_signal(jcr, TIMEOUT_SIGNAL);
}
cancel_count++;
}
/* Give SD 30 seconds to clean up after cancel */
if (cancel_count == 6) {
break;
}
}
jcr->setJobStatus(JS_Terminated);
}
#ifdef needed
#define MAX_TRIES 30
#define WAIT_TIME 2
extern "C" void *device_thread(void *arg)
{
int i;
JCR *jcr;
DEVICERES *dev;
pthread_detach(pthread_self());
jcr = new_control_jcr("*DeviceInit*", JT_SYSTEM);
for (i=0; i < MAX_TRIES; i++) {
if (!connect_to_storage_daemon(jcr, 10, 30, true)) {
Dmsg0(900, "Failed connecting to SD.\n");
continue;
}
LockRes();
foreach_res(dev, R_DEVICE) {
if (!update_device_res(jcr, dev)) {
Dmsg1(900, "Error updating device=%s\n", dev->name());
} else {
Dmsg1(900, "Updated Device=%s\n", dev->name());
}
}
UnlockRes();
jcr->store_bsock->close();
delete jcr->store_bsock;
jcr->store_bsock = NULL;
break;
}
free_jcr(jcr);
return NULL;
}
/*
* Start a thread to handle getting Device resource information
* from SD. This is called once at startup of the Director.
*/
void init_device_resources()
{
int status;
pthread_t thid;
Dmsg0(100, "Start Device thread.\n");
if ((status = pthread_create(&thid, NULL, device_thread, NULL)) != 0) {
berrno be;
Jmsg1(NULL, M_ABORT, 0, _("Cannot create message thread: %s\n"), be.bstrerror(status));
}
}
#endif