/*
- * Copyright (C) 2007-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2007-2009 Andre Noll <maan@tuebingen.mpg.de>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include <sys/stat.h>
#include <sys/types.h>
#include <dirent.h>
+#include <lopsub.h>
#include <assert.h>
#include <pwd.h>
#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" \
- "This is free software with ABSOLUTELY NO WARRANTY." \
- " See COPYING for details.\n" \
- "Written by Andre Noll.\n" \
- "Report bugs to <maan@systemlinux.org>.\n"
-
-/** print out \p VERSION_TEXT and exit if version flag was given */
-#define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
- if (_args_info_struct.version_given) { \
- printf("%s", VERSION_TEXT(_prefix)); \
- exit(EXIT_SUCCESS); \
- }
+#include "oslfsck.lsg.h"
-static struct fsck_args_info conf;
+static struct lls_parse_result *lpr;
+#define CMD_PTR (lls_cmd(0, oslfsck_suite))
+#define OPT_RESULT(_name) \
+ (lls_opt_result(LSG_OSLFSCK_OSLFSCK_OPT_ ## _name, lpr))
+#define OPT_GIVEN(_name) (lls_opt_given(OPT_RESULT(_name)))
+#define OPT_STRING_VAL(_name) (lls_string_val(0, OPT_RESULT(_name)))
+#define OPT_UINT32_VAL(_name) (lls_uint32_val(0, OPT_RESULT(_name)))
#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,
};
#undef FSCK_ERROR
#define FSCK_ERROR(num, txt) txt
-const char const *fsck_errors[] = {
+static const char *fsck_errors[] = {
FSCK_ERRORS
};
extern int loglevel;
/* taken from git */
-signed char hexval_table[256] = {
+static signed char hexval_table[256] = {
-1, -1, -1, -1, -1, -1, -1, -1, /* 00-07 */
-1, -1, -1, -1, -1, -1, -1, -1, /* 08-0f */
-1, -1, -1, -1, -1, -1, -1, -1, /* 10-17 */
-1, -1, -1, -1, -1, -1, -1, -1, /* f8-ff */
};
-int asc_to_hash(const char *asc_hash, int len, HASH_TYPE *hash)
+static int asc_to_hash(const char *asc_hash, int len, HASH_TYPE *hash)
{
int i = 0;
const unsigned char *asc = (const unsigned char *) asc_hash;
return write_all(fd, buf, &len);
}
-/**
- * Paraslash's version of malloc().
+/*
+ * Wrapper for malloc().
*
* \param size The desired new size.
*
}
/**
- * Paraslash's version of calloc().
+ * Allocate memory and fill with zeros.
*
* \param size The desired new size.
*
}
/**
- * Paraslash's version of strdup().
+ * Save version of strdup().
*
* \param s The string to be duplicated.
*
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) {
+ int __a_unused ret2 = fchdir(*cwd); /* STFU, gcc */
+ }
+close_cwd:
+ if (cwd)
+ close(*cwd);
+ return ret;
+}
+
+
+
/**
* Traverse the given directory recursively.
*
{
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;
ret = 1;
out:
closedir(dir);
- ret2 = para_fchdir(cwd_fd);
+ ret2 = __fchdir(cwd_fd);
if (ret2 < 0 && ret >= 0)
ret = ret2;
close(cwd_fd);
return 1;
}
+static int fsck_mark_row_invalid(struct osl_table *t, int i)
+{
+ if (OPT_GIVEN(DRY_RUN))
+ return 0;
+ return mark_row_invalid(t, i);
+}
+
/*
* check all cells of the given table for boundary violations
*/
//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);
+ ret = fsck_mark_row_invalid(t, i);
if (ret < 0)
goto err;
t->num_invalid_rows++;
INFO_LOG("all rows are valid, good\n");
return 1;
}
- NOTICE_LOG("deleting %u invalid row(s) (%d bytes) from index\n",
+ NOTICE_LOG("index contains %u invalid row(s) (%d bytes)\n",
t->num_invalid_rows, t->row_index_size * t->num_invalid_rows);
+ if (OPT_GIVEN(DRY_RUN))
+ return 0;
+ NOTICE_LOG("removing invalid rows from index\n");
bottom = t->num_rows - 1;
while (top < bottom) {
if (!row_is_invalid(t, top)) {
/* 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: %zu 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;
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;
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;
struct osl_row *row;
(*num_missing_objects)++;
ERROR_LOG("row %d: object %s is missing\n", row_num, path);
+ ret = 0;
+ if (OPT_GIVEN(DRY_RUN))
+ goto out;
NOTICE_LOG("trying to delete row %d\n", row_num);
ret = osl_get_row(t, dsnc, &obj, &row);
if (ret < 0) {
CRIT_LOG("unable to get row %d\n", row_num);
- mark_row_invalid(t, row_num);
+ fsck_mark_row_invalid(t, row_num);
CRIT_LOG("Please re-run fsck\n");
goto out;
}
static unsigned files_pruned;
-int prune_disk_storage_file(const char *path, void *private_data)
+static 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;
invalid:
ERROR_LOG("could not read hash value of %s\n", path);
remove:
+ if (OPT_GIVEN(DRY_RUN))
+ return 0;
NOTICE_LOG("removing %s\n", path);
unlink(path);
files_pruned++;
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)
}
DEBUG_LOG("unmapping index\n");
osl_munmap(map.data, map.size);
- if (conf.force_given)
+ if (OPT_GIVEN(FORCE))
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;
}
#define ST_CASE(st) case st: return #st
-const char *get_asc_storage_type(enum osl_storage_type st)
+static const char *get_asc_storage_type(enum osl_storage_type st)
{
switch (st) {
ST_CASE(OSL_MAPPED_STORAGE);
else str = fsck_strdup(#flag); }} while (0)
-char *get_asc_storage_flags(enum osl_storage_type sf)
+static char *get_asc_storage_flags(enum osl_storage_type sf)
{
char *asc_sf = NULL;
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;
}
return ret;
}
-static int dump_table(char *dump_dir, struct osl_table_description *desc)
+static int dump_table(const char *dump_dir, struct osl_table_description *desc)
{
struct osl_table *t = NULL;
int fd, ret = fsck_init(desc, &t);
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);
ret = check_for_invalid_objects(t, &lost_bytes);
if (ret < 0)
goto out_unmap;
- if (ret > 0) { /* at least one mapped data file needs pruning */
+ if (ret > 0 && !OPT_GIVEN(DRY_RUN)) {
+ /* at least one mapped data file needs pruning */
ret = prune_objects(t, lost_bytes);
if (ret < 0)
goto out_unmap;
return ret;
}
-static int check_table(char *db_dir, char *table_name)
+static int check_table(const char *db_dir, const char *table_name)
{
struct osl_table_description desc = {
.column_descriptions = NULL,
int ret;
INFO_LOG("checking table %s\n", table_name);
- if (!conf.no_fsck_given) {
+ if (!OPT_GIVEN(NO_FSCK)) {
ret = fsck(&desc);
if (ret < 0)
goto out;
}
ret = 1;
- if (!conf.dump_dir_given || !*conf.dump_dir_arg)
+ if (!OPT_GIVEN(DUMP_DIR) || !*OPT_STRING_VAL(DUMP_DIR))
goto out;
- ret = dump_table(conf.dump_dir_arg, &desc);
+ ret = dump_table(OPT_STRING_VAL(DUMP_DIR), &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;
}
-static int check_all_tables(char *db_dir)
+static int check_all_tables(const 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;
break;
}
closedir(dir);
- ret2 = para_fchdir(cwd_fd);
+ ret2 = __fchdir(cwd_fd);
if (ret2 < 0 && ret >= 0)
ret = ret2;
close(cwd_fd);
int main(int argc, char **argv)
{
int i, ret;
- struct fsck_cmdline_parser_params params = {
- .override = 0,
- .initialize = 1,
- .check_required = 1,
- .check_ambiguity = 1,
- .print_errors = 1
- };
- ret = fsck_cmdline_parser_ext(argc, argv, &conf, ¶ms);
+ char *errctx = NULL;
+ const char *dd;
+
+ loglevel = 0;
+ ret = lls_parse(argc, argv, CMD_PTR, &lpr, &errctx);
if (ret < 0) {
- loglevel = EMERG;
- ret = -E_FSCK_SYNTAX;
- goto out;
+ if (errctx)
+ ERROR_LOG("%s\n", errctx);
+ EMERG_LOG("%s\n", lls_strerror(-ret));
+ exit(EXIT_FAILURE);
+ }
+ loglevel = OPT_UINT32_VAL(LOGLEVEL);
+ if (OPT_GIVEN(DETAILED_HELP)) {
+ printf("%s\n", lls_long_help(CMD_PTR));
+ exit(EXIT_SUCCESS);
+ }
+ if (OPT_GIVEN(HELP)) {
+ printf("%s\n", lls_short_help(CMD_PTR));
+ exit(EXIT_SUCCESS);
+ }
+ if (OPT_GIVEN(VERSION)) {
+ printf(
+ "oslfsck " OSL_VERSION "\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"
+ "Report bugs to <maan@tuebingen.mpg.de>.\n"
+ );
+ exit(EXIT_SUCCESS);
+ }
+ dd = OPT_STRING_VAL(DATABASE_DIR);
+ if (!dd) {
+ EMERG_LOG("--database-dir: mandatory option not given\n");
+ exit(EXIT_FAILURE);
}
- loglevel = conf.loglevel_arg;
- HANDLE_VERSION_FLAG("fsck", conf);
- INFO_LOG("database dir: %s\n", conf.database_dir_arg);
- if (!conf.inputs_num) {
- ret = check_all_tables(conf.database_dir_arg);
+ INFO_LOG("database dir: %s\n", dd);
+ if (lls_num_inputs(lpr) == 0) {
+ ret = check_all_tables(dd);
goto out;
}
- for (i = 0; i < conf.inputs_num; i++) {
- ret = check_table(conf.database_dir_arg, conf.inputs[i]);
+ for (i = 0; i < lls_num_inputs(lpr); i++) {
+ ret = check_table(dd, lls_input(i, lpr));
if (ret < 0)
break;
}
out:
if (ret < 0) {
ERROR_LOG("%s\n", fsck_strerror(-ret));
- if (conf.loglevel_arg > 1)
+ if (loglevel > 1)
EMERG_LOG("re-run with \"--loglevel %d\" to increase verbosity\n",
- conf.loglevel_arg - 1);
+ loglevel - 1);
} else
NOTICE_LOG("success\n");
return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;