/* 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_DEBUG_NODE_KEY_H_
#define TENSORFLOW_DEBUG_NODE_KEY_H_

#include <string>

#include "tensorflow/core/platform/types.h"

namespace tensorflow {

// Encapsulates debug information for a node that was observed.
struct DebugNodeKey {
  static const char* const kMetadataFilePrefix;
  static const char* const kDeviceTag;

  DebugNodeKey(const string& device_name, const string& node_name,
               const int32 output_slot, const string& debug_op);

  // Converts a device name string to a device path string.
  // E.g., /job:localhost/replica:0/task:0/cpu:0 will be converted to
  //   ,job_localhost,replica_0,task_0,cpu_0.
  static const string DeviceNameToDevicePath(const string& device_name);

  bool operator==(const DebugNodeKey& other) const;
  bool operator!=(const DebugNodeKey& other) const;

  const string device_name;
  const string node_name;
  const int32 output_slot;
  const string debug_op;
  const string debug_node_name;
  const string device_path;
};

}  // namespace tensorflow

#endif  // TENSORFLOW_DEBUG_NODE_KEY_H_
