// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-

// Copyright (c) 2001-2009 XORP, Inc.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, Version 2, June
// 1991 as published by the Free Software Foundation. Redistribution
// and/or modification of this program under the terms of any other
// version of the GNU General Public License is not permitted.
// 
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. For more details,
// see the GNU General Public License, Version 2, a copy of which can be
// found in the XORP LICENSE.gpl file.
// 
// XORP Inc, 2953 Bunker Hill Lane, Suite 204, Santa Clara, CA 95054, USA;
// http://xorp.net




//
// PIM PIM_JOIN_PRUNE control messages supporting functions.
//

#include <map>

#include "pim_module.h"
#include "libxorp/xorp.h"
#include "libxorp/xlog.h"
#include "libxorp/debug.h"
#include "libxorp/ipvx.hh"
#include "libxorp/utils.hh"

#include "pim_mre.hh"
#include "pim_node.hh"
#include "pim_proto.h"
#include "pim_proto_join_prune_message.hh"
#include "pim_vif.hh"


//
// Exported variables
//

//
// Local constants definitions
//

//
// Local structures/classes, typedefs and macros
//

//
// Local variables
//

//
// Local functions prototypes
//


PimJpHeader::PimJpHeader(PimNode& pim_node)
    : _pim_node(pim_node),
      _family(pim_node.family()),
      _jp_groups_n(0),
      _jp_sources_n(0),
      _holdtime(PIM_JOIN_PRUNE_HOLDTIME_DEFAULT) // XXX
{
    
}

PimJpHeader::~PimJpHeader()
{
    // Delete all 'jp_group' entries
    delete_pointers_list(_jp_groups_list);
}

void
PimJpHeader::reset()
{
    delete_pointers_list(_jp_groups_list);
    _jp_groups_n = 0;
    _jp_sources_n = 0;
    _holdtime = PIM_JOIN_PRUNE_HOLDTIME_DEFAULT; // XXX
}

PimMrt&
PimJpHeader::pim_mrt() const
{
    return (_pim_node.pim_mrt());
}

// Return true if @ipaddr found
bool
PimJpSources::j_list_found(const IPvX& ipaddr)
{
    list<IPvX>::iterator iter;
    for (iter = j_list().begin(); iter != j_list().end(); ++iter) {
	if (ipaddr == *iter)
	    return (true);
    }
    
    return (false);
}

// Return true if @ipaddr found
bool
PimJpSources::p_list_found(const IPvX& ipaddr)
{
    list<IPvX>::iterator iter;
    for (iter = p_list().begin(); iter != p_list().end(); ++iter) {
	if (ipaddr == *iter)
	    return (true);
    }
    
    return (false);
}

// Remove entry for @ipaddr, and return true if such entry was removed
bool
PimJpSources::j_list_remove(const IPvX& ipaddr)
{
    list<IPvX>::iterator iter;
    for (iter = j_list().begin(); iter != j_list().end(); ++iter) {
	if (ipaddr == *iter) {
	    j_list().erase(iter);
	    return (true);
	}
    }
    
    return (false);
}

// Remove entry for @ipaddr, and return true if such entry was removed
bool
PimJpSources::p_list_remove(const IPvX& ipaddr)
{
    list<IPvX>::iterator iter;
    for (iter = p_list().begin(); iter != p_list().end(); ++iter) {
	if (ipaddr == *iter) {
	    p_list().erase(iter);
	    return (true);
	}
    }
    
    return (false);
}

PimJpGroup::PimJpGroup(PimJpHeader& jp_header, int family)
    : _jp_header(jp_header),
      _family(family),
      _group_addr(family)
{
    _group_mask_len = IPvX::addr_bitlen(family);
    _j_sources_n = 0;
    _p_sources_n = 0;
}

