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) 2000, 2001, 2002 Kern Sibbald and John Walker
18 This program is free software; you can redistribute it and/or
19 modify it under the terms of the GNU General Public License as
20 published by the Free Software Foundation; either version 2 of
21 the License, or (at your option) any later version.
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 GNU
26 General Public License for more details.
28 You should have received a copy of the GNU General Public
29 License along with this program; if not, write to the Free
30 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
39 * Handle catalog request
40 * For now, we simply return next Volume to be used
43 /* Requests from the Storage daemon */
44 static char Find_media[] = "CatReq Job=%127s FindMedia=%d\n";
45 static char Get_Vol_Info[] = "CatReq Job=%127s GetVolInfo VolName=%127s write=%d\n";
47 static char Update_media[] = "CatReq Job=%127s UpdateMedia VolName=%s\
48 VolJobs=%u VolFiles=%u VolBlocks=%u VolBytes=%" lld " VolMounts=%u\
49 VolErrors=%u VolWrites=%u MaxVolBytes=%" lld " EndTime=%d VolStatus=%10s\
50 Slot=%d relabel=%d\n";
52 static char Create_job_media[] = "CatReq Job=%127s CreateJobMedia \
53 FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u \
54 StartBlock=%u EndBlock=%u\n";
57 /* Responses sent to Storage daemon */
58 static char OK_media[] = "1000 OK VolName=%s VolJobs=%u VolFiles=%u\
59 VolBlocks=%u VolBytes=%s VolMounts=%u VolErrors=%u VolWrites=%u\
60 MaxVolBytes=%s VolCapacityBytes=%s VolStatus=%s Slot=%d\
61 MaxVolJobs=%u MaxVolFiles=%u\n";
63 static char OK_update[] = "1000 OK UpdateMedia\n";
65 /* static char FileAttributes[] = "UpdCat Job=%127s FileAttributes "; */
68 void catalog_request(JCR *jcr, BSOCK *bs, char *msg)
72 char Job[MAX_NAME_LENGTH];
73 int index, ok, relabel, writing;
76 memset(&mr, 0, sizeof(mr));
77 memset(&sdmr, 0, sizeof(sdmr));
78 memset(&jm, 0, sizeof(jm));
81 * Request to find next appendable Volume for this Job
83 Dmsg1(200, "catreq %s", bs->msg);
84 if (sscanf(bs->msg, Find_media, &Job, &index) == 2) {
85 ok = find_next_volume_for_append(jcr, &mr, TRUE /*create*/);
87 * Send Find Media response to Storage daemon
90 char ed1[50], ed2[50], ed3[50];
91 jcr->MediaId = mr.MediaId;
92 pm_strcpy(&jcr->VolumeName, mr.VolumeName);
93 bash_spaces(mr.VolumeName);
94 bnet_fsend(bs, OK_media, mr.VolumeName, mr.VolJobs,
95 mr.VolFiles, mr.VolBlocks, edit_uint64(mr.VolBytes, ed1),
96 mr.VolMounts, mr.VolErrors, mr.VolWrites,
97 edit_uint64(mr.MaxVolBytes, ed2),
98 edit_uint64(mr.VolCapacityBytes, ed3),
99 mr.VolStatus, mr.Slot, mr.MaxVolJobs, mr.MaxVolFiles);
100 Dmsg2(100, "Find media for %s: %s", jcr->Job, bs->msg);
102 bnet_fsend(bs, "1901 No Media.\n");
106 * Request to find specific Volume information
108 } else if (sscanf(bs->msg, Get_Vol_Info, &Job, &mr.VolumeName, &writing) == 3) {
109 Dmsg1(400, "CatReq GetVolInfo Vol=%s\n", mr.VolumeName);
113 unbash_spaces(mr.VolumeName);
114 if (db_get_media_record(jcr, jcr->db, &mr)) {
115 bool VolSuitable = false;
116 char *reason = ""; /* detailed reason for rejection */
117 jcr->MediaId = mr.MediaId;
118 Dmsg1(120, "VolumeInfo MediaId=%d\n", jcr->MediaId);
119 pm_strcpy(&jcr->VolumeName, mr.VolumeName);
121 VolSuitable = true; /* accept anything for read */
124 * SD wants to write this Volume, so make
125 * sure it is suitable for this job, i.e.
126 * Pool matches, and it is either Append or Recycle
127 * and Media Type matches and Pool allows any volume.
129 if (mr.PoolId != jcr->PoolId) {
130 reason = "not in Pool";
131 } else if (strcmp(mr.VolStatus, "Append") != 0 &&
132 strcmp(mr.VolStatus, "Recycle") != 0 &&
133 strcmp(mr.VolStatus, "Purged") != 0) {
134 reason = "not Append, Purged or Recycle";
135 /* What we're trying to do here is see if the current volume is
136 * "recycleable" - ie. if we prune all expired jobs off it, is
137 * it now possible to reuse it for the job that it is currently
140 if ((mr.LastWritten + mr.VolRetention) < (utime_t)time(NULL)
141 && mr.Recycle && jcr->pool->recycle_current_volume
142 && (strcmp(mr.VolStatus, "Full") == 0 ||
143 strcmp(mr.VolStatus, "Used") == 0)) {
145 * Attempt prune of current volume to see if we can
146 * recycle it for use.
150 ua = new_ua_context(jcr);
151 ok = prune_volume(ua, &mr);
155 /* If fully purged, recycle current volume */
156 if (recycle_volume(jcr, &mr)) {
157 Jmsg(jcr, M_INFO, 0, "Recycled current "
158 "volume \"%s\"\n", mr.VolumeName);
161 reason = "not Append, Purged or Recycle (recycling of the "
162 "current volume failed)";
165 reason = "not Append, Purged or Recycle (cannot automatically "
166 "recycle current volume, as it still contains "
170 } else if (strcmp(mr.MediaType, jcr->store->media_type) != 0) {
171 reason = "not correct MediaType";
172 } else if (!jcr->pool->accept_any_volume) {
173 reason = "Volume not in sequence";
174 } else if (strcmp(mr.VolStatus, "Purged") == 0) {
175 if (recycle_volume(jcr, &mr)) {
176 Jmsg(jcr, M_INFO, 0, "Recycled current "
177 "volume \"%s\"\n", mr.VolumeName);
180 /* In principle this shouldn't happen */
181 reason = "recycling of current volume failed";
188 char ed1[50], ed2[50], ed3[50];
190 * Send Find Media response to Storage daemon
192 bash_spaces(mr.VolumeName);
193 bnet_fsend(bs, OK_media, mr.VolumeName, mr.VolJobs,
194 mr.VolFiles, mr.VolBlocks, edit_uint64(mr.VolBytes, ed1),
195 mr.VolMounts, mr.VolErrors, mr.VolWrites,
196 edit_uint64(mr.MaxVolBytes, ed2),
197 edit_uint64(mr.VolCapacityBytes, ed3),
198 mr.VolStatus, mr.Slot, mr.MaxVolJobs, mr.MaxVolFiles);
199 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, bs->msg);
201 /* Not suitable volume */
202 bnet_fsend(bs, "1998 Volume \"%s\" %s.\n",
203 mr.VolumeName, reason);
207 bnet_fsend(bs, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
212 * Request to update Media record. Comes typically at the end
213 * of a Storage daemon Job Session
215 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName, &sdmr.VolJobs,
216 &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes, &sdmr.VolMounts, &sdmr.VolErrors,
217 &sdmr.VolWrites, &sdmr.MaxVolBytes, &sdmr.LastWritten, &sdmr.VolStatus,
218 &sdmr.Slot, &relabel) == 14) {
221 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
222 mr.VolStatus, sdmr.VolStatus);
223 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
224 unbash_spaces(mr.VolumeName);
225 if (!db_get_media_record(jcr, jcr->db, &mr)) {
226 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
227 mr.VolumeName, db_strerror(jcr->db));
228 bnet_fsend(bs, "1991 Catalog Request failed: %s", db_strerror(jcr->db));
232 /* Set first written time if this is first job */
233 if (mr.VolJobs == 0 || sdmr.VolJobs == 1) {
234 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
236 Dmsg2(200, "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;
246 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
250 * Update Media Record
253 /* Check limits and expirations if "Append" and not a relable request */
254 if (strcmp(mr.VolStatus, "Append") == 0 && !relabel) {
255 /* First handle Max Volume Bytes */
256 if ((mr.MaxVolBytes > 0 && mr.VolBytes >= mr.MaxVolBytes)) {
257 Jmsg(jcr, M_INFO, 0, _("Max Volume bytes exceeded. "
258 "Marking Volume \"%s\" as Full.\n"), mr.VolumeName);
259 strcpy(mr.VolStatus, "Full");
261 /* Now see if Volume should only be used once */
262 } else if (mr.VolBytes > 0 && jcr->pool->use_volume_once) {
263 Jmsg(jcr, M_INFO, 0, _("Volume used once. "
264 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
265 strcpy(mr.VolStatus, "Used");
267 /* Now see if Max Jobs written to volume */
268 } else if (mr.MaxVolJobs > 0 && mr.MaxVolJobs <= mr.VolJobs) {
269 Jmsg(jcr, M_INFO, 0, _("Max Volume jobs exceeded. "
270 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
271 strcpy(mr.VolStatus, "Used");
273 /* Now see if Max Files written to volume */
274 } else if (mr.MaxVolFiles > 0 && mr.MaxVolFiles <= mr.VolFiles) {
275 Jmsg(jcr, M_INFO, 0, _("Max Volume files exceeded. "
276 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
277 strcpy(mr.VolStatus, "Used");
279 /* Finally, check Use duration expiration */
280 } else if (mr.VolUseDuration > 0) {
281 utime_t now = time(NULL);
282 /* See if Vol Use has expired */
283 if (mr.VolUseDuration <= (now - mr.FirstWritten)) {
284 Jmsg(jcr, M_INFO, 0, _("Max configured use duration exceeded. "
285 "Marking Volume \"%s\"as Used.\n"), mr.VolumeName);
286 strcpy(mr.VolStatus, "Used"); /* yes, mark as used */
290 Dmsg2(200, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
291 if (db_update_media_record(jcr, jcr->db, &mr)) {
292 bnet_fsend(bs, OK_update);
293 Dmsg0(190, "send OK\n");
295 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating Media record. %s"),
296 db_strerror(jcr->db));
297 bnet_fsend(bs, "1992 Update Media error\n");
298 Dmsg0(190, "send error\n");
303 * Request to create a JobMedia record
305 } else if (sscanf(bs->msg, Create_job_media, &Job,
306 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
307 &jm.StartBlock, &jm.EndBlock) == 7) {
309 jm.JobId = jcr->JobId;
310 jm.MediaId = jcr->MediaId;
311 Dmsg6(100, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
312 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
313 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
314 Jmsg(jcr, M_ERROR, 0, _("Catalog error creating JobMedia record. %s"),
315 db_strerror(jcr->db));
316 bnet_fsend(bs, "1991 Update JobMedia error\n");
318 Dmsg0(100, "JobMedia record created\n");
319 bnet_fsend(bs, OK_update);
323 omsg = get_memory(bs->msglen+1);
324 pm_strcpy(&omsg, bs->msg);
325 bnet_fsend(bs, "1990 Invalid Catalog Request: %s", omsg);
326 Jmsg1(jcr, M_ERROR, 0, _("Invalid Catalog request: %s"), omsg);
329 Dmsg1(120, ">CatReq response: %s", bs->msg);
330 Dmsg1(200, "Leave catreq jcr 0x%x\n", jcr);
335 * Update File Attributes in the catalog with data
336 * sent by the Storage daemon. Note, we receive the whole
337 * attribute record, but we select out only the stat packet,
338 * VolSessionId, VolSessionTime, FileIndex, and file name
339 * to store in the catalog.
341 void catalog_update(JCR *jcr, BSOCK *bs, char *msg)
344 uint32_t VolSessionId, VolSessionTime;
353 if (!jcr->pool->catalog_files) {
356 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
357 skip_nonspaces(&p); /* UpdCat */
359 skip_nonspaces(&p); /* Job=nnn */
361 skip_nonspaces(&p); /* FileAttributes */
364 unser_uint32(VolSessionId);
365 unser_uint32(VolSessionTime);
366 unser_int32(FileIndex);
368 unser_uint32(data_len);
369 p += unser_length(p);
371 Dmsg1(99, "UpdCat msg=%s\n", bs->msg);
372 Dmsg5(99, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
373 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
375 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
376 skip_nonspaces(&p); /* skip FileIndex */
378 skip_nonspaces(&p); /* skip FileType */
381 len = strlen(fname); /* length before attributes */
382 attr = &fname[len+1];
384 Dmsg2(109, "dird<stored: stream=%d %s\n", Stream, fname);
385 Dmsg1(109, "dird<stored: attr=%s\n", attr);
388 ar.FileIndex = FileIndex;
391 ar.JobId = jcr->JobId;
393 Dmsg2(111, "dird<filed: stream=%d %s\n", Stream, fname);
394 Dmsg1(120, "dird<filed: attr=%s\n", attr);
396 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
397 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
399 /* Save values for SIG update */
400 jcr->FileId = ar.FileId;
401 jcr->FileIndex = FileIndex;
402 } else if (Stream == STREAM_MD5_SIGNATURE || Stream == STREAM_SHA1_SIGNATURE) {
404 if (jcr->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(190, "SIGlen=%d SIG=%s type=%d\n", strlen(SIGbuf), SIGbuf, Stream);
419 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIGbuf, type)) {
420 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating MD5/SHA1. %s"),
421 db_strerror(jcr->db));