/* Copyright 2026 The OpenXLA 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 THIRD_PARTY_XPROF_CONVERT_BASE_OP_STATS_PROCESSOR_H_
#define THIRD_PARTY_XPROF_CONVERT_BASE_OP_STATS_PROCESSOR_H_

#include <string>
#include <vector>

#include "absl/status/status.h"
#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
#include "tsl/profiler/protobuf/xplane.pb.h"
#include "xprof/convert/tool_options.h"
#include "xprof/convert/unified_profile_processor.h"
#include "xprof/convert/unified_session_snapshot.h"
#include "plugin/xprof/protobuf/op_stats.pb.h"

namespace xprof {

// Unified base class for OpStats processors across 1P and 3P environments.
// Inherits virtually from UnifiedProfileProcessor to support combination with
// other intermediate structural classes.
class BaseOpStatsProcessor : public virtual UnifiedProfileProcessor {
 public:
  explicit BaseOpStatsProcessor(
      const tensorflow::profiler::ToolOptions& options)
      : options_(options) {}

  virtual ~BaseOpStatsProcessor() = default;

  // Converts XSpace to serialized OpStats.
  absl::StatusOr<std::string> Map(
      const XprofSessionSnapshot& session_snapshot,
      absl::string_view hostname,
      const tensorflow::profiler::XSpace& xspace) override;
  // Deserializes map_outputs, combines OpStats, and delegates to
  // ProcessCombinedOpStats.
  absl::Status Reduce(
      const XprofSessionSnapshot& session_snapshot,
      const std::vector<std::string>& map_output_files) override;

  absl::Status ProcessSession(
      const XprofSessionSnapshot& session_snapshot,
      const tensorflow::profiler::ToolOptions& options) override;

  bool ShouldUseWorkerService(
      const XprofSessionSnapshot& session_snapshot,
      const tensorflow::profiler::ToolOptions& options) const override;

  // Extension point for subclasses to process the merged OpStats.
  // TODO: b/514176124 - Migrate to XprofSessionSnapshot in the child CL
  // (cl/907391150).
  virtual absl::Status ProcessCombinedOpStats(
      const XprofSessionSnapshot& session_snapshot,
      const tensorflow::profiler::OpStats& combined_op_stats,
      const tensorflow::profiler::ToolOptions& options) = 0;

 protected:
  tensorflow::profiler::ToolOptions options_;
};

}  // namespace xprof

#endif  // THIRD_PARTY_XPROF_CONVERT_BASE_OP_STATS_PROCESSOR_H_
