summaryrefslogtreecommitdiffstats
path: root/tests/utils/arequal-checksum.c
blob: d4e8688b9be3f23c2ba8c8ba676aaa288ca6e00d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
/*
  Copyright (c) 2012 Red Hat, Inc. <http://www.redhat.com>
  This file is part of GlusterFS.

  This file is licensed to you under your choice of the GNU Lesser
  General Public License, version 3 or any later version (LGPLv3 or
  later), or the GNU General Public License, version 2 (GPLv2), in all
  cases as published by the Free Software Foundation.
*/

#ifndef _GNU_SOURCE
#define _GNU_SOURCE
#endif

#define _XOPEN_SOURCE 500

#include <ftw.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <dirent.h>
#include <stdlib.h>
#include <libgen.h>
#include <stdint.h>
#include <dirent.h>
#include <argp.h>

/*
 * FTW_ACTIONRETVAL is a GNU libc extension. It is used here to skip
 * hiearchies. On other systems we will still walk the tree, ignoring
 * entries.
 */
#ifndef FTW_ACTIONRETVAL
#define FTW_ACTIONRETVAL 0
#endif

int debug = 0;

typedef struct {
        char test_directory[4096];
        char **ignored_directory;
        unsigned int directories_ignored;
} arequal_config_t;

static arequal_config_t arequal_config;

static error_t
arequal_parse_opts (int key, char *arg, struct argp_state *_state);

static struct argp_option arequal_options[] = {
        { "ignore", 'i', "IGNORED", 0,
          "entry in the given path to be ignored"},
        { "path", 'p', "PATH", 0, "path where arequal has to be run"},
        {0, 0, 0, 0, 0}
};

#define DBG(fmt ...) do {                       \
                if (debug) {                    \
                        fprintf (stderr, "D "); \
                        fprintf (stderr, fmt);  \
                }                               \
        } while (0)

void
add_to_list (char *arg);
void
get_absolute_path (char directory[], char *arg);

static inline int roof(int a, int b)
{
        return ((((a)+(b)-1)/((b)?(b):1))*(b));
}

void
add_to_list (char *arg)
{
        char *string = NULL;
        int index = 0;

        index = arequal_config.directories_ignored - 1;
        string = strdup (arg);

        if (!arequal_config.ignored_directory) {
                arequal_config.ignored_directory = calloc (1, sizeof (char *));
        } else
                arequal_config.ignored_directory =
                        realloc (arequal_config.ignored_directory,
                                 sizeof (char *) * (index+1));

        arequal_config.ignored_directory[index] = string;
}

static error_t
arequal_parse_opts (int key, char *arg, struct argp_state *_state)
{
        switch (key) {
        case 'i':
        {
                arequal_config.directories_ignored++;
                add_to_list (arg);
        }
        break;
        case 'p':
        {
                if (arg[0] == '/')
                        strcpy (arequal_config.test_directory, arg);
                else
                        get_absolute_path (arequal_config.test_directory, arg);

                if (arequal_config.test_directory
                    [strlen(arequal_config.test_directory) - 1] == '/')
                        arequal_config.test_directory
                                [strlen(arequal_config.test_directory) - 1] = '\0';
        }
        break;

        case ARGP_KEY_NO_ARGS:
                break;
        case ARGP_KEY_ARG:
                break;
        case ARGP_KEY_END:
                if (_state->argc == 1) {
                       argp_usage (_state);
                }

        }

        return 0;
}

void
get_absolute_path (char directory[], char *arg)
{
        char   cwd[4096] = {0,};

        if (getcwd (cwd, sizeof (cwd)) == NULL)
                printf ("some error in getting cwd\n");

        if (strcmp (arg, ".") != 0) {
                if (cwd[strlen(cwd)] != '/')
                        cwd[strlen (cwd)] = '/';
                strcat (cwd, arg);
        }
        strcpy (directory, cwd);
}

static struct argp argp = {
        arequal_options,
        arequal_parse_opts,
        "",
        "arequal - Tool which calculates the checksum of all the entries"
        "present in a given directory"
};

/* All this runs in single thread, hence using 'global' variables */

unsigned long long     avg_uid_file    = 0;
unsigned long long     avg_uid_dir     = 0;
unsigned long long     avg_uid_symlink = 0;
unsigned long long     avg_uid_other   = 0;

