inet::RoutingTableRecorder Class Reference

Records routing table changes into a file. More...

#include <RoutingTableRecorder.h>

Inheritance diagram for inet::RoutingTableRecorder:

Public Member Functions
	RoutingTableRecorder ()
virtual	~RoutingTableRecorder ()
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *) override
virtual void	hookListeners ()
virtual void	ensureRoutingLogFileOpen ()
virtual void	receiveChangeNotification (cComponent *source, simsignal_t signalID, cObject *details)
virtual void	recordInterfaceChange (cModule *host, const InterfaceEntry *ie, simsignal_t signalID)
virtual void	recordRouteChange (cModule *host, const IRoute *route, simsignal_t signalID)

Private Attributes
FILE *	routingLogFile

Detailed Description

Records routing table changes into a file.

See also

IPv4RoutingTable, IPv4Route

Constructor & Destructor Documentation

inet::RoutingTableRecorder::RoutingTableRecorder

(

)

{
    routingLogFile = nullptr;
}

inet::RoutingTableRecorder::~RoutingTableRecorder ( )

virtual

{
}

Member Function Documentation

void inet::RoutingTableRecorder::ensureRoutingLogFileOpen ( )

protectedvirtual

{
    if (routingLogFile == nullptr) {
        // hack to ensure that results/ folder is created
        getSimulation()->getSystemModule()->recordScalar("hackForCreateResultsFolder", 0);

        std::string fname = getEnvir()->getConfig()->getAsFilename(CFGID_ROUTINGLOG_FILE);
        routingLogFile = fopen(fname.c_str(), "w");
        if (!routingLogFile)
            throw cRuntimeError("Cannot open file %s", fname.c_str());
    }
}

void inet::RoutingTableRecorder::handleMessage ( cMessage *  )

overrideprotectedvirtual

{
    throw cRuntimeError(this, "This module doesn't process messages");
}

void inet::RoutingTableRecorder::hookListeners ( )

protectedvirtual

{
    cModule *systemModule = getSimulation()->getSystemModule();
    systemModule->subscribe(NF_INTERFACE_CREATED, this);
    systemModule->subscribe(NF_INTERFACE_DELETED, this);
    systemModule->subscribe(NF_INTERFACE_CONFIG_CHANGED, this);
    systemModule->subscribe(NF_INTERFACE_IPv4CONFIG_CHANGED, this);
    //systemModule->subscribe(NF_INTERFACE_IPv6CONFIG_CHANGED, this);
    //systemModule->subscribe(NF_INTERFACE_STATE_CHANGED, this);

    systemModule->subscribe(NF_ROUTE_ADDED, this);
    systemModule->subscribe(NF_ROUTE_DELETED, this);
    systemModule->subscribe(NF_ROUTE_CHANGED, this);
}

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_NETWORK_LAYER) {
        if (par("enabled").boolValue())
            hookListeners();
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::RoutingTableRecorder::receiveChangeNotification ( cComponent *  source, simsignal_t  signalID, cObject *  details  )

protectedvirtual

{
    cModule *m = dynamic_cast<cModule *>(nsource);
    if (!m)
        m = nsource->getParentModule();
    cModule *host = getContainingNode(m);
    if (signalID == NF_ROUTE_ADDED || signalID == NF_ROUTE_DELETED || signalID == NF_ROUTE_CHANGED)
        recordRouteChange(host, check_and_cast<const IRoute *>(obj), signalID);
    else if (signalID == NF_INTERFACE_CREATED || signalID == NF_INTERFACE_DELETED)
        recordInterfaceChange(host, check_and_cast<const InterfaceEntry *>(obj), signalID);
    else if (signalID == NF_INTERFACE_CONFIG_CHANGED || signalID == NF_INTERFACE_IPv4CONFIG_CHANGED)
        recordInterfaceChange(host, check_and_cast<const InterfaceEntryChangeDetails *>(obj)->getInterfaceEntry(), signalID);
}

virtual void inet::RoutingTableRecorder::receiveSignal ( cComponent *  source, simsignal_t  signalID, cObject *  obj, cObject *  details  )

inlineoverridevirtual

{ receiveChangeNotification(source, signalID, obj); }

void inet::RoutingTableRecorder::recordInterfaceChange ( cModule *  host, const InterfaceEntry *  ie, simsignal_t  signalID  )

protectedvirtual

{
    // Note: ie->getInterfaceTable() may be nullptr (entry already removed from its table)

    const char *tag;

    if (signalID == NF_INTERFACE_CREATED)
        tag = "+I";
    else if (signalID == NF_INTERFACE_DELETED)
        tag = "-I";
    else if (signalID == NF_INTERFACE_CONFIG_CHANGED)
        tag = "*I";
    else if (signalID == NF_INTERFACE_IPv4CONFIG_CHANGED)
        tag = "*I";
    else
        throw cRuntimeError("Unexpected signal: %s", getSignalName(signalID));

    // action, eventNo, simtime, moduleId, ifname, address
    ensureRoutingLogFileOpen();
    fprintf(routingLogFile, "%s  %" PRId64 "  %s  %d  %s %s\n",
            tag,
            getSimulation()->getEventNumber(),
            SIMTIME_STR(simTime()),
            host->getId(),
            ie->getName(),
            (ie->ipv4Data() != nullptr ? ie->ipv4Data()->getIPAddress().str().c_str() : IPv4Address().str().c_str())
            );
    fflush(routingLogFile);
}

void inet::RoutingTableRecorder::recordRouteChange ( cModule *  host, const IRoute *  route, simsignal_t  signalID  )

protectedvirtual

{
    IRoutingTable *rt = route->getRoutingTableAsGeneric();    // may be nullptr! (route already removed from its routing table)

    const char *tag;
    if (signalID == NF_ROUTE_ADDED)
        tag = "+R";
    else if (signalID == NF_ROUTE_CHANGED)
        tag = "*R";
    else if (signalID == NF_ROUTE_DELETED)
        tag = "-R";
    else
        throw cRuntimeError("Unexpected signal: %s", getSignalName(signalID));

    // action, eventNo, simtime, moduleId, routerID, dest, dest netmask, nexthop
    ensureRoutingLogFileOpen();
    fprintf(routingLogFile, "%s %" PRId64 "  %s  %d  %s  %s  %d  %s\n",
            tag,
            getSimulation()->getEventNumber(),
            SIMTIME_STR(simTime()),
            host->getId(),
            (rt ? rt->getRouterIdAsGeneric().str().c_str() : "*"),
            route->getDestinationAsGeneric().str().c_str(),
            route->getPrefixLength(),
            route->getNextHopAsGeneric().str().c_str()
            );
    fflush(routingLogFile);
}

Member Data Documentation

FILE* inet::RoutingTableRecorder::routingLogFile

private

---

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

• RoutingTableRecorder.h
• RoutingTableRecorder.cc