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     /* Compute 128-bit sum of 128-bit to 64-bit unsigned integer addition */
 158     inline std::tuple<uint64_t, uint64_t>
 159     add(uint64_t ralo, uint64_t rahi, uint64_t rb) const
 160     {
 161         uint64_t slo, shi;
 162     #if defined(__SIZEOF_INT128__)
 163         __uint128_t ra = ((__uint128_t)rahi << 64) | ralo;
 164         __uint128_t sum = ra + rb;
 165         slo = sum;
 166         shi = sum >> 64;
 167     #else
 168         shi = rahi + ((ralo + rb) < ralo);
 169         slo = ralo + rb;
 170     #endif
 171         return std::make_tuple(slo, shi);
 172     }
 173
 174     /* Compute 128-bit sum of 128-bit to 64-bit signed integer addition */
 175     inline std::tuple<uint64_t, int64_t>
 176     add(uint64_t ralo, int64_t rahi, int64_t rb) const
 177     {
 178         uint64_t slo;
 179         int64_t shi;
 180     #if defined(__SIZEOF_INT128__)
 181         __int128_t ra = ((__int128_t)rahi << 64) | ralo;
 182         __int128_t sum = (__int128_t)ra + rb;
 183         slo = sum;
 184         shi = sum >> 64;
 185     #else
 186         if (rb < 0) {
 187             shi = rahi - 1;
 188             slo = ralo + rb;
 189             if (slo < rb) {
 190                 shi++;
 191             }
 192         } else {
 193             shi = rahi;
 194             slo = ralo + rb;
 195             if (slo < rb) {
 196                 shi++;
 197             }
 198         }
 199     #endif
 200         return std::make_tuple(slo, shi);
 201     }
 202
 203     /**
 204      * Compute 128-bit product of 64-bit unsigned integer multiplication
 205      * based on https://stackoverflow.com/a/28904636
 206      */
 207     inline std::tuple<uint64_t, uint64_t>
 208     multiply(uint64_t ra, uint64_t rb) const
 209     {
 210         uint64_t plo, phi;
 211     #if defined(__SIZEOF_INT128__)
 212         __uint128_t prod = (__uint128_t)ra * rb;
 213         plo = prod;
 214         phi = prod >> 64;
 215     #else
 216         uint64_t ralo = (uint32_t)ra, rahi = ra >> 32;
 217         uint64_t rblo = (uint32_t)rb, rbhi = rb >> 32;
 218         uint64_t pp0 = ralo * rblo;
 219         uint64_t pp1 = rahi * rblo;
 220         uint64_t pp2 = ralo * rbhi;
 221         uint64_t pp3 = rahi * rbhi;
 222         uint64_t c = ((uint32_t)pp1) + ((uint32_t)pp2) + (pp0 >> 32);
 223         phi = pp3 + (pp2 >> 32) + (pp1 >> 32) + (c >> 32);
 224         plo = (c << 32) | ((uint32_t)pp0);
 225     #endif
 226         return std::make_tuple(plo, phi);
 227     }
 228
 229     /* Compute 128-bit product of 64-bit signed integer multiplication */
 230     inline std::tuple<uint64_t, int64_t>
 231     multiply(int64_t ra, int64_t rb) const
 232     {
 233         uint64_t plo, phi;
 234     #if defined(__SIZEOF_INT128__)
 235         __int128_t prod = (__int128_t)ra * rb;
 236         plo = prod;
 237         phi = prod >> 64;
 238     #else
 239         std::tie(plo, phi) = multiply((uint64_t)ra, (uint64_t)rb);
 240         if (rb < 0) phi -= (uint64_t)ra;
 241         if (ra < 0) phi -= (uint64_t)rb;
 242     #endif
 243         return std::make_tuple(plo, (int64_t)phi);
 244     }
 245
 246     /**
 247      * Compute 128-bit result of 64-bit unsigned integer multiplication
 248      * followed by addition
 249      */
 250     inline std::tuple<uint64_t, uint64_t>
 251     multiplyAdd(uint64_t ra, uint64_t rb, uint64_t rc) const
 252     {
 253         uint64_t rlo, rhi;
 254     #if defined(__SIZEOF_INT128__)
 255         __uint128_t res = ((__uint128_t)ra * rb) + rc;
 256         rlo = res;
 257         rhi = res >> 64;
 258     #else
 259         uint64_t plo, phi;
 260         std::tie(plo, phi) = multiply(ra, rb);
 261         std::tie(rlo, rhi) = add(plo, phi, rc);
 262     #endif
 263         return std::make_tuple(rlo, rhi);
 264     }
 265
 266     /**
 267      * Compute 128-bit result of 64-bit signed integer multiplication
 268      * followed by addition
 269      */
 270     inline std::tuple<uint64_t, int64_t>
 271     multiplyAdd(int64_t ra, int64_t rb, int64_t rc) const
 272     {
 273         uint64_t rlo;
 274         int64_t rhi;
 275     #if defined(__SIZEOF_INT128__)
 276         __int128_t res = (__int128_t)ra * rb + rc;
 277         rlo = res;
 278         rhi = res >> 64;
 279     #else
 280         uint64_t plo;
 281         int64_t phi;
 282         std::tie(plo, phi) = multiply(ra, rb);
 283         std::tie(rlo, rhi) = add(plo, phi, rc);
 284     #endif
 285         return std::make_tuple(rlo, rhi);
 286     }
 287
 288     std::string generateDisassembly(
 289             Addr pc, const Loader::SymbolTable *symtab) const override;
 290 };
 291
 292
 293 /**
 294  * Class for integer immediate arithmetic operations.
 295  */
 296 class IntImmArithOp : public IntArithOp
 297 {
 298   protected:
 299
 300     int32_t simm;
 301
 302     /// Constructor
 303     IntImmArithOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 304       : IntArithOp(mnem, _machInst, __opClass),
 305         simm((int16_t)machInst.si)
 306     {
 307     }
 308
 309     std::string generateDisassembly(
 310             Addr pc, const Loader::SymbolTable *symtab) const override;
 311 };
 312
 313
 314 /**
 315  * Class for integer arithmetic operations with displacement.
 316  */
 317 class IntDispArithOp : public IntArithOp
 318 {
 319   protected:
 320
 321     int32_t disp;
 322
 323     /// Constructor
 324     IntDispArithOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 325       : IntArithOp(mnem, _machInst, __opClass),
 326         disp((int16_t)((machInst.d0 << 6) | (machInst.d1 << 1) | machInst.d2))
 327     {
 328     }
 329
 330     std::string generateDisassembly(
 331             Addr pc, const Loader::SymbolTable *symtab) const override;
 332 };
 333
 334
 335 /**
 336  * Class for integer operations with a shift.
 337  */
 338 class IntShiftOp : public IntOp
 339 {
 340   protected:
 341
 342     uint32_t sh;
 343
 344     /// Constructor
 345     IntShiftOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 346       : IntOp(mnem, _machInst, __opClass),
 347         sh(machInst.sh)
 348     {
 349     }
 350
 351     std::string generateDisassembly(
 352             Addr pc, const Loader::SymbolTable *symtab) const override;
 353 };
 354
 355
 356 /**
 357  * Class for integer rotate operations.
 358  */
 359 class IntRotateOp : public IntShiftOp
 360 {
 361   protected:
 362
 363     uint32_t mb;
 364     uint32_t me;
 365     uint32_t fullMask;
 366
 367     /// Constructor
 368     IntRotateOp(const char *mnem, MachInst _machInst, OpClass __opClass)
 369       : IntShiftOp(mnem, _machInst, __opClass),
 370         mb(machInst.mb),
 371         me(machInst.me)
 372     {
 373         if (me >= mb) {
 374             fullMask = mask(31 - mb, 31 - me);
 375         } else {
 376             fullMask = ~mask(31 - (me + 1), 31 - (mb - 1));
 377         }
 378     }
 379
 380     uint32_t
 381     rotateValue(uint32_t rs, uint32_t shift) const
 382     {
 383         uint32_t n = shift & 31;
 384         return (rs << n) | (rs >> (32 - n));
 385     }
 386
 387     std::string generateDisassembly(
 388             Addr pc, const Loader::SymbolTable *symtab) const override;
 389 };
 390
 391 } // namespace PowerISA
 392
 393 #endif //__ARCH_POWER_INSTS_INTEGER_HH__