mirror of
https://github.com/espressif/openthread.git
synced 2026-07-04 19:30:22 +00:00
Abtin Keshavarzian
d0cf21e3ba
This commit contains the following: - It adds methods to `Message` to assign a priority level to messages. Currently there are four priority levels: High, Medium, Low, VeryLow but this is easily changeable. - It introduces a new class `PriorityQueue` which implements a FIFO queue for storing messages based on their priority level in addition to oder in which they are added. If the priority level of an already queued message in a `PriorityQueue` is changed, the associated queue will automatically move the message within the queue based on its new priority level. Internally the implementation uses a circular doubly linked-list with an array of tail pointers associated with different priority levels. - It adds new methods and an `Iterator` class in `MessagePool` to access the priority queue where all allocated and queued messages from this pool are stored. The `Iterator` class allows bi-directional iteration through the list (from highest priority to lowest or reverse). - This commit also contain detailed unit-test for all the newly added features/methods.
144 lines
6.0 KiB
C++
144 lines
6.0 KiB
C++
/*
|
|
* Copyright (c) 2016, The OpenThread Authors.
|
|
* 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 of the copyright holder 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 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.
|
|
*/
|
|
|
|
#include "test_util.h"
|
|
#include <openthread.h>
|
|
#include <common/debug.hpp>
|
|
#include <common/message.hpp>
|
|
#include <string.h>
|
|
#include <stdarg.h>
|
|
|
|
#define kNumTestMessages 5
|
|
|
|
// This function verifies the content of the message queue to match the passed in messages
|
|
void VerifyMessageQueueContent(Thread::MessageQueue &aMessageQueue, int aExpectedLength, ...)
|
|
{
|
|
va_list args;
|
|
Thread::Message *message;
|
|
Thread::Message *msgArg;
|
|
|
|
va_start(args, aExpectedLength);
|
|
|
|
if (aExpectedLength == 0)
|
|
{
|
|
message = aMessageQueue.GetHead();
|
|
VerifyOrQuit(message == NULL, "MessageQueue is not empty when expected len is zero.\n");
|
|
}
|
|
else
|
|
{
|
|
for (message = aMessageQueue.GetHead(); message != NULL; message = message->GetNext())
|
|
{
|
|
VerifyOrQuit(aExpectedLength != 0, "MessageQueue contains more entries than expected\n");
|
|
|
|
msgArg = va_arg(args, Thread::Message *);
|
|
VerifyOrQuit(msgArg == message, "MessageQueue content does not match what is expected.\n");
|
|
|
|
aExpectedLength--;
|
|
}
|
|
|
|
VerifyOrQuit(aExpectedLength == 0, "MessageQueue contains less entries than expected\n");
|
|
}
|
|
|
|
va_end(args);
|
|
}
|
|
|
|
void TestMessageQueue(void)
|
|
{
|
|
Thread::MessagePool messagePool;
|
|
Thread::MessageQueue messageQueue;
|
|
Thread::Message *msg[kNumTestMessages];
|
|
uint16_t msgCount, bufferCount;
|
|
|
|
for (int i = 0; i < kNumTestMessages; i++)
|
|
{
|
|
msg[i] = messagePool.New(Thread::Message::kTypeIp6, 0);
|
|
VerifyOrQuit(msg[i] != NULL, "Message::New failed\n");
|
|
}
|
|
|
|
VerifyMessageQueueContent(messageQueue, 0);
|
|
|
|
// Enqueue 1 message and remove it
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[0]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 1, msg[0]);
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[0]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 0);
|
|
|
|
// Enqueue 5 messages
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[0]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 1, msg[0]);
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[1]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 2, msg[0], msg[1]);
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[2]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 3, msg[0], msg[1], msg[2]);
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[3]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 4, msg[0], msg[1], msg[2], msg[3]);
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[4]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 5, msg[0], msg[1], msg[2], msg[3], msg[4]);
|
|
|
|
// Check the GetInfo()
|
|
messageQueue.GetInfo(msgCount, bufferCount);
|
|
VerifyOrQuit(msgCount == 5, "MessageQueue::GetInfo() failed.\n");
|
|
|
|
// Remove from head
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[0]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 4, msg[1], msg[2], msg[3], msg[4]);
|
|
|
|
// Remove a message in middle
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[3]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 3, msg[1], msg[2], msg[4]);
|
|
|
|
// Remove from tail
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[4]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 2, msg[1], msg[2]);
|
|
|
|
// Add after removes
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[0]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 3, msg[1], msg[2], msg[0]);
|
|
SuccessOrQuit(messageQueue.Enqueue(*msg[3]), "MessageQueue::Enqueue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 4, msg[1], msg[2], msg[0], msg[3]);
|
|
|
|
// Remove all messages
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[2]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 3, msg[1], msg[0], msg[3]);
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[1]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 2, msg[0], msg[3]);
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[3]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 1, msg[0]);
|
|
SuccessOrQuit(messageQueue.Dequeue(*msg[0]), "MessageQueue::Dequeue() failed.\n");
|
|
VerifyMessageQueueContent(messageQueue, 0);
|
|
}
|
|
|
|
#ifdef ENABLE_TEST_MAIN
|
|
int main(void)
|
|
{
|
|
TestMessageQueue();
|
|
printf("All tests passed\n");
|
|
return 0;
|
|
}
|
|
#endif
|