A simple flooding protocol. More...

#include <Flooding.h>

Inheritance diagram for inet::Flooding:

Classes
class	Bcast

Public Member Functions
	Flooding ()

virtual int	numInitStages () const override
	Initialization of omnetpp.ini parameters. More...

virtual void	initialize (int) override
	Reads all parameters from the ini file. More...

virtual void	finish () override

const Protocol &	getProtocol () const override

Public Member Functions inherited from inet::NetworkProtocolBase
virtual void	handleRegisterService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...

Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Public Member Functions inherited from inet::DefaultProtocolRegistrationListener
virtual void	handleRegisterServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyService (cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) override

Public Member Functions inherited from inet::INetworkProtocol
virtual	~INetworkProtocol ()

Protected Types
typedef std::list< Bcast >	cBroadcastList

Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	handleUpperPacket (Packet *packet) override
	Handle messages from upper layer. More...

virtual void	handleLowerPacket (Packet *packet) override
	Handle messages from lower layer. More...

bool	notBroadcasted (const FloodingHeader *)
	Checks whether a message was already broadcasted. More...

void	decapsulate (Packet *packet)
	Decapsulates the packet from the received Network packet. More...

void	encapsulate (Packet *packet)
	Encapsulates the received ApplPkt into a NetwPkt and set all needed header fields. More...

virtual void	setDownControlInfo (Packet *const pMsg, const MacAddress &pDestAddr)
	Attaches a "control info" (NetwToMac) structure (object) to the message pMsg. More...

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

Protected Member Functions inherited from inet::NetworkProtocolBase
	NetworkProtocolBase ()

virtual	~NetworkProtocolBase ()

virtual void	sendUp (cMessage *message)

virtual void	sendDown (cMessage *message, int interfaceId=-1)

virtual bool	isUpperMessage (cMessage *message) const override

virtual bool	isLowerMessage (cMessage *message) const override

virtual bool	isInitializeStage (int stage) const override

virtual bool	isModuleStartStage (int stage) const override

virtual bool	isModuleStopStage (int stage) const override

virtual void	handleUpperCommand (cMessage *msg) override

Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleMessageWhenUp (cMessage *message) override

virtual void	handleSelfMessage (cMessage *message)

virtual void	handleUpperMessage (cMessage *message)

virtual void	handleLowerMessage (cMessage *message)

virtual void	handleLowerCommand (cMessage *message)

Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override

virtual void	refreshDisplay () const override

virtual void	handleMessage (cMessage *msg) override

virtual void	handleMessageWhenDown (cMessage *msg)

virtual bool	handleOperationStage (LifecycleOperation operation, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...

virtual void	handleActiveOperationTimeout (cMessage *message)

virtual bool	isUp () const
	utility functions More...

virtual bool	isDown () const

virtual void	setOperationalState (State newState)

virtual void	scheduleOperationTimeout (simtime_t timeout)

virtual void	setupActiveOperation (LifecycleOperation operation, IDoneCallback doneCallback, State)

virtual void	delayActiveOperationFinish (simtime_t timeout)

virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)

virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)

virtual void	finishActiveOperation ()

Protected Attributes
unsigned long	seqNum = 0
	Network layer sequence number. More...

L3Address	myNetwAddr
	cached variable of my networ address More...

int	headerLength = 0
	Length of the header. More...

int	defaultTtl = 0
	Default time-to-live (ttl) used for this module. More...

bool	plainFlooding = false
	Defines whether to use plain flooding or not. More...

cBroadcastList	bcMsgs
	List of already broadcasted messages. More...

unsigned int	bcMaxEntries = 0
	Max number of entries in the list of already broadcasted messages. More...

simtime_t	bcDelTime
	Time after which an entry for an already broadcasted msg can be deleted. More...

long	nbDataPacketsReceived = 0

long	nbDataPacketsSent = 0

long	nbDataPacketsForwarded = 0

long	nbHops = 0

Protected Attributes inherited from inet::NetworkProtocolBase
ModuleRefByPar< IInterfaceTable >	interfaceTable

std::set< const Protocol * >	upperProtocols

std::map< int, SocketDescriptor * >	socketIdToSocketDescriptor

Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout

cMessage *	activeOperationExtraTimer

Detailed Description

A simple flooding protocol.

This implementation uses plain flooding, i.e. it "remembers" (stores) already broadcasted messages in a list and does not rebroadcast them again, if it gets another copy of that message.