unsigned long long     avg_gid_file    = 0;
unsigned long long     avg_gid_dir     = 0;
unsigned long long     avg_gid_symlink = 0;
unsigned long long     avg_gid_other   = 0;

unsigned long long     avg_mode_file    = 0;
unsigned long long     avg_mode_dir     = 0;
unsigned long long     avg_mode_symlink = 0;
unsigned long long     avg_mode_other   = 0;

unsigned long long global_ctime_checksum = 0;


unsigned long long      count_dir        = 0;
unsigned long long      count_file       = 0;
unsigned long long      count_symlink    = 0;
unsigned long long      count_other      = 0;


unsigned long long      checksum_file1   = 0;
unsigned long long      checksum_file2   = 0;
unsigned long long      checksum_dir     = 0;
unsigned long long      checksum_symlink = 0;
unsigned long long      checksum_other   = 0;


unsigned long long
checksum_path (const char *path)
{
        unsigned long long   csum = 0;
        unsigned long long  *nums = 0;
        int                  len = 0;
        int                  cnt = 0;

        len = roof (strlen (path), sizeof (csum));
        cnt = len / sizeof (csum);

        nums = __builtin_alloca (len);
        memset (nums, 0, len);
        strcpy ((char *)nums, path);

        while (cnt) {
                csum ^= *nums;
                nums++;
                cnt--;
        }

        return csum;
}

int
checksum_md5 (const char *path, const struct stat *sb)
{
        uint64_t    this_data_checksum = 0;
        FILE       *filep              = NULL;
        char        *cmd               = NULL;
        char        strvalue[17]       = {0,};
        int         ret                = -1;
        int         len                = 0;
        const char  *pos               = NULL;
        char        *cpos              = NULL;

        /* Have to escape single-quotes in filename.
         * First, calculate the size of the buffer I'll need.
         */
        for (pos = path; *pos; pos++) {
                if ( *pos == '\'' )
                        len += 4;
                else
                        len += 1;
        }

        cmd = malloc(sizeof(char) * (len + 20));
        cmd[0] = '\0';

        /* Now, build the command with single quotes escaped. */

        cpos = cmd;
#if defined(linux)
        strcpy(cpos, "md5sum '");
        cpos += 8;
#elif defined(__NetBSD__)
        strcpy(cpos, "md5 -n '");
        cpos += 8;
#elif defined(__FreeBSD__) || defined(__APPLE__)
        strcpy(cpos, "md5 -q '");
        cpos += 8;
#else
#error "Please add system-specific md5 command"
#endif

        /* Add the file path, with every single quotes replaced with this sequence:
         * '\''
         */

        for (pos = path; *pos; pos++) {
                if ( *pos == '\'' ) {
                        strcpy(cpos, "'\\''");
                        cpos += 4;
                } else {
                        *cpos = *pos;
                        cpos++;
                }
        }

        /* Add on the trailing single-quote and null-terminate. */
        strcpy(cpos, "'");

        filep = popen (cmd, "r");
        if (!filep) {
                perror (path);
                goto out;
        }

        if (fread (strvalue, sizeof (char), 16, filep) != 16) {
                fprintf (stderr, "%s: short read\n", path);
                goto out;
        }

        this_data_checksum = strtoull (strvalue, NULL, 16);
        if (-1 == this_data_checksum) {
                fprintf (stderr, "%s: %s\n", strvalue, strerror (errno));
                goto out;
        }
        checksum_file1 ^= this_data_checksum;

        if (fread (strvalue, sizeof (char), 16, filep) != 16) {
                fprintf (stderr, "%s: short read\n", path);
                goto out;
        }

        this_data_checksum = strtoull (strvalue, NULL, 16);
        if (-1 == this_data_checksum) {
                fprintf (stderr, "%s: %s\n", strvalue, strerror (errno));
                goto out;
        }
        checksum_file2 ^= this_data_checksum;

        ret = 0;
out:
        if (filep)
                pclose (filep);

        if (cmd)
                free(cmd);

        return ret;
}