// Return: XORP_ERROR if the addition of this entry is inconsistent
// XXX: the (*,*,RP) entries are first in the chain.
// @is_new_group: if true, create a new PimJpGroup().
int
PimJpHeader::jp_entry_add(const IPvX& source_addr, const IPvX& group_addr,
			  uint8_t group_mask_len,
			  mrt_entry_type_t mrt_entry_type,
			  action_jp_t action_jp, uint16_t holdtime,
			  bool is_new_group)
{
    bool is_jp_group_found = false;
    PimJpGroup *jp_group = NULL;
    PimJpSources *jp_sources = NULL;
    
    if (! is_new_group) {
	// Allow to merge together all entries for the same group.
	// Try to find the group entry.
	list<PimJpGroup *>::iterator iter;
	for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	     ++iter) {
	    jp_group = *iter;
	    if ( (group_addr != jp_group->group_addr())
		 || (group_mask_len != jp_group->group_mask_len()))
		continue;
	    is_jp_group_found = true;
	    break;
	}
    }
    
    if ( ! is_jp_group_found) {
	// Create a new entry
	jp_group = new PimJpGroup(*this, family());
	_jp_groups_list.push_back(jp_group);
	jp_group->set_group_addr(group_addr);
	jp_group->set_group_mask_len(group_mask_len);
	incr_jp_groups_n();
    }
    _holdtime = holdtime;	// XXX: the older holdtime may be modified
    XLOG_ASSERT(jp_group != NULL);

    //
    // Perform sanity check for conflicting entries,
    // and at the same time find the type of entry.
    // XXX: the "?" entries in the J/P rules table are accepted, but
    // the redundant entries are removed.
    // (see the J/P messages format section in the spec).
    //
    switch(mrt_entry_type) {
    case MRT_ENTRY_RP:
	if (action_jp == ACTION_JOIN) {
	    // (*,*,RP) Join
	    if (jp_group->rp()->j_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    if (jp_group->rp()->p_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	} else {
	    // (*,*,RP) Prune
	    if (jp_group->rp()->j_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    if (jp_group->rp()->p_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	}
	jp_sources = jp_group->rp();
	break;
	
    case MRT_ENTRY_WC:
	if (action_jp == ACTION_JOIN) {
	    // (*,G) Join
	    if (jp_group->wc()->j_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    if (jp_group->wc()->p_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    // Remove redundant entries: all (S,G,rpt)J
	    while (! jp_group->sg_rpt()->j_list().empty()) {
		const IPvX& addr = *jp_group->sg_rpt()->j_list().begin();
		jp_group->sg_rpt()->j_list_remove(addr);
	    }
	} else {
	    // (*,G) Prune
	    if (jp_group->wc()->j_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    if (jp_group->wc()->p_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    // Remove redundant entries: all (S,G,rpt)J
	    while (! jp_group->sg_rpt()->j_list().empty()) {
		const IPvX& addr = *jp_group->sg_rpt()->j_list().begin();
		jp_group->sg_rpt()->j_list_remove(addr);
	    }
	    // Remove redundant entries: all (S,G,rpt)P
	    while (! jp_group->sg_rpt()->p_list().empty()) {
		const IPvX& addr = *jp_group->sg_rpt()->p_list().begin();
		jp_group->sg_rpt()->p_list_remove(addr);
	    }
	}
	jp_sources = jp_group->wc();
	break;
	
    case MRT_ENTRY_SG_RPT:
	if (action_jp == ACTION_JOIN) {
	    if (! jp_group->wc()->j_list().empty())
		return (XORP_OK);		// Redundant; ignore.
	    if (! jp_group->wc()->p_list().empty())
		return (XORP_OK);		// Redundant; ignore.
	    // (S,G,rpt) Join
	    if (jp_group->sg_rpt()->j_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    if (jp_group->sg_rpt()->p_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    if (jp_group->sg()->p_list_found(source_addr))
		return (XORP_OK);		// Redundant; ignore.
	} else {
	    // (S,G,rpt) Prune
	    if (! jp_group->wc()->p_list().empty())
		return (XORP_OK);		// Redundant; ignore.
	    if (jp_group->sg_rpt()->j_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    if (jp_group->sg_rpt()->p_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    if (jp_group->sg()->j_list_found(source_addr))
		return (XORP_OK);		// Redundant; ignore.
	}
	jp_sources = jp_group->sg_rpt();
	break;
	
    case MRT_ENTRY_SG:
	if (action_jp == ACTION_JOIN) {
	    // (S,G) Join
	    if (jp_group->sg()->j_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    if (jp_group->sg()->p_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    // Remove redundant entries: (S,G,rpt)P
	    jp_group->sg_rpt()->p_list_remove(source_addr);
	} else {
	    // (S,G) Prune
	    if (jp_group->sg()->j_list_found(source_addr))
		return (XORP_ERROR);		// Combination not allowed
	    if (jp_group->sg()->p_list_found(source_addr))
		return (XORP_OK);		// Already added; ignore.
	    // Remove redundant entries: (S,G,rpt)J
	    jp_group->sg_rpt()->j_list_remove(source_addr);
	}
	jp_sources = jp_group->sg();
	break;
	
    default:
	XLOG_UNREACHABLE();
	return (XORP_ERROR);
    }
    XLOG_ASSERT(jp_sources != NULL);
    
    // Add the new entry and record the fact.
    if (action_jp == ACTION_JOIN) {
	jp_sources->j_list().push_back(source_addr);
	jp_sources->incr_j_n();
	jp_group->incr_j_sources_n();
    } else {
	jp_sources->p_list().push_back(source_addr);
	jp_sources->incr_p_n();
	jp_group->incr_p_sources_n();
    }
    
    return (XORP_OK);
}

int
PimJpHeader::mrt_commit(PimVif *pim_vif, const IPvX& target_nbr_addr)
{
    bool	i_am_target_router = true;
    uint32_t	lookup_flags = 0, create_flags = 0;
    uint32_t	vif_index;
    uint16_t	holdtime;
    uint8_t	source_mask_len, group_mask_len;
    IPvX	source_addr(family()), group_addr(family());
    list<PimJpGroup *>::iterator iter;
    PimMre	*pim_mre;
    map<IPvX, IPvX> groups_map, join_wc_map;
    
    vif_index = pim_vif->vif_index();
    
    //
    // Test if I am the target router; e.g., in case I need to
    // perform Join/Prune suppression.
    // XXX: on p2p interfaces, target_nbr_addr of all zeros is also accepted
    if ((target_nbr_addr == pim_vif->primary_addr())
	|| (pim_vif->is_p2p() && target_nbr_addr == IPvX::ZERO(family()))) {
	i_am_target_router = true;
    } else {
	i_am_target_router = false;
    }
    
    //
    // Create the map with all group addresses
    //
    if (i_am_target_router) {
	for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	     ++iter) {
	    PimJpGroup *jp_group = *iter;
	    group_addr = jp_group->group_addr();
	    group_mask_len = jp_group->group_mask_len();
	    if (group_mask_len != group_addr.addr_bitlen())
		continue;	// XXX: exclude (e.g., probably (*,*,RP) entry)
	    groups_map.insert(pair<IPvX, IPvX>(group_addr, group_addr));
	}
    }
    
    //
    // The main loop
    //
    for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	 ++iter) {
	list<IPvX>::iterator iter2;
	PimJpGroup *jp_group = *iter;
	group_addr = jp_group->group_addr();
	group_mask_len = jp_group->group_mask_len();
	holdtime = _holdtime;
	
	//
	// Build the map for all (*,G) Joins so far
	//
	if (i_am_target_router) {
	    if (! jp_group->wc()->j_list().empty())
		join_wc_map.insert(pair<IPvX, IPvX>(group_addr, group_addr));
	}
	
	// (*,*,RP) Join
	for (iter2 = jp_group->rp()->j_list().begin();
	     iter2 != jp_group->rp()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router)
		pim_mrt().add_task_receive_join_rp(vif_index, source_addr);
	    
	    lookup_flags	= PIM_MRE_RP;
	    if (i_am_target_router)
		create_flags = lookup_flags;
	    else
		create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, IPvX::ZERO(family()),
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_join_rp(vif_index, holdtime);
		} else {
		    pim_mre->rp_see_join_rp(vif_index, holdtime,
					    target_nbr_addr);
		}
	    }
	}
	// (*,*,RP) Prune
	for (iter2 = jp_group->rp()->p_list().begin();
	     iter2 != jp_group->rp()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router)
		pim_mrt().add_task_receive_prune_rp(vif_index, source_addr);
	    
	    lookup_flags	= PIM_MRE_RP;
	    // XXX: if no entry, the (*,*,RP) Prune should not create one
	    create_flags = 0;
	    
	    pim_mre = pim_mrt().pim_mre_find(source_addr, IPvX::ZERO(family()),
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_prune_rp(vif_index, holdtime);
		} else {
		    pim_mre->rp_see_prune_rp(vif_index, holdtime,
					     target_nbr_addr);
		}
	    }
	}
	// (*,G) Join
	for (iter2 = jp_group->wc()->j_list().begin();
	     iter2 != jp_group->wc()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router)
		pim_mrt().add_task_receive_join_wc(vif_index, group_addr);
	    
	    lookup_flags	= PIM_MRE_WC;
	    if (i_am_target_router)
		create_flags = lookup_flags;
	    else
		create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_join_wc(vif_index, holdtime);
		} else {
		    pim_mre->wc_see_join_wc(vif_index, holdtime,
					    target_nbr_addr);
		}
	    }
	}
	// (*,G) Prune
	for (iter2 = jp_group->wc()->p_list().begin();
	     iter2 != jp_group->wc()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router) {
		pim_mrt().add_task_receive_prune_wc(vif_index, group_addr);
	    } else {
		pim_mrt().add_task_see_prune_wc(vif_index, group_addr,
						target_nbr_addr);
	    }
	    
	    lookup_flags	= PIM_MRE_WC;
	    // XXX: if no entry, the (*,G) Prune should not create one
	    create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_prune_wc(vif_index, holdtime);
		} else {
		    pim_mre->wc_see_prune_wc(vif_index, holdtime,
					     target_nbr_addr);
		}
	    }
	}
	// (S,G,rpt) Join
	for (iter2 = jp_group->sg_rpt()->j_list().begin();
	     iter2 != jp_group->sg_rpt()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router) {
		pim_mrt().add_task_receive_join_sg_rpt(vif_index, source_addr,
						       group_addr);
	    }
	    
	    lookup_flags	= PIM_MRE_SG_RPT;
	    // XXX: if no entry, the (S,G,rpt) Join should not create one
	    create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_join_sg_rpt(vif_index, holdtime);
		} else {
		    pim_mre->sg_rpt_see_join_sg_rpt(vif_index, holdtime,
						    target_nbr_addr);
		}
	    }
	}
	// (S,G,rpt) Prune
	for (iter2 = jp_group->sg_rpt()->p_list().begin();
	     iter2 != jp_group->sg_rpt()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router) {
		pim_mrt().add_task_receive_prune_sg_rpt(vif_index, source_addr,
							group_addr);
	    }
	    
	    lookup_flags	= PIM_MRE_SG_RPT;
	    // XXX: even if no entry, the (S,G,rpt) Prune should create one
	    // XXX: even if the (S,G,rpt) Prune is not for me, try to create
	    // an entry.
	    if (i_am_target_router)
		create_flags = lookup_flags;
	    else
		create_flags = lookup_flags;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		bool is_join_wc_received;
		if (jp_group->wc()->j_list().empty())
		    is_join_wc_received = false;
		else
		    is_join_wc_received = true;
		if (! is_join_wc_received) {
		    is_join_wc_received
			= (join_wc_map.find(group_addr) != join_wc_map.end());
		}
		if (i_am_target_router) {
		    pim_mre->receive_prune_sg_rpt(vif_index, holdtime,
						  is_join_wc_received);
		} else {
		    pim_mre->sg_rpt_see_prune_sg_rpt(vif_index, holdtime,
						     target_nbr_addr);
		    pim_mre->entry_try_remove();
		}
	    }
	    
	    //
	    // Take care of the (S,G) entry that
	    // "See Prune (S,G,rpt) to RPF'(S,G)"
	    //
	    if (! i_am_target_router) {
		PimMre *pim_mre_sg = NULL;
		if (pim_mre != NULL) {
		    pim_mre_sg = pim_mre->sg_entry();
		} else {
		    pim_mre_sg = pim_mrt().pim_mre_find(source_addr,
							group_addr,
							PIM_MRE_SG, 0);
		}
		if (pim_mre_sg != NULL)
		    pim_mre_sg->sg_see_prune_sg_rpt(vif_index, holdtime,
						    target_nbr_addr);
	    }
	}
	// (S,G) Join
	for (iter2 = jp_group->sg()->j_list().begin();
	     iter2 != jp_group->sg()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router) {
		pim_mrt().add_task_receive_join_sg(vif_index, source_addr,
						   group_addr);
	    }
	    
	    lookup_flags	= PIM_MRE_SG;
	    if (i_am_target_router)
		create_flags = lookup_flags;
	    else
		create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_join_sg(vif_index, holdtime);
		} else {
		    pim_mre->sg_see_join_sg(vif_index, holdtime,
					    target_nbr_addr);
		}
	    }
	}
	// (S,G) Prune
	for (iter2 = jp_group->sg()->p_list().begin();
	     iter2 != jp_group->sg()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    
	    if (i_am_target_router) {
		pim_mrt().add_task_receive_prune_sg(vif_index, source_addr,
						    group_addr);
	    }
    	    
	    lookup_flags	= PIM_MRE_SG;
	    // XXX: if no entry, the (S,G) Prune should not create one
	    create_flags = 0;
	    pim_mre = pim_mrt().pim_mre_find(source_addr, group_addr,
					     lookup_flags, create_flags);
	    if (pim_mre == NULL) {
		if (create_flags)
		    goto pim_mre_find_error;
	    } else {
		if (i_am_target_router) {
		    pim_mre->receive_prune_sg(vif_index, holdtime);
		} else {
		    pim_mre->sg_see_prune_sg(vif_index, holdtime,
					     target_nbr_addr);
		}
	    }
	    
	    //
	    // Take care of the (S,G,rpt) entry that
	    // "See Prune (S,G) to RPF'(S,G,rpt)"
	    //
	    if (! i_am_target_router) {
		PimMre *pim_mre_sg_rpt = NULL;
		if (pim_mre != NULL)
		    pim_mre_sg_rpt = pim_mre->sg_rpt_entry();
		if (pim_mre_sg_rpt == NULL) {
		    // XXX: always create the (S,G,rpt) entry even
		    // if the (S,G) Prune is not for me
		    lookup_flags = PIM_MRE_SG_RPT;
		    create_flags = lookup_flags;
		    pim_mre_sg_rpt = pim_mrt().pim_mre_find(source_addr,
							    group_addr,
							    lookup_flags,
							    create_flags);
		    if (pim_mre_sg_rpt == NULL) {
			if (create_flags)
			    goto pim_mre_find_error;
		    }
		}
		if (pim_mre_sg_rpt != NULL) {
		    pim_mre_sg_rpt->sg_rpt_see_prune_sg(vif_index, holdtime,
							target_nbr_addr);
		    pim_mre_sg_rpt->entry_try_remove();
		}
	    }
	}
    }
    
    //
    // Take care of the (S,G,rpt) entries that see
    // "End of Message"
    //
    if (i_am_target_router) {
	map<IPvX, IPvX>::iterator map_iter;
	for (map_iter = groups_map.begin(); map_iter != groups_map.end();
	     ++map_iter) {
	    group_addr = map_iter->second;
	    pim_mrt().add_task_receive_end_of_message_sg_rpt(vif_index,
							     group_addr);
	}
    }
    
    return (XORP_OK);
    
 pim_mre_find_error:
    XLOG_UNREACHABLE();
    XLOG_ERROR("INTERNAL PimMrt ERROR: "
	       "cannot create entry for (%s, %s) create_flags = %#x",
	       cstring(source_addr), cstring(group_addr),
	       XORP_UINT_CAST(create_flags));
    return (XORP_ERROR);
}

