Minor cleanup

Author: devajithvs

mlir/lib/Tools/mlir-query/Diagnostics.h

@@ -10,8 +10,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_CLANG_ASTMATCHERS_DYNAMIC_DIAGNOSTICS_H
-#define LLVM_CLANG_ASTMATCHERS_DYNAMIC_DIAGNOSTICS_H
+#ifndef MLIR_TOOLS_MLIRQUERY_MATCHERS_DIAGNOSTICS_H
+#define MLIR_TOOLS_MLIRQUERY_MATCHERS_DIAGNOSTICS_H
 
 #include "VariantValue.h"
 #include "llvm/ADT/ArrayRef.h"
@@ -177,4 +177,4 @@ class Diagnostics {
 } // namespace query
 } // namespace mlir
 
-#endif // LLVM_CLANG_ASTMATCHERS_DYNAMIC_DIAGNOSTICS_H
+#endif // MLIR_TOOLS_MLIRQUERY_MATCHERS_DIAGNOSTICS_H

mlir/lib/Tools/mlir-query/ExtraMatchers.h

@@ -8,7 +8,21 @@
 //
 // This file provides extra matchers that are very useful for mlir-query. The
 // goal is to move this to include/mlir/IR/Matchers.h after the initial testing
-// phase.
+// phase. The matchers in this file are:
+//
+// - operation(args...): Matches an operation that matches all of the matchers
+// in the vector `matchers`.
+//
+// - argument(innerMatcher, index): Matches an operation argument that matches
+// `innerMatcher` at the given `index`.
+//
+// - usedBy(innerMatcher, hops, inclusive): Matches an operation that is used by
+// an operation that matches `innerMatcher` `hops` hops away. If `inclusive` is
+// true, also matches operations upto `hops` away.
+//
+// - definedBy(innerMatcher, hops, inclusive): Matches an operation that is
+// defined by an operation that matches `innerMatcher` `hops` hops away. If
+// `inclusive` is true, also matches operations upto `hops` away.
 //
 //===----------------------------------------------------------------------===//
 
