src/mem/ruby/common/Address.hh

   1 /*
   2  * Copyright (c) 1999 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_ADDRESS_HH__
  30 #define __MEM_RUBY_COMMON_ADDRESS_HH__
  31
  32 #include <cassert>
  33 #include <iomanip>
  34 #include <iostream>
  35
  36 #include "base/types.hh"
  37
  38 const uint32_t ADDRESS_WIDTH = 64; // address width in bytes
  39
  40 // selects bits inclusive
  41 Addr bitSelect(Addr addr, unsigned int small, unsigned int big);
  42 Addr bitRemove(Addr addr, unsigned int small, unsigned int big);
  43 Addr maskLowOrderBits(Addr addr, unsigned int number);
  44 Addr maskHighOrderBits(Addr addr, unsigned int number);
  45 Addr shiftLowOrderBits(Addr addr, unsigned int number);
  46 Addr getOffset(Addr addr);
  47 Addr makeLineAddress(Addr addr);
  48 Addr makeNextStrideAddress(Addr addr, int stride);
  49 std::string printAddress(Addr addr);
  50
  51 #endif // __MEM_RUBY_COMMON_ADDRESS_HH__