perf_data.h

Go to the documentation of this file.

/*
//@HEADER
// *****************************************************************************
//
//                                 perf_data.h
//                       DARMA/vt => Virtual Transport
//
// Copyright 2019-2024 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
*/
 
#if !defined INCLUDED_VT_METRICS_PERF_DATA_H
#define INCLUDED_VT_METRICS_PERF_DATA_H
 
#include "vt/config.h"
#include "vt/runtime/component/component_pack.h"
#include "vt/context/context.h"
#include "vt/metrics/perf_event_groups.h"
#include "vt/metrics/example_events.h"
 
#include <linux/perf_event.h>
#include <sys/ioctl.h>
#include <sys/syscall.h>
#include <unistd.h>
#include <cstdint>
#include <cstring>
#include <unordered_map>
#include <vector>
#include <string>
 
namespace vt::metrics {


struct PerfData: runtime::component::Component<PerfData>
{
public:
  struct TaskGroupMeasurements {
    PerfEventGroupInfo group_;
    uint64_t time_enabled_ = 0;
    uint64_t time_running_ = 0;
    std::unordered_map<std::string, uint64_t> measurements_;
 
    double getScalingRatio() const {
      if (time_running_ == 0) {
        return 0.0;
      }
 
      return static_cast<double>(time_enabled_) /
        static_cast<double>(time_running_);
    }
 
    double getRunningFraction() const {
      if (time_enabled_ == 0) {
        return 0.0;
      }
 
      return static_cast<double>(time_running_) /
        static_cast<double>(time_enabled_);
    }
  };

  PerfData();

  virtual ~PerfData();

  void startTaskMeasurement();

  void stopTaskMeasurement();

  std::unordered_map<std::string, uint64_t> getTaskMeasurements();

  std::vector<TaskGroupMeasurements> getTaskGroupMeasurements();

  std::unordered_map<std::string, PerfEventDescriptor> getEventMap() const;

  std::vector<PerfEventGroupInfo> getEventGroups() const;

  void startup() override;

  std::string name() override;

  template <typename SerializerT>
  void serialize(SerializerT& s) {
    s | event_map_
      | event_names_
      | event_groups_;
  }
 
private:
  struct GroupState {
    PerfEventGroupInfo info_;
    int leader_fd_ = -1;
    std::unordered_map<uint64_t, std::string> event_ids_;
  };

  PerfEventDescriptorMap event_map_;

  std::vector<std::string> event_names_;

  std::vector<PerfEventGroupInfo> event_groups_;

  std::vector<GroupState> group_states_;

  std::vector<int> open_fds_;

  std::vector<TaskGroupMeasurements> readTaskGroupMeasurements() const;

  void maybePrintEventGroups() const;

  void cleanupBeforeAbort();

  static long perfEventOpen(struct perf_event_attr *hw_event, pid_t pid, int cpu, int group_fd, unsigned long flags);
};
 
} // end namespace vt::metrics
 
namespace vt {
 
extern metrics::PerfData* thePerfData();
 
} // end namespace vt
 
#endif /*INCLUDED_VT_METRICS_PERF_DATA_H*/