/src/libxml2/timsort.h

Source (jump to first uncovered line)
/*
 * Taken from https://github.com/swenson/sort
 * Revision: 05fd77bfec049ce8b7c408c4d3dd2d51ee061a15
 * Removed all code unrelated to Timsort and made minor adjustments for
 * cross-platform compatibility.
 */

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2010-2017 Christopher Swenson.
 * Copyright (c) 2012 Vojtech Fried.
 * Copyright (c) 2012 Google Inc. All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#ifdef HAVE_STDINT_H
#include <stdint.h>
#elif defined(_WIN32)
typedef unsigned __int64 uint64_t;
#endif

#ifndef SORT_NAME
#error "Must declare SORT_NAME"
#endif

#ifndef SORT_TYPE
#error "Must declare SORT_TYPE"
#endif

#ifndef SORT_CMP
#define SORT_CMP(x, y)  ((x) < (y) ? -1 : ((x) == (y) ? 0 : 1))
#endif

#ifndef TIM_SORT_STACK_SIZE
#define TIM_SORT_STACK_SIZE 128
#endif

#define SORT_SWAP(x,y) {SORT_TYPE __SORT_SWAP_t = (x); (x) = (y); (y) = __SORT_SWAP_t;}


/* Common, type-agnostic functions and constants that we don't want to declare twice. */
#ifndef SORT_COMMON_H
#define SORT_COMMON_H

#ifndef MAX
#define MAX(x,y) (((x) > (y) ? (x) : (y)))
#endif

#ifndef MIN
#define MIN(x,y) (((x) < (y) ? (x) : (y)))
#endif

static int compute_minrun(const uint64_t);

#ifndef CLZ
#if defined(__GNUC__) && ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || (__GNUC__ > 3))
#define CLZ __builtin_clzll
#else

static int clzll(uint64_t);

/* adapted from Hacker's Delight */
static int clzll(uint64_t x) {
  int n;

  if (x == 0) {
    return 64;
  }

  n = 0;

  if (x <= 0x00000000FFFFFFFFL) {
    n = n + 32;
    x = x << 32;
  }

  if (x <= 0x0000FFFFFFFFFFFFL) {
    n = n + 16;
    x = x << 16;
  }

  if (x <= 0x00FFFFFFFFFFFFFFL) {
    n = n + 8;
    x = x << 8;
  }

  if (x <= 0x0FFFFFFFFFFFFFFFL) {
    n = n + 4;
    x = x << 4;
  }

  if (x <= 0x3FFFFFFFFFFFFFFFL) {
    n = n + 2;
    x = x << 2;
  }

  if (x <= 0x7FFFFFFFFFFFFFFFL) {
    n = n + 1;
  }

  return n;
}

#define CLZ clzll
#endif
#endif

static __inline int compute_minrun(const uint64_t size) {
  const int top_bit = 64 - CLZ(size);
  const int shift = MAX(top_bit, 6) - 6;
  const int minrun = size >> shift;
  const uint64_t mask = (1ULL << shift) - 1;

  if (mask & size) {
    return minrun + 1;
  }

  return minrun;
}

#endif /* SORT_COMMON_H */

#define SORT_CONCAT(x, y) x ## _ ## y
#define SORT_MAKE_STR1(x, y) SORT_CONCAT(x,y)
#define SORT_MAKE_STR(x) SORT_MAKE_STR1(SORT_NAME,x)

#define BINARY_INSERTION_FIND          SORT_MAKE_STR(binary_insertion_find)
#define BINARY_INSERTION_SORT_START    SORT_MAKE_STR(binary_insertion_sort_start)
#define BINARY_INSERTION_SORT          SORT_MAKE_STR(binary_insertion_sort)
#define REVERSE_ELEMENTS               SORT_MAKE_STR(reverse_elements)
#define COUNT_RUN                      SORT_MAKE_STR(count_run)
#define CHECK_INVARIANT                SORT_MAKE_STR(check_invariant)
#define TIM_SORT                       SORT_MAKE_STR(tim_sort)
#define TIM_SORT_RESIZE                SORT_MAKE_STR(tim_sort_resize)
#define TIM_SORT_MERGE                 SORT_MAKE_STR(tim_sort_merge)
#define TIM_SORT_COLLAPSE              SORT_MAKE_STR(tim_sort_collapse)

#ifndef MAX
#define MAX(x,y) (((x) > (y) ? (x) : (y)))
#endif
#ifndef MIN
#define MIN(x,y) (((x) < (y) ? (x) : (y)))
#endif

typedef struct {
  size_t start;
  size_t length;
} TIM_SORT_RUN_T;


void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size);
void TIM_SORT(SORT_TYPE *dst, const size_t size);


