/***************************************************************************************
 * This file includes most utilized functions for LbRRGraph object
 ***************************************************************************************/

/* Headers from vtrutil library */
#include "lb_rr_graph_utils.h"

#include "vtr_assert.h"
#include "vtr_log.h"
#include "vtr_util.h"

/* begin namespace openfpga */
namespace openfpga {

/***************************************************************************************
 * Generate a string to describe a node in a logical tile rr_graph
 * in the context of logical tile
 ***************************************************************************************/
std::string describe_lb_rr_node(const LbRRGraph& lb_rr_graph,
                                const LbRRNodeId& inode) {
  std::string description;

  const t_pb_graph_pin* pb_graph_pin = lb_rr_graph.node_pb_graph_pin(inode);

  if (pb_graph_pin) {
    description += "'" + pb_graph_pin->to_string(false) + "'";
  } else if (inode == lb_rr_graph.ext_source_node()) {
    VTR_ASSERT(LB_SOURCE == lb_rr_graph.node_type(inode));
    description = "cluster-external source (LB_SOURCE)";
  } else if (inode == lb_rr_graph.ext_sink_node()) {
    VTR_ASSERT(LB_SINK == lb_rr_graph.node_type(inode));
    description = "cluster-external sink (LB_SINK)";
  } else if (LB_SINK == lb_rr_graph.node_type(inode)) {
    description =
      "cluster-internal sink (LB_SINK accessible via architecture pins: ";

    // To account for equivalent pins multiple pins may route to a single sink.
    // As a result we need to fin all the nodes which connect to this sink in
    // order to give user-friendly pin names
    std::vector<std::string> pin_descriptions;
    for (const LbRREdgeId edge : lb_rr_graph.node_in_edges(inode)) {
      const LbRRNodeId pin_rr_idx = lb_rr_graph.edge_src_node(edge);
      const t_pb_graph_pin* pin_pb_gpin =
        lb_rr_graph.node_pb_graph_pin(pin_rr_idx);
      pin_descriptions.push_back(pin_pb_gpin->to_string());
    }

    description += vtr::join(pin_descriptions, ", ");
    description += ")";

  } else if (LB_SOURCE == lb_rr_graph.node_type(inode)) {
    description = "cluster-internal source (LB_SOURCE)";
  } else if (LB_INTERMEDIATE == lb_rr_graph.node_type(inode)) {
    description = "cluster-internal intermediate?";
  } else {
    description = "<unknown lb_type_rr_node>";
  }

  return description;
}

/* This function aims to print basic information about a node */
void print_lb_rr_node(const LbRRGraph& lb_rr_graph, const LbRRNodeId& node) {
  VTR_LOG("Node id: %d\n", size_t(node));
  VTR_LOG("Node type: %s\n", lb_rr_type_str[lb_rr_graph.node_type(node)]);
  VTR_LOG("Node capacity: %d\n", lb_rr_graph.node_capacity(node));
  /* Some node, e.g., SOURCE, SINK  may not have pb_graph_pin, skip outputing in
   * this case */
  if (nullptr != lb_rr_graph.node_pb_graph_pin(node)) {
    VTR_LOG("Node pb_graph_pin: %s\n",
            lb_rr_graph.node_pb_graph_pin(node)->to_string().c_str());
  }
  VTR_LOG("Node intrinsic_cost: %f\n", lb_rr_graph.node_intrinsic_cost(node));
  VTR_LOG("Node num in_edges: %ld\n", lb_rr_graph.node_in_edges(node).size());
  VTR_LOG("Node num out_edges: %ld\n", lb_rr_graph.node_out_edges(node).size());
}

} /* end namespace openfpga */