adu.h

   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.h Global definitions. */
   8
   9 #include <sys/stat.h>
  10 #include <fcntl.h>
  11 #include <signal.h>
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <time.h> /* time(), localtime() */
  15 #include <unistd.h>
  16 #include <errno.h>
  17 #include <limits.h>
  18 #include <stdarg.h>
  19 #include <inttypes.h>
  20 #include <string.h>
  21 #include <assert.h>
  22 #include <osl.h>
  23 #include "gcc-compat.h"
  24 #include "portable_io.h"
  25
  26 /** debug loglevel, gets really noisy */
  27 #define DEBUG 1
  28 /** still noisy, but won't fill your disk */
  29 #define INFO  2
  30 /** normal, but significant event */
  31 #define NOTICE 3
  32 /** unexpected event that can be handled */
  33 #define WARNING 4
  34 /** unhandled error condition */
  35 #define ERROR 5
  36 /** system might be unreliable */
  37 #define CRIT 6
  38 /** last message before exit */
  39 #define EMERG 7
  40
  41 /** Log messages with lower priority than that will not be compiled in. */
  42 #define COMPILE_TIME_LOGLEVEL 0
  43
  44 /** \cond */
  45 #if DEBUG > COMPILE_TIME_LOGLEVEL
  46 #define DEBUG_LOG(f,...) __log(DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  47 #else
  48 #define DEBUG_LOG(...) do {;} while (0)
  49 #endif
  50
  51 #if INFO > COMPILE_TIME_LOGLEVEL
  52 #define INFO_LOG(f,...) __log(INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  53 #else
  54 #define INFO_LOG(...) do {;} while (0)
  55 #endif
  56
  57 #if NOTICE > COMPILE_TIME_LOGLEVEL
  58 #define NOTICE_LOG(f,...) __log(NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  59 #else
  60 #define NOTICE_LOG(...) do {;} while (0)
  61 #endif
  62
  63 #if WARNING > COMPILE_TIME_LOGLEVEL
  64 #define WARNING_LOG(f,...) __log(WARNING, "%s: " f, __FUNCTION__, ##  __VA_ARGS__)
  65 #else
  66 #define WARNING_LOG(...) do {;} while (0)
  67 #endif
  68
  69 #if ERROR > COMPILE_TIME_LOGLEVEL
  70 #define ERROR_LOG(f,...) __log(ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  71 #else
  72 #define ERROR_LOG(...) do {;} while (0)
  73 #endif
  74
  75 #if CRIT > COMPILE_TIME_LOGLEVEL
  76 #define CRIT_LOG(f,...) __log(CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  77 #else
  78 #define CRIT_LOG(...) do {;} while (0)
  79 #endif
  80
  81 #if EMERG > COMPILE_TIME_LOGLEVEL
  82 #define EMERG_LOG(f,...) __log(EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
  83 #else
  84 #define EMERG_LOG(...)
  85 #endif
  86 /** \endcond */
  87
  88 /**
  89  * Write a log message to a dynamically allocated string.
  90  *
  91  * \param fmt Usual format string.
  92  * \param p Result pointer.
  93  *
  94  * \sa printf(3). */
  95 #define VSPRINTF(fmt, p) \
  96 { \
  97         int n; \
  98         size_t size = 100; \
  99         p = adu_malloc(size); \
 100         while (1) { \
 101                 va_list ap; \
 102                 /* Try to print in the allocated space. */ \
 103                 va_start(ap, fmt); \
 104                 n = vsnprintf(p, size, fmt, ap); \
 105                 va_end(ap); \
 106                 /* If that worked, return the string. */ \
 107                 if (n > -1 && n < size) \
 108                         break; \
 109                 /* Else try again with more space. */ \
 110                 if (n > -1) /* glibc 2.1 */ \
 111                         size = n + 1; /* precisely what is needed */ \
 112                 else /* glibc 2.0 */ \
 113                         size *= 2; /* twice the old size */ \
 114                 p = adu_realloc(p, size); \
 115         } \
 116 }
 117
 118 /** Evaluates to 1 if x < y, to -1 if x > y and to 0 if x == y. */
 119 #define NUM_COMPARE(x, y) ((int)((x) < (y)) - (int)((x) > (y)))
 120
 121 /** The columns of the directory table. */
 122 enum dir_table_columns {
 123         /** The name of the directory. */
 124         DT_NAME,
 125         /** The dir count number. */
 126         DT_NUM,
 127         /** The number of the parent directory. */
 128         DT_PARENT_NUM,
 129         /** The number of bytes of all regular files. */
 130         DT_BYTES,
 131         /** The number of all regular files. */
 132         DT_FILES,
 133         /** Number of columns in this table. */
 134         NUM_DT_COLUMNS
 135 };
 136
 137 extern struct osl_table *dir_table;
 138
 139 /** The adu command line options. */
 140 extern struct gengetopt_args_info conf;
 141
 142 /**
 143  * The select command line options.
 144  *
 145  * Either given at the command line, or via the \a set command
 146  * in interactive mode.
 147  */
 148 extern struct select_args_info select_conf;
 149
 150 /**
 151  * Compare two osl objects pointing to unsigned integers of 64 bit size.
 152  *
 153  * \param obj1 Pointer to the first integer.
 154  * \param obj2 Pointer to the second integer.
 155  *
 156  * \return The values required for an osl compare function.
 157  *
 158  * \sa osl_compare_func, osl_hash_compare().
 159  */
 160 static inline int uint64_compare(const struct osl_object *obj1,
 161                 const struct osl_object *obj2)
 162 {
 163         uint64_t d1 = read_u64((const char *)obj1->data);
 164         uint64_t d2 = read_u64((const char *)obj2->data);
 165
 166         if (d1 < d2)
 167                 return 1;
 168         if (d1 > d2)
 169                 return -1;
 170         return 0;
 171 }
 172
 173 /**
 174  * Compare the size of two directories
 175  *
 176  * \param obj1 Pointer to the first object.
 177  * \param obj2 Pointer to the second object.
 178  *
 179  * This function first compares the size values as usual integers. If they compare as
 180  * equal, the address of \a obj1 and \a obj2 are compared. So this compare function
 181  * returns zero if and only if \a obj1 and \a obj2 point to the same memory area.
 182  */
 183 static inline int size_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 184 {
 185         uint64_t d1 = *(uint64_t *)obj1->data;
 186         uint64_t d2 = *(uint64_t *)obj2->data;
 187         int ret = NUM_COMPARE(d2, d1);
 188
 189         if (ret)
 190                 return ret;
 191         //INFO_LOG("addresses: %p, %p\n", obj1->data, obj2->data);
 192         return NUM_COMPARE(obj2->data, obj1->data);
 193 }
 194
 195 /* adu.c */
 196 __printf_2_3 void __log(int, const char*, ...);
 197 int open_dir_table(int create);
 198 void check_signals(void);
 199 /* create.c */
 200 int com_create(void);
 201
 202 /* interactive.c */
 203 void print_interactive_help(void);
 204 int com_interactive(void);