NetworkConfigurator Class Reference

#include <NetworkConfigurator.h>

List of all members.

---

Detailed Description

Configures IP addresses and routing tables for a network. For more info please see the NED file.

Protected Types
typedef std::vector< NodeInfo >	NodeInfoVector
typedef std::vector< std::string >	StringVector
Protected Member Functions
virtual int	numInitStages () const
virtual void	initialize (int stage)
virtual void	handleMessage (cMessage *msg)
void	extractTopology (cTopology &topo, NodeInfoVector &nodeInfo)
void	assignAddresses (cTopology &topo, NodeInfoVector &nodeInfo)
void	addPointToPointPeerRoutes (cTopology &topo, NodeInfoVector &nodeInfo)
void	addDefaultRoutes (cTopology &topo, NodeInfoVector &nodeInfo)
void	setPeersParameter (const char *submodName, cTopology &topo, NodeInfoVector &nodeInfo)
void	fillRoutingTables (cTopology &topo, NodeInfoVector &nodeInfo)
void	setDisplayString (cTopology &topo, NodeInfoVector &nodeInfo)
Classes
struct	NodeInfo

---

Member Typedef Documentation

typedef std::vector<NodeInfo> NetworkConfigurator::NodeInfoVector [protected]

typedef std::vector<std::string> NetworkConfigurator::StringVector [protected]

---

Member Function Documentation

