// -*- c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t -*-// Copyright (c) 2001-2008 XORP, Inc.//// 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.#ident "$XORP: xorp/contrib/mld6igmp_lite/mld6igmp_source_record.cc,v 1.2 2008/07/23 05:09:49 pavlin Exp $"//// Multicast source record information used by IGMPv3 (RFC 3376) and// MLDv2 (RFC 3810).//#include "mld6igmp_module.h"#include "libxorp/xorp.h"#include "libxorp/xlog.h"#include "libxorp/debug.h"#include "libxorp/ipvx.hh"#include "mld6igmp_source_record.hh"#include "mld6igmp_group_record.hh"#include "mld6igmp_vif.hh"//// Exported variables////// Local constants definitions////// Local structures/classes, typedefs and macros////// Local variables////// Local functions prototypes///** * Mld6igmpSourceRecord::Mld6igmpSourceRecord: * @group_record: The group record this entry belongs to. * @source: The entry source address. *  * Return value:  **/Mld6igmpSourceRecord::Mld6igmpSourceRecord(Mld6igmpGroupRecord& group_record,					   const IPvX& source)    : _group_record(group_record),      _source(source),      _query_retransmission_count(0){    }/** * Mld6igmpSourceRecord::~Mld6igmpSourceRecord: * @:  *  * Mld6igmpSourceRecord destructor. **/Mld6igmpSourceRecord::~Mld6igmpSourceRecord(){}/** * Set the source timer. * * @param timeval the timeout interval of the source timer. */voidMld6igmpSourceRecord::set_source_timer(const TimeVal& timeval){    EventLoop& eventloop = _group_record.eventloop();    _source_timer = eventloop.new_oneoff_after(	timeval,	callback(this, &Mld6igmpSourceRecord::source_timer_timeout));}/** * Cancel the source timer. */voidMld6igmpSourceRecord::cancel_source_timer(){    _source_timer.unschedule();}/** * Lower the source timer. * * @param timeval the timeout interval the source timer should be * lowered to. */voidMld6igmpSourceRecord::lower_source_timer(const TimeVal& timeval){    EventLoop& eventloop = _group_record.eventloop();    TimeVal timeval_remaining;    //    // Lower the source timer    //    _source_timer.time_remaining(timeval_remaining);    if (timeval < timeval_remaining) {	_source_timer = eventloop.new_oneoff_after(	    timeval,	    callback(this, &Mld6igmpSourceRecord::source_timer_timeout));    }}/** * Timeout: the source timer has expired. */voidMld6igmpSourceRecord::source_timer_timeout(){    _group_record.source_expired(this);}/** * Get the number of seconds until the source timer expires. *  * @return the number of seconds until the source timer expires. */uint32_tMld6igmpSourceRecord::timeout_sec() const{    TimeVal tv;        _source_timer.time_remaining(tv);        return (tv.sec());}/** * Constructor for a given group record. * * @param group_record the group record this set belongs to. */Mld6igmpSourceSet::Mld6igmpSourceSet(Mld6igmpGroupRecord& group_record)    : _group_record(group_record){}/** * Destructor. */Mld6igmpSourceSet::~Mld6igmpSourceSet(){    // XXX: don't delete the payload, because it might be used elsewhere}/** * Find a source record. * * @param source the source address. * @return the corresponding source record (@ref Mld6igmpSourceRecord) * if found, otherwise NULL. */Mld6igmpSourceRecord*Mld6igmpSourceSet::find_source_record(const IPvX& source){    Mld6igmpSourceSet::iterator iter = this->find(source);    if (iter != this->end())	return (iter->second);    return (NULL);}/** * Delete the payload of the set, and clear the set itself. */voidMld6igmpSourceSet::delete_payload_and_clear(){    Mld6igmpSourceSet::iterator iter;    //    // Delete the payload of the set    //    for (iter = this->begin(); iter != this->end(); ++iter) {	Mld6igmpSourceRecord* source_record = iter->second;	delete source_record;    }    //    // Clear the set itself    //    this->clear();}/** * Assignment operator for sets. * * @param other the right-hand operand. * @return the assigned set. */Mld6igmpSourceSet&Mld6igmpSourceSet::operator=(const Mld6igmpSourceSet& other){    Mld6igmpSourceSet::const_iterator iter;    XLOG_ASSERT(&_group_record == &(other._group_record));    this->clear();    //    // Copy the payload of the set    //    for (iter = other.begin(); iter != other.end(); ++iter) {	insert(make_pair(iter->first, iter->second));    }    return (*this);}/** * UNION operator for sets. * * @param other the right-hand operand. * @return the union of two sets. Note that if an element is in * both sets, we use the value from the first set. */Mld6igmpSourceSetMld6igmpSourceSet::operator+(const Mld6igmpSourceSet& other){    Mld6igmpSourceSet result(*this);	// XXX: all elements from the first set    Mld6igmpSourceSet::const_iterator iter;    //    // Insert all elements from the second set that are not in the first set    //    for (iter = other.begin(); iter != other.end(); ++iter) {	const IPvX& ipvx = iter->first;	if (result.find(ipvx) == result.end())	    result.insert(make_pair(iter->first, iter->second));    }    return (result);}/** * UNION operator for sets when the second operand is a set of IPvX * addresses. * * @param other the right-hand operand. * @return the union of two sets. Note that if an element is not in the * first set, then it is created (see @ref Mld6igmpSourceRecord). */Mld6igmpSourceSetMld6igmpSourceSet::operator+(const set<IPvX>& other){    Mld6igmpSourceSet result(*this);	// XXX: all elements from the first set    set<IPvX>::const_iterator iter;    Mld6igmpSourceRecord* source_record;    //    // Insert all elements from the second set that are not in the first set    //    for (iter = other.begin(); iter != other.end(); ++iter) {	const IPvX& ipvx = *iter;	if (result.find(ipvx) == result.end()) {	    source_record = new Mld6igmpSourceRecord(_group_record, ipvx);	    result.insert(make_pair(ipvx, source_record));	}    }    return (result);}/** * INTERSECTION operator for sets. * * @param other the right-hand operand. * @return the intersection of two sets. Note that we use the values * from the first set. */Mld6igmpSourceSetMld6igmpSourceSet::operator*(const Mld6igmpSourceSet& other){    Mld6igmpSourceSet result(_group_record);    Mld6igmpSourceSet::const_iterator iter;    //    // Insert all elements from the first set that are also in the second set    //    for (iter = this->begin(); iter != this->end(); ++iter) {	const IPvX& ipvx = iter->first;	if (other.find(ipvx) != other.end())	    result.insert(make_pair(iter->first, iter->second));    }    return (result);}/** * INTERSECTION operator for sets when the second operand is a set of IPvX * addresses. * * @param other the right-hand operand. * @return the intersection of two sets. Note that we use the values * from the first set. */Mld6igmpSourceSetMld6igmpSourceSet::operator*(const set<IPvX>& other){    Mld6igmpSourceSet result(_group_record);    Mld6igmpSourceSet::const_iterator iter;    //    // Insert all elements from the first set that are also in the second set    //    for (iter = this->begin(); iter != this->end(); ++iter) {	const IPvX& ipvx = iter->first;	if (other.find(ipvx) != other.end())	    result.insert(make_pair(iter->first, iter->second));    }    return (result);}/** * REMOVAL operator for sets. * * @param other the right-hand operand. * @return the elements from the first set (after the elements from * the right-hand set have been removed). */Mld6igmpSourceSetMld6igmpSourceSet::operator-(const Mld6igmpSourceSet& other){    Mld6igmpSourceSet result(_group_record);    Mld6igmpSourceSet::const_iterator iter;    //    // Insert all elements from the first set that are not in the second set    //    for (iter = this->begin(); iter != this->end(); ++iter) {	const IPvX& ipvx = iter->first;	if (other.find(ipvx) == other.end())	    result.insert(make_pair(iter->first, iter->second));    }    return (result);}/** * REMOVAL operator for sets when the second operand is a set of IPvX * addresses. * * @param other the right-hand operand. * @return the elements from the first set (after the elements from * the right-hand set have been removed). */Mld6igmpSourceSetMld6igmpSourceSet::operator-(const set<IPvX>& other){    Mld6igmpSourceSet result(_group_record);    Mld6igmpSourceSet::const_iterator iter;    //    // Insert all elements from the first set that are not in the second set    //    for (iter = this->begin(); iter != this->end(); ++iter) {	const IPvX& ipvx = iter->first;	if (other.find(ipvx) == other.end())	    result.insert(make_pair(iter->first, iter->second));    }    return (result);}/** * Set the source timer for a set of source addresses. * * @param sources the set of source addresses whose source timer will * be set. * @param timeval the timeout interval of the source timer. */voidMld6igmpSourceSet::set_source_timer(const set<IPvX>& sources,				    const TimeVal& timeval){    set<IPvX>::const_iterator iter;    Mld6igmpSourceSet::iterator record_iter;    for (iter = sources.begin(); iter != sources.end(); ++iter) {	const IPvX& ipvx = *iter;	record_iter = this->find(ipvx);	if (record_iter != this->end()) {	    Mld6igmpSourceRecord* source_record = record_iter->second;	    source_record->set_source_timer(timeval);	}    }}/** * Set the source timer for all source addresses. * * @param timeval the timeout interval of the source timer. */voidMld6igmpSourceSet::set_source_timer(const TimeVal& timeval){    Mld6igmpSourceSet::iterator iter;    for (iter = this->begin(); iter != this->end(); ++iter) {	Mld6igmpSourceRecord* source_record = iter->second;	source_record->set_source_timer(timeval);    }}/** * Cancel the source timer for a set of source addresses. * * @param sources the set of source addresses whose source timer will * be canceled. */voidMld6igmpSourceSet::cancel_source_timer(const set<IPvX>& sources){    set<IPvX>::const_iterator iter;    Mld6igmpSourceSet::iterator record_iter;    for (iter = sources.begin(); iter != sources.end(); ++iter) {	const IPvX& ipvx = *iter;	record_iter = this->find(ipvx);	if (record_iter != this->end()) {	    Mld6igmpSourceRecord* source_record = record_iter->second;	    source_record->cancel_source_timer();	}    }}/** * Cancel the source timer for all source addresses. */voidMld6igmpSourceSet::cancel_source_timer(){    Mld6igmpSourceSet::iterator iter;    for (iter = this->begin(); iter != this->end(); ++iter) {	Mld6igmpSourceRecord* source_record = iter->second;	source_record->cancel_source_timer();    }}/** * Lower the source timer for a set of sources. * * @param sources the source addresses. * @param timeval the timeout interval the source timer should be * lowered to. */voidMld6igmpSourceSet::lower_source_timer(const set<IPvX>& sources,				      const TimeVal& timeval){    set<IPvX>::const_iterator iter;    Mld6igmpSourceSet::iterator record_iter;    for (iter = sources.begin(); iter != sources.end(); ++iter) {	const IPvX& ipvx = *iter;	record_iter = this->find(ipvx);	if (record_iter != this->end()) {	    Mld6igmpSourceRecord* source_record = record_iter->second;	    source_record->lower_source_timer(timeval);	}    }}/** * Extract the set of source addresses. * * @return the set with the source addresses. */set<IPvX>Mld6igmpSourceSet::extract_source_addresses() const{    set<IPvX> sources;    Mld6igmpSourceSet::const_iterator record_iter;    for (record_iter = this->begin();	 record_iter != this->end();	 ++record_iter) {	const Mld6igmpSourceRecord* source_record = record_iter->second;	const IPvX& ipvx = source_record->source();	sources.insert(ipvx);    }    return (sources);}