Rename "BasePointer" -> "LowerBound"

Author: john-h-kastner

clang/include/clang/3C/BasePointerAssignment.h renamed to clang/include/clang/3C/LowerBoundAssignment.h

@@ -1,4 +1,4 @@
-//=--PointerArithmeticAssignment.h--------------------------------*- C++-*-===//
+//=--LowerBoundAssignment.h---------------------------------------*- C++-*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -8,14 +8,14 @@
 // Contains classes for detection and rewriting of assignment expression that
 // would invalidate the bounds of pointers rewritten to use range bounds.
 // For pointers using a range bound `bounds(__3c_tmp_p, __3c_tmp_p + n)`, an
-// assignment `p = q` effectively changes the "base pointer" of the range
+// assignment `p = q` effectively changes the lower bound of the range
 // bounds, so that the new bounds of `p` are `bounds(q, q + n)`
 // (assuming `q` has the same size as `p`). For this to not invalidate the
 // bound, `__3c_tmp_p` must also be updated to be equal to `q`.
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_BASEPOINTERASSIGNMENT_H
-#define LLVM_BASEPOINTERASSIGNMENT_H
+#ifndef LLVM_LOWERBOUNDASSIGNMENT_H
+#define LLVM_LOWERBOUNDASSIGNMENT_H
 
 #include "clang/AST/Decl.h"
 #include "clang/AST/Stmt.h"
@@ -24,59 +24,59 @@
 // Return true if an assignment LHS=RHS is the value of RHS is not derived form
 // LHS. For example, an assignment `p = q` will return true (we assume `q`
 // doesn't alias `p`), while `p = p + 1` will return false.
-bool isBasePointerAssignment(clang::Expr *LHS, clang::Expr *RHS);
+bool isLowerBoundAssignment(clang::Expr *LHS, clang::Expr *RHS);
 
