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 reason = "not Append or Recycle";
134 /* What we're trying to do here is see if the current volume is
135 * "recycleable" - ie. if we prune all expired jobs off it, is
136 * it now possible to reuse it for the job that it is currently
139 if ((mr.LastWritten + mr.VolRetention) < (utime_t)time(NULL)
140 && mr.Recycle && jcr->pool->recycle_current_volume
141 && (strcmp(mr.VolStatus, "Full") == 0 ||
142 strcmp(mr.VolStatus, "Used") == 0)) {
144 * Attempt prune of current volume to see if we can
145 * recycle it for use.
149 ua = new_ua_context(jcr);
150 ok = prune_volume(ua, &mr);
154 /* If fully purged, recycle current volume */
155 if (recycle_volume(jcr, &mr)) {
156 Jmsg(jcr, M_INFO, 0, "Recycled current "
157 "volume \"%s\"\n", mr.VolumeName);
160 reason = "not Append or Recycle (recycling of the "
161 "current volume failed)";
164 reason = "not Append or Recycle (cannot automatically "
165 "recycle current volume, as it still contains "
169 } else if (strcmp(mr.MediaType, jcr->store->media_type) != 0) {
170 reason = "not correct MediaType";
171 } else if (!jcr->pool->accept_any_volume) {
172 reason = "Volume not in sequence";
178 char ed1[50], ed2[50], ed3[50];
180 * Send Find Media response to Storage daemon
182 bash_spaces(mr.VolumeName);
183 bnet_fsend(bs, OK_media, mr.VolumeName, mr.VolJobs,
184 mr.VolFiles, mr.VolBlocks, edit_uint64(mr.VolBytes, ed1),
185 mr.VolMounts, mr.VolErrors, mr.VolWrites,
186 edit_uint64(mr.MaxVolBytes, ed2),
187 edit_uint64(mr.VolCapacityBytes, ed3),
188 mr.VolStatus, mr.Slot, mr.MaxVolJobs, mr.MaxVolFiles);
189 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, bs->msg);
191 /* Not suitable volume */
192 bnet_fsend(bs, "1998 Volume \"%s\" %s.\n",
193 mr.VolumeName, reason);
197 bnet_fsend(bs, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
202 * Request to update Media record. Comes typically at the end
203 * of a Storage daemon Job Session
205 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName, &sdmr.VolJobs,
206 &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes, &sdmr.VolMounts, &sdmr.VolErrors,
207 &sdmr.VolWrites, &sdmr.MaxVolBytes, &sdmr.LastWritten, &sdmr.VolStatus,
208 &sdmr.Slot, &relabel) == 14) {
211 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
212 mr.VolStatus, sdmr.VolStatus);
213 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
214 unbash_spaces(mr.VolumeName);
215 if (!db_get_media_record(jcr, jcr->db, &mr)) {
216 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
217 mr.VolumeName, db_strerror(jcr->db));
218 bnet_fsend(bs, "1991 Catalog Request failed: %s", db_strerror(jcr->db));
222 /* Set first written time if this is first job */
223 if (mr.VolJobs == 0 || sdmr.VolJobs == 1) {
224 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
226 Dmsg2(200, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
227 /* Copy updated values to original media record */
228 mr.VolJobs = sdmr.VolJobs;
229 mr.VolFiles = sdmr.VolFiles;
230 mr.VolBlocks = sdmr.VolBlocks;
231 mr.VolBytes = sdmr.VolBytes;
232 mr.VolMounts = sdmr.VolMounts;
233 mr.VolErrors = sdmr.VolErrors;
234 mr.VolWrites = sdmr.VolWrites;
235 mr.LastWritten = sdmr.LastWritten;
236 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
240 * Update Media Record
243 /* Check limits and expirations if "Append" and not a relable request */
244 if (strcmp(mr.VolStatus, "Append") == 0 && !relabel) {
245 /* First handle Max Volume Bytes */
246 if ((mr.MaxVolBytes > 0 && mr.VolBytes >= mr.MaxVolBytes)) {
247 Jmsg(jcr, M_INFO, 0, _("Max Volume bytes exceeded. "
248 "Marking Volume \"%s\" as Full.\n"), mr.VolumeName);
249 strcpy(mr.VolStatus, "Full");
251 /* Now see if Volume should only be used once */
252 } else if (mr.VolBytes > 0 && jcr->pool->use_volume_once) {
253 Jmsg(jcr, M_INFO, 0, _("Volume used once. "
254 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
255 strcpy(mr.VolStatus, "Used");
257 /* Now see if Max Jobs written to volume */
258 } else if (mr.MaxVolJobs > 0 && mr.MaxVolJobs <= mr.VolJobs) {
259 Jmsg(jcr, M_INFO, 0, _("Max Volume jobs exceeded. "
260 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
261 strcpy(mr.VolStatus, "Used");
263 /* Now see if Max Files written to volume */
264 } else if (mr.MaxVolFiles > 0 && mr.MaxVolFiles <= mr.VolFiles) {
265 Jmsg(jcr, M_INFO, 0, _("Max Volume files exceeded. "
266 "Marking Volume \"%s\" as Used.\n"), mr.VolumeName);
267 strcpy(mr.VolStatus, "Used");
269 /* Finally, check Use duration expiration */
270 } else if (mr.VolUseDuration > 0) {
271 utime_t now = time(NULL);
272 /* See if Vol Use has expired */
273 if (mr.VolUseDuration <= (now - mr.FirstWritten)) {
274 Jmsg(jcr, M_INFO, 0, _("Max configured use duration exceeded. "
275 "Marking Volume \"%s\"as Used.\n"), mr.VolumeName);
276 strcpy(mr.VolStatus, "Used"); /* yes, mark as used */
280 Dmsg2(200, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
281 if (db_update_media_record(jcr, jcr->db, &mr)) {
282 bnet_fsend(bs, OK_update);
283 Dmsg0(190, "send OK\n");
285 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating Media record. %s"),
286 db_strerror(jcr->db));
287 bnet_fsend(bs, "1992 Update Media error\n");
288 Dmsg0(190, "send error\n");
293 * Request to create a JobMedia record
295 } else if (sscanf(bs->msg, Create_job_media, &Job,
296 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
297 &jm.StartBlock, &jm.EndBlock) == 7) {
299 jm.JobId = jcr->JobId;
300 jm.MediaId = jcr->MediaId;
301 Dmsg6(100, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
302 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
303 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
304 Jmsg(jcr, M_ERROR, 0, _("Catalog error creating JobMedia record. %s"),
305 db_strerror(jcr->db));
306 bnet_fsend(bs, "1991 Update JobMedia error\n");
308 Dmsg0(100, "JobMedia record created\n");
309 bnet_fsend(bs, OK_update);
313 omsg = get_memory(bs->msglen+1);
314 pm_strcpy(&omsg, bs->msg);
315 bnet_fsend(bs, "1990 Invalid Catalog Request: %s", omsg);
316 Jmsg1(jcr, M_ERROR, 0, _("Invalid Catalog request: %s"), omsg);
319 Dmsg1(120, ">CatReq response: %s", bs->msg);
320 Dmsg1(200, "Leave catreq jcr 0x%x\n", jcr);
325 * Update File Attributes in the catalog with data
326 * sent by the Storage daemon. Note, we receive the whole
327 * attribute record, but we select out only the stat packet,
328 * VolSessionId, VolSessionTime, FileIndex, and file name
329 * to store in the catalog.
331 void catalog_update(JCR *jcr, BSOCK *bs, char *msg)
334 uint32_t VolSessionId, VolSessionTime;
343 if (!jcr->pool->catalog_files) {
346 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
347 skip_nonspaces(&p); /* UpdCat */
349 skip_nonspaces(&p); /* Job=nnn */
351 skip_nonspaces(&p); /* FileAttributes */
354 unser_uint32(VolSessionId);
355 unser_uint32(VolSessionTime);
356 unser_int32(FileIndex);
358 unser_uint32(data_len);
359 p += unser_length(p);
361 Dmsg1(99, "UpdCat msg=%s\n", bs->msg);
362 Dmsg5(99, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
363 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
365 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
366 skip_nonspaces(&p); /* skip FileIndex */
368 skip_nonspaces(&p); /* skip FileType */
371 len = strlen(fname); /* length before attributes */
372 attr = &fname[len+1];
374 Dmsg2(109, "dird<stored: stream=%d %s\n", Stream, fname);
375 Dmsg1(109, "dird<stored: attr=%s\n", attr);
378 ar.FileIndex = FileIndex;
381 ar.JobId = jcr->JobId;
383 Dmsg2(111, "dird<filed: stream=%d %s\n", Stream, fname);
384 Dmsg1(120, "dird<filed: attr=%s\n", attr);
386 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
387 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
389 /* Save values for SIG update */
390 jcr->FileId = ar.FileId;
391 jcr->FileIndex = FileIndex;
392 } else if (Stream == STREAM_MD5_SIGNATURE || Stream == STREAM_SHA1_SIGNATURE) {
394 if (jcr->FileIndex != FileIndex) {
395 Jmsg(jcr, M_WARNING, 0, "Got MD5/SHA1 but not same File as attributes\n");
397 /* Update signature in catalog */
398 char SIGbuf[50]; /* 24 bytes should be enough */
400 if (Stream == STREAM_MD5_SIGNATURE) {
407 bin_to_base64(SIGbuf, fname, len);
408 Dmsg3(190, "SIGlen=%d SIG=%s type=%d\n", strlen(SIGbuf), SIGbuf, Stream);
409 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIGbuf, type)) {
410 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating MD5/SHA1. %s"),
411 db_strerror(jcr->db));