int
checksum_filenames (const char *path, const struct stat *sb)
{
        DIR                *dirp = NULL;
        struct dirent      *entry = NULL;
        unsigned long long  csum = 0;
        int                 i = 0;
        int                 found = 0;

        dirp = opendir (path);
        if (!dirp) {
                perror (path);
                goto out;
        }

        errno = 0;
        while ((entry = readdir (dirp))) {
                /* do not calculate the checksum of the entries which user has
                   told to ignore and proceed to other siblings.*/
                if (arequal_config.ignored_directory) {
                        for (i = 0;i < arequal_config.directories_ignored;i++) {
                                if ((strcmp (entry->d_name,
                                             arequal_config.ignored_directory[i])
                                     == 0)) {
                                        found = 1;
                                        DBG ("ignoring the entry %s\n",
                                             entry->d_name);
                                        break;
                                }
                        }
                        if (found == 1) {
                                found = 0;
                                continue;
                        }
                }
                csum = checksum_path (entry->d_name);
                checksum_dir ^= csum;
        }

        if (errno) {
                perror (path);
                goto out;
        }

out:
        if (dirp)
                closedir (dirp);

        return 0;
}


int
process_file (const char *path, const struct stat *sb)
{
        int    ret = 0;

        count_file++;

        avg_uid_file ^= sb->st_uid;
        avg_gid_file ^= sb->st_gid;
        avg_mode_file ^= sb->st_mode;

        ret = checksum_md5 (path, sb);

        return ret;
}


int
process_dir (const char *path, const struct stat *sb)
{
        unsigned long long csum = 0;

        count_dir++;

        avg_uid_dir ^= sb->st_uid;
        avg_gid_dir ^= sb->st_gid;
        avg_mode_dir ^= sb->st_mode;

        csum = checksum_filenames (path, sb);

        checksum_dir ^= csum;

        return 0;
}


int
process_symlink (const char *path, const struct stat *sb)
{
        int                ret = 0;
        char               buf[4096] = {0, };
        unsigned long long csum = 0;

        count_symlink++;

        avg_uid_symlink ^= sb->st_uid;
        avg_gid_symlink ^= sb->st_gid;
        avg_mode_symlink ^= sb->st_mode;

        ret = readlink (path, buf, 4096);
        if (ret < 0) {
                perror (path);
                goto out;
        }

        DBG ("readlink (%s) => %s\n", path, buf);

        csum = checksum_path (buf);

        DBG ("checksum_path (%s) => %llx\n", buf, csum);

        checksum_symlink ^= csum;

        ret = 0;
out:
        return ret;
}


int
process_other (const char *path, const struct stat *sb)
{
        count_other++;

        avg_uid_other ^= sb->st_uid;
        avg_gid_other ^= sb->st_gid;
        avg_mode_other ^= sb->st_mode;

        checksum_other ^= sb->st_rdev;

        return 0;
}

static int
ignore_entry(const char *bname, const char *dname)
{
        int i;

	for (i  = 0; i < arequal_config.directories_ignored; i++) {
		if (strcmp(bname, arequal_config.ignored_directory[i]) == 0 &&
                    strncmp(arequal_config.test_directory, dname,
                            strlen(arequal_config.test_directory)) == 0)
                        return 1;
        }

        return 0;
}

int
process_entry (const char *path, const struct stat *sb,
               int typeflag, struct FTW *ftwbuf)
{
        int ret = 0;
        char *name = NULL;
        char *bname = NULL;
        char *dname = NULL;
        int  i = 0;

        /* The if condition below helps in ignoring some directories in
           the given path. If the name of the entry is one of the directory
           names that the user told to ignore, then that directory will not
           be processed and will return FTW_SKIP_SUBTREE to nftw which will
           not crawl this directory and move on to other siblings.
           Note that for nftw to recognize FTW_SKIP_TREE, FTW_ACTIONRETVAL
           should be passed as an argument to nftw.

           This mainly helps in calculating the checksum of network filesystems
           (client-server), where the server might have some hidden directories
           for managing the filesystem. So to calculate the sanity of filesytem
           one has to get the checksum of the client and then the export directory
           of server by telling arequal to ignore some of the directories which
           are not part of the namespace.
        */

        if (arequal_config.ignored_directory) {
#ifndef FTW_SKIP_SUBTREE
                char *cp;

                name = strdup (path);
                dname = dirname (name);

                for (cp = strtok(name, "/"); cp; cp = strtok(NULL, "/")) {
                        if (ignore_entry(cp, dname)) {
                                DBG ("ignoring %s\n", path);
                                if (name)
                                        free (name);
                                return 0;
                        }
                }
#else /* FTW_SKIP_SUBTREE */
                name = strdup (path);

                name[strlen(name)] = '\0';

                bname = strrchr (name, '/');
                if (bname)
                        bname++;

                dname = dirname (name);
                if (ignore_entry(bname, dname)) {
                                DBG ("ignoring %s\n", bname);
                                ret = FTW_SKIP_SUBTREE;
                                if (name)
                                        free (name);
                                return ret;
                }
#endif /* FTW_SKIP_SUBTREE */
        }

        DBG ("processing entry %s\n", path);

        switch ((S_IFMT & sb->st_mode)) {
        case S_IFDIR:
                ret = process_dir (path, sb);
                break;
        case S_IFREG:
                ret = process_file (path, sb);
                break;
        case S_IFLNK:
                ret = process_symlink (path, sb);
                break;
        default:
                ret = process_other (path, sb);
                break;
        }

        if (name)
                free (name);
        return ret;
}


