/* Copyright 2022 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 XPROF_CONVERT_XPLANE_TO_HLO_H_
#define XPROF_CONVERT_XPLANE_TO_HLO_H_

#include "absl/status/statusor.h"
#include "absl/strings/string_view.h"
#include "xla/service/hlo.pb.h"
#include "xprof/convert/repository.h"
#include "xprof/convert/tool_options.h"

namespace tensorflow {
namespace profiler {

// Get HLO proto by module name.
absl::StatusOr<xla::HloProto> GetHloProtoByModuleName(
    const SessionSnapshot& session_snapshot, absl::string_view module_name);

// Get HLO proto by program id.
absl::StatusOr<xla::HloProto> GetHloProtoByProgramId(
    const SessionSnapshot& session_snapshot, absl::string_view program_id);

// Get HLO proto by searching for node name in all HLO modules.
absl::StatusOr<xla::HloProto> GetHloProtoByNodeName(
    const SessionSnapshot& session_snapshot, absl::string_view node_name);

absl::StatusOr<xla::HloProto> GetHloProtoByOptions(
    const SessionSnapshot& session_snapshot, const ToolOptions& options);

// Converts multiple XSpaces to HLO protos.
// Stores the HLO protos as files in the same directory as the xspace files.
// Returns whether there are HLO protos in this profile.
absl::StatusOr<bool> ConvertMultiXSpaceToHloProto(
    const SessionSnapshot& session_snapshot);

}  // namespace profiler
}  // namespace tensorflow

#endif  // XPROF_CONVERT_XPLANE_TO_HLO_H_
