op_events.h

Go to the documentation of this file.

#ifndef OP_EVENTS_H
#define OP_EVENTS_H

#ifdef __cplusplus
extern "C" {
#endif

#include "op_cpu_type.h"
#include "op_types.h"
#include "op_list.h"

#define EXTRA_EDGE (1U << 18)
#define EXTRA_ANY  (1U << 21)
#define EXTRA_INV  (1U << 23)
#define EXTRA_CMASK_SHIFT 24
#define EXTRA_CMASK_MASK 0xff

/*
 * For timer based sampling some targets (e.g. s390) use a virtual
 * counter whose file system resides in /dev/oprofile/timer.  These
 * macros set the values used to define a specific timer event solely
 * used by the timer counter.
 */
#define TIMER_EVENT_NAME           "TIMER"
#define TIMER_EVENT_UNIT_MASK_NAME "timer_unit_mask"
#define TIMER_EVENT_DESC           "Timer based sampling"
#define TIMER_EVENT_VALUE          (u32)-1

enum unit_mask_type {
    utm_mandatory,      
    utm_exclusive,      
    utm_bitmask     
};

#define MAX_UNIT_MASK 32


struct op_unit_mask {
    char * name;        
    u32 num;        
    enum unit_mask_type unit_type_mask;
    u32 default_mask;   
    struct op_described_um {
            u32 extra;
        u32 value;
        char * desc;
    } um[MAX_UNIT_MASK];
    struct list_head um_next; 
    int used;                 
};


struct op_event {
    u32 counter_mask;   
    u32 val;        
    struct op_unit_mask * unit;         
    char * name;        
    char * desc;        
    int min_count;      
    int filter;     
    char * ext;     
    struct list_head event_next;   
};

struct list_head * op_events(op_cpu cpu_type);

struct op_event * op_find_event(op_cpu cpu_type, u32 nr, u32 um);
struct op_event * op_find_event_any(op_cpu cpu_type, u32 nr);

struct op_event * find_event_by_name(char const * name, unsigned um,
                                     int um_valid);

char const * find_mapping_for_event(u32 val, op_cpu cpu_type);


enum op_event_check {
    OP_OK_EVENT = 0, 
    OP_INVALID_EVENT = 1, 
    OP_INVALID_UM = 2, 
    OP_INVALID_COUNTER = 4 
};

int op_check_events(int ctr, u32 event, u32 um, op_cpu cpu_type);

void op_free_events(void);

struct op_default_event_descr {
    char * name;
    unsigned long count;
    unsigned long um;
};

void op_default_event(op_cpu cpu_type, struct op_default_event_descr * descr);

struct parsed_event;
void op_resolve_unit_mask(struct parsed_event *pe, u32 *extra);

#ifdef __cplusplus
}
#endif

#endif /* OP_EVENTS_H */