/* Function used to do a binary search for binary insertion sort */
static __inline size_t BINARY_INSERTION_FIND(SORT_TYPE *dst, const SORT_TYPE x,
    const size_t size) {
  size_t l, c, r;
  SORT_TYPE cx;
  l = 0;
  r = size - 1;
  c = r >> 1;

  /* check for out of bounds at the beginning. */
  if (SORT_CMP(x, dst[0]) < 0) {
    return 0;
  } else if (SORT_CMP(x, dst[r]) > 0) {
    return r;
  }

  cx = dst[c];

  while (1) {
    const int val = SORT_CMP(x, cx);

    if (val < 0) {
      if (c - l <= 1) {
        return c;
      }

      r = c;
    } else { /* allow = for stability. The binary search favors the right. */
      if (r - c <= 1) {
        return c + 1;
      }

      l = c;
    }

    c = l + ((r - l) >> 1);
    cx = dst[c];
  }
}

/* Binary insertion sort, but knowing that the first "start" entries are sorted.  Used in timsort. */
static void BINARY_INSERTION_SORT_START(SORT_TYPE *dst, const size_t start, const size_t size) {
  size_t i;

  for (i = start; i < size; i++) {
    size_t j;
    SORT_TYPE x;
    size_t location;

    /* If this entry is already correct, just move along */
    if (SORT_CMP(dst[i - 1], dst[i]) <= 0) {
      continue;
    }

    /* Else we need to find the right place, shift everything over, and squeeze in */
    x = dst[i];
    location = BINARY_INSERTION_FIND(dst, x, i);

    for (j = i - 1; j >= location; j--) {
      dst[j + 1] = dst[j];

      if (j == 0) { /* check edge case because j is unsigned */
        break;
      }
    }

    dst[location] = x;
  }
}

/* Binary insertion sort */
void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size) {
  /* don't bother sorting an array of size <= 1 */
  if (size <= 1) {
    return;
  }

  BINARY_INSERTION_SORT_START(dst, 1, size);
}

/* timsort implementation, based on timsort.txt */

static __inline void REVERSE_ELEMENTS(SORT_TYPE *dst, size_t start, size_t end) {
  while (1) {
    if (start >= end) {
      return;
    }

    SORT_SWAP(dst[start], dst[end]);
    start++;
    end--;
  }
}

static size_t COUNT_RUN(SORT_TYPE *dst, const size_t start, const size_t size) {
  size_t curr;

  if (size - start == 1) {
    return 1;
  }

  if (start >= size - 2) {
    if (SORT_CMP(dst[size - 2], dst[size - 1]) > 0) {
      SORT_SWAP(dst[size - 2], dst[size - 1]);
    }

    return 2;
  }

  curr = start + 2;

  if (SORT_CMP(dst[start], dst[start + 1]) <= 0) {
    /* increasing run */
    while (1) {
      if (curr == size - 1) {
        break;
      }

      if (SORT_CMP(dst[curr - 1], dst[curr]) > 0) {
        break;
      }

      curr++;
    }

    return curr - start;
  } else {
    /* decreasing run */
    while (1) {
      if (curr == size - 1) {
        break;
      }

      if (SORT_CMP(dst[curr - 1], dst[curr]) <= 0) {
        break;
      }

      curr++;
    }

    /* reverse in-place */
    REVERSE_ELEMENTS(dst, start, curr - 1);
    return curr - start;
  }
}

static int CHECK_INVARIANT(TIM_SORT_RUN_T *stack, const int stack_curr) {
  size_t A, B, C;

  if (stack_curr < 2) {
    return 1;
  }

  if (stack_curr == 2) {
    const size_t A1 = stack[stack_curr - 2].length;
    const size_t B1 = stack[stack_curr - 1].length;

    if (A1 <= B1) {
      return 0;
    }

    return 1;
  }

  A = stack[stack_curr - 3].length;
  B = stack[stack_curr - 2].length;
  C = stack[stack_curr - 1].length;

  if ((A <= B + C) || (B <= C)) {
    return 0;
  }

  return 1;
}

typedef struct {
  size_t alloc;
  SORT_TYPE *storage;
} TEMP_STORAGE_T;

static void TIM_SORT_RESIZE(TEMP_STORAGE_T *store, const size_t new_size) {
  if (store->alloc < new_size) {
    SORT_TYPE *tempstore = (SORT_TYPE *)realloc(store->storage, new_size * sizeof(SORT_TYPE));

    if (tempstore == NULL) {
      fprintf(stderr, "Error allocating temporary storage for tim sort: need %lu bytes",
              (unsigned long)(sizeof(SORT_TYPE) * new_size));
      exit(1);
    }

    store->storage = tempstore;
    store->alloc = new_size;
  }
}

