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, label, 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 /*permit create new vol*/);
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 char *reason = NULL; /* detailed reason for rejection */
116 jcr->MediaId = mr.MediaId;
117 Dmsg1(120, "VolumeInfo MediaId=%d\n", jcr->MediaId);
118 pm_strcpy(&jcr->VolumeName, mr.VolumeName);
120 * If we are reading, accept any volume (reason == NULL)
121 * If we are writing, check if the Volume is valid
122 * for this job, and do a recycle if necessary
126 * SD wants to write this Volume, so make
127 * sure it is suitable for this job, i.e.
128 * Pool matches, and it is either Append or Recycle
129 * and Media Type matches and Pool allows any volume.
131 if (mr.PoolId != jcr->PoolId) {
132 reason = "not in Pool";
133 } else if (strcmp(mr.MediaType, jcr->store->media_type) != 0) {
134 reason = "not correct MediaType";
138 * This test (accept_any_volume) is turned off
139 * because it doesn't properly check if the volume
140 * really is out of sequence!
142 * } else if (!jcr->pool->accept_any_volume) {
143 * reason = "Volume not in sequence";
147 * Now try recycling if necessary
148 * reason set non-NULL if we cannot use it
149 * We also check for Volume being expired.
151 check_if_volume_valid_or_recyclable(jcr, &mr, &reason);
154 if (reason == NULL) {
155 char ed1[50], ed2[50], ed3[50];
157 * Send Find Media response to Storage daemon
159 bash_spaces(mr.VolumeName);
160 bnet_fsend(bs, OK_media, mr.VolumeName, mr.VolJobs,
161 mr.VolFiles, mr.VolBlocks, edit_uint64(mr.VolBytes, ed1),
162 mr.VolMounts, mr.VolErrors, mr.VolWrites,
163 edit_uint64(mr.MaxVolBytes, ed2),
164 edit_uint64(mr.VolCapacityBytes, ed3),
165 mr.VolStatus, mr.Slot, mr.MaxVolJobs, mr.MaxVolFiles);
166 Dmsg2(100, "Vol Info for %s: %s", jcr->Job, bs->msg);
168 /* Not suitable volume */
169 bnet_fsend(bs, "1998 Volume \"%s\" status is %s, %s.\n", mr.VolumeName,
170 mr.VolStatus, reason);
174 bnet_fsend(bs, "1997 Volume \"%s\" not in catalog.\n", mr.VolumeName);
179 * Request to update Media record. Comes typically at the end
180 * of a Storage daemon Job Session or when labeling/relabeling a
183 } else if (sscanf(bs->msg, Update_media, &Job, &sdmr.VolumeName, &sdmr.VolJobs,
184 &sdmr.VolFiles, &sdmr.VolBlocks, &sdmr.VolBytes, &sdmr.VolMounts, &sdmr.VolErrors,
185 &sdmr.VolWrites, &sdmr.MaxVolBytes, &sdmr.LastWritten, &sdmr.VolStatus,
186 &sdmr.Slot, &label) == 14) {
189 Dmsg3(400, "Update media %s oldStat=%s newStat=%s\n", sdmr.VolumeName,
190 mr.VolStatus, sdmr.VolStatus);
191 bstrncpy(mr.VolumeName, sdmr.VolumeName, sizeof(mr.VolumeName)); /* copy Volume name */
192 unbash_spaces(mr.VolumeName);
193 if (!db_get_media_record(jcr, jcr->db, &mr)) {
194 Jmsg(jcr, M_ERROR, 0, _("Unable to get Media record for Volume %s: ERR=%s\n"),
195 mr.VolumeName, db_strerror(jcr->db));
196 bnet_fsend(bs, "1991 Catalog Request failed: %s", db_strerror(jcr->db));
200 /* Set first written time if this is first job */
201 if (mr.VolJobs == 0 || sdmr.VolJobs == 1) {
202 mr.FirstWritten = jcr->start_time; /* use Job start time as first write */
204 /* If we just labeled the tape set time */
205 Dmsg2(400, "label=%d labeldate=%d\n", label, mr.LabelDate);
206 if (label || mr.LabelDate == 0) {
207 mr.LabelDate = time(NULL);
209 Dmsg2(200, "Update media: BefVolJobs=%u After=%u\n", mr.VolJobs, sdmr.VolJobs);
210 /* Copy updated values to original media record */
211 mr.VolJobs = sdmr.VolJobs;
212 mr.VolFiles = sdmr.VolFiles;
213 mr.VolBlocks = sdmr.VolBlocks;
214 mr.VolBytes = sdmr.VolBytes;
215 mr.VolMounts = sdmr.VolMounts;
216 mr.VolErrors = sdmr.VolErrors;
217 mr.VolWrites = sdmr.VolWrites;
218 mr.LastWritten = sdmr.LastWritten;
219 bstrncpy(mr.VolStatus, sdmr.VolStatus, sizeof(mr.VolStatus));
222 Dmsg2(200, "db_update_media_record. Stat=%s Vol=%s\n", mr.VolStatus, mr.VolumeName);
224 * Write the modified record to the DB
226 if (db_update_media_record(jcr, jcr->db, &mr)) {
227 bnet_fsend(bs, OK_update);
228 Dmsg0(190, "send OK\n");
230 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating Media record. %s"),
231 db_strerror(jcr->db));
232 bnet_fsend(bs, "1992 Update Media error\n");
233 Dmsg0(190, "send error\n");
235 has_volume_expired(jcr, &mr); /* if expired, change Media record */
239 * Request to create a JobMedia record
241 } else if (sscanf(bs->msg, Create_job_media, &Job,
242 &jm.FirstIndex, &jm.LastIndex, &jm.StartFile, &jm.EndFile,
243 &jm.StartBlock, &jm.EndBlock) == 7) {
245 jm.JobId = jcr->JobId;
246 jm.MediaId = jcr->MediaId;
247 Dmsg6(100, "create_jobmedia JobId=%d MediaId=%d SF=%d EF=%d FI=%d LI=%d\n",
248 jm.JobId, jm.MediaId, jm.StartFile, jm.EndFile, jm.FirstIndex, jm.LastIndex);
249 if (!db_create_jobmedia_record(jcr, jcr->db, &jm)) {
250 Jmsg(jcr, M_ERROR, 0, _("Catalog error creating JobMedia record. %s"),
251 db_strerror(jcr->db));
252 bnet_fsend(bs, "1991 Update JobMedia error\n");
254 Dmsg0(100, "JobMedia record created\n");
255 bnet_fsend(bs, OK_update);
259 omsg = get_memory(bs->msglen+1);
260 pm_strcpy(&omsg, bs->msg);
261 bnet_fsend(bs, "1990 Invalid Catalog Request: %s", omsg);
262 Jmsg1(jcr, M_ERROR, 0, _("Invalid Catalog request: %s"), omsg);
265 Dmsg1(120, ">CatReq response: %s", bs->msg);
266 Dmsg1(200, "Leave catreq jcr 0x%x\n", jcr);
271 * Update File Attributes in the catalog with data
272 * sent by the Storage daemon. Note, we receive the whole
273 * attribute record, but we select out only the stat packet,
274 * VolSessionId, VolSessionTime, FileIndex, and file name
275 * to store in the catalog.
277 void catalog_update(JCR *jcr, BSOCK *bs, char *msg)
280 uint32_t VolSessionId, VolSessionTime;
289 if (!jcr->pool->catalog_files) {
292 db_start_transaction(jcr, jcr->db); /* start transaction if not already open */
293 skip_nonspaces(&p); /* UpdCat */
295 skip_nonspaces(&p); /* Job=nnn */
297 skip_nonspaces(&p); /* FileAttributes */
300 unser_uint32(VolSessionId);
301 unser_uint32(VolSessionTime);
302 unser_int32(FileIndex);
304 unser_uint32(data_len);
305 p += unser_length(p);
307 Dmsg1(99, "UpdCat msg=%s\n", bs->msg);
308 Dmsg5(99, "UpdCat VolSessId=%d VolSessT=%d FI=%d Strm=%d data_len=%d\n",
309 VolSessionId, VolSessionTime, FileIndex, Stream, data_len);
311 if (Stream == STREAM_UNIX_ATTRIBUTES || Stream == STREAM_UNIX_ATTRIBUTES_EX) {
312 skip_nonspaces(&p); /* skip FileIndex */
314 skip_nonspaces(&p); /* skip FileType */
317 len = strlen(fname); /* length before attributes */
318 attr = &fname[len+1];
320 Dmsg2(109, "dird<stored: stream=%d %s\n", Stream, fname);
321 Dmsg1(109, "dird<stored: attr=%s\n", attr);
324 ar.FileIndex = FileIndex;
327 ar.JobId = jcr->JobId;
329 Dmsg2(111, "dird<filed: stream=%d %s\n", Stream, fname);
330 Dmsg1(120, "dird<filed: attr=%s\n", attr);
332 if (!db_create_file_attributes_record(jcr, jcr->db, &ar)) {
333 Jmsg1(jcr, M_FATAL, 0, _("Attribute create error. %s"), db_strerror(jcr->db));
335 /* Save values for SIG update */
336 jcr->FileId = ar.FileId;
337 jcr->FileIndex = FileIndex;
338 } else if (Stream == STREAM_MD5_SIGNATURE || Stream == STREAM_SHA1_SIGNATURE) {
340 if (jcr->FileIndex != FileIndex) {
341 Jmsg(jcr, M_WARNING, 0, "Got MD5/SHA1 but not same File as attributes\n");
343 /* Update signature in catalog */
344 char SIGbuf[50]; /* 24 bytes should be enough */
346 if (Stream == STREAM_MD5_SIGNATURE) {
353 bin_to_base64(SIGbuf, fname, len);
354 Dmsg3(190, "SIGlen=%d SIG=%s type=%d\n", strlen(SIGbuf), SIGbuf, Stream);
355 if (!db_add_SIG_to_file_record(jcr, jcr->db, jcr->FileId, SIGbuf, type)) {
356 Jmsg(jcr, M_ERROR, 0, _("Catalog error updating MD5/SHA1. %s"),
357 db_strerror(jcr->db));