@@ -24,7 +38,9 @@ namespace query {
 namespace extramatcher {
 
 namespace detail {
-// VariadicMatcher takes a vector of DynMatchers and returns true if all
+
+// TODO: Rename to AllOf
+// OperationMatcher takes a vector of DynMatchers and returns true if all
 // DynMatchers match the given operation.
 struct OperationMatcher {
   OperationMatcher(std::vector<matcher::DynMatcher> matchers)
@@ -38,6 +54,7 @@ struct OperationMatcher {
   std::vector<matcher::DynMatcher> matchers;
 };
 
+// ArgumentMatcher matches the operand of an operation at a specific index.
 struct ArgumentMatcher {
   ArgumentMatcher(matcher::DynMatcher innerMatcher, unsigned index)
       : innerMatcher(innerMatcher), index(index) {}
@@ -57,6 +74,9 @@ struct ArgumentMatcher {
   unsigned index;
 };
 
+// This matcher checks if an operation is used by another operation that matches
+// the given inner matcher. It allows specifying the number of hops to follow in
+// the use-def chain, and whether the chain should be inclusive or not.
 struct UsedByMatcher {
   UsedByMatcher(matcher::DynMatcher innerMatcher, unsigned hops, bool inclusive)
       : innerMatcher(innerMatcher), hops(hops), inclusive(inclusive) {}
@@ -90,6 +110,10 @@ struct UsedByMatcher {
   bool inclusive;
 };
 
+// This matcher checks if an operation is defined by another operation that
+// matches the given inner matcher. It allows specifying the number of hops to
+// follow in the def-use chain, and whether the chain should be inclusive or
+// not.
 struct DefinedByMatcher {
   DefinedByMatcher(matcher::DynMatcher innerMatcher, unsigned hops,
                    bool inclusive)
@@ -121,6 +145,7 @@ struct DefinedByMatcher {
 
 } // namespace detail
 
+// TODO: Rename to allOf()
 inline detail::OperationMatcher operation(matcher::DynMatcher args...) {
   std::vector<matcher::DynMatcher> matchers({args});
   return detail::OperationMatcher(matchers);

mlir/lib/Tools/mlir-query/MLIRTypeTraits.h

@@ -22,10 +22,8 @@ namespace mlir {
 namespace query {
 namespace matcher {
 
-/// MLIRNodeKind identifier.
-/// It can be constructed from any node kind and allows for runtime type
-/// hierarchy checks.
-/// Use getFromNodeKind<T>() to construct them.
+// MLIRNodeKind can be constructed from any node kind and allows for runtime type
+// hierarchy checks. Use getFromNodeKind<T>() to construct them.
 class MLIRNodeKind {
 public:
   // Empty identifier. It matches nothing.
@@ -53,8 +51,8 @@ class MLIRNodeKind {
   // Use getFromNodeKind<T>() to construct the kind.
   constexpr MLIRNodeKind(NodeKindId KindId) : KindId(KindId) {}
 
-  /// Helper meta-function to convert a kind T to its enum value.
-  /// This struct is specialized below for all known kinds.
+  // Helper meta-function to convert a kind T to its enum value.
+  // This struct is specialized below for all known kinds.
   template <class T>
   struct KindToKindId {
     static const NodeKindId Id = NKI_None;
@@ -70,21 +68,21 @@ struct MLIRNodeKind::KindToKindId<Operation *> {
   static const NodeKindId Id = NKI_Operation;
 };
 
-/// A dynamically typed MLIR node container.
-///
-/// Stores an MLIR node in a type safe way. This allows writing code that
-/// works with different kinds of MLIR nodes, despite the fact that they don't
-/// have a common base class.
-///
-/// Use create(Node) to create a DynTypedNode from an MLIR node,
-/// and get<T>() to retrieve the node as type T if the types match.
-///
-/// See MLIRNodeKind for which node base types are currently supported;
-/// You can create DynTypedNodes for all nodes in the inheritance hierarchy of
-/// the supported base types.
+// A dynamically typed MLIR node container.
+//
+// Stores an MLIR node in a type safe way. This allows writing code that
+// works with different kinds of MLIR nodes, despite the fact that they don't
+// have a common base class.
+//
+// Use create(Node) to create a DynTypedNode from an MLIR node,
+// and get<T>() to retrieve the node as type T if the types match.
+//
+// See MLIRNodeKind for which node base types are currently supported;
+// You can create DynTypedNodes for all nodes in the inheritance hierarchy of
+// the supported base types.
 class DynTypedNode {
 public:
-  /// Creates a \c DynTypedNode from \c Node.
+  // Creates a DynTypedNode from Node.
   template <typename T>
   static DynTypedNode create(T &Node) {
     return BaseConverter<T>::create(Node);

mlir/lib/Tools/mlir-query/Marshallers.h

@@ -18,10 +18,6 @@
 #ifndef MLIR_TOOLS_MLIRQUERY_MATCHERS_MARSHALLERS_H
 #define MLIR_TOOLS_MLIRQUERY_MATCHERS_MARSHALLERS_H
 
-#include <list>
-#include <string>
-#include <vector>
-
 #include "MatchersInternal.h"
 #include "VariantValue.h"
 #include "mlir/IR/Matchers.h"
@@ -88,7 +84,7 @@ class MatcherCreateCallback {
 public:
   virtual ~MatcherCreateCallback() = default;
   virtual DynMatcher *run(const SourceRange &NameRange,
-                          ArrayRef<ParserValue> Args,
+                          const ArrayRef<ParserValue> &Args,
                           Diagnostics *Error) const = 0;
 };
 
@@ -104,7 +100,7 @@ class FixedArgCountMatcherCreateCallback : public MatcherCreateCallback {
                                      StringRef MatcherName)
       : Marshaller(Marshaller), Func(Func), MatcherName(MatcherName) {}
 
-  DynMatcher *run(const SourceRange &NameRange, ArrayRef<ParserValue> Args,
+  DynMatcher *run(const SourceRange &NameRange, const ArrayRef<ParserValue> &Args,
                   Diagnostics *Error) const override {
     return Marshaller(Func, MatcherName, NameRange, Args, Error);
   }
@@ -124,16 +120,16 @@ class VariadicMatcherCreateCallback : public MatcherCreateCallback {
 
   typedef DynMatcher DerivedMatcherType;
 
-  DynMatcher *run(const SourceRange &NameRange, ArrayRef<ParserValue> Args,
+  DynMatcher *run(const SourceRange &NameRange, const ArrayRef<ParserValue> &Args,
                   Diagnostics *Error) const override {
     std::vector<DerivedMatcherType> References;
     std::vector<const DerivedMatcherType *> InnerArgs(Args.size());
-    for (size_t i = 0, e = Args.size(); i != e; ++i) {
+    for (std::size_t i = 0, e = Args.size(); i != e; ++i) {
 
       if (!ArgTypeTraits<DerivedMatcherType>::is(Args[i].Value)) {
         Error->addError(Args[i].Range, Error->ET_RegistryWrongArgType)
             << MatcherName << i + 1;
-        return NULL;
+        return nullptr;
       }
       References.push_back(
           ArgTypeTraits<DerivedMatcherType>::get(Args[i].Value));
@@ -170,7 +166,7 @@ DynMatcher *matcherMarshall0(ReturnType (*Func)(), StringRef MatcherName,
   if (Args.size() != 0) {
     Error->addError(NameRange, Error->ET_RegistryWrongArgCount)
         << 0 << Args.size();
-    return NULL;
+    return nullptr;
   }
   ReturnType matcherFn = Func();
   MatcherInterface<T> *singleMatcher =
@@ -189,12 +185,12 @@ DynMatcher *matcherMarshall1(ReturnType (*Func)(InArgType1),
   if (Args.size() != 1) {
     Error->addError(NameRange, Error->ET_RegistryWrongArgCount)
         << 1 << Args.size();
-    return NULL;
+    return nullptr;
   }
   if (!ArgTypeTraits<ArgType1>::is(Args[0].Value)) {
     Error->addError(Args[0].Range, Error->ET_RegistryWrongArgType)
         << MatcherName << 1;
-    return NULL;
+    return nullptr;
   }
   ReturnType matcherFn = Func(ArgTypeTraits<ArgType1>::get(Args[0].Value));
   MatcherInterface<T> *singleMatcher =
@@ -215,17 +211,17 @@ DynMatcher *matcherMarshall1(ReturnType (*Func)(InArgType1, InArgType2),
   if (Args.size() != 2) {
     Error->addError(NameRange, Error->ET_RegistryWrongArgCount)
         << 1 << Args.size();
-    return NULL;
+    return nullptr;
   }
   if (!ArgTypeTraits<ArgType1>::is(Args[0].Value)) {
     Error->addError(Args[0].Range, Error->ET_RegistryWrongArgType)
         << MatcherName << 1;
-    return NULL;
+    return nullptr;
   }
   if (!ArgTypeTraits<ArgType2>::is(Args[1].Value)) {
     Error->addError(Args[1].Range, Error->ET_RegistryWrongArgType)
         << MatcherName << 1;
-    return NULL;
+    return nullptr;
   }
   ReturnType matcherFn = Func(ArgTypeTraits<ArgType1>::get(Args[0].Value),
                               ArgTypeTraits<ArgType2>::get(Args[1].Value));