memaddress.c

Go to the documentation of this file.

// -*-Mode: C++;-*- // technically C99

// * BeginRiceCopyright *****************************************************
//
// $HeadURL$
// $Id$
//
// --------------------------------------------------------------------------
// Part of HPCToolkit (hpctoolkit.org)
//
// Information about sources of support for research and development of
// HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
// --------------------------------------------------------------------------
//
// Copyright ((c)) 2002-2017, Rice University
// All rights reserved.
//
// 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 Rice University (RICE) 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 RICE 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 RICE 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.
//
// ******************************************************* EndRiceCopyright *



/******************************************************************************
 * local includes
 ******************************************************************************/

#include <cct/cct.h>                          // cct_node_t

#include "sample-sources/perf/perf-util.h"    // event_info_t, perf_attr_init
#include "sample-sources/perf/event_custom.h" // event_custom_t
#include "sample-sources/perf/perf_skid.h"    // precice ip

#include "data_tree.h"

#include "place_folder.h"

/******************************************************************************
 *  MACROs
 ******************************************************************************/

#define EVNAME_MEMORY_CENTRIC "MEMCENTRIC"


/******************************************************************************
 * function folder
 ******************************************************************************/

FUNCTION_FOLDER(first_touch)

/******************************************************************************
 * data structure
 *****************************************************************************/


/******************************************************************************
 * local variables
 *****************************************************************************/


/******************************************************************************
 * local methods
 *****************************************************************************/


static void
memcentric_handler(event_handler_arg_t *args)
{
  if ( (args->current == NULL) || (args->data == NULL) ||
       (args->data->addr == 0) || (args->sample->sample_node == NULL))
    return;

  // memory information exists
  void *start, *end;
  struct datatree_info_s *info = datatree_splay_lookup((void*) args->data->addr, &start, &end);

  if (info && info->context) {
    thread_data_t* td    = hpcrun_get_thread_data();
    cct_bundle_t *bundle = &(td->core_profile_trace_data.epoch->csdata);

    cct_node_t *root = hpcrun_insert_special_node(bundle->tree_root,
        POINTER_TO_FUNCTION FUNCTION_FOLDER_NAME(first_touch));

    // copy the call path of the malloc
    cct_node_t *node =  hpcrun_cct_insert_path_return_leaf(info->context, root);

    metric_set_t* mset = hpcrun_reify_metric_set(node);

    hpcrun_metricVal_t* loc = hpcrun_metric_set_loc(mset, args->metric);
    if (loc->i == 0) {
      loc->i = args->data->addr;
    }

    td->core_profile_trace_data.perf_event_info[args->metric].num_samples++;

    TMSG(DATACENTRIC, "handling node %p, cct: %p, addr: %p", node, args->sample->sample_node, args->data->addr);
  }
}


static int
memcentric_register(sample_source_t *self, event_custom_t *event, struct event_threshold_s *period)
{
  event_info_t *event_info = (event_info_t*) hpcrun_malloc(sizeof(event_info_t));
  if (event_info == NULL)
    return -1;

  memset(event_info, 0, sizeof(event_info_t));

  event_info->metric_custom = event;

  struct event_threshold_s threshold;
  perf_util_get_default_threshold( &threshold );

  // ------------------------------------------
  // create metric page-fault
  // ------------------------------------------
  int metric_page_fault = hpcrun_new_metric();

  hpcrun_set_metric_info_and_period(
      metric_page_fault, "PAGE-FAULTS",
      MetricFlags_ValFmt_Int, 1, metric_property_none);

  // ------------------------------------------
  // create custom metric page-address
  // ------------------------------------------
  int page_address     = hpcrun_new_metric();
  hpcrun_set_metric_info_and_period(
      page_address, "PAGE-ADDR",
      MetricFlags_ValFmt_Int, 1 /* frequency*/, metric_property_none);

  // ------------------------------------------
  // initialize perf attributes
  // ------------------------------------------
  u64 sample_type = PERF_SAMPLE_IP   | PERF_SAMPLE_TID       |
      PERF_SAMPLE_TIME | PERF_SAMPLE_CALLCHAIN |
      PERF_SAMPLE_CPU  | PERF_SAMPLE_PERIOD;

  // set the default attributes for page fault
  struct perf_event_attr *attr = &(event_info->attr);
  attr->config = PERF_COUNT_SW_PAGE_FAULTS;
  attr->type   = PERF_TYPE_SOFTWARE;

  perf_util_attr_init(
      EVNAME_MEMORY_CENTRIC,
      attr,
      true                      /* use_period*/,
      threshold.threshold_num   /* use the default */,
      sample_type               /* need additional info to gather memory address */
  );
  perf_skid_set_max_precise_ip(attr);

  event_info->attr.sample_id_all = 1;

  METHOD_CALL(self, store_event_and_info,
              attr->config, 1, page_address, event_info);;
  return 1;
}


/******************************************************************************
 * Interface
 *****************************************************************************/


void
memcentric_init()
{
  event_custom_t *event_memcentric = hpcrun_malloc(sizeof(event_custom_t));
  event_memcentric->name         = EVNAME_MEMORY_CENTRIC;
  event_memcentric->desc         = "Experimental counter: identifying first-touch memory address.";
  event_memcentric->register_fn  = memcentric_register;   // call backs
  event_memcentric->handler_fn   = memcentric_handler;
  event_memcentric->handle_type  = EXCLUSIVE;// call me only for my events

  event_custom_register(event_memcentric);
}