/* Copyright 2016 The TensorFlow Authors All Rights Reserved.

Licensed 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 TENSORFLOW_CORE_PROFILER_INTERNAL_ADVISOR_CHECKER_H_
#define TENSORFLOW_CORE_PROFILER_INTERNAL_ADVISOR_CHECKER_H_

#include "tensorflow/core/profiler/internal/tfprof_stats.h"
#include "tensorflow/core/profiler/tfprof_options.pb.h"

namespace tensorflow {
namespace tfprof {

// Append only.
static const char* const kCheckers[] = {
    "AcceleratorUtilizationChecker", "OperationChecker",
    "ExpensiveOperationChecker",
    "JobChecker",  // Internal checker.
};

class Checker {
 public:
  virtual ~Checker() = default;

  virtual std::string name() const = 0;

  AdviceProto::Checker Run(const AdvisorOptionsProto::CheckerOption& options,
                           const TFStats* stats) {
    return Check(options, stats);
  }

 protected:
  virtual AdviceProto::Checker Check(
      const AdvisorOptionsProto::CheckerOption& options,
      const TFStats* stats) = 0;
};
}  // namespace tfprof
}  // namespace tensorflow

#endif  // TENSORFLOW_CORE_PROFILER_INTERNAL_ADVISOR_CHECKER_H_
