msr_counters.h

Go to the documentation of this file.

/* msr_counters.h
 *
 * Copyright (c) 2011-2016, Lawrence Livermore National Security, LLC.
 * LLNL-CODE-645430
 *
 * Produced at Lawrence Livermore National Laboratory
 * Written by  Barry Rountree, rountree@llnl.gov
 *             Scott Walker,   walker91@llnl.gov
 *             Kathleen Shoga, shoga1@llnl.gov
 *
 * All rights reserved.
 *
 * This file is part of libmsr.
 *
 * libmsr is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option)
 * any later version.
 *
 * libmsr is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libmsr. If not, see <http://www.gnu.org/licenses/>.
 *
 * This material is based upon work supported by the U.S. Department of
 * Energy's Lawrence Livermore National Laboratory. Office of Science, under
 * Award number DE-AC52-07NA27344.
 *
 */

#ifndef MSR_COUNTERS_H_INCLUDE
#define MSR_COUNTERS_H_INCLUDE

#include <stdint.h>
#include <stdio.h>

#include "msr_core.h"
#include "master.h"

// Note: It should not matter which platform header (i.e., master header) you
// are using because the counter MSRs are architectural and should remain
// consistent across platforms.

#ifdef __cplusplus
extern "C" {
#endif

struct fixed_counter {
    uint64_t *enable;
    uint64_t *ring_level;
    uint64_t *anyThread;
    uint64_t *pmi;
    uint64_t **value;
    uint64_t *overflow;
};

struct fixed_counter_config {
    int num_counters;
    int width;
};

struct perfevtsel {
    uint64_t **perf_evtsel0;
    uint64_t **perf_evtsel1;
    uint64_t **perf_evtsel2;
    uint64_t **perf_evtsel3;
    uint64_t **perf_evtsel4;
    uint64_t **perf_evtsel5;
    uint64_t **perf_evtsel6;
    uint64_t **perf_evtsel7;
};

struct pmc {
    uint64_t **pmc0;
    uint64_t **pmc1;
    uint64_t **pmc2;
    uint64_t **pmc3;
    uint64_t **pmc4;
    uint64_t **pmc5;
    uint64_t **pmc6;
    uint64_t **pmc7;
};

struct unc_perfevtsel {
    uint64_t **c0;
    uint64_t **c1;
    uint64_t **c2;
    uint64_t **c3;
};

struct unc_counters {
    uint64_t **c0;
    uint64_t **c1;
    uint64_t **c2;
    uint64_t **c3;
};

void print_available_counters(void);

/*************************************/
/* Programmable Performance Counters */
/*************************************/

void perfevtsel_storage(struct perfevtsel **e);

void pmc_storage(struct pmc **p);

void set_pmc_ctrl_flags(uint64_t cmask,
                        uint64_t flags,
                        uint64_t umask,
                        uint64_t eventsel,
                        int pmcnum,
                        unsigned thread);

void set_all_pmc_ctrl(uint64_t cmask,
                      uint64_t flags,
                      uint64_t umask,
                      uint64_t eventsel,
                      int pmcnum);

int enable_pmc(void);

void clear_all_pmc(void);

int clear_pmc(int idx);

void dump_pmc_data_readable(FILE *writedest);

/*************************************/
/* Uncore PCU Performance Monitoring */
/*************************************/

void unc_perfevtsel_storage(struct unc_perfevtsel **uevt);

void unc_counters_storage(struct unc_counters **uc);

void set_pcu_ctrl_flags(uint64_t flags,
                        uint64_t reset,
                        uint64_t occ,
                        uint64_t eventsel,
                        int pcunum,
                        unsigned socket);

void set_all_pcu_ctrl(uint64_t flags,
                      uint64_t reset,
                      uint64_t occ,
                      uint64_t eventsel,
                      int pcunum);

void enable_pcu(void);

void clear_all_pcu(void);

int clear_pcu(int idx);

void dump_unc_counter_data_label(FILE *writedest);

void dump_unc_counter_data(FILE *writedest);

/*****************************************/
/* Fixed Counters Performance Monitoring */
/*****************************************/

void fixed_counter_storage(struct fixed_counter **ctr0,
                           struct fixed_counter **ctr1,
                           struct fixed_counter **ctr2);

void fixed_counter_ctrl_storage(uint64_t ***perf_ctrl,
                                uint64_t ***fixed_ctrl);

void init_fixed_counter(struct fixed_counter *ctr);

void get_fixed_counter_ctrl(struct fixed_counter *ctr0,
                            struct fixed_counter *ctr1,
                            struct fixed_counter *ctr2);

void set_fixed_counter_ctrl(struct fixed_counter *ctr0,
                            struct fixed_counter *ctr1,
                            struct fixed_counter *ctr2);

void get_fixed_counter_config(struct fixed_counter_config *data);

void enable_fixed_counters(void);

void disable_fixed_counters(void);

void dump_fixed_counter_data_terse(FILE *writedest);

void dump_fixed_counter_data_terse_label(FILE *writedest);

void dump_fixed_counter_data_readable(FILE *writedest);

#ifdef __cplusplus
}
#endif
#endif