-// A class to visit all base pointer assignment expression as detected by
-// isBasePointerAssignment. This class should be extended with
-// visitBasePointerAssignment overridden.
-class BasePointerAssignmentVisitor
-  : public RecursiveASTVisitor<BasePointerAssignmentVisitor> {
+// A class to visit all lower bound assignment expression as detected by
+// isLowerBoundAssignment. This class should be extended with
+// visitLowerBoundAssignment overridden.
+class LowerBoundAssignmentVisitor
+  : public RecursiveASTVisitor<LowerBoundAssignmentVisitor> {
 public:
-  explicit BasePointerAssignmentVisitor() {}
+  explicit LowerBoundAssignmentVisitor() {}
 
   bool VisitBinaryOperator(BinaryOperator *O);
 
   // Override this method to define the operation that should be performed on
   // each assignment. The LHS and RHS of the assignment expression are passed
   // through.
-  virtual void visitBasePointerAssignment(Expr *LHS, Expr *RHS) = 0;
+  virtual void visitLowerBoundAssignment(Expr *LHS, Expr *RHS) = 0;
 };
 
-// Visit each base pointer assignment expression and, if the LHS is a pointer
+// Visit each lower bound pointer expression and, if the LHS is a pointer
 // variable that was rewritten to use range bounds, rewrite the assignment so
 // that it doesn't not invalidate the bounds. e.g.:
 //     q = p;
 // becomes
 //     __3c_tmp_q = p, q = __3c_tmp_q;
-class BasePointerAssignmentUpdater : public BasePointerAssignmentVisitor {
+class LowerBoundAssignmentUpdater : public LowerBoundAssignmentVisitor {
 public:
-  explicit BasePointerAssignmentUpdater(ASTContext *C, ProgramInfo &I,
-                                        Rewriter &R) : ABInfo(
+  explicit LowerBoundAssignmentUpdater(ASTContext *C, ProgramInfo &I,
+                                       Rewriter &R) : ABInfo(
     I.getABoundsInfo()), CR(I, C), R(R) {}
 
-  void visitBasePointerAssignment(Expr *LHS, Expr *RHS) override;
+  void visitLowerBoundAssignment(Expr *LHS, Expr *RHS) override;
 
 private:
   AVarBoundsInfo &ABInfo;
   ConstraintResolver CR;
   Rewriter &R;
 };
 
-// Visit each base pointer assignment expression and, if it is inside a macro,
+// Visit each lower bound assignment expression and, if it is inside a macro,
 // mark the LHS pointer as ineligible for range bounds. This is required
 // because, if the pointer is given range bounds, then the assignment expression
 // would need to be rewritten. The expression is a macro, so it cannot be
 // rewritten.
-class BasePointerAssignmentFinder : public BasePointerAssignmentVisitor {
+class LowerBoundAssignmentFinder : public LowerBoundAssignmentVisitor {
 public:
-  explicit BasePointerAssignmentFinder(ASTContext *C, ProgramInfo &I) : ABInfo(
+  explicit LowerBoundAssignmentFinder(ASTContext *C, ProgramInfo &I) : ABInfo(
     I.getABoundsInfo()), CR(I, C), C(C) {}
 
-  void visitBasePointerAssignment(Expr *LHS, Expr *RHS) override;
+  void visitLowerBoundAssignment(Expr *LHS, Expr *RHS) override;
 
 private:
   AVarBoundsInfo &ABInfo;
   ConstraintResolver CR;
   ASTContext *C;
 };
-#endif //LLVM_BASEPOINTERASSIGNMENT_H
+#endif //LLVM_LOWERBOUNDASSIGNMENT_H

clang/lib/3C/AVarBoundsInfo.cpp

@@ -15,7 +15,7 @@
 #include "clang/3C/ProgramInfo.h"
 #include "clang/3C/3CGlobalOptions.h"
 #include <sstream>
-#include <clang/3C/BasePointerAssignment.h>
+#include <clang/3C/LowerBoundAssignment.h>
 
 std::vector<BoundsPriority> AVarBoundsInfo::PrioList{Declared, Allocator,
                                                      FlowInferred, Heuristics};
@@ -1197,7 +1197,7 @@ bool AVarBoundsInfo::addAssignment(BoundsKey L, BoundsKey R) {
 bool AVarBoundsInfo::handlePointerAssignment(clang::Expr *L, clang::Expr *R,
                                              ASTContext *C,
                                              ConstraintResolver *CR) {
-  if (!isBasePointerAssignment(L, R))
+  if (!isLowerBoundAssignment(L, R))
     recordArithmeticOperation(L, CR);
   return true;
 }

clang/lib/3C/CMakeLists.txt

@@ -30,7 +30,7 @@ add_clang_library(clang3C
   AVarBoundsInfo.cpp
   AVarGraph.cpp
   ArrayBoundsInferenceConsumer.cpp
-  BasePointerAssignment.cpp
+        LowerBoundAssignment.cpp
   CastPlacement.cpp
   3C.cpp
   3CInteractiveData.cpp

clang/lib/3C/ConstraintBuilder.cpp

@@ -10,7 +10,7 @@
 //===----------------------------------------------------------------------===//
 
 #include "clang/3C/ConstraintBuilder.h"
-#include "clang/3C/BasePointerAssignment.h"
+#include "clang/3C/LowerBoundAssignment.h"
 #include "clang/3C/3CGlobalOptions.h"
 #include "clang/3C/3CStats.h"
 #include "clang/3C/ArrayBoundsInferenceConsumer.h"
@@ -472,7 +472,7 @@ void VariableAdderConsumer::HandleTranslationUnit(ASTContext &C) {
   }
 
   VariableAdderVisitor VAV = VariableAdderVisitor(&C, Info);
-  BasePointerAssignmentFinder BPF = BasePointerAssignmentFinder(&C, Info);
+  LowerBoundAssignmentFinder BPF = LowerBoundAssignmentFinder(&C, Info);
   TranslationUnitDecl *TUD = C.getTranslationUnitDecl();
   // Collect Variables.
   for (const auto &D : TUD->decls()) {

clang/lib/3C/BasePointerAssignment.cpp renamed to clang/lib/3C/LowerBoundAssignment.cpp

@@ -1,18 +1,18 @@
-//=--PointerArithmeticAssignment.cpp------------------------------*- C++-*-===//
+//=--LowerBoundAssignment.cpp-------------------------------------*- C++-*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
-// Implementation of methods in PointerArithmeticAssignment.h
+// Implementation of methods in LowerBoundAssignment.h
 //===----------------------------------------------------------------------===//
 
 #include "clang/3C/ProgramInfo.h"
 #include "clang/AST/ASTContext.h"
 
 #include "clang/Rewrite/Core/Rewriter.h"
-#include "clang/3C/BasePointerAssignment.h"
+#include "clang/3C/LowerBoundAssignment.h"
 #include "clang/3C/RewriteUtils.h"
 
 using namespace llvm;
@@ -78,7 +78,7 @@ class CollectDeclsVisitor : public RecursiveASTVisitor<CollectDeclsVisitor> {
   std::set<StructAccess> ObservedStructAccesses;
 };
 
-bool isBasePointerAssignment(Expr *LHS, Expr *RHS) {
+bool isLowerBoundAssignment(Expr *LHS, Expr *RHS) {
   CollectDeclsVisitor LVarVis;
   LVarVis.TraverseStmt(LHS);
 
@@ -93,21 +93,21 @@ bool isBasePointerAssignment(Expr *LHS, Expr *RHS) {
                    RVarVis.getObservedStructAccesses(), CommonStVars);
 
   // If CommonVars is empty, then the same pointer does not appears on the LHS
-  // and RHS of the assignment. We say that the assignment is a base pointer
+  // and RHS of the assignment. We say that the assignment is a lower bound
   // update.
   return CommonVars.empty() && CommonStVars.empty();
 }
 
 bool
-BasePointerAssignmentVisitor::VisitBinaryOperator(BinaryOperator *O) {
+LowerBoundAssignmentVisitor::VisitBinaryOperator(BinaryOperator *O) {
   if (O->getOpcode() == clang::BO_Assign &&
-      isBasePointerAssignment(O->getLHS(), O->getRHS()))
-    visitBasePointerAssignment(O->getLHS(), O->getRHS());
+    isLowerBoundAssignment(O->getLHS(), O->getRHS()))
+    visitLowerBoundAssignment(O->getLHS(), O->getRHS());
   return true;
 }
 
-void BasePointerAssignmentUpdater::visitBasePointerAssignment(Expr *LHS,
-                                                              Expr *RHS) {
+void LowerBoundAssignmentUpdater::visitLowerBoundAssignment(Expr *LHS,
+                                                            Expr *RHS) {
   CVarSet LHSCVs = CR.getExprConstraintVarsSet(LHS);
   // It is possible for multiple ConstraintVariables to exist on the LHS
   // of an assignment expression; e.g., `*(0 ? a : b) = 0`. If this
@@ -134,8 +134,8 @@ void BasePointerAssignmentUpdater::visitBasePointerAssignment(Expr *LHS,
   }
 }
 
-void BasePointerAssignmentFinder::visitBasePointerAssignment(Expr *LHS,
-                                                             Expr *RHS) {
+void LowerBoundAssignmentFinder::visitLowerBoundAssignment(Expr *LHS,
+                                                           Expr *RHS) {
   SourceLocation RHSEnd =
     getLocationAfter(RHS->getEndLoc(), C->getSourceManager(), C->getLangOpts());
   SourceLocation LHSLoc = LHS->getExprLoc();

clang/lib/3C/RewriteUtils.cpp

@@ -14,7 +14,7 @@
 #include "clang/3C/CastPlacement.h"
 #include "clang/3C/CheckedRegions.h"
 #include "clang/3C/DeclRewriter.h"
-#include "clang/3C/BasePointerAssignment.h"
+#include "clang/3C/LowerBoundAssignment.h"
 #include "clang/3C/TypeVariableAnalysis.h"
 #include "clang/AST/RecursiveASTVisitor.h"
 #include "clang/Tooling/Transformer/SourceCode.h"
@@ -700,7 +700,7 @@ void RewriteConsumer::HandleTranslationUnit(ASTContext &Context) {
   CastPlacementVisitor ECPV(&Context, Info, R, CLV.getExprsWithCast());
   TypeExprRewriter TER(&Context, Info, R);
   TypeArgumentAdder TPA(&Context, Info, R);
-  BasePointerAssignmentUpdater AU(&Context, Info, R);
+  LowerBoundAssignmentUpdater AU(&Context, Info, R);
   TranslationUnitDecl *TUD = Context.getTranslationUnitDecl();
   for (const auto &D : TUD->decls()) {
     if (_3COpts.AddCheckedRegions) {