Swift: replace assertions and prints in main and SwiftExtractor

Author: redsun82

swift/extractor/SwiftExtractor.cpp

@@ -14,18 +14,23 @@
 #include "swift/extractor/infra/SwiftLocationExtractor.h"
 #include "swift/extractor/infra/SwiftBodyEmissionStrategy.h"
 #include "swift/extractor/mangler/SwiftMangler.h"
+#include "swift/extractor/infra/log/SwiftAssert.h"
 
 using namespace codeql;
 using namespace std::string_literals;
 namespace fs = std::filesystem;
 
+Logger& main_logger::logger() {
+  static Logger ret{"main"};
+  return ret;
+}
+
+using namespace main_logger;
+
 static void ensureDirectory(const char* label, const fs::path& dir) {
   std::error_code ec;
   fs::create_directories(dir, ec);
-  if (ec) {
-    std::cerr << "Cannot create " << label << " directory: " << ec.message() << "\n";
-    std::abort();
-  }
+  CODEQL_ASSERT(!ec, "Cannot create {} directory ({})", label, ec);
 }
 
 static void archiveFile(const SwiftExtractorConfiguration& config, swift::SourceFile& file) {
@@ -36,11 +41,7 @@ static void archiveFile(const SwiftExtractorConfiguration& config, swift::Source
 
   std::error_code ec;
   fs::copy(source, destination, fs::copy_options::overwrite_existing, ec);
-
-  if (ec) {
-    std::cerr << "Cannot archive source file " << source << " -> " << destination << ": "
-              << ec.message() << "\n";
-  }
+  CODEQL_ASSERT(!ec, "Cannot archive source file {} -> {} ({})", source, destination, ec);
 }
 
 static fs::path getFilename(swift::ModuleDecl& module,
@@ -243,11 +244,9 @@ void codeql::extractExtractLazyDeclarations(SwiftExtractorState& state,
   // Just in case
   const int upperBound = 100;
   int iteration = 0;
-  while (!state.pendingDeclarations.empty() && iteration++ < upperBound) {
+  while (!state.pendingDeclarations.empty()) {
+    CODEQL_ASSERT(iteration++ < upperBound,
+                  "Swift extractor reached upper bound while extracting lazy declarations");
     extractLazy(state, compiler);
   }
-  if (iteration >= upperBound) {
-    std::cerr << "Swift extractor reached upper bound while extracting lazy declarations\n";
-    abort();
-  }
 }

swift/extractor/SwiftExtractor.h

@@ -8,4 +8,9 @@
 namespace codeql {
 void extractSwiftFiles(SwiftExtractorState& state, swift::CompilerInstance& compiler);
 void extractExtractLazyDeclarations(SwiftExtractorState& state, swift::CompilerInstance& compiler);
+
+class Logger;
+namespace main_logger {
+Logger& logger();
+}
 }  // namespace codeql

swift/extractor/main.cpp

@@ -16,9 +16,10 @@
 #include "swift/extractor/invocation/SwiftInvocationExtractor.h"
 #include "swift/extractor/trap/TrapDomain.h"
 #include "swift/extractor/infra/file/Path.h"
-#include "swift/extractor/infra/log/SwiftLogging.h"
+#include "swift/extractor/infra/log/SwiftAssert.h"
 
 using namespace std::string_literals;
+using namespace codeql::main_logger;
 
 const std::string_view codeql::logRootName = "extractor";
 
@@ -30,9 +31,10 @@ static void lockOutputSwiftModuleTraps(codeql::SwiftExtractorState& state,
         !module.empty()) {
       if (auto target = codeql::createTargetTrapDomain(state, codeql::resolvePath(module),
                                                        codeql::TrapType::module)) {
-        target->emit("// trap file deliberately empty\n"
-                     "// this swiftmodule was created during the build, so its entities must have"
-                     " been extracted directly from source files");
+        target->emitComment(
+            "trap file deliberately empty\n"
+            " * this swiftmodule was created during the build, so its entities must have\n"
+            " * been extracted directly from source files\n");
       }
     }
   }
@@ -43,7 +45,6 @@ static void processFrontendOptions(codeql::SwiftExtractorState& state,
   auto& inOuts = options.InputsAndOutputs;
   std::vector<swift::InputFile> inputs;
   inOuts.forEachInput([&](const swift::InputFile& input) {
-    std::cerr << input.getFileName() << ":\n";
     swift::PrimarySpecificPaths psp{};
     if (std::filesystem::path output = input.getPrimarySpecificPaths().OutputFilename;
         !output.empty()) {
@@ -142,7 +143,7 @@ static bool checkRunUnderFilter(int argc, char* const* argv) {
 // An example usage is to run the extractor under `gdbserver :1234` when the
 // arguments match a given source file.
 static void checkWhetherToRunUnderTool(int argc, char* const* argv) {
-  assert(argc > 0);
+  if (argc == 0) return;
 
   auto runUnder = getenv("CODEQL_EXTRACTOR_SWIFT_RUN_UNDER");
   if (runUnder == nullptr || !checkRunUnderFilter(argc, argv)) {
@@ -168,10 +169,7 @@ codeql::TrapDomain invocationTrapDomain(codeql::SwiftExtractorState& state) {
   auto filename = std::to_string(timestamp) + '-' + std::to_string(getpid());
   auto target = std::filesystem::path("invocations") / std::filesystem::path(filename);
   auto maybeDomain = codeql::createTargetTrapDomain(state, target, codeql::TrapType::invocation);
-  if (!maybeDomain) {
-    std::cerr << "Cannot create invocation trap file: " << target << "\n";
-    abort();
-  }
+  CODEQL_ASSERT(maybeDomain, "Cannot create invocation trap file for {}", target);
   return std::move(maybeDomain.value());
 }
 
@@ -219,11 +217,8 @@ int main(int argc, char** argv, char** envp) {
   initializeSwiftModules();
 
   const auto configuration = configure(argc, argv);
-  {
-    codeql::Logger logger{"main"};
-    LOG_INFO("calling extractor with arguments \"{}\"", argDump(argc, argv));
-    LOG_DEBUG("environment:\n{}\n", envDump(envp));
-  }
+  LOG_INFO("calling extractor with arguments \"{}\"", argDump(argc, argv));
+  LOG_DEBUG("environment:\n{}\n", envDump(envp));
 
   auto openInterception = codeql::setupFileInterception(configuration);
 

swift/extractor/trap/TrapDomain.h

@@ -26,10 +26,15 @@ class TrapDomain {
   }
 
   template <typename... Args>
-  void debug(const Args&... args) {
-    out << "/* DEBUG:\n";
+  void emitComment(const Args&... args) {
+    out << "/* ";
     (out << ... << args);
-    out << "\n*/\n";
+    out << " */\n";
+  }
+
+  template <typename... Args>
+  void debug(const Args&... args) {
+    emitComment("DEBUG:\n", args..., '\n');
   }
 
   template <typename Tag>