xref: /gem5/src/mem/ruby/common/NetDest.hh

/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Set.h
 *
 * Description:
 *
 * $Id$
 *
 */

// NetDest specifies the network destination of a NetworkMessage
// This is backward compatible with the Set class that was previously
// used to specify network destinations.
// NetDest supports both node networks and component networks

#ifndef NETDEST_H
#define NETDEST_H

#include "mem/ruby/common/Global.hh"
#include "mem/gems_common/Vector.hh"
#include "mem/ruby/system/NodeID.hh"
#include "mem/ruby/system/MachineID.hh"
#include "mem/ruby/config/RubyConfig.hh"
#include "mem/ruby/common/Set.hh"
#include "mem/protocol/MachineType.hh"

class Set;

class NetDest {
public:
  // Constructors
  // creates and empty set
  NetDest();
  explicit NetDest(int bit_size);

  NetDest& operator=(const Set& obj);

  // Destructor
  // ~NetDest();

  // Public Methods
  void add(MachineID newElement);
  void addNetDest(const NetDest& netDest);
  void addRandom();
  void setNetDest(MachineType machine, const Set& set);
  void remove(MachineID oldElement);
  void removeNetDest(const NetDest& netDest);
  void clear();
  void broadcast();
  void broadcast(MachineType machine);
  int count() const;
  bool isEqual(const NetDest& netDest);

  NetDest OR(const NetDest& orNetDest) const;  // return the logical OR of this netDest and orNetDest
  NetDest AND(const NetDest& andNetDest) const;  // return the logical AND of this netDest and andNetDest

  // Returns true if the intersection of the two netDests is non-empty
  bool intersectionIsNotEmpty(const NetDest& other_netDest) const;

  // Returns true if the intersection of the two netDests is empty
  bool intersectionIsEmpty(const NetDest& other_netDest) const;

  bool isSuperset(const NetDest& test) const;
  bool isSubset(const NetDest& test) const { return test.isSuperset(*this); }
  bool isElement(MachineID element) const;
  bool isBroadcast() const;
  bool isEmpty() const;

  //For Princeton Network
  Vector<NodeID> getAllDest();

  NodeID smallestElement() const;
  MachineID smallestElement(MachineType machine) const;

  void setSize();
  int getSize() const { return m_bits.size(); }

  // get element for a index
  NodeID elementAt(MachineID index);

  void print(ostream& out) const;

private:

  // Private Methods
  // returns a value >= MachineType_base_level("this machine") and < MachineType_base_level("next highest machine")
  int vecIndex(MachineID m) const {
    int vec_index = MachineType_base_level(m.type);
    assert(vec_index < m_bits.size());
    return vec_index;
  }

  NodeID bitIndex(NodeID index) const {
    return index;
  }

  // Data Members (m_ prefix)
  Vector < Set > m_bits;  // a Vector of bit vectors - i.e. Sets

};

// Output operator declaration
ostream& operator<<(ostream& out, const NetDest& obj);

// ******************* Definitions *******************

// Output operator definition
extern inline
ostream& operator<<(ostream& out, const NetDest& obj)
{
  obj.print(out);
  out << flush;
  return out;
}

#endif //NETDEST_H