Add target for man page, install oslfsck and its man page on make install.
[osl.git] / fsck.c
diff --git a/fsck.c b/fsck.c
index dea7ad6..f700e9f 100644 (file)
--- a/fsck.c
+++ b/fsck.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 #include "log.h"
 #include "osl.h"
-#include "error.h"
-#include "fd.h"
+#include "util.h"
 #include "osl_core.h"
 #include "fsck.cmdline.h"
 
 /** version text used by various commands if -V switch was given */
 #define VERSION_TEXT(prefix) "osl_" prefix " " VERSION " " "\n" \
-       "Copyright (C) 2008 Andre Noll\n" \
+       "Copyright (C) 2008-2009 Andre Noll\n" \
        "This is free software with ABSOLUTELY NO WARRANTY." \
        " See COPYING for details.\n" \
        "Written by Andre Noll.\n" \
@@ -39,8 +38,12 @@ static struct fsck_args_info conf;
 #define FSCK_ERRORS \
        FSCK_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
        FSCK_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
-       FSCK_ERROR(SYNTAX, "fsck syntax error"),
+       FSCK_ERROR(SYNTAX, "fsck syntax error"), \
+       FSCK_ERROR(ACCESS, "permission denied"), \
+       FSCK_ERROR(CHDIR, "could not change directory"), \
+       FSCK_ERROR(OPENDIR, "could not open directory"),
 
+#define FSCK_ERROR_BIT 29
 #define FSCK_ERROR(num, txt) E_FSCK_ ## num
 enum {
        FSCK_DUMMY = (1 << FSCK_ERROR_BIT) - 1,
@@ -118,8 +121,8 @@ static int _write_all(int fd, const char *buf, size_t len)
        return write_all(fd, buf, &len);
 }
 
-/**
- * Paraslash's version of malloc().
+/*
+ * Wrapper for malloc().
  *
  * \param size The desired new size.
  *
@@ -130,7 +133,7 @@ static int _write_all(int fd, const char *buf, size_t len)
  *
  * \sa malloc(3).
  */
-__must_check __malloc static void *para_malloc(size_t size)
+__must_check __malloc static void *fsck_malloc(size_t size)
 {
        assert(size);
        void *p = malloc(size);
@@ -144,7 +147,7 @@ __must_check __malloc static void *para_malloc(size_t size)
 }
 
 /**
- * Paraslash's version of calloc().
+ * Allocate memory and fill with zeros.
  *
  * \param size The desired new size.
  *
@@ -155,16 +158,16 @@ __must_check __malloc static void *para_malloc(size_t size)
  *
  * \sa calloc(3)
  */
-__must_check __malloc static void *para_calloc(size_t size)
+__must_check __malloc static void *fsck_calloc(size_t size)
 {
-       void *ret = para_malloc(size);
+       void *ret = fsck_malloc(size);
 
        memset(ret, 0, size);
        return ret;
 }
 
 /**
- * Paraslash's version of strdup().
+ * Save version of strdup().
  *
  * \param s The string to be duplicated.
  *
@@ -176,7 +179,7 @@ __must_check __malloc static void *para_calloc(size_t size)
  *
  * \sa strdup(3)
  */
