2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2010 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 two of the GNU 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 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 Pmsg0(000, "I have been requested to die ...");
267 a = djcr->JobId; /* ref NULL pointer */
275 * Set debug level as requested by the Director
278 static bool setdebug_cmd(JCR *jcr)
280 BSOCK *dir = jcr->dir_bsock;
281 int level, trace_flag;
283 Dmsg1(10, "setdebug_cmd: %s", dir->msg);
284 if (sscanf(dir->msg, "setdebug=%d trace=%d", &level, &trace_flag) != 2 || level < 0) {
285 dir->fsend(_("3991 Bad setdebug command: %s\n"), dir->msg);
289 set_trace(trace_flag);
290 return dir->fsend(OKsetdebug, level);
297 static bool cancel_cmd(JCR *cjcr)
299 BSOCK *dir = cjcr->dir_bsock;
301 char Job[MAX_NAME_LENGTH];
304 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
305 if (!(jcr=get_jcr_by_full_name(Job))) {
306 dir->fsend(_("3904 Job %s not found.\n"), Job);
308 oldStatus = jcr->JobStatus;
309 set_jcr_job_status(jcr, JS_Canceled);
310 Dmsg2(800, "Cancel JobId=%d %p\n", jcr->JobId, jcr);
311 if (!jcr->authenticated && oldStatus == JS_WaitFD) {
312 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting thread */
314 if (jcr->file_bsock) {
315 jcr->file_bsock->signal(BNET_TERMINATE);
316 jcr->file_bsock->set_terminated();
317 Dmsg2(800, "Term bsock jid=%d %p\n", jcr->JobId, jcr);
319 /* Still waiting for FD to connect, release it */
320 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting job */
321 Dmsg2(800, "Signal FD connect jid=%d %p\n", jcr->JobId, jcr);
323 /* If thread waiting on mount, wake him */
324 if (jcr->dcr && jcr->dcr->dev && jcr->dcr->dev->waiting_for_mount()) {
325 pthread_cond_broadcast(&jcr->dcr->dev->wait_next_vol);
326 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
327 pthread_cond_broadcast(&wait_device_release);
329 if (jcr->read_dcr && jcr->read_dcr->dev && jcr->read_dcr->dev->waiting_for_mount()) {
330 pthread_cond_broadcast(&jcr->read_dcr->dev->wait_next_vol);
331 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)jcr->JobId);
332 pthread_cond_broadcast(&wait_device_release);
334 Jmsg(jcr, M_INFO, 0, _("JobId=%d Job=\"%s\" marked to be canceled.\n"),
335 (int)jcr->JobId, jcr->Job);
336 dir->fsend(_("3000 Job %s marked to be canceled.\n"), jcr->Job);
340 dir->fsend(_("3903 Error scanning cancel command.\n"));
342 dir->signal(BNET_EOD);
350 static bool label_cmd(JCR *jcr)
352 return do_label(jcr, 0);
355 static bool relabel_cmd(JCR *jcr)
357 return do_label(jcr, 1);
360 static bool do_label(JCR *jcr, int relabel)
362 POOLMEM *newname, *oldname, *poolname, *mtype;
364 BSOCK *dir = jcr->dir_bsock;
371 newname = get_memory(dir->msglen+1);
372 oldname = get_memory(dir->msglen+1);
373 poolname = get_memory(dir->msglen+1);
374 mtype = get_memory(dir->msglen+1);
376 if (sscanf(dir->msg, "relabel %127s OldName=%127s NewName=%127s PoolName=%127s "
377 "MediaType=%127s Slot=%d drive=%d",
378 dev_name.c_str(), oldname, newname, poolname, mtype,
379 &slot, &drive) == 7) {
384 if (sscanf(dir->msg, "label %127s VolumeName=%127s PoolName=%127s "
385 "MediaType=%127s Slot=%d drive=%d",
386 dev_name.c_str(), newname, poolname, mtype, &slot, &drive) == 6) {
391 unbash_spaces(newname);
392 unbash_spaces(oldname);
393 unbash_spaces(poolname);
394 unbash_spaces(mtype);
395 dcr = find_device(jcr, dev_name, drive);
398 dev->dlock(); /* Use P to avoid indefinite block */
399 if (!dev->is_open() && !dev->is_busy()) {
400 Dmsg1(400, "Can %slabel. Device is not open\n", relabel?"re":"");
401 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
403 /* Under certain "safe" conditions, we can steal the lock */
404 } else if (dev->can_steal_lock()) {
405 Dmsg0(400, "Can relabel. can_steal_lock\n");
406 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
407 } else if (dev->is_busy() || dev->is_blocked()) {
408 send_dir_busy_message(dir, dev);
409 } else { /* device not being used */
410 Dmsg0(400, "Can relabel. device not used\n");
411 label_volume_if_ok(dcr, oldname, newname, poolname, slot, relabel);
416 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), dev_name.c_str());
419 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
420 pm_strcpy(jcr->errmsg, dir->msg);
421 dir->fsend(_("3903 Error scanning label command: %s\n"), jcr->errmsg);
423 free_memory(oldname);
424 free_memory(newname);
425 free_memory(poolname);
427 dir->signal(BNET_EOD);
432 * Read the tape label and determine if we can safely
433 * label the tape (not a Bacula volume), then label it.
435 * Enter with the mutex set
437 static void label_volume_if_ok(DCR *dcr, char *oldname,
438 char *newname, char *poolname,
439 int slot, int relabel)
441 BSOCK *dir = dcr->jcr->dir_bsock;
443 DEVICE *dev = dcr->dev;
446 const char *volname = (relabel == 1) ? oldname : newname;
449 steal_device_lock(dev, &hold, BST_WRITING_LABEL);
450 Dmsg1(100, "Stole device %s lock, writing label.\n", dev->print_name());
453 Dmsg0(90, "try_autoload_device - looking for volume_info\n");
454 if (!try_autoload_device(dcr->jcr, dcr, slot, volname)) {
455 goto bail_out; /* error */
458 /* Ensure that the device is open -- autoload_device() closes it */
459 if (dev->is_tape()) {
460 mode = OPEN_READ_WRITE;
462 mode = CREATE_READ_WRITE;
466 dev->truncating = true; /* let open() know we will truncate it */
468 /* Set old volume name for open if relabeling */
469 dcr->setVolCatName(volname);
470 if (dev->open(dcr, mode) < 0) {
471 dir->fsend(_("3910 Unable to open device %s: ERR=%s\n"),
472 dev->print_name(), dev->bstrerror());
476 /* See what we have for a Volume */
477 label_status = read_dev_volume_label(dcr);
479 /* Set new volume name */
480 dcr->setVolCatName(newname);
481 switch(label_status) {
483 case VOL_VERSION_ERROR:
484 case VOL_LABEL_ERROR:
488 "3920 Cannot label Volume because it is already labeled: \"%s\"\n"),
489 dev->VolHdr.VolumeName);
493 /* Relabel request. If oldname matches, continue */
494 if (strcmp(oldname, dev->VolHdr.VolumeName) != 0) {
495 dir->fsend(_("3921 Wrong volume mounted.\n"));
498 if (dev->label_type != B_BACULA_LABEL) {
499 dir->fsend(_("3922 Cannot relabel an ANSI/IBM labeled Volume.\n"));
502 /* Fall through wanted! */
505 if (!write_new_volume_label_to_dev(dcr, newname, poolname,
506 relabel, true /* write dvd now */)) {
507 dir->fsend(_("3912 Failed to label Volume: ERR=%s\n"), dev->bstrerror());
510 bstrncpy(dcr->VolumeName, newname, sizeof(dcr->VolumeName));
511 /* The following 3000 OK label. string is scanned in ua_label.c */
512 dir->fsend("3000 OK label. VolBytes=%s DVD=%d Volume=\"%s\" Device=%s\n",
513 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1),
514 dev->is_dvd()?1:0, newname, dev->print_name());
517 dir->fsend(_("3914 Failed to label Volume (no media): ERR=%s\n"), dev->bstrerror());
520 dir->fsend(_("3913 Cannot label Volume. "
521 "Unknown status %d from read_volume_label()\n"), label_status);
526 if (!dev->is_open()) {
529 volume_unused(dcr); /* no longer using volume */
530 give_back_device_lock(dev, &hold);
536 * Read the tape label
538 * Enter with the mutex set
540 static bool read_label(DCR *dcr)
544 BSOCK *dir = jcr->dir_bsock;
546 DEVICE *dev = dcr->dev;
548 steal_device_lock(dev, &hold, BST_DOING_ACQUIRE);
550 dcr->VolumeName[0] = 0;
551 dev->clear_labeled(); /* force read of label */
552 switch (read_dev_volume_label(dcr)) {
554 dir->fsend(_("3001 Mounted Volume: %s\n"), dev->VolHdr.VolumeName);
558 dir->fsend(_("3902 Cannot mount Volume on Storage Device %s because:\n%s"),
559 dev->print_name(), jcr->errmsg);
564 give_back_device_lock(dev, &hold);
569 * Searches for device by name, and if found, creates a dcr and
572 static DCR *find_device(JCR *jcr, POOL_MEM &devname, int drive)
575 AUTOCHANGER *changer;
579 unbash_spaces(devname);
580 foreach_res(device, R_DEVICE) {
581 /* Find resource, and make sure we were able to open it */
582 if (strcmp(device->hdr.name, devname.c_str()) == 0) {
584 device->dev = init_dev(jcr, device);
587 Jmsg(jcr, M_WARNING, 0, _("\n"
588 " Device \"%s\" requested by DIR could not be opened or does not exist.\n"),
592 Dmsg1(20, "Found device %s\n", device->hdr.name);
598 foreach_res(changer, R_AUTOCHANGER) {
599 /* Find resource, and make sure we were able to open it */
600 if (strcmp(devname.c_str(), changer->hdr.name) == 0) {
601 /* Try each device in this AutoChanger */
602 foreach_alist(device, changer->device) {
603 Dmsg1(100, "Try changer device %s\n", device->hdr.name);
605 device->dev = init_dev(jcr, device);
608 Dmsg1(100, "Device %s could not be opened. Skipped\n", devname.c_str());
609 Jmsg(jcr, M_WARNING, 0, _("\n"
610 " Device \"%s\" in changer \"%s\" requested by DIR could not be opened or does not exist.\n"),
611 device->hdr.name, devname.c_str());
614 if (!device->dev->autoselect) {
615 Dmsg1(100, "Device %s not autoselect skipped.\n", devname.c_str());
616 continue; /* device is not available */
618 if (drive < 0 || drive == (int)device->dev->drive_index) {
619 Dmsg1(20, "Found changer device %s\n", device->hdr.name);
623 Dmsg3(100, "Device %s drive wrong: want=%d got=%d skipping\n",
624 devname.c_str(), drive, (int)device->dev->drive_index);
626 break; /* we found it but could not open a device */
632 Dmsg1(100, "Found device %s\n", device->hdr.name);
633 dcr = new_dcr(jcr, NULL, device->dev);
634 dcr->device = device;
641 * Mount command from Director
643 static bool mount_cmd(JCR *jcr)
646 BSOCK *dir = jcr->dir_bsock;
653 ok = sscanf(dir->msg, "mount %127s drive=%d slot=%d", devname.c_str(),
656 ok = sscanf(dir->msg, "mount %127s drive=%d", devname.c_str(), &drive) == 2;
659 dcr = find_device(jcr, devname, drive);
662 dev->dlock(); /* Use P to avoid indefinite block */
663 Dmsg2(100, "mount cmd blocked=%d must_unload=%d\n", dev->blocked(),
665 switch (dev->blocked()) { /* device blocked? */
666 case BST_WAITING_FOR_SYSOP:
667 /* Someone is waiting, wake him */
668 Dmsg0(100, "Waiting for mount. Attempting to wake thread\n");
669 dev->set_blocked(BST_MOUNT);
670 dir->fsend("3001 OK mount requested. %sDevice=%s\n",
671 slot>0?_("Specified slot ignored. "):"",
673 pthread_cond_broadcast(&dev->wait_next_vol);
674 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
675 pthread_cond_broadcast(&wait_device_release);
678 /* In both of these two cases, we (the user) unmounted the Volume */
679 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
681 if (dev->is_autochanger() && slot > 0) {
682 try_autoload_device(jcr, dcr, slot, "");
684 /* We freed the device, so reopen it and wake any waiting threads */
685 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
686 dir->fsend(_("3901 Unable to open device %s: ERR=%s\n"),
687 dev->print_name(), dev->bstrerror());
688 if (dev->blocked() == BST_UNMOUNTED) {
689 /* We blocked the device, so unblock it */
690 Dmsg0(100, "Unmounted. Unblocking device\n");
695 read_dev_volume_label(dcr);
696 if (dev->blocked() == BST_UNMOUNTED) {
697 /* We blocked the device, so unblock it */
698 Dmsg0(100, "Unmounted. Unblocking device\n");
699 read_label(dcr); /* this should not be necessary */
702 Dmsg0(100, "Unmounted waiting for mount. Attempting to wake thread\n");
703 dev->set_blocked(BST_MOUNT);
705 if (dev->is_labeled()) {
706 dir->fsend(_("3001 Device %s is mounted with Volume \"%s\"\n"),
707 dev->print_name(), dev->VolHdr.VolumeName);
709 dir->fsend(_("3905 Device %s open but no Bacula volume is mounted.\n"
710 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
713 pthread_cond_broadcast(&dev->wait_next_vol);
714 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
715 pthread_cond_broadcast(&wait_device_release);
718 case BST_DOING_ACQUIRE:
719 dir->fsend(_("3001 Device %s is doing acquire.\n"),
723 case BST_WRITING_LABEL:
724 dir->fsend(_("3903 Device %s is being labeled.\n"),
728 case BST_NOT_BLOCKED:
729 if (dev->is_autochanger() && slot > 0) {
730 try_autoload_device(jcr, dcr, slot, "");
732 if (dev->is_open()) {
733 if (dev->is_labeled()) {
734 dir->fsend(_("3001 Device %s is mounted with Volume \"%s\"\n"),
735 dev->print_name(), dev->VolHdr.VolumeName);
737 dir->fsend(_("3905 Device %s open but no Bacula volume is mounted.\n"
738 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
741 } else if (dev->is_tape()) {
742 if (dev->open(dcr, OPEN_READ_ONLY) < 0) {
743 dir->fsend(_("3901 Unable to open device %s: ERR=%s\n"),
744 dev->print_name(), dev->bstrerror());
748 if (dev->is_labeled()) {
749 dir->fsend(_("3001 Device %s is already mounted with Volume \"%s\"\n"),
750 dev->print_name(), dev->VolHdr.VolumeName);
752 dir->fsend(_("3905 Device %s open but no Bacula volume is mounted.\n"
753 "If this is not a blank tape, try unmounting and remounting the Volume.\n"),
756 } else if (dev->is_unmountable()) {
758 dir->fsend(_("3002 Device %s is mounted.\n"),
761 dir->fsend(_("3907 %s"), dev->bstrerror());
763 } else { /* must be file */
764 dir->fsend(_("3906 File device %s is always mounted.\n"),
766 pthread_cond_broadcast(&dev->wait_next_vol);
767 Dmsg1(100, "JobId=%u broadcast wait_device_release\n", (uint32_t)dcr->jcr->JobId);
768 pthread_cond_broadcast(&wait_device_release);
773 dir->fsend(_("3905 Bizarre wait state %d\n"), dev->blocked());
779 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
782 pm_strcpy(jcr->errmsg, dir->msg);
783 dir->fsend(_("3909 Error scanning mount command: %s\n"), jcr->errmsg);
785 dir->signal(BNET_EOD);
790 * unmount command from Director
792 static bool unmount_cmd(JCR *jcr)
795 BSOCK *dir = jcr->dir_bsock;
800 if (sscanf(dir->msg, "unmount %127s drive=%d", devname.c_str(), &drive) == 2) {
801 dcr = find_device(jcr, devname, drive);
804 dev->dlock(); /* Use P to avoid indefinite block */
805 if (!dev->is_open()) {
806 if (!dev->is_busy()) {
807 unload_autochanger(dcr, -1);
809 if (dev->is_unmountable()) {
810 if (dev->unmount(0)) {
811 dir->fsend(_("3002 Device %s unmounted.\n"),
814 dir->fsend(_("3907 %s"), dev->bstrerror());
817 Dmsg0(90, "Device already unmounted\n");
818 dir->fsend(_("3901 Device %s is already unmounted.\n"),
821 } else if (dev->blocked() == BST_WAITING_FOR_SYSOP) {
822 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
824 if (!unload_autochanger(dcr, -1)) {
825 /* ***FIXME**** what is this ???? */
829 if (dev->is_unmountable() && !dev->unmount(0)) {
830 dir->fsend(_("3907 %s"), dev->bstrerror());
832 dev->set_blocked(BST_UNMOUNTED_WAITING_FOR_SYSOP);
833 dir->fsend(_("3001 Device %s unmounted.\n"),
837 } else if (dev->blocked() == BST_DOING_ACQUIRE) {
838 dir->fsend(_("3902 Device %s is busy in acquire.\n"),
841 } else if (dev->blocked() == BST_WRITING_LABEL) {
842 dir->fsend(_("3903 Device %s is being labeled.\n"),
845 } else if (dev->is_busy()) {
846 send_dir_busy_message(dir, dev);
847 } else { /* device not being used */
848 Dmsg0(90, "Device not in use, unmounting\n");
849 /* On FreeBSD, I am having ASSERT() failures in block_device()
850 * and I can only imagine that the thread id that we are
851 * leaving in no_wait_id is being re-used. So here,
852 * we simply do it by hand. Gross, but a solution.
854 /* block_device(dev, BST_UNMOUNTED); replace with 2 lines below */
855 dev->set_blocked(BST_UNMOUNTED);
856 clear_thread_id(dev->no_wait_id);
857 if (!unload_autochanger(dcr, -1)) {
861 if (dev->is_unmountable() && !dev->unmount(0)) {
862 dir->fsend(_("3907 %s"), dev->bstrerror());
864 dir->fsend(_("3002 Device %s unmounted.\n"),
871 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
874 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
875 pm_strcpy(jcr->errmsg, dir->msg);
876 dir->fsend(_("3907 Error scanning unmount command: %s\n"), jcr->errmsg);
878 dir->signal(BNET_EOD);
884 * The truncate command will recycle a volume. The director can call this
885 * after purging a volume so that disk space will not be wasted. Only useful
886 * for File Storage, of course.
889 * It is currently disabled
891 static bool action_on_purge_cmd(JCR *jcr)
893 BSOCK *dir = jcr->dir_bsock;
895 char devname[MAX_NAME_LENGTH];
896 char volumename[MAX_NAME_LENGTH];
899 /* TODO: Need to find a free device and ask for slot to the director */
901 "action_on_purge %127s vol=%127s action=%d",
902 devname, volumename, &action)!= 5)
904 dir->fsend(_("3916 Error scanning action_on_purge command\n"));
907 unbash_spaces(volumename);
908 unbash_spaces(devname);
910 /* Check if action is correct */
911 if (action & AOP_TRUNCTATE) {
917 dir->signal(BNET_EOD);
923 * Release command from Director. This rewinds the device and if
924 * configured does a offline and ensures that Bacula will
925 * re-read the label of the tape before continuing. This gives
926 * the operator the chance to change the tape anytime before the
929 static bool release_cmd(JCR *jcr)
932 BSOCK *dir = jcr->dir_bsock;
937 if (sscanf(dir->msg, "release %127s drive=%d", devname.c_str(), &drive) == 2) {
938 dcr = find_device(jcr, devname, drive);
941 dev->dlock(); /* Use P to avoid indefinite block */
942 if (!dev->is_open()) {
943 if (!dev->is_busy()) {
944 unload_autochanger(dcr, -1);
946 Dmsg0(90, "Device already released\n");
947 dir->fsend(_("3921 Device %s already released.\n"),
950 } else if (dev->blocked() == BST_WAITING_FOR_SYSOP) {
951 Dmsg2(90, "%d waiter dev_block=%d.\n", dev->num_waiting,
953 unload_autochanger(dcr, -1);
954 dir->fsend(_("3922 Device %s waiting for sysop.\n"),
957 } else if (dev->blocked() == BST_UNMOUNTED_WAITING_FOR_SYSOP) {
958 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
960 dir->fsend(_("3922 Device %s waiting for mount.\n"),
963 } else if (dev->blocked() == BST_DOING_ACQUIRE) {
964 dir->fsend(_("3923 Device %s is busy in acquire.\n"),
967 } else if (dev->blocked() == BST_WRITING_LABEL) {
968 dir->fsend(_("3914 Device %s is being labeled.\n"),
971 } else if (dev->is_busy()) {
972 send_dir_busy_message(dir, dev);
973 } else { /* device not being used */
974 Dmsg0(90, "Device not in use, releasing\n");
975 dcr->release_volume();
976 dir->fsend(_("3022 Device %s released.\n"),
982 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
985 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
986 pm_strcpy(jcr->errmsg, dir->msg);
987 dir->fsend(_("3927 Error scanning release command: %s\n"), jcr->errmsg);
989 dir->signal(BNET_EOD);
993 static pthread_mutex_t bsr_mutex = PTHREAD_MUTEX_INITIALIZER;
994 static uint32_t bsr_uniq = 0;
996 static bool get_bootstrap_file(JCR *jcr, BSOCK *sock)
998 POOLMEM *fname = get_pool_memory(PM_FNAME);
1002 if (jcr->RestoreBootstrap) {
1003 unlink(jcr->RestoreBootstrap);
1004 free_pool_memory(jcr->RestoreBootstrap);
1008 Mmsg(fname, "%s/%s.%s.%d.bootstrap", me->working_directory, me->hdr.name,
1009 jcr->Job, bsr_uniq);
1011 Dmsg1(400, "bootstrap=%s\n", fname);
1012 jcr->RestoreBootstrap = fname;
1013 bs = fopen(fname, "a+b"); /* create file */
1016 Jmsg(jcr, M_FATAL, 0, _("Could not create bootstrap file %s: ERR=%s\n"),
1017 jcr->RestoreBootstrap, be.bstrerror());
1020 Dmsg0(10, "=== Bootstrap file ===\n");
1021 while (sock->recv() >= 0) {
1022 Dmsg1(10, "%s", sock->msg);
1023 fputs(sock->msg, bs);
1026 Dmsg0(10, "=== end bootstrap file ===\n");
1027 jcr->bsr = parse_bsr(jcr, jcr->RestoreBootstrap);
1029 Jmsg(jcr, M_FATAL, 0, _("Error parsing bootstrap file.\n"));
1032 if (debug_level >= 10) {
1033 dump_bsr(jcr->bsr, true);
1035 /* If we got a bootstrap, we are reading, so create read volume list */
1036 create_restore_volume_list(jcr);
1040 unlink(jcr->RestoreBootstrap);
1041 free_pool_memory(jcr->RestoreBootstrap);
1042 jcr->RestoreBootstrap = NULL;
1044 sock->fsend(ERROR_bootstrap);
1047 return sock->fsend(OK_bootstrap);
1050 static bool bootstrap_cmd(JCR *jcr)
1052 return get_bootstrap_file(jcr, jcr->dir_bsock);
1056 * Autochanger command from Director
1058 static bool changer_cmd(JCR *jcr)
1061 BSOCK *dir = jcr->dir_bsock;
1064 const char *cmd = NULL;
1067 * A safe_cmd may call autochanger script but does not load/unload
1068 * slots so it can be done at the same time that the drive is open.
1070 bool safe_cmd = false;
1072 if (sscanf(dir->msg, "autochanger listall %127s", devname.c_str()) == 1) {
1074 safe_cmd = ok = true;
1075 } else if (sscanf(dir->msg, "autochanger list %127s", devname.c_str()) == 1) {
1077 safe_cmd = ok = true;
1078 } else if (sscanf(dir->msg, "autochanger slots %127s", devname.c_str()) == 1) {
1080 safe_cmd = ok = true;
1081 } else if (sscanf(dir->msg, "autochanger drives %127s", devname.c_str()) == 1) {
1083 safe_cmd = ok = true;
1086 dcr = find_device(jcr, devname, -1);
1089 dev->dlock(); /* Use P to avoid indefinite block */
1090 if (!dev->device->changer_res) {
1091 dir->fsend(_("3995 Device %s is not an autochanger.\n"),
1093 /* Under certain "safe" conditions, we can steal the lock */
1094 } else if (safe_cmd || !dev->is_open() || dev->can_steal_lock()) {
1095 autochanger_cmd(dcr, dir, cmd);
1096 } else if (dev->is_busy() || dev->is_blocked()) {
1097 send_dir_busy_message(dir, dev);
1098 } else { /* device not being used */
1099 autochanger_cmd(dcr, dir, cmd);
1104 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
1106 } else { /* error on scanf */
1107 pm_strcpy(jcr->errmsg, dir->msg);
1108 dir->fsend(_("3908 Error scanning autocharger drives/list/slots command: %s\n"),
1111 dir->signal(BNET_EOD);
1116 * Read and return the Volume label
1118 static bool readlabel_cmd(JCR *jcr)
1121 BSOCK *dir = jcr->dir_bsock;
1127 if (sscanf(dir->msg, "readlabel %127s Slot=%d drive=%d", devname.c_str(),
1128 &Slot, &drive) == 3) {
1129 dcr = find_device(jcr, devname, drive);
1132 dev->dlock(); /* Use P to avoid indefinite block */
1133 if (!dev->is_open()) {
1134 read_volume_label(jcr, dcr, dev, Slot);
1136 /* Under certain "safe" conditions, we can steal the lock */
1137 } else if (dev->can_steal_lock()) {
1138 read_volume_label(jcr, dcr, dev, Slot);
1139 } else if (dev->is_busy() || dev->is_blocked()) {
1140 send_dir_busy_message(dir, dev);
1141 } else { /* device not being used */
1142 read_volume_label(jcr, dcr, dev, Slot);
1147 dir->fsend(_("3999 Device \"%s\" not found or could not be opened.\n"), devname.c_str());
1150 pm_strcpy(jcr->errmsg, dir->msg);
1151 dir->fsend(_("3909 Error scanning readlabel command: %s\n"), jcr->errmsg);
1153 dir->signal(BNET_EOD);
1159 * Read the tape label
1161 * Enter with the mutex set
1163 static void read_volume_label(JCR *jcr, DCR *dcr, DEVICE *dev, int Slot)
1165 BSOCK *dir = jcr->dir_bsock;
1169 steal_device_lock(dev, &hold, BST_WRITING_LABEL);
1171 if (!try_autoload_device(jcr, dcr, Slot, "")) {
1172 goto bail_out; /* error */
1175 dev->clear_labeled(); /* force read of label */
1176 switch (read_dev_volume_label(dcr)) {
1178 /* DO NOT add quotes around the Volume name. It is scanned in the DIR */
1179 dir->fsend(_("3001 Volume=%s Slot=%d\n"), dev->VolHdr.VolumeName, Slot);
1180 Dmsg1(100, "Volume: %s\n", dev->VolHdr.VolumeName);
1183 dir->fsend(_("3902 Cannot mount Volume on Storage Device %s because:\n%s"),
1184 dev->print_name(), jcr->errmsg);
1189 give_back_device_lock(dev, &hold);
1193 static bool try_autoload_device(JCR *jcr, DCR *dcr, int slot, const char *VolName)
1195 BSOCK *dir = jcr->dir_bsock;
1197 bstrncpy(dcr->VolumeName, VolName, sizeof(dcr->VolumeName));
1198 dcr->VolCatInfo.Slot = slot;
1199 dcr->VolCatInfo.InChanger = slot > 0;
1200 if (autoload_device(dcr, 0, dir) < 0) { /* autoload if possible */
1206 static void send_dir_busy_message(BSOCK *dir, DEVICE *dev)
1208 if (dev->is_blocked()) {
1209 switch (dev->blocked()) {
1211 dir->fsend(_("3931 Device %s is BLOCKED. user unmounted.\n"),
1214 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
1215 dir->fsend(_("3932 Device %s is BLOCKED. user unmounted during wait for media/mount.\n"),
1218 case BST_WAITING_FOR_SYSOP:
1219 dir->fsend(_("3933 Device %s is BLOCKED waiting for media.\n"),
1222 case BST_DOING_ACQUIRE:
1223 dir->fsend(_("3934 Device %s is being initialized.\n"),
1226 case BST_WRITING_LABEL:
1227 dir->fsend(_("3935 Device %s is blocked labeling a Volume.\n"),
1231 dir->fsend(_("3935 Device %s is blocked for unknown reason.\n"),
1235 } else if (dev->can_read()) {
1236 dir->fsend(_("3936 Device %s is busy reading.\n"),
1237 dev->print_name());;
1239 dir->fsend(_("3937 Device %s is busy with %d writer(s).\n"),
1240 dev->print_name(), dev->num_writers);