Merge branch 'main' into ci-fix-dead-docker-prune

Author: hunhoffe

.clang-tidy

@@ -1,6 +1,32 @@
 # 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.
 Checks: >
   -*,
   clang-diagnostic-*,
@@ -11,22 +37,30 @@ Checks: >
   -misc-non-private-member-variables-in-classes,
   -misc-no-recursion,
   -misc-use-anonymous-namespace,
-  readability-identifier-naming,
-  -misc-const-correctness,
+  -misc-include-cleaner,
+  -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,
@@ -60,7 +94,15 @@ Checks: >
   readability-redundant-smartptr-get,
   readability-simplify-boolean-expr,
   readability-simplify-subscript-expr,
-  readability-use-anyofallof
+  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
@@ -72,14 +114,8 @@ CheckOptions:
     value:           camelBack
   - key:             readability-identifier-naming.FunctionIgnoredRegexp
     value:           "LLVMFuzzerTestOneInput"
-  - key:             readability-identifier-naming.MemberCase
-    value:           CamelCase
-  - key:             readability-identifier-naming.ParameterCase
-    value:           CamelCase
   - key:             readability-identifier-naming.UnionCase
     value:           CamelCase
-  - key:             readability-identifier-naming.VariableCase
-    value:           CamelCase
   - key:             readability-identifier-naming.IgnoreMainLikeFunctions
     value:           1
   - key:             readability-redundant-member-init.IgnoreBaseInCopyConstructors

.github/PULL_REQUEST_TEMPLATE.md

