error.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_ERROR_H_
#define TVM_IR_ERROR_H_

#include <tvm/ir/module.h>
#include <tvm/ir/span.h>

#include <sstream>
#include <string>
#include <unordered_map>
#include <vector>

namespace tvm {
struct ErrorBuilder {
 public:
  template <typename T>
  ErrorBuilder& operator<<(const T& val) {  // NOLINT(*)
    stream_ << val;
    return *this;
  }

 private:
  std::stringstream stream_;
  friend class CompileError;
};

class CompileError : public Error {
 public:
  Span span;
  explicit CompileError(const std::string& msg) : Error(msg), span(nullptr) {}
  CompileError(const ErrorBuilder& err) : Error(err.stream_.str()), span(nullptr) {}  // NOLINT(*)
  CompileError(const CompileError& other) : Error(other.what()), span(other.span) {}  // NOLINT(*)
  CompileError() : Error(""), span(nullptr) {}
};

class ErrorReporter {
 public:
  ErrorReporter() : errors_(), node_to_error_() {}

  void Report(const CompileError& err) {
    if (!err.span.defined()) {
      throw err;
    }

    this->errors_.push_back(err);
  }

  void ReportAt(const GlobalVar& global, const ObjectRef& node, std::stringstream& err) {
    std::string err_msg = err.str();
    this->ReportAt(global, node, CompileError(err_msg));
  }

  void ReportAt(const GlobalVar& global, const ObjectRef& node, const CompileError& err);

  void RenderErrors(const IRModule& module, bool use_color = true);

  inline bool AnyErrors() { return errors_.size() != 0; }

 private:
  std::vector<CompileError> errors_;
  std::unordered_map<ObjectRef, std::vector<size_t>, ObjectPtrHash, ObjectPtrEqual> node_to_error_;
  std::unordered_map<ObjectRef, GlobalVar, ObjectPtrHash, ObjectPtrEqual> node_to_gv_;
};

}  // namespace tvm
#endif  // TVM_IR_ERROR_H_