blob: e1d097e250ae6690d077c104fcd2833ab6a24e58 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/**
2 * @file cpu_buffer.h
3 *
Robert Richter2cc28b92008-12-25 17:26:07 +01004 * @remark Copyright 2002-2009 OProfile authors
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * @remark Read the file COPYING
6 *
7 * @author John Levon <levon@movementarian.org>
Robert Richter2cc28b92008-12-25 17:26:07 +01008 * @author Robert Richter <robert.richter@amd.com>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 */
10
11#ifndef OPROFILE_CPU_BUFFER_H
12#define OPROFILE_CPU_BUFFER_H
13
14#include <linux/types.h>
15#include <linux/spinlock.h>
16#include <linux/workqueue.h>
17#include <linux/cache.h>
Mike Travis608dfdd2008-04-28 02:14:15 -070018#include <linux/sched.h>
Robert Richter6dad8282008-12-09 01:21:32 +010019#include <linux/ring_buffer.h>
Robert Richter6a180372008-10-16 15:01:40 +020020
Linus Torvalds1da177e2005-04-16 15:20:36 -070021struct task_struct;
Robert Richter6a180372008-10-16 15:01:40 +020022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023int alloc_cpu_buffers(void);
24void free_cpu_buffers(void);
25
26void start_cpu_work(void);
27void end_cpu_work(void);
Tejun Heo3d7851b2010-10-15 09:51:08 -040028void flush_cpu_work(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30/* CPU buffer is composed of such entries (which are
31 * also used for context switch notes)
32 */
33struct op_sample {
34 unsigned long eip;
35 unsigned long event;
Robert Richter2cc28b92008-12-25 17:26:07 +010036 unsigned long data[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -070037};
Robert Richter6a180372008-10-16 15:01:40 +020038
Robert Richter14f0ca82009-01-07 21:50:22 +010039struct op_entry;
Robert Richter6dad8282008-12-09 01:21:32 +010040
Linus Torvalds1da177e2005-04-16 15:20:36 -070041struct oprofile_cpu_buffer {
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 unsigned long buffer_size;
Robert Richter25ad2912008-09-05 17:12:36 +020043 struct task_struct *last_task;
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 int last_is_kernel;
45 int tracing;
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 unsigned long sample_received;
47 unsigned long sample_lost_overflow;
48 unsigned long backtrace_aborted;
Philippe Eliedf9d1772007-11-14 16:58:48 -080049 unsigned long sample_invalid_eip;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 int cpu;
David Howellsc4028952006-11-22 14:57:56 +000051 struct delayed_work work;
Eric Dumazet8b8b4982008-05-14 16:05:31 -070052};
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Tejun Heob3e9f672009-10-29 22:34:13 +090054DECLARE_PER_CPU(struct oprofile_cpu_buffer, op_cpu_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Robert Richterfbc9bf92008-12-04 16:27:00 +010056/*
57 * Resets the cpu buffer to a sane state.
58 *
59 * reset these to invalid values; the next sample collected will
60 * populate the buffer with proper values to initialize the buffer
61 */
Robert Richter6d2c53f2008-12-24 16:53:53 +010062static inline void op_cpu_buffer_reset(int cpu)
Robert Richterfbc9bf92008-12-04 16:27:00 +010063{
Tejun Heob3e9f672009-10-29 22:34:13 +090064 struct oprofile_cpu_buffer *cpu_buf = &per_cpu(op_cpu_buffer, cpu);
Robert Richterfbc9bf92008-12-04 16:27:00 +010065
66 cpu_buf->last_is_kernel = -1;
67 cpu_buf->last_task = NULL;
68}
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
Robert Richterfdb6a8f2009-01-17 17:13:27 +010070/*
71 * op_cpu_buffer_add_data() and op_cpu_buffer_write_commit() may be
72 * called only if op_cpu_buffer_write_reserve() did not return NULL or
73 * entry->event != NULL, otherwise entry->size or entry->event will be
74 * used uninitialized.
75 */
76
Robert Richter2cc28b92008-12-25 17:26:07 +010077struct op_sample
78*op_cpu_buffer_write_reserve(struct op_entry *entry, unsigned long size);
Robert Richter99667182008-12-16 16:19:54 +010079int op_cpu_buffer_write_commit(struct op_entry *entry);
Robert Richter2d87b142008-12-30 04:10:46 +010080struct op_sample *op_cpu_buffer_read_entry(struct op_entry *entry, int cpu);
Robert Richter99667182008-12-16 16:19:54 +010081unsigned long op_cpu_buffer_entries(int cpu);
Robert Richterbf589e32008-11-27 22:33:37 +010082
Robert Richterd9928c22008-12-25 17:26:07 +010083/* returns the remaining free size of data in the entry */
84static inline
85int op_cpu_buffer_add_data(struct op_entry *entry, unsigned long val)
86{
87 if (!entry->size)
88 return 0;
89 *entry->data = val;
90 entry->size--;
91 entry->data++;
92 return entry->size;
93}
94
Robert Richterbd7dc462009-01-06 03:56:50 +010095/* returns the size of data in the entry */
96static inline
97int op_cpu_buffer_get_size(struct op_entry *entry)
98{
99 return entry->size;
100}
101
102/* returns 0 if empty or the size of data including the current value */
103static inline
104int op_cpu_buffer_get_data(struct op_entry *entry, unsigned long *val)
105{
106 int size = entry->size;
107 if (!size)
108 return 0;
109 *val = *entry->data;
110 entry->size--;
111 entry->data++;
112 return size;
113}
114
Robert Richterae735e92008-12-25 17:26:07 +0100115/* extra data flags */
116#define KERNEL_CTX_SWITCH (1UL << 0)
117#define IS_KERNEL (1UL << 1)
118#define TRACE_BEGIN (1UL << 2)
119#define USER_CTX_SWITCH (1UL << 3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121#endif /* OPROFILE_CPU_BUFFER_H */