2 Bacula® - The Network Backup Solution
4 Copyright (C) 2001-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.
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.
45 #include "findlib/find.h"
48 * Handle catalog request
49 * For now, we simply return next Volume to be used
52 /* Requests from the Storage daemon */
53 static char Find_media[] = "CatReq Job=%127s FindMedia=%d pool_name=%127s media_type=%127s\n";
54 static char Get_Vol_Info[] = "CatReq Job=%127s GetVolInfo VolName=%127s write=%d\n";
56 static char Update_media[] = "CatReq Job=%127s UpdateMedia VolName=%s"
57 " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%" lld " VolMounts=%u"
58 " VolErrors=%u VolWrites=%u MaxVolBytes=%" lld " EndTime=%d VolStatus=%10s"
59 " Slot=%d relabel=%d InChanger=%d VolReadTime=%" lld " VolWriteTime=%" lld
60 " VolFirstWritten=%" lld " VolParts=%u\n";
62 static char Create_job_media[] = "CatReq Job=%127s CreateJobMedia "
63 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u "
64 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d MediaId=%" lld "\n";
67 /* Responses sent to Storage daemon */
68 static char OK_media[] = "1000 OK VolName=%s VolJobs=%u VolFiles=%u"
69 " VolBlocks=%u VolBytes=%s VolMounts=%u VolErrors=%u VolWrites=%u"
70 " MaxVolBytes=%s VolCapacityBytes=%s VolStatus=%s Slot=%d"
71 " MaxVolJobs=%u MaxVolFiles=%u InChanger=%d VolReadTime=%s"
72 " VolWriteTime=%s EndFile=%u EndBlock=%u VolParts=%u LabelType=%d"
75 static char OK_create[] = "1000 OK CreateJobMedia\n";
78 static int send_volume_info_to_storage_daemon(JCR *jcr, BSOCK *sd, MEDIA_DBR *mr)
81 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50], ed6[50];
83 jcr->MediaId = mr->MediaId;
84 pm_strcpy(jcr->VolumeName, mr->VolumeName);
85 bash_spaces(mr->VolumeName);
86 stat = bnet_fsend(sd, OK_media, mr->VolumeName, mr->VolJobs,
87 mr->VolFiles, mr->VolBlocks, edit_uint64(mr->VolBytes, ed1),
88 mr->VolMounts, mr->VolErrors, mr->VolWrites,
89 edit_uint64(mr->MaxVolBytes, ed2),
90 edit_uint64(mr->VolCapacityBytes, ed3),
91 mr->VolStatus, mr->Slot, mr->MaxVolJobs, mr->MaxVolFiles,
93 edit_int64(mr->VolReadTime, ed4),
94 edit_int64(mr->VolWriteTime, ed5),
95 mr->EndFile, mr->EndBlock,
98 edit_uint64(mr->MediaId, ed6));
99 unbash_spaces(mr->VolumeName);
100 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, sd->msg);
104 void catalog_request(JCR *jcr, BSOCK *bs)
108 char Job[MAX_NAME_LENGTH];
109 char pool_name[MAX_NAME_LENGTH];
110 int index, ok, label, writing;
115 utime_t VolFirstWritten;
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 ok = find_next_volume_for_append(jcr, &mr, index, fnv_create_vol, fnv_prune);
146 Dmsg3(050, "find_media ok=%d idx=%d vol=%s\n", ok, index, mr.VolumeName);
149 * Send Find Media response to Storage daemon
152 send_volume_info_to_storage_daemon(jcr, bs, &mr);
154 bs->fsend(_("1901 No Media.\n"));
155 Dmsg0(500, "1901 No Media.\n");
159 * Request to find specific Volume information
161 } else if (sscanf(bs->msg, Get_Vol_Info, &Job, &mr.VolumeName, &writing) == 3) {
162 Dmsg1(100, "CatReq GetVolInfo Vol=%s\n", mr.VolumeName);
166 unbash_spaces(mr.VolumeName);
167 if (db_get_media_record(jcr, jcr->db, &mr)) {
168 const char *reason = NULL; /* detailed reason for rejection */
170 * If we are reading, accept any volume (reason == NULL)
171 * If we are writing, check if the Volume is valid
172 * for this job, and do a recycle if necessary
176 * SD wants to write this Volume, so make
177 * sure it is suitable for this job, i.e.
178 * Pool matches, and it is either Append or Recycle
179 * and Media Type matches and Pool allows any volume.
181 if (mr.PoolId != jcr->jr.PoolId) {
182 reason = _("not in Pool");
183 } else if (strcmp(mr.MediaType, jcr->wstore->media_type) != 0) {
184 reason = _("not correct MediaType");
187 * Now try recycling if necessary
188 * reason set non-NULL if we cannot use it
190 check_if_volume_valid_or_recyclable(jcr, &mr, &reason);
193 if (!reason && mr.Enabled != 1) {
194 reason = _("is not Enabled");
196 if (reason == NULL) {
198 * Send Find Media response to Storage daemon
200 send_volume_info_to_storage_daemon(jcr, bs, &mr);
202 /* Not suitable volume */
203 bs->fsend(_("1998 Volume \"%s\" status is %s, %s.\n"), mr.VolumeName,
204 mr.VolStatus, reason);
208 bs->fsend(_("1997 Volume \"%s\" not in catalog.\n"), mr.VolumeName);
209 Dmsg1(100, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
213 * Request to update Media record. Comes typically at the end
214 * of a Storage daemon Job Session, when labeling/relabeling a
215 * Volume, or when an EOF mark is written.
217 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName,
218 &sdmr.VolJobs, &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes,
219 &sdmr.VolMounts, &sdmr.VolErrors, &sdmr.VolWrites, &sdmr.MaxVolBytes,
220 &sdmr.LastWritten, &sdmr.VolStatus, &sdmr.Slot, &label, &sdmr.InChanger,
221 &sdmr.VolReadTime, &sdmr.VolWriteTime, &VolFirstWritten,
222 &sdmr.VolParts) == 19) {
225 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
226 mr.VolStatus, sdmr.VolStatus);
227 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
228 unbash_spaces(mr.VolumeName);
229 if (!db_get_media_record(jcr, jcr->db, &mr)) {
230 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
231 mr.VolumeName, db_strerror(jcr->db));
232 bs->fsend(_("1991 Catalog Request for vol=%s failed: %s"),
233 mr.VolumeName, db_strerror(jcr->db));
237 /* Set first written time if this is first job */
238 if (mr.FirstWritten == 0) {
239 if (VolFirstWritten == 0) {
240 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
242 mr.FirstWritten = VolFirstWritten;
244 mr.set_first_written = true;
246 /* If we just labeled the tape set time */
247 if (label || mr.LabelDate == 0) {
248 mr.LabelDate = jcr->start_time;
249 mr.set_label_date = true;
250 if (mr.InitialWrite == 0) {
251 mr.InitialWrite = jcr->start_time;
253 Dmsg2(400, "label=%d labeldate=%d\n", label, mr.LabelDate);
256 * Insanity check for VolFiles get set to a smaller value
258 if (sdmr.VolFiles < mr.VolFiles) {
259 Jmsg(jcr, M_FATAL, 0, _("Volume Files at %u being set to %u"
260 " for Volume \"%s\". This is incorrect.\n"),
261 mr.VolFiles, sdmr.VolFiles, mr.VolumeName);
262 bs->fsend(_("1992 Update Media error. VolFiles=%u, CatFiles=%u\n"),
263 sdmr.VolFiles, mr.VolFiles);
268 Dmsg2(400, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
269 /* Check if the volume has been written by the job,
270 * and update the LastWritten field if needed */
271 if (mr.VolBlocks != sdmr.VolBlocks) {
272 mr.LastWritten = sdmr.LastWritten;
274 /* Copy updated values to original media record */
275 mr.VolJobs = sdmr.VolJobs;
276 mr.VolFiles = sdmr.VolFiles;
277 mr.VolBlocks = sdmr.VolBlocks;
278 mr.VolBytes = sdmr.VolBytes;
279 mr.VolMounts = sdmr.VolMounts;
280 mr.VolErrors = sdmr.VolErrors;
281 mr.VolWrites = sdmr.VolWrites;
283 mr.InChanger = sdmr.InChanger;
284 mr.VolReadTime = sdmr.VolReadTime;
285 mr.VolWriteTime = sdmr.VolWriteTime;
286 mr.VolParts = sdmr.VolParts;
287 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
289 * Update to point to the last device used to write the Volume.
290 * However, do so only if we are writing the tape, i.e.
291 * the number of VolBlocks has increased.
293 if (jcr->wstore && jcr->wstore->StorageId && mr.VolBlocks != sdmr.VolBlocks) {
294 mr.StorageId = jcr->wstore->StorageId;
297 Dmsg2(400, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
299 * Update the database, then before sending the response to the
300 * SD, check if the Volume has expired.
302 if (!db_update_media_record(jcr, jcr->db, &mr)) {
303 Jmsg(jcr, M_FATAL, 0, _("Catalog error updating Media record. %s"),
304 db_strerror(jcr->db));
305 bs->fsend(_("1993 Update Media error\n"));
306 Dmsg0(400, "send error\n");
308 (void)has_volume_expired(jcr, &mr);
309 send_volume_info_to_storage_daemon(jcr, bs, &mr);
314 * Request to create a JobMedia record
316 } else if (sscanf(bs->msg, Create_job_media, &Job,
317 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
318 &jm.StartBlock, &jm.EndBlock, &jm.Copy, &Stripe, &MediaId) == 10) {
321 jm.JobId = jcr->mig_jcr->JobId;
323 jm.JobId = jcr->JobId;
325 jm.MediaId = MediaId;
326 Dmsg6(400, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
327 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
328 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
329 Jmsg(jcr, M_FATAL, 0, _("Catalog error creating JobMedia record. %s"),
330 db_strerror(jcr->db));
331 bs->fsend(_("1991 Update JobMedia error\n"));
333 Dmsg0(400, "JobMedia record created\n");
334 bs->fsend(OK_create);
338 omsg = get_memory(bs->msglen+1);
339 pm_strcpy(omsg, bs->msg);
340 bs->fsend(_("1990 Invalid Catalog Request: %s"), omsg);
341 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request: %s"), omsg);
344 Dmsg1(400, ">CatReq response: %s", bs->msg);
345 Dmsg1(400, "Leave catreq jcr 0x%x\n", jcr);
350 * Update File Attributes in the catalog with data
351 * sent by the Storage daemon. Note, we receive the whole
352 * attribute record, but we select out only the stat packet,
353 * VolSessionId, VolSessionTime, FileIndex, and file name
354 * to store in the catalog.
356 void catalog_update(JCR *jcr, BSOCK *bs)
359 uint32_t VolSessionId, VolSessionTime;
370 if (job_canceled(jcr) || !jcr->pool->catalog_files) {
371 goto bail_out; /* user disabled cataloging */
374 omsg = get_memory(bs->msglen+1);
375 pm_strcpy(omsg, bs->msg);
376 bs->fsend(_("1991 Invalid Catalog Update: %s"), omsg);
377 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog Update; DB not open: %s"), omsg);
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", bs->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_file_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, bs->msglen);
418 memcpy(jcr->attr, bs->msg, bs->msglen);
419 p = jcr->attr - bs->msg + p; /* point p into jcr->attr */
420 skip_nonspaces(&p); /* skip FileIndex */
422 skip_nonspaces(&p); /* skip FileType */
425 len = strlen(fname); /* length before attributes */
426 attr = &fname[len+1];
428 Dmsg2(400, "dird<stored: stream=%d %s\n", Stream, fname);
429 Dmsg1(400, "dird<stored: attr=%s\n", attr);
432 ar->FileIndex = FileIndex;
436 ar->JobId = jcr->mig_jcr->JobId;
438 ar->JobId = jcr->JobId;
441 ar->DigestType = CRYPTO_DIGEST_NONE;
442 jcr->cached_attribute = true;
444 Dmsg2(400, "dird<filed: stream=%d %s\n", Stream, fname);
445 Dmsg1(400, "dird<filed: attr=%s\n", attr);
447 } else if (crypto_digest_stream_type(Stream) != CRYPTO_DIGEST_NONE) {
449 if (ar->FileIndex != FileIndex) {
450 Jmsg(jcr, M_WARNING, 0, _("Got %s but not same File as attributes\n"), stream_to_ascii(Stream));
452 /* Update digest in catalog */
453 char digestbuf[BASE64_SIZE(CRYPTO_DIGEST_MAX_SIZE)];
455 int type = CRYPTO_DIGEST_NONE;
458 case STREAM_MD5_DIGEST:
459 len = CRYPTO_DIGEST_MD5_SIZE;
460 type = CRYPTO_DIGEST_MD5;
462 case STREAM_SHA1_DIGEST:
463 len = CRYPTO_DIGEST_SHA1_SIZE;
464 type = CRYPTO_DIGEST_SHA1;
466 case STREAM_SHA256_DIGEST:
467 len = CRYPTO_DIGEST_SHA256_SIZE;
468 type = CRYPTO_DIGEST_SHA256;
470 case STREAM_SHA512_DIGEST:
471 len = CRYPTO_DIGEST_SHA512_SIZE;
472 type = CRYPTO_DIGEST_SHA512;
475 /* Never reached ... */
476 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating file digest. Unsupported digest stream type: %d"),
480 bin_to_base64(digestbuf, sizeof(digestbuf), fname, len, true);
481 Dmsg3(400, "DigestLen=%d Digest=%s type=%d\n", strlen(digestbuf), digestbuf, Stream);
482 if (jcr->cached_attribute) {
483 ar->Digest = digestbuf;
484 ar->DigestType = type;
485 Dmsg2(400, "Cached attr with digest. Stream=%d fname=%s\n", ar->Stream, ar->fname);
486 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
487 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
489 jcr->cached_attribute = false;
491 if (!db_add_digest_to_file_record(jcr, jcr->db, ar->FileId, digestbuf, type)) {
492 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating file digest. %s"),
493 db_strerror(jcr->db));
499 if (job_canceled(jcr)) {
500 cancel_storage_daemon_job(jcr);