2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 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=%s 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 = dir->fsend(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 = dir->fsend(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 jcr->dir_bsock->fsend(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 Dmsg1(100, "<dird %s", 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 Dmsg3(100, "Bad response from Dir fields=%d, len=%d: %s",
195 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 Dmsg2(100, "do_reqest_vol_info return true slot=%d Volume=%s\n",
205 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 Dmsg1(100, ">dird %s", 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 Dmsg2(200, "dir_find_next_appendable_volume: reserved=%d Vol=%s\n",
258 dcr->reserved_device, dcr->VolumeName);
261 * Try the fourty oldest or most available volumes. Note,
262 * the most available could already be mounted on another
263 * drive, so we continue looking for a not in use Volume.
267 dcr->volume_in_use = false;
268 for (int vol_index=1; vol_index < 40; vol_index++) {
269 bash_spaces(dcr->media_type);
270 bash_spaces(dcr->pool_name);
271 dir->fsend(Find_media, jcr->Job, vol_index, dcr->pool_name, dcr->media_type);
272 unbash_spaces(dcr->media_type);
273 unbash_spaces(dcr->pool_name);
274 Dmsg1(100, ">dird %s", dir->msg);
275 if (do_get_volume_info(dcr)) {
276 if (!is_volume_in_use(dcr)) {
277 Dmsg1(100, "Call reserve_volume. Vol=%s\n", dcr->VolumeName);
278 if (reserve_volume(dcr, dcr->VolumeName) == 0) {
279 Dmsg2(100, "Could not reserve volume %s on %s\n", dcr->VolumeName,
280 dcr->dev->print_name());
283 Dmsg1(100, "dir_find_next_appendable_volume return true. vol=%s\n",
288 Dmsg1(100, "Volume %s is in use.\n", dcr->VolumeName);
289 dcr->volume_in_use = true;
293 Dmsg2(100, "No vol. index %d return false. dev=%s\n", vol_index,
294 dcr->dev->print_name());
298 dcr->VolumeName[0] = 0;
308 * After writing a Volume, send the updated statistics
309 * back to the director. The information comes from the
312 bool dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten)
315 BSOCK *dir = jcr->dir_bsock;
316 DEVICE *dev = dcr->dev;
317 VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
318 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50], ed6[50];
323 /* If system job, do not update catalog */
324 if (jcr->JobType == JT_SYSTEM) {
328 if (vol->VolCatName[0] == 0) {
329 Jmsg0(jcr, M_FATAL, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
330 Pmsg0(000, _("NULL Volume name. This shouldn't happen!!!\n"));
334 /* Lock during Volume update */
336 Dmsg1(100, "Update cat VolFiles=%d\n", dev->file);
337 /* Just labeled or relabeled the tape */
339 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
341 // if (update_LastWritten) {
342 vol->VolLastWritten = time(NULL);
344 pm_strcpy(VolumeName, vol->VolCatName);
345 bash_spaces(VolumeName);
346 InChanger = vol->InChanger;
347 dir->fsend(Update_media, jcr->Job,
348 VolumeName.c_str(), vol->VolCatJobs, vol->VolCatFiles,
349 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
350 vol->VolCatMounts, vol->VolCatErrors,
351 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
352 edit_uint64(vol->VolLastWritten, ed6),
353 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 Dmsg1(100, ">dird %s", 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 Dmsg1(420, "get_volume_info() %s", 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 dir->fsend(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 Dmsg1(100, ">dird %s", 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 Dmsg1(100, "<dird %s", 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->msg = check_pool_memory_size(dir->msg, sizeof(FileAttributes) +
434 MAX_NAME_LENGTH + sizeof(DEV_RECORD) + rec->data_len + 1);
435 dir->msglen = bsnprintf(dir->msg, sizeof(FileAttributes) +
436 MAX_NAME_LENGTH + 1, FileAttributes, jcr->Job);
437 ser_begin(dir->msg + dir->msglen, 0);
438 ser_uint32(rec->VolSessionId);
439 ser_uint32(rec->VolSessionTime);
440 ser_int32(rec->FileIndex);
441 ser_int32(rec->Stream);
442 ser_uint32(rec->data_len);
443 ser_bytes(rec->data, rec->data_len);
444 dir->msglen = ser_length(dir->msg);
445 Dmsg1(1800, ">dird %s\n", dir->msg); /* Attributes */
451 * Request the sysop to create an appendable volume
453 * Entered with device blocked.
454 * Leaves with device blocked.
456 * Returns: true on success (operator issues a mount command)
458 * Note, must create dev->errmsg on error return.
460 * On success, dcr->VolumeName and dcr->VolCatInfo contain
461 * information on suggested volume, but this may not be the
462 * same as what is actually mounted.
464 * When we return with success, the correct tape may or may not
465 * actually be mounted. The calling routine must read it and
468 bool dir_ask_sysop_to_create_appendable_volume(DCR *dcr)
470 int stat = W_TIMEOUT;
471 DEVICE *dev = dcr->dev;
473 bool got_vol = false;
475 Dmsg0(400, "enter dir_ask_sysop_to_create_appendable_volume\n");
476 ASSERT(dev->blocked());
478 if (job_canceled(jcr)) {
480 _("Job %s canceled while waiting for mount on Storage Device \"%s\".\n"),
481 jcr->Job, dev->print_name());
482 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
486 got_vol = dir_find_next_appendable_volume(dcr); /* get suggested volume */
491 if (stat == W_TIMEOUT || stat == W_MOUNT) {
492 Jmsg(jcr, M_MOUNT, 0, _(
493 "Job %s waiting. Cannot find any appendable volumes.\n"
494 "Please use the \"label\" command to create a new Volume for:\n"
497 " Media type: %s\n"),
505 set_jcr_job_status(jcr, JS_WaitMedia);
506 dir_send_job_status(jcr);
508 stat = wait_for_sysop(dcr);
509 Dmsg1(100, "Back from wait_for_sysop stat=%d\n", stat);
511 Dmsg1(100, "Poll timeout in create append vol on device %s\n", dev->print_name());
515 if (stat == W_TIMEOUT) {
516 if (!double_dev_wait_time(dev)) {
517 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
518 dev->print_name(), jcr->Job);
519 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
520 Dmsg1(100, "Gave up waiting on device %s\n", dev->print_name());
521 return false; /* exceeded maximum waits */
525 if (stat == W_ERROR) {
527 Mmsg0(dev->errmsg, _("pthread error in mount_next_volume.\n"));
528 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
531 Dmsg1(100, "Someone woke me for device %s\n", dev->print_name());
533 set_jcr_job_status(jcr, JS_Running);
534 dir_send_job_status(jcr);
535 Dmsg0(100, "leave dir_ask_sysop_to_mount_create_appendable_volume\n");
540 * Request to mount specific Volume
542 * Entered with device blocked and dcr->VolumeName is desired
544 * Leaves with device blocked.
546 * Returns: true on success (operator issues a mount command)
548 * Note, must create dev->errmsg on error return.
551 bool dir_ask_sysop_to_mount_volume(DCR *dcr, int mode)
553 int stat = W_TIMEOUT;
554 DEVICE *dev = dcr->dev;
557 Dmsg0(400, "enter dir_ask_sysop_to_mount_volume\n");
558 if (!dcr->VolumeName[0]) {
559 Mmsg0(dev->errmsg, _("Cannot request another volume: no volume name given.\n"));
562 ASSERT(dev->blocked());
564 if (job_canceled(jcr)) {
565 Mmsg(dev->errmsg, _("Job %s canceled while waiting for mount on Storage Device %s.\n"),
566 jcr->Job, dev->print_name());
575 * If we are not polling, and the wait timeout or the
576 * user explicitly did a mount, send him the message.
579 if (!dev->poll && (stat == W_TIMEOUT || stat == W_MOUNT)) {
581 if (mode == ST_APPEND) {
582 msg = _("Please mount Volume \"%s\" or label a new one for:\n"
586 " Media type: %s\n");
588 msg = _("Please mount Volume \"%s\" for:\n"
592 " Media type: %s\n");
594 Jmsg(jcr, M_MOUNT, 0, msg,
600 Dmsg3(400, "Mount \"%s\" on device \"%s\" for Job %s\n",
601 dcr->VolumeName, dev->print_name(), jcr->Job);
604 set_jcr_job_status(jcr, JS_WaitMount);
605 dir_send_job_status(jcr);
607 stat = wait_for_sysop(dcr); /* wait on device */
608 Dmsg1(100, "Back from wait_for_sysop stat=%d\n", stat);
610 Dmsg1(400, "Poll timeout in mount vol on device %s\n", dev->print_name());
611 Dmsg1(400, "Blocked=%s\n", dev->print_blocked());
615 if (stat == W_TIMEOUT) {
616 if (!double_dev_wait_time(dev)) {
617 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
618 dev->print_name(), jcr->Job);
619 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
620 Dmsg1(400, "Gave up waiting on device %s\n", dev->print_name());
621 return false; /* exceeded maximum waits */
625 if (stat == W_ERROR) {
627 Mmsg(dev->errmsg, _("pthread error in mount_volume\n"));
628 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
631 Dmsg1(400, "Someone woke me for device %s\n", dev->print_name());
636 set_jcr_job_status(jcr, JS_Running);
637 dir_send_job_status(jcr);
638 Dmsg0(400, "leave dir_ask_sysop_to_mount_volume\n");