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-2005 Kern Sibbald
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 pool_name=%s media_type=%s\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"
40 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia"
41 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u"
42 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d\n";
43 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
44 static char Job_status[] = "Status Job=%s JobStatus=%d\n";
48 /* Responses received from the Director */
49 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u"
50 " VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u"
51 " MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s"
52 " Slot=%d MaxVolJobs=%u MaxVolFiles=%u InChanger=%d"
53 " VolReadTime=%" lld " VolWriteTime=%" lld " EndFile=%u EndBlock=%u"
54 " VolParts=%u LabelType=%d";
57 static char OK_create[] = "1000 OK CreateJobMedia\n";
61 static char Device_update[] = "DevUpd Job=%s device=%s "
62 "append=%d read=%d num_writers=%d "
63 "open=%d labeled=%d offline=%d "
64 "reserved=%d max_writers=%d "
65 "autoselect=%d autochanger=%d "
66 "changer_name=%s media_type=%s volume_name=%s\n";
69 /* Send update information about a device to Director */
70 bool dir_update_device(JCR *jcr, DEVICE *dev)
72 BSOCK *dir = jcr->dir_bsock;
73 POOL_MEM dev_name, VolumeName, MediaType, ChangerName;
74 DEVRES *device = dev->device;
77 pm_strcpy(dev_name, device->hdr.name);
78 bash_spaces(dev_name);
79 if (dev->is_labeled()) {
80 pm_strcpy(VolumeName, dev->VolHdr.VolName);
82 pm_strcpy(VolumeName, "*");
84 bash_spaces(VolumeName);
85 pm_strcpy(MediaType, device->media_type);
86 bash_spaces(MediaType);
87 if (device->changer_res) {
88 pm_strcpy(ChangerName, device->changer_res->hdr.name);
89 bash_spaces(ChangerName);
91 pm_strcpy(ChangerName, "*");
93 ok =bnet_fsend(dir, Device_update,
97 dev->can_read()!=0, dev->num_writers,
98 dev->is_open()!=0, dev->is_labeled()!=0,
99 dev->is_offline()!=0, dev->reserved_device,
100 dev->is_tape()?100000:1,
102 ChangerName.c_str(), MediaType.c_str(), VolumeName.c_str());
103 Dmsg1(100, ">dird: %s\n", dir->msg);
107 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer)
109 BSOCK *dir = jcr->dir_bsock;
110 POOL_MEM dev_name, MediaType;
114 pm_strcpy(dev_name, changer->hdr.name);
115 bash_spaces(dev_name);
116 device = (DEVRES *)changer->device->first();
117 pm_strcpy(MediaType, device->media_type);
118 bash_spaces(MediaType);
119 /* This is mostly to indicate that we are here */
120 ok = bnet_fsend(dir, Device_update,
122 dev_name.c_str(), /* Changer name */
123 0, 0, 0, /* append, read, num_writers */
124 0, 0, 0, /* is_open, is_labeled, offline */
125 0, 0, /* reserved, max_writers */
127 changer->device->size(), /* Number of devices */
129 "*", /* ChangerName */
130 MediaType.c_str(), /* MediaType */
132 Dmsg1(100, ">dird: %s\n", dir->msg);
139 * Send current JobStatus to Director
141 bool dir_send_job_status(JCR *jcr)
143 return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
147 * Common routine for:
148 * dir_get_volume_info()
150 * dir_find_next_appendable_volume()
152 * Returns: true on success and vol info in dcr->VolCatInfo
155 static bool do_get_volume_info(DCR *dcr)
158 BSOCK *dir = jcr->dir_bsock;
163 dcr->VolumeName[0] = 0; /* No volume */
164 if (bnet_recv(dir) <= 0) {
165 Dmsg0(200, "getvolname error bnet_recv\n");
166 Mmsg(jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
169 memset(&vol, 0, sizeof(vol));
170 Dmsg1(100, "<dird %s", dir->msg);
171 n = sscanf(dir->msg, OK_media, vol.VolCatName,
172 &vol.VolCatJobs, &vol.VolCatFiles,
173 &vol.VolCatBlocks, &vol.VolCatBytes,
174 &vol.VolCatMounts, &vol.VolCatErrors,
175 &vol.VolCatWrites, &vol.VolCatMaxBytes,
176 &vol.VolCatCapacityBytes, vol.VolCatStatus,
177 &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles,
178 &InChanger, &vol.VolReadTime, &vol.VolWriteTime,
179 &vol.EndFile, &vol.EndBlock, &vol.VolCatParts,
182 Dmsg2(100, "Bad response from Dir fields=%d: %s\n", n, dir->msg);
183 Mmsg(jcr->errmsg, _("Error getting Volume info: %s\n"), dir->msg);
186 vol.InChanger = InChanger; /* bool in structure */
187 unbash_spaces(vol.VolCatName);
188 bstrncpy(dcr->VolumeName, vol.VolCatName, sizeof(dcr->VolumeName));
189 memcpy(&dcr->VolCatInfo, &vol, sizeof(dcr->VolCatInfo));
191 Dmsg2(300, "do_reqest_vol_info got slot=%d Volume=%s\n",
192 vol.Slot, vol.VolCatName);
198 * Get Volume info for a specific volume from the Director's Database
200 * Returns: true on success (not Director guarantees that Pool and MediaType
201 * are correct and VolStatus==Append or
202 * VolStatus==Recycle)
205 * Volume information returned in jcr
207 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw writing)
210 BSOCK *dir = jcr->dir_bsock;
212 bstrncpy(dcr->VolCatInfo.VolCatName, dcr->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
213 bash_spaces(dcr->VolCatInfo.VolCatName);
214 bnet_fsend(dir, Get_Vol_Info, jcr->Job, dcr->VolCatInfo.VolCatName,
215 writing==GET_VOL_INFO_FOR_WRITE?1:0);
216 Dmsg1(100, ">dird: %s", dir->msg);
217 return do_get_volume_info(dcr);
223 * Get info on the next appendable volume in the Director's database
224 * Returns: true on success
227 * Volume information returned in dcr
230 bool dir_find_next_appendable_volume(DCR *dcr)
233 BSOCK *dir = jcr->dir_bsock;
236 Dmsg0(200, "dir_find_next_appendable_volume\n");
238 * Try the three oldest or most available volumes. Note,
239 * the most available could already be mounted on another
240 * drive, so we continue looking for a not in use Volume.
242 for (int vol_index=1; vol_index < 3; vol_index++) {
243 bash_spaces(dcr->media_type);
244 bash_spaces(dcr->pool_name);
245 bnet_fsend(dir, Find_media, jcr->Job, vol_index, dcr->pool_name, dcr->media_type);
246 unbash_spaces(dcr->media_type);
247 unbash_spaces(dcr->pool_name);
248 Dmsg1(100, ">dird: %s", dir->msg);
249 if (do_get_volume_info(dcr)) {
250 Dmsg2(300, "JobId=%d got possible Vol=%s\n", jcr->JobId, dcr->VolumeName);
253 * Walk through all jobs and see if the volume is
254 * already mounted. If so, try a different one.
255 * This would be better done by walking through
261 free_locked_jcr(njcr);
264 Dmsg2(300, "Compare to JobId=%d using Vol=%s\n", njcr->JobId, njcr->dcr->VolumeName);
265 if (njcr->dcr && strcmp(dcr->VolumeName, njcr->dcr->VolumeName) == 0) {
267 Dmsg1(400, "Vol in use by JobId=%u\n", njcr->JobId);
268 free_locked_jcr(njcr);
271 free_locked_jcr(njcr);
275 Dmsg0(400, "dir_find_next_appendable_volume return true\n");
276 return true; /* Got good Volume */
279 Dmsg0(200, "No volume info, return false\n");
283 Dmsg0(400, "dir_find_next_appendable_volume return true\n");
289 * After writing a Volume, send the updated statistics
290 * back to the director. The information comes from the
293 bool dir_update_volume_info(DCR *dcr, bool label)
296 BSOCK *dir = jcr->dir_bsock;
297 DEVICE *dev = dcr->dev;
298 time_t LastWritten = time(NULL);
299 char ed1[50], ed2[50], ed3[50], ed4[50];
300 VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
304 if (vol->VolCatName[0] == 0) {
305 Jmsg0(jcr, M_FATAL, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
306 Pmsg0(000, "NULL Volume name. This shouldn't happen!!!\n");
309 if (dev->can_read()) {
310 Jmsg0(jcr, M_FATAL, 0, _("Attempt to update_volume_info in read mode!!!\n"));
311 Pmsg0(000, "Attempt to update_volume_info in read mode!!!\n");
315 Dmsg1(300, "Update cat VolFiles=%d\n", dev->file);
316 /* Just labeled or relabeled the tape */
318 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
319 vol->VolCatBytes = 1; /* indicates tape labeled */
321 pm_strcpy(VolumeName, vol->VolCatName);
322 bash_spaces(VolumeName);
323 InChanger = vol->InChanger;
324 bnet_fsend(dir, Update_media, jcr->Job,
325 VolumeName.c_str(), vol->VolCatJobs, vol->VolCatFiles,
326 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
327 vol->VolCatMounts, vol->VolCatErrors,
328 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
329 LastWritten, vol->VolCatStatus, vol->Slot, label,
330 InChanger, /* bool in structure */
331 edit_uint64(vol->VolReadTime, ed3),
332 edit_uint64(vol->VolWriteTime, ed4),
334 Dmsg1(100, ">dird: %s", dir->msg);
336 if (!do_get_volume_info(dcr)) {
337 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
338 Pmsg2(000, "Didn't get vol info vol=%s: ERR=%s",
339 vol->VolCatName, jcr->errmsg);
342 Dmsg1(420, "get_volume_info(): %s", dir->msg);
343 /* Update dev Volume info in case something changed (e.g. expired) */
344 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
349 * After writing a Volume, create the JobMedia record.
351 bool dir_create_jobmedia_record(DCR *dcr)
354 BSOCK *dir = jcr->dir_bsock;
356 if (!dcr->WroteVol) {
357 return true; /* nothing written to tape */
360 dcr->WroteVol = false;
361 bnet_fsend(dir, Create_job_media, jcr->Job,
362 dcr->VolFirstIndex, dcr->VolLastIndex,
363 dcr->StartFile, dcr->EndFile,
364 dcr->StartBlock, dcr->EndBlock,
365 dcr->Copy, dcr->Stripe);
366 Dmsg1(100, ">dird: %s", dir->msg);
367 if (bnet_recv(dir) <= 0) {
368 Dmsg0(190, "create_jobmedia error bnet_recv\n");
369 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: ERR=%s\n"),
373 Dmsg1(100, "<dir: %s", dir->msg);
374 if (strcmp(dir->msg, OK_create) != 0) {
375 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
376 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
384 * Update File Attribute data
386 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec)
389 BSOCK *dir = jcr->dir_bsock;
392 #ifdef NO_ATTRIBUTES_TEST
396 dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
397 dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
398 sizeof(DEV_RECORD) + rec->data_len);
399 ser_begin(dir->msg + dir->msglen, 0);
400 ser_uint32(rec->VolSessionId);
401 ser_uint32(rec->VolSessionTime);
402 ser_int32(rec->FileIndex);
403 ser_int32(rec->Stream);
404 ser_uint32(rec->data_len);
405 ser_bytes(rec->data, rec->data_len);
406 dir->msglen = ser_length(dir->msg);
407 Dmsg1(1800, ">dird: %s\n", dir->msg); /* Attributes */
408 return bnet_send(dir);
413 * Request the sysop to create an appendable volume
415 * Entered with device blocked.
416 * Leaves with device blocked.
418 * Returns: true on success (operator issues a mount command)
420 * Note, must create dev->errmsg on error return.
422 * On success, dcr->VolumeName and dcr->VolCatInfo contain
423 * information on suggested volume, but this may not be the
424 * same as what is actually mounted.
426 * When we return with success, the correct tape may or may not
427 * actually be mounted. The calling routine must read it and
430 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr)
435 DEVICE *dev = dcr->dev;
438 Dmsg0(400, "enter dir_ask_sysop_to_create_appendable_volume\n");
439 ASSERT(dev->dev_blocked);
441 if (job_canceled(jcr)) {
443 _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
444 jcr->Job, dev->print_name());
445 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
448 /* First pass, we *know* there are no appendable volumes, so no need to call */
449 if (!first && dir_find_next_appendable_volume(dcr)) { /* get suggested volume */
450 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
451 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
453 * If we have a valid volume name and we are not
454 * removable media, return now, or if we have a
455 * Slot for an autochanger, otherwise wait
456 * for the operator to mount the media.
458 if (!unmounted && ((dcr->VolumeName[0] && !dev_cap(dev, CAP_REM) &&
459 dev_cap(dev, CAP_LABEL)) ||
460 (dcr->VolumeName[0] && dcr->VolCatInfo.Slot))) {
461 Dmsg0(400, "Return 1 from mount without wait.\n");
464 jstat = JS_WaitMount;
466 Jmsg(jcr, M_MOUNT, 0, _(
467 "Please mount Volume \"%s\" on Storage Device %s for Job %s\n"
468 "Use \"mount\" command to release Job.\n"),
469 dcr->VolumeName, dev->print_name(), jcr->Job);
470 Dmsg3(400, "Mount %s on %s for Job %s\n",
471 dcr->VolumeName, dcr->dev_name, jcr->Job);
474 jstat = JS_WaitMedia;
476 Jmsg(jcr, M_MOUNT, 0, _(
477 "Job %s waiting. Cannot find any appendable volumes.\n"
478 "Please use the \"label\" command to create a new Volume for:\n"
490 jcr->JobStatus = jstat;
491 dir_send_job_status(jcr);
493 stat = wait_for_sysop(dcr);
495 Dmsg1(400, "Poll timeout in create append vol on device %s\n", dev->print_name());
499 if (stat == ETIMEDOUT) {
500 if (!double_dev_wait_time(dev)) {
501 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
502 dev->print_name(), jcr->Job);
503 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
504 Dmsg1(400, "Gave up waiting on device %s\n", dev->print_name());
505 return false; /* exceeded maximum waits */
509 if (stat == EINVAL) {
511 Mmsg2(dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
512 stat, be.strerror(stat));
513 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
518 Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
521 Dmsg1(400, "Someone woke me for device %s\n", dev->print_name());
523 /* If no VolumeName, and cannot get one, try again */
524 if (dcr->VolumeName[0] == 0 && !job_canceled(jcr) &&
525 !dir_find_next_appendable_volume(dcr)) {
526 Jmsg(jcr, M_MOUNT, 0, _(
527 "Someone woke me up, but I cannot find any appendable\n"
528 "volumes for Job=%s.\n"), jcr->Job);
529 /* Restart wait counters after user interaction */
530 init_device_wait_timers(dcr);
533 unmounted = (dev->dev_blocked == BST_UNMOUNTED) ||
534 (dev->dev_blocked == BST_UNMOUNTED_WAITING_FOR_SYSOP);
536 continue; /* continue to wait */
540 * Device mounted, we have a volume, break and return
544 set_jcr_job_status(jcr, JS_Running);
545 dir_send_job_status(jcr);
546 Dmsg0(400, "leave dir_ask_sysop_to_mount_create_appendable_volume\n");
551 * Request to mount specific Volume
553 * Entered with device blocked and dcr->VolumeName is desired
555 * Leaves with device blocked.
557 * Returns: true on success (operator issues a mount command)
559 * Note, must create dev->errmsg on error return.
562 bool dir_ask_sysop_to_mount_volume(DCR *dcr)
566 DEVICE *dev = dcr->dev;
569 Dmsg0(400, "enter dir_ask_sysop_to_mount_volume\n");
570 if (!dcr->VolumeName[0]) {
571 Mmsg0(dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
574 ASSERT(dev->dev_blocked);
576 if (job_canceled(jcr)) {
577 Mmsg(dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device %s.\n"),
578 jcr->Job, dev->print_name());
583 msg = _("Please mount");
584 Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device %s for Job %s\n"),
585 msg, dcr->VolumeName, dev->print_name(), jcr->Job);
586 Dmsg3(400, "Mount \"%s\" on device \"%s\" for Job %s\n",
587 dcr->VolumeName, dcr->dev_name, jcr->Job);
590 jcr->JobStatus = JS_WaitMount;
591 dir_send_job_status(jcr);
593 stat = wait_for_sysop(dcr); ; /* wait on device */
595 Dmsg1(400, "Poll timeout in mount vol on device %s\n", dev->print_name());
596 Dmsg1(400, "Blocked=%s\n", edit_blocked_reason(dev));
600 if (stat == ETIMEDOUT) {
601 if (!double_dev_wait_time(dev)) {
602 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
603 dev->print_name(), jcr->Job);
604 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
605 Dmsg1(400, "Gave up waiting on device %s\n", dev->print_name());
606 return false; /* exceeded maximum waits */
610 if (stat == EINVAL) {
612 Mmsg2(dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
613 stat, be.strerror(stat));
614 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
619 Jmsg(jcr, M_FATAL, 0, _("pthread error in mount_next_volume stat=%d: ERR=%s\n"), stat,
622 Dmsg1(400, "Someone woke me for device %s\n", dev->print_name());
625 set_jcr_job_status(jcr, JS_Running);
626 dir_send_job_status(jcr);
627 Dmsg0(400, "leave dir_ask_sysop_to_mount_volume\n");