Skip to content

[ClangImporter] improve structure of swiftify debug logs #85129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2025
Merged

[ClangImporter] improve structure of swiftify debug logs #85129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 80 additions & 23 deletions lib/ClangImporter/SwiftifyDecl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,38 @@ using namespace swift;
using namespace importer;

#define DEBUG_TYPE "safe-interop-wrappers"
#define DLOG(x) LLVM_DEBUG(llvm::dbgs() << x)

#define DLOG(x) LLVM_DEBUG(LogIndentTracker::indent(DBGS) << x)

#ifndef NDEBUG
#define DBGS llvm::dbgs() << "[swiftify:" << __LINE__ << "] "
#define DUMP(x) DLOG(""); x->dump()
#define DLOG_SCOPE(x) DLOG(x); LogIndentTracker Scope
#else
#define DLOG_SCOPE(x) do {} while(false);
#endif


namespace {
#ifndef NDEBUG
struct LogIndentTracker {
static thread_local uint8_t LogIndent;
static llvm::raw_ostream &indent(llvm::raw_ostream &out) {
for (uint8_t i = 0; i < LogIndent; i++)
out << "| ";
return out;
}

LogIndentTracker() {
LogIndent++;
}
~LogIndentTracker() {
LogIndent--;
}
};
thread_local uint8_t LogIndentTracker::LogIndent = 0;
#endif

ValueDecl *getKnownSingleDecl(ASTContext &SwiftContext, StringRef DeclName) {
SmallVector<ValueDecl *, 1> decls;
SwiftContext.lookupInSwiftModule(DeclName, decls);
Expand Down Expand Up @@ -196,8 +225,7 @@ struct CountedByExpressionValidator
case clang::BuiltinType::ULong:
case clang::BuiltinType::LongLong:
case clang::BuiltinType::ULongLong:
// These integer literals are printed with a suffix that isn't valid Swift
// syntax
DLOG("Ignoring count parameter with non-portable integer literal");
return false;
default:
return true;
Expand Down Expand Up @@ -236,7 +264,10 @@ struct CountedByExpressionValidator
SUPPORTED_BINOP(Or)
#undef SUPPORTED_BINOP

bool VisitStmt(const clang::Stmt *) { return false; }
bool VisitStmt(const clang::Stmt *) {
DLOG("Ignoring count parameter with unsupported expression\n");
return false;
}
};


Expand All @@ -255,16 +286,24 @@ static bool SwiftifiableSizedByPointerType(const clang::ASTContext &ctx,
if (nonnullType->isOpaquePointer())
return true;
PointerTypeKind PTK;
if (!nonnullType->getAnyPointerElementType(PTK))
if (!nonnullType->getAnyPointerElementType(PTK)) {
DLOG("Ignoring sized_by on non-pointer type\n");
return false;
}
if (PTK == PTK_UnsafeRawPointer || PTK == PTK_UnsafeMutableRawPointer)
return true;
if (PTK != PTK_UnsafePointer && PTK != PTK_UnsafeMutablePointer)
if (PTK != PTK_UnsafePointer && PTK != PTK_UnsafeMutablePointer) {
DLOG("Ignoring sized_by on Autoreleasing pointer\n");
CONDITIONAL_ASSERT(PTK == PTK_AutoreleasingUnsafeMutablePointer);
return false;
}
// We have a pointer to a type with a size. Verify that it is char-sized.
auto PtrT = CAT->getAs<clang::PointerType>();
auto PointeeT = PtrT->getPointeeType();
return ctx.getTypeSizeInChars(PointeeT).isOne();
bool isByteSized = ctx.getTypeSizeInChars(PointeeT).isOne();
if (!isByteSized)
DLOG("Ignoring sized_by on non-byte-sized pointer\n");
return isByteSized;
}
static bool SwiftifiableCAT(const clang::ASTContext &ctx,
const clang::CountAttributedType *CAT,
Expand All @@ -287,6 +326,7 @@ struct UnaliasedInstantiationVisitor
bool
VisitTemplateSpecializationType(const clang::TemplateSpecializationType *) {
hasUnaliasedInstantiation = true;
DLOG("Signature contains raw template, skipping");
return false;
}
};
Expand Down Expand Up @@ -325,7 +365,7 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,
SwiftifyInfoFunctionPrinter &printer,
const AbstractFunctionDecl *MappedDecl,
const T *ClangDecl) {
DLOG("Checking " << *ClangDecl << " for bounds and lifetime info\n");
DLOG_SCOPE("Checking '" << *ClangDecl << "' for bounds and lifetime info\n");

// FIXME: for private macro generated functions we do not serialize the
// SILFunction's body anywhere triggering assertions.
Expand Down Expand Up @@ -354,20 +394,22 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,
auto *CAT = clangReturnTy->getAs<clang::CountAttributedType>();
if (SwiftifiableCAT(clangASTContext, CAT, swiftReturnTy)) {
printer.printCountedBy(CAT, SwiftifyInfoPrinter::RETURN_VALUE_INDEX);
DLOG(" Found bounds info '" << clang::QualType(CAT, 0) << "' on return value\n");
DLOG("Found bounds info '" << clang::QualType(CAT, 0) << "' on return value\n");
attachMacro = true;
}
auto dependsOnClass = [](const ParamDecl *fromParam) {
return fromParam->getInterfaceType()->isAnyClassReferenceType();
};
bool returnHasLifetimeInfo = false;
if (getImplicitObjectParamAnnotation<clang::LifetimeBoundAttr>(ClangDecl)) {
DLOG(" Found lifetimebound attribute on implicit 'this'\n");
DLOG("Found lifetimebound attribute on implicit 'this'\n");
if (!dependsOnClass(
MappedDecl->getImplicitSelfDecl(/*createIfNeeded*/ true))) {
printer.printLifetimeboundReturn(SwiftifyInfoPrinter::SELF_PARAM_INDEX,
true);
returnHasLifetimeInfo = true;
} else {
DLOG("lifetimebound ignored because it depends on class with refcount\n");
}
}

Expand All @@ -385,6 +427,8 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,
: getNumParams(ClangDecl);
for (auto [index, clangParam] : llvm::enumerate(ClangDecl->parameters())) {
clang::QualType clangParamTy = clangParam->getType();
DLOG_SCOPE("Checking parameter '" << *clangParam << "' with type '"
<< clangParamTy << "'\n");
int mappedIndex = index < selfParamIndex ? index :
index > selfParamIndex ? index - 1 :
SwiftifyInfoPrinter::SELF_PARAM_INDEX;
Expand All @@ -408,8 +452,7 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,
diag::note_swift_name_instance_method);
} else if (SwiftifiableCAT(clangASTContext, CAT, swiftParamTy)) {
printer.printCountedBy(CAT, mappedIndex);
DLOG(" Found bounds info '" << clangParamTy << "' on parameter '"
<< *clangParam << "'\n");
DLOG("Found bounds info '" << clangParamTy << "'\n");
attachMacro = paramHasBoundsInfo = true;
}
bool paramIsStdSpan =
Expand All @@ -418,13 +461,12 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,

