2 * Copyright (C) 2007-2009 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file fsck.c The program used to check an osl table. */
10 #include <sys/types.h>
19 #include "fsck.cmdline.h"
21 #define VERSION_TEXT(prefix) "osl" prefix " " VERSION " " "\n" \
22 "Copyright (C) 2008-2009 Andre Noll\n" \
23 "This is free software with ABSOLUTELY NO WARRANTY." \
24 " See COPYING for details.\n" \
25 "Written by Andre Noll.\n" \
26 "Report bugs to <maan@tuebingen.mpg.de>.\n"
28 /** print out \p VERSION_TEXT and exit if version flag was given */
29 #define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
30 if (_args_info_struct.version_given) { \
31 printf("%s", VERSION_TEXT(_prefix)); \
35 static struct fsck_args_info conf;
38 FSCK_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
39 FSCK_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
40 FSCK_ERROR(SYNTAX, "fsck syntax error"), \
41 FSCK_ERROR(ACCESS, "permission denied"), \
42 FSCK_ERROR(CHDIR, "could not change directory"), \
43 FSCK_ERROR(OPENDIR, "could not open directory"),
45 #define FSCK_ERROR_BIT 29
46 #define FSCK_ERROR(num, txt) E_FSCK_ ## num
48 FSCK_DUMMY = (1 << FSCK_ERROR_BIT) - 1,
52 #define FSCK_ERROR(num, txt) txt
53 static const char *fsck_errors[] = {
57 static const char *fsck_strerror(int num)
59 if (num & (1 << FSCK_ERROR_BIT))
60 return fsck_errors[num & ((1 << FSCK_ERROR_BIT) - 1)];
61 return osl_strerror(num);
67 static signed char hexval_table[256] = {
68 -1, -1, -1, -1, -1, -1, -1, -1, /* 00-07 */
69 -1, -1, -1, -1, -1, -1, -1, -1, /* 08-0f */
70 -1, -1, -1, -1, -1, -1, -1, -1, /* 10-17 */
71 -1, -1, -1, -1, -1, -1, -1, -1, /* 18-1f */
72 -1, -1, -1, -1, -1, -1, -1, -1, /* 20-27 */
73 -1, -1, -1, -1, -1, -1, -1, -1, /* 28-2f */
74 0, 1, 2, 3, 4, 5, 6, 7, /* 30-37 */
75 8, 9, -1, -1, -1, -1, -1, -1, /* 38-3f */
76 -1, 10, 11, 12, 13, 14, 15, -1, /* 40-47 */
77 -1, -1, -1, -1, -1, -1, -1, -1, /* 48-4f */
78 -1, -1, -1, -1, -1, -1, -1, -1, /* 50-57 */
79 -1, -1, -1, -1, -1, -1, -1, -1, /* 58-5f */
80 -1, 10, 11, 12, 13, 14, 15, -1, /* 60-67 */
81 -1, -1, -1, -1, -1, -1, -1, -1, /* 68-67 */
82 -1, -1, -1, -1, -1, -1, -1, -1, /* 70-77 */
83 -1, -1, -1, -1, -1, -1, -1, -1, /* 78-7f */
84 -1, -1, -1, -1, -1, -1, -1, -1, /* 80-87 */
85 -1, -1, -1, -1, -1, -1, -1, -1, /* 88-8f */
86 -1, -1, -1, -1, -1, -1, -1, -1, /* 90-97 */
87 -1, -1, -1, -1, -1, -1, -1, -1, /* 98-9f */
88 -1, -1, -1, -1, -1, -1, -1, -1, /* a0-a7 */
89 -1, -1, -1, -1, -1, -1, -1, -1, /* a8-af */
90 -1, -1, -1, -1, -1, -1, -1, -1, /* b0-b7 */
91 -1, -1, -1, -1, -1, -1, -1, -1, /* b8-bf */
92 -1, -1, -1, -1, -1, -1, -1, -1, /* c0-c7 */
93 -1, -1, -1, -1, -1, -1, -1, -1, /* c8-cf */
94 -1, -1, -1, -1, -1, -1, -1, -1, /* d0-d7 */
95 -1, -1, -1, -1, -1, -1, -1, -1, /* d8-df */
96 -1, -1, -1, -1, -1, -1, -1, -1, /* e0-e7 */
97 -1, -1, -1, -1, -1, -1, -1, -1, /* e8-ef */
98 -1, -1, -1, -1, -1, -1, -1, -1, /* f0-f7 */
99 -1, -1, -1, -1, -1, -1, -1, -1, /* f8-ff */
102 static int asc_to_hash(const char *asc_hash, int len, HASH_TYPE *hash)
105 const unsigned char *asc = (const unsigned char *) asc_hash;
107 while (*asc && i++ < len) {
108 unsigned int val = (hexval_table[asc[0]] << 4) | hexval_table[asc[1]];
118 static int _write_all(int fd, const char *buf, size_t len)
120 return write_all(fd, buf, &len);
124 * Wrapper for malloc().
126 * \param size The desired new size.
128 * A wrapper for malloc(3) which exits on errors.
130 * \return A pointer to the allocated memory, which is suitably aligned for any
135 __must_check __malloc static void *fsck_malloc(size_t size)
138 void *p = malloc(size);
141 EMERG_LOG("malloc failed (size = %zu), aborting\n",
149 * Allocate memory and fill with zeros.
151 * \param size The desired new size.
153 * A wrapper for calloc(3) which exits on errors.
155 * \return A pointer to the allocated and zeroed-out memory, which is suitably
156 * aligned for any kind of variable.
160 __must_check __malloc static void *fsck_calloc(size_t size)
162 void *ret = fsck_malloc(size);
164 memset(ret, 0, size);
169 * Save version of strdup().
171 * \param s The string to be duplicated.
173 * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
174 * there is no need to check the return value in the caller.
176 * \return A pointer to the duplicated string. If \p s was the NULL pointer,
177 * an pointer to an empty string is returned.
181 __must_check __malloc static char *fsck_strdup(const char *s)
185 if ((ret = strdup(s? s: "")))
187 EMERG_LOG("strdup failed, aborting\n");
192 * Compare two osl objects pointing to unsigned integers of 32 bit size.
194 * \param obj1 Pointer to the first integer.
195 * \param obj2 Pointer to the second integer.
197 * \return The values required for an osl compare function.
199 * \sa osl_compare_func, osl_hash_compare().
201 static int uint32_compare(const struct osl_object *obj1, const struct osl_object *obj2)
203 uint32_t d1 = read_u32((const char *)obj1->data);
204 uint32_t d2 = read_u32((const char *)obj2->data);
214 * A wrapper for fchdir().
216 * \param fd An open file descriptor.
220 static inline int __fchdir(int fd)
224 return errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_CHDIR;
228 * Wrapper for chdir(2).
230 * \param path The specified directory.
234 _static_inline_ int __chdir(const char *path)
236 if (chdir(path) >= 0)
238 return errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_CHDIR;
242 * Save the cwd and open a given directory.
244 * \param dirname Path to the directory to open.
245 * \param dir Result pointer.
246 * \param cwd File descriptor of the current working directory.
250 * Opening the current directory (".") and calling fchdir() to return is
251 * usually faster and more reliable than saving cwd in some buffer and calling
252 * chdir() afterwards.
254 * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
255 * stored in \a cwd. If the function returns success, and \a cwd is not \p
256 * NULL, the caller must close this file descriptor (probably after calling
259 * On errors, the function undos everything, so the caller needs neither close
260 * any files, nor change back to the original working directory.
265 static int fsck_opendir(const char *dirname, DIR **dir, int *cwd)
270 ret = osl_open(".", O_RDONLY, 0);
275 ret = __chdir(dirname);
281 ret = errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_OPENDIR;
282 /* Ignore return value of fchdir() and close(). We're busted anyway. */
284 int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
295 * Traverse the given directory recursively.
297 * \param dirname The directory to traverse.
298 * \param func The function to call for each entry.
299 * \param private_data Pointer to an arbitrary data structure.
301 * For each regular file under \a dirname, the supplied function \a func is
302 * called. The full path of the regular file and the \a private_data pointer
303 * are passed to \a func. Directories for which the calling process has no
304 * permissions to change to are silently ignored.
308 static int for_each_file_in_dir(const char *dirname,
309 int (*func)(const char *, void *), void *private_data)
312 struct dirent *entry;
313 int cwd_fd, ret2, ret = fsck_opendir(dirname, &dir, &cwd_fd);
316 return ret == -E_FSCK_ACCESS? 1 : ret;
317 /* scan cwd recursively */
318 while ((entry = readdir(dir))) {
323 if (!strcmp(entry->d_name, "."))
325 if (!strcmp(entry->d_name, ".."))
327 if (lstat(entry->d_name, &s) == -1)
330 if (!S_ISREG(m) && !S_ISDIR(m))
332 tmp = make_message("%s/%s", dirname, entry->d_name);
334 ret = func(tmp, private_data);
341 ret = for_each_file_in_dir(tmp, func, private_data);
349 ret2 = __fchdir(cwd_fd);
350 if (ret2 < 0 && ret >= 0)
357 * check for object boundary violations
359 * test whether the range pointed to by the index entry for a given cell is
360 * contained in mapped data file. This should always be the case. Otherwise
361 * we are in real trouble.
363 static int check_range(struct osl_table *t, uint32_t row_num, uint32_t col_num)
366 struct osl_object obj;
367 struct osl_column *col;
369 char *map_start, *obj_start;
371 ret = get_cell_index(t, row_num, col_num, &index_entry);
374 ret = get_mapped_object(t, col_num, row_num, &obj);
377 col = t->columns + col_num;
378 obj_start = obj.data;
379 map_start = col->data_map.data;
380 // INFO_LOG("obj: %p..%p\n", obj_start, obj_start + obj.size);
381 // INFO_LOG("map: %p..%p\n", map_start, map_start + col->data_map.size);
382 if (obj_start < map_start || obj_start + obj.size > map_start + col->data_map.size) {
383 CRIT_LOG("range violation in row %u, col %u\n", row_num,
385 return -E_FSCK_RANGE_VIOLATION;
387 DEBUG_LOG("col %u: ok\n", col_num);
391 static int fsck_mark_row_invalid(struct osl_table *t, int i)
393 if (conf.dry_run_given)
395 return mark_row_invalid(t, i);
399 * check all cells of the given table for boundary violations
401 static int check_index_ranges(struct osl_table *t)
405 INFO_LOG("checking for range violations in index\n");
406 //DEBUG_LOG("%d rows. %d columns\n", t->num_rows, t->desc->num_columns);
407 t->num_invalid_rows = 0;
408 for (i = 0; i < t->num_rows; i++) {
409 const struct osl_column_description *cd;
411 if (row_is_invalid(t, i)) {
412 t->num_invalid_rows++;
415 FOR_EACH_MAPPED_COLUMN(j, t, cd) {
416 ret = check_range(t, i, j);
418 if (ret != -E_FSCK_RANGE_VIOLATION)
420 ret = fsck_mark_row_invalid(t, i);
423 t->num_invalid_rows++;
429 if (t->num_invalid_rows)
430 NOTICE_LOG("ranges OK. %d invalid row(s) detected\n",
431 t->num_invalid_rows);
433 INFO_LOG("no invalid rows, no range violations, good\n");
439 static int move_index_entry(struct osl_table *t, uint32_t dest, uint32_t src)
441 char *dest_ie, *src_ie;
442 int ret = get_row_index(t, dest, &dest_ie);
446 ret = get_row_index(t, src, &src_ie);
449 INFO_LOG("moving entry #%u to position %u\n", src, dest);
450 memcpy(dest_ie, src_ie, t->row_index_size);
454 static int map_index(const struct osl_table_description *desc, struct osl_object *map)
456 char *filename = index_filename(desc);
459 ret = mmap_full_file(filename, O_RDWR, &map->data, &map->size, NULL);
460 DEBUG_LOG("mapping index %s: ret: %d, size: %zu\n", filename, ret, map->size);
465 static int prune_invalid_rows_from_index(struct osl_table *t)
467 uint32_t top = 0, bottom;
471 if (!t->num_invalid_rows) {
472 INFO_LOG("all rows are valid, good\n");
475 NOTICE_LOG("index contains %u invalid row(s) (%d bytes)\n",
476 t->num_invalid_rows, t->row_index_size * t->num_invalid_rows);
477 if (conf.dry_run_given)
479 NOTICE_LOG("removing invalid rows from index\n");
480 bottom = t->num_rows - 1;
481 while (top < bottom) {
482 if (!row_is_invalid(t, top)) {
486 while (bottom > top) {
487 if (row_is_invalid(t, bottom)) {
491 /* move bottom index entry to top */
492 move_index_entry(t, top, bottom);
498 DEBUG_LOG("unmapping index\n");
499 osl_munmap(t->index_map.data, t->index_map.size);
500 filename = index_filename(t->desc);
501 ret = truncate_file(filename, t->row_index_size
502 * t->num_invalid_rows);
506 ret = map_index(t->desc, &t->index_map);
509 t->num_rows = table_num_rows(t);
513 static int check_for_invalid_objects(struct osl_table *t, uint32_t **lost_bytes)
516 const struct osl_column_description *cd;
517 uint32_t *loss = fsck_malloc(sizeof(uint32_t) * t->desc->num_columns);
519 INFO_LOG("looking for mapped objects not contained in index\n");
520 /* first count used bytes */
521 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
522 loss[i] = t->columns[i].data_map.size;
523 DEBUG_LOG("column %i data map: %zu bytes\n", i,
524 t->columns[i].data_map.size);
525 for (j = 0; j < t->num_rows; j++) {
526 struct osl_object obj;
527 ret = get_mapped_object(t, i, j, &obj);
534 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
536 NOTICE_LOG("column %u contains %u lost bytes\n",
542 INFO_LOG("all mapped objects are valid, good\n");
550 /* prune_invalid_rows() must be run on the table before calling this */
551 static int prune_mapped_column(struct osl_table *t, uint32_t col_num, int fd)
554 uint32_t written = 0;
555 struct osl_column *col = t->columns + col_num;
557 INFO_LOG("pruning col %u\n", col_num);
558 for (i = 0; i < t->num_rows; i++) {
559 struct osl_object obj;
562 DEBUG_LOG("checking row %u/%u\n", i, t->num_rows);
563 ret = get_mapped_object(t, col_num, i, &obj);
566 ret = _write_all(fd, (char *)(obj.data), obj.size);
570 ret = get_row_index(t, i, &index_entry);
573 update_cell_index(index_entry, col, written, obj.size);
578 static int prune_objects(struct osl_table *t, uint32_t *lost_bytes)
581 const struct osl_column_description *cd;
582 char **col_filenames = fsck_calloc(t->desc->num_columns * sizeof(char *));
583 char **new_col_filenames = fsck_calloc(t->desc->num_columns * sizeof(char *));
584 char *idx_filename = index_filename(t->desc);
585 char *old_idx_filename = make_message("%s.bak", idx_filename);
588 NOTICE_LOG("removing unreferenced objects from data files\n");
589 /* first make a copy of the index */
590 DEBUG_LOG("opening %s\n", old_idx_filename);
591 ret = osl_open(old_idx_filename, O_WRONLY | O_CREAT | O_TRUNC, 0644);
595 ret = _write_all(fd, t->index_map.data, t->index_map.size);
599 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
602 col_filenames[i] = column_filename(t, i);
603 new_col_filenames[i] = make_message("%s.fsck", col_filenames[i]);
604 ret = osl_open(new_col_filenames[i], O_WRONLY | O_CREAT | O_EXCL, 0644);
606 goto out_unlink_data;
608 ret = prune_mapped_column(t, i, fd);
611 goto out_unlink_data;
613 ret = unmap_table(t, OSL_MARK_CLEAN);
615 goto out_unlink_data;
616 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
619 ret = osl_rename(new_col_filenames[i], col_filenames[i]);
620 if (ret < 0) { /* we're kinda screwed here */
621 CRIT_LOG("rename of col %i failed: %s\n", i,
622 osl_strerror(errno));
626 unlink(old_idx_filename);
627 ret = map_table(t, 0);
630 FOR_EACH_MAPPED_COLUMN(i, t, cd)
631 unlink(new_col_filenames[i]);
633 free(old_idx_filename);
635 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
636 free(col_filenames[i]);
637 free(new_col_filenames[i]);
640 free(new_col_filenames);
644 static struct osl_column_description hash_tree_table_cols[] = {
646 .storage_type = OSL_NO_STORAGE,
647 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
649 .compare_function = uint32_compare,
650 .data_size = HASH_SIZE
654 static const struct osl_table_description hash_tree_table_desc = {
655 .dir = "/", /* irrelevant */
659 .column_descriptions = hash_tree_table_cols
663 * The hash_tree table contains all hashes of the disk storage name column.
664 * of each row. It is used for checking if a disk storage file has a reference
667 static struct osl_table *hash_tree_table;
668 static HASH_TYPE *hashes;
670 static int check_disk_storage_column(struct osl_table *t, int row_num,
671 int col_num, char *ds_name, unsigned *num_missing_objects)
675 char *path = disk_storage_path(t, col_num, ds_name);
676 unsigned dsnc = t->disk_storage_name_column;
677 struct osl_object obj;
679 DEBUG_LOG("checking if %s is a regular file\n", path);
680 ret = stat(path, &statbuf);
681 if (ret < 0 && errno == ENOENT) {
683 (*num_missing_objects)++;
684 ERROR_LOG("row %d: object %s is missing\n", row_num, path);
686 if (conf.dry_run_given)
688 NOTICE_LOG("trying to delete row %d\n", row_num);
689 ret = osl_get_row(t, dsnc, &obj, &row);
691 CRIT_LOG("unable to get row %d\n", row_num);
692 fsck_mark_row_invalid(t, row_num);
693 CRIT_LOG("Please re-run fsck\n");
696 ret = osl_del_row(t, row);
704 ret = -E_FSCK_NOT_A_REGULAR_FILE;
705 if (!(S_IFREG & statbuf.st_mode))
710 static int check_disk_storage_presence(struct osl_table *t)
713 struct osl_object obj, hash_obj = {.size = HASH_SIZE};
715 const struct osl_column_description *cd;
716 unsigned dsnc = t->disk_storage_name_column, missing_objects = 0;
720 hashes = fsck_malloc(t->num_rows * HASH_SIZE);
721 INFO_LOG("looking for missing disk storage objects\n");
722 for (i = 0; i < t->num_rows; i++) {
723 if (row_is_invalid(t, i))
725 ret = get_mapped_object(t, dsnc, i, &obj);
728 hash_object(&obj, hashes + i * HASH_SIZE);
729 hash_obj.data = hashes + i * HASH_SIZE;
730 osl_add_row(hash_tree_table, &hash_obj);
731 ds_name = disk_storage_name_of_hash(t, hashes + i * HASH_SIZE);
732 FOR_EACH_DISK_STORAGE_COLUMN(j, t, cd) {
733 ret = check_disk_storage_column(t, i, j, ds_name,
740 if (!missing_objects)
741 INFO_LOG("all referenced disk storage objects exist, good\n");
743 NOTICE_LOG("%d missing object(s)\n", missing_objects);
744 return missing_objects;
750 static int dummy_compare(const struct osl_object *obj1, const struct osl_object *obj2)
759 static unsigned files_pruned;
761 static int prune_disk_storage_file(const char *path, void *private_data)
763 HASH_TYPE hash[HASH_SIZE];
764 uint8_t flags = *(uint8_t *)private_data;
765 struct osl_object obj = {.data = hash, .size = HASH_SIZE};
768 size_t len = strlen(path);
771 DEBUG_LOG("path: %s\n", path);
772 if (flags & OSL_LARGE_TABLE) {
773 if (len < HASH_SIZE * 2 + 2)
775 // NOTICE_LOG("p: %s\n", path + len - 2 * HASH_SIZE - 1);
776 ret = asc_to_hash(path + len - 2 * HASH_SIZE - 1, 1, hash);
779 ret = asc_to_hash(path + len - 2 * HASH_SIZE + 2, HASH_SIZE - 1,
783 // INFO_LOG("high: %x, low: %x, hash: %x\n", high, low, hash);
785 if (len < 2 * HASH_SIZE + 1)
787 ret = asc_to_hash(path + len - 2 * HASH_SIZE, 2 * HASH_SIZE, hash);
790 // INFO_LOG("hash: %x\n", hash);
794 char asc[2 * HASH_SIZE + 1];
795 hash_to_asc(hash, asc);
796 NOTICE_LOG("before: %s\nafter: %s\n", path, asc);
799 ret = osl_get_row(hash_tree_table, 0, &obj, &row);
802 NOTICE_LOG("unreferenced file in hash dir: %s\n", path);
805 ERROR_LOG("could not read hash value of %s\n", path);
807 if (conf.dry_run_given)
809 NOTICE_LOG("removing %s\n", path);
815 static int prune_disk_storage_files(struct osl_table *t)
818 const struct osl_column_description *cd;
820 INFO_LOG("looking for unreferenced disk storage files\n");
821 FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd) {
822 char *dirname = column_filename(t, i);
823 uint8_t flags = t->desc->flags;
824 ret = for_each_file_in_dir(dirname, prune_disk_storage_file,
829 NOTICE_LOG("%u disk storage files deleted\n",
832 INFO_LOG("all files are are referenced, good\n");
836 static int check_disk_storage_columns(struct osl_table *t)
839 const struct osl_column_description *cd;
841 if (!t->num_disk_storage_columns) {
842 INFO_LOG("no disk storage columns in table '%s', "
843 "skipping checks\n", t->desc->name);
846 FOR_EACH_COLUMN(i, t->desc, cd)
847 t->desc->column_descriptions[i].compare_function = dummy_compare;
848 ret = init_rbtrees(t);
851 INFO_LOG("creating rbtree for disk storage hash values\n");
852 ret = osl_open_table(&hash_tree_table_desc, &hash_tree_table);
855 ret = check_disk_storage_presence(t);
857 goto out_close_hash_tree;
858 ret = prune_disk_storage_files(t);
860 osl_close_table(hash_tree_table, 0);
864 clear_rbtrees(t); /* TODO why are we doing that here? Seems odd */
868 static void set_dummy_contents(struct osl_table_description *desc)
871 struct osl_column_description *cd;
873 for (i = 0; i < desc->num_columns; i++) {
874 cd = get_column_description(desc, i);
875 cd->compare_function = dummy_compare;
879 static int fsck_init(struct osl_table_description *desc, struct osl_table **t)
881 struct osl_object map;
882 int ret = map_index(desc, &map);
886 ret = read_table_desc(&map, desc);
888 osl_munmap(map.data, map.size);
891 set_dummy_contents(desc);
892 ret = init_table_structure(desc, t);
894 osl_munmap(map.data, map.size);
897 DEBUG_LOG("unmapping index\n");
898 osl_munmap(map.data, map.size);
899 if (conf.force_given)
900 ret = map_table(*t, (MAP_TBL_FL_IGNORE_DIRTY));
902 ret = map_table(*t, 0);
904 (*t)->num_rows = table_num_rows(*t);
905 DEBUG_LOG("index header size: %d\n", (*t)->index_header_size);
906 DEBUG_LOG("row index size: %d\n", (*t)->row_index_size);
912 static void fsck_cleanup(struct osl_table *t)
918 if (t->desc->column_descriptions) {
919 struct osl_column_description *cd;
920 for (i = 0; i < t->desc->num_columns; i++) {
921 cd = get_column_description(t->desc, i);
922 free((char*)cd->name);
924 free(t->desc->column_descriptions);
931 #define ST_CASE(st) case st: return #st
933 static const char *get_asc_storage_type(enum osl_storage_type st)
936 ST_CASE(OSL_MAPPED_STORAGE);
937 ST_CASE(OSL_DISK_STORAGE);
938 ST_CASE(OSL_NO_STORAGE);
943 #define APPEND_ASC_SF(sf, flag, str) do { if (sf & flag) { \
944 if (str) str = make_message("%s%s", str, " | " # flag); \
945 else str = fsck_strdup(#flag); }} while (0)
948 static char *get_asc_storage_flags(enum osl_storage_type sf)
952 APPEND_ASC_SF(sf, OSL_RBTREE, asc_sf);
953 APPEND_ASC_SF(sf, OSL_FIXED_SIZE, asc_sf);
954 APPEND_ASC_SF(sf, OSL_UNIQUE, asc_sf);
958 static int dump_table_desc(struct osl_table *t, int fd)
960 const struct osl_table_description *desc = t->desc;
962 struct osl_column_description *cd;
963 char *msg = make_message("static struct osl_column_description cols[] = {\n");
964 ret = _write_all(fd, msg, strlen(msg));
968 FOR_EACH_COLUMN(i, desc, cd) {
970 msg = make_message("\t[%d] = {\n", i);
971 ret = _write_all(fd, msg, strlen(msg));
975 asc_st = get_asc_storage_type(cd->storage_type);
976 msg = make_message("\t\t.storage_type = %s,\n", asc_st);
977 ret = _write_all(fd, msg, strlen(msg));
981 if (cd->storage_flags) {
982 char *asc_sf = get_asc_storage_flags(cd->storage_flags);
983 msg = make_message("\t\t,storage_flags = %s,\n", asc_sf);
985 ret = _write_all(fd, msg, strlen(msg));
990 if (cd->storage_flags & OSL_FIXED_SIZE) {
991 msg = make_message("\t\t.data_size = %u,\n", cd->data_size);
992 ret = _write_all(fd, msg, strlen(msg));
997 msg = make_message("\t\t.name = \"%s\",\n", cd->name);
998 ret = _write_all(fd, msg, strlen(msg));
1002 if (cd->storage_flags & OSL_RBTREE) {
1003 msg = make_message("\t\t.compare_function = compare_func,\n");
1004 ret = _write_all(fd, msg, strlen(msg));
1009 msg = make_message("\t},\n");
1010 ret = _write_all(fd, msg, strlen(msg));
1015 msg = make_message("};\n");
1016 ret = _write_all(fd, msg, strlen(msg));
1023 static int dump_row(struct osl_table *t, unsigned row_num, const char *row_dir)
1026 const struct osl_column_description *cd;
1028 struct osl_object obj;
1030 HASH_TYPE hash[HASH_SIZE];
1033 FOR_EACH_MAPPED_COLUMN(i, t, cd) {
1034 ret = get_mapped_object(t, i, row_num, &obj);
1037 filename = make_message("%s/col_%03u", row_dir, i);
1038 ret = write_file(filename, obj.data, obj.size);
1043 if (!t->num_disk_storage_columns)
1045 dsnc = t->disk_storage_name_column;
1046 ret = get_mapped_object(t, dsnc, row_num, &obj);
1049 hash_object(&obj, hash);
1050 ds_name = disk_storage_name_of_hash(t, hash);
1051 FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd) {
1052 filename = disk_storage_path(t, i, ds_name);
1053 ret = mmap_full_file(filename, O_RDONLY, &obj.data, &obj.size, NULL);
1057 filename = make_message("%s/col_%03u", row_dir, i);
1058 ret = write_file(filename, obj.data, obj.size);
1069 static int dump_rows(char *dump_dir, struct osl_table *t)
1072 char *current_dir = NULL;
1075 for (i = 0; i < t->num_rows; i++) {
1077 if (row_is_invalid(t, i))
1081 current_dir = make_message("%s/rows_%u-%u", dump_dir, i, i + 999);
1082 NOTICE_LOG("dumping rows %u - %u\n", i, i + 999);
1083 ret = osl_mkdir(current_dir, 0777);
1084 if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
1087 row_dir = make_message("%s/row_%03u", current_dir, i);
1088 ret = osl_mkdir(row_dir, 0777);
1089 if (ret < 0 && ret != -E_OSL_DIR_EXISTS) {
1093 ret = dump_row(t, i, row_dir);
1103 static int dump_table(char *dump_dir, struct osl_table_description *desc)
1105 struct osl_table *t = NULL;
1106 int fd, ret = fsck_init(desc, &t);
1108 char *table_dump_dir = NULL;
1112 ret = osl_mkdir(dump_dir, 0777);
1113 if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
1115 table_dump_dir = make_message("%s/%s", dump_dir, desc->name);
1116 ret = osl_mkdir(table_dump_dir, 0777);
1117 if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
1119 desc_file = make_message("%s/table_description.c", table_dump_dir);
1120 ret = osl_open(desc_file, O_WRONLY | O_CREAT | O_EXCL, 0644);
1125 ret = dump_table_desc(t, fd);
1129 ret = dump_rows(table_dump_dir, t);
1131 free(table_dump_dir);
1136 static int fsck(struct osl_table_description *desc)
1139 struct osl_table *t = NULL;
1140 uint32_t *lost_bytes = NULL;
1142 ret = fsck_init(desc, &t);
1145 ret = check_index_ranges(t);
1148 ret = check_disk_storage_columns(t);
1151 ret = prune_invalid_rows_from_index(t);
1154 ret = check_for_invalid_objects(t, &lost_bytes);
1157 if (ret > 0 && !conf.dry_run_given) { /* at least one mapped data file needs pruning */
1158 ret = prune_objects(t, lost_bytes);
1164 unmap_table(t, OSL_MARK_CLEAN);
1170 static int check_table(char *db_dir, char *table_name)
1172 struct osl_table_description desc = {
1173 .column_descriptions = NULL,
1179 INFO_LOG("checking table %s\n", table_name);
1180 if (!conf.no_fsck_given) {
1186 if (!conf.dump_dir_given || !*conf.dump_dir_arg)
1188 ret = dump_table(conf.dump_dir_arg, &desc);
1191 ERROR_LOG("failed to check table %s: %s\n", table_name,
1192 fsck_strerror(-ret));
1194 NOTICE_LOG("successfully checked table %s\n", table_name);
1198 static int check_all_tables(char *db_dir)
1201 struct dirent *entry;
1202 int cwd_fd, ret2, ret = fsck_opendir(db_dir, &dir, &cwd_fd);
1206 while ((entry = readdir(dir))) {
1209 if (!strcmp(entry->d_name, "."))
1211 if (!strcmp(entry->d_name, ".."))
1213 if (lstat(entry->d_name, &s) == -1)
1218 ret = check_table(db_dir, entry->d_name);
1223 ret2 = __fchdir(cwd_fd);
1224 if (ret2 < 0 && ret >= 0)
1230 int main(int argc, char **argv)
1233 struct fsck_cmdline_parser_params params = {
1236 .check_required = 1,
1237 .check_ambiguity = 1,
1240 ret = fsck_cmdline_parser_ext(argc, argv, &conf, ¶ms);
1243 ret = -E_FSCK_SYNTAX;
1246 loglevel = conf.loglevel_arg;
1247 HANDLE_VERSION_FLAG("fsck", conf);
1248 INFO_LOG("database dir: %s\n", conf.database_dir_arg);
1249 if (!conf.inputs_num) {
1250 ret = check_all_tables(conf.database_dir_arg);
1253 for (i = 0; i < conf.inputs_num; i++) {
1254 ret = check_table(conf.database_dir_arg, conf.inputs[i]);
1260 ERROR_LOG("%s\n", fsck_strerror(-ret));
1261 if (conf.loglevel_arg > 1)
1262 EMERG_LOG("re-run with \"--loglevel %d\" to increase verbosity\n",
1263 conf.loglevel_arg - 1);
1265 NOTICE_LOG("success\n");
1266 return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;