class RIB Master class for a RIB. More... Definition #include <rib.hh> Template form RIB<class A> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  RIB (RibTransportType rib_type)
• virtual  ~RIB ()
• int  initialize_export (FeaClient *fea)
• int  initialize_register (RegisterServer *regserv)
• int  new_origin_table (const string& tablename, int admin_distance, int igp)
• int  new_merged_table (const string& tablename, const string& table_a, const string& table_b)
• int  new_extint_table (const string& tablename, const string& t_ext, const string& t_int)
• virtual int  new_vif (const string& vifname, const Vif& vif)
• virtual int  delete_vif (const string& vifname)
• virtual int  add_vif_address (const string& vifname, const A& addr, const IPNet<A>& net)
• virtual int  delete_vif_address (const string& vifname, const A& addr)
• virtual int  add_route (const string& tablename, const IPNet<A>& net, const A& addr, uint32_t metric)
• virtual int  replace_route (const string& tablename, const IPNet<A>& net, const A& addr, uint32_t metric)
• virtual int  verify_route (const A& lookupaddr, const string& ifname, const A& nexthop, uint32_t metric)
• virtual int  delete_route (const string& tablename, const IPNet<A>& subnet)
• virtual const A&  lookup_route (const A& lookupaddr)
• virtual RouteRange<A>*  route_range_lookup (const A& lookupaddr)
• virtual RouteRegister<A>*  route_register (const A& lookupaddr, const string& module)
• virtual bool  route_deregister (const IPNet<A> &subnet, const string &module)
• virtual int  redist_enable (const string& fromtable, const string& totable)
• virtual int  redist_disable (const string& fromtable, const string& totable)
• virtual int  add_igp_table (const string& tablename)
• virtual int  delete_igp_table (const string& tablename)
• virtual int  add_egp_table (const string& tablename)
• virtual int  delete_egp_table (const string& tablename)
• void  print_rib () const

Protected Members

• RouteTable<A>* _final_table
• RegisterTable<A>* _register_table
• bool _mcast
• map<const string, RouteTable<A>*> _tables
• map<const string, Vif> _vifs
• map<const string, int> _admin_distances
• map<const A, IPExternalNextHop<A> > _external_nexthops
• map<const A, IPPeerNextHop<A> > _peer_nexthops

Detailed Description

RIB is the master class for a Routing Information Base. It holds the Vif table, routing tables for each protocol, etc. Typically we would have one RIB for IPv4 unicast, one for IPv4 multicast topology, one for IPv6 unicast and one for IPv6 multicast.

Note that the XRL commands assume some level of filtering has already taken place to route to command to the right RIB.

RIB Constructor.

Parameters:

rib_type

indicates whether this RIB holds UNICAST or MULTICAST routing information. In the case of multicast, this is the topology information, not the forwarding information.

[virtual]

RIB Destructor.

Initialize the RIB's ExportTable so that the winning routes are exported to the Forwarding Engine.

Returns: -1 if already initialized.

See also: ExportTable

Initialize the RIB's RegisterTable. The RegisterTable allows routing protocols such as BGP to register interest in routing information that affects specfic addresses.

Returns: -1 if already initialized.

Add a new OriginTable. Use is deprecated, except in test suites.

Parameters:

tablename	human-readable name for this table to help in debugging
admin_distance	default administrative distance to be applied to routes that enter the RIB through this OriginTable.
igp	true if the routing protocol that will inject routes is a Interior Gateway Protocol such as OSPF. False if it's an EGP such as BGP (or IBGP).

Returns: -1 if table cannot be created, 0 otherwise.

See also: OriginTable

Add a new MergedTable. Use is deprecated, except in test suites.

Parameters:

tablename	human-readable name for this table to help in debugging
table_a	parent routing table that will feed routes in to this MergedTable
table_b	parent routing table that will feed routes in to this MergedTable

Returns: 0 on success, -1 if table_a or table_b does not exist.

See also: MergedTable

Add a new ExtIntTable. Use is deprecated, except in test suites.

Parameters:

tablename	human-readable name for this table to help in debugging
t_ext	parent routing table that will feed EGP routes in to this ExtIntTable
t_int	parent routing table that will feed IGP routes in to this ExtIntTable

Returns: 0 on success, -1 if t_ext or t_int does not exist.

See also: ExtIntTable

[virtual]

Inform the RIB about the existence of a Virtual Interface.

Parameters:

vifname	the name of the VIF, as understood by the FEA.
vif	Vif class instance giving the information about this vif.

Returns: 0 on success, -1 if vif named vifname already exists.

See also: Vif