static void TIM_SORT_MERGE(SORT_TYPE *dst, const TIM_SORT_RUN_T *stack, const int stack_curr,
                           TEMP_STORAGE_T *store) {
  const size_t A = stack[stack_curr - 2].length;
  const size_t B = stack[stack_curr - 1].length;
  const size_t curr = stack[stack_curr - 2].start;
  SORT_TYPE *storage;
  size_t i, j, k;
  TIM_SORT_RESIZE(store, MIN(A, B));
  storage = store->storage;

  /* left merge */
  if (A < B) {
    memcpy(storage, &dst[curr], A * sizeof(SORT_TYPE));
    i = 0;
    j = curr + A;

    for (k = curr; k < curr + A + B; k++) {
      if ((i < A) && (j < curr + A + B)) {
        if (SORT_CMP(storage[i], dst[j]) <= 0) {
          dst[k] = storage[i++];
        } else {
          dst[k] = dst[j++];
        }
      } else if (i < A) {
        dst[k] = storage[i++];
      } else {
        break;
      }
    }
  } else {
    /* right merge */
    memcpy(storage, &dst[curr + A], B * sizeof(SORT_TYPE));
    i = B;
    j = curr + A;
    k = curr + A + B;

    while (k > curr) {
      k--;
      if ((i > 0) && (j > curr)) {
        if (SORT_CMP(dst[j - 1], storage[i - 1]) > 0) {
          dst[k] = dst[--j];
        } else {
          dst[k] = storage[--i];
        }
      } else if (i > 0) {
        dst[k] = storage[--i];
      } else {
        break;
      }
    }
  }
}

static int TIM_SORT_COLLAPSE(SORT_TYPE *dst, TIM_SORT_RUN_T *stack, int stack_curr,
                             TEMP_STORAGE_T *store, const size_t size) {
  while (1) {
    size_t A, B, C, D;
    int ABC, BCD, CD;

    /* if the stack only has one thing on it, we are done with the collapse */
    if (stack_curr <= 1) {
      break;
    }

    /* if this is the last merge, just do it */
    if ((stack_curr == 2) && (stack[0].length + stack[1].length == size)) {
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
      stack[0].length += stack[1].length;
      stack_curr--;
      break;
    }
    /* check if the invariant is off for a stack of 2 elements */
    else if ((stack_curr == 2) && (stack[0].length <= stack[1].length)) {
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
      stack[0].length += stack[1].length;
      stack_curr--;
      break;
    } else if (stack_curr == 2) {
      break;
    }

    B = stack[stack_curr - 3].length;
    C = stack[stack_curr - 2].length;
    D = stack[stack_curr - 1].length;

    if (stack_curr >= 4) {
      A = stack[stack_curr - 4].length;
      ABC = (A <= B + C);
    } else {
      ABC = 0;
    }

    BCD = (B <= C + D) || ABC;
    CD = (C <= D);

    /* Both invariants are good */
    if (!BCD && !CD) {
      break;
    }

    /* left merge */
    if (BCD && !CD) {
      TIM_SORT_MERGE(dst, stack, stack_curr - 1, store);
      stack[stack_curr - 3].length += stack[stack_curr - 2].length;
      stack[stack_curr - 2] = stack[stack_curr - 1];
      stack_curr--;
    } else {
      /* right merge */
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
      stack[stack_curr - 2].length += stack[stack_curr - 1].length;
      stack_curr--;
    }
  }

  return stack_curr;
}

static __inline int PUSH_NEXT(SORT_TYPE *dst,
                              const size_t size,
                              TEMP_STORAGE_T *store,
                              const size_t minrun,
                              TIM_SORT_RUN_T *run_stack,
                              size_t *stack_curr,
                              size_t *curr) {
  size_t len = COUNT_RUN(dst, *curr, size);
  size_t run = minrun;

  if (run > size - *curr) {
    run = size - *curr;
  }

  if (run > len) {
    BINARY_INSERTION_SORT_START(&dst[*curr], len, run);
    len = run;
  }

  run_stack[*stack_curr].start = *curr;
  run_stack[*stack_curr].length = len;
  (*stack_curr)++;
  *curr += len;

  if (*curr == size) {
    /* finish up */
    while (*stack_curr > 1) {
      TIM_SORT_MERGE(dst, run_stack, *stack_curr, store);
      run_stack[*stack_curr - 2].length += run_stack[*stack_curr - 1].length;
      (*stack_curr)--;
    }

    if (store->storage != NULL) {
      free(store->storage);
      store->storage = NULL;
    }

    return 0;
  }

  return 1;
}

