lib/sorter/sorter.h

   1 /*
   2  *      UCW Library -- Universal Sorter
   3  *
   4  *      (c) 2001--2007 Martin Mares <mj@ucw.cz>
   5  *      (c) 2004 Robert Spalek <robert@ucw.cz>
   6  *
   7  *      This software may be freely distributed and used according to the terms
   8  *      of the GNU Lesser General Public License.
   9  */
  10
  11 /*
  12  *  This is not a normal header file, but a generator of sorting
  13  *  routines.  Each time you include it with parameters set in the
  14  *  corresponding preprocessor macros, it generates a file sorter
  15  *  with the parameters given.
  16  *
  17  *  FIXME: explain the basics (keys and data, callbacks etc.)
  18  *
  19  *  Basic parameters and callbacks:
  20  *
  21  *  SORT_PREFIX(x)      add a name prefix (used on all global names
  22  *                      defined by the sorter)
  23  *
  24  *  SORT_KEY            data type capable of storing a single key.
  25  *  SORT_KEY_REGULAR    data type holding a single key both in memory and on disk;
  26  *                      in this case, bread() and bwrite() is used to read/write keys
  27  *                      and it's also assumed that the keys are not very long.
  28  *  int PREFIX_compare(SORT_KEY *a, SORT_KEY *b)
  29  *                      compares two keys, result like strcmp(). Mandatory.
  30  *  int PREFIX_read_key(struct fastbuf *f, SORT_KEY *k)
  31  *                      reads a key from a fastbuf, returns nonzero=ok, 0=EOF.
  32  *                      Mandatory unless SORT_KEY_REGULAR is defined.
  33  *  void PREFIX_write_key(struct fastbuf *f, SORT_KEY *k)
  34  *                      writes a key to a fastbuf. Mandatory unless SORT_KEY_REGULAR.
  35  *
  36  *  SORT_KEY_SIZE(key)  returns the real size of a key (a SORT_KEY type in memory
  37  *                      can be truncated to this number of bytes without any harm;
  38  *                      used to save memory when the keys have variable sizes).
  39  *                      Default: always store the whole SORT_KEY.
  40  *  SORT_DATA_SIZE(key) gets a key and returns the amount of data following it.
  41  *                      Default: records consist of keys only.
  42  *
  43  *  Integer sorting:
  44  *
  45  *  SORT_INT(key)       We are sorting by an integer value. In this mode, PREFIX_compare
  46  *                      is supplied automatically and the sorting function gets an extra
  47  *                      parameter specifying a range of the integers. The better the range
  48  *                      fits, the faster we sort. Sets up SORT_HASH_xxx automatically.
  49  *  SORT_INT64(key)     the same for 64-bit integers.
  50  *
  51  *  Hashing (optional, but it can speed sorting up):
  52  *
  53  *  SORT_HASH_BITS      signals that a monotone hashing function returning a given number of
  54  *                      bits is available. Monotone hash is a function f such that f(x) < f(y)
  55  *                      implies x < y and which is approximately uniformly distributed.
  56  *  uns PREFIX_hash(SORT_KEY *a)
  57  *
  58  *  Unification:
  59  *
  60  *  SORT_UNIFY          merge items with identical keys, needs the following functions:
  61  *  void PREFIX_write_merged(struct fastbuf *f, SORT_KEY **keys, void **data, uns n, void *buf)
  62  *                      takes n records in memory with keys which compare equal and writes
  63  *                      a single record to the given fastbuf. `buf' points to a buffer which
  64  *                      is guaranteed to hold the sum of workspace requirements (see below)
  65  *                      over all given records. The function is allowed to modify all its inputs.
  66  *  void PREFIX_copy_merged(SORT_KEY **keys, struct fastbuf **data, uns n, struct fastbuf *dest)
  67  *                      takes n records with keys in memory and data in fastbufs and writes
  68  *                      a single record. Used only if SORT_DATA_SIZE or SORT_UNIFY_WORKSPACE is defined.
  69  *  SORT_UNIFY_WORKSPACE(key)
  70  *                      gets a key and returns the amount of workspace required when merging
  71  *                      the given record. Defaults to 0.
  72  *
  73  *  Input (choose one of these):
  74  *
  75  *  SORT_INPUT_FILE     file of a given name
  76  *  SORT_INPUT_FB       seekable fastbuf stream
  77  *  SORT_INPUT_PIPE     non-seekable fastbuf stream
  78  *  SORT_INPUT_PRESORT  custom presorter. Calls function
  79  *  int PREFIX_presort(struct fastbuf *dest, void *buf, size_t bufsize)
  80  *                      to get successive batches of pre-sorted data.
  81  *                      The function is passed a page-aligned presorting buffer.
  82  *                      It returns 1 on success or 0 on EOF.
  83  *  SORT_DELETE_INPUT   A C expression, if true, then the input files are deleted
  84  *                      as soon as possible.
  85  *
  86  *  Output (chose one of these):
  87  *
  88  *  SORT_OUTPUT_FILE    file of a given name
  89  *  SORT_OUTPUT_FB      temporary fastbuf stream
  90  *  SORT_OUTPUT_THIS_FB a given fastbuf stream which can already contain a header
  91  *
  92  *  Other switches:
  93  *
  94  *  SORT_UNIQUE         all items have distinct keys (checked in debug mode)
  95  *
  96  *  The function generated:
  97  *
  98  *  <outfb> PREFIX_sort(<in>, <out> [,<range>]), where:
  99  *                      <in> = input file name/fastbuf or NULL
 100  *                      <out> = output file name/fastbuf or NULL
 101  *                      <range> = maximum integer value for the SORT_INT mode
 102  *                      <outfb> = output fastbuf (in SORT_OUTPUT_FB mode)
 103  *
 104  *  After including this file, all parameter macros are automatically
 105  *  undef'd.
 106  */
 107
 108 #include "lib/sorter/common.h"
 109 #include "lib/fastbuf.h"
 110
 111 #include <fcntl.h>
 112
 113 #define P(x) SORT_PREFIX(x)
 114
 115 #ifdef SORT_KEY_REGULAR
 116 typedef SORT_KEY_REGULAR P(key);
 117 static inline int P(read_key) (struct fastbuf *f, P(key) *k)
 118 {
 119   return breadb(f, k, sizeof(P(key)));
 120 }
 121 static inline void P(write_key) (struct fastbuf *f, P(key) *k)
 122 {
 123   bwrite(f, k, sizeof(P(key)));
 124 }
 125 #elif defined(SORT_KEY)
 126 typedef SORT_KEY P(key);
 127 #else
 128 #error Missing definition of sorting key.
 129 #endif
 130
 131 #ifdef SORT_INT64
 132 typedef u64 P(hash_t);
 133 #define SORT_INT SORT_INT64
 134 #else
 135 typedef uns P(hash_t);
 136 #endif
 137
 138 #ifdef SORT_INT
 139 static inline int P(compare) (P(key) *x, P(key) *y)
 140 {
 141   if (SORT_INT(*x) < SORT_INT(*y))
 142     return -1;
 143   if (SORT_INT(*x) > SORT_INT(*y))
 144     return 1;
 145   return 0;
 146 }
 147
 148 #ifndef SORT_HASH_BITS
 149 static inline P(hash_t) P(hash) (P(key) *x)
 150 {
 151   return SORT_INT((*x));
 152 }
 153 #endif
 154 #endif
 155
 156 #ifdef SORT_UNIFY
 157 #define LESS <
 158 #else
 159 #define LESS <=
 160 #endif
 161 #define SWAP(x,y,z) do { z=x; x=y; y=z; } while(0)
 162
 163 #if defined(SORT_UNIQUE) && defined(DEBUG_ASSERTS)
 164 #define SORT_ASSERT_UNIQUE
 165 #endif
 166
 167 #ifdef SORT_KEY_SIZE
 168 #define SORT_VAR_KEY
 169 #else
 170 #define SORT_KEY_SIZE(key) sizeof(key)
 171 #endif
 172
 173 #ifdef SORT_DATA_SIZE
 174 #define SORT_VAR_DATA
 175 #else
 176 #define SORT_DATA_SIZE(key) 0
 177 #endif
 178
 179 static inline void P(copy_data)(P(key) *key, struct fastbuf *in, struct fastbuf *out)
 180 {
 181   P(write_key)(out, key);
 182 #ifdef SORT_VAR_DATA
 183   bbcopy(in, out, SORT_DATA_SIZE(*key));
 184 #else
 185   (void) in;
 186 #endif
 187 }
 188
 189 #if defined(SORT_UNIFY) && !defined(SORT_VAR_DATA) && !defined(SORT_UNIFY_WORKSPACE)
 190 static inline void P(copy_merged)(P(key) **keys, struct fastbuf **data UNUSED, uns n, struct fastbuf *dest)
 191 {
 192   P(write_merged)(dest, keys, NULL, n, NULL);
 193 }
 194 #endif
 195
 196 #if defined(SORT_VAR_KEY) || defined(SORT_VAR_DATA) || defined(SORT_UNIFY_WORKSPACE)
 197 #include "lib/sorter/s-internal.h"
 198 #else
 199 #include "lib/sorter/s-fixint.h"
 200 #endif
 201
 202 #include "lib/sorter/s-twoway.h"
 203 #include "lib/sorter/s-multiway.h"
 204
 205 #if defined(SORT_HASH_BITS) || defined(SORT_INT)
 206 #include "lib/sorter/s-radix.h"
 207 #endif
 208
 209 static struct fastbuf *P(sort)(
 210 #ifdef SORT_INPUT_FILE
 211                                byte *in,
 212 #else
 213                                struct fastbuf *in,
 214 #endif
 215 #ifdef SORT_OUTPUT_FILE
 216                                byte *out
 217 #else
 218                                struct fastbuf *out
 219 #endif
 220 #ifdef SORT_INT
 221                                , u64 int_range
 222 #endif
 223                                )
 224 {
 225   struct sort_context ctx;
 226   bzero(&ctx, sizeof(ctx));
 227
 228 #ifdef SORT_INPUT_FILE
 229   ctx.in_fb = bopen_file(in, O_RDONLY, &sorter_fb_params);
 230   ctx.in_size = bfilesize(ctx.in_fb);
 231 #elif defined(SORT_INPUT_FB)
 232   ctx.in_fb = in;
 233   ctx.in_size = bfilesize(in);
 234 #elif defined(SORT_INPUT_PIPE)
 235   ctx.in_fb = in;
 236   ctx.in_size = ~(u64)0;
 237 #elif defined(SORT_INPUT_PRESORT)
 238   ASSERT(!in);
 239   ctx.custom_presort = P(presort);
 240   ctx.in_size = ~(u64)0;
 241 #else
 242 #error No input given.
 243 #endif
 244 #ifdef SORT_DELETE_INPUT
 245   if (SORT_DELETE_INPUT)
 246     bconfig(ctx.in_fb, BCONFIG_IS_TEMP_FILE, 1);
 247 #endif
 248
 249 #ifdef SORT_OUTPUT_FB
 250   ASSERT(!out);
 251 #elif defined(SORT_OUTPUT_THIS_FB)
 252   ctx.out_fb = out;
 253 #elif defined(SORT_OUTPUT_FILE)
 254   /* Just assume fastbuf output and rename the fastbuf later */
 255 #else
 256 #error No output given.
 257 #endif
 258
 259 #ifdef SORT_HASH_BITS
 260   ctx.hash_bits = SORT_HASH_BITS;
 261   ctx.radix_split = P(radix_split);
 262 #elif defined(SORT_INT)
 263   ctx.hash_bits = 0;
 264   while (ctx.hash_bits < 64 && (int_range >> ctx.hash_bits))
 265     ctx.hash_bits++;
 266   ctx.radix_split = P(radix_split);
 267 #endif
 268
 269   ctx.internal_sort = P(internal);
 270   ctx.internal_estimate = P(internal_estimate);
 271   ctx.twoway_merge = P(twoway_merge);
 272   ctx.multiway_merge = P(multiway_merge);
 273
 274   sorter_run(&ctx);
 275
 276 #ifdef SORT_OUTPUT_FILE
 277   bfix_tmp_file(ctx.out_fb, out);
 278   ctx.out_fb = NULL;
 279 #endif
 280   return ctx.out_fb;
 281 }
 282
 283 #undef SORT_PREFIX
 284 #undef SORT_KEY
 285 #undef SORT_KEY_REGULAR
 286 #undef SORT_KEY_SIZE
 287 #undef SORT_DATA_SIZE
 288 #undef SORT_VAR_KEY
 289 #undef SORT_VAR_DATA
 290 #undef SORT_INT
 291 #undef SORT_INT64
 292 #undef SORT_HASH_BITS
 293 #undef SORT_UNIFY
 294 #undef SORT_UNIFY_WORKSPACE
 295 #undef SORT_INPUT_FILE
 296 #undef SORT_INPUT_FB
 297 #undef SORT_INPUT_PRESORT
 298 #undef SORT_OUTPUT_FILE
 299 #undef SORT_OUTPUT_FB
 300 #undef SORT_OUTPUT_THIS_FB
 301 #undef SORT_UNIQUE
 302 #undef SORT_ASSERT_UNIQUE
 303 #undef SORT_DELETE_INPUT
 304 #undef SWAP
 305 #undef LESS
 306 #undef P
 307 /* FIXME: Check that we undef everything we should. */