Coverage Report

Created: 2026-08-31 07:18

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
1.48k
#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
4.85k
#define MAX(x,y) (((x) > (y) ? (x) : (y)))
68
#endif
69
70
#ifndef MIN
71
11.3k
#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
4.85k
#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
4.85k
static __inline int compute_minrun(const uint64_t size) {
130
4.85k
  const int top_bit = 64 - CLZ(size);
131
4.85k
  const int shift = MAX(top_bit, 6) - 6;
132
4.85k
  const int minrun = size >> shift;
133
4.85k
  const uint64_t mask = (1ULL << shift) - 1;
134
135
4.85k
  if (mask & size) {
136
3.29k
    return minrun + 1;
137
3.29k
  }
138
139
1.55k
  return minrun;
140
4.85k
}
141
142
#endif /* SORT_COMMON_H */
143
144
416k
#define SORT_CONCAT(x, y) x ## _ ## y
145
416k
#define SORT_MAKE_STR1(x, y) SORT_CONCAT(x,y)
146
416k
#define SORT_MAKE_STR(x) SORT_MAKE_STR1(SORT_NAME,x)
147
148
302k
#define BINARY_INSERTION_FIND          SORT_MAKE_STR(binary_insertion_find)
149
35.9k
#define BINARY_INSERTION_SORT_START    SORT_MAKE_STR(binary_insertion_sort_start)
150
25.8k
#define BINARY_INSERTION_SORT          SORT_MAKE_STR(binary_insertion_sort)
151
1.48k
#define REVERSE_ELEMENTS               SORT_MAKE_STR(reverse_elements)
152
16.1k
#define COUNT_RUN                      SORT_MAKE_STR(count_run)
153
7.97k
#define CHECK_INVARIANT                SORT_MAKE_STR(check_invariant)
154
#define TIM_SORT                       SORT_MAKE_STR(tim_sort)
155
11.3k
#define TIM_SORT_RESIZE                SORT_MAKE_STR(tim_sort_resize)
156
11.3k
#define TIM_SORT_MERGE                 SORT_MAKE_STR(tim_sort_merge)
157
3.36k
#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
302k
    const size_t size) {
181
302k
  size_t l, c, r;
182
302k
  SORT_TYPE cx;
183
302k
  l = 0;
184
302k
  r = size - 1;
185
302k
  c = r >> 1;
186
187
  /* check for out of bounds at the beginning. */
188
302k
  if (SORT_CMP(x, dst[0]) < 0) {
189
2.30k
    return 0;
190
300k
  } else if (SORT_CMP(x, dst[r]) > 0) {
191
0
    return r;
192
0
  }
193
194
300k
  cx = dst[c];
195
196
1.15M
  while (1) {
197
1.15M
    const int val = SORT_CMP(x, cx);
198
199
1.15M
    if (val < 0) {
200
505k
      if (c - l <= 1) {
201
213k
        return c;
202
213k
      }
203
204
291k
      r = c;
205
649k
    } else { /* allow = for stability. The binary search favors the right. */
206
649k
      if (r - c <= 1) {
207
87.2k
        return c + 1;
208
87.2k
      }
209
210
562k
      l = c;
211
562k
    }
212
213
854k
    c = l + ((r - l) >> 1);
214
854k
    cx = dst[c];
215
854k
  }
216
300k
}
217
218
/* Binary insertion sort, but knowing that the first "start" entries are sorted.  Used in timsort. */
219
35.9k
static void BINARY_INSERTION_SORT_START(SORT_TYPE *dst, const size_t start, const size_t size) {
220
35.9k
  size_t i;
221
222
568k
  for (i = start; i < size; i++) {
223
532k
    size_t j;
224
532k
    SORT_TYPE x;
225
532k
    size_t location;
226
227
    /* If this entry is already correct, just move along */
228
532k
    if (SORT_CMP(dst[i - 1], dst[i]) <= 0) {
229
230k
      continue;
230
230k
    }
231
232
    /* Else we need to find the right place, shift everything over, and squeeze in */
233
302k
    x = dst[i];
234
302k
    location = BINARY_INSERTION_FIND(dst, x, i);
235
236
2.27M
    for (j = i - 1; j >= location; j--) {
237
1.97M
      dst[j + 1] = dst[j];
238
239
1.97M
      if (j == 0) { /* check edge case because j is unsigned */
240
2.30k
        break;
241
2.30k
      }
242
1.97M
    }
243
244
302k
    dst[location] = x;
245
302k
  }
246
35.9k
}
247
248
/* Binary insertion sort */
249
25.8k
void BINARY_INSERTION_SORT(SORT_TYPE *dst, const size_t size) {
250
  /* don't bother sorting an array of size <= 1 */
251
25.8k
  if (size <= 1) {
252
0
    return;
253
0
  }
254
255
25.8k
  BINARY_INSERTION_SORT_START(dst, 1, size);
256
25.8k
}
257
258
/* timsort implementation, based on timsort.txt */
259
260
1.48k
static __inline void REVERSE_ELEMENTS(SORT_TYPE *dst, size_t start, size_t end) {
261
2.96k
  while (1) {
262
2.96k
    if (start >= end) {
263
1.48k
      return;
264
1.48k
    }
265
266
1.48k
    SORT_SWAP(dst[start], dst[end]);
267
1.48k
    start++;
268
1.48k
    end--;
269
1.48k
  }
270
1.48k
}
271
272
16.1k
static size_t COUNT_RUN(SORT_TYPE *dst, const size_t start, const size_t size) {
273
16.1k
  size_t curr;
274
275
16.1k
  if (size - start == 1) {
276
2.29k
    return 1;
277
2.29k
  }
278
279
13.8k
  if (start >= size - 2) {
280
80
    if (SORT_CMP(dst[size - 2], dst[size - 1]) > 0) {
281
3
      SORT_SWAP(dst[size - 2], dst[size - 1]);
282
3
    }
283
284
80
    return 2;
285
80
  }
286
287
13.7k
  curr = start + 2;
288
289
13.7k
  if (SORT_CMP(dst[start], dst[start + 1]) <= 0) {
290
    /* increasing run */
291
1.22M
    while (1) {
292
1.22M
      if (curr == size - 1) {
293
2.51k
        break;
294
2.51k
      }
295
296
1.22M
      if (SORT_CMP(dst[curr - 1], dst[curr]) > 0) {
297
9.79k
        break;
298
9.79k
      }
299
300
1.21M
      curr++;
301
1.21M
    }
302
303
12.3k
    return curr - start;
304
12.3k
  } else {
305
    /* decreasing run */
306
1.48k
    while (1) {
307
1.48k
      if (curr == size - 1) {
308
3
        break;
309
3
      }
310
311
1.48k
      if (SORT_CMP(dst[curr - 1], dst[curr]) <= 0) {
312
1.47k
        break;
313
1.47k
      }
314
315
6
      curr++;
316
6
    }
317
318
    /* reverse in-place */
319
1.48k
    REVERSE_ELEMENTS(dst, start, curr - 1);
320
1.48k
    return curr - start;
321
1.48k
  }
322
13.7k
}
323
324
7.97k
static int CHECK_INVARIANT(TIM_SORT_RUN_T *stack, const int stack_curr) {
325
7.97k
  size_t A, B, C;
326
327
7.97k
  if (stack_curr < 2) {
328
1.13k
    return 1;
329
1.13k
  }
330
331
6.83k
  if (stack_curr == 2) {
332
2.07k
    const size_t A1 = stack[stack_curr - 2].length;
333
2.07k
    const size_t B1 = stack[stack_curr - 1].length;
334
335
2.07k
    if (A1 <= B1) {
336
18
      return 0;
337
18
    }
338
339
2.05k
    return 1;
340
2.07k
  }
341
342
4.76k
  A = stack[stack_curr - 3].length;
343
4.76k
  B = stack[stack_curr - 2].length;
344
4.76k
  C = stack[stack_curr - 1].length;
345
346
4.76k
  if ((A <= B + C) || (B <= C)) {
347
3.35k
    return 0;
348
3.35k
  }
349
350
1.41k
  return 1;
351
4.76k
}
352
353
typedef struct {
354
  size_t alloc;
355
  SORT_TYPE *storage;
356
} TEMP_STORAGE_T;
357
358
11.3k
static void TIM_SORT_RESIZE(TEMP_STORAGE_T *store, const size_t new_size) {
359
11.3k
  if (store->alloc < new_size) {
360
6.91k
    SORT_TYPE *tempstore = (SORT_TYPE *)realloc(store->storage, new_size * sizeof(SORT_TYPE));
361
362
6.91k
    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
6.91k
    store->storage = tempstore;
369
6.91k
    store->alloc = new_size;
370
6.91k
  }
371
11.3k
}
372
373
static void TIM_SORT_MERGE(SORT_TYPE *dst, const TIM_SORT_RUN_T *stack, const int stack_curr,
374
11.3k
                           TEMP_STORAGE_T *store) {
375
11.3k
  const size_t A = stack[stack_curr - 2].length;
376
11.3k
  const size_t B = stack[stack_curr - 1].length;
377
11.3k
  const size_t curr = stack[stack_curr - 2].start;
378
11.3k
  SORT_TYPE *storage;
379
11.3k
  size_t i, j, k;
380
11.3k
  TIM_SORT_RESIZE(store, MIN(A, B));
381
11.3k
  storage = store->storage;
382
383
  /* left merge */
384
11.3k
  if (A < B) {
385
3.18k
    memcpy(storage, &dst[curr], A * sizeof(SORT_TYPE));
386
3.18k
    i = 0;
387
3.18k
    j = curr + A;
388
389
812k
    for (k = curr; k < curr + A + B; k++) {
390
811k
      if ((i < A) && (j < curr + A + B)) {
391
799k
        if (SORT_CMP(storage[i], dst[j]) <= 0) {
392
241k
          dst[k] = storage[i++];
393
558k
        } else {
394
558k
          dst[k] = dst[j++];
395
558k
        }
396
799k
      } else if (i < A) {
397
8.83k
        dst[k] = storage[i++];
398
8.83k
      } else {
399
2.20k
        break;
400
2.20k
      }
401
811k
    }
402
8.13k
  } else {
403
    /* right merge */
404
8.13k
    memcpy(storage, &dst[curr + A], B * sizeof(SORT_TYPE));
405
8.13k
    i = B;
406
8.13k
    j = curr + A;
407
8.13k
    k = curr + A + B;
408
409
500k
    while (k > curr) {
410
499k
      k--;
411
499k
      if ((i > 0) && (j > curr)) {
412
488k
        if (SORT_CMP(dst[j - 1], storage[i - 1]) > 0) {
413
151k
          dst[k] = dst[--j];
414
337k
        } else {
415
337k
          dst[k] = storage[--i];
416
337k
        }
417
488k
      } else if (i > 0) {
418
3.32k
        dst[k] = storage[--i];
419
7.92k
      } else {
420
7.92k
        break;
421
7.92k
      }
422
499k
    }
423
8.13k
  }
424
11.3k
}
425
426
static int TIM_SORT_COLLAPSE(SORT_TYPE *dst, TIM_SORT_RUN_T *stack, int stack_curr,
427
3.36k
                             TEMP_STORAGE_T *store, const size_t size) {
428
7.41k
  while (1) {
429
7.41k
    size_t A, B, C, D;
430
7.41k
    int ABC, BCD, CD;
431
432
    /* if the stack only has one thing on it, we are done with the collapse */
433
7.41k
    if (stack_curr <= 1) {
434
0
      break;
435
0
    }
436
437
    /* if this is the last merge, just do it */
438
7.41k
    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
7.41k
    else if ((stack_curr == 2) && (stack[0].length <= stack[1].length)) {
446
1.13k
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
447
1.13k
      stack[0].length += stack[1].length;
448
1.13k
      stack_curr--;
449
1.13k
      break;
450
6.28k
    } else if (stack_curr == 2) {
451
1.81k
      break;
452
1.81k
    }
453
454
4.47k
    B = stack[stack_curr - 3].length;
455
4.47k
    C = stack[stack_curr - 2].length;
456
4.47k
    D = stack[stack_curr - 1].length;
457
458
4.47k
    if (stack_curr >= 4) {
459
1.16k
      A = stack[stack_curr - 4].length;
460
1.16k
      ABC = (A <= B + C);
461
3.31k
    } else {
462
3.31k
      ABC = 0;
463
3.31k
    }
464
465
4.47k
    BCD = (B <= C + D) || ABC;
466
4.47k
    CD = (C <= D);
467
468
    /* Both invariants are good */
469
4.47k
    if (!BCD && !CD) {
470
425
      break;
471
425
    }
472
473
    /* left merge */
474
4.04k
    if (BCD && !CD) {
475
833
      TIM_SORT_MERGE(dst, stack, stack_curr - 1, store);
476
833
      stack[stack_curr - 3].length += stack[stack_curr - 2].length;
477
833
      stack[stack_curr - 2] = stack[stack_curr - 1];
478
833
      stack_curr--;
479
3.21k
    } else {
480
      /* right merge */
481
3.21k
      TIM_SORT_MERGE(dst, stack, stack_curr, store);
482
3.21k
      stack[stack_curr - 2].length += stack[stack_curr - 1].length;
483
3.21k
      stack_curr--;
484
3.21k
    }
485
4.04k
  }
486
487
3.36k
  return stack_curr;
488
3.36k
}
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
16.1k
                              size_t *curr) {
497
16.1k
  size_t len = COUNT_RUN(dst, *curr, size);
498
16.1k
  size_t run = minrun;
499
500
16.1k
  if (run > size - *curr) {
501
3.82k
    run = size - *curr;
502
3.82k
  }
503
504
16.1k
  if (run > len) {
505
10.1k
    BINARY_INSERTION_SORT_START(&dst[*curr], len, run);
506
10.1k
    len = run;
507
10.1k
  }
508
509
16.1k
  run_stack[*stack_curr].start = *curr;
510
16.1k
  run_stack[*stack_curr].length = len;
511
16.1k
  (*stack_curr)++;
512
16.1k
  *curr += len;
513
514
16.1k
  if (*curr == size) {
515
    /* finish up */
516
10.9k
    while (*stack_curr > 1) {
517
6.13k
      TIM_SORT_MERGE(dst, run_stack, *stack_curr, store);
518
6.13k
      run_stack[*stack_curr - 2].length += run_stack[*stack_curr - 1].length;
519
6.13k
      (*stack_curr)--;
520
6.13k
    }
521
522
4.85k
    if (store->storage != NULL) {
523
4.85k
      free(store->storage);
524
4.85k
      store->storage = NULL;
525
4.85k
    }
526
527
4.85k
    return 0;
528
4.85k
  }
529
530
11.3k
  return 1;
531
16.1k
}
532
533
30.6k
void TIM_SORT(SORT_TYPE *dst, const size_t size) {
534
30.6k
  size_t minrun;
535
30.6k
  TEMP_STORAGE_T _store, *store;
536
30.6k
  TIM_SORT_RUN_T run_stack[TIM_SORT_STACK_SIZE];
537
30.6k
  size_t stack_curr = 0;
538
30.6k
  size_t curr = 0;
539
540
  /* don't bother sorting an array of size 1 */
541
30.6k
  if (size <= 1) {
542
0
    return;
543
0
  }
544
545
30.6k
  if (size < 64) {
546
25.8k
    BINARY_INSERTION_SORT(dst, size);
547
25.8k
    return;
548
25.8k
  }
549
550
  /* compute the minimum run length */
551
4.85k
  minrun = compute_minrun(size);
552
  /* temporary storage for merges */
553
4.85k
  store = &_store;
554
4.85k
  store->alloc = 0;
555
4.85k
  store->storage = NULL;
556
557
4.85k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
558
0
    return;
559
0
  }
560
561
4.85k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
562
2.98k
    return;
563
2.98k
  }
564
565
1.86k
  if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
566
484
    return;
567
484
  }
568
569
7.97k
  while (1) {
570
7.97k
    if (!CHECK_INVARIANT(run_stack, stack_curr)) {
571
3.36k
      stack_curr = TIM_SORT_COLLAPSE(dst, run_stack, stack_curr, store, size);
572
3.36k
      continue;
573
3.36k
    }
574
575
4.60k
    if (!PUSH_NEXT(dst, size, store, minrun, run_stack, &stack_curr, &curr)) {
576
1.38k
      return;
577
1.38k
    }
578
4.60k
  }
579
1.38k
}
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