void NetworkConfigurator::addDefaultRoutes (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ // add default route to nodes with exactly one (non-loopback) interface for (int i=0; i<topo.nodes(); i++) { // skip bus types if (!nodeInfo[i].isIPNode) continue; cTopology::Node *node = topo.node(i); InterfaceTable *ift = nodeInfo[i].ift; RoutingTable *rt = nodeInfo[i].rt; // count non-loopback interfaces int numIntf = 0; InterfaceEntry *ie = NULL; for (int k=0; k<ift->numInterfaces(); k++) if (!ift->interfaceAt(k)->isLoopback()) {ie = ift->interfaceAt(k); numIntf++;} nodeInfo[i].usesDefaultRoute = (numIntf==1); if (numIntf!=1) continue; // only deal with nodes with one interface plus loopback EV << " " << node->module()->fullName() << " has only one (non-loopback) " "interface, adding default route\n"; // add route RoutingEntry *e = new RoutingEntry(); e->host = IPAddress(); e->netmask = IPAddress(); e->interfaceName = ie->name(); e->interfacePtr = ie; e->type = RoutingEntry::REMOTE; e->source = RoutingEntry::MANUAL; //e->metric() = 1; rt->addRoutingEntry(e); } }

void NetworkConfigurator::addPointToPointPeerRoutes (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ bool useRouterIdForRoutes = true; // TODO make it parameter // add routes towards point-to-point routers (in real life these routes are // created automatically after PPP handshake when neighbour's address is learned) for (int i=0; i<topo.nodes(); i++) { // skip bus types if (!nodeInfo[i].isIPNode) continue; cTopology::Node *node = topo.node(i); InterfaceTable *ift = nodeInfo[i].ift; RoutingTable *rt = nodeInfo[i].rt; // loop through neighbors for (int j=0; j<node->outLinks(); j++) { cTopology::Node *neighbor = node->out(j)->remoteNode(); // find neighbour's index in cTopology ==> k int k; for (k=0; k<topo.nodes(); k++) if (topo.node(k)==neighbor) break; ASSERT(k<=topo.nodes()); // if it's not an IP node (e.g. an Ethernet switch), then we're not interested if (!nodeInfo[k].isIPNode) continue; // find out neighbor's routerId IPAddress neighborRouterId = nodeInfo[k].rt->routerId(); // find out neighbor's interface IP address int neighborGateId = node->out(j)->remoteGate()->id(); InterfaceEntry *neighborIe = nodeInfo[k].ift->interfaceByNodeInputGateId(neighborGateId); ASSERT(neighborIe); IPAddress neighborAddr = neighborIe->ipv4()->inetAddress(); // find our own interface towards neighbor int gateId = node->out(j)->localGate()->id(); InterfaceEntry *ie = nodeInfo[i].ift->interfaceByNodeOutputGateId(gateId); ASSERT(ie); // add route RoutingEntry *e = new RoutingEntry(); if (useRouterIdForRoutes) { e->host = neighborRouterId; e->gateway = neighborAddr; } else { e->host = neighborAddr; // and no gateway } e->netmask = IPAddress(255,255,255,255); // full match needed e->interfaceName = ie->name(); e->interfacePtr = ie; e->type = RoutingEntry::DIRECT; e->source = RoutingEntry::MANUAL; //e->metric() = 1; rt->addRoutingEntry(e); } } }

void NetworkConfigurator::assignAddresses (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ uint32 base = 10 << 24; // 10.x.x.x addresses int nodeCtr = 1; // middle 16 bits for (int i=0; i<topo.nodes(); i++) { // skip bus types if (!nodeInfo[i].isIPNode) continue; uint32 addr = base + (nodeCtr++ << 8); // --> 10.nn.nn.0 // assign address to all (non-loopback) interfaces InterfaceTable *ift = nodeInfo[i].ift; for (int k=0; k<ift->numInterfaces(); k++) { InterfaceEntry *ie = ift->interfaceAt(k); if (!ie->isLoopback()) { ie->ipv4()->setInetAddress(IPAddress(addr | (uint32)k)); ie->ipv4()->setNetmask(IPAddress::ALLONES_ADDRESS); // full address must match for local delivery } } // set routerId as well (if not yet configured) RoutingTable *rt = nodeInfo[i].rt; if (rt->routerId().isUnspecified()) { rt->setRouterId(IPAddress(addr | 1U)); // 10.nn.nn.1 } } }

void NetworkConfigurator::extractTopology (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ StringVector types = cStringTokenizer(par("moduleTypes"), " ").asVector(); // extract topology topo.extractByModuleType(types); EV << "cTopology found " << topo.nodes() << " nodes\n"; // fill in isIPNode, ift and rt members in nodeInfo[] nodeInfo.resize(topo.nodes()); for (int i=0; i<topo.nodes(); i++) { cModule *mod = topo.node(i)->module(); nodeInfo[i].ift = IPAddressResolver().findInterfaceTableOf(mod); nodeInfo[i].rt = IPAddressResolver().findRoutingTableOf(mod); nodeInfo[i].isIPNode = nodeInfo[i].rt!=NULL; } }

void NetworkConfigurator::fillRoutingTables (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ /* FIXME TBD // fill in routing tables with static routes for (int i=0; i<topo.nodes(); i++) { cTopology::Node *destNode = topo.node(i); // skip bus types if (!nodeInfo[i].isIPNode) continue; IPAddress destAddr = nodeInfo[i].address; std::string destModName = destNode->module()->fullName(); // calculate shortest paths from everywhere towards destNode topo.unweightedSingleShortestPathsTo(destNode); // add route (with host=destNode) to every routing table in the network // (excepting nodes with only one interface -- there we'll set up a default route) for (int j=0; j<topo.nodes(); j++) { if (i==j) continue; if (!nodeInfo[j].isIPNode) continue; cTopology::Node *atNode = topo.node(j); if (atNode->paths()==0) continue; // not connected if (nodeInfo[j].usesDefaultRoute) continue; // already added default route here IPAddress atAddr = nodeInfo[j].address; InterfaceTable *ift = nodeInfo[j].ift; int outputGateId = atNode->path(0)->localGate()->id(); InterfaceEntry *ie = ift->interfaceByNodeOutputGateId(outputGateId); if (!ie) error("%s has no interface for output gate id %d", ift->fullPath().c_str(), outputGateId); EV << " from " << atNode->module()->fullName() << "=" << IPAddress(atAddr); EV << " towards " << destModName << "=" << IPAddress(destAddr) << " interface " << ie->name() << endl; // add route RoutingTable *rt = nodeInfo[j].rt; RoutingEntry *e = new RoutingEntry(); e->host = destAddr; e->gateway = ??? e->netmask = IPAddress(255,255,255,255); // full match needed e->interfaceName = ie->name(); e->interfacePtr = ie; e->type = RoutingEntry::REMOTE; e->source = RoutingEntry::MANUAL; //e->metric() = 1; rt->addRoutingEntry(e); } } */ }

void NetworkConfigurator::handleMessage (  cMessage *  msg  )  [protected, virtual]

{ error("this module doesn't handle messages, it runs only in initialize()"); }

void NetworkConfigurator::initialize (  int  stage  )  [protected, virtual]

{ if (stage==2) { cTopology topo("topo"); NodeInfoVector nodeInfo; // will be of size topo.nodes[] // extract topology into the cTopology object, then fill in // isIPNode, rt and ift members of nodeInfo[] extractTopology(topo, nodeInfo); // assign addresses to IP nodes, and also store result in nodeInfo[].address assignAddresses(topo, nodeInfo); // add routes for point-to-point peers addPointToPointPeerRoutes(topo, nodeInfo); // add default routes to hosts (nodes with a single attachment); // also remember result in nodeInfo[].usesDefaultRoute addDefaultRoutes(topo, nodeInfo); // help configure RSVP and LinkStateRouting modules by setting their "peers" parameters setPeersParameter("rsvp", topo, nodeInfo); setPeersParameter("linkStateRouting", topo, nodeInfo); // calculate shortest paths, and add corresponding static routes fillRoutingTables(topo, nodeInfo); // update display string setDisplayString(topo, nodeInfo); } }

virtual int NetworkConfigurator::numInitStages (   )  const [inline, protected, virtual]

{return 3;}

void NetworkConfigurator::setDisplayString (  cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ int numIPNodes = 0; for (int i=0; i<topo.nodes(); i++) if (nodeInfo[i].isIPNode) numIPNodes++; // update display string char buf[80]; sprintf(buf, "%d IP nodes\n%d non-IP nodes", numIPNodes, topo.nodes()-numIPNodes); displayString().setTagArg("t",0,buf); }

void NetworkConfigurator::setPeersParameter (  const char *  submodName, cTopology &  topo, NodeInfoVector &  nodeInfo )  [protected]

{ // the RSVP module expects a "peers" module parameter to contain the interfaces // towards directly connected other RSVP routers. Since it's cumbersome to configure // manually in a large network, do it here (submodName = "rsvp"). // The LinkStateRouting module is similar, so this function is also called with submodName = "LinkStateRouting". // for each RSVP router, collect neighbors which are also RSVP routers for (int i=0; i<topo.nodes(); i++) { // if it doesn't have an RSVP submodule, we're not interested cModule *submod = topo.node(i)->module()->submodule(submodName); if (submod==NULL) continue; std::string peers; cTopology::Node *node = topo.node(i); for (int j=0; j<node->outLinks(); j++) { // if neighbor is not an RSVP router, then we're not interested cModule *neighborSubmod = node->out(j)->remoteNode()->module()->submodule(submodName); if (neighborSubmod==NULL) continue; // find our own interface towards neighbor int gateId = node->out(j)->localGate()->id(); InterfaceEntry *ie = nodeInfo[i].ift->interfaceByNodeOutputGateId(gateId); ASSERT(ie); // interface name to peers list peers += std::string(" ") + ie->name(); } // set "peers" parameter submod->par("peers") = peers.c_str(); } }

---

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

• NetworkConfigurator.h
• NetworkConfigurator.cc

---