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
15 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
17 This program is free software; you can redistribute it and/or
18 modify it under the terms of the GNU General Public License as
19 published by the Free Software Foundation; either version 2 of
20 the License, or (at your option) any later version.
22 This program is distributed in the hope that it will be useful,
23 but WITHOUT ANY WARRANTY; without even the implied warranty of
24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25 General Public License for more details.
27 You should have received a copy of the GNU General Public
28 License along with this program; if not, write to the Free
29 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
37 /* Exported variables */
39 /* Imported variables */
40 extern BSOCK *filed_chan;
41 extern int r_first, r_last;
42 extern struct s_res resources[];
43 extern char my_name[];
44 extern time_t daemon_start_time;
45 extern struct s_last_job last_job;
47 /* Static variables */
48 static char derrmsg[] = "3900 Invalid command\n";
49 static char OKsetdebug[] = "3000 OK setdebug=%d\n";
52 /* Imported functions */
53 extern void terminate_child();
54 extern int job_cmd(JCR *jcr);
56 /* Forward referenced functions */
57 static int label_cmd(JCR *jcr);
58 static int setdebug_cmd(JCR *jcr);
59 static int cancel_cmd(JCR *cjcr);
60 static int mount_cmd(JCR *jcr);
61 static int unmount_cmd(JCR *jcr);
62 static int status_cmd(JCR *sjcr);
63 static void label_device_if_ok(JCR *jcr, DEVICE *dev, char *vname, char *poolname);
67 int (*func)(JCR *jcr);
71 * The following are the recognized commands from the Director.
73 static struct s_cmds cmds[] = {
74 {"JobId=", job_cmd}, /* start Job */
75 {"setdebug=", setdebug_cmd}, /* set debug level */
76 {"cancel", cancel_cmd},
77 {"label", label_cmd}, /* label a tape */
79 {"unmount", unmount_cmd},
80 {"status", status_cmd},
81 {NULL, NULL} /* list terminator */
86 * Connection request. We accept connections either from the
87 * Director or a Client.
89 * Note, we are running as a seperate thread of the Storage daemon.
90 * and it is because a Director has made a connection with
91 * us on the "Message" channel.
93 * Basic tasks done here:
94 * - Create a JCR record
95 * - Authenticate the Director
96 * - We wait for a command
97 * - We execute the command
98 * - We continue or exit depending on the return status
100 void connection_request(void *arg)
102 BSOCK *bs = (BSOCK *)arg;
106 char name[MAX_NAME_LENGTH];
108 if (bnet_recv(bs) <= 0) {
109 Emsg0(M_ERROR, 0, "Connection request failed.\n");
114 * See if this is a File daemon connection
116 if (sscanf(bs->msg, "Hello Start Job %127s calling\n", name) == 1) {
117 handle_filed_connection(bs, name);
121 jcr = new_jcr(sizeof(JCR), stored_free_jcr); /* create Job Control Record */
122 jcr->dir_bsock = bs; /* save Director bsock */
124 Dmsg0(1000, "stored in start_job\n");
127 * Authenticate the Director
129 if (!authenticate_director(jcr)) {
130 Emsg0(M_FATAL, 0, _("Unable to authenticate Director\n"));
134 Dmsg0(90, "Message channel init completed.\n");
136 for (quit=0; !quit;) {
139 if ((bnet_stat = bnet_recv(bs)) <= 0) {
140 break; /* connection terminated */
142 Dmsg1(9, "<dird: %s\n", bs->msg);
144 for (i=0; cmds[i].cmd; i++) {
145 if (strncmp(cmds[i].cmd, bs->msg, strlen(cmds[i].cmd)) == 0) {
146 if (!cmds[i].func(jcr)) { /* do command */
147 quit = TRUE; /* error, get out */
148 Dmsg1(90, "Command %s requsts quit\n", cmds[i].cmd);
150 found = TRUE; /* indicate command found */
154 if (!found) { /* command not found */
155 bnet_fsend(bs, derrmsg);
160 if (bnet_stat != BNET_TERMINATE) {
161 bnet_sig(bs, BNET_TERMINATE);
168 * Set debug level as requested by the Director
171 static int setdebug_cmd(JCR *jcr)
173 BSOCK *dir = jcr->dir_bsock;
176 Dmsg1(10, "setdebug_cmd: %s", dir->msg);
177 if (sscanf(dir->msg, "setdebug=%d", &level) != 1 || level < 0) {
178 bnet_fsend(dir, "3991 Bad setdebug command: %s\n", dir->msg);
182 return bnet_fsend(dir, OKsetdebug, level);
189 static int cancel_cmd(JCR *cjcr)
191 BSOCK *dir = cjcr->dir_bsock;
193 char Job[MAX_NAME_LENGTH];
196 if (sscanf(dir->msg, "cancel Job=%127s", Job) == 1) {
197 if (!(jcr=get_jcr_by_full_name(Job))) {
198 bnet_fsend(dir, _("3992 Job %s not found.\n"), Job);
201 oldStatus = jcr->JobStatus;
202 jcr->JobStatus = JS_Cancelled;
203 if (!jcr->authenticated && jcr->JobStatus == JS_WaitFD) {
204 pthread_cond_signal(&jcr->job_start_wait); /* wake waiting thread */
207 if (jcr->file_bsock) {
208 bnet_sig(jcr->file_bsock, BNET_TERMINATE);
210 bnet_fsend(dir, _("3000 Job %s Status=%c marked to be cancelled.\n"),
211 jcr->Job, oldStatus);
215 bnet_fsend(dir, _("3993 Error scanning cancel command.\n"));
217 bnet_sig(dir, BNET_EOF);
225 static int label_cmd(JCR *jcr)
227 char *dname, *volname, *poolname, *mtype;
228 BSOCK *dir = jcr->dir_bsock;
233 dname = (char *) get_memory(dir->msglen+1);
234 volname = (char *) get_memory(dir->msglen+1);
235 poolname = (char *) get_memory(dir->msglen+1);
236 mtype = (char *) get_memory(dir->msglen+1);
237 if (sscanf(dir->msg, "label %s VolumeName=%s PoolName=%s MediaType=%s",
238 dname, volname, poolname, mtype) == 4) {
239 unbash_spaces(dname);
240 unbash_spaces(volname);
241 unbash_spaces(poolname);
242 unbash_spaces(mtype);
245 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
246 /* Find resource, and make sure we were able to open it */
247 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
248 Dmsg1(20, "Found device %s\n", device->hdr.name);
255 /******FIXME**** compare MediaTypes */
256 jcr->device = device;
259 if (!(dev->state & ST_OPENED)) {
260 if (open_dev(dev, volname, READ_WRITE) < 0) {
261 bnet_fsend(dir, _("3994 Connot open device: %s\n"), strerror_dev(dev));
263 label_device_if_ok(jcr, dev, volname, poolname);
264 force_close_dev(dev);
266 } else if (dev->dev_blocked &&
267 dev->dev_blocked != BST_DOING_ACQUIRE) { /* device blocked? */
268 label_device_if_ok(jcr, dev, volname, poolname);
269 } else if (dev->state & ST_READ || dev->num_writers) {
270 if (dev->state & ST_READ) {
271 bnet_fsend(dir, _("3901 Device %s is busy with 1 reader.\n"),
274 bnet_fsend(dir, _("3902 Device %s is busy with %d writer(s).\n"),
275 dev_name(dev), dev->num_writers);
277 } else { /* device not being used */
278 label_device_if_ok(jcr, dev, volname, poolname);
282 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
285 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
286 strcpy(dname, dir->msg);
287 bnet_fsend(dir, _("3903 Error scanning label command: %s\n"), dname);
290 free_memory(volname);
291 free_memory(poolname);
293 bnet_sig(dir, BNET_EOF);
298 * Read the tape label and determine if we can safely
299 * label the tape (not a Bacula volume), then label it.
301 * Enter with the mutex set
303 static void label_device_if_ok(JCR *jcr, DEVICE *dev, char *vname, char *poolname)
305 BSOCK *dir = jcr->dir_bsock;
308 pthread_t no_wait_id;
310 blocked = dev->dev_blocked; /* save any prev blocked state */
311 no_wait_id = dev->no_wait_id;
312 dev->dev_blocked = BST_WRITING_LABEL;
313 dev->no_wait_id = pthread_self(); /* let us use the tape */
314 V(dev->mutex); /* release lock */
316 strcpy(jcr->VolumeName, vname);
317 block = new_block(dev);
318 switch (read_dev_volume_label(jcr, dev, block)) {
320 case VOL_VERSION_ERROR:
321 case VOL_LABEL_ERROR:
323 bnet_fsend(dir, _("3901 Cannot label Volume because it is \
324 already labeled: %s\n"), dev->VolHdr.VolName);
328 write_volume_label_to_dev(jcr, jcr->device, vname, poolname);
329 strcpy(jcr->VolumeName, vname);
330 bnet_fsend(dir, _("3000 OK label. Volume=%s Device=%s\n"),
331 vname, dev->dev_name);
334 bnet_fsend(dir, _("3902 Cannot label Volume. \
335 Unknown status %d from read_volume_label()\n"), jcr->label_status);
340 dev->dev_blocked = blocked; /* reset blocked state */
341 dev->no_wait_id = no_wait_id; /* reset blocking thread id */
346 * Read the tape label
348 * Enter with the mutex set
350 static int read_label(JCR *jcr, DEVICE *dev)
352 BSOCK *dir = jcr->dir_bsock;
355 pthread_t no_wait_id;
358 blocked = dev->dev_blocked; /* save any prev blocked state */
359 no_wait_id = dev->no_wait_id;
360 dev->dev_blocked = BST_DOING_ACQUIRE;
361 dev->no_wait_id = pthread_self(); /* let us use the tape */
362 V(dev->mutex); /* release lock */
364 jcr->VolumeName[0] = 0;
365 block = new_block(dev);
366 dev->state &= ~ST_LABEL; /* force read of label */
367 switch (read_dev_volume_label(jcr, dev, block)) {
369 bnet_fsend(dir, _("3001 Mounted Volume: %s\n"), dev->VolHdr.VolName);
373 bnet_fsend(dir, _("3902 Cannot mount Volume on Storage Device \"%s\" because:\n%s\n"),
374 dev->dev_name, jcr->errmsg);
380 dev->dev_blocked = blocked; /* reset blocked state */
381 dev->no_wait_id = no_wait_id; /* reset blocking thread id */
386 * Mount command from Director
388 static int mount_cmd(JCR *jcr)
391 BSOCK *dir = jcr->dir_bsock;
396 dev_name = (char *) get_memory(dir->msglen);
397 if (sscanf(dir->msg, "mount %s", dev_name) == 1) {
398 unbash_spaces(dev_name);
401 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
402 /* Find resource, and make sure we were able to open it */
403 if (strcmp(device->hdr.name, dev_name) == 0 && device->dev) {
404 Dmsg1(20, "Found device %s\n", device->hdr.name);
411 jcr->device = device;
414 switch (dev->dev_blocked) { /* device blocked? */
416 case BST_WAITING_FOR_SYSOP:
417 /* Someone is waiting, wake him */
418 Dmsg0(90, "Waiting for mount attempt to wake thread\n");
419 pthread_cond_signal(&dev->wait_next_vol);
420 bnet_fsend(dir, "3001 OK mount. Device=%s\n", dev->dev_name);
423 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
425 /* We freed the device, so reopen it and wake any waiting threads */
426 if (open_dev(dev, NULL, READ_WRITE) < 0) {
427 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
431 block = new_block(dev);
432 read_dev_volume_label(jcr, dev, block);
434 if (dev->dev_blocked == BST_UNMOUNTED) {
435 Dmsg0(90, "Unmounted unblocking device\n");
436 read_label(jcr, dev);
439 Dmsg0(90, "Unmounted waiting for mount attempt to wake thread\n");
440 dev->dev_blocked = BST_WAITING_FOR_SYSOP;
441 pthread_cond_signal(&dev->wait_next_vol);
443 if (dev->state & ST_LABEL) {
444 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
445 dev->dev_name, dev->VolHdr.VolName);
447 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
452 case BST_DOING_ACQUIRE:
453 bnet_fsend(dir, _("3001 Device %s is mounted; doing acquire.\n"),
457 case BST_WRITING_LABEL:
458 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"), dev->dev_name);
461 case BST_NOT_BLOCKED:
462 if (dev->state & ST_OPENED) {
463 if (dev->state & ST_LABEL) {
464 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
465 dev->dev_name, dev->VolHdr.VolName);
467 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
471 if (!dev_is_tape(dev)) {
472 bnet_fsend(dir, _("3906 cannot mount non-tape.\n"));
475 if (open_dev(dev, NULL, READ_WRITE) < 0) {
476 bnet_fsend(dir, _("3901 open device failed: ERR=%s\n"),
480 read_label(jcr, dev);
481 if (dev->state & ST_LABEL) {
482 bnet_fsend(dir, _("3001 Device %s is mounted with Volume %s\n"),
483 dev->dev_name, dev->VolHdr.VolName);
485 bnet_fsend(dir, _("3905 Device %s open but no Bacula volume is mounted.\n"),
492 bnet_fsend(dir, _("3905 Bizarre wait state %d\n"), dev->dev_blocked);
497 bnet_fsend(dir, _("3999 Device %s not found\n"), dev_name);
500 strcpy(dev_name, dir->msg);
501 bnet_fsend(dir, _("3906 Error scanning mount command: %s\n"), dev_name);
503 free_memory(dev_name);
504 bnet_sig(dir, BNET_EOF);
509 * unmount command from Director
511 static int unmount_cmd(JCR *jcr)
514 BSOCK *dir = jcr->dir_bsock;
519 dname = (char *) get_memory(dir->msglen+1);
520 if (sscanf(dir->msg, "unmount %s", dname) == 1) {
521 unbash_spaces(dname);
524 while ((device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device))) {
525 /* Find resource, and make sure we were able to open it */
526 if (strcmp(device->hdr.name, dname) == 0 && device->dev) {
527 Dmsg1(20, "Found device %s\n", device->hdr.name);
534 jcr->device = device;
537 if (!(dev->state & ST_OPENED)) {
538 Dmsg0(90, "Device already unmounted\n");
539 bnet_fsend(dir, _("3901 Device %s is already unmounted.\n"), dev_name(dev));
541 } else if (dev->dev_blocked == BST_WAITING_FOR_SYSOP) {
542 Dmsg2(90, "%d waiter dev_block=%d. doing unmount\n", dev->num_waiting,
544 force_close_dev(dev);
545 dev->dev_blocked = BST_UNMOUNTED_WAITING_FOR_SYSOP;
546 bnet_fsend(dir, _("3001 Device %s unmounted.\n"), dev_name(dev));
548 } else if (dev->dev_blocked == BST_DOING_ACQUIRE) {
549 bnet_fsend(dir, _("3902 Device %s is busy in acquire.\n"),
552 } else if (dev->dev_blocked == BST_WRITING_LABEL) {
553 bnet_fsend(dir, _("3903 Device %s is being labeled.\n"),
556 } else if (dev->state & ST_READ || dev->num_writers) {
557 if (dev->state & ST_READ) {
558 Dmsg0(90, "Device in read mode\n");
559 bnet_fsend(dir, _("3904 Device %s is busy with 1 reader.\n"),
562 Dmsg1(90, "Device busy with %d writers\n", dev->num_writers);
563 bnet_fsend(dir, _("3905 Device %s is busy with %d writer(s).\n"),
564 dev_name(dev), dev->num_writers);
567 } else { /* device not being used */
568 Dmsg0(90, "Device not in use, unmounting\n");
569 block_device(dev, BST_UNMOUNTED);
570 force_close_dev(dev);
571 bnet_fsend(dir, _("3002 Device %s unmounted.\n"), dev_name(dev));
575 bnet_fsend(dir, _("3999 Device %s not found\n"), dname);
578 /* NB dir->msg gets clobbered in bnet_fsend, so save command */
579 strcpy(dname, dir->msg);
580 bnet_fsend(dir, _("3907 Error scanning unmount command: %s\n"), dname);
583 bnet_sig(dir, BNET_EOF);
588 * Status command from Director
590 static int status_cmd(JCR *jcr)
594 int found, bps, sec, bpb;
595 BSOCK *user = jcr->dir_bsock;
596 char dt[MAX_TIME_LENGTH];
597 char b1[30], b2[30], b3[30];
599 bnet_fsend(user, "\n%s Version: " VERSION " (" DATE ")\n", my_name);
600 bstrftime(dt, sizeof(dt), daemon_start_time);
601 bnet_fsend(user, _("Daemon started %s, %d Job%s run.\n"), dt, last_job.NumJobs,
602 last_job.NumJobs == 1 ? "" : "s");
603 if (last_job.NumJobs > 0) {
604 char *termstat, jstat[2];
606 bstrftime(dt, sizeof(dt), last_job.end_time);
607 bnet_fsend(user, _("Last Job %s finished at %s\n"), last_job.Job, dt);
608 switch (last_job.JobStatus) {
612 case JS_ErrorTerminated:
613 termstat = _("Error");
616 jstat[0] = last_job.JobStatus;
622 bnet_fsend(user, _(" Files=%s Bytes=%s Termination Status=%s\n"),
623 edit_uint_with_commas(last_job.JobFiles, b1),
624 edit_uint_with_commas(last_job.JobBytes, b2),
629 for (device=NULL; (device=(DEVRES *)GetNextRes(R_DEVICE, (RES *)device)); ) {
632 if (dev->state & ST_OPENED) {
633 if (dev->state & ST_LABEL) {
634 bnet_fsend(user, _("Device %s is mounted with Volume %s\n"),
635 dev_name(dev), dev->VolHdr.VolName);
637 bnet_fsend(user, _("Device %s open but no Bacula volume is mounted.\n"), dev_name(dev));
639 switch (dev->dev_blocked) {
641 bnet_fsend(user, _(" Deviced is blocked. User unmounted.\n"));
643 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
644 bnet_fsend(user, _(" Deviced is blocked. User unmounted during wait for media/mount.\n"));
646 case BST_WAITING_FOR_SYSOP:
647 if (jcr->JobStatus == JS_WaitMount) {
648 bnet_fsend(user, _(" Device is blocked waiting for mount.\n"));
650 bnet_fsend(user, _(" Device is blocked waiting for appendable media.\n"));
653 case BST_DOING_ACQUIRE:
654 bnet_fsend(user, _(" Device is being initialized.\n"));
656 case BST_WRITING_LABEL:
657 bnet_fsend(user, _(" Device is blocked labeling a Volume.\n"));
662 bpb = dev->VolCatInfo.VolCatBlocks;
666 bpb = dev->VolCatInfo.VolCatBytes / bpb;
667 bnet_fsend(user, _(" Total Bytes=%s Blocks=%s Bytes/block=%s\n"),
668 edit_uint_with_commas(dev->VolCatInfo.VolCatBytes, b1),
669 edit_uint_with_commas(dev->VolCatInfo.VolCatBlocks, b2),
670 edit_uint_with_commas(bpb, b3));
671 bnet_fsend(user, _(" Positioned at File=%s Block=%s\n"),
672 edit_uint_with_commas(dev->file, b1),
673 edit_uint_with_commas(dev->block_num, b2));
676 bnet_fsend(user, _("Device %s is not open.\n"), dev_name(dev));
684 /* NOTE, we reuse a calling argument jcr. Be warned! */
685 for (jcr=NULL; (jcr=get_next_jcr(jcr)); ) {
686 if (jcr->JobStatus == JS_WaitFD) {
687 bnet_fsend(user, _("Job %s is waiting for the Client connection.\n"),
691 bnet_fsend(user, _("Job %s is using device %s\n"),
692 jcr->Job, jcr->device->device_name);
693 sec = time(NULL) - jcr->run_time;
697 bps = jcr->JobBytes / sec;
698 bnet_fsend(user, _(" Files=%s Bytes=%s Bytes/sec=%s\n"),
699 edit_uint_with_commas(jcr->JobFiles, b1),
700 edit_uint_with_commas(jcr->JobBytes, b2),
701 edit_uint_with_commas(bps, b3));
704 if (jcr->file_bsock) {
705 bnet_fsend(user, " FDReadSeqNo=%" lld " fd=%d\n",
706 jcr->file_bsock->read_seqno, jcr->file_bsock->fd);
708 bnet_fsend(user, " FDSocket closed\n");
712 free_locked_jcr(jcr);
716 bnet_fsend(user, _("No jobs running.\n"));
720 bnet_fsend(user, "\n\n");
721 dump_resource(R_DEVICE, resources[R_DEVICE-r_first].res_head, sendit, user);
723 bnet_fsend(user, "====\n");
725 bnet_sig(user, BNET_EOF);