Skip to content

Commit

Permalink
#2302: Add task clearing to thePerfData
Browse files Browse the repository at this point in the history
  • Loading branch information
pierrepebay committed Dec 12, 2024
1 parent d064015 commit 8210642
Show file tree
Hide file tree
Showing 6 changed files with 264 additions and 181 deletions.
9 changes: 8 additions & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@ set(TOP_LEVEL_SUBDIRS
activefn
# Add single-directory components
context event handler sequence termination
scheduler standalone runtime trace timing demangle rdmahandle metrics
scheduler standalone runtime trace timing demangle rdmahandle
)
if(vt_perf_enabled)
list(
APPEND
TOP_LEVEL_SUBDIRS
metrics
)
endif()
set(
PROJECT_SUBDIRS_LIST
# Add component along with sub-directories
Expand Down
12 changes: 11 additions & 1 deletion src/vt/metrics/example_events.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,15 @@ const std::unordered_map<std::string, std::pair<uint64_t,uint64_t>> example_even
{"cache_references", std::make_pair(PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_REFERENCES)},
{"cache_misses", std::make_pair(PERF_TYPE_HARDWARE, PERF_COUNT_HW_CACHE_MISSES)},
{"branch_instructions", std::make_pair(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_INSTRUCTIONS)},
{"branch_misses", std::make_pair(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES)}
{"branch_misses", std::make_pair(PERF_TYPE_HARDWARE, PERF_COUNT_HW_BRANCH_MISSES)},
{"fp_arith_inst_retired_scalar_double", std::make_pair(PERF_TYPE_RAW, 0x5301c7)},
{"fp_arith_inst_retired_scalar_single", std::make_pair(PERF_TYPE_RAW, 0x5302c7)},
{"fp_arith_inst_retired_128b_packed_double", std::make_pair(PERF_TYPE_RAW, 0x5304c7)},
{"fp_arith_inst_retired_128b_packed_single", std::make_pair(PERF_TYPE_RAW, 0x5308c7)},
{"fp_arith_inst_retired_256b_packed_double", std::make_pair(PERF_TYPE_RAW, 0x5310c7)},
{"fp_arith_inst_retired_256b_packed_single", std::make_pair(PERF_TYPE_RAW, 0x5320c7)},
{"fp_arith_inst_retired_512b_packed_double", std::make_pair(PERF_TYPE_RAW, 0x5340c7)},
{"fp_arith_inst_retired_512b_packed_single", std::make_pair(PERF_TYPE_RAW, 0x5380c7)}
};

#endif /*INCLUDED_VT_METRICS_EXAMPLE_EVENTS_H*/
217 changes: 217 additions & 0 deletions src/vt/metrics/perf_data.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
/*
//@HEADER
// *****************************************************************************
//
// perf_data.cc
// DARMA/vt => Virtual Transport
//
// Copyright 2019-2021 National Technology & Engineering Solutions of Sandia, LLC
// (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
// Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// * Neither the name of the copyright holder nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact darma@sandia.gov
//
// *****************************************************************************
//@HEADER
*/

#include "perf_data.h"

