2 * Subroutines to handle Catalog reqests sent to the Director
3 * Reqests/commands from the Director are handled in dircmd.c
5 * Kern Sibbald, December 2000
10 Copyright (C) 2000-2004 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
29 #include "bacula.h" /* pull in global headers */
30 #include "stored.h" /* pull in Storage Deamon headers */
32 /* Requests sent to the Director */
33 static char Find_media[] = "CatReq Job=%s FindMedia=%d\n";
34 static char Get_Vol_Info[] = "CatReq Job=%s GetVolInfo VolName=%s write=%d\n";
35 static char Update_media[] = "CatReq Job=%s UpdateMedia VolName=%s"
36 " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%s VolMounts=%u"
37 " VolErrors=%u VolWrites=%u MaxVolBytes=%s EndTime=%d VolStatus=%s"
38 " Slot=%d relabel=%d InChanger=%d VolReadTime=%s VolWriteTime=%s\n";
39 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia"
40 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u"
41 " StartBlock=%u EndBlock=%u\n";
42 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
43 static char Job_status[] = "3012 Job %s jobstatus %d\n";
46 /* Responses received from the Director */
47 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u"
48 " VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u"
49 " MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s"
50 " Slot=%d MaxVolJobs=%u MaxVolFiles=%u InChanger=%d"
51 " VolReadTime=%" lld " VolWriteTime=%" lld;
54 static char OK_create[] = "1000 OK CreateJobMedia\n";
56 /* Forward referenced functions */
57 static int wait_for_sysop(JCR *jcr, DEVICE *dev);
60 * Send current JobStatus to Director
62 bool dir_send_job_status(JCR *jcr)
64 return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
69 * dir_get_volume_info()
71 * dir_find_next_appendable_volume()
73 * Returns: true on success and vol info in jcr->VolCatInfo
76 static bool do_get_volume_info(JCR *jcr)
78 BSOCK *dir = jcr->dir_bsock;
84 jcr->VolumeName[0] = 0; /* No volume */
85 dcr->VolumeName[0] = 0; /* No volume */
86 if (bnet_recv(dir) <= 0) {
87 Dmsg0(200, "getvolname error bnet_recv\n");
88 Mmsg(&jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
91 memset(&vol, 0, sizeof(vol));
92 Dmsg1(200, "Get vol info=%s\n", dir->msg);
93 n = sscanf(dir->msg, OK_media, vol.VolCatName,
94 &vol.VolCatJobs, &vol.VolCatFiles,
95 &vol.VolCatBlocks, &vol.VolCatBytes,
96 &vol.VolCatMounts, &vol.VolCatErrors,
97 &vol.VolCatWrites, &vol.VolCatMaxBytes,
98 &vol.VolCatCapacityBytes, vol.VolCatStatus,
99 &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles,
100 &InChanger, &vol.VolReadTime, &vol.VolWriteTime);
102 Dmsg2(100, "Bad response from Dir fields=%d: %s\n", n, dir->msg);
103 Mmsg(&jcr->errmsg, _("Error getting Volume info: %s\n"), dir->msg);
106 vol.InChanger = InChanger; /* bool in structure */
107 unbash_spaces(vol.VolCatName);
108 pm_strcpy(&jcr->VolumeName, vol.VolCatName); /* set desired VolumeName */
109 bstrncpy(dcr->VolumeName, vol.VolCatName, sizeof(dcr->VolumeName));
110 memcpy(&jcr->VolCatInfo, &vol, sizeof(jcr->VolCatInfo));
111 memcpy(&dcr->VolCatInfo, &vol, sizeof(dcr->VolCatInfo));
113 Dmsg2(200, "do_reqest_vol_info got slot=%d Volume=%s\n",
114 vol.Slot, vol.VolCatName);
120 * Get Volume info for a specific volume from the Director's Database
122 * Returns: true on success (not Director guarantees that Pool and MediaType
123 * are correct and VolStatus==Append or
124 * VolStatus==Recycle)
127 * Volume information returned in jcr
129 bool dir_get_volume_info(JCR *jcr, enum get_vol_info_rw writing)
131 BSOCK *dir = jcr->dir_bsock;
133 bstrncpy(jcr->VolCatInfo.VolCatName, jcr->VolumeName, sizeof(jcr->VolCatInfo.VolCatName));
134 Dmsg1(200, "dir_get_volume_info=%s\n", jcr->VolCatInfo.VolCatName);
135 bash_spaces(jcr->VolCatInfo.VolCatName);
136 bnet_fsend(dir, Get_Vol_Info, jcr->Job, jcr->VolCatInfo.VolCatName,
137 writing==GET_VOL_INFO_FOR_WRITE?1:0);
138 return do_get_volume_info(jcr);
144 * Get info on the next appendable volume in the Director's database
145 * Returns: true on success
148 * Volume information returned in jcr
151 bool dir_find_next_appendable_volume(JCR *jcr)
153 BSOCK *dir = jcr->dir_bsock;
156 Dmsg0(200, "dir_find_next_appendable_volume\n");
157 for (int vol_index=1; vol_index < 3; vol_index++) {
158 bnet_fsend(dir, Find_media, jcr->Job, vol_index);
159 if (do_get_volume_info(jcr)) {
160 Dmsg2(200, "JobId=%d got possible Vol=%s\n", jcr->JobId, jcr->VolumeName);
163 * Walk through all jobs and see if the volume is
164 * already mounted. If so, try a different one.
165 * This would be better done by walking through
171 free_locked_jcr(njcr);
174 Dmsg2(200, "Compare to JobId=%d using Vol=%s\n", njcr->JobId, njcr->VolumeName);
175 if (strcmp(jcr->VolumeName, njcr->VolumeName) == 0) {
177 Dmsg1(200, "Vol in use by JobId=%u\n", njcr->JobId);
178 free_locked_jcr(njcr);
181 free_locked_jcr(njcr);
185 Dmsg0(200, "dir_find_next_appendable_volume return true\n");
186 return true; /* Got good Volume */
189 Dmsg0(200, "No volume info, return false\n");
193 Dmsg0(200, "dir_find_next_appendable_volume return true\n");
199 * After writing a Volume, send the updated statistics
200 * back to the director. The information comes from the
203 bool dir_update_volume_info(JCR *jcr, bool label)
205 BSOCK *dir = jcr->dir_bsock;
206 DEVICE *dev = jcr->dcr->dev;
207 time_t LastWritten = time(NULL);
208 char ed1[50], ed2[50], ed3[50], ed4[50];
209 VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
212 if (vol->VolCatName[0] == 0) {
213 Jmsg0(jcr, M_ERROR, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
216 if (dev_state(dev, ST_READ)) {
217 Jmsg0(jcr, M_ERROR, 0, _("Attempt to update_volume_info in read mode!!!\n"));
221 Dmsg1(100, "Update cat VolFiles=%d\n", dev->file);
222 /* Just labeled or relabeled the tape */
224 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
225 vol->VolCatBytes = 1; /* indicates tape labeled */
227 bash_spaces(vol->VolCatName);
228 InChanger = vol->InChanger;
229 bnet_fsend(dir, Update_media, jcr->Job,
230 vol->VolCatName, vol->VolCatJobs, vol->VolCatFiles,
231 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
232 vol->VolCatMounts, vol->VolCatErrors,
233 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
234 LastWritten, vol->VolCatStatus, vol->Slot, label,
235 InChanger, /* bool in structure */
236 edit_uint64(vol->VolReadTime, ed3),
237 edit_uint64(vol->VolWriteTime, ed4) );
239 Dmsg1(120, "update_volume_info(): %s", dir->msg);
240 unbash_spaces(vol->VolCatName);
242 if (!do_get_volume_info(jcr)) {
243 Jmsg(jcr, M_ERROR, 0, "%s", jcr->errmsg);
246 Dmsg1(120, "get_volume_info(): %s", dir->msg);
247 /* Update dev Volume info in case something changed (e.g. expired) */
248 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
253 * After writing a Volume, create the JobMedia record.
255 bool dir_create_jobmedia_record(JCR *jcr)
257 BSOCK *dir = jcr->dir_bsock;
260 if (!dcr->WroteVol) {
261 return true; /* nothing written to tape */
264 dcr->WroteVol = false;
265 bnet_fsend(dir, Create_job_media, jcr->Job,
266 dcr->VolFirstIndex, dcr->VolLastIndex,
267 dcr->StartFile, dcr->EndFile,
268 dcr->StartBlock, dcr->EndBlock);
269 Dmsg1(100, "create_jobmedia(): %s", dir->msg);
270 if (bnet_recv(dir) <= 0) {
271 Dmsg0(190, "create_jobmedia error bnet_recv\n");
272 Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: ERR=%s\n"),
276 Dmsg1(120, "Create_jobmedia: %s", dir->msg);
277 if (strcmp(dir->msg, OK_create) != 0) {
278 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
279 Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
287 * Update File Attribute data
289 bool dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec)
291 BSOCK *dir = jcr->dir_bsock;
294 dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
295 dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
296 sizeof(DEV_RECORD) + rec->data_len);
297 ser_begin(dir->msg + dir->msglen, 0);
298 ser_uint32(rec->VolSessionId);
299 ser_uint32(rec->VolSessionTime);
300 ser_int32(rec->FileIndex);
301 ser_int32(rec->Stream);
302 ser_uint32(rec->data_len);
303 ser_bytes(rec->data, rec->data_len);
304 dir->msglen = ser_length(dir->msg);
305 return bnet_send(dir);
310 * Request the sysop to create an appendable volume
312 * Entered with device blocked.
313 * Leaves with device blocked.
315 * Returns: true on success (operator issues a mount command)
317 * Note, must create dev->errmsg on error return.
319 * On success, jcr->VolumeName and jcr->VolCatInfo contain
320 * information on suggested volume, but this may not be the
321 * same as what is actually mounted.
323 * When we return with success, the correct tape may or may not
324 * actually be mounted. The calling routine must read it and
327 bool dir_ask_sysop_to_create_appendable_volume(JCR *jcr)
332 DEVICE *dev = jcr->dcr->dev;
334 Dmsg0(130, "enter dir_ask_sysop_to_create_appendable_volume\n");
335 ASSERT(dev->dev_blocked);
337 if (job_canceled(jcr)) {
339 _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
340 jcr->Job, jcr->dev_name);
341 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
344 /* First pass, we *know* there are no appendable volumes, so no need to call */
345 if (!first && dir_find_next_appendable_volume(jcr)) { /* get suggested volume */
346 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
347 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
349 * If we have a valid volume name and we are not
350 * removable media, return now, or if we have a
351 * Slot for an autochanger, otherwise wait
352 * for the operator to mount the media.
354 if (!unmounted && ((jcr->VolumeName[0] && !dev_cap(dev, CAP_REM) &&
355 dev_cap(dev, CAP_LABEL)) ||
356 (jcr->VolumeName[0] && jcr->VolCatInfo.Slot))) {
357 Dmsg0(100, "Return 1 from mount without wait.\n");
360 jstat = JS_WaitMount;
362 Jmsg(jcr, M_MOUNT, 0, _(
363 "Please mount Volume \"%s\" on Storage Device \"%s\" for Job %s\n"
364 "Use \"mount\" command to release Job.\n"),
365 jcr->VolumeName, jcr->dev_name, jcr->Job);
366 Dmsg3(190, "Mount %s on %s for Job %s\n",
367 jcr->VolumeName, jcr->dev_name, jcr->Job);
370 jstat = JS_WaitMedia;
372 Jmsg(jcr, M_MOUNT, 0, _(
373 "Job %s waiting. Cannot find any appendable volumes.\n\
374 Please use the \"label\" command to create a new Volume for:\n\
386 jcr->JobStatus = jstat;
387 dir_send_job_status(jcr);
389 stat = wait_for_sysop(jcr, dev);
391 Dmsg1(200, "Poll timeout in create append vol on device %s\n", dev_name(dev));
395 if (stat == ETIMEDOUT) {
396 if (!double_dev_wait_time(dev)) {
397 Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
398 dev_name(dev), jcr->Job);
399 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
400 Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
401 return false; /* exceeded maximum waits */
405 if (stat == EINVAL) {
406 Mmsg2(&dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
407 stat, strerror(stat));
408 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
412 Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
415 Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
417 /* If no VolumeName, and cannot get one, try again */
418 if (jcr->VolumeName[0] == 0 && !job_canceled(jcr) &&
419 !dir_find_next_appendable_volume(jcr)) {
420 Jmsg(jcr, M_MOUNT, 0, _(
421 "Someone woke me up, but I cannot find any appendable\n\
422 volumes for Job=%s.\n"), jcr->Job);
423 /* Restart wait counters after user interaction */
424 init_dev_wait_timers(dev);
427 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
428 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
430 continue; /* continue to wait */
434 * Device mounted, we have a volume, break and return
438 set_jcr_job_status(jcr, JS_Running);
439 dir_send_job_status(jcr);
440 Dmsg0(130, "leave dir_ask_sysop_to_mount_create_appendable_volume\n");
445 * Request to mount specific Volume
447 * Entered with device blocked and jcr->VolumeName is desired
449 * Leaves with device blocked.
451 * Returns: 1 on success (operator issues a mount command)
453 * Note, must create dev->errmsg on error return.
456 bool dir_ask_sysop_to_mount_volume(JCR *jcr)
460 DEVICE *dev = jcr->dcr->dev;
462 Dmsg0(130, "enter dir_ask_sysop_to_mount_volume\n");
463 if (!jcr->VolumeName[0]) {
464 Mmsg0(&dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
467 ASSERT(dev->dev_blocked);
469 if (job_canceled(jcr)) {
470 Mmsg(&dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
471 jcr->Job, jcr->dev_name);
476 msg = _("Please mount");
477 Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device \"%s\" for Job %s\n"),
478 msg, jcr->VolumeName, jcr->dev_name, jcr->Job);
479 Dmsg3(190, "Mount %s on %s for Job %s\n",
480 jcr->VolumeName, jcr->dev_name, jcr->Job);
483 jcr->JobStatus = JS_WaitMount;
484 dir_send_job_status(jcr);
486 stat = wait_for_sysop(jcr, dev); /* wait on device */
488 Dmsg1(200, "Poll timeout in mount vol on device %s\n", dev_name(dev));
489 Dmsg1(200, "Blocked=%d\n", dev->dev_blocked);
493 if (stat == ETIMEDOUT) {
494 if (!double_dev_wait_time(dev)) {
495 Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
496 dev_name(dev), jcr->Job);
497 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
498 Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
499 return false; /* exceeded maximum waits */
503 if (stat == EINVAL) {
504 Mmsg2(&dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
505 stat, strerror(stat));
506 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
510 Jmsg(jcr, M_ERROR, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
513 Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
516 set_jcr_job_status(jcr, JS_Running);
517 dir_send_job_status(jcr);
518 Dmsg0(130, "leave dir_ask_sysop_to_mount_volume\n");
523 * Wait for SysOp to mount a tape
525 static int wait_for_sysop(JCR *jcr, DEVICE *dev)
529 struct timespec timeout;
530 time_t last_heartbeat = 0;
531 time_t first_start = time(NULL);
537 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
538 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
542 * Wait requested time (dev->rem_wait_sec). However, we also wake up every
543 * HB_TIME seconds and send a heartbeat to the FD and the Director
544 * to keep stateful firewalls from closing them down while waiting
547 add_wait = dev->rem_wait_sec;
548 if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
549 add_wait = me->heartbeat_interval;
551 if (!unmounted && dev->vol_poll_interval && add_wait > dev->vol_poll_interval) {
552 add_wait = dev->vol_poll_interval;
554 gettimeofday(&tv, &tz);
555 timeout.tv_nsec = tv.tv_usec * 1000;
556 timeout.tv_sec = tv.tv_sec + add_wait;
559 dev->dev_prev_blocked = dev->dev_blocked;
560 dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
563 for ( ; !job_canceled(jcr); ) {
566 Dmsg3(100, "I'm going to sleep on device %s. HB=%d wait=%d\n", dev_name(dev),
567 (int)me->heartbeat_interval, dev->wait_sec);
569 stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
570 Dmsg1(100, "Wokeup from sleep on device stat=%d\n", stat);
573 dev->rem_wait_sec -= (now - start);
575 /* Note, this always triggers the first time. We want that. */
576 if (me->heartbeat_interval) {
577 if (now - last_heartbeat >= me->heartbeat_interval) {
578 /* send heartbeats */
579 if (jcr->file_bsock) {
580 bnet_sig(jcr->file_bsock, BNET_HEARTBEAT);
581 Dmsg0(100, "Send heartbeat to FD.\n");
583 if (jcr->dir_bsock) {
584 bnet_sig(jcr->dir_bsock, BNET_HEARTBEAT);
586 last_heartbeat = now;
591 * Check if user unmounted the device while we were waiting
593 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
594 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
596 if (stat != ETIMEDOUT) { /* we blocked the device */
597 break; /* on error return */
599 if (dev->rem_wait_sec <= 0) { /* on exceeding wait time return */
600 Dmsg0(100, "Exceed wait time.\n");
604 if (!unmounted && dev->vol_poll_interval &&
605 (now - first_start >= dev->vol_poll_interval)) {
606 Dmsg1(200, "In wait blocked=%d\n", dev->dev_blocked);
611 * Check if user mounted the device while we were waiting
613 if (dev->dev_blocked == BST_MOUNT) { /* mount request ? */
618 add_wait = dev->wait_sec - (now - start);
622 if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
623 add_wait = me->heartbeat_interval;
625 gettimeofday(&tv, &tz);
626 timeout.tv_nsec = tv.tv_usec * 1000;
627 timeout.tv_sec = tv.tv_sec + add_wait; /* additional wait */
628 Dmsg1(100, "Additional wait %d sec.\n", add_wait);
632 dev->dev_blocked = dev->dev_prev_blocked; /* restore entry state */