+/*
+ * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file adu.c \brief The main functions used by all modes of operation. */
+
+/**
+ * \mainpage adu API reference
+ *
+ * - Modes of operation: \ref select.c, \ref create.c, \ref interactive.c
+ * - User handling: \ref user.c
+ * - Error handling: \ref error.h
+ * - Library-type functions: \ref fd.c, \ref format.c, \ref string.c, \ref portable_io.h
+ */
+
#include "adu.h"
#include <dirent.h> /* readdir() */
#include <pwd.h>
-
-#include "gcc-compat.h"
+#include "format.h"
+#include "user.h"
+#include "select.cmdline.h"
+#include "select.h"
#include "cmdline.h"
#include "fd.h"
#include "string.h"
#include "error.h"
-#include "portable_io.h"
+/** Define the array of error descriptions. */
DEFINE_ERRLIST;
+
+/**
+ * The error code of the last called osl library function.
+ *
+ * \sa osl().
+ */
int osl_errno;
/** In case a signal is received, its number is stored here. */
/** Command line and config file options. */
struct gengetopt_args_info conf;
-/** Global dir count. */
-uint64_t num_dirs = 0;
-/** Global files count. */
-uint64_t num_files = 0;
-/** Global bytes count. */
-uint64_t num_bytes = 0;
-
-/** The number of different uids found so far. */
-uint32_t num_uids = 0;
+/** Options passed to --select-options. */
+struct select_args_info select_conf;
-/**
- * Contains info for each user that owns at least one regular file.
- *
- * Even users that are not taken into account because of the --uid
- * option occupy a slot in this hash table. This allows to find out
- * quicky whether a uid is admissible. And yes, this has to be fast.
- */
-struct user_info *uid_hash_table = NULL;
/**
* The table containing the directory names and statistics.
*/
struct osl_table *dir_table = NULL;
-/**
- * The array of all uid ranges that were given at the command line.
- */
-struct uid_range *admissible_uids;
-
-/** Evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y. */
-#define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
-
-/**
- * Compare the size of two directories
- *
- * \param obj1 Pointer to the first object.
- * \param obj2 Pointer to the second object.
- *
- * This function first compares the size values as usual integers. If they compare as
- * equal, the address of \a obj1 and \a obj2 are compared. So this compare function
- * returns zero if and only if \a obj1 and \a obj2 point to the same memory area.
- */
-static int size_compare(const struct osl_object *obj1, const struct osl_object *obj2)
-{
- uint64_t d1 = *(uint64_t *)obj1->data;
- uint64_t d2 = *(uint64_t *)obj2->data;
- int ret = NUM_COMPARE(d2, d1);
-
- if (ret)
- return ret;
- //INFO_LOG("addresses: %p, %p\n", obj1->data, obj2->data);
- return NUM_COMPARE(obj2->data, obj1->data);
-}
-
-/**
- * Compare two osl objects pointing to unsigned integers of 64 bit size.
- *
- * \param obj1 Pointer to the first integer.
- * \param obj2 Pointer to the second integer.
- *
- * \return The values required for an osl compare function.
- *
- * \sa osl_compare_func, osl_hash_compare().
- */
-static int uint64_compare(const struct osl_object *obj1,
- const struct osl_object *obj2)
-{
- uint64_t d1 = read_u64((const char *)obj1->data);
- uint64_t d2 = read_u64((const char *)obj2->data);
-
- if (d1 < d2)
- return 1;
- if (d1 > d2)
- return -1;
- return 0;
-}
-
static struct osl_column_description dir_table_cols[] = {
[DT_NAME] = {
.storage_type = OSL_MAPPED_STORAGE,
.column_descriptions = dir_table_cols,
};
-static struct osl_column_description user_table_cols[] = {
- [UT_DIR_NUM] = {
- .storage_type = OSL_MAPPED_STORAGE,
- .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
- .name = "dir_num",
- .compare_function = uint64_compare,
- .data_size = sizeof(uint64_t)
- },
- [UT_BYTES] = {
- .storage_type = OSL_MAPPED_STORAGE,
- .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE,
- .compare_function = size_compare,
- .name = "num_bytes",
- .data_size = sizeof(uint64_t)
- },
- [UT_FILES] = {
- .storage_type = OSL_MAPPED_STORAGE,
- .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE,
- .compare_function = size_compare,
- .name = "num_files",
- .data_size = sizeof(uint64_t)
- },
-};
-
-static int check_uid_arg(const char *arg, uint32_t *uid)
-{
- const uint32_t max = ~0U;
- /*
- * we need an 64-bit int for string -> uid conversion because strtoll()
- * returns a signed value.
- */
- int64_t val;
- int ret = atoi64(arg, &val);
-
- if (ret < 0)
- return ret;
- if (val < 0 || val > max)
- return -ERRNO_TO_ERROR(EINVAL);
- *uid = val;
- return 1;
-}
-
-static int parse_uid_range(const char *orig_arg, struct uid_range *ur)
-{
- int ret;
- char *arg = adu_strdup(orig_arg), *p = strchr(arg, '-');
-
- if (!p || p == arg) { /* -42 or 42 */
- ret = check_uid_arg(p? p + 1 : arg, &ur->high);
- if (ret < 0)
- goto out;
- ur->low = p? 0 : ur->high;
- ret = 1;
- goto out;
- }
- /* 42- or 42-4711 */
- *p = '\0';
- p++;
- ret = check_uid_arg(arg, &ur->low);
- if (ret < 0)
- goto out;
- ur->high = ~0U;
- if (*p) { /* 42-4711 */
- ret = check_uid_arg(p, &ur->high);
- if (ret < 0)
- goto out;
- }
- if (ur->low > ur->high)
- ret = -ERRNO_TO_ERROR(EINVAL);
-out:
- if (ret < 0)
- ERROR_LOG("bad uid option: %s\n", orig_arg);
- else
- INFO_LOG("admissible uid range: %u - %u\n", ur->low,
- ur->high);
- free(arg);
- return ret;
-}
-
/**
* The log function.
*
* \param ll Loglevel.
- * \param fml Usual format string.
+ * \param fmt Usual format string.
*
* All XXX_LOG() macros use this function.
*/
va_end(argp);
}
-static int add_directory(char *dirname, uint64_t *dir_num, uint64_t *parent_dir_num,
- uint64_t *dir_size, uint64_t *dir_files)
-{
- struct osl_object dir_objects[NUM_DT_COLUMNS];
-
- INFO_LOG("adding #%llu: %s\n", (long long unsigned)*dir_num, dirname);
- dir_objects[DT_NAME].data = dirname;
- dir_objects[DT_NAME].size = strlen(dirname) + 1;
- dir_objects[DT_NUM].data = dir_num;
- dir_objects[DT_NUM].size = sizeof(*dir_num);
- dir_objects[DT_PARENT_NUM].data = parent_dir_num;
- dir_objects[DT_PARENT_NUM].size = sizeof(*parent_dir_num);
- dir_objects[DT_BYTES].data = dir_size;
- dir_objects[DT_BYTES].size = sizeof(*dir_size);
- dir_objects[DT_FILES].data = dir_files;
- dir_objects[DT_FILES].size = sizeof(*dir_files);
- return osl(osl_add_row(dir_table, dir_objects));
-}
-
-static int open_user_table(struct user_info *ui, int create)
-{
- int ret;
- struct passwd *pw;
-
- ui->desc = adu_malloc(sizeof(*ui->desc));
- ui->desc->num_columns = NUM_UT_COLUMNS;
- ui->desc->flags = 0;
- ui->desc->column_descriptions = user_table_cols;
- ui->desc->dir = adu_strdup(conf.database_dir_arg);
- ui->desc->name = make_message("%u", (unsigned)ui->uid);
- pw = getpwuid(ui->uid);
- if (pw && pw->pw_name)
- ui->pw_name = adu_strdup(pw->pw_name);
-
- INFO_LOG(".............................uid #%u: %u\n",
- (unsigned)num_uids, (unsigned)ui->uid);
- if (create) {
- ret = osl(osl_create_table(ui->desc));
- if (ret < 0)
- goto err;
- num_uids++;
- }
- ret = osl(osl_open_table(ui->desc, &ui->table));
- if (ret < 0)
- goto err;
- return 1;
-err:
- free((char *)ui->desc->name);
- free((char *)ui->desc->dir);
- free(ui->pw_name);
- free(ui->desc);
- ui->desc->name = NULL;
- ui->desc->dir = NULL;
- ui->desc = NULL;
- ui->table = NULL;
- ui->flags = 0;
- return ret;
-}
-
-#define uid_hash_bits 8
-uint32_t uid_hash_table_size = 1 << uid_hash_bits;
-#define PRIME1 0x811c9dc5
-#define PRIME2 0x01000193
-
-void create_hash_table(void)
-{
- uid_hash_table = adu_calloc(uid_hash_table_size
- * sizeof(struct user_info));
-}
-
-static void free_hash_table(void)
-{
- free(uid_hash_table);
- uid_hash_table = NULL;
-}
-
-static int create_tables(void)
-{
- int ret;
-
- dir_table_desc.dir = adu_strdup(conf.database_dir_arg);
- ret = osl(osl_create_table(&dir_table_desc));
- if (ret < 0)
- return ret;
- create_hash_table();
- return 1;
-}
-
static void close_dir_table(void)
{
int ret;
if (!dir_table)
return;
+ NOTICE_LOG("closing dir table\n");
ret = osl(osl_close_table(dir_table, OSL_MARK_CLEAN));
if (ret < 0)
ERROR_LOG("failed to close dir table: %s\n", adu_strerror(-ret));
dir_table = NULL;
}
-static void close_user_table(struct user_info *ui)
-{
- int ret;
-
- if (!ui || !ui_used(ui) || !ui_admissible(ui))
- return;
- ret = osl(osl_close_table(ui->table, OSL_MARK_CLEAN));
- if (ret < 0)
- ERROR_LOG("failed to close user table %u: %s\n",
- (unsigned) ui->uid, adu_strerror(-ret));
- free((char *)ui->desc->name);
- ui->desc->name = NULL;
- free((char *)ui->desc->dir);
- ui->desc->dir = NULL;
- free(ui->pw_name);
- ui->pw_name = NULL;
- free(ui->desc);
- ui->desc = NULL;
- ui->table = NULL;
- ui->flags = 0;
-}
-
-static void close_user_tables(void)
-{
- struct user_info *ui;
-
- FOR_EACH_USER(ui)
- close_user_table(ui);
-}
-
-void close_all_tables(void)
+static void close_all_tables(void)
{
close_dir_table();
close_user_tables();
- free_hash_table();
}
static void signal_handler(int s)
signum = s;
}
+/**
+ * Check whether to terminate adu.
+ *
+ * Check whether a signal was caught that should terminate the
+ * adu process. If yes, close all osl tables and exit gracefully.
+ */
void check_signals(void)
{
if (likely(!signum))
return -E_SIGNAL_SIG_ERR;
if (signal(SIGTERM, &signal_handler) == SIG_ERR)
return -E_SIGNAL_SIG_ERR;
+ if (signal(SIGPIPE, &signal_handler) == SIG_ERR)
+ return -E_SIGNAL_SIG_ERR;
return 1;
}
-/*
- * We use a hash table of size s=2^uid_hash_bits to map the uids into the
- * interval [0..s]. Hash collisions are treated by open addressing, i.e.
- * unused slots in the table are used to store different uids that hash to the
- * same slot.
+/**
+ * Open the directory table.
*
- * If a hash collision occurs, different slots are successively probed in order
- * to find an unused slot for the new uid. Probing is implemented via a second
- * hash function that maps the uid to h=(uid * PRIME2) | 1, which is always an
- * odd number.
+ * \param create If non-zero, create the table first.
*
- * An odd number is sufficient to make sure each entry of the hash table gets
- * probed for probe_num between 0 and s-1 because s is a power of two, hence
- * the second hash value has never a common divisor with the hash table size.
- * IOW: h is invertible in the ring [0..s].
+ * \return Standard.
*/
-static uint32_t double_hash(uint32_t uid, uint32_t probe_num)
-{
- return (uid * PRIME1 + ((uid * PRIME2) | 1) * probe_num)
- % uid_hash_table_size;
-}
-
-static int uid_is_admissible(uint32_t uid)
-{
- int i;
-
- for (i = 0; i < conf.uid_given; i++) {
- struct uid_range *ur = admissible_uids + i;
-
- if (ur->low <= uid && ur->high >= uid)
- break;
- }
- i = !conf.uid_given || i < conf.uid_given;
- DEBUG_LOG("uid %u is %sadmissible\n", (unsigned)uid,
- i? "" : "not ");
- return i;
-}
-
-int search_uid(uint32_t uid, enum search_uid_flags flags,
- struct user_info **ui_ptr)
-{
- uint32_t p;
-
- for (p = 0; p < uid_hash_table_size; p++) {
- struct user_info *ui = uid_hash_table + double_hash(uid, p);
-
- if (!ui_used(ui)) {
- int ret;
- if (!flags)
- return -E_BAD_UID;
- ui->uid = uid;
- ui->flags |= UI_FL_SLOT_USED;
- if (!uid_is_admissible(uid))
- return 0;
- ui->flags |= UI_FL_ADMISSIBLE;
- ret = open_user_table(ui, flags & CREATE_USER_TABLE);
- if (ret < 0)
- return ret;
-
- if (ui_ptr)
- *ui_ptr = ui;
- return 1;
- }
- if (ui->uid != uid)
- continue;
- if (ui_ptr)
- *ui_ptr = ui;
- return 0;
- }
- return flags? -E_HASH_TABLE_OVERFLOW : -E_BAD_UID;
-}
-
-static int update_user_row(struct osl_table *t, uint64_t dir_num,
- uint64_t *add)
+int open_dir_table(int create)
{
- struct osl_row *row;
- struct osl_object obj = {.data = &dir_num, .size = sizeof(dir_num)};
-
- int ret = osl(osl_get_row(t, UT_DIR_NUM, &obj, &row));
-
- if (ret == -E_OSL && osl_errno != E_OSL_RB_KEY_NOT_FOUND)
- return ret;
- if (ret < 0) { /* this is the first file we add */
- struct osl_object objects[NUM_UT_COLUMNS];
- uint64_t num_files = 1;
-
- objects[UT_DIR_NUM].data = &dir_num;
- objects[UT_DIR_NUM].size = sizeof(dir_num);
- objects[UT_BYTES].data = add;
- objects[UT_BYTES].size = sizeof(*add);
- objects[UT_FILES].data = &num_files;
- objects[UT_FILES].size = sizeof(num_files);
- INFO_LOG("######################### ret: %d\n", ret);
- ret = osl(osl_add_row(t, objects));
- INFO_LOG("######################### ret: %d\n", ret);
- return ret;
- } else { /* add size and increment file count */
- uint64_t num;
- struct osl_object obj1, obj2 = {.data = &num, .size = sizeof(num)};
-
- ret = osl(osl_get_object(t, row, UT_BYTES, &obj1));
- if (ret < 0)
- return ret;
- num = *(uint64_t *)obj1.data + *add;
- ret = osl(osl_update_object(t, row, UT_BYTES, &obj2));
- if (ret < 0)
- return ret;
- ret = osl(osl_get_object(t, row, UT_FILES, &obj1));
- if (ret < 0)
- return ret;
- num = *(uint64_t *)obj1.data + 1;
- return osl(osl_update_object(t, row, UT_FILES, &obj2));
- }
-}
-/* id of the device containing the base dir. */
-static dev_t device_id;
+ if (dir_table)
+ return 1;
+ dir_table_desc.dir = adu_strdup(conf.database_dir_arg);
-static int scan_dir(char *dirname, uint64_t *parent_dir_num)
-{
- DIR *dir;
- struct dirent *entry;
- int ret, cwd_fd, ret2;
- uint64_t dir_size = 0, dir_files = 0;
- uint64_t this_dir_num = ++num_dirs;
-
- check_signals();
- DEBUG_LOG("----------------- %llu: %s\n", (long long unsigned)num_dirs, dirname);
- ret = adu_opendir(dirname, &dir, &cwd_fd);
- if (ret < 0) {
- if (ret != -ERRNO_TO_ERROR(EACCES))
+ if (create) {
+ NOTICE_LOG("creating dir table\n");
+ int ret = osl(osl_create_table(&dir_table_desc));
+ if (ret < 0) {
+ free((char *)dir_table_desc.dir);
return ret;
- WARNING_LOG("permission denied for %s\n", dirname);
- return 1;
- }
- while ((entry = readdir(dir))) {
- mode_t m;
- struct stat s;
- uint32_t uid;
- uint64_t size;
- struct user_info *ui;
-
- if (!strcmp(entry->d_name, "."))
- continue;
- if (!strcmp(entry->d_name, ".."))
- continue;
- if (lstat(entry->d_name, &s) == -1) {
- WARNING_LOG("lstat error for %s/%s\n", dirname,
- entry->d_name);
- continue;
- }
- m = s.st_mode;
- if (!S_ISREG(m) && !S_ISDIR(m))
- continue;
- if (S_ISDIR(m)) {
- if (conf.one_file_system_given && s.st_dev != device_id)
- continue;
- ret = scan_dir(entry->d_name, &this_dir_num);
- if (ret < 0)
- goto out;
- continue;
}
- /* regular file */
- size = s.st_size;
- dir_size += size;
- num_bytes += size;
- dir_files++;
- num_files++;
- uid = s.st_uid;
- ret = search_uid(uid, CREATE_USER_TABLE | OPEN_USER_TABLE, &ui);
- if (ret < 0)
- goto out;
- ui->bytes += size;
- ui->files++;
- ret = update_user_row(ui->table, this_dir_num, &size);
- if (ret < 0)
- goto out;
- }
- ret = add_directory(dirname, &this_dir_num, parent_dir_num,
- &dir_size, &dir_files);
-out:
- closedir(dir);
- ret2 = adu_fchdir(cwd_fd);
- if (ret2 < 0 && ret >= 0)
- ret = ret2;
- close(cwd_fd);
- return ret;
-}
-
-char *get_uid_list_name(void)
-{
- return make_message("%s/uid_list", conf.database_dir_arg);
-}
-
-static int write_uid_list(void)
-{
- char *buf, *filename;
- uint32_t count = 0;
- struct user_info *ui;
- size_t size = num_uids * sizeof(uint32_t);
- int ret;
-
- if (!num_uids)
- return 0;
- buf = adu_malloc(size);
- FOR_EACH_USER(ui) {
- if (!ui_used(ui) || !ui_admissible(ui))
- continue;
- DEBUG_LOG("saving uid %u\n", (unsigned) ui->uid);
- write_u32(buf + count++ * sizeof(uint32_t), ui->uid);
}
- filename = get_uid_list_name();
- ret = adu_write_file(filename, buf, size);
- free(filename);
- free(buf);
- return ret;
-}
-
-int open_dir_table(void)
-{
- if (!dir_table_desc.dir) /* we did not create the table */
- dir_table_desc.dir = adu_strdup(conf.database_dir_arg);
+ INFO_LOG("opening dir table\n");
return osl(osl_open_table(&dir_table_desc, &dir_table));
}
-static int com_create()
-{
- uint64_t zero = 0ULL;
- int ret;
- struct stat statbuf;
-
- if (lstat(conf.base_dir_arg, &statbuf) == -1)
- return -ERRNO_TO_ERROR(errno);
- if (!S_ISDIR(statbuf.st_mode))
- return -ERRNO_TO_ERROR(ENOTDIR);
- device_id = statbuf.st_dev;
- ret = create_tables();
- if (ret < 0)
- return ret;
- check_signals();
- ret = open_dir_table();
- if (ret < 0)
- return ret;
- check_signals();
- ret = scan_dir(conf.base_dir_arg, &zero);
- if (ret < 0)
- goto out;
- ret = write_uid_list();
-out:
- close_all_tables();
- return ret;
-}
static int check_args(void)
{
- int i, ret;
+ if (conf.create_given && !conf.base_dir_given)
+ return -E_SYNTAX;
/* remove trailing slashes from base-dir arg */
if (conf.base_dir_given) {
conf.base_dir_arg[len] = '\0';
}
}
- if (!conf.uid_given)
- return 0;
- admissible_uids = adu_malloc(conf.uid_given * sizeof(*admissible_uids));
- for (i = 0; i < conf.uid_given; i++) {
- ret = parse_uid_range(conf.uid_arg[i], admissible_uids + i);
- if (ret < 0)
- goto err;
- }
return 1;
-err:
- free(admissible_uids);
- admissible_uids = NULL;
- return ret;
}
+static void print_complete_help_and_die(void)
+{
+ const char **line;
+
+ printf("%s-%s\n", CMDLINE_PARSER_PACKAGE, CMDLINE_PARSER_VERSION);
+ printf("%s\n\n", gengetopt_args_info_purpose);
+ printf("%s\n\n", gengetopt_args_info_usage);
+
+ if (conf.help_given)
+ line = gengetopt_args_info_help;
+ else
+ line = gengetopt_args_info_detailed_help;
+ for (; *line; line++)
+ printf("%s\n", *line);
+
+ if (conf.help_given)
+ line = select_args_info_help;
+ else
+ line = select_args_info_detailed_help;
+ printf("Select options:\n");
+ for (; *line; line++)
+ printf("%s\n", *line);
+
+ printf("Interactive commands:\n");
+ print_interactive_help();
+ cmdline_parser_free(&conf);
+ select_cmdline_parser_free(&select_conf);
+ exit(EXIT_FAILURE);
+}
+
+/**
+ * The main function of adu.
+ *
+ * \param argc Usual argument count.
+ * \param argv Usual argument vector.
+ *
+ * Check command line options, init the signal handlers and
+ * call the main function of the selected mode.
+ *
+ * \return \p EXIT_SUCCESS on success, \p EXIT_FAILURE otherwise.
+ */
int main(int argc, char **argv)
{
int ret;
struct cmdline_parser_params params = {
- .override = 0,
+ .override = 1,
.initialize = 1,
.check_required = 0,
.check_ambiguity = 0,
- .print_errors = 1
+ .print_errors = 0
};
+ select_cmdline_parser_init(&select_conf);
+ cmdline_parser_init(&conf);
+ /* ignore errors and print complete help if --help was given */
+ cmdline_parser_ext(argc, argv, &conf, ¶ms);
+ if (conf.help_given || conf.detailed_help_given)
+ print_complete_help_and_die();
+ cmdline_parser_free(&conf);
+ params.check_required = 1;
+ params.check_ambiguity = 1;
+ params.print_errors = 1;
+ ret = cmdline_parser_ext(argc, argv, &conf, ¶ms);
+ if (ret)
+ exit(EXIT_FAILURE);
- cmdline_parser_ext(argc, argv, &conf, ¶ms); /* aborts on errors */
- ret = init_signals();
+ ret = check_args();
if (ret < 0)
goto out;
- ret = check_args();
+ ret = init_signals();
if (ret < 0)
goto out;
ret = -E_SYNTAX;
if (conf.select_given)
ret = com_select();
- else
+ else if (conf.create_given)
ret = com_create();
+ else
+ ret = com_interactive();
if (ret < 0)
goto out;
out:
- free(admissible_uids);
+ close_all_tables();
if (ret < 0) {
ERROR_LOG("%s\n", adu_strerror(-ret));
return -EXIT_FAILURE;
}
+ cmdline_parser_free(&conf);
+ select_cmdline_parser_free(&select_conf);
return EXIT_SUCCESS;
}
projects / adu.git / blobdiff