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-2005 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,
33 /* Forward referenced functions */
34 static int save_file(FF_PKT *ff_pkt, void *pkt, bool top_level);
35 static int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, struct CHKSUM *chksum);
36 static bool encode_and_send_attributes(JCR *jcr, FF_PKT *ff_pkt, int &data_stream);
37 static bool read_and_send_acl(JCR *jcr, int acltype, int stream);
40 * Find all the requested files and send them
41 * to the Storage daemon.
43 * Note, we normally carry on a one-way
44 * conversation from this point on with the SD, simply blasting
45 * data to him. To properly know what is going on, we
46 * also run a "heartbeat" monitor which reads the socket and
47 * reacts accordingly (at the moment it has nothing to do
48 * except echo the heartbeat to the Director).
51 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
56 sd = jcr->store_bsock;
58 set_jcr_job_status(jcr, JS_Running);
60 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->fd);
63 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
67 buf_size = client->max_network_buffer_size;
69 buf_size = 0; /* use default */
71 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
72 set_jcr_job_status(jcr, JS_ErrorTerminated);
73 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
77 jcr->buf_size = sd->msglen;
78 /* Adjust for compression so that output buffer is
79 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
80 * This gives a bit extra plus room for the sparse addr if any.
81 * Note, we adjust the read size to be smaller so that the
82 * same output buffer can be used without growing it.
84 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
85 jcr->compress_buf = get_memory(jcr->compress_buf_size);
87 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
88 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
89 Dmsg0(300, "start find files\n");
91 start_heartbeat_monitor(jcr);
93 jcr->acl_text = get_pool_memory(PM_MESSAGE);
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 free_pool_memory(jcr->acl_text);
104 stop_heartbeat_monitor(jcr);
106 bnet_sig(sd, BNET_EOD); /* end data connection */
112 if (jcr->compress_buf) {
113 free_pool_memory(jcr->compress_buf);
114 jcr->compress_buf = NULL;
116 Dmsg1(300, "end blast_data stat=%d\n", ok);
121 * Called here by find() for each file included.
122 * This is a callback. The original is find_files() above.
124 * Send the file and its data to the Storage daemon.
128 * -1 to ignore file/directory (not used here)
130 static int save_file(FF_PKT *ff_pkt, void *vjcr, bool top_level)
132 int stat, data_stream;
133 struct CHKSUM chksum;
135 JCR *jcr = (JCR *)vjcr;
137 if (job_canceled(jcr)) {
141 sd = jcr->store_bsock;
142 jcr->num_files_examined++; /* bump total file count */
144 switch (ff_pkt->type) {
145 case FT_LNKSAVED: /* Hard linked, file already saved */
146 Dmsg2(130, "FT_LNKSAVED hard link: %s => %s\n", ff_pkt->fname, ff_pkt->link);
149 Dmsg1(130, "FT_REGE saving: %s\n", ff_pkt->fname);
152 Dmsg1(130, "FT_REG saving: %s\n", ff_pkt->fname);
155 Dmsg2(130, "FT_LNK saving: %s -> %s\n", ff_pkt->fname, ff_pkt->link);
158 return 1; /* not used */
163 if (ff_pkt->type == FT_NORECURSE) {
164 Jmsg(jcr, M_INFO, 1, _(" Recursion turned off. Will not descend into %s\n"),
166 } else if (ff_pkt->type == FT_NOFSCHG) {
167 Jmsg(jcr, M_INFO, 1, _(" File system change prohibited. Will not descend into %s\n"),
169 } else if (ff_pkt->type == FT_INVALIDFS) {
170 Jmsg(jcr, M_INFO, 1, _(" Disallowed filesystem. Will not descend into %s\n"),
173 ff_pkt->type = FT_DIREND; /* value is used below */
174 Dmsg1(130, "FT_DIR saving: %s\n", ff_pkt->link);
177 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
180 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
183 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
187 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
188 be.strerror(ff_pkt->ff_errno));
194 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not follow link %s: ERR=%s\n"), ff_pkt->fname,
195 be.strerror(ff_pkt->ff_errno));
201 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
202 be.strerror(ff_pkt->ff_errno));
208 Jmsg(jcr, M_SKIPPED, 1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
211 Jmsg(jcr, M_NOTSAVED, 0, _(" Archive file not saved: %s\n"), ff_pkt->fname);
215 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not open directory %s: ERR=%s\n"), ff_pkt->fname,
216 be.strerror(ff_pkt->ff_errno));
221 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"), ff_pkt->type, ff_pkt->fname);
226 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
228 if (!encode_and_send_attributes(jcr, ff_pkt, data_stream)) {
233 * Setup for signature handling.
234 * Then initialise the file descriptor we use for data and other streams.
236 chksum_init(&chksum, ff_pkt->flags);
239 if (ff_pkt->flags & FO_PORTABLE) {
240 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
242 if (ff_pkt->reader) {
243 set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr);
247 * Open any file with data that we intend to save, then save it.
249 * Note, if is_win32_backup, we must open the Directory so that
250 * the BackupRead will save its permissions and ownership streams.
252 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
253 ff_pkt->statp.st_size > 0) ||
254 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
255 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
257 if (ff_pkt->type == FT_FIFO) {
258 tid = start_thread_timer(pthread_self(), 60);
262 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
263 ff_pkt->ff_errno = errno;
265 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
269 stop_thread_timer(tid);
275 stop_thread_timer(tid);
278 stat = send_data(jcr, data_stream, ff_pkt, &chksum);
279 bclose(&ff_pkt->bfd);
285 #ifdef HAVE_DARWIN_OS
286 /* Regular files can have resource forks and Finder Info */
287 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
288 ff_pkt->flags & FO_HFSPLUS)) {
289 if (ff_pkt->hfsinfo.rsrclength > 0) {
291 if (!bopen_rsrc(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
292 ff_pkt->ff_errno = errno;
294 Jmsg(jcr, M_NOTSAVED, -1, _(" Cannot open resource fork for %s: ERR=%s.\n"), ff_pkt->fname,
297 if (is_bopen(&ff_pkt->bfd)) {
298 bclose(&ff_pkt->bfd);
302 flags = ff_pkt->flags;
303 ff_pkt->flags &= ~(FO_GZIP|FO_SPARSE);
304 stat = send_data(jcr, STREAM_MACOS_FORK_DATA, ff_pkt, &chksum);
305 ff_pkt->flags = flags;
306 bclose(&ff_pkt->bfd);
312 Dmsg1(300, "Saving Finder Info for \"%s\"\n", ff_pkt->fname);
313 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_HFSPLUS_ATTRIBUTES);
314 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
315 memcpy(sd->msg, ff_pkt->hfsinfo.fndrinfo, 32);
317 chksum_update(&chksum, (unsigned char *)sd->msg, sd->msglen);
319 bnet_sig(sd, BNET_EOD);
323 if (ff_pkt->flags & FO_ACL) {
324 /* Read access ACLs for files, dirs and links */
325 if (!read_and_send_acl(jcr, BACL_TYPE_ACCESS, STREAM_UNIX_ATTRIBUTES_ACCESS_ACL)) {
328 /* Directories can have default ACLs too */
329 if (ff_pkt->type == FT_DIREND && (BACL_CAP & BACL_CAP_DEFAULTS_DIR)) {
330 if (!read_and_send_acl(jcr, BACL_TYPE_DEFAULT, STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL)) {
336 /* Terminate any signature and send it to Storage daemon and the Director */
337 if (chksum.updated) {
339 chksum_final(&chksum);
340 if (chksum.type == CHKSUM_MD5) {
341 stream = STREAM_MD5_SIGNATURE;
342 } else if (chksum.type == CHKSUM_SHA1) {
343 stream = STREAM_SHA1_SIGNATURE;
345 Jmsg1(jcr, M_WARNING, 0, _("Unknown signature type %i.\n"), chksum.type);
348 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream);
349 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
350 memcpy(sd->msg, chksum.signature, chksum.length);
351 sd->msglen = chksum.length;
353 bnet_sig(sd, BNET_EOD); /* end of checksum */
361 * Send data read from an already open file descriptor.
363 * We return 1 on sucess and 0 on errors.
366 * We use ff_pkt->statp.st_size when FO_SPARSE.
367 * Currently this is not a problem as the only other stream, resource forks,
368 * are not handled as sparse files.
370 int send_data(JCR *jcr, int stream, FF_PKT *ff_pkt, struct CHKSUM *chksum)
372 BSOCK *sd = jcr->store_bsock;
373 uint64_t fileAddr = 0; /* file address */
375 int rsize = jcr->buf_size; /* read buffer size */
379 rbuf = sd->msg; /* read buffer */
380 wbuf = sd->msg; /* write buffer */
383 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
387 uLong compress_len, max_compress_len = 0;
388 const Bytef *cbuf = NULL;
390 if (ff_pkt->flags & FO_GZIP) {
391 if (ff_pkt->flags & FO_SPARSE) {
392 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
393 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
395 cbuf = (Bytef *)jcr->compress_buf;
396 max_compress_len = jcr->compress_buf_size; /* set max length */
398 wbuf = jcr->compress_buf; /* compressed output here */
403 * Send Data header to Storage daemon
404 * <file-index> <stream> <info>
406 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream)) {
407 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
411 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
414 * Make space at beginning of buffer for fileAddr because this
415 * same buffer will be used for writing if compression if off.
417 if (ff_pkt->flags & FO_SPARSE) {
418 rbuf += SPARSE_FADDR_SIZE;
419 rsize -= SPARSE_FADDR_SIZE;
420 #ifdef HAVE_FREEBSD_OS
422 * To read FreeBSD partitions, the read size must be
425 rsize = (rsize/512) * 512;
432 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
435 /* Check for sparse blocks */
436 if (ff_pkt->flags & FO_SPARSE) {
438 if (sd->msglen == rsize &&
439 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
440 sparseBlock = is_buf_zero(rbuf, rsize);
443 ser_begin(wbuf, SPARSE_FADDR_SIZE);
444 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
447 jcr->ReadBytes += sd->msglen; /* count bytes read */
448 fileAddr += sd->msglen;
450 /* Update checksum if requested */
451 chksum_update(chksum, (unsigned char *)rbuf, sd->msglen);
454 /* Do compression if turned on */
455 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
457 compress_len = max_compress_len;
458 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
460 /* NOTE! This call modifies compress_len !!! */
461 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
462 (const Bytef *)rbuf, (uLong)sd->msglen,
463 ff_pkt->GZIP_level)) != Z_OK) {
464 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
467 set_jcr_job_status(jcr, JS_ErrorTerminated);
470 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
471 compress_len, sd->msglen);
473 sd->msglen = compress_len; /* set compressed length */
477 /* Send the buffer to the Storage daemon */
479 if (ff_pkt->flags & FO_SPARSE) {
480 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
482 sd->msg = wbuf; /* set correct write buffer */
483 if (!bnet_send(sd)) {
484 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
485 sd->msglen, bnet_strerror(sd));
486 sd->msg = msgsave; /* restore bnet buffer */
491 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
493 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
494 sd->msg = msgsave; /* restore read buffer */
496 } /* end while read file data */
499 if (sd->msglen < 0) {
501 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
502 ff_pkt->fname, be.strerror(ff_pkt->bfd.berrno));
505 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
506 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
515 * Read and send an ACL for the last encountered file.
517 static bool read_and_send_acl(JCR *jcr, int acltype, int stream)
520 BSOCK *sd = jcr->store_bsock;
524 len = bacl_get(jcr, acltype);
526 Jmsg1(jcr, M_WARNING, 0, "Error reading ACL of %s\n", jcr->last_fname);
530 return true; /* no ACL */
534 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream)) {
535 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
540 /* Send the buffer to the storage deamon */
541 Dmsg2(400, "Backing up ACL type 0x%2x <%s>\n", acltype, jcr->acl_text);
543 sd->msg = jcr->acl_text;
544 sd->msglen = len + 1;
545 if (!bnet_send(sd)) {
548 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
553 jcr->JobBytes += sd->msglen;
555 if (!bnet_sig(sd, BNET_EOD)) {
556 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
561 Dmsg1(200, "ACL of file: %s successfully backed up!\n", jcr->last_fname);
566 static bool encode_and_send_attributes(JCR *jcr, FF_PKT *ff_pkt, int &data_stream)
568 BSOCK *sd = jcr->store_bsock;
569 char attribs[MAXSTRING];
570 char attribsEx[MAXSTRING];
573 #ifdef FD_NO_SEND_TEST
577 /* Find what data stream we will use, then encode the attributes */
578 data_stream = select_data_stream(ff_pkt);
579 encode_stat(attribs, ff_pkt, data_stream);
581 /* Now possibly extend the attributes */
582 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
584 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
587 jcr->JobFiles++; /* increment number of files sent */
588 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
589 pm_strcpy(jcr->last_fname, ff_pkt->fname);
593 * Send Attributes header to Storage daemon
594 * <file-index> <stream> <info>
596 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
597 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
601 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
604 * Send file attributes to Storage daemon
607 * Filename (full path)
609 * Link name (if type==FT_LNK or FT_LNKSAVED)
610 * Encoded extended-attributes (for Win32)
612 * For a directory, link is the same as fname, but with trailing
613 * slash. For a linked file, link is the link.
615 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
616 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
617 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
618 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
620 } else if (ff_pkt->type == FT_DIREND) {
621 /* Here link is the canonical filename (i.e. with trailing slash) */
622 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
623 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
625 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
626 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
629 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
631 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
635 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */