2 Copyright (C) 2000-2004 Kern Sibbald and John Walker
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License as
6 published by the Free Software Foundation; either version 2 of
7 the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 General Public License for more details.
14 You should have received a copy of the GNU General Public
15 License along with this program; if not, write to the Free
16 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 This file is based on GNU TAR source code. Except for a few key
20 ideas, it has been rewritten for Bacula.
24 Thanks to the TAR programmers.
31 extern int32_t name_max; /* filename max length */
32 extern int32_t path_max; /* path name max length */
35 * Structure for keeping track of hard linked files, we
36 * keep an entry for each hardlinked file that we save,
37 * which is the first one found. For all the other files that
38 * are linked to this one, we save only the directory
39 * entry so we can link it.
43 dev_t dev; /* device */
44 ino_t ino; /* inode with device is unique */
46 uint32_t FileIndex; /* Bacula FileIndex of this file */
47 char name[1]; /* The name */
50 static void free_dir_ff_pkt(FF_PKT *dir_ff_pkt)
52 free(dir_ff_pkt->fname);
53 free(dir_ff_pkt->link);
54 free_pool_memory(dir_ff_pkt->sys_fname);
60 * handle_file is the callback for handling the file.
62 * parent_device is the device we are currently on
63 * top_level is 1 when not recursing or 0 when
64 * decending into a directory.
67 find_one_file(JCR *jcr, FF_PKT *ff_pkt, int handle_file(FF_PKT *ff, void *hpkt),
68 void *pkt, char *fname, dev_t parent_device, int top_level)
70 struct utimbuf restore_times;
73 ff_pkt->fname = ff_pkt->link = fname;
75 if (lstat(fname, &ff_pkt->statp) != 0) {
76 /* Cannot stat file */
77 ff_pkt->type = FT_NOSTAT;
78 ff_pkt->ff_errno = errno;
79 return handle_file(ff_pkt, pkt);
82 Dmsg1(300, "File ----: %s\n", fname);
84 /* Save current times of this directory in case we need to
85 * reset them because the user doesn't want them changed.
87 restore_times.actime = ff_pkt->statp.st_atime;
88 restore_times.modtime = ff_pkt->statp.st_mtime;
92 * If this is an Incremental backup, see if file was modified
93 * since our last "save_time", presumably the last Full save
96 if (ff_pkt->incremental && !S_ISDIR(ff_pkt->statp.st_mode)) {
97 Dmsg1(300, "Non-directory incremental: %s\n", ff_pkt->fname);
99 if (ff_pkt->statp.st_mtime < ff_pkt->save_time
100 && ((ff_pkt->flags & FO_MTIMEONLY) ||
101 ff_pkt->statp.st_ctime < ff_pkt->save_time)) {
102 /* Incremental option, file not changed */
103 ff_pkt->type = FT_NOCHG;
104 return handle_file(ff_pkt, pkt);
108 /* ***FIXME*** implement this */
110 /* See if we are trying to dump the archive. */
111 if (ar_dev && ff_pkt->statp.st_dev == ar_dev && ff_pkt->statp.st_ino == ar_ino) {
112 ff_pkt->type = FT_ISARCH;
113 return handle_file(ff_pkt, pkt);
118 * Handle hard linked files
120 * Maintain a list of hard linked files already backed up. This
121 * allows us to ensure that the data of each file gets backed
124 if (ff_pkt->statp.st_nlink > 1
125 && (S_ISREG(ff_pkt->statp.st_mode)
126 || S_ISCHR(ff_pkt->statp.st_mode)
127 || S_ISBLK(ff_pkt->statp.st_mode)
128 || S_ISFIFO(ff_pkt->statp.st_mode)
129 || S_ISSOCK(ff_pkt->statp.st_mode))) {
133 /* Search link list of hard linked files */
134 for (lp = ff_pkt->linklist; lp; lp = lp->next)
135 if (lp->ino == (ino_t)ff_pkt->statp.st_ino &&
136 lp->dev == (dev_t)ff_pkt->statp.st_dev) {
137 /* If we have already backed up the hard linked file don't do it again */
138 if (strcmp(lp->name, fname) == 0) {
139 Jmsg1(jcr, M_WARNING, 0, _("Attempt to backup hard linked file %s twice ignored.\n"),
141 return 1; /* ignore */
143 ff_pkt->link = lp->name;
144 ff_pkt->type = FT_LNKSAVED; /* Handle link, file already saved */
145 ff_pkt->LinkFI = lp->FileIndex;
146 return handle_file(ff_pkt, pkt);
149 /* File not previously dumped. Chain it into our list. */
150 lp = (struct f_link *)bmalloc(sizeof(struct f_link) + strlen(fname) +1);
151 lp->ino = ff_pkt->statp.st_ino;
152 lp->dev = ff_pkt->statp.st_dev;
153 strcpy(lp->name, fname);
154 lp->next = ff_pkt->linklist;
155 ff_pkt->linklist = lp;
156 ff_pkt->linked = lp; /* mark saved link */
158 ff_pkt->linked = NULL;
161 /* This is not a link to a previously dumped file, so dump it. */
162 if (S_ISREG(ff_pkt->statp.st_mode)) {
165 sizeleft = ff_pkt->statp.st_size;
167 /* Don't bother opening empty, world readable files. Also do not open
168 files when archive is meant for /dev/null. */
169 if (ff_pkt->null_output_device || (sizeleft == 0
170 && MODE_RALL == (MODE_RALL & ff_pkt->statp.st_mode))) {
171 ff_pkt->type = FT_REGE;
173 ff_pkt->type = FT_REG;
175 rtn_stat = handle_file(ff_pkt, pkt);
176 if (ff_pkt->linked) {
177 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
182 } else if (S_ISLNK(ff_pkt->statp.st_mode)) { /* soft link */
184 char *buffer = (char *)alloca(path_max + name_max + 102);
186 size = readlink(fname, buffer, path_max + name_max + 101);
188 /* Could not follow link */
189 ff_pkt->type = FT_NOFOLLOW;
190 ff_pkt->ff_errno = errno;
191 rtn_stat = handle_file(ff_pkt, pkt);
192 if (ff_pkt->linked) {
193 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
198 ff_pkt->link = buffer; /* point to link */
199 ff_pkt->type = FT_LNK; /* got a real link */
200 rtn_stat = handle_file(ff_pkt, pkt);
201 if (ff_pkt->linked) {
202 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
206 } else if (S_ISDIR(ff_pkt->statp.st_mode)) {
208 struct dirent *entry, *result;
213 dev_t our_device = ff_pkt->statp.st_dev;
216 * If we are using Win32 (non-portable) backup API, don't check
217 * access as everything is more complicated, and
218 * in principle, we should be able to access everything.
220 if (!have_win32_api() || (ff_pkt->flags & FO_PORTABLE)) {
221 if (access(fname, R_OK) == -1 && geteuid() != 0) {
222 /* Could not access() directory */
223 ff_pkt->type = FT_NOACCESS;
224 ff_pkt->ff_errno = errno;
225 rtn_stat = handle_file(ff_pkt, pkt);
226 if (ff_pkt->linked) {
227 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
233 /* Build a canonical directory name with a trailing slash in link var */
235 link_len = len + 200;
236 link = (char *)bmalloc(link_len + 2);
237 bstrncpy(link, fname, link_len);
238 /* Strip all trailing slashes */
239 while (len >= 1 && link[len - 1] == '/')
241 link[len++] = '/'; /* add back one */
245 if (ff_pkt->incremental &&
246 (ff_pkt->statp.st_mtime < ff_pkt->save_time &&
247 ff_pkt->statp.st_ctime < ff_pkt->save_time)) {
248 /* Incremental option, directory entry not changed */
249 ff_pkt->type = FT_DIRNOCHG;
251 ff_pkt->type = FT_DIRBEGIN;
253 /* Send off Directory packet now */
254 if (!handle_file(ff_pkt, pkt)) {
256 return 0; /* Do not save this directory */
258 if (ff_pkt->type == FT_DIRBEGIN) {
259 ff_pkt->type = FT_DIREND;
263 * Create a temporary ff packet for this directory
264 * entry, and defer handling the directory until
265 * we have recursed into it. This saves the
266 * directory after all files have been processed, and
267 * during the restore, the directory permissions will
268 * be reset after all the files have been restored.
270 Dmsg1(300, "Create temp ff packet for dir: %s\n", ff_pkt->fname);
271 FF_PKT *dir_ff_pkt = (FF_PKT *)bmalloc(sizeof(FF_PKT));
272 memcpy(dir_ff_pkt, ff_pkt, sizeof(FF_PKT));
273 dir_ff_pkt->fname = bstrdup(ff_pkt->fname);
274 dir_ff_pkt->link = bstrdup(ff_pkt->link);
275 dir_ff_pkt->sys_fname = get_pool_memory(PM_FNAME);
276 dir_ff_pkt->included_files_list = NULL;
277 dir_ff_pkt->excluded_files_list = NULL;
278 dir_ff_pkt->excluded_paths_list = NULL;
279 dir_ff_pkt->linklist = NULL;
281 ff_pkt->link = ff_pkt->fname; /* reset "link" */
284 * Do not decend into subdirectories (recurse) if the
285 * user has turned it off for this directory.
287 if (ff_pkt->flags & FO_NO_RECURSION) {
288 /* No recursion into this directory */
289 ff_pkt->type = FT_NORECURSE;
290 rtn_stat = handle_file(ff_pkt, pkt);
291 if (ff_pkt->linked) {
292 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
295 free_dir_ff_pkt(dir_ff_pkt);
300 * See if we are crossing file systems, and
301 * avoid doing so if the user only wants to dump one file system.
303 if (!top_level && !(ff_pkt->flags & FO_MULTIFS) &&
304 parent_device != ff_pkt->statp.st_dev) {
305 /* returning here means we do not handle this directory */
306 ff_pkt->type = FT_NOFSCHG;
307 rtn_stat = handle_file(ff_pkt, pkt);
308 if (ff_pkt->linked) {
309 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
312 free_dir_ff_pkt(dir_ff_pkt);
316 * Decend into or "recurse" into the directory to read
317 * all the files in it.
320 if ((directory = opendir(fname)) == NULL) {
321 ff_pkt->type = FT_NOOPEN;
322 ff_pkt->ff_errno = errno;
323 rtn_stat = handle_file(ff_pkt, pkt);
324 if (ff_pkt->linked) {
325 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
328 free_dir_ff_pkt(dir_ff_pkt);
333 * Process all files in this directory entry (recursing).
334 * This would possibly run faster if we chdir to the directory
335 * before traversing it.
338 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 100);
339 for ( ; !job_canceled(jcr); ) {
343 status = readdir_r(directory, entry, &result);
344 if (status != 0 || result == NULL) {
345 // Dmsg2(99, "readdir returned stat=%d result=0x%x\n",
346 // status, (long)result);
349 ASSERT(name_max+1 > (int)sizeof(struct dirent) + (int)NAMELEN(entry));
351 /* Skip `.', `..', and excluded file names. */
352 if (p[0] == '\0' || (p[0] == '.' && (p[1] == '\0' ||
353 (p[1] == '.' && p[2] == '\0')))) {
357 if ((int)NAMELEN(entry) + len >= link_len) {
358 link_len = len + NAMELEN(entry) + 1;
359 link = (char *)brealloc(link, link_len + 1);
362 for (i=0; i < (int)NAMELEN(entry); i++) {
366 if (!file_is_excluded(ff_pkt, link)) {
367 rtn_stat = find_one_file(jcr, ff_pkt, handle_file, pkt, link, our_device, 0);
368 if (ff_pkt->linked) {
369 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
378 * Now that we have recursed through all the files in the
379 * directory, we "save" the directory so that after all
380 * the files are restored, this entry will serve to reset
381 * the directory modes and dates. Temp directory values
382 * were used without this record.
384 handle_file(dir_ff_pkt, pkt); /* handle directory entry */
385 if (ff_pkt->linked) {
386 ff_pkt->linked->FileIndex = dir_ff_pkt->FileIndex;
388 free_dir_ff_pkt(dir_ff_pkt);
390 if (ff_pkt->flags & FO_KEEPATIME) {
391 utime(fname, &restore_times);
394 } /* end check for directory */
397 * If it is explicitly mentioned (i.e. top_level) and is
398 * a block device, we do a raw backup of it or if it is
399 * a fifo, we simply read it.
401 #ifdef HAVE_FREEBSD_OS
403 * On FreeBSD, all block devices are character devices, so
404 * to be able to read a raw disk, we need the check for
405 * a character device.
406 * crw-r----- 1 root operator - 116, 0x00040002 Jun 9 19:32 /dev/ad0s3
407 * crw-r----- 1 root operator - 116, 0x00040002 Jun 9 19:32 /dev/rad0s3
409 if (top_level && (S_ISBLK(ff_pkt->statp.st_mode) || S_ISCHR(ff_pkt->statp.st_mode))) {
411 if (top_level && S_ISBLK(ff_pkt->statp.st_mode)) {
413 ff_pkt->type = FT_RAW; /* raw partition */
414 } else if (top_level && S_ISFIFO(ff_pkt->statp.st_mode) &&
415 ff_pkt->flags & FO_READFIFO) {
416 ff_pkt->type = FT_FIFO;
418 /* The only remaining types are special (character, ...) files */
419 ff_pkt->type = FT_SPEC;
421 rtn_stat = handle_file(ff_pkt, pkt);
422 if (ff_pkt->linked) {
423 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
428 int term_find_one(FF_PKT *ff)
430 struct f_link *lp, *lc;
433 /* Free up list of hard linked files */
434 for (lp = ff->linklist; lp;) {