ARM: Add a findLsbSet function and use it to implement clz.
[gem5.git] / src / base / bitfield.hh
index 5af453a76fbded0ad75e027c013c9f2f4b15eff3..cc3695159e639dc030c055ff82aa9d3a245dbf6a 100644 (file)
@@ -32,7 +32,7 @@
 #ifndef __BASE_BITFIELD_HH__
 #define __BASE_BITFIELD_HH__
 
-#include <inttypes.h>
+#include "base/types.hh"
 
 /**
  * Generate a 64-bit mask of 'nbits' 1s, right justified.
@@ -58,6 +58,17 @@ bits(T val, int first, int last)
     return (val >> last) & mask(nbits);
 }
 
+/**
+ * Extract the bit from this position from 'val' and right justify it.
+ */
+template <class T>
+inline
+T
+bits(T val, int bit)
+{
+    return bits(val, bit, bit);
+}
+
 /**
  * Mask off the given bits in place like bits() but without shifting.
  * msb = 63, lsb = 0
@@ -96,8 +107,20 @@ inline
 T
 insertBits(T val, int first, int last, B bit_val)
 {
+    T t_bit_val = bit_val;
     T bmask = mask(first - last + 1) << last;
-    return ((bit_val << last) & bmask) | (val & ~bmask);
+    return ((t_bit_val << last) & bmask) | (val & ~bmask);
+}
+
+/**
+ * Overloaded for access to only one bit in value
+ */
+template <class T, class B>
+inline
+T
+insertBits(T val, int bit, B bit_val)
+{
+    return insertBits(val, bit, bit, bit_val);
 }
 
 /**
@@ -112,6 +135,14 @@ replaceBits(T& val, int first, int last, B bit_val)
     val = insertBits(val, first, last, bit_val);
 }
 
+/** Overloaded function to allow to access only 1 bit*/
+template <class T, class B>
+inline
+void
+replaceBits(T& val, int bit, B bit_val)
+{
+    val = insertBits(val, bit, bit, bit_val);
+}
 /**
  * Returns the bit position of the MSB that is set in the input
  */
@@ -130,155 +161,21 @@ findMsbSet(uint64_t val) {
     return msb;
 }
 
-namespace BitfieldBackend
-{
-    template<class Data>
-    class BitfieldBase
-    {
-      protected:
-        Data __data;
-
-        inline uint64_t
-        getBits(int first, int last)
-        {
-            return bits(__data, first, last);
-        }
-
-        inline void
-        setBits(int first, int last, uint64_t val)
-        {
-            replaceBits(__data, first, last, val);
-        }
-    };
-
-    template<class Type, class Base>
-    class _BitfieldRO : public Base
-    {
-      public:
-        operator const Type ()
-        {
-            return *((Base *)this);
-        }
-    };
-
-    template<class Type, class Base>
-    class _BitfieldWO : public Base
-    {
-      public:
-        const Type operator = (const Type & _data)
-        {
-            *((Base *)this) = _data;
-            return _data;
-        }
-    };
-
-    template<class Data, int first, int last=first>
-    class _Bitfield : public BitfieldBase<Data>
-    {
-      public:
-        operator const Data ()
-        {
-            return this->getBits(first, last);
-        }
-
-        const Data
-        operator = (const Data & _data)
-        {
-            this->setBits(first, last, _data);
-            return _data;
-        }
-    };
-
-    template <class Type, class Base>
-    class BitUnionOperators : public Base
-    {
-      public:
-        operator const Type ()
-        {
-            return Base::__data;
-        }
-
-        const Type
-        operator = (const Type & _data)
-        {
-            Base::__data = _data;
-        }
-
-        bool
-        operator < (const Base & base)
-        {
-            return Base::__data < base.__data;
-        }
-
-        bool
-        operator == (const Base & base)
-        {
-            return Base::__data == base.__data;
-        }
-    };
+/**
+ * Returns the bit position of the LSB that is set in the input
+ */
+inline int
+findLsbSet(uint64_t val) {
+    int lsb = 0;
+    if (!val)
+        return sizeof(val) * 8;
+    if (!bits(val, 31,0)) { lsb += 32; val >>= 32; }
+    if (!bits(val, 15,0)) { lsb += 16; val >>= 16; }
+    if (!bits(val, 7,0))  { lsb += 8;  val >>= 8;  }
+    if (!bits(val, 3,0))  { lsb += 4;  val >>= 4;  }
+    if (!bits(val, 1,0))  { lsb += 2;  val >>= 2;  }
+    if (!bits(val, 0,0))  { lsb += 1; }
+    return lsb;
 }
 
-#define __BitUnion(type, name) \
-    namespace BitfieldUnderlyingClasses \
-    { \
-        class name; \
-    } \
-    class BitfieldUnderlyingClasses::name { \
-      public: \
-        typedef type __DataType; \
-        union { \
-            type __data;\
-
-#define EndBitUnion(name) \
-        }; \
-    }; \
-    typedef BitfieldBackend::BitUnionOperators< \
-        BitfieldUnderlyingClasses::name::__DataType, \
-        BitfieldUnderlyingClasses::name> name;
-
-#define __SubBitUnion(type, name) \
-        union { \
-            type __data; \
-            inline operator const __DataType () \
-            { return __data; } \
-            \
-            inline const __DataType operator = (const __DataType & _data) \
-            { __data = _data; }
-
-#define EndSubBitUnion(name) } name;
-
-//This is so we can send in parameters with commas
-#define wrap(guts) guts
-
-//Read only bitfields
-#define __BitfieldRO(base) \
-    BitfieldBackend::_BitfieldRO<__DataType, base>
-#define __SubBitUnionRO(name, base) \
-    __SubBitUnion(wrap(_BitfieldRO<__DataType, base>), name)
-
-//Write only bitfields
-#define __BitfieldWO(base) \
-    BitfieldBackend::_BitfieldWO<__DataType, base>
-#define __SubBitUnionWO(name, base) \
-    __SubBitUnion(wrap(_BitfieldWO<__DataType, base>), name)
-
-//Regular bitfields
-#define Bitfield(first, last) \
-    BitfieldBackend::_Bitfield<__DataType, first, last>
-#define SubBitUnion(name, first, last) \
-    __SubBitUnion(Bitfield(first, last), name)
-#define BitfieldRO(first, last) __BitfieldRO(Bitfield(first, last))
-#define SubBitUnionRO(name, first, last) \
-    __SubBitUnionRO(Bitfield(first, last), name)
-#define BitfieldWO(first, last) __BitfieldWO(Bitfield(first, last))
-#define SubBitUnionWO(name, first, last) \
-    __SubBitUnionWO(Bitfield(first, last), name)
-
-#define BitUnion(type, name) __BitUnion(type, name)
-
-#define BitUnion64(name) __BitUnion(uint64_t, name)
-#define BitUnion32(name) __BitUnion(uint32_t, name)
-#define BitUnion16(name) __BitUnion(uint16_t, name)
-#define BitUnion8(name) __BitUnion(uint8_t, name)
-
 #endif // __BASE_BITFIELD_HH__