[GitHub] [tvm] zackcquic commented on a change in pull request #7952: [IR][Pass][Instrument] Pass instrument framework

[GitBox <gi...@apache.org>]

zackcquic commented on a change in pull request #7952:
URL: https://github.com/apache/tvm/pull/7952#discussion_r631669510



##########
File path: include/tvm/ir/instrument.h
##########
@@ -0,0 +1,244 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*!
+ * \file tvm/ir/instrument.h
+ *
+ * This file implements a pass instrument infrastructure, inspired from LLVM and MLIR.
+ * It inserts instrumentation points between passes run.
+ *
+ * Within a pass context (tvm::transfom::PassContext), the instrumentation call sequence will like:
+ *
+ *   Instrument SetUp
+ *
+ *     if (Instrument Before Pass)
+ *       Pass Run
+ *       Instrument After Pass
+ *
+ *     if (Instrument Before Pass)
+ *       Pass Run
+ *       Instrument After Pass
+ *
+ *   Instrument TearDown
+ *
+ *
+ * Instrument point before pass can determine particular pass is disable or not depends on the
+ * callback registered.
+ */
+#ifndef TVM_IR_INSTRUMENT_H_
+#define TVM_IR_INSTRUMENT_H_
+
+#include <tvm/node/reflection.h>
+#include <tvm/runtime/container.h>
+
+#include <utility>
+#include <vector>
+
+namespace tvm {
+
+class IRModule;
+
+// Forward class for PassInstrumentNode methods
+namespace transform {
+class PassInfo;
+}  // namespace transform
+
+namespace instrument {
+
+/*!
+ * \brief A callback type for set up or clean up instrument environment.
+ */
+using InstrumentEnvFunc = runtime::TypedPackedFunc<void()>;
+
+/*!
+ * \brief A callback template for instrumenting before/after environment.
+ * \tparam RetTy the return type of callback.
+ */
+template <typename RetTy = void>
+using PassInstrumentFunc =
+    runtime::TypedPackedFunc<RetTy(const IRModule&, const transform::PassInfo&)>;
+
+/*!
+ * \brief PassInstrumentNode forms an instrument implementation.
+ * It provides API for users to register callbacks at different instrument point.
+ * \sa PassInstrument
+ */
+class PassInstrumentNode : public Object {
+ public:

Review comment:
       Do you mean making PassInstrument a virtual class? I agree with it. 
   
   Currently, PassInstrumentor and PassInstrument have different meanings, they don't have inheritance relationship.
   
   PassInstrumentor will collect a set of instrument implementations (PassInstrument), usage is like: [test_pass_instrument.py#L140](https://github.com/zackcquic/tvm/blob/0ad48d4f1e04f048bbae12daaec1cc100db458cd/tests/python/relay/test_pass_instrument.py#L140)
   
   Do you think it's ok?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org