The maximum number of entires for that list can be defined in the .ini file (bcMaxEntries) as well as the time after which an entry is deleted (bcDelTime).

If you prefere a memory-less version you can comment out the

#define PLAINFLOODING

Author: Daniel Willkomm

ported to Mixim 2.0 by Theodoros Kapourniotis

Member Typedef Documentation

◆ cBroadcastList

typedef std::list<Bcast> inet::Flooding::cBroadcastList

protected

Constructor & Destructor Documentation

◆ Flooding()

inet::Flooding::Flooding ( )

inline

106 {}

Member Function Documentation

◆ decapsulate()

void inet::Flooding::decapsulate ( Packet * packet )

protected

Decapsulates the packet from the received Network packet.

 {
     auto floodHeader = packet->popAtFront<FloodingHeader>();
     auto payloadLength = floodHeader->getPayloadLengthField();
     if (packet->getDataLength() < payloadLength) {
         throw cRuntimeError("Data error: illegal payload length"); // FIXME packet drop
     }
     if (packet->getDataLength() > payloadLength)
         packet->setBackOffset(packet->getFrontOffset() + payloadLength);
     auto payloadProtocol = floodHeader->getProtocol();
     packet->addTagIfAbsent<NetworkProtocolInd>()->setProtocol(&getProtocol());
     packet->addTagIfAbsent<NetworkProtocolInd>()->setNetworkProtocolHeader(floodHeader);
     packet->addTagIfAbsent<DispatchProtocolReq>()->setProtocol(payloadProtocol);
     packet->addTagIfAbsent<PacketProtocolTag>()->setProtocol(payloadProtocol);
     auto addressInd = packet->addTagIfAbsent<L3AddressInd>();
     addressInd->setSrcAddress(floodHeader->getSourceAddress());
     addressInd->setDestAddress(floodHeader->getDestinationAddress());
     packet->addTagIfAbsent<HopLimitInd>()->setHopLimit(floodHeader->getTtl());
 }

Referenced by handleLowerPacket().

◆ encapsulate()

void inet::Flooding::encapsulate ( Packet * packet )

protected

Encapsulates the received ApplPkt into a NetwPkt and set all needed header fields.

 {
     L3Address netwAddr;
  
     EV << "in encaps...\n";
  
     auto cInfo = appPkt->removeControlInfo();
     auto pkt = makeShared<FloodingHeader>(); // TODO appPkt->getName(), appPkt->getKind());
     pkt->setChunkLength(b(headerLength));
  
     auto& hopLimitReq = appPkt->removeTagIfPresent<HopLimitReq>();
     int ttl = (hopLimitReq != nullptr) ? hopLimitReq->getHopLimit() : -1;
     if (ttl == -1)
         ttl = defaultTtl;
  
     pkt->setSeqNum(seqNum);
     seqNum++;
     pkt->setTtl(ttl);
  
     const auto& addressReq = appPkt->findTag<L3AddressReq>();
     if (addressReq == nullptr) {
         EV << "warning: Application layer did not specifiy a destination L3 address\n"
            << "\tusing broadcast address instead\n";
         netwAddr = netwAddr.getAddressType()->getBroadcastAddress();
     }
     else {
         pkt->setProtocol(appPkt->getTag<PacketProtocolTag>()->getProtocol());
         netwAddr = addressReq->getDestAddress();
         EV << "CInfo removed, netw addr=" << netwAddr << endl;
         delete cInfo;
     }
  
     pkt->setSrcAddr(myNetwAddr);
     pkt->setDestAddr(netwAddr);
     EV << " netw " << myNetwAddr << " sending packet" << endl;
  
     EV << "sendDown: nHop=L3BROADCAST -> message has to be broadcasted"
        << " -> set destMac=L2BROADCAST" << endl;
  
     pkt->setPayloadLengthField(appPkt->getDataLength());
  
     // encapsulate the application packet
     setDownControlInfo(appPkt, MacAddress::BROADCAST_ADDRESS);
  
     appPkt->insertAtFront(pkt);
     EV << " pkt encapsulated\n";
 }

Referenced by handleUpperPacket().

◆ finish()

void inet::Flooding::finish ( )

overridevirtual

 {
     if (plainFlooding) {
         bcMsgs.clear();
     }
     recordScalar("nbDataPacketsReceived", nbDataPacketsReceived);
     recordScalar("nbDataPacketsSent", nbDataPacketsSent);
     recordScalar("nbDataPacketsForwarded", nbDataPacketsForwarded);
     if (nbDataPacketsReceived > 0) {
         recordScalar("meanNbHops", (double)nbHops / (double)nbDataPacketsReceived);
     }
     else {
         recordScalar("meanNbHops", 0);
     }
 }

