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);
42 static int read_send_acl(JCR *jcr, BSOCK *sd, int acltype, int stream);
46 * Find all the requested files and send them
47 * to the Storage daemon.
49 * Note, we normally carry on a one-way
50 * conversation from this point on with the SD, simply blasting
51 * data to him. To properly know what is going on, we
52 * also run a "heartbeat" monitor which reads the socket and
53 * reacts accordingly (at the moment it has nothing to do
54 * except echo the heartbeat to the Director).
57 bool blast_data_to_storage_daemon(JCR *jcr, char *addr)
62 sd = jcr->store_bsock;
64 set_jcr_job_status(jcr, JS_Running);
66 Dmsg1(300, "bfiled: opened data connection %d to stored\n", sd->fd);
69 CLIENT *client = (CLIENT *)GetNextRes(R_CLIENT, NULL);
73 buf_size = client->max_network_buffer_size;
75 buf_size = 0; /* use default */
77 if (!bnet_set_buffer_size(sd, buf_size, BNET_SETBUF_WRITE)) {
78 set_jcr_job_status(jcr, JS_ErrorTerminated);
79 Jmsg(jcr, M_FATAL, 0, _("Cannot set buffer size FD->SD.\n"));
83 jcr->buf_size = sd->msglen;
84 /* Adjust for compression so that output buffer is
85 * 12 bytes + 0.1% larger than input buffer plus 18 bytes.
86 * This gives a bit extra plus room for the sparse addr if any.
87 * Note, we adjust the read size to be smaller so that the
88 * same output buffer can be used without growing it.
90 jcr->compress_buf_size = jcr->buf_size + ((jcr->buf_size+999) / 1000) + 30;
91 jcr->compress_buf = get_memory(jcr->compress_buf_size);
93 Dmsg1(300, "set_find_options ff=%p\n", jcr->ff);
94 set_find_options((FF_PKT *)jcr->ff, jcr->incremental, jcr->mtime);
95 Dmsg0(300, "start find files\n");
97 start_heartbeat_monitor(jcr);
99 /* Subroutine save_file() is called for each file */
100 if (!find_files(jcr, (FF_PKT *)jcr->ff, save_file, (void *)jcr)) {
101 ok = false; /* error */
102 set_jcr_job_status(jcr, JS_ErrorTerminated);
103 // Jmsg(jcr, M_FATAL, 0, _("Find files error.\n"));
106 stop_heartbeat_monitor(jcr);
108 bnet_sig(sd, BNET_EOD); /* end data connection */
114 if (jcr->compress_buf) {
115 free_pool_memory(jcr->compress_buf);
116 jcr->compress_buf = NULL;
118 Dmsg1(300, "end blast_data stat=%d\n", ok);
123 * Called here by find() for each file included.
125 * *****FIXME***** add FSMs File System Modules
127 * Send the file and its data to the Storage daemon.
131 * -1 to ignore file/directory (not used here)
133 static int save_file(FF_PKT *ff_pkt, void *vjcr)
135 char attribs[MAXSTRING];
136 char attribsEx[MAXSTRING];
137 int stat, attr_stream, data_stream;
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 */
170 Dmsg1(130, "FT_DIR saving: %s\n", ff_pkt->link);
173 Dmsg1(130, "FT_SPEC saving: %s\n", ff_pkt->fname);
176 Dmsg1(130, "FT_RAW saving: %s\n", ff_pkt->fname);
179 Dmsg1(130, "FT_FIFO saving: %s\n", ff_pkt->fname);
183 be.set_errno(ff_pkt->ff_errno);
184 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not access %s: ERR=%s\n"), ff_pkt->fname,
191 be.set_errno(ff_pkt->ff_errno);
192 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not follow link %s: ERR=%s\n"), ff_pkt->fname,
199 be.set_errno(ff_pkt->ff_errno);
200 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not stat %s: ERR=%s\n"), ff_pkt->fname,
207 Jmsg(jcr, M_SKIPPED, 1, _(" Unchanged file skipped: %s\n"), ff_pkt->fname);
210 Jmsg(jcr, M_NOTSAVED, 0, _(" Archive file not saved: %s\n"), ff_pkt->fname);
213 Jmsg(jcr, M_SKIPPED, 1, _(" Recursion turned off. Directory skipped: %s\n"),
217 Jmsg(jcr, M_SKIPPED, 1, _(" File system change prohibited. Directory skipped. %s\n"),
222 be.set_errno(ff_pkt->ff_errno);
223 Jmsg(jcr, M_NOTSAVED, 0, _(" Could not open directory %s: ERR=%s\n"), ff_pkt->fname,
229 Jmsg(jcr, M_NOTSAVED, 0, _(" Unknown file type %d; not saved: %s\n"), ff_pkt->type, ff_pkt->fname);
235 if (ff_pkt->flags & FO_PORTABLE) {
236 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
238 if (ff_pkt->reader) {
239 set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr);
243 * Open any file with data that we intend to save.
244 * Note, if is_win32_backup, we must open the Directory so that
245 * the BackupRead will save its permissions and ownership streams.
247 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
248 ff_pkt->statp.st_size > 0) ||
249 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
250 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
252 if (ff_pkt->type == FT_FIFO) {
253 tid = start_thread_timer(pthread_self(), 60);
257 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
258 ff_pkt->ff_errno = errno;
260 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
264 stop_thread_timer(tid);
270 stop_thread_timer(tid);
275 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
277 /* Find what data stream we will use, then encode the attributes */
278 data_stream = select_data_stream(ff_pkt);
279 encode_stat(attribs, ff_pkt, data_stream);
281 /* Now possibly extend the attributes */
282 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
284 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
287 jcr->JobFiles++; /* increment number of files sent */
288 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
289 pm_strcpy(jcr->last_fname, ff_pkt->fname);
293 * Send Attributes header to Storage daemon
294 * <file-index> <stream> <info>
296 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
298 if (is_bopen(&ff_pkt->bfd)) {
299 bclose(&ff_pkt->bfd);
301 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
305 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
308 * Send file attributes to Storage daemon
311 * Filename (full path)
313 * Link name (if type==FT_LNK or FT_LNKSAVED)
314 * Encoded extended-attributes (for Win32)
316 * For a directory, link is the same as fname, but with trailing
317 * slash. For a linked file, link is the link.
319 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
320 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
321 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
322 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
324 } else if (ff_pkt->type == FT_DIREND) {
325 /* Here link is the canonical filename (i.e. with trailing slash) */
326 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
327 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
329 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
330 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
333 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
336 if (is_bopen(&ff_pkt->bfd)) {
337 bclose(&ff_pkt->bfd);
339 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
343 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */
346 * If the file has data, read it and send to the Storage daemon
349 if (is_bopen(&ff_pkt->bfd)) {
350 uint64_t fileAddr = 0; /* file address */
352 int rsize = jcr->buf_size; /* read buffer size */
355 rbuf = sd->msg; /* read buffer */
356 wbuf = sd->msg; /* write buffer */
359 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
363 uLong compress_len, max_compress_len = 0;
364 const Bytef *cbuf = NULL;
366 if (ff_pkt->flags & FO_GZIP) {
367 if (ff_pkt->flags & FO_SPARSE) {
368 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
369 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
371 cbuf = (Bytef *)jcr->compress_buf;
372 max_compress_len = jcr->compress_buf_size; /* set max length */
374 wbuf = jcr->compress_buf; /* compressed output here */
379 * Send Data header to Storage daemon
380 * <file-index> <stream> <info>
382 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, data_stream)) {
384 bclose(&ff_pkt->bfd);
385 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
389 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
391 if (ff_pkt->flags & FO_MD5) {
393 } else if (ff_pkt->flags & FO_SHA1) {
398 * Make space at beginning of buffer for fileAddr because this
399 * same buffer will be used for writing if compression if off.
401 if (ff_pkt->flags & FO_SPARSE) {
402 rbuf += SPARSE_FADDR_SIZE;
403 rsize -= SPARSE_FADDR_SIZE;
404 #ifdef HAVE_FREEBSD_OS
406 * To read FreeBSD partitions, the read size must be
409 rsize = (rsize/512) * 512;
416 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
419 /* Check for sparse blocks */
420 if (ff_pkt->flags & FO_SPARSE) {
422 if (sd->msglen == rsize &&
423 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
424 sparseBlock = is_buf_zero(rbuf, rsize);
427 ser_begin(wbuf, SPARSE_FADDR_SIZE);
428 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
431 jcr->ReadBytes += sd->msglen; /* count bytes read */
432 fileAddr += sd->msglen;
434 /* Update MD5 if requested */
435 if (ff_pkt->flags & FO_MD5) {
436 MD5Update(&md5c, (unsigned char *)rbuf, sd->msglen);
438 } else if (ff_pkt->flags & FO_SHA1) {
439 SHA1Update(&sha1c, (unsigned char *)rbuf, sd->msglen);
444 /* Do compression if turned on */
445 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
447 compress_len = max_compress_len;
448 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
450 /* NOTE! This call modifies compress_len !!! */
451 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
452 (const Bytef *)rbuf, (uLong)sd->msglen,
453 ff_pkt->GZIP_level)) != Z_OK) {
454 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
457 bclose(&ff_pkt->bfd);
458 set_jcr_job_status(jcr, JS_ErrorTerminated);
461 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
462 compress_len, sd->msglen);
464 sd->msglen = compress_len; /* set compressed length */
468 /* Send the buffer to the Storage daemon */
470 if (ff_pkt->flags & FO_SPARSE) {
471 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
473 sd->msg = wbuf; /* set correct write buffer */
474 if (!bnet_send(sd)) {
476 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
477 sd->msglen, bnet_strerror(sd));
478 sd->msg = msgsave; /* restore bnet buffer */
480 bclose(&ff_pkt->bfd);
484 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
486 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
487 sd->msg = msgsave; /* restore read buffer */
489 } /* end while read file data */
492 if (sd->msglen < 0) {
494 be.set_errno(ff_pkt->bfd.berrno);
495 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
496 ff_pkt->fname, be.strerror());
499 bclose(&ff_pkt->bfd); /* close file */
500 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
502 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
510 if (ff_pkt->flags & FO_ACL) {
511 /* Storing of ACLs for Links is not needed, because: ACL of link == ACL of original */
512 if(ff_pkt->type != FT_LNK) {
513 /* Read access ACLs for files, dirs and links */
514 if (!read_send_acl(jcr, sd, ACL_TYPE_ACCESS, STREAM_UNIX_ATTRIBUTES_ACCESS_ACL)) {
517 /* Directories can have also default ACLs*/
518 if (ff_pkt->type == FT_DIREND) {
519 if (!read_send_acl(jcr, sd, ACL_TYPE_DEFAULT, STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL)) {
524 Dmsg1(200, "No need to store ACLs from Links!\n", jcr->last_fname);
530 /* Terminate any MD5 signature and send it to Storage daemon and the Director */
531 if (gotMD5 && ff_pkt->flags & FO_MD5) {
532 MD5Final(signature, &md5c);
533 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_MD5_SIGNATURE);
534 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
535 memcpy(sd->msg, signature, 16);
538 bnet_sig(sd, BNET_EOD); /* end of MD5 */
541 } else if (gotSHA1 && ff_pkt->flags & FO_SHA1) {
542 /* Terminate any SHA1 signature and send it to Storage daemon and the Director */
543 SHA1Final(&sha1c, signature);
544 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_SHA1_SIGNATURE);
545 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
546 memcpy(sd->msg, signature, 20);
549 bnet_sig(sd, BNET_EOD); /* end of SHA1 */
557 * Read and send an ACL for the last encountered file.
559 int read_send_acl(JCR *jcr, BSOCK *sd, int acltype, int stream)
562 char *acl_text = NULL;
565 /* Read access ACLs for files, dirs and links */
566 acl = acl_get_file(jcr->last_fname, acltype);
568 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of %s!\n", jcr->last_fname);
572 acl_text = acl_to_any_text(acl, NULL, ',', TEXT_ABBREVIATE);
574 /* Check if ACL is valid */
575 if ((acl_valid(acl) != 0) && (acltype != ACL_TYPE_DEFAULT)) {
576 Jmsg1(jcr, M_WARNING, 0, "Failure in the ACL of %s! FD is not able to back it up!\n", jcr->last_fname);
577 Dmsg1(200, "ACL of file/dir: %s is not valid!\n", jcr->last_fname);
578 Dmsg1(200, "ACL value=%s\n", acl_text);
579 } else if (acl_valid(acl) == 0) {
580 Dmsg1(200, "ACL of file/dir: %s is valid!\n", jcr->last_fname);
581 Dmsg1(200, "ACL value=%s\n", acl_text);
583 Dmsg1(200, "Directory: %s has no Default ACL, there is nothing to do from here!\n", jcr->last_fname);
589 if (acl_text == NULL) {
590 /* ***FIXME*** Can this happen? */
591 Jmsg1(jcr, M_WARNING, 0, "Error decoding ACL of %s!\n", jcr->last_fname);
595 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, stream)) {
597 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"), bnet_strerror(sd));
601 /* Send the buffer to the storage deamon */
604 sd->msglen = strlen(acl_text) + 1;
605 if (!bnet_send(sd)) {
609 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"), bnet_strerror(sd));
613 jcr->JobBytes += sd->msglen;
615 if (!bnet_sig(sd, BNET_EOD)) {
617 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"), bnet_strerror(sd));
621 Dmsg1(200, "ACL of file: %s successfully backed up!\n", jcr->last_fname);