2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Subroutines to handle Catalog reqests sent to the Director
30 * Reqests/commands from the Director are handled in dircmd.c
32 * Kern Sibbald, December 2000
37 #include "bacula.h" /* pull in global headers */
38 #include "stored.h" /* pull in Storage Deamon headers */
40 /* Requests sent to the Director */
41 static char Find_media[] = "CatReq Job=%s FindMedia=%d pool_name=%s media_type=%s\n";
42 static char Get_Vol_Info[] = "CatReq Job=%s GetVolInfo VolName=%s write=%d\n";
43 static char Update_media[] = "CatReq Job=%s UpdateMedia VolName=%s"
44 " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%s VolMounts=%u"
45 " VolErrors=%u VolWrites=%u MaxVolBytes=%s EndTime=%d VolStatus=%s"
46 " Slot=%d relabel=%d InChanger=%d VolReadTime=%s VolWriteTime=%s"
47 " VolFirstWritten=%s VolParts=%u\n";
48 static char Create_job_media[] = "CatReq Job=%s CreateJobMedia"
49 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u"
50 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d MediaId=%s\n";
51 static char FileAttributes[] = "UpdCat Job=%s FileAttributes ";
52 static char Job_status[] = "Status Job=%s JobStatus=%d\n";
54 /* Responses received from the Director */
55 static char OK_media[] = "1000 OK VolName=%127s VolJobs=%u VolFiles=%lu"
56 " VolBlocks=%lu VolBytes=%lld VolMounts=%lu VolErrors=%lu VolWrites=%lu"
57 " MaxVolBytes=%lld VolCapacityBytes=%lld VolStatus=%20s"
58 " Slot=%ld MaxVolJobs=%lu MaxVolFiles=%lu InChanger=%ld"
59 " VolReadTime=%lld VolWriteTime=%lld EndFile=%lu EndBlock=%lu"
60 " VolParts=%lu LabelType=%ld MediaId=%lld\n";
63 static char OK_create[] = "1000 OK CreateJobMedia\n";
65 static pthread_mutex_t vol_info_mutex = PTHREAD_MUTEX_INITIALIZER;
69 static char Device_update[] = "DevUpd Job=%s device=%s "
70 "append=%d read=%d num_writers=%d "
71 "open=%d labeled=%d offline=%d "
72 "reserved=%d max_writers=%d "
73 "autoselect=%d autochanger=%d "
74 "changer_name=%s media_type=%s volume_name=%s\n";
77 /* Send update information about a device to Director */
78 bool dir_update_device(JCR *jcr, DEVICE *dev)
80 BSOCK *dir = jcr->dir_bsock;
81 POOL_MEM dev_name, VolumeName, MediaType, ChangerName;
82 DEVRES *device = dev->device;
85 pm_strcpy(dev_name, device->hdr.name);
86 bash_spaces(dev_name);
87 if (dev->is_labeled()) {
88 pm_strcpy(VolumeName, dev->VolHdr.VolumeName);
90 pm_strcpy(VolumeName, "*");
92 bash_spaces(VolumeName);
93 pm_strcpy(MediaType, device->media_type);
94 bash_spaces(MediaType);
95 if (device->changer_res) {
96 pm_strcpy(ChangerName, device->changer_res->hdr.name);
97 bash_spaces(ChangerName);
99 pm_strcpy(ChangerName, "*");
101 ok =bnet_fsend(dir, Device_update,
104 dev->can_append()!=0,
105 dev->can_read()!=0, dev->num_writers,
106 dev->is_open()!=0, dev->is_labeled()!=0,
107 dev->is_offline()!=0, dev->reserved_device,
108 dev->is_tape()?100000:1,
110 ChangerName.c_str(), MediaType.c_str(), VolumeName.c_str());
111 Dmsg1(100, ">dird: %s\n", dir->msg);
115 bool dir_update_changer(JCR *jcr, AUTOCHANGER *changer)
117 BSOCK *dir = jcr->dir_bsock;
118 POOL_MEM dev_name, MediaType;
122 pm_strcpy(dev_name, changer->hdr.name);
123 bash_spaces(dev_name);
124 device = (DEVRES *)changer->device->first();
125 pm_strcpy(MediaType, device->media_type);
126 bash_spaces(MediaType);
127 /* This is mostly to indicate that we are here */
128 ok = bnet_fsend(dir, Device_update,
130 dev_name.c_str(), /* Changer name */
131 0, 0, 0, /* append, read, num_writers */
132 0, 0, 0, /* is_open, is_labeled, offline */
133 0, 0, /* reserved, max_writers */
135 changer->device->size(), /* Number of devices */
137 "*", /* ChangerName */
138 MediaType.c_str(), /* MediaType */
140 Dmsg1(100, ">dird: %s\n", dir->msg);
147 * Send current JobStatus to Director
149 bool dir_send_job_status(JCR *jcr)
151 return bnet_fsend(jcr->dir_bsock, Job_status, jcr->Job, jcr->JobStatus);
155 * Common routine for:
156 * dir_get_volume_info()
158 * dir_find_next_appendable_volume()
160 * NOTE!!! All calls to this routine must be protected by
161 * locking vol_info_mutex before calling it so that
162 * we don't have one thread modifying the parameters
163 * and another reading them.
165 * Returns: true on success and vol info in dcr->VolCatInfo
168 static bool do_get_volume_info(DCR *dcr)
171 BSOCK *dir = jcr->dir_bsock;
176 if (dir->recv() <= 0) {
177 Dmsg0(200, "getvolname error bnet_recv\n");
178 Mmsg(jcr->errmsg, _("Network error on bnet_recv in req_vol_info.\n"));
181 memset(&vol, 0, sizeof(vol));
182 Dmsg2(100, "<dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
183 n = sscanf(dir->msg, OK_media, vol.VolCatName,
184 &vol.VolCatJobs, &vol.VolCatFiles,
185 &vol.VolCatBlocks, &vol.VolCatBytes,
186 &vol.VolCatMounts, &vol.VolCatErrors,
187 &vol.VolCatWrites, &vol.VolCatMaxBytes,
188 &vol.VolCatCapacityBytes, vol.VolCatStatus,
189 &vol.Slot, &vol.VolCatMaxJobs, &vol.VolCatMaxFiles,
190 &InChanger, &vol.VolReadTime, &vol.VolWriteTime,
191 &vol.EndFile, &vol.EndBlock, &vol.VolCatParts,
192 &vol.LabelType, &vol.VolMediaId);
194 Dmsg4(100, "Bad response from Dir jid=%u fields=%d, len=%d: %s",
195 (uint32_t)jcr->JobId, n, dir->msglen, dir->msg);
196 Mmsg(jcr->errmsg, _("Error getting Volume info: %s"), dir->msg);
199 vol.InChanger = InChanger; /* bool in structure */
200 unbash_spaces(vol.VolCatName);
201 bstrncpy(dcr->VolumeName, vol.VolCatName, sizeof(dcr->VolumeName));
202 dcr->VolCatInfo = vol; /* structure assignment */
204 Dmsg3(100, "do_reqest_vol_info return true jid=%u slot=%d Volume=%s\n",
205 (uint32_t)jcr->JobId, vol.Slot, vol.VolCatName);
211 * Get Volume info for a specific volume from the Director's Database
213 * Returns: true on success (Director guarantees that Pool and MediaType
214 * are correct and VolStatus==Append or
215 * VolStatus==Recycle)
218 * Volume information returned in dcr->VolCatInfo
220 bool dir_get_volume_info(DCR *dcr, enum get_vol_info_rw writing)
223 BSOCK *dir = jcr->dir_bsock;
226 bstrncpy(dcr->VolCatInfo.VolCatName, dcr->VolumeName, sizeof(dcr->VolCatInfo.VolCatName));
227 bash_spaces(dcr->VolCatInfo.VolCatName);
228 dir->fsend(Get_Vol_Info, jcr->Job, dcr->VolCatInfo.VolCatName,
229 writing==GET_VOL_INFO_FOR_WRITE?1:0);
230 Dmsg2(100, ">dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
231 unbash_spaces(dcr->VolCatInfo.VolCatName);
232 bool ok = do_get_volume_info(dcr);
240 * Get info on the next appendable volume in the Director's database
242 * Returns: true on success dcr->VolumeName is volume
243 * reserve_volume() called on Volume name
244 * false on failure dcr->VolumeName[0] == 0
245 * also sets dcr->volume_in_use if at least one
246 * in use volume was found.
248 * Volume information returned in dcr
251 bool dir_find_next_appendable_volume(DCR *dcr)
254 BSOCK *dir = jcr->dir_bsock;
257 Dmsg0(200, "dir_find_next_appendable_volume\n");
259 * Try the twenty oldest or most available volumes. Note,
260 * the most available could already be mounted on another
261 * drive, so we continue looking for a not in use Volume.
265 dcr->volume_in_use = false;
266 for (int vol_index=1; vol_index < 20; vol_index++) {
267 bash_spaces(dcr->media_type);
268 bash_spaces(dcr->pool_name);
269 dir->fsend(Find_media, jcr->Job, vol_index, dcr->pool_name, dcr->media_type);
270 unbash_spaces(dcr->media_type);
271 unbash_spaces(dcr->pool_name);
272 Dmsg2(100, ">dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
273 bool ok = do_get_volume_info(dcr);
275 if (!is_volume_in_use(dcr)) {
279 Dmsg2(100, "jid=%u Volume %s is in use.\n", (uint32_t)jcr->JobId, dcr->VolumeName);
280 dcr->volume_in_use = true;
284 Dmsg2(100, "No vol. index %d return false. dev=%s\n", vol_index,
285 dcr->dev->print_name());
291 Dmsg0(400, "dir_find_next_appendable_volume return true\n");
292 if (reserve_volume(dcr, dcr->VolumeName) == 0) {
293 Dmsg2(100, "Could not reserve volume %s on %s\n", dcr->VolumeName,
294 dcr->dev->print_name());
298 unlock_reservations();
303 dcr->VolumeName[0] = 0;
305 unlock_reservations();
311 * After writing a Volume, send the updated statistics
312 * back to the director. The information comes from the
315 bool dir_update_volume_info(DCR *dcr, bool label)
318 BSOCK *dir = jcr->dir_bsock;
319 DEVICE *dev = dcr->dev;
320 time_t LastWritten = time(NULL);
321 VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
322 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50];
327 /* If system job, do not update catalog */
328 if (jcr->JobType == JT_SYSTEM) {
332 if (vol->VolCatName[0] == 0) {
333 Jmsg0(jcr, M_FATAL, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
334 Pmsg0(000, _("NULL Volume name. This shouldn't happen!!!\n"));
338 /* Lock during Volume update */
340 Dmsg1(100, "Update cat VolFiles=%d\n", dev->file);
341 /* Just labeled or relabeled the tape */
343 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
345 pm_strcpy(VolumeName, vol->VolCatName);
346 bash_spaces(VolumeName);
347 InChanger = vol->InChanger;
348 bnet_fsend(dir, Update_media, jcr->Job,
349 VolumeName.c_str(), vol->VolCatJobs, vol->VolCatFiles,
350 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
351 vol->VolCatMounts, vol->VolCatErrors,
352 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
353 LastWritten, vol->VolCatStatus, vol->Slot, label,
354 InChanger, /* bool in structure */
355 edit_int64(vol->VolReadTime, ed3),
356 edit_int64(vol->VolWriteTime, ed4),
357 edit_uint64(vol->VolFirstWritten, ed5),
359 Dmsg2(100, ">dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
361 /* Do not lock device here because it may be locked from label */
362 if (!do_get_volume_info(dcr)) {
363 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
364 Dmsg2(100, _("Didn't get vol info vol=%s: ERR=%s"),
365 vol->VolCatName, jcr->errmsg);
368 Dmsg2(420, "get_volume_info() jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
369 /* Update dev Volume info in case something changed (e.g. expired) */
370 dev->VolCatInfo = dcr->VolCatInfo;
379 * After writing a Volume, create the JobMedia record.
381 bool dir_create_jobmedia_record(DCR *dcr)
384 BSOCK *dir = jcr->dir_bsock;
387 /* If system job, do not update catalog */
388 if (jcr->JobType == JT_SYSTEM) {
392 if (!dcr->WroteVol) {
393 return true; /* nothing written to tape */
396 dcr->WroteVol = false;
397 bnet_fsend(dir, Create_job_media, jcr->Job,
398 dcr->VolFirstIndex, dcr->VolLastIndex,
399 dcr->StartFile, dcr->EndFile,
400 dcr->StartBlock, dcr->EndBlock,
401 dcr->Copy, dcr->Stripe,
402 edit_uint64(dcr->VolMediaId, ed1));
403 Dmsg2(100, ">dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
404 if (bnet_recv(dir) <= 0) {
405 Dmsg0(190, "create_jobmedia error bnet_recv\n");
406 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: ERR=%s\n"),
410 Dmsg2(100, "<dird jid=%u: %s", (uint32_t)jcr->JobId, dir->msg);
411 if (strcmp(dir->msg, OK_create) != 0) {
412 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
413 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
421 * Update File Attribute data
423 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec)
426 BSOCK *dir = jcr->dir_bsock;
429 #ifdef NO_ATTRIBUTES_TEST
433 dir->msglen = sprintf(dir->msg, FileAttributes, jcr->Job);
434 dir->msg = check_pool_memory_size(dir->msg, dir->msglen +
435 sizeof(DEV_RECORD) + rec->data_len);
436 ser_begin(dir->msg + dir->msglen, 0);
437 ser_uint32(rec->VolSessionId);
438 ser_uint32(rec->VolSessionTime);
439 ser_int32(rec->FileIndex);
440 ser_int32(rec->Stream);
441 ser_uint32(rec->data_len);
442 ser_bytes(rec->data, rec->data_len);
443 dir->msglen = ser_length(dir->msg);
444 Dmsg2(1800, ">dird jid=%u: %s\n", (uint32_t)jcr->JobId, dir->msg); /* Attributes */
445 return bnet_send(dir);
450 * Request the sysop to create an appendable volume
452 * Entered with device blocked.
453 * Leaves with device blocked.
455 * Returns: true on success (operator issues a mount command)
457 * Note, must create dev->errmsg on error return.
459 * On success, dcr->VolumeName and dcr->VolCatInfo contain
460 * information on suggested volume, but this may not be the
461 * same as what is actually mounted.
463 * When we return with success, the correct tape may or may not
464 * actually be mounted. The calling routine must read it and
467 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr)
469 int stat = W_TIMEOUT;
470 DEVICE *dev = dcr->dev;
472 bool got_vol = false;
474 Dmsg0(400, "enter dir_ask_sysop_to_create_appendable_volume\n");
475 ASSERT(dev->blocked());
477 if (job_canceled(jcr)) {
479 _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
480 jcr->Job, dev->print_name());
481 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
485 got_vol = dir_find_next_appendable_volume(dcr); /* get suggested volume */
490 if (stat == W_TIMEOUT || stat == W_MOUNT) {
491 Jmsg(jcr, M_MOUNT, 0, _(
492 "Job %s waiting. Cannot find any appendable volumes.\n"
493 "Please use the \"label\" command to create a new Volume for:\n"
496 " Media type: %s\n"),
504 set_jcr_job_status(jcr, JS_WaitMedia);
505 dir_send_job_status(jcr);
507 stat = wait_for_sysop(dcr);
508 Dmsg1(100, "Back from wait_for_sysop stat=%d\n", stat);
510 Dmsg1(100, "Poll timeout in create append vol on device %s\n", dev->print_name());
514 if (stat == W_TIMEOUT) {
515 if (!double_dev_wait_time(dev)) {
516 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
517 dev->print_name(), jcr->Job);
518 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
519 Dmsg1(100, "Gave up waiting on device %s\n", dev->print_name());
520 return false; /* exceeded maximum waits */
524 if (stat == W_ERROR) {
526 Mmsg0(dev->errmsg, _("pthread error in mount_next_volume.\n"));
527 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
530 Dmsg1(100, "Someone woke me for device %s\n", dev->print_name());
532 set_jcr_job_status(jcr, JS_Running);
533 dir_send_job_status(jcr);
534 Dmsg0(100, "leave dir_ask_sysop_to_mount_create_appendable_volume\n");
539 * Request to mount specific Volume
541 * Entered with device blocked and dcr->VolumeName is desired
543 * Leaves with device blocked.
545 * Returns: true on success (operator issues a mount command)
547 * Note, must create dev->errmsg on error return.
550 bool dir_ask_sysop_to_mount_volume(DCR *dcr)
552 int stat = W_TIMEOUT;
553 DEVICE *dev = dcr->dev;
556 Dmsg0(400, "enter dir_ask_sysop_to_mount_volume\n");
557 if (!dcr->VolumeName[0]) {
558 Mmsg0(dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
561 ASSERT(dev->blocked());
563 if (job_canceled(jcr)) {
564 Mmsg(dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device %s.\n"),
565 jcr->Job, dev->print_name());
574 * If we are not polling, and the wait timeout or the
575 * user explicitly did a mount, send him the message.
578 if (!dev->poll && (stat == W_TIMEOUT || stat == W_MOUNT)) {
579 Jmsg(jcr, M_MOUNT, 0, _("Please mount Volume \"%s\" or label a new one for:\n"
583 " Media type: %s\n"),
589 Dmsg3(400, "Mount \"%s\" on device \"%s\" for Job %s\n",
590 dcr->VolumeName, dev->print_name(), jcr->Job);
593 set_jcr_job_status(jcr, JS_WaitMount);
594 dir_send_job_status(jcr);
596 stat = wait_for_sysop(dcr); /* wait on device */
597 Dmsg1(100, "Back from wait_for_sysop stat=%d\n", stat);
599 Dmsg1(400, "Poll timeout in mount vol on device %s\n", dev->print_name());
600 Dmsg1(400, "Blocked=%s\n", dev->print_blocked());
604 if (stat == W_TIMEOUT) {
605 if (!double_dev_wait_time(dev)) {
606 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
607 dev->print_name(), jcr->Job);
608 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
609 Dmsg1(400, "Gave up waiting on device %s\n", dev->print_name());
610 return false; /* exceeded maximum waits */
614 if (stat == W_ERROR) {
616 Mmsg(dev->errmsg, _("pthread error in mount_volume\n"));
617 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
620 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");