mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
99faa033fc
By convention, most structs and classes in the Swift compiler include a `dump()` method which prints debugging information. This method is meant to be called only from the debugger, but this means they’re often unused and may be eliminated from optimized binaries. On the other hand, some parts of the compiler call `dump()` methods directly despite them being intended as a pure debugging aid. clang supports attributes which can be used to avoid these problems, but they’re used very inconsistently across the compiler. This commit adds `SWIFT_DEBUG_DUMP` and `SWIFT_DEBUG_DUMPER(<name>(<params>))` macros to declare `dump()` methods with the appropriate set of attributes and adopts this macro throughout the frontend. It does not pervasively adopt this macro in SILGen, SILOptimizer, or IRGen; these components use `dump()` methods in a different way where they’re frequently called from debugging code. Nor does it adopt it in runtime components like swiftRuntime and swiftReflection, because I’m a bit worried about size. Despite the large number of files and lines affected, this change is NFC.
40 lines
1.5 KiB
C++
40 lines
1.5 KiB
C++
//===--- Debug.h - Compiler debugging helpers -------------------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SWIFT_BASIC_DEBUG_H
|
|
#define SWIFT_BASIC_DEBUG_H
|
|
|
|
#include "llvm/Support/Compiler.h"
|
|
|
|
|
|
/// Adds attributes to the provided method signature indicating that it is a
|
|
/// debugging helper that should never be called directly from compiler code.
|
|
/// This deprecates the method so it won't be called directly and marks it as
|
|
/// used so it won't be eliminated as dead code.
|
|
#define SWIFT_DEBUG_HELPER(method) \
|
|
LLVM_ATTRIBUTE_DEPRECATED(method LLVM_ATTRIBUTE_USED, \
|
|
"only for use in the debugger")
|
|
|
|
/// Declares a const void instance method with the name and parameters provided.
|
|
/// Methods declared with this macro should never be called except in the
|
|
/// debugger.
|
|
#define SWIFT_DEBUG_DUMPER(nameAndParams) \
|
|
SWIFT_DEBUG_HELPER(void nameAndParams const)
|
|
|
|
/// Declares an instance `void dump() const` method. Methods declared with this
|
|
/// macro should never be called except in the debugger.
|
|
#define SWIFT_DEBUG_DUMP \
|
|
SWIFT_DEBUG_DUMPER(dump())
|
|
|
|
#endif
|
|
|
|
|