zackcquic commented on a change in pull request #7952: URL: https://github.com/apache/tvm/pull/7952#discussion_r637520285
########## File path: include/tvm/ir/instrument.h ########## @@ -0,0 +1,127 @@ +/* + * 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 introduces a pass instrument infrastructure, inspired by LLVM and MLIR. + * It inserts instrumentation points around passes. + */ +#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 PassInstrumentNode forms an instrument implementation. + * It provides API for users to register callbacks at different instrumentation points. + * + * Within a pass context (tvm::transfom::PassContext), the instrumentation call sequence will like: + * + * Instrument SetUp() + * + * if (Instrument Before Pass()) + * Pass1() + * Instrument After Pass() + * + * if (Instrument Before Pass()) + * Pass2() + * Instrument After Pass() + * + * Instrument TearDown() + * + * + * The `Before Pass` instrumentation point can selectively disable passes by returning true (to + * enable) or false (to disable). + * + * If there are multiple pass instrumentations provided, `Before Pass` callbacks are applied in + * order. If one return false, then the pass will be skipped: + * + * for (auto pi : PassInstruments) + * if (pi->BeforePass()) + * return False // Disable pass + * + * return True // All ok, enable pass + * + * + * \sa PassInstrument + * \sa PassContextNode::InstrumentBeforePass() + * \sa src/ir/transform.cc + */ +class PassInstrumentNode : public Object { + public: + virtual ~PassInstrumentNode() {} + + /*! \brief Set up environment for instrumentation. */ Review comment: Done ########## File path: include/tvm/ir/instrument.h ########## @@ -0,0 +1,127 @@ +/* + * 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 introduces a pass instrument infrastructure, inspired by LLVM and MLIR. + * It inserts instrumentation points around passes. + */ +#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 PassInstrumentNode forms an instrument implementation. + * It provides API for users to register callbacks at different instrumentation points. + * + * Within a pass context (tvm::transfom::PassContext), the instrumentation call sequence will like: + * + * Instrument SetUp() + * + * if (Instrument Before Pass()) + * Pass1() + * Instrument After Pass() + * + * if (Instrument Before Pass()) + * Pass2() + * Instrument After Pass() + * + * Instrument TearDown() + * + * + * The `Before Pass` instrumentation point can selectively disable passes by returning true (to + * enable) or false (to disable). + * + * If there are multiple pass instrumentations provided, `Before Pass` callbacks are applied in + * order. If one return false, then the pass will be skipped: + * + * for (auto pi : PassInstruments) + * if (pi->BeforePass()) + * return False // Disable pass + * + * return True // All ok, enable pass + * + * + * \sa PassInstrument + * \sa PassContextNode::InstrumentBeforePass() + * \sa src/ir/transform.cc + */ +class PassInstrumentNode : public Object { + public: + virtual ~PassInstrumentNode() {} + + /*! \brief Set up environment for instrumentation. */ + virtual void SetUp() const = 0; + + /*! \brief Clean up instrumentation environment. */ Review comment: Done ########## File path: include/tvm/ir/transform.h ########## @@ -95,8 +87,9 @@ class PassContextNode : public Object { mutable Optional<DiagnosticContext> diag_ctx; /*! \brief Pass specific configurations. */ Map<String, ObjectRef> config; - /*! \brief Trace function to be invoked before and after each pass. */ - TraceFunc trace_func; + + /*! \brief A list of pass instrument implementations. */ Review comment: Done ########## File path: python/tvm/ir/instrument.py ########## @@ -0,0 +1,154 @@ +# 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. +# pylint: disable=invalid-name,unused-argument +"""Common pass instrumentation across IR variants.""" +import inspect +import functools + +import tvm._ffi +import tvm.runtime + +from . import _ffi_instrument_api + + +@tvm._ffi.register_object("instrument.PassInstrument") +class PassInstrument(tvm.runtime.Object): + """A pass instrument implementation. + + Users don't need to interact with this class directly. + Instead, a `PassInstrument` instance should be created through `pass_instrument`. + + See Also + -------- + `pass_instrument` + """ + + +def _wrap_class_pass_instrument(pi_cls): + """Wrap a python class as pass instrument""" + + class PyPassInstrument(PassInstrument): + """Internal wrapper class to create a class instance.""" + + def __init__(self, *args, **kwargs): + # initialize handle in cass pi_cls creation failed.fg Review comment: Done -- 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: [email protected]