bool paramHasLifetimeInfo = false;
if (clangParam->template hasAttr<clang::NoEscapeAttr>()) {
DLOG(" Found noescape attribute on parameter '" << *clangParam << "'\n");
DLOG("Found noescape attribute\n");
printer.printNonEscaping(mappedIndex);
paramHasLifetimeInfo = true;
}
if (clangParam->template hasAttr<clang::LifetimeBoundAttr>()) {
DLOG(" Found lifetimebound attribute on parameter '" << *clangParam
<< "'\n");
DLOG("Found lifetimebound attribute\n");
if (!dependsOnClass(swiftParam)) {
// If this parameter has bounds info we will tranform it into a Span,
// so then it will no longer be Escapable.
Expand All @@ -435,16 +477,17 @@ static bool swiftifyImpl(ClangImporter::Implementation &Self,
printer.printLifetimeboundReturn(mappedIndex, willBeEscapable);
paramHasLifetimeInfo = true;
returnHasLifetimeInfo = true;
} else {
DLOG("lifetimebound ignored because it depends on class with refcount\n");
}
}
if (paramIsStdSpan && paramHasLifetimeInfo) {
DLOG(" Found both std::span and lifetime info for parameter '"
<< *clangParam << "'\n");
DLOG("Found both std::span and lifetime info\n");
attachMacro = true;
}
}
if (returnIsStdSpan && returnHasLifetimeInfo) {
DLOG(" Found both std::span and lifetime info for return value\n");
DLOG("Found both std::span and lifetime info for return value\n");
attachMacro = true;
}
}
Expand Down Expand Up @@ -501,6 +544,11 @@ void ClangImporter::Implementation::swiftify(AbstractFunctionDecl *MappedDecl) {
if (!ClangDecl)
return;

DLOG_SCOPE(
"Checking '" << *ClangDecl << "' (imported as '"
<< MappedDecl->getName().getBaseName().userFacingName()
<< "')\n");

{
UnaliasedInstantiationVisitor visitor;
visitor.TraverseType(ClangDecl->getType());
Expand All @@ -509,8 +557,10 @@ void ClangImporter::Implementation::swiftify(AbstractFunctionDecl *MappedDecl) {
}

MacroDecl *SwiftifyImportDecl = dyn_cast_or_null<MacroDecl>(getKnownSingleDecl(SwiftContext, "_SwiftifyImport"));
if (!SwiftifyImportDecl)
if (!SwiftifyImportDecl) {
DLOG("_SwiftifyImport macro not found");
return;
}

llvm::SmallString<128> MacroString;
{
Expand All @@ -520,8 +570,10 @@ void ClangImporter::Implementation::swiftify(AbstractFunctionDecl *MappedDecl) {
llvm::StringMap<std::string> typeMapping;
SwiftifyInfoFunctionPrinter printer(getClangASTContext(), SwiftContext, out,
*SwiftifyImportDecl, typeMapping);
if (!swiftifyImpl(*this, printer, MappedDecl, ClangDecl))
if (!swiftifyImpl(*this, printer, MappedDecl, ClangDecl)) {
DLOG("No relevant bounds or lifetime info found\n");
return;
}
printer.printAvailability();
printer.printTypeMapping();
out << ")";
Expand Down Expand Up @@ -557,10 +609,13 @@ void ClangImporter::Implementation::swiftifyProtocol(

MacroDecl *SwiftifyImportDecl = dyn_cast_or_null<MacroDecl>(
getKnownSingleDecl(SwiftContext, "_SwiftifyImportProtocol"));
if (!SwiftifyImportDecl)
if (!SwiftifyImportDecl) {
DLOG("_SwiftifyImportProtocol macro not found");
return;
}

DLOG("Checking " << MappedDecl->getName() << " protocol for methods with bounds and lifetime info\n");
DLOG_SCOPE("Checking '" << MappedDecl->getName()
<< "' protocol for methods with bounds and lifetime info\n");
llvm::SmallString<128> MacroString;
{
llvm::raw_svector_ostream out(MacroString);
Expand All @@ -579,8 +634,10 @@ void ClangImporter::Implementation::swiftifyProtocol(
hasBoundsAttributes |= printer.printMethod(SwiftDecl);
}

if (!hasBoundsAttributes)
if (!hasBoundsAttributes) {
DLOG("No relevant bounds or lifetime info found\n");
return;
}
printer.printAvailability();
printer.printTypeMapping();
out << ")";
Expand Down