@@ -11,3 +11,4 @@
 - [ ] Docs / docstrings updated if the change is user-facing
 - [ ] Code is formatted (`clang-format` for C++, `black` for Python — see [CONTRIBUTING](../CONTRIBUTING.md))
 - [ ] `ruff check` and `pyright` pass locally for any touched Python file in their covered paths (see [CONTRIBUTING](../CONTRIBUTING.md#linting-python))
+- [ ] `clang-tidy` passes locally for any touched file on the enabled list (see [CONTRIBUTING](../CONTRIBUTING.md#static-analysis-for-c-clang-tidy))

.github/workflows/lintAndFormat.yml

@@ -39,10 +39,10 @@ jobs:
           fetch-depth: 2
           submodules: "true"
 
-      - name: Install clang-tidy
+      - name: Install C/C++ toolchain
         run: |
           sudo apt-get update
-          sudo apt-get install -y clang-tidy ninja-build clang libelf-dev
+          sudo apt-get install -y ninja-build clang libelf-dev
 
       - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6
         with:
@@ -57,6 +57,9 @@ jobs:
               --requirements python/requirements.txt \
               --install-non-eudsl
           python -m pip install --require-hashes -r python/requirements_dev.lock
+          # clang-tidy comes from this lockfile (see python/requirements_dev.txt),
+          # pinned to match clang-format's pin below -- not a system apt package,
+          # so its version doesn't silently drift across CI runs.
 
       - name: Get MLIR
         id: mlir-wheels
@@ -95,16 +98,40 @@ jobs:
             -DLLVM_EXTERNAL_LIT=$(which lit) \
             -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 
-          # aie-headers only aggregates the dialect/op/type tablegen targets;
-          # it does not pull in the Conversion pass enum header or the vendored
-          # xaiengine/*.h headers copied from third_party/aie-rt. Without these,
-          # clang-tidy fails to compile any touched file that includes
-          # aie/Conversion/Passes.h (e.g. lib/Conversion/**) or xaiengine/*.h
-          # (e.g. lib/Targets/AIERT.cpp) with a file-not-found error instead of
-          # a real lint finding.
+          # Pass/op tablegen targets not covered by aie-headers/mlir-headers --
+          # needed so clang-tidy (below) can parse pass source files
+          # that include generated headers. Extend this
+          # list as the clang-tidy file set (see the "clang-tidy" step below)
+          # grows into dialects/passes with their own IncGen targets.
+          #   MLIRAIEPassIncGen             -> AIEPasses.h.inc
+          #   MLIRAIEXPassIncGen            -> AIEXPasses.h.inc
+          #   MLIRAIEVecPassIncGen          -> AIEVec Transforms/Passes.h.inc
+          #   MLIRAIEVecAnalysisPassIncGen  -> AIEVec Analysis/Passes.h.inc
+          #   MLIRAIEVecTransformOpsIncGen  -> AIEVecTransformOps.h.inc
+          #   MLIRAIEConversionPassIncGen   -> Conversion Passes.h.inc,
+          #                                    PassesEnums.h.inc
+          #   MLIRXLLVMOpsIncGen            -> XLLVMOps.h.inc
+          #   MLIRXLLVMConversionsIncGen    -> XLLVMConversions.inc
+          #   MLIRAIEVecAttributesIncGen    -> AIEVecEnums.h.inc,
+          #                                    AIEVecAttributes.h.inc
+          #   MLIRAIENormalizeAddressSpacesIncGen -> AIENormalizeAddressSpaces.inc
+          #   xaienginecdo_static-headers   -> vendored xaiengine/*.h used by
+          #                                    the CDO backend (AIETargets,
+          #                                    AIEToConfiguration)
+          #   aiecc_version                 -> aiecc/AIECCVersion.h
           ninja aie-headers mlir-headers \
+            MLIRAIEPassIncGen \
+            MLIRAIEXPassIncGen \
+            MLIRAIEVecPassIncGen \
+            MLIRAIEVecAnalysisPassIncGen \
+            MLIRAIEVecTransformOpsIncGen \
             MLIRAIEConversionPassIncGen \
-            xaienginecdo_static-headers
+            MLIRXLLVMOpsIncGen \
+            MLIRXLLVMConversionsIncGen \
+            MLIRAIEVecAttributesIncGen \
+            MLIRAIENormalizeAddressSpacesIncGen \
+            xaienginecdo_static-headers \
+            aiecc_version
 
           # Assemble the Python package sources (hand-written + tablegen'd op/enum
           # wrappers) into build/python/aie. This needs only tablegen, not a full
@@ -141,21 +168,145 @@ jobs:
       - name: Lint Python (ruff)
         run: ruff check
 
-      - name: Analyze
-        id: clang-tidy-fixes
+      - name: Lint C/C++ (clang-tidy)
         run: |
+          # Currently-enabled file(s) -- keep this in sync with the `files:`
+          # regex on the `clang-tidy` pre-commit hook (.pre-commit-config.yaml),
+          # same convention ruff-check's hook uses to stay in sync with
+          # ruff.toml's `include`. Grows one file at a time.
+          #
+          # Unlike pyright/ruff (which always check their whole configured
+          # set), this only checks enabled files that this PR actually
+          # touched -- as the enabled list grows, most PRs don't touch C++
+          # passes at all, and re-linting the full set on every push would be
+          # wasted time. A PR that doesn't touch any enabled file passes
+          # trivially; one that does gets that file fully re-checked (not
+          # just the changed lines).
+          CLANG_TIDY_FILES=(
+            lib/CAPI/Dialects.cpp
+            lib/CAPI/Registration.cpp
+            lib/CAPI/TargetModel.cpp
+            lib/CAPI/Translation.cpp
+            lib/Conversion/AIEToConfiguration/AIEToConfiguration.cpp
+            lib/Conversion/AIEVecToLLVM/AIEVecToLLVM.cpp
+            lib/Conversion/AIEXToEmitC/AIEXToEmitC.cpp
+            lib/Dialect/AIE/IR/AIEDialect.cpp
+            lib/Dialect/AIE/IR/AIETargetModel.cpp
+            lib/Dialect/AIE/IR/AIETraceOps.cpp
+            lib/Dialect/AIE/Transforms/AIEAssignBufferDescriptorIDs.cpp
+            lib/Dialect/AIE/Transforms/AIEAssignBuffers.cpp
+            lib/Dialect/AIE/Transforms/AIEAssignCoreLinkFiles.cpp
+            lib/Dialect/AIE/Transforms/AIEAssignLockIDs.cpp
+            lib/Dialect/AIE/Transforms/AIECanonicalizeDevice.cpp
+            lib/Dialect/AIE/Transforms/AIECoreToStandard.cpp
+            lib/Dialect/AIE/Transforms/AIECreatePathFindFlows.cpp
+            lib/Dialect/AIE/Transforms/AIEFindFlows.cpp
+            lib/Dialect/AIE/Transforms/AIEGenerateColumnControlOverlay.cpp
+            lib/Dialect/AIE/Transforms/AIEHoistVectorTransferPointers.cpp
+            lib/Dialect/AIE/Transforms/AIEInsertTraceFlows.cpp
+            lib/Dialect/AIE/Transforms/AIELocalizeLocks.cpp
+            lib/Dialect/AIE/Transforms/AIELowerCascadeFlows.cpp
+            lib/Dialect/AIE/Transforms/AIENormalizeAddressSpaces.cpp
+            lib/Dialect/AIE/Transforms/AIEObjectFifoLiveness.cpp
+            lib/Dialect/AIE/Transforms/AIEObjectFifoStatefulTransform.cpp
+            lib/Dialect/AIE/Transforms/AIEPathFinder.cpp
+            lib/Dialect/AIE/Transforms/AIEPlacer.cpp
+            lib/Dialect/AIE/Transforms/AIEPlaceTiles.cpp
+            lib/Dialect/AIE/Transforms/AIESAPlacer.cpp
+            lib/Dialect/AIE/Transforms/AIETraceToConfig.cpp
+            lib/Dialect/AIE/Transforms/AIEVectorToPointerLoops.cpp
+            lib/Dialect/AIE/Transforms/AIEVectorTransferLowering.cpp
+            lib/Dialect/AIE/Util/AIERegisterDatabase.cpp
+            lib/Dialect/AIEVec/IR/AIE1/AIEVecAIE1Ops.cpp
+            lib/Dialect/AIEVec/IR/AIEVecOps.cpp
+            lib/Dialect/AIEVec/IR/AIEVecTypes.cpp
+            lib/Dialect/AIEVec/TransformOps/AIEVecTransformOps.cpp
+            lib/Dialect/AIEVec/TransformOps/DialectExtension.cpp
+            lib/Dialect/AIEVec/Transforms/AIEVecOptimizations.cpp
+            lib/Dialect/AIEVec/Transforms/ConvertVectorToAIEVec.cpp
+            lib/Dialect/AIEVec/Transforms/CopyRemoval.cpp
+            lib/Dialect/AIEVec/Transforms/DynamicSizeNoImplicitBroadcast.cpp
+            lib/Dialect/AIEVec/Transforms/FoldMulAddChainToConvOp.cpp
+            lib/Dialect/AIEVec/Transforms/SplitVectorLoadUpsChains.cpp
+            lib/Dialect/AIEVec/Transforms/VectorToAIEVecConversions.cpp
+            lib/Dialect/AIEVec/Transforms/VectorToVectorConversions.cpp
+            lib/Dialect/AIEVec/Utils/Utils.cpp
+            lib/Dialect/AIEX/IR/AIEXDialect.cpp
+            lib/Dialect/AIEX/IR/DmaDecomposition.cpp
+            lib/Dialect/AIEX/Transforms/AIEAssignRuntimeSequenceBDIDs.cpp
+            lib/Dialect/AIEX/Transforms/AIECreateBroadcastPacket.cpp
+            lib/Dialect/AIEX/Transforms/AIECreateCores.cpp
+            lib/Dialect/AIEX/Transforms/AIECreateLocks.cpp
+            lib/Dialect/AIEX/Transforms/AIECtrlPacketToDma.cpp
+            lib/Dialect/AIEX/Transforms/AIEDecomposeLargeDmaBd.cpp
+            lib/Dialect/AIEX/Transforms/AIEDMATasksToNPU.cpp
+            lib/Dialect/AIEX/Transforms/AIEDmaToNpu.cpp
+            lib/Dialect/AIEX/Transforms/AIEExpandLoadPdi.cpp
+            lib/Dialect/AIEX/Transforms/AIEInlineTraceConfig.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerCoreReset.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerDmaChannelReset.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerDynamicBDPool.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerMemcpy.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerMulticast.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerScratchpadParameters.cpp
+            lib/Dialect/AIEX/Transforms/AIELowerSetLock.cpp
+            lib/Dialect/AIEX/Transforms/AIEMaterializeBDChains.cpp
+            lib/Dialect/AIEX/Transforms/AIEMaterializeRuntimeSequences.cpp
+            lib/Dialect/AIEX/Transforms/AIENpuToCert.cpp
+            lib/Dialect/AIEX/Transforms/AIESCFToControlFlow.cpp
+            lib/Dialect/AIEX/Transforms/AIESubstituteShimDMAAllocations.cpp
+            lib/Dialect/AIEX/Transforms/AIETransformBfpTypes.cpp
+            lib/Dialect/AIEX/Transforms/AIETxnToControlPacket.cpp
+            lib/Dialect/AIEX/Transforms/AIEUnrollRuntimeSequenceLoops.cpp
+            lib/Dialect/AIEX/Transforms/AIEVerifyRuntimeRearm.cpp
+            lib/Dialect/AIEX/Transforms/AIEXToStandard.cpp
+            lib/Dialect/AIEX/Utils/AIETokenAnalysis.cpp
+            lib/Dialect/AIEX/Utils/AIEUtils.cpp
+            lib/Dialect/AIEX/Utils/BdLowering.cpp
+            lib/Dialect/XLLVM/XLLVMOps.cpp
+            lib/Target/LLVMIR/Dialect/XLLVM/XLLVMToLLVMIRTranslation.cpp
+            lib/Targets/AIEFlowsToJSON.cpp
+            lib/Targets/AIELLVMLink.cpp
+            lib/Targets/AIERT.cpp
+            lib/Targets/AIETargetBCF.cpp
+            lib/Targets/AIETargetCDODirect.cpp
+            lib/Targets/AIETargetCppTxn.cpp
+            lib/Targets/AIETargetLdScript.cpp
+            lib/Targets/AIETargetNPU.cpp
+            lib/Targets/AIETargets.cpp
+            lib/Targets/AIETargetShared.cpp
+            lib/Targets/AIETargetSimulationFiles.cpp
+            lib/Targets/AIETargetUcCert.cpp
+            lib/Targets/AIETargetXAIEV2.cpp
+            tools/aiecc/aiecc.cpp
+            tools/aie-lsp-server/aie-lsp-server.cpp
+            tools/aie-opt/aie-opt.cpp
+            tools/aie-reset/aie-reset.cpp
+            tools/aie-translate/aie-translate.cpp
+            tools/aie-visualize/aie-visualize.cpp
+            tools/bootgen/bootgen_c_api.cpp
+          )
+
           git fetch origin main
-          git diff -U0 origin/main | clang-tidy-diff -p1 -path build -export-fixes fixes.yml
-          if [ -f fixes.yml ]; then
-            echo "FIXES=true" | tee $GITHUB_OUTPUT
+          mapfile -t changed < <(git diff --name-only origin/main HEAD)
+
+          to_check=()
+          for f in "${CLANG_TIDY_FILES[@]}"; do
+            for c in "${changed[@]}"; do
+              if [ "$f" = "$c" ]; then
+                to_check+=("$f")
+                break
+              fi
+            done
+          done
+
+          if [ "${#to_check[@]}" -eq 0 ]; then
+            echo "No enabled clang-tidy file changed in this PR -- skipping."
+            exit 0
           fi
 
-      - name: Upload clang-tidy fixes
-        if: ${{ steps.clang-tidy-fixes.outputs.FIXES }}
-        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7
-        with:
-          path: fixes.yml
-          name: clang-tidy-fixes.yml
+          echo "Running clang-tidy on: ${to_check[*]}"
+          MLIR_AIE_BUILD_DIR="$PWD/build" utils/run_clang_tidy.sh "${to_check[@]}"
 
 
   formatting:
@@ -178,7 +329,7 @@ jobs:
       - name: Install clang-format
         uses: aminya/setup-cpp@8170d66c458f4a045220b7b0966c10940bb2a15d  # v1.8.1
         with:
-          clangformat: 17.0.1
+          clangformat: 20.1.0
 
       - name: Setup Python env
         uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1  # v6