diff mbox

Add Berkeley qsort to libiberty to make GCC host-independent

Message ID CAFc0fxx7V6o-d0adJfbQ7=+zXFTu8Ebh0sY9oPJP0L8xrJ6oEA@mail.gmail.com
State New
Headers show

Commit Message

Felix Yang Aug. 13, 2014, 12:12 p.m. UTC
Hi all,

    The qsort library function may have different behavior on
different hosts (say Linux vs MinGW).
    We may have different sorting results with qsort when there are
elements with the same key value.
    GCC uses qsort a lot. And the output of certain optimizations,
such as IRA, relies on the sorting result of this library function.
    The problem is that we may have different assembly code of GCC on
different hosts even with the same source file.
    Normally this is not what a GCC user expect to see.
    In order to fix this issue, I am adding Berkeley qsort to
libiberty in order to override the one from the library.

    Bootstrapped on x86_64-suse-linux, OK for trunk? Please help
commit this patch if it's OK.

Cheers,
Felix

Comments

Jakub Jelinek Aug. 13, 2014, 12:16 p.m. UTC | #1
On Wed, Aug 13, 2014 at 08:12:03PM +0800, Felix Yang wrote:
>     The qsort library function may have different behavior on
> different hosts (say Linux vs MinGW).
>     We may have different sorting results with qsort when there are
> elements with the same key value.
>     GCC uses qsort a lot. And the output of certain optimizations,
> such as IRA, relies on the sorting result of this library function.
>     The problem is that we may have different assembly code of GCC on
> different hosts even with the same source file.
>     Normally this is not what a GCC user expect to see.
>     In order to fix this issue, I am adding Berkeley qsort to
> libiberty in order to override the one from the library.

Why have you picked a BSD one rather than the GNU one?
glibc qsort is highly optimized and has some other nice properties qsort
from many other sources does not have.

	Jakub
Felix Yang Aug. 13, 2014, 12:48 p.m. UTC | #2
Hi Jakub,

    I did tried to use the glibc qsort. I compared the source of the
two versions.
    I found that the BSD one is more self-contained and easy for
integration with libiberty.
    That's why the BSD one is preferred.
    And we already have several BSD functions there in libiberty
(libiberty/random.c, an example).
Cheers,
Felix


On Wed, Aug 13, 2014 at 8:16 PM, Jakub Jelinek <jakub@redhat.com> wrote:
> On Wed, Aug 13, 2014 at 08:12:03PM +0800, Felix Yang wrote:
>>     The qsort library function may have different behavior on
>> different hosts (say Linux vs MinGW).
>>     We may have different sorting results with qsort when there are
>> elements with the same key value.
>>     GCC uses qsort a lot. And the output of certain optimizations,
>> such as IRA, relies on the sorting result of this library function.
>>     The problem is that we may have different assembly code of GCC on
>> different hosts even with the same source file.
>>     Normally this is not what a GCC user expect to see.
>>     In order to fix this issue, I am adding Berkeley qsort to
>> libiberty in order to override the one from the library.
>
> Why have you picked a BSD one rather than the GNU one?
> glibc qsort is highly optimized and has some other nice properties qsort
> from many other sources does not have.
>
>         Jakub
Jakub Jelinek Aug. 13, 2014, 12:55 p.m. UTC | #3
On Wed, Aug 13, 2014 at 08:48:52PM +0800, Felix Yang wrote:
>     I did tried to use the glibc qsort. I compared the source of the
> two versions.
>     I found that the BSD one is more self-contained and easy for
> integration with libiberty.

Being more self-contained is not what we care about, the most significant
thing about qsort from GCC POV is performance, people complain about compile
times and slowing compilation down by a few % just so that libiberty can
contain a single file rather than two files doesn't look to be a good idea.

	Jakub
Felix Yang Aug. 13, 2014, 1:14 p.m. UTC | #4
Hi Jakub,

    I got it. I will update the patch after I finished integrating the
GLIBC qsort with libiberty.
Cheers,
Felix


