This is an archive of the discontinued LLVM Phabricator instance.

[mlir] Move casting calls from methods to function calls
ClosedPublic

Authored by tpopp on May 8 2023, 8:44 AM.

Details

Summary

The MLIR classes Type/Attribute/Operation/Op/Value support
cast/dyn_cast/isa/dyn_cast_or_null functionality through llvm's doCast
functionality in addition to defining methods with the same name.
This change begins the migration of uses of the method to the
corresponding function call as has been decided as more consistent.

Note that there still exist classes that only define methods directly,
such as AffineExpr, and this does not include work currently to support
a functional cast/isa call.

Caveats include:

  • This clang-tidy script probably has more problems.
  • This only touches C++ code, so nothing that is being generated.

Context:

Implementation:
This first patch was created with the following steps. The intention is
to only do automated changes at first, so I waste less time if it's
reverted, and so the first mass change is more clear as an example to
other teams that will need to follow similar steps.

Steps are described per line, as comments are removed by git:
0. Retrieve the change from the following to build clang-tidy with an

additional check:
https://github.com/llvm/llvm-project/compare/main...tpopp:llvm-project:tidy-cast-check
  1. Build clang-tidy
  2. Run clang-tidy over your entire codebase while disabling all checks and enabling the one relevant one. Make sure to save to a .yaml file
  3. Apply all changes
  4. Some changes have been deleted for the following reasons:
    • Some files had a variable also named cast
    • Some files had not included a header file that defines the cast functions
    • Some files are definitions of the classes that have the casting methods, so the code still refers to the method instead of the function without adding a prefix or removing the method declaration at the same time.
ninja clang-tidy

run-clang-tidy -clang-tidy-binary=$PWD/bin/clang-tidy -checks='-*,misc-cast-functions'\
                 -export-fixes /tmp/cast/casts.yaml mlir/*

./bin/clang-apply-replacements /tmp/cast/

git restore mlir/lib/IR mlir/lib/Dialect/DLTI/DLTI.cpp\
            mlir/lib/Dialect/Complex/IR/ComplexDialect.cpp\
            mlir/lib/**/IR/\
            mlir/lib/Dialect/SparseTensor/Transforms/SparseVectorization.cpp\
            mlir/lib/Dialect/Vector/Transforms/LowerVectorMultiReduction.cpp\
            mlir/test/lib/Dialect/Test/TestTypes.cpp\
            mlir/test/lib/Dialect/Transform/TestTransformDialectExtension.cpp\
            mlir/test/lib/Dialect/Test/TestAttributes.cpp\
            mlir/unittests/TableGen/EnumsGenTest.cpp\
            mlir/test/python/lib/PythonTestCAPI.cpp

Diff Detail

Event Timeline

tpopp created this revision.May 8 2023, 8:44 AM
tpopp requested review of this revision.May 8 2023, 8:44 AM
tpopp added a comment.May 8 2023, 8:48 AM

To be honest, I just wanted to play around with AST matchers and took this deprecation as an example, so please feel free to block this change permanently, until all code is updated at the same time, etc. I can also do one commit per class, etc. I won't be hurt if I have to do more work, as I was doing this for fun.

tpopp updated this revision to Diff 521312.May 11 2023, 7:46 AM

Also refactor header files

I'm +1 on this change for sure :) Any chance you could also do dyn_cast_or_null -> dyn_cast_if_present in that AST matcher?

rriddle accepted this revision.May 12 2023, 1:54 AM
This revision is now accepted and ready to land.May 12 2023, 1:54 AM
tpopp added a comment.May 12 2023, 2:05 AM

I'm +1 on this change for sure :) Any chance you could also do dyn_cast_or_null -> dyn_cast_if_present in that AST matcher?

Assuming the rebases go smoothly, I will do this as a follow up in MLIR instead, but I will update the code at https://github.com/llvm/llvm-project/compare/main...tpopp:llvm-project:tidy-cast-check to also do this transformation, so others benefit when updating their own codebase.

This revision was landed with ongoing or failed builds.May 12 2023, 2:52 AM
This revision was automatically updated to reflect the committed changes.

Assuming the rebases go smoothly, I will do this as a follow up in MLIR instead, but I will update the code at https://github.com/llvm/llvm-project/compare/main...tpopp:llvm-project:tidy-cast-check to also do this transformation, so others benefit when updating their own codebase.

Awesome!