perf_counter: Add fork event
[safe/jmp/linux-2.6] / include / linux / perf_counter.h
index 7fdbdf8..380247b 100644 (file)
@@ -22,7 +22,7 @@
  */
 
 /*
- * hw_event.type
+ * attr.type
  */
 enum perf_event_types {
        PERF_TYPE_HARDWARE              = 0,
@@ -37,10 +37,10 @@ enum perf_event_types {
 };
 
 /*
- * Generalized performance counter event types, used by the hw_event.event_id
+ * Generalized performance counter event types, used by the attr.event_id
  * parameter of the sys_perf_counter_open() syscall:
  */
-enum hw_event_ids {
+enum attr_ids {
        /*
         * Common hardware events, generalized by the kernel:
         */
@@ -73,16 +73,7 @@ enum sw_event_ids {
        PERF_SW_EVENTS_MAX              = 7,
 };
 
-/*
- * IRQ-notification data record type:
- */
-enum perf_counter_record_type {
-       PERF_RECORD_SIMPLE              = 0,
-       PERF_RECORD_IRQ                 = 1,
-       PERF_RECORD_GROUP               = 2,
-};
-
-#define __PERF_COUNTER_MASK(name)                      \
+#define __PERF_COUNTER_MASK(name)                      \
        (((1ULL << PERF_COUNTER_##name##_BITS) - 1) <<  \
         PERF_COUNTER_##name##_SHIFT)
 
@@ -103,9 +94,35 @@ enum perf_counter_record_type {
 #define PERF_COUNTER_EVENT_MASK                __PERF_COUNTER_MASK(EVENT)
 
 /*
+ * Bits that can be set in attr.sample_type to request information
+ * in the overflow packets.
+ */
+enum perf_counter_sample_format {
+       PERF_SAMPLE_IP                  = 1U << 0,
+       PERF_SAMPLE_TID                 = 1U << 1,
+       PERF_SAMPLE_TIME                = 1U << 2,
+       PERF_SAMPLE_ADDR                = 1U << 3,
+       PERF_SAMPLE_GROUP               = 1U << 4,
+       PERF_SAMPLE_CALLCHAIN           = 1U << 5,
+       PERF_SAMPLE_CONFIG              = 1U << 6,
+       PERF_SAMPLE_CPU                 = 1U << 7,
+};
+
+/*
+ * Bits that can be set in attr.read_format to request that
+ * reads on the counter should return the indicated quantities,
+ * in increasing order of bit value, after the counter value.
+ */
+enum perf_counter_read_format {
+       PERF_FORMAT_TOTAL_TIME_ENABLED  =  1U << 0,
+       PERF_FORMAT_TOTAL_TIME_RUNNING  =  1U << 1,
+       PERF_FORMAT_ID                  =  1U << 2,
+};
+
+/*
  * Hardware event to monitor via a performance monitoring counter:
  */
-struct perf_counter_hw_event {
+struct perf_counter_attr {
        /*
         * The MSB of the config word signifies if the rest contains cpu
         * specific (raw) counter configuration data, if unset, the next
@@ -114,12 +131,15 @@ struct perf_counter_hw_event {
         */
        __u64                   config;
 
-       __u64                   irq_period;
-       __u64                   record_type;
+       union {
+               __u64           sample_period;
+               __u64           sample_freq;
+       };
+
+       __u64                   sample_type;
        __u64                   read_format;
 
        __u64                   disabled       :  1, /* off by default        */
-                               nmi            :  1, /* NMI sampling          */
                                inherit        :  1, /* children inherit it   */
                                pinned         :  1, /* must always be on PMU */
                                exclusive      :  1, /* only group on PMU     */
@@ -127,22 +147,32 @@ struct perf_counter_hw_event {
                                exclude_kernel :  1, /* ditto kernel          */
                                exclude_hv     :  1, /* ditto hypervisor      */
                                exclude_idle   :  1, /* don't count when idle */
-                               include_tid    :  1, /* include the tid */
+                               mmap           :  1, /* include mmap data     */
+                               munmap         :  1, /* include munmap data   */
+                               comm           :  1, /* include comm data     */
+                               freq           :  1, /* use freq, not period  */
 
-                               __reserved_1   : 54;
+                               __reserved_1   : 52;
 
-       __u32                   extra_config_len;
-       __u32                   __reserved_4;
+       __u32                   wakeup_events;  /* wakeup every n events */
+       __u32                   __reserved_2;
 
-       __u64                   __reserved_2;
        __u64                   __reserved_3;
+       __u64                   __reserved_4;
 };
 
 /*
  * Ioctls that can be done on a perf counter fd:
  */
-#define PERF_COUNTER_IOC_ENABLE                _IO('$', 0)
-#define PERF_COUNTER_IOC_DISABLE       _IO('$', 1)
+#define PERF_COUNTER_IOC_ENABLE                _IO ('$', 0)
+#define PERF_COUNTER_IOC_DISABLE       _IO ('$', 1)
+#define PERF_COUNTER_IOC_REFRESH       _IO ('$', 2)
+#define PERF_COUNTER_IOC_RESET         _IO ('$', 3)
+#define PERF_COUNTER_IOC_PERIOD                _IOW('$', 4, u64)
+
+enum perf_counter_ioc_flags {
+       PERF_IOC_FLAG_GROUP             = 1U << 0,
+};
 
 /*
  * Structure of the page that can be mapped via mmap
@@ -150,23 +180,134 @@ struct perf_counter_hw_event {
 struct perf_counter_mmap_page {
        __u32   version;                /* version number of this structure */
        __u32   compat_version;         /* lowest version this is compat with */
+
+       /*
+        * Bits needed to read the hw counters in user-space.
+        *
+        *   u32 seq;
+        *   s64 count;
+        *
+        *   do {
+        *     seq = pc->lock;
+        *
+        *     barrier()
+        *     if (pc->index) {
+        *       count = pmc_read(pc->index - 1);
+        *       count += pc->offset;
+        *     } else
+        *       goto regular_read;
+        *
+        *     barrier();
+        *   } while (pc->lock != seq);
+        *
+        * NOTE: for obvious reason this only works on self-monitoring
+        *       processes.
+        */
        __u32   lock;                   /* seqlock for synchronization */
        __u32   index;                  /* hardware counter identifier */
        __s64   offset;                 /* add to hardware counter value */
 
-       __u32   data_head;              /* head in the data section */
+       /*
+        * Control data for the mmap() data buffer.
+        *
+        * User-space reading this value should issue an rmb(), on SMP capable
+        * platforms, after reading this value -- see perf_counter_wakeup().
+        */
+       __u64   data_head;              /* head in the data section */
 };
 
+#define PERF_EVENT_MISC_CPUMODE_MASK   (3 << 0)
+#define PERF_EVENT_MISC_CPUMODE_UNKNOWN        (0 << 0)
+#define PERF_EVENT_MISC_KERNEL         (1 << 0)
+#define PERF_EVENT_MISC_USER           (2 << 0)
+#define PERF_EVENT_MISC_HYPERVISOR     (3 << 0)
+#define PERF_EVENT_MISC_OVERFLOW       (1 << 2)
+
 struct perf_event_header {
        __u32   type;
-       __u32   size;
+       __u16   misc;
+       __u16   size;
 };
 
 enum perf_event_type {
-       PERF_EVENT_IP           = 0,
-       PERF_EVENT_GROUP        = 1,
 
-       __PERF_EVENT_TID        = 0x100,
+       /*
+        * The MMAP events record the PROT_EXEC mappings so that we can
+        * correlate userspace IPs to code. They have the following structure:
+        *
+        * struct {
+        *      struct perf_event_header        header;
+        *
+        *      u32                             pid, tid;
+        *      u64                             addr;
+        *      u64                             len;
+        *      u64                             pgoff;
+        *      char                            filename[];
+        * };
+        */
+       PERF_EVENT_MMAP                 = 1,
+       PERF_EVENT_MUNMAP               = 2,
+
+       /*
+        * struct {
+        *      struct perf_event_header        header;
+        *
+        *      u32                             pid, tid;
+        *      char                            comm[];
+        * };
+        */
+       PERF_EVENT_COMM                 = 3,
+
+       /*
+        * struct {
+        *      struct perf_event_header        header;
+        *      u64                             time;
+        *      u64                             sample_period;
+        * };
+        */
+       PERF_EVENT_PERIOD               = 4,
+
+       /*
+        * struct {
+        *      struct perf_event_header        header;
+        *      u64                             time;
+        * };
+        */
+       PERF_EVENT_THROTTLE             = 5,
+       PERF_EVENT_UNTHROTTLE           = 6,
+
+       /*
+        * struct {
+        *      struct perf_event_header        header;
+        *      u32                             pid, ppid;
+        * };
+        */
+       PERF_EVENT_FORK                 = 7,
+
+       /*
+        * When header.misc & PERF_EVENT_MISC_OVERFLOW the event_type field
+        * will be PERF_RECORD_*
+        *
+        * struct {
+        *      struct perf_event_header        header;
+        *
+        *      { u64                   ip;       } && PERF_RECORD_IP
+        *      { u32                   pid, tid; } && PERF_RECORD_TID
+        *      { u64                   time;     } && PERF_RECORD_TIME
+        *      { u64                   addr;     } && PERF_RECORD_ADDR
+        *      { u64                   config;   } && PERF_RECORD_CONFIG
+        *      { u32                   cpu, res; } && PERF_RECORD_CPU
+        *
+        *      { u64                   nr;
+        *        { u64 id, val; }      cnt[nr];  } && PERF_RECORD_GROUP
+        *
+        *      { u16                   nr,
+        *                              hv,
+        *                              kernel,
+        *                              user;
+        *        u64                   ips[nr];  } && PERF_RECORD_CALLCHAIN
+        * };
+        */
 };
 
 #ifdef __KERNEL__
@@ -184,29 +325,31 @@ enum perf_event_type {
 #include <linux/rcupdate.h>
 #include <linux/spinlock.h>
 #include <linux/hrtimer.h>
+#include <linux/fs.h>
+#include <linux/pid_namespace.h>
 #include <asm/atomic.h>
 
 struct task_struct;
 
-static inline u64 perf_event_raw(struct perf_counter_hw_event *hw_event)
+static inline u64 perf_event_raw(struct perf_counter_attr *attr)
 {
-       return hw_event->config & PERF_COUNTER_RAW_MASK;
+       return attr->config & PERF_COUNTER_RAW_MASK;
 }
 
-static inline u64 perf_event_config(struct perf_counter_hw_event *hw_event)
+static inline u64 perf_event_config(struct perf_counter_attr *attr)
 {
-       return hw_event->config & PERF_COUNTER_CONFIG_MASK;
+       return attr->config & PERF_COUNTER_CONFIG_MASK;
 }
 
-static inline u64 perf_event_type(struct perf_counter_hw_event *hw_event)
+static inline u64 perf_event_type(struct perf_counter_attr *attr)
 {
-       return (hw_event->config & PERF_COUNTER_TYPE_MASK) >>
+       return (attr->config & PERF_COUNTER_TYPE_MASK) >>
                PERF_COUNTER_TYPE_SHIFT;
 }
 
-static inline u64 perf_event_id(struct perf_counter_hw_event *hw_event)
+static inline u64 perf_event_id(struct perf_counter_attr *attr)
 {
-       return hw_event->config & PERF_COUNTER_EVENT_MASK;
+       return attr->config & PERF_COUNTER_EVENT_MASK;
 }
 
 /**
@@ -219,8 +362,7 @@ struct hw_perf_counter {
                        u64                             config;
                        unsigned long                   config_base;
                        unsigned long                   counter_base;
-                       int                             nmi;
-                       unsigned int                    idx;
+                       int                             idx;
                };
                union { /* software */
                        atomic64_t                      count;
@@ -228,20 +370,22 @@ struct hw_perf_counter {
                };
        };
        atomic64_t                      prev_count;
-       u64                             irq_period;
+       u64                             sample_period;
        atomic64_t                      period_left;
+       u64                             interrupts;
 #endif
 };
 
 struct perf_counter;
 
 /**
- * struct hw_perf_counter_ops - performance counter hw ops
+ * struct pmu - generic performance monitoring unit
  */
-struct hw_perf_counter_ops {
+struct pmu {
        int (*enable)                   (struct perf_counter *counter);
        void (*disable)                 (struct perf_counter *counter);
        void (*read)                    (struct perf_counter *counter);
+       void (*unthrottle)              (struct perf_counter *counter);
 };
 
 /**
@@ -258,11 +402,26 @@ struct file;
 
 struct perf_mmap_data {
        struct rcu_head                 rcu_head;
-       int                             nr_pages;
-       atomic_t                        wakeup;
-       atomic_t                        head;
+       int                             nr_pages;       /* nr of data pages  */
+       int                             nr_locked;      /* nr pages mlocked  */
+
+       atomic_t                        poll;           /* POLL_ for wakeups */
+       atomic_t                        events;         /* event limit       */
+
+       atomic_long_t                   head;           /* write position    */
+       atomic_long_t                   done_head;      /* completed head    */
+
+       atomic_t                        lock;           /* concurrent writes */
+
+       atomic_t                        wakeup;         /* needs a wakeup    */
+
        struct perf_counter_mmap_page   *user_page;
-       void                            *data_pages[0];
+       void                            *data_pages[0];
+};
+
+struct perf_pending_entry {
+       struct perf_pending_entry *next;
+       void (*func)(struct perf_pending_entry *);
 };
 
 /**
@@ -273,32 +432,65 @@ struct perf_counter {
        struct list_head                list_entry;
        struct list_head                event_entry;
        struct list_head                sibling_list;
-       int                             nr_siblings;
+       int                             nr_siblings;
        struct perf_counter             *group_leader;
-       const struct hw_perf_counter_ops *hw_ops;
+       const struct pmu                *pmu;
 
        enum perf_counter_active_state  state;
-       enum perf_counter_active_state  prev_state;
        atomic64_t                      count;
 
-       struct perf_counter_hw_event    hw_event;
+       /*
+        * These are the total time in nanoseconds that the counter
+        * has been enabled (i.e. eligible to run, and the task has
+        * been scheduled in, if this is a per-task counter)
+        * and running (scheduled onto the CPU), respectively.
+        *
+        * They are computed from tstamp_enabled, tstamp_running and
+        * tstamp_stopped when the counter is in INACTIVE or ACTIVE state.
+        */
+       u64                             total_time_enabled;
+       u64                             total_time_running;
+
+       /*
+        * These are timestamps used for computing total_time_enabled
+        * and total_time_running when the counter is in INACTIVE or
+        * ACTIVE state, measured in nanoseconds from an arbitrary point
+        * in time.
+        * tstamp_enabled: the notional time when the counter was enabled
+        * tstamp_running: the notional time when the counter was scheduled on
+        * tstamp_stopped: in INACTIVE state, the notional time when the
+        *      counter was scheduled off.
+        */
+       u64                             tstamp_enabled;
+       u64                             tstamp_running;
+       u64                             tstamp_stopped;
+
+       struct perf_counter_attr        attr;
        struct hw_perf_counter          hw;
 
        struct perf_counter_context     *ctx;
-       struct task_struct              *task;
        struct file                     *filp;
 
-       struct perf_counter             *parent;
-       struct list_head                child_list;
+       /*
+        * These accumulate total time (in nanoseconds) that children
+        * counters have been enabled and running, respectively.
+        */
+       atomic64_t                      child_total_time_enabled;
+       atomic64_t                      child_total_time_running;
 
        /*
         * Protect attach/detach and child_list:
         */
-       struct mutex                    mutex;
+       struct mutex                    child_mutex;
+       struct list_head                child_list;
+       struct perf_counter             *parent;
 
        int                             oncpu;
        int                             cpu;
 
+       struct list_head                owner_entry;
+       struct task_struct              *owner;
+
        /* mmap bits */
        struct mutex                    mmap_mutex;
        atomic_t                        mmap_count;
@@ -306,11 +498,21 @@ struct perf_counter {
 
        /* poll related */
        wait_queue_head_t               waitq;
-       /* optional: for NMIs */
-       int                             wakeup_pending;
+       struct fasync_struct            *fasync;
+
+       /* delayed work for NMIs and such */
+       int                             pending_wakeup;
+       int                             pending_kill;
+       int                             pending_disable;
+       struct perf_pending_entry       pending;
+
+       atomic_t                        event_limit;
 
        void (*destroy)(struct perf_counter *);
        struct rcu_head                 rcu_head;
+
+       struct pid_namespace            *ns;
+       u64                             id;
 #endif
 };
 
@@ -320,7 +522,6 @@ struct perf_counter {
  * Used as a container for task counters and CPU counters as well:
  */
 struct perf_counter_context {
-#ifdef CONFIG_PERF_COUNTERS
        /*
         * Protect the states of the counters in the list,
         * nr_active, and the list:
@@ -338,8 +539,24 @@ struct perf_counter_context {
        int                     nr_counters;
        int                     nr_active;
        int                     is_active;
+       atomic_t                refcount;
        struct task_struct      *task;
-#endif
+
+       /*
+        * Context clock, runs when context enabled.
+        */
+       u64                     time;
+       u64                     timestamp;
+
+       /*
+        * These fields let us detect when two contexts have both
+        * been cloned (inherited) from a common ancestor.
+        */
+       struct perf_counter_context *parent_ctx;
+       u64                     parent_gen;
+       u64                     generation;
+       int                     pin_count;
+       struct rcu_head         rcu_head;
 };
 
 /**
@@ -357,28 +574,31 @@ struct perf_cpu_context {
         *
         * task, softirq, irq, nmi context
         */
-       int                     recursion[4];
+       int                             recursion[4];
 };
 
+#ifdef CONFIG_PERF_COUNTERS
+
 /*
  * Set by architecture code:
  */
 extern int perf_max_counters;
 
-#ifdef CONFIG_PERF_COUNTERS
-extern const struct hw_perf_counter_ops *
-hw_perf_counter_init(struct perf_counter *counter);
+extern const struct pmu *hw_perf_counter_init(struct perf_counter *counter);
 
 extern void perf_counter_task_sched_in(struct task_struct *task, int cpu);
-extern void perf_counter_task_sched_out(struct task_struct *task, int cpu);
+extern void perf_counter_task_sched_out(struct task_struct *task,
+                                       struct task_struct *next, int cpu);
 extern void perf_counter_task_tick(struct task_struct *task, int cpu);
-extern void perf_counter_init_task(struct task_struct *child);
+extern int perf_counter_init_task(struct task_struct *child);
 extern void perf_counter_exit_task(struct task_struct *child);
-extern void perf_counter_notify(struct pt_regs *regs);
+extern void perf_counter_free_task(struct task_struct *task);
+extern void perf_counter_do_pending(void);
 extern void perf_counter_print_debug(void);
-extern void perf_counter_unthrottle(void);
-extern u64 hw_perf_save_disable(void);
-extern void hw_perf_restore(u64 ctrl);
+extern void __perf_disable(void);
+extern bool __perf_enable(void);
+extern void perf_disable(void);
+extern void perf_enable(void);
 extern int perf_counter_task_disable(void);
 extern int perf_counter_task_enable(void);
 extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
@@ -386,38 +606,86 @@ extern int hw_perf_group_sched_in(struct perf_counter *group_leader,
               struct perf_counter_context *ctx, int cpu);
 extern void perf_counter_update_userpage(struct perf_counter *counter);
 
-extern void perf_counter_output(struct perf_counter *counter,
-                               int nmi, struct pt_regs *regs);
+extern int perf_counter_overflow(struct perf_counter *counter,
+                                int nmi, struct pt_regs *regs, u64 addr);
 /*
  * Return 1 for a software counter, 0 for a hardware counter
  */
 static inline int is_software_counter(struct perf_counter *counter)
 {
-       return !perf_event_raw(&counter->hw_event) &&
-               perf_event_type(&counter->hw_event) != PERF_TYPE_HARDWARE;
+       return !perf_event_raw(&counter->attr) &&
+               perf_event_type(&counter->attr) != PERF_TYPE_HARDWARE;
 }
 
-extern void perf_swcounter_event(u32, u64, int, struct pt_regs *);
+extern void perf_swcounter_event(u32, u64, int, struct pt_regs *, u64);
+
+extern void perf_counter_mmap(unsigned long addr, unsigned long len,
+                             unsigned long pgoff, struct file *file);
+
+extern void perf_counter_munmap(unsigned long addr, unsigned long len,
+                               unsigned long pgoff, struct file *file);
+
+extern void perf_counter_comm(struct task_struct *tsk);
+extern void perf_counter_fork(struct task_struct *tsk);
+
+extern void perf_counter_task_migration(struct task_struct *task, int cpu);
+
+#define MAX_STACK_DEPTH                255
+
+struct perf_callchain_entry {
+       u16     nr, hv, kernel, user;
+       u64     ip[MAX_STACK_DEPTH];
+};
+
+extern struct perf_callchain_entry *perf_callchain(struct pt_regs *regs);
+
+extern int sysctl_perf_counter_priv;
+extern int sysctl_perf_counter_mlock;
+extern int sysctl_perf_counter_limit;
+
+extern void perf_counter_init(void);
+
+#ifndef perf_misc_flags
+#define perf_misc_flags(regs)  (user_mode(regs) ? PERF_EVENT_MISC_USER : \
+                                PERF_EVENT_MISC_KERNEL)
+#define perf_instruction_pointer(regs) instruction_pointer(regs)
+#endif
 
 #else
 static inline void
 perf_counter_task_sched_in(struct task_struct *task, int cpu)          { }
 static inline void
-perf_counter_task_sched_out(struct task_struct *task, int cpu)         { }
+perf_counter_task_sched_out(struct task_struct *task,
+                           struct task_struct *next, int cpu)          { }
 static inline void
 perf_counter_task_tick(struct task_struct *task, int cpu)              { }
-static inline void perf_counter_init_task(struct task_struct *child)   { }
+static inline int perf_counter_init_task(struct task_struct *child)    { return 0; }
 static inline void perf_counter_exit_task(struct task_struct *child)   { }
-static inline void perf_counter_notify(struct pt_regs *regs)           { }
+static inline void perf_counter_free_task(struct task_struct *task)    { }
+static inline void perf_counter_do_pending(void)                       { }
 static inline void perf_counter_print_debug(void)                      { }
-static inline void perf_counter_unthrottle(void)                       { }
-static inline void hw_perf_restore(u64 ctrl)                           { }
-static inline u64 hw_perf_save_disable(void)                 { return 0; }
+static inline void perf_disable(void)                                  { }
+static inline void perf_enable(void)                                   { }
 static inline int perf_counter_task_disable(void)      { return -EINVAL; }
 static inline int perf_counter_task_enable(void)       { return -EINVAL; }
 
-static inline void perf_swcounter_event(u32 event, u64 nr,
-                                       int nmi, struct pt_regs *regs)  { }
+static inline void
+perf_swcounter_event(u32 event, u64 nr, int nmi,
+                    struct pt_regs *regs, u64 addr)                    { }
+
+static inline void
+perf_counter_mmap(unsigned long addr, unsigned long len,
+                 unsigned long pgoff, struct file *file)               { }
+
+static inline void
+perf_counter_munmap(unsigned long addr, unsigned long len,
+                   unsigned long pgoff, struct file *file)             { }
+
+static inline void perf_counter_comm(struct task_struct *tsk)          { }
+static inline void perf_counter_fork(struct task_struct *tsk)          { }
+static inline void perf_counter_init(void)                             { }
+static inline void perf_counter_task_migration(struct task_struct *task,
+                                              int cpu)                 { }
 #endif
 
 #endif /* __KERNEL__ */