[ARM] Follow AACPS standard for volatile bit-fields access width

Diogo Sampaio · Diogo Sampaio · commit 6a24339a4524 · 2020-01-21T15:23:38.000Z
Summary: This patch resumes the work of D16586. According to the AAPCS, volatile bit-fields should be accessed using containers of the widht of their declarative type. In such case: ``` struct S1 { short a : 1; } ``` should be accessed using load and stores of the width (sizeof(short)), where now the compiler does only load the minimum required width (char in this case). However, as discussed in D16586, that could overwrite non-volatile bit-fields, which conflicted with C and C++ object models by creating data race conditions that are not part of the bit-field, e.g. ``` struct S2 { short a; int b : 16; } ``` Accessing `S2.b` would also access `S2.a`. The AAPCS Release 2019Q1.1 (https://static.docs.arm.com/ihi0042/g/aapcs32.pdf) section 8.1 Data Types, page 35, "Volatile bit-fields - preserving number and width of container accesses" has been updated to avoid conflict with the C++ Memory Model. Now it reads in the note: ``` This ABI does not place any restrictions on the access widths of bit-fields where the container overlaps with a non-bit-field member. This is because the C/C++ memory model defines these as being separate memory locations, which can be accessed by two threads simultaneously. For this reason, compilers must be permitted to use a narrower memory access width (including splitting the access into multiple instructions) to avoid writing to a different memory location. ``` I've updated the patch D16586 to follow such behavior by verifying that we only change volatile bit-field access when: - it won't overlap with any other non-bit-field member - we only access memory inside the bounds of the record Regarding the number of memory accesses, that should be preserved, that will be implemented by D67399. Reviewers: rsmith, rjmccall, eli.friedman, ostannard Subscribers: ostannard, kristof.beyls, cfe-commits, carwil, olista01 Tags: #clang Differential Revision: https://reviews.llvm.org/D72932
diff --git a/clang/lib/CodeGen/CGExpr.cpp b/clang/lib/CodeGen/CGExpr.cpp
@@ -177,6 +177,11 @@ llvm::Value *CodeGenFunction::EvaluateExprAsBool(const Expr *E) {
                                        Loc);
 }
 
