varun-r-mallya/sysprof
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/sysprof.git synced 2025-12-31 20:36:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

libsysprof: sort frames with timsort

Browse Source 
These are largely pre-sorted, but not fully when you have merged data. This
uses timsort to speed that up a bit.

In particular, the comparison of various sorts break down to (for a
~32,000,000 record capture.

  g_array_sort_with_data() => 3.9 seconds
  qsort_r() = > 3.7 seconds
  gtk_tim_sort() => .79 seconds
This commit is contained in:
Christian Hergert
2023-08-18 16:46:28 -07:00
parent c730ce8320
commit bf73d142dc
7 changed files with 1661 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/libsysprof/meson.build
View File

@ -145,6 +145,7 @@ libsysprof_private_sources = [
'sysprof-process-info.c',
'sysprof-strings.c',
'sysprof-symbol-cache.c',
'timsort/gtktimsort.c',
]
if polkit_dep.found()

14
src/libsysprof/sysprof-document.c
View File

@ -27,6 +27,8 @@
#include <libdex.h>
#include "timsort/gtktimsortprivate.h"
#include "sysprof-document-private.h"
#include "sysprof-bundled-symbolizer-private.h"
@ -1207,9 +1209,17 @@ sysprof_document_load_worker (GTask *task,
* have state which belongs earlier in the capture.
*/
if G_UNLIKELY (self->needs_swap)
g_array_sort_with_data (self->frames, sort_by_time_swapped, (gpointer)self->base);
gtk_tim_sort (self->frames->data,
self->frames->len,
sizeof (SysprofDocumentFramePointer),
sort_by_time_swapped,
(gpointer)self->base);
else
g_array_sort_with_data (self->frames, sort_by_time, (gpointer)self->base);
gtk_tim_sort (self->frames->data,
self->frames->len,
sizeof (SysprofDocumentFramePointer),
sort_by_time,
(gpointer)self->base);
for (guint f = 0; f < self->frames->len; f++)
{

202
src/libsysprof/timsort/COPYING Normal file
View File

@ -0,0 +1,202 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

8
src/libsysprof/timsort/README.md Normal file
View File

@ -0,0 +1,8 @@
Timsort implementation
======================
This directory contains code modified for GTK, based on the timsort
implementation in python, and its Java adaptation by Joshua Bloch.
See the source files for copyright and licensing information, and the
`COPYING` file for the full text of the Apache license, version 2.0.

943
src/libsysprof/timsort/gtktimsort-impl.c Normal file
View File

@ -0,0 +1,943 @@
/*
* Copyright (C) 2020 Benjamin Otte
* Copyright (C) 2011 Patrick O. Perry
* Copyright (C) 2008 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef NAME
#define NAME WIDTH
#endif
#define DEFINE_TEMP(temp) gpointer temp = g_alloca (WIDTH)
#define ASSIGN(x, y) memcpy (x, y, WIDTH)
#define INCPTR(x) ((gpointer) ((char *) (x) + WIDTH))
#define DECPTR(x) ((gpointer) ((char *) (x) - WIDTH))
#define ELEM(a, i) ((char *) (a) + (i) * WIDTH)
#define LEN(n) ((n) * WIDTH)
#define CONCAT(x, y) gtk_tim_sort_ ## x ## _ ## y
#define MAKE_STR(x, y) CONCAT (x, y)
#define gtk_tim_sort(x) MAKE_STR (x, NAME)
/*
* Reverse the specified range of the specified array.
*
* @param a the array in which a range is to be reversed
* @param hi the index after the last element in the range to be reversed
*/
static void gtk_tim_sort(reverse_range) (GtkTimSort *self,
gpointer a,
gsize hi)
{
DEFINE_TEMP (t);
char *front = a;
char *back = ELEM (a, hi - 1);
g_assert (hi > 0);
while (front < back)
{
ASSIGN (t, front);
ASSIGN (front, back);
ASSIGN (back, t);
front = INCPTR (front);
back = DECPTR (back);
}
}
/*
* Returns the length of the run beginning at the specified position in
* the specified array and reverses the run if it is descending (ensuring
* that the run will always be ascending when the method returns).
*
* A run is the longest ascending sequence with:
*
* a[0] <= a[1] <= a[2] <= ...
*
* or the longest descending sequence with:
*
* a[0] > a[1] > a[2] > ...
*
* For its intended use in a stable mergesort, the strictness of the
* definition of "descending" is needed so that the call can safely
* reverse a descending sequence without violating stability.
*
* @param a the array in which a run is to be counted and possibly reversed
* @param hi index after the last element that may be contained in the run.
* It is required that {@code 0 < hi}.
* @param compare the comparator to used for the sort
* @return the length of the run beginning at the specified position in
* the specified array
*/
static gsize
gtk_tim_sort(prepare_run) (GtkTimSort *self,
GtkTimSortRun *out_change)
{
gsize run_hi = 1;
char *cur;
char *next;
if (self->size <= run_hi)
{
gtk_tim_sort_set_change (out_change, NULL, 0);
return self->size;
}
cur = INCPTR (self->base);
next = INCPTR (cur);
run_hi++;
/* Find end of run, and reverse range if descending */
if (gtk_tim_sort_compare (self, cur, self->base) < 0) /* Descending */
{
while (run_hi < self->size && gtk_tim_sort_compare (self, next, cur) < 0)
{
run_hi++;
cur = next;
next = INCPTR (next);
}
gtk_tim_sort(reverse_range) (self, self->base, run_hi);
gtk_tim_sort_set_change (out_change, self->base, run_hi);
}
else /* Ascending */
{
while (run_hi < self->size && gtk_tim_sort_compare (self, next, cur) >= 0)
{
run_hi++;
cur = next;
next = INCPTR (next);
}
gtk_tim_sort_set_change (out_change, NULL, 0);
}
return run_hi;
}
/*
* Sorts the specified portion of the specified array using a binary
* insertion sort. This is the best method for sorting small numbers
* of elements. It requires O(n log n) compares, but O(n^2) data
* movement (worst case).
*
* If the initial part of the specified range is already sorted,
* this method can take advantage of it: the method assumes that the
* elements from index {@code lo}, inclusive, to {@code start},
* exclusive are already sorted.
*
* @param a the array in which a range is to be sorted
* @param hi the index after the last element in the range to be sorted
* @param start the index of the first element in the range that is
* not already known to be sorted ({@code lo <= start <= hi})
*/
static void gtk_tim_sort(binary_sort) (GtkTimSort *self,
gpointer a,
gsize hi,
gsize start,
GtkTimSortRun *inout_change)
{
DEFINE_TEMP (pivot);
char *startp;
char *change_min = ELEM (a, hi);
char *change_max = a;
g_assert (start <= hi);
if (start == 0)
start++;
startp = ELEM (a, start);
for (; start < hi; start++, startp = INCPTR (startp))
{
/* Set left (and right) to the index where a[start] (pivot) belongs */
char *leftp = a;
gsize right = start;
gsize n;
/*
* Invariants:
* pivot >= all in [0, left).
* pivot < all in [right, start).
*/
while (0 < right)
{
gsize mid = right >> 1;
gpointer midp = ELEM (leftp, mid);
if (gtk_tim_sort_compare (self, startp, midp) < 0)
{
right = mid;
}
else
{
leftp = INCPTR (midp);
right -= (mid + 1);
}
}
g_assert (0 == right);
/*
* The invariants still hold: pivot >= all in [lo, left) and
* pivot < all in [left, start), so pivot belongs at left. Note
* that if there are elements equal to pivot, left points to the
* first slot after them -- that's why this sort is stable.
* Slide elements over to make room to make room for pivot.
*/
n = startp - leftp; /* The number of bytes to move */
if (n == 0)
continue;
ASSIGN (pivot, startp);
memmove (INCPTR (leftp), leftp, n); /* POP: overlaps */
/* a[left] = pivot; */
ASSIGN (leftp, pivot);
change_min = MIN (change_min, leftp);
change_max = MAX (change_max, ELEM (startp, 1));
}
if (change_max > (char *) a)
{
g_assert (change_min < ELEM (a, hi));
if (inout_change && inout_change->len)
{
change_max = MAX (change_max, ELEM (inout_change->base, inout_change->len));
change_min = MIN (change_min, (char *) inout_change->base);
}
gtk_tim_sort_set_change (inout_change, change_min, (change_max - change_min) / WIDTH);
}
}
static gboolean
gtk_tim_sort(merge_append) (GtkTimSort *self,
GtkTimSortRun *out_change)
{
/* Identify next run */
gsize run_len;
run_len = gtk_tim_sort(prepare_run) (self, out_change);
if (run_len == 0)
return FALSE;
/* If run is short, extend to min(self->min_run, self->size) */
if (run_len < self->min_run)
{
gsize force = MIN (self->size, self->min_run);
gtk_tim_sort(binary_sort) (self, self->base, force, run_len, out_change);
run_len = force;
}
/* Push run onto pending-run stack, and maybe merge */
gtk_tim_sort_push_run (self, self->base, run_len);
return TRUE;
}
/*
* Locates the position at which to insert the specified key into the
* specified sorted range; if the range contains an element equal to key,
* returns the index of the leftmost equal element.
*
* @param key the key whose insertion point to search for
* @param base the array in which to search
* @param len the length of the range; must be > 0
* @param hint the index at which to begin the search, 0 <= hint < n.
* The closer hint is to the result, the faster this method will run.
* @param c the comparator used to order the range, and to search
* @return the int k, 0 <= k <= n such that a[b + k - 1] < key <= a[b + k],
* pretending that a[b - 1] is minus infinity and a[b + n] is infinity.
* In other words, key belongs at index b + k; or in other words,
* the first k elements of a should precede key, and the last n - k
* should follow it.
*/
static gsize
gtk_tim_sort(gallop_left) (GtkTimSort *self,
gpointer key,
gpointer base,
gsize len,
gsize hint)
{
char *hintp = ELEM (base, hint);
gsize last_ofs = 0;
gsize ofs = 1;
g_assert (len > 0 && hint < len);
if (gtk_tim_sort_compare (self, key, hintp) > 0)
{
/* Gallop right until a[hint+last_ofs] < key <= a[hint+ofs] */
gsize max_ofs = len - hint;
while (ofs < max_ofs
&& gtk_tim_sort_compare (self, key, ELEM (hintp, ofs)) > 0)
{
last_ofs = ofs;
ofs = (ofs << 1) + 1; /* eventually this becomes SIZE_MAX */
}
if (ofs > max_ofs)
ofs = max_ofs;
/* Make offsets relative to base */
last_ofs += hint + 1; /* POP: we add 1 here so last_ofs stays non-negative */
ofs += hint;
}
else /* key <= a[hint] */
/* Gallop left until a[hint-ofs] < key <= a[hint-last_ofs] */
{
const gsize max_ofs = hint + 1;
gsize tmp;
while (ofs < max_ofs
&& gtk_tim_sort_compare (self, key, ELEM (hintp, -ofs)) <= 0)
{
last_ofs = ofs;
ofs = (ofs << 1) + 1; /* no need to check for overflow */
}
if (ofs > max_ofs)
ofs = max_ofs;
/* Make offsets relative to base */
tmp = last_ofs;
last_ofs = hint + 1 - ofs; /* POP: we add 1 here so last_ofs stays non-negative */
ofs = hint - tmp;
}
g_assert (last_ofs <= ofs && ofs <= len);
/*
* Now a[last_ofs-1] < key <= a[ofs], so key belongs somewhere
* to the right of last_ofs but no farther right than ofs. Do a binary
* search, with invariant a[last_ofs - 1] < key <= a[ofs].
*/
/* last_ofs++; POP: we added 1 above to keep last_ofs non-negative */
while (last_ofs < ofs)
{
/*gsize m = last_ofs + ((ofs - last_ofs) >> 1); */
/* http://stackoverflow.com/questions/4844165/safe-integer-middle-value-formula */
gsize m = (last_ofs & ofs) + ((last_ofs ^ ofs) >> 1);
if (gtk_tim_sort_compare (self, key, ELEM (base, m)) > 0)
last_ofs = m + 1; /* a[m] < key */
else
ofs = m; /* key <= a[m] */
}
g_assert (last_ofs == ofs); /* so a[ofs - 1] < key <= a[ofs] */
return ofs;
}
/*
* Like gallop_left, except that if the range contains an element equal to
* key, gallop_right returns the index after the rightmost equal element.
*
* @param key the key whose insertion point to search for
* @param base the array in which to search
* @param len the length of the range; must be > 0
* @param hint the index at which to begin the search, 0 <= hint < n.
* The closer hint is to the result, the faster this method will run.
* @param c the comparator used to order the range, and to search
* @return the int k, 0 <= k <= n such that a[b + k - 1] <= key < a[b + k]
*/
static gsize
gtk_tim_sort(gallop_right) (GtkTimSort *self,
gpointer key,
gpointer base,
gsize len,
gsize hint)
{
char *hintp = ELEM (base, hint);
gsize ofs = 1;
gsize last_ofs = 0;
g_assert (len > 0 && hint < len);
if (gtk_tim_sort_compare (self, key, hintp) < 0)
{
/* Gallop left until a[hint - ofs] <= key < a[hint - last_ofs] */
gsize max_ofs = hint + 1;
gsize tmp;
while (ofs < max_ofs
&& gtk_tim_sort_compare (self, key, ELEM (hintp, -ofs)) < 0)
{
last_ofs = ofs;
ofs = (ofs << 1) + 1; /* no need to check for overflow */
}
if (ofs > max_ofs)
ofs = max_ofs;
/* Make offsets relative to base */
tmp = last_ofs;
last_ofs = hint + 1 - ofs;
ofs = hint - tmp;
}
else /* a[hint] <= key */
/* Gallop right until a[hint + last_ofs] <= key < a[hint + ofs] */
{
gsize max_ofs = len - hint;
while (ofs < max_ofs
&& gtk_tim_sort_compare (self, key, ELEM (hintp, ofs)) >= 0)
{
last_ofs = ofs;
ofs = (ofs << 1) + 1; /* no need to check for overflow */
}
if (ofs > max_ofs)
ofs = max_ofs;
/* Make offsets relative to base */
last_ofs += hint + 1;
ofs += hint;
}
g_assert (last_ofs <= ofs && ofs <= len);
/*
* Now a[last_ofs - 1] <= key < a[ofs], so key belongs somewhere to
* the right of last_ofs but no farther right than ofs. Do a binary
* search, with invariant a[last_ofs - 1] <= key < a[ofs].
*/
while (last_ofs < ofs)
{
/* gsize m = last_ofs + ((ofs - last_ofs) >> 1); */
gsize m = (last_ofs & ofs) + ((last_ofs ^ ofs) >> 1);
if (gtk_tim_sort_compare (self, key, ELEM (base, m)) < 0)
ofs = m; /* key < a[m] */
else
last_ofs = m + 1; /* a[m] <= key */
}
g_assert (last_ofs == ofs); /* so a[ofs - 1] <= key < a[ofs] */
return ofs;
}
/*
* Merges two adjacent runs in place, in a stable fashion. The first
* element of the first run must be greater than the first element of the
* second run (a[base1] > a[base2]), and the last element of the first run
* (a[base1 + len1-1]) must be greater than all elements of the second run.
*
* For performance, this method should be called only when len1 <= len2;
* its twin, merge_hi should be called if len1 >= len2. (Either method
* may be called if len1 == len2.)
*
* @param base1 first element in first run to be merged
* @param len1 length of first run to be merged (must be > 0)
* @param base2 first element in second run to be merged
* (must be aBase + aLen)
* @param len2 length of second run to be merged (must be > 0)
*/
static void
gtk_tim_sort(merge_lo) (GtkTimSort *self,
gpointer base1,
gsize len1,
gpointer base2,
gsize len2)
{
/* Copy first run into temp array */
gpointer tmp = gtk_tim_sort_ensure_capacity (self, len1);
char *cursor1;
char *cursor2;
char *dest;
gsize min_gallop;
g_assert (len1 > 0 && len2 > 0 && ELEM (base1, len1) == base2);
/* System.arraycopy(a, base1, tmp, 0, len1); */
memcpy (tmp, base1, LEN (len1)); /* POP: can't overlap */
cursor1 = tmp; /* Indexes into tmp array */
cursor2 = base2; /* Indexes int a */
dest = base1; /* Indexes int a */
/* Move first element of second run and deal with degenerate cases */
/* a[dest++] = a[cursor2++]; */
ASSIGN (dest, cursor2);
dest = INCPTR (dest);
cursor2 = INCPTR (cursor2);
if (--len2 == 0)
{
memcpy (dest, cursor1, LEN (len1)); /* POP: can't overlap */
return;
}
if (len1 == 1)
{
memmove (dest, cursor2, LEN (len2)); /* POP: overlaps */
/* a[dest + len2] = tmp[cursor1]; // Last elt of run 1 to end of merge */
ASSIGN (ELEM (dest, len2), cursor1);
return;
}
/* Use local variable for performance */
min_gallop = self->min_gallop;
while (TRUE)
{
gsize count1 = 0; /* Number of times in a row that first run won */
gsize count2 = 0; /* Number of times in a row that second run won */
/*
* Do the straightforward thing until (if ever) one run starts
* winning consistently.
*/
do
{
g_assert (len1 > 1 && len2 > 0);
if (gtk_tim_sort_compare (self, cursor2, cursor1) < 0)
{
ASSIGN (dest, cursor2);
dest = INCPTR (dest);
cursor2 = INCPTR (cursor2);
count2++;
count1 = 0;
if (--len2 == 0)
goto outer;
if (count2 >= min_gallop)
break;
}
else
{
ASSIGN (dest, cursor1);
dest = INCPTR (dest);
cursor1 = INCPTR (cursor1);
count1++;
count2 = 0;
if (--len1 == 1)
goto outer;
if (count1 >= min_gallop)
break;
}
}
while (TRUE); /* (count1 | count2) < min_gallop); */
/*
* One run is winning so consistently that galloping may be a
* huge win. So try that, and continue galloping until (if ever)
* neither run appears to be winning consistently anymore.
*/
do
{
g_assert (len1 > 1 && len2 > 0);
count1 = gtk_tim_sort(gallop_right) (self, cursor2, cursor1, len1, 0);
if (count1 != 0)
{
memcpy (dest, cursor1, LEN (count1)); /* POP: can't overlap */
dest = ELEM (dest, count1);
cursor1 = ELEM (cursor1, count1);
len1 -= count1;
if (len1 <= 1) /* len1 == 1 || len1 == 0 */
goto outer;
}
ASSIGN (dest, cursor2);
dest = INCPTR (dest);
cursor2 = INCPTR (cursor2);
if (--len2 == 0)
goto outer;
count2 = gtk_tim_sort(gallop_left) (self, cursor1, cursor2, len2, 0);
if (count2 != 0)
{
memmove (dest, cursor2, LEN (count2)); /* POP: might overlap */
dest = ELEM (dest, count2);
cursor2 = ELEM (cursor2, count2);
len2 -= count2;
if (len2 == 0)
goto outer;
}
ASSIGN (dest, cursor1);
dest = INCPTR (dest);
cursor1 = INCPTR (cursor1);
if (--len1 == 1)
goto outer;
if (min_gallop > 0)
min_gallop--;
}
while (count1 >= MIN_GALLOP || count2 >= MIN_GALLOP);
min_gallop += 2; /* Penalize for leaving gallop mode */
} /* End of "outer" loop */
outer:
self->min_gallop = min_gallop < 1 ? 1 : min_gallop; /* Write back to field */
if (len1 == 1)
{
g_assert (len2 > 0);
memmove (dest, cursor2, LEN (len2)); /* POP: might overlap */
ASSIGN (ELEM (dest, len2), cursor1); /* Last elt of run 1 to end of merge */
}
else if (len1 == 0)
{
g_critical ("Comparison method violates its general contract");
return;
}
else
{
g_assert (len2 == 0);
g_assert (len1 > 1);
memcpy (dest, cursor1, LEN (len1)); /* POP: can't overlap */
}
}
/*
* Like merge_lo, except that this method should be called only if
* len1 >= len2; merge_lo should be called if len1 <= len2. (Either method
* may be called if len1 == len2.)
*
* @param base1 first element in first run to be merged
* @param len1 length of first run to be merged (must be > 0)
* @param base2 first element in second run to be merged
* (must be aBase + aLen)
* @param len2 length of second run to be merged (must be > 0)
*/
static void
gtk_tim_sort(merge_hi) (GtkTimSort *self,
gpointer base1,
gsize len1,
gpointer base2,
gsize len2)
{
/* Copy second run into temp array */
gpointer tmp = gtk_tim_sort_ensure_capacity (self, len2);
char *cursor1; /* Indexes into a */
char *cursor2; /* Indexes into tmp array */
char *dest; /* Indexes into a */
gsize min_gallop;
g_assert (len1 > 0 && len2 > 0 && ELEM (base1, len1) == base2);
memcpy (tmp, base2, LEN (len2)); /* POP: can't overlap */
cursor1 = ELEM (base1, len1 - 1); /* Indexes into a */
cursor2 = ELEM (tmp, len2 - 1); /* Indexes into tmp array */
dest = ELEM (base2, len2 - 1); /* Indexes into a */
/* Move last element of first run and deal with degenerate cases */
/* a[dest--] = a[cursor1--]; */
ASSIGN (dest, cursor1);
dest = DECPTR (dest);
cursor1 = DECPTR (cursor1);
if (--len1 == 0)
{
memcpy (ELEM (dest, -(len2 - 1)), tmp, LEN (len2)); /* POP: can't overlap */
return;
}
if (len2 == 1)
{
dest = ELEM (dest, -len1);
cursor1 = ELEM (cursor1, -len1);
memmove (ELEM (dest, 1), ELEM (cursor1, 1), LEN (len1)); /* POP: overlaps */
/* a[dest] = tmp[cursor2]; */
ASSIGN (dest, cursor2);
return;
}
/* Use local variable for performance */
min_gallop = self->min_gallop;
while (TRUE)
{
gsize count1 = 0; /* Number of times in a row that first run won */
gsize count2 = 0; /* Number of times in a row that second run won */
/*
* Do the straightforward thing until (if ever) one run
* appears to win consistently.
*/
do
{
g_assert (len1 > 0 && len2 > 1);
if (gtk_tim_sort_compare (self, cursor2, cursor1) < 0)
{
ASSIGN (dest, cursor1);
dest = DECPTR (dest);
cursor1 = DECPTR (cursor1);
count1++;
count2 = 0;
if (--len1 == 0)
goto outer;
}
else
{
ASSIGN (dest, cursor2);
dest = DECPTR (dest);
cursor2 = DECPTR (cursor2);
count2++;
count1 = 0;
if (--len2 == 1)
goto outer;
}
}
while ((count1 | count2) < min_gallop);
/*
* One run is winning so consistently that galloping may be a
* huge win. So try that, and continue galloping until (if ever)
* neither run appears to be winning consistently anymore.
*/
do
{
g_assert (len1 > 0 && len2 > 1);
count1 = len1 - gtk_tim_sort(gallop_right) (self, cursor2, base1, len1, len1 - 1);
if (count1 != 0)
{
dest = ELEM (dest, -count1);
cursor1 = ELEM (cursor1, -count1);
len1 -= count1;
memmove (INCPTR (dest), INCPTR (cursor1),
LEN (count1)); /* POP: might overlap */
if (len1 == 0)
goto outer;
}
ASSIGN (dest, cursor2);
dest = DECPTR (dest);
cursor2 = DECPTR (cursor2);
if (--len2 == 1)
goto outer;
count2 = len2 - gtk_tim_sort(gallop_left) (self, cursor1, tmp, len2, len2 - 1);
if (count2 != 0)
{
dest = ELEM (dest, -count2);
cursor2 = ELEM (cursor2, -count2);
len2 -= count2;
memcpy (INCPTR (dest), INCPTR (cursor2), LEN (count2)); /* POP: can't overlap */
if (len2 <= 1) /* len2 == 1 || len2 == 0 */
goto outer;
}
ASSIGN (dest, cursor1);
dest = DECPTR (dest);
cursor1 = DECPTR (cursor1);
if (--len1 == 0)
goto outer;
if (min_gallop > 0)
min_gallop--;
}
while (count1 >= MIN_GALLOP || count2 >= MIN_GALLOP);
min_gallop += 2; /* Penalize for leaving gallop mode */
} /* End of "outer" loop */
outer:
self->min_gallop = min_gallop < 1 ? 1 : min_gallop; /* Write back to field */
if (len2 == 1)
{
g_assert (len1 > 0);
dest = ELEM (dest, -len1);
cursor1 = ELEM (cursor1, -len1);
memmove (INCPTR (dest), INCPTR (cursor1), LEN (len1)); /* POP: might overlap */
/* a[dest] = tmp[cursor2]; // Move first elt of run2 to front of merge */
ASSIGN (dest, cursor2);
}
else if (len2 == 0)
{
g_critical ("Comparison method violates its general contract");
return;
}
else
{
g_assert (len1 == 0);
g_assert (len2 > 0);
memcpy (ELEM (dest, -(len2 - 1)), tmp, LEN (len2)); /* POP: can't overlap */
}
}
/*
* Merges the two runs at stack indices i and i+1. Run i must be
* the penultimate or antepenultimate run on the stack. In other words,
* i must be equal to pending_runs-2 or pending_runs-3.
*
* @param i stack index of the first of the two runs to merge
*/
static void
gtk_tim_sort(merge_at) (GtkTimSort *self,
gsize i,
GtkTimSortRun *out_change)
{
gpointer base1 = self->run[i].base;
gsize len1 = self->run[i].len;
gpointer base2 = self->run[i + 1].base;
gsize len2 = self->run[i + 1].len;
gsize k;
g_assert (self->pending_runs >= 2);
g_assert (i == self->pending_runs - 2 || i == self->pending_runs - 3);
g_assert (len1 > 0 && len2 > 0);
g_assert (ELEM (base1, len1) == base2);
/*
* Find where the first element of run2 goes in run1. Prior elements
* in run1 can be ignored (because they're already in place).
*/
k = gtk_tim_sort(gallop_right) (self, base2, base1, len1, 0);
base1 = ELEM (base1, k);
len1 -= k;
if (len1 == 0)
{
gtk_tim_sort_set_change (out_change, NULL, 0);
goto done;
}
/*
* Find where the last element of run1 goes in run2. Subsequent elements
* in run2 can be ignored (because they're already in place).
*/
len2 = gtk_tim_sort(gallop_left) (self,
ELEM (base1, len1 - 1),
base2, len2, len2 - 1);
if (len2 == 0)
{
gtk_tim_sort_set_change (out_change, NULL, 0);
goto done;
}
/* Merge remaining runs, using tmp array with min(len1, len2) elements */
if (len1 <= len2)
{
if (len1 > self->max_merge_size)
{
base1 = ELEM (self->run[i].base, self->run[i].len - self->max_merge_size);
gtk_tim_sort(merge_lo) (self, base1, self->max_merge_size, base2, len2);
gtk_tim_sort_set_change (out_change, base1, self->max_merge_size + len2);
self->run[i].len -= self->max_merge_size;
self->run[i + 1].base = ELEM (self->run[i + 1].base, - self->max_merge_size);
self->run[i + 1].len += self->max_merge_size;
g_assert (ELEM (self->run[i].base, self->run[i].len) == self->run[i + 1].base);
return;
}
else
{
gtk_tim_sort(merge_lo) (self, base1, len1, base2, len2);
gtk_tim_sort_set_change (out_change, base1, len1 + len2);
}
}
else
{
if (len2 > self->max_merge_size)
{
gtk_tim_sort(merge_hi) (self, base1, len1, base2, self->max_merge_size);
gtk_tim_sort_set_change (out_change, base1, len1 + self->max_merge_size);
self->run[i].len += self->max_merge_size;
self->run[i + 1].base = ELEM (self->run[i + 1].base, self->max_merge_size);
self->run[i + 1].len -= self->max_merge_size;
g_assert (ELEM (self->run[i].base, self->run[i].len) == self->run[i + 1].base);
return;
}
else
{
gtk_tim_sort(merge_hi) (self, base1, len1, base2, len2);
gtk_tim_sort_set_change (out_change, base1, len1 + len2);
}
}
done:
/*
* Record the length of the combined runs; if i is the 3rd-last
* run now, also slide over the last run (which isn't involved
* in this merge). The current run (i+1) goes away in any case.
*/
self->run[i].len += self->run[i + 1].len;
if (i == self->pending_runs - 3)
self->run[i + 1] = self->run[i + 2];
self->pending_runs--;
}
/*
* Examines the stack of runs waiting to be merged and merges adjacent runs
* until the stack invariants are reestablished:
*
* 1. run_len[i - 3] > run_len[i - 2] + run_len[i - 1]
* 2. run_len[i - 2] > run_len[i - 1]
*
* This method is called each time a new run is pushed onto the stack,
* so the invariants are guaranteed to hold for i < pending_runs upon
* entry to the method.
*
* POP:
* Modified according to http://envisage-project.eu/wp-content/uploads/2015/02/sorting.pdf
*
* and
*
* https://bugs.openjdk.java.net/browse/JDK-8072909 (suggestion 2)
*
*/
static gboolean
gtk_tim_sort(merge_collapse) (GtkTimSort *self,
GtkTimSortRun *out_change)
{
GtkTimSortRun *run = self->run;
gsize n;
if (self->pending_runs <= 1)
return FALSE;
n = self->pending_runs - 2;
if ((n > 0 && run[n - 1].len <= run[n].len + run[n + 1].len) ||
(n > 1 && run[n - 2].len <= run[n].len + run[n - 1].len))
{
if (run[n - 1].len < run[n + 1].len)
n--;
}
else if (run[n].len > run[n + 1].len)
{
return FALSE; /* Invariant is established */
}
gtk_tim_sort(merge_at) (self, n, out_change);
return TRUE;
}
/*
* Merges all runs on the stack until only one remains. This method is
* called once, to complete the sort.
*/
static gboolean
gtk_tim_sort(merge_force_collapse) (GtkTimSort *self,
GtkTimSortRun *out_change)
{
gsize n;
if (self->pending_runs <= 1)
return FALSE;
n = self->pending_runs - 2;
if (n > 0 && self->run[n - 1].len < self->run[n + 1].len)
n--;
gtk_tim_sort(merge_at) (self, n, out_change);
return TRUE;
}
static gboolean
gtk_tim_sort(step) (GtkTimSort *self,
GtkTimSortRun *out_change)
{
g_assert (self);
if (gtk_tim_sort(merge_collapse) (self, out_change))
return TRUE;
if (gtk_tim_sort(merge_append) (self, out_change))
return TRUE;
if (gtk_tim_sort(merge_force_collapse) (self, out_change))
return TRUE;
return FALSE;
}
#undef DEFINE_TEMP
#undef ASSIGN
#undef INCPTR
#undef DECPTR
#undef ELEM
#undef LEN
#undef CONCAT
#undef MAKE_STR
#undef gtk_tim_sort
#undef WIDTH
#undef NAME

375
src/libsysprof/timsort/gtktimsort.c Normal file
View File

@ -0,0 +1,375 @@
/* Lots of code for an adaptive, stable, natural mergesort. There are many
* pieces to this algorithm; read listsort.txt for overviews and details.
*/
#include "config.h"
#include "gtktimsortprivate.h"
/*
* This is the minimum sized sequence that will be merged. Shorter
* sequences will be lengthened by calling binarySort. If the entire
* array is less than this length, no merges will be performed.
*
* This constant should be a power of two. It was 64 in Tim Peter's C
* implementation, but 32 was empirically determined to work better in
* [Android's Java] implementation. In the unlikely event that you set
* this constant to be a number that's not a power of two, you'll need
* to change the compute_min_run() computation.
*
* If you decrease this constant, you must change the
* GTK_TIM_SORT_MAX_PENDING value, or you risk running out of space.
* See Python's listsort.txt for a discussion of the minimum stack
* length required as a function of the length of the array being sorted and
* the minimum merge sequence length.
*/
#define MIN_MERGE 32
/*
* When we get into galloping mode, we stay there until both runs win less
* often than MIN_GALLOP consecutive times.
*/
#define MIN_GALLOP 7
/*
* Returns the minimum acceptable run length for an array of the specified
* length. Natural runs shorter than this will be extended with binary sort.
*
* Roughly speaking, the computation is:
*
* If n < MIN_MERGE, return n (it's too small to bother with fancy stuff).
* Else if n is an exact power of 2, return MIN_MERGE/2.
* Else return an int k, MIN_MERGE/2 <= k <= MIN_MERGE, such that n/k
* is close to, but strictly less than, an exact power of 2.
*
* For the rationale, see listsort.txt.
*
* @param n the length of the array to be sorted
* @return the length of the minimum run to be merged
*/
static gsize
compute_min_run (gsize n)
{
gsize r = 0; // Becomes 1 if any 1 bits are shifted off
while (n >= MIN_MERGE) {
r |= (n & 1);
n >>= 1;
}
return n + r;
}
void
gtk_tim_sort_init (GtkTimSort *self,
gpointer base,
gsize size,
gsize element_size,
GCompareDataFunc compare_func,
gpointer data)
{
self->element_size = element_size;
self->base = base;
self->size = size;
self->compare_func = compare_func;
self->data = data;
self->min_gallop = MIN_GALLOP;
self->max_merge_size = G_MAXSIZE;
self->min_run = compute_min_run (size);
self->tmp = NULL;
self->tmp_length = 0;
self->pending_runs = 0;
}
void
gtk_tim_sort_finish (GtkTimSort *self)
{
g_clear_pointer (&self->tmp, g_free);
}
void
gtk_tim_sort (gpointer base,
gsize size,
gsize element_size,
GCompareDataFunc compare_func,
gpointer user_data)
{
GtkTimSort self;
gtk_tim_sort_init (&self, base, size, element_size, compare_func, user_data);
while (gtk_tim_sort_step (&self, NULL));
gtk_tim_sort_finish (&self);
}
static inline int
gtk_tim_sort_compare (GtkTimSort *self,
gpointer a,
gpointer b)
{
return self->compare_func (a, b, self->data);
}
/**
* Pushes the specified run onto the pending-run stack.
*
* @param runBase index of the first element in the run
* @param runLen the number of elements in the run
*/
static void
gtk_tim_sort_push_run (GtkTimSort *self,
void *base,
gsize len)
{
g_assert (self->pending_runs < GTK_TIM_SORT_MAX_PENDING);
g_assert (len <= self->size);
self->run[self->pending_runs].base = base;
self->run[self->pending_runs].len = len;
self->pending_runs++;
/* Advance to find next run */
self->base = ((char *) self->base) + len * self->element_size;
self->size -= len;
}
/**
* Ensures that the external array tmp has at least the specified
* number of elements, increasing its size if necessary. The size
* increases exponentially to ensure amortized linear time complexity.
*
* @param min_capacity the minimum required capacity of the tmp array
* @return tmp, whether or not it grew
*/
static gpointer
gtk_tim_sort_ensure_capacity (GtkTimSort *self,
gsize min_capacity)
{
if (self->tmp_length < min_capacity)
{
/* Compute smallest power of 2 > min_capacity */
gsize new_size = min_capacity;
new_size |= new_size >> 1;
new_size |= new_size >> 2;
new_size |= new_size >> 4;
new_size |= new_size >> 8;
new_size |= new_size >> 16;
if (sizeof(new_size) > 4)
new_size |= new_size >> 32;
new_size++;
if (new_size == 0) /* (overflow) Not bloody likely! */
new_size = min_capacity;
g_free (self->tmp);
self->tmp_length = new_size;
self->tmp = g_malloc (self->tmp_length * self->element_size);
}
return self->tmp;
}
static void
gtk_tim_sort_set_change (GtkTimSortRun *out_change,
gpointer base,
gsize len)
{
if (out_change)
{
out_change->base = base;
out_change->len = len;
}
}
/*<private>
* gtk_tim_sort_get_runs:
* @self: a GtkTimSort
* @runs: (out) (caller-allocates): Place to store the 0-terminated list of
* runs
*
* Stores the already presorted list of runs - ranges of items that are
* known to be sorted among themselves.
*
* This can be used with gtk_tim_sort_set_runs() when resuming a sort later.
**/
void
gtk_tim_sort_get_runs (GtkTimSort *self,
gsize runs[GTK_TIM_SORT_MAX_PENDING + 1])
{
gsize i;
g_return_if_fail (self);
g_return_if_fail (runs);
for (i = 0; i < self->pending_runs; i++)
runs[i] = self->run[i].len;
runs[self->pending_runs] = 0;
}
/*<private>
* gtk_tim_sort_set_runs:
* @self: a freshly initialized GtkTimSort
* @runs: (array length=zero-terminated): a 0-terminated list of runs
*
* Sets the list of runs. A run is a range of items that are already
* sorted correctly among themselves. Runs must appear at the beginning of
* the array.
*
* Runs can only be set at the beginning of the sort operation.
**/
void
gtk_tim_sort_set_runs (GtkTimSort *self,
gsize *runs)
{
gsize i;
g_return_if_fail (self);
g_return_if_fail (self->pending_runs == 0);
for (i = 0; runs[i] != 0; i++)
gtk_tim_sort_push_run (self, self->base, runs[i]);
}
/*
* gtk_tim_sort_set_max_merge_size:
* @self: a GtkTimSort
* @max_merge_size: Maximum size of a merge step, 0 for unlimited
*
* Sets the maximum size of a merge step. Every time
* gtk_tim_sort_step() is called and a merge operation has to be
* done, the @max_merge_size will be used to limit the size of
* the merge.
*
* The benefit is that merges happen faster, and if you're using
* an incremental sorting algorithm in the main thread, this will
* limit the runtime.
*
* The disadvantage is that setting up merges is expensive and that
* various optimizations benefit from larger merges, so the total
* runtime of the sorting will increase with the number of merges.
*
* A good estimate is to set a @max_merge_size to 1024 for around
* 1ms runtimes, if your compare function is fast.
*
* By default, max_merge_size is set to unlimited.
**/
void
gtk_tim_sort_set_max_merge_size (GtkTimSort *self,
gsize max_merge_size)
{
g_return_if_fail (self != NULL);
if (max_merge_size == 0)
max_merge_size = G_MAXSIZE;
self->max_merge_size = max_merge_size;
}
/**
* gtk_tim_sort_get_progress:
* @self: a GtkTimSort
*
* Does a progress estimate about sort progress, estimates relative
* to the number of items to sort.
*
* Note that this is entirely a progress estimate and does not have
* a relationship with items put in their correct place.
* It is also an estimate, so no guarantees are made about accuracy,
* other than that it will only report 100% completion when it is
* indeed done sorting.
*
* To get a percentage, you need to divide this number by the total
* number of elements that are being sorted.
*
* Returns: Rough guess of sort progress
**/
gsize
gtk_tim_sort_get_progress (GtkTimSort *self)
{
#define DEPTH 4
gsize i;
gsize last, progress;
g_return_val_if_fail (self != NULL, 0);
if (self->pending_runs == 0)
return 0;
last = self->run[0].len;
progress = 0;
for (i = 1; i < DEPTH + 1 && i < self->pending_runs; i++)
{
progress += (DEPTH + 1 - i) * MAX (last, self->run[i].len);
last = MIN (last, self->run[i].len);
}
if (i < DEPTH + 1)
progress += (DEPTH + 1 - i) * last;
return progress / DEPTH;
#undef DEPTH
}
#if 1
#define WIDTH 4
#include "gtktimsort-impl.c"
#define WIDTH 8
#include "gtktimsort-impl.c"
#define WIDTH 16
#include "gtktimsort-impl.c"
#endif
#define NAME default
#define WIDTH (self->element_size)
#include "gtktimsort-impl.c"
/*
* gtk_tim_sort_step:
* @self: a GtkTimSort
* @out_change: (optional): Return location for changed
* area. If a change did not cause any changes (for example,
* if an already sorted array gets sorted), out_change
* will be set to %NULL and 0.
*
* Performs another step in the sorting process. If a
* step was performed, %TRUE is returned and @out_change is
* set to the smallest area that contains all changes while
* sorting.
*
* If the data is completely sorted, %FALSE will be
* returned.
*
* Returns: %TRUE if an action was performed
**/
gboolean
gtk_tim_sort_step (GtkTimSort *self,
GtkTimSortRun *out_change)
{
gboolean result;
g_assert (self);
switch (self->element_size)
{
case 4:
result = gtk_tim_sort_step_4 (self, out_change);
break;
case 8:
result = gtk_tim_sort_step_8 (self, out_change);
break;
case 16:
result = gtk_tim_sort_step_16 (self, out_change);
break;
default:
result = gtk_tim_sort_step_default (self, out_change);
break;
}
return result;
}

120
src/libsysprof/timsort/gtktimsortprivate.h Normal file
View File

@ -0,0 +1,120 @@
/*
* Copyright © 2020 Benjamin Otte
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <glib-object.h>
/* The maximum number of entries in a GtkTimState's pending-runs stack.
* This is enough to sort arrays of size up to about
* 32 * phi ** GTK_TIM_SORT_MAX_PENDING
* where phi ~= 1.618. 85 is ridiculously large enough, good for an array
* with 2**64 elements.
*/
#define GTK_TIM_SORT_MAX_PENDING 86
typedef struct _GtkTimSort GtkTimSort;
typedef struct _GtkTimSortRun GtkTimSortRun;
struct _GtkTimSortRun
{
void *base;
gsize len;
};
struct _GtkTimSort
{
/*
* Size of elements. Used to decide on fast paths.
*/
gsize element_size;
/* The comparator for this sort.
*/
GCompareDataFunc compare_func;
gpointer data;
/*
* The array being sorted.
*/
gpointer base;
gsize size;
/*
* The maximum size of a merge. It's guaranteed >0 and user-provided.
* See the comments for gtk_tim_sort_set_max_merge_size() for details.
*/
gsize max_merge_size;
/*
* This controls when we get *into* galloping mode. It is initialized
* to MIN_GALLOP. The mergeLo and mergeHi methods nudge it higher for
* random data, and lower for highly structured data.
*/
gsize min_gallop;
/*
* The minimum run length. See compute_min_run() for details.
*/
gsize min_run;
/*
* Temp storage for merges.
*/
void *tmp;
gsize tmp_length;
/*
* A stack of pending runs yet to be merged. Run i starts at
* address base[i] and extends for len[i] elements. It's always
* true (so long as the indices are in bounds) that:
*
* runBase[i] + runLen[i] == runBase[i + 1]
*
* so we could cut the storage for this, but it's a minor amount,
* and keeping all the info explicit simplifies the code.
*/
gsize pending_runs; // Number of pending runs on stack
GtkTimSortRun run[GTK_TIM_SORT_MAX_PENDING];
};
void gtk_tim_sort_init (GtkTimSort *self,
gpointer base,
gsize size,
gsize element_size,
GCompareDataFunc compare_func,
gpointer data);
void gtk_tim_sort_finish (GtkTimSort *self);
void gtk_tim_sort_get_runs (GtkTimSort *self,
gsize runs[GTK_TIM_SORT_MAX_PENDING + 1]);
void gtk_tim_sort_set_runs (GtkTimSort *self,
gsize *runs);
void gtk_tim_sort_set_max_merge_size (GtkTimSort *self,
gsize max_merge_size);
gsize gtk_tim_sort_get_progress (GtkTimSort *self);
gboolean gtk_tim_sort_step (GtkTimSort *self,
GtkTimSortRun *out_change);
void gtk_tim_sort (gpointer base,
gsize size,
gsize element_size,
GCompareDataFunc compare_func,
gpointer user_data);