Making checked-c-convert into a library (#837)

This large change adds support for existential struct types to Checked C.  These can be used to replace uses of void pointers in callbacks, abstract data types, and closures.  There is a corresponding commit of tests for existential types to the Checked C repo.

This changes adds IR support, parsing support, semantic checking/typechecking support, and code generation support.  Serialization/deserialization support still needs to be implemented.   There are also a number of cleanups to do, which are documented in GitHub issues.   There are three parts to the change:
- Support for existential types.
- The pack operation.
- The unpack operation, which is done as a declaration with an initializer.

Merged on behalf of Machiry Aravind Kumar (@Machiry)

Author: Machiry

clang-tools-extra/clangd/CConvertCommands.h

@@ -13,7 +13,7 @@
 #define LLVM_TOOLS_CLANG_TOOLS_EXTRA_CLANGD_CCONVERTCOMMANDS_H
 
 #include "Protocol.h"
-#include "cconvert/CConvInteractive.h"
+#include "clang/CConv/CConv.h"
 
 namespace clang {
 namespace clangd {

clang-tools-extra/clangd/CConvertDiagnostics.h

@@ -14,7 +14,7 @@
 
 #include <set>
 #include "Diagnostics.h"
-#include "cconvert/CConvInteractive.h"
+#include "clang/CConv/CConv.h"
 
 namespace clang {
 namespace clangd {

clang-tools-extra/clangd/CMakeLists.txt

@@ -210,6 +210,7 @@ add_clang_library(cconvClangDaemon
   refactor/Tweak.cpp
 
   LINK_LIBS
+  CConv
   clangAST
   clangASTMatchers
   clangBasic
@@ -254,7 +255,6 @@ if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
   # FIXME: Make fuzzer not use linux-specific APIs, build it everywhere.
   add_subdirectory(fuzzer)
 endif()
-add_subdirectory(cconvert)
 add_subdirectory(tool)
 add_subdirectory(indexer)
 add_subdirectory(index/dex/dexp)

clang-tools-extra/clangd/ClangdLSPServer.cpp

@@ -548,13 +548,13 @@ void ClangdLSPServer::ccConvResultsReady(std::string FileName,
   this->onDiagnosticsReady(FileName, Diagnostics);
 }
 
-void ClangdLSPServer::sendCConvMessage(std::string msg) {\
+void ClangdLSPServer::sendCConvMessage(std::string MsgStr) {
  // Send message as info to the client.
   notify("window/showMessage",
          llvm::json::Object{
              // Info message.
              {"type", 3},
-             {"message", std::move(msg)},
+             {"message", std::move(MsgStr)},
          });
 }
 #endif

clang-tools-extra/clangd/ClangdLSPServer.h

@@ -18,7 +18,7 @@
 #include "Protocol.h"
 #include "Transport.h"
 #ifdef INTERACTIVECCCONV
-#include "cconvert/CConvInteractive.h"
+#include "clang/CConv/CConv.h"
 #endif
 #include "clang/Tooling/Core/Replacement.h"
 #include "llvm/ADT/Optional.h"
@@ -64,7 +64,7 @@ class ClangdLSPServer : private DiagnosticsConsumer {
 
 #ifdef INTERACTIVECCCONV
   void ccConvResultsReady(std::string FileName, bool ClearDiags = false) override;
-  void sendCConvMessage(std::string msg) override;
+  void sendCConvMessage(std::string MsgStr) override;
 #endif
 
 private:

clang-tools-extra/clangd/ClangdServer.cpp

@@ -24,7 +24,7 @@
 #include "refactor/Rename.h"
 #include "refactor/Tweak.h"
 #ifdef INTERACTIVECCCONV
-#include "cconvert/CConvInteractive.h"
+#include "clang/CConv/CConv.h"
 #include "CConvertCommands.h"
 #endif
 #include "clang/Format/Format.h"
@@ -170,34 +170,36 @@ void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents,
 }
 
 #ifdef INTERACTIVECCCONV
-void ClangdServer::reportCConvDiagsForAllFiles(DisjointSet &ccInfo,
+void ClangdServer::reportCConvDiagsForAllFiles(DisjointSet &CcInfo,
                                                CConvLSPCallBack *ConvCB) {
   // Update the diag information for all the valid files.
-  for (auto &srcFileDiags : CConvDiagInfo.GetAllFilesDiagnostics()) {
-    ConvCB->ccConvResultsReady(srcFileDiags.first);
+  for (auto &SrcFileDiags : CConvDiagInfo.GetAllFilesDiagnostics()) {
+    ConvCB->ccConvResultsReady(SrcFileDiags.first);
   }
 }
 
-void ClangdServer::clearCConvDiagsForAllFiles(DisjointSet &ccInfo,
+void ClangdServer::clearCConvDiagsForAllFiles(DisjointSet &CcInfo,
                                               CConvLSPCallBack *ConvCB) {
-  for (auto &srcFileDiags : CConvDiagInfo.GetAllFilesDiagnostics()) {
+  for (auto &SrcFileDiags : CConvDiagInfo.GetAllFilesDiagnostics()) {
     // Clear diags for all files.
-    ConvCB->ccConvResultsReady(srcFileDiags.first, true);
+    ConvCB->ccConvResultsReady(SrcFileDiags.first, true);
   }
 }
 
-void ClangdServer::cconvCollectAndBuildInitialConstraints(CConvLSPCallBack *ConvCB) {
+void
+ClangdServer::cconvCollectAndBuildInitialConstraints(CConvLSPCallBack *ConvCB) {
   auto Task = [=]() {
     CConvDiagInfo.ClearAllDiags();
     ConvCB->sendCConvMessage("Running CConv for first time.");
     CConvInter.BuildInitialConstraints();
+    CConvInter.SolveConstraints();
     ConvCB->sendCConvMessage("Finished running CConv.");
     log("CConv: Built initial constraints successfully.\n");
-    auto &ccInterfaceInfo = CConvInter.GetWILDPtrsInfo();
+    auto &WildPtrsInfo = CConvInter.GetWILDPtrsInfo();
     log("CConv: Got WILD Ptrs Info.\n");
-    CConvDiagInfo.PopulateDiagsFromDisjointSet(ccInterfaceInfo);
+    CConvDiagInfo.PopulateDiagsFromDisjointSet(WildPtrsInfo);
     log("CConv: Populated Diags from Disjoint Sets.\n");
-    reportCConvDiagsForAllFiles(ccInterfaceInfo, ConvCB);
+    reportCConvDiagsForAllFiles(WildPtrsInfo, ConvCB);
     ConvCB->sendCConvMessage("CConv: Finished updating problems.");
     log("CConv: Updated the diag information.\n");
   };
@@ -207,37 +209,40 @@ void ClangdServer::cconvCollectAndBuildInitialConstraints(CConvLSPCallBack *Conv
 void ClangdServer::executeCConvCommand(ExecuteCommandParams Params,
                                        CConvLSPCallBack *ConvCB) {
   auto Task = [this, Params, ConvCB]() {
-    std::string replyMessage;
-    auto &wildPtrInfo = CConvInter.GetWILDPtrsInfo();
-    auto &ptrSourceMap = wildPtrInfo.PtrSourceMap;
-    if (ptrSourceMap.find(Params.ccConvertManualFix->ptrID) != ptrSourceMap.end()) {
-      std::string ptrFileName = ptrSourceMap[Params.ccConvertManualFix->ptrID]->getFileName();
-      log("CConv: File of the pointer {0}\n", ptrFileName);
-      clearCConvDiagsForAllFiles(wildPtrInfo, ConvCB);
+    std::string RplMsg;
+    auto &WildPtrsInfo = CConvInter.GetWILDPtrsInfo();
+    auto &PtrSourceMap = WildPtrsInfo.PtrSourceMap;
+    if (PtrSourceMap.find(Params.ccConvertManualFix->ptrID) !=
+        PtrSourceMap.end()) {
+      std::string PtrFileName =
+          PtrSourceMap[Params.ccConvertManualFix->ptrID]->getFileName();
+      log("CConv: File of the pointer {0}\n", PtrFileName);
+      clearCConvDiagsForAllFiles(WildPtrsInfo, ConvCB);
       ConvCB->sendCConvMessage("CConv modifying constraints.");
-      ExecuteCCCommand(Params, replyMessage, CConvInter);
+      ExecuteCCCommand(Params, RplMsg, CConvInter);
       this->CConvDiagInfo.ClearAllDiags();
-      auto &ccInterfaceInfo = wildPtrInfo;
-      ConvCB->sendCConvMessage("CConv Updating new issues after editing constraints.");
-      this->CConvDiagInfo.PopulateDiagsFromDisjointSet(ccInterfaceInfo);
+      ConvCB->sendCConvMessage("CConv Updating new issues "
+                               "after editing constraints.");
+      this->CConvDiagInfo.PopulateDiagsFromDisjointSet(WildPtrsInfo);
       log("CConv calling call-back\n");
       // ConvCB->ccConvResultsReady(ptrFileName);
       ConvCB->sendCConvMessage("CConv Updated new issues.");
-      reportCConvDiagsForAllFiles(ccInterfaceInfo, ConvCB);
+      reportCConvDiagsForAllFiles(WildPtrsInfo, ConvCB);
     } else {
       ConvCB->sendCConvMessage("CConv contraint key already removed.");
     }
   };
   WorkScheduler.run("Applying on demand ptr modifications", Task);
 }
 
-void ClangdServer::cconvCloseDocument(std::string file) {
+void ClangdServer::cconvCloseDocument(std::string FileName) {
   auto Task = [=]() {
-    log("CConv: Trying to write back file: {0}\n", file);
-    if (CConvInter.WriteConvertedFileToDisk(file)) {
-      log("CConv: Finished writing back file: {0}\n", file);
+    log("CConv: Trying to write back file: {0}\n", FileName);
+    if (CConvInter.WriteConvertedFileToDisk(FileName)) {
+      log("CConv: Finished writing back file: {0}\n", FileName);
     } else {
-      log("CConv: File not included during constraint solving phase. Rewriting failed: {0}\n", file);
+      log("CConv: File not included during constraint solving phase. "
+          "Rewriting failed: {0}\n", FileName);
     }
   };
   WorkScheduler.run("CConv: Writing back file.", Task);

clang-tools-extra/clangd/ClangdServer.h

@@ -63,8 +63,9 @@ class DiagnosticsConsumer {
 #ifdef INTERACTIVECCCONV
 class CConvLSPCallBack {
 public:
-  virtual void ccConvResultsReady(std::string targetFileName, bool clearDiags = false) = 0;
-  virtual void sendCConvMessage(std::string msg) = 0;
+  virtual void ccConvResultsReady(std::string FileName,
+                                  bool ClearDiags = false) = 0;
+  virtual void sendCConvMessage(std::string MsgStr) = 0;
 };
 #endif
 
@@ -316,7 +317,7 @@ class ClangdServer {
 
   CConvertDiagnostics CConvDiagInfo;
 
-  void cconvCloseDocument(std::string file);
+  void cconvCloseDocument(std::string FileName);
 #endif
 
 private:
@@ -327,8 +328,8 @@ class ClangdServer {
              ArrayRef<tooling::Range> Ranges);
 
 #ifdef INTERACTIVECCCONV
-  void reportCConvDiagsForAllFiles(DisjointSet &ccInfo, CConvLSPCallBack *ConvCB);
-  void clearCConvDiagsForAllFiles(DisjointSet &ccInfo, CConvLSPCallBack *ConvCB);
+  void reportCConvDiagsForAllFiles(DisjointSet &CcInfo, CConvLSPCallBack *ConvCB);
+  void clearCConvDiagsForAllFiles(DisjointSet &CcInfo, CConvLSPCallBack *ConvCB);
 #endif
 
   const FileSystemProvider &FSProvider;