include/asm-ia64/perfmon.h

   1 /*
   2  * Copyright (C) 2001-2003 Hewlett-Packard Co
   3  *               Stephane Eranian <eranian@hpl.hp.com>
   4  */
   5
   6 #ifndef _ASM_IA64_PERFMON_H
   7 #define _ASM_IA64_PERFMON_H
   8
   9 /*
  10  * perfmon comamnds supported on all CPU models
  11  */
  12 #define PFM_WRITE_PMCS          0x01
  13 #define PFM_WRITE_PMDS          0x02
  14 #define PFM_READ_PMDS           0x03
  15 #define PFM_STOP                0x04
  16 #define PFM_START               0x05
  17 #define PFM_ENABLE              0x06 /* obsolete */
  18 #define PFM_DISABLE             0x07 /* obsolete */
  19 #define PFM_CREATE_CONTEXT      0x08
  20 #define PFM_DESTROY_CONTEXT     0x09 /* obsolete use close() */
  21 #define PFM_RESTART             0x0a
  22 #define PFM_PROTECT_CONTEXT     0x0b /* obsolete */
  23 #define PFM_GET_FEATURES        0x0c
  24 #define PFM_DEBUG               0x0d
  25 #define PFM_UNPROTECT_CONTEXT   0x0e /* obsolete */
  26 #define PFM_GET_PMC_RESET_VAL   0x0f
  27 #define PFM_LOAD_CONTEXT        0x10
  28 #define PFM_UNLOAD_CONTEXT      0x11
  29
  30 /*
  31  * PMU model specific commands (may not be supported on all PMU models)
  32  */
  33 #define PFM_WRITE_IBRS          0x20
  34 #define PFM_WRITE_DBRS          0x21
  35
  36 /*
  37  * context flags
  38  */
  39 #define PFM_FL_NOTIFY_BLOCK      0x01   /* block task on user level notifications */
  40 #define PFM_FL_SYSTEM_WIDE       0x02   /* create a system wide context */
  41 #define PFM_FL_OVFL_NO_MSG       0x80   /* do not post overflow/end messages for notification */
  42
  43 /*
  44  * event set flags
  45  */
  46 #define PFM_SETFL_EXCL_IDLE      0x01   /* exclude idle task (syswide only) XXX: DO NOT USE YET */
  47
  48 /*
  49  * PMC flags
  50  */
  51 #define PFM_REGFL_OVFL_NOTIFY   0x1     /* send notification on overflow */
  52 #define PFM_REGFL_RANDOM        0x2     /* randomize sampling interval   */
  53
  54 /*
  55  * PMD/PMC/IBR/DBR return flags (ignored on input)
  56  *
  57  * Those flags are used on output and must be checked in case EAGAIN is returned
  58  * by any of the calls using a pfarg_reg_t or pfarg_dbreg_t structure.
  59  */
  60 #define PFM_REG_RETFL_NOTAVAIL  (1UL<<31) /* set if register is implemented but not available */
  61 #define PFM_REG_RETFL_EINVAL    (1UL<<30) /* set if register entry is invalid */
  62 #define PFM_REG_RETFL_MASK      (PFM_REG_RETFL_NOTAVAIL|PFM_REG_RETFL_EINVAL)
  63
  64 #define PFM_REG_HAS_ERROR(flag) (((flag) & PFM_REG_RETFL_MASK) != 0)
  65
  66 typedef unsigned char pfm_uuid_t[16];   /* custom sampling buffer identifier type */
  67
  68 /*
  69  * Request structure used to define a context
  70  */
  71 typedef struct {
  72         pfm_uuid_t     ctx_smpl_buf_id;  /* which buffer format to use (if needed) */
  73         unsigned long  ctx_flags;        /* noblock/block */
  74         unsigned short ctx_nextra_sets;  /* number of extra event sets (you always get 1) */
  75         unsigned short ctx_reserved1;    /* for future use */
  76         int            ctx_fd;           /* return arg: unique identification for context */
  77         void           *ctx_smpl_vaddr;  /* return arg: virtual address of sampling buffer, is used */
  78         unsigned long  ctx_reserved2[11];/* for future use */
  79 } pfarg_context_t;
  80
  81 /*
  82  * Request structure used to write/read a PMC or PMD
  83  */
  84 typedef struct {
  85         unsigned int    reg_num;           /* which register */
  86         unsigned short  reg_set;           /* event set for this register */
  87         unsigned short  reg_reserved1;     /* for future use */
  88
  89         unsigned long   reg_value;         /* initial pmc/pmd value */
  90         unsigned long   reg_flags;         /* input: pmc/pmd flags, return: reg error */
  91
  92         unsigned long   reg_long_reset;    /* reset after buffer overflow notification */
  93         unsigned long   reg_short_reset;   /* reset after counter overflow */
  94
  95         unsigned long   reg_reset_pmds[4]; /* which other counters to reset on overflow */
  96         unsigned long   reg_random_seed;   /* seed value when randomization is used */
  97         unsigned long   reg_random_mask;   /* bitmask used to limit random value */
  98         unsigned long   reg_last_reset_val;/* return: PMD last reset value */
  99
 100         unsigned long   reg_smpl_pmds[4];  /* which pmds are accessed when PMC overflows */
 101         unsigned long   reg_smpl_eventid;  /* opaque sampling event identifier */
 102
 103         unsigned long   reg_reserved2[3];   /* for future use */
 104 } pfarg_reg_t;
 105
 106 typedef struct {
 107         unsigned int    dbreg_num;              /* which debug register */
 108         unsigned short  dbreg_set;              /* event set for this register */
 109         unsigned short  dbreg_reserved1;        /* for future use */
 110         unsigned long   dbreg_value;            /* value for debug register */
 111         unsigned long   dbreg_flags;            /* return: dbreg error */
 112         unsigned long   dbreg_reserved2[1];     /* for future use */
 113 } pfarg_dbreg_t;
 114
 115 typedef struct {
 116         unsigned int    ft_version;     /* perfmon: major [16-31], minor [0-15] */
 117         unsigned int    ft_reserved;    /* reserved for future use */
 118         unsigned long   reserved[4];    /* for future use */
 119 } pfarg_features_t;
 120
 121 typedef struct {
 122         pid_t           load_pid;          /* process to load the context into */
 123         unsigned short  load_set;          /* first event set to load */
 124         unsigned short  load_reserved1;    /* for future use */
 125         unsigned long   load_reserved2[3]; /* for future use */
 126 } pfarg_load_t;
 127
 128 typedef struct {
 129         int             msg_type;               /* generic message header */
 130         int             msg_ctx_fd;             /* generic message header */
 131         unsigned long   msg_ovfl_pmds[4];       /* which PMDs overflowed */
 132         unsigned short  msg_active_set;         /* active set at the time of overflow */
 133         unsigned short  msg_reserved1;          /* for future use */
 134         unsigned int    msg_reserved2;          /* for future use */
 135         unsigned long   msg_tstamp;             /* for perf tuning/debug */
 136 } pfm_ovfl_msg_t;
 137
 138 typedef struct {
 139         int             msg_type;               /* generic message header */
 140         int             msg_ctx_fd;             /* generic message header */
 141         unsigned long   msg_tstamp;             /* for perf tuning */
 142 } pfm_end_msg_t;
 143
 144 typedef struct {
 145         int             msg_type;               /* type of the message */
 146         int             msg_ctx_fd;             /* unique identifier for the context */
 147         unsigned long   msg_tstamp;             /* for perf tuning */
 148 } pfm_gen_msg_t;
 149
 150 #define PFM_MSG_OVFL    1       /* an overflow happened */
 151 #define PFM_MSG_END     2       /* task to which context was attached ended */
 152
 153 typedef union {
 154         pfm_ovfl_msg_t  pfm_ovfl_msg;
 155         pfm_end_msg_t   pfm_end_msg;
 156         pfm_gen_msg_t   pfm_gen_msg;
 157 } pfm_msg_t;
 158
 159 /*
 160  * Define the version numbers for both perfmon as a whole and the sampling buffer format.
 161  */
 162 #define PFM_VERSION_MAJ          2U
 163 #define PFM_VERSION_MIN          0U
 164 #define PFM_VERSION              (((PFM_VERSION_MAJ&0xffff)<<16)|(PFM_VERSION_MIN & 0xffff))
 165 #define PFM_VERSION_MAJOR(x)     (((x)>>16) & 0xffff)
 166 #define PFM_VERSION_MINOR(x)     ((x) & 0xffff)
 167
 168
 169 /*
 170  * miscellaneous architected definitions
 171  */
 172 #define PMU_FIRST_COUNTER       4       /* first counting monitor (PMC/PMD) */
 173 #define PMU_MAX_PMCS            256     /* maximum architected number of PMC registers */
 174 #define PMU_MAX_PMDS            256     /* maximum architected number of PMD registers */
 175
 176 #ifdef __KERNEL__
 177
 178 extern long perfmonctl(int fd, int cmd, void *arg, int narg);
 179
 180 extern void pfm_save_regs (struct task_struct *);
 181 extern void pfm_load_regs (struct task_struct *);
 182
 183 extern void pfm_exit_thread(struct task_struct *);
 184 extern int  pfm_use_debug_registers(struct task_struct *);
 185 extern int  pfm_release_debug_registers(struct task_struct *);
 186 extern void pfm_syst_wide_update_task(struct task_struct *, unsigned long info, int is_ctxswin);
 187 extern void pfm_inherit(struct task_struct *task, struct pt_regs *regs);
 188 extern void pfm_init_percpu(void);
 189 extern void pfm_handle_work(void);
 190
 191 /*
 192  * Reset PMD register flags
 193  */
 194 #define PFM_PMD_SHORT_RESET     0
 195 #define PFM_PMD_LONG_RESET      1
 196
 197 typedef union {
 198         unsigned int val;
 199         struct {
 200                 unsigned int notify_user:1;     /* notify user program of overflow */
 201                 unsigned int reset_ovfl_pmds:1; /* reset overflowed PMDs */
 202                 unsigned int block_task:1;      /* block monitored task on kernel exit */
 203                 unsigned int mask_monitoring:1; /* mask monitors via PMCx.plm */
 204                 unsigned int reserved:28;       /* for future use */
 205         } bits;
 206 } pfm_ovfl_ctrl_t;
 207
 208 typedef struct {
 209         unsigned char   ovfl_pmd;                       /* index of overflowed PMD  */
 210         unsigned char   ovfl_notify;                    /* =1 if monitor requested overflow notification */
 211         unsigned short  active_set;                     /* event set active at the time of the overflow */
 212         pfm_ovfl_ctrl_t ovfl_ctrl;                      /* return: perfmon controls to set by handler */
 213
 214         unsigned long   pmd_last_reset;                 /* last reset value of of the PMD */
 215         unsigned long   smpl_pmds[4];                   /* bitmask of other PMD of interest on overflow */
 216         unsigned long   smpl_pmds_values[PMU_MAX_PMDS]; /* values for the other PMDs of interest */
 217         unsigned long   pmd_value;                      /* current 64-bit value of the PMD */
 218         unsigned long   pmd_eventid;                    /* eventid associated with PMD */
 219 } pfm_ovfl_arg_t;
 220
 221
 222 typedef struct {
 223         char            *fmt_name;
 224         pfm_uuid_t      fmt_uuid;
 225         size_t          fmt_arg_size;
 226         unsigned long   fmt_flags;
 227
 228         int             (*fmt_validate)(struct task_struct *task, unsigned int flags, int cpu, void *arg);
 229         int             (*fmt_getsize)(struct task_struct *task, unsigned int flags, int cpu, void *arg, unsigned long *size);
 230         int             (*fmt_init)(struct task_struct *task, void *buf, unsigned int flags, int cpu, void *arg);
 231         int             (*fmt_handler)(struct task_struct *task, void *buf, pfm_ovfl_arg_t *arg, struct pt_regs *regs, unsigned long stamp);
 232         int             (*fmt_restart)(struct task_struct *task, pfm_ovfl_ctrl_t *ctrl, void *buf, struct pt_regs *regs);
 233         int             (*fmt_restart_active)(struct task_struct *task, pfm_ovfl_ctrl_t *ctrl, void *buf, struct pt_regs *regs);
 234         int             (*fmt_exit)(struct task_struct *task, void *buf, struct pt_regs *regs);
 235
 236         struct list_head fmt_list;
 237 } pfm_buffer_fmt_t;
 238
 239 extern int pfm_register_buffer_fmt(pfm_buffer_fmt_t *fmt);
 240 extern int pfm_unregister_buffer_fmt(pfm_uuid_t uuid);
 241
 242 /*
 243  * perfmon interface exported to modules
 244  */
 245 extern int pfm_mod_read_pmds(struct task_struct *, void *req, unsigned int nreq, struct pt_regs *regs);
 246 extern int pfm_mod_write_pmcs(struct task_struct *, void *req, unsigned int nreq, struct pt_regs *regs);
 247 extern int pfm_mod_write_ibrs(struct task_struct *task, void *req, unsigned int nreq, struct pt_regs *regs);
 248 extern int pfm_mod_write_dbrs(struct task_struct *task, void *req, unsigned int nreq, struct pt_regs *regs);
 249
 250 /*
 251  * describe the content of the local_cpu_date->pfm_syst_info field
 252  */
 253 #define PFM_CPUINFO_SYST_WIDE   0x1     /* if set a system wide session exists */
 254 #define PFM_CPUINFO_DCR_PP      0x2     /* if set the system wide session has started */
 255 #define PFM_CPUINFO_EXCL_IDLE   0x4     /* the system wide session excludes the idle task */
 256
 257 /*
 258  * sysctl control structure. visible to sampling formats
 259  */
 260 typedef struct {
 261         int     debug;          /* turn on/off debugging via syslog */
 262         int     debug_ovfl;     /* turn on/off debug printk in overflow handler */
 263         int     fastctxsw;      /* turn on/off fast (unsecure) ctxsw */
 264         int     expert_mode;    /* turn on/off value checking */
 265 } pfm_sysctl_t;
 266 extern pfm_sysctl_t pfm_sysctl;
 267
 268
 269 #endif /* __KERNEL__ */
 270
 271 #endif /* _ASM_IA64_PERFMON_H */