[Dependency Scanning] Add libSwiftScan API and JSON output for source import information

artemcm · artemcm · commit 33d7de6875d5 · 2025-06-11T11:54:37.000-07:00
diff --git a/include/swift-c/DependencyScan/DependencyScan.h b/include/swift-c/DependencyScan/DependencyScan.h
@@ -25,7 +25,7 @@
 /// SWIFTSCAN_VERSION_MINOR should increase when there are API additions.
 /// SWIFTSCAN_VERSION_MAJOR is intended for "major" source/ABI breaking changes.
 #define SWIFTSCAN_VERSION_MAJOR 2
-#define SWIFTSCAN_VERSION_MINOR 1
+#define SWIFTSCAN_VERSION_MINOR 2
 
 SWIFTSCAN_BEGIN_DECLS
 
@@ -49,6 +49,9 @@ typedef struct swiftscan_dependency_info_s *swiftscan_dependency_info_t;
 /// Opaque container to a link library info.
 typedef struct swiftscan_link_library_info_s *swiftscan_link_library_info_t;
 
+/// Opaque container to an import info.
+typedef struct swiftscan_import_info_s *swiftscan_import_info_t;
+
 /// Opaque container to a macro dependency.
 typedef struct swiftscan_macro_dependency_s *swiftscan_macro_dependency_t;
 
@@ -76,6 +79,18 @@ typedef struct {
   size_t count;
 } swiftscan_link_library_set_t;
 
