beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-25 00:50:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ladybird/AK/IntrusiveList.h

306 lines
8.3 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 08:38:21 +00:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
#pragma once
LibCore: Add a forward declaration header This patch adds <LibCore/Forward.h> and uses it in various places to shrink the header dependency graph.
2020-02-14 21:29:06 +00:00
#include <AK/Assertions.h>
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
namespace AK {
class IntrusiveListNode;
class IntrusiveListStorage {
private:
friend class IntrusiveListNode;
template<class T, IntrusiveListNode T::*member>
friend class IntrusiveList;
IntrusiveListNode* m_first { nullptr };
IntrusiveListNode* m_last { nullptr };
};
template<class T, IntrusiveListNode T::*member>
class IntrusiveList {
public:
IntrusiveList();
~IntrusiveList();
void clear();
AK: Annotate IntrusiveList functions as [[nodiscard]]
2021-04-11 08:25:58 +00:00
[[nodiscard]] bool is_empty() const;
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
void append(T& n);
void prepend(T& n);
void remove(T& n);
AK: Annotate IntrusiveList functions as [[nodiscard]]
2021-04-11 08:25:58 +00:00
[[nodiscard]] bool contains(const T&) const;
[[nodiscard]] T* first() const;
[[nodiscard]] T* last() const;
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
AK: Annotate IntrusiveList functions as [[nodiscard]]
2021-04-11 08:25:58 +00:00
[[nodiscard]] T* take_first();
[[nodiscard]] T* take_last();
AK: Add IntrusiveList::take_first()
2019-12-22 11:23:30 +00:00
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
class Iterator {
public:
AK: Add basic const iteration to IntrusiveList
2021-03-11 13:12:33 +00:00
Iterator() = default;
Iterator(T* value)
: m_value(value)
{
}
T& operator*() const { return *m_value; }
T* operator->() const { return m_value; }
bool operator==(const Iterator& other) const { return other.m_value == m_value; }
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
bool operator!=(const Iterator& other) const { return !(*this == other); }
AK: Add basic const iteration to IntrusiveList
2021-03-11 13:12:33 +00:00
Iterator& operator++()
{
m_value = IntrusiveList<T, member>::next(m_value);
return *this;
}
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
Iterator& erase();
private:
T* m_value { nullptr };
};
Iterator begin();
AK: Add basic const iteration to IntrusiveList
2021-03-11 13:12:33 +00:00
Iterator end() { return Iterator {}; }
class ConstIterator {
public:
ConstIterator() = default;
ConstIterator(const T* value)
: m_value(value)
{
}
const T& operator*() const { return *m_value; }
const T* operator->() const { return m_value; }
bool operator==(const ConstIterator& other) const { return other.m_value == m_value; }
bool operator!=(const ConstIterator& other) const { return !(*this == other); }
ConstIterator& operator++()
{
m_value = IntrusiveList<T, member>::next(const_cast<T*>(m_value));
return *this;
}
private:
const T* m_value { nullptr };
};
ConstIterator begin() const;
ConstIterator end() const { return ConstIterator {}; }
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
private:
static T* next(T* current);
static T* node_to_value(IntrusiveListNode& node);
IntrusiveListStorage m_storage;
};
class IntrusiveListNode {
public:
~IntrusiveListNode();
void remove();
bool is_in_list() const;
private:
template<class T, IntrusiveListNode T::*member>
friend class IntrusiveList;
IntrusiveListStorage* m_storage = nullptr;
IntrusiveListNode* m_next = nullptr;
IntrusiveListNode* m_prev = nullptr;
};
template<class T, IntrusiveListNode T::*member>
inline typename IntrusiveList<T, member>::Iterator& IntrusiveList<T, member>::Iterator::erase()
{
T* old = m_value;
m_value = IntrusiveList<T, member>::next(m_value);
(old->*member).remove();
return *this;
}
template<class T, IntrusiveListNode T::*member>
inline IntrusiveList<T, member>::IntrusiveList()
{
}
template<class T, IntrusiveListNode T::*member>
inline IntrusiveList<T, member>::~IntrusiveList()
{
clear();
}
template<class T, IntrusiveListNode T::*member>
inline void IntrusiveList<T, member>::clear()
{
while (m_storage.m_first)
m_storage.m_first->remove();
}
template<class T, IntrusiveListNode T::*member>
inline bool IntrusiveList<T, member>::is_empty() const
{
return m_storage.m_first == nullptr;
}
template<class T, IntrusiveListNode T::*member>
inline void IntrusiveList<T, member>::append(T& n)
{
auto& nnode = n.*member;
if (nnode.m_storage)
nnode.remove();
nnode.m_storage = &m_storage;
nnode.m_prev = m_storage.m_last;
nnode.m_next = nullptr;
if (m_storage.m_last)
m_storage.m_last->m_next = &nnode;
m_storage.m_last = &nnode;
if (!m_storage.m_first)
m_storage.m_first = &nnode;
}
template<class T, IntrusiveListNode T::*member>
inline void IntrusiveList<T, member>::prepend(T& n)
{
auto& nnode = n.*member;
if (nnode.m_storage)
nnode.remove();
nnode.m_storage = &m_storage;
nnode.m_prev = nullptr;
nnode.m_next = m_storage.m_first;
if (m_storage.m_first)
m_storage.m_first->m_prev = &nnode;
m_storage.m_first = &nnode;
if (!m_storage.m_last)
m_storage.m_last = &nnode;
}
template<class T, IntrusiveListNode T::*member>
inline void IntrusiveList<T, member>::remove(T& n)
{
auto& nnode = n.*member;
if (nnode.m_storage)
nnode.remove();
}
template<class T, IntrusiveListNode T::*member>
inline bool IntrusiveList<T, member>::contains(const T& n) const
{
auto& nnode = n.*member;
return nnode.m_storage == &m_storage;
}
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::first() const
{
return m_storage.m_first ? node_to_value(*m_storage.m_first) : nullptr;
}
AK: Add IntrusiveList::take_first()
2019-12-22 11:23:30 +00:00
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::take_first()
{
if (auto* ptr = first()) {
remove(*ptr);
return ptr;
}
return nullptr;
}
AK: Add IntrusiveList::take_last()
2020-11-24 15:37:55 +00:00
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::take_last()
{
if (auto* ptr = last()) {
remove(*ptr);
return ptr;
}
return nullptr;
}
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::last() const
{
return m_storage.m_last ? node_to_value(*m_storage.m_last) : nullptr;
}
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::next(T* current)
{
auto& nextnode = (current->*member).m_next;
T* nextstruct = nextnode ? node_to_value(*nextnode) : nullptr;
return nextstruct;
}
template<class T, IntrusiveListNode T::*member>
inline typename IntrusiveList<T, member>::Iterator IntrusiveList<T, member>::begin()
{
return m_storage.m_first ? Iterator(node_to_value(*m_storage.m_first)) : Iterator();
}
template<class T, IntrusiveListNode T::*member>
AK: Add basic const iteration to IntrusiveList
2021-03-11 13:12:33 +00:00
inline typename IntrusiveList<T, member>::ConstIterator IntrusiveList<T, member>::begin() const
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
{
AK: Add basic const iteration to IntrusiveList
2021-03-11 13:12:33 +00:00
return m_storage.m_first ? ConstIterator(node_to_value(*m_storage.m_first)) : ConstIterator();
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
}
template<class T, IntrusiveListNode T::*member>
inline T* IntrusiveList<T, member>::node_to_value(IntrusiveListNode& node)
{
return (T*)((char*)&node - ((char*)&(((T*)nullptr)->*member) - (char*)nullptr));
}
inline IntrusiveListNode::~IntrusiveListNode()
{
if (m_storage)
remove();
}
inline void IntrusiveListNode::remove()
{
Everywhere: Rename ASSERT => VERIFY (...and ASSERT_NOT_REACHED => VERIFY_NOT_REACHED) Since all of these checks are done in release builds as well, let's rename them to VERIFY to prevent confusion, as everyone is used to assertions being compiled out in release. We can introduce a new ASSERT macro that is specifically for debug checks, but I'm doing this wholesale conversion first since we've accumulated thousands of these already, and it's not immediately obvious which ones are suitable for ASSERT.
2021-02-23 19:42:32 +00:00
VERIFY(m_storage);
AK: Introduce IntrusiveList And use it in the scheduler. IntrusiveList is similar to InlineLinkedList, except that rather than making assertions about the type (and requiring inheritance), it provides an IntrusiveListNode type that can be used to put an instance into many different lists at once. As a proof of concept, port the scheduler over to use it. The only downside here is that the "list" global needs to know the position of the IntrusiveListNode member, so we have to position things a little awkwardly to make that happen. We also move the runnable lists to Thread, to avoid having to publicize the node.
2019-07-19 11:04:42 +00:00
if (m_storage->m_first == this)
m_storage->m_first = m_next;
if (m_storage->m_last == this)
m_storage->m_last = m_prev;
if (m_prev)
m_prev->m_next = m_next;
if (m_next)
m_next->m_prev = m_prev;
m_prev = nullptr;
m_next = nullptr;
m_storage = nullptr;
}
inline bool IntrusiveListNode::is_in_list() const
{
return m_storage != nullptr;
}
}
using AK::IntrusiveList;
using AK::IntrusiveListNode;
Reference in a new issue Copy permalink