X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=lib%2Fsorter%2Fcommon.h;h=ad16382a6c732229d494a52914e22aa2d2595c7b;hb=280892f550b5e98870fc1de117891212f32d4749;hp=76d3e8c893ae243686216a65dd94486b9bcd2d64;hpb=116954d49373438c669eadd764e03ee8ac4211bb;p=libucw.git

diff --git a/lib/sorter/common.h b/lib/sorter/common.h
index 76d3e8c8..ad16382a 100644
--- a/lib/sorter/common.h
+++ b/lib/sorter/common.h
@@ -1,5 +1,5 @@
 /*
- *	UCW Library -- Universal Sorter
+ *	UCW Library -- Universal Sorter: Common Declarations
  *
  *	(c) 2007 Martin Mares <mj@ucw.cz>
  *
@@ -10,7 +10,136 @@
 #ifndef _UCW_SORTER_COMMON_H
 #define _UCW_SORTER_COMMON_H
 
+#include "lib/clists.h"
+
 /* Configuration, some of the variables are used by the old sorter, too. */
 extern uns sorter_trace, sorter_presort_bufsize, sorter_stream_bufsize;
+extern uns sorter_debug, sorter_min_radix_bits, sorter_max_radix_bits;
+extern uns sorter_min_multiway_bits, sorter_max_multiway_bits;
+extern uns sorter_threads, sorter_thread_threshold;
+extern u64 sorter_bufsize;
+extern struct fb_params sorter_fb_params;
+
+#define SORT_TRACE(x...) do { if (sorter_trace) msg(L_DEBUG, x); } while(0)
+#define SORT_XTRACE(level, x...) do { if (sorter_trace >= level) msg(L_DEBUG, x); } while(0)
+
+enum sort_debug {
+  SORT_DEBUG_NO_PRESORT = 1,
+  SORT_DEBUG_NO_JOIN = 2,
+  SORT_DEBUG_KEEP_BUCKETS = 4,
+  SORT_DEBUG_NO_RADIX = 8,
+  SORT_DEBUG_NO_MULTIWAY = 16,
+  SORT_DEBUG_ASORT_NO_RADIX = 32,
+  SORT_DEBUG_ASORT_NO_THREADS = 64
+};
+
+struct sort_bucket;
+
+struct sort_context {
+  struct fastbuf *in_fb;
+  struct fastbuf *out_fb;
+  uns hash_bits;
+  u64 in_size;
+
+  struct mempool *pool;
+  clist bucket_list;
+  void *big_buf;
+  size_t big_buf_size;
+
+  int (*custom_presort)(struct fastbuf *dest, void *buf, size_t bufsize);
+
+  // Take as much as possible from the source bucket, sort it in memory and dump to destination bucket.
+  // Return 1 if there is more data available in the source bucket.
+  int (*internal_sort)(struct sort_context *ctx, struct sort_bucket *in, struct sort_bucket *out, struct sort_bucket *out_only);
+
+  // Estimate how much input data from `b' will fit in the internal sorting buffer.
+  u64 (*internal_estimate)(struct sort_context *ctx, struct sort_bucket *b);
+
+  // Two-way split/merge: merge up to 2 source buckets to up to 2 destination buckets.
+  // Bucket arrays are NULL-terminated.
+  void (*twoway_merge)(struct sort_context *ctx, struct sort_bucket **ins, struct sort_bucket **outs);
+
+  // Multi-way merge: merge an arbitrary number of source buckets to a single destination bucket.
+  void (*multiway_merge)(struct sort_context *ctx, struct sort_bucket **ins, struct sort_bucket *out);
+
+  // Radix split according to hash function
+  void (*radix_split)(struct sort_context *ctx, struct sort_bucket *in, struct sort_bucket **outs, uns bitpos, uns numbits);
+
+  // State variables of internal_sort
+  void *key_buf;
+  int more_keys;
+
+  // Timing
+  timestamp_t start_time;
+  uns last_pass_time;
+  uns total_int_time, total_pre_time, total_ext_time;
+};
+
+void sorter_run(struct sort_context *ctx);
+
+/* Buffers */
+
+void *sorter_alloc(struct sort_context *ctx, uns size);
+void sorter_prepare_buf(struct sort_context *ctx);
+void sorter_alloc_buf(struct sort_context *ctx);
+void sorter_free_buf(struct sort_context *ctx);
+
+/* Buckets */
+
+struct sort_bucket {
+  cnode n;
+  struct sort_context *ctx;
+  uns flags;
+  struct fastbuf *fb;
+  byte *filename;
+  u64 size;				// Size in bytes (not valid when writing)
+  uns runs;				// Number of runs, 0 if not sorted
+  uns hash_bits;			// Remaining bits of the hash function
+  byte *ident;				// Identifier used in debug messages
+};
+
+enum sort_bucket_flags {
+  SBF_FINAL = 1,			// This bucket corresponds to the final output file (always 1 run)
+  SBF_SOURCE = 2,			// Contains the source file (always 0 runs)
+  SBF_CUSTOM_PRESORT = 4,		// Contains source to read via custom presorter
+  SBF_OPEN_WRITE = 256,			// We are currently writing to the fastbuf
+  SBF_OPEN_READ = 512,			// We are reading from the fastbuf
+  SBF_DESTROYED = 1024,			// Already done with, no further references allowed
+  SBF_SWAPPED_OUT = 2048,		// Swapped out to a named file
+};
+
+struct sort_bucket *sbuck_new(struct sort_context *ctx);
+void sbuck_drop(struct sort_bucket *b);
+int sbuck_have(struct sort_bucket *b);
+int sbuck_has_file(struct sort_bucket *b);
+sh_off_t sbuck_size(struct sort_bucket *b);
+struct fastbuf *sbuck_read(struct sort_bucket *b);
+struct fastbuf *sbuck_write(struct sort_bucket *b);
+void sbuck_swap_out(struct sort_bucket *b);
+
+/* Contexts and helper functions for the array sorter */
+
+struct asort_context {
+  void *array;				// Array to sort
+  void *buffer;				// Auxiliary buffer (required when radix-sorting)
+  uns num_elts;				// Number of elements in the array
+  uns elt_size;				// Bytes per element
+  uns hash_bits;			// Remaining bits of the hash function
+  uns radix_bits;			// How many bits to process in a single radix-sort pass
+  void (*quicksort)(void *array_ptr, uns num_elts);
+  void (*quicksplit)(void *array_ptr, uns num_elts, int *leftp, int *rightp);
+  void (*radix_count)(void *src_ptr, uns num_elts, uns *cnt, uns shift);
+  void (*radix_split)(void *src_ptr, void *dest_ptr, uns num_elts, uns *ptrs, uns shift);
+
+  // Used internally by array.c
+  struct rs_work **rs_works;
+  struct work_queue *rs_work_queue;
+  clist rs_bits;
+  struct eltpool *eltpool;
+};
+
+void asort_run(struct asort_context *ctx);
+void asort_start_threads(uns run);
+void asort_stop_threads(void);
 
 #endif