-/* Copyright (c) 2010-2017. The SimGrid Team.
+/* Copyright (c) 2010-2023. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "simgrid/sg_config.h"
+#include "simgrid/Exception.hpp"
#include "src/instr/instr_private.hpp"
#include "src/instr/instr_smpi.hpp"
+#include "src/simgrid/sg_config.hpp"
#include "src/smpi/include/private.hpp"
-#include "typeinfo"
-#include "xbt/virtu.h" /* sg_cmdline */
#include <fstream>
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_paje_trace, instr, "tracing event system");
-static std::stringstream stream;
-FILE *tracing_file = nullptr;
+namespace simgrid::instr {
+static std::vector<PajeEvent*> buffer;
-std::vector<simgrid::instr::PajeEvent*> buffer;
-void buffer_debug(std::vector<simgrid::instr::PajeEvent*>* buf);
-
-void dump_comment(std::string comment)
-{
- if (comment.empty())
- return;
- fprintf(tracing_file, "# %s\n", comment.c_str());
-}
-
-void dump_comment_file(std::string filename)
-{
- if (filename.empty())
- return;
- std::ifstream* fs = new std::ifstream();
- fs->open(filename.c_str(), std::ifstream::in);
-
- if (fs->fail()) {
- THROWF(system_error, 1, "Comment file %s could not be opened for reading.", filename.c_str());
- }
- while (not fs->eof()) {
- std::string line;
- fprintf (tracing_file, "# ");
- std::getline(*fs, line);
- fprintf(tracing_file, "%s", line.c_str());
- }
- fs->close();
-}
-
-double TRACE_last_timestamp_to_dump = 0;
-//dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
-void TRACE_paje_dump_buffer(bool force)
+double last_timestamp_to_dump = 0;
+// dumps the trace file until the last_timestamp_to_dump
+void dump_buffer(bool force)
{
if (not TRACE_is_enabled())
return;
- XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
- if (force){
+ XBT_DEBUG("%s: dump until %f. starts", __func__, last_timestamp_to_dump);
+ if (force || (trace_format == TraceFormat::Ti)){
for (auto const& event : buffer) {
event->print();
delete event;
}
buffer.clear();
- }else{
- std::vector<simgrid::instr::PajeEvent*>::iterator i = buffer.begin();
+ } else {
+ auto i = buffer.begin();
for (auto const& event : buffer) {
- double head_timestamp = event->timestamp_;
- if (head_timestamp > TRACE_last_timestamp_to_dump)
+ if (event->timestamp_ > last_timestamp_to_dump)
break;
event->print();
delete event;
}
buffer.erase(buffer.begin(), i);
}
- XBT_DEBUG("%s: ends", __FUNCTION__);
-}
-
-void buffer_debug(std::vector<simgrid::instr::PajeEvent*>* buf)
-{
- return;
- XBT_DEBUG(">>>>>> Dump the state of the buffer. %zu events", buf->size());
- for (auto const& event : *buf) {
- event->print();
- XBT_DEBUG("%p %s", event, stream.str().c_str());
- stream.str("");
- stream.clear();
- }
- XBT_DEBUG("<<<<<<");
-}
-
-static void print_row() {
- stream << std::endl;
- fprintf(tracing_file, "%s", stream.str().c_str());
- XBT_DEBUG("Dump %s", stream.str().c_str());
- stream.str("");
- stream.clear();
-}
-
-static void print_timestamp(simgrid::instr::PajeEvent* event)
-{
- stream << " ";
- /* prevent 0.0000 in the trace - this was the behavior before the transition to c++ */
- if (event->timestamp_ < 1e-12)
- stream << 0;
- else
- stream << event->timestamp_;
+ XBT_DEBUG("%s: ends", __func__);
}
/* internal do the instrumentation module */
-void simgrid::instr::PajeEvent::insertIntoBuffer()
+void PajeEvent::insert_into_buffer()
{
- if (not TRACE_buffer()) {
- print();
- delete this;
- return;
- }
- buffer_debug(&buffer);
-
- XBT_DEBUG("%s: insert event_type=%u, timestamp=%f, buffersize=%zu)", __FUNCTION__, eventType_, timestamp_,
- buffer.size());
- std::vector<simgrid::instr::PajeEvent*>::reverse_iterator i;
+ XBT_DEBUG("%s: insert event_type=%u, timestamp=%f, buffersize=%zu)", __func__, static_cast<unsigned>(eventType_),
+ timestamp_, buffer.size());
+ std::vector<PajeEvent*>::reverse_iterator i;
for (i = buffer.rbegin(); i != buffer.rend(); ++i) {
- simgrid::instr::PajeEvent* e1 = *i;
- XBT_DEBUG("compare to %p is of type %u; timestamp:%f", e1, e1->eventType_, e1->timestamp_);
+ PajeEvent* e1 = *i;
+ XBT_DEBUG("compare to %p is of type %u; timestamp:%f", e1, static_cast<unsigned>(e1->eventType_), e1->timestamp_);
if (e1->timestamp_ <= timestamp_)
break;
}
if (i == buffer.rend())
- XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
+ XBT_DEBUG("%s: inserted at beginning", __func__);
else if (i == buffer.rbegin())
- XBT_DEBUG("%s: inserted at end", __FUNCTION__);
+ XBT_DEBUG("%s: inserted at end", __func__);
else
- XBT_DEBUG("%s: inserted at pos= %zd from its end", __FUNCTION__, std::distance(buffer.rbegin(), i));
+ XBT_DEBUG("%s: inserted at pos= %zd from its end", __func__, std::distance(buffer.rbegin(), i));
buffer.insert(i.base(), this);
-
- buffer_debug(&buffer);
-}
-
-simgrid::instr::PajeEvent::~PajeEvent()
-{
- XBT_DEBUG("%s not implemented for %p: event_type=%u, timestamp=%f", __FUNCTION__, this, eventType_, timestamp_);
-}
-
-void TRACE_paje_start() {
- char *filename = TRACE_get_filename();
- tracing_file = fopen(filename, "w");
- if (tracing_file == nullptr){
- THROWF (system_error, 1, "Tracefile %s could not be opened for writing.", filename);
- }
-
- XBT_DEBUG("Filename %s is open for writing", filename);
-
- /* output generator version */
- fprintf (tracing_file, "#This file was generated using SimGrid-%d.%d.%d\n",
- SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR, SIMGRID_VERSION_PATCH);
- fprintf (tracing_file, "#[");
- unsigned int cpt;
- char *str;
- xbt_dynar_foreach (xbt_cmdline, cpt, str){
- fprintf(tracing_file, "%s ",str);
- }
- fprintf (tracing_file, "]\n");
-
- /* output one line comment */
- dump_comment (TRACE_get_comment());
-
- /* output comment file */
- dump_comment_file (TRACE_get_comment_file());
-
- /* output header */
- TRACE_header(TRACE_basic(),TRACE_display_sizes());
}
-void TRACE_paje_end() {
- fclose(tracing_file);
- char *filename = TRACE_get_filename();
- XBT_DEBUG("Filename %s is closed", filename);
-}
-
-simgrid::instr::SetVariableEvent::SetVariableEvent(double timestamp, container_t container, Type* type, double value)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_SetVariable), value(value)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __FUNCTION__, eventType_, this->timestamp_);
- insertIntoBuffer();
-}
-
-void simgrid::instr::SetVariableEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision()) << this->eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << value;
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-simgrid::instr::AddVariableEvent::AddVariableEvent(double timestamp, container_t container, simgrid::instr::Type* type,
- double value)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_AddVariable), value(value)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __FUNCTION__, eventType_, this->timestamp_);
- insertIntoBuffer();
-}
-
-void simgrid::instr::AddVariableEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << value;
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-simgrid::instr::SubVariableEvent::SubVariableEvent(double timestamp, container_t container, Type* type, double value)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_SubVariable), value(value)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __FUNCTION__, eventType_, this->timestamp_);
- insertIntoBuffer();
-}
-
-void simgrid::instr::SubVariableEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << value;
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-simgrid::instr::StartLinkEvent::StartLinkEvent(double timestamp, container_t container, Type* type,
- container_t sourceContainer, std::string value, std::string key)
- : StartLinkEvent(timestamp, container, type, sourceContainer, value, key, -1)
-{}
-
-simgrid::instr::StartLinkEvent::StartLinkEvent(double timestamp, container_t container, Type* type,
- container_t sourceContainer, std::string value, std::string key,
- int size)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_StartLink)
- , sourceContainer_(sourceContainer)
- , value_(value)
- , key_(key)
- , size_(size)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f, value:%s", __FUNCTION__, eventType_, this->timestamp_,
- this->value_.c_str());
- insertIntoBuffer();
-}
-
-void simgrid::instr::StartLinkEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << value_;
- stream << " " << sourceContainer_->getId() << " " << key_;
-
- if (TRACE_display_sizes()) {
- stream << " " << size_;
- }
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-simgrid::instr::EndLinkEvent::EndLinkEvent(double timestamp, container_t container, Type* type,
- container_t destContainer, std::string value, std::string key)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_EndLink)
- , destContainer(destContainer)
- , value(value)
- , key(key)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __FUNCTION__, eventType_, this->timestamp_);
- insertIntoBuffer();
-}
-
-void simgrid::instr::EndLinkEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << value;
- stream << " " << destContainer->getId() << " " << key;
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-simgrid::instr::NewEvent::NewEvent(double timestamp, container_t container, Type* type, EntityValue* val)
- : simgrid::instr::PajeEvent::PajeEvent(container, type, timestamp, PAJE_NewEvent), val(val)
-{
- XBT_DEBUG("%s: event_type=%u, timestamp=%f", __FUNCTION__, eventType_, this->timestamp_);
-
- insertIntoBuffer();
-}
-
-void simgrid::instr::NewEvent::print()
-{
- if (instr_fmt_type == instr_fmt_paje) {
- XBT_DEBUG("%s: event_type=%u, timestamp=%.*f", __FUNCTION__, eventType_, TRACE_precision(), timestamp_);
- stream << std::fixed << std::setprecision(TRACE_precision());
- stream << eventType_;
- print_timestamp(this);
- stream << " " << type->getId() << " " << container->getId() << " " << val->getId();
- print_row();
- } else if (instr_fmt_type == instr_fmt_TI) {
- /* Nothing to do */
- } else {
- THROW_IMPOSSIBLE;
- }
-}
-
-void TRACE_TI_start()
-{
- char *filename = TRACE_get_filename();
- tracing_file = fopen(filename, "w");
- if (tracing_file == nullptr)
- THROWF(system_error, 1, "Tracefile %s could not be opened for writing.", filename);
-
- XBT_DEBUG("Filename %s is open for writing", filename);
-
- /* output one line comment */
- dump_comment(TRACE_get_comment());
-
- /* output comment file */
- dump_comment_file(TRACE_get_comment_file());
-}
-
-void TRACE_TI_end()
-{
- fclose(tracing_file);
- char *filename = TRACE_get_filename();
- XBT_DEBUG("Filename %s is closed", filename);
-}
+} // namespace simgrid::instr