2 * Amanda, The Advanced Maryland Automatic Network Disk Archiver
3 * Copyright (c) 1991-1998 University of Maryland at College Park
6 * Permission to use, copy, modify, distribute, and sell this software and its
7 * documentation for any purpose is hereby granted without fee, provided that
8 * the above copyright notice appear in all copies and that both that
9 * copyright notice and this permission notice appear in supporting
10 * documentation, and that the name of U.M. not be used in advertising or
11 * publicity pertaining to distribution of the software without specific,
12 * written prior permission. U.M. makes no representations about the
13 * suitability of this software for any purpose. It is provided "as is"
14 * without express or implied warranty.
16 * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
18 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
20 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 * Authors: the Amanda Development Team. Its members are listed in a
24 * file named AUTHORS, in the root directory of this distribution.
27 * $Id: calcsize.c,v 1.44 2006/07/25 18:27:56 martinea Exp $
29 * traverse directory tree to get backup size estimates
31 * argv[0] is the calcsize program name
32 * argv[1] is the config name or NOCONFIG
40 #define ROUND(n,x) ((x) + (n) - 1 - (((x) + (n) - 1) % (n)))
48 unsigned long remainder = x % n;
55 #define ST_BLOCKS(s) \
56 (((((off_t)(s).st_blocks * (off_t)512) <= (s).st_size)) ? \
57 ((off_t)(s).st_blocks + (off_t)1) : \
58 ((s).st_size / (off_t)512 + \
59 (off_t)((((s).st_size % (off_t)512) != (off_t)0) ? \
60 (off_t)1 : (off_t)0)))
62 #define FILETYPES (S_IFREG|S_IFLNK|S_IFDIR)
64 typedef struct name_s {
78 off_t total_size_name;
79 } dumpstats[MAXDUMPS];
81 time_t dumpdate[MAXDUMPS];
82 int dumplevel[MAXDUMPS];
85 void (*add_file_name)(int, char *);
86 void (*add_file)(int, struct stat *);
87 off_t (*final_size)(int, char *);
90 int main(int, char **);
91 void traverse_dirs(char *, char *);
94 void add_file_name_dump(int, char *);
95 void add_file_dump(int, struct stat *);
96 off_t final_size_dump(int, char *);
98 void add_file_name_star(int, char *);
99 void add_file_star(int, struct stat *);
100 off_t final_size_star(int, char *);
102 void add_file_name_gnutar(int, char *);
103 void add_file_gnutar(int, struct stat *);
104 off_t final_size_gnutar(int, char *);
106 void add_file_name_unknown(int, char *);
107 void add_file_unknown(int, struct stat *);
108 off_t final_size_unknown(int, char *);
110 sl_t *calc_load_file(char *filename);
111 int calc_check_exclude(char *filename);
113 int use_star_excl = 0;
114 int use_gtar_excl = 0;
115 sl_t *include_sl=NULL, *exclude_sl=NULL;
123 /* standalone test to ckeck wether the calculated file size is ok */
126 off_t dump_total = (off_t)0;
127 off_t gtar_total = (off_t)0;
133 set_pname("calcsize");
137 /* Don't die when child closes pipe */
138 signal(SIGPIPE, SIG_IGN);
141 fprintf(stderr,"Usage: %s file[s]\n",argv[0]);
144 for(i=1; i<argc; i++) {
145 if(lstat(argv[i], &finfo) == -1) {
146 fprintf(stderr, "%s: %s\n", argv[i], strerror(errno));
149 printf("%s: st_size=%lu", argv[i],(unsigned long)finfo.st_size);
150 printf(": blocks=%llu\n", ST_BLOCKS(finfo));
151 dump_total += (ST_BLOCKS(finfo) + (off_t)1) / (off_t)2 + (off_t)1;
152 gtar_total += ROUND(4,(ST_BLOCKS(finfo) + (off_t)1));
154 printf(" gtar dump\n");
155 printf("total %-9lu %-9lu\n",gtar_total,dump_total);
159 char *dirname=NULL, *amname=NULL, *filename=NULL, *qfilename = NULL;
160 unsigned long malloc_hist_1, malloc_size_1;
161 unsigned long malloc_hist_2, malloc_size_2;
166 set_pname("calcsize");
168 dbopen(DBG_SUBDIR_CLIENT);
169 dbprintf(("%s: version %s\n", debug_prefix(NULL), version()));
171 malloc_size_1 = malloc_inuse(&malloc_hist_1);
174 erroutput_type = (ERR_INTERACTIVE|ERR_SYSLOG);
177 argc--, argv++; /* skip program name */
179 /* need at least program, amname, and directory name */
182 error("Usage: %s config [DUMP|GNUTAR] name dir [-X exclude-file] [-I include-file] [level date]*",
187 dbprintf(("config: %s\n", *argv));
188 if (strcmp(*argv, "NOCONFIG") != 0) {
189 dbrename(*argv, DBG_SUBDIR_CLIENT);
194 /* parse backup program name */
196 if(strcmp(*argv, "DUMP") == 0) {
197 #if !defined(DUMP) && !defined(XFSDUMP)
198 error("dump not available on this system");
201 add_file_name = add_file_name_dump;
202 add_file = add_file_dump;
203 final_size = final_size_dump;
206 else if(strcmp(*argv, "GNUTAR") == 0) {
208 error("gnutar not available on this system");
211 add_file_name = add_file_name_gnutar;
212 add_file = add_file_gnutar;
213 final_size = final_size_gnutar;
218 add_file_name = add_file_name_unknown;
219 add_file = add_file_unknown;
220 final_size = final_size_unknown;
224 /* the amanda name can be different from the directory name */
230 error("missing <name>");
234 /* the toplevel directory name to search from */
239 error("missing <dir>");
243 if ((argc > 1) && strcmp(*argv,"-X") == 0) {
246 if (!(use_gtar_excl || use_star_excl)) {
247 error("exclusion specification not supported");
251 filename = stralloc(*argv);
252 qfilename = quote_string(filename);
253 if (access(filename, R_OK) != 0) {
254 fprintf(stderr,"Cannot open exclude file %s\n", qfilename);
255 use_gtar_excl = use_star_excl = 0;
257 exclude_sl = calc_load_file(filename);
259 fprintf(stderr,"Cannot open exclude file %s: %s\n", qfilename,
261 use_gtar_excl = use_star_excl = 0;
269 use_gtar_excl = use_star_excl = 0;
272 if ((argc > 1) && strcmp(*argv,"-I") == 0) {
275 filename = stralloc(*argv);
276 qfilename = quote_string(filename);
277 if (access(filename, R_OK) != 0) {
278 fprintf(stderr,"Cannot open include file %s\n", qfilename);
279 use_gtar_excl = use_star_excl = 0;
281 include_sl = calc_load_file(filename);
283 fprintf(stderr,"Cannot open include file %s: %s\n", qfilename,
285 use_gtar_excl = use_star_excl = 0;
294 /* the dump levels to calculate sizes for */
298 if(ndumps < MAXDUMPS) {
299 dumplevel[ndumps] = atoi(argv[0]);
300 dumpdate [ndumps] = (time_t) atol(argv[1]);
302 argc -= 2, argv += 2;
307 error("leftover arg \"%s\", expected <level> and <date>", *argv);
311 if(is_empty_sl(include_sl)) {
312 traverse_dirs(dirname,".");
315 sle_t *an_include = include_sl->first;
316 while(an_include != NULL) {
318 char *adirname = stralloc2(dirname, an_include->name+1);
319 traverse_dirs(adirname);
322 traverse_dirs(dirname, an_include->name);
323 an_include = an_include->next;
326 for(i = 0; i < ndumps; i++) {
330 if (fseek(stderr, 0L, SEEK_END) < 0) {
331 dbprintf(("calcsize: warning - seek failed: %s\n",
335 dbprintf(("calcsize: %s %d SIZE " OFF_T_FMT "\n",
336 amname, dumplevel[i],
337 (OFF_T_FMT_TYPE)final_size(i, dirname)));
338 fprintf(stderr, "%s %d SIZE " OFF_T_FMT "\n",
339 amname, dumplevel[i],
340 (OFF_T_FMT_TYPE)final_size(i, dirname));
343 amfunlock(1, "size");
346 malloc_size_2 = malloc_inuse(&malloc_hist_2);
348 if(malloc_size_1 != malloc_size_2) {
349 malloc_list(fileno(stderr), malloc_hist_1, malloc_hist_2);
357 * =========================================================================
360 #if !defined(HAVE_BASENAME) && defined(BUILTIN_EXCLUDE_SUPPORT)
368 if ( (cp = strrchr(file,'/')) )
374 void push_name(char *str);
375 char *pop_name(void);
385 char *dirname, *newname = NULL;
386 char *newbase = NULL;
387 dev_t parent_dev = (dev_t)0;
394 if(parent_dir == NULL || include == NULL)
397 has_exclude = !is_empty_sl(exclude_sl) && (use_gtar_excl || use_star_excl);
398 aparent = vstralloc(parent_dir, "/", include, NULL);
400 if(stat(parent_dir, &finfo) != -1)
401 parent_dev = finfo.st_dev;
403 parent_len = strlen(parent_dir);
407 for(; (dirname = pop_name()) != NULL; free(dirname)) {
408 if(has_exclude && calc_check_exclude(dirname+parent_len+1)) {
411 if((d = opendir(dirname)) == NULL) {
417 if(l > 0 && dirname[l - 1] != '/') {
418 newbase = newstralloc2(newbase, dirname, "/");
420 newbase = newstralloc(newbase, dirname);
423 while((f = readdir(d)) != NULL) {
427 if(is_dot_or_dotdot(f->d_name)) {
431 newname = newstralloc2(newname, newbase, f->d_name);
432 if(lstat(newname, &finfo) == -1) {
433 fprintf(stderr, "%s/%s: %s\n",
434 dirname, f->d_name, strerror(errno));
438 if(finfo.st_dev != parent_dev)
442 is_symlink = ((finfo.st_mode & S_IFMT) == S_IFLNK);
444 is_dir = ((finfo.st_mode & S_IFMT) == S_IFDIR);
445 is_file = ((finfo.st_mode & S_IFMT) == S_IFREG);
447 if (!(is_file || is_dir || is_symlink)) {
452 int is_excluded = -1;
453 for(i = 0; i < ndumps; i++) {
454 add_file_name(i, newname);
455 if(is_file && (time_t)finfo.st_ctime >= dumpdate[i]) {
458 if(is_excluded == -1)
460 calc_check_exclude(newname+parent_len+1);
461 if(is_excluded == 1) {
470 if(has_exclude && calc_check_exclude(newname+parent_len+1))
480 if(closedir(d) == -1)
495 newp = alloc(SIZEOF(*newp));
496 newp->str = stralloc(str);
498 newp->next = name_stack;
505 Name *newp = name_stack;
508 if(!newp) return NULL;
510 name_stack = newp->next;
518 * =========================================================================
519 * Backup size calculations for DUMP program
521 * Given the system-dependent nature of dump, it's impossible to pin this
522 * down accurately. Luckily, that's not necessary.
524 * Dump rounds each file up to TP_BSIZE bytes, which is 1k in the BSD dump,
525 * others are unknown. In addition, dump stores three bitmaps at the
526 * beginning of the dump: a used inode map, a dumped dir map, and a dumped
527 * inode map. These are sized by the number of inodes in the filesystem.
529 * We don't take into account the complexities of BSD dump's indirect block
530 * requirements for files with holes, nor the dumping of directories that
531 * are not themselves modified.
538 (void)level; /* Quiet unused parameter warning */
539 (void)name; /* Quiet unused parameter warning */
549 /* keep the size in kbytes, rounded up, plus a 1k header block */
550 if((sp->st_mode & S_IFMT) == S_IFREG || (sp->st_mode & S_IFMT) == S_IFDIR)
551 dumpstats[level].total_size +=
552 (ST_BLOCKS(*sp) + (off_t)1) / (off_t)2 + (off_t)1;
560 generic_fs_stats_t stats;
564 /* calculate the map sizes */
566 s = stralloc2(topdir, "/.");
567 if(get_fs_stats(s, &stats) == -1) {
568 error("statfs %s: %s", s, strerror(errno));
573 mapsize = (stats.files + (off_t)7) / (off_t)8; /* in bytes */
574 mapsize = (mapsize + (off_t)1023) / (off_t)1024; /* in kbytes */
576 /* the dump contains three maps plus the files */
578 return (mapsize * (off_t)3) + dumpstats[level].total_size;
582 * =========================================================================
583 * Backup size calculations for GNUTAR program
585 * Gnutar's basic blocksize is 512 bytes. Each file is rounded up to that
586 * size, plus one header block. Gnutar stores directories' file lists in
587 * incremental dumps - we'll pick up size of the modified dirs here. These
588 * will be larger than a simple filelist of their contents, but that's ok.
590 * As with DUMP, we only need a reasonable estimate, not an exact figure.
593 add_file_name_gnutar(
597 (void)name; /* Quiet unused parameter warning */
599 /* dumpstats[level].total_size_name += strlen(name) + 64;*/
600 dumpstats[level].total_size += (off_t)1;
608 /* the header takes one additional block */
609 dumpstats[level].total_size += ST_BLOCKS(*sp);
617 (void)topdir; /* Quiet unused parameter warning */
619 /* divide by two to get kbytes, rounded up */
620 /* + 4 blocks for security */
621 return (dumpstats[level].total_size + (off_t)5 +
622 (dumpstats[level].total_size_name/(off_t)512)) / (off_t)2;
626 * =========================================================================
627 * Backup size calculations for unknown backup programs.
629 * Here we'll just add up the file sizes and output that.
633 add_file_name_unknown(
637 (void)level; /* Quiet unused parameter warning */
638 (void)name; /* Quiet unused parameter warning */
648 /* just add up the block counts */
649 if((sp->st_mode & S_IFMT) == S_IFREG || (sp->st_mode & S_IFMT) == S_IFDIR)
650 dumpstats[level].total_size += ST_BLOCKS(*sp);
658 (void)topdir; /* Quiet unused parameter warning */
660 /* divide by two to get kbytes, rounded up */
661 return (dumpstats[level].total_size + (off_t)1) / (off_t)2;
665 * =========================================================================
675 FILE *file = fopen(filename, "r");
683 while(fgets(pattern, 1025, file)) {
684 if(strlen(pattern)>0 && pattern[strlen(pattern)-1] == '\n')
685 pattern[strlen(pattern)-1] = '\0';
686 sl_list = append_sl(sl_list, pattern);
698 if(is_empty_sl(exclude_sl)) return 0;
700 an_exclude=exclude_sl->first;
701 while(an_exclude != NULL) {
702 if(match_tar(an_exclude->name, filename)) {
705 an_exclude=an_exclude->next;