Source: ../../mfea/xrl_mfea_node.hh
|
|
|
|
// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-
// Copyright (c) 2001,2002 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/mfea/xrl_mfea_node.hh,v 1.1.1.1 2002/12/11 23:56:06 hodson Exp $
#ifndef __MFEA_XRL_MFEA_NODE_HH__
#define __MFEA_XRL_MFEA_NODE_HH__
//
// MFEA (Multicast Forwarding Engine Abstraction) XRL-aware node definition.
//
#include <string>
#include "libxorp/xlog.h"
#include "xrl/targets/mfea_base.hh"
#include "xrl/interfaces/common_xif.hh"
#include "xrl/interfaces/mfea_client_xif.hh"
#include "xrl/interfaces/cli_manager_xif.hh"
#include "mfea_node.hh"
#include "mfea_node_cli.hh"
class EventLoop;
//
// The top-level class that wraps-up everything together under one roof
//
class XrlMfeaNode : public MfeaNode,
public XrlMfeaTargetBase,
public XrlCommonV0p1Client,
public XrlMfeaClientV0p1Client,
public XrlCliManagerV0p1Client,
public MfeaNodeCli {
public:
XrlMfeaNode(int family, x_module_id module_id,
EventLoop& event_loop, XrlRouter* r)
: MfeaNode(family, module_id, event_loop),
XrlMfeaTargetBase(r),
XrlCommonV0p1Client(r),
XrlMfeaClientV0p1Client(r),
XrlCliManagerV0p1Client(r),
MfeaNodeCli(*static_cast<MfeaNode *>(this))
{ }
virtual ~XrlMfeaNode() { MfeaNode::stop(); MfeaNodeCli::stop(); }
//
// XrlMfeaNode front-end interface
//
int enable_cli();
int disable_cli();
int start_cli();
int stop_cli();
int enable_mfea();
int disable_mfea();
int start_mfea();
int stop_mfea();
protected:
//
// Protocol node methods
//
int proto_send(const string& dst_module_instance_name,
x_module_id dst_module_id,
uint16_t vif_index,
const IPvX& src, const IPvX& dst,
int ip_ttl, int ip_tos, bool router_alert_bool,
const uint8_t * sndbuf, size_t sndlen);
//
// XXX: xrl_result_recv_protocol_message() in fact
// is the callback when proto_send() calls send_recv_protocol_message()
// so the destination protocol will receive a protocol message.
// Sigh, the 'recv' part in the name is rather confusing, but that
// is in the name of consistency between the XRL calling function
// and the return result callback...
//
void xrl_result_recv_protocol_message(const XrlError& xrl_error,
const bool *fail,
const string *reason);
int signal_message_send(const string& dst_module_instance_name,
x_module_id dst_module_id,
int message_type,
uint16_t vif_index,
const IPvX& src, const IPvX& dst,
const uint8_t *rcvbuf, size_t rcvlen);
//
// Methods for sending MRIB information
//
int send_add_mrib(const string& dst_module_instance_name,
x_module_id dst_module_id,
const Mrib& mrib);
int send_delete_mrib(const string& dst_module_instance_name,
x_module_id dst_module_id,
const Mrib& mrib);
int send_set_mrib_done(const string& dst_module_instance_name,
x_module_id dst_module_id);
//
// XXX: xrl_result_recv_kernel_signal_message() in fact
// is the callback when signal_message_send() calls
// send_recv_kernel_signal_message()
// so the destination protocol will receive a kernel message.
// Sigh, the 'recv' part in the name is rather confusing, but that
// is in the name of consistency between the XRL calling function
// and the return result callback...
//
void xrl_result_recv_kernel_signal_message(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_new_vif(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_delete_vif(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_add_vif_addr(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_delete_vif_addr(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_set_vif_flags(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_set_vif_done(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_set_all_vifs_done(const XrlError& xrl_error,
const bool *fail,
const string *reason);
int dataflow_signal_send(const string& dst_module_instance_name,
x_module_id dst_module_id,
const IPvX& source_addr,
const IPvX& group_addr,
uint32_t threshold_interval_sec,
uint32_t threshold_interval_usec,
uint32_t measured_interval_sec,
uint32_t measured_interval_usec,
uint32_t threshold_packets,
uint32_t threshold_bytes,
uint32_t measured_packets,
uint32_t measured_bytes,
bool is_threshold_in_packets,
bool is_threshold_in_bytes,
bool is_geq_upcall,
bool is_leq_upcall);
void xrl_result_recv_dataflow_signal(const XrlError& xrl_error,
const bool *fail,
const string *reason);
//
// Protocol node CLI methods
//
int add_cli_command_to_cli_manager(const char *command_name,
const char *command_help,
bool is_command_cd,
const char *command_cd_prompt,
bool is_command_processor);
void xrl_result_add_cli_command(const XrlError& xrl_error,
const bool *fail,
const string *reason);
int delete_cli_command_from_cli_manager(const char *command_name);
void xrl_result_delete_cli_command(const XrlError& xrl_error,
const bool *fail,
const string *reason);
//
// XRL target methods
//
/**
* Get name of Xrl Target
*/
XrlCmdError common_0_1_get_target_name(
// Output values,
string& name);
/**
* Get version string from Xrl Target
*/
XrlCmdError common_0_1_get_version(
// Output values,
string& version);
XrlCmdError cli_processor_0_1_process_command(
// Input values,
const string& processor_name,
const string& cli_term_name,
const uint32_t& cli_session_id,
const string& command_name,
const string& command_args,
// Output values,
string& ret_processor_name,
string& ret_cli_term_name,
uint32_t& ret_cli_session_id,
string& ret_command_output);
/**
* Add/delete a protocol in the Multicast FEA.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol to add/delete.
*
* @param protocol_id the ID of the protocol to add/delete
* (both sides must agree on the particular values).
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_add_protocol4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_add_protocol6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_protocol4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_protocol6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
// Output values,
bool& fail,
string& reason);
/**
* Start/stop a protocol on an interface in the Multicast FEA.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol to start/stop on the
* particular vif.
*
* @param protocol_id the ID of the protocol to add/stop on the particular
* vif (both sides must agree on the particular values).
*
* @param vif_name the name of the vif to start/stop for the particular
* protocol.
*
* @param vif_index the index of the vif to start/stop for the particular
* protocol.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_start_protocol_vif4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_start_protocol_vif6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_protocol_vif4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_protocol_vif6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable the receiving of kernel-originated signal messages.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol to add.
*
* @param protocol_id the ID of the protocol to add (both sides must agree
* on the particular values).
*
* @param is_allow if true, enable the receiving of kernel-originated
* signal messages by protocol
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*
* @protocol_name.
*/
XrlCmdError mfea_0_1_allow_signal_messages(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const bool& is_allow,
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable the receiving of Multicast Routing Information Base
* information.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol to add.
*
* @param protocol_id the ID of the protocol to add (both sides must agree
* on the particular values).
*
* @param is_allow if true, enable the receiving of MRIB information
* messages by protocol 'protocol_name'.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_allow_mrib_messages(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const bool& is_allow,
// Output values,
bool& fail,
string& reason);
void xrl_result_add_mrib(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_delete_mrib(const XrlError& xrl_error,
const bool *fail,
const string *reason);
void xrl_result_set_mrib_done(const XrlError& xrl_error,
const bool *fail,
const string *reason);
/**
* Join/leave a multicast group.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol that joins/leave the
* group.
*
* @param protocol_id the ID of the protocol that joins/leave the group
* (both sides must agree on the particular values).
*
* @param vif_name the name of the vif to join/leave the multicast group.
*
* @param vif_index the index of the vif to join/leave the multicast
* group.
*
* @param group_address the multicast group to join/leave
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_join_multicast_group4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& group_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_join_multicast_group6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& group_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_leave_multicast_group4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& group_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_leave_multicast_group6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& group_address,
// Output values,
bool& fail,
string& reason);
/**
* Add/delete a Multicast Forwarding Cache with the kernel.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param source_address the source address of the MFC to add/delete.
*
* @param group_address the group address of the MFC to add/delete.
*
* @param iif_vif_index the index of the vif that is the incoming
* interface.
*
* @param oiflist the bit-vector with the set of outgoing interfaces.
*
* @param oiflist_disable_wrongvif the bit-vector with the set of outgoing
* interfaces to disable WRONGVIF kernel signal.
*
* @param max_vifs_oiflist the number of vifs covered by oiflist or
* oiflist_disable_wrongvif .
*
* @param rp_address the RP address of the MFC to add.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_add_mfc4(
// Input values,
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
const uint32_t& iif_vif_index,
const vector<uint8_t>& oiflist,
const vector<uint8_t>& oiflist_disable_wrongvif,
const uint32_t& max_vifs_oiflist,
const IPv4& rp_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_add_mfc6(
// Input values,
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
const uint32_t& iif_vif_index,
const vector<uint8_t>& oiflist,
const vector<uint8_t>& oiflist_disable_wrongvif,
const uint32_t& max_vifs_oiflist,
const IPv6& rp_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_mfc4(
// Input values,
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_mfc6(
// Input values,
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
// Output values,
bool& fail,
string& reason);
/**
* Send a protocol message to the MFEA.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param protocol_name the name of the protocol that sends a message.
*
* @param protocol_id the ID of the protocol that sends a message (both
* sides must agree on the particular values).
*
* @param vif_name the name of the vif to send the message.
*
* @param vif_index the vif index of the vif to send the message.
*
* @param source_address the address of the sender.
*
* @param dest_address the destination address.
*
* @param ip_ttl the TTL of the IP packet to send. If it has a negative
* value, the TTL will be set by the lower layers.
*
* @param ip_tos the TOS of the IP packet to send. If it has a negative
* value, the TOS will be set by the lower layers.
*
* @param is_router_alert set/reset the IP Router Alert option in the IP
* packet to send (when applicable).
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_send_protocol_message4(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv4& source_address,
const IPv4& dest_address,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& is_router_alert,
const vector<uint8_t>& protocol_message,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_send_protocol_message6(
// Input values,
const string& xrl_sender_name,
const string& protocol_name,
const uint32_t& protocol_id,
const string& vif_name,
const uint32_t& vif_index,
const IPv6& source_address,
const IPv6& dest_address,
const int32_t& ip_ttl,
const int32_t& ip_tos,
const bool& is_router_alert,
const vector<uint8_t>& protocol_message,
// Output values,
bool& fail,
string& reason);
/**
* Add/delete a dataflow monitor with the MFEA.
*
* @param xrl_sender_name the XRL name of the originator of this XRL.
*
* @param source_address the source address of the dataflow to start/stop
* monitoring.
*
* @param group_address the group address of the dataflow to start/stop
* monitoring.
*
* @param threshold_interval_sec the number of seconds in the interval to
* measure.
*
* @param threshold_interval_usec the number of microseconds in the
* interval to measure.
*
* @param threshold_packets the threshold (in number of packets) to
* compare against.
*
* @param threshold_bytes the threshold (in number of bytes) to compare
* against.
*
* @param is_threshold_in_packets if true, threshold_packets is valid.
*
* @param is_threshold_in_bytes if true, threshold_bytes is valid.
*
* @param is_geq_upcall if true, the operation for comparison is ">=".
*
* @param is_leq_upcall if true, the operation for comparison is "<=".
*/
XrlCmdError mfea_0_1_add_dataflow_monitor4(
// Input values,
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_add_dataflow_monitor6(
// Input values,
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_dataflow_monitor4(
// Input values,
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_dataflow_monitor6(
// Input values,
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
const uint32_t& threshold_interval_sec,
const uint32_t& threshold_interval_usec,
const uint32_t& threshold_packets,
const uint32_t& threshold_bytes,
const bool& is_threshold_in_packets,
const bool& is_threshold_in_bytes,
const bool& is_geq_upcall,
const bool& is_leq_upcall,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_all_dataflow_monitor4(
// Input values,
const string& xrl_sender_name,
const IPv4& source_address,
const IPv4& group_address,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_delete_all_dataflow_monitor6(
// Input values,
const string& xrl_sender_name,
const IPv6& source_address,
const IPv6& group_address,
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable/start/stop a MFEA vif interface.
*
* @param vif_name the name of the vif to enable/disable/start/stop.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_enable_vif(
// Input values,
const string& vif_name,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_disable_vif(
// Input values,
const string& vif_name,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_start_vif(
// Input values,
const string& vif_name,
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_vif(
// Input values,
const string& vif_name,
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable/start/stop all MFEA vif interfaces.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_enable_all_vifs(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_disable_all_vifs(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_start_all_vifs(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_all_vifs(
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable/start/stop MFEA and the MFEA CLI access.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_enable_mfea(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_disable_mfea(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_enable_cli(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_disable_cli(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_start_mfea(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_mfea(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_start_cli(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_stop_cli(
// Output values,
bool& fail,
string& reason);
/**
* Enable/disable the MFEA trace log.
*
* @param fail true if failure has occured.
*
* @param reason contains failure reason if it occured.
*/
XrlCmdError mfea_0_1_enable_log_trace(
// Output values,
bool& fail,
string& reason);
XrlCmdError mfea_0_1_disable_log_trace(
// Output values,
bool& fail,
string& reason);
private:
const string& my_xrl_target_name() {
return XrlMfeaTargetBase::_router->name();
}
int family() const { return (MfeaNode::family()); }
};
#endif // __MFEA_XRL_MFEA_NODE_HH__
| Generated by: pavlin on possum.icir.org on Wed Dec 11 16:50:48 2002, using kdoc 2.0a54+XORP. |
