adu.c

   1 /*
   2  * Copyright (C) 2008 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file adu.c \brief The main functions used by all modes of operation. */
   8
   9 /**
  10  * \mainpage adu API reference
  11  *
  12  * - Modes of operation: \ref select.c, \ref create.c, \ref interactive.c
  13  * - User handling: \ref user.c
  14  * - Error handling: \ref error.h
  15  * - Library-type functions: \ref fd.c, \ref format.c, \ref string.c, \ref portable_io.h, \ref bloom.c
  16  */
  17
  18 #include "adu.h"
  19 #include <dirent.h> /* readdir() */
  20 #include <pwd.h>
  21 #include "format.h"
  22 #include "user.h"
  23 #include "select.cmdline.h"
  24 #include "select.h"
  25 #include "cmdline.h"
  26 #include "fd.h"
  27 #include "string.h"
  28 #include "error.h"
  29
  30 /** Define the array of error descriptions. */
  31 DEFINE_ERRLIST;
  32
  33 /**
  34  * The error code of the last called osl library function.
  35  *
  36  * \sa osl().
  37  */
  38 int osl_errno;
  39
  40 /** In case a signal is received, its number is stored here. */
  41 static int signum;
  42
  43 /** Command line and config file options. */
  44 struct gengetopt_args_info conf;
  45
  46 /** Options passed to --select-options. */
  47 struct select_args_info select_conf;
  48
  49 /** Computed database dir */
  50 char *database_dir;
  51
  52 /**
  53  * The table containing the directory names and statistics.
  54  */
  55 struct osl_table *dir_table = NULL;
  56
  57 static struct osl_column_description dir_table_cols[] = {
  58         [DT_NAME] = {
  59                 .storage_type = OSL_MAPPED_STORAGE,
  60                 .storage_flags = 0,
  61                 .name = "dir",
  62         },
  63         [DT_NUM] = {
  64                 .storage_type = OSL_MAPPED_STORAGE,
  65                 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
  66                 .name = "num",
  67                 .compare_function = uint64_compare,
  68                 .data_size = sizeof(uint64_t)
  69         },
  70         [DT_PARENT_NUM] = {
  71                 .storage_type = OSL_MAPPED_STORAGE,
  72                 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
  73                 .name = "parent_num",
  74                 .compare_function = size_compare,
  75                 .data_size = sizeof(uint64_t)
  76         },
  77         [DT_BYTES] = {
  78                 .storage_type = OSL_MAPPED_STORAGE,
  79                 .storage_flags =  OSL_RBTREE | OSL_FIXED_SIZE,
  80                 .compare_function = size_compare,
  81                 .name = "num_bytes",
  82                 .data_size = sizeof(uint64_t)
  83         },
  84         [DT_FILES] = {
  85                 .storage_type = OSL_MAPPED_STORAGE,
  86                 .storage_flags =  OSL_RBTREE | OSL_FIXED_SIZE,
  87                 .compare_function = size_compare,
  88                 .name = "num_files",
  89                 .data_size = sizeof(uint64_t)
  90         }
  91 };
  92
  93 static struct osl_table_description dir_table_desc = {
  94         .name = "dir_table",
  95         .num_columns = NUM_DT_COLUMNS,
  96         .flags = 0,
  97         .column_descriptions = dir_table_cols,
  98 };
  99
 100 /**
 101  * The log function.
 102  *
 103  * \param ll Loglevel.
 104  * \param fmt Usual format string.
 105  *
 106  * All XXX_LOG() macros use this function.
 107  */
 108 __printf_2_3 void __log(int ll, const char* fmt,...)
 109 {
 110         va_list argp;
 111         FILE *outfd;
 112         struct tm *tm;
 113         time_t t1;
 114         char str[255] = "";
 115
 116         if (ll < conf.loglevel_arg)
 117                 return;
 118         outfd = stderr;
 119         time(&t1);
 120         tm = localtime(&t1);
 121         strftime(str, sizeof(str), "%b %d %H:%M:%S", tm);
 122         fprintf(outfd, "%s ", str);
 123         va_start(argp, fmt);
 124         vfprintf(outfd, fmt, argp);
 125         va_end(argp);
 126 }
 127
 128 static void close_dir_table(void)
 129 {
 130         int ret;
 131
 132         if (!dir_table)
 133                 return;
 134         NOTICE_LOG("closing dir table\n");
 135         ret = osl(osl_close_table(dir_table, OSL_MARK_CLEAN));
 136         if (ret < 0)
 137                 ERROR_LOG("failed to close dir table: %s\n", adu_strerror(-ret));
 138         free((char *)dir_table_desc.dir);
 139         dir_table = NULL;
 140 }
 141
 142 static void close_all_tables(void)
 143 {
 144         close_dir_table();
 145         close_user_tables();
 146 }
 147
 148 static void signal_handler(int s)
 149 {
 150         signum = s;
 151 }
 152
 153 /**
 154  * Check whether to terminate adu.
 155  *
 156  * Check whether a signal was caught that should terminate the
 157  * adu process. If yes, close all osl tables and exit gracefully.
 158  */
 159 void check_signals(void)
 160 {
 161         if (likely(!signum))
 162                 return;
 163         EMERG_LOG("caught signal %d\n", signum);
 164         close_all_tables();
 165         exit(EXIT_FAILURE);
 166 }
 167
 168 static int catch_signal(int sig)
 169 {
 170         struct sigaction act;
 171
 172         act.sa_handler = signal_handler;
 173         sigemptyset(&act.sa_mask);
 174         act.sa_flags = 0;
 175         return sigaction(sig, &act, NULL);
 176 }
 177
 178 static int init_signals(void)
 179 {
 180         if (catch_signal(SIGINT) < 0)
 181                 return -E_SIGACTION;
 182         if (catch_signal(SIGTERM) < 0)
 183                 return -E_SIGACTION;
 184         if (catch_signal(SIGPIPE) == SIG_ERR)
 185                 return -E_SIGACTION;
 186         return 1;
 187 }
 188
 189 /**
 190  * Open the directory table.
 191  *
 192  * \param create If non-zero, create the table first.
 193  *
 194  * \return Standard.
 195  */
 196 int open_dir_table(int create)
 197 {
 198         int ret;
 199
 200         if (dir_table)
 201                 return 1;
 202
 203         dir_table_desc.dir = adu_strdup(database_dir);
 204         if (create) {
 205                 INFO_LOG("creating database directory structure\n");
 206                 ret = mkpath(dir_table_desc.dir, 0777);
 207                 if (ret < 0)
 208                         goto out;
 209                 NOTICE_LOG("creating dir table\n");
 210                 ret = osl(osl_create_table(&dir_table_desc));
 211                 if (ret < 0)
 212                         goto out;
 213         }
 214         INFO_LOG("opening dir table\n");
 215         return osl(osl_open_table(&dir_table_desc, &dir_table));
 216 out:
 217         free((char *)dir_table_desc.dir);
 218         return ret;
 219 }
 220
 221 static int check_args(void)
 222 {
 223         if (conf.create_given && !conf.base_dir_given)
 224                 return -E_SYNTAX;
 225
 226         /* remove trailing slashes from base-dir arg */
 227         if (conf.base_dir_given) {
 228                 size_t len = strlen(conf.base_dir_arg);
 229                 for (;;) {
 230                         if (!len) /* empty string */
 231                                 return -ERRNO_TO_ERROR(EINVAL);
 232                         if (!--len) /* length 1 is always OK */
 233                                 break;
 234                         if (conf.base_dir_arg[len] != '/')
 235                                 break; /* no trailing slash, also OK */
 236                         conf.base_dir_arg[len] = '\0';
 237                 }
 238         }
 239         return 1;
 240 }
 241
 242 static void print_complete_help_and_die(void)
 243 {
 244         const char **line;
 245
 246         printf("%s-%s\n", CMDLINE_PARSER_PACKAGE, CMDLINE_PARSER_VERSION);
 247         printf("%s\n\n", gengetopt_args_info_purpose);
 248         printf("%s\n\n", gengetopt_args_info_usage);
 249
 250         if (conf.help_given)
 251                 line = gengetopt_args_info_help;
 252         else
 253                 line = gengetopt_args_info_detailed_help;
 254         for (; *line; line++)
 255                 printf("%s\n", *line);
 256
 257         if (conf.help_given)
 258                 line = select_args_info_help;
 259         else
 260                 line  = select_args_info_detailed_help;
 261         printf("Select options:\n");
 262         for (; *line; line++)
 263                 printf("%s\n", *line);
 264
 265         printf("Interactive commands:\n");
 266         print_interactive_help();
 267         cmdline_parser_free(&conf);
 268         select_cmdline_parser_free(&select_conf);
 269         exit(EXIT_FAILURE);
 270 }
 271
 272 static void get_database_dir_or_die(void)
 273 {
 274         char *tmp;
 275
 276         if (conf.database_dir_given)
 277                 tmp = adu_strdup(conf.database_dir_arg);
 278         else
 279                 tmp = make_message("%s%s",
 280                         conf.database_root_arg, conf.base_dir_arg);
 281         /*
 282          * As we change the cwd during database creation, database_dir
 283          * must be an absolute path.
 284          */
 285         database_dir = absolute_path(tmp);
 286         free(tmp);
 287         if (database_dir)
 288                 return;
 289         EMERG_LOG("failed to get absolute path of database dir\n");
 290         exit(EXIT_FAILURE);
 291 }
 292
 293 /**
 294  * The main function of adu.
 295  *
 296  * \param argc Usual argument count.
 297  * \param argv Usual argument vector.
 298  *
 299  * Check command line options, init the signal handlers and
 300  * call the main function of the selected mode.
 301  *
 302  * \return \p EXIT_SUCCESS on success, \p EXIT_FAILURE otherwise.
 303  */
 304 int main(int argc, char **argv)
 305 {
 306         int ret;
 307         struct cmdline_parser_params params = {
 308                 .override = 1,
 309                 .initialize = 1,
 310                 .check_required = 0,
 311                 .check_ambiguity = 0,
 312                 .print_errors = 0
 313         };
 314         select_cmdline_parser_init(&select_conf);
 315         cmdline_parser_init(&conf);
 316         /* ignore errors and print complete help if --help was given */
 317         cmdline_parser_ext(argc, argv, &conf, &params);
 318         if (conf.help_given || conf.detailed_help_given)
 319                 print_complete_help_and_die();
 320         cmdline_parser_free(&conf);
 321         params.check_required = 1;
 322         params.check_ambiguity = 1;
 323         params.print_errors = 1;
 324         ret = cmdline_parser_ext(argc, argv, &conf, &params);
 325         if (ret)
 326                 exit(EXIT_FAILURE);
 327
 328         ret = check_args();
 329         if (ret < 0)
 330                 goto out;
 331         ret = init_signals();
 332         if (ret < 0)
 333                 goto out;
 334         get_database_dir_or_die();
 335         if (conf.select_given)
 336                 ret = com_select();
 337         else if (conf.create_given)
 338                 ret = com_create();
 339         else
 340                 ret = com_interactive();
 341         if (ret < 0)
 342                 goto out;
 343 out:
 344         close_all_tables();
 345         if (ret < 0) {
 346                 ERROR_LOG("%s\n", adu_strerror(-ret));
 347                 return -EXIT_FAILURE;
 348         }
 349         free(database_dir);
 350         cmdline_parser_free(&conf);
 351         select_cmdline_parser_free(&select_conf);
 352         return EXIT_SUCCESS;
 353 }