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;
256 Dmsg2(200, "dir_find_next_appendable_volume: reserved=%d Vol=%s\n",
257 dcr->reserved_device, dcr->VolumeName);
260 * Try the fourty oldest or most available volumes. Note,
261 * the most available could already be mounted on another
262 * drive, so we continue looking for a not in use Volume.
266 dcr->volume_in_use = false;
267 for (int vol_index=1; vol_index < 40; vol_index++) {
268 bash_spaces(dcr->media_type);
269 bash_spaces(dcr->pool_name);
270 dir->fsend(Find_media, jcr->Job, vol_index, dcr->pool_name, dcr->media_type);
271 unbash_spaces(dcr->media_type);
272 unbash_spaces(dcr->pool_name);
273 Dmsg1(100, ">dird %s", dir->msg);
274 bool ok = do_get_volume_info(dcr);
276 if (!is_volume_in_use(dcr)) {
277 Dmsg1(100, "Attempt reserve. 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());
284 unlock_reservations();
285 Dmsg1(100, "dir_find_next_appendable_volume return true. vol=%s\n",
289 Dmsg1(100, "Volume %s is in use.\n", dcr->VolumeName);
290 dcr->volume_in_use = true;
294 Dmsg2(100, "No vol. index %d return false. dev=%s\n", vol_index,
295 dcr->dev->print_name());
299 dcr->VolumeName[0] = 0;
301 unlock_reservations();
307 * After writing a Volume, send the updated statistics
308 * back to the director. The information comes from the
311 bool dir_update_volume_info(DCR *dcr, bool label, bool update_LastWritten)
314 BSOCK *dir = jcr->dir_bsock;
315 DEVICE *dev = dcr->dev;
316 VOLUME_CAT_INFO *vol = &dev->VolCatInfo;
317 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50], ed6[50];
322 /* If system job, do not update catalog */
323 if (jcr->JobType == JT_SYSTEM) {
327 if (vol->VolCatName[0] == 0) {
328 Jmsg0(jcr, M_FATAL, 0, _("NULL Volume name. This shouldn't happen!!!\n"));
329 Pmsg0(000, _("NULL Volume name. This shouldn't happen!!!\n"));
333 /* Lock during Volume update */
335 Dmsg1(100, "Update cat VolFiles=%d\n", dev->file);
336 /* Just labeled or relabeled the tape */
338 bstrncpy(vol->VolCatStatus, "Append", sizeof(vol->VolCatStatus));
340 // if (update_LastWritten) {
341 vol->VolLastWritten = time(NULL);
343 pm_strcpy(VolumeName, vol->VolCatName);
344 bash_spaces(VolumeName);
345 InChanger = vol->InChanger;
346 dir->fsend(Update_media, jcr->Job,
347 VolumeName.c_str(), vol->VolCatJobs, vol->VolCatFiles,
348 vol->VolCatBlocks, edit_uint64(vol->VolCatBytes, ed1),
349 vol->VolCatMounts, vol->VolCatErrors,
350 vol->VolCatWrites, edit_uint64(vol->VolCatMaxBytes, ed2),
351 edit_uint64(vol->VolLastWritten, ed6),
352 vol->VolCatStatus, vol->Slot, label,
353 InChanger, /* bool in structure */
354 edit_int64(vol->VolReadTime, ed3),
355 edit_int64(vol->VolWriteTime, ed4),
356 edit_uint64(vol->VolFirstWritten, ed5),
358 Dmsg1(100, ">dird %s", dir->msg);
360 /* Do not lock device here because it may be locked from label */
361 if (!do_get_volume_info(dcr)) {
362 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
363 Dmsg2(100, _("Didn't get vol info vol=%s: ERR=%s"),
364 vol->VolCatName, jcr->errmsg);
367 Dmsg1(420, "get_volume_info() %s", dir->msg);
368 /* Update dev Volume info in case something changed (e.g. expired) */
369 dev->VolCatInfo = dcr->VolCatInfo;
378 * After writing a Volume, create the JobMedia record.
380 bool dir_create_jobmedia_record(DCR *dcr)
383 BSOCK *dir = jcr->dir_bsock;
386 /* If system job, do not update catalog */
387 if (jcr->JobType == JT_SYSTEM) {
391 if (!dcr->WroteVol) {
392 return true; /* nothing written to tape */
395 dcr->WroteVol = false;
396 dir->fsend(Create_job_media, jcr->Job,
397 dcr->VolFirstIndex, dcr->VolLastIndex,
398 dcr->StartFile, dcr->EndFile,
399 dcr->StartBlock, dcr->EndBlock,
400 dcr->Copy, dcr->Stripe,
401 edit_uint64(dcr->VolMediaId, ed1));
402 Dmsg1(100, ">dird %s", dir->msg);
403 if (bnet_recv(dir) <= 0) {
404 Dmsg0(190, "create_jobmedia error bnet_recv\n");
405 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: ERR=%s\n"),
409 Dmsg1(100, "<dird %s", dir->msg);
410 if (strcmp(dir->msg, OK_create) != 0) {
411 Dmsg1(130, "Bad response from Dir: %s\n", dir->msg);
412 Jmsg(jcr, M_FATAL, 0, _("Error creating JobMedia record: %s\n"), dir->msg);
420 * Update File Attribute data
422 bool dir_update_file_attributes(DCR *dcr, DEV_RECORD *rec)
425 BSOCK *dir = jcr->dir_bsock;
428 #ifdef NO_ATTRIBUTES_TEST
432 dir->msg = check_pool_memory_size(dir->msg, sizeof(FileAttributes) +
433 MAX_NAME_LENGTH + sizeof(DEV_RECORD) + rec->data_len + 1);
434 dir->msglen = bsnprintf(dir->msg, sizeof(FileAttributes) +
435 MAX_NAME_LENGTH + 1, FileAttributes, jcr->Job);
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 Dmsg1(1800, ">dird %s\n", dir->msg); /* Attributes */
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, int mode)
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)) {
580 if (mode == ST_APPEND) {
581 msg = _("Please mount Volume \"%s\" or label a new one for:\n"
585 " Media type: %s\n");
587 msg = _("Please mount Volume \"%s\" for:\n"
591 " Media type: %s\n");
593 Jmsg(jcr, M_MOUNT, 0, msg,
599 Dmsg3(400, "Mount \"%s\" on device \"%s\" for Job %s\n",
600 dcr->VolumeName, dev->print_name(), jcr->Job);
603 set_jcr_job_status(jcr, JS_WaitMount);
604 dir_send_job_status(jcr);
606 stat = wait_for_sysop(dcr); /* wait on device */
607 Dmsg1(100, "Back from wait_for_sysop stat=%d\n", stat);
609 Dmsg1(400, "Poll timeout in mount vol on device %s\n", dev->print_name());
610 Dmsg1(400, "Blocked=%s\n", dev->print_blocked());
614 if (stat == W_TIMEOUT) {
615 if (!double_dev_wait_time(dev)) {
616 Mmsg(dev->errmsg, _("Max time exceeded waiting to mount Storage Device %s for Job %s\n"),
617 dev->print_name(), jcr->Job);
618 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
619 Dmsg1(400, "Gave up waiting on device %s\n", dev->print_name());
620 return false; /* exceeded maximum waits */
624 if (stat == W_ERROR) {
626 Mmsg(dev->errmsg, _("pthread error in mount_volume\n"));
627 Jmsg(jcr, M_FATAL, 0, "%s", dev->errmsg);
630 Dmsg1(400, "Someone woke me for device %s\n", dev->print_name());
635 set_jcr_job_status(jcr, JS_Running);
636 dir_send_job_status(jcr);
637 Dmsg0(400, "leave dir_ask_sysop_to_mount_volume\n");