Blame glib/glib/gqsort.c

Packit db3073
/* GLIB - Library of useful routines for C programming
Packit db3073
 * Copyright (C) 1991, 1992, 1996, 1997,1999,2004 Free Software Foundation, Inc.
Packit db3073
 * Copyright (C) 2000 Eazel, Inc.
Packit db3073
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
Packit db3073
 *
Packit db3073
 * This library is free software; you can redistribute it and/or
Packit db3073
 * modify it under the terms of the GNU Lesser General Public
Packit db3073
 * License as published by the Free Software Foundation; either
Packit db3073
 * version 2 of the License, or (at your option) any later version.
Packit db3073
 *
Packit db3073
 * This library is distributed in the hope that it will be useful,
Packit db3073
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit db3073
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
Packit db3073
 * Lesser General Public License for more details.
Packit db3073
 *
Packit db3073
 * You should have received a copy of the GNU Lesser General Public
Packit db3073
 * License along with this library; if not, write to the
Packit db3073
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Packit db3073
 * Boston, MA 02111-1307, USA.
Packit db3073
 */
Packit db3073
Packit db3073
#include "config.h"
Packit db3073
Packit db3073
#include <limits.h>
Packit db3073
#include <stdlib.h>
Packit db3073
#include <string.h>
Packit db3073
#include "galloca.h"
Packit db3073
#include "gmem.h"
Packit db3073
Packit db3073
#include "gqsort.h"
Packit db3073
Packit db3073
#include "gtestutils.h"
Packit db3073
Packit db3073
/* This file was originally from stdlib/msort.c in gnu libc, just changed
Packit db3073
   to build inside glib and to not fall back to an unstable quicksort
Packit db3073
   for large arrays. */
Packit db3073
Packit db3073
/* An alternative to qsort, with an identical interface.
Packit db3073
   This file is part of the GNU C Library.
Packit db3073
   Copyright (C) 1992,95-97,99,2000,01,02,04,07 Free Software Foundation, Inc.
Packit db3073
   Written by Mike Haertel, September 1988.
Packit db3073
Packit db3073
   The GNU C Library is free software; you can redistribute it and/or
Packit db3073
   modify it under the terms of the GNU Lesser General Public
Packit db3073
   License as published by the Free Software Foundation; either
Packit db3073
   version 2.1 of the License, or (at your option) any later version.
Packit db3073
Packit db3073
   The GNU C Library is distributed in the hope that it will be useful,
Packit db3073
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit db3073
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit db3073
   Lesser General Public License for more details.
Packit db3073
Packit db3073
   You should have received a copy of the GNU Lesser General Public
Packit db3073
   License along with the GNU C Library; if not, see
Packit db3073
   <http://www.gnu.org/licenses/>.  */