namespace vt { namespace metrics {

PerfData::PerfData()
{
event_map_ = example_event_map;
const char* env_p = getenv("VT_EVENTS");

// Check if the environment variable is set
if (env_p == nullptr) {
vtWarn("Warning: Environment variable VT_EVENTS not set, defaulting to 'instructions' for the PAPI event set.\n");
event_names_.push_back("instructions");
}
else {
std::string env_str(env_p);
std::stringstream ss(env_str);
std::string item;

while (std::getline(ss, item, ','))
{
event_names_.push_back(item);
}
}

for (const auto &event_name : event_names_)
{
if (event_map_.find(event_name) == event_map_.end())
{
cleanupBeforeAbort();
vtAbort("Event name isn't in known perf events map: " + event_name);
}
}
}

PerfData::~PerfData()
{
for (auto& [task, fds] : task_fds_map_)
{
for (int fd : fds)
{
if (fd != -1)
{
close(fd);
}
}
}
}

void PerfData::startTaskMeasurement(runnable::RunnableNew* task)
{
// fmt::print("*********** startTaskMeasurement: PerfData currently is tracking {} tasks\n", task_fds_map_.size());
if (task_fds_map_.find(task) == task_fds_map_.end())
{
// fmt::print(" Task was not in the task_fds_map_.\n");
std::vector<int> fds;
for (const auto &event_name : event_names_)
{
struct perf_event_attr pe = {};
pe.type = event_map_.at(event_name).first;
pe.size = sizeof(struct perf_event_attr);
pe.config = event_map_.at(event_name).second;

pe.disabled = 1;
pe.exclude_kernel = 1;
pe.exclude_hv = 1;
pe.inherit = 1; // Ensure event is inherited by threads

if (event_name == "instructions") {
pe.pinned = 1;
}

int fd = perf_event_open(&pe, 0, -1, -1, PERF_FLAG_FD_CLOEXEC);
if (fd == -1)
{
cleanupBeforeAbort();
vtAbort("Error opening perf event: " + std::string(strerror(errno)));
}

fds.push_back(fd);
}
task_fds_map_[task] = fds;
}

for (int fd : task_fds_map_[task])
{
if (fd != -1) {
ioctl(fd, PERF_EVENT_IOC_RESET, 0);
ioctl(fd, PERF_EVENT_IOC_ENABLE, 0);
}
}
}

void PerfData::stopTaskMeasurement(runnable::RunnableNew* task)
{
// fmt::print("*********** stopTaskMeasurement: PerfData currently is tracking {} tasks\n", task_fds_map_.size());
if (task_fds_map_.find(task) != task_fds_map_.end())
{
for (int fd : task_fds_map_[task])
{
if (fd != -1) {
ioctl(fd, PERF_EVENT_IOC_DISABLE, 0);
}
}
}
}

std::unordered_map<std::string, uint64_t> PerfData::getTaskMeasurements(runnable::RunnableNew* task)
{
// fmt::print("*********** getTaskMeasurements: PerfData currently is tracking {} tasks\n", task_fds_map_.size());
std::unordered_map<std::string, uint64_t> measurements;
if (task_fds_map_.find(task) != task_fds_map_.end())
{
for (size_t i = 0; i < task_fds_map_[task].size(); ++i)
{
uint64_t count;
if (task_fds_map_[task][i] != -1 && read(task_fds_map_[task][i], &count, sizeof(uint64_t)) != -1) {
measurements[event_names_[i]] = count;
}
else {
vtWarn("Failed to read perf event data for: " + event_names_[i]);
}
}
}
return measurements;
}

void PerfData::purgeTask(runnable::RunnableNew* task)
{
if (task_fds_map_.find(task) != task_fds_map_.end())
{
for (int fd : task_fds_map_[task])
{
if (fd != -1)
{
close(fd);
}
}
task_fds_map_.erase(task);
}
}

std::unordered_map<std::string, std::pair<uint64_t,uint64_t>> PerfData::getEventMap() const { return event_map_; }

void PerfData::startup() { event_map_ = example_event_map; }

std::string PerfData::name() { return "PerfData"; }

template <typename SerializerT>
void PerfData::serialize(SerializerT& s) {
s | event_map_;
}

void PerfData::cleanupBeforeAbort()
{
for (auto& [task, fds] : task_fds_map_)
{
for (int fd : fds)
{
if (fd != -1)
{
close(fd);
}
}
}
task_fds_map_.clear();
}

long PerfData::perf_event_open(struct perf_event_attr *hw_event, pid_t pid, int cpu, int group_fd, unsigned long flags)
{
return syscall(__NR_perf_event_open, hw_event, pid, cpu, group_fd, flags);
}

}} // end namespace vt::metrics
Loading

0 comments on commit 8210642

Please sign in to comment.