NetDest.hh revision 8232:b28d06a175be 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29// NetDest specifies the network destination of a NetworkMessage
30// This is backward compatible with the Set class that was previously
31// used to specify network destinations.
32// NetDest supports both node networks and component networks
33
34#ifndef __MEM_RUBY_COMMON_NETDEST_HH__
35#define __MEM_RUBY_COMMON_NETDEST_HH__
36
37#include <iostream>
38#include <vector>
39
40#include "debug/RubyMemory.hh"
41#include "mem/protocol/MachineType.hh"
42#include "mem/ruby/common/Global.hh"
43#include "mem/ruby/common/Set.hh"
44#include "mem/ruby/system/MachineID.hh"
45#include "mem/ruby/system/NodeID.hh"
46
47class NetDest
48{
49  public:
50    // Constructors
51    // creates and empty set
52    NetDest();
53    explicit NetDest(int bit_size);
54
55    NetDest& operator=(const Set& obj);
56
57    ~NetDest()
58    { }
59
60    void add(MachineID newElement);
61    void addNetDest(const NetDest& netDest);
62    void addRandom();
63    void setNetDest(MachineType machine, const Set& set);
64    void remove(MachineID oldElement);
65    void removeNetDest(const NetDest& netDest);
66    void clear();
67    void broadcast();
68    void broadcast(MachineType machine);
69    int count() const;
70    bool isEqual(const NetDest& netDest);
71
72    // return the logical OR of this netDest and orNetDest
73    NetDest OR(const NetDest& orNetDest) const;
74
75    // return the logical AND of this netDest and andNetDest
76    NetDest AND(const NetDest& andNetDest) const;
77
78    // Returns true if the intersection of the two netDests is non-empty
79    bool intersectionIsNotEmpty(const NetDest& other_netDest) const;
80
81    // Returns true if the intersection of the two netDests is empty
82    bool intersectionIsEmpty(const NetDest& other_netDest) const;
83
84    bool isSuperset(const NetDest& test) const;
85    bool isSubset(const NetDest& test) const { return test.isSuperset(*this); }
86    bool isElement(MachineID element) const;
87    bool isBroadcast() const;
88    bool isEmpty() const;
89
90    // For Princeton Network
91    std::vector<NodeID> getAllDest();
92
93    MachineID smallestElement() const;
94    MachineID smallestElement(MachineType machine) const;
95
96    void resize();
97    int getSize() const { return m_bits.size(); }
98
99    // get element for a index
100    NodeID elementAt(MachineID index);
101
102    void print(std::ostream& out) const;
103
104  private:
105    // returns a value >= MachineType_base_level("this machine")
106    // and < MachineType_base_level("next highest machine")
107    int
108    vecIndex(MachineID m) const
109    {
110        int vec_index = MachineType_base_level(m.type);
111        assert(vec_index < m_bits.size());
112        return vec_index;
113    }
114
115    NodeID
116    bitIndex(NodeID index) const
117    {
118        return index;
119    }
120
121    std::vector<Set> m_bits;  // a vector of bit vectors - i.e. Sets
122};
123
124inline std::ostream&
125operator<<(std::ostream& out, const NetDest& obj)
126{
127    obj.print(out);
128    out << std::flush;
129    return out;
130}
131
132#endif // __MEM_RUBY_COMMON_NETDEST_HH__
133
134