int
display_counts (FILE *fp)
{
        fprintf (fp, "\n");
        fprintf (fp, "Entry counts\n");
        fprintf (fp, "Regular files   : %lld\n", count_file);
        fprintf (fp, "Directories     : %lld\n", count_dir);
        fprintf (fp, "Symbolic links  : %lld\n", count_symlink);
        fprintf (fp, "Other           : %lld\n", count_other);
        fprintf (fp, "Total           : %lld\n",
                 (count_file + count_dir + count_symlink + count_other));

        return 0;
}


int
display_checksums (FILE *fp)
{
        fprintf (fp, "\n");
        fprintf (fp, "Checksums\n");
        fprintf (fp, "Regular files   : %llx%llx\n", checksum_file1, checksum_file2);
        fprintf (fp, "Directories     : %llx\n", checksum_dir);
        fprintf (fp, "Symbolic links  : %llx\n", checksum_symlink);
        fprintf (fp, "Other           : %llx\n", checksum_other);
        fprintf (fp, "Total           : %llx\n",
                 (checksum_file1 ^ checksum_file2 ^ checksum_dir ^ checksum_symlink ^ checksum_other));

        return 0;
}


int
display_metadata (FILE *fp)
{
        fprintf (fp, "\n");
        fprintf (fp, "Metadata checksums\n");
        fprintf (fp, "Regular files   : %llx\n",
                 (avg_uid_file + 13) * (avg_gid_file + 11) * (avg_mode_file + 7));
        fprintf (fp, "Directories     : %llx\n",
                 (avg_uid_dir + 13) * (avg_gid_dir + 11) * (avg_mode_dir + 7));
        fprintf (fp, "Symbolic links  : %llx\n",
                 (avg_uid_symlink + 13) * (avg_gid_symlink + 11) * (avg_mode_symlink + 7));
        fprintf (fp, "Other           : %llx\n",
                 (avg_uid_other + 13) * (avg_gid_other + 11) * (avg_mode_other + 7));

        return 0;
}

int
display_stats (FILE *fp)
{
        display_counts (fp);

        display_metadata (fp);

        display_checksums (fp);

        return 0;
}


int
main(int argc, char *argv[])
{
        int  ret = 0;
        int  i = 0;

        ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
        if (ret != 0) {
                fprintf (stderr, "parsing arguments failed\n");
                return -2;
        }

         /* Use FTW_ACTIONRETVAL to take decision on what to do depending upon */
         /* the return value of the callback function */
         /* (process_entry in this case) */
        ret = nftw (arequal_config.test_directory, process_entry, 30,
                    FTW_ACTIONRETVAL|FTW_PHYS|FTW_MOUNT);
        if (ret != 0) {
                fprintf (stderr, "ftw (%s) returned %d (%s), terminating\n",
                         argv[1], ret, strerror (errno));
                return 1;
        }

        display_stats (stdout);

        if (arequal_config.ignored_directory) {
                for (i = 0; i < arequal_config.directories_ignored; i++) {
                        if (arequal_config.ignored_directory[i])
                            free (arequal_config.ignored_directory[i]);
                }
                free (arequal_config.ignored_directory);
        }

        return 0;
}