2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2011 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version three of the GNU Affero General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU Affero General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * This file handles accepting Director Commands
31 * Most Director commands are handled here, with the
32 * exception of the Job command command and subsequent
33 * subcommands that are handled
36 * N.B. in this file, in general we must use P(dev->mutex) rather
37 * than dev->r_lock() so that we can examine the blocked
38 * state rather than blocking ourselves because a Job
39 * thread has the device blocked. In some "safe" cases,
40 * we can do things to a blocked device. CAREFUL!!!!
42 * File daemon commands are handled in fdcmd.c
44 * Kern Sibbald, May MMI
51 /* Exported variables */
53 /* Imported variables */
54 extern BSOCK *filed_chan;
55 extern struct s_last_job last_job;
56 extern bool init_done;
58 /* Static variables */
59 static char derrmsg[] = "3900 Invalid command:";
60 static char OKsetdebug[] = "3000 OK setdebug=%d\n";
61 static char invalid_cmd[] = "3997 Invalid command for a Director with Monitor directive enabled.\n";
62 static char OK_bootstrap[] = "3000 OK bootstrap\n";
63 static char ERROR_bootstrap[] = "3904 Error bootstrap\n";
65 /* Imported functions */
66 extern void terminate_child();
67 extern bool job_cmd(JCR *jcr);
68 extern bool use_cmd(JCR *jcr);
69 extern bool run_cmd(JCR *jcr);
70 extern bool status_cmd(JCR *sjcr);
71 extern bool qstatus_cmd(JCR *jcr);
72 //extern bool query_cmd(JCR *jcr);
74 /* Forward referenced functions */
75 static bool label_cmd(JCR *jcr);
76 static bool die_cmd(JCR *jcr);
77 static bool relabel_cmd(JCR *jcr);
78 static bool readlabel_cmd(JCR *jcr);
79 static bool release_cmd(JCR *jcr);
80 static bool setdebug_cmd(JCR *jcr);
81 static bool cancel_cmd(JCR *cjcr);
82 static bool mount_cmd(JCR *jcr);
83 static bool unmount_cmd(JCR *jcr);
84 //static bool action_on_purge_cmd(JCR *jcr);
85 static bool bootstrap_cmd(JCR *jcr);
86 static bool changer_cmd(JCR *sjcr);
87 static bool do_label(JCR *jcr, int relabel);
88 static DCR *find_device(JCR *jcr, POOL_MEM &dev_name, int drive);
89 static void read_volume_label(JCR *jcr, DCR *dcr, DEVICE *dev, int Slot);
90 static void label_volume_if_ok(DCR *dcr, char *oldname,
91 char *newname, char *poolname,
92 int Slot, int relabel);
93 static bool try_autoload_device(JCR *jcr, DCR *dcr, int slot, const char *VolName);
94 static void send_dir_busy_message(BSOCK *dir, DEVICE *dev);
98 bool (*func)(JCR *jcr);
99 bool monitoraccess; /* set if monitors can access this cmd */
103 * The following are the recognized commands from the Director.
105 static struct s_cmds cmds[] = {
106 {"JobId=", job_cmd, 0}, /* start Job */
107 {"autochanger", changer_cmd, 0},
108 {"bootstrap", bootstrap_cmd, 0},
109 {"cancel", cancel_cmd, 0},
110 {".die", die_cmd, 0},
111 {"label", label_cmd, 0}, /* label a tape */
112 {"mount", mount_cmd, 0},
113 {"readlabel", readlabel_cmd, 0},
114 {"release", release_cmd, 0},
115 {"relabel", relabel_cmd, 0}, /* relabel a tape */
116 {"setdebug=", setdebug_cmd, 0}, /* set debug level */
117 {"status", status_cmd, 1},
118 {".status", qstatus_cmd, 1},
119 {"unmount", unmount_cmd, 0},
120 // {"action_on_purge", action_on_purge_cmd, 0},
121 {"use storage=", use_cmd, 0},
123 // {"query", query_cmd, 0},
124 {NULL, NULL} /* list terminator */
129 * Connection request. We accept connections either from the
130 * Director or a Client (File daemon).
132 * Note, we are running as a seperate thread of the Storage daemon.
133 * and it is because a Director has made a connection with
134 * us on the "Message" channel.
136 * Basic tasks done here:
137 * - Create a JCR record
138 * - If it was from the FD, call handle_filed_connection()
139 * - Authenticate the Director
140 * - We wait for a command
141 * - We execute the command
142 * - We continue or exit depending on the return status
144 void *handle_connection_request(void *arg)
146 BSOCK *bs = (BSOCK *)arg;
154 if (bs->recv() <= 0) {
155 Emsg1(M_ERROR, 0, _("Connection request from %s failed.\n"), bs->who());
161 * Do a sanity check on the message received
163 if (bs->msglen < 25 || bs->msglen > (int)sizeof(name)) {
164 Dmsg1(000, "<filed: %s", bs->msg);
165 Emsg2(M_ERROR, 0, _("Invalid connection from %s. Len=%d\n"), bs->who(), bs->msglen);
170 * See if this is a File daemon connection. If so
173 Dmsg1(110, "Conn: %s", bs->msg);
174 if (debug_level == 3) {
175 Dmsg1(000, "<filed: %s", bs->msg);
177 if (sscanf(bs->msg, "Hello Start Job %127s", name) == 1) {
178 Dmsg1(110, "Got a FD connection at %s\n", bstrftimes(tbuf, sizeof(tbuf),
179 (utime_t)time(NULL)));
180 Dmsg1(50, "%s", bs->msg);
181 handle_filed_connection(bs, name);
186 * This is a connection from the Director, so setup a JCR
188 Dmsg1(110, "Got a DIR connection at %s\n", bstrftimes(tbuf, sizeof(tbuf),
189 (utime_t)time(NULL)));
190 jcr = new_jcr(sizeof(JCR), stored_free_jcr); /* create Job Control Record */
191 jcr->dir_bsock = bs; /* save Director bsock */
192 jcr->dir_bsock->set_jcr(jcr);
193 jcr->dcrs = New(alist(10, not_owned_by_alist));
194 /* Initialize FD start condition variable */
195 int errstat = pthread_cond_init(&jcr->job_start_wait, NULL);
198 Jmsg1(jcr, M_FATAL, 0, _("Unable to init job cond variable: ERR=%s\n"), be.bstrerror(errstat));
202 Dmsg0(1000, "stored in start_job\n");
205 * Authenticate the Director
207 if (!authenticate_director(jcr)) {
208 Jmsg(jcr, M_FATAL, 0, _("Unable to authenticate Director\n"));
211 Dmsg0(90, "Message channel init completed.\n");
213 for (quit=false; !quit;) {
215 if ((bnet_stat = bs->recv()) <= 0) {
216 break; /* connection terminated */
218 Dmsg1(199, "<dird: %s\n", bs->msg);
219 /* Ensure that device initialization is complete */
224 for (i=0; cmds[i].cmd; i++) {
225 if (strncmp(cmds[i].cmd, bs->msg, strlen(cmds[i].cmd)) == 0) {
226 if ((!cmds[i].monitoraccess) && (jcr->director->monitor)) {
227 Dmsg1(100, "Command \"%s\" is invalid.\n", cmds[i].cmd);
228 bs->fsend(invalid_cmd);
229 bs->signal(BNET_EOD);
232 Dmsg1(200, "Do command: %s\n", cmds[i].cmd);
233 if (!cmds[i].func(jcr)) { /* do command */
234 quit = true; /* error, get out */
235 Dmsg1(190, "Command %s requests quit\n", cmds[i].cmd);
237 found = true; /* indicate command found */
241 if (!found) { /* command not found */
243 Mmsg(err_msg, "%s %s\n", derrmsg, bs->msg);
244 bs->fsend(err_msg.c_str());
249 generate_daemon_event(jcr, "JobEnd");
250 dequeue_messages(jcr); /* send any queued messages */
251 bs->signal(BNET_TERMINATE);
258 * Force SD to die, and hopefully dump itself. Turned on only
259 * in development version.
261 static bool die_cmd(JCR *jcr)
266 BSOCK *dir = jcr->dir_bsock;
267 pthread_mutex_t m=PTHREAD_MUTEX_INITIALIZER;
269 if (strstr(dir->msg, "deadlock")) {
270 Pmsg0(000, "I have been requested to deadlock ...\n");
275 Pmsg1(000, "I have been requested to die ... (%s)\n", dir->msg);
276 a = djcr->JobId; /* ref NULL pointer */
284 * Set debug level as requested by the Director
287 static bool setdebug_cmd(JCR *jcr)
289 BSOCK *dir = jcr->dir_bsock;
290 int level, trace_flag;
292 Dmsg1(10, "setdebug_cmd: %s", dir->msg);
293 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
294 dir->fsend(_("3991 Bad setdebug command: %s\n"), dir->msg);
298 set_trace(trace_flag);
299 return dir->fsend(OKsetdebug, level);
305 * Be careful, we switch to using the job's JCR! So, using
306 * BSOCKs on that jcr can have two threads in the same code.
308 static bool cancel_cmd(JCR *cjcr)
310 BSOCK *dir = cjcr->dir_bsock;
312 char Job[MAX_NAME_LENGTH];
315 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
316 if (!(jcr=get_jcr_by_full_name(Job))) {
317 dir->fsend(_("3904 Job %s not found.\n"), Job);
319 oldStatus = jcr->JobStatus;
320 jcr->setJobStatus(JS_Canceled);
321 Dmsg2(800, "Cancel JobId=%d %p\n", jcr->JobId, jcr);
322 if (!jcr->authenticated && oldStatus == JS_WaitFD) {
323 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting thread */
325 if (jcr->file_bsock) {
326 jcr->file_bsock->set_terminated();
327 jcr->file_bsock->set_timed_out();
328 Dmsg2(800, "Term bsock jid=%d %p\n", jcr->JobId, jcr);
330 /* Still waiting for FD to connect, release it */
331 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting job */
332 Dmsg2(800, "Signal FD connect jid=%d %p\n", jcr->JobId, jcr);
334 /* If thread waiting on mount, wake him */
335 if (jcr->dcr && jcr->dcr->dev && jcr->dcr->dev->waiting_for_mount()) {
336 pthread_cond_broadcast(&jcr->dcr->dev->wait_next_vol);
337 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
338 pthread_cond_broadcast(&wait_device_release);
340 if (jcr->read_dcr && jcr->read_dcr->dev && jcr->read_dcr->dev->waiting_for_mount()) {
341 pthread_cond_broadcast(&jcr->read_dcr->dev->wait_next_vol);
342 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
343 pthread_cond_broadcast(&wait_device_release);
345 dir->fsend(_("3000 JobId=%ld Job=\"%s\" marked to be canceled.\n"), jcr->JobId, jcr->Job);
349 dir->fsend(_("3903 Error scanning cancel command.\n"));
351 dir->signal(BNET_EOD);
359 static bool label_cmd(JCR *jcr)
361 return do_label(jcr, 0);
364 static bool relabel_cmd(JCR *jcr)
366 return do_label(jcr, 1);
369 static bool do_label(JCR *jcr, int relabel)
371 POOLMEM *newname, *oldname, *poolname, *mtype;
373 BSOCK *dir = jcr->dir_bsock;
380 newname = get_memory(dir->msglen+1);
381 oldname = get_memory(dir->msglen+1);
382 poolname = get_memory(dir->msglen+1);
383 mtype = get_memory(dir->msglen+1);
385 if (sscanf(dir->msg, "relabel %127s OldName=%127s NewName=%127s PoolName=%127s "
386 "MediaType=%127s Slot=%d drive=%d",
387 dev_name.c_str(), oldname, newname, poolname, mtype,
388 &slot, &drive) == 7) {
393 if (sscanf(dir->msg, "label %127s VolumeName=%127s PoolName=%127s "
394 "MediaType=%127s Slot=%d drive=%d",
395 dev_name.c_str(), newname, poolname, mtype, &slot, &drive) == 6) {
400 unbash_spaces(newname);
401 unbash_spaces(oldname);
402 unbash_spaces(poolname);
403 unbash_spaces(mtype);
404 dcr = find_device(jcr, dev_name, drive);
407 dev->dlock(); /* Use P to avoid indefinite block */
408 if (!dev->is_open() && !dev->is_busy()) {
409 Dmsg1(400, "Can %slabel. Device is not open\n", relabel?"re":"");
410 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
412 /* Under certain "safe" conditions, we can steal the lock */
413 } else if (dev->can_steal_lock()) {
414 Dmsg0(400, "Can relabel. can_steal_lock\n");
415 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
416 } else if (dev->is_busy() || dev->is_blocked()) {
417 send_dir_busy_message(dir, dev);
418 } else { /* device not being used */
419 Dmsg0(400, "Can relabel. device not used\n");
420 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
425 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), dev_name.c_str());
428 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
429 pm_strcpy(jcr->errmsg, dir->msg);
430 dir->fsend(_("3903 Error scanning label command: %s\n"), jcr->errmsg);
432 free_memory(oldname);
433 free_memory(newname);
434 free_memory(poolname);
436 dir->signal(BNET_EOD);
441 * Read the tape label and determine if we can safely
442 * label the tape (not a Bacula volume), then label it.
444 * Enter with the mutex set
446 static void label_volume_if_ok(DCR *dcr, char *oldname,
447 char *newname, char *poolname,
448 int slot, int relabel)
450 BSOCK *dir = dcr->jcr->dir_bsock;
452 DEVICE *dev = dcr->dev;
455 const char *volname = (relabel == 1) ? oldname : newname;
458 steal_device_lock(dev, &hold, BST_WRITING_LABEL);
459 Dmsg1(100, "Stole device %s lock, writing label.\n", dev->print_name());
462 Dmsg0(90, "try_autoload_device - looking for volume_info\n");
463 if (!try_autoload_device(dcr->jcr, dcr, slot, volname)) {
464 goto bail_out; /* error */
467 /* Ensure that the device is open -- autoload_device() closes it */
468 if (dev->is_tape()) {
469 mode = OPEN_READ_WRITE;
471 mode = CREATE_READ_WRITE;
475 dev->truncating = true; /* let open() know we will truncate it */
477 /* Set old volume name for open if relabeling */
478 dcr->setVolCatName(volname);
479 if (dev->open(dcr, mode) < 0) {
480 dir->fsend(_("3910 Unable to open device \"%s\": ERR=%s\n"),
481 dev->print_name(), dev->bstrerror());
485 /* See what we have for a Volume */
486 label_status = read_dev_volume_label(dcr);
488 /* Set new volume name */
489 dcr->setVolCatName(newname);
490 switch(label_status) {
492 case VOL_VERSION_ERROR:
493 case VOL_LABEL_ERROR:
497 "3920 Cannot label Volume because it is already labeled: \"%s\"\n"),
498 dev->VolHdr.VolumeName);
502 /* Relabel request. If oldname matches, continue */
503 if (strcmp(oldname, dev->VolHdr.VolumeName) != 0) {
504 dir->fsend(_("3921 Wrong volume mounted.\n"));
507 if (dev->label_type != B_BACULA_LABEL) {
508 dir->fsend(_("3922 Cannot relabel an ANSI/IBM labeled Volume.\n"));
511 /* Fall through wanted! */
514 if (!write_new_volume_label_to_dev(dcr, newname, poolname,
515 relabel, true /* write dvd now */)) {
516 dir->fsend(_("3912 Failed to label Volume: ERR=%s\n"), dev->bstrerror());
519 bstrncpy(dcr->VolumeName, newname, sizeof(dcr->VolumeName));
520 /* The following 3000 OK label. string is scanned in ua_label.c */
521 dir->fsend("3000 OK label. VolBytes=%s DVD=%d Volume=\"%s\" Device=%s\n",
522 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1),
523 dev->is_dvd()?1:0, newname, dev->print_name());
526 dir->fsend(_("3914 Failed to label Volume (no media): ERR=%s\n"), dev->bstrerror());
529 dir->fsend(_("3913 Cannot label Volume. "
530 "Unknown status %d from read_volume_label()\n"), label_status);
535 if (!dev->is_open()) {
538 volume_unused(dcr); /* no longer using volume */
539 give_back_device_lock(dev, &hold);
545 * Read the tape label
547 * Enter with the mutex set
549 static bool read_label(DCR *dcr)
553 BSOCK *dir = jcr->dir_bsock;
555 DEVICE *dev = dcr->dev;
557 steal_device_lock(dev, &hold, BST_DOING_ACQUIRE);
559 dcr->VolumeName[0] = 0;
560 dev->clear_labeled(); /* force read of label */
561 switch (read_dev_volume_label(dcr)) {
563 dir->fsend(_("3001 Mounted Volume: %s\n"), dev->VolHdr.VolumeName);
567 dir->fsend(_("3902 Cannot mount Volume on Storage Device \"%s\" because:\n%s"),
568 dev->print_name(), jcr->errmsg);
573 give_back_device_lock(dev, &hold);
578 * Searches for device by name, and if found, creates a dcr and
581 static DCR *find_device(JCR *jcr, POOL_MEM &devname, int drive)
584 AUTOCHANGER *changer;
588 unbash_spaces(devname);
589 foreach_res(device, R_DEVICE) {
590 /* Find resource, and make sure we were able to open it */
591 if (strcmp(device->hdr.name, devname.c_str()) == 0) {
593 device->dev = init_dev(jcr, device);
596 Jmsg(jcr, M_WARNING, 0, _("\n"
597 " Device \"%s\" requested by DIR could not be opened or does not exist.\n"),
601 Dmsg1(20, "Found device %s\n", device->hdr.name);
607 foreach_res(changer, R_AUTOCHANGER) {
608 /* Find resource, and make sure we were able to open it */
609 if (strcmp(devname.c_str(), changer->hdr.name) == 0) {
610 /* Try each device in this AutoChanger */
611 foreach_alist(device, changer->device) {
612 Dmsg1(100, "Try changer device %s\n", device->hdr.name);
614 device->dev = init_dev(jcr, device);
617 Dmsg1(100, "Device %s could not be opened. Skipped\n", devname.c_str());
618 Jmsg(jcr, M_WARNING, 0, _("\n"
619 " Device \"%s\" in changer \"%s\" requested by DIR could not be opened or does not exist.\n"),
620 device->hdr.name, devname.c_str());
623 if (!device->dev->autoselect) {
624 Dmsg1(100, "Device %s not autoselect skipped.\n", devname.c_str());
625 continue; /* device is not available */
627 if (drive < 0 || drive == (int)device->dev->drive_index) {
628 Dmsg1(20, "Found changer device %s\n", device->hdr.name);
632 Dmsg3(100, "Device %s drive wrong: want=%d got=%d skipping\n",
633 devname.c_str(), drive, (int)device->dev->drive_index);
635 break; /* we found it but could not open a device */
641 Dmsg1(100, "Found device %s\n", device->hdr.name);
642 dcr = new_dcr(jcr, NULL, device->dev);
643 dcr->device = device;
650 * Mount command from Director
652 static bool mount_cmd(JCR *jcr)
655 BSOCK *dir = jcr->dir_bsock;
662 ok = sscanf(dir->msg, "mount %127s drive=%d slot=%d", devname.c_str(),
665 ok = sscanf(dir->msg, "mount %127s drive=%d", devname.c_str(), &drive) == 2;
668 dcr = find_device(jcr, devname, drive);
671 dev->dlock(); /* Use P to avoid indefinite block */
672 Dmsg2(100, "mount cmd blocked=%d must_unload=%d\n", dev->blocked(),
674 switch (dev->blocked()) { /* device blocked? */
675 case BST_WAITING_FOR_SYSOP:
676 /* Someone is waiting, wake him */
677 Dmsg0(100, "Waiting for mount. Attempting to wake thread\n");
678 dev->set_blocked(BST_MOUNT);
679 dir->fsend("3001 OK mount requested. %sDevice=%s\n",
680 slot>0?_("Specified slot ignored. "):"",
682 pthread_cond_broadcast(&dev->wait_next_vol);
683 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
684 pthread_cond_broadcast(&wait_device_release);
687 /* In both of these two cases, we (the user) unmounted the Volume */
688 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
690 Dmsg2(100, "Unmounted changer=%d slot=%d\n", dev->is_autochanger(), slot);
691 if (dev->is_autochanger() && slot > 0) {
692 try_autoload_device(jcr, dcr, slot, "");
694 /* We freed the device, so reopen it and wake any waiting threads */
695 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
696 dir->fsend(_("3901 Unable to open device \"%s\": ERR=%s\n"),
697 dev->print_name(), dev->bstrerror());
698 if (dev->blocked() == BST_UNMOUNTED) {
699 /* We blocked the device, so unblock it */
700 Dmsg0(100, "Unmounted. Unblocking device\n");
705 read_dev_volume_label(dcr);
706 if (dev->blocked() == BST_UNMOUNTED) {
707 /* We blocked the device, so unblock it */
708 Dmsg0(100, "Unmounted. Unblocking device\n");
709 read_label(dcr); /* this should not be necessary */
712 Dmsg0(100, "Unmounted waiting for mount. Attempting to wake thread\n");
713 dev->set_blocked(BST_MOUNT);
715 if (dev->is_labeled()) {
716 dir->fsend(_("3001 Device \"%s\" is mounted with Volume \"%s\"\n"),
717 dev->print_name(), dev->VolHdr.VolumeName);
719 dir->fsend(_("3905 Device \"%s\" open but no Bacula volume is mounted.\n"
720 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
723 pthread_cond_broadcast(&dev->wait_next_vol);
724 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
725 pthread_cond_broadcast(&wait_device_release);
728 case BST_DOING_ACQUIRE:
729 dir->fsend(_("3001 Device \"%s\" is doing acquire.\n"),
733 case BST_WRITING_LABEL:
734 dir->fsend(_("3903 Device \"%s\" is being labeled.\n"),
738 case BST_NOT_BLOCKED:
739 Dmsg2(100, "Not blocked changer=%d slot=%d\n", dev->is_autochanger(), slot);
740 if (dev->is_autochanger() && slot > 0) {
741 try_autoload_device(jcr, dcr, slot, "");
743 if (dev->is_open()) {
744 if (dev->is_labeled()) {
745 dir->fsend(_("3001 Device \"%s\" is mounted with Volume \"%s\"\n"),
746 dev->print_name(), dev->VolHdr.VolumeName);
748 dir->fsend(_("3905 Device \"%s\" open but no Bacula volume is mounted.\n"
749 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
752 } else if (dev->is_tape()) {
753 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
754 dir->fsend(_("3901 Unable to open device \"%s\": ERR=%s\n"),
755 dev->print_name(), dev->bstrerror());
759 if (dev->is_labeled()) {
760 dir->fsend(_("3001 Device \"%s\" is already mounted with Volume \"%s\"\n"),
761 dev->print_name(), dev->VolHdr.VolumeName);
763 dir->fsend(_("3905 Device \"%s\" open but no Bacula volume is mounted.\n"
764 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
767 } else if (dev->is_unmountable()) {
769 dir->fsend(_("3002 Device \"%s\" is mounted.\n"), dev->print_name());
771 dir->fsend(_("3907 %s"), dev->bstrerror());
773 } else { /* must be file */
774 dir->fsend(_("3906 File device \"%s\" is always mounted.\n"),
776 pthread_cond_broadcast(&dev->wait_next_vol);
777 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
778 pthread_cond_broadcast(&wait_device_release);
783 dir->fsend(_("3930 Device \"%s\" is being released.\n"), dev->print_name());
787 dir->fsend(_("3905 Unknown wait state %d\n"), dev->blocked());
793 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
796 pm_strcpy(jcr->errmsg, dir->msg);
797 dir->fsend(_("3909 Error scanning mount command: %s\n"), jcr->errmsg);
799 dir->signal(BNET_EOD);
804 * unmount command from Director
806 static bool unmount_cmd(JCR *jcr)
809 BSOCK *dir = jcr->dir_bsock;
814 if (sscanf(dir->msg, "unmount %127s drive=%d", devname.c_str(), &drive) == 2) {
815 dcr = find_device(jcr, devname, drive);
818 dev->dlock(); /* Use P to avoid indefinite block */
819 if (!dev->is_open()) {
820 if (!dev->is_busy()) {
821 unload_autochanger(dcr, -1);
823 if (dev->is_unmountable()) {
824 if (dev->unmount(0)) {
825 dir->fsend(_("3002 Device \"%s\" unmounted.\n"),
828 dir->fsend(_("3907 %s"), dev->bstrerror());
831 Dmsg0(90, "Device already unmounted\n");
832 dir->fsend(_("3901 Device \"%s\" is already unmounted.\n"),
835 } else if (dev->blocked() == BST_WAITING_FOR_SYSOP) {
836 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
838 if (!unload_autochanger(dcr, -1)) {
839 /* ***FIXME**** what is this ???? */
843 if (dev->is_unmountable() && !dev->unmount(0)) {
844 dir->fsend(_("3907 %s"), dev->bstrerror());
846 dev->set_blocked(BST_UNMOUNTED_WAITING_FOR_SYSOP);
847 dir->fsend(_("3001 Device \"%s\" unmounted.\n"),
851 } else if (dev->blocked() == BST_DOING_ACQUIRE) {
852 dir->fsend(_("3902 Device \"%s\" is busy in acquire.\n"),
855 } else if (dev->blocked() == BST_WRITING_LABEL) {
856 dir->fsend(_("3903 Device \"%s\" is being labeled.\n"),
859 } else if (dev->is_busy()) {
860 send_dir_busy_message(dir, dev);
861 } else { /* device not being used */
862 Dmsg0(90, "Device not in use, unmounting\n");
863 /* On FreeBSD, I am having ASSERT() failures in block_device()
864 * and I can only imagine that the thread id that we are
865 * leaving in no_wait_id is being re-used. So here,
866 * we simply do it by hand. Gross, but a solution.
868 /* block_device(dev, BST_UNMOUNTED); replace with 2 lines below */
869 dev->set_blocked(BST_UNMOUNTED);
870 clear_thread_id(dev->no_wait_id);
871 if (!unload_autochanger(dcr, -1)) {
875 if (dev->is_unmountable() && !dev->unmount(0)) {
876 dir->fsend(_("3907 %s"), dev->bstrerror());
878 dir->fsend(_("3002 Device \"%s\" unmounted.\n"),
885 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
888 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
889 pm_strcpy(jcr->errmsg, dir->msg);
890 dir->fsend(_("3907 Error scanning unmount command: %s\n"), jcr->errmsg);
892 dir->signal(BNET_EOD);
898 * The truncate command will recycle a volume. The director can call this
899 * after purging a volume so that disk space will not be wasted. Only useful
900 * for File Storage, of course.
903 * It is currently disabled
905 static bool action_on_purge_cmd(JCR *jcr)
907 BSOCK *dir = jcr->dir_bsock;
909 char devname[MAX_NAME_LENGTH];
910 char volumename[MAX_NAME_LENGTH];
913 /* TODO: Need to find a free device and ask for slot to the director */
915 "action_on_purge %127s vol=%127s action=%d",
916 devname, volumename, &action)!= 5)
918 dir->fsend(_("3916 Error scanning action_on_purge command\n"));
921 unbash_spaces(volumename);
922 unbash_spaces(devname);
924 /* Check if action is correct */
925 if (action & AOP_TRUNCTATE) {
931 dir->signal(BNET_EOD);
937 * Release command from Director. This rewinds the device and if
938 * configured does a offline and ensures that Bacula will
939 * re-read the label of the tape before continuing. This gives
940 * the operator the chance to change the tape anytime before the
943 static bool release_cmd(JCR *jcr)
946 BSOCK *dir = jcr->dir_bsock;
951 if (sscanf(dir->msg, "release %127s drive=%d", devname.c_str(), &drive) == 2) {
952 dcr = find_device(jcr, devname, drive);
955 dev->dlock(); /* Use P to avoid indefinite block */
956 if (!dev->is_open()) {
957 if (!dev->is_busy()) {
958 unload_autochanger(dcr, -1);
960 Dmsg0(90, "Device already released\n");
961 dir->fsend(_("3921 Device \"%s\" already released.\n"),
964 } else if (dev->blocked() == BST_WAITING_FOR_SYSOP) {
965 Dmsg2(90, "%d waiter dev_block=%d.\n", dev->num_waiting,
967 unload_autochanger(dcr, -1);
968 dir->fsend(_("3922 Device \"%s\" waiting for sysop.\n"),
971 } else if (dev->blocked() == BST_UNMOUNTED_WAITING_FOR_SYSOP) {
972 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
974 dir->fsend(_("3922 Device \"%s\" waiting for mount.\n"),
977 } else if (dev->blocked() == BST_DOING_ACQUIRE) {
978 dir->fsend(_("3923 Device \"%s\" is busy in acquire.\n"),
981 } else if (dev->blocked() == BST_WRITING_LABEL) {
982 dir->fsend(_("3914 Device \"%s\" is being labeled.\n"),
985 } else if (dev->is_busy()) {
986 send_dir_busy_message(dir, dev);
987 } else { /* device not being used */
988 Dmsg0(90, "Device not in use, releasing\n");
989 dcr->release_volume();
990 dir->fsend(_("3022 Device \"%s\" released.\n"),
996 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
999 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
1000 pm_strcpy(jcr->errmsg, dir->msg);
1001 dir->fsend(_("3927 Error scanning release command: %s\n"), jcr->errmsg);
1003 dir->signal(BNET_EOD);
1007 static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER;
1008 static uint32_t bsr_uniq = 0;
1010 static bool get_bootstrap_file(JCR *jcr, BSOCK *sock)
1012 POOLMEM *fname = get_pool_memory(PM_FNAME);
1016 if (jcr->RestoreBootstrap) {
1017 unlink(jcr->RestoreBootstrap);
1018 free_pool_memory(jcr->RestoreBootstrap);
1022 Mmsg(fname, "%s/%s.%s.%d.bootstrap", me->working_directory, me->hdr.name,
1023 jcr->Job, bsr_uniq);
1025 Dmsg1(400, "bootstrap=%s\n", fname);
1026 jcr->RestoreBootstrap = fname;
1027 bs = fopen(fname, "a+b"); /* create file */
1030 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
1031 jcr->RestoreBootstrap, be.bstrerror());
1034 Dmsg0(10, "=== Bootstrap file ===\n");
1035 while (sock->recv() >= 0) {
1036 Dmsg1(10, "%s", sock->msg);
1037 fputs(sock->msg, bs);
1040 Dmsg0(10, "=== end bootstrap file ===\n");
1041 jcr->bsr = parse_bsr(jcr, jcr->RestoreBootstrap);
1043 Jmsg(jcr, M_FATAL, 0, _("Error parsing bootstrap file.\n"));
1046 if (debug_level >= 10) {
1047 dump_bsr(jcr->bsr, true);
1049 /* If we got a bootstrap, we are reading, so create read volume list */
1050 create_restore_volume_list(jcr);
1054 unlink(jcr->RestoreBootstrap);
1055 free_pool_memory(jcr->RestoreBootstrap);
1056 jcr->RestoreBootstrap = NULL;
1058 sock->fsend(ERROR_bootstrap);
1061 return sock->fsend(OK_bootstrap);
1064 static bool bootstrap_cmd(JCR *jcr)
1066 return get_bootstrap_file(jcr, jcr->dir_bsock);
1070 * Autochanger command from Director
1072 static bool changer_cmd(JCR *jcr)
1075 BSOCK *dir = jcr->dir_bsock;
1078 const char *cmd = NULL;
1081 * A safe_cmd may call autochanger script but does not load/unload
1082 * slots so it can be done at the same time that the drive is open.
1084 bool safe_cmd = false;
1086 if (sscanf(dir->msg, "autochanger listall %127s", devname.c_str()) == 1) {
1088 safe_cmd = ok = true;
1089 } else if (sscanf(dir->msg, "autochanger list %127s", devname.c_str()) == 1) {
1091 safe_cmd = ok = true;
1092 } else if (sscanf(dir->msg, "autochanger slots %127s", devname.c_str()) == 1) {
1094 safe_cmd = ok = true;
1095 } else if (sscanf(dir->msg, "autochanger drives %127s", devname.c_str()) == 1) {
1097 safe_cmd = ok = true;
1100 dcr = find_device(jcr, devname, -1);
1103 dev->dlock(); /* Use P to avoid indefinite block */
1104 if (!dev->device->changer_res) {
1105 dir->fsend(_("3995 Device \"%s\" is not an autochanger.\n"),
1107 /* Under certain "safe" conditions, we can steal the lock */
1108 } else if (safe_cmd || !dev->is_open() || dev->can_steal_lock()) {
1109 autochanger_cmd(dcr, dir, cmd);
1110 } else if (dev->is_busy() || dev->is_blocked()) {
1111 send_dir_busy_message(dir, dev);
1112 } else { /* device not being used */
1113 autochanger_cmd(dcr, dir, cmd);
1118 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
1120 } else { /* error on scanf */
1121 pm_strcpy(jcr->errmsg, dir->msg);
1122 dir->fsend(_("3908 Error scanning autochanger drives/list/slots command: %s\n"),
1125 dir->signal(BNET_EOD);
1130 * Read and return the Volume label
1132 static bool readlabel_cmd(JCR *jcr)
1135 BSOCK *dir = jcr->dir_bsock;
1141 if (sscanf(dir->msg, "readlabel %127s Slot=%d drive=%d", devname.c_str(),
1142 &Slot, &drive) == 3) {
1143 dcr = find_device(jcr, devname, drive);
1146 dev->dlock(); /* Use P to avoid indefinite block */
1147 if (!dev->is_open()) {
1148 read_volume_label(jcr, dcr, dev, Slot);
1150 /* Under certain "safe" conditions, we can steal the lock */
1151 } else if (dev->can_steal_lock()) {
1152 read_volume_label(jcr, dcr, dev, Slot);
1153 } else if (dev->is_busy() || dev->is_blocked()) {
1154 send_dir_busy_message(dir, dev);
1155 } else { /* device not being used */
1156 read_volume_label(jcr, dcr, dev, Slot);
1161 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
1164 pm_strcpy(jcr->errmsg, dir->msg);
1165 dir->fsend(_("3909 Error scanning readlabel command: %s\n"), jcr->errmsg);
1167 dir->signal(BNET_EOD);
1173 * Read the tape label
1175 * Enter with the mutex set
1177 static void read_volume_label(JCR *jcr, DCR *dcr, DEVICE *dev, int Slot)
1179 BSOCK *dir = jcr->dir_bsock;
1183 steal_device_lock(dev, &hold, BST_WRITING_LABEL);
1185 if (!try_autoload_device(jcr, dcr, Slot, "")) {
1186 goto bail_out; /* error */
1189 dev->clear_labeled(); /* force read of label */
1190 switch (read_dev_volume_label(dcr)) {
1192 /* DO NOT add quotes around the Volume name. It is scanned in the DIR */
1193 dir->fsend(_("3001 Volume=%s Slot=%d\n"), dev->VolHdr.VolumeName, Slot);
1194 Dmsg1(100, "Volume: %s\n", dev->VolHdr.VolumeName);
1197 dir->fsend(_("3902 Cannot mount Volume on Storage Device \"%s\" because:\n%s"),
1198 dev->print_name(), jcr->errmsg);
1203 give_back_device_lock(dev, &hold);
1207 static bool try_autoload_device(JCR *jcr, DCR *dcr, int slot, const char *VolName)
1209 BSOCK *dir = jcr->dir_bsock;
1211 bstrncpy(dcr->VolumeName, VolName, sizeof(dcr->VolumeName));
1212 dcr->VolCatInfo.Slot = slot;
1213 dcr->VolCatInfo.InChanger = slot > 0;
1214 if (autoload_device(dcr, 0, dir) < 0) { /* autoload if possible */
1220 static void send_dir_busy_message(BSOCK *dir, DEVICE *dev)
1222 if (dev->is_blocked()) {
1223 switch (dev->blocked()) {
1225 dir->fsend(_("3931 Device \"%s\" is BLOCKED. user unmounted.\n"),
1228 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
1229 dir->fsend(_("3932 Device \"%s\" is BLOCKED. user unmounted during wait for media/mount.\n"),
1232 case BST_WAITING_FOR_SYSOP:
1233 dir->fsend(_("3933 Device \"%s\" is BLOCKED waiting for media.\n"),
1236 case BST_DOING_ACQUIRE:
1237 dir->fsend(_("3934 Device \"%s\" is being initialized.\n"),
1240 case BST_WRITING_LABEL:
1241 dir->fsend(_("3935 Device \"%s\" is blocked labeling a Volume.\n"),
1245 dir->fsend(_("3935 Device \"%s\" is blocked for unknown reason.\n"),
1249 } else if (dev->can_read()) {
1250 dir->fsend(_("3936 Device \"%s\" is busy reading.\n"),
1251 dev->print_name());;
1253 dir->fsend(_("3937 Device \"%s\" is busy with writers=%d reserved=%d.\n"),
1254 dev->print_name(), dev->num_writers, dev->num_reserved());