instrument.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef TVM_IR_INSTRUMENT_H_
#define TVM_IR_INSTRUMENT_H_
 
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
 
#include <utility>
#include <vector>
 
namespace tvm {
 
class IRModule;
 
// Forward class for PassInstrumentNode methods
namespace transform {
class PassInfo;
}  // namespace transform
 
namespace instrument {
 
class PassInstrumentNode : public ffi::Object {
 public:
  ffi::String name;
 
  virtual ~PassInstrumentNode() {}
 
  virtual void EnterPassContext() const = 0;
 
  virtual void ExitPassContext() const = 0;
 
  virtual bool ShouldRun(const IRModule& mod, const transform::PassInfo& info) const = 0;
 
  virtual void RunBeforePass(const IRModule& mod, const transform::PassInfo& info) const = 0;
 
  virtual void RunAfterPass(const IRModule& mod, const transform::PassInfo& info) const = 0;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PassInstrumentNode>().def_ro("name", &PassInstrumentNode::name);
  }
  TVM_FFI_DECLARE_OBJECT_INFO("instrument.PassInstrument", PassInstrumentNode, ffi::Object);
};
 
class PassInstrument : public ffi::ObjectRef {
 public:
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PassInstrument, ffi::ObjectRef, PassInstrumentNode);
};
 
}  // namespace instrument
}  // namespace tvm
 
#endif  // TVM_IR_INSTRUMENT_H_