int
PimJpHeader::network_commit(PimVif *pim_vif, const IPvX& target_nbr_addr,
			    string& error_msg)
{
    const size_t max_packet_size = PIM_MAXPACKET(family());
    IPvX source_addr(family());
    PimJpHeader jp_header(pim_node());
    list<PimJpGroup *>::iterator iter;
    
    //
    // Add first all (S,G,rpt) entries that need to be included
    // with the (*,G) Join messages.
    //
    for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	 ++iter) {
	list<IPvX>::iterator iter2;
	PimJpGroup *jp_group = *iter;
	
	// (*,G) Join
	for (iter2 = jp_group->wc()->j_list().begin();
	     iter2 != jp_group->wc()->j_list().end();
	     ++iter2) {
	    PimMre *pim_mre_wc = pim_mrt().pim_mre_find(IPvX::ZERO(family()),
							jp_group->group_addr(),
							PIM_MRE_WC, 0);
	    if (pim_mre_wc == NULL)
		continue;
	    //
	    // Add all necessary (S,G,rpt) entries for this group
	    // First we go through all (S,G) entries, and then through
	    // the (S,G,rpt) entries.
	    //
	    
	    //
	    // Go through the (S,G) entries and add (S,G,rpt) Prune
	    // if needed
	    //
	    PimMrtSg::const_gs_iterator iter3_begin, iter3_end, iter3;
	    iter3_begin = pim_mrt().pim_mrt_sg().group_by_addr_begin(pim_mre_wc->group_addr());
	    iter3_end = pim_mrt().pim_mrt_sg().group_by_addr_end(pim_mre_wc->group_addr());
	    for (iter3 = iter3_begin; iter3 != iter3_end; ++iter3) {
		PimMre *pim_mre_sg = iter3->second;
		
		if (pim_mre_sg->is_spt()) {
		    // Note: If receiving (S,G) on the SPT, we only prune off
		    // the shared tree if the RPF neighbors differ, i.e.
		    // if ( RPF'(*,G) != RPF'(S,G) )
		    if (pim_mre_wc->rpfp_nbr_wc() != pim_mre_sg->rpfp_nbr_sg())
			goto add_prune_sg_rpt_label1;
		}
		continue;
		
	    add_prune_sg_rpt_label1:
		bool is_new_group = false;
		jp_entry_add(pim_mre_sg->source_addr(),
			     pim_mre_sg->group_addr(),
			     IPvX::addr_bitlen(family()),
			     MRT_ENTRY_SG_RPT,
			     ACTION_PRUNE, _holdtime, is_new_group);
	    }
	    //
	    // Go through the (S,G,rpt) entries and add (S,G,rpt) Prune
	    // if needed.
	    //
	    iter3_begin = pim_mrt().pim_mrt_sg_rpt().group_by_addr_begin(pim_mre_wc->group_addr());
	    iter3_end = pim_mrt().pim_mrt_sg_rpt().group_by_addr_end(pim_mre_wc->group_addr());
	    for (iter3 = iter3_begin; iter3 != iter3_end; ++iter3) {
		PimMre *pim_mre_sg_rpt = iter3->second;
		if (pim_mre_sg_rpt->inherited_olist_sg_rpt().none()) {
		    // Note: all (*,G) olist interfaces received RPT prunes
		    // for (S,G).
		    goto add_prune_sg_rpt_label2;
		} else if (pim_mre_wc->rpfp_nbr_wc()
			   != pim_mre_sg_rpt->rpfp_nbr_sg_rpt()) {
		    // Note: we joined the shared tree, but there was
		    // an (S,G) assert and the source tree RPF neighbor
		    // is different.
		    goto add_prune_sg_rpt_label2;
		}
		continue;
		
	    add_prune_sg_rpt_label2:
		do {
		    //
		    // XXX: check if already we added the entry because
		    // of an (S,G) entry.
		    //
		    PimMre *pim_mre_sg = pim_mre_sg_rpt->sg_entry();
		    if ((pim_mre_sg != NULL) && (pim_mre_sg->is_spt())) {
			// Note: If receiving (S,G) on the SPT, we only prune
			// off the shared tree if the RPF neighbors differ,
			// i.e. if ( RPF'(*,G) != RPF'(S,G) )
			if (pim_mre_wc->rpfp_nbr_wc()
			    != pim_mre_sg->rpfp_nbr_sg())
			    continue;		// XXX: already added
		    }
		} while (false);
		
		bool is_new_group = false;
		jp_entry_add(pim_mre_sg_rpt->source_addr(),
			     pim_mre_sg_rpt->group_addr(),
			     IPvX::addr_bitlen(family()),
			     MRT_ENTRY_SG_RPT,
			     ACTION_PRUNE, _holdtime, is_new_group);
	    }
	}
    }
    
    //
    // Create the output message(s) and send them one-by-one.
    //
    for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	 ++iter) {
	list<IPvX>::iterator iter2;
	PimJpGroup *jp_group = *iter;
	
	//
	// Check if the group number is too large
	//
	if (jp_header.jp_groups_n() == 0xff) {
	    // Send what we have already
	    if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		!= XORP_OK) {
		return (XORP_ERROR);
	    }
	    jp_header.reset();
	}
	
	//
	// Check the result message size if we add this group
	//
	if (jp_header.message_size() + jp_group->message_size()
	    > max_packet_size) {
	    if (jp_header.jp_groups_n() > 0) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
	    }
	}
	
	//
	// Start adding the Join/Prune entries for the group
	//
	size_t j_sources_n = 0;		// Number of join sources per group
	size_t p_sources_n = 0;		// Number of prune sources per group
	
	//
	// Add as many (*,*,RP) Join/Prune sources (i.e., the RPs) as we can
	//
	// (*,*,RP) Join
	for (iter2 = jp_group->rp()->j_list().begin();
	     iter2 != jp_group->rp()->j_list().end();
	     ++iter2) {
	    if ((j_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    j_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_RP,
				   ACTION_JOIN,
				   _holdtime,
				   false);
	}
	// (*,*,RP) Prune
	for (iter2 = jp_group->rp()->p_list().begin();
	     iter2 != jp_group->rp()->p_list().end();
	     ++iter2) {
	    if ((p_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    p_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_RP,
				   ACTION_PRUNE,
				   _holdtime,
				   false);
	}
	
	//
	// Add as many (*,G) Join/Prune sources (i.e., the RPs) as we can
	//
	// (*,G) Join
	for (iter2 = jp_group->wc()->j_list().begin();
	     iter2 != jp_group->wc()->j_list().end();
	     ++iter2) {
	    if ((j_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    j_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_WC,
				   ACTION_JOIN,
				   _holdtime,
				   false);
	}
	// (*,G) Prune
	for (iter2 = jp_group->wc()->p_list().begin();
	     iter2 != jp_group->wc()->p_list().end();
	     ++iter2) {
	    if ((p_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    p_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_WC,
				   ACTION_PRUNE,
				   _holdtime,
				   false);
	}
	
	//
	// Add as many (S,G,rpt) Join/Prune sources as we can
	//
	// (S,G,rpt) Prune
	// XXX: if we are sending (*,G) Join, and if we can fit only N
	// (S,G,rpt) Prune entries, then we MUST choose to include
	// the first N (numerically smallest) addresses.
	// Hence, first we order the (S,G,rpt) addresses, and then we add them.
	map<IPvX, IPvX> addrs_map;
	map<IPvX, IPvX>::iterator map_iter;
	// Order the addresses
	for (iter2 = jp_group->sg_rpt()->p_list().begin();
	     iter2 != jp_group->sg_rpt()->p_list().end();
	     ++iter2) {
	    source_addr = *iter2;
	    addrs_map.insert(pair<IPvX, IPvX>(source_addr, source_addr));
	}
	// Add as many addresses as we can
	for (map_iter = addrs_map.begin(); map_iter != addrs_map.end();
	     ++map_iter) {
	    if ((p_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
		// If we have (*,G) Join entry, do not add the rest of the
		// (S,G,rpt) Prune entries.
		if (! jp_group->wc()->j_list().empty())
		    break;
	    }
	    p_sources_n++;
	    source_addr = map_iter->second;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_SG_RPT,
				   ACTION_PRUNE,
				   _holdtime,
				   false);
	}
	// (S,G,rpt) Join
	for (iter2 = jp_group->sg_rpt()->j_list().begin();
	     iter2 != jp_group->sg_rpt()->j_list().end();
	     ++iter2) {
	    if ((j_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    j_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_SG_RPT,
				   ACTION_JOIN,
				   _holdtime,
				   false);
	}

	//
	// Add as many (S,G) Join/Prune sources as we can
	//
	// (S,G) Join
	for (iter2 = jp_group->sg()->j_list().begin();
	     iter2 != jp_group->sg()->j_list().end();
	     ++iter2) {
	    if ((j_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    j_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_SG,
				   ACTION_JOIN,
				   _holdtime,
				   false);
	}
	// (S,G) Prune
	for (iter2 = jp_group->sg()->p_list().begin();
	     iter2 != jp_group->sg()->p_list().end();
	     ++iter2) {
	    if ((p_sources_n == 0xffff)
		|| (jp_header.message_size() + jp_header.extra_source_size()
		    > max_packet_size)) {
		// Send what we have already
		if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
		    != XORP_OK) {
		    return (XORP_ERROR);
		}
		jp_header.reset();
		j_sources_n = 0;
		p_sources_n = 0;
	    }
	    p_sources_n++;
	    source_addr = *iter2;
	    jp_header.jp_entry_add(source_addr,
				   jp_group->group_addr(),
				   jp_group->group_mask_len(),
				   MRT_ENTRY_SG,
				   ACTION_PRUNE,
				   _holdtime,
				   false);
	}
    }
    
    // Sent the last fragment (if such)
    if (jp_header.jp_groups_n() > 0) {
	if (jp_header.network_send(pim_vif, target_nbr_addr, error_msg)
	    != XORP_OK) {
	    return (XORP_ERROR);
	}
	jp_header.reset();
    }
    
    return (XORP_OK);
}

int
PimJpHeader::network_send(PimVif *pim_vif, const IPvX& target_nbr_addr,
			  string& error_msg)
{
    uint32_t	flags;
    uint8_t	source_mask_len;
    IPvX	source_addr(family());
    list<PimJpGroup *>::iterator iter;
    uint8_t sparse_bit = pim_node().proto_is_pimsm() ? ESADDR_S_BIT : 0;
    buffer_t *buffer = NULL;
    
    //
    // Prepare a new buffer
    //
    buffer = pim_vif->buffer_send_prepare();
    PUT_ENCODED_UNICAST_ADDR(family(), target_nbr_addr, buffer);
    BUFFER_PUT_OCTET(0, buffer);		// Reserved
    BUFFER_PUT_OCTET(_jp_groups_n, buffer);	// Number of groups
    BUFFER_PUT_HOST_16(_holdtime, buffer);	// Holdtime
    
    //
    // Prepare the message
    //
    for (iter = _jp_groups_list.begin(); iter != _jp_groups_list.end();
	 ++iter) {
	list<IPvX>::iterator iter2;
	PimJpGroup *jp_group = *iter;
	uint8_t group_addr_reserved_flags = 0;
	
	PUT_ENCODED_GROUP_ADDR(family(), jp_group->group_addr(),
			       jp_group->group_mask_len(),
			       group_addr_reserved_flags, buffer);
	// The number of joined sources
	BUFFER_PUT_HOST_16(jp_group->j_sources_n(), buffer);
	// The number of pruned sources
	BUFFER_PUT_HOST_16(jp_group->p_sources_n(), buffer);
	
	// (*,*,RP) Join
	for (iter2 = jp_group->rp()->j_list().begin();
	     iter2 != jp_group->rp()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | ESADDR_WC_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (*,*,RP) Prune
	for (iter2 = jp_group->rp()->p_list().begin();
	     iter2 != jp_group->rp()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | ESADDR_WC_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (*,G) Join
	for (iter2 = jp_group->wc()->j_list().begin();
	     iter2 != jp_group->wc()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | ESADDR_WC_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (S,G,rpt) Join
	for (iter2 = jp_group->sg_rpt()->j_list().begin();
	     iter2 != jp_group->sg_rpt()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (S,G) Join
	for (iter2 = jp_group->sg()->j_list().begin();
	     iter2 != jp_group->sg()->j_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (*,G) Prune
	for (iter2 = jp_group->wc()->p_list().begin();
	     iter2 != jp_group->wc()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | ESADDR_WC_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (S,G,rpt) Prune
	for (iter2 = jp_group->sg_rpt()->p_list().begin();
	     iter2 != jp_group->sg_rpt()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= ESADDR_RPT_BIT | sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
	// (S,G) Prune
	for (iter2 = jp_group->sg()->p_list().begin();
	     iter2 != jp_group->sg()->p_list().end();
	     ++iter2) {
	    source_addr		= *iter2;
	    source_mask_len	= IPvX::addr_bitlen(family());
	    flags		= sparse_bit;
	    PUT_ENCODED_SOURCE_ADDR(family(), source_addr, source_mask_len,
				    flags, buffer);
	}
    }
    
    //
    // Send the message
    //
    if (pim_vif->pim_send(pim_vif->primary_addr(), IPvX::PIM_ROUTERS(family()),
			  PIM_JOIN_PRUNE, buffer, error_msg)
	!= XORP_OK) {
	return (XORP_ERROR);
    }
    
    return (XORP_OK);
    
 invalid_addr_family_error:
    XLOG_UNREACHABLE();
    error_msg = c_format("INTERNAL %s ERROR: "
			 "invalid address family error = %d",
			 PIMTYPE2ASCII(PIM_JOIN_PRUNE),
			 family());
    XLOG_ERROR("%s", error_msg.c_str());
    return (XORP_ERROR);
    
 buflen_error:
    XLOG_UNREACHABLE();
    error_msg = c_format("INTERNAL %s ERROR: "
			 "packet cannot fit into sending buffer",
			 PIMTYPE2ASCII(PIM_JOIN_PRUNE));
    XLOG_ERROR("%s", error_msg.c_str());
    
    return (XORP_ERROR);
}
