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 * File daemon commands are handled in fdcmd.c
11 * Kern Sibbald, May MMI
17 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
19 This program is free software; you can redistribute it and/or
20 modify it under the terms of the GNU General Public License as
21 published by the Free Software Foundation; either version 2 of
22 the License, or (at your option) any later version.
24 This program is distributed in the hope that it will be useful,
25 but WITHOUT ANY WARRANTY; without even the implied warranty of
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 General Public License for more details.
29 You should have received a copy of the GNU General Public
30 License along with this program; if not, write to the Free
31 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
39 /* Exported variables */
41 /* Imported variables */
42 extern BSOCK *filed_chan;
43 extern int r_first, r_last;
44 extern struct s_res resources[];
45 extern char my_name[];
46 extern time_t daemon_start_time;
47 extern struct s_last_job last_job;
49 /* Static variables */
50 static char derrmsg[] = "3900 Invalid command\n";
51 static char OKsetdebug[] = "3000 OK setdebug=%d\n";
54 /* Imported functions */
55 extern void terminate_child();
56 extern int job_cmd(JCR *jcr);
58 /* Forward referenced functions */
59 static int label_cmd(JCR *jcr);
60 static int setdebug_cmd(JCR *jcr);
61 static int cancel_cmd(JCR *cjcr);
62 static int mount_cmd(JCR *jcr);
63 static int unmount_cmd(JCR *jcr);
64 static int status_cmd(JCR *sjcr);
65 static void label_volume_if_ok(JCR *jcr, DEVICE *dev, char *vname, char *poolname);
69 int (*func)(JCR *jcr);
73 * The following are the recognized commands from the Director.
75 static struct s_cmds cmds[] = {
76 {"JobId=", job_cmd}, /* start Job */
77 {"setdebug=", setdebug_cmd}, /* set debug level */
78 {"cancel", cancel_cmd},
79 {"label", label_cmd}, /* label a tape */
81 {"unmount", unmount_cmd},
82 {"status", status_cmd},
83 {NULL, NULL} /* list terminator */
88 * Connection request. We accept connections either from the
89 * Director or a Client.
91 * Note, we are running as a seperate thread of the Storage daemon.
92 * and it is because a Director has made a connection with
93 * us on the "Message" channel.
95 * Basic tasks done here:
96 * - Create a JCR record
97 * - Authenticate the Director
98 * - We wait for a command
99 * - We execute the command
100 * - We continue or exit depending on the return status
102 void connection_request(void *arg)
104 BSOCK *bs = (BSOCK *)arg;
108 char name[MAX_NAME_LENGTH];
110 if (bnet_recv(bs) <= 0) {
111 Emsg0(M_ERROR, 0, "Connection request failed.\n");
116 * See if this is a File daemon connection
118 if (sscanf(bs->msg, "Hello Start Job %127s calling\n", name) == 1) {
119 handle_filed_connection(bs, name);
123 jcr = new_jcr(sizeof(JCR), stored_free_jcr); /* create Job Control Record */
124 jcr->dir_bsock = bs; /* save Director bsock */
126 Dmsg0(1000, "stored in start_job\n");
129 * Authenticate the Director
131 if (!authenticate_director(jcr)) {
132 Jmsg(jcr, M_FATAL, 0, _("Unable to authenticate Director\n"));
136 Dmsg0(90, "Message channel init completed.\n");
138 for (quit=0; !quit;) {
141 if ((bnet_stat = bnet_recv(bs)) <= 0) {
142 break; /* connection terminated */
144 Dmsg1(9, "<dird: %s\n", bs->msg);
146 for (i=0; cmds[i].cmd; i++) {
147 if (strncmp(cmds[i].cmd, bs->msg, strlen(cmds[i].cmd)) == 0) {
148 if (!cmds[i].func(jcr)) { /* do command */
149 quit = TRUE; /* error, get out */
150 Dmsg1(90, "Command %s requsts quit\n", cmds[i].cmd);
152 found = TRUE; /* indicate command found */
156 if (!found) { /* command not found */
157 bnet_fsend(bs, derrmsg);
162 if (bnet_stat != BNET_TERMINATE) {
163 bnet_sig(bs, BNET_TERMINATE);
170 * Set debug level as requested by the Director
173 static int setdebug_cmd(JCR *jcr)
175 BSOCK *dir = jcr->dir_bsock;
178 Dmsg1(10, "setdebug_cmd: %s", dir->msg);
179 if (sscanf(dir->msg, "setdebug=%d", &level) != 1 || level < 0) {
180 bnet_fsend(dir, "3991 Bad setdebug command: %s\n", dir->msg);
184 return bnet_fsend(dir, OKsetdebug, level);
191 static int cancel_cmd(JCR *cjcr)
193 BSOCK *dir = cjcr->dir_bsock;
195 char Job[MAX_NAME_LENGTH];
198 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
199 if (!(jcr=get_jcr_by_full_name(Job))) {
200 bnet_fsend(dir, _("3992 Job %s not found.\n"), Job);
203 oldStatus = jcr->JobStatus;
204 jcr->JobStatus = JS_Cancelled;
205 if (!jcr->authenticated && jcr->JobStatus == JS_WaitFD) {
206 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting thread */
209 if (jcr->file_bsock) {
210 bnet_sig(jcr->file_bsock, BNET_TERMINATE);
212 bnet_fsend(dir, _("3000 Job %s Status=%c marked to be cancelled.\n"),
213 jcr->Job, oldStatus);
217 bnet_fsend(dir, _("3993 Error scanning cancel command.\n"));
219 bnet_sig(dir, BNET_EOF);
227 static int label_cmd(JCR *jcr)
229 char *dname, *volname, *poolname, *mtype;
230 BSOCK *dir = jcr->dir_bsock;
235 dname = (char *) get_memory(dir->msglen+1);
236 volname = (char *) get_memory(dir->msglen+1);
237 poolname = (char *) get_memory(dir->msglen+1);
238 mtype = (char *) get_memory(dir->msglen+1);
239 if (sscanf(dir->msg, "label %s VolumeName=%s PoolName=%s MediaType=%s",
240 dname, volname, poolname, mtype) == 4) {
241 unbash_spaces(dname);
242 unbash_spaces(volname);
243 unbash_spaces(poolname);
244 unbash_spaces(mtype);
247 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
248 /* Find resource, and make sure we were able to open it */
249 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
250 Dmsg1(20, "Found device %s\n", device->hdr.name);
257 /******FIXME**** compare MediaTypes */
258 jcr->device = device;
261 if (!(dev->state & ST_OPENED)) {
262 if (open_dev(dev, volname, READ_WRITE) < 0) {
263 bnet_fsend(dir, _("3994 Connot open device: %s\n"), strerror_dev(dev));
265 label_volume_if_ok(jcr, dev, volname, poolname);
266 force_close_dev(dev);
268 } else if (dev->dev_blocked &&
269 dev->dev_blocked != BST_DOING_ACQUIRE) { /* device blocked? */
270 label_volume_if_ok(jcr, dev, volname, poolname);
271 } else if (dev->state & ST_READ || dev->num_writers) {
272 if (dev->state & ST_READ) {
273 bnet_fsend(dir, _("3901 Device %s is busy with 1 reader.\n"),
276 bnet_fsend(dir, _("3902 Device %s is busy with %d writer(s).\n"),
277 dev_name(dev), dev->num_writers);
279 } else { /* device not being used */
280 label_volume_if_ok(jcr, dev, volname, poolname);
284 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
287 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
288 strcpy(dname, dir->msg);
289 bnet_fsend(dir, _("3903 Error scanning label command: %s\n"), dname);
292 free_memory(volname);
293 free_memory(poolname);
295 bnet_sig(dir, BNET_EOF);
300 * Read the tape label and determine if we can safely
301 * label the tape (not a Bacula volume), then label it.
303 * Enter with the mutex set
305 static void label_volume_if_ok(JCR *jcr, DEVICE *dev, char *vname, char *poolname)
307 BSOCK *dir = jcr->dir_bsock;
310 pthread_t no_wait_id;
312 blocked = dev->dev_blocked; /* save any prev blocked state */
313 no_wait_id = dev->no_wait_id;
314 dev->dev_blocked = BST_WRITING_LABEL;
315 dev->no_wait_id = pthread_self(); /* let us use the tape */
316 V(dev->mutex); /* release lock */
318 strcpy(jcr->VolumeName, vname);
319 block = new_block(dev);
320 switch (read_dev_volume_label(jcr, dev, block)) {
322 case VOL_VERSION_ERROR:
323 case VOL_LABEL_ERROR:
325 bnet_fsend(dir, _("3901 Cannot label Volume because it is \
326 already labeled: %s\n"), dev->VolHdr.VolName);
330 write_volume_label_to_dev(jcr, jcr->device, vname, poolname);
331 strcpy(jcr->VolumeName, vname);
332 bnet_fsend(dir, _("3000 OK label. Volume=%s Device=%s\n"),
333 vname, dev->dev_name);
336 bnet_fsend(dir, _("3902 Cannot label Volume. \
337 Unknown status %d from read_volume_label()\n"), jcr->label_status);
342 dev->dev_blocked = blocked; /* reset blocked state */
343 dev->no_wait_id = no_wait_id; /* reset blocking thread id */
348 * Read the tape label
350 * Enter with the mutex set
352 static int read_label(JCR *jcr, DEVICE *dev)
354 BSOCK *dir = jcr->dir_bsock;
357 pthread_t no_wait_id;
360 blocked = dev->dev_blocked; /* save any prev blocked state */
361 no_wait_id = dev->no_wait_id;
362 dev->dev_blocked = BST_DOING_ACQUIRE;
363 dev->no_wait_id = pthread_self(); /* let us use the tape */
364 V(dev->mutex); /* release lock */
366 jcr->VolumeName[0] = 0;
367 block = new_block(dev);
368 dev->state &= ~ST_LABEL; /* force read of label */
369 switch (read_dev_volume_label(jcr, dev, block)) {
371 bnet_fsend(dir, _("3001 Mounted Volume: %s\n"), dev->VolHdr.VolName);
375 bnet_fsend(dir, _("3902 Cannot mount Volume on Storage Device \"%s\" because:\n%s\n"),
376 dev->dev_name, jcr->errmsg);
382 dev->dev_blocked = blocked; /* reset blocked state */
383 dev->no_wait_id = no_wait_id; /* reset blocking thread id */
388 * Mount command from Director
390 static int mount_cmd(JCR *jcr)
393 BSOCK *dir = jcr->dir_bsock;
398 dev_name = (char *) get_memory(dir->msglen);
399 if (sscanf(dir->msg, "mount %s", dev_name) == 1) {
400 unbash_spaces(dev_name);
403 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
404 /* Find resource, and make sure we were able to open it */
405 if (strcmp(device->hdr.name, dev_name) == 0 && device->dev) {
406 Dmsg1(20, "Found device %s\n", device->hdr.name);
413 jcr->device = device;
416 switch (dev->dev_blocked) { /* device blocked? */
418 case BST_WAITING_FOR_SYSOP:
419 /* Someone is waiting, wake him */
420 Dmsg0(90, "Waiting for mount attempt to wake thread\n");
421 pthread_cond_signal(&dev->wait_next_vol);
422 bnet_fsend(dir, "3001 OK mount. Device=%s\n", dev->dev_name);
425 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
427 /* We freed the device, so reopen it and wake any waiting threads */
428 if (open_dev(dev, NULL, READ_WRITE) < 0) {
429 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
433 block = new_block(dev);
434 read_dev_volume_label(jcr, dev, block);
436 if (dev->dev_blocked == BST_UNMOUNTED) {
437 Dmsg0(90, "Unmounted unblocking device\n");
438 read_label(jcr, dev);
441 Dmsg0(90, "Unmounted waiting for mount attempt to wake thread\n");
442 dev->dev_blocked = BST_WAITING_FOR_SYSOP;
443 pthread_cond_signal(&dev->wait_next_vol);
445 if (dev->state & ST_LABEL) {
446 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
447 dev->dev_name, dev->VolHdr.VolName);
449 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
454 case BST_DOING_ACQUIRE:
455 bnet_fsend(dir, _("3001 Device %s is mounted; doing acquire.\n"),
459 case BST_WRITING_LABEL:
460 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"), dev->dev_name);
463 case BST_NOT_BLOCKED:
464 if (dev->state & ST_OPENED) {
465 if (dev->state & ST_LABEL) {
466 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
467 dev->dev_name, dev->VolHdr.VolName);
469 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
473 if (!dev_is_tape(dev)) {
474 bnet_fsend(dir, _("3906 cannot mount non-tape.\n"));
477 if (open_dev(dev, NULL, READ_WRITE) < 0) {
478 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
482 read_label(jcr, dev);
483 if (dev->state & ST_LABEL) {
484 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
485 dev->dev_name, dev->VolHdr.VolName);
487 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
494 bnet_fsend(dir, _("3905 Bizarre wait state %d\n"), dev->dev_blocked);
499 bnet_fsend(dir, _("3999 Device %s not found\n"), dev_name);
502 strcpy(dev_name, dir->msg);
503 bnet_fsend(dir, _("3906 Error scanning mount command: %s\n"), dev_name);
505 free_memory(dev_name);
506 bnet_sig(dir, BNET_EOF);
511 * unmount command from Director
513 static int unmount_cmd(JCR *jcr)
516 BSOCK *dir = jcr->dir_bsock;
521 dname = (char *) get_memory(dir->msglen+1);
522 if (sscanf(dir->msg, "unmount %s", dname) == 1) {
523 unbash_spaces(dname);
526 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
527 /* Find resource, and make sure we were able to open it */
528 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
529 Dmsg1(20, "Found device %s\n", device->hdr.name);
536 jcr->device = device;
539 if (!(dev->state & ST_OPENED)) {
540 Dmsg0(90, "Device already unmounted\n");
541 bnet_fsend(dir, _("3901 Device %s is already unmounted.\n"), dev_name(dev));
543 } else if (dev->dev_blocked == BST_WAITING_FOR_SYSOP) {
544 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
546 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
549 force_close_dev(dev);
550 dev->dev_blocked = BST_UNMOUNTED_WAITING_FOR_SYSOP;
551 bnet_fsend(dir, _("3001 Device %s unmounted.\n"), dev_name(dev));
553 } else if (dev->dev_blocked == BST_DOING_ACQUIRE) {
554 bnet_fsend(dir, _("3902 Device %s is busy in acquire.\n"),
557 } else if (dev->dev_blocked == BST_WRITING_LABEL) {
558 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"),
561 } else if (dev->state & ST_READ || dev->num_writers) {
562 if (dev->state & ST_READ) {
563 Dmsg0(90, "Device in read mode\n");
564 bnet_fsend(dir, _("3904 Device %s is busy with 1 reader.\n"),
567 Dmsg1(90, "Device busy with %d writers\n", dev->num_writers);
568 bnet_fsend(dir, _("3905 Device %s is busy with %d writer(s).\n"),
569 dev_name(dev), dev->num_writers);
572 } else { /* device not being used */
573 Dmsg0(90, "Device not in use, unmounting\n");
574 block_device(dev, BST_UNMOUNTED);
575 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
578 force_close_dev(dev);
579 bnet_fsend(dir, _("3002 Device %s unmounted.\n"), dev_name(dev));
583 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
586 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
587 strcpy(dname, dir->msg);
588 bnet_fsend(dir, _("3907 Error scanning unmount command: %s\n"), dname);
591 bnet_sig(dir, BNET_EOF);
596 * Status command from Director
598 static int status_cmd(JCR *jcr)
602 int found, bps, sec, bpb;
603 BSOCK *user = jcr->dir_bsock;
604 char dt[MAX_TIME_LENGTH];
605 char b1[30], b2[30], b3[30];
607 bnet_fsend(user, "\n%s Version: " VERSION " (" DATE ")\n", my_name);
608 bstrftime(dt, sizeof(dt), daemon_start_time);
609 bnet_fsend(user, _("Daemon started %s, %d Job%s run.\n"), dt, last_job.NumJobs,
610 last_job.NumJobs == 1 ? "" : "s");
611 if (last_job.NumJobs > 0) {
614 bstrftime(dt, sizeof(dt), last_job.end_time);
615 bnet_fsend(user, _("Last Job %s finished at %s\n"), last_job.Job, dt);
617 jobstatus_to_ascii(last_job.JobStatus, termstat, sizeof(termstat));
618 bnet_fsend(user, _(" Files=%s Bytes=%s Termination Status=%s\n"),
619 edit_uint64_with_commas(last_job.JobFiles, b1),
620 edit_uint64_with_commas(last_job.JobBytes, b2),
625 for (device=NULL; (device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device)); ) {
628 if (dev->state & ST_OPENED) {
629 if (dev->state & ST_LABEL) {
630 bnet_fsend(user, _("Device %s is mounted with Volume %s\n"),
631 dev_name(dev), dev->VolHdr.VolName);
633 bnet_fsend(user, _("Device %s open but no Bacula volume is mounted.\n"), dev_name(dev));
635 switch (dev->dev_blocked) {
637 bnet_fsend(user, _(" Deviced is blocked. User unmounted.\n"));
639 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
640 bnet_fsend(user, _(" Deviced is blocked. User unmounted during wait for media/mount.\n"));
642 case BST_WAITING_FOR_SYSOP:
643 if (jcr->JobStatus == JS_WaitMount) {
644 bnet_fsend(user, _(" Device is blocked waiting for mount.\n"));
646 bnet_fsend(user, _(" Device is blocked waiting for appendable media.\n"));
649 case BST_DOING_ACQUIRE:
650 bnet_fsend(user, _(" Device is being initialized.\n"));
652 case BST_WRITING_LABEL:
653 bnet_fsend(user, _(" Device is blocked labeling a Volume.\n"));
658 bpb = dev->VolCatInfo.VolCatBlocks;
662 bpb = dev->VolCatInfo.VolCatBytes / bpb;
663 bnet_fsend(user, _(" Total Bytes=%s Blocks=%s Bytes/block=%s\n"),
664 edit_uint64_with_commas(dev->VolCatInfo.VolCatBytes, b1),
665 edit_uint64_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
666 edit_uint64_with_commas(bpb, b3));
667 bnet_fsend(user, _(" Positioned at File=%s Block=%s\n"),
668 edit_uint64_with_commas(dev->file, b1),
669 edit_uint64_with_commas(dev->block_num, b2));
672 bnet_fsend(user, _("Device %s is not open.\n"), dev_name(dev));
680 /* NOTE, we reuse a calling argument jcr. Be warned! */
681 for (jcr=NULL; (jcr=get_next_jcr(jcr)); ) {
682 if (jcr->JobStatus == JS_WaitFD) {
683 bnet_fsend(user, _("%s Job %s waiting for Client connection.\n"),
684 job_type_to_str(jcr->JobType), jcr->Job);
687 bnet_fsend(user, _("%s %s job %s is using device %s\n"),
688 job_level_to_str(jcr->JobLevel),
689 job_type_to_str(jcr->JobType),
690 jcr->Job, jcr->device->device_name);
691 sec = time(NULL) - jcr->run_time;
695 bps = jcr->JobBytes / sec;
696 bnet_fsend(user, _(" Files=%s Bytes=%s Bytes/sec=%s\n"),
697 edit_uint64_with_commas(jcr->JobFiles, b1),
698 edit_uint64_with_commas(jcr->JobBytes, b2),
699 edit_uint64_with_commas(bps, b3));
702 if (jcr->file_bsock) {
703 bnet_fsend(user, " FDReadSeqNo=%" lld " fd=%d\n",
704 jcr->file_bsock->read_seqno, jcr->file_bsock->fd);
706 bnet_fsend(user, " FDSocket closed\n");
710 free_locked_jcr(jcr);
714 bnet_fsend(user, _("No jobs running.\n"));
718 bnet_fsend(user, "\n\n");
719 dump_resource(R_DEVICE, resources[R_DEVICE-r_first].res_head, sendit, user);
721 bnet_fsend(user, "====\n");
723 bnet_sig(user, BNET_EOF);