On Wed, Aug 13, 2014 at 8:55 PM, Jakub Jelinek <jakub@redhat.com> wrote:
> On Wed, Aug 13, 2014 at 08:48:52PM +0800, Felix Yang wrote:
>>     I did tried to use the glibc qsort. I compared the source of the
>> two versions.
>>     I found that the BSD one is more self-contained and easy for
>> integration with libiberty.
>
> Being more self-contained is not what we care about, the most significant
> thing about qsort from GCC POV is performance, people complain about compile
> times and slowing compilation down by a few % just so that libiberty can
> contain a single file rather than two files doesn't look to be a good idea.
>
>         Jakub
Jeff Law Aug. 13, 2014, 1:31 p.m. UTC | #5
On 08/13/14 06:12, Felix Yang wrote:
> Hi all,
>
>      The qsort library function may have different behavior on
> different hosts (say Linux vs MinGW).
>      We may have different sorting results with qsort when there are
> elements with the same key value.
>      GCC uses qsort a lot. And the output of certain optimizations,
> such as IRA, relies on the sorting result of this library function.
>      The problem is that we may have different assembly code of GCC on
> different hosts even with the same source file.
>      Normally this is not what a GCC user expect to see.
>      In order to fix this issue, I am adding Berkeley qsort to
> libiberty in order to override the one from the library.
>
>      Bootstrapped on x86_64-suse-linux, OK for trunk? Please help
> commit this patch if it's OK.
Or we find the cases where the sort comparison routine can be tweaked to 
make it stable which makes this class of problems go away.

jeff
Felix Yang Aug. 13, 2014, 1:55 p.m. UTC | #6
Is this possible a Canadian build. I am afread that the qsort then is
from the MinGW/Win host?
Cheers,
Felix


On Wed, Aug 13, 2014 at 9:31 PM, Jeff Law <law@redhat.com> wrote:
> On 08/13/14 06:12, Felix Yang wrote:
>>
>> Hi all,
>>
>>      The qsort library function may have different behavior on
>> different hosts (say Linux vs MinGW).
>>      We may have different sorting results with qsort when there are
>> elements with the same key value.
>>      GCC uses qsort a lot. And the output of certain optimizations,
>> such as IRA, relies on the sorting result of this library function.
>>      The problem is that we may have different assembly code of GCC on
>> different hosts even with the same source file.
>>      Normally this is not what a GCC user expect to see.
>>      In order to fix this issue, I am adding Berkeley qsort to
>> libiberty in order to override the one from the library.
>>
>>      Bootstrapped on x86_64-suse-linux, OK for trunk? Please help
>> commit this patch if it's OK.
>
> Or we find the cases where the sort comparison routine can be tweaked to
> make it stable which makes this class of problems go away.
>
> jeff
Ian Lance Taylor Aug. 13, 2014, 1:57 p.m. UTC | #7
On Wed, Aug 13, 2014 at 6:31 AM, Jeff Law <law@redhat.com> wrote:
> On 08/13/14 06:12, Felix Yang wrote:
>>
>> Hi all,
>>
>>      The qsort library function may have different behavior on
>> different hosts (say Linux vs MinGW).
>>      We may have different sorting results with qsort when there are
>> elements with the same key value.
>>      GCC uses qsort a lot. And the output of certain optimizations,
>> such as IRA, relies on the sorting result of this library function.
>>      The problem is that we may have different assembly code of GCC on
>> different hosts even with the same source file.
>>      Normally this is not what a GCC user expect to see.
>>      In order to fix this issue, I am adding Berkeley qsort to
>> libiberty in order to override the one from the library.
>>
>>      Bootstrapped on x86_64-suse-linux, OK for trunk? Please help
>> commit this patch if it's OK.
>
> Or we find the cases where the sort comparison routine can be tweaked to
> make it stable which makes this class of problems go away.

I tend to agree.  When we want a fully specified sort, it seems to me
we should use a fully specified comparison routine.

Ian
Jeff Law Aug. 13, 2014, 2:02 p.m. UTC | #8
On 08/13/14 07:55, Felix Yang wrote:
> Is this possible a Canadian build. I am afread that the qsort then is
> from the MinGW/Win host?
The stability of the sort is independent of the underlying qsort 
implementation if the comparison routine is fully specified.

It's somewhat painful, but I'd really prefer to have every qsort 
callback routine fully specified.  So if you have examples where it 
isn't certainly pass them along.


jeff
Mike Stump Aug. 13, 2014, 5:59 p.m. UTC | #9
On Aug 13, 2014, at 5:12 AM, Felix Yang <fei.yang0953@gmail.com> wrote:
>    The qsort library function may have different behavior on
> different hosts (say Linux vs MinGW).

> OK for trunk?

I just have one question.  Why if we want to use a stable sort, and we program in C++, would we not want to just use C++:

  http://www.cplusplus.com/reference/algorithm/stable_sort/

