msr_core.h

Go to the documentation of this file.

/* msr_core.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_CORE_H_INCLUDE
#define MSR_CORE_H_INCLUDE

#include <linux/types.h>
#include <stdint.h>
#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif

#define NUM_DEVS (sockets * coresPerSocket * threadsPerCore)
#define X86_IOC_MSR_BATCH _IOWR('c', 0xA2, struct msr_batch_array)
#define MSR_BATCH_DIR "/dev/cpu/msr_batch"
#define FILENAME_SIZE 1024
//#define USE_NO_BATCH 1

enum libmsr_data_type_e {
    RAPL_DATA,
    RAPL_UNIT,
    FIXED_COUNTERS_DATA,
    FIXED_COUNTERS_CTR_DATA,
    COUNTERS_DATA,
    COUNTERS_CTRL,
    CLOCKS_DATA,
    PERF_DATA,
    THERM_STAT,
    THERM_INTERR,
    PKG_THERM_STAT,
    PKG_THERM_INTERR,
    TEMP_TARGET,
    PERF_CTL,
    PKG_CRES,
    CORE_CRES,
    UNCORE_EVTSEL,
    UNCORE_COUNT,
    USR_BATCH0,
    USR_BATCH1,
    USR_BATCH2,
    USR_BATCH3,
    USR_BATCH4,
    USR_BATCH5,
    USR_BATCH6,
    USR_BATCH7,
    USR_BATCH8,
    USR_BATCH9,
    USR_BATCH10,
};

enum libmsr_batch_op_type_e {
    BATCH_LOAD,
    BATCH_WRITE,
    BATCH_READ,
};

// Depending on their scope, MSRs can be written to or read from at either the
// socket (aka package/cpu) or core level, and possibly the hardware thread
// level.
//
//  read/write_msr reads from core 0.
//  read/write_msr_all_cores_v uses a vector of values.
//  write_msr_all_cores writes all cores with a single value.
//  read/write_msr_single_core contains all of the low-level logic.
//  The rest of the functions are wrappers that call these two functions.

struct msr_batch_op {
    __u16 cpu;
    __u16 isrdmsr;
    __s32 err;
    __u32 msr;
    __u64 msrdata;
    __u64 wmask;
};

struct msr_batch_array {
    __u32 numops;
    struct msr_batch_op *ops;
};

uint64_t num_cores(void);

uint64_t num_sockets(void);

uint64_t num_devs(void);

uint64_t cores_per_socket(void);

int allocate_batch(int batchnum,
                   size_t bsize);

int free_batch(int batchnum);

int create_batch_op(off_t msr,
                    uint64_t cpu,
                    uint64_t **dest,
                    const int batchnum);

void core_config(uint64_t *coresPerSocket,
                 uint64_t *threadsPerCore,
                 uint64_t *sockets,
                 int *HTenabled);

int sockets_assert(const unsigned *socket,
                   const int location,
                   const char *file);

int threads_assert(const unsigned *thread,
                   const int location,
                   const char *file);

int cores_assert(const unsigned *core,
                 const int location,
                 const char *file);

int stat_module(char *filename,
                int *kerneltype,
                int *dev_idx);

int init_msr(void);

int finalize_msr(void);

int write_msr_by_coord(unsigned socket,
                       unsigned core,
                       unsigned thread,
                       off_t msr,
                       uint64_t val);

int read_msr_by_coord(unsigned socket,
                      unsigned core,
                      unsigned thread,
                      off_t msr,
                      uint64_t *val);

int read_msr_by_coord_batch(unsigned socket,
                            unsigned core,
                            unsigned thread,
                            off_t msr,
                            uint64_t **val,
                            int batchnum);

int read_batch(const int batchnum);

int write_batch(const int batchnum);

int load_socket_batch(off_t msr,
                      uint64_t **val,
                      const int batchnum);

int load_core_batch(off_t msr,
                    uint64_t **val,
                    const int batchnum);

int load_thread_batch(off_t msr,
                      uint64_t **val,
                      const int batchnum);

int read_msr_by_idx(int dev_idx,
                    off_t msr,
                    uint64_t *val);

int write_msr_by_idx(int dev_idx,
                     off_t msr,
                     uint64_t val);

//
int write_msr_by_idx_and_verify(int dev_idx,
                                off_t msr,
                                uint64_t val);

#ifdef __cplusplus
}
#endif
#endif