fq-cobalt-queue-disc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
 * Copyright (c) 2020 NITK Surathkal (adapted for COBALT)
 *
 * 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
 *
 * Authors: Pasquale Imputato <p.imputato@gmail.com>
 *          Stefano Avallone <stefano.avallone@unina.it>
 * Modified by: Bhaskar Kataria <bhaskar.k7920@gmail.com> (for COBALT)
 *          Tom Henderson <tomhend@u.washington.edu>
 *          Mohit P. Tahiliani <tahiliani@nitk.edu.in>
 *          Vivek Jain <jain.vivek.anand@gmail.com>
 *          Ankit Deepak <adadeepak8@gmail.com>
 */
 
#ifndef FQ_COBALT_QUEUE_DISC
#define FQ_COBALT_QUEUE_DISC
 
#include "ns3/object-factory.h"
#include "ns3/queue-disc.h"
 
#include <list>
#include <map>
 
namespace ns3
{
 
class FqCobaltFlow : public QueueDiscClass
{
  public:
    static TypeId GetTypeId();
    FqCobaltFlow();
 
    ~FqCobaltFlow() override;
 
    enum FlowStatus
    {
        INACTIVE,
        NEW_FLOW,
        OLD_FLOW
    };
 
    void SetDeficit(uint32_t deficit);
    int32_t GetDeficit() const;
    void IncreaseDeficit(int32_t deficit);
    void SetStatus(FlowStatus status);
    FlowStatus GetStatus() const;
    void SetIndex(uint32_t index);
    uint32_t GetIndex() const;
 
  private:
    int32_t m_deficit;   
    FlowStatus m_status; 
    uint32_t m_index;    
};
 
class FqCobaltQueueDisc : public QueueDisc
{
  public:
    static TypeId GetTypeId();
    FqCobaltQueueDisc();
 
    ~FqCobaltQueueDisc() override;
 
    void SetQuantum(uint32_t quantum);
 
    uint32_t GetQuantum() const;
 
    // Reasons for dropping packets
    static constexpr const char* UNCLASSIFIED_DROP =
        "Unclassified drop"; 
    static constexpr const char* OVERLIMIT_DROP = "Overlimit drop"; 
 
  private:
    bool DoEnqueue(Ptr<QueueDiscItem> item) override;
    Ptr<QueueDiscItem> DoDequeue() override;
    bool CheckConfig() override;
    void InitializeParams() override;
 
    uint32_t FqCobaltDrop();
 
    uint32_t SetAssociativeHash(uint32_t flowHash);
 
    std::string m_interval;   
    std::string m_target;     
    uint32_t m_quantum;       
    uint32_t m_flows;         
    uint32_t m_setWays;       
    uint32_t m_dropBatchSize; 
    uint32_t m_perturbation;  
    bool m_useEcn;            
    Time m_ceThreshold;       
    bool m_enableSetAssociativeHash; 
    bool m_useL4s;        
    double m_increment;   
    double m_decrement;   
    double m_Pdrop;       
    Time m_blueThreshold; 
 
    std::list<Ptr<FqCobaltFlow>> m_newFlows; 
    std::list<Ptr<FqCobaltFlow>> m_oldFlows; 
 
    std::map<uint32_t, uint32_t> m_flowsIndices; 
    std::map<uint32_t, uint32_t> m_tags;         
 
    ObjectFactory m_flowFactory;      
    ObjectFactory m_queueDiscFactory; 
};
 
} // namespace ns3
 
#endif /* FQ_COBALT_QUEUE_DISC */