+// Helper method to check if the underlying ABI is AAPCS
+static bool isAAPCS(const TargetInfo &TargetInfo) {
+  return TargetInfo.getABI().startswith("aapcs");
+}
+
 /// EmitIgnoredExpr - Emit code to compute the specified expression,
 /// ignoring the result.
 void CodeGenFunction::EmitIgnoredExpr(const Expr *E) {
@@ -4052,15 +4057,120 @@ static bool hasAnyVptr(const QualType Type, const ASTContext &Context) {
   return false;
 }
 
+// AAPCS requires volatile bitfield accesses to be performed using the
+// natural alignment / width of the bitfield declarative type, if that
+// won't cause overlap over a non-bitfield member nor access outside the
+// the data structure.
+bool CodeGenFunction::AdjustAAPCSBitfieldLValue(Address &Base,
+                                                CGBitFieldInfo &Info,
+                                                const FieldDecl *Field,
+                                                const QualType FieldType,
+                                                const CGRecordLayout &RL) {
+  llvm::Type *ResLTy = ConvertTypeForMem(FieldType);
+  // CGRecordLowering::setBitFieldInfo() pre-adjusts the bitfield offsets for
+  // big-endian targets, but it assumes a container of width Info.StorageSize.
+  // Since AAPCS uses a different container size (width of the type), we first
+  // undo that calculation here and redo it once the bitfield offset within the
+  // new container is calculated
+  const bool BE = CGM.getTypes().getDataLayout().isBigEndian();
+  const unsigned OldOffset =
+      BE ? Info.StorageSize - (Info.Offset + Info.Size) : Info.Offset;
+  // Offset to the bitfield from the beginning of the struct
+  const unsigned AbsoluteOffset =
+      getContext().toBits(Info.StorageOffset) + OldOffset;
+
+  // Container size is the width of the bitfield type
+  const unsigned ContainerSize = ResLTy->getPrimitiveSizeInBits();
+  // Nothing to do if the access uses the desired
+  // container width and is naturally aligned
+  if (Info.StorageSize == ContainerSize && (OldOffset % ContainerSize == 0))
+    return false;
+
+  // Offset within the container
+  unsigned MemberOffset = AbsoluteOffset & (ContainerSize - 1);
+
+  // Bail out if an aligned load of the container cannot cover the entire
+  // bitfield. This can happen for example, if the bitfield is part of a packed
+  // struct. AAPCS does not define access rules for such cases, we let clang to
+  // follow its own rules.
+  if (MemberOffset + Info.Size > ContainerSize) {
+    return false;
+  }
+  // Re-adjust offsets for big-endian targets
+  if (BE)
+    MemberOffset = ContainerSize - (MemberOffset + Info.Size);
+
+  const CharUnits NewOffset =
+      getContext().toCharUnitsFromBits(AbsoluteOffset & ~(ContainerSize - 1));
+  const CharUnits End = NewOffset +
+                        getContext().toCharUnitsFromBits(ContainerSize) -
+                        CharUnits::One();
+
+  const ASTRecordLayout &Layout =
+      getContext().getASTRecordLayout(Field->getParent());
+  // If we access outside memory outside the record, than bail out
+  const CharUnits RecordSize = Layout.getSize();
+  if (End >= RecordSize) {
+    return false;
+  }
+
+  // Bail out if performing this load would access non-bitfields members
+
+  for (auto it : Field->getParent()->fields()) {
+    const FieldDecl &F = *it;
+    // We distinct allow bitfields overlaps
+    if (F.isBitField())
+      continue;
+    const CharUnits FOffset = getContext().toCharUnitsFromBits(
+        Layout.getFieldOffset(F.getFieldIndex()));
+    const CharUnits FEnd =
+        FOffset +
+        getContext().toCharUnitsFromBits(
+            ConvertTypeForMem(F.getType())->getPrimitiveSizeInBits()) -
+        CharUnits::One();
+    if (End < FOffset) {
+      // The other field starts after the desired load end.
+      break;
+    }
+    if (FEnd < NewOffset) {
+      // The other field ends before the desired load offset.
+      continue;
+    }
+    // The desired load overlaps a non-bitfiel member, bail out.
+    return false;
+  }
+
+  // Write the new bitfield access parameters
+  Info.StorageOffset = NewOffset;
+  Info.StorageSize = ContainerSize;
+  Info.Offset = MemberOffset;
+  // GEP into the bitfield container. Here we essentially treat the Base as a
+  // pointer to a block of containers and index into it appropriately
+  Base =
+      Builder.CreateConstInBoundsGEP(Builder.CreateElementBitCast(Base, ResLTy),
+                                     AbsoluteOffset / ContainerSize);
+  return true;
+}
+
 LValue CodeGenFunction::EmitLValueForField(LValue base,
                                            const FieldDecl *field) {
   LValueBaseInfo BaseInfo = base.getBaseInfo();
 
   if (field->isBitField()) {
     const CGRecordLayout &RL =
-      CGM.getTypes().getCGRecordLayout(field->getParent());
-    const CGBitFieldInfo &Info = RL.getBitFieldInfo(field);
+        CGM.getTypes().getCGRecordLayout(field->getParent());
+    CGBitFieldInfo Info = RL.getBitFieldInfo(field);
     Address Addr = base.getAddress(*this);
+    const QualType FieldType =
+        field->getType().withCVRQualifiers(base.getVRQualifiers());
+
+    if (isAAPCS(CGM.getTarget()) && FieldType.isVolatileQualified()) {
+      if (AdjustAAPCSBitfieldLValue(Addr, Info, field, FieldType, RL)) {
+        return LValue::MakeBitfield(Addr, Info, FieldType, BaseInfo,
+                                    TBAAAccessInfo());
+      }
+    }
+
     unsigned Idx = RL.getLLVMFieldNo(field);
     const RecordDecl *rec = field->getParent();
     if (!IsInPreservedAIRegion &&
@@ -4082,11 +4192,9 @@ LValue CodeGenFunction::EmitLValueForField(LValue base,
     if (Addr.getElementType() != FieldIntTy)
       Addr = Builder.CreateElementBitCast(Addr, FieldIntTy);
 
-    QualType fieldType =
-      field->getType().withCVRQualifiers(base.getVRQualifiers());
     // TODO: Support TBAA for bit fields.
     LValueBaseInfo FieldBaseInfo(BaseInfo.getAlignmentSource());
-    return LValue::MakeBitfield(Addr, Info, fieldType, FieldBaseInfo,
+    return LValue::MakeBitfield(Addr, Info, FieldType, FieldBaseInfo,
                                 TBAAAccessInfo());
   }
 
diff --git a/clang/lib/CodeGen/CGValue.h b/clang/lib/CodeGen/CGValue.h
@@ -14,12 +14,13 @@
 #ifndef LLVM_CLANG_LIB_CODEGEN_CGVALUE_H
 #define LLVM_CLANG_LIB_CODEGEN_CGVALUE_H
 
+#include "Address.h"
+#include "CGRecordLayout.h"
+#include "CodeGenTBAA.h"
 #include "clang/AST/ASTContext.h"
 #include "clang/AST/Type.h"
-#include "llvm/IR/Value.h"
 #include "llvm/IR/Type.h"
-#include "Address.h"
-#include "CodeGenTBAA.h"
+#include "llvm/IR/Value.h"
 
 namespace llvm {
   class Constant;
@@ -181,11 +182,11 @@ class LValue {
 
     // ExtVector element subset: V.xyx
     llvm::Constant *VectorElts;
-
-    // BitField start bit and size
-    const CGBitFieldInfo *BitFieldInfo;
   };
 
+  // BitField start bit and size
+  CGBitFieldInfo BitFieldInfo;
+
   QualType Type;
 
   // 'const' is unused here
@@ -357,10 +358,13 @@ class LValue {
   Address getBitFieldAddress() const {
     return Address(getBitFieldPointer(), getAlignment());
   }
-  llvm::Value *getBitFieldPointer() const { assert(isBitField()); return V; }
+  llvm::Value *getBitFieldPointer() const {
+    assert(isBitField());
+    return V;
+  }
   const CGBitFieldInfo &getBitFieldInfo() const {
     assert(isBitField());
-    return *BitFieldInfo;
+    return BitFieldInfo;
   }
 
   // global register lvalue
@@ -415,7 +419,7 @@ class LValue {
     LValue R;
     R.LVType = BitField;
     R.V = Addr.getPointer();
-    R.BitFieldInfo = &Info;
+    R.BitFieldInfo = Info;
     R.Initialize(type, type.getQualifiers(), Addr.getAlignment(), BaseInfo,
                  TBAAInfo);
     return R;
diff --git a/clang/lib/CodeGen/CodeGenFunction.h b/clang/lib/CodeGen/CodeGenFunction.h
@@ -1619,8 +1619,14 @@ class CodeGenFunction : public CodeGenTypeCache {
   void EmitOpenCLKernelMetadata(const FunctionDecl *FD,
                                 llvm::Function *Fn);
 
+  /// Perform AAPCS specific tweaks on volatile bitfield accesses.
+  bool AdjustAAPCSBitfieldLValue(Address &Base, CGBitFieldInfo &Info,
+                                 const FieldDecl *Field,
+                                 const QualType FieldType,
+                                 const CGRecordLayout &RL);
+
 public:
-  CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext=false);
+  CodeGenFunction(CodeGenModule &cgm, bool suppressNewContext = false);
   ~CodeGenFunction();
 
   CodeGenTypes &getTypes() const { return CGM.getTypes(); }
diff --git a/clang/test/CodeGen/aapcs-bitfield.c b/clang/test/CodeGen/aapcs-bitfield.c
