2 * Bacula File Daemon backup.c send file attributes and data
3 * to the Storage daemon.
5 * Kern Sibbald, March MM
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
35 #include <acl/libacl.h>
38 static int save_file(FF_PKT *ff_pkt, void *pkt);
41 * Find all the requested files and send them
42 * to the Storage daemon.
44 * Note, we normally carry on a one-way
45 * conversation from this point on with the SD, simply blasting
46 * data to him. To properly know what is going on, we
47 * also run a "heartbeat" monitor which reads the socket and
48 * reacts accordingly (at the moment it has nothing to do
49 * except echo the heartbeat to the Director).
52 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
57 sd = jcr->store_bsock;
59 set_jcr_job_status(jcr, JS_Running);
61 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->fd);
64 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
68 buf_size = client->max_network_buffer_size;
70 buf_size = 0; /* use default */
72 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
73 set_jcr_job_status(jcr, JS_ErrorTerminated);
74 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
78 jcr->buf_size = sd->msglen;
79 /* Adjust for compression so that output buffer is
80 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
81 * This gives a bit extra plus room for the sparse addr if any.
82 * Note, we adjust the read size to be smaller so that the
83 * same output buffer can be used without growing it.
85 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
86 jcr->compress_buf = get_memory(jcr->compress_buf_size);
88 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
89 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
90 Dmsg0(300, "start find files\n");
92 start_heartbeat_monitor(jcr);
94 /* Subroutine save_file() is called for each file */
95 if (!find_files(jcr, (FF_PKT *)jcr->ff, save_file, (void *)jcr)) {
96 ok = false; /* error */
97 set_jcr_job_status(jcr, JS_ErrorTerminated);
98 // Jmsg(jcr, M_FATAL, 0, _("Find files error.\n"));
101 stop_heartbeat_monitor(jcr);
103 bnet_sig(sd, BNET_EOD); /* end data connection */
109 if (jcr->compress_buf) {
110 free_pool_memory(jcr->compress_buf);
111 jcr->compress_buf = NULL;
113 Dmsg1(300, "end blast_data stat=%d\n", ok);
118 * Called here by find() for each file included.
120 * *****FIXME***** add FSMs File System Modules
122 * Send the file and its data to the Storage daemon.
126 * -1 to ignore file/directory (not used here)
128 static int save_file(FF_PKT *ff_pkt, void *vjcr)
130 char attribs[MAXSTRING];
131 char attribsEx[MAXSTRING];
132 int stat, attr_stream, data_stream;
133 struct MD5Context md5c;
134 struct SHA1Context sha1c;
137 unsigned char signature[30]; /* large enough for either signature */
139 JCR *jcr = (JCR *)vjcr;
142 if (job_canceled(jcr)) {
146 sd = jcr->store_bsock;
147 jcr->num_files_examined++; /* bump total file count */
149 switch (ff_pkt->type) {
150 case FT_LNKSAVED: /* Hard linked, file already saved */
151 Dmsg2(130, "FT_LNKSAVED hard link: %s => %s\n", ff_pkt->fname, ff_pkt->link);
154 Dmsg1(130, "FT_REGE saving: %s\n", ff_pkt->fname);
157 Dmsg1(130, "FT_REG saving: %s\n", ff_pkt->fname);
160 Dmsg2(130, "FT_LNK saving: %s -> %s\n", ff_pkt->fname, ff_pkt->link);
163 return 1; /* not used */
165 Dmsg1(130, "FT_DIR saving: %s\n", ff_pkt->link);
168 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
171 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
174 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
177 Jmsg(jcr, M_NOTSAVED, -1, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
178 strerror(ff_pkt->ff_errno));
182 Jmsg(jcr, M_NOTSAVED, -1, _(" Could not follow link %s: ERR=%s\n"), ff_pkt->fname,
183 strerror(ff_pkt->ff_errno));
187 Jmsg(jcr, M_NOTSAVED, -1, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
188 strerror(ff_pkt->ff_errno));
193 Jmsg(jcr, M_SKIPPED, -1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
196 Jmsg(jcr, M_NOTSAVED, -1, _(" Archive file not saved: %s\n"), ff_pkt->fname);
199 Jmsg(jcr, M_SKIPPED, -1, _(" Recursion turned off. Directory skipped: %s\n"),
203 Jmsg(jcr, M_SKIPPED, -1, _(" File system change prohibited. Directory skipped. %s\n"),
207 Jmsg(jcr, M_NOTSAVED, -1, _(" Could not open directory %s: ERR=%s\n"), ff_pkt->fname,
208 strerror(ff_pkt->ff_errno));
212 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"), ff_pkt->type, ff_pkt->fname);
218 if (ff_pkt->flags & FO_PORTABLE) {
219 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
223 * Open any file with data that we intend to save.
224 * Note, if is_win32_backup, we must open the Directory so that
225 * the BackupRead will save its permissions and ownership streams.
227 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
228 ff_pkt->statp.st_size > 0) ||
229 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
230 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
232 if (ff_pkt->type == FT_FIFO) {
233 tid = start_thread_timer(pthread_self(), 60);
237 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
238 ff_pkt->ff_errno = errno;
239 Jmsg(jcr, M_NOTSAVED, -1, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
240 berror(&ff_pkt->bfd));
243 stop_thread_timer(tid);
249 stop_thread_timer(tid);
254 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
256 /* Find what data stream we will use, then encode the attributes */
257 data_stream = select_data_stream(ff_pkt);
258 encode_stat(attribs, ff_pkt, data_stream);
260 /* Now possibly extend the attributes */
261 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
263 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
266 jcr->JobFiles++; /* increment number of files sent */
267 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
268 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
272 * Send Attributes header to Storage daemon
273 * <file-index> <stream> <info>
275 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
276 if (is_bopen(&ff_pkt->bfd)) {
277 bclose(&ff_pkt->bfd);
279 set_jcr_job_status(jcr, JS_ErrorTerminated);
282 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
285 * Send file attributes to Storage daemon
288 * Filename (full path)
290 * Link name (if type==FT_LNK or FT_LNKSAVED)
291 * Encoded extended-attributes (for Win32)
293 * For a directory, link is the same as fname, but with trailing
294 * slash. For a linked file, link is the link.
296 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
297 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
298 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
299 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
301 } else if (ff_pkt->type == FT_DIREND) {
302 /* Here link is the canonical filename (i.e. with trailing slash) */
303 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
304 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
306 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
307 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
310 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
312 if (is_bopen(&ff_pkt->bfd)) {
313 bclose(&ff_pkt->bfd);
315 set_jcr_job_status(jcr, JS_ErrorTerminated);
316 Jmsg0(jcr, M_FATAL, 0, _("Network send error.\n"));
319 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */
322 * If the file has data, read it and send to the Storage daemon
325 if (is_bopen(&ff_pkt->bfd)) {
326 uint64_t fileAddr = 0; /* file address */
328 int rsize = jcr->buf_size; /* read buffer size */
331 rbuf = sd->msg; /* read buffer */
332 wbuf = sd->msg; /* write buffer */
335 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
339 uLong compress_len, max_compress_len = 0;
340 const Bytef *cbuf = NULL;
342 if (ff_pkt->flags & FO_GZIP) {
343 if (ff_pkt->flags & FO_SPARSE) {
344 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
345 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
347 cbuf = (Bytef *)jcr->compress_buf;
348 max_compress_len = jcr->compress_buf_size; /* set max length */
350 wbuf = jcr->compress_buf; /* compressed output here */
355 * Send Data header to Storage daemon
356 * <file-index> <stream> <info>
358 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, data_stream)) {
359 bclose(&ff_pkt->bfd);
360 set_jcr_job_status(jcr, JS_ErrorTerminated);
361 Jmsg0(jcr, M_FATAL, 0, _("Network send error.\n"));
364 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
366 if (ff_pkt->flags & FO_MD5) {
368 } else if (ff_pkt->flags & FO_SHA1) {
373 * Make space at beginning of buffer for fileAddr because this
374 * same buffer will be used for writing if compression if off.
376 if (ff_pkt->flags & FO_SPARSE) {
377 rbuf += SPARSE_FADDR_SIZE;
378 rsize -= SPARSE_FADDR_SIZE;
379 #ifdef HAVE_FREEBSD_OS
381 * To read FreeBSD partitions, the read size must be
384 rsize = (rsize/512) * 512;
391 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
394 /* Check for sparse blocks */
395 if (ff_pkt->flags & FO_SPARSE) {
397 if (sd->msglen == rsize &&
398 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
399 sparseBlock = is_buf_zero(rbuf, rsize);
402 ser_begin(wbuf, SPARSE_FADDR_SIZE);
403 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
406 jcr->ReadBytes += sd->msglen; /* count bytes read */
407 fileAddr += sd->msglen;
409 /* Update MD5 if requested */
410 if (ff_pkt->flags & FO_MD5) {
411 MD5Update(&md5c, (unsigned char *)rbuf, sd->msglen);
413 } else if (ff_pkt->flags & FO_SHA1) {
414 SHA1Update(&sha1c, (unsigned char *)rbuf, sd->msglen);
419 /* Do compression if turned on */
420 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
422 compress_len = max_compress_len;
423 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
425 /* NOTE! This call modifies compress_len !!! */
426 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
427 (const Bytef *)rbuf, (uLong)sd->msglen,
428 ff_pkt->GZIP_level)) != Z_OK) {
429 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
432 bclose(&ff_pkt->bfd);
433 set_jcr_job_status(jcr, JS_ErrorTerminated);
436 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
437 compress_len, sd->msglen);
439 sd->msglen = compress_len; /* set compressed length */
443 /* Send the buffer to the Storage daemon */
445 if (ff_pkt->flags & FO_SPARSE) {
446 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
448 sd->msg = wbuf; /* set correct write buffer */
449 if (!bnet_send(sd)) {
450 sd->msg = msgsave; /* restore bnet buffer */
452 bclose(&ff_pkt->bfd);
453 set_jcr_job_status(jcr, JS_ErrorTerminated);
454 Jmsg0(jcr, M_FATAL, 0, _("Network send error.\n"));
458 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
460 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
461 sd->msg = msgsave; /* restore read buffer */
463 } /* end while read file data */
466 if (sd->msglen < 0) {
467 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
468 ff_pkt->fname, berror(&ff_pkt->bfd));
471 bclose(&ff_pkt->bfd); /* close file */
472 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
473 set_jcr_job_status(jcr, JS_ErrorTerminated);
474 Jmsg0(jcr, M_FATAL, 0, _("Network send error.\n"));
481 if (ff_pkt->flags & FO_ACL) {
483 /* Read ACLs for files, dirs and links */
484 if (ff_pkt->type == FT_DIREND) {
485 /* Directory: Try for default ACL*/
486 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_DEFAULT);
488 Dmsg1(200, "No default ACL defined for directory: %s!\n", ff_pkt->fname);
489 /* If there is no default ACL get standard ACL */
490 myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
492 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of directory: %s!\n", ff_pkt->fname);
495 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
500 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
502 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of file: %s!\n", ff_pkt->fname);
505 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
509 /* If there is an ACL, send it to the Storage daemon */
511 sd = jcr->store_bsock;
512 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
518 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_UNIX_ATTRIBUTES_ACL)) {
519 set_jcr_job_status(jcr, JS_ErrorTerminated);
523 /* Send the buffer to the storage deamon */
526 sd->msglen = strlen(acl_text) + 1;
527 if (!bnet_send(sd)) {
530 bclose(&ff_pkt->bfd);
531 set_jcr_job_status(jcr, JS_ErrorTerminated);
532 Jmsg1(jcr, M_FATAL, 0, "Error while trying to send ACL of %s to SD!\n", ff_pkt->fname);
534 jcr->JobBytes += sd->msglen;
536 bclose(&ff_pkt->bfd);
537 if (!bnet_sig(sd, BNET_EOD)) {
538 set_jcr_job_status(jcr, JS_ErrorTerminated);
540 Dmsg1(200, "ACL of file: %s successfully backed up!\n", ff_pkt->fname);
547 /* Terminate any MD5 signature and send it to Storage daemon and the Director */
548 if (gotMD5 && ff_pkt->flags & FO_MD5) {
549 MD5Final(signature, &md5c);
550 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_MD5_SIGNATURE);
551 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
552 memcpy(sd->msg, signature, 16);
555 bnet_sig(sd, BNET_EOD); /* end of MD5 */
558 } else if (gotSHA1 && ff_pkt->flags & FO_SHA1) {
559 /* Terminate any SHA1 signature and send it to Storage daemon and the Director */
560 SHA1Final(&sha1c, signature);
561 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_SHA1_SIGNATURE);
562 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
563 memcpy(sd->msg, signature, 20);
566 bnet_sig(sd, BNET_EOD); /* end of SHA1 */