class PimNode The PIM node class. More... Contains pure virtuals Definition #include <pim_node.hh> Inherits ProtoNode (libproto) [public ] Inherited by XrlPimNode List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  PimNode (int family, x_module_id module_id, EventLoop& event_loop)
• virtual  ~PimNode ()
• int  set_proto_version (int proto_version)
• int  start ()
• int  stop ()
• int  final_stop ()
• bool  has_pending_down_units ()
• int  add_vif (const Vif& vif)
• int  add_vif (const char *vif_name, uint16_t vif_index)
• int  delete_vif (const char *vif_name)
• int  set_vif_flags (const char *vif_name, bool is_pim_register, bool is_p2p, bool is_loopback, bool is_multicast, bool is_broadcast, bool is_up)
• int  add_vif_addr (const char *vif_name, const IPvX& addr, const IPvXNet& subnet_addr, const IPvX& broadcast_addr, const IPvX& peer_addr)
• int  delete_vif_addr (const char *vif_name, const IPvX& addr)
• int  start_all_vifs ()
• int  stop_all_vifs ()
• int  enable_all_vifs ()
• int  disable_all_vifs ()
• void  delete_all_vifs ()
• int  proto_recv (const string& src_module_instance_name, x_module_id src_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 *rcvbuf, size_t rcvlen)
• int  pim_send (uint16_t vif_index, const IPvX& src, const IPvX& dst, int ip_ttl, int ip_tos, bool router_alert_bool, buffer_t *buffer)
• int  signal_message_recv (const string& src_module_instance_name, x_module_id src_module_id, int message_type, uint16_t vif_index, const IPvX& src, const IPvX& dst, const uint8_t *rcvbuf, size_t rcvlen)
• int  signal_message_send (const string&, x_module_id , int , uint16_t , const IPvX& , const IPvX& , const uint8_t * , size_t )
• virtual int  start_protocol_kernel ()
• virtual int  stop_protocol_kernel ()
• virtual int  start_protocol_kernel_vif (uint16_t vif_index)
• virtual int  stop_protocol_kernel_vif (uint16_t vif_index)
• virtual int  join_multicast_group (uint16_t vif_index, const IPvX& multicast_group)
• virtual int  leave_multicast_group (uint16_t vif_index, const IPvX& multicast_group)
• virtual int  add_mfc_to_kernel (const PimMfc& pim_mfc)
• virtual int  delete_mfc_from_kernel (const PimMfc& pim_mfc)
• virtual int  add_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr, uint32_t threshold_interval_sec, uint32_t threshold_interval_usec, uint32_t threshold_packets, uint32_t threshold_bytes, bool is_threshold_in_packets, bool is_threshold_in_bytes, bool is_geq_upcall, bool is_leq_upcall)
• virtual int  delete_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr, uint32_t threshold_interval_sec, uint32_t threshold_interval_usec, uint32_t threshold_packets, uint32_t threshold_bytes, bool is_threshold_in_packets, bool is_threshold_in_bytes, bool is_geq_upcall, bool is_leq_upcall)
• virtual int  delete_all_dataflow_monitor (const IPvX& source_addr, const IPvX& group_addr)
• virtual int  add_protocol_mld6igmp (uint16_t vif_index)
• virtual int  delete_protocol_mld6igmp (uint16_t vif_index)
• int  add_membership (uint16_t vif_index, const IPvX& source, const IPvX& group)
• int  delete_membership (uint16_t vif_index, const IPvX& source, const IPvX& group)
• void  add_mrib_entry (const Mrib& mrib)
• void  delete_mrib_entry (const Mrib& mrib)
• PimVif * vif_find_pim_register () const
• uint16_t  pim_register_vif_index () const
• PimMrt&  pim_mrt ()
• PimMribTable&  pim_mrib_table ()
• PimBsr&  pim_bsr ()
• RpTable&  rp_table ()
• PimScopeZoneTable&  pim_scope_zone_table ()
• Mifset&  pim_vifs_dr ()
• void  set_pim_vifs_dr (uint16_t vif_index, bool v)
• PimNbr * pim_nbr_rpf_find (const IPvX& dst_addr)
• PimNbr * pim_nbr_rpf_find (const IPvX& dst_addr, const Mrib *mrib)
• PimNbr * pim_nbr_find (const IPvX& nbr_addr)
• void  enable_bsr ()
• void  disable_bsr ()
• int  start_bsr ()
• int  stop_bsr ()
• int  set_vif_proto_version (const string& vif_name, int proto_version)
• int  reset_vif_proto_version (const string& vif_name)
• int  set_vif_hello_triggered_delay (const string& vif_name, uint16_t hello_triggered_delay)
• int  reset_vif_hello_triggered_delay (const string vif_name)
• int  set_vif_hello_period (const string& vif_name, uint16_t hello_period)
• int  reset_vif_hello_period (const string& vif_name)
• int  set_vif_hello_holdtime (const string& vif_name, uint16_t hello_holdtime)
• int  reset_vif_hello_holdtime (const string& vif_name)
• int  set_vif_dr_priority (const string& vif_name, uint32_t dr_priority)
• int  reset_vif_dr_priority (const string& vif_name)
• int  set_vif_lan_delay (const string& vif_name, uint16_t lan_delay)
• int  reset_vif_lan_delay (const string& vif_name)
• int  set_vif_override_interval (const string& vif_name, uint16_t override_interval)
• int  reset_vif_override_interval (const string& vif_name)
• int  set_vif_accept_nohello_neighbors (const string& vif_name, bool accept_nohello_neighbors)
• int  reset_vif_accept_nohello_neighbors (const string& vif_name)
• int  set_vif_join_prune_period (const string& vif_name, uint16_t join_prune_period)
• int  reset_vif_join_prune_period (const string& vif_name)
• int  add_config_cand_bsr_by_vif_name (bool is_admin_scope_zone, const IPvXNet& admin_scope_zone_id, const string& vif_name, uint8_t bsr_priority, uint8_t hash_masklen)
• int  add_config_cand_bsr_by_addr (bool is_admin_scope_zone, const IPvXNet& admin_scope_zone_id, const IPvX& my_cand_bsr_addr, uint8_t bsr_priority, uint8_t hash_masklen)
• int  delete_config_cand_bsr (bool is_admin_scope_zone, const IPvXNet& admin_scope_zone_id)
• int  add_config_cand_rp_by_vif_name (bool is_admin_scope_zone, const IPvXNet& group_prefix, const string& vif_name, uint8_t rp_priority, uint16_t rp_holdtime)
• int  add_config_cand_rp_by_addr (bool is_admin_scope_zone, const IPvXNet& group_prefix, const IPvX& my_cand_rp_addr, uint8_t rp_priority, uint16_t rp_holdtime)
• int  delete_config_cand_rp_by_vif_name (bool is_admin_scope_zone, const IPvXNet& group_prefix, const string& vif_name)
• int  delete_config_cand_rp_by_addr (bool is_admin_scope_zone, const IPvXNet& group_prefix, const IPvX& my_cand_rp_addr)
• int  add_config_rp (const IPvXNet& group_prefix, const IPvX& rp_addr, uint8_t rp_priority, uint8_t hash_masklen)
• int  delete_config_rp (const IPvXNet& group_prefix, const IPvX& rp_addr)
• int  config_rp_done ()
• bool  is_log_trace () const
• void  set_log_trace (bool is_enabled)
• int  add_test_jp_entry (const IPvX& source_addr, const IPvX& group_addr, uint32_t group_masklen, mrt_entry_type_t mrt_entry_type, action_jp_t action_jp, uint16_t holdtime, bool new_group_bool)
• int  send_test_jp_entry (const IPvX& nbr_addr)
• void  add_pim_mre_no_pim_nbr (PimMre *pim_mre)
• void  delete_pim_mre_no_pim_nbr (PimMre *pim_mre)
• list<PimNbr *>&  processing_pim_nbr_list ()
• void  init_processing_pim_mre_rp (uint16_t vif_index, const IPvX& pim_nbr_addr)
• void  init_processing_pim_mre_wc (uint16_t vif_index, const IPvX& pim_nbr_addr)
• void  init_processing_pim_mre_sg (uint16_t vif_index, const IPvX& pim_nbr_addr)
• void  init_processing_pim_mre_sg_rpt (uint16_t vif_index, const IPvX& pim_nbr_addr)
• PimNbr * find_processing_pim_mre_rp (uint16_t vif_index, const IPvX& pim_nbr_addr)
• PimNbr * find_processing_pim_mre_wc (uint16_t vif_index, const IPvX& pim_nbr_addr)
• PimNbr * find_processing_pim_mre_sg (uint16_t vif_index, const IPvX& pim_nbr_addr)
• PimNbr * find_processing_pim_mre_sg_rpt (uint16_t vif_index, const IPvX& pim_nbr_addr)