[virtual]

Inform the RIB that a VIF no longer exists.

Parameters:

vifname

the name of the VIF, as previously indicated by new_vif.

Returns: 0 on success, -1 if vif named vifname doesn't exist.

[virtual]

Add an address and subnet to a existing VIF. Each VIF may have multiple addresses and associated subnets.

Parameters:

vifname	the name of the VIF the address will be added to.
addr	the address to be added. This must be one of the addresses of this router.
net	the subnet that is connected to this VIF corresponding to the address addr.

Returns: 0 on success, -1 if vif is unknown.

[virtual]

Remove an address and the associated subnet from an existing VIF.

Parameters:

vifname	the name of the VIF the address will be removed from.
addr	the address to be removed. This must be an address previously added by add_vif_address

Returns: 0 on success, -1 if vif is unknown or addr is not an address on this vif.

[virtual]

Add a route via the OriginTable called tablename.

Parameters:

tablename	the name of the OriginTable into which the route should be inserted.
net	the subnet (address and prefix length) of the route.
addr	the nexthop that packets destined for net should be forwarded to.
the	routing protocol metric associated with this route.

Returns: 0 on success, -1 otherwise.

[virtual]

Replace an existing route via the OriginTable called tablename.

Parameters:

tablename	the name of the OriginTable in which the route should be replaced.
net	the subnet (address and prefix length) of the route.
addr	the new nexthop that packets destined for net should be forwarded to.
the	new routing protocol metric associated with this route.

Returns: 0 on success, -1 otherwise.

[virtual]

Verify that expected routing information is correct. This is intended for testing purposes only.

Returns: 0 on successful verification, -1 otherwise.

[virtual]

Delete an existing route via the OriginTable called tablename.

Parameters:

tablename	the name of the OriginTable in which the route should be deleted.
subnet	the subnet (address and prefix length) of the route to be deleted.

Returns: 0 on success, -1 otherwise.

[virtual]

Lookup an address in the RIB to determine the nexthop router to which packets for this address will be forwarded.

Parameters:

lookupaddr

the address to be looked up.

Returns: pointer to address of next hop for lookupaddr if available, A::ZERO() otherwise.

[virtual]

Used for debugging only

[virtual]

Register interest in being notified about all changes to routing information that would affect traffic destined for a particular address

Parameters:

lookupaddr	the address to register interest in.
module	the XRL module name to which notifications of changes should be sent.

[virtual]

De-register interest in being notified about all changes to routing information for a particular address.

Parameters:

lookupaddr	the address to de-register interest in.
module	the XRL module name to which notifications of changes should no longer be sent.

Returns: true on successful deregistration, false if the entry to be deregistered was not found.

See also: route_register

[virtual]

Enable Redistribution.

Parameters:

fromtable	the name of the source redistribition table.
totable	the name of the destination table to which routes should be redistributed (must be an OriginTable<A> name).

Returns: 0 on success, -1 if either table does not exists or redistribution is already enabled.

[virtual]

Disable redistribution.

Parameters:

fromtable	the name of the source redistribition table.
totable	the name of the destination table to which routes were previously redistributed (must be an OriginTable<A> name).

Returns: 0 on success, -1 if table does not exist.

[virtual]

Create the OriginTable for an IGP protocol and plumb it into the RIB. Typically this will be called when a new instance of an IGP routing protocol such as OSPF starts up.

Parameters:

tablename

the routing protocol name. This should be one of the list of names the RIB knows about, or the incorrect default administrative distance will be applied.

Returns: 0 on success, -1 otherwise.

[virtual]

Delete the OriginTable for an IGP protocol and unplumb it from the RIB. Typically this will be called when an instance of an IGP routing protocol such as OSPF exits.

Parameters:

tablename

the routing protocol name, previously registered using add_igp_table .

Returns: 0 on success, -1 otherwise.

[virtual]

Create the OriginTable for an EGP protocol and plumb it into the RIB. Typically this will be called when a new instance of an EGP routing protocol such as EBGP or IBGP starts up. Note that EBGP and IBGP should register separately.

Parameters:

tablename

the routing protocol name. This should be one of the list of names the RIB knows about, or the incorrect default administrative distance will be applied.

Returns: 0 on success, -1 otherwise.

[virtual]

Delete the OriginTable for an EGP protocol and unplumb it from the RIB. Typically this will be called when an instance of an EGP routing protocol such as BGP exits.

Parameters:

tablename

the routing protocol name, previously registered using add_igp_table .

Returns: 0 on success, -1 otherwise.

[const]

Print the RIB structure for debugging

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]