.clang-tidy

# Copyright (C) 2023-2024 Advanced Micro Devices, Inc.
# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

# bugprone-unchecked-optional-access was disabled through clang-tidy 17
# (llvm/llvm-project#55530: hung 180s+ on AIEAssignBufferDescriptorIDs.cpp);
# re-enabled since it completes in ~7s under the 20.1.0 pin.
# misc-include-cleaner is excluded, matching LLVM's own .clang-tidy: too
# unreliable on forward-declaration-heavy, template-heavy code.
# clang-analyzer-* is scoped to four suites (Chromium's precedent) rather
# than the full wildcard, which is noisy inside MLIR/LLVM header boilerplate.
# Four sub-checks within those suites are further disabled: they still fire
# on MLIR/LLVM's own internals (StorageUniquerSupport.h, APInt.h, etc., via
# templates instantiated from our code) rather than anything we own, and
# unlike ordinary checks, the static analyzer's diagnostics aren't scoped by
# --header-filter/-line-filter (confirmed: neither suppresses them) nor by
# NOLINT in our own files (the diagnostic's location is inside the vendored
# header, a different file than any NOLINT we could place).
# - StackAddressEscape false-positives on MLIR's StorageUniquerSupport.h
#   lambda-returning helpers.
# - CallAndMessage false-positives in mlir::Value's null-check idiom.
# - BitwiseShift false-positives in llvm::SmallBitVector's bit-packing.
# - cplusplus.NewDelete false-positives in llvm::APInt's inline-vs-heap
#   storage switch.
# readability-identifier-naming is disabled repo-wide for now: expanding
# enforcement to all 102 production files (see git history) surfaced 614
# pre-existing naming violations that aren't safely batch-fixable (clang-tidy
# -fix corrupted shared headers via overlapping cross-TU edits twice), and
# per-site manual review/rename is a separate, much larger effort tracked
# on its own. Re-enable once that renaming pass lands.
# misc-override-with-different-visibility (new in clang-tidy 22) fires on
# every MLIR pass: mlir::Pass declares runOnOperation() protected, and the
# standard MLIR pass idiom is to override it public. That's the codebase's
# convention, not a bug, so the check has no legitimate use here.
# misc-use-internal-linkage and llvm-prefer-static-over-anonymous-namespace
# both went from zero findings (clang-tidy 20.1.0) to 297 findings across 54
# files (clang-tidy 22.1.8), almost entirely on this codebase's dominant
# idiom of a single pass/pattern struct per .cpp file. Unlike llvm-use-ranges
# (fixed in place, same version bump), neither is safely batch-fixable:
# misc-use-internal-linkage offers no fix-it at all for structs/classes
# (confirmed by direct testing -- only free functions get one), and
# llvm-prefer-static-over-anonymous-namespace's fix-it reports as "applied"
# but does not actually rewrite the file. Disabled following the same
# precedent as readability-identifier-naming below: per-site manual fixes
# are a separate, much larger effort tracked on its own.
Checks: >
  -*,
  clang-diagnostic-*,
  llvm-*,
  -llvm-prefer-static-over-anonymous-namespace,
  misc-*,
  -misc-const-correctness,
  -misc-unused-parameters,
  -misc-non-private-member-variables-in-classes,
  -misc-no-recursion,
  -misc-use-anonymous-namespace,
  -misc-use-internal-linkage,
  -misc-include-cleaner,
  -misc-override-with-different-visibility,
  -readability-identifier-naming,
  bugprone-argument-comment,
  bugprone-assert-side-effect,
  bugprone-bitwise-pointer-cast,
  bugprone-branch-clone,
  bugprone-copy-constructor-init,
  bugprone-dangling-handle,
  bugprone-dynamic-static-initializers,
  bugprone-incorrect-enable-shared-from-this,
  bugprone-macro-parentheses,
  bugprone-macro-repeated-side-effects,
  bugprone-misplaced-widening-cast,
  bugprone-move-forwarding-reference,
  bugprone-multiple-statement-macro,
  bugprone-optional-value-conversion,
  bugprone-pointer-arithmetic-on-polymorphic-object,
  bugprone-return-const-ref-from-parameter,
  bugprone-suspicious-semicolon,
  bugprone-suspicious-stringview-data-usage,
  bugprone-swapped-arguments,
  bugprone-terminating-continue,
  bugprone-unchecked-optional-access,
  bugprone-unused-local-non-trivial-variable,
  bugprone-unused-raii,
  bugprone-unused-return-value,
  misc-redundant-expression,
  misc-static-assert,
  misc-unused-using-decls,
  modernize-use-bool-literals,
  modernize-loop-convert,
  modernize-make-unique,
  modernize-raw-string-literal,
  modernize-use-equals-default,
  modernize-use-default-member-init,
  modernize-use-emplace,
  modernize-use-nullptr,
  modernize-use-override,
  modernize-use-using,
  performance-for-range-copy,
  performance-implicit-conversion-in-loop,
  performance-inefficient-algorithm,
  performance-inefficient-vector-operation,
  performance-move-const-arg,
  performance-no-automatic-move,
  performance-trivially-destructible,
  performance-unnecessary-copy-initialization,
  performance-unnecessary-value-param,
  readability-avoid-const-params-in-decls,
  readability-const-return-type,
  readability-container-size-empty,
  readability-inconsistent-declaration-parameter-name,
  readability-misleading-indentation,
  readability-redundant-control-flow,
  readability-redundant-smartptr-get,
  readability-simplify-boolean-expr,
  readability-simplify-subscript-expr,
  readability-use-anyofallof,
  clang-analyzer-core.*,
  -clang-analyzer-core.StackAddressEscape,
  -clang-analyzer-core.CallAndMessage,
  -clang-analyzer-core.BitwiseShift,
  clang-analyzer-cplusplus.*,
  -clang-analyzer-cplusplus.NewDelete,
  clang-analyzer-unix.*,
  clang-analyzer-deadcode.*

CheckOptions:
  # LLVM
  - key:             readability-identifier-naming.ClassCase
    value:           CamelCase
  - key:             readability-identifier-naming.EnumCase
    value:           CamelCase
  - key:             readability-identifier-naming.FunctionCase
    value:           camelBack
  - key:             readability-identifier-naming.FunctionIgnoredRegexp
    value:           "LLVMFuzzerTestOneInput"
  - key:             readability-identifier-naming.UnionCase
    value:           CamelCase
  - key:             readability-identifier-naming.IgnoreMainLikeFunctions
    value:           1
  - key:             readability-redundant-member-init.IgnoreBaseInCopyConstructors
    value:           1
  - key:             modernize-use-default-member-init.UseAssignment
    value:           1
  # MLIR
  - key:             readability-identifier-naming.MemberCase
    value:           camelBack
  - key:             readability-identifier-naming.ParameterCase
    value:           camelBack
  - key:             readability-identifier-naming.VariableCase
    value:           camelBack