ofswitch13-priority-queue.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2019 University of Campinas (Unicamp)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Luciano Jerez Chaves <ljerezchaves@gmail.com>
 */
 
#include "ofswitch13-priority-queue.h"
 
#include "ns3/log.h"
#include "ns3/string.h"
 
#undef NS_LOG_APPEND_CONTEXT
#define NS_LOG_APPEND_CONTEXT                                                  \
    std::clog << "[dp " << m_dpId << " port " << m_portNo << "] ";
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("OFSwitch13PriorityQueue");
NS_OBJECT_ENSURE_REGISTERED(OFSwitch13PriorityQueue);
 
static ObjectFactory
GetDefaultQueueFactory()
{
    // Setting default internal queue configuration.
    ObjectFactory queueFactory;
    queueFactory.SetTypeId("ns3::DropTailQueue<Packet>");
    queueFactory.Set("MaxSize", StringValue("100p"));
    return queueFactory;
}
 
TypeId
OFSwitch13PriorityQueue::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::OFSwitch13PriorityQueue")
            .SetParent<OFSwitch13Queue>()
            .SetGroupName("OFSwitch13")
            .AddConstructor<OFSwitch13PriorityQueue>()
            .AddAttribute(
                "NumQueues",
                "The number of internal priority queues.",
                TypeId::ATTR_GET | TypeId::ATTR_CONSTRUCT,
                UintegerValue(1),
                MakeUintegerAccessor(&OFSwitch13PriorityQueue::m_numQueues),
                MakeUintegerChecker<int>(1, PORT_MAX_QUEUES))
            .AddAttribute("QueueFactory",
                          "The object factory for internal priority queues.",
                          TypeId::ATTR_GET | TypeId::ATTR_CONSTRUCT,
                          ObjectFactoryValue(GetDefaultQueueFactory()),
                          MakeObjectFactoryAccessor(
                              &OFSwitch13PriorityQueue::m_facQueues),
                          MakeObjectFactoryChecker());
    return tid;
}
 
OFSwitch13PriorityQueue::OFSwitch13PriorityQueue()
    : OFSwitch13Queue(),
      NS_LOG_TEMPLATE_DEFINE("OFSwitch13PriorityQueue")
{
    NS_LOG_FUNCTION(this);
}
 
OFSwitch13PriorityQueue::~OFSwitch13PriorityQueue()
{
    NS_LOG_FUNCTION(this);
}
 
Ptr<Packet>
OFSwitch13PriorityQueue::Dequeue()
{
    NS_LOG_FUNCTION(this);
 
    int queueId = GetNonEmptyQueue();
    if (queueId >= 0)
    {
        NS_LOG_DEBUG("Packet to be dequeued from queue " << queueId);
        Ptr<Packet> packet = GetQueue(queueId)->Dequeue();
        NotifyDequeue(packet);
        return packet;
    }
 
    NS_LOG_DEBUG("Queue empty");
    return nullptr;
}
 
Ptr<Packet>
OFSwitch13PriorityQueue::Remove()
{
    NS_LOG_FUNCTION(this);
 
    int queueId = GetNonEmptyQueue();
    if (queueId >= 0)
    {
        NS_LOG_DEBUG("Packet to be removed from queue " << queueId);
        Ptr<Packet> packet = GetQueue(queueId)->Remove();
        NotifyRemove(packet);
        return packet;
    }
 
    NS_LOG_DEBUG("Queue empty");
    return nullptr;
}
 
Ptr<const Packet>
OFSwitch13PriorityQueue::Peek() const
{
    NS_LOG_FUNCTION(this);
 
    int queueId = GetNonEmptyQueue();
    if (queueId >= 0)
    {
        NS_LOG_DEBUG("Packet to be peeked from queue " << queueId);
        return GetQueue(queueId)->Peek();
    }
 
    NS_LOG_DEBUG("Queue empty");
    return nullptr;
}
 
void
OFSwitch13PriorityQueue::DoInitialize()
{
    NS_LOG_FUNCTION(this);
 
    // Creating the internal priority queues.
    for (int queueId = 0; queueId < m_numQueues; queueId++)
    {
        AddQueue(m_facQueues.Create<Queue<Packet>>());
    }
 
    // Chain up.
    OFSwitch13Queue::DoInitialize();
}
 
int
OFSwitch13PriorityQueue::GetNonEmptyQueue() const
{
    NS_LOG_FUNCTION(this);
 
    for (int queueId = 0; queueId < GetNQueues(); queueId++)
    {
        if (GetQueue(queueId)->IsEmpty() == false)
        {
            return queueId;
        }
    }
 
    NS_LOG_DEBUG("All internal queues are empty.");
    return -1;
}
 
} // namespace ns3