[clang][Interp] Start handling mutable record members

[tbaeder]

Ping

[shafik]

Two cases to consider: https://godbolt.org/z/ovofPExGK

namespace MutableFields {
  class Foo {
  public:
    constexpr Foo() : I(1) {}
    mutable int I; // ref-note {{declared here}}
  };


  constexpr int foo() {
    constexpr Foo F;  
    F.I = 12;
    return F.I;
  }
  static_assert(foo() == 12, "");
}

clang and gcc disagree on this one, I think clang is right not 100%.

and this one:

namespace MutableFields {
  class Foo {
  public:
    constexpr Foo() : I(1) {}
    mutable int I; // ref-note {{declared here}}
  };


  constexpr int foo() {
    constexpr Foo F;  // A
    F.I = 12;
    constexpr int x = F.I; // B
    return F.I;
  }
  static_assert(foo() == 12, "");
}

[tbaeder]

Ping

clang/lib/AST/Interp/Interp.h

 inline bool GetPtrField(InterpState &S, CodePtr OpPC, uint32_t Off) {
   const Pointer &Ptr = S.Stk.pop<Pointer>();
   if (!CheckNull(S, OpPC, Ptr, CSK_Field))
     return false;
   if (!CheckExtern(S, OpPC, Ptr))
     return false;
   if (!CheckRange(S, OpPC, Ptr, CSK_Field))
     return false;
-  S.Stk.push<Pointer>(Ptr.atField(Off));
+
+  const Pointer &FieldPtr = Ptr.atField(Off);
+  if (!CheckMutable(S, OpPC, FieldPtr))
+    return false;
+
+  S.Stk.push<Pointer>(FieldPtr);
   return true;
 }
 
 inline bool GetPtrThisField(InterpState &S, CodePtr OpPC, uint32_t Off) {
   if (S.checkingPotentialConstantExpression())
     return false;
   const Pointer &This = S.Current->getThis();
   if (!CheckThis(S, OpPC, This))

clang/lib/AST/Interp/Interp.cpp

bool CheckConst(InterpState &S, CodePtr OpPC, const Pointer &Ptr) {
   // The This pointer is writable in constructors and destructors,
   // even if isConst() returns true.
   if (const Function *Func = S.Current->getFunction();
       Func && (Func->isConstructor() || Func->isDestructor()) &&
       Ptr.block() == S.Current->getThis().block()) {
     return true;
   }
 
+  // Writing to mutable fields is fine even if the parent is
+  // declared const.
+  if (S.getLangOpts().CPlusPlus14) {
+    if (const auto *FD = dyn_cast<FieldDecl>(Ptr.getFieldDesc()->asDecl());
+        FD && FD->isMutable())
+      return true;
+  }
+
   const QualType Ty = Ptr.getType();
   const SourceInfo &Loc = S.Current->getSource(OpPC);
   S.FFDiag(Loc, diag::note_constexpr_modify_const_type) << Ty;
   return false;
 }
 
 bool CheckMutable(InterpState &S, CodePtr OpPC, const Pointer &Ptr) {
   assert(Ptr.isLive() && "Pointer is not live");
   if (!Ptr.isMutable()) {
     return true;
   }
 
+  // In C++14 onwards, it is permitted to read a mutable member whose
+  // lifetime began within the evaluation.
+  if (S.getLangOpts().CPlusPlus14)
+    return true;
+
   const SourceInfo &Loc = S.Current->getSource(OpPC);
   const FieldDecl *Field = Ptr.getField();
   S.FFDiag(Loc, diag::note_constexpr_access_mutable, 1) << AK_Read << Field;
   S.Note(Field->getLocation(), diag::note_declared_at);
   return false;
 }
 
 bool CheckLoad(InterpState &S, CodePtr OpPC, const Pointer &Ptr) {

clang/test/AST/Interp/records.cpp

namespace VirtualFunctionPointers {
   static_assert(dynamicDispatch(s) == 1);
   static_assert(dynamicDispatch(s2) == 7);
 };
 
 
 
 };
 #endif
+
+namespace MutableFields {
+  class Foo {
+  public:
+    constexpr Foo() : I(1) {}
+    mutable int I; // ref-note {{declared here}}
+  };
+
+
+  constexpr int foo() {
+    const Foo F;
+    F.I = 12;
+    return F.I;
+  }
+  static_assert(foo() == 12, "");
+
+  /// FIXME: This should also be rejected in the new interpreter.
+  constexpr Foo GlobalF;
+  constexpr int foo2() { // ref-error {{never produces a constant expression}}
+    return GlobalF.I; // ref-note {{read of mutable member 'I' is not allowed in a constant expression}}
+  }
+}
+