I’m hoping that performance doesn’t fall off the cliff with it...
Mike Stump Aug. 13, 2014, 6:01 p.m. UTC | #10
[ dup sorry ]

On Aug 13, 2014, at 5:12 AM, Felix Yang <fei.yang0953@gmail.com> wrote:
>   The qsort library function may have different behavior on
> different hosts (say Linux vs MinGW).

> OK for trunk?

I just have one question.  Why if we want to use a stable sort, and we program in C++, would we not want to just use C++:

 http://www.cplusplus.com/reference/algorithm/stable_sort/

I’m hoping that performance doesn’t fall off the cliff with it...
diff mbox

Patch

Index: libiberty/ChangeLog
===================================================================
--- libiberty/ChangeLog	(revision 213873)
+++ libiberty/ChangeLog	(working copy)
@@ -1,3 +1,10 @@ 
+2014-08-12  Felix Yang  <fei.yang0953@gmail.com>
+
+	* qsort.c: New file.
+	* Makefile.in (CFILES): Add qsort.c
+	(REQUIRED_OFILES): Add qsort.o.
+	(qsort.o): New target.
+
 2014-06-11  Andrew Burgess  <aburgess@broadcom.com>
 
 	* cplus-dem.c (do_type): Call string_delete even if the call to
Index: libiberty/qsort.c
===================================================================
--- libiberty/qsort.c	(revision 0)
+++ libiberty/qsort.c	(revision 0)
@@ -0,0 +1,178 @@ 
+/*
+ * Copyright (c) 1992, 1993
+ *	The Regents of the University of California.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *	This product includes software developed by the University of
+ *	California, Berkeley and its contributors.
+ * 4. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+
+#include <stdlib.h>
+
+#define min(a, b)	(a) < (b) ? a : b
+
+/*
+ * Qsort routine from Bentley & McIlroy's "Engineering a Sort Function".
+ */
+#define swapcode(TYPE, parmi, parmj, n)		\
+{						\
+  long i = (n) / sizeof (TYPE); 		\
+  TYPE *pi = (TYPE *) (parmi);			\
+  TYPE *pj = (TYPE *) (parmj);			\
+  do { 						\
+    TYPE t = *pi;				\
+    *pi++ = *pj;				\
+    *pj++ = t;					\
+  } while (--i > 0);				\
+}
+
+#define SWAPINIT(a, es) swaptype = ((char *)a - (char *)0) % sizeof(long) || \
+	es % sizeof(long) ? 2 : es == sizeof(long)? 0 : 1;
+
+static inline void
+swapfunc (char *a, char *b, int n, int swaptype)
+{
+  if (swaptype <= 1) 
+    swapcode (long, a, b, n)
+  else
+    swapcode (char, a, b, n)
+}
+
+#define swap(a, b)					\
+	if (swaptype == 0) {				\
+		long t = *(long *)(a);			\
+		*(long *)(a) = *(long *)(b);		\
+		*(long *)(b) = t;			\
+	} else						\
+		swapfunc(a, b, es, swaptype)
+
+#define vecswap(a, b, n) 	if ((n) > 0) swapfunc (a, b, n, swaptype)
+
+static inline char *
+med3 (char *a, char *b, char *c, int (*cmp)())
+{
+  return cmp (a, b) < 0 ?
+           (cmp (b, c) < 0 ? b : (cmp (a, c) < 0 ? c : a))
+           : (cmp (b, c) > 0 ? b : (cmp (a, c) < 0 ? a : c));
+}
+
+void
+qsort (void *a, size_t n, size_t es, int (*cmp)())
+{
+  char *pa, *pb, *pc, *pd, *pl, *pm, *pn;
+  int d, r, swaptype, swap_cnt;
+
+loop:
+  SWAPINIT (a, es);
+  swap_cnt = 0;
+  if (n < 7)
+    {
+      for (pm = (char *) a + es; pm < (char *) a + n * es; pm += es)
+        for (pl = pm; pl > (char *) a && cmp (pl - es, pl) > 0; pl -= es)
+          swap (pl, pl - es);
+      return;
+    }
+
+  pm = (char *) a + (n / 2) * es;
+  if (n > 7)
+    {
+      pl = a;
+      pn = (char *) a + (n - 1) * es;
+      if (n > 40)
+        {
+          d = (n / 8) * es;
+          pl = med3 (pl, pl + d, pl + 2 * d, cmp);
+          pm = med3 (pm - d, pm, pm + d, cmp);
+          pn = med3 (pn - 2 * d, pn - d, pn, cmp);
+        }
+      pm = med3 (pl, pm, pn, cmp);
+    }
+
+  swap (a, pm);
+  pa = pb = (char *) a + es;
+
+  pc = pd = (char *) a + (n - 1) * es;
+  for (;;)
+    {
+      while (pb <= pc && (r = cmp (pb, a)) <= 0)
+        {
+          if (r == 0)
+            {
+              swap_cnt = 1;
+              swap (pa, pb);
+              pa += es;
+            }
+          pb += es;
+        }
+
+      while (pb <= pc && (r = cmp (pc, a)) >= 0)
+        {
+          if (r == 0)
+            {
+              swap_cnt = 1;
+              swap (pc, pd);
+              pd -= es;
+            }
+          pc -= es;
+        }
+
+      if (pb > pc)
+        break;
+
+      swap (pb, pc);
+      swap_cnt = 1;
+      pb += es;
+      pc -= es;
+    }
+
+  if (swap_cnt == 0)
+    {
+      /* Switch to insertion sort.  */
+      for (pm = (char *) a + es; pm < (char *) a + n * es; pm += es)
+        for (pl = pm; pl > (char *) a && cmp (pl - es, pl) > 0; pl -= es)
+          swap (pl, pl - es);
+      return;
+    }
+
+  pn = (char *) a + n * es;
+  r = min (pa - (char *)a, pb - pa);
+  vecswap (a, pb - r, r);
+  r = min (pd - pc, pn - pd - es);
+  vecswap (pb, pn - r, r);
+
+  if ((r = pb - pa) > es)
+    qsort (a, r / es, es, cmp);
+
+  if ((r = pd - pc) > es)
+    { 
+      /* Iterate rather than recurse to save stack space.  */
+      a = pn - r;
+      n = r / es;
+      goto loop;
+    }
+}
Index: libiberty/Makefile.in
===================================================================
--- libiberty/Makefile.in	(revision 213873)
+++ libiberty/Makefile.in	(working copy)
@@ -143,7 +143,7 @@  CFILES = alloca.c argv.c asprintf.c atexit.c				\
 	partition.c pexecute.c						\
 	 pex-common.c pex-djgpp.c pex-msdos.c pex-one.c			\
 	 pex-unix.c pex-win32.c						\
