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-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 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 pool_name=%127s media_type=%127s\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 InChanger=%d VolReadTime=%" lld " VolWriteTime=%" lld
53 static char Create_job_media[] = "CatReq Job=%127s CreateJobMedia "
54 " FirstIndex=%u LastIndex=%u StartFile=%u EndFile=%u "
55 " StartBlock=%u EndBlock=%u Copy=%d Strip=%d\n";
58 /* Responses sent to Storage daemon */
59 static char OK_media[] = "1000 OK VolName=%s VolJobs=%u VolFiles=%u"
60 " VolBlocks=%u VolBytes=%s VolMounts=%u VolErrors=%u VolWrites=%u"
61 " MaxVolBytes=%s VolCapacityBytes=%s VolStatus=%s Slot=%d"
62 " MaxVolJobs=%u MaxVolFiles=%u InChanger=%d VolReadTime=%s"
63 " VolWriteTime=%s EndFile=%u EndBlock=%u VolParts=%u LabelType=%d\n";
65 static char OK_create[] = "1000 OK CreateJobMedia\n";
68 static int send_volume_info_to_storage_daemon(JCR *jcr, BSOCK *sd, MEDIA_DBR *mr)
71 char ed1[50], ed2[50], ed3[50], ed4[50], ed5[50];
73 jcr->MediaId = mr->MediaId;
74 pm_strcpy(jcr->VolumeName, mr->VolumeName);
75 bash_spaces(mr->VolumeName);
76 stat = bnet_fsend(sd, OK_media, mr->VolumeName, mr->VolJobs,
77 mr->VolFiles, mr->VolBlocks, edit_uint64(mr->VolBytes, ed1),
78 mr->VolMounts, mr->VolErrors, mr->VolWrites,
79 edit_uint64(mr->MaxVolBytes, ed2),
80 edit_uint64(mr->VolCapacityBytes, ed3),
81 mr->VolStatus, mr->Slot, mr->MaxVolJobs, mr->MaxVolFiles,
83 edit_uint64(mr->VolReadTime, ed4),
84 edit_uint64(mr->VolWriteTime, ed5),
85 mr->EndFile, mr->EndBlock,
88 unbash_spaces(mr->VolumeName);
89 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, sd->msg);
93 void catalog_request(JCR *jcr, BSOCK *bs, char *msg)
97 char Job[MAX_NAME_LENGTH];
98 char pool_name[MAX_NAME_LENGTH];
99 int index, ok, label, writing;
103 memset(&mr, 0, sizeof(mr));
104 memset(&sdmr, 0, sizeof(sdmr));
105 memset(&jm, 0, sizeof(jm));
108 * Request to find next appendable Volume for this Job
110 Dmsg1(100, "catreq %s", bs->msg);
112 omsg = get_memory(bs->msglen+1);
113 pm_strcpy(omsg, bs->msg);
114 bnet_fsend(bs, "1990 Invalid Catalog Request: %s", omsg);
115 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request; DB not open: %s"), omsg);
120 * Find next appendable medium for SD
122 if (sscanf(bs->msg, Find_media, &Job, &index, &pool_name, &mr.MediaType) == 4) {
123 memset(&pr, 0, sizeof(pr));
124 bstrncpy(pr.Name, pool_name, sizeof(pr.Name));
125 ok = db_get_pool_record(jcr, jcr->db, &pr);
127 mr.PoolId = pr.PoolId;
128 ok = find_next_volume_for_append(jcr, &mr, true /*permit create new vol*/);
131 * Send Find Media response to Storage daemon
134 send_volume_info_to_storage_daemon(jcr, bs, &mr);
136 bnet_fsend(bs, "1901 No Media.\n");
137 Dmsg0(500, "1901 No Media.\n");
141 * Request to find specific Volume information
143 } else if (sscanf(bs->msg, Get_Vol_Info, &Job, &mr.VolumeName, &writing) == 3) {
144 Dmsg1(500, "CatReq GetVolInfo Vol=%s\n", mr.VolumeName);
148 unbash_spaces(mr.VolumeName);
149 if (db_get_media_record(jcr, jcr->db, &mr)) {
150 const char *reason = NULL; /* detailed reason for rejection */
152 * If we are reading, accept any volume (reason == NULL)
153 * If we are writing, check if the Volume is valid
154 * for this job, and do a recycle if necessary
158 * SD wants to write this Volume, so make
159 * sure it is suitable for this job, i.e.
160 * Pool matches, and it is either Append or Recycle
161 * and Media Type matches and Pool allows any volume.
163 if (mr.PoolId != jcr->PoolId) {
164 reason = "not in Pool";
165 } else if (strcmp(mr.MediaType, jcr->store->media_type) != 0) {
166 reason = "not correct MediaType";
170 * This test (accept_any_volume) is turned off
171 * because it doesn't properly check if the volume
172 * really is out of sequence!
174 * } else if (!jcr->pool->accept_any_volume) {
175 * reason = "Volume not in sequence";
179 * Now try recycling if necessary
180 * reason set non-NULL if we cannot use it
182 check_if_volume_valid_or_recyclable(jcr, &mr, &reason);
185 if (reason == NULL) {
187 * Send Find Media response to Storage daemon
189 send_volume_info_to_storage_daemon(jcr, bs, &mr);
191 /* Not suitable volume */
192 bnet_fsend(bs, "1998 Volume \"%s\" status is %s, %s.\n", mr.VolumeName,
193 mr.VolStatus, reason);
197 bnet_fsend(bs, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
198 Dmsg1(400, "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, when labeling/relabeling a
204 * Volume, or when an EOF mark is written.
206 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName,
207 &sdmr.VolJobs, &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes,
208 &sdmr.VolMounts, &sdmr.VolErrors, &sdmr.VolWrites, &sdmr.MaxVolBytes,
209 &sdmr.LastWritten, &sdmr.VolStatus, &sdmr.Slot, &label, &sdmr.InChanger,
210 &sdmr.VolReadTime, &sdmr.VolWriteTime, &sdmr.VolParts) == 18) {
213 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
214 mr.VolStatus, sdmr.VolStatus);
215 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
216 unbash_spaces(mr.VolumeName);
217 if (!db_get_media_record(jcr, jcr->db, &mr)) {
218 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
219 mr.VolumeName, db_strerror(jcr->db));
220 bnet_fsend(bs, "1991 Catalog Request for vol=%s failed: %s",
221 mr.VolumeName, db_strerror(jcr->db));
225 /* Set first written time if this is first job */
226 if (mr.FirstWritten == 0) {
227 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
228 mr.set_first_written = true;
230 /* If we just labeled the tape set time */
231 if (label || mr.LabelDate == 0) {
232 mr.LabelDate = jcr->start_time;
233 mr.set_label_date = true;
234 Dmsg2(400, "label=%d labeldate=%d\n", label, mr.LabelDate);
237 * Insanity check for VolFiles get set to a smaller value
239 if (sdmr.VolFiles < mr.VolFiles) {
240 Jmsg(jcr, M_FATAL, 0, _("Volume Files at %u being set to %u"
241 " for Volume \"%s\". This is incorrect.\n"),
242 mr.VolFiles, sdmr.VolFiles, mr.VolumeName);
243 bnet_fsend(bs, "1992 Update Media error\n");
248 Dmsg2(400, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
249 /* Copy updated values to original media record */
250 mr.VolJobs = sdmr.VolJobs;
251 mr.VolFiles = sdmr.VolFiles;
252 mr.VolBlocks = sdmr.VolBlocks;
253 mr.VolBytes = sdmr.VolBytes;
254 mr.VolMounts = sdmr.VolMounts;
255 mr.VolErrors = sdmr.VolErrors;
256 mr.VolWrites = sdmr.VolWrites;
257 mr.LastWritten = sdmr.LastWritten;
259 mr.InChanger = sdmr.InChanger;
260 mr.VolReadTime = sdmr.VolReadTime;
261 mr.VolWriteTime = sdmr.VolWriteTime;
262 mr.VolParts = sdmr.VolParts;
263 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
265 Dmsg2(400, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
267 * Check if it has expired, and if not update the DB. Note, if
268 * Volume has expired, has_volume_expired() will update the DB.
270 if (has_volume_expired(jcr, &mr) || db_update_media_record(jcr, jcr->db, &mr)) {
271 send_volume_info_to_storage_daemon(jcr, bs, &mr);
273 Jmsg(jcr, M_FATAL, 0, _("Catalog error updating Media record. %s"),
274 db_strerror(jcr->db));
275 bnet_fsend(bs, "1992 Update Media error\n");
276 Dmsg0(400, "send error\n");
281 * Request to create a JobMedia record
283 } else if (sscanf(bs->msg, Create_job_media, &Job,
284 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
285 &jm.StartBlock, &jm.EndBlock, &jm.Copy, &jm.Stripe) == 9) {
287 jm.JobId = jcr->JobId;
288 jm.MediaId = jcr->MediaId;
289 Dmsg6(400, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
290 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
291 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
292 Jmsg(jcr, M_FATAL, 0, _("Catalog error creating JobMedia record. %s"),
293 db_strerror(jcr->db));
294 bnet_fsend(bs, "1991 Update JobMedia error\n");
296 Dmsg0(400, "JobMedia record created\n");
297 bnet_fsend(bs, OK_create);
301 omsg = get_memory(bs->msglen+1);
302 pm_strcpy(omsg, bs->msg);
303 bnet_fsend(bs, "1990 Invalid Catalog Request: %s", omsg);
304 Jmsg1(jcr, M_FATAL, 0, _("Invalid Catalog request: %s"), omsg);
307 Dmsg1(400, ">CatReq response: %s", bs->msg);
308 Dmsg1(400, "Leave catreq jcr 0x%x\n", jcr);
313 * Update File Attributes in the catalog with data
314 * sent by the Storage daemon. Note, we receive the whole
315 * attribute record, but we select out only the stat packet,
316 * VolSessionId, VolSessionTime, FileIndex, and file name
317 * to store in the catalog.
319 void catalog_update(JCR *jcr, BSOCK *bs, char *msg)
322 uint32_t VolSessionId, VolSessionTime;
331 if (!jcr->pool->catalog_files) {
334 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
335 skip_nonspaces(&p); /* UpdCat */
337 skip_nonspaces(&p); /* Job=nnn */
339 skip_nonspaces(&p); /* FileAttributes */
342 unser_uint32(VolSessionId);
343 unser_uint32(VolSessionTime);
344 unser_int32(FileIndex);
346 unser_uint32(data_len);
347 p += unser_length(p);
349 Dmsg1(400, "UpdCat msg=%s\n", bs->msg);
350 Dmsg5(400, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
351 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
353 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
354 skip_nonspaces(&p); /* skip FileIndex */
356 skip_nonspaces(&p); /* skip FileType */
359 len = strlen(fname); /* length before attributes */
360 attr = &fname[len+1];
362 Dmsg2(400, "dird<stored: stream=%d %s\n", Stream, fname);
363 Dmsg1(400, "dird<stored: attr=%s\n", attr);
366 ar.FileIndex = FileIndex;
369 ar.JobId = jcr->JobId;
371 Dmsg2(400, "dird<filed: stream=%d %s\n", Stream, fname);
372 Dmsg1(400, "dird<filed: attr=%s\n", attr);
374 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
375 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
377 /* Save values for SIG update */
378 jcr->FileId = ar.FileId;
379 jcr->FileIndex = FileIndex;
380 } else if (Stream == STREAM_MD5_SIGNATURE || Stream == STREAM_SHA1_SIGNATURE) {
382 if (jcr->FileIndex != FileIndex) {
383 Jmsg(jcr, M_WARNING, 0, "Got MD5/SHA1 but not same File as attributes\n");
385 /* Update signature in catalog */
386 char SIGbuf[50]; /* 24 bytes should be enough */
388 if (Stream == STREAM_MD5_SIGNATURE) {
395 bin_to_base64(SIGbuf, fname, len);
396 Dmsg3(400, "SIGlen=%d SIG=%s type=%d\n", strlen(SIGbuf), SIGbuf, Stream);
397 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIGbuf, type)) {
398 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating MD5/SHA1. %s"),
399 db_strerror(jcr->db));