lib/sorter/common.h

   1 /*
   2  *      UCW Library -- Universal Sorter: Common Declarations
   3  *
   4  *      (c) 2007 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #ifndef _UCW_SORTER_COMMON_H
  11 #define _UCW_SORTER_COMMON_H
  12
  13 #include "lib/clists.h"
  14
  15 /* Configuration, some of the variables are used by the old sorter, too. */
  16 extern uns sorter_trace, sorter_presort_bufsize, sorter_stream_bufsize;
  17 extern uns sorter_debug;
  18 extern u64 sorter_bufsize;
  19
  20 #define SORT_TRACE(x...) do { if (sorter_trace) log(L_DEBUG, x); } while(0)
  21 #define SORT_XTRACE(x...) do { if (sorter_trace > 1) log(L_DEBUG, x); } while(0)
  22
  23 enum sort_debug {
  24   SORT_DEBUG_NO_PRESORT = 1,
  25   SORT_DEBUG_NO_JOIN = 2,
  26 };
  27
  28 struct sort_bucket;
  29
  30 struct sort_context {
  31   struct fastbuf *in_fb;
  32   struct fastbuf *out_fb;
  33   uns hash_bits;
  34
  35   struct mempool *pool;
  36   clist bucket_list;
  37   void *big_buf, *big_buf_half;
  38   size_t big_buf_size, big_buf_half_size;
  39
  40   int (*custom_presort)(struct fastbuf *dest, void *buf, size_t bufsize);
  41   // Take as much as possible from the source bucket, sort it in memory and dump to destination bucket.
  42   // Return 1 if there is more data available in the source bucket.
  43   int (*internal_sort)(struct sort_context *ctx, struct sort_bucket *in, struct sort_bucket *out, struct sort_bucket *out_only);
  44   // Two-way split/merge: merge up to 2 source buckets to up to 2 destination buckets.
  45   // Bucket arrays are NULL-terminated.
  46   void (*twoway_merge)(struct sort_context *ctx, struct sort_bucket **ins, struct sort_bucket **outs);
  47
  48   // State variables of internal_sort
  49   void *key_buf;
  50   int more_keys;
  51 };
  52
  53 void sorter_run(struct sort_context *ctx);
  54
  55 /* Buffers */
  56
  57 void *sorter_alloc(struct sort_context *ctx, uns size);
  58 void sorter_alloc_buf(struct sort_context *ctx);
  59 void sorter_free_buf(struct sort_context *ctx);
  60
  61 /* Buckets */
  62
  63 struct sort_bucket {
  64   cnode n;
  65   struct sort_context *ctx;
  66   uns flags;
  67   struct fastbuf *fb;
  68   byte *filename;
  69   u64 size;                             // Size in bytes (not valid when writing)
  70   uns runs;                             // Number of runs, 0 if not sorted
  71   uns hash_bits;                        // Remaining bits of the hash function
  72   byte *ident;                          // Identifier used in debug messages
  73 };
  74
  75 enum sort_bucket_flags {
  76   SBF_FINAL = 1,                        // This bucket corresponds to the final output file (always 1 run)
  77   SBF_SOURCE = 2,                       // Contains the source file (always 0 runs)
  78   SBF_CUSTOM_PRESORT = 4,               // Contains source to read via custom presorter
  79   SBF_OPEN_WRITE = 256,                 // We are currently writing to the fastbuf
  80   SBF_OPEN_READ = 512,                  // We are reading from the fastbuf
  81   SBF_DESTROYED = 1024,                 // Already done with, no further references allowed
  82   SBF_SWAPPED_OUT = 2048,               // Swapped out to a named file
  83 };
  84
  85 struct sort_bucket *sbuck_new(struct sort_context *ctx);
  86 void sbuck_drop(struct sort_bucket *b);
  87 int sbuck_have(struct sort_bucket *b);
  88 int sbuck_has_file(struct sort_bucket *b);
  89 sh_off_t sbuck_size(struct sort_bucket *b);
  90 struct fastbuf *sbuck_read(struct sort_bucket *b);
  91 struct fastbuf *sbuck_write(struct sort_bucket *b);
  92 void sbuck_swap_out(struct sort_bucket *b);
  93
  94 #endif