Detailed Description

There should be one node per PIM instance. There should be one instance per address family.

Constructor for a given address family, module ID, and event loop.

Parameters:

family	the address family (AF_INET or AF_INET6 for IPv4 and IPv6 respectively).
module_id	the module ID (x_module_id). Should be X_MODULE_PIMSM Note: if/after PIM-DM is implemented, X_MODULE_PIMDM would be allowed as well.
event_loop	the event loop to use.

[virtual]

Destructor

Set the current protocol version.

The protocol version must be in the interval [PIM_VERSION_MIN, PIM_VERSION_MAX].

Parameters:

proto_version

the protocol version to set.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Start the node operation.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Stop the node operation.

Gracefully stop the PIM protocol. The graceful stop will attempt to send Join/Prune, Assert, etc. messages for all multicast routing entries to gracefully clean-up state with neighbors. After the multicast routing entries cleanup is completed, PimNode::final_stop() is called to complete the job. If this method is called one-after-another, the second one will force calling immediately PimNode::final_stop() to quickly finish the job. This function, unlike start(), will stop the protocol operation on all interfaces.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Completely stop the node operation.

This method should be called after PimNode::stop() to complete the job.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Test if there is an unit that is in PENDING_DOWN state.

Returns: true if there is an unit that is in PENDING_DOWN state, otherwise false.