void TIM_SORT(SORT_TYPE *dst, const size_t size) {
  size_t minrun;
  TEMP_STORAGE_T _store, *store;
  TIM_SORT_RUN_T run_stack[TIM_SORT_STACK_SIZE];
  size_t stack_curr = 0;
  size_t curr = 0;

  /* don't bother sorting an array of size 1 */
  if (size <= 1) {
    return;
  }

  if (size < 64) {
    BINARY_INSERTION_SORT(dst, size);
    return;
  }

  /* compute the minimum run length */
  minrun = compute_minrun(size);
  /* temporary storage for merges */
  store = &_store;
  store->alloc = 0;
  store->storage = NULL;

  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
    return;
  }

  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
    return;
  }

  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
    return;
  }

  while (1) {
    if (!CHECK_INVARIANT(run_stack, stack_curr)) {
      stack_curr = TIM_SORT_COLLAPSE(dst, run_stack, stack_curr, store, size);
      continue;
    }

    if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
      return;
    }
  }
}

#undef SORT_CONCAT
#undef SORT_MAKE_STR1
#undef SORT_MAKE_STR
#undef SORT_NAME
#undef SORT_TYPE
#undef SORT_CMP
#undef TEMP_STORAGE_T
#undef TIM_SORT_RUN_T
#undef PUSH_NEXT
#undef SORT_SWAP
#undef SORT_CONCAT
#undef SORT_MAKE_STR1
#undef SORT_MAKE_STR
#undef BINARY_INSERTION_FIND
#undef BINARY_INSERTION_SORT_START
#undef BINARY_INSERTION_SORT
#undef REVERSE_ELEMENTS
#undef COUNT_RUN
#undef TIM_SORT
#undef TIM_SORT_RESIZE
#undef TIM_SORT_COLLAPSE
#undef TIM_SORT_RUN_T
#undef TEMP_STORAGE_T

Coverage Report

