new IntrusiveSortedList container used for uORB, WorkQueues, and WorkItems

- new intrusive linked list container (c++ template) that sorts on insertion
 - primarily for convenience inspecting things in the system like uORB or WorkQueues
 - uorb status or top sorted alphabetically 
 - work_queue status threads sorted by priority, then items sorted alphabetically within each
This commit is contained in:
Daniel Agar
2020-08-04 11:09:41 -04:00
committed by GitHub
parent dfc2160489
commit b6a17a6538
11 changed files with 502 additions and 13 deletions
+6 -6
View File
@@ -39,14 +39,14 @@
#pragma once
#include "List.hpp"
#include "IntrusiveSortedList.hpp"
#include "LockGuard.hpp"
#include <pthread.h>
#include <stdlib.h>
template<class T>
class BlockingList : public List<T>
class BlockingList : public IntrusiveSortedList<T>
{
public:
@@ -59,25 +59,25 @@ public:
void add(T newNode)
{
LockGuard lg{_mutex};
List<T>::add(newNode);
IntrusiveSortedList<T>::add(newNode);
}
bool remove(T removeNode)
{
LockGuard lg{_mutex};
return List<T>::remove(removeNode);
return IntrusiveSortedList<T>::remove(removeNode);
}
size_t size()
{
LockGuard lg{_mutex};
return List<T>::size();
return IntrusiveSortedList<T>::size();
}
void clear()
{
LockGuard lg{_mutex};
List<T>::clear();
IntrusiveSortedList<T>::clear();
}
pthread_mutex_t &mutex() { return _mutex; }
@@ -0,0 +1,187 @@
/****************************************************************************
*
* Copyright (C) 2020 PX4 Development Team. 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.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* 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 OWNER 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.
*
****************************************************************************/
/**
* @file IntrusiveSortedList.hpp
*
* An intrusive linked list where nodes are sorted on insertion.
*/
#pragma once
#include <stdlib.h>
template<class T>
class IntrusiveSortedListNode
{
public:
void setSortedSibling(T sibling) { _sorted_list_node_sibling = sibling; }
const T getSortedSibling() const { return _sorted_list_node_sibling; }
protected:
T _sorted_list_node_sibling{nullptr};
};
template<class T>
class IntrusiveSortedList
{
public:
void add(T newNode)
{
if (_head == nullptr) {
// list is empty, add as head
_head = newNode;
return;
} else {
if (*newNode <= *_head) {
newNode->setSortedSibling(_head);
_head = newNode;
return;
}
// find last node and add to end
T node = _head;
while (node != nullptr && node->getSortedSibling() != nullptr) {
if (*newNode <= *node->getSortedSibling()) {
// insert newNode
newNode->setSortedSibling(node->getSortedSibling());
node->setSortedSibling(newNode);
return;
}
node = node->getSortedSibling();
}
// reached the end, add
node->setSortedSibling(newNode);
}
}
bool remove(T removeNode)
{
if (removeNode == nullptr) {
return false;
}
// base case
if (removeNode == _head) {
if (_head != nullptr) {
_head = _head->getSortedSibling();
}
removeNode->setSortedSibling(nullptr);
return true;
}
for (T node = _head; node != nullptr; node = node->getSortedSibling()) {
// is sibling the node to remove?
if (node->getSortedSibling() == removeNode) {
// replace sibling
if (node->getSortedSibling() != nullptr) {
node->setSortedSibling(node->getSortedSibling()->getSortedSibling());
} else {
node->setSortedSibling(nullptr);
}
removeNode->setSortedSibling(nullptr);
return true;
}
}
return false;
}
struct Iterator {
T node;
explicit Iterator(T v) : node(v) {}
operator T() const { return node; }
operator T &() { return node; }
T operator* () const { return node; }
Iterator &operator++ ()
{
if (node) {
node = node->getSortedSibling();
};
return *this;
}
};
Iterator begin() { return Iterator(_head); }
Iterator end() { return Iterator(nullptr); }
bool empty() const { return _head == nullptr; }
size_t size() const
{
size_t sz = 0;
for (T node = _head; node != nullptr; node = node->getSortedSibling()) {
sz++;
}
return sz;
}
void deleteNode(T node)
{
if (remove(node)) {
// only delete if node was successfully removed
delete node;
}
}
void clear()
{
T node = _head;
while (node != nullptr) {
T next = node->getSortedSibling();
delete node;
node = next;
}
_head = nullptr;
}
protected:
T _head{nullptr};
};