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
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);
39 static int send_data(int stream, FF_PKT *ff_pkt, BSOCK *sd, JCR *jcr, struct CHKSUM *chksum);
42 * Find all the requested files and send them
43 * to the Storage daemon.
45 * Note, we normally carry on a one-way
46 * conversation from this point on with the SD, simply blasting
47 * data to him. To properly know what is going on, we
48 * also run a "heartbeat" monitor which reads the socket and
49 * reacts accordingly (at the moment it has nothing to do
50 * except echo the heartbeat to the Director).
53 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
58 sd = jcr->store_bsock;
60 set_jcr_job_status(jcr, JS_Running);
62 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->fd);
65 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
69 buf_size = client->max_network_buffer_size;
71 buf_size = 0; /* use default */
73 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
74 set_jcr_job_status(jcr, JS_ErrorTerminated);
75 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
79 jcr->buf_size = sd->msglen;
80 /* Adjust for compression so that output buffer is
81 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
82 * This gives a bit extra plus room for the sparse addr if any.
83 * Note, we adjust the read size to be smaller so that the
84 * same output buffer can be used without growing it.
86 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
87 jcr->compress_buf = get_memory(jcr->compress_buf_size);
89 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
90 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
91 Dmsg0(300, "start find files\n");
93 start_heartbeat_monitor(jcr);
95 /* Subroutine save_file() is called for each file */
96 if (!find_files(jcr, (FF_PKT *)jcr->ff, save_file, (void *)jcr)) {
97 ok = false; /* error */
98 set_jcr_job_status(jcr, JS_ErrorTerminated);
99 // Jmsg(jcr, M_FATAL, 0, _("Find files error.\n"));
102 stop_heartbeat_monitor(jcr);
104 bnet_sig(sd, BNET_EOD); /* end data connection */
110 if (jcr->compress_buf) {
111 free_pool_memory(jcr->compress_buf);
112 jcr->compress_buf = NULL;
114 Dmsg1(300, "end blast_data stat=%d\n", ok);
119 * Called here by find() for each file included.
121 * *****FIXME***** add FSMs File System Modules
123 * Send the file and its data to the Storage daemon.
127 * -1 to ignore file/directory (not used here)
129 static int save_file(FF_PKT *ff_pkt, void *vjcr)
131 char attribs[MAXSTRING];
132 char attribsEx[MAXSTRING];
133 int stat, attr_stream, data_stream;
134 struct CHKSUM chksum;
136 JCR *jcr = (JCR *)vjcr;
138 if (job_canceled(jcr)) {
142 sd = jcr->store_bsock;
143 jcr->num_files_examined++; /* bump total file count */
145 switch (ff_pkt->type) {
146 case FT_LNKSAVED: /* Hard linked, file already saved */
147 Dmsg2(130, "FT_LNKSAVED hard link: %s => %s\n", ff_pkt->fname, ff_pkt->link);
150 Dmsg1(130, "FT_REGE saving: %s\n", ff_pkt->fname);
153 Dmsg1(130, "FT_REG saving: %s\n", ff_pkt->fname);
156 Dmsg2(130, "FT_LNK saving: %s -> %s\n", ff_pkt->fname, ff_pkt->link);
159 return 1; /* not used */
164 if (ff_pkt->type == FT_NORECURSE) {
165 Jmsg(jcr, M_INFO, 1, _(" Recursion turned off. Will not descend into %s\n"),
167 } else if (ff_pkt->type == FT_NOFSCHG) {
168 Jmsg(jcr, M_INFO, 1, _(" File system change prohibited. Will not descend into %s\n"),
170 } else if (ff_pkt->type == FT_INVALIDFS) {
171 Jmsg(jcr, M_INFO, 1, _(" Disallowed filesystem. Will not descend into %s\n"),
174 ff_pkt->type = FT_DIREND; /* value is used below */
175 Dmsg1(130, "FT_DIR saving: %s\n", ff_pkt->link);
178 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
181 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
184 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
188 be.set_errno(ff_pkt->ff_errno);
189 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
196 be.set_errno(ff_pkt->ff_errno);
197 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not follow link %s: ERR=%s\n"), ff_pkt->fname,
204 be.set_errno(ff_pkt->ff_errno);
205 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
212 Jmsg(jcr, M_SKIPPED, 1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
215 Jmsg(jcr, M_NOTSAVED, 0, _(" Archive file not saved: %s\n"), ff_pkt->fname);
219 be.set_errno(ff_pkt->ff_errno);
220 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not open directory %s: ERR=%s\n"), ff_pkt->fname,
226 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"), ff_pkt->type, ff_pkt->fname);
231 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
233 /* Find what data stream we will use, then encode the attributes */
234 data_stream = select_data_stream(ff_pkt);
235 encode_stat(attribs, ff_pkt, data_stream);
237 /* Now possibly extend the attributes */
238 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
240 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
243 jcr->JobFiles++; /* increment number of files sent */
244 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
245 pm_strcpy(jcr->last_fname, ff_pkt->fname);
249 * Send Attributes header to Storage daemon
250 * <file-index> <stream> <info>
252 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
254 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
258 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
261 * Send file attributes to Storage daemon
264 * Filename (full path)
266 * Link name (if type==FT_LNK or FT_LNKSAVED)
267 * Encoded extended-attributes (for Win32)
269 * For a directory, link is the same as fname, but with trailing
270 * slash. For a linked file, link is the link.
272 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
273 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
274 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
275 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
277 } else if (ff_pkt->type == FT_DIREND) {
278 /* Here link is the canonical filename (i.e. with trailing slash) */
279 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
280 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
282 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
283 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
286 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
289 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
293 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */
296 * Setup for signature handling.
297 * Then initialise the file descriptor we use for data and other streams.
299 chksum_init(&chksum, ff_pkt->flags);
302 if (ff_pkt->flags & FO_PORTABLE) {
303 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
305 if (ff_pkt->reader) {
306 set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr);
310 * Open any file with data that we intend to save, then save it.
312 * Note, if is_win32_backup, we must open the Directory so that
313 * the BackupRead will save its permissions and ownership streams.
315 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
316 ff_pkt->statp.st_size > 0) ||
317 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
318 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
320 if (ff_pkt->type == FT_FIFO) {
321 tid = start_thread_timer(pthread_self(), 60);
325 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
326 ff_pkt->ff_errno = errno;
328 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
332 stop_thread_timer(tid);
338 stop_thread_timer(tid);
341 stat = send_data(data_stream, ff_pkt, sd, jcr, &chksum);
342 bclose(&ff_pkt->bfd);
348 #ifdef HAVE_DARWIN_OS
349 /* Open resource fork if necessary and save content */
350 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
351 ff_pkt->flags & FO_HFSPLUS)) {
352 if (ff_pkt->hfsinfo.rsrclength > 0) {
354 if (!bopen_rsrc(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
355 ff_pkt->ff_errno = errno;
357 Jmsg(jcr, M_NOTSAVED, -1, _(" Cannot open resource fork for %s: ERR=%s.\n"), ff_pkt->fname,
360 if (is_bopen(&ff_pkt->bfd)) {
361 bclose(&ff_pkt->bfd);
365 flags = ff_pkt->flags;
366 ff_pkt->flags &= ~(FO_GZIP|FO_SPARSE);
367 stat = send_data(STREAM_MACOS_FORK_DATA, ff_pkt, sd, jcr, &chksum);
368 ff_pkt->flags = flags;
369 bclose(&ff_pkt->bfd);
375 Dmsg1(300, "Saving Finder Info for \"%s\"\n", ff_pkt->fname);
376 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_HFSPLUS_ATTRIBUTES);
377 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
378 memcpy(sd->msg, ff_pkt->hfsinfo.fndrinfo, 32);
380 chksum_update(&chksum, (unsigned char *)sd->msg, sd->msglen);
382 bnet_sig(sd, BNET_EOD);
389 if (ff_pkt->flags & FO_ACL) {
390 char *acl_text = NULL;
391 char *aclDef_text = NULL;
393 /* Read ACLs for files, dirs and links */
394 if (ff_pkt->type == FT_DIREND) {
395 /* Directory: Check for default ACL*/
396 acl_t myDefAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_DEFAULT);
397 /* Check for Access ACL */
398 acl_t myAccAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
399 if (!myDefAcl || !myAccAcl) {
400 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of directory: %s!\n", ff_pkt->fname);
403 aclDef_text = acl_to_any_text(myDefAcl, NULL, ',', TEXT_ABBREVIATE);
407 acl_text = acl_to_any_text(myAccAcl, NULL, ',', TEXT_ABBREVIATE);
412 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
414 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of file: %s!\n", ff_pkt->fname);
417 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
423 /* If there is an ACL, send it to the Storage daemon */
424 if (acl_text != NULL) {
425 sd = jcr->store_bsock;
426 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
430 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_UNIX_ATTRIBUTES_ACCESS_ACL)) {
432 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
437 /* Send the buffer to the storage deamon */
440 sd->msglen = strlen(acl_text) + 1;
441 if (!bnet_send(sd)) {
445 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
448 jcr->JobBytes += sd->msglen;
450 if (!bnet_sig(sd, BNET_EOD)) {
452 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
455 Dmsg1(200, "ACL of file: %s successfully backed up!\n", ff_pkt->fname);
459 /* If there is an Default ACL, send it to the Storage daemon */
460 if (aclDef_text != NULL) {
461 sd = jcr->store_bsock;
462 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
466 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL)) {
468 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
473 // Send the buffer to the storage deamon
475 sd->msg = aclDef_text;
476 sd->msglen = strlen(aclDef_text) + 1;
477 if (!bnet_send(sd)) {
481 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
484 jcr->JobBytes += sd->msglen;
486 if (!bnet_sig(sd, BNET_EOD)) {
488 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
491 Dmsg1(200, "ACL of file: %s successfully backed up!\n", ff_pkt->fname);
498 /* Terminate any signature and send it to Storage daemon and the Director */
499 if (chksum.updated) {
501 chksum_final(&chksum);
502 if (chksum.type == CHKSUM_MD5) {
503 stream = STREAM_MD5_SIGNATURE;
504 } else if (chksum.type == CHKSUM_SHA1) {
505 stream = STREAM_SHA1_SIGNATURE;
507 Jmsg1(jcr, M_WARNING, 0, _("Unknown signature type %i.\n"), chksum.type);
510 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream);
511 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
512 memcpy(sd->msg, chksum.signature, chksum.length);
513 sd->msglen = chksum.length;
515 bnet_sig(sd, BNET_EOD); /* end of checksum */
523 * Send data read from an already open file descriptor.
525 * We return 1 on sucess and 0 on errors.
528 * We use ff_pkt->statp.st_size when FO_SPARSE.
529 * Currently this is not a problem as the only other stream, resource forks,
530 * are not handled as sparse files.
532 int send_data(int stream, FF_PKT *ff_pkt, BSOCK *sd, JCR *jcr, struct CHKSUM *chksum)
534 uint64_t fileAddr = 0; /* file address */
536 int rsize = jcr->buf_size; /* read buffer size */
540 rbuf = sd->msg; /* read buffer */
541 wbuf = sd->msg; /* write buffer */
544 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
548 uLong compress_len, max_compress_len = 0;
549 const Bytef *cbuf = NULL;
551 if (ff_pkt->flags & FO_GZIP) {
552 if (ff_pkt->flags & FO_SPARSE) {
553 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
554 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
556 cbuf = (Bytef *)jcr->compress_buf;
557 max_compress_len = jcr->compress_buf_size; /* set max length */
559 wbuf = jcr->compress_buf; /* compressed output here */
564 * Send Data header to Storage daemon
565 * <file-index> <stream> <info>
567 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream)) {
568 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
572 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
575 * Make space at beginning of buffer for fileAddr because this
576 * same buffer will be used for writing if compression if off.
578 if (ff_pkt->flags & FO_SPARSE) {
579 rbuf += SPARSE_FADDR_SIZE;
580 rsize -= SPARSE_FADDR_SIZE;
581 #ifdef HAVE_FREEBSD_OS
583 * To read FreeBSD partitions, the read size must be
586 rsize = (rsize/512) * 512;
593 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
596 /* Check for sparse blocks */
597 if (ff_pkt->flags & FO_SPARSE) {
599 if (sd->msglen == rsize &&
600 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
601 sparseBlock = is_buf_zero(rbuf, rsize);
604 ser_begin(wbuf, SPARSE_FADDR_SIZE);
605 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
608 jcr->ReadBytes += sd->msglen; /* count bytes read */
609 fileAddr += sd->msglen;
611 /* Update checksum if requested */
612 chksum_update(chksum, (unsigned char *)rbuf, sd->msglen);
615 /* Do compression if turned on */
616 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
618 compress_len = max_compress_len;
619 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
621 /* NOTE! This call modifies compress_len !!! */
622 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
623 (const Bytef *)rbuf, (uLong)sd->msglen,
624 ff_pkt->GZIP_level)) != Z_OK) {
625 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
628 set_jcr_job_status(jcr, JS_ErrorTerminated);
631 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
632 compress_len, sd->msglen);
634 sd->msglen = compress_len; /* set compressed length */
638 /* Send the buffer to the Storage daemon */
640 if (ff_pkt->flags & FO_SPARSE) {
641 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
643 sd->msg = wbuf; /* set correct write buffer */
644 if (!bnet_send(sd)) {
646 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
647 sd->msglen, bnet_strerror(sd));
648 sd->msg = msgsave; /* restore bnet buffer */
653 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
655 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
656 sd->msg = msgsave; /* restore read buffer */
658 } /* end while read file data */
661 if (sd->msglen < 0) {
663 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
664 ff_pkt->fname, be.strerror(ff_pkt->bfd.berrno));
667 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
668 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),