SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/perf_counter.h

   1 /*
   2  *  Performance counters:
   3  *
   4  *   Copyright(C) 2008, Thomas Gleixner <tglx@linutronix.de>
   5  *   Copyright(C) 2008, Red Hat, Inc., Ingo Molnar
   6  *
   7  *  Data type definitions, declarations, prototypes.
   8  *
   9  *  Started by: Thomas Gleixner and Ingo Molnar
  10  *
  11  *  For licencing details see kernel-base/COPYING
  12  */
  13 #ifndef _LINUX_PERF_COUNTER_H
  14 #define _LINUX_PERF_COUNTER_H
  15
  16 #include <linux/types.h>
  17 #include <linux/ioctl.h>
  18 #include <asm/byteorder.h>
  19
  20 /*
  21  * User-space ABI bits:
  22  */
  23
  24 /*
  25  * hw_event.type
  26  */
  27 enum perf_event_types {
  28         PERF_TYPE_HARDWARE              = 0,
  29         PERF_TYPE_SOFTWARE              = 1,
  30         PERF_TYPE_TRACEPOINT            = 2,
  31
  32         /*
  33          * available TYPE space, raw is the max value.
  34          */
  35
  36         PERF_TYPE_RAW                   = 128,
  37 };
  38
  39 /*
  40  * Generalized performance counter event types, used by the hw_event.event_id
  41  * parameter of the sys_perf_counter_open() syscall:
  42  */
  43 enum hw_event_ids {
  44         /*
  45          * Common hardware events, generalized by the kernel:
  46          */
  47         PERF_COUNT_CPU_CYCLES           = 0,
  48         PERF_COUNT_INSTRUCTIONS         = 1,
  49         PERF_COUNT_CACHE_REFERENCES     = 2,
  50         PERF_COUNT_CACHE_MISSES         = 3,
  51         PERF_COUNT_BRANCH_INSTRUCTIONS  = 4,
  52         PERF_COUNT_BRANCH_MISSES        = 5,
  53         PERF_COUNT_BUS_CYCLES           = 6,
  54
  55         PERF_HW_EVENTS_MAX              = 7,
  56 };
  57
  58 /*
  59  * Special "software" counters provided by the kernel, even if the hardware
  60  * does not support performance counters. These counters measure various
  61  * physical and sw events of the kernel (and allow the profiling of them as
  62  * well):
  63  */
  64 enum sw_event_ids {
  65         PERF_COUNT_CPU_CLOCK            = 0,
  66         PERF_COUNT_TASK_CLOCK           = 1,
  67         PERF_COUNT_PAGE_FAULTS          = 2,
  68         PERF_COUNT_CONTEXT_SWITCHES     = 3,
  69         PERF_COUNT_CPU_MIGRATIONS       = 4,
  70         PERF_COUNT_PAGE_FAULTS_MIN      = 5,
  71         PERF_COUNT_PAGE_FAULTS_MAJ      = 6,
  72
  73         PERF_SW_EVENTS_MAX              = 7,
  74 };
  75
  76 /*
  77  * IRQ-notification data record type:
  78  */
  79 enum perf_counter_record_type {
  80         PERF_RECORD_SIMPLE              = 0,
  81         PERF_RECORD_IRQ                 = 1,
  82         PERF_RECORD_GROUP               = 2,
  83 };
  84
  85 #define __PERF_COUNTER_MASK(name)                       \
  86         (((1ULL << PERF_COUNTER_##name##_BITS) - 1) <<  \
  87          PERF_COUNTER_##name##_SHIFT)
  88
  89 #define PERF_COUNTER_RAW_BITS           1
  90 #define PERF_COUNTER_RAW_SHIFT          63
  91 #define PERF_COUNTER_RAW_MASK           __PERF_COUNTER_MASK(RAW)
  92
  93 #define PERF_COUNTER_CONFIG_BITS        63
  94 #define PERF_COUNTER_CONFIG_SHIFT       0
  95 #define PERF_COUNTER_CONFIG_MASK        __PERF_COUNTER_MASK(CONFIG)
  96
  97 #define PERF_COUNTER_TYPE_BITS          7
  98 #define PERF_COUNTER_TYPE_SHIFT         56
  99 #define PERF_COUNTER_TYPE_MASK          __PERF_COUNTER_MASK(TYPE)
 100
 101 #define PERF_COUNTER_EVENT_BITS         56
 102 #define PERF_COUNTER_EVENT_SHIFT        0
 103 #define PERF_COUNTER_EVENT_MASK         __PERF_COUNTER_MASK(EVENT)
 104
 105 /*
 106  * Hardware event to monitor via a performance monitoring counter:
 107  */
 108 struct perf_counter_hw_event {
 109         /*
 110          * The MSB of the config word signifies if the rest contains cpu
 111          * specific (raw) counter configuration data, if unset, the next
 112          * 7 bits are an event type and the rest of the bits are the event
 113          * identifier.
 114          */
 115         __u64                   config;
 116
 117         __u64                   irq_period;
 118         __u64                   record_type;
 119         __u64                   read_format;
 120
 121         __u64                   disabled       :  1, /* off by default        */
 122                                 nmi            :  1, /* NMI sampling          */
 123                                 inherit        :  1, /* children inherit it   */
 124                                 pinned         :  1, /* must always be on PMU */
 125                                 exclusive      :  1, /* only group on PMU     */
 126                                 exclude_user   :  1, /* don't count user      */
 127                                 exclude_kernel :  1, /* ditto kernel          */
 128                                 exclude_hv     :  1, /* ditto hypervisor      */
 129                                 exclude_idle   :  1, /* don't count when idle */
 130
 131                                 __reserved_1   : 55;
 132
 133         __u32                   extra_config_len;
 134         __u32                   __reserved_4;
 135
 136         __u64                   __reserved_2;
 137         __u64                   __reserved_3;
 138 };
 139
 140 /*
 141  * Ioctls that can be done on a perf counter fd:
 142  */
 143 #define PERF_COUNTER_IOC_ENABLE         _IO('$', 0)
 144 #define PERF_COUNTER_IOC_DISABLE        _IO('$', 1)
 145
 146 #ifdef __KERNEL__
 147 /*
 148  * Kernel-internal data types and definitions:
 149  */
 150
 151 #ifdef CONFIG_PERF_COUNTERS
 152 # include <asm/perf_counter.h>
 153 #endif
 154
 155 #include <linux/list.h>
 156 #include <linux/mutex.h>
 157 #include <linux/rculist.h>
 158 #include <linux/rcupdate.h>
 159 #include <linux/spinlock.h>
 160 #include <linux/hrtimer.h>
 161 #include <asm/atomic.h>
 162
 163 struct task_struct;
 164
 165 static inline u64 perf_event_raw(struct perf_counter_hw_event *hw_event)
 166 {
 167         return hw_event->config & PERF_COUNTER_RAW_MASK;
 168 }
 169
 170 static inline u64 perf_event_config(struct perf_counter_hw_event *hw_event)
 171 {
 172         return hw_event->config & PERF_COUNTER_CONFIG_MASK;
 173 }
 174
 175 static inline u64 perf_event_type(struct perf_counter_hw_event *hw_event)
 176 {
 177         return (hw_event->config & PERF_COUNTER_TYPE_MASK) >>
 178                 PERF_COUNTER_TYPE_SHIFT;
 179 }
 180
 181 static inline u64 perf_event_id(struct perf_counter_hw_event *hw_event)
 182 {
 183         return hw_event->config & PERF_COUNTER_EVENT_MASK;
 184 }
 185
 186 /**
 187  * struct hw_perf_counter - performance counter hardware details:
 188  */
 189 struct hw_perf_counter {
 190 #ifdef CONFIG_PERF_COUNTERS
 191         union {
 192                 struct { /* hardware */
 193                         u64                             config;
 194                         unsigned long                   config_base;
 195                         unsigned long                   counter_base;
 196                         int                             nmi;
 197                         unsigned int                    idx;
 198                 };
 199                 union { /* software */
 200                         atomic64_t                      count;
 201                         struct hrtimer                  hrtimer;
 202                 };
 203         };
 204         atomic64_t                      prev_count;
 205         u64                             irq_period;
 206         atomic64_t                      period_left;
 207 #endif
 208 };
 209
 210 /*
 211  * Hardcoded buffer length limit for now, for IRQ-fed events:
 212  */
 213 #define PERF_DATA_BUFLEN                2048
 214
 215 /**
 216  * struct perf_data - performance counter IRQ data sampling ...
 217  */
 218 struct perf_data {
 219         int                             len;
 220         int                             rd_idx;
 221         int                             overrun;
 222         u8                              data[PERF_DATA_BUFLEN];
 223 };
 224
 225 struct perf_counter;
 226
 227 /**
 228  * struct hw_perf_counter_ops - performance counter hw ops
 229  */
 230 struct hw_perf_counter_ops {
 231         int (*enable)                   (struct perf_counter *counter);
 232         void (*disable)                 (struct perf_counter *counter);
 233         void (*read)                    (struct perf_counter *counter);
 234 };
 235
 236 /**
 237  * enum perf_counter_active_state - the states of a counter
 238  */
 239 enum perf_counter_active_state {
 240         PERF_COUNTER_STATE_ERROR        = -2,
 241         PERF_COUNTER_STATE_OFF          = -1,
 242         PERF_COUNTER_STATE_INACTIVE     =  0,
 243         PERF_COUNTER_STATE_ACTIVE       =  1,
 244 };
 245
 246 struct file;
 247
 248 /**
 249  * struct perf_counter - performance counter kernel representation:
 250  */
 251 struct perf_counter {
 252 #ifdef CONFIG_PERF_COUNTERS
 253         struct list_head                list_entry;
 254         struct list_head                event_entry;
 255         struct list_head                sibling_list;
 256         struct perf_counter             *group_leader;
 257         const struct hw_perf_counter_ops *hw_ops;
 258
 259         enum perf_counter_active_state  state;
 260         enum perf_counter_active_state  prev_state;
 261         atomic64_t                      count;
 262
 263         struct perf_counter_hw_event    hw_event;
 264         struct hw_perf_counter          hw;
 265
 266         struct perf_counter_context     *ctx;
 267         struct task_struct              *task;
 268         struct file                     *filp;
 269
 270         struct perf_counter             *parent;
 271         struct list_head                child_list;
 272
 273         /*
 274          * Protect attach/detach and child_list:
 275          */
 276         struct mutex                    mutex;
 277
 278         int                             oncpu;
 279         int                             cpu;
 280
 281         /* read() / irq related data */
 282         wait_queue_head_t               waitq;
 283         /* optional: for NMIs */
 284         int                             wakeup_pending;
 285         struct perf_data                *irqdata;
 286         struct perf_data                *usrdata;
 287         struct perf_data                data[2];
 288
 289         void (*destroy)(struct perf_counter *);
 290         struct rcu_head                 rcu_head;
 291 #endif
 292 };
 293
 294 /**
 295  * struct perf_counter_context - counter context structure
 296  *
 297  * Used as a container for task counters and CPU counters as well:
 298  */
 299 struct perf_counter_context {
 300 #ifdef CONFIG_PERF_COUNTERS
 301         /*
 302          * Protect the states of the counters in the list,
 303          * nr_active, and the list:
 304          */
 305         spinlock_t              lock;
 306         /*
 307          * Protect the list of counters.  Locking either mutex or lock
 308          * is sufficient to ensure the list doesn't change; to change
 309          * the list you need to lock both the mutex and the spinlock.
 310          */
 311         struct mutex            mutex;
 312
 313         struct list_head        counter_list;
 314         struct list_head        event_list;
 315         int                     nr_counters;
 316         int                     nr_active;
 317         int                     is_active;
 318         struct task_struct      *task;
 319 #endif
 320 };
 321
 322 /**
 323  * struct perf_counter_cpu_context - per cpu counter context structure
 324  */
 325 struct perf_cpu_context {
 326         struct perf_counter_context     ctx;
 327         struct perf_counter_context     *task_ctx;
 328         int                             active_oncpu;
 329         int                             max_pertask;
 330         int                             exclusive;
 331 };
 332
 333 /*
 334  * Set by architecture code:
 335  */
 336 extern int perf_max_counters;
 337
 338 #ifdef CONFIG_PERF_COUNTERS
 339 extern const struct hw_perf_counter_ops *
 340 hw_perf_counter_init(struct perf_counter *counter);
 341
 342 extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
 343 extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
 344 extern void perf_counter_task_tick(struct task_struct *task, int cpu);
 345 extern void perf_counter_init_task(struct task_struct *child);
 346 extern void perf_counter_exit_task(struct task_struct *child);
 347 extern void perf_counter_notify(struct pt_regs *regs);
 348 extern void perf_counter_print_debug(void);
 349 extern void perf_counter_unthrottle(void);
 350 extern u64 hw_perf_save_disable(void);
 351 extern void hw_perf_restore(u64 ctrl);
 352 extern int perf_counter_task_disable(void);
 353 extern int perf_counter_task_enable(void);
 354 extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
 355                struct perf_cpu_context *cpuctx,
 356                struct perf_counter_context *ctx, int cpu);
 357
 358 extern void perf_counter_output(struct perf_counter *counter,
 359                                 int nmi, struct pt_regs *regs);
 360 /*
 361  * Return 1 for a software counter, 0 for a hardware counter
 362  */
 363 static inline int is_software_counter(struct perf_counter *counter)
 364 {
 365         return !perf_event_raw(&counter->hw_event) &&
 366                 perf_event_type(&counter->hw_event) != PERF_TYPE_HARDWARE;
 367 }
 368
 369 extern void perf_swcounter_event(u32, u64, int, struct pt_regs *);
 370
 371 #else
 372 static inline void
 373 perf_counter_task_sched_in(struct task_struct *task, int cpu)           { }
 374 static inline void
 375 perf_counter_task_sched_out(struct task_struct *task, int cpu)          { }
 376 static inline void
 377 perf_counter_task_tick(struct task_struct *task, int cpu)               { }
 378 static inline void perf_counter_init_task(struct task_struct *child)    { }
 379 static inline void perf_counter_exit_task(struct task_struct *child)    { }
 380 static inline void perf_counter_notify(struct pt_regs *regs)            { }
 381 static inline void perf_counter_print_debug(void)                       { }
 382 static inline void perf_counter_unthrottle(void)                        { }
 383 static inline void hw_perf_restore(u64 ctrl)                            { }
 384 static inline u64 hw_perf_save_disable(void)                  { return 0; }
 385 static inline int perf_counter_task_disable(void)       { return -EINVAL; }
 386 static inline int perf_counter_task_enable(void)        { return -EINVAL; }
 387
 388 static inline void perf_swcounter_event(u32 event, u64 nr,
 389                                         int nmi, struct pt_regs *regs)  { }
 390 #endif
 391
 392 #endif /* __KERNEL__ */
 393 #endif /* _LINUX_PERF_COUNTER_H */