Base class of PimSm and PimDm modules. More...

#include <PimBase.h>

Inheritance diagram for inet::PimBase:

Classes
struct	AssertMetric

struct	Interface

struct	RouteEntry

struct	SourceAndGroup

Public Member Functions
	PimBase (PimInterface::PimMode mode)

virtual	~PimBase ()

Public Member Functions inherited from inet::RoutingProtocolBase
	RoutingProtocolBase ()

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

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

Protected Types
enum	PimTimerKind { HelloTimer = 1, TriggeredHelloDelay, AssertTimer, PruneTimer, PrunePendingTimer, GraftRetryTimer, UpstreamOverrideTimer, PruneLimitTimer, SourceActiveTimer, StateRefreshTimer, KeepAliveTimer, RegisterStopTimer, ExpiryTimer, JoinTimer }

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

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

void	sendHelloPackets ()

void	sendHelloPacket (PimInterface *pimInterface)

void	processHelloTimer (cMessage *timer)

void	processHelloPacket (Packet *pk)

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

Protected Member Functions inherited from inet::RoutingProtocolBase
virtual bool	isInitializeStage (int stage) const override

virtual bool	isModuleStartStage (int stage) const override

virtual bool	isModuleStopStage (int stage) const override

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 void	handleMessageWhenUp (cMessage *msg)=0

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
ModuleRefByPar< IIpv4RoutingTable >	rt

ModuleRefByPar< IInterfaceTable >	ift

ModuleRefByPar< PimInterfaceTable >	pimIft

ModuleRefByPar< PimNeighborTable >	pimNbt

opp_component_ptr< Pim >	pimModule

bool	isUp = false

bool	isEnabled = false

const char *	hostname = nullptr

double	helloPeriod = 0

double	holdTime = 0

int	designatedRouterPriority = 0

PimInterface::PimMode	mode = static_cast<PimInterface::PimMode>(0)

uint32_t	generationID = 0

cMessage *	helloTimer = nullptr

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

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout

cMessage *	activeOperationExtraTimer

Static Protected Attributes
static const Ipv4Address	ALL_PIM_ROUTERS_MCAST

static simsignal_t	sentHelloPkSignal = registerSignal("sentHelloPk")

static simsignal_t	rcvdHelloPkSignal = registerSignal("rcvdHelloPk")

Friends
std::ostream &	operator<< (std::ostream &out, const SourceAndGroup &sourceGroup)

Detailed Description

Base class of PimSm and PimDm modules.

Member Enumeration Documentation

◆ PimTimerKind

enum inet::PimBase::PimTimerKind

protected

Enumerator
HelloTimer
TriggeredHelloDelay
AssertTimer
PruneTimer
PrunePendingTimer
GraftRetryTimer
UpstreamOverrideTimer
PruneLimitTimer
SourceActiveTimer
StateRefreshTimer
KeepAliveTimer
RegisterStopTimer
ExpiryTimer
JoinTimer

                       {
         // global timers
         HelloTimer = 1,
         TriggeredHelloDelay,
  
         // timers for each interface and each source-group pair (S,G,I)
         AssertTimer,
         PruneTimer,
         PrunePendingTimer,
  
         // timers for each source-group pair (S,G)
         GraftRetryTimer,
         UpstreamOverrideTimer,
         PruneLimitTimer,
         SourceActiveTimer,
         StateRefreshTimer,
  
         // PIM-SM specific timers
         KeepAliveTimer,
         RegisterStopTimer,
         ExpiryTimer,
         JoinTimer,
     };

Constructor & Destructor Documentation

◆ PimBase()

inet::PimBase::PimBase ( PimInterface::PimMode mode )

inline

170 : mode(mode) {}

◆ ~PimBase()

inet::PimBase::~PimBase ( )

virtual

 {
     cancelAndDelete(helloTimer);
 }

Member Function Documentation

◆ handleCrashOperation()

