merge with master

Author: kyleheadley

.github/workflows/main.yml

@@ -54,6 +54,14 @@ manual is
 For more information on Checked C and pointers to example code, see our
 [Wiki](https://github.com/Microsoft/checkedc/wiki).
 
+## 3C: Semi-automated conversion of C code to Checked C
+
+This repository includes a tool called 3C that partially automates the
+conversion of C code to Checked C. Here is [general information about the 3C
+software](clang/docs/checkedc/3C/README.md), including development status and
+how to contribute. Here are the [usage instructions for the `3c` command-line
+tool](clang/tools/3c/README.md).
+
 ## More information
 
 For more information on the Checked C clang compiler, see the [Checked C clang

README.md

@@ -16,7 +16,7 @@ namespace clangd {
 
 #define _3CSOURCE "3C_RealWild"
 
-static bool GetPtrIDFromDiagMessage(const Diagnostic &DiagMsg,
+static bool getPtrIdFromDiagMessage(const Diagnostic &DiagMsg,
                                     unsigned long &PtrId) {
   if (DiagMsg.source.rfind(_3CSOURCE, 0) == 0) {
     PtrId = atoi(DiagMsg.code.c_str());
@@ -25,13 +25,13 @@ static bool GetPtrIDFromDiagMessage(const Diagnostic &DiagMsg,
   return false;
 }
 
-void AsCCCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
+void as3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
   unsigned long PtrId;
-  if (GetPtrIDFromDiagMessage(D, PtrId)) {
+  if (getPtrIdFromDiagMessage(D, PtrId)) {
     Command AllPtrsCmd;
     _3CManualFix PtrFix;
-    PtrFix.ptrID = PtrId;
-    AllPtrsCmd._3CManualFix = PtrFix;
+    PtrFix.PtrId = PtrId;
+    AllPtrsCmd.The3CManualFix = PtrFix;
     Command SinglePtrCmd = AllPtrsCmd;
 
     AllPtrsCmd.command = Command::_3C_APPLY_FOR_ALL;
@@ -47,27 +47,26 @@ void AsCCCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
   }
 }
 
-bool Is3CCommand(const ExecuteCommandParams &Params) {
-    return (Params.command.rfind(Command::_3C_APPLY_ONLY_FOR_THIS, 0) == 0) ||
-           (Params.command.rfind(Command::_3C_APPLY_FOR_ALL, 0) == 0);
+bool is3CCommand(const ExecuteCommandParams &Params) {
+  return (Params.command.rfind(Command::_3C_APPLY_ONLY_FOR_THIS, 0) == 0) ||
+         (Params.command.rfind(Command::_3C_APPLY_FOR_ALL, 0) == 0);
 }
 
-bool ExecuteCCCommand(const ExecuteCommandParams &Params,
-                    std::string &ReplyMessage,
-                    _3CInterface &CcInterface) {
+bool execute3CCommand(const ExecuteCommandParams &Params,
+                      std::string &ReplyMessage, _3CInterface &CcInterface) {
   ReplyMessage = "Checked C Pointer Modified.";
   if (Params.command.rfind(Command::_3C_APPLY_ONLY_FOR_THIS, 0) == 0) {
-    int PtrId = Params._3CManualFix->ptrID;
-    CcInterface.MakeSinglePtrNonWild(PtrId);
+    int PtrId = Params.The3CManualFix->PtrId;
+    CcInterface.makeSinglePtrNonWild(PtrId);
     return true;
   }
   if (Params.command.rfind(Command::_3C_APPLY_FOR_ALL, 0) == 0) {
-    int PtrId = Params._3CManualFix->ptrID;
-    CcInterface.InvalidateWildReasonGlobally(PtrId);
+    int PtrId = Params.The3CManualFix->PtrId;
+    CcInterface.invalidateWildReasonGlobally(PtrId);
     return true;
   }
   return false;
 }
-}
-}
-#endif
+} // namespace clangd
+} // namespace clang
+#endif

clang-tools-extra/clangd/3CCommands.cpp

@@ -17,17 +17,16 @@
 
 namespace clang {
 namespace clangd {
-  // Convert the provided Diagnostic into Commands
-  void AsCCCommands(const Diagnostic &D, std::vector<Command> &OutCommands);
-  // Check if the execute command request from the client is a 3C command.
-  bool Is3CCommand(const ExecuteCommandParams &Params);
+// Convert the provided Diagnostic into Commands.
+void as3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands);
+// Check if the execute command request from the client is a 3C command.
+bool is3CCommand(const ExecuteCommandParams &Params);
 
-  // Interpret the provided execute command request as 3C command
-  // and execute them.
-  bool ExecuteCCCommand(const ExecuteCommandParams &Params,
-                        std::string &ReplyMessage,
-                        _3CInterface &CcInterface);
-}
-}
-#endif //LLVM_CLANG_TOOLS_EXTRA_CLANGD_3CCOMMANDS_H
+// Interpret the provided execute command request as 3C command
+// and execute them.
+bool execute3CCommand(const ExecuteCommandParams &Params,
+                      std::string &ReplyMessage, _3CInterface &CcInterface);
+} // namespace clangd
+} // namespace clang
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_3CCOMMANDS_H
 #endif

clang-tools-extra/clangd/3CCommands.h

@@ -16,40 +16,40 @@ namespace clangd {
 
 #define DEFAULT_PTRSIZE 4
 
-void _3CDiagnostics::ClearAllDiags() {
+void _3CDiagnostics::clearAllDiags() {
   std::lock_guard<std::mutex> Lock(DiagMutex);
   AllFileDiagnostics.clear();
 }
 
-static bool IsValidSourceFile(ConstraintsInfo &CCRes, std::string &FilePath) {
+static bool isValidSourceFile(ConstraintsInfo &CCRes, std::string &FilePath) {
   return CCRes.ValidSourceFiles.find(FilePath) != CCRes.ValidSourceFiles.end();
 }
 
-
-bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
+bool _3CDiagnostics::populateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
   std::lock_guard<std::mutex> Lock(DiagMutex);
   std::set<ConstraintKey> ProcessedCKeys;
   ProcessedCKeys.clear();
-  auto GetLocRange = [](uint32_t Line, uint32_t ColNoS, uint32_t ColNoE) -> Range {
-    Range nRange;
+  auto GetLocRange = [](uint32_t Line, uint32_t ColNoS,
+                        uint32_t ColNoE) -> Range {
+    Range NRange;
     Line--;
-    nRange.start.line = Line;
-    nRange.end.line = Line;
-    nRange.start.character = ColNoS;
+    NRange.start.line = Line;
+    NRange.end.line = Line;
+    NRange.start.character = ColNoS;
     if (ColNoE > 0) {
-      nRange.end.character = ColNoE;
+      NRange.end.character = ColNoE;
     } else {
-      nRange.end.character = ColNoS + DEFAULT_PTRSIZE;
+      NRange.end.character = ColNoS + DEFAULT_PTRSIZE;
     }
-    return nRange;
+    return NRange;
   };
 
   for (auto &WReason : Line.RootWildAtomsWithReason) {
     if (Line.AtomSourceMap.find(WReason.first) != Line.AtomSourceMap.end()) {
       auto *PsInfo = Line.AtomSourceMap[WReason.first];
       std::string FilePath = PsInfo->getFileName();
       // If this is not a file in a project? Then ignore.
-      if (!IsValidSourceFile(Line, FilePath))
+      if (!isValidSourceFile(Line, FilePath))
         continue;
 
       ProcessedCKeys.insert(WReason.first);
@@ -59,9 +59,9 @@ bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
                                   PsInfo->getColENo());
       NewDiag.Source = Diag::_3CMain;
       NewDiag.Severity = DiagnosticsEngine::Level::Error;
-      NewDiag.code = std::to_string(WReason.first);
-      NewDiag.Message = "Pointer is wild because of:" +
-                        WReason.second.getWildPtrReason();
+      NewDiag.Code = std::to_string(WReason.first);
+      NewDiag.Message =
+          "Pointer is wild because of:" + WReason.second.getWildPtrReason();
 
       // Create notes for the information about root cause.
       PersistentSourceLoc SL = WReason.second.getLocation();
@@ -85,36 +85,41 @@ bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
         auto *PsInfo = Line.AtomSourceMap[NonWildCk];
         std::string FilePath = PsInfo->getFileName();
         // If this is not a file in a project? Then ignore.
-        if (!IsValidSourceFile(Line, FilePath))
+        if (!isValidSourceFile(Line, FilePath))
           continue;
 
         ProcessedCKeys.insert(NonWildCk);
         Diag NewDiag;
         NewDiag.Range = GetLocRange(PsInfo->getLineNo(), PsInfo->getColSNo(),
                                     PsInfo->getColENo());
 
-        NewDiag.code = std::to_string(NonWildCk);
+        NewDiag.Code = std::to_string(NonWildCk);
         NewDiag.Source = Diag::_3CSec;
         NewDiag.Severity = DiagnosticsEngine::Level::Warning;
         NewDiag.Message = "Pointer is wild because it transitively "
                           "depends on other pointer(s)";
 
         // find the pointer group
-        CVars &DirectWildPtrs = Line.GetRCVars(NonWildCk);
+        CVars &DirectWildPtrs = Line.getRCVars(NonWildCk);
 
         unsigned MaxPtrReasons = 4;
-        for (auto tC : DirectWildPtrs) {
+        for (auto TC : DirectWildPtrs) {
           Note DiagNote;
 
-          if (Line.AtomSourceMap.find(tC) != Line.AtomSourceMap.end()) {
-            PsInfo = Line.AtomSourceMap[tC];
+          if (Line.AtomSourceMap.find(TC) != Line.AtomSourceMap.end()) {
+            PsInfo = Line.AtomSourceMap[TC];
             FilePath = PsInfo->getFileName();
             DiagNote.AbsFile = FilePath;
-            DiagNote.Range =
-                GetLocRange(PsInfo->getLineNo(), PsInfo->getColSNo(),
-                            PsInfo->getColENo());
+            DiagNote.Range = GetLocRange(
+                PsInfo->getLineNo(), PsInfo->getColSNo(), PsInfo->getColENo());
             MaxPtrReasons--;
-            DiagNote.Message = Line.RootWildAtomsWithReason[tC].getWildPtrReason();
+            // NOTE: Matt changed [] to `at` to fix a compile error after the
+            // default constructor of WildPointerInferenceInfo was removed in
+            // 3c3098c8724889a12eba383dec9088094bced99c. Right now, we don't
+            // care because we're not running clangd3c at all, but if and when
+            // we revive it, we should consider whether this assumption is safe.
+            DiagNote.Message =
+                Line.RootWildAtomsWithReason.at(TC).getWildPtrReason();
             if (MaxPtrReasons <= 1)
               DiagNote.Message += " (others)";
             NewDiag.Notes.push_back(DiagNote);
@@ -127,10 +132,9 @@ bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
     }
   }
 
-
   return true;
 }
 
-}
-}
-#endif
+} // namespace clangd
+} // namespace clang
+#endif

clang-tools-extra/clangd/3CDiagnostics.cpp

@@ -12,34 +12,36 @@
 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_3CDIAGNOSTICS_H
 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_3CDIAGNOSTICS_H
 
-#include <set>
 #include "Diagnostics.h"
 #include "clang/3C/3C.h"
+#include <set>
 
 namespace clang {
 namespace clangd {
 
 // Class that represents diagnostics messages specific to 3C.
+//
+// See clang/docs/checkedc/3C/clang-tidy.md#_3c-name-prefix
+// NOLINTNEXTLINE(readability-identifier-naming)
 class _3CDiagnostics {
 public:
   std::mutex DiagMutex;
 
   // GUARDED by DiagMutex
   // Populate diagnostics from the given disjoint set.
-  bool PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line);
+  bool populateDiagsFromConstraintsInfo(ConstraintsInfo &Line);
   // GUARDED by DiagMutex
   // Clear diagnostics of all files.
-  void ClearAllDiags();
-  std::map<std::string, std::vector<Diag>> &GetAllFilesDiagnostics() {
+  void clearAllDiags();
+  std::map<std::string, std::vector<Diag>> &getAllFilesDiagnostics() {
     return AllFileDiagnostics;
   }
+
 private:
   // Diagnostics of all files.
   std::map<std::string, std::vector<Diag>> AllFileDiagnostics;
-
-
 };
-}
-}
-#endif //LLVM_CLANG_TOOLS_EXTRA_CLANGD_
+} // namespace clangd
+} // namespace clang
+#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_
 #endif

clang-tools-extra/clangd/3CDiagnostics.h

@@ -209,7 +209,7 @@ add_clang_library(3cClangDaemon
   refactor/Tweak.cpp
 
   LINK_LIBS
-  3C
+  clang3C
   clangAST
   clangASTMatchers
   clangBasic