3 * Bacula Director -- catreq.c -- handles the message channel
4 * catalog request from the Storage daemon.
6 * Kern Sibbald, March MMI
8 * This routine runs as a thread and must be thread reentrant.
10 * Basic tasks done here:
11 * Handle Catalog services.
16 Copyright (C) 2001-2005 Kern Sibbald
18 This program is free software; you can redistribute it and/or
19 modify it under the terms of the GNU General Public License
20 version 2 as amended with additional clauses defined in the
21 file LICENSE in the main source directory.
23 This program is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 the file LICENSE for additional details.
34 * Handle catalog request
35 * For now, we simply return next Volume to be used
38 /* Requests from the Storage daemon */
39 static char Find_media[] = "CatReq Job=%127s FindMedia=%d pool_name=%127s media_type=%127s\n";
40 static char Get_Vol_Info[] = "CatReq Job=%127s GetVolInfo VolName=%127s write=%d\n";
42 static char Update_media[] = "CatReq Job=%127s UpdateMedia VolName=%s"
43 " VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%" lld " VolMounts=%u"
44 " VolErrors=%u VolWrites=%u MaxVolBytes=%" lld " EndTime=%d VolStatus=%10s"
45 " Slot=%d relabel=%d InChanger=%d VolReadTime=%" lld " VolWriteTime=%" lld
48 static char Create_job_media[] = "CatReq Job=%127s CreateJobMedia "
49 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u "
50 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d\n";
53 /* Responses sent to Storage daemon */
54 static char OK_media[] = "1000 OK VolName=%s VolJobs=%u VolFiles=%u"
55 " VolBlocks=%u VolBytes=%s VolMounts=%u VolErrors=%u VolWrites=%u"
56 " MaxVolBytes=%s VolCapacityBytes=%s VolStatus=%s Slot=%d"
57 " MaxVolJobs=%u MaxVolFiles=%u InChanger=%d VolReadTime=%s"
58 " VolWriteTime=%s EndFile=%u EndBlock=%u VolParts=%u LabelType=%d\n";
60 static char OK_create[] = "1000 OK CreateJobMedia\n";
63 static int send_volume_info_to_storage_daemon(JCR *jcr, BSOCK *sd, MEDIA_DBR *mr)
66 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50];
68 jcr->MediaId = mr->MediaId;
69 pm_strcpy(jcr->VolumeName, mr->VolumeName);
70 bash_spaces(mr->VolumeName);
71 stat = bnet_fsend(sd, OK_media, mr->VolumeName, mr->VolJobs,
72 mr->VolFiles, mr->VolBlocks, edit_uint64(mr->VolBytes, ed1),
73 mr->VolMounts, mr->VolErrors, mr->VolWrites,
74 edit_uint64(mr->MaxVolBytes, ed2),
75 edit_uint64(mr->VolCapacityBytes, ed3),
76 mr->VolStatus, mr->Slot, mr->MaxVolJobs, mr->MaxVolFiles,
78 edit_uint64(mr->VolReadTime, ed4),
79 edit_uint64(mr->VolWriteTime, ed5),
80 mr->EndFile, mr->EndBlock,
83 unbash_spaces(mr->VolumeName);
84 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, sd->msg);
88 void catalog_request(JCR *jcr, BSOCK *bs)
92 char Job[MAX_NAME_LENGTH];
93 char pool_name[MAX_NAME_LENGTH];
94 int index, ok, label, writing;
98 memset(&mr, 0, sizeof(mr));
99 memset(&sdmr, 0, sizeof(sdmr));
100 memset(&jm, 0, sizeof(jm));
103 * Request to find next appendable Volume for this Job
105 Dmsg1(100, "catreq %s", bs->msg);
107 omsg = get_memory(bs->msglen+1);
108 pm_strcpy(omsg, bs->msg);
109 bnet_fsend(bs, _("1990 Invalid Catalog Request: %s"), omsg);
110 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request; DB not open: %s"), omsg);
115 * Find next appendable medium for SD
117 if (sscanf(bs->msg, Find_media, &Job, &index, &pool_name, &mr.MediaType) == 4) {
118 memset(&pr, 0, sizeof(pr));
119 bstrncpy(pr.Name, pool_name, sizeof(pr.Name));
120 unbash_spaces(pr.Name);
121 ok = db_get_pool_record(jcr, jcr->db, &pr);
123 mr.PoolId = pr.PoolId;
124 mr.StorageId = jcr->store->StorageId;
125 ok = find_next_volume_for_append(jcr, &mr, index, true /*permit create new vol*/);
128 * Send Find Media response to Storage daemon
131 send_volume_info_to_storage_daemon(jcr, bs, &mr);
133 bnet_fsend(bs, _("1901 No Media.\n"));
134 Dmsg0(500, "1901 No Media.\n");
138 * Request to find specific Volume information
140 } else if (sscanf(bs->msg, Get_Vol_Info, &Job, &mr.VolumeName, &writing) == 3) {
141 Dmsg1(100, "CatReq GetVolInfo Vol=%s\n", mr.VolumeName);
145 unbash_spaces(mr.VolumeName);
146 if (db_get_media_record(jcr, jcr->db, &mr)) {
147 const char *reason = NULL; /* detailed reason for rejection */
149 * If we are reading, accept any volume (reason == NULL)
150 * If we are writing, check if the Volume is valid
151 * for this job, and do a recycle if necessary
155 * SD wants to write this Volume, so make
156 * sure it is suitable for this job, i.e.
157 * Pool matches, and it is either Append or Recycle
158 * and Media Type matches and Pool allows any volume.
160 if (mr.PoolId != jcr->PoolId) {
161 reason = _("not in Pool");
162 } else if (strcmp(mr.MediaType, jcr->store->media_type) != 0) {
163 reason = _("not correct MediaType");
166 * Now try recycling if necessary
167 * reason set non-NULL if we cannot use it
169 check_if_volume_valid_or_recyclable(jcr, &mr, &reason);
172 if (reason == NULL) {
174 * Send Find Media response to Storage daemon
176 send_volume_info_to_storage_daemon(jcr, bs, &mr);
178 /* Not suitable volume */
179 bnet_fsend(bs, _("1998 Volume \"%s\" status is %s, %s.\n"), mr.VolumeName,
180 mr.VolStatus, reason);
184 bnet_fsend(bs, _("1997 Volume \"%s\" not in catalog.\n"), mr.VolumeName);
185 Dmsg1(100, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
189 * Request to update Media record. Comes typically at the end
190 * of a Storage daemon Job Session, when labeling/relabeling a
191 * Volume, or when an EOF mark is written.
193 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName,
194 &sdmr.VolJobs, &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes,
195 &sdmr.VolMounts, &sdmr.VolErrors, &sdmr.VolWrites, &sdmr.MaxVolBytes,
196 &sdmr.LastWritten, &sdmr.VolStatus, &sdmr.Slot, &label, &sdmr.InChanger,
197 &sdmr.VolReadTime, &sdmr.VolWriteTime, &sdmr.VolParts) == 18) {
200 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
201 mr.VolStatus, sdmr.VolStatus);
202 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
203 unbash_spaces(mr.VolumeName);
204 if (!db_get_media_record(jcr, jcr->db, &mr)) {
205 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
206 mr.VolumeName, db_strerror(jcr->db));
207 bnet_fsend(bs, _("1991 Catalog Request for vol=%s failed: %s"),
208 mr.VolumeName, db_strerror(jcr->db));
212 /* Set first written time if this is first job */
213 if (mr.FirstWritten == 0) {
214 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
215 mr.set_first_written = true;
217 /* If we just labeled the tape set time */
218 if (label || mr.LabelDate == 0) {
219 mr.LabelDate = jcr->start_time;
220 mr.set_label_date = true;
221 Dmsg2(400, "label=%d labeldate=%d\n", label, mr.LabelDate);
224 * Insanity check for VolFiles get set to a smaller value
226 if (sdmr.VolFiles < mr.VolFiles) {
227 Jmsg(jcr, M_FATAL, 0, _("Volume Files at %u being set to %u"
228 " for Volume \"%s\". This is incorrect.\n"),
229 mr.VolFiles, sdmr.VolFiles, mr.VolumeName);
230 bnet_fsend(bs, _("1992 Update Media error. VolFiles=%u, CatFiles=%u\n"),
231 sdmr.VolFiles, mr.VolFiles);
236 Dmsg2(400, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
237 /* Copy updated values to original media record */
238 mr.VolJobs = sdmr.VolJobs;
239 mr.VolFiles = sdmr.VolFiles;
240 mr.VolBlocks = sdmr.VolBlocks;
241 mr.VolBytes = sdmr.VolBytes;
242 mr.VolMounts = sdmr.VolMounts;
243 mr.VolErrors = sdmr.VolErrors;
244 mr.VolWrites = sdmr.VolWrites;
245 mr.LastWritten = sdmr.LastWritten;
247 mr.InChanger = sdmr.InChanger;
248 mr.VolReadTime = sdmr.VolReadTime;
249 mr.VolWriteTime = sdmr.VolWriteTime;
250 mr.VolParts = sdmr.VolParts;
251 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
252 if (jcr->store->StorageId) {
253 mr.StorageId = jcr->store->StorageId;
256 Dmsg2(400, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
258 * Update the database, then before sending the response to the
259 * SD, check if the Volume has expired.
261 if (!db_update_media_record(jcr, jcr->db, &mr)) {
262 Jmsg(jcr, M_FATAL, 0, _("Catalog error updating Media record. %s"),
263 db_strerror(jcr->db));
264 bnet_fsend(bs, _("1993 Update Media error\n"));
265 Dmsg0(400, "send error\n");
267 (void)has_volume_expired(jcr, &mr);
268 send_volume_info_to_storage_daemon(jcr, bs, &mr);
273 * Request to create a JobMedia record
275 } else if (sscanf(bs->msg, Create_job_media, &Job,
276 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
277 &jm.StartBlock, &jm.EndBlock, &jm.Copy, &jm.Stripe) == 9) {
279 jm.JobId = jcr->JobId;
280 jm.MediaId = jcr->MediaId;
281 Dmsg6(400, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
282 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
283 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
284 Jmsg(jcr, M_FATAL, 0, _("Catalog error creating JobMedia record. %s"),
285 db_strerror(jcr->db));
286 bnet_fsend(bs, _("1991 Update JobMedia error\n"));
288 Dmsg0(400, "JobMedia record created\n");
289 bnet_fsend(bs, OK_create);
293 omsg = get_memory(bs->msglen+1);
294 pm_strcpy(omsg, bs->msg);
295 bnet_fsend(bs, _("1990 Invalid Catalog Request: %s"), omsg);
296 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request: %s"), omsg);
299 Dmsg1(400, ">CatReq response: %s", bs->msg);
300 Dmsg1(400, "Leave catreq jcr 0x%x\n", jcr);
305 * Update File Attributes in the catalog with data
306 * sent by the Storage daemon. Note, we receive the whole
307 * attribute record, but we select out only the stat packet,
308 * VolSessionId, VolSessionTime, FileIndex, and file name
309 * to store in the catalog.
311 void catalog_update(JCR *jcr, BSOCK *bs)
314 uint32_t VolSessionId, VolSessionTime;
324 if (!jcr->pool->catalog_files) {
325 return; /* user disabled cataloging */
328 omsg = get_memory(bs->msglen+1);
329 pm_strcpy(omsg, bs->msg);
330 bnet_fsend(bs, _("1991 Invalid Catalog Update: %s"), omsg);
331 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog Update; DB not open: %s"), omsg);
336 /* Start transaction allocates jcr->attr and jcr->ar if needed */
337 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
340 /* Start by scanning directly in the message buffer to get Stream
341 * there may be a cached attr so we cannot yet write into
342 * jcr->attr or jcr->ar
345 skip_nonspaces(&p); /* UpdCat */
347 skip_nonspaces(&p); /* Job=nnn */
349 skip_nonspaces(&p); /* FileAttributes */
352 unser_uint32(VolSessionId);
353 unser_uint32(VolSessionTime);
354 unser_int32(FileIndex);
356 unser_uint32(data_len);
357 p += unser_length(p);
359 Dmsg1(400, "UpdCat msg=%s\n", bs->msg);
360 Dmsg5(400, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
361 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
363 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
364 if (jcr->cached_attribute) {
365 Dmsg2(400, "Cached attr. Stream=%d fname=%s\n", ar->Stream, ar->fname);
366 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
367 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
370 /* Any cached attr is flushed so we can reuse jcr->attr and jcr->ar */
371 jcr->attr = check_pool_memory_size(jcr->attr, bs->msglen);
372 memcpy(jcr->attr, bs->msg, bs->msglen);
373 p = jcr->attr - bs->msg + p; /* point p into jcr->attr */
374 skip_nonspaces(&p); /* skip FileIndex */
376 skip_nonspaces(&p); /* skip FileType */
379 len = strlen(fname); /* length before attributes */
380 attr = &fname[len+1];
382 Dmsg2(400, "dird<stored: stream=%d %s\n", Stream, fname);
383 Dmsg1(400, "dird<stored: attr=%s\n", attr);
386 ar->FileIndex = FileIndex;
389 ar->JobId = jcr->JobId;
392 jcr->cached_attribute = true;
394 Dmsg2(400, "dird<filed: stream=%d %s\n", Stream, fname);
395 Dmsg1(400, "dird<filed: attr=%s\n", attr);
398 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
399 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
402 } else if (Stream == STREAM_MD5_SIGNATURE || Stream == STREAM_SHA1_SIGNATURE) {
404 if (ar->FileIndex != FileIndex) {
405 Jmsg(jcr, M_WARNING, 0, _("Got MD5/SHA1 but not same File as attributes\n"));
407 /* Update signature in catalog */
408 char SIGbuf[50]; /* 24 bytes should be enough */
410 if (Stream == STREAM_MD5_SIGNATURE) {
417 bin_to_base64(SIGbuf, fname, len);
418 Dmsg3(400, "SIGlen=%d SIG=%s type=%d\n", strlen(SIGbuf), SIGbuf, Stream);
419 if (jcr->cached_attribute) {
422 Dmsg2(400, "Cached attr with SIG. Stream=%d fname=%s\n", ar->Stream, ar->fname);
423 if (!db_create_file_attributes_record(jcr, jcr->db, ar)) {
424 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
426 jcr->cached_attribute = false;
428 if (!db_add_SIG_to_file_record(jcr, jcr->db, ar->FileId, SIGbuf, type)) {
429 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating MD5/SHA1. %s"),
430 db_strerror(jcr->db));