commit d4c0e9897d06d9991571f5e990448a3cb84c7986
author Zane Shelley <zshelle@us.ibm.com> Thu Dec 05 21:27:41 2019 -0600
committer Zane Shelley <zshelle@us.ibm.com> Fri Dec 06 14:09:47 2019 -0600
tree 5d2b94d8ffa2aa1f6c4dca50f9f88698b815b0ab
parent 5e61824ec9468ad7571461b7ec210fc5e7100023

Removed potentially dangerous * from operator registers

The BitStringBuffer* iv_bs instance variable that is used in most of the
operator register could be easily mishandled in copy constructors and
assignment operators. A safer alternative was implemented.

Change-Id: I747a3cb9ad35fa8b924b2242964968a675e184dd
Signed-off-by: Zane Shelley <zshelle@us.ibm.com>

src/register/hei_operator_register.hpp

diff --git a/src/register/hei_operator_register.hpp b/src/register/hei_operator_register.hpp
index 7c6b4d5..50223ac 100644
--- a/src/register/hei_operator_register.hpp
+++ b/src/register/hei_operator_register.hpp
@@ -10,22 +10,22 @@
   public:
     NotRegister(Register& i_arg) :
         Register(), iv_child(&i_arg), iv_iBS(i_arg.GetBitLength())
-    {
-        iv_bs = &iv_iBS;
-    }
+    {}
 
     NotRegister& operator=(const NotRegister& r)
     {
         iv_child = r.iv_child;
         iv_iBS   = r.iv_iBS;
-        // iv_bs = r.iv_bs; <-- don't do this!
         return *this;
     }
 
     const BitString* getBitString(const Chip& i_chip) const
     {
-        (*iv_bs) = ~(*iv_child->getBitString(i_chip));
-        return iv_bs;
+        const auto* bs = iv_child->getBitString(i_chip);
+
+        (const_cast<NotRegister*>(this))->iv_iBS = ~(*bs);
+
+        return &iv_iBS;
     }
 
     bool operator==(const NotRegister& r) const
@@ -41,7 +41,6 @@
   private:
     Register* iv_child;
 
-    BitStringBuffer* iv_bs;
     BitStringBuffer iv_iBS;
 };
 
@@ -51,23 +50,23 @@
     LeftShiftRegister(Register& i_arg, uint16_t i_amount) :
         Register(), iv_child(&i_arg), iv_amount(i_amount),
         iv_iBS(i_arg.GetBitLength())
-    {
-        iv_bs = &iv_iBS;
-    }
+    {}
 
     LeftShiftRegister& operator=(const LeftShiftRegister& r)
     {
         iv_child  = r.iv_child;
         iv_amount = r.iv_amount;
         iv_iBS    = r.iv_iBS;
-        // iv_bs = r.iv_bs; <-- don't do this!
         return *this;
     }
 
     const BitString* getBitString(const Chip& i_chip) const
     {
-        (*iv_bs) = (*iv_child->getBitString(i_chip)) << iv_amount;
-        return iv_bs;
+        const auto* bs = iv_child->getBitString(i_chip);
+
+        (const_cast<LeftShiftRegister*>(this))->iv_iBS = (*bs) << iv_amount;
+
+        return &iv_iBS;
     }
 
     bool operator==(const LeftShiftRegister& r) const
@@ -86,7 +85,6 @@
     Register* iv_child;
     uint16_t iv_amount;
 
-    BitStringBuffer* iv_bs;
     BitStringBuffer iv_iBS;
 };
 
@@ -96,23 +94,23 @@
     RightShiftRegister(Register& i_arg, uint16_t i_amount) :
         Register(), iv_child(&i_arg), iv_amount(i_amount),
         iv_iBS(i_arg.GetBitLength())
-    {
-        iv_bs = &iv_iBS;
-    }
+    {}
 
     RightShiftRegister& operator=(const RightShiftRegister& r)
     {
         iv_child  = r.iv_child;
         iv_amount = r.iv_amount;
         iv_iBS    = r.iv_iBS;
-        // iv_bs = r.iv_bs; <-- don't do this!
         return *this;
     }
 
     const BitString* getBitString(const Chip& i_chip) const
     {
-        (*iv_bs) = (*iv_child->getBitString(i_chip)) >> iv_amount;
-        return iv_bs;
+        const auto* bs = iv_child->getBitString(i_chip);
+
+        (const_cast<RightShiftRegister*>(this))->iv_iBS = (*bs) >> iv_amount;
+
+        return &iv_iBS;
     }
 
     bool operator==(const RightShiftRegister& r) const
@@ -131,7 +129,6 @@
     Register* iv_child;
     uint16_t iv_amount;
 
-    BitStringBuffer* iv_bs;
     BitStringBuffer iv_iBS;
 };
 
@@ -141,24 +138,24 @@
     AndRegister(Register& i_left, Register& i_right) :
         Register(), iv_left(&i_left), iv_right(&i_right),
         iv_iBS(std::min(i_left.GetBitLength(), i_right.GetBitLength()))
-    {
-        iv_bs = &iv_iBS;
-    }
+    {}
 
     AndRegister& operator=(const AndRegister& r)
     {
         iv_left  = r.iv_left;
         iv_right = r.iv_right;
         iv_iBS   = r.iv_iBS;
-        // iv_bs = r.iv_bs; <-- don't do this!
         return *this;
     }
 
     const BitString* getBitString(const Chip& i_chip) const
     {
-        (*iv_bs) = *iv_left->getBitString(i_chip);
-        (*iv_bs) = (*iv_bs) & (*iv_right->getBitString(i_chip));
-        return iv_bs;
+        const auto* l_bs = iv_left->getBitString(i_chip);
+        const auto* r_bs = iv_right->getBitString(i_chip);
+
+        (const_cast<AndRegister*>(this))->iv_iBS = (*l_bs) & (*r_bs);
+
+        return &iv_iBS;
     }
 
     bool operator==(const AndRegister& r) const
@@ -177,7 +174,6 @@
     Register* iv_left;
     Register* iv_right;
 
-    BitStringBuffer* iv_bs;
     BitStringBuffer iv_iBS;
 };
 
@@ -187,24 +183,24 @@
     OrRegister(Register& i_left, Register& i_right) :
         Register(), iv_left(&i_left), iv_right(&i_right),
         iv_iBS(std::min(i_left.GetBitLength(), i_right.GetBitLength()))
-    {
-        iv_bs = &iv_iBS;
-    }
+    {}
 
     OrRegister& operator=(const OrRegister& r)
     {
         iv_left  = r.iv_left;
         iv_right = r.iv_right;
         iv_iBS   = r.iv_iBS;
-        // iv_bs = r.iv_bs; <-- don't do this!
         return *this;
     }
 
     const BitString* getBitString(const Chip& i_chip) const
     {
-        (*iv_bs) = *iv_left->getBitString(i_chip);
-        (*iv_bs) = (*iv_bs) | (*iv_right->getBitString(i_chip));
-        return iv_bs;
+        const auto* l_bs = iv_left->getBitString(i_chip);
+        const auto* r_bs = iv_right->getBitString(i_chip);
+
+        (const_cast<OrRegister*>(this))->iv_iBS = (*l_bs) | (*r_bs);
+
+        return &iv_iBS;
     }
 
     bool operator==(const OrRegister& r) const
@@ -223,7 +219,6 @@
     Register* iv_left;
     Register* iv_right;
 
-    BitStringBuffer* iv_bs;
     BitStringBuffer iv_iBS;
 };