source4/lib/ldb/common/qsort.c

   1 /* Copyright (C) 1991,1992,1996,1997,1999,2004 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Written by Douglas C. Schmidt (schmidt@ics.uci.edu).
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 /* If you consider tuning this algorithm, you should consult first:
  21    Engineering a sort function; Jon Bentley and M. Douglas McIlroy;
  22    Software - Practice and Experience; Vol. 23 (11), 1249-1265, 1993.  */
  23
  24 /* Modified to be used in samba4 by
  25  * Simo Sorce <idra@samba.org>          2005
  26  */
  27
  28 #include "includes.h"
  29 #include "ldb/include/ldb.h"
  30
  31 #include <limits.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34
  35 /* Byte-wise swap two items of size SIZE. */
  36 #define SWAP(a, b, size)                                                      \
  37   do                                                                          \
  38     {                                                                         \
  39       register size_t __size = (size);                                        \
  40       register char *__a = (a), *__b = (b);                                   \
  41       do                                                                      \
  42         {                                                                     \
  43           char __tmp = *__a;                                                  \
  44           *__a++ = *__b;                                                      \
  45           *__b++ = __tmp;                                                     \
  46         } while (--__size > 0);                                               \
  47     } while (0)
  48
  49 /* Discontinue quicksort algorithm when partition gets below this size.
  50    This particular magic number was chosen to work best on a Sun 4/260. */
  51 #define MAX_THRESH 4
  52
  53 /* Stack node declarations used to store unfulfilled partition obligations. */
  54 typedef struct
  55   {
  56     char *lo;
  57     char *hi;
  58   } stack_node;
  59
  60 /* The next 4 #defines implement a very fast in-line stack abstraction. */
  61 /* The stack needs log (total_elements) entries (we could even subtract
  62    log(MAX_THRESH)).  Since total_elements has type size_t, we get as
  63    upper bound for log (total_elements):
  64    bits per byte (CHAR_BIT) * sizeof(size_t).  */
  65 #define STACK_SIZE      (CHAR_BIT * sizeof(size_t))
  66 #define PUSH(low, high) ((void) ((top->lo = (low)), (top->hi = (high)), ++top))
  67 #define POP(low, high)  ((void) (--top, (low = top->lo), (high = top->hi)))
  68 #define STACK_NOT_EMPTY (stack < top)
  69
  70
  71 /* Order size using quicksort.  This implementation incorporates
  72    four optimizations discussed in Sedgewick:
  73
  74    1. Non-recursive, using an explicit stack of pointer that store the
  75       next array partition to sort.  To save time, this maximum amount
  76       of space required to store an array of SIZE_MAX is allocated on the
  77       stack.  Assuming a 32-bit (64 bit) integer for size_t, this needs
  78       only 32 * sizeof(stack_node) == 256 bytes (for 64 bit: 1024 bytes).
  79       Pretty cheap, actually.
  80
  81    2. Chose the pivot element using a median-of-three decision tree.
  82       This reduces the probability of selecting a bad pivot value and
  83       eliminates certain extraneous comparisons.
  84
  85    3. Only quicksorts TOTAL_ELEMS / MAX_THRESH partitions, leaving
  86       insertion sort to order the MAX_THRESH items within each partition.
  87       This is a big win, since insertion sort is faster for small, mostly
  88       sorted array segments.
  89
  90    4. The larger of the two sub-partitions is always pushed onto the
  91       stack first, with the algorithm then concentrating on the
  92       smaller partition.  This *guarantees* no more than log (total_elems)
  93       stack size is needed (actually O(1) in this case)!  */
  94
  95 void ldb_qsort (void *const pbase, size_t total_elems, size_t size,
  96                 void *opaque, ldb_qsort_cmp_fn_t cmp)
  97 {
  98   register char *base_ptr = (char *) pbase;
  99
 100   const size_t max_thresh = MAX_THRESH * size;
 101
 102   if (total_elems == 0)
 103     /* Avoid lossage with unsigned arithmetic below.  */
 104     return;
 105
 106   if (total_elems > MAX_THRESH)
 107     {
 108       char *lo = base_ptr;
 109       char *hi = &lo[size * (total_elems - 1)];
 110       stack_node stack[STACK_SIZE];
 111       stack_node *top = stack;
 112
 113       PUSH (NULL, NULL);
 114
 115       while (STACK_NOT_EMPTY)
 116         {
 117           char *left_ptr;
 118           char *right_ptr;
 119
 120           /* Select median value from among LO, MID, and HI. Rearrange
 121              LO and HI so the three values are sorted. This lowers the
 122              probability of picking a pathological pivot value and
 123              skips a comparison for both the LEFT_PTR and RIGHT_PTR in
 124              the while loops. */
 125
 126           char *mid = lo + size * ((hi - lo) / size >> 1);
 127
 128           if ((*cmp) ((void *) mid, (void *) lo, opaque) < 0)
 129             SWAP (mid, lo, size);
 130           if ((*cmp) ((void *) hi, (void *) mid, opaque) < 0)
 131             SWAP (mid, hi, size);
 132           else
 133             goto jump_over;
 134           if ((*cmp) ((void *) mid, (void *) lo, opaque) < 0)
 135             SWAP (mid, lo, size);
 136         jump_over:;
 137
 138           left_ptr  = lo + size;
 139           right_ptr = hi - size;
 140
 141           /* Here's the famous ``collapse the walls'' section of quicksort.
 142              Gotta like those tight inner loops!  They are the main reason
 143              that this algorithm runs much faster than others. */
 144           do
 145             {
 146               while ((*cmp) ((void *) left_ptr, (void *) mid, opaque) < 0)
 147                 left_ptr += size;
 148
 149               while ((*cmp) ((void *) mid, (void *) right_ptr, opaque) < 0)
 150                 right_ptr -= size;
 151
 152               if (left_ptr < right_ptr)
 153                 {
 154                   SWAP (left_ptr, right_ptr, size);
 155                   if (mid == left_ptr)
 156                     mid = right_ptr;
 157                   else if (mid == right_ptr)
 158                     mid = left_ptr;
 159                   left_ptr += size;
 160                   right_ptr -= size;
 161                 }
 162               else if (left_ptr == right_ptr)
 163                 {
 164                   left_ptr += size;
 165                   right_ptr -= size;
 166                   break;
 167                 }
 168             }
 169           while (left_ptr <= right_ptr);
 170
 171           /* Set up pointers for next iteration.  First determine whether
 172              left and right partitions are below the threshold size.  If so,
 173              ignore one or both.  Otherwise, push the larger partition's
 174              bounds on the stack and continue sorting the smaller one. */
 175
 176           if ((size_t) (right_ptr - lo) <= max_thresh)
 177             {
 178               if ((size_t) (hi - left_ptr) <= max_thresh)
 179                 /* Ignore both small partitions. */
 180                 POP (lo, hi);
 181               else
 182                 /* Ignore small left partition. */
 183                 lo = left_ptr;
 184             }
 185           else if ((size_t) (hi - left_ptr) <= max_thresh)
 186             /* Ignore small right partition. */
 187             hi = right_ptr;
 188           else if ((right_ptr - lo) > (hi - left_ptr))
 189             {
 190               /* Push larger left partition indices. */
 191               PUSH (lo, right_ptr);
 192               lo = left_ptr;
 193             }
 194           else
 195             {
 196               /* Push larger right partition indices. */
 197               PUSH (left_ptr, hi);
 198               hi = right_ptr;
 199             }
 200         }
 201     }
 202
 203   /* Once the BASE_PTR array is partially sorted by quicksort the rest
 204      is completely sorted using insertion sort, since this is efficient
 205      for partitions below MAX_THRESH size. BASE_PTR points to the beginning
 206      of the array to sort, and END_PTR points at the very last element in
 207      the array (*not* one beyond it!). */
 208
 209 #define min(x, y) ((x) < (y) ? (x) : (y))
 210
 211   {
 212     char *const end_ptr = &base_ptr[size * (total_elems - 1)];
 213     char *tmp_ptr = base_ptr;
 214     char *thresh = min(end_ptr, base_ptr + max_thresh);
 215     register char *run_ptr;
 216
 217     /* Find smallest element in first threshold and place it at the
 218        array's beginning.  This is the smallest array element,
 219        and the operation speeds up insertion sort's inner loop. */
 220
 221     for (run_ptr = tmp_ptr + size; run_ptr <= thresh; run_ptr += size)
 222       if ((*cmp) ((void *) run_ptr, (void *) tmp_ptr, opaque) < 0)
 223         tmp_ptr = run_ptr;
 224
 225     if (tmp_ptr != base_ptr)
 226       SWAP (tmp_ptr, base_ptr, size);
 227
 228     /* Insertion sort, running from left-hand-side up to right-hand-side.  */
 229
 230     run_ptr = base_ptr + size;
 231     while ((run_ptr += size) <= end_ptr)
 232       {
 233         tmp_ptr = run_ptr - size;
 234         while ((*cmp) ((void *) run_ptr, (void *) tmp_ptr, opaque) < 0)
 235           tmp_ptr -= size;
 236
 237         tmp_ptr += size;
 238         if (tmp_ptr != run_ptr)
 239           {
 240             char *trav;
 241
 242             trav = run_ptr + size;
 243             while (--trav >= run_ptr)
 244               {
 245                 char c = *trav;
 246                 char *hi, *lo;
 247
 248                 for (hi = lo = trav; (lo -= size) >= tmp_ptr; hi = lo)
 249                   *hi = *lo;
 250                 *hi = c;
 251               }
 252           }
 253       }
 254   }
 255 }