RubySlicc_ComponentMapping.hh revision 10005:8c2b0dc16ccd 
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_SLICC_INTERFACE_RUBYSLICC_COMPONENTMAPPINGS_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_RUBYSLICC_COMPONENTMAPPINGS_HH__
31
32#include "mem/protocol/MachineType.hh"
33#include "mem/ruby/common/Address.hh"
34#include "mem/ruby/common/Global.hh"
35#include "mem/ruby/common/NetDest.hh"
36#include "mem/ruby/system/DirectoryMemory.hh"
37#include "mem/ruby/system/MachineID.hh"
38
39// used to determine the home directory
40// returns a value between 0 and total_directories_within_the_system
41inline NodeID
42map_Address_to_DirectoryNode(const Address& addr)
43{
44    return DirectoryMemory::mapAddressToDirectoryVersion(addr);
45}
46
47// used to determine the home directory
48// returns a value between 0 and total_directories_within_the_system
49inline MachineID
50map_Address_to_Directory(const Address &addr)
51{
52    MachineID mach =
53        {MachineType_Directory, map_Address_to_DirectoryNode(addr)};
54    return mach;
55}
56
57inline NetDest
58broadcast(MachineType type)
59{
60    NetDest dest;
61    for (NodeID i = 0; i < MachineType_base_count(type); i++) {
62        MachineID mach = {type, i};
63        dest.add(mach);
64    }
65    return dest;
66}
67
68inline MachineID
69mapAddressToRange(const Address & addr, MachineType type, int low_bit,
70                  int num_bits, int cluster_id = 0)
71{
72    MachineID mach = {type, 0};
73    if (num_bits == 0)
74        mach.num = cluster_id;
75    else
76        mach.num = addr.bitSelect(low_bit, low_bit + num_bits - 1)
77            + (1 << num_bits) * cluster_id;
78    return mach;
79}
80
81inline NodeID
82machineIDToNodeID(MachineID machID)
83{
84    return machID.num;
85}
86
87inline MachineType
88machineIDToMachineType(MachineID machID)
89{
90    return machID.type;
91}
92
93inline int
94machineCount(MachineType machType)
95{
96    return MachineType_base_count(machType);
97}
98
99#endif  // __MEM_RUBY_SLICC_INTERFACE_COMPONENTMAPPINGS_HH__
100