MachineID.hh revision 12492 
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#ifndef __MEM_RUBY_COMMON_MACHINEID_HH__
30#define __MEM_RUBY_COMMON_MACHINEID_HH__
31
32#include <iostream>
33#include <string>
34
35#include "base/cprintf.hh"
36#include "mem/protocol/MachineType.hh"
37
38struct MachineID
39{
40    MachineID() : type(MachineType_NULL), num(0) { }
41    MachineID(MachineType mach_type, NodeID node_id)
42        : type(mach_type), num(node_id) { }
43
44    MachineType type;
45    //! range: 0 ... number of this machine's components in system - 1
46    NodeID num;
47
48    MachineType getType() const { return type; }
49    NodeID getNum() const { return num; }
50};
51
52inline std::string
53MachineIDToString(MachineID machine)
54{
55    return csprintf("%s_%d", MachineType_to_string(machine.type), machine.num);
56}
57
58inline bool
59operator==(const MachineID & obj1, const MachineID & obj2)
60{
61    return (obj1.type == obj2.type && obj1.num == obj2.num);
62}
63
64inline bool
65operator!=(const MachineID & obj1, const MachineID & obj2)
66{
67    return (obj1.type != obj2.type || obj1.num != obj2.num);
68}
69
70// Output operator declaration
71std::ostream& operator<<(std::ostream& out, const MachineID& obj);
72
73inline std::ostream&
74operator<<(std::ostream& out, const MachineID& obj)
75{
76    if ((obj.type < MachineType_NUM) && (obj.type >= MachineType_FIRST)) {
77        out << MachineType_to_string(obj.type);
78    } else {
79        out << "NULL";
80    }
81    out << "-";
82    out << obj.num;
83    out << std::flush;
84    return out;
85}
86
87#endif // __MEM_RUBY_COMMON_MACHINEID_HH__
88