2 * UCW Library -- Universal Sorter: Governing Routines
4 * (c) 2007 Martin Mares <mj@ucw.cz>
6 * This software may be freely distributed and used according to the terms
7 * of the GNU Lesser General Public License.
11 #include "lib/fastbuf.h"
12 #include "lib/mempool.h"
13 #include "lib/stkstring.h"
14 #include "lib/sorter/common.h"
20 #define F_BSIZE(b) stk_fsize(sbuck_size(b))
23 sorter_start_timer(struct sort_context *ctx)
25 init_timer(&ctx->start_time);
29 sorter_stop_timer(struct sort_context *ctx, uns *account_to)
31 ctx->last_pass_time = get_timer(&ctx->start_time);
32 *account_to += ctx->last_pass_time;
36 sorter_speed(struct sort_context *ctx, u64 size)
40 if (!ctx->last_pass_time)
42 return (uns)((double)size / (1<<20) * 1000 / ctx->last_pass_time);
46 sorter_presort(struct sort_context *ctx, struct sort_bucket *in, struct sort_bucket *out, struct sort_bucket *out_only)
48 sorter_alloc_buf(ctx);
49 if (in->flags & SBF_CUSTOM_PRESORT)
51 struct fastbuf *f = sbuck_write(out);
53 return ctx->custom_presort(f, ctx->big_buf, ctx->big_buf_size); // FIXME: out_only optimization?
55 return ctx->internal_sort(ctx, in, out, out_only);
58 static inline struct sort_bucket *
59 sbuck_join_to(struct sort_bucket *b)
61 if (sorter_debug & SORT_DEBUG_NO_JOIN)
64 struct sort_bucket *out = (struct sort_bucket *) b->n.prev; // Such bucket is guaranteed to exist
65 return (out->flags & SBF_FINAL) ? out : NULL;
69 sorter_join(struct sort_bucket *b)
71 struct sort_bucket *join = (struct sort_bucket *) b->n.prev;
72 ASSERT(join->flags & SBF_FINAL);
75 if (!sbuck_has_file(join))
77 // The final bucket doesn't have any file associated yet, so replace
78 // it with the new bucket.
79 SORT_XTRACE(2, "Replaced final bucket");
80 b->flags |= SBF_FINAL;
85 SORT_TRACE("Copying to output file: %s", F_BSIZE(b));
86 struct fastbuf *src = sbuck_read(b);
87 struct fastbuf *dest = sbuck_write(join);
88 bbcopy(src, dest, ~0U);
94 sorter_twoway(struct sort_context *ctx, struct sort_bucket *b)
96 struct sort_bucket *ins[3] = { NULL }, *outs[3] = { NULL };
97 cnode *list_pos = b->n.prev;
98 struct sort_bucket *join = sbuck_join_to(b);
100 if (!(sorter_debug & SORT_DEBUG_NO_PRESORT) || (b->flags & SBF_CUSTOM_PRESORT))
102 SORT_XTRACE(3, "%s", ((b->flags & SBF_CUSTOM_PRESORT) ? "Custom presorting" : "Presorting"));
103 sorter_start_timer(ctx);
104 ins[0] = sbuck_new(ctx);
105 if (!sorter_presort(ctx, b, ins[0], join ? : ins[0]))
107 sorter_stop_timer(ctx, &ctx->total_pre_time);
108 SORT_XTRACE(((b->flags & SBF_SOURCE) ? 1 : 2), "Sorted in memory");
112 clist_insert_after(&ins[0]->n, list_pos);
117 ins[1] = sbuck_new(ctx);
119 while (sorter_presort(ctx, b, ins[i], ins[i]))
122 sorter_stop_timer(ctx, &ctx->total_pre_time);
123 SORT_TRACE("Presorting pass (%d+%d runs, %s+%s, %dMB/s)",
124 ins[0]->runs, ins[1]->runs,
125 F_BSIZE(ins[0]), F_BSIZE(ins[1]),
126 sorter_speed(ctx, sbuck_size(ins[0]) + sbuck_size(ins[1])));
130 SORT_XTRACE(2, "Presorting disabled");
134 SORT_XTRACE(3, "Main sorting");
138 sorter_start_timer(ctx);
139 if (ins[0]->runs == 1 && ins[1]->runs == 1 && join)
141 // This is guaranteed to produce a single run, so join if possible
142 sh_off_t join_size = sbuck_size(join);
145 ctx->twoway_merge(ctx, ins, outs);
146 ASSERT(join->runs == 2);
148 join_size = sbuck_size(join) - join_size;
149 sorter_stop_timer(ctx, &ctx->total_ext_time);
150 SORT_TRACE("Mergesort pass %d (final run, %s, %dMB/s)", pass, stk_fsize(join_size), sorter_speed(ctx, join_size));
155 outs[0] = sbuck_new(ctx);
156 outs[1] = sbuck_new(ctx);
158 ctx->twoway_merge(ctx, ins, outs);
159 sorter_stop_timer(ctx, &ctx->total_ext_time);
160 SORT_TRACE("Mergesort pass %d (%d+%d runs, %s+%s, %dMB/s)", pass,
161 outs[0]->runs, outs[1]->runs,
162 F_BSIZE(outs[0]), F_BSIZE(outs[1]),
163 sorter_speed(ctx, sbuck_size(outs[0]) + sbuck_size(outs[1])));
166 memcpy(ins, outs, 3*sizeof(struct sort_bucket *));
167 } while (sbuck_have(ins[1]));
170 clist_insert_after(&ins[0]->n, list_pos);
174 sorter_radix_bits(struct sort_context *ctx, struct sort_bucket *b)
176 if (!b->hash_bits || !ctx->radix_split ||
177 (b->flags & SBF_CUSTOM_PRESORT) ||
178 (sorter_debug & SORT_DEBUG_NO_RADIX))
181 u64 in = sbuck_size(b);
182 u64 mem = ctx->internal_estimate(ctx, b) * 0.8; // FIXME: Magical factor for hash non-uniformity
186 uns n = sorter_min_radix_bits;
187 while (n < sorter_max_radix_bits && n < b->hash_bits && (in >> n) > mem)
193 sorter_radix(struct sort_context *ctx, struct sort_bucket *b, uns bits)
195 uns nbuck = 1 << bits;
196 SORT_XTRACE(2, "Running radix split on %s with hash %d bits of %d (expecting %s buckets)",
197 F_BSIZE(b), bits, b->hash_bits, stk_fsize(sbuck_size(b) / nbuck));
198 sorter_free_buf(ctx);
199 sorter_start_timer(ctx);
201 struct sort_bucket **outs = alloca(nbuck * sizeof(struct sort_bucket *));
202 for (uns i=nbuck; i--; )
204 outs[i] = sbuck_new(ctx);
205 outs[i]->hash_bits = b->hash_bits - bits;
206 clist_insert_after(&outs[i]->n, &b->n);
209 ctx->radix_split(ctx, b, outs, b->hash_bits - bits, bits);
211 u64 min = ~(u64)0, max = 0, sum = 0;
212 for (uns i=0; i<nbuck; i++)
214 u64 s = sbuck_size(outs[i]);
219 sbuck_swap_out(outs[i]);
222 sorter_stop_timer(ctx, &ctx->total_ext_time);
223 SORT_TRACE("Radix split (%d buckets, %s min, %s max, %s avg, %dMB/s)", nbuck,
224 stk_fsize(min), stk_fsize(max), stk_fsize(sum / nbuck), sorter_speed(ctx, sum));
229 sorter_run(struct sort_context *ctx)
231 ctx->pool = mp_new(4096);
232 clist_init(&ctx->bucket_list);
233 sorter_prepare_buf(ctx);
235 // Create bucket containing the source
236 struct sort_bucket *bin = sbuck_new(ctx);
237 bin->flags = SBF_SOURCE | SBF_OPEN_READ;
238 if (ctx->custom_presort)
239 bin->flags |= SBF_CUSTOM_PRESORT;
241 bin->fb = ctx->in_fb;
243 bin->size = ctx->in_size;
244 bin->hash_bits = ctx->hash_bits;
245 clist_add_tail(&ctx->bucket_list, &bin->n);
246 SORT_XTRACE(2, "Input size: %s", F_BSIZE(bin));
248 // Create bucket for the output
249 struct sort_bucket *bout = sbuck_new(ctx);
250 bout->flags = SBF_FINAL;
251 if (bout->fb = ctx->out_fb)
252 bout->flags |= SBF_OPEN_WRITE;
255 clist_add_head(&ctx->bucket_list, &bout->n);
257 struct sort_bucket *b;
259 while (bout = clist_head(&ctx->bucket_list), b = clist_next(&ctx->bucket_list, &bout->n))
261 SORT_XTRACE(2, "Next block: %s, %d hash bits", F_BSIZE(b), b->hash_bits);
264 else if (b->runs == 1)
266 else if (bits = sorter_radix_bits(ctx, b))
267 sorter_radix(ctx, b, bits);
269 sorter_twoway(ctx, b);
272 sorter_free_buf(ctx);
273 sbuck_write(bout); // Force empty bucket to a file
274 SORT_XTRACE(2, "Final size: %s", F_BSIZE(bout));
275 SORT_XTRACE(2, "Final timings: %.3fs external sorting, %.3fs presorting, %.3fs internal sorting",
276 ctx->total_ext_time/1000., ctx->total_pre_time/1000., ctx->total_int_time/1000.);
277 ctx->out_fb = sbuck_read(bout);