src/base/channel_addr.hh

   1 /*
   2  * Copyright (c) 2019 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  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * Authors: Andreas Sandberg
  38  */
  39
  40 #ifndef __BASE_CHANNEL_ADDR_HH__
  41 #define __BASE_CHANNEL_ADDR_HH__
  42
  43 #include <ostream>
  44
  45 #include "base/addr_range.hh"
  46
  47 /**
  48  * Class holding a guest address in a contiguous channel-local address
  49  * space.
  50  */
  51 class ChannelAddr
  52 {
  53   public:
  54     using Type = Addr;
  55
  56     /** Explicit constructor assigning a value. */
  57     explicit constexpr ChannelAddr(Type _a) : a(_a) { }
  58
  59     /** Converting back to the value type. */
  60     explicit constexpr operator Type() const { return a; }
  61
  62     /** Converting back to the value type. */
  63     constexpr Type value() const { return a; }
  64
  65     constexpr ChannelAddr() : a(0) { }
  66
  67     ChannelAddr(const AddrRange &range, Addr _a)
  68         : a(range.removeIntlvBits(_a)) {}
  69
  70     ChannelAddr(const ChannelAddr &) = default;
  71     ChannelAddr &operator=(const ChannelAddr &) = default;
  72
  73
  74     Addr getPA(const AddrRange &range) const {
  75         return range.addIntlvBits(a);
  76     }
  77
  78     constexpr ChannelAddr operator|(const Type b) const {
  79         return ChannelAddr(a | b);
  80     }
  81     constexpr ChannelAddr operator&(const Type b) const {
  82         return ChannelAddr(a & b);
  83     }
  84
  85     constexpr ChannelAddr operator>>(const int b) const {
  86         return ChannelAddr(a >> b);
  87     }
  88
  89     constexpr ChannelAddr operator<<(const int b) const {
  90         return ChannelAddr(a << b);
  91     }
  92
  93     constexpr ChannelAddr operator*(const Type &b) const {
  94         return ChannelAddr(a * b);
  95     }
  96
  97     constexpr ChannelAddr operator/(const Type &b) const {
  98         return ChannelAddr(a / b);
  99     }
 100
 101     constexpr ChannelAddr operator+(const Type &b) const {
 102         return ChannelAddr(a + b);
 103     }
 104
 105     constexpr ChannelAddr operator-(const Type &b) const {
 106         return ChannelAddr(a - b);
 107     }
 108
 109     constexpr ChannelAddr operator|(const ChannelAddr &b) const {
 110         return ChannelAddr(a | b.a);
 111     }
 112
 113     constexpr ChannelAddr operator&(const ChannelAddr &b) const {
 114         return ChannelAddr(a & b.a);
 115     }
 116
 117     constexpr ChannelAddr operator^(const ChannelAddr &b) const {
 118         return ChannelAddr(a ^ b.a);
 119     }
 120
 121     constexpr ChannelAddr operator+(const ChannelAddr &b) const {
 122         return ChannelAddr(a + b.a);
 123     }
 124
 125     constexpr ChannelAddr operator-(const ChannelAddr &b) const {
 126         return ChannelAddr(a - b.a);
 127     }
 128
 129     constexpr bool operator>(const ChannelAddr &b) const { return a > b.a; }
 130     constexpr bool operator>=(const ChannelAddr &b) const { return a >= b.a; }
 131     constexpr bool operator<(const ChannelAddr &b) const { return a < b.a; }
 132     constexpr bool operator<=(const ChannelAddr &b) const { return a <= b.a; }
 133     constexpr bool operator==(const ChannelAddr &b) const { return a == b.a; }
 134     constexpr bool operator!=(const ChannelAddr &b) const { return a != b.a; }
 135
 136   private:
 137     /** Member holding the actual value. */
 138     Type a;
 139 };
 140
 141 /**
 142  * The ChanneelAddrRange class describes a contiguous range of
 143  * addresses in a contiguous channel-local address space.
 144  */
 145 class ChannelAddrRange
 146 {
 147   public:
 148     constexpr ChannelAddrRange()
 149         : ChannelAddrRange(ChannelAddr(1), ChannelAddr(0)) {}
 150
 151     constexpr ChannelAddrRange(ChannelAddr start, ChannelAddr end)
 152         : _start(start), _end(end) {}
 153
 154     ChannelAddrRange(AddrRange ch_range, Addr start, Addr end);
 155     ChannelAddrRange(AddrRange ch_range, AddrRange range);
 156
 157     constexpr ChannelAddrRange(const ChannelAddrRange &) = default;
 158
 159     constexpr ChannelAddr size() const { return _end - _start + 1; }
 160
 161     constexpr bool valid() const { return _start <= _end; }
 162
 163     constexpr ChannelAddr start() const { return _start; }
 164     constexpr ChannelAddr end() const { return _end; }
 165
 166     constexpr bool contains(ChannelAddr a) const {
 167         return a >= _start && a <= _end;
 168     }
 169
 170   protected:
 171     ChannelAddr _start;
 172     ChannelAddr _end;
 173 };
 174
 175 namespace std
 176 {
 177     template<>
 178     struct hash<ChannelAddr>
 179     {
 180         typedef ChannelAddr argument_type;
 181         typedef std::size_t result_type;
 182
 183         result_type
 184         operator()(argument_type const &a) const noexcept {
 185             return std::hash<ChannelAddr::Type>{}(
 186                 static_cast<argument_type::Type>(a));
 187         }
 188     };
 189 }
 190
 191 std::ostream &operator<<(std::ostream &out, const ChannelAddr &addr);
 192
 193 #endif // __BASE_CHANNEL_ADDR_HH__