Install a new PIM vif.

Parameters:

vif	vif information about new PimVif to install.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Install a new PIM vif.

Parameters:

vif_name	the name of the new vif.
vif_index	the vif index of the new vif.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Delete an existing PIM vif.

Parameters:

vif_name

the name of the vif to delete.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Set flags to a vif.

Parameters:

vif_name	the name of the vif.
is_pim_register	true if this is a PIM Register vif.
is_p2p	true if this is a point-to-point vif.
is_loopback	true if this is a loopback interface.
is_multicast	rue if the vif is multicast-capable.
is_broadcast	true if the vif is broadcast-capable.
is_up	true if the vif is UP and running.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Add an address to a vif.

Parameters:

vif_name	the name of the vif.
addr	the unicast address to add.
subnet_addr	the subnet address to add.
broadcast_addr	the broadcast address (when applicable).
peer_addr	the peer address (when applicable).

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete an address from a vif.

Parameters:

vif_name	the name of the vif.
addr	the unicast address to delete.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Start PIM on all enabled interfaces.

Returns: the number of virtual interfaces PIM was started on, or XORP_ERROR if error occured.

Stop PIM on all interfaces it was running on.

Returns: he number of virtual interfaces PIM was stopped on, or XORP_ERROR if error occured.

Enable PIM on all interfaces.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Disable PIM on all interfaces.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Delete all PIM vifs.

Receive a protocol message.

Parameters:

