error-model.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007 University of Washington
 * Copyright (c) 2013 ResiliNets, ITTC, University of Kansas
 *
 * 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
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright (c) 1997 Regents of the University of California.
 * 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 University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
 *
 * Contributed by the Daedalus Research Group, UC Berkeley
 * (http://daedalus.cs.berkeley.edu)
 *
 * This code has been ported from ns-2 (queue/errmodel.{cc,h}
 */
 
/* BurstErrorModel additions
 *
 * Author: Truc Anh N. Nguyen   <annguyen@ittc.ku.edu>
 *         ResiliNets Research Group   https://resilinets.org/
 *         James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
 */
 
#ifndef ERROR_MODEL_H
#define ERROR_MODEL_H
 
#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
 
#include <list>
 
namespace ns3
{
 
class Packet;
 
class ErrorModel : public Object
{
  public:
    static TypeId GetTypeId();
 
    ErrorModel();
    ~ErrorModel() override;
 
    bool IsCorrupt(Ptr<Packet> pkt);
    void Reset();
    void Enable();
    void Disable();
    bool IsEnabled() const;
 
  private:
    virtual bool DoCorrupt(Ptr<Packet> p) = 0;
    virtual void DoReset() = 0;
 
    bool m_enable; 
};
 
class RateErrorModel : public ErrorModel
{
  public:
    static TypeId GetTypeId();
 
    RateErrorModel();
    ~RateErrorModel() override;
 
    enum ErrorUnit
    {
        ERROR_UNIT_BIT,
        ERROR_UNIT_BYTE,
        ERROR_UNIT_PACKET
    };
 
    RateErrorModel::ErrorUnit GetUnit() const;
    void SetUnit(ErrorUnit error_unit);
 
    double GetRate() const;
    void SetRate(double rate);
 
    void SetRandomVariable(Ptr<RandomVariableStream>);
 
    int64_t AssignStreams(int64_t stream);
 
  private:
    bool DoCorrupt(Ptr<Packet> p) override;
    virtual bool DoCorruptPkt(Ptr<Packet> p);
    virtual bool DoCorruptByte(Ptr<Packet> p);
    virtual bool DoCorruptBit(Ptr<Packet> p);
    void DoReset() override;
 
    ErrorUnit m_unit; 
    double m_rate;    
 
    Ptr<RandomVariableStream> m_ranvar; 
};
 
class BurstErrorModel : public ErrorModel
{
  public:
    static TypeId GetTypeId();
 
    BurstErrorModel();
    ~BurstErrorModel() override;
 
    double GetBurstRate() const;
    void SetBurstRate(double rate);
 
    void SetRandomVariable(Ptr<RandomVariableStream> ranVar);
 
    void SetRandomBurstSize(Ptr<RandomVariableStream> burstSz);
 
    int64_t AssignStreams(int64_t stream);
 
  private:
    bool DoCorrupt(Ptr<Packet> p) override;
    void DoReset() override;
 
    double m_burstRate;                     
    Ptr<RandomVariableStream> m_burstStart; 
    Ptr<RandomVariableStream> m_burstSize;  
 
    uint32_t m_counter;
    uint32_t m_currentBurstSz; 
};
 
class ListErrorModel : public ErrorModel
{
  public:
    static TypeId GetTypeId();
    ListErrorModel();
    ~ListErrorModel() override;
 
    std::list<uint64_t> GetList() const;
    void SetList(const std::list<uint64_t>& packetlist);
 
  private:
    bool DoCorrupt(Ptr<Packet> p) override;
    void DoReset() override;
 
    typedef std::list<uint64_t> PacketList;
    typedef std::list<uint64_t>::const_iterator PacketListCI;
 
    PacketList m_packetList; 
};
 
class ReceiveListErrorModel : public ErrorModel
{
  public:
    static TypeId GetTypeId();
    ReceiveListErrorModel();
    ~ReceiveListErrorModel() override;
 
    std::list<uint32_t> GetList() const;
    void SetList(const std::list<uint32_t>& packetlist);
 
  private:
    bool DoCorrupt(Ptr<Packet> p) override;
    void DoReset() override;
 
    typedef std::list<uint32_t> PacketList;
    typedef std::list<uint32_t>::const_iterator PacketListCI;
 
    PacketList m_packetList; 
    uint32_t m_timesInvoked; 
};
 
class BinaryErrorModel : public ErrorModel
{
  public:
    static TypeId GetTypeId();
 
    BinaryErrorModel();
    ~BinaryErrorModel() override;
 
  private:
    bool DoCorrupt(Ptr<Packet> p) override;
    void DoReset() override;
 
    uint8_t m_counter; 
};
 
} // namespace ns3
#endif