Source: ../../static_routes/static_routes_node.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001-2004 International Computer Science Institute
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software")
// to deal in the Software without restriction, subject to the conditions
// listed in the XORP LICENSE file. These conditions include: you must
// preserve this copyright notice, and you cannot mention the copyright
// holders in advertising related to the Software without their permission.
// The Software is provided WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED. This
// notice is a summary of the XORP LICENSE file; the license in that file is
// legally binding.
// $XORP: xorp/static_routes/static_routes_node.hh,v 1.10 2004/06/10 22:41:57 hodson Exp $
#ifndef __STATIC_ROUTES_STATIC_ROUTES_NODE_HH__
#define __STATIC_ROUTES_STATIC_ROUTES_NODE_HH__
//
// StaticRoutes node definition.
//
#include <map>
#include "libxorp/service.hh"
#include "libxorp/status_codes.h"
#include "libfeaclient/ifmgr_xrl_mirror.hh"
class EventLoop;
/**
* @short A StaticRoute helper class.
*
* This class is used to store a routing entry.
*/
class StaticRoute {
public:
/**
* Constructor for a given IPv4 static route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
*/
StaticRoute(bool unicast, bool multicast,
const IPv4Net& network, const IPv4& nexthop,
const string& ifname, const string& vifname,
uint32_t metric)
: _unicast(unicast), _multicast(multicast),
_network(network), _nexthop(nexthop),
_ifname(ifname), _vifname(vifname),
_metric(metric),
_route_type(IDLE_ROUTE), _is_ignored(false) {}
/**
* Constructor for a given IPv6 static route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
*/
StaticRoute(bool unicast, bool multicast,
const IPv6Net& network, const IPv6& nexthop,
const string& ifname, const string& vifname,
uint32_t metric)
: _unicast(unicast), _multicast(multicast),
_network(network), _nexthop(nexthop),
_ifname(ifname), _vifname(vifname),
_metric(metric),
_route_type(IDLE_ROUTE), _is_ignored(false) {}
/**
* Equality Operator
*
* @param other the right-hand operand to compare against.
* @return true if the left-hand operand is numerically same as the
* right-hand operand.
*/
bool operator==(const StaticRoute& other) {
return ((_unicast == other.unicast())
&& (_multicast == other.multicast())
&& (_network == other.network())
&& (_nexthop == other.nexthop())
&& (_ifname == other.ifname())
&& (_vifname == other.vifname())
&& (_metric == other.metric())
&& (_route_type == other._route_type));
}
/**
* Test if this is an IPv4 route.
*
* @return true if this is an IPv4 route, otherwise false.
*/
bool is_ipv4() const { return _network.is_ipv4(); }
/**
* Test if this is an IPv6 route.
*
* @return true if this is an IPv6 route, otherwise false.
*/
bool is_ipv6() const { return _network.is_ipv6(); }
/**
* Test if this route would be used for unicast routing.
*
* @return true if this route would be used for unicast routing,
* otherwise false.
*/
bool unicast() const { return _unicast; }
/**
* Test if this route would be used for multicast routing.
*
* @return true if this route would be used for multicast routing,
* otherwise false.
*/
bool multicast() const { return _multicast; }
/**
* Get the network address prefix this route applies to.
*
* @return the network address prefix this route appies to.
*/
const IPvXNet& network() const { return _network; }
/**
* Get the address of the next-hop router for this route.
*
* @return the address of the next-hop router for this route.
*/
const IPvX& nexthop() const { return _nexthop; }
/**
* Get the name of the physical interface toward the destination.
*
* @return the name of the physical interface toward the destination.
*/
const string& ifname() const { return _ifname; }
/**
* Get the name of the virtual interface toward the destination.
*
* @return the name of the virtual interface toward the destination.
*/
const string& vifname() const { return _vifname; }
/**
* Get the metric distance for this route.
*
* @return the metric distance for this route.
*/
uint32_t metric() const { return _metric; }
/**
* Test if this is a route to add.
*
* @return true if this is a route to add, otherwise false.
*/
bool is_add_route() const { return (_route_type == ADD_ROUTE); }
/**
* Test if this is a replacement route.
*
* @return true if this is a replacement route, otherwise false.
*/
bool is_replace_route() const { return (_route_type == REPLACE_ROUTE); }
/**
* Test if this is a route to delete.
*
* @return true if this is a route to delete, otherwise false.
*/
bool is_delete_route() const { return (_route_type == DELETE_ROUTE); }
/**
* Set the type of this route to "a route to add".
*/
void set_add_route() { _route_type = ADD_ROUTE; }
/**
* Set the type of this route to "a replacement route".
*/
void set_replace_route() { _route_type = REPLACE_ROUTE; }
/**
* Set the type of this route to "a route to delete".
*/
void set_delete_route() { _route_type = DELETE_ROUTE; }
/**
* Test if the route is interface-specific (e.g., if the interface
* is explicitly specified).
*
* @return true if the route is interface-specific, otherwise false.
*/
bool is_interface_route() const { return ! (_ifname.empty()
&& _vifname.empty()); }
/**
* Check whether the route entry is valid.
*
* @param error_msg the error message (if error).
* @return true if the route entry is valid, otherwise false.
*/
bool is_valid_entry(string& error_msg) const;
/**
* Test if the route is to be ignored.
*
* This method is used only for internal purpose when passing the route
* around.
*
* @return true if the route is to be ignored, otherwise false.
*/
bool is_ignored() const { return _is_ignored; }
/**
* Set whether the route is to be ignored.
*
* This method is used only for internal purpose when passing the route
* around.
*
* @param v true if the route is to be ignored, otherwise false.
*/
void set_ignored(bool v) { _is_ignored = v; }
private:
bool _unicast;
bool _multicast;
IPvXNet _network;
IPvX _nexthop;
string _ifname;
string _vifname;
uint32_t _metric;
enum RouteType { IDLE_ROUTE, ADD_ROUTE, REPLACE_ROUTE, DELETE_ROUTE };
RouteType _route_type;
bool _is_ignored; // True if the route is to be ignored
};
/**
* @short The StaticRoutes node class.
*
* There should be one node per StaticRoutes instance.
*/
class StaticRoutesNode : public IfMgrHintObserver,
public ServiceBase,
public ServiceChangeObserverBase {
public:
/**
* Constructor for a given event loop.
*
* @param eventloop the event loop to use.
*/
StaticRoutesNode(EventLoop& eventloop);
/**
* Destructor
*/
virtual ~StaticRoutesNode();
/**
* Get the event loop this node is added to.
*
* @return the event loop this node is added to.
*/
EventLoop& eventloop() { return _eventloop; }
/**
* Get the protocol name.
*
* @return a string with the protocol name.
*/
const string& protocol_name() const { return _protocol_name; }
/**
* Startup the node operation.
*
* @return true on success, false on failure.
*/
bool startup();
/**
* Shutdown the node operation.
*
* @return true on success, false on failure.
*/
bool shutdown();
/**
* Get the node status (see @ref ProcessStatus).
*
* @param reason_msg return-by-reference string that contains
* human-readable information about the status.
* @return the node status (see @ref ProcessStatus).
*/
ProcessStatus node_status(string& reason_msg);
/**
* Test if the node processing is done.
*
* @return true if the node processing is done, otherwise false.
*/
bool is_done() const { return (_node_status == PROC_DONE); }
/**
* Add a static IPv4 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int add_route4(bool unicast, bool multicast,
const IPv4Net& network, const IPv4& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg);
/**
* Add a static IPv6 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int add_route6(bool unicast, bool multicast,
const IPv6Net& network, const IPv6& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg);
/**
* Replace a static IPv4 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int replace_route4(bool unicast, bool multicast,
const IPv4Net& network, const IPv4& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg);
/**
* Replace a static IPv6 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param nexthop the address of the next-hop router for this route.
* @param ifname of the name of the physical interface toward the
* destination.
* @param vifname of the name of the virtual interface toward the
* destination.
* @param metric the metric distance for this route.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int replace_route6(bool unicast, bool multicast,
const IPv6Net& network, const IPv6& nexthop,
const string& ifname, const string& vifname,
uint32_t metric, string& error_msg);
/**
* Delete a static IPv4 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int delete_route4(bool unicast, bool multicast,
const IPv4Net& network, string& error_msg);
/**
* Delete a static IPv6 route.
*
* @param unicast if true, then the route would be used for unicast
* routing.
* @param multicast if true, then the route would be used in the MRIB
* (Multicast Routing Information Base) for multicast purpose (e.g.,
* computing the Reverse-Path Forwarding information).
* @param network the network address prefix this route applies to.
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int delete_route6(bool unicast, bool multicast,
const IPv6Net& network, string& error_msg);
//
// Debug-related methods
//
/**
* Test if trace log is enabled.
*
* This method is used to test whether to output trace log debug messges.
*
* @return true if trace log is enabled, otherwise false.
*/
bool is_log_trace() const { return (_is_log_trace); }
/**
* Enable/disable trace log.
*
* This method is used to enable/disable trace log debug messages output.
*
* @param is_enabled if true, trace log is enabled, otherwise is disabled.
*/
void set_log_trace(bool is_enabled) { _is_log_trace = is_enabled; }
protected:
//
// IfMgrHintObserver methods
//
void tree_complete();
void updates_made();
void incr_startup_requests_n();
void decr_startup_requests_n();
void incr_shutdown_requests_n();
void decr_shutdown_requests_n();
void update_status();
private:
/**
* A method invoked when the status of a service changes.
*
* @param service the service whose status has changed.
* @param old_status the old status.
* @param new_status the new status.
*/
void status_change(ServiceBase* service,
ServiceStatus old_status,
ServiceStatus new_status);
/**
* Get a reference to the service base of the interface manager.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @return a reference to the service base of the interface manager.
*/
virtual const ServiceBase* ifmgr_mirror_service_base() const = 0;
/**
* Get a reference to the interface manager tree.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @return a reference to the interface manager tree.
*/
virtual const IfMgrIfTree& ifmgr_iftree() const = 0;
/**
* Initiate startup of the interface manager.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @return true on success, false on failure.
*/
virtual bool ifmgr_startup() = 0;
/**
* Initiate shutdown of the interface manager.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @return true on success, false on failure.
*/
virtual bool ifmgr_shutdown() = 0;
/**
* Initiate registration with the RIB.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*/
virtual void rib_register_startup() = 0;
/**
* Initiate de-registration with the RIB.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*/
virtual void rib_register_shutdown() = 0;
/**
* Add a static IPvX route.
*
* @param static_route the route to add.
* @see StaticRoute
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int add_route(const StaticRoute& static_route, string& error_msg);
/**
* Replace a static IPvX route.
*
* @param static_route the replacement route.
* @see StaticRoute
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int replace_route(const StaticRoute& static_route, string& error_msg);
/**
* Delete a static IPvX route.
*
* @param static_route the route to delete.
* @see StaticRoute
* @param error_msg the error message (if error).
* @return XORP_OK on success, otherwise XORP_ERROR.
*/
int delete_route(const StaticRoute& static_route, string& error_msg);
/**
* Inform the RIB about a route change.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @param static_route the route with the information about the change.
*/
virtual void inform_rib_route_change(const StaticRoute& static_route) = 0;
/**
* Cancel a pending request to inform the RIB about a route change.
*
* This is a pure virtual function, and it must be implemented
* by the communication-wrapper class that inherits this base class.
*
* @param static_route the route with the request that would be canceled.
*/
virtual void cancel_rib_route_change(const StaticRoute& static_route) = 0;
/**
* Test if an address is directly connected to an interface.
*
* If an interface toward an address is down, then the address is not
* considered as directly connected.
*
* @param if_tree the tree with the interface state.
* @param addr the address to test.
* @return true if @ref addr is directly connected to an interface
* contained inside @ref if_tree, otherwise false.
*/
bool is_directly_connected(const IfMgrIfTree& if_tree,
const IPvX& addr) const;
EventLoop& _eventloop; // The event loop
ProcessStatus _node_status; // The node/process status
const string _protocol_name; // The protocol name
list<StaticRoute> _static_routes; // The routes
//
// Status-related state
//
size_t _startup_requests_n;
size_t _shutdown_requests_n;
//
// A local copy with the interface state information
//
IfMgrIfTree _iftree;
//
// Debug and test-related state
//
bool _is_log_trace; // If true, enable XLOG_TRACE()
};
#endif // __STATIC_ROUTES_STATIC_ROUTES_NODE_HH__
Generated by: pavlin on possum.icir.org on Thu Jul 8 23:48:42 2004, using kdoc $.