◆ getProtocol()

const Protocol& inet::Flooding::getProtocol ( ) const

inlineoverridevirtual

Implements inet::NetworkProtocolBase.

115 { return Protocol::flooding; }

Referenced by decapsulate(), and setDownControlInfo().

◆ handleCrashOperation()

virtual void inet::Flooding::handleCrashOperation ( LifecycleOperation * operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

149 {} // TODO implementation

◆ handleLowerPacket()

void inet::Flooding::handleLowerPacket ( Packet * packet )

overrideprotectedvirtual

Handle messages from lower layer.

Messages from the mac layer will be forwarded to the application only if the are broadcast or destined for this node.

If the arrived message is a broadcast message it is also reflooded only if the tll field is bigger than one. Before the message is handed back to the mac layer the ttl field is reduced by one to account for this hop.

In the case of plain flooding the message will only be processed if there is no corresponding entry in the bcMsgs list (notBroadcasted). Otherwise the message will be deleted.

Reimplemented from inet::LayeredProtocolBase.

 {
     auto floodHeader = packet->peekAtFront<FloodingHeader>();
  
     // msg not broadcasted yet
     if (notBroadcasted(floodHeader.get())) {
         // msg is for me
         if (interfaceTable->isLocalAddress(floodHeader->getDestinationAddress())) {
             EV << " data msg for me! send to Upper" << endl;
             nbHops = nbHops + (defaultTtl + 1 - floodHeader->getTtl());
             decapsulate(packet);
             sendUp(packet);
             nbDataPacketsReceived++;
         }
         // broadcast message
         else if (floodHeader->getDestinationAddress().isBroadcast()) {
             // check ttl and rebroadcast
             if (floodHeader->getTtl() > 1) {
                 EV << " data msg BROADCAST! ttl = " << floodHeader->getTtl()
                    << " > 1 -> rebroadcast msg & send to upper\n";
                 auto dMsg = packet->dup();
                 auto newFloodHeader = dMsg->removeAtFront<FloodingHeader>();
                 newFloodHeader->setTtl(newFloodHeader->getTtl() - 1);
                 dMsg->insertAtFront(newFloodHeader);
                 setDownControlInfo(dMsg, MacAddress::BROADCAST_ADDRESS);
                 sendDown(dMsg);
                 nbDataPacketsForwarded++;
             }
             else
                 EV << " max hops reached (ttl = " << floodHeader->getTtl() << ") -> only send to upper\n";
  
             // message has to be forwarded to upper layer
             nbHops = nbHops + (defaultTtl + 1 - floodHeader->getTtl());
             decapsulate(packet);
             sendUp(packet);
             nbDataPacketsReceived++;
         }
         // not for me -> rebroadcast
         else {
             // check ttl and rebroadcast
             if (floodHeader->getTtl() > 1) {
                 EV << " data msg not for me! ttl = " << floodHeader->getTtl()
                    << " > 1 -> forward\n";
                 decapsulate(packet);
                 auto packetCopy = new Packet();
                 packetCopy->insertAtBack(packet->peekDataAt(b(0), packet->getDataLength()));
                 auto floodHeaderCopy = staticPtrCast<FloodingHeader>(floodHeader->dupShared());
                 floodHeaderCopy->setTtl(floodHeader->getTtl() - 1);
                 packetCopy->insertAtFront(floodHeaderCopy);
                 // needs to set the next hop address again to broadcast
                 cObject *const pCtrlInfo = packetCopy->removeControlInfo();
                 if (pCtrlInfo != nullptr)
                     delete pCtrlInfo;
                 setDownControlInfo(packetCopy, MacAddress::BROADCAST_ADDRESS);
                 sendDown(packetCopy);
                 nbDataPacketsForwarded++;
                 delete packet;
             }
             else {
                 // max hops reached -> delete
                 EV << " max hops reached (ttl = " << floodHeader->getTtl() << ") -> delete msg\n";
                 delete packet;
             }
         }
     }
     else {
         EV << " data msg already BROADCASTed! delete msg\n";
         delete packet;
     }
 }

◆ handleStartOperation()

virtual void inet::Flooding::handleStartOperation ( LifecycleOperation * operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

147 {} // TODO implementation

◆ handleStopOperation()

virtual void inet::Flooding::handleStopOperation ( LifecycleOperation * operation )

inlineoverrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

148 {} // TODO implementation

◆ handleUpperPacket()

void inet::Flooding::handleUpperPacket ( Packet * packet )

overrideprotectedvirtual

Handle messages from upper layer.

All messages have to get a sequence number and the ttl filed has to be specified.

Afterwards the messages can be handed to the mac layer. The mac address is set to -1 (broadcast address) because the message is flooded (i.e. has to be send to all neighbors)

In the case of plain flooding the message sequence number and source address has also be stored in the bcMsgs list, so that this message will not be rebroadcasted, if a copy will be flooded back from the neigbouring nodes.

If the maximum number of entries is reached the first (oldest) entry is deleted.

Reimplemented from inet::LayeredProtocolBase.

 {
     encapsulate(packet);
     auto floodHeader = packet->peekAtFront<FloodingHeader>();
  
     if (plainFlooding) {
         if (bcMsgs.size() >= bcMaxEntries) {
             // serach the broadcast list of outdated entries and delete them
             for (auto it = bcMsgs.begin(); it != bcMsgs.end();) {
                 if (it->delTime < simTime())
                     it = bcMsgs.erase(it);
                 else
                     ++it;
             }
             // delete oldest entry if max size is reached
             if (bcMsgs.size() >= bcMaxEntries) {
                 EV << "bcMsgs is full, delete oldest entry" << endl;
                 bcMsgs.pop_front();
             }
         }
         bcMsgs.push_back(Bcast(floodHeader->getSeqNum(), floodHeader->getSourceAddress(), simTime() + bcDelTime));
     }
     // there is no routing so all messages are broadcast for the mac layer
     sendDown(packet);
     nbDataPacketsSent++;
 }

◆ initialize()

void inet::Flooding::initialize ( int stage )

overridevirtual

Reads all parameters from the ini file.

If a parameter is not specified in the ini file a default value will be set.

Reimplemented from inet::NetworkProtocolBase.

 {
     NetworkProtocolBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         // initialize seqence number to 0
         seqNum = 0;
         nbDataPacketsReceived = 0;
         nbDataPacketsSent = 0;
         nbDataPacketsForwarded = 0;
         nbHops = 0;
         headerLength = par("headerLength");
         defaultTtl = par("defaultTtl");
         plainFlooding = par("plainFlooding");
  
         EV << "defaultTtl = " << defaultTtl
            << " plainFlooding = " << plainFlooding << endl;
  
         if (plainFlooding) {
             // these parameters are only needed for plain flooding
             bcMaxEntries = par("bcMaxEntries");
             bcDelTime = par("bcDelTime");
             EV << "bcMaxEntries = " << bcMaxEntries
                << " bcDelTime = " << bcDelTime << endl;
         }
     }
     else if (stage == INITSTAGE_NETWORK_INTERFACE_CONFIGURATION) {
         for (int i = 0; i < interfaceTable->getNumInterfaces(); i++)
             interfaceTable->getInterface(i)->setHasModulePathAddress(true);
     }
     else if (stage == INITSTAGE_NETWORK_LAYER) {
         if (auto ie = interfaceTable->findFirstNonLoopbackInterface())
             myNetwAddr = ie->getNetworkAddress();
         else
             throw cRuntimeError("No non-loopback interface found!");
     }
 }

◆ notBroadcasted()

bool inet::Flooding::notBroadcasted ( const FloodingHeader * msg )

protected

Checks whether a message was already broadcasted.

The bcMsgs list is searched for the arrived message.

If the message is in the list, it was already broadcasted and the function returns false.

Concurrently all outdated (older than bcDelTime) are deleted. If the list is full and a new message has to be entered, the oldest entry is deleted.

 {
     if (!plainFlooding)
         return true;
  
     // serach the broadcast list of outdated entries and delete them
     for (auto it = bcMsgs.begin(); it != bcMsgs.end();) {
         if (it->delTime < simTime()) {
             it = bcMsgs.erase(it);
         }
         // message was already broadcasted
         else if ((it->srcAddr == msg->getSourceAddress()) && (it->seqNum == msg->getSeqNum())) {
             // update entry
             it->delTime = simTime() + bcDelTime;
             return false;
         }
         else
             ++it;
     }
  
     // delete oldest entry if max size is reached
     if (bcMsgs.size() >= bcMaxEntries) {
         EV << "bcMsgs is full, delete oldest entry\n";
         bcMsgs.pop_front();
     }
  
     bcMsgs.push_back(Bcast(msg->getSeqNum(), msg->getSourceAddress(), simTime() + bcDelTime));
     return true;
 }

Referenced by handleLowerPacket().

◆ numInitStages()

virtual int inet::Flooding::numInitStages ( ) const

inlineoverridevirtual

Initialization of omnetpp.ini parameters.

109 { return NUM_INIT_STAGES; }

◆ setDownControlInfo()

void inet::Flooding::setDownControlInfo	(	Packet *const	pMsg,
		const MacAddress &	pDestAddr
	)

protectedvirtual

Attaches a "control info" (NetwToMac) structure (object) to the message pMsg.

Attaches a "control info" structure (object) to the down message pMsg.

This is most useful when passing packets between protocol layers of a protocol stack, the control info will contain the destination MAC address.

The "control info" object will be deleted when the message is deleted. Only one "control info" structure can be attached (the second setL3ToL2ControlInfo() call throws an error).

Parameters

pMsg	The message where the "control info" shall be attached.
pDestAddr	The MAC address of the message receiver.

 {
     pMsg->addTagIfAbsent<MacAddressReq>()->setDestAddress(pDestAddr);
     pMsg->addTagIfAbsent<PacketProtocolTag>()->setProtocol(&getProtocol());
     pMsg->addTagIfAbsent<DispatchProtocolInd>()->setProtocol(&getProtocol());
 }

Referenced by encapsulate(), and handleLowerPacket().

Member Data Documentation

◆ bcDelTime

simtime_t inet::Flooding::bcDelTime

protected

Time after which an entry for an already broadcasted msg can be deleted.

Referenced by handleUpperPacket(), initialize(), and notBroadcasted().

◆ bcMaxEntries

unsigned int inet::Flooding::bcMaxEntries = 0

protected

Max number of entries in the list of already broadcasted messages.

Referenced by handleUpperPacket(), initialize(), and notBroadcasted().

◆ bcMsgs

cBroadcastList inet::Flooding::bcMsgs

protected

List of already broadcasted messages.

Referenced by finish(), handleUpperPacket(), and notBroadcasted().

◆ defaultTtl

int inet::Flooding::defaultTtl = 0

protected

Default time-to-live (ttl) used for this module.

Referenced by encapsulate(), handleLowerPacket(), and initialize().

◆ headerLength

int inet::Flooding::headerLength = 0

protected

Length of the header.

Referenced by encapsulate(), and initialize().

◆ myNetwAddr

L3Address inet::Flooding::myNetwAddr

protected

cached variable of my networ address

Referenced by encapsulate(), and initialize().

◆ nbDataPacketsForwarded

long inet::Flooding::nbDataPacketsForwarded = 0

protected

Referenced by finish(), handleLowerPacket(), and initialize().

◆ nbDataPacketsReceived

long inet::Flooding::nbDataPacketsReceived = 0

protected

Referenced by finish(), handleLowerPacket(), and initialize().

◆ nbDataPacketsSent

long inet::Flooding::nbDataPacketsSent = 0

protected

Referenced by finish(), handleUpperPacket(), and initialize().

◆ nbHops

long inet::Flooding::nbHops = 0

protected

Referenced by finish(), handleLowerPacket(), and initialize().

◆ plainFlooding

bool inet::Flooding::plainFlooding = false

protected

Defines whether to use plain flooding or not.

Referenced by finish(), handleUpperPacket(), initialize(), and notBroadcasted().

◆ seqNum

unsigned long inet::Flooding::seqNum = 0

protected

Network layer sequence number.

Referenced by encapsulate(), and initialize().

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ cBroadcastList

Constructor & Destructor Documentation

◆ Flooding()

Member Function Documentation

◆ decapsulate()

◆ encapsulate()

◆ finish()

◆ getProtocol()

◆ handleCrashOperation()

◆ handleLowerPacket()

◆ handleStartOperation()

◆ handleStopOperation()

◆ handleUpperPacket()

◆ initialize()

◆ notBroadcasted()

◆ numInitStages()

◆ setDownControlInfo()

Member Data Documentation

◆ bcDelTime

◆ bcMaxEntries

◆ bcMsgs

◆ defaultTtl

◆ headerLength

◆ myNetwAddr

◆ nbDataPacketsForwarded

◆ nbDataPacketsReceived

◆ nbDataPacketsSent

◆ nbHops

◆ plainFlooding

◆ seqNum