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