-__must_check __malloc static char *para_strdup(const char *s)
+__must_check __malloc static char *fsck_strdup(const char *s)
 {
        char *ret;
 
@@ -208,6 +211,86 @@ static int uint32_compare(const struct osl_object *obj1, const struct osl_object
        return 0;
 }
 
+/**
+ * A wrapper for fchdir().
+ *
+ * \param fd An open file descriptor.
+ *
+ * \return Standard.
+ */
+static inline int __fchdir(int fd)
+{
+       if (fchdir(fd) >= 0)
+               return 1;
+       return errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_CHDIR;
+}
+
+/**
+ * Wrapper for chdir(2).
+ *
+ * \param path The specified directory.
+ *
+ * \return Standard.
+ */
+_static_inline_ int __chdir(const char *path)
+{
+       if (chdir(path) >= 0)
+               return 1;
+       return errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_CHDIR;
+}
+
+/**
+ * Save the cwd and open a given directory.
+ *
+ * \param dirname Path to the directory to open.
+ * \param dir Result pointer.
+ * \param cwd File descriptor of the current working directory.
+ *
+ * \return Standard.
+ *
+ * Opening the current directory (".") and calling fchdir() to return is
+ * usually faster and more reliable than saving cwd in some buffer and calling
+ * chdir() afterwards.
+ *
+ * If \a cwd is not \p NULL "." is opened and the resulting file descriptor is
+ * stored in \a cwd. If the function returns success, and \a cwd is not \p
+ * NULL, the caller must close this file descriptor (probably after calling
+ * fchdir(*cwd)).
+ *
+ * On errors, the function undos everything, so the caller needs neither close
+ * any files, nor change back to the original working directory.
+ *
+ * \sa getcwd(3).
+ *
+ */
+static int fsck_opendir(const char *dirname, DIR **dir, int *cwd)
+{
+       int ret;
+
+       if (cwd) {
+               ret = osl_open(".", O_RDONLY, 0);
+               if (ret < 0)
+                       return ret;
+               *cwd = ret;
+       }
+       ret = __chdir(dirname);
+       if (ret < 0)
+               goto close_cwd;
+       *dir = opendir(".");
+       if (*dir)
+               return 1;
+       ret = errno == EACCES? -E_FSCK_ACCESS : -E_FSCK_OPENDIR;
+/* Ignore return value of fchdir() and close(). We're busted anyway. */
+       if (cwd)
+               fchdir(*cwd);
+close_cwd:
+       if (cwd)
+               close(*cwd);
+       return ret;
+}
+
+
+
 /**
  * Traverse the given directory recursively.
  *
@@ -227,10 +310,10 @@ static int for_each_file_in_dir(const char *dirname,
 {
        DIR *dir;
        struct dirent *entry;
-       int cwd_fd, ret2, ret = para_opendir(dirname, &dir, &cwd_fd);
+       int cwd_fd, ret2, ret = fsck_opendir(dirname, &dir, &cwd_fd);
 
        if (ret < 0)
-               return ret == -ERRNO_TO_ERROR(EACCES)? 1 : ret;
+               return ret == -E_FSCK_ACCESS? 1 : ret;
        /* scan cwd recursively */
        while ((entry = readdir(dir))) {
                mode_t m;
@@ -263,7 +346,7 @@ static int for_each_file_in_dir(const char *dirname,
        ret = 1;
 out:
        closedir(dir);
-       ret2 = para_fchdir(cwd_fd);
+       ret2 = __fchdir(cwd_fd);
        if (ret2 < 0 && ret >= 0)
                ret = ret2;
        close(cwd_fd);
@@ -316,24 +399,17 @@ static int check_index_ranges(struct osl_table *t)
        //DEBUG_LOG("%d rows. %d columns\n", t->num_rows, t->desc->num_columns);
        t->num_invalid_rows = 0;
        for (i = 0; i < t->num_rows; i++) {
+               const struct osl_column_description *cd;
+
                if (row_is_invalid(t, i)) {
                        t->num_invalid_rows++;
                        continue;
                }
-               for (j = 0; j < t->desc->num_columns; j++) { /* FXIME */
-                       const struct osl_column_description *cd =
-                               get_column_description(t->desc, j);
-                       if (cd->storage_type != OSL_MAPPED_STORAGE)
-                               continue;
+               FOR_EACH_MAPPED_COLUMN(j, t, cd) {
                        ret = check_range(t, i, j);
                        if (ret < 0) {
-                               if (ret != -E_OSL_INVALID_OBJECT &&
-                                               ret != -E_FSCK_RANGE_VIOLATION)
+                               if (ret != -E_FSCK_RANGE_VIOLATION)
                                        goto err;
-                               if (ret == -E_OSL_INVALID_OBJECT) {
-                                       CRIT_LOG("row %d, col %d maps to an "
-                                               "invalid object\n", i, j);
-                               }
                                ret = mark_row_invalid(t, i);
                                if (ret < 0)
                                        goto err;
@@ -412,7 +488,7 @@ static int prune_invalid_rows_from_index(struct osl_table *t)
        DEBUG_LOG("unmapping index\n");
        osl_munmap(t->index_map.data, t->index_map.size);
        filename = index_filename(t->desc);
-       ret = para_truncate(filename, t->row_index_size
+       ret = truncate_file(filename, t->row_index_size
                * t->num_invalid_rows);
        free(filename);
        if (ret < 0)
@@ -428,23 +504,20 @@ static int check_for_invalid_objects(struct osl_table *t, uint32_t **lost_bytes)
 {
        int i, j, ret;
        const struct osl_column_description *cd;
-       uint32_t *loss = para_malloc(sizeof(uint32_t) * t->desc->num_columns);
+       uint32_t *loss = fsck_malloc(sizeof(uint32_t) * t->desc->num_columns);
 
        INFO_LOG("looking for mapped objects not contained in index\n");
        /* first count used bytes */
        FOR_EACH_MAPPED_COLUMN(i, t, cd) {
                loss[i] = t->columns[i].data_map.size;
+               DEBUG_LOG("column %i data map: %u bytes\n", i,
+                       t->columns[i].data_map.size);
                for (j = 0; j < t->num_rows; j++) {
                        struct osl_object obj;
                        ret = get_mapped_object(t, i, j, &obj);
-                       if (ret >= 0) {
-                               loss[i] -= obj.size + 1; /* add one for header byte */
-                               continue;
-                       }
-                       if (ret != -E_OSL_INVALID_OBJECT)
+                       if (ret < 0)
                                goto err;
-                       CRIT_LOG("row %d, col %d points to an invalid "
-                               "mapped object, bad\n", j, i);
+                       loss[i] -= obj.size;
                }
        }
        ret = 0;
@@ -480,10 +553,10 @@ static int prune_mapped_column(struct osl_table *t, uint32_t col_num, int fd)
                ret = get_mapped_object(t, col_num, i, &obj);
                if (ret < 0)
                        return ret;
-               ret = _write_all(fd, (char *)(obj.data) - 1, obj.size + 1);
+               ret = _write_all(fd, (char *)(obj.data), obj.size);
                if (ret < 0)
                        return ret;
-               written += obj.size + 1;
+               written += obj.size;
                ret = get_row_index(t, i, &index_entry);
                if (ret < 0)
                        return ret;
@@ -496,15 +569,16 @@ static int prune_objects(struct osl_table *t, uint32_t *lost_bytes)
 {
        int i, ret;
        const struct osl_column_description *cd;
-       char **col_filenames = para_calloc(t->desc->num_columns * sizeof(char *));
-       char **new_col_filenames = para_calloc(t->desc->num_columns * sizeof(char *));
+       char **col_filenames = fsck_calloc(t->desc->num_columns * sizeof(char *));
+       char **new_col_filenames = fsck_calloc(t->desc->num_columns * sizeof(char *));
        char *idx_filename = index_filename(t->desc);
        char *old_idx_filename = make_message("%s.bak", idx_filename);
        int fd;
 
        NOTICE_LOG("removing unreferenced objects from data files\n");
        /* first make a copy of the index */
-       ret = osl_open(old_idx_filename, O_WRONLY | O_CREAT | O_EXCL, 0644);
+       DEBUG_LOG("opening %s\n", old_idx_filename);
+       ret = osl_open(old_idx_filename, O_WRONLY | O_CREAT | O_TRUNC, 0644);
        if (ret < 0)
                goto out_free;
        fd = ret;
@@ -630,7 +704,7 @@ static int check_disk_storage_presence(struct osl_table *t)
 
        if (!t->num_rows)
                return 1;
-       hashes = para_malloc(t->num_rows * HASH_SIZE);
+       hashes = fsck_malloc(t->num_rows * HASH_SIZE);
        INFO_LOG("looking for missing disk storage objects\n");
        for (i = 0; i < t->num_rows; i++) {
                if (row_is_invalid(t, i))
@@ -674,7 +748,7 @@ static unsigned files_pruned;
 int prune_disk_storage_file(const char *path, void *private_data)
 {
        HASH_TYPE hash[HASH_SIZE];
-       unsigned flags = *(unsigned *)private_data;
+       uint8_t flags = *(uint8_t *)private_data;
        struct osl_object obj = {.data = hash, .size = HASH_SIZE};
        struct osl_row *row;
        int ret = -1;
@@ -731,8 +805,9 @@ static int prune_disk_storage_files(struct osl_table *t)
        INFO_LOG("looking for unreferenced disk storage files\n");
        FOR_EACH_DISK_STORAGE_COLUMN(i, t, cd) {
                char *dirname = column_filename(t, i);
+               uint8_t flags = t->desc->flags;
                ret = for_each_file_in_dir(dirname, prune_disk_storage_file,
-                       (unsigned *)&t->desc->flags);
+                       &flags);
                free(dirname);
        }
        if (files_pruned)
@@ -810,8 +885,11 @@ static int fsck_init(struct osl_table_description *desc, struct osl_table **t)
                ret = map_table(*t, (MAP_TBL_FL_IGNORE_DIRTY));
        else
                ret = map_table(*t, 0);
-       if (ret >= 0)
+       if (ret >= 0) {
                (*t)->num_rows = table_num_rows(*t);
+               DEBUG_LOG("index header size: %d\n", (*t)->index_header_size);
+               DEBUG_LOG("row index size: %d\n", (*t)->row_index_size);
+       }
 out:
        return ret;
 }
@@ -849,7 +927,7 @@ const char *get_asc_storage_type(enum osl_storage_type st)
 
 #define APPEND_ASC_SF(sf, flag, str) do { if (sf & flag) { \
        if (str) str = make_message("%s%s", str, " | " # flag); \
-       else str = para_strdup(#flag); }} while (0)
+       else str = fsck_strdup(#flag); }} while (0)
 
 
 char *get_asc_storage_flags(enum osl_storage_type sf)
@@ -988,12 +1066,12 @@ static int dump_rows(char *dump_dir, struct osl_table *t)
                        current_dir = make_message("%s/rows_%u-%u", dump_dir, i, i + 999);
                        NOTICE_LOG("dumping rows %u - %u\n", i, i + 999);
                        ret = osl_mkdir(current_dir, 0777);
-                       if (ret < 0 && !is_errno(-ret, EEXIST))
+                       if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
                                goto out;
                }
                row_dir = make_message("%s/row_%03u", current_dir, i);
                ret = osl_mkdir(row_dir, 0777);
-               if (ret < 0 && !is_errno(-ret, EEXIST)) {
+               if (ret < 0 && ret != -E_OSL_DIR_EXISTS) {
                        free(row_dir);
                        goto out;
                }
@@ -1017,11 +1095,11 @@ static int dump_table(char *dump_dir, struct osl_table_description *desc)
        if (ret < 0)
                goto out;
        ret = osl_mkdir(dump_dir, 0777);
-       if (ret < 0 && !is_errno(-ret, EEXIST))
+       if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
                goto out;
        table_dump_dir = make_message("%s/%s", dump_dir, desc->name);
        ret = osl_mkdir(table_dump_dir, 0777);
-       if (ret < 0 && !is_errno(-ret, EEXIST))
+       if (ret < 0 && ret != -E_OSL_DIR_EXISTS)
                goto out;
        desc_file = make_message("%s/table_description.c", table_dump_dir);
        ret = osl_open(desc_file, O_WRONLY | O_CREAT | O_EXCL, 0644);
@@ -1095,7 +1173,8 @@ static int check_table(char *db_dir, char *table_name)
        ret = dump_table(conf.dump_dir_arg, &desc);
 out:
        if (ret < 0)
-               ERROR_LOG("failed to check table %s\n", table_name);
+               ERROR_LOG("failed to check table %s: %s\n", table_name,
+                       fsck_strerror(-ret));
        else
                NOTICE_LOG("successfully checked table %s\n", table_name);
        return ret;
@@ -1105,7 +1184,7 @@ static int check_all_tables(char *db_dir)
 {
        DIR *dir;
        struct dirent *entry;
-       int cwd_fd, ret2, ret = para_opendir(db_dir, &dir, &cwd_fd);
+       int cwd_fd, ret2, ret = fsck_opendir(db_dir, &dir, &cwd_fd);
 
        if (ret < 0)
                return ret;
@@ -1126,7 +1205,7 @@ static int check_all_tables(char *db_dir)
                        break;
        }
        closedir(dir);
-       ret2 = para_fchdir(cwd_fd);
+       ret2 = __fchdir(cwd_fd);
        if (ret2 < 0 && ret >= 0)
                ret = ret2;
        close(cwd_fd);