Coverage Report

Created: 2026-01-19 06:48

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libxml2/timsort.h
Line
Count
Source
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
324k
#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
18.2k
#define MAX(x,y) (((x) > (y) ? (x) : (y)))
68
#endif
69
70
#ifndef MIN
71
30.2k
#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
18.2k
#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
18.2k
static __inline int compute_minrun(const uint64_t size) {
130
18.2k
  const int top_bit = 64 - CLZ(size);
131
18.2k
  const int shift = MAX(top_bit, 6) - 6;
132
18.2k
  const int minrun = size >> shift;
133
18.2k
  const uint64_t mask = (1ULL << shift) - 1;
134
135
18.2k
  if (mask & size) {
136
9.94k
    return minrun + 1;
137
9.94k
  }
138
139
8.32k
  return minrun;
140
18.2k
}
141
142
#endif /* SORT_COMMON_H */
143
144
876k
#define SORT_CONCAT(x, y) x ## _ ## y
145
876k
#define SORT_MAKE_STR1(x, y) SORT_CONCAT(x,y)
146
876k
#define SORT_MAKE_STR(x) SORT_MAKE_STR1(SORT_NAME,x)
147
148
612k
#define BINARY_INSERTION_FIND          SORT_MAKE_STR(binary_insertion_find)
149
71.5k
#define BINARY_INSERTION_SORT_START    SORT_MAKE_STR(binary_insertion_sort_start)
150
48.2k
#define BINARY_INSERTION_SORT          SORT_MAKE_STR(binary_insertion_sort)
151
16.6k
#define REVERSE_ELEMENTS               SORT_MAKE_STR(reverse_elements)
152
48.4k
#define COUNT_RUN                      SORT_MAKE_STR(count_run)
153
12.9k
#define CHECK_INVARIANT                SORT_MAKE_STR(check_invariant)
154
#define TIM_SORT                       SORT_MAKE_STR(tim_sort)
155
30.2k
#define TIM_SORT_RESIZE                SORT_MAKE_STR(tim_sort_resize)
156
30.2k
#define TIM_SORT_MERGE                 SORT_MAKE_STR(tim_sort_merge)
157
5.55k
#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
XML_HIDDEN
173
void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size);
174
XML_HIDDEN
175
void TIM_SORT(SORT_TYPE *dst, const size_t size);
176
177
178
/* Function used to do a binary search for binary insertion sort */
179
static __inline size_t BINARY_INSERTION_FIND(SORT_TYPE *dst, const SORT_TYPE x,
180
612k
    const size_t size) {
181
612k
  size_t l, c, r;
182
612k
  SORT_TYPE cx;
183
612k
  l = 0;
184
612k
  r = size - 1;
185
612k
  c = r >> 1;
186
187
  /* check for out of bounds at the beginning. */
188
612k
  if (SORT_CMP(x, dst[0]) < 0) {
189
393k
    return 0;
190
393k
  } else if (SORT_CMP(x, dst[r]) > 0) {
191
0
    return r;
192
0
  }
193
194
218k
  cx = dst[c];
195
196
970k
  while (1) {
197
970k
    const int val = SORT_CMP(x, cx);
198
199
970k
    if (val < 0) {
200
480k
      if (c - l <= 1) {
201
124k
        return c;
202
124k
      }
203
204
356k
      r = c;
205
490k
    } else { /* allow = for stability. The binary search favors the right. */
206
490k
      if (r - c <= 1) {
207
94.9k
        return c + 1;
208
94.9k
      }
209
210
395k
      l = c;
211
395k
    }
212
213
751k
    c = l + ((r - l) >> 1);
214
751k
    cx = dst[c];
215
751k
  }
216
218k
}
217
218
/* Binary insertion sort, but knowing that the first "start" entries are sorted.  Used in timsort. */
219
71.5k
static void BINARY_INSERTION_SORT_START(SORT_TYPE *dst, const size_t start, const size_t size) {
220
71.5k
  size_t i;
221
222
1.31M
  for (i = start; i < size; i++) {
223
1.24M
    size_t j;
224
1.24M
    SORT_TYPE x;
225
1.24M
    size_t location;
226
227
    /* If this entry is already correct, just move along */
228
1.24M
    if (SORT_CMP(dst[i - 1], dst[i]) <= 0) {
229
627k
      continue;
230
627k
    }
231
232
    /* Else we need to find the right place, shift everything over, and squeeze in */
233
612k
    x = dst[i];
234
612k
    location = BINARY_INSERTION_FIND(dst, x, i);
235
236
13.4M
    for (j = i - 1; j >= location; j--) {
237
13.2M
      dst[j + 1] = dst[j];
238
239
13.2M
      if (j == 0) { /* check edge case because j is unsigned */
240
393k
        break;
241
393k
      }
242
13.2M
    }
243
244
612k
    dst[location] = x;
245
612k
  }
246
71.5k
}
247
248
/* Binary insertion sort */
249
48.2k
void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size) {
250
  /* don't bother sorting an array of size <= 1 */
251
48.2k
  if (size <= 1) {
252
0
    return;
253
0
  }
254
255
48.2k
  BINARY_INSERTION_SORT_START(dst, 1, size);
256
48.2k
}
257
258
/* timsort implementation, based on timsort.txt */
259
260
16.6k
static __inline void REVERSE_ELEMENTS(SORT_TYPE *dst, size_t start, size_t end) {
261
340k
  while (1) {
262
340k
    if (start >= end) {
263
16.6k
      return;
264
16.6k
    }
265
266
324k
    SORT_SWAP(dst[start], dst[end]);
267
324k
    start++;
268
324k
    end--;
269
324k
  }
270
16.6k
}
271
272
48.4k
static size_t COUNT_RUN(SORT_TYPE *dst, const size_t start, const size_t size) {
273
48.4k
  size_t curr;
274
275
48.4k
  if (size - start == 1) {
276
5.94k
    return 1;
277
5.94k
  }
278
279
42.5k
  if (start >= size - 2) {
280
1.68k
    if (SORT_CMP(dst[size - 2], dst[size - 1]) > 0) {
281
205
      SORT_SWAP(dst[size - 2], dst[size - 1]);
282
205
    }
283
284
1.68k
    return 2;
285
1.68k
  }
286
287
40.8k
  curr = start + 2;
288
289
40.8k
  if (SORT_CMP(dst[start], dst[start + 1]) <= 0) {
290
    /* increasing run */
291
2.16M
    while (1) {
292
2.16M
      if (curr == size - 1) {
293
8.73k
        break;
294
8.73k
      }
295
296
2.15M
      if (SORT_CMP(dst[curr - 1], dst[curr]) > 0) {
297
15.4k
        break;
298
15.4k
      }
299
300
2.13M
      curr++;
301
2.13M
    }
302
303
24.1k
    return curr - start;
304
24.1k
  } else {
305
    /* decreasing run */
306
639k
    while (1) {
307
639k
      if (curr == size - 1) {
308
305
        break;
309
305
      }
310
311
638k
      if (SORT_CMP(dst[curr - 1], dst[curr]) <= 0) {
312
16.3k
        break;
313
16.3k
      }
314
315
622k
      curr++;
316
622k
    }
317
318
    /* reverse in-place */
319
16.6k
    REVERSE_ELEMENTS(dst, start, curr - 1);
320
16.6k
    return curr - start;
321
16.6k
  }
322
40.8k
}
323
324
12.9k
static int CHECK_INVARIANT(TIM_SORT_RUN_T *stack, const int stack_curr) {
325
12.9k
  size_t A, B, C;
326
327
12.9k
  if (stack_curr < 2) {
328
2.08k
    return 1;
329
2.08k
  }
330
331
10.8k
  if (stack_curr == 2) {
332
3.67k
    const size_t A1 = stack[stack_curr - 2].length;
333
3.67k
    const size_t B1 = stack[stack_curr - 1].length;
334
335
3.67k
    if (A1 <= B1) {
336
78
      return 0;
337
78
    }
338
339
3.59k
    return 1;
340
3.67k
  }
341
342
7.18k
  A = stack[stack_curr - 3].length;
343
7.18k
  B = stack[stack_curr - 2].length;
344
7.18k
  C = stack[stack_curr - 1].length;
345
346
7.18k
  if ((A <= B + C) || (B <= C)) {
347
5.47k
    return 0;
348
5.47k
  }
349
350
1.70k
  return 1;
351
7.18k
}
352
353
typedef struct {
354
  size_t alloc;
355
  SORT_TYPE *storage;
356
} TEMP_STORAGE_T;
357
358
30.2k
static void TIM_SORT_RESIZE(TEMP_STORAGE_T *store, const size_t new_size) {
359
30.2k
  if (store->alloc < new_size) {
360
23.5k
    SORT_TYPE *tempstore = (SORT_TYPE *)realloc(store->storage, new_size * sizeof(SORT_TYPE));
361
362
23.5k
    if (tempstore == NULL) {
363
0
      fprintf(stderr, "Error allocating temporary storage for tim sort: need %lu bytes",
364
0
              (unsigned long)(sizeof(SORT_TYPE) * new_size));
365
0
      exit(1);
366
0
    }
367
368
23.5k
    store->storage = tempstore;
369
23.5k
    store->alloc = new_size;
370
23.5k
  }
371
30.2k
}
372
373
static void TIM_SORT_MERGE(SORT_TYPE *dst, const TIM_SORT_RUN_T *stack, const int stack_curr,
374
30.2k
                           TEMP_STORAGE_T *store) {
375
30.2k
  const size_t A = stack[stack_curr - 2].length;
376
30.2k
  const size_t B = stack[stack_curr - 1].length;
377
30.2k
  const size_t curr = stack[stack_curr - 2].start;
378
30.2k
  SORT_TYPE *storage;
379
30.2k
  size_t i, j, k;
380
30.2k
  TIM_SORT_RESIZE(store, MIN(A, B));
381
30.2k
  storage = store->storage;
382
383
  /* left merge */
384
30.2k
  if (A < B) {
385
6.09k
    memcpy(storage, &dst[curr], A * sizeof(SORT_TYPE));
386
6.09k
    i = 0;
387
6.09k
    j = curr + A;
388
389
1.06M
    for (k = curr; k < curr + A + B; k++) {
390
1.05M
      if ((i < A) && (j < curr + A + B)) {
391
943k
        if (SORT_CMP(storage[i], dst[j]) <= 0) {
392
401k
          dst[k] = storage[i++];
393
541k
        } else {
394
541k
          dst[k] = dst[j++];
395
541k
        }
396
943k
      } else if (i < A) {
397
111k
        dst[k] = storage[i++];
398
111k
      } else {
399
2.62k
        break;
400
2.62k
      }
401
1.05M
    }
402
24.1k
  } else {
403
    /* right merge */
404
24.1k
    memcpy(storage, &dst[curr + A], B * sizeof(SORT_TYPE));
405
24.1k
    i = B;
406
24.1k
    j = curr + A;
407
24.1k
    k = curr + A + B;
408
409
1.95M
    while (k > curr) {
410
1.94M
      k--;
411
1.94M
      if ((i > 0) && (j > curr)) {
412
1.58M
        if (SORT_CMP(dst[j - 1], storage[i - 1]) > 0) {
413
1.08M
          dst[k] = dst[--j];
414
1.08M
        } else {
415
503k
          dst[k] = storage[--i];
416
503k
        }
417
1.58M
      } else if (i > 0) {
418
345k
        dst[k] = storage[--i];
419
345k
      } else {
420
14.5k
        break;
421
14.5k
      }
422
1.94M
    }
423
24.1k
  }
424
30.2k
}
425
426
static int TIM_SORT_COLLAPSE(SORT_TYPE *dst, TIM_SORT_RUN_T *stack, int stack_curr,
427
5.55k
                             TEMP_STORAGE_T *store, const size_t size) {
428
11.9k
  while (1) {
429
11.9k
    size_t A, B, C, D;
430
11.9k
    int ABC, BCD, CD;
431
432
    /* if the stack only has one thing on it, we are done with the collapse */
433
11.9k
    if (stack_curr <= 1) {
434
0
      break;
435
0
    }
436
437
    /* if this is the last merge, just do it */
438
11.9k
    if ((stack_curr == 2) && (stack[0].length + stack[1].length == size)) {
439
0
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
440
0
      stack[0].length += stack[1].length;
441
0
      stack_curr--;
442
0
      break;
443
0
    }
444
    /* check if the invariant is off for a stack of 2 elements */
445
11.9k
    else if ((stack_curr == 2) && (stack[0].length <= stack[1].length)) {
446
2.08k
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
447
2.08k
      stack[0].length += stack[1].length;
448
2.08k
      stack_curr--;
449
2.08k
      break;
450
9.83k
    } else if (stack_curr == 2) {
451
2.85k
      break;
452
2.85k
    }
453
454
6.98k
    B = stack[stack_curr - 3].length;
455
6.98k
    C = stack[stack_curr - 2].length;
456
6.98k
    D = stack[stack_curr - 1].length;
457
458
6.98k
    if (stack_curr >= 4) {
459
1.68k
      A = stack[stack_curr - 4].length;
460
1.68k
      ABC = (A <= B + C);
461
5.30k
    } else {
462
5.30k
      ABC = 0;
463
5.30k
    }
464
465
6.98k
    BCD = (B <= C + D) || ABC;
466
6.98k
    CD = (C <= D);
467
468
    /* Both invariants are good */
469
6.98k
    if (!BCD && !CD) {
470
621
      break;
471
621
    }
472
473
    /* left merge */
474
6.36k
    if (BCD && !CD) {
475
1.77k
      TIM_SORT_MERGE(dst, stack, stack_curr - 1, store);
476
1.77k
      stack[stack_curr - 3].length += stack[stack_curr - 2].length;
477
1.77k
      stack[stack_curr - 2] = stack[stack_curr - 1];
478
1.77k
      stack_curr--;
479
4.58k
    } else {
480
      /* right merge */
481
4.58k
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
482
4.58k
      stack[stack_curr - 2].length += stack[stack_curr - 1].length;
483
4.58k
      stack_curr--;
484
4.58k
    }
485
6.36k
  }
486
487
5.55k
  return stack_curr;
488
5.55k
}
489
490
static __inline int PUSH_NEXT(SORT_TYPE *dst,
491
                              const size_t size,
492
                              TEMP_STORAGE_T *store,
493
                              const size_t minrun,
494
                              TIM_SORT_RUN_T *run_stack,
495
                              size_t *stack_curr,
496
48.4k
                              size_t *curr) {
497
48.4k
  size_t len = COUNT_RUN(dst, *curr, size);
498
48.4k
  size_t run = minrun;
499
500
48.4k
  if (run > size - *curr) {
501
15.7k
    run = size - *curr;
502
15.7k
  }
503
504
48.4k
  if (run > len) {
505
23.2k
    BINARY_INSERTION_SORT_START(&dst[*curr], len, run);
506
23.2k
    len = run;
507
23.2k
  }
508
509
48.4k
  run_stack[*stack_curr].start = *curr;
510
48.4k
  run_stack[*stack_curr].length = len;
511
48.4k
  (*stack_curr)++;
512
48.4k
  *curr += len;
513
514
48.4k
  if (*curr == size) {
515
    /* finish up */
516
40.0k
    while (*stack_curr > 1) {
517
21.7k
      TIM_SORT_MERGE(dst, run_stack, *stack_curr, store);
518
21.7k
      run_stack[*stack_curr - 2].length += run_stack[*stack_curr - 1].length;
519
21.7k
      (*stack_curr)--;
520
21.7k
    }
521
522
18.2k
    if (store->storage != NULL) {
523
18.2k
      free(store->storage);
524
18.2k
      store->storage = NULL;
525
18.2k
    }
526
527
18.2k
    return 0;
528
18.2k
  }
529
530
30.2k
  return 1;
531
48.4k
}
532
533
66.5k
void TIM_SORT(SORT_TYPE *dst, const size_t size) {
534
66.5k
  size_t minrun;
535
66.5k
  TEMP_STORAGE_T _store, *store;
536
66.5k
  TIM_SORT_RUN_T run_stack[TIM_SORT_STACK_SIZE];
537
66.5k
  size_t stack_curr = 0;
538
66.5k
  size_t curr = 0;
539
540
  /* don't bother sorting an array of size 1 */
541
66.5k
  if (size <= 1) {
542
0
    return;
543
0
  }
544
545
66.5k
  if (size < 64) {
546
48.2k
    BINARY_INSERTION_SORT(dst, size);
547
48.2k
    return;
548
48.2k
  }
549
550
  /* compute the minimum run length */
551
18.2k
  minrun = compute_minrun(size);
552
  /* temporary storage for merges */
553
18.2k
  store = &_store;
554
18.2k
  store->alloc = 0;
555
18.2k
  store->storage = NULL;
556
557
18.2k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
558
0
    return;
559
0
  }
