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>
39 #include <sys/paths.h>
42 static int save_file(FF_PKT *ff_pkt, void *pkt);
45 * Find all the requested files and send them
46 * to the Storage daemon.
48 * Note, we normally carry on a one-way
49 * conversation from this point on with the SD, simply blasting
50 * data to him. To properly know what is going on, we
51 * also run a "heartbeat" monitor which reads the socket and
52 * reacts accordingly (at the moment it has nothing to do
53 * except echo the heartbeat to the Director).
56 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
61 sd = jcr->store_bsock;
63 set_jcr_job_status(jcr, JS_Running);
65 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->fd);
68 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
72 buf_size = client->max_network_buffer_size;
74 buf_size = 0; /* use default */
76 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
77 set_jcr_job_status(jcr, JS_ErrorTerminated);
78 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
82 jcr->buf_size = sd->msglen;
83 /* Adjust for compression so that output buffer is
84 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
85 * This gives a bit extra plus room for the sparse addr if any.
86 * Note, we adjust the read size to be smaller so that the
87 * same output buffer can be used without growing it.
89 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
90 jcr->compress_buf = get_memory(jcr->compress_buf_size);
92 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
93 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
94 Dmsg0(300, "start find files\n");
96 start_heartbeat_monitor(jcr);
98 /* Subroutine save_file() is called for each file */
99 if (!find_files(jcr, (FF_PKT *)jcr->ff, save_file, (void *)jcr)) {
100 ok = false; /* error */
101 set_jcr_job_status(jcr, JS_ErrorTerminated);
102 // Jmsg(jcr, M_FATAL, 0, _("Find files error.\n"));
105 stop_heartbeat_monitor(jcr);
107 bnet_sig(sd, BNET_EOD); /* end data connection */
113 if (jcr->compress_buf) {
114 free_pool_memory(jcr->compress_buf);
115 jcr->compress_buf = NULL;
117 Dmsg1(300, "end blast_data stat=%d\n", ok);
122 * Called here by find() for each file included.
124 * *****FIXME***** add FSMs File System Modules
126 * Send the file and its data to the Storage daemon.
130 * -1 to ignore file/directory (not used here)
132 static int save_file(FF_PKT *ff_pkt, void *vjcr)
134 char attribs[MAXSTRING];
135 char attribsEx[MAXSTRING];
136 int stat, attr_stream, data_stream;
137 bool hfsplus = false;
138 struct MD5Context md5c;
139 struct SHA1Context sha1c;
142 unsigned char signature[30]; /* large enough for either signature */
144 JCR *jcr = (JCR *)vjcr;
147 if (job_canceled(jcr)) {
151 sd = jcr->store_bsock;
152 jcr->num_files_examined++; /* bump total file count */
154 switch (ff_pkt->type) {
155 case FT_LNKSAVED: /* Hard linked, file already saved */
156 Dmsg2(130, "FT_LNKSAVED hard link: %s => %s\n", ff_pkt->fname, ff_pkt->link);
159 Dmsg1(130, "FT_REGE saving: %s\n", ff_pkt->fname);
162 Dmsg1(130, "FT_REG saving: %s\n", ff_pkt->fname);
165 Dmsg2(130, "FT_LNK saving: %s -> %s\n", ff_pkt->fname, ff_pkt->link);
168 return 1; /* not used */
173 if (ff_pkt->type == FT_NORECURSE) {
174 Jmsg(jcr, M_INFO, 1, _(" Recursion turned off. Will not descend into %s\n"),
176 } else if (ff_pkt->type == FT_NOFSCHG) {
177 Jmsg(jcr, M_INFO, 1, _(" File system change prohibited. Will not descend into %s\n"),
179 } else if (ff_pkt->type == FT_INVALIDFS) {
180 Jmsg(jcr, M_INFO, 1, _(" Disallowed filesystem. Will not descend into %s\n"),
183 ff_pkt->type = FT_DIREND; /* value is used below */
184 Dmsg1(130, "FT_DIR saving: %s\n", ff_pkt->link);
187 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
190 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
193 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
197 be.set_errno(ff_pkt->ff_errno);
198 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
205 be.set_errno(ff_pkt->ff_errno);
206 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not follow link %s: ERR=%s\n"), ff_pkt->fname,
213 be.set_errno(ff_pkt->ff_errno);
214 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
221 Jmsg(jcr, M_SKIPPED, 1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
224 Jmsg(jcr, M_NOTSAVED, 0, _(" Archive file not saved: %s\n"), ff_pkt->fname);
228 be.set_errno(ff_pkt->ff_errno);
229 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not open directory %s: ERR=%s\n"), ff_pkt->fname,
235 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"), ff_pkt->type, ff_pkt->fname);
241 if (ff_pkt->flags & FO_PORTABLE) {
242 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
244 if (ff_pkt->reader) {
245 set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr);
249 * Open any file with data that we intend to save.
250 * Note, if is_win32_backup, we must open the Directory so that
251 * the BackupRead will save its permissions and ownership streams.
253 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
254 ff_pkt->statp.st_size > 0) ||
255 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
256 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
258 if (ff_pkt->type == FT_FIFO) {
259 tid = start_thread_timer(pthread_self(), 60);
263 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
264 ff_pkt->ff_errno = errno;
266 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
270 stop_thread_timer(tid);
276 stop_thread_timer(tid);
281 binit(&ff_pkt->rsrc_bfd);
282 #ifdef HAVE_DARWIN_OS
283 /* Open resource fork if necessary */
284 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
285 ff_pkt->flags & FO_HFSPLUS)) {
286 /* Remember Finder Info, whether we have data or fork, or not */
288 if (ff_pkt->hfsinfo.rsrclength > 0) {
289 if (!bopen_rsrc(&ff_pkt->rsrc_bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
290 ff_pkt->ff_errno = errno;
292 Jmsg(jcr, M_NOTSAVED, -1, _(" Cannot open resource fork for %s: ERR=%s.\n"), ff_pkt->fname,
295 if (is_bopen(&ff_pkt->bfd)) {
296 bclose(&ff_pkt->bfd);
304 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
306 /* Find what data stream we will use, then encode the attributes */
307 data_stream = select_data_stream(ff_pkt);
308 encode_stat(attribs, ff_pkt, data_stream);
310 /* Now possibly extend the attributes */
311 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
313 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
316 jcr->JobFiles++; /* increment number of files sent */
317 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
318 pm_strcpy(jcr->last_fname, ff_pkt->fname);
322 * Send Attributes header to Storage daemon
323 * <file-index> <stream> <info>
325 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
327 if (is_bopen(&ff_pkt->bfd)) {
328 bclose(&ff_pkt->bfd);
330 if (is_bopen(&ff_pkt->rsrc_bfd)) {
331 bclose(&ff_pkt->rsrc_bfd);
333 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
337 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
340 * Send file attributes to Storage daemon
343 * Filename (full path)
345 * Link name (if type==FT_LNK or FT_LNKSAVED)
346 * Encoded extended-attributes (for Win32)
348 * For a directory, link is the same as fname, but with trailing
349 * slash. For a linked file, link is the link.
351 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
352 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
353 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
354 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
356 } else if (ff_pkt->type == FT_DIREND) {
357 /* Here link is the canonical filename (i.e. with trailing slash) */
358 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
359 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
361 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
362 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
365 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
368 if (is_bopen(&ff_pkt->bfd)) {
369 bclose(&ff_pkt->bfd);
371 if (is_bopen(&ff_pkt->rsrc_bfd)) {
372 bclose(&ff_pkt->rsrc_bfd);
374 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
378 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */
380 if (is_bopen(&ff_pkt->bfd) || hfsplus) {
381 if (ff_pkt->flags & FO_MD5) {
383 } else if (ff_pkt->flags & FO_SHA1) {
389 * If the file has data, read it and send to the Storage daemon
392 if (is_bopen(&ff_pkt->bfd)) {
393 uint64_t fileAddr = 0; /* file address */
395 int rsize = jcr->buf_size; /* read buffer size */
398 rbuf = sd->msg; /* read buffer */
399 wbuf = sd->msg; /* write buffer */
402 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
406 uLong compress_len, max_compress_len = 0;
407 const Bytef *cbuf = NULL;
409 if (ff_pkt->flags & FO_GZIP) {
410 if (ff_pkt->flags & FO_SPARSE) {
411 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
412 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
414 cbuf = (Bytef *)jcr->compress_buf;
415 max_compress_len = jcr->compress_buf_size; /* set max length */
417 wbuf = jcr->compress_buf; /* compressed output here */
422 * Send Data header to Storage daemon
423 * <file-index> <stream> <info>
425 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, data_stream)) {
427 bclose(&ff_pkt->bfd);
428 if (is_bopen(&ff_pkt->rsrc_bfd)) {
429 bclose(&ff_pkt->rsrc_bfd);
431 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
435 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
438 * Make space at beginning of buffer for fileAddr because this
439 * same buffer will be used for writing if compression if off.
441 if (ff_pkt->flags & FO_SPARSE) {
442 rbuf += SPARSE_FADDR_SIZE;
443 rsize -= SPARSE_FADDR_SIZE;
444 #ifdef HAVE_FREEBSD_OS
446 * To read FreeBSD partitions, the read size must be
449 rsize = (rsize/512) * 512;
456 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
459 /* Check for sparse blocks */
460 if (ff_pkt->flags & FO_SPARSE) {
462 if (sd->msglen == rsize &&
463 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
464 sparseBlock = is_buf_zero(rbuf, rsize);
467 ser_begin(wbuf, SPARSE_FADDR_SIZE);
468 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
471 jcr->ReadBytes += sd->msglen; /* count bytes read */
472 fileAddr += sd->msglen;
474 /* Update MD5 if requested */
475 if (ff_pkt->flags & FO_MD5) {
476 MD5Update(&md5c, (unsigned char *)rbuf, sd->msglen);
478 } else if (ff_pkt->flags & FO_SHA1) {
479 SHA1Update(&sha1c, (unsigned char *)rbuf, sd->msglen);
484 /* Do compression if turned on */
485 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
487 compress_len = max_compress_len;
488 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
490 /* NOTE! This call modifies compress_len !!! */
491 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
492 (const Bytef *)rbuf, (uLong)sd->msglen,
493 ff_pkt->GZIP_level)) != Z_OK) {
494 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
497 bclose(&ff_pkt->bfd);
498 if (is_bopen(&ff_pkt->rsrc_bfd)) {
499 bclose(&ff_pkt->rsrc_bfd);
501 set_jcr_job_status(jcr, JS_ErrorTerminated);
504 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
505 compress_len, sd->msglen);
507 sd->msglen = compress_len; /* set compressed length */
511 /* Send the buffer to the Storage daemon */
513 if (ff_pkt->flags & FO_SPARSE) {
514 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
516 sd->msg = wbuf; /* set correct write buffer */
517 if (!bnet_send(sd)) {
519 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
520 sd->msglen, bnet_strerror(sd));
521 sd->msg = msgsave; /* restore bnet buffer */
523 bclose(&ff_pkt->bfd);
524 if (is_bopen(&ff_pkt->rsrc_bfd)) {
525 bclose(&ff_pkt->rsrc_bfd);
530 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
532 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
533 sd->msg = msgsave; /* restore read buffer */
535 } /* end while read file data */
538 if (sd->msglen < 0) {
540 be.set_errno(ff_pkt->bfd.berrno);
541 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
542 ff_pkt->fname, be.strerror());
545 bclose(&ff_pkt->bfd); /* close file */
546 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
548 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
550 if (is_bopen(&ff_pkt->rsrc_bfd)) {
551 bclose(&ff_pkt->rsrc_bfd);
557 #ifdef HAVE_DARWIN_OS
559 * If resource fork has data, read it and send to the Storage daemon
562 if (is_bopen(&ff_pkt->rsrc_bfd)) {
563 uint64_t fileAddr = 0; /* file address */
564 int rsize = jcr->buf_size; /* read buffer size */
566 Dmsg1(300, "Saving resource fork for \"%s\"", ff_pkt->fname);
569 * Send Data header to Storage daemon
570 * <file-index> <stream> <info>
572 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_MACOS_FORK_DATA)) {
574 bclose(&ff_pkt->rsrc_bfd);
575 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
579 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
582 * Read the resource fork
584 while ((sd->msglen=(uint32_t)bread(&ff_pkt->rsrc_bfd, sd->msg, rsize)) > 0) {
585 jcr->ReadBytes += sd->msglen; /* count bytes read */
586 fileAddr += sd->msglen;
588 /* Update MD5 if requested */
589 if (ff_pkt->flags & FO_MD5) {
590 MD5Update(&md5c, (unsigned char *)sd->msg, sd->msglen);
592 } else if (ff_pkt->flags & FO_SHA1) {
593 SHA1Update(&sha1c, (unsigned char *)sd->msg, sd->msglen);
597 /* Send the buffer to the Storage daemon */
598 if (!bnet_send(sd)) {
600 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
601 sd->msglen, bnet_strerror(sd));
603 bclose(&ff_pkt->rsrc_bfd);
606 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
608 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
609 } /* end while read file data */
611 if (sd->msglen < 0) {
613 be.set_errno(ff_pkt->rsrc_bfd.berrno);
614 Jmsg(jcr, M_ERROR, 0, _("Read error on resource fork of %s. ERR=%s\n"),
615 ff_pkt->fname, be.strerror());
618 bclose(&ff_pkt->rsrc_bfd); /* close resource fork */
619 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of resource fork */
621 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
628 #ifdef HAVE_DARWIN_OS
629 /* Handle Finder Info */
630 if (S_ISREG(ff_pkt->statp.st_mode) && ff_pkt->flags & FO_HFSPLUS) {
631 Dmsg1(300, "Saving Finder Info for \"%s\"", ff_pkt->fname);
632 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_HFSPLUS_ATTRIBUTES);
633 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
634 memcpy(sd->msg, ff_pkt->hfsinfo.fndrinfo, 32);
636 /* Update MD5 if requested */
637 if (ff_pkt->flags & FO_MD5) {
638 MD5Update(&md5c, (unsigned char *)sd->msg, sd->msglen);
640 } else if (ff_pkt->flags & FO_SHA1) {
641 SHA1Update(&sha1c, (unsigned char *)sd->msg, sd->msglen);
645 bnet_sig(sd, BNET_EOD);
652 if (ff_pkt->flags & FO_ACL) {
654 /* Read ACLs for files, dirs and links */
655 if (ff_pkt->type == FT_DIREND) {
656 /* Directory: Try for default ACL*/
657 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_DEFAULT);
659 Dmsg1(200, "No default ACL defined for directory: %s!\n", ff_pkt->fname);
660 /* If there is no default ACL get standard ACL */
661 myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
663 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of directory: %s!\n", ff_pkt->fname);
666 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
671 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
673 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of file: %s!\n", ff_pkt->fname);
676 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
680 /* If there is an ACL, send it to the Storage daemon */
682 sd = jcr->store_bsock;
683 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
689 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_UNIX_ATTRIBUTES_ACL)) {
691 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
696 /* Send the buffer to the storage deamon */
699 sd->msglen = strlen(acl_text) + 1;
700 if (!bnet_send(sd)) {
704 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
707 jcr->JobBytes += sd->msglen;
709 if (!bnet_sig(sd, BNET_EOD)) {
711 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
714 Dmsg1(200, "ACL of file: %s successfully backed up!\n", ff_pkt->fname);
721 /* Terminate any MD5 signature and send it to Storage daemon and the Director */
722 if (gotMD5 && ff_pkt->flags & FO_MD5) {
723 MD5Final(signature, &md5c);
724 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_MD5_SIGNATURE);
725 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
726 memcpy(sd->msg, signature, 16);
729 bnet_sig(sd, BNET_EOD); /* end of MD5 */
732 } else if (gotSHA1 && ff_pkt->flags & FO_SHA1) {
733 /* Terminate any SHA1 signature and send it to Storage daemon and the Director */
734 SHA1Final(&sha1c, signature);
735 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_SHA1_SIGNATURE);
736 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
737 memcpy(sd->msg, signature, 20);
740 bnet_sig(sd, BNET_EOD); /* end of SHA1 */