gem5  v21.1.0.2
MachineID.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020 ARM Limited
3  * All rights reserved.
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
41 #ifndef __MEM_RUBY_COMMON_MACHINEID_HH__
42 #define __MEM_RUBY_COMMON_MACHINEID_HH__
43 
44 #include <iostream>
45 #include <string>
46 
47 #include "base/cprintf.hh"
48 #include "mem/ruby/protocol/MachineType.hh"
49 
50 namespace gem5
51 {
52 
53 namespace ruby
54 {
55 
56 struct MachineID
57 {
58  MachineID() : type(MachineType_NUM), num(0) { }
59  MachineID(MachineType mach_type, NodeID node_id)
60  : type(mach_type), num(node_id) { }
61 
62  MachineType type;
65 
66  MachineType getType() const { return type; }
67  NodeID getNum() const { return num; }
68 
69  bool isValid() const { return type != MachineType_NUM; }
70 };
71 
72 inline std::string
74 {
75  return csprintf("%s_%d", MachineType_to_string(machine.type), machine.num);
76 }
77 
78 inline bool
79 operator==(const MachineID & obj1, const MachineID & obj2)
80 {
81  return (obj1.type == obj2.type && obj1.num == obj2.num);
82 }
83 
84 inline bool
85 operator!=(const MachineID & obj1, const MachineID & obj2)
86 {
87  return (obj1.type != obj2.type || obj1.num != obj2.num);
88 }
89 
90 // Output operator declaration
91 ::std::ostream& operator<<(::std::ostream& out, const MachineID& obj);
92 
93 inline ::std::ostream&
94 operator<<(::std::ostream& out, const MachineID& obj)
95 {
96  if ((obj.type < MachineType_NUM) && (obj.type >= MachineType_FIRST)) {
97  out << MachineType_to_string(obj.type);
98  } else {
99  out << "NULL";
100  }
101  out << "-";
102  out << obj.num;
103  out << ::std::flush;
104  return out;
105 }
106 
107 } // namespace ruby
108 } // namespace gem5
109 
110 namespace std
111 {
112  template<>
113  struct hash<gem5::ruby::MachineID>
114  {
115  inline size_t operator()(const gem5::ruby::MachineID& id) const
116  {
117  size_t hval = gem5::ruby::MachineType_base_level(
118  id.type) << 16 | id.num;
119  return hval;
120  }
121  };
122 } // namespace std
123 
124 #endif // __MEM_RUBY_COMMON_MACHINEID_HH__
gem5::ruby::MachineID::getType
MachineType getType() const
Definition: MachineID.hh:66
gem5::ruby::operator<<
std::ostream & operator<<(std::ostream &os, const BoolVec &myvector)
Definition: BoolVec.cc:49
gem5::ruby::MachineID::num
NodeID num
range: 0 ... number of this machine's components in system - 1
Definition: MachineID.hh:64
gem5::csprintf
std::string csprintf(const char *format, const Args &...args)
Definition: cprintf.hh:161
gem5::ruby::operator==
bool operator==(const DataBlock &obj1, const DataBlock &obj2)
Definition: DataBlock.hh:137
gem5::ruby::MachineID::type
MachineType type
Definition: MachineID.hh:62
gem5::X86ISA::type
type
Definition: misc.hh:733
gem5::ruby::MachineID::isValid
bool isValid() const
Definition: MachineID.hh:69
gem5::ruby::MachineID::MachineID
MachineID()
Definition: MachineID.hh:58
cprintf.hh
gem5::ruby::MachineID::getNum
NodeID getNum() const
Definition: MachineID.hh:67
std
Overload hash function for BasicBlockRange type.
Definition: types.hh:111
gem5::ruby::operator!=
bool operator!=(const MachineID &obj1, const MachineID &obj2)
Definition: MachineID.hh:85
gem5::ruby::NodeID
unsigned int NodeID
Definition: TypeDefines.hh:40
gem5::ruby::MachineID::MachineID
MachineID(MachineType mach_type, NodeID node_id)
Definition: MachineID.hh:59
std::hash< gem5::ruby::MachineID >::operator()
size_t operator()(const gem5::ruby::MachineID &id) const
Definition: MachineID.hh:115
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ruby::MachineIDToString
std::string MachineIDToString(MachineID machine)
Definition: MachineID.hh:73
gem5::ruby::MachineID
Definition: MachineID.hh:56

Generated on Tue Sep 21 2021 12:25:40 for gem5 by doxygen 1.8.17