void inet::PimBase::handleCrashOperation ( LifecycleOperation * operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::PimDm, and inet::PimSm.

 {
     // TODO unregister IP_PROT_PIM
     cancelAndDelete(helloTimer);
     helloTimer = nullptr;
 }

Referenced by inet::PimSm::handleCrashOperation(), and inet::PimDm::handleCrashOperation().

◆ handleStartOperation()

void inet::PimBase::handleStartOperation ( LifecycleOperation * operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::PimDm, and inet::PimSm.

 {
     generationID = intrand(UINT32_MAX);
  
     // to receive PIM messages, join to ALL_PIM_ROUTERS multicast group
     isEnabled = false;
     for (int i = 0; i < pimIft->getNumInterfaces(); i++) {
         PimInterface *pimInterface = pimIft->getInterface(i);
         if (pimInterface->getMode() == mode) {
             pimInterface->getInterfacePtr()->getProtocolDataForUpdate<Ipv4InterfaceData>()->joinMulticastGroup(ALL_PIM_ROUTERS_MCAST);
             isEnabled = true;
         }
     }
  
     if (isEnabled) {
         EV_INFO << "PIM is enabled on device " << hostname << endl;
         helloTimer = new cMessage("PIM HelloTimer", HelloTimer);
         scheduleAfter(par("triggeredHelloDelay"), helloTimer);
     }
 }

Referenced by inet::PimSm::handleStartOperation(), and inet::PimDm::handleStartOperation().

◆ handleStopOperation()

void inet::PimBase::handleStopOperation ( LifecycleOperation * operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::PimDm, and inet::PimSm.

 {
     // TODO unregister IP_PROT_PIM
     cancelAndDelete(helloTimer);
     helloTimer = nullptr;
 }

Referenced by inet::PimSm::handleStopOperation(), and inet::PimDm::handleStopOperation().

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

Reimplemented in inet::PimDm, and inet::PimSm.

 {
     RoutingProtocolBase::initialize(stage);
  
     if (stage == INITSTAGE_LOCAL) {
         ift.reference(this, "interfaceTableModule", true);
         rt.reference(this, "routingTableModule", true);
         pimIft.reference(this, "pimInterfaceTableModule", true);
         pimNbt.reference(this, "pimNeighborTableModule", true);
  
         cModule *host = findContainingNode(this);
         if (!host)
             throw cRuntimeError("PimBase: containing node not found.");
  
         hostname = host->getName();
  
         helloPeriod = par("helloPeriod");
         holdTime = par("holdTime");
         designatedRouterPriority = mode == PimInterface::SparseMode ? par("designatedRouterPriority") : -1;
         pimModule = check_and_cast<Pim *>(getParentModule());
     }
 }

Referenced by inet::PimSm::initialize(), and inet::PimDm::initialize().

◆ numInitStages()

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

inlineoverrideprotectedvirtual

Reimplemented in inet::PimDm, and inet::PimSm.

174 { return NUM_INIT_STAGES; }

◆ processHelloPacket()

void inet::PimBase::processHelloPacket ( Packet * pk )

protected

 {
     int interfaceId = packet->getTag<InterfaceInd>()->getInterfaceId();
  
     Ipv4Address address = packet->getTag<L3AddressInd>()->getSrcAddress().toIpv4();
     const auto& pimPacket = packet->peekAtFront<PimHello>();
     int version = pimPacket->getVersion();
  
     emit(rcvdHelloPkSignal, packet);
  
     // process options
     double holdTime = 3.5 * 30;
     long drPriority = -1L;
     unsigned int generationId = 0;
     for (unsigned int i = 0; i < pimPacket->getOptionsArraySize(); i++) {
         const HelloOption *option = pimPacket->getOptions(i);
         switch (option->getType()) {
             case Holdtime:
                 holdTime = check_and_cast<const HoldtimeOption *>(option)->getHoldTime();
                 break;
             case DRPriority:
                 drPriority = check_and_cast<const DrPriorityOption *>(option)->getPriority();
                 break;
             case GenerationID:
                 generationId = check_and_cast<const GenerationIdOption *>(option)->getGenerationID();
                 break;
             default:
                 break;
         }
     }
  
     NetworkInterface *ie = ift->getInterfaceById(interfaceId);
  
     EV_INFO << "Received PIM Hello from neighbor: interface=" << ie->getInterfaceName() << " address=" << address << "\n";
  
     PimNeighbor *neighbor = pimNbt->findNeighbor(interfaceId, address);
     if (neighbor)
         pimNbt->restartLivenessTimer(neighbor, holdTime);
     else {
         neighbor = new PimNeighbor(ie, address, version);
         pimNbt->addNeighbor(neighbor, holdTime);
  
         // TODO If a Hello message is received from a new neighbor, the
         // receiving router SHOULD send its own Hello message after a random
         // delay between 0 and Triggered_Hello_Delay.
     }
  
     neighbor->setGenerationId(generationId);
     neighbor->setDRPriority(drPriority);
  
     delete packet;
 }

Referenced by inet::PimSm::handleMessageWhenUp(), and inet::PimDm::handleMessageWhenUp().

◆ processHelloTimer()

void inet::PimBase::processHelloTimer ( cMessage * timer )

protected

 {
     ASSERT(timer == helloTimer);
     EV_DETAIL << "Hello Timer expired.\n";
     sendHelloPackets();
     scheduleAfter(helloPeriod, helloTimer);
 }

Referenced by inet::PimSm::handleMessageWhenUp(), and inet::PimDm::handleMessageWhenUp().

◆ sendHelloPacket()

void inet::PimBase::sendHelloPacket ( PimInterface * pimInterface )

protected

 {
     EV_INFO << "Sending Hello packet on interface '" << pimInterface->getInterfacePtr()->getInterfaceName() << "'\n";
  
     Packet *pk = new Packet("PimHello");
     const auto& msg = makeShared<PimHello>();
  
     B byteLength = PIM_HEADER_LENGTH + B(6) + B(8); // HoldTime + GenerationID option
  
     msg->setOptionsArraySize(designatedRouterPriority < 0 ? 2 : 3);
     HoldtimeOption *holdtimeOption = new HoldtimeOption();
     holdtimeOption->setHoldTime(holdTime < 0 ? (uint16_t)0xffff : (uint16_t)holdTime);
     msg->setOptions(0, holdtimeOption);
  
     GenerationIdOption *genIdOption = new GenerationIdOption();
     genIdOption->setGenerationID(generationID);
     msg->setOptions(1, genIdOption);
  
     if (designatedRouterPriority >= 0) {
         DrPriorityOption *drPriorityOption = new DrPriorityOption();
         drPriorityOption->setPriority(designatedRouterPriority);
         msg->setOptions(2, drPriorityOption);
         byteLength += B(8);
     }
  
     msg->setChunkLength(byteLength);
     msg->setCrcMode(pimModule->getCrcMode());
     Pim::insertCrc(msg);
     pk->insertAtFront(msg);
     pk->addTag<PacketProtocolTag>()->setProtocol(&Protocol::pim);
     pk->addTag<InterfaceReq>()->setInterfaceId(pimInterface->getInterfaceId());
     pk->addTag<DispatchProtocolInd>()->setProtocol(&Protocol::pim);
     pk->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ipv4);
     pk->addTag<L3AddressReq>()->setDestAddress(ALL_PIM_ROUTERS_MCAST);
     pk->addTag<HopLimitReq>()->setHopLimit(1);
  
     emit(sentHelloPkSignal, pk);
  
     send(pk, "ipOut");
 }

Referenced by sendHelloPackets().

◆ sendHelloPackets()

void inet::PimBase::sendHelloPackets ( )

protected

 {
     for (int i = 0; i < pimIft->getNumInterfaces(); i++) {
         PimInterface *pimInterface = pimIft->getInterface(i);
         if (pimInterface->getMode() == mode)
             sendHelloPacket(pimInterface);
     }
 }

Referenced by processHelloTimer().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	out,
		const SourceAndGroup &	sourceGroup
	)

friend

 {
     out << "(source: " << (sourceGroup.source.isUnspecified() ? "*" : sourceGroup.source.str()) << ", "
         << "group: " << (sourceGroup.group.isUnspecified() ? "*" : sourceGroup.group.str()) << ")";
     return out;
 }