src_module_instance_name	the module instance name of the module-origin of the message.
src_module_id	the module ID (x_module_id) of the module-origin of the message.
vif_index	the vif index of the interface used to receive this message.
src	the source address of the message.
dst	the destination address of the message.
ip_ttl	the IP TTL of the message. If it has a negative value, it should be ignored.
ip_tos	the IP TOS of the message. If it has a negative value, it should be ignored.
router_alert_bool	if true, the IP Router Alert option in the IP packet was set (when applicable).
rcvbuf	the data buffer with the received message.
rcvlen	the data length in rcvbuf.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Send a protocol message.

Note: this method uses the pure virtual ProtoNode::proto_send() method that is implemented somewhere else (in a class that inherits this one).

Parameters:

vif_index	the vif index of the vif to send the message.
src	the source address of the message.
dst	the destination address of the message.
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.
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.
router_alert_bool	if true, set the IP Router Alert option in the IP packet to send (when applicable).
buffer	the data buffer with the message to send.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Receive a signal message from the kernel.

#define MFEA_UNIX_KERNEL_MESSAGE_NOCACHE        1
#define MFEA_UNIX_KERNEL_MESSAGE_WRONGVIF       2
#define MFEA_UNIX_KERNEL_MESSAGE_WHOLEPKT       3

Parameters:

src_module_instance_name	the module instance name of the module-origin of the message.
src_module_id	the module ID (x_module_id) of the module-origin of the message.
message_type	the message type. Currently, the type of messages received from the kernel are:
vif_index	the vif index of the related interface (message-specific relation).
src	the source address in the message.
dst	the destination address in the message.
rcvbuf	the data buffer with the additional information in the message.
rcvlen	the data length in rcvbuf.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Reimplemented from ProtoNode.

Send signal message: not used by PIM.

Reimplemented from ProtoNode.

[pure virtual]

Start the protocol with the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Stop the protocol with the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Start a protocol vif with the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

vif_index

the vif index of the interface to start.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Stop a protocol vif with the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

vif_index

the vif index of the interface to stop.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Join a multicast group on an interface.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

TODO: add a source address as well!!

Parameters:

vif_index	the vif index of the interface to join.
multicast_group	the multicast group address.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Leave a multicast group on an interface.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

TODO: add a source address as well!!

Parameters:

vif_index	the vif index of the interface to leave.
multicast_group	the multicast group address.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Add a Multicast Forwarding Cache to the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

pim_mfc

the PimMfc entry to add.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Delete a Multicast Forwarding Cache to the kernel.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

pim_mfc

the PimMfc entry to delete.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Add a dataflow monitor to the MFEA.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Note: either is_threshold_in_packets or is_threshold_in_bytes (or both) must be true. Note: either is_geq_upcall or is_leq_upcall (but not both) must be true.

Parameters:

source	the source address.
group	the group address.
threshold_interval_sec	the dataflow threshold interval (seconds).
threshold_interval_usec	the dataflow threshold interval (microseconds).
threshold_packets	the threshold (in number of packets) to compare against.
threshold_bytes	the threshold (in number of bytes) to compare against.
is_threshold_in_packets	if true, threshold_packets is valid.
is_threshold_in_bytes	if true, threshold_bytes is valid.
is_geq_upcall	if true, the operation for comparison is ">=".
is_leq_upcall	if true, the operation for comparison is "<=".

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Delete a dataflow monitor from the MFEA.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Note: either is_threshold_in_packets or is_threshold_in_bytes (or both) must be true. Note: either is_geq_upcall or is_leq_upcall (but not both) must be true.

Parameters:

source	the source address.
group	the group address.
threshold_interval_sec	the dataflow threshold interval (seconds).
threshold_interval_usec	the dataflow threshold interval (microseconds).
threshold_packets	the threshold (in number of packets) to compare against.
threshold_bytes	the threshold (in number of bytes) to compare against.
is_threshold_in_packets	if true, threshold_packets is valid.
is_threshold_in_bytes	if true, threshold_bytes is valid.
is_geq_upcall	if true, the operation for comparison is ">=".
is_leq_upcall	if true, the operation for comparison is "<=".

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Delete all dataflow monitors for a given source and group address from the MFEA.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

