New Vector_sort function, replacing insertion and quick sort

Introduce the new Vector_sort() function and obsolete the old
Vector_quickSortCustomCompare() and Vector_insertionSort() APIs.

This new sort function is a natural, in-place merge sort. I.e. it takes
advantage of partially sorted data, and it's stable.

Space complexity: O(log(n)) worst case (on stack, no malloc())
Time complexity: O(n) best case, O(n*(log(n))^2) average & worst case

Signed-off-by: Kang-Che Sung <explorer09@gmail.com>

Author: Explorer09

Action.c

@@ -542,7 +542,7 @@ static Htop_Reaction actionFilterByUser(State* st) {
    Panel_setHeader(usersPanel, "Show processes of:");
    Machine* host = st->host;
    UsersTable_foreach(host->usersTable, addUserToVector, usersPanel);
-   Vector_insertionSort(usersPanel->items);
+   Vector_sort(usersPanel->items, NULL);
    ListItem* allUsers = ListItem_new("All users", -1);
    Panel_insert(usersPanel, 0, (Object*) allUsers);
    const ListItem* picked = (ListItem*) Action_pickFromVector(st, usersPanel, 19, false);

EnvScreen.c

@@ -52,8 +52,8 @@ static void EnvScreen_scan(InfoScreen* this) {
       InfoScreen_addLine(this, "Could not read process environment.");
    }
 
-   Vector_insertionSort(this->lines);
-   Vector_insertionSort(panel->items);
+   Vector_sort(this->lines, NULL);
+   Vector_sort(panel->items, NULL);
    Panel_setSelected(panel, idx);
 }
 

OpenFilesScreen.c

@@ -300,8 +300,8 @@ static void OpenFilesScreen_scan(InfoScreen* super) {
       OpenFiles_Data_clear(&pdata->data);
    }
    free(pdata);
-   Vector_insertionSort(super->lines);
-   Vector_insertionSort(panel->items);
+   Vector_sort(super->lines, NULL);
+   Vector_sort(panel->items, NULL);
    Panel_setSelected(panel, idx);
 }
 

ProcessLocksScreen.c

@@ -91,8 +91,8 @@ static void ProcessLocksScreen_scan(InfoScreen* this) {
       }
    }
    free(pdata);
-   Vector_insertionSort(this->lines);
-   Vector_insertionSort(panel->items);
+   Vector_sort(this->lines, NULL);
+   Vector_sort(panel->items, NULL);
    Panel_setSelected(panel, idx);
 }
 

Table.c

@@ -168,7 +168,7 @@ static void Table_buildTree(Table* this) {
    }
 
    // Sort by known parent (roots first), then row ID