560
561
18.2k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
562
13.7k
    return;
563
13.7k
  }
564
565
4.56k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
566
1.96k
    return;
567
1.96k
  }
568
569
12.9k
  while (1) {
570
12.9k
    if (!CHECK_INVARIANT(run_stack, stack_curr)) {
571
5.55k
      stack_curr = TIM_SORT_COLLAPSE(dst, run_stack, stack_curr, store, size);
572
5.55k
      continue;
573
5.55k
    }
574
575
7.38k
    if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
576
2.60k
      return;
577
2.60k
    }
578
7.38k
  }
579
2.60k
}
580
581
#undef SORT_CONCAT
582
#undef SORT_MAKE_STR1
583
#undef SORT_MAKE_STR
584
#undef SORT_NAME
585
#undef SORT_TYPE
586
#undef SORT_CMP
587
#undef TEMP_STORAGE_T
588
#undef TIM_SORT_RUN_T
589
#undef PUSH_NEXT
590
#undef SORT_SWAP
591
#undef SORT_CONCAT
592
#undef SORT_MAKE_STR1
593
#undef SORT_MAKE_STR
594
#undef BINARY_INSERTION_FIND
595
#undef BINARY_INSERTION_SORT_START
596
#undef BINARY_INSERTION_SORT
597
#undef REVERSE_ELEMENTS
598
#undef COUNT_RUN
599
#undef TIM_SORT
600
#undef TIM_SORT_RESIZE
601
#undef TIM_SORT_COLLAPSE
602
#undef TIM_SORT_RUN_T
603
#undef TEMP_STORAGE_T