+/// Set of details about source imports
+typedef struct {
+  swiftscan_import_info_t *imports;
+  size_t count;
+} swiftscan_import_info_set_t;
+
+/// Set of source location infos
+typedef struct {
+  swiftscan_source_location_t *source_locations;
+  size_t count;
+} swiftscan_source_location_set_t;
+
 /// Set of macro dependency
 typedef struct {
   swiftscan_macro_dependency_t *macro_dependencies;
@@ -89,6 +104,16 @@ typedef enum {
   SWIFTSCAN_DIAGNOSTIC_SEVERITY_REMARK = 3
 } swiftscan_diagnostic_severity_t;
 
+// Must maintain consistency with swift::AccessLevel
+typedef enum {
+  SWIFTSCAN_ACCESS_LEVEL_PRIVATE = 0,
+  SWIFTSCAN_ACCESS_LEVEL_FILEPRIVATE = 1,
+  SWIFTSCAN_ACCESS_LEVEL_INTERNAL = 2,
+  SWIFTSCAN_ACCESS_LEVEL_PACKAGE = 3,
+  SWIFTSCAN_ACCESS_LEVEL_PUBLIC = 4,
+  SWIFTSCAN_ACCESS_LEVEL_OPEN = 5,
+} swiftscan_access_level_t;
+
 typedef struct {
   swiftscan_diagnostic_info_t *diagnostics;
   size_t count;
@@ -148,10 +173,23 @@ swiftscan_module_info_get_direct_dependencies(swiftscan_dependency_info_t info);
 SWIFTSCAN_PUBLIC swiftscan_link_library_set_t *
 swiftscan_module_info_get_link_libraries(swiftscan_dependency_info_t info);
 
+SWIFTSCAN_PUBLIC swiftscan_import_info_set_t *
+swiftscan_module_info_get_imports(swiftscan_dependency_info_t info);
+
 SWIFTSCAN_PUBLIC swiftscan_module_details_t
 swiftscan_module_info_get_details(swiftscan_dependency_info_t info);
 
-//=== Link Library Info Functions ------------------------------------===//
+//=== Import Details Functions -------------------------------------------===//
+SWIFTSCAN_PUBLIC swiftscan_source_location_set_t *
+swiftscan_import_info_get_source_locations(swiftscan_import_info_t info);
+
+SWIFTSCAN_PUBLIC swiftscan_string_ref_t
+swiftscan_import_info_get_identifier(swiftscan_import_info_t info);
+
+SWIFTSCAN_PUBLIC swiftscan_access_level_t
+swiftscan_import_info_get_access_level(swiftscan_import_info_t info);
+
+//=== Link Library Info Functions ----------------------------------------===//
 SWIFTSCAN_PUBLIC swiftscan_string_ref_t
 swiftscan_link_library_info_get_link_name(
     swiftscan_link_library_info_t info);
diff --git a/include/swift/DependencyScan/DependencyScanImpl.h b/include/swift/DependencyScan/DependencyScanImpl.h
@@ -63,6 +63,9 @@ struct swiftscan_dependency_info_s {
   /// The list of link libraries for this module.
   swiftscan_link_library_set_t *link_libraries;
 
+  /// The list of source import infos.
+  swiftscan_import_info_set_t *imports;
+
   /// Specific details of a particular kind of module.
   swiftscan_module_details_t details;
 };
@@ -74,10 +77,16 @@ struct swiftscan_link_library_info_s {
   bool forceLoad;
 };
 
+struct swiftscan_import_info_s {
+  swiftscan_string_ref_t import_identifier;
+  swiftscan_source_location_set_t *source_locations;
+  swiftscan_access_level_t access_level;
+};
+
 struct swiftscan_macro_dependency_s {
-  swiftscan_string_ref_t moduleName;
-  swiftscan_string_ref_t libraryPath;
-  swiftscan_string_ref_t executablePath;
+  swiftscan_string_ref_t module_name;
+  swiftscan_string_ref_t library_path;
+  swiftscan_string_ref_t executable_path;
 };
 
 /// Swift modules to be built from a module interface, may have a bridging
diff --git a/lib/DependencyScan/DependencyScanJSON.cpp b/lib/DependencyScan/DependencyScanJSON.cpp
@@ -77,6 +77,11 @@ void writeJSONValue(llvm::raw_ostream &out, bool value, unsigned indentLevel) {
   out.write_escaped(value ? "true" : "false");
 }
 
+/// Write a boolean value as JSON.
+void writeJSONValue(llvm::raw_ostream &out, uint32_t value, unsigned indentLevel) {
+  out.write_escaped(std::to_string(value));
+}
+
 /// Write a JSON array.
 template <typename T>
 void writeJSONValue(llvm::raw_ostream &out, ArrayRef<T> values,
@@ -226,6 +231,93 @@ void writeLinkLibraries(llvm::raw_ostream &out,
   out << "\n";
 }
 
+void writeImportInfos(llvm::raw_ostream &out,
+                      const swiftscan_import_info_set_t *imports,
+                      unsigned indentLevel, bool trailingComma) {
+  out.indent(indentLevel * 2);
+  out << "\"imports\": ";
+  out << "[\n";
+
+  for (size_t i = 0; i < imports->count; ++i) {
+    const auto &iInfo = *imports->imports[i];
+    out.indent((indentLevel + 1) * 2);
+    out << "{\n";
+    auto entryIndentLevel = ((indentLevel + 2) * 2);
+    out.indent(entryIndentLevel);
+    out << "\"identifier\": ";
+    writeJSONValue(out, iInfo.import_identifier, indentLevel);
+    out << ",\n";
+    out.indent(entryIndentLevel);
+    out << "\"accessLevel\": ";
+    switch (iInfo.access_level) {
+      case SWIFTSCAN_ACCESS_LEVEL_PRIVATE:
+        writeJSONValue(out, StringRef("private"), entryIndentLevel);
+        break;
+      case SWIFTSCAN_ACCESS_LEVEL_FILEPRIVATE:
+        writeJSONValue(out, StringRef("fileprivate"), entryIndentLevel);
+        break;
+      case SWIFTSCAN_ACCESS_LEVEL_INTERNAL:
+        writeJSONValue(out, StringRef("internal"), entryIndentLevel);
+        break;
+      case SWIFTSCAN_ACCESS_LEVEL_PACKAGE:
+        writeJSONValue(out, StringRef("package"), entryIndentLevel);
+        break;
+      case SWIFTSCAN_ACCESS_LEVEL_PUBLIC:
+        writeJSONValue(out, StringRef("public"), entryIndentLevel);
+        break;
+      case SWIFTSCAN_ACCESS_LEVEL_OPEN:
+        writeJSONValue(out, StringRef("open"), entryIndentLevel);
+        break;
+    }
+
+    if (iInfo.source_locations->count) {
+      out << ",\n";
+      out.indent(entryIndentLevel);
+      out << "\"importLocations\": ";
+      out << "[\n";
+      auto slIndentLevel = ((entryIndentLevel + 4));
+      for (size_t i = 0; i < iInfo.source_locations->count; ++i) {
+        out.indent(entryIndentLevel + 2);
+        out << "{\n";
+        const auto &sl = *iInfo.source_locations->source_locations[i];
+        out.indent(slIndentLevel);
+        out << "\"bufferIdentifier\": ";
+        writeJSONValue(out, sl.buffer_identifier, indentLevel);
+        out << ",\n";
+        out.indent(slIndentLevel);
+        out << "\"linuNumber\": ";
+        writeJSONValue(out, sl.line_number, indentLevel);
+        out << ",\n";
+        out.indent(slIndentLevel);
+        out << "\"columnNumber\": ";
+        writeJSONValue(out, sl.column_number, indentLevel);
+        out << "\n";
+        out.indent(entryIndentLevel + 2);
+        out << "}";
+        if (i != iInfo.source_locations->count - 1)
+          out << ",";
+        out << "\n";
+      }
+      out.indent(entryIndentLevel);
+      out << "]\n";
+    } else {
+      out << "\n";
+    }
+    out.indent((indentLevel + 1) * 2);
+    out << "}";
+    if (i != imports->count - 1)
+      out << ",";
+    out << "\n";
+  }
+
+  out.indent(indentLevel * 2);
+  out << "]";
+
+  if (trailingComma)
+    out << ",";
+  out << "\n";
+}
+
 static void
 writeMacroDependencies(llvm::raw_ostream &out,
                        const swiftscan_macro_dependency_set_t *macro_deps,
@@ -243,15 +335,15 @@ writeMacroDependencies(llvm::raw_ostream &out,
     auto entryIndentLevel = ((indentLevel + 2) * 2);
     out.indent(entryIndentLevel);
     out << "\"moduleName\": ";
-    writeJSONValue(out, macroInfo.moduleName, indentLevel);
+    writeJSONValue(out, macroInfo.module_name, indentLevel);
     out << ",\n";
     out.indent(entryIndentLevel);
     out << "\"libraryPath\": ";
-    writeJSONValue(out, macroInfo.libraryPath, entryIndentLevel);
+    writeJSONValue(out, macroInfo.library_path, entryIndentLevel);
     out << ",\n";
     out.indent(entryIndentLevel);
     out << "\"executablePath\": ";
-    writeJSONValue(out, macroInfo.executablePath, entryIndentLevel);
+    writeJSONValue(out, macroInfo.executable_path, entryIndentLevel);
     out << "\n";
     out.indent((indentLevel + 1) * 2);
     out << "}";
@@ -368,6 +460,8 @@ void writeJSON(llvm::raw_ostream &out,
                         /*trailingComma=*/true);
       writeLinkLibraries(out, moduleInfo.link_libraries,
                          3, /*trailingComma=*/true);
+      writeImportInfos(out, moduleInfo.imports,
+                       3, /*trailingComma=*/true);
     }
     // Swift and Clang-specific details.
     out.indent(3 * 2);
diff --git a/lib/DependencyScan/DependencyScanningTool.cpp b/lib/DependencyScan/DependencyScanningTool.cpp
@@ -238,6 +238,13 @@ static swiftscan_dependency_graph_t generateHollowDiagnosticOutput(
   hollowLinkLibrarySet->link_libraries = nullptr;
   hollowMainModuleInfo->link_libraries = hollowLinkLibrarySet;
 
+  // Empty Import set
+  swiftscan_import_info_set_t *hollowImportInfoSet =
+      new swiftscan_import_info_set_t;
+  hollowImportInfoSet->count = 0;
+  hollowImportInfoSet->imports = nullptr;
+  hollowMainModuleInfo->imports = hollowImportInfoSet;
+
   // Populate the diagnostic info
   hollowResult->diagnostics =
       mapCollectedDiagnosticsForOutput(&ScanDiagnosticConsumer);
diff --git a/lib/DependencyScan/ScanDependencies.cpp b/lib/DependencyScan/ScanDependencies.cpp
@@ -747,10 +747,10 @@ static swiftscan_macro_dependency_set_t *createMacroDependencySet(
   unsigned SI = 0;
   for (auto &entry : macroDeps) {
     set->macro_dependencies[SI] = new swiftscan_macro_dependency_s;
-    set->macro_dependencies[SI]->moduleName = create_clone(entry.first.c_str());
-    set->macro_dependencies[SI]->libraryPath =
+    set->macro_dependencies[SI]->module_name = create_clone(entry.first.c_str());
+    set->macro_dependencies[SI]->library_path =
         create_clone(entry.second.LibraryPath.c_str());
-    set->macro_dependencies[SI]->executablePath =
+    set->macro_dependencies[SI]->executable_path =
         create_clone(entry.second.ExecutablePath.c_str());
     ++ SI;
   }
@@ -976,6 +976,37 @@ generateFullDependencyGraph(const CompilerInstance &instance,
       linkLibrarySet->link_libraries[i] = llInfo;
     }
     moduleInfo->link_libraries = linkLibrarySet;
+
+    // Create source import infos set for this module
+    auto imports = moduleDependencyInfo.getModuleImports();
+    swiftscan_import_info_set_t *importInfoSet =
+        new swiftscan_import_info_set_t;
+    importInfoSet->count = imports.size();
+    importInfoSet->imports = new swiftscan_import_info_t[importInfoSet->count];
+    for (size_t i = 0; i < imports.size(); ++i) {
+      const auto &ii = imports[i];
+      swiftscan_import_info_s *iInfo = new swiftscan_import_info_s;
+      iInfo->import_identifier = create_clone(ii.importIdentifier.c_str());
+      iInfo->access_level = static_cast<swiftscan_access_level_t>(ii.accessLevel);
+
+      const auto &sourceLocations = ii.importLocations;
+      swiftscan_source_location_set_t *sourceLocSet =
+          new swiftscan_source_location_set_t;
+      sourceLocSet->count = sourceLocations.size();
+      sourceLocSet->source_locations =
+          new swiftscan_source_location_t[sourceLocSet->count];
+      for (size_t i = 0; i < sourceLocations.size(); ++i) {
+        const auto &sl = sourceLocations[i];
+        swiftscan_source_location_s *slInfo = new swiftscan_source_location_s;
+        slInfo->buffer_identifier = create_clone(sl.bufferIdentifier.c_str());
+        slInfo->line_number = sl.lineNumber;
+        slInfo->column_number = sl.columnNumber;
+        sourceLocSet->source_locations[i] = slInfo;
+      }
+      iInfo->source_locations = sourceLocSet;
+      importInfoSet->imports[i] = iInfo;
+    }
+    moduleInfo->imports = importInfoSet;
   }
 
   swiftscan_dependency_graph_t result = new swiftscan_dependency_graph_s;
diff --git a/lib/Tooling/libSwiftScan/libSwiftScan.cpp b/lib/Tooling/libSwiftScan/libSwiftScan.cpp
@@ -35,9 +35,9 @@ void swiftscan_macro_dependency_dispose(
     return;
 
   for (unsigned i = 0; i < macro->count; ++i) {
-    swiftscan_string_dispose(macro->macro_dependencies[i]->moduleName);
-    swiftscan_string_dispose(macro->macro_dependencies[i]->libraryPath);
-    swiftscan_string_dispose(macro->macro_dependencies[i]->executablePath);
+    swiftscan_string_dispose(macro->macro_dependencies[i]->module_name);
+    swiftscan_string_dispose(macro->macro_dependencies[i]->library_path);
+    swiftscan_string_dispose(macro->macro_dependencies[i]->executable_path);
     delete macro->macro_dependencies[i];
   }
   delete[] macro->macro_dependencies;
@@ -240,12 +240,17 @@ swiftscan_link_library_set_t *swiftscan_module_info_get_link_libraries(
   return info->link_libraries;
 }
 
+swiftscan_import_info_set_t *swiftscan_module_info_get_imports(
+    swiftscan_dependency_info_t info) {
+  return info->imports;
+}
+
 swiftscan_module_details_t
 swiftscan_module_info_get_details(swiftscan_dependency_info_t info) {
   return info->details;
 }
 
-//=== Link Library Info query APIs -----------------------------------===//
+//=== Link Library Info query APIs ---------------------------------------===//
 
 swiftscan_string_ref_t
 swiftscan_link_library_info_get_link_name(swiftscan_link_library_info_t info) {
@@ -267,7 +272,23 @@ swiftscan_link_library_info_get_should_force_load(swiftscan_link_library_info_t
   return info->forceLoad;
 }
 
-//=== Swift Textual Module Details query APIs -----------------------------===//
+//=== Import Details Query APIs ------------------------------------------===//
+swiftscan_source_location_set_t *
+swiftscan_import_info_get_source_locations(swiftscan_import_info_t info) {
+  return info->source_locations;
+}
+
+swiftscan_string_ref_t
+swiftscan_import_info_get_identifier(swiftscan_import_info_t info) {
+  return info->import_identifier;
+}
+
+swiftscan_access_level_t
+swiftscan_import_info_get_access_level(swiftscan_import_info_t info) {
+  return info->access_level;
+}
+
+//=== Swift Textual Module Details query APIs ----------------------------===//
 
 swiftscan_dependency_info_kind_t
 swiftscan_module_detail_get_kind(swiftscan_module_details_t details) {
diff --git a/lib/Tooling/libSwiftScan/libSwiftScan.exports b/lib/Tooling/libSwiftScan/libSwiftScan.exports
@@ -5,11 +5,15 @@ swiftscan_link_library_info_get_link_name
 swiftscan_link_library_info_get_is_static
 swiftscan_link_library_info_get_is_framework
 swiftscan_link_library_info_get_should_force_load
+swiftscan_import_info_get_source_locations
+swiftscan_import_info_get_identifier
+swiftscan_import_info_get_access_level
 swiftscan_module_info_get_module_name
 swiftscan_module_info_get_module_path
 swiftscan_module_info_get_source_files
 swiftscan_module_info_get_direct_dependencies
 swiftscan_module_info_get_link_libraries
+swiftscan_module_info_get_imports
 swiftscan_module_info_get_details
 swiftscan_module_detail_get_kind
 swiftscan_swift_textual_detail_get_module_interface_path
