perfmon_types.h

/*
 * =======================================================================================
 *
 *      Filename:  perfmon_types.h
 *
 *      Description:  Header File of perfmon module.
 *                    Configures and reads out performance counters
 *                    on x86 based architectures. Supports multi threading.
 *
 *      Version:   4.1
 *      Released:  19.5.2016
 *
 *      Author:   Jan Treibig (jt), jan.treibig@gmail.com
 *                Thomas Roehl (tr), thomas.roehl@googlemail.com
 *      Project:  likwid
 *
 *      Copyright (C) 2016 RRZE, University Erlangen-Nuremberg
 *
 *      This program is free software: you can redistribute it and/or modify it under
 *      the terms of the GNU General Public License as published by the Free Software
 *      Foundation, either version 3 of the License, or (at your option) any later
 *      version.
 *
 *      This program 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 General Public License for more details.
 *
 *      You should have received a copy of the GNU General Public License along with
 *      this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * =======================================================================================
 */

#ifndef PERFMON_TYPES_H
#define PERFMON_TYPES_H

#include <bstrlib.h>
#include <timer.h>
#include <inttypes.h>
#include <perfgroup.h>

#define MAX_EVENT_OPTIONS NUM_EVENT_OPTIONS

/* #####   EXPORTED TYPE DEFINITIONS   #################################### */


typedef enum {
    EVENT_OPTION_NONE = 0, 
    EVENT_OPTION_OPCODE, 
    EVENT_OPTION_MATCH0, 
    EVENT_OPTION_MATCH1, 
    EVENT_OPTION_MATCH2, 
    EVENT_OPTION_MATCH3, 
    EVENT_OPTION_MASK0, 
    EVENT_OPTION_MASK1, 
    EVENT_OPTION_MASK2, 
    EVENT_OPTION_MASK3, 
    EVENT_OPTION_NID, 
    EVENT_OPTION_TID, 
    EVENT_OPTION_STATE, 
    EVENT_OPTION_EDGE, 
    EVENT_OPTION_THRESHOLD, 
    EVENT_OPTION_INVERT, 
    EVENT_OPTION_COUNT_KERNEL, 
    EVENT_OPTION_ANYTHREAD, 
    EVENT_OPTION_OCCUPANCY, 
    EVENT_OPTION_OCCUPANCY_FILTER, 
    EVENT_OPTION_OCCUPANCY_EDGE, 
    EVENT_OPTION_OCCUPANCY_INVERT, 
    EVENT_OPTION_IN_TRANS, 
    EVENT_OPTION_IN_TRANS_ABORT, 
    NUM_EVENT_OPTIONS 
} EventOptionType;

typedef enum {
    STATE_NONE = 0, 
    STATE_SETUP, 
    STATE_START, 
} GroupState;

extern char* eventOptionTypeName[NUM_EVENT_OPTIONS];

#define EVENT_OPTION_NONE_MASK 0x0ULL

#define OPTIONS_TYPE_MASK(type) \
        (((type == EVENT_OPTION_NONE)||(type >= NUM_EVENT_OPTIONS)) ? \
        EVENT_OPTION_NONE_MASK : \
        (1ULL<<type))


