2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-2010 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 Kern Sibbald.
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.
30 * Bacula Director -- catreq.c -- handles the message channel
31 * catalog request from the Storage daemon.
33 * Kern Sibbald, March MMI
35 * This routine runs as a thread and must be thread reentrant.
37 * Basic tasks done here:
38 * Handle Catalog services.
44 #include "findlib/find.h"
47 * Handle catalog request
48 * For now, we simply return next Volume to be used
51 /* Requests from the Storage daemon */
52 static char Find_media[] = "CatReq Job=%127s FindMedia=%d pool_name=%127s media_type=%127s\n";
53 static char Get_Vol_Info[] = "CatReq Job=%127s GetVolInfo VolName=%127s write=%d\n";
55 static char Update_media[] = "CatReq Job=%127s UpdateMedia VolName=%s"
56 " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%lld VolMounts=%u"
57 " VolErrors=%u VolWrites=%u MaxVolBytes=%lld EndTime=%lld VolStatus=%10s"
58 " Slot=%d relabel=%d InChanger=%d VolReadTime=%lld VolWriteTime=%lld"
59 " VolFirstWritten=%lld VolParts=%u\n";
61 static char Create_job_media[] = "CatReq Job=%127s CreateJobMedia "
62 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u "
63 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d MediaId=%" lld "\n";
66 /* Responses sent to Storage daemon */
67 static char OK_media[] = "1000 OK VolName=%s VolJobs=%u VolFiles=%u"
68 " VolBlocks=%u VolBytes=%s VolMounts=%u VolErrors=%u VolWrites=%u"
69 " MaxVolBytes=%s VolCapacityBytes=%s VolStatus=%s Slot=%d"
70 " MaxVolJobs=%u MaxVolFiles=%u InChanger=%d VolReadTime=%s"
71 " VolWriteTime=%s EndFile=%u EndBlock=%u VolParts=%u LabelType=%d"
74 static char OK_create[] = "1000 OK CreateJobMedia\n";
77 static int send_volume_info_to_storage_daemon(JCR *jcr, BSOCK *sd, MEDIA_DBR *mr)
80 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50], ed6[50];
82 jcr->MediaId = mr->MediaId;
83 pm_strcpy(jcr->VolumeName, mr->VolumeName);
84 bash_spaces(mr->VolumeName);
85 stat = sd->fsend(OK_media, mr->VolumeName, mr->VolJobs,
86 mr->VolFiles, mr->VolBlocks, edit_uint64(mr->VolBytes, ed1),
87 mr->VolMounts, mr->VolErrors, mr->VolWrites,
88 edit_uint64(mr->MaxVolBytes, ed2),
89 edit_uint64(mr->VolCapacityBytes, ed3),
90 mr->VolStatus, mr->Slot, mr->MaxVolJobs, mr->MaxVolFiles,
92 edit_int64(mr->VolReadTime, ed4),
93 edit_int64(mr->VolWriteTime, ed5),
94 mr->EndFile, mr->EndBlock,
97 edit_uint64(mr->MediaId, ed6));
98 unbash_spaces(mr->VolumeName);
99 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, sd->msg);
103 void catalog_request(JCR *jcr, BSOCK *bs)
107 char Job[MAX_NAME_LENGTH];
108 char pool_name[MAX_NAME_LENGTH];
109 int index, ok, label, writing;
112 uint32_t Stripe, Copy;
114 utime_t VolFirstWritten;
115 utime_t VolLastWritten;
117 memset(&mr, 0, sizeof(mr));
118 memset(&sdmr, 0, sizeof(sdmr));
119 memset(&jm, 0, sizeof(jm));
123 * Request to find next appendable Volume for this Job
125 Dmsg1(100, "catreq %s", bs->msg);
127 omsg = get_memory(bs->msglen+1);
128 pm_strcpy(omsg, bs->msg);
129 bs->fsend(_("1990 Invalid Catalog Request: %s"), omsg);
130 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request; DB not open: %s"), omsg);
135 * Find next appendable medium for SD
137 if (sscanf(bs->msg, Find_media, &Job, &index, &pool_name, &mr.MediaType) == 4) {
138 memset(&pr, 0, sizeof(pr));
139 bstrncpy(pr.Name, pool_name, sizeof(pr.Name));
140 unbash_spaces(pr.Name);
141 ok = db_get_pool_record(jcr, jcr->db, &pr);
143 mr.PoolId = pr.PoolId;
144 mr.StorageId = jcr->wstore->StorageId;
145 mr.ScratchPoolId = pr.ScratchPoolId;
146 ok = find_next_volume_for_append(jcr, &mr, index, fnv_create_vol, fnv_prune);
147 Dmsg3(050, "find_media ok=%d idx=%d vol=%s\n", ok, index, mr.VolumeName);
150 * Send Find Media response to Storage daemon
153 send_volume_info_to_storage_daemon(jcr, bs, &mr);
155 bs->fsend(_("1901 No Media.\n"));
156 Dmsg0(500, "1901 No Media.\n");
160 * Request to find specific Volume information
162 } else if (sscanf(bs->msg, Get_Vol_Info, &Job, &mr.VolumeName, &writing) == 3) {
163 Dmsg1(100, "CatReq GetVolInfo Vol=%s\n", mr.VolumeName);
167 unbash_spaces(mr.VolumeName);
168 if (db_get_media_record(jcr, jcr->db, &mr)) {
169 const char *reason = NULL; /* detailed reason for rejection */
171 * If we are reading, accept any volume (reason == NULL)
172 * If we are writing, check if the Volume is valid
173 * for this job, and do a recycle if necessary
177 * SD wants to write this Volume, so make
178 * sure it is suitable for this job, i.e.
179 * Pool matches, and it is either Append or Recycle
180 * and Media Type matches and Pool allows any volume.
182 if (mr.PoolId != jcr->jr.PoolId) {
183 reason = _("not in Pool");
184 } else if (strcmp(mr.MediaType, jcr->wstore->media_type) != 0) {
185 reason = _("not correct MediaType");
188 * Now try recycling if necessary
189 * reason set non-NULL if we cannot use it
191 check_if_volume_valid_or_recyclable(jcr, &mr, &reason);
194 if (!reason && mr.Enabled != 1) {
195 reason = _("is not Enabled");
197 if (reason == NULL) {
199 * Send Find Media response to Storage daemon
201 send_volume_info_to_storage_daemon(jcr, bs, &mr);
203 /* Not suitable volume */
204 bs->fsend(_("1998 Volume \"%s\" status is %s, %s.\n"), mr.VolumeName,
205 mr.VolStatus, reason);
209 bs->fsend(_("1997 Volume \"%s\" not in catalog.\n"), mr.VolumeName);
210 Dmsg1(100, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
214 * Request to update Media record. Comes typically at the end
215 * of a Storage daemon Job Session, when labeling/relabeling a
216 * Volume, or when an EOF mark is written.
218 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName,
219 &sdmr.VolJobs, &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes,
220 &sdmr.VolMounts, &sdmr.VolErrors, &sdmr.VolWrites, &sdmr.MaxVolBytes,
221 &VolLastWritten, &sdmr.VolStatus, &sdmr.Slot, &label, &sdmr.InChanger,
222 &sdmr.VolReadTime, &sdmr.VolWriteTime, &VolFirstWritten,
223 &sdmr.VolParts) == 19) {
226 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
227 mr.VolStatus, sdmr.VolStatus);
228 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
229 unbash_spaces(mr.VolumeName);
230 if (!db_get_media_record(jcr, jcr->db, &mr)) {
231 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
232 mr.VolumeName, db_strerror(jcr->db));
233 bs->fsend(_("1991 Catalog Request for vol=%s failed: %s"),
234 mr.VolumeName, db_strerror(jcr->db));
238 /* Set first written time if this is first job */
239 if (mr.FirstWritten == 0) {
240 if (VolFirstWritten == 0) {
241 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
243 mr.FirstWritten = VolFirstWritten;
245 mr.set_first_written = true;
247 /* If we just labeled the tape set time */
248 if (label || mr.LabelDate == 0) {
249 mr.LabelDate = jcr->start_time;
250 mr.set_label_date = true;
251 if (mr.InitialWrite == 0) {
252 mr.InitialWrite = jcr->start_time;
254 Dmsg2(400, "label=%d labeldate=%d\n", label, mr.LabelDate);
257 * Insanity check for VolFiles get set to a smaller value
259 if (sdmr.VolFiles < mr.VolFiles) {
260 Jmsg(jcr, M_FATAL, 0, _("Volume Files at %u being set to %u"
261 " for Volume \"%s\". This is incorrect.\n"),
262 mr.VolFiles, sdmr.VolFiles, mr.VolumeName);
263 bs->fsend(_("1992 Update Media error. VolFiles=%u, CatFiles=%u\n"),
264 sdmr.VolFiles, mr.VolFiles);
269 Dmsg2(400, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
272 * Check if the volume has been written by the job,
273 * and update the LastWritten field if needed.
275 if (mr.VolBlocks != sdmr.VolBlocks && VolLastWritten != 0) {
276 mr.LastWritten = VolLastWritten;
280 * Update to point to the last device used to write the Volume.
281 * However, do so only if we are writing the tape, i.e.
282 * the number of VolWrites has increased.
284 if (jcr->wstore && jcr->wstore->StorageId && sdmr.VolWrites > mr.VolWrites) {
285 Dmsg2(050, "Update StorageId old=%d new=%d\n",
286 mr.StorageId, jcr->wstore->StorageId);
287 if (jcr->wstore->StorageId == 0) {
288 Jmsg(jcr, M_ERROR, 0, _("Attempt to set StorageId to zero.\n"));
290 mr.StorageId = jcr->wstore->StorageId;
294 /* Copy updated values to original media record */
295 mr.VolJobs = sdmr.VolJobs;
296 mr.VolFiles = sdmr.VolFiles;
297 mr.VolBlocks = sdmr.VolBlocks;
298 mr.VolBytes = sdmr.VolBytes;
299 mr.VolMounts = sdmr.VolMounts;
300 mr.VolErrors = sdmr.VolErrors;
301 mr.VolWrites = sdmr.VolWrites;
303 mr.InChanger = sdmr.InChanger;
304 mr.VolParts = sdmr.VolParts;
305 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
306 if (sdmr.VolReadTime >= 0) {
307 mr.VolReadTime = sdmr.VolReadTime;
309 if (sdmr.VolWriteTime >= 0) {
310 mr.VolWriteTime = sdmr.VolWriteTime;
313 Dmsg2(400, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
315 * Update the database, then before sending the response to the
316 * SD, check if the Volume has expired.
318 if (!db_update_media_record(jcr, jcr->db, &mr)) {
319 Jmsg(jcr, M_FATAL, 0, _("Catalog error updating Media record. %s"),
320 db_strerror(jcr->db));
321 bs->fsend(_("1993 Update Media error\n"));
322 Dmsg0(400, "send error\n");
324 (void)has_volume_expired(jcr, &mr);
325 send_volume_info_to_storage_daemon(jcr, bs, &mr);
330 * Request to create a JobMedia record
332 } else if (sscanf(bs->msg, Create_job_media, &Job,
333 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
334 &jm.StartBlock, &jm.EndBlock, &Copy, &Stripe, &MediaId) == 10) {
337 jm.JobId = jcr->mig_jcr->JobId;
339 jm.JobId = jcr->JobId;
341 jm.MediaId = MediaId;
342 Dmsg6(400, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
343 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
344 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
345 Jmsg(jcr, M_FATAL, 0, _("Catalog error creating JobMedia record. %s"),
346 db_strerror(jcr->db));
347 bs->fsend(_("1992 Create JobMedia error\n"));
349 Dmsg0(400, "JobMedia record created\n");
350 bs->fsend(OK_create);
354 omsg = get_memory(bs->msglen+1);
355 pm_strcpy(omsg, bs->msg);
356 bs->fsend(_("1990 Invalid Catalog Request: %s"), omsg);
357 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request: %s"), omsg);
360 Dmsg1(400, ">CatReq response: %s", bs->msg);
361 Dmsg1(400, "Leave catreq jcr 0x%x\n", jcr);
366 * Note, we receive the whole attribute record, but we select out only the stat
367 * packet, VolSessionId, VolSessionTime, FileIndex, file type, and file name to
368 * store in the catalog.
370 static void update_attribute(JCR *jcr, char *msg, int32_t msglen)
373 uint32_t VolSessionId, VolSessionTime;
382 /* Start transaction allocates jcr->attr and jcr->ar if needed */
383 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
386 /* Start by scanning directly in the message buffer to get Stream
387 * there may be a cached attr so we cannot yet write into
388 * jcr->attr or jcr->ar
391 skip_nonspaces(&p); /* UpdCat */
393 skip_nonspaces(&p); /* Job=nnn */
395 skip_nonspaces(&p); /* FileAttributes */
398 unser_uint32(VolSessionId);
399 unser_uint32(VolSessionTime);
400 unser_int32(FileIndex);
402 unser_uint32(data_len);
403 p += unser_length(p);
405 Dmsg1(400, "UpdCat msg=%s\n", msg);
406 Dmsg5(400, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
407 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
409 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
410 if (jcr->cached_attribute) {
411 Dmsg2(400, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname);
412 if (!db_create_attributes_record(jcr, jcr->db, ar)) {
413 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
416 /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
417 jcr->attr = check_pool_memory_size(jcr->attr, msglen);
418 memcpy(jcr->attr, msg, msglen);
419 p = jcr->attr - msg + p; /* point p into jcr->attr */
420 skip_nonspaces(&p); /* skip FileIndex */
422 ar->FileType = str_to_int32(p); /* TODO: choose between unserialize and str_to_int32 */
423 skip_nonspaces(&p); /* skip FileType */
426 len = strlen(fname); /* length before attributes */
427 attr = &fname[len+1];
429 Dmsg2(400, "dird<stored: stream=%d %s\n", Stream, fname);
430 Dmsg1(400, "dird<stored: attr=%s\n", attr);
433 if (ar->FileType == FT_DELETED) {
434 ar->FileIndex = 0; /* special value */
436 ar->FileIndex = FileIndex;
441 ar->JobId = jcr->mig_jcr->JobId;
443 ar->JobId = jcr->JobId;
446 ar->DigestType = CRYPTO_DIGEST_NONE;
447 jcr->cached_attribute = true;
449 Dmsg2(400, "dird<filed: stream=%d %s\n", Stream, fname);
450 Dmsg1(400, "dird<filed: attr=%s\n", attr);
452 } else if (crypto_digest_stream_type(Stream) != CRYPTO_DIGEST_NONE) {
454 if (ar->FileIndex != FileIndex) {
455 Jmsg(jcr, M_WARNING, 0, _("Got %s but not same File as attributes\n"), stream_to_ascii(Stream));
457 /* Update digest in catalog */
458 char digestbuf[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
460 int type = CRYPTO_DIGEST_NONE;
463 case STREAM_MD5_DIGEST:
464 len = CRYPTO_DIGEST_MD5_SIZE;
465 type = CRYPTO_DIGEST_MD5;
467 case STREAM_SHA1_DIGEST:
468 len = CRYPTO_DIGEST_SHA1_SIZE;
469 type = CRYPTO_DIGEST_SHA1;
471 case STREAM_SHA256_DIGEST:
472 len = CRYPTO_DIGEST_SHA256_SIZE;
473 type = CRYPTO_DIGEST_SHA256;
475 case STREAM_SHA512_DIGEST:
476 len = CRYPTO_DIGEST_SHA512_SIZE;
477 type = CRYPTO_DIGEST_SHA512;
480 /* Never reached ... */
481 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating file digest. Unsupported digest stream type: %d"),
485 bin_to_base64(digestbuf, sizeof(digestbuf), fname, len, true);
486 Dmsg3(400, "DigestLen=%d Digest=%s type=%d\n", strlen(digestbuf),
488 if (jcr->cached_attribute) {
489 ar->Digest = digestbuf;
490 ar->DigestType = type;
491 Dmsg2(400, "Cached attr with digest. Stream=%d fname=%s\n",
492 ar->Stream, ar->fname);
494 /* Update BaseFile table */
495 if (!db_create_attributes_record(jcr, jcr->db, ar)) {
496 Jmsg1(jcr, M_FATAL, 0, _("attribute create error. %s"),
497 db_strerror(jcr->db));
499 jcr->cached_attribute = false;
501 if (!db_add_digest_to_file_record(jcr, jcr->db, ar->FileId, digestbuf, type)) {
502 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating file digest. %s"),
503 db_strerror(jcr->db));
511 * Update File Attributes in the catalog with data
512 * sent by the Storage daemon.
514 void catalog_update(JCR *jcr, BSOCK *bs)
516 if (!jcr->pool->catalog_files) {
517 return; /* user disabled cataloging */
519 if (job_canceled(jcr)) {
523 POOLMEM *omsg = get_memory(bs->msglen+1);
524 pm_strcpy(omsg, bs->msg);
525 bs->fsend(_("1994 Invalid Catalog Update: %s"), omsg);
526 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog Update; DB not open: %s"), omsg);
530 update_attribute(jcr, bs->msg, bs->msglen);
533 if (job_canceled(jcr)) {
534 cancel_storage_daemon_job(jcr);
539 * Update File Attributes in the catalog with data read from
540 * the storage daemon spool file. We receive the filename and
543 bool despool_attributes_from_file(JCR *jcr, const char *file)
548 ssize_t last = 0, size = 0;
550 int32_t msglen; /* message length */
551 POOLMEM *msg = get_pool_memory(PM_MESSAGE);
554 Dmsg0(100, "Begin despool_attributes_from_file\n");
556 if (job_canceled(jcr) || !jcr->pool->catalog_files || !jcr->db) {
557 goto bail_out; /* user disabled cataloging */
560 spool_fd = fopen(file, "rb");
562 Dmsg0(100, "cancel despool_attributes_from_file\n");
563 /* send an error message */
566 #if defined(HAVE_POSIX_FADVISE) && defined(POSIX_FADV_WILLNEED)
567 posix_fadvise(fileno(spool_fd), 0, 0, POSIX_FADV_WILLNEED);
570 while (fread((char *)&pktsiz, 1, sizeof(int32_t), spool_fd) ==
572 size += sizeof(int32_t);
573 msglen = ntohl(pktsiz);
575 if (msglen > (int32_t) sizeof_pool_memory(msg)) {
576 msg = realloc_pool_memory(msg, msglen + 1);
578 nbytes = fread(msg, 1, msglen, spool_fd);
579 if (nbytes != (size_t) msglen) {
581 Dmsg2(400, "nbytes=%d msglen=%d\n", nbytes, msglen);
582 Qmsg1(jcr, M_FATAL, 0, _("fread attr spool error. ERR=%s\n"),
587 if ((++count & 0x3F) == 0) {
591 if (!job_canceled(jcr)) {
592 update_attribute(jcr, msg, msglen);
593 if (job_canceled(jcr)) {
598 if (ferror(spool_fd)) {
600 Qmsg1(jcr, M_FATAL, 0, _("fread attr spool error. ERR=%s\n"),
611 if (job_canceled(jcr)) {
612 cancel_storage_daemon_job(jcr);
615 free_pool_memory(msg);
616 Dmsg1(100, "End despool_attributes_from_file ret=%i\n", ret);