Created: 2023-06-07 06:14

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Taken from https://github.com/swenson/sort
3		* Revision: 05fd77bfec049ce8b7c408c4d3dd2d51ee061a15
4		* Removed all code unrelated to Timsort and made minor adjustments for
5		* cross-platform compatibility.
6		*/
7
8		/*
9		* The MIT License (MIT)
10		*
11		* Copyright (c) 2010-2017 Christopher Swenson.
12		* Copyright (c) 2012 Vojtech Fried.
13		* Copyright (c) 2012 Google Inc. All Rights Reserved.
14		*
15		* Permission is hereby granted, free of charge, to any person obtaining a
16		* copy of this software and associated documentation files (the "Software"),
17		* to deal in the Software without restriction, including without limitation
18		* the rights to use, copy, modify, merge, publish, distribute, sublicense,
19		* and/or sell copies of the Software, and to permit persons to whom the
20		* Software is furnished to do so, subject to the following conditions:
21		*
22		* The above copyright notice and this permission notice shall be included in
23		* all copies or substantial portions of the Software.
24		*
25		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
31		* DEALINGS IN THE SOFTWARE.
32		*/
33
34		#include <stdlib.h>
35		#include <stdio.h>
36		#include <string.h>
37		#ifdef HAVE_STDINT_H
38		#include <stdint.h>
39		#elif defined(_WIN32)
40		typedef unsigned __int64 uint64_t;
41		#endif
42
43		#ifndef SORT_NAME
44		#error "Must declare SORT_NAME"
45		#endif
46
47		#ifndef SORT_TYPE
48		#error "Must declare SORT_TYPE"
49		#endif
50
51		#ifndef SORT_CMP
52		#define SORT_CMP(x, y) ((x) < (y) ? -1 : ((x) == (y) ? 0 : 1))
53		#endif
54
55		#ifndef TIM_SORT_STACK_SIZE
56		#define TIM_SORT_STACK_SIZE 128
57		#endif
58
59	793k	#define SORT_SWAP(x,y) {SORT_TYPE __SORT_SWAP_t = (x); (x) = (y); (y) = __SORT_SWAP_t;}
60
61
62		/* Common, type-agnostic functions and constants that we don't want to declare twice. */
63		#ifndef SORT_COMMON_H
64		#define SORT_COMMON_H
65
66		#ifndef MAX
67	1.93k	#define MAX(x,y) (((x) > (y) ? (x) : (y)))
68		#endif
69
70		#ifndef MIN
71	14.8k	#define MIN(x,y) (((x) < (y) ? (x) : (y)))
72		#endif
73
74		static int compute_minrun(const uint64_t);
75
76		#ifndef CLZ
77		#if defined(__GNUC__) && ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) \|\| (__GNUC__ > 3))
78	1.93k	#define CLZ __builtin_clzll
79		#else
80
81		static int clzll(uint64_t);
82
83		/* adapted from Hacker's Delight */
84		static int clzll(uint64_t x) {
85		int n;
86
87		if (x == 0) {
88		return 64;
89		}
90
91		n = 0;
92
93		if (x <= 0x00000000FFFFFFFFL) {
94		n = n + 32;
95		x = x << 32;
96		}
97
98		if (x <= 0x0000FFFFFFFFFFFFL) {
99		n = n + 16;
100		x = x << 16;
101		}
102
103		if (x <= 0x00FFFFFFFFFFFFFFL) {
104		n = n + 8;
105		x = x << 8;
106		}
107
108		if (x <= 0x0FFFFFFFFFFFFFFFL) {
109		n = n + 4;
110		x = x << 4;
111		}
112
113		if (x <= 0x3FFFFFFFFFFFFFFFL) {
114		n = n + 2;
115		x = x << 2;
116		}
117
118		if (x <= 0x7FFFFFFFFFFFFFFFL) {
119		n = n + 1;
120		}
121
122		return n;
123		}
124
125		#define CLZ clzll
126		#endif
127		#endif
128
129	1.93k	static __inline int compute_minrun(const uint64_t size) {
130	1.93k	const int top_bit = 64 - CLZ(size);
131	1.93k	const int shift = MAX(top_bit, 6) - 6;
132	1.93k	const int minrun = size >> shift;
133	1.93k	const uint64_t mask = (1ULL << shift) - 1;
134
135	1.93k	if (mask & size) {
136	1.57k	return minrun + 1;
137	1.57k	}
138
139	355	return minrun;
140	1.93k	}
141
142		#endif /* SORT_COMMON_H */
143
144	422k	#define SORT_CONCAT(x, y) x ## _ ## y
145	422k	#define SORT_MAKE_STR1(x, y) SORT_CONCAT(x,y)
146	422k	#define SORT_MAKE_STR(x) SORT_MAKE_STR1(SORT_NAME,x)
147
148	318k	#define BINARY_INSERTION_FIND SORT_MAKE_STR(binary_insertion_find)
149	18.0k	#define BINARY_INSERTION_SORT_START SORT_MAKE_STR(binary_insertion_sort_start)
150	3.99k	#define BINARY_INSERTION_SORT SORT_MAKE_STR(binary_insertion_sort)
151	7.35k	#define REVERSE_ELEMENTS SORT_MAKE_STR(reverse_elements)
152	16.7k	#define COUNT_RUN SORT_MAKE_STR(count_run)
153	19.9k	#define CHECK_INVARIANT SORT_MAKE_STR(check_invariant)
154		#define TIM_SORT SORT_MAKE_STR(tim_sort)
155	14.8k	#define TIM_SORT_RESIZE SORT_MAKE_STR(tim_sort_resize)
156	14.8k	#define TIM_SORT_MERGE SORT_MAKE_STR(tim_sort_merge)
157	8.27k	#define TIM_SORT_COLLAPSE SORT_MAKE_STR(tim_sort_collapse)
158
159		#ifndef MAX
160		#define MAX(x,y) (((x) > (y) ? (x) : (y)))
161		#endif
162		#ifndef MIN
163		#define MIN(x,y) (((x) < (y) ? (x) : (y)))
164		#endif
165
166		typedef struct {
167		size_t start;
168		size_t length;
169		} TIM_SORT_RUN_T;
170
171
172		void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size);
173		void TIM_SORT(SORT_TYPE *dst, const size_t size);
174
175
176		/* Function used to do a binary search for binary insertion sort */
177		static __inline size_t BINARY_INSERTION_FIND(SORT_TYPE *dst, const SORT_TYPE x,
178	318k	const size_t size) {
179	318k	size_t l, c, r;
180	318k	SORT_TYPE cx;
181	318k	l = 0;
182	318k	r = size - 1;
183	318k	c = r >> 1;
184
185		/* check for out of bounds at the beginning. */
186	318k	if (SORT_CMP(x, dst[0]) < 0) {
187	315k	return 0;
188	315k	} else if (SORT_CMP(x, dst[r]) > 0) {
189	0	return r;
190	0	}
191
192	3.23k	cx = dst[c];
193
194	12.2k	while (1) {
195	12.2k	const int val = SORT_CMP(x, cx);
196
197	12.2k	if (val < 0) {
198	5.92k	if (c - l <= 1) {
199	2.13k	return c;
200	2.13k	}
201
202	3.78k	r = c;
203	6.27k	} else { /* allow = for stability. The binary search favors the right. */
204	6.27k	if (r - c <= 1) {
205	1.09k	return c + 1;
206	1.09k	}
207
208	5.18k	l = c;
209	5.18k	}
210
211	8.97k	c = l + ((r - l) >> 1);
212	8.97k	cx = dst[c];
213	8.97k	}
214	3.23k	}
215
216		/* Binary insertion sort, but knowing that the first "start" entries are sorted. Used in timsort. */
217	18.0k	static void BINARY_INSERTION_SORT_START(SORT_TYPE *dst, const size_t start, const size_t size) {
218	18.0k	size_t i;
219
220	596k	for (i = start; i < size; i++) {
221	578k	size_t j;
222	578k	SORT_TYPE x;
223	578k	size_t location;
224
225		/* If this entry is already correct, just move along */
226	578k	if (SORT_CMP(dst[i - 1], dst[i]) <= 0) {
227	260k	continue;
228	260k	}
229
230		/* Else we need to find the right place, shift everything over, and squeeze in */
231	318k	x = dst[i];
232	318k	location = BINARY_INSERTION_FIND(dst, x, i);
233
234	7.14M	for (j = i - 1; j >= location; j--) {
235	7.14M	dst[j + 1] = dst[j];
236
237	7.14M	if (j == 0) { /* check edge case because j is unsigned */
238	315k	break;
239	315k	}
240	7.14M	}
241
242	318k	dst[location] = x;
243	318k	}
244	18.0k	}
245
246		/* Binary insertion sort */
247	3.99k	void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size) {
248		/* don't bother sorting an array of size <= 1 */
249	3.99k	if (size <= 1) {
250	0	return;
251	0	}
252
253	3.99k	BINARY_INSERTION_SORT_START(dst, 1, size);
254	3.99k	}
255
256		/* timsort implementation, based on timsort.txt */
257
258	7.35k	static __inline void REVERSE_ELEMENTS(SORT_TYPE *dst, size_t start, size_t end) {
259	801k	while (1) {
260	801k	if (start >= end) {
261	7.35k	return;
262	7.35k	}
263
264	793k	SORT_SWAP(dst[start], dst[end]);
265	793k	start++;
266	793k	end--;
267	793k	}
268	7.35k	}
269
270	16.7k	static size_t COUNT_RUN(SORT_TYPE *dst, const size_t start, const size_t size) {
271	16.7k	size_t curr;
272
273	16.7k	if (size - start == 1) {
274	683	return 1;
275	683	}
276
277	16.0k	if (start >= size - 2) {
278	0	if (SORT_CMP(dst[size - 2], dst[size - 1]) > 0) {
279	0	SORT_SWAP(dst[size - 2], dst[size - 1]);
280	0	}
281
282	0	return 2;
283	0	}
284
285	16.0k	curr = start + 2;
286
287	16.0k	if (SORT_CMP(dst[start], dst[start + 1]) <= 0) {
288		/* increasing run */
289	5.10M	while (1) {
290	5.10M	if (curr == size - 1) {
291	781	break;
292	781	}
293
294	5.10M	if (SORT_CMP(dst[curr - 1], dst[curr]) > 0) {
295	7.93k	break;
296	7.93k	}
297
298	5.10M	curr++;
299	5.10M	}
300
301	8.71k	return curr - start;
302	8.71k	} else {
303		/* decreasing run */
304	1.58M	while (1) {
305	1.58M	if (curr == size - 1) {
306	6	break;
307	6	}
308
309	1.58M	if (SORT_CMP(dst[curr - 1], dst[curr]) <= 0) {
310	7.35k	break;
311	7.35k	}
312
313	1.57M	curr++;
314	1.57M	}
315
316		/* reverse in-place */
317	7.35k	REVERSE_ELEMENTS(dst, start, curr - 1);
318	7.35k	return curr - start;
319	7.35k	}
320	16.0k	}
321
322	19.9k	static int CHECK_INVARIANT(TIM_SORT_RUN_T *stack, const int stack_curr) {
323	19.9k	size_t A, B, C;
324
325	19.9k	if (stack_curr < 2) {
326	1.18k	return 1;
327	1.18k	}
328
329	18.7k	if (stack_curr == 2) {
330	6.48k	const size_t A1 = stack[stack_curr - 2].length;
331	6.48k	const size_t B1 = stack[stack_curr - 1].length;
332
333	6.48k	if (A1 <= B1) {
334	0	return 0;
335	0	}
336
337	6.48k	return 1;
338	6.48k	}
339
340	12.2k	A = stack[stack_curr - 3].length;
341	12.2k	B = stack[stack_curr - 2].length;
342	12.2k	C = stack[stack_curr - 1].length;
343
344	12.2k	if ((A <= B + C) \|\| (B <= C)) {
345	8.27k	return 0;
346	8.27k	}
347
348	3.98k	return 1;
349	12.2k	}
350
351		typedef struct {
352		size_t alloc;
353		SORT_TYPE *storage;
354		} TEMP_STORAGE_T;
355
356	14.8k	static void TIM_SORT_RESIZE(TEMP_STORAGE_T *store, const size_t new_size) {
357	14.8k	if (store->alloc < new_size) {
358	4.81k	SORT_TYPE tempstore = (SORT_TYPE )realloc(store->storage, new_size * sizeof(SORT_TYPE));
359
360	4.81k	if (tempstore == NULL) {
361	0	fprintf(stderr, "Error allocating temporary storage for tim sort: need %lu bytes",
362	0	(unsigned long)(sizeof(SORT_TYPE) * new_size));
363	0	exit(1);
364	0	}
365
366	4.81k	store->storage = tempstore;
367	4.81k	store->alloc = new_size;
368	4.81k	}
369	14.8k	}
370
371		static void TIM_SORT_MERGE(SORT_TYPE dst, const TIM_SORT_RUN_T stack, const int stack_curr,
372	14.8k	TEMP_STORAGE_T *store) {
373	14.8k	const size_t A = stack[stack_curr - 2].length;
374	14.8k	const size_t B = stack[stack_curr - 1].length;
375	14.8k	const size_t curr = stack[stack_curr - 2].start;
376	14.8k	SORT_TYPE *storage;
377	14.8k	size_t i, j, k;
378	14.8k	TIM_SORT_RESIZE(store, MIN(A, B));
379	14.8k	storage = store->storage;
380
381		/* left merge */
382	14.8k	if (A < B) {
383	2.18k	memcpy(storage, &dst[curr], A * sizeof(SORT_TYPE));
384	2.18k	i = 0;
385	2.18k	j = curr + A;
386
387	2.32M	for (k = curr; k < curr + A + B; k++) {
388	2.32M	if ((i < A) && (j < curr + A + B)) {
389	2.32M	if (SORT_CMP(storage[i], dst[j]) <= 0) {
390	749k	dst[k] = storage[i++];
391	1.57M	} else {
392	1.57M	dst[k] = dst[j++];
393	1.57M	}
394	2.32M	} else if (i < A) {
395	204	dst[k] = storage[i++];
396	2.17k	} else {
397	2.17k	break;
398	2.17k	}
399	2.32M	}
400	12.6k	} else {
401		/* right merge */
402	12.6k	memcpy(storage, &dst[curr + A], B * sizeof(SORT_TYPE));
403	12.6k	i = B;
404	12.6k	j = curr + A;
405	12.6k	k = curr + A + B;
406
407	2.45M	while (k > curr) {
408	2.45M	k--;
409	2.45M	if ((i > 0) && (j > curr)) {
410	2.44M	if (SORT_CMP(dst[j - 1], storage[i - 1]) > 0) {
411	9.75k	dst[k] = dst[--j];
412	2.43M	} else {
413	2.43M	dst[k] = storage[--i];
414	2.43M	}
415	2.44M	} else if (i > 0) {
416	0	dst[k] = storage[--i];
417	12.6k	} else {
418	12.6k	break;
419	12.6k	}
420	2.45M	}
421	12.6k	}
422	14.8k	}
423
424		static int TIM_SORT_COLLAPSE(SORT_TYPE dst, TIM_SORT_RUN_T stack, int stack_curr,
425	8.27k	TEMP_STORAGE_T *store, const size_t size) {
426	18.1k	while (1) {
427	18.1k	size_t A, B, C, D;
428	18.1k	int ABC, BCD, CD;
429
430		/* if the stack only has one thing on it, we are done with the collapse */
431	18.1k	if (stack_curr <= 1) {
432	0	break;
433	0	}
434
435		/* if this is the last merge, just do it */
436	18.1k	if ((stack_curr == 2) && (stack[0].length + stack[1].length == size)) {
437	0	TIM_SORT_MERGE(dst, stack, stack_curr, store);
438	0	stack[0].length += stack[1].length;
439	0	stack_curr--;
440	0	break;
441	0	}
442		/* check if the invariant is off for a stack of 2 elements */
443	18.1k	else if ((stack_curr == 2) && (stack[0].length <= stack[1].length)) {
444	1.18k	TIM_SORT_MERGE(dst, stack, stack_curr, store);
445	1.18k	stack[0].length += stack[1].length;
446	1.18k	stack_curr--;
447	1.18k	break;
448	17.0k	} else if (stack_curr == 2) {
449	5.48k	break;
450	5.48k	}
451
452	11.5k	B = stack[stack_curr - 3].length;
453	11.5k	C = stack[stack_curr - 2].length;
454	11.5k	D = stack[stack_curr - 1].length;
455
456	11.5k	if (stack_curr >= 4) {
457	3.69k	A = stack[stack_curr - 4].length;
458	3.69k	ABC = (A <= B + C);
459	7.83k	} else {
460	7.83k	ABC = 0;
461	7.83k	}
462
463	11.5k	BCD = (B <= C + D) \|\| ABC;
464	11.5k	CD = (C <= D);
465
466		/* Both invariants are good */
467	11.5k	if (!BCD && !CD) {
468	1.60k	break;
469	1.60k	}
470
471		/* left merge */
472	9.91k	if (BCD && !CD) {
473	2.38k	TIM_SORT_MERGE(dst, stack, stack_curr - 1, store);
474	2.38k	stack[stack_curr - 3].length += stack[stack_curr - 2].length;
475	2.38k	stack[stack_curr - 2] = stack[stack_curr - 1];
476	2.38k	stack_curr--;
477	7.53k	} else {
478		/* right merge */
479	7.53k	TIM_SORT_MERGE(dst, stack, stack_curr, store);
480	7.53k	stack[stack_curr - 2].length += stack[stack_curr - 1].length;
481	7.53k	stack_curr--;
482	7.53k	}
483	9.91k	}
484
485	8.27k	return stack_curr;
486	8.27k	}
487
488		static __inline int PUSH_NEXT(SORT_TYPE *dst,
489		const size_t size,
490		TEMP_STORAGE_T *store,
491		const size_t minrun,
492		TIM_SORT_RUN_T *run_stack,
493		size_t *stack_curr,
494	16.7k	size_t *curr) {
495	16.7k	size_t len = COUNT_RUN(dst, *curr, size);
496	16.7k	size_t run = minrun;
497
498	16.7k	if (run > size - *curr) {
499	1.75k	run = size - *curr;
500	1.75k	}
501
502	16.7k	if (run > len) {
503	14.0k	BINARY_INSERTION_SORT_START(&dst[*curr], len, run);
504	14.0k	len = run;
505	14.0k	}
506
507	16.7k	run_stack[stack_curr].start = curr;
508	16.7k	run_stack[*stack_curr].length = len;
509	16.7k	(*stack_curr)++;
510	16.7k	*curr += len;
511
512	16.7k	if (*curr == size) {
513		/* finish up */
514	5.65k	while (*stack_curr > 1) {
515	3.72k	TIM_SORT_MERGE(dst, run_stack, *stack_curr, store);
516	3.72k	run_stack[stack_curr - 2].length += run_stack[stack_curr - 1].length;
517	3.72k	(*stack_curr)--;
518	3.72k	}
519
520	1.93k	if (store->storage != NULL) {
521	1.93k	free(store->storage);
522	1.93k	store->storage = NULL;
523	1.93k	}
524
525	1.93k	return 0;
526	1.93k	}
527
528	14.8k	return 1;
529	16.7k	}
530
531	6.34k	void TIM_SORT(SORT_TYPE *dst, const size_t size) {
532	6.34k	size_t minrun;
533	6.34k	TEMP_STORAGE_T _store, *store;
534	6.34k	TIM_SORT_RUN_T run_stack[TIM_SORT_STACK_SIZE];
535	6.34k	size_t stack_curr = 0;
536	6.34k	size_t curr = 0;
537
538		/* don't bother sorting an array of size 1 */
539	6.34k	if (size <= 1) {
540	415	return;
541	415	}
542
543	5.92k	if (size < 64) {
544	3.99k	BINARY_INSERTION_SORT(dst, size);
545	3.99k	return;
546	3.99k	}
547
548		/* compute the minimum run length */
549	1.93k	minrun = compute_minrun(size);
550		/* temporary storage for merges */
551	1.93k	store = &_store;
552	1.93k	store->alloc = 0;
553	1.93k	store->storage = NULL;
554
555	1.93k	if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
556	0	return;
557	0	}
558
559	1.93k	if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
560	695	return;
561	695	}
562
563	1.23k	if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
564	12	return;
565	12	}
566
567	19.9k	while (1) {
568	19.9k	if (!CHECK_INVARIANT(run_stack, stack_curr)) {
569	8.27k	stack_curr = TIM_SORT_COLLAPSE(dst, run_stack, stack_curr, store, size);
570	8.27k	continue;
571	8.27k	}
572
573	11.6k	if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
574	1.22k	return;
575	1.22k	}
576	11.6k	}
577	1.22k	}
578
579		#undef SORT_CONCAT
580		#undef SORT_MAKE_STR1
581		#undef SORT_MAKE_STR
582		#undef SORT_NAME
583		#undef SORT_TYPE
584		#undef SORT_CMP
585		#undef TEMP_STORAGE_T
586		#undef TIM_SORT_RUN_T
587		#undef PUSH_NEXT
588		#undef SORT_SWAP
589		#undef SORT_CONCAT
590		#undef SORT_MAKE_STR1
591		#undef SORT_MAKE_STR
592		#undef BINARY_INSERTION_FIND
593		#undef BINARY_INSERTION_SORT_START
594		#undef BINARY_INSERTION_SORT
595		#undef REVERSE_ELEMENTS
596		#undef COUNT_RUN
597		#undef TIM_SORT
598		#undef TIM_SORT_RESIZE
599		#undef TIM_SORT_COLLAPSE
600		#undef TIM_SORT_RUN_T
601		#undef TEMP_STORAGE_T