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-2003 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\n";
40 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia \
41 FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u \
42 StartBlock=%u EndBlock=%u\n";
43 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
44 static char Job_status[] = "3012 Job %s jobstatus %d\n";
47 /* Responses received from the Director */
48 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%u\
49 VolBlocks=%u VolBytes=%" lld " VolMounts=%u VolErrors=%u VolWrites=%u\
50 MaxVolBytes=%" lld " VolCapacityBytes=%" lld " VolStatus=%20s\
51 Slot=%d MaxVolJobs=%u MaxVolFiles=%u\n";
52 static char OK_update[] = "1000 OK UpdateMedia\n";
54 /* Forward referenced functions */
55 static int wait_for_sysop(JCR *jcr, DEVICE *dev, int wait_sec);
58 * Send current JobStatus to Director
60 int dir_send_job_status(JCR *jcr)
62 return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
67 * dir_get_volume_info()
69 * dir_find_next_appendable_volume()
71 static int do_request_volume_info(JCR *jcr)
73 BSOCK *dir = jcr->dir_bsock;
76 jcr->VolumeName[0] = 0; /* No volume */
77 if (bnet_recv(dir) <= 0) {
78 Dmsg0(200, "getvolname error bnet_recv\n");
79 Mmsg(&jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
82 memset(&vol, 0, sizeof(vol));
83 if (sscanf(dir->msg, OK_media, vol.VolCatName,
84 &vol.VolCatJobs, &vol.VolCatFiles,
85 &vol.VolCatBlocks, &vol.VolCatBytes,
86 &vol.VolCatMounts, &vol.VolCatErrors,
87 &vol.VolCatWrites, &vol.VolCatMaxBytes,
88 &vol.VolCatCapacityBytes, vol.VolCatStatus,
89 &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles) != 14) {
91 Dmsg1(200, "Bad response from Dir: %s\n", dir->msg);
92 Mmsg(&jcr->errmsg, _("Error scanning Dir response: %s\n"), dir->msg);
95 unbash_spaces(vol.VolCatName);
96 pm_strcpy(&jcr->VolumeName, vol.VolCatName); /* set desired VolumeName */
97 memcpy(&jcr->VolCatInfo, &vol, sizeof(jcr->VolCatInfo));
99 Dmsg2(200, "do_reqest_vol_info got slot=%d Volume=%s\n",
100 vol.Slot, vol.VolCatName);
106 * Get Volume info for a specific volume from the Director's Database
108 * Returns: 1 on success (not Director guarantees that Pool and MediaType
109 * are correct and VolStatus==Append or
110 * VolStatus==Recycle)
113 * Volume information returned in jcr
115 int dir_get_volume_info(JCR *jcr, enum get_vol_info_rw writing)
117 BSOCK *dir = jcr->dir_bsock;
119 bstrncpy(jcr->VolCatInfo.VolCatName, jcr->VolumeName, sizeof(jcr->VolCatInfo.VolCatName));
120 Dmsg1(200, "dir_get_volume_info=%s\n", jcr->VolCatInfo.VolCatName);
121 bash_spaces(jcr->VolCatInfo.VolCatName);
122 bnet_fsend(dir, Get_Vol_Info, jcr->Job, jcr->VolCatInfo.VolCatName,
123 writing==GET_VOL_INFO_FOR_WRITE?1:0);
124 return do_request_volume_info(jcr);
130 * Get info on the next appendable volume in the Director's database
131 * Returns: 1 on success
134 * Volume information returned in jcr
137 int dir_find_next_appendable_volume(JCR *jcr)
139 BSOCK *dir = jcr->dir_bsock;
141 Dmsg0(200, "dir_find_next_appendable_volume\n");
142 bnet_fsend(dir, Find_media, jcr->Job, 1);
143 return do_request_volume_info(jcr);
148 * After writing a Volume, send the updated statistics
149 * back to the director.
151 int dir_update_volume_info(JCR *jcr, VOLUME_CAT_INFO *vol, int label)
153 BSOCK *dir = jcr->dir_bsock;
154 time_t EndTime = time(NULL);
155 char ed1[50], ed2[50];
157 if (vol->VolCatName[0] == 0) {
158 Jmsg0(jcr, M_ERROR, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
161 /* Just labeled or relabeled the tape */
163 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
164 vol->VolCatBytes = 1; /* indicates tape labeled */
166 bash_spaces(vol->VolCatName);
167 bnet_fsend(dir, Update_media, jcr->Job,
168 vol->VolCatName, vol->VolCatJobs, vol->VolCatFiles,
169 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
170 vol->VolCatMounts, vol->VolCatErrors,
171 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
172 EndTime, vol->VolCatStatus, vol->Slot, label);
173 Dmsg1(120, "update_volume_data(): %s", dir->msg);
174 unbash_spaces(vol->VolCatName);
175 if (bnet_recv(dir) <= 0) {
176 Dmsg0(190, "updateVolCatInfo error bnet_recv\n");
177 Jmsg(jcr, M_ERROR, 0, _("Error updating Volume info Vol=\"%s\": ERR=%s\n"),
178 vol->VolCatName, bnet_strerror(dir));
181 Dmsg1(120, "Updatevol: %s", dir->msg);
182 if (strcmp(dir->msg, OK_update) != 0) {
183 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
184 Jmsg(jcr, M_ERROR, 0, _("Error updating Volume info Vol=\"%s\": %s\n"),
185 vol->VolCatName, dir->msg);
192 * After writing a Volume, create the JobMedia record.
194 int dir_create_jobmedia_record(JCR *jcr)
196 BSOCK *dir = jcr->dir_bsock;
198 if (!jcr->WroteVol) {
199 return 1; /* nothing written to tape */
202 jcr->WroteVol = false;
203 bnet_fsend(dir, Create_job_media, jcr->Job,
204 jcr->VolFirstIndex, jcr->VolLastIndex,
205 jcr->StartFile, jcr->EndFile,
206 jcr->StartBlock, jcr->EndBlock);
207 Dmsg1(100, "create_jobmedia(): %s", dir->msg);
208 if (bnet_recv(dir) <= 0) {
209 Dmsg0(190, "create_jobmedia error bnet_recv\n");
210 Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: ERR=%s\n"),
214 Dmsg1(120, "Create_jobmedia: %s", dir->msg);
215 if (strcmp(dir->msg, OK_update) != 0) {
216 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
217 Jmsg(jcr, M_ERROR, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
225 * Update File Attribute data
227 int dir_update_file_attributes(JCR *jcr, DEV_RECORD *rec)
229 BSOCK *dir = jcr->dir_bsock;
232 dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
233 dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
234 sizeof(DEV_RECORD) + rec->data_len);
235 ser_begin(dir->msg + dir->msglen, 0);
236 ser_uint32(rec->VolSessionId);
237 ser_uint32(rec->VolSessionTime);
238 ser_int32(rec->FileIndex);
239 ser_int32(rec->Stream);
240 ser_uint32(rec->data_len);
241 ser_bytes(rec->data, rec->data_len);
242 dir->msglen = ser_length(dir->msg);
243 return bnet_send(dir);
249 * Entered with device blocked.
250 * Leaves with device blocked.
252 * Returns: 1 on success (operator issues a mount command)
254 * Note, must create dev->errmsg on error return.
256 * On success, jcr->VolumeName and jcr->VolCatInfo contain
257 * information on suggested volume, but this may not be the
258 * same as what is actually mounted.
260 * When we return with success, the correct tape may or may not
261 * actually be mounted. The calling routine must read it and
264 int dir_ask_sysop_to_mount_next_volume(JCR *jcr, DEVICE *dev)
267 /* ******FIXME******* put these on config variable */
268 int min_wait = 60 * 60;
269 int max_wait = 24 * 60 * 60;
270 int max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
275 Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
276 ASSERT(dev->dev_blocked);
279 if (job_canceled(jcr)) {
280 Mmsg(&dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
281 jcr->Job, jcr->dev_name);
282 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
285 if (dir_find_next_appendable_volume(jcr)) { /* get suggested volume */
286 jstat = JS_WaitMount;
288 * If we have a valid volume name and we are not
289 * removable media, return now, or if we have a
290 * Slot for an autochanger, otherwise wait
291 * for the operator to mount the media.
293 if ((jcr->VolumeName[0] && !dev_cap(dev, CAP_REM) && dev_cap(dev, CAP_LABEL)) ||
294 (jcr->VolumeName[0] && jcr->VolCatInfo.Slot)) {
295 Dmsg0(100, "Return 1 from mount without wait.\n");
298 Jmsg(jcr, M_MOUNT, 0, _(
299 "Please mount Volume \"%s\" on Storage Device \"%s\" for Job %s\n"
300 "Use \"mount\" command to release Job.\n"),
301 jcr->VolumeName, jcr->dev_name, jcr->Job);
302 Dmsg3(190, "Mount %s on %s for Job %s\n",
303 jcr->VolumeName, jcr->dev_name, jcr->Job);
305 jstat = JS_WaitMedia;
306 Jmsg(jcr, M_MOUNT, 0, _(
307 "Job %s waiting. Cannot find any appendable volumes.\n\
308 Please use the \"label\" command to create a new Volume for:\n\
318 jcr->JobStatus = jstat;
319 dir_send_job_status(jcr);
321 stat = wait_for_sysop(jcr, dev, wait_sec);
323 if (stat == ETIMEDOUT) {
324 wait_sec *= 2; /* double wait time */
325 if (wait_sec > max_wait) { /* but not longer than maxtime */
329 if (num_wait >= max_num_wait) {
330 Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
331 jcr->dev_name, jcr->Job);
332 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
333 Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
334 return 0; /* exceeded maximum waits */
338 if (stat == EINVAL) {
339 Mmsg2(&dev->errmsg, _("pthread error in mount_next_volume stat=%d ERR=%s\n"),
340 stat, strerror(stat));
341 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
345 Jmsg(jcr, M_WARNING, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
348 Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
350 /* Restart wait counters */
353 /* If no VolumeName, and cannot get one, try again */
354 if (jcr->VolumeName[0] == 0 &&
355 !dir_find_next_appendable_volume(jcr) && !job_canceled(jcr)) {
356 Jmsg(jcr, M_MOUNT, 0, _(
357 "Someone woke me up, but I cannot find any appendable\n\
358 volumes for Job=%s.\n"), jcr->Job);
363 set_jcr_job_status(jcr, JS_Running);
364 dir_send_job_status(jcr);
365 Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
371 * Entered with device blocked and jcr->VolumeName is desired
373 * Leaves with device blocked.
375 * Returns: 1 on success (operator issues a mount command)
377 * Note, must create dev->errmsg on error return.
380 int dir_ask_sysop_to_mount_volume(JCR *jcr, DEVICE *dev)
383 /* ******FIXME******* put these on config variable */
384 int min_wait = 60 * 60;
385 int max_wait = 24 * 60 * 60;
386 int max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
391 Dmsg0(130, "enter dir_ask_sysop_to_mount_next_volume\n");
392 if (!jcr->VolumeName[0]) {
393 Mmsg0(&dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
396 ASSERT(dev->dev_blocked);
399 if (job_canceled(jcr)) {
400 Mmsg(&dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
401 jcr->Job, jcr->dev_name);
404 msg = _("Please mount");
405 Jmsg(jcr, M_MOUNT, 0, _("%s Volume \"%s\" on Storage Device \"%s\" for Job %s\n"),
406 msg, jcr->VolumeName, jcr->dev_name, jcr->Job);
407 Dmsg3(190, "Mount %s on %s for Job %s\n",
408 jcr->VolumeName, jcr->dev_name, jcr->Job);
410 jcr->JobStatus = JS_WaitMount;
411 dir_send_job_status(jcr);
413 stat = wait_for_sysop(jcr, dev, wait_sec); /* wait on device */
415 if (stat == ETIMEDOUT) {
416 wait_sec *= 2; /* double wait time */
417 if (wait_sec > max_wait) { /* but not longer than maxtime */
421 if (num_wait >= max_num_wait) {
422 Mmsg(&dev->errmsg, _("Gave up waiting to mount Storage Device \"%s\" for Job %s\n"),
423 jcr->dev_name, jcr->Job);
424 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
425 Dmsg1(190, "Gave up waiting on device %s\n", dev_name(dev));
426 return 0; /* exceeded maximum waits */
430 if (stat == EINVAL) {
431 Mmsg2(&dev->errmsg, _("pthread error in mount_volume stat=%d ERR=%s\n"),
432 stat, strerror(stat));
433 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
437 Jmsg(jcr, M_ERROR, 0, _("pthread error in mount_next_volume stat=%d ERR=%s\n"), stat,
440 Dmsg1(190, "Someone woke me for device %s\n", dev_name(dev));
442 /* Restart wait counters */
447 set_jcr_job_status(jcr, JS_Running);
448 dir_send_job_status(jcr);
449 Dmsg0(130, "leave dir_ask_sysop_to_mount_next_volume\n");
454 * Wait for SysOp to mount a tape
456 static int wait_for_sysop(JCR *jcr, DEVICE *dev, int wait_sec)
460 struct timespec timeout;
462 time_t start = time(NULL);
463 time_t last_heartbeat = 0;
468 * Wait requested time (wait_sec). However, we also wake up every
469 * HB_TIME seconds and send a heartbeat to the FD and the Director
470 * to keep stateful firewalls from closing them down while waiting
474 if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
475 add_wait = me->heartbeat_interval;
477 gettimeofday(&tv, &tz);
478 timeout.tv_nsec = tv.tv_usec * 1000;
479 timeout.tv_sec = tv.tv_sec + add_wait;
482 dev_blocked = dev->dev_blocked;
483 dev->dev_blocked = BST_WAITING_FOR_SYSOP; /* indicate waiting for mount */
485 for ( ; !job_canceled(jcr); ) {
488 Dmsg3(100, "I'm going to sleep on device %s. HB=%d wait=%d\n", dev_name(dev),
489 (int)me->heartbeat_interval, wait_sec);
490 stat = pthread_cond_timedwait(&dev->wait_next_vol, &dev->mutex, &timeout);
491 Dmsg1(100, "Wokeup from sleep on device stat=%d\n", stat);
495 /* Note, this always triggers the first time. We want that. */
496 if (me->heartbeat_interval) {
497 if (now - last_heartbeat >= me->heartbeat_interval) {
498 /* send heartbeats */
499 if (jcr->file_bsock) {
500 bnet_sig(jcr->file_bsock, BNET_HEARTBEAT);
501 Dmsg0(100, "Send heartbeat to FD.\n");
503 if (jcr->dir_bsock) {
504 bnet_sig(jcr->dir_bsock, BNET_HEARTBEAT);
506 last_heartbeat = now;
510 if (dev->dev_blocked == BST_MOUNT) { /* mount request ? */
515 if (stat != ETIMEDOUT) { /* we blocked the device */
516 break; /* on error return */
518 if (now - start >= wait_sec) { /* on exceeding wait time return */
519 Dmsg0(100, "Exceed wait time.\n");
522 add_wait = wait_sec - (now - start);
523 if (me->heartbeat_interval && add_wait > me->heartbeat_interval) {
524 add_wait = me->heartbeat_interval;
526 gettimeofday(&tv, &tz);
527 timeout.tv_nsec = tv.tv_usec * 1000;
528 timeout.tv_sec = tv.tv_sec + add_wait; /* additional wait */
529 Dmsg1(100, "Additional wait %d sec.\n", add_wait);
532 dev->dev_blocked = dev_blocked;