#define EVENT_OPTION_OPCODE_MASK (1ULL<<EVENT_OPTION_OPCODE)
#define EVENT_OPTION_MATCH0_MASK (1ULL<<EVENT_OPTION_MATCH0)
#define EVENT_OPTION_MATCH1_MASK (1ULL<<EVENT_OPTION_MATCH1)
#define EVENT_OPTION_MATCH2_MASK (1ULL<<EVENT_OPTION_MATCH2)
#define EVENT_OPTION_MATCH3_MASK (1ULL<<EVENT_OPTION_MATCH3)
#define EVENT_OPTION_MASK0_MASK (1ULL<<EVENT_OPTION_MASK0)
#define EVENT_OPTION_MASK1_MASK (1ULL<<EVENT_OPTION_MASK1)
#define EVENT_OPTION_MASK2_MASK (1ULL<<EVENT_OPTION_MASK2)
#define EVENT_OPTION_MASK3_MASK (1ULL<<EVENT_OPTION_MASK3)
#define EVENT_OPTION_NID_MASK (1ULL<<EVENT_OPTION_NID)
#define EVENT_OPTION_TID_MASK (1ULL<<EVENT_OPTION_TID)
#define EVENT_OPTION_STATE_MASK (1ULL<<EVENT_OPTION_STATE)
#define EVENT_OPTION_EDGE_MASK (1ULL<<EVENT_OPTION_EDGE)
#define EVENT_OPTION_THRESHOLD_MASK (1ULL<<EVENT_OPTION_THRESHOLD)
#define EVENT_OPTION_INVERT_MASK (1ULL<<EVENT_OPTION_INVERT)
#define EVENT_OPTION_COUNT_KERNEL_MASK (1ULL<<EVENT_OPTION_COUNT_KERNEL)
#define EVENT_OPTION_ANYTHREAD_MASK (1ULL<<EVENT_OPTION_ANYTHREAD)
#define EVENT_OPTION_OCCUPANCY_MASK (1ULL<<EVENT_OPTION_OCCUPANCY)
#define EVENT_OPTION_OCCUPANCY_FILTER_MASK (1ULL<<EVENT_OPTION_OCCUPANCY_FILTER)
#define EVENT_OPTION_OCCUPANCY_EDGE_MASK (1ULL<<EVENT_OPTION_OCCUPANCY_EDGE)
#define EVENT_OPTION_OCCUPANCY_INVERT_MASK (1ULL<<EVENT_OPTION_OCCUPANCY_INVERT)
#define EVENT_OPTION_IN_TRANS_MASK (1ULL<<EVENT_OPTION_IN_TRANS)
#define EVENT_OPTION_IN_TRANS_ABORT_MASK (1ULL<<EVENT_OPTION_IN_TRANS_ABORT)

typedef struct {
    int             thread_id; 
    int             processorId; 
} PerfmonThread;

typedef struct {
    EventOptionType      type; 
    uint64_t             value; 
} PerfmonEventOption;

typedef struct {
    const char*     name; 
    const char*     limit; 
    uint16_t        eventId; 
    uint8_t         umask; 
    uint8_t         cfgBits; 
    uint64_t        cmask; 
    uint8_t         numberOfOptions; 
    uint64_t        optionMask; 
    PerfmonEventOption options[NUM_EVENT_OPTIONS]; 
} PerfmonEvent;

typedef struct {
    int         init; 
    int         id; 
    int         overflows; 
    uint64_t    startData; 
    uint64_t    counterData; 
    double      lastResult; 
    double      fullResult; 
} PerfmonCounter;


typedef struct {
    PerfmonEvent        event; 
    RegisterIndex       index; 
    RegisterType        type; 
    PerfmonCounter*     threadCounter; 
} PerfmonEventSetEntry;

typedef struct {
    int                   numberOfEvents; 
    PerfmonEventSetEntry* events; 
    TimerData             timer; 
    double                rdtscTime; 
    double                runTime; 
#ifdef __x86_64
    __uint128_t           regTypeMask; 
#else
    uint64_t              regTypeMask; 
#endif
    GroupState            state; 
    GroupInfo             group; 
} PerfmonEventSet;

typedef struct {
    int              numberOfGroups; 
    int              numberOfActiveGroups; 
    int              activeGroup; 
    PerfmonEventSet* groups; 
    int              numberOfThreads; 
    PerfmonThread*   threads; 
} PerfmonGroupSet;

extern RegisterMap* counter_map;
extern BoxMap* box_map;
extern PerfmonEvent* eventHash;
extern PciDevice* pci_devices;
/* perfmon datatypes */
extern PerfmonGroupSet *groupSet;
extern int perfmon_numCounters;
extern int perfmon_numCoreCounters;
extern int perfmon_numUncoreCounters;
extern int perfmon_numArchEvents;


#endif /*PERFMON_TYPES_H*/