gecko-dev/xpcom/ds/nsTArray.cpp
Jens Stutte 989d33f031 Bug 1839051 - Use std::sort for nsTArray and deprecate NS_QuickSort. r=emilio,nika,janv,dom-storage-reviewers
Until now we used our own, well-aged C-style implementation of quick sort, based on code from 1992/93. Apart from being old (which is not bad as such), this code had some
disadvantages, namely:

- It was not typesafe and invocations could not be optimized by inlining.
- [Quick Sort](https://en.wikipedia.org/wiki/Quicksort) has a worst case performance of O(n<sup>2</sup>).
- Quick Sort can recurse deeply and thus cause stack overflows.
- On Windows, [Control Flow Guard](https://learn.microsoft.com/en-us/windows/win32/secbp/control-flow-guard) inspects any function invocation via function pointers to check if the called function was known at compile time. This comes with a [notable overhead](https://bugzilla.mozilla.org/show_bug.cgi?id=1842079) when calling the compare function repeatedly.

`std::sort` and `std::stable_sort` are preferred and have an optimal, guaranteed worst case performance.

Differential Revision: https://phabricator.services.mozilla.com/D181339
2023-12-11 06:53:25 +00:00

28 lines
1.1 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsTArray.h"
#include "nsXPCOM.h"
#include "nsCycleCollectionNoteChild.h"
#include "nsDebug.h"
#include "mozilla/CheckedInt.h"
#include "mozilla/IntegerPrintfMacros.h"
// Ensure this is sufficiently aligned so that Elements() and co don't create
// unaligned pointers, or slices with unaligned pointers for empty arrays, see
// https://github.com/servo/servo/issues/22613.
alignas(8) const nsTArrayHeader sEmptyTArrayHeader = {0, 0, 0};
bool IsTwiceTheRequiredBytesRepresentableAsUint32(size_t aCapacity,
size_t aElemSize) {
using mozilla::CheckedUint32;
return ((CheckedUint32(aCapacity) * aElemSize) * 2).isValid();
}
void ::detail::SetCycleCollectionArrayFlag(uint32_t& aFlags) {
aFlags |= CycleCollectionEdgeNameArrayFlag;
}