tracer.cpp

// See license for details

#include "tracer.hpp"

#include "absl/strings/str_cat.h"
#include "config.hpp"
#include "fmt/format.h"
#include "iassert.hpp"
#include "report.hpp"

bool Tracer::open(const std::string &fname) {
  auto file_name = absl::StrCat(fname, ".", Report::get_extension());

  ofs.open(file_name);
  if (!ofs) {
    Config::add_error(fmt::format("unable to open trace file {}", file_name));
    track_from = UINT64_MAX;
    track_to   = UINT64_MAX;
    return false;
  }

  main_clock_set = false;
  last_clock     = 0;
  track_from     = 0;
  track_to       = UINT64_MAX;
  // track_to       = 2*UINT64_MAX;

  return true;
}

void Tracer::track_range(uint64_t from, uint64_t to) {
  I(ofs);

  track_from = from;
  track_to   = to;
}

void Tracer::stage(const Dinst *dinst, const std::string ev) {
  I(ev.size() <= 4);  // tracer stages should have 4 or less characers

  if (dinst->getID() > track_to || dinst->getID() < track_from) {
    return;
  }

  adjust_clock();
  int id = dinst->getID();

  if (!started.contains(id)) {
    ofs << "I\t" << std::dec << id << "\t" << id << "\t" << dinst->getFlowId() << "\n";
    ofs << "L\t" << std::dec << id << "\t0\t" << std::hex << dinst->getPC() << " " << dinst->getInst()->get_asm() << "\n";
    started.insert(id);
  }

  ofs << fmt::format("S\t{}\t0\t{}\n", id, ev);
  if (ev == "WB" || ev == "RN" || ev == "PNR") {
    pending_end.emplace_back(fmt::format("E\t{}\t0\t{}\n", id, ev));
  }
}

void Tracer::event(const Dinst *dinst, const std::string ev) {
  I(ev.size() <= 8);  // tracer events should have 8 or less characers

  if (dinst->getID() > track_to || dinst->getID() < track_from) {
    return;
  }

  I(started.contains(dinst->getID()));  // events should be called once an instruction is already started

  adjust_clock();
  int id = dinst->getID();

  ofs << fmt::format("S\t{}\t1\t{}\n", id, ev);

  pending_end.emplace_back(fmt::format("E\t{}\t1\t{}\n", id, ev));
}

void Tracer::commit(const Dinst *dinst) {
  if (dinst->getID() > track_to || dinst->getID() < track_from) {
    return;
  }

  adjust_clock();
  int id = dinst->getID();

  stage(dinst, "CO");
  pending_end.emplace_back(fmt::format("R\t{}\t{}\t0\n", id, id));
}

void Tracer::flush(const Dinst *dinst) {
  if (dinst->getID() > track_to || dinst->getID() < track_from) {
    return;
  }

  adjust_clock();
  int id = dinst->getID();

  ofs << fmt::format("R\t{}\t{}\t1\n", id, id);
}

void Tracer::adjust_clock() {
  if (!main_clock_set) {
    ofs << "Kanata\t0004\n";
    // ofs << "C=\t" << std::dec << globalClock << "\n";
    ofs << "C=\t0\n";  // Easier to read
    main_clock_set = true;
    last_clock     = globalClock;
  }
}

void Tracer::advance_clock() {
  if (main_clock_set) {
    ofs << "C\t" << std::dec << globalClock - last_clock << "\n";
  }
  last_clock = globalClock;

  if (pending_end.empty()) {
    return;
  }

  I(main_clock_set);
  for (const auto &txt : pending_end) {
    ofs << txt;
  }
  pending_end.clear();
}