lib/libc/stdlib/qsort.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 #if defined(LIBC_SCCS) && !defined(lint)
  33 static char sccsid[] = "@(#)qsort.c     8.1 (Berkeley) 6/4/93";
  34 #endif /* LIBC_SCCS and not lint */
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <errno.h>
  39 #include <stdint.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42 #include "libc_private.h"
  43
  44 #if defined(I_AM_QSORT_R)
  45 typedef int              cmp_t(void *, const void *, const void *);
  46 #elif defined(I_AM_QSORT_S)
  47 typedef int              cmp_t(const void *, const void *, void *);
  48 #else
  49 typedef int              cmp_t(const void *, const void *);
  50 #endif
  51 static inline char      *med3(char *, char *, char *, cmp_t *, void *);
  52
  53 #define MIN(a, b)       ((a) < (b) ? a : b)
  54
  55 /*
  56  * Qsort routine from Bentley & McIlroy's "Engineering a Sort Function".
  57  */
  58
  59 static inline void
  60 swapfunc(char *a, char *b, size_t es)
  61 {
  62         char t;
  63
  64         do {
  65                 t = *a;
  66                 *a++ = *b;
  67                 *b++ = t;
  68         } while (--es > 0);
  69 }
  70
  71 #define vecswap(a, b, n)                                \
  72         if ((n) > 0) swapfunc(a, b, n)
  73
  74 #if defined(I_AM_QSORT_R)
  75 #define CMP(t, x, y) (cmp((t), (x), (y)))
  76 #elif defined(I_AM_QSORT_S)
  77 #define CMP(t, x, y) (cmp((x), (y), (t)))
  78 #else
  79 #define CMP(t, x, y) (cmp((x), (y)))
  80 #endif
  81
  82 static inline char *
  83 med3(char *a, char *b, char *c, cmp_t *cmp, void *thunk
  84 #if !defined(I_AM_QSORT_R) && !defined(I_AM_QSORT_S)
  85 __unused
  86 #endif
  87 )
  88 {
  89         return CMP(thunk, a, b) < 0 ?
  90                (CMP(thunk, b, c) < 0 ? b : (CMP(thunk, a, c) < 0 ? c : a ))
  91               :(CMP(thunk, b, c) > 0 ? b : (CMP(thunk, a, c) < 0 ? a : c ));
  92 }
  93
  94 #if defined(I_AM_QSORT_R)
  95 void
  96 qsort_r(void *a, size_t n, size_t es, void *thunk, cmp_t *cmp)
  97 #elif defined(I_AM_QSORT_S)
  98 errno_t
  99 qsort_s(void *a, rsize_t n, rsize_t es, cmp_t *cmp, void *thunk)
 100 #else
 101 #define thunk NULL
 102 void
 103 qsort(void *a, size_t n, size_t es, cmp_t *cmp)
 104 #endif
 105 {
 106         char *pa, *pb, *pc, *pd, *pl, *pm, *pn;
 107         size_t d1, d2;
 108         int cmp_result;
 109         int swap_cnt;
 110
 111 #ifdef I_AM_QSORT_S
 112         if (n > RSIZE_MAX) {
 113                 __throw_constraint_handler_s("qsort_s : n > RSIZE_MAX", EINVAL);
 114                 return (EINVAL);
 115         } else if (es > RSIZE_MAX) {
 116                 __throw_constraint_handler_s("qsort_s : es > RSIZE_MAX", EINVAL);
 117                 return (EINVAL);
 118         } else if (n != 0) {
 119                 if (a == NULL) {
 120                         __throw_constraint_handler_s("qsort_s : a == NULL", EINVAL);
 121                         return (EINVAL);
 122                 } else if (cmp == NULL) {
 123                         __throw_constraint_handler_s("qsort_s : cmp == NULL", EINVAL);
 124                         return (EINVAL);
 125                 }
 126         }
 127 #endif
 128
 129 loop:
 130         swap_cnt = 0;
 131         if (n < 7) {
 132                 for (pm = (char *)a + es; pm < (char *)a + n * es; pm += es)
 133                         for (pl = pm;
 134                              pl > (char *)a && CMP(thunk, pl - es, pl) > 0;
 135                              pl -= es)
 136                                 swapfunc(pl, pl - es, es);
 137 #ifdef I_AM_QSORT_S
 138                 return (0);
 139 #else
 140                 return;
 141 #endif
 142         }
 143         pm = (char *)a + (n / 2) * es;
 144         if (n > 7) {
 145                 pl = a;
 146                 pn = (char *)a + (n - 1) * es;
 147                 if (n > 40) {
 148                         size_t d = (n / 8) * es;
 149
 150                         pl = med3(pl, pl + d, pl + 2 * d, cmp, thunk);
 151                         pm = med3(pm - d, pm, pm + d, cmp, thunk);
 152                         pn = med3(pn - 2 * d, pn - d, pn, cmp, thunk);
 153                 }
 154                 pm = med3(pl, pm, pn, cmp, thunk);
 155         }
 156         swapfunc(a, pm, es);
 157         pa = pb = (char *)a + es;
 158
 159         pc = pd = (char *)a + (n - 1) * es;
 160         for (;;) {
 161                 while (pb <= pc && (cmp_result = CMP(thunk, pb, a)) <= 0) {
 162                         if (cmp_result == 0) {
 163                                 swap_cnt = 1;
 164                                 swapfunc(pa, pb, es);
 165                                 pa += es;
 166                         }
 167                         pb += es;
 168                 }
 169                 while (pb <= pc && (cmp_result = CMP(thunk, pc, a)) >= 0) {
 170                         if (cmp_result == 0) {
 171                                 swap_cnt = 1;
 172                                 swapfunc(pc, pd, es);
 173                                 pd -= es;
 174                         }
 175                         pc -= es;
 176                 }
 177                 if (pb > pc)
 178                         break;
 179                 swapfunc(pb, pc, es);
 180                 swap_cnt = 1;
 181                 pb += es;
 182                 pc -= es;
 183         }
 184         if (swap_cnt == 0) {  /* Switch to insertion sort */
 185                 for (pm = (char *)a + es; pm < (char *)a + n * es; pm += es)
 186                         for (pl = pm;
 187                              pl > (char *)a && CMP(thunk, pl - es, pl) > 0;
 188                              pl -= es)
 189                                 swapfunc(pl, pl - es, es);
 190 #ifdef I_AM_QSORT_S
 191                 return (0);
 192 #else
 193                 return;
 194 #endif
 195         }
 196
 197         pn = (char *)a + n * es;
 198         d1 = MIN(pa - (char *)a, pb - pa);
 199         vecswap(a, pb - d1, d1);
 200         d1 = MIN(pd - pc, pn - pd - es);
 201         vecswap(pb, pn - d1, d1);
 202
 203         d1 = pb - pa;
 204         d2 = pd - pc;
 205         if (d1 <= d2) {
 206                 /* Recurse on left partition, then iterate on right partition */
 207                 if (d1 > es) {
 208 #if defined(I_AM_QSORT_R)
 209                         qsort_r(a, d1 / es, es, thunk, cmp);
 210 #elif defined(I_AM_QSORT_S)
 211                         qsort_s(a, d1 / es, es, cmp, thunk);
 212 #else
 213                         qsort(a, d1 / es, es, cmp);
 214 #endif
 215                 }
 216                 if (d2 > es) {
 217                         /* Iterate rather than recurse to save stack space */
 218                         /* qsort(pn - d2, d2 / es, es, cmp); */
 219                         a = pn - d2;
 220                         n = d2 / es;
 221                         goto loop;
 222                 }
 223         } else {
 224                 /* Recurse on right partition, then iterate on left partition */
 225                 if (d2 > es) {
 226 #if defined(I_AM_QSORT_R)
 227                         qsort_r(pn - d2, d2 / es, es, thunk, cmp);
 228 #elif defined(I_AM_QSORT_S)
 229                         qsort_s(pn - d2, d2 / es, es, cmp, thunk);
 230 #else
 231                         qsort(pn - d2, d2 / es, es, cmp);
 232 #endif
 233                 }
 234                 if (d1 > es) {
 235                         /* Iterate rather than recurse to save stack space */
 236                         /* qsort(a, d1 / es, es, cmp); */
 237                         n = d1 / es;
 238                         goto loop;
 239                 }
 240         }
 241
 242 #ifdef I_AM_QSORT_S
 243         return (0);
 244 #endif
 245 }