Packit db3073
Packit db3073
Packit db3073
struct msort_param
Packit db3073
{
Packit db3073
  size_t s;
Packit db3073
  size_t var;
Packit db3073
  GCompareDataFunc cmp;
Packit db3073
  void *arg;
Packit db3073
  char *t;
Packit db3073
};
Packit db3073
Packit db3073
static void msort_with_tmp (const struct msort_param *p, void *b, size_t n);
Packit db3073
Packit db3073
static void
Packit db3073
msort_with_tmp (const struct msort_param *p, void *b, size_t n)
Packit db3073
{
Packit db3073
  char *b1, *b2;
Packit db3073
  size_t n1, n2;
Packit db3073
  char *tmp = p->t;
Packit db3073
  const size_t s = p->s;
Packit db3073
  GCompareDataFunc cmp = p->cmp;
Packit db3073
  void *arg = p->arg;
Packit db3073
Packit db3073
  if (n <= 1)
Packit db3073
    return;
Packit db3073
Packit db3073
  n1 = n / 2;
Packit db3073
  n2 = n - n1;
Packit db3073
  b1 = b;
Packit db3073
  b2 = (char *) b + (n1 * p->s);
Packit db3073
Packit db3073
  msort_with_tmp (p, b1, n1);
Packit db3073
  msort_with_tmp (p, b2, n2);
Packit db3073
Packit db3073
  switch (p->var)
Packit db3073
    {
Packit db3073
    case 0:
Packit db3073
      while (n1 > 0 && n2 > 0)
Packit db3073
	{
Packit db3073
	  if ((*cmp) (b1, b2, arg) <= 0)
Packit db3073
	    {
Packit db3073
	      *(guint32 *) tmp = *(guint32 *) b1;
Packit db3073
	      b1 += sizeof (guint32);
Packit db3073
	      --n1;
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      *(guint32 *) tmp = *(guint32 *) b2;
Packit db3073
	      b2 += sizeof (guint32);
Packit db3073
	      --n2;
Packit db3073
	    }
Packit db3073
	  tmp += sizeof (guint32);
Packit db3073
	}
Packit db3073
      break;
Packit db3073
    case 1:
Packit db3073
      while (n1 > 0 && n2 > 0)
Packit db3073
	{
Packit db3073
	  if ((*cmp) (b1, b2, arg) <= 0)
Packit db3073
	    {
Packit db3073
	      *(guint64 *) tmp = *(guint64 *) b1;
Packit db3073
	      b1 += sizeof (guint64);
Packit db3073
	      --n1;
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      *(guint64 *) tmp = *(guint64 *) b2;
Packit db3073
	      b2 += sizeof (guint64);
Packit db3073
	      --n2;
Packit db3073
	    }
Packit db3073
	  tmp += sizeof (guint64);
Packit db3073
	}
Packit db3073
      break;
Packit db3073
    case 2:
Packit db3073
      while (n1 > 0 && n2 > 0)
Packit db3073
	{
Packit db3073
	  unsigned long *tmpl = (unsigned long *) tmp;
Packit db3073
	  unsigned long *bl;
Packit db3073
Packit db3073
	  tmp += s;
Packit db3073
	  if ((*cmp) (b1, b2, arg) <= 0)
Packit db3073
	    {
Packit db3073
	      bl = (unsigned long *) b1;
Packit db3073
	      b1 += s;
Packit db3073
	      --n1;
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      bl = (unsigned long *) b2;
Packit db3073
	      b2 += s;
Packit db3073
	      --n2;
Packit db3073
	    }
Packit db3073
	  while (tmpl < (unsigned long *) tmp)
Packit db3073
	    *tmpl++ = *bl++;
Packit db3073
	}
Packit db3073
      break;
Packit db3073
    case 3:
Packit db3073
      while (n1 > 0 && n2 > 0)
Packit db3073
	{
Packit db3073
	  if ((*cmp) (*(const void **) b1, *(const void **) b2, arg) <= 0)
Packit db3073
	    {
Packit db3073
	      *(void **) tmp = *(void **) b1;
Packit db3073
	      b1 += sizeof (void *);
Packit db3073
	      --n1;
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      *(void **) tmp = *(void **) b2;
Packit db3073
	      b2 += sizeof (void *);
Packit db3073
	      --n2;
Packit db3073
	    }
Packit db3073
	  tmp += sizeof (void *);
Packit db3073
	}
Packit db3073
      break;
Packit db3073
    default:
Packit db3073
      while (n1 > 0 && n2 > 0)
Packit db3073
	{
Packit db3073
	  if ((*cmp) (b1, b2, arg) <= 0)
Packit db3073
	    {
Packit db3073
	      memcpy (tmp, b1, s);
Packit db3073
	      tmp += s;
Packit db3073
	      b1 += s;
Packit db3073
	      --n1;
Packit db3073
	    }
Packit db3073
	  else
Packit db3073
	    {
Packit db3073
	      memcpy (tmp, b2, s);
Packit db3073
	      tmp += s;
Packit db3073
	      b2 += s;
Packit db3073
	      --n2;
Packit db3073
	    }
Packit db3073
	}
Packit db3073
      break;
Packit db3073
    }
Packit db3073
Packit db3073
  if (n1 > 0)
Packit db3073
    memcpy (tmp, b1, n1 * s);
Packit db3073
  memcpy (b, p->t, (n - n2) * s);
Packit db3073
}
Packit db3073
Packit db3073
Packit db3073
static void
Packit db3073
msort_r (void *b, size_t n, size_t s, GCompareDataFunc cmp, void *arg)
Packit db3073
{
Packit db3073
  size_t size = n * s;
Packit db3073
  char *tmp = NULL;
Packit db3073
  struct msort_param p;
Packit db3073
Packit db3073
  /* For large object sizes use indirect sorting.  */
Packit db3073
  if (s > 32)
Packit db3073
    size = 2 * n * sizeof (void *) + s;
Packit db3073
Packit db3073
  if (size < 1024)
Packit db3073
    /* The temporary array is small, so put it on the stack.  */
Packit db3073
    p.t = g_alloca (size);
Packit db3073
  else
Packit db3073
    {
Packit db3073
      /* It's large, so malloc it.  */
Packit db3073
      tmp = g_malloc (size);
Packit db3073
      p.t = tmp;
Packit db3073
    }
Packit db3073
Packit db3073
  p.s = s;
Packit db3073
  p.var = 4;
Packit db3073
  p.cmp = cmp;
Packit db3073
  p.arg = arg;
Packit db3073
Packit db3073
  if (s > 32)
Packit db3073
    {
Packit db3073
      /* Indirect sorting.  */
Packit db3073
      char *ip = (char *) b;
Packit db3073
      void **tp = (void **) (p.t + n * sizeof (void *));
Packit db3073
      void **t = tp;
Packit db3073
      void *tmp_storage = (void *) (tp + n);
Packit db3073
      char *kp;
Packit db3073
      size_t i;
Packit db3073
Packit db3073
      while ((void *) t < tmp_storage)
Packit db3073
	{
Packit db3073
	  *t++ = ip;
Packit db3073
	  ip += s;
Packit db3073
	}
Packit db3073
      p.s = sizeof (void *);
Packit db3073
      p.var = 3;
Packit db3073
      msort_with_tmp (&p, p.t + n * sizeof (void *), n);
Packit db3073
Packit db3073
      /* tp[0] .. tp[n - 1] is now sorted, copy around entries of
Packit db3073
	 the original array.  Knuth vol. 3 (2nd ed.) exercise 5.2-10.  */
Packit db3073
      for (i = 0, ip = (char *) b; i < n; i++, ip += s)
Packit db3073
	if ((kp = tp[i]) != ip)
Packit db3073
	  {
Packit db3073
	    size_t j = i;
Packit db3073
	    char *jp = ip;
Packit db3073
	    memcpy (tmp_storage, ip, s);
Packit db3073
Packit db3073
	    do
Packit db3073
	      {
Packit db3073
		size_t k = (kp - (char *) b) / s;
Packit db3073
		tp[j] = jp;
Packit db3073
		memcpy (jp, kp, s);
Packit db3073
		j = k;
Packit db3073
		jp = kp;
Packit db3073
		kp = tp[k];
Packit db3073
	      }
Packit db3073
	    while (kp != ip);
Packit db3073
Packit db3073
	    tp[j] = jp;
Packit db3073
	    memcpy (jp, tmp_storage, s);
Packit db3073
	  }
Packit db3073
    }
Packit db3073
  else
Packit db3073
    {
Packit db3073
      if ((s & (sizeof (guint32) - 1)) == 0
Packit db3073
	  && ((char *) b - (char *) 0) % ALIGNOF_GUINT32 == 0)
Packit db3073
	{
Packit db3073
	  if (s == sizeof (guint32))
Packit db3073
	    p.var = 0;
Packit db3073
	  else if (s == sizeof (guint64)
Packit db3073
		   && ((char *) b - (char *) 0) % ALIGNOF_GUINT64 == 0)
Packit db3073
	    p.var = 1;
Packit db3073
	  else if ((s & (sizeof (unsigned long) - 1)) == 0
Packit db3073
		   && ((char *) b - (char *) 0)
Packit db3073
		      % ALIGNOF_UNSIGNED_LONG == 0)
Packit db3073
	    p.var = 2;
Packit db3073
	}
Packit db3073
      msort_with_tmp (&p, b, n);
Packit db3073
    }
Packit db3073
  g_free (tmp);
Packit db3073
}
Packit db3073
Packit db3073
/**
Packit db3073
 * g_qsort_with_data:
Packit db3073
 * @pbase: start of array to sort
Packit db3073
 * @total_elems: elements in the array
Packit db3073
 * @size: size of each element
Packit db3073
 * @compare_func: function to compare elements
Packit db3073
 * @user_data: data to pass to @compare_func
Packit db3073
 *
Packit db3073
 * This is just like the standard C qsort() function, but
Packit db3073
 * the comparison routine accepts a user data argument.
Packit db3073
 *
Packit db3073
 * This is guaranteed to be a stable sort since version 2.32.
Packit db3073
 */
Packit db3073
void
Packit db3073
g_qsort_with_data (gconstpointer    pbase,
Packit db3073
                   gint             total_elems,
Packit db3073
                   gsize            size,
Packit db3073
                   GCompareDataFunc compare_func,
Packit db3073
                   gpointer         user_data)
Packit db3073
{
Packit db3073
  msort_r ((gpointer)pbase, total_elems, size, compare_func, user_data);
Packit db3073
}