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
  38 #ifndef __BASE_CHANNEL_ADDR_HH__
  39 #define __BASE_CHANNEL_ADDR_HH__
  40
  41 #include <ostream>
  42
  43 #include "base/addr_range.hh"
  44
  45 /**
  46  * Class holding a guest address in a contiguous channel-local address
  47  * space.
  48  */
  49 class ChannelAddr
  50 {
  51   public:
  52     using Type = Addr;
  53
  54     /** Explicit constructor assigning a value. */
  55     explicit constexpr ChannelAddr(Type _a) : a(_a) { }
  56
  57     /** Converting back to the value type. */
  58     explicit constexpr operator Type() const { return a; }
  59
  60     /** Converting back to the value type. */
  61     constexpr Type value() const { return a; }
  62
  63     constexpr ChannelAddr() : a(0) { }
  64
  65     ChannelAddr(const AddrRange &range, Addr _a)
  66         : a(range.removeIntlvBits(_a)) {}
  67
  68     ChannelAddr(const ChannelAddr &) = default;
  69     ChannelAddr &operator=(const ChannelAddr &) = default;
  70
  71
  72     Addr getPA(const AddrRange &range) const {
  73         return range.addIntlvBits(a);
  74     }
  75
  76     constexpr ChannelAddr operator|(const Type b) const {
  77         return ChannelAddr(a | b);
  78     }
  79     constexpr ChannelAddr operator&(const Type b) const {
  80         return ChannelAddr(a & b);
  81     }
  82
  83     constexpr ChannelAddr operator>>(const int b) const {
  84         return ChannelAddr(a >> b);
  85     }
  86
  87     constexpr ChannelAddr operator<<(const int b) const {
  88         return ChannelAddr(a << b);
  89     }
  90
  91     constexpr ChannelAddr operator*(const Type &b) const {
  92         return ChannelAddr(a * b);
  93     }
  94
  95     constexpr ChannelAddr operator/(const Type &b) const {
  96         return ChannelAddr(a / b);
  97     }
  98
  99     constexpr ChannelAddr operator+(const Type &b) const {
 100         return ChannelAddr(a + b);
 101     }
 102
 103     constexpr ChannelAddr operator-(const Type &b) const {
 104         return ChannelAddr(a - b);
 105     }
 106
 107     constexpr ChannelAddr operator|(const ChannelAddr &b) const {
 108         return ChannelAddr(a | b.a);
 109     }
 110
 111     constexpr ChannelAddr operator&(const ChannelAddr &b) const {
 112         return ChannelAddr(a & b.a);
 113     }
 114
 115     constexpr ChannelAddr operator^(const ChannelAddr &b) const {
 116         return ChannelAddr(a ^ b.a);
 117     }
 118
 119     constexpr ChannelAddr operator+(const ChannelAddr &b) const {
 120         return ChannelAddr(a + b.a);
 121     }
 122
 123     constexpr ChannelAddr operator-(const ChannelAddr &b) const {
 124         return ChannelAddr(a - b.a);
 125     }
 126
 127     constexpr bool operator>(const ChannelAddr &b) const { return a > b.a; }
 128     constexpr bool operator>=(const ChannelAddr &b) const { return a >= b.a; }
 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
 134   private:
 135     /** Member holding the actual value. */
 136     Type a;
 137 };
 138
 139 /**
 140  * The ChanneelAddrRange class describes a contiguous range of
 141  * addresses in a contiguous channel-local address space.
 142  */
 143 class ChannelAddrRange
 144 {
 145   public:
 146     constexpr ChannelAddrRange()
 147         : ChannelAddrRange(ChannelAddr(1), ChannelAddr(0)) {}
 148
 149     constexpr ChannelAddrRange(ChannelAddr start, ChannelAddr end)
 150         : _start(start), _end(end) {}
 151
 152     ChannelAddrRange(AddrRange ch_range, Addr start, Addr end);
 153     ChannelAddrRange(AddrRange ch_range, AddrRange range);
 154
 155     constexpr ChannelAddrRange(const ChannelAddrRange &) = default;
 156
 157     constexpr ChannelAddr size() const { return _end - _start + 1; }
 158
 159     constexpr bool valid() const { return _start <= _end; }
 160
 161     constexpr ChannelAddr start() const { return _start; }
 162     constexpr ChannelAddr end() const { return _end; }
 163
 164     constexpr bool contains(ChannelAddr a) const {
 165         return a >= _start && a <= _end;
 166     }
 167
 168   protected:
 169     ChannelAddr _start;
 170     ChannelAddr _end;
 171 };
 172
 173 namespace std
 174 {
 175     template<>
 176     struct hash<ChannelAddr>
 177     {
 178         typedef ChannelAddr argument_type;
 179         typedef std::size_t result_type;
 180
 181         result_type
 182         operator()(argument_type const &a) const noexcept {
 183             return std::hash<ChannelAddr::Type>{}(
 184                 static_cast<argument_type::Type>(a));
 185         }
 186     };
 187 }
 188
 189 std::ostream &operator<<(std::ostream &out, const ChannelAddr &addr);
 190
 191 #endif // __BASE_CHANNEL_ADDR_HH__