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   cnode n;
  30   struct sort_context *ctx;
  31   uns flags;
  32   struct fastbuf *fb;
  33   byte *filename;
  34   u64 size;                             // Size in bytes (not valid when writing)
  35   uns runs;                             // Number of runs, 0 if not sorted
  36   uns hash_bits;                        // Remaining bits of the hash function
  37   byte *ident;                          // Identifier used in debug messages
  38 };
  39
  40 enum sort_bucket_flags {
  41   SBF_FINAL = 1,                        // This bucket corresponds to the final output file (always 1 run)
  42   SBF_SOURCE = 2,                       // Contains the source file (always 0 runs)
  43   SBF_CUSTOM_PRESORT = 4,               // Contains source to read via custom presorter
  44   SBF_OPEN_WRITE = 256,                 // We are currently writing to the fastbuf
  45   SBF_OPEN_READ = 512,                  // We are reading from the fastbuf
  46   SBF_DESTROYED = 1024,                 // Already done with, no further references allowed
  47   SBF_SWAPPED_OUT = 2048,               // Swapped out to a named file
  48 };
  49
  50 struct sort_context {
  51   struct fastbuf *in_fb;
  52   struct fastbuf *out_fb;
  53   uns hash_bits;
  54
  55   struct mempool *pool;
  56   clist bucket_list;
  57   void *big_buf, *big_buf_half;
  58   size_t big_buf_size, big_buf_half_size;
  59
  60   int (*custom_presort)(struct fastbuf *dest, void *buf, size_t bufsize);
  61   // Take as much as possible from the source bucket, sort it in memory and dump to destination bucket.
  62   // Return 1 if there is more data available in the source bucket.
  63   int (*internal_sort)(struct sort_context *ctx, struct sort_bucket *in, struct sort_bucket *out, struct sort_bucket *out_only);
  64   // Two-way split/merge: merge up to 2 source buckets to up to 2 destination buckets.
  65   // Bucket arrays are NULL-terminated.
  66   void (*twoway_merge)(struct sort_context *ctx, struct sort_bucket **ins, struct sort_bucket **outs);
  67
  68   // State variables of internal_sort
  69   void *key_buf;
  70   int more_keys;
  71 };
  72
  73 void sorter_run(struct sort_context *ctx);
  74
  75 void *sorter_alloc(struct sort_context *ctx, uns size);
  76 void sorter_alloc_buf(struct sort_context *ctx);
  77 void sorter_free_buf(struct sort_context *ctx);
  78
  79 // Operations on buckets
  80 struct sort_bucket *sbuck_new(struct sort_context *ctx);
  81 void sbuck_drop(struct sort_bucket *b);
  82 int sbuck_have(struct sort_bucket *b);
  83 sh_off_t sbuck_size(struct sort_bucket *b);
  84 struct fastbuf *sbuck_read(struct sort_bucket *b);
  85 struct fastbuf *sbuck_write(struct sort_bucket *b);
  86 void sbuck_swap_out(struct sort_bucket *b);
  87
  88 #endif