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->flags & FO_NO_HARDLINK)
125 && ff_pkt->statp.st_nlink > 1
126 && (S_ISREG(ff_pkt->statp.st_mode)
127 || S_ISCHR(ff_pkt->statp.st_mode)
128 || S_ISBLK(ff_pkt->statp.st_mode)
129 || S_ISFIFO(ff_pkt->statp.st_mode)
130 || S_ISSOCK(ff_pkt->statp.st_mode))) {
134 /* Search link list of hard linked files */
135 for (lp = ff_pkt->linklist; lp; lp = lp->next)
136 if (lp->ino == (ino_t)ff_pkt->statp.st_ino &&
137 lp->dev == (dev_t)ff_pkt->statp.st_dev) {
138 /* If we have already backed up the hard linked file don't do it again */
139 if (strcmp(lp->name, fname) == 0) {
140 Jmsg1(jcr, M_WARNING, 0, _("Attempt to backup hard linked file %s twice ignored.\n"),
142 return 1; /* ignore */
144 ff_pkt->link = lp->name;
145 ff_pkt->type = FT_LNKSAVED; /* Handle link, file already saved */
146 ff_pkt->LinkFI = lp->FileIndex;
147 return handle_file(ff_pkt, pkt);
150 /* File not previously dumped. Chain it into our list. */
151 lp = (struct f_link *)bmalloc(sizeof(struct f_link) + strlen(fname) +1);
152 lp->ino = ff_pkt->statp.st_ino;
153 lp->dev = ff_pkt->statp.st_dev;
154 strcpy(lp->name, fname);
155 lp->next = ff_pkt->linklist;
156 ff_pkt->linklist = lp;
157 ff_pkt->linked = lp; /* mark saved link */
159 ff_pkt->linked = NULL;
162 /* This is not a link to a previously dumped file, so dump it. */
163 if (S_ISREG(ff_pkt->statp.st_mode)) {
166 sizeleft = ff_pkt->statp.st_size;
168 /* Don't bother opening empty, world readable files. Also do not open
169 files when archive is meant for /dev/null. */
170 if (ff_pkt->null_output_device || (sizeleft == 0
171 && MODE_RALL == (MODE_RALL & ff_pkt->statp.st_mode))) {
172 ff_pkt->type = FT_REGE;
174 ff_pkt->type = FT_REG;
176 rtn_stat = handle_file(ff_pkt, pkt);
177 if (ff_pkt->linked) {
178 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
183 } else if (S_ISLNK(ff_pkt->statp.st_mode)) { /* soft link */
185 char *buffer = (char *)alloca(path_max + name_max + 102);
187 size = readlink(fname, buffer, path_max + name_max + 101);
189 /* Could not follow link */
190 ff_pkt->type = FT_NOFOLLOW;
191 ff_pkt->ff_errno = errno;
192 rtn_stat = handle_file(ff_pkt, pkt);
193 if (ff_pkt->linked) {
194 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
199 ff_pkt->link = buffer; /* point to link */
200 ff_pkt->type = FT_LNK; /* got a real link */
201 rtn_stat = handle_file(ff_pkt, pkt);
202 if (ff_pkt->linked) {
203 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
207 } else if (S_ISDIR(ff_pkt->statp.st_mode)) {
209 struct dirent *entry, *result;
214 dev_t our_device = ff_pkt->statp.st_dev;
217 * If we are using Win32 (non-portable) backup API, don't check
218 * access as everything is more complicated, and
219 * in principle, we should be able to access everything.
221 if (!have_win32_api() || (ff_pkt->flags & FO_PORTABLE)) {
222 if (access(fname, R_OK) == -1 && geteuid() != 0) {
223 /* Could not access() directory */
224 ff_pkt->type = FT_NOACCESS;
225 ff_pkt->ff_errno = errno;
226 rtn_stat = handle_file(ff_pkt, pkt);
227 if (ff_pkt->linked) {
228 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
234 /* Build a canonical directory name with a trailing slash in link var */
236 link_len = len + 200;
237 link = (char *)bmalloc(link_len + 2);
238 bstrncpy(link, fname, link_len);
239 /* Strip all trailing slashes */
240 while (len >= 1 && link[len - 1] == '/')
242 link[len++] = '/'; /* add back one */
246 if (ff_pkt->incremental &&
247 (ff_pkt->statp.st_mtime < ff_pkt->save_time &&
248 ff_pkt->statp.st_ctime < ff_pkt->save_time)) {
249 /* Incremental option, directory entry not changed */
250 ff_pkt->type = FT_DIRNOCHG;
252 ff_pkt->type = FT_DIRBEGIN;
255 * Note, we return the directory to the calling program (handle_file)
256 * when we first see the directory (FT_DIRBEGIN.
257 * This allows the program to apply matches and make a
258 * choice whether or not to accept it. If it is accepted, we
259 * do not immediately save it, but do so only after everything
260 * in the directory is seen (i.e. the FT_DIREND).
262 rtn_stat = handle_file(ff_pkt, pkt);
263 if (rtn_stat < 1) { /* ignore or error status */
267 /* Done with DIRBEGIN, next call will be DIREND */
268 if (ff_pkt->type == FT_DIRBEGIN) {
269 ff_pkt->type = FT_DIREND;
273 * Create a temporary ff packet for this directory
274 * entry, and defer handling the directory until
275 * we have recursed into it. This saves the
276 * directory after all files have been processed, and
277 * during the restore, the directory permissions will
278 * be reset after all the files have been restored.
280 Dmsg1(300, "Create temp ff packet for dir: %s\n", ff_pkt->fname);
281 FF_PKT *dir_ff_pkt = (FF_PKT *)bmalloc(sizeof(FF_PKT));
282 memcpy(dir_ff_pkt, ff_pkt, sizeof(FF_PKT));
283 dir_ff_pkt->fname = bstrdup(ff_pkt->fname);
284 dir_ff_pkt->link = bstrdup(ff_pkt->link);
285 dir_ff_pkt->sys_fname = get_pool_memory(PM_FNAME);
286 dir_ff_pkt->included_files_list = NULL;
287 dir_ff_pkt->excluded_files_list = NULL;
288 dir_ff_pkt->excluded_paths_list = NULL;
289 dir_ff_pkt->linklist = NULL;
291 ff_pkt->link = ff_pkt->fname; /* reset "link" */
294 * Do not decend into subdirectories (recurse) if the
295 * user has turned it off for this directory.
297 if (ff_pkt->flags & FO_NO_RECURSION) {
298 /* No recursion into this directory */
299 ff_pkt->type = FT_NORECURSE;
300 rtn_stat = handle_file(ff_pkt, pkt);
301 if (ff_pkt->linked) {
302 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
305 free_dir_ff_pkt(dir_ff_pkt);
310 * See if we are crossing file systems, and
311 * avoid doing so if the user only wants to dump one file system.
313 if (!top_level && !(ff_pkt->flags & FO_MULTIFS) &&
314 parent_device != ff_pkt->statp.st_dev) {
315 /* returning here means we do not handle this directory */
316 ff_pkt->type = FT_NOFSCHG;
317 rtn_stat = handle_file(ff_pkt, pkt);
318 if (ff_pkt->linked) {
319 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
322 free_dir_ff_pkt(dir_ff_pkt);
326 * Decend into or "recurse" into the directory to read
327 * all the files in it.
330 if ((directory = opendir(fname)) == NULL) {
331 ff_pkt->type = FT_NOOPEN;
332 ff_pkt->ff_errno = errno;
333 rtn_stat = handle_file(ff_pkt, pkt);
334 if (ff_pkt->linked) {
335 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
338 free_dir_ff_pkt(dir_ff_pkt);
343 * Process all files in this directory entry (recursing).
344 * This would possibly run faster if we chdir to the directory
345 * before traversing it.
348 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 100);
349 for ( ; !job_canceled(jcr); ) {
353 status = readdir_r(directory, entry, &result);
354 if (status != 0 || result == NULL) {
355 // Dmsg2(99, "readdir returned stat=%d result=0x%x\n",
356 // status, (long)result);
359 ASSERT(name_max+1 > (int)sizeof(struct dirent) + (int)NAMELEN(entry));
361 /* Skip `.', `..', and excluded file names. */
362 if (p[0] == '\0' || (p[0] == '.' && (p[1] == '\0' ||
363 (p[1] == '.' && p[2] == '\0')))) {
367 if ((int)NAMELEN(entry) + len >= link_len) {
368 link_len = len + NAMELEN(entry) + 1;
369 link = (char *)brealloc(link, link_len + 1);
372 for (i=0; i < (int)NAMELEN(entry); i++) {
376 if (!file_is_excluded(ff_pkt, link)) {
377 rtn_stat = find_one_file(jcr, ff_pkt, handle_file, pkt, link, our_device, 0);
378 if (ff_pkt->linked) {
379 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
388 * Now that we have recursed through all the files in the
389 * directory, we "save" the directory so that after all
390 * the files are restored, this entry will serve to reset
391 * the directory modes and dates. Temp directory values
392 * were used without this record.
394 handle_file(dir_ff_pkt, pkt); /* handle directory entry */
395 if (ff_pkt->linked) {
396 ff_pkt->linked->FileIndex = dir_ff_pkt->FileIndex;
398 free_dir_ff_pkt(dir_ff_pkt);
400 if (ff_pkt->flags & FO_KEEPATIME) {
401 utime(fname, &restore_times);
404 } /* end check for directory */
407 * If it is explicitly mentioned (i.e. top_level) and is
408 * a block device, we do a raw backup of it or if it is
409 * a fifo, we simply read it.
411 #ifdef HAVE_FREEBSD_OS
413 * On FreeBSD, all block devices are character devices, so
414 * to be able to read a raw disk, we need the check for
415 * a character device.
416 * crw-r----- 1 root operator - 116, 0x00040002 Jun 9 19:32 /dev/ad0s3
417 * crw-r----- 1 root operator - 116, 0x00040002 Jun 9 19:32 /dev/rad0s3
419 if (top_level && (S_ISBLK(ff_pkt->statp.st_mode) || S_ISCHR(ff_pkt->statp.st_mode))) {
421 if (top_level && S_ISBLK(ff_pkt->statp.st_mode)) {
423 ff_pkt->type = FT_RAW; /* raw partition */
424 } else if (top_level && S_ISFIFO(ff_pkt->statp.st_mode) &&
425 ff_pkt->flags & FO_READFIFO) {
426 ff_pkt->type = FT_FIFO;
428 /* The only remaining types are special (character, ...) files */
429 ff_pkt->type = FT_SPEC;
431 rtn_stat = handle_file(ff_pkt, pkt);
432 if (ff_pkt->linked) {
433 ff_pkt->linked->FileIndex = ff_pkt->FileIndex;
438 int term_find_one(FF_PKT *ff)
440 struct f_link *lp, *lc;
443 /* Free up list of hard linked files */
444 for (lp = ff->linklist; lp;) {