2 * Main routine for finding files on a file system.
3 * The heart of the work is done in find_one.c
8 Copyright (C) 2000-2003 Kern Sibbald and John Walker
10 This program is free software; you can redistribute it and/or
11 modify it under the terms of the GNU General Public License as
12 published by the Free Software Foundation; either version 2 of
13 the License, or (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU General Public
21 License along with this program; if not, write to the Free
22 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 int32_t name_max; /* filename max length */
33 int32_t path_max; /* path name max length */
36 /* ****FIXME**** debug until stable */
38 #define bmalloc(x) sm_malloc(__FILE__, __LINE__, x)
39 static void set_options(FF_PKT *ff, const char *opts);
43 * Initialize the find files "global" variables
45 FF_PKT *init_find_files()
49 ff = (FF_PKT *)bmalloc(sizeof(FF_PKT));
50 memset(ff, 0, sizeof(FF_PKT));
52 ff->sys_fname = get_pool_memory(PM_FNAME);
54 init_include_exclude_files(ff); /* init lists */
56 /* Get system path and filename maximum lengths */
57 path_max = pathconf(".", _PC_PATH_MAX);
58 if (path_max < 1024) {
62 name_max = pathconf(".", _PC_NAME_MAX);
63 if (name_max < 1024) {
66 path_max++; /* add for EOS */
67 name_max++; /* add for EOS */
69 Dmsg1(100, "init_find_files ff=%p\n", ff);
74 * Set find_files options. For the moment, we only
75 * provide for full/incremental saves, and setting
76 * of save_time. For additional options, see above
79 set_find_options(FF_PKT *ff, int incremental, time_t save_time)
81 Dmsg0(100, "Enter set_find_options()\n");
82 ff->incremental = incremental;
83 ff->save_time = save_time;
84 Dmsg0(100, "Leave set_find_options()\n");
88 * Find all specified files (determined by calls to
90 * This routine calls the (handle_file) subroutine with all
91 * sorts of good information for the final disposition of
94 * Call this subroutine with a callback subroutine as the first
95 * argument and a packet as the second argument, this packet
96 * will be passed back to the callback subroutine as the last
99 * The callback subroutine gets called with:
100 * arg1 -- the FF_PKT containing filename, link, stat, ftype, flags, etc
101 * arg2 -- the user supplied packet
105 find_files(JCR *jcr, FF_PKT *ff, int callback(FF_PKT *ff_pkt, void *hpkt), void *his_pkt)
107 struct s_included_file *inc = NULL;
109 /* This is the old deprecated way */
110 while (!job_canceled(jcr) && (inc = get_next_included_file(ff, inc))) {
111 /* Copy options for this file */
112 bstrncpy(ff->VerifyOpts, inc->VerifyOpts, sizeof(ff->VerifyOpts));
113 Dmsg1(50, "find_files: file=%s\n", inc->fname);
114 if (!file_is_excluded(ff, inc->fname)) {
115 if (!find_one_file(jcr, ff, callback, his_pkt, inc->fname, (dev_t)-1, 1)) {
116 return 0; /* error return */
121 /* This is the new way */
122 findFILESET *fileset = ff->fileset;
125 for (i=0; i<fileset->include_list.size(); i++) {
126 findINCEXE *incexe = (findINCEXE *)fileset->include_list.get(i);
128 * By setting all options, we in effect or the global options
129 * which is what we want.
131 for (j=0; j<incexe->opts_list.size(); j++) {
132 findFOPTS *fo = (findFOPTS *)incexe->opts_list.get(j);
133 Dmsg1(400, "Find global options O %s\n", fo->opts);
134 set_options(ff, fo->opts);
136 for (j=0; j<incexe->name_list.size(); j++) {
137 Dmsg1(400, "F %s\n", (char *)incexe->name_list.get(j));
138 char *fname = (char *)incexe->name_list.get(j);
139 if (!find_one_file(jcr, ff, callback, his_pkt, fname, (dev_t)-1, 1)) {
140 return 0; /* error return */
149 * As an optimization, we should do this during
150 * "compile" time in filed/job.c, and keep only a bit mask
151 * and the Verify options.
153 static void set_options(FF_PKT *ff, const char *opts)
158 for (p=opts; *p; p++) {
160 case 'a': /* alway replace */
161 case '0': /* no option */
164 ff->flags |= FO_EXCLUDE;
167 ff->flags |= FO_MULTIFS;
169 case 'h': /* no recursion */
170 ff->flags |= FO_NO_RECURSION;
176 ff->flags |= FO_NOREPLACE;
178 case 'p': /* use portable data format */
179 ff->flags |= FO_PORTABLE;
181 case 'r': /* read fifo */
182 ff->flags |= FO_READFIFO;
185 ff->flags |= FO_SHA1;
188 ff->flags |= FO_SPARSE;
191 ff->flags |= FO_MTIMEONLY;
194 ff->flags |= FO_KEEPATIME;
196 case 'V': /* verify options */
197 /* Copy Verify Options */
198 for (j=0; *p && *p != ':'; p++) {
199 ff->VerifyOpts[j] = *p;
200 if (j < (int)sizeof(ff->VerifyOpts) - 1) {
204 ff->VerifyOpts[j] = 0;
207 ff->flags |= FO_IF_NEWER;
209 case 'Z': /* gzip compression */
210 ff->flags |= FO_GZIP;
211 ff->GZIP_level = *++p - '0';
212 Dmsg1(200, "Compression level=%d\n", ff->GZIP_level);
215 Emsg1(M_ERROR, 0, "Unknown include/exclude option: %c\n", *p);
223 * Terminate find_files() and release
224 * all allocated memory
227 term_find_files(FF_PKT *ff)
231 term_include_exclude_files(ff);
232 free_pool_memory(ff->sys_fname);
233 hard_links = term_find_one(ff);