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 */
167 if (ff_pkt->type == FT_NORECURSE) {
168 Jmsg(jcr, M_INFO, 1, _(" Recursion turned off. Will not descend into %s\n"),
170 } else if (ff_pkt->type == FT_NOFSCHG) {
171 Jmsg(jcr, M_INFO, 1, _(" File system change prohibited. 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);
232 if (ff_pkt->flags & FO_PORTABLE) {
233 set_portable_backup(&ff_pkt->bfd); /* disable Win32 BackupRead() */
235 if (ff_pkt->reader) {
236 set_prog(&ff_pkt->bfd, ff_pkt->reader, jcr);
240 * Open any file with data that we intend to save.
241 * Note, if is_win32_backup, we must open the Directory so that
242 * the BackupRead will save its permissions and ownership streams.
244 if (ff_pkt->type != FT_LNKSAVED && (S_ISREG(ff_pkt->statp.st_mode) &&
245 ff_pkt->statp.st_size > 0) ||
246 ff_pkt->type == FT_RAW || ff_pkt->type == FT_FIFO ||
247 (!is_portable_backup(&ff_pkt->bfd) && ff_pkt->type == FT_DIREND)) {
249 if (ff_pkt->type == FT_FIFO) {
250 tid = start_thread_timer(pthread_self(), 60);
254 if (bopen(&ff_pkt->bfd, ff_pkt->fname, O_RDONLY | O_BINARY, 0) < 0) {
255 ff_pkt->ff_errno = errno;
257 Jmsg(jcr, M_NOTSAVED, 0, _(" Cannot open %s: ERR=%s.\n"), ff_pkt->fname,
261 stop_thread_timer(tid);
267 stop_thread_timer(tid);
272 Dmsg1(130, "bfiled: sending %s to stored\n", ff_pkt->fname);
274 /* Find what data stream we will use, then encode the attributes */
275 data_stream = select_data_stream(ff_pkt);
276 encode_stat(attribs, ff_pkt, data_stream);
278 /* Now possibly extend the attributes */
279 attr_stream = encode_attribsEx(jcr, attribsEx, ff_pkt);
281 Dmsg3(300, "File %s\nattribs=%s\nattribsEx=%s\n", ff_pkt->fname, attribs, attribsEx);
284 jcr->JobFiles++; /* increment number of files sent */
285 ff_pkt->FileIndex = jcr->JobFiles; /* return FileIndex */
286 pm_strcpy(jcr->last_fname, ff_pkt->fname);
290 * Send Attributes header to Storage daemon
291 * <file-index> <stream> <info>
293 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, attr_stream)) {
295 if (is_bopen(&ff_pkt->bfd)) {
296 bclose(&ff_pkt->bfd);
298 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
302 Dmsg1(300, ">stored: attrhdr %s\n", sd->msg);
305 * Send file attributes to Storage daemon
308 * Filename (full path)
310 * Link name (if type==FT_LNK or FT_LNKSAVED)
311 * Encoded extended-attributes (for Win32)
313 * For a directory, link is the same as fname, but with trailing
314 * slash. For a linked file, link is the link.
316 if (ff_pkt->type == FT_LNK || ff_pkt->type == FT_LNKSAVED) {
317 Dmsg2(300, "Link %s to %s\n", ff_pkt->fname, ff_pkt->link);
318 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%s%c%s%c", jcr->JobFiles,
319 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, ff_pkt->link, 0,
321 } else if (ff_pkt->type == FT_DIREND) {
322 /* Here link is the canonical filename (i.e. with trailing slash) */
323 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
324 ff_pkt->type, ff_pkt->link, 0, attribs, 0, 0, attribsEx, 0);
326 stat = bnet_fsend(sd, "%ld %d %s%c%s%c%c%s%c", jcr->JobFiles,
327 ff_pkt->type, ff_pkt->fname, 0, attribs, 0, 0, attribsEx, 0);
330 Dmsg2(300, ">stored: attr len=%d: %s\n", sd->msglen, sd->msg);
333 if (is_bopen(&ff_pkt->bfd)) {
334 bclose(&ff_pkt->bfd);
336 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
340 bnet_sig(sd, BNET_EOD); /* indicate end of attributes data */
343 * If the file has data, read it and send to the Storage daemon
346 if (is_bopen(&ff_pkt->bfd)) {
347 uint64_t fileAddr = 0; /* file address */
349 int rsize = jcr->buf_size; /* read buffer size */
352 rbuf = sd->msg; /* read buffer */
353 wbuf = sd->msg; /* write buffer */
356 Dmsg1(300, "Saving data, type=%d\n", ff_pkt->type);
360 uLong compress_len, max_compress_len = 0;
361 const Bytef *cbuf = NULL;
363 if (ff_pkt->flags & FO_GZIP) {
364 if (ff_pkt->flags & FO_SPARSE) {
365 cbuf = (Bytef *)jcr->compress_buf + SPARSE_FADDR_SIZE;
366 max_compress_len = jcr->compress_buf_size - SPARSE_FADDR_SIZE;
368 cbuf = (Bytef *)jcr->compress_buf;
369 max_compress_len = jcr->compress_buf_size; /* set max length */
371 wbuf = jcr->compress_buf; /* compressed output here */
376 * Send Data header to Storage daemon
377 * <file-index> <stream> <info>
379 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, data_stream)) {
381 bclose(&ff_pkt->bfd);
382 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
386 Dmsg1(300, ">stored: datahdr %s\n", sd->msg);
388 if (ff_pkt->flags & FO_MD5) {
390 } else if (ff_pkt->flags & FO_SHA1) {
395 * Make space at beginning of buffer for fileAddr because this
396 * same buffer will be used for writing if compression if off.
398 if (ff_pkt->flags & FO_SPARSE) {
399 rbuf += SPARSE_FADDR_SIZE;
400 rsize -= SPARSE_FADDR_SIZE;
401 #ifdef HAVE_FREEBSD_OS
403 * To read FreeBSD partitions, the read size must be
406 rsize = (rsize/512) * 512;
413 while ((sd->msglen=(uint32_t)bread(&ff_pkt->bfd, rbuf, rsize)) > 0) {
416 /* Check for sparse blocks */
417 if (ff_pkt->flags & FO_SPARSE) {
419 if (sd->msglen == rsize &&
420 (fileAddr+sd->msglen < (uint64_t)ff_pkt->statp.st_size)) {
421 sparseBlock = is_buf_zero(rbuf, rsize);
424 ser_begin(wbuf, SPARSE_FADDR_SIZE);
425 ser_uint64(fileAddr); /* store fileAddr in begin of buffer */
428 jcr->ReadBytes += sd->msglen; /* count bytes read */
429 fileAddr += sd->msglen;
431 /* Update MD5 if requested */
432 if (ff_pkt->flags & FO_MD5) {
433 MD5Update(&md5c, (unsigned char *)rbuf, sd->msglen);
435 } else if (ff_pkt->flags & FO_SHA1) {
436 SHA1Update(&sha1c, (unsigned char *)rbuf, sd->msglen);
441 /* Do compression if turned on */
442 if (!sparseBlock && ff_pkt->flags & FO_GZIP) {
444 compress_len = max_compress_len;
445 Dmsg4(400, "cbuf=0x%x len=%u rbuf=0x%x len=%u\n", cbuf, compress_len,
447 /* NOTE! This call modifies compress_len !!! */
448 if ((zstat=compress2((Bytef *)cbuf, &compress_len,
449 (const Bytef *)rbuf, (uLong)sd->msglen,
450 ff_pkt->GZIP_level)) != Z_OK) {
451 Jmsg(jcr, M_FATAL, 0, _("Compression error: %d\n"), zstat);
454 bclose(&ff_pkt->bfd);
455 set_jcr_job_status(jcr, JS_ErrorTerminated);
458 Dmsg2(400, "compressed len=%d uncompressed len=%d\n",
459 compress_len, sd->msglen);
461 sd->msglen = compress_len; /* set compressed length */
465 /* Send the buffer to the Storage daemon */
467 if (ff_pkt->flags & FO_SPARSE) {
468 sd->msglen += SPARSE_FADDR_SIZE; /* include fileAddr in size */
470 sd->msg = wbuf; /* set correct write buffer */
471 if (!bnet_send(sd)) {
473 Jmsg2(jcr, M_FATAL, 0, _("Network send error %d to SD. ERR=%s\n"),
474 sd->msglen, bnet_strerror(sd));
475 sd->msg = msgsave; /* restore bnet buffer */
477 bclose(&ff_pkt->bfd);
481 Dmsg1(130, "Send data to SD len=%d\n", sd->msglen);
483 jcr->JobBytes += sd->msglen; /* count bytes saved possibly compressed */
484 sd->msg = msgsave; /* restore read buffer */
486 } /* end while read file data */
489 if (sd->msglen < 0) {
491 be.set_errno(ff_pkt->bfd.berrno);
492 Jmsg(jcr, M_ERROR, 0, _("Read error on file %s. ERR=%s\n"),
493 ff_pkt->fname, be.strerror());
496 bclose(&ff_pkt->bfd); /* close file */
497 if (!bnet_sig(sd, BNET_EOD)) { /* indicate end of file data */
499 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
507 if (ff_pkt->flags & FO_ACL) {
509 /* Read ACLs for files, dirs and links */
510 if (ff_pkt->type == FT_DIREND) {
511 /* Directory: Try for default ACL*/
512 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_DEFAULT);
514 Dmsg1(200, "No default ACL defined for directory: %s!\n", ff_pkt->fname);
515 /* If there is no default ACL get standard ACL */
516 myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
518 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of directory: %s!\n", ff_pkt->fname);
521 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
526 acl_t myAcl = acl_get_file(ff_pkt->fname, ACL_TYPE_ACCESS);
528 Jmsg1(jcr, M_WARNING, 0, "Error while trying to get ACL of file: %s!\n", ff_pkt->fname);
531 acl_text = acl_to_any_text(myAcl, NULL, ',', TEXT_ABBREVIATE);
535 /* If there is an ACL, send it to the Storage daemon */
537 sd = jcr->store_bsock;
538 pm_strcpy(&jcr->last_fname, ff_pkt->fname);
544 if (!bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_UNIX_ATTRIBUTES_ACL)) {
546 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
551 /* Send the buffer to the storage deamon */
554 sd->msglen = strlen(acl_text) + 1;
555 if (!bnet_send(sd)) {
559 bclose(&ff_pkt->bfd);
560 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
563 jcr->JobBytes += sd->msglen;
565 bclose(&ff_pkt->bfd);
566 if (!bnet_sig(sd, BNET_EOD)) {
568 Jmsg1(jcr, M_FATAL, 0, _("Network send error to SD. ERR=%s\n"),
571 Dmsg1(200, "ACL of file: %s successfully backed up!\n", ff_pkt->fname);
578 /* Terminate any MD5 signature and send it to Storage daemon and the Director */
579 if (gotMD5 && ff_pkt->flags & FO_MD5) {
580 MD5Final(signature, &md5c);
581 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_MD5_SIGNATURE);
582 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
583 memcpy(sd->msg, signature, 16);
586 bnet_sig(sd, BNET_EOD); /* end of MD5 */
589 } else if (gotSHA1 && ff_pkt->flags & FO_SHA1) {
590 /* Terminate any SHA1 signature and send it to Storage daemon and the Director */
591 SHA1Final(&sha1c, signature);
592 bnet_fsend(sd, "%ld %d 0", jcr->JobFiles, STREAM_SHA1_SIGNATURE);
593 Dmsg1(300, "bfiled>stored:header %s\n", sd->msg);
594 memcpy(sd->msg, signature, 20);
597 bnet_sig(sd, BNET_EOD); /* end of SHA1 */