Source: ../../mld6igmp/xrl_mld6igmp_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/mld6igmp/xrl_mld6igmp_node.hh,v 1.23 2004/06/10 22:41:28 hodson Exp $
#ifndef __MLD6IGMP_XRL_MLD6IGMP_NODE_HH__
#define __MLD6IGMP_XRL_MLD6IGMP_NODE_HH__
//
// MLD6IGMP XRL-aware node definition.
//
#include <string>
#include "libxorp/xlog.h"
#include "libxipc/xrl_router.hh"
#include "xrl/targets/mld6igmp_base.hh"
#include "xrl/interfaces/mfea_xif.hh"
#include "xrl/interfaces/cli_manager_xif.hh"
#include "xrl/interfaces/mld6igmp_client_xif.hh"
#include "mld6igmp_node.hh"
#include "mld6igmp_node_cli.hh"
//
// The top-level class that wraps-up everything together under one roof
//
class XrlMld6igmpNode : public Mld6igmpNode,
public XrlMld6igmpTargetBase,
public Mld6igmpNodeCli {
public:
XrlMld6igmpNode(int family,
xorp_module_id module_id,
EventLoop& eventloop,
XrlRouter* xrl_router,
const string& mfea_target);
virtual ~XrlMld6igmpNode();
/**
* 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();
//
// XrlMld6igmpNode front-end interface
//
int enable_cli();
int disable_cli();
int start_cli();
int stop_cli();
int enable_mld6igmp();
int disable_mld6igmp();
int start_mld6igmp();
int stop_mld6igmp();
protected:
//
// 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);
/**
* Get status from Xrl Target
*/
XrlCmdError common_0_1_get_status(// Output values,
uint32_t& status,
string& reason);
/**
* Shutdown cleanly
*/
XrlCmdError common_0_1_shutdown();
/**
* Process a CLI command.
*
* @param processor_name the processor name for this command.
*
* @param cli_term_name the terminal name the command was entered from.
*
* @param cli_session_id the CLI session ID the command was entered from.
*
* @param command_name the command name to process.
*
* @param command_args the command arguments to process.
*
* @param ret_processor_name the processor name to return back to the CLI.
*
* @param ret_cli_term_name the terminal name to return back.
*
* @param ret_cli_session_id the CLI session ID to return back.
*
* @param ret_command_output the command output to return back.
*/
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 a new vif.
*
* @param vif_name the name of the new vif.
*
* @param vif_index the index of the new vif.
*/
XrlCmdError mfea_client_0_1_new_vif(
// Input values,
const string& vif_name,
const uint32_t& vif_index);
/**
* Delete an existing vif.
*
* @param vif_name the name of the vif to delete.
*/
XrlCmdError mfea_client_0_1_delete_vif(
// Input values,
const string& vif_name);
/**
* Add an address to a vif.
*
* @param vif_name the name of the vif.
*
* @param addr the unicast address to add.
*
* @param subnet the subnet address to add.
*
* @param broadcast the broadcast address (when applicable).
*
* @param peer the peer address (when applicable).
*/
XrlCmdError mfea_client_0_1_add_vif_addr4(
// Input values,
const string& vif_name,
const IPv4& addr,
const IPv4Net& subnet,
const IPv4& broadcast,
const IPv4& peer);
XrlCmdError mfea_client_0_1_add_vif_addr6(
// Input values,
const string& vif_name,
const IPv6& addr,
const IPv6Net& subnet,
const IPv6& broadcast,
const IPv6& peer);
/**
* Delete an address from a vif.
*
* @param vif_name the name of the vif.
*
* @param addr the unicast address to delete.
*/
XrlCmdError mfea_client_0_1_delete_vif_addr4(
// Input values,
const string& vif_name,
const IPv4& addr);
XrlCmdError mfea_client_0_1_delete_vif_addr6(
// Input values,
const string& vif_name,
const IPv6& addr);
/**
* Set flags to a vif.
*
* @param vif_name the name of the vif.
*
* @param is_pim_register true if this is a PIM Register vif.
*
* @param is_p2p true if this is a point-to-point vif.
*
* @param is_loopback true if this is a loopback interface.
*
* @param is_multicast true if the vif is multicast-capable.
*
* @param is_broadcast true if the vif is broadcast-capable.
*
* @param is_up true if the vif is UP and running.
*/
XrlCmdError mfea_client_0_1_set_vif_flags(
// Input values,
const string& vif_name,
const bool& is_pim_register,
const bool& is_p2p,
const bool& is_loopback,
const bool& is_multicast,
const bool& is_broadcast,
const bool& is_up);
/**
* Complete all transactions with vif information.
*/
XrlCmdError mfea_client_0_1_set_all_vifs_done();
/**
* Test if the vif setup is completed.
*
* @param is_completed if true the vif setup is completed.
*/
XrlCmdError mfea_client_0_1_is_vif_setup_completed(
// Output values,
bool& is_completed);
/**
* Receive a protocol message from 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 the message was received on.
*
* @param vif_index the index of the vif the message was received on.
*
* @param source_address the address of the sender.
*
* @param dest_address the destination address.
*
* @param ip_ttl the TTL of the received IP packet. If it has a negative
* value, it should be ignored.
*
* @param ip_tos the TOS of the received IP packet. If it has a negative
* value, it should be ignored.
*
* @param is_router_alert if true, the IP Router Alert option in
* the IP packet was set (when applicable).
*
* @param protocol_message the protocol message.
*/
XrlCmdError mfea_client_0_1_recv_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);
XrlCmdError mfea_client_0_1_recv_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);
/**
* Receive a kernel signal message from 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 message_type the type of the kernel signal message (TODO:
* integer for now: the particular types are well-known by both sides).
*
* @param vif_name the name of the vif the message was received on.
*
* @param vif_index the index of the vif the message was received on.
*
* @param source_address the address of the sender.
*
* @param dest_address the destination address.
*
* @param protocol_message the protocol message.
*/
XrlCmdError mfea_client_0_1_recv_kernel_signal_message4(
// Input values,
const string& , // xrl_sender_name,
const string& , // protocol_name,
const uint32_t& , // protocol_id,
const uint32_t& , // message_type,
const string& , // vif_name,
const uint32_t& , // vif_index,
const IPv4& , // source_address,
const IPv4& , // dest_address,
const vector<uint8_t>& // protocol_message
) {
string msg = "Unexpected kernel signal message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_recv_kernel_signal_message6(
// Input values,
const string& , // xrl_sender_name,
const string& , // protocol_name,
const uint32_t& , // protocol_id,
const uint32_t& , // message_type,
const string& , // vif_name,
const uint32_t& , // vif_index,
const IPv6& , // source_address,
const IPv6& , // dest_address,
const vector<uint8_t>& // protocol_message
) {
string msg = "Unexpected kernel signal message";
return XrlCmdError::COMMAND_FAILED(msg);
}
//
// MRIB-related add/delete/done: not used by MLD or IGMP.
//
XrlCmdError mfea_client_0_1_add_mrib4(
// Input values,
const string& , // xrl_sender_name,
const IPv4Net& , // dest_prefix,
const IPv4& , // next_hop_router_addr,
const string& , // next_hop_vif_name,
const uint32_t& , // next_hop_vif_index,
const uint32_t& , // metric_preference,
const uint32_t& // metric
) {
string msg = "Unexpected add_mrib() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_add_mrib6(
// Input values,
const string& , // xrl_sender_name,
const IPv6Net& , // dest_prefix,
const IPv6& , // next_hop_router_addr,
const string& , // next_hop_vif_name,
const uint32_t& , // next_hop_vif_index,
const uint32_t& , // metric_preference,
const uint32_t& // metric
) {
string msg = "Unexpected add_mrib() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_delete_mrib4(
// Input values,
const string& , // xrl_sender_name,
const IPv4Net& // dest_prefix
) {
string msg = "Unexpected delete_mrib() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_delete_mrib6(
// Input values,
const string& , // xrl_sender_name,
const IPv6Net& // dest_prefix
) {
string msg = "Unexpected delete_mrib() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_set_mrib_done(
// Input values,
const string& // xrl_sender_name
) {
string msg = "Unexpected set_mrib_done() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
//
// A signal that a dataflow-related pre-condition is true:
// not used by MLD or IGMP.
//
XrlCmdError mfea_client_0_1_recv_dataflow_signal4(
// 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& , // measured_interval_sec,
const uint32_t& , // measured_interval_usec,
const uint32_t& , // threshold_packets,
const uint32_t& , // threshold_bytes,
const uint32_t& , // measured_packets,
const uint32_t& , // measured_bytes,
const bool& , // is_threshold_in_packets,
const bool& , // is_threshold_in_bytes,
const bool& , // is_geq_upcall,
const bool& // is_leq_upcall
) {
string msg = "Unexpected recv_dataflow_signal4() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
XrlCmdError mfea_client_0_1_recv_dataflow_signal6(
// 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& , // measured_interval_sec,
const uint32_t& , // measured_interval_usec,
const uint32_t& , // threshold_packets,
const uint32_t& , // threshold_bytes,
const uint32_t& , // measured_packets,
const uint32_t& , // measured_bytes,
const bool& , // is_threshold_in_packets,
const bool& , // is_threshold_in_bytes,
const bool& , // is_geq_upcall,
const bool& // is_leq_upcall
) {
string msg = "Unexpected recv_dataflow_signal4() message";
return XrlCmdError::COMMAND_FAILED(msg);
}
/**
* Enable/disable/start/stop a MLD6IGMP vif interface.
*
* @param vif_name the name of the vif to enable/disable/start/stop.
*
* @param enable if true, then enable the vif, otherwise disable it.
*/
XrlCmdError mld6igmp_0_1_enable_vif(
// Input values,
const string& vif_name,
const bool& enable);
XrlCmdError mld6igmp_0_1_start_vif(
// Input values,
const string& vif_name);
XrlCmdError mld6igmp_0_1_stop_vif(
// Input values,
const string& vif_name);
/**
* Enable/disable/start/stop all MLD6IGMP vif interfaces.
*
* @param enable if true, then enable the vifs, otherwise disable them.
*/
XrlCmdError mld6igmp_0_1_enable_all_vifs(
// Input values,
const bool& enable);
XrlCmdError mld6igmp_0_1_start_all_vifs();
XrlCmdError mld6igmp_0_1_stop_all_vifs();
/**
* Enable/disable/start/stop the MLD6IGMP protocol.
*
* @param enable if true, then enable the MLD6IGMP protocol, otherwise
* disable it.
*/
XrlCmdError mld6igmp_0_1_enable_mld6igmp(
// Input values,
const bool& enable);
XrlCmdError mld6igmp_0_1_start_mld6igmp();
XrlCmdError mld6igmp_0_1_stop_mld6igmp();
/**
* Enable/disable/start/stop the MLD6IGMP CLI access.
*
* @param enable if true, then enable the MLD6IGMP CLI access, otherwise
* disable it.
*/
XrlCmdError mld6igmp_0_1_enable_cli(
// Input values,
const bool& enable);
XrlCmdError mld6igmp_0_1_start_cli();
XrlCmdError mld6igmp_0_1_stop_cli();
/**
* Configure MLD6IGMP interface-related metrics. The 'set_foo' XRLs set
* the particular values. The 'reset_foo' XRLs reset the metrics to their
* default values.
*
* @param vif_name the name of the vif to configure.
*
* @param proto_version the protocol version.
*/
XrlCmdError mld6igmp_0_1_get_vif_proto_version(
// Input values,
const string& vif_name,
// Output values,
uint32_t& proto_version);
XrlCmdError mld6igmp_0_1_set_vif_proto_version(
// Input values,
const string& vif_name,
const uint32_t& proto_version);
XrlCmdError mld6igmp_0_1_reset_vif_proto_version(
// Input values,
const string& vif_name);
/**
* Enable/disable the MLD6IGMP trace log for all operations.
*
* @param enable if true, then enable the trace log, otherwise disable it.
*/
XrlCmdError mld6igmp_0_1_log_trace_all(
// Input values,
const bool& enable);
/**
* Add/delete a client protocol in the MLD/IGMP protocol.
*
* @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 vif_name the name of the vif the protocol add/delete to apply
* to.
*
* @param vif_index the index of the vif the protocol add/delete to apply
* to. The added protocol will receive Join/Leave membership information
* about same-LAN members for the particular vif.
*/
XrlCmdError mld6igmp_0_1_add_protocol4(
// 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);
XrlCmdError mld6igmp_0_1_add_protocol6(
// 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);
XrlCmdError mld6igmp_0_1_delete_protocol4(
// 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);
XrlCmdError mld6igmp_0_1_delete_protocol6(
// 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);
private:
void mfea_register_startup();
void mfea_register_shutdown();
void send_mfea_registration();
void mfea_client_send_add_protocol_cb(const XrlError& xrl_error);
void send_mfea_deregistration();
void mfea_client_send_delete_protocol_cb(const XrlError& xrl_error);
//
// Protocol node methods
//
int start_protocol_kernel_vif(uint16_t vif_index);
int stop_protocol_kernel_vif(uint16_t vif_index);
void send_start_stop_protocol_kernel_vif();
void mfea_client_send_start_stop_protocol_kernel_vif_cb(const XrlError& xrl_error);
int join_multicast_group(uint16_t vif_index, const IPvX& multicast_group);
int leave_multicast_group(uint16_t vif_index, const IPvX& multicast_group);
void send_join_leave_multicast_group();
void mfea_client_send_join_leave_multicast_group_cb(const XrlError& xrl_error);
int send_add_membership(const string& dst_module_instance_name,
xorp_module_id dst_module_id,
uint16_t vif_index,
const IPvX& source,
const IPvX& group);
int send_delete_membership(const string& dst_module_instance_name,
xorp_module_id dst_module_id,
uint16_t vif_index,
const IPvX& source,
const IPvX& group);
void send_add_delete_membership();
void mld6igmp_client_send_add_delete_membership_cb(const XrlError& xrl_error);
int proto_send(const string& dst_module_instance_name,
xorp_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);
void mfea_client_send_protocol_message_cb(const XrlError& xrl_error);
//
// 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 cli_manager_client_send_add_cli_command_cb(const XrlError& xrl_error);
int delete_cli_command_from_cli_manager(const char *command_name);
void cli_manager_client_send_delete_cli_command_cb(const XrlError& xrl_error);
const string& my_xrl_target_name() {
return XrlMld6igmpTargetBase::name();
}
int family() const { return (Mld6igmpNode::family()); }
/**
* Class for handling the queue of Join/Leave multicast group requests
*/
class JoinLeaveMulticastGroup {
public:
JoinLeaveMulticastGroup(uint16_t vif_index,
const IPvX& multicast_group,
bool is_join)
: _vif_index(vif_index),
_multicast_group(multicast_group),
_is_join(is_join) {}
uint16_t vif_index() const { return _vif_index; }
const IPvX& multicast_group() const { return _multicast_group; }
bool is_join() const { return _is_join; }
private:
uint16_t _vif_index;
IPvX _multicast_group;
bool _is_join;
};
/**
* Class for handling the queue of sending Add/Delete membership requests
*/
class SendAddDeleteMembership {
public:
SendAddDeleteMembership(const string& dst_module_instance_name,
xorp_module_id dst_module_id,
uint16_t vif_index,
const IPvX& source,
const IPvX& group,
bool is_add)
: _dst_module_instance_name(dst_module_instance_name),
_dst_module_id(dst_module_id),
_vif_index(vif_index),
_source(source),
_group(group),
_is_add(is_add) {}
const string& dst_module_instance_name() const { return _dst_module_instance_name; }
xorp_module_id dst_module_id() const { return _dst_module_id; }
uint16_t vif_index() const { return _vif_index; }
const IPvX& source() const { return _source; }
const IPvX& group() const { return _group; }
bool is_add() const { return _is_add; }
private:
string _dst_module_instance_name;
xorp_module_id _dst_module_id;
uint16_t _vif_index;
IPvX _source;
IPvX _group;
bool _is_add;
};
const string _class_name;
const string _instance_name;
XrlMfeaV0p1Client _xrl_mfea_client;
XrlMld6igmpClientV0p1Client _xrl_mld6igmp_client_client;
XrlCliManagerV0p1Client _xrl_cli_manager_client;
const string _mfea_target;
bool _is_mfea_add_protocol_registered;
XorpTimer _mfea_registration_timer;
list<pair<uint16_t, bool> > _start_stop_protocol_kernel_vif_queue;
XorpTimer _start_stop_protocol_kernel_vif_queue_timer;
list<JoinLeaveMulticastGroup> _join_leave_multicast_group_queue;
XorpTimer _join_leave_multicast_group_queue_timer;
list<SendAddDeleteMembership> _send_add_delete_membership_queue;
XorpTimer _send_add_delete_membership_queue_timer;
};
#endif // __MLD6IGMP_XRL_MLD6IGMP_NODE_HH__
Generated by: pavlin on possum.icir.org on Thu Jul 8 23:48:28 2004, using kdoc $.