-         physmem.c putenv.c						\
+         physmem.c putenv.c qsort.c					\
 	random.c regex.c rename.c rindex.c				\
 	safe-ctype.c setenv.c setproctitle.c sha1.c sigsetmask.c        \
 	 simple-object.c simple-object-coff.c simple-object-elf.c	\
@@ -180,7 +180,7 @@  REQUIRED_OFILES =							\
 	./obstack.$(objext)						\
 	./partition.$(objext) ./pexecute.$(objext) ./physmem.$(objext)	\
 	./pex-common.$(objext) ./pex-one.$(objext)			\
-	./@pexecute@.$(objext)						\
+	./@pexecute@.$(objext) ./qsort.$(objext)				\
 	./safe-ctype.$(objext)						\
 	./simple-object.$(objext) ./simple-object-coff.$(objext)	\
 	./simple-object-elf.$(objext) ./simple-object-mach-o.$(objext)	\
@@ -1139,6 +1139,15 @@  $(CONFIGURED_OFILES): stamp-picdir stamp-noasandir
 	else true; fi
 	$(COMPILE.c) $(srcdir)/putenv.c $(OUTPUT_OPTION)
 
+./qsort.$(objext): $(srcdir)/qsort.c $(INCDIR)/ansidecl.h
+	if [ x"$(PICFLAG)" != x ]; then \
+	  $(COMPILE.c) $(PICFLAG) $(srcdir)/qsort.c -o pic/$@; \
+	else true; fi
+	if [ x"$(NOASANFLAG)" != x ]; then \
+ 	  $(COMPILE.c) $(PICFLAG) $(NOASANFLAG) $(srcdir)/qsort.c -o noasan/$@; \
+	else true; fi
+	  $(COMPILE.c) $(srcdir)/qsort.c $(OUTPUT_OPTION)
+
 ./random.$(objext): $(srcdir)/random.c $(INCDIR)/ansidecl.h
 	if [ x"$(PICFLAG)" != x ]; then \
 	  $(COMPILE.c) $(PICFLAG) $(srcdir)/random.c -o pic/$@; \