2 * This file handles accepting Director Commands
4 * Most Director commands are handled here, with the
5 * exception of the Job command command and subsequent
6 * subcommands that are handled
9 * N.B. in this file, in general we must use P(dev->mutex) rather
10 * than lock_device(dev) so that we can examine the blocked
11 * state rather than blocking ourselves. In some "safe" cases,
12 * we can do things to a blocked device. CAREFUL!!!!
14 * File daemon commands are handled in fdcmd.c
16 * Kern Sibbald, May MMI
22 Copyright (C) 2000-2003 Kern Sibbald and John Walker
24 This program is free software; you can redistribute it and/or
25 modify it under the terms of the GNU General Public License as
26 published by the Free Software Foundation; either version 2 of
27 the License, or (at your option) any later version.
29 This program is distributed in the hope that it will be useful,
30 but WITHOUT ANY WARRANTY; without even the implied warranty of
31 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
32 General Public License for more details.
34 You should have received a copy of the GNU General Public
35 License along with this program; if not, write to the Free
36 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
44 /* Exported variables */
46 /* Imported variables */
47 extern BSOCK *filed_chan;
48 extern int r_first, r_last;
49 extern struct s_res resources[];
50 extern char my_name[];
51 extern time_t daemon_start_time;
52 extern struct s_last_job last_job;
54 /* Static variables */
55 static char derrmsg[] = "3900 Invalid command\n";
56 static char OKsetdebug[] = "3000 OK setdebug=%d\n";
59 /* Imported functions */
60 extern void terminate_child();
61 extern int job_cmd(JCR *jcr);
62 extern int status_cmd(JCR *sjcr);
64 /* Forward referenced functions */
65 static int label_cmd(JCR *jcr);
66 static int relabel_cmd(JCR *jcr);
67 static int setdebug_cmd(JCR *jcr);
68 static int cancel_cmd(JCR *cjcr);
69 static int mount_cmd(JCR *jcr);
70 static int unmount_cmd(JCR *jcr);
71 static int autochanger_cmd(JCR *sjcr);
72 static int do_label(JCR *jcr, int relabel);
73 static void label_volume_if_ok(JCR *jcr, DEVICE *dev, char *oldname,
74 char *newname, char *poolname,
75 int Slot, int relabel);
79 int (*func)(JCR *jcr);
83 * The following are the recognized commands from the Director.
85 static struct s_cmds cmds[] = {
86 {"JobId=", job_cmd}, /* start Job */
87 {"setdebug=", setdebug_cmd}, /* set debug level */
88 {"cancel", cancel_cmd},
89 {"label", label_cmd}, /* label a tape */
90 {"relabel", relabel_cmd}, /* relabel a tape */
92 {"unmount", unmount_cmd},
93 {"status", status_cmd},
94 {"autochanger", autochanger_cmd},
95 {NULL, NULL} /* list terminator */
100 * Connection request. We accept connections either from the
101 * Director or a Client.
103 * Note, we are running as a seperate thread of the Storage daemon.
104 * and it is because a Director has made a connection with
105 * us on the "Message" channel.
107 * Basic tasks done here:
108 * - Create a JCR record
109 * - Authenticate the Director
110 * - We wait for a command
111 * - We execute the command
112 * - We continue or exit depending on the return status
114 void *connection_request(void *arg)
116 BSOCK *bs = (BSOCK *)arg;
120 char name[MAX_NAME_LENGTH];
122 if (bnet_recv(bs) <= 0) {
123 Emsg0(M_ERROR, 0, _("Connection request failed.\n"));
128 * See if this is a File daemon connection
130 if (bs->msglen < 25 || bs->msglen > (int)sizeof(name)+25) {
131 Emsg1(M_ERROR, 0, _("Invalid Dir connection. Len=%d\n"), bs->msglen);
133 if (sscanf(bs->msg, "Hello Start Job %127s calling\n", name) == 1) {
134 handle_filed_connection(bs, name);
138 jcr = new_jcr(sizeof(JCR), stored_free_jcr); /* create Job Control Record */
139 jcr->dir_bsock = bs; /* save Director bsock */
141 Dmsg0(1000, "stored in start_job\n");
144 * Authenticate the Director
146 if (!authenticate_director(jcr)) {
147 Jmsg(jcr, M_FATAL, 0, _("Unable to authenticate Director\n"));
151 Dmsg0(90, "Message channel init completed.\n");
153 for (quit=0; !quit;) {
155 if ((bnet_stat = bnet_recv(bs)) <= 0) {
156 break; /* connection terminated */
158 Dmsg1(9, "<dird: %s\n", bs->msg);
160 for (i=0; cmds[i].cmd; i++) {
161 if (strncmp(cmds[i].cmd, bs->msg, strlen(cmds[i].cmd)) == 0) {
162 if (!cmds[i].func(jcr)) { /* do command */
163 quit = TRUE; /* error, get out */
164 Dmsg1(90, "Command %s requsts quit\n", cmds[i].cmd);
166 found = TRUE; /* indicate command found */
170 if (!found) { /* command not found */
171 bnet_fsend(bs, derrmsg);
176 if (bnet_stat != BNET_TERMINATE) {
177 bnet_sig(bs, BNET_TERMINATE);
184 * Set debug level as requested by the Director
187 static int setdebug_cmd(JCR *jcr)
189 BSOCK *dir = jcr->dir_bsock;
192 Dmsg1(10, "setdebug_cmd: %s", dir->msg);
193 if (sscanf(dir->msg, "setdebug=%d", &level) != 1 || level < 0) {
194 bnet_fsend(dir, "3991 Bad setdebug command: %s\n", dir->msg);
198 return bnet_fsend(dir, OKsetdebug, level);
205 static int cancel_cmd(JCR *cjcr)
207 BSOCK *dir = cjcr->dir_bsock;
209 char Job[MAX_NAME_LENGTH];
212 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
213 if (!(jcr=get_jcr_by_full_name(Job))) {
214 bnet_fsend(dir, _("3992 Job %s not found.\n"), Job);
217 oldStatus = jcr->JobStatus;
218 set_jcr_job_status(jcr, JS_Canceled);
219 if (!jcr->authenticated && oldStatus == JS_WaitFD) {
220 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting thread */
223 if (jcr->file_bsock) {
224 bnet_sig(jcr->file_bsock, BNET_TERMINATE);
226 /* If thread waiting on mount, wake him */
227 if (jcr->device && jcr->device->dev &&
228 (jcr->device->dev->dev_blocked == BST_WAITING_FOR_SYSOP ||
229 jcr->device->dev->dev_blocked == BST_UNMOUNTED ||
230 jcr->device->dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP)) {
231 pthread_cond_signal(&jcr->device->dev->wait_next_vol);
233 bnet_fsend(dir, _("3000 Job %s marked to be canceled.\n"), jcr->Job);
237 bnet_fsend(dir, _("3993 Error scanning cancel command.\n"));
239 bnet_sig(dir, BNET_EOD);
247 static int label_cmd(JCR *jcr)
249 return do_label(jcr, 0);
252 static int relabel_cmd(JCR *jcr)
254 return do_label(jcr, 1);
257 static int do_label(JCR *jcr, int relabel)
259 POOLMEM *dname, *newname, *oldname, *poolname, *mtype;
260 BSOCK *dir = jcr->dir_bsock;
263 int found = 0, ok = 0;
266 dname = get_memory(dir->msglen+1);
267 newname = get_memory(dir->msglen+1);
268 oldname = get_memory(dir->msglen+1);
269 poolname = get_memory(dir->msglen+1);
270 mtype = get_memory(dir->msglen+1);
272 if (sscanf(dir->msg, "relabel %s OldName=%s NewName=%s PoolName=%s MediaType=%s Slot=%d",
273 dname, oldname, newname, poolname, mtype, &slot) == 6) {
278 if (sscanf(dir->msg, "label %s VolumeName=%s PoolName=%s MediaType=%s Slot=%d",
279 dname, newname, poolname, mtype, &slot) == 5) {
284 unbash_spaces(dname);
285 unbash_spaces(newname);
286 unbash_spaces(oldname);
287 unbash_spaces(poolname);
288 unbash_spaces(mtype);
291 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
292 /* Find resource, and make sure we were able to open it */
293 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
294 Dmsg1(20, "Found device %s\n", device->hdr.name);
301 /******FIXME**** compare MediaTypes */
302 jcr->device = device;
305 P(dev->mutex); /* Use P to avoid indefinite block */
306 if (!(dev->state & ST_OPENED)) {
307 if (open_dev(dev, newname, READ_WRITE) < 0) {
308 bnet_fsend(dir, _("3994 Connot open device: %s\n"), strerror_dev(dev));
310 label_volume_if_ok(jcr, dev, oldname, newname, poolname, slot, relabel);
311 force_close_dev(dev);
313 /* Under certain "safe" conditions, we can steal the lock */
314 } else if (dev->dev_blocked &&
315 (dev->dev_blocked == BST_UNMOUNTED ||
316 dev->dev_blocked == BST_WAITING_FOR_SYSOP ||
317 dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP)) {
318 label_volume_if_ok(jcr, dev, oldname, newname, poolname, slot, relabel);
319 } else if (dev->state & ST_READ || dev->num_writers) {
320 if (dev->state & ST_READ) {
321 bnet_fsend(dir, _("3901 Device %s is busy with 1 reader.\n"),
324 bnet_fsend(dir, _("3902 Device %s is busy with %d writer(s).\n"),
325 dev_name(dev), dev->num_writers);
327 } else { /* device not being used */
328 label_volume_if_ok(jcr, dev, oldname, newname, poolname, slot, relabel);
332 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
335 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
336 pm_strcpy(&jcr->errmsg, dir->msg);
337 bnet_fsend(dir, _("3903 Error scanning label command: %s\n"), jcr->errmsg);
340 free_memory(oldname);
341 free_memory(newname);
342 free_memory(poolname);
344 bnet_sig(dir, BNET_EOD);
349 * Read the tape label and determine if we can safely
350 * label the tape (not a Bacula volume), then label it.
352 * Enter with the mutex set
354 static void label_volume_if_ok(JCR *jcr, DEVICE *dev, char *oldname,
355 char *newname, char *poolname,
356 int slot, int relabel)
358 BSOCK *dir = jcr->dir_bsock;
362 steal_device_lock(dev, &hold, BST_WRITING_LABEL);
364 pm_strcpy(&jcr->VolumeName, newname);
365 jcr->VolCatInfo.Slot = slot;
366 autoload_device(jcr, dev, 0, dir); /* autoload if possible */
367 block = new_block(dev);
369 /* Ensure that the device is open -- not autoload_device() closes it */
370 for ( ; !(dev->state & ST_OPENED); ) {
371 if (open_dev(dev, jcr->VolumeName, READ_WRITE) < 0) {
372 if (dev->dev_errno == EAGAIN || dev->dev_errno == EBUSY) {
375 bnet_fsend(dir, _("3910 Unable to open device %s. ERR=%s\n"),
376 dev_name(dev), strerror_dev(dev));
381 /* See what we have for a Volume */
382 switch (read_dev_volume_label(jcr, dev, block)) {
384 case VOL_VERSION_ERROR:
385 case VOL_LABEL_ERROR:
389 "3911 Cannot label Volume because it is already labeled: %s\n"),
390 dev->VolHdr.VolName);
393 /* Relabel request. If oldname matches, continue */
394 if (strcmp(oldname, dev->VolHdr.VolName) != 0) {
395 bnet_fsend(dir, _("Wrong volume mounted.\n"));
398 /* Fall through wanted! */
401 if (!write_volume_label_to_dev(jcr, jcr->device, newname, poolname)) {
402 bnet_fsend(dir, _("3912 Failed to label Volume: ERR=%s\n"), strerror_dev(dev));
405 strcpy(jcr->VolumeName, newname);
406 bnet_fsend(dir, _("3000 OK label. Volume=%s Device=%s\n"),
407 newname, dev->dev_name);
410 bnet_fsend(dir, _("3912 Failed to label Volume: ERR=%s\n"), strerror_dev(dev));
413 bnet_fsend(dir, _("3913 Cannot label Volume. \
414 Unknown status %d from read_volume_label()\n"), jcr->label_status);
419 return_device_lock(dev, &hold);
424 * Read the tape label
426 * Enter with the mutex set
428 static int read_label(JCR *jcr, DEVICE *dev)
431 BSOCK *dir = jcr->dir_bsock;
435 steal_device_lock(dev, &hold, BST_DOING_ACQUIRE);
437 jcr->VolumeName[0] = 0;
438 block = new_block(dev);
439 dev->state &= ~ST_LABEL; /* force read of label */
440 switch (read_dev_volume_label(jcr, dev, block)) {
442 bnet_fsend(dir, _("3001 Mounted Volume: %s\n"), dev->VolHdr.VolName);
446 bnet_fsend(dir, _("3902 Cannot mount Volume on Storage Device \"%s\" because:\n%s\n"),
447 dev->dev_name, jcr->errmsg);
452 return_device_lock(dev, &hold);
457 * Mount command from Director
459 static int mount_cmd(JCR *jcr)
462 BSOCK *dir = jcr->dir_bsock;
467 dev_name = get_memory(dir->msglen+1);
468 if (sscanf(dir->msg, "mount %s", dev_name) == 1) {
469 unbash_spaces(dev_name);
472 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
473 /* Find resource, and make sure we were able to open it */
474 if (strcmp(device->hdr.name, dev_name) == 0 && device->dev) {
475 Dmsg1(20, "Found device %s\n", device->hdr.name);
482 jcr->device = device;
484 P(dev->mutex); /* Use P to avoid indefinite block */
485 switch (dev->dev_blocked) { /* device blocked? */
487 case BST_WAITING_FOR_SYSOP:
488 /* Someone is waiting, wake him */
489 Dmsg0(100, "Waiting for mount. Attempting to wake thread\n");
490 dev->dev_blocked = BST_MOUNT;
491 pthread_cond_signal(&dev->wait_next_vol);
492 bnet_fsend(dir, "3001 OK mount. Device=%s\n", dev->dev_name);
495 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
497 /* We freed the device, so reopen it and wake any waiting threads */
498 if (open_dev(dev, NULL, READ_WRITE) < 0) {
499 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
503 block = new_block(dev);
504 read_dev_volume_label(jcr, dev, block);
506 if (dev->dev_blocked == BST_UNMOUNTED) {
507 Dmsg0(100, "Unmounted. Unblocking device\n");
508 read_label(jcr, dev);
511 Dmsg0(100, "Unmounted waiting for mount. Attempting to wake thread\n");
512 dev->dev_blocked = BST_MOUNT;
513 pthread_cond_signal(&dev->wait_next_vol);
515 if (dev->state & ST_LABEL) {
516 bnet_fsend(dir, _("3001 Device %s is mounted with Volume \"%s\"\n"),
517 dev->dev_name, dev->VolHdr.VolName);
519 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"
520 "Try unmounting and remounting the Volume.\n"),
525 case BST_DOING_ACQUIRE:
526 bnet_fsend(dir, _("3001 Device %s is mounted; doing acquire.\n"),
530 case BST_WRITING_LABEL:
531 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"), dev->dev_name);
534 case BST_NOT_BLOCKED:
535 if (dev->state & ST_OPENED) {
536 if (dev->state & ST_LABEL) {
537 bnet_fsend(dir, _("3001 Device %s is mounted with Volume \"%s\"\n"),
538 dev->dev_name, dev->VolHdr.VolName);
540 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"
541 "Try unmounting and remounting the Volume.\n"),
545 if (!dev_is_tape(dev)) {
546 bnet_fsend(dir, _("3906 cannot mount non-tape.\n"));
549 if (open_dev(dev, NULL, READ_WRITE) < 0) {
550 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
554 read_label(jcr, dev);
555 if (dev->state & ST_LABEL) {
556 bnet_fsend(dir, _("3001 Device %s is mounted with Volume \"%s\"\n"),
557 dev->dev_name, dev->VolHdr.VolName);
559 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"
560 "Try unmounting and remounting the Volume.\n"),
567 bnet_fsend(dir, _("3905 Bizarre wait state %d\n"), dev->dev_blocked);
572 bnet_fsend(dir, _("3999 Device %s not found\n"), dev_name);
575 pm_strcpy(&jcr->errmsg, dir->msg);
576 bnet_fsend(dir, _("3906 Error scanning mount command: %s\n"), jcr->errmsg);
578 free_memory(dev_name);
579 bnet_sig(dir, BNET_EOD);
584 * unmount command from Director
586 static int unmount_cmd(JCR *jcr)
589 BSOCK *dir = jcr->dir_bsock;
594 dname = get_memory(dir->msglen+1);
595 if (sscanf(dir->msg, "unmount %s", dname) == 1) {
596 unbash_spaces(dname);
599 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
600 /* Find resource, and make sure we were able to open it */
601 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
602 Dmsg1(20, "Found device %s\n", device->hdr.name);
609 jcr->device = device;
611 P(dev->mutex); /* Use P to avoid indefinite block */
612 if (!(dev->state & ST_OPENED)) {
613 Dmsg0(90, "Device already unmounted\n");
614 bnet_fsend(dir, _("3901 Device %s is already unmounted.\n"), dev_name(dev));
616 } else if (dev->dev_blocked == BST_WAITING_FOR_SYSOP) {
617 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
619 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
622 force_close_dev(dev);
623 dev->dev_blocked = BST_UNMOUNTED_WAITING_FOR_SYSOP;
624 bnet_fsend(dir, _("3001 Device %s unmounted.\n"), dev_name(dev));
626 } else if (dev->dev_blocked == BST_DOING_ACQUIRE) {
627 bnet_fsend(dir, _("3902 Device %s is busy in acquire.\n"),
630 } else if (dev->dev_blocked == BST_WRITING_LABEL) {
631 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"),
634 } else if (dev->state & ST_READ || dev->num_writers) {
635 if (dev->state & ST_READ) {
636 Dmsg0(90, "Device in read mode\n");
637 bnet_fsend(dir, _("3904 Device %s is busy with 1 reader.\n"),
640 Dmsg1(90, "Device busy with %d writers\n", dev->num_writers);
641 bnet_fsend(dir, _("3905 Device %s is busy with %d writer(s).\n"),
642 dev_name(dev), dev->num_writers);
645 } else { /* device not being used */
646 Dmsg0(90, "Device not in use, unmounting\n");
647 block_device(dev, BST_UNMOUNTED);
648 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
651 force_close_dev(dev);
652 bnet_fsend(dir, _("3002 Device %s unmounted.\n"), dev_name(dev));
656 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
659 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
660 pm_strcpy(&jcr->errmsg, dir->msg);
661 bnet_fsend(dir, _("3907 Error scanning unmount command: %s\n"), jcr->errmsg);
664 bnet_sig(dir, BNET_EOD);
670 * Autochanger command from Director
672 static int autochanger_cmd(JCR *jcr)
675 BSOCK *dir = jcr->dir_bsock;
680 devname = get_memory(dir->msglen+1);
681 if (sscanf(dir->msg, "autochanger list %s ", devname) == 1) {
682 unbash_spaces(devname);
685 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
686 /* Find resource, and make sure we were able to open it */
687 if (strcmp(device->hdr.name, devname) == 0 && device->dev) {
688 Dmsg1(20, "Found device %s\n", device->hdr.name);
695 jcr->device = device;
697 P(dev->mutex); /* Use P to avoid indefinite block */
698 if (!dev_is_tape(dev)) {
699 bnet_fsend(dir, _("3995 Device %s is not an autochanger.\n"),
701 } else if (!(dev->state & ST_OPENED)) {
702 if (open_dev(dev, NULL, READ_WRITE) < 0) {
703 bnet_fsend(dir, _("3994 Connot open device: %s\n"), strerror_dev(dev));
705 autochanger_list(jcr, dev, dir);
706 force_close_dev(dev);
708 /* Under certain "safe" conditions, we can steal the lock */
709 } else if (dev->dev_blocked &&
710 (dev->dev_blocked == BST_UNMOUNTED ||
711 dev->dev_blocked == BST_WAITING_FOR_SYSOP ||
712 dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP)) {
713 autochanger_list(jcr, dev, dir);
714 } else if (dev->state & ST_READ || dev->num_writers) {
715 if (dev->state & ST_READ) {
716 bnet_fsend(dir, _("3901 Device %s is busy with 1 reader.\n"),
719 bnet_fsend(dir, _("3902 Device %s is busy with %d writer(s).\n"),
720 dev_name(dev), dev->num_writers);
722 } else { /* device not being used */
723 autochanger_list(jcr, dev, dir);
727 bnet_fsend(dir, _("3999 Device %s not found\n"), devname);
729 } else { /* error on scanf */
730 pm_strcpy(&jcr->errmsg, dir->msg);
731 bnet_fsend(dir, _("3907 Error scanning autocharger list command: %s\n"),
734 free_memory(devname);
735 bnet_sig(dir, BNET_EOD);