source_addr	the source address.
group_addr	the group address.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Register this protocol with the MLD/IGMP module.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

By registering this protocol with the MLD/IGMP module, it will be notified about multicast group membership events.

Parameters:

vif_index

the vif index of the interface to register with the MLD/IGMP module.

Returns: XORP_OK on success, otherwise XORP_ERROR.

[pure virtual]

Deregister this protocol with the MLD/IGMP module.

This is a pure virtual function, and it must be implemented by the communication-wrapper class that inherits this base class.

Parameters:

vif_index

the vif index of the interface to deregister with the MLD/IGMP module.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Receive "add membership" from the MLD/IGMP module.

Parameters:

vif_index	the vif index of the interface with membership change.
source	the source address of the (S,G) or (*,G) entry that has changed membership. In case of Any-Source Multicast, it is IPvX::ZERO().
group	the group address.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Receive "delete membership" from the MLD/IGMP module.

Parameters:

vif_index	the vif index of the interface with membership change.
source	the source address of the (S,G) or (*,G) entry that has changed membership. In case of Any-Source Multicast, it is IPvX::ZERO().
group	the group address.

Returns: XORP_OK on success, otherwise XORP_ERROR.

Add an entry to the MRIB table (MribTable).

Parameters:

mrib	the Mrib entry to add.

Delete an entry from the MRIB table (MribTable).

Parameters:

mrib	the Mrib entry to delete.

[const]

Get the PIM-Register virtual interface.

Returns: the PIM-Register virtual interface if exists, otherwise NULL.

[const]

Get the vif index of the PIM-Register virtual interface.

Returns: the vif index of the PIM-Register virtual interface if exists, otherwise Vif::VIF_INDEX_INVALID.

Get the PIM Multicast Routing Table.

Returns: a reference to the PIM Multicast Routing Table (PimMrt).

Get the table with the Multicast Routing Information Base used by PIM.

Returns: a reference to the table with the Multicast Routing Information Base used by PIM (PimMribTable).

Get the PIM Bootstrap entity.

Returns: a reference to the PIM Bootstrap entity (PimBsr).

Get the PIM RP table.

Returns: a reference to the PIM RP table (RpTable).

Get the PIM Scope-Zone table.

Returns: a reference to the PIM Scope-Zone table.

Get the set of vifs for which this PIM note is a Designated Router.

Returns: the Mifset indicating the vifs for which this PIM node is a Designated Router.

Set/reset a virtual interface as a Designated Router.

Parameters:

vif_index	the vif index of the virtual interface to set/reset as a Designated Router.
v	if true, set the virtual interface as a Designated Router, otherwise reset it.

Find the RPF PIM neighbor for a given destination address.

Parameters:

dst_addr

the destination address to lookup.

Returns: the RPF PIM neighbor (PimNbr) toward dst_addr if found, otherwise NULL.

Find the RPF PIM neighbor for a given destination address, and already known Mrib entry.

Parameters:

dst_addr	the destination address to lookup.
mrib	the already known Mrib entry.

Returns: the RPF PIM neighbor (PimNbr) toward dst_addr if found, otherwise NULL.

Find a PIM neighbor.

Parameters:

nbr_addr

the address of the PIM neighbor.

Returns: the PIM neighbor (PimNbr) if found, otherwise NULL.

Enable the PIM Bootstrap mechanism.

Disable the PIM Bootstrap mechanism.

Start the Bootstrap mechanism.

Returns: XORP_OK if a new address, otherwise XORP_ERROR.

Stop the Bootstrap mechanism.

Returns: XORP_OK if a new address, otherwise XORP_ERROR.

[const]