-   Vector_quickSortCustomCompare(this->rows, compareRowByKnownParentThenNatural);
+   Vector_sort(this->rows, compareRowByKnownParentThenNatural);
 
    // Find all processes whose parent is not visible
    for (int i = 0; i < vsize; i++) {
@@ -199,7 +199,7 @@ void Table_updateDisplayList(Table* this) {
          Table_buildTree(this);
    } else {
       if (this->needsSort)
-         Vector_insertionSort(this->rows);
+         Vector_sort(this->rows, NULL);
       Vector_prune(this->displayList);
       int size = Vector_size(this->rows);
       for (int i = 0; i < size; i++)

Vector.c

@@ -10,12 +10,19 @@ in the source distribution for its full text.
 #include "Vector.h"
 
 #include <assert.h>
+#include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include "XUtils.h"
 
 
+typedef int(*CompareWithContext)(const void*, const void*, void*);
+
+typedef struct VectorSortContext_ {
+   Object_Compare compare;
+} VectorSortContext;
+
 Vector* Vector_new(const ObjectClass* type, bool owner, int size) {
    Vector* this;
 
@@ -93,91 +100,167 @@ void Vector_prune(Vector* this) {
    memset(this->array, '\0', this->arraySize * sizeof(Object*));
 }
 
-//static int comparisons = 0;
-
-static void swap(Object** array, int indexA, int indexB) {
-   assert(indexA >= 0);
-   assert(indexB >= 0);
-   Object* tmp = array[indexA];
-   array[indexA] = array[indexB];
-   array[indexB] = tmp;
+ATTR_NONNULL
+static void swapByte(char* p1, char* p2) {
+    char temp = *p1;
+    *p1 = *p2;
+    *p2 = temp;
 }
 
-static int partition(Object** array, int left, int right, int pivotIndex, Object_Compare compare) {
-   const Object* pivotValue = array[pivotIndex];
-   swap(array, pivotIndex, right);
-   int storeIndex = left;
-   for (int i = left; i < right; i++) {
-      //comparisons++;
-      if (compare(array[i], pivotValue) <= 0) {
-         swap(array, i, storeIndex);
-         storeIndex++;
+ATTR_NONNULL
+static void rotate(void* buffer, size_t leftSize, size_t rightSize) {
+   if (rightSize == 0)
+      return;
+
+   char* p1 = buffer;
+   char* p2 = p1 + leftSize;
+   char* mid = p2;
+   const char* const end = mid + rightSize;
+
+   while (true) {
+      // Ensure there is no arithmetic overflow on input.
+      assert(p1 <= mid);
+      assert(mid <= p2);
+      assert(p2 <= end);
+
+      if (p2 >= end) {
+         assert(mid < end);
+         p2 = mid;
       }
+
+      if (p1 >= p2)
+         break;
+
+      if (p1 >= mid)
+         mid = p2;
+
+      swapByte(p1, p2);
+      p1 += 1;
+      p2 += 1;
    }
-   swap(array, storeIndex, right);
-   return storeIndex;
 }
 
-static void quickSort(Object** array, int left, int right, Object_Compare compare) {
-   if (left >= right)
+ATTR_NONNULL_N(1, 5)
+static void mergeRuns(void* array, size_t leftLen, size_t rightLen, size_t size, CompareWithContext compare, void* context) {
+   assert(size > 0);
+   if (leftLen == 0 || rightLen == 0 || size == 0)
       return;
 
-   int pivotIndex = left + (right - left) / 2;
-   int pivotNewIndex = partition(array, left, right, pivotIndex, compare);
-   quickSort(array, left, pivotNewIndex - 1, compare);
-   quickSort(array, pivotNewIndex + 1, right, compare);
-}
+   assert(leftLen <= SIZE_MAX / size);
+   assert(rightLen <= SIZE_MAX / size);
 
-// If I were to use only one sorting algorithm for both cases, it would probably be this one:
-/*
+   char* p1 = array;
+   char* p2 = p1 + leftLen * size;
+   char* mid = p2;
+   const char* const end = mid + rightLen * size;
 
-static void combSort(Object** array, int left, int right, Object_Compare compare) {
-   int gap = right - left;
-   bool swapped = true;
-   while ((gap > 1) || swapped) {
-      if (gap > 1) {
-         gap = (int)((double)gap / 1.247330950103979);
-      }
-      swapped = false;
-      for (int i = left; gap + i <= right; i++) {
-         comparisons++;
-         if (compare(array[i], array[i+gap]) > 0) {
-            swap(array, i, i+gap);
-            swapped = true;
-         }
+   for (size_t limit = (leftLen + rightLen) / 2; limit > 0; limit--) {
+      // Ensure there is no arithmetic overflow on input.
+      assert(p1 <= mid);
+      assert(mid <= p2);
+      assert(p2 <= end);
+
+      if (p1 >= mid || p2 >= end)
+         break;
+
+      if (compare(p1, p2, context) <= 0) {
+         p1 += size;
+      } else {
+         p2 += size;
       }
    }
-}
 
-*/
+   rotate(p1, (size_t)(mid - p1), (size_t)(p2 - mid));
+
+   leftLen = (size_t)(p1 - (char*)array) / size;
+   rightLen = (size_t)(p2 - mid) / size;
+   mergeRuns(array, leftLen, rightLen, size, compare, context);
 
-static void insertionSort(Object** array, int left, int right, Object_Compare compare) {
-   for (int i = left + 1; i <= right; i++) {
-      Object* t = array[i];
-      int j = i - 1;
-      while (j >= left) {
-         //comparisons++;
-         if (compare(array[j], t) <= 0)
+   leftLen = (size_t)(mid - p1) / size;
+   rightLen = (size_t)(end - p2) / size;
+   mergeRuns(p1 + (p2 - mid), leftLen, rightLen, size, compare, context);
+}
+
+ATTR_NONNULL_N(1, 5)
+static size_t mergeSortSubarray(void* array, size_t unsortedLen, size_t limit, size_t size, CompareWithContext compare, void* context) {
+   assert(size > 0);
+   if (size == 0)
+      return 0;
+
+   // The initial level of this function call must set "limit" to 0. Subsequent
+   // levels of recursion will have "limit" no less than the previous level.
+
+   // A run is a sorted subarray. Each recursive call of this function keeps
+   // the lengths of two runs. At most O(log(n)) lengths of runs will be
+   // tracked on the call stack.
+   size_t runLen[3] = {0};
+   while (unsortedLen > 0) {
+      size_t totalLen = unsortedLen;
+      assert(totalLen <= SIZE_MAX / size);
+      while (true) {
+         --unsortedLen;
+
+         const char* p2 = (const char*)array + unsortedLen * size;
+         // Ensure there is no arithmetic overflow on input.
+         assert(p2 > (const char*)array);
+
+         if (unsortedLen < limit)
+            return 0;
+
+         if (unsortedLen == 0 || compare(p2 - 1 * size, p2, context) > 0) {
             break;
+         }
+      }
+      runLen[1] = totalLen - unsortedLen;
+
+      bool reachesLimit = false;
+
+      assert(runLen[2] > 0 || runLen[0] == 0);
+      if (runLen[2] > 0) {
+         size_t nextLimit = limit;
+         if (unsortedLen > runLen[2] + limit) {
+            nextLimit = unsortedLen - runLen[2];
+         } else {
+            reachesLimit = true;
+         }
+
+         runLen[0] = mergeSortSubarray(array, unsortedLen, nextLimit, size, compare, context);
+         unsortedLen -= runLen[0];
+
+         char* p1 = (char*)array + unsortedLen * size;
+         mergeRuns(p1, runLen[0], runLen[1], size, compare, context);
+         runLen[1] += runLen[0];
+         runLen[0] = 0;
 
-         array[j + 1] = array[j];
-         j--;
+         mergeRuns(p1, runLen[1], runLen[2], size, compare, context);
+      }
+      runLen[2] += runLen[1];
+      runLen[1] = 0;
+
+      if (reachesLimit) {
+         break;
       }
-      array[j + 1] = t;
    }
+   return runLen[2];
 }
 
-void Vector_quickSortCustomCompare(Vector* this, Object_Compare compare) {
-   assert(compare);
-   assert(Vector_isConsistent(this));
-   quickSort(this->array, 0, this->items - 1, compare);
-   assert(Vector_isConsistent(this));
+ATTR_NONNULL
+static int Vector_sortCompare(const void* p1, const void* p2, void* context) {
+   VectorSortContext* vc = (VectorSortContext*) context;
+
+   return vc->compare(*(const void* const*)p1, *(const void* const*)p2);
 }
 
-void Vector_insertionSort(Vector* this) {
-   assert(this->type->compare);
+ATTR_NONNULL_N(1)
+void Vector_sort(Vector* this, Object_Compare compare) {
+   VectorSortContext vc = {
+      .compare = compare ? compare : this->type->compare,
+   };
+   assert(vc.compare);
    assert(Vector_isConsistent(this));
-   insertionSort(this->array, 0, this->items - 1, this->type->compare);
+
+   (void)mergeSortSubarray(this->array, this->items, 0, sizeof(*this->array), Vector_sortCompare, &vc);
+
    assert(Vector_isConsistent(this));
 }
 

Vector.h

@@ -35,12 +35,7 @@ void Vector_delete(Vector* this);
 
 void Vector_prune(Vector* this);
 
-void Vector_quickSortCustomCompare(Vector* this, Object_Compare compare);
-static inline void Vector_quickSort(Vector* this) {
-   Vector_quickSortCustomCompare(this, this->type->compare);
-}
-
-void Vector_insertionSort(Vector* this);
+void Vector_sort(Vector* this, Object_Compare compare);
 
 void Vector_insert(Vector* this, int idx, void* data_);