src/arch/power/insts/integer.hh

   1 /*
   2  * Copyright (c) 2009 The University of Edinburgh
   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 __ARCH_POWER_INSTS_INTEGER_HH__
  30 #define __ARCH_POWER_INSTS_INTEGER_HH__
  31
  32 #include "arch/power/insts/static_inst.hh"
  33 #include "base/bitfield.hh"
  34 #include "base/cprintf.hh"
  35
  36 namespace PowerISA
  37 {
  38
  39 /**
  40  * We provide a base class for integer operations and then inherit for
  41  * several other classes. These specialise for instructions using immediate
  42  * values and also rotate instructions. We also need to have versions that
  43  * consider the Rc and OE bits.
  44  */
  45
  46 /**
  47  * Base class for integer operations.
  48  */
  49 class IntOp : public PowerStaticInst
  50 {
  51   protected:
  52
  53     bool rcSet;
  54     bool oeSet;
  55
  56     // Needed for srawi only
  57     uint32_t sh;
  58
  59     /// Constructor
  60     IntOp(const char *mnem, MachInst _machInst, OpClass __opClass)
  61       : PowerStaticInst(mnem, _machInst, __opClass),
  62         rcSet(false), oeSet(false)
  63     {
  64     }
  65
  66     /* Compute the CR (condition register) field using signed comparison */
  67     inline uint32_t
  68     makeCRField(int64_t a, int64_t b, uint32_t xerSO) const
  69     {
  70         uint32_t c = xerSO;
  71
  72         /* We've pre-shifted the immediate values here */
  73         if (a < b)      { c += 0x8; }
  74         else if (a > b) { c += 0x4; }
  75         else            { c += 0x2; }
  76         return c;
  77     }
  78
  79     inline uint32_t
  80     makeCRField(int64_t a, int32_t b, uint32_t xerSO) const
  81     {
  82         return makeCRField(a, (int64_t)b, xerSO);
  83     }
  84
  85     inline uint32_t
  86     makeCRField(int32_t a, int32_t b, uint32_t xerSO) const
  87     {
  88         return makeCRField((int64_t)a, (int64_t)b, xerSO);
  89     }
  90
  91     /* Compute the CR (condition register) field using unsigned comparison */
  92     inline uint32_t
  93     makeCRField(uint64_t a, uint64_t b, uint32_t xerSO) const
  94     {
  95         uint32_t c = xerSO;
  96
  97         /* We've pre-shifted the immediate values here */
  98         if (a < b)      { c += 0x8; }
  99         else if (a > b) { c += 0x4; }
 100         else            { c += 0x2; }
 101         return c;
 102     }
 103
 104     inline uint32_t
 105     makeCRField(uint64_t a, uint32_t b, uint32_t xerSO) const
 106     {
 107         return makeCRField(a, (uint64_t)b, xerSO);
 108     }
 109
 110     inline uint32_t
 111     makeCRField(uint32_t a, uint32_t b, uint32_t xerSO) const
 112     {
 113         return makeCRField((uint64_t)a, (uint64_t)b, xerSO);
 114     }
 115
 116     std::string generateDisassembly(
 117             Addr pc, const Loader::SymbolTable *symtab) const override;
 118 };
 119
 120
 121 /**
 122  * Class for integer immediate (signed and unsigned) operations.
 123  */
 124 class IntImmOp : public IntOp
 125 {
 126   protected:
 127
 128     int32_t imm;
 129     uint32_t uimm;
 130
 131     /// Constructor
 132     IntImmOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 133       : IntOp(mnem, _machInst, __opClass),
 134         imm(sext<16>(machInst.si)),
 135         uimm(machInst.si)
 136     {
 137     }
 138
 139     std::string generateDisassembly(
 140             Addr pc, const Loader::SymbolTable *symtab) const override;
 141 };
 142
 143
 144 /**
 145  * Class for integer arithmetic operations.
 146  */
 147 class IntArithOp : public IntOp
 148 {
 149   protected:
 150
 151     /// Constructor
 152     IntArithOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 153       : IntOp(mnem, _machInst, __opClass)
 154     {
 155     }
 156
 157     /**
 158      * Compute 128-bit product of 64-bit unsigned integer multiplication
 159      * based on https://stackoverflow.com/a/28904636
 160      */
 161     inline std::tuple<uint64_t, uint64_t>
 162     multiply(uint64_t ra, uint64_t rb) const
 163     {
 164         uint64_t plo, phi;
 165     #if defined(__SIZEOF_INT128__)
 166         __uint128_t prod = (__uint128_t)ra * rb;
 167         plo = prod;
 168         phi = prod >> 64;
 169     #else
 170         uint64_t ralo = (uint32_t)ra, rahi = ra >> 32;
 171         uint64_t rblo = (uint32_t)rb, rbhi = rb >> 32;
 172         uint64_t pp0 = ralo * rblo;
 173         uint64_t pp1 = rahi * rblo;
 174         uint64_t pp2 = ralo * rbhi;
 175         uint64_t pp3 = rahi * rbhi;
 176         uint64_t c = ((uint32_t)pp1) + ((uint32_t)pp2) + (pp0 >> 32);
 177         phi = pp3 + (pp2 >> 32) + (pp1 >> 32) + (c >> 32);
 178         plo = (c << 32) | ((uint32_t)pp0);
 179     #endif
 180         return std::make_tuple(plo, phi);
 181     }
 182
 183     /* Compute 128-bit product of 64-bit signed integer multiplication */
 184     inline std::tuple<uint64_t, int64_t>
 185     multiply(int64_t ra, int64_t rb) const
 186     {
 187         uint64_t plo, phi;
 188     #if defined(__SIZEOF_INT128__)
 189         __int128_t prod = (__int128_t)ra * rb;
 190         plo = prod;
 191         phi = prod >> 64;
 192     #else
 193         std::tie(plo, phi) = multiply((uint64_t)ra, (uint64_t)rb);
 194         if (rb < 0) phi -= (uint64_t)ra;
 195         if (ra < 0) phi -= (uint64_t)rb;
 196     #endif
 197         return std::make_tuple(plo, (int64_t)phi);
 198     }
 199
 200     std::string generateDisassembly(
 201             Addr pc, const Loader::SymbolTable *symtab) const override;
 202 };
 203
 204
 205 /**
 206  * Class for integer immediate arithmetic operations.
 207  */
 208 class IntImmArithOp : public IntArithOp
 209 {
 210   protected:
 211
 212     int32_t simm;
 213
 214     /// Constructor
 215     IntImmArithOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 216       : IntArithOp(mnem, _machInst, __opClass),
 217         simm((int16_t)machInst.si)
 218     {
 219     }
 220
 221     std::string generateDisassembly(
 222             Addr pc, const Loader::SymbolTable *symtab) const override;
 223 };
 224
 225
 226 /**
 227  * Class for integer arithmetic operations with displacement.
 228  */
 229 class IntDispArithOp : public IntArithOp
 230 {
 231   protected:
 232
 233     int32_t disp;
 234
 235     /// Constructor
 236     IntDispArithOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 237       : IntArithOp(mnem, _machInst, __opClass),
 238         disp((int16_t)((machInst.d0 << 6) | (machInst.d1 << 1) | machInst.d2))
 239     {
 240     }
 241
 242     std::string generateDisassembly(
 243             Addr pc, const Loader::SymbolTable *symtab) const override;
 244 };
 245
 246
 247 /**
 248  * Class for integer operations with a shift.
 249  */
 250 class IntShiftOp : public IntOp
 251 {
 252   protected:
 253
 254     uint32_t sh;
 255
 256     /// Constructor
 257     IntShiftOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 258       : IntOp(mnem, _machInst, __opClass),
 259         sh(machInst.sh)
 260     {
 261     }
 262
 263     std::string generateDisassembly(
 264             Addr pc, const Loader::SymbolTable *symtab) const override;
 265 };
 266
 267
 268 /**
 269  * Class for integer rotate operations.
 270  */
 271 class IntRotateOp : public IntShiftOp
 272 {
 273   protected:
 274
 275     uint32_t mb;
 276     uint32_t me;
 277     uint32_t fullMask;
 278
 279     /// Constructor
 280     IntRotateOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 281       : IntShiftOp(mnem, _machInst, __opClass),
 282         mb(machInst.mb),
 283         me(machInst.me)
 284     {
 285         if (me >= mb) {
 286             fullMask = mask(31 - mb, 31 - me);
 287         } else {
 288             fullMask = ~mask(31 - (me + 1), 31 - (mb - 1));
 289         }
 290     }
 291
 292     uint32_t
 293     rotateValue(uint32_t rs, uint32_t shift) const
 294     {
 295         uint32_t n = shift & 31;
 296         return (rs << n) | (rs >> (32 - n));
 297     }
 298
 299     std::string generateDisassembly(
 300             Addr pc, const Loader::SymbolTable *symtab) const override;
 301 };
 302
 303 } // namespace PowerISA
 304
 305 #endif //__ARCH_POWER_INSTS_INTEGER_HH__