path: root/tools/perf/design.txt
AgeCommit message (Collapse)AuthorFilesLines
2014-03-18perf tools: Update some code references in design.txtRamkumar Ramachandra1-6/+6
Update the names of some functions and enums in design.txt. The document still has some stale information, but the motivation behind this patch is to allow a developer to quickly grep and learn about the associated structures. Signed-off-by: Ramkumar Ramachandra <> Cc: David Ahern <> Cc: Jiri Olsa <> Link: Signed-off-by: Arnaldo Carvalho de Melo <>
2014-01-26perf/doc: Remove mention of non-existent set_perf_event_pending() from ↵Baruch Siach1-1/+0
design.txt set_perf_event_pending() was removed in e360adbe ("irq_work: Add generic hardirq context callbacks"). Signed-off-by: Baruch Siach <> Cc: Peter Zijlstra <> Cc: Paul Mackerras <> Cc: Arnaldo Carvalho de Melo <> Link: Signed-off-by: Ingo Molnar <>
2012-05-31perf tools: Update ioctl documentation for PERF_IOC_FLAG_GROUPNamhyung Kim1-3/+4
The ioctl interface of perf event fd receives 3 arguments to control event group behavior but it lacked documentation. Signed-off-by: Namhyung Kim <> Cc: Namhyung Kim <> Cc: Paul Mackerras <> Cc: Peter Zijlstra <> Link: Signed-off-by: Arnaldo Carvalho de Melo <>
2010-01-13perf: Fix few typos + cosmeticsKirill Smelkov1-4/+4
Signed-off-by: Kirill Smelkov <> Signed-off-by: Arnaldo Carvalho de Melo <> LKML-Reference: <> Signed-off-by: Ingo Molnar <>
2009-12-28perf: Rename perf_event_hw_event in design documentTim Blechmann1-4/+4
perf_event_hw_event has been renamed to perf_event_attr. The design document was still using the old name, though. Signed-off-by: Tim Blechmann <> Cc: Peter Zijlstra <> Cc: Mike Galbraith <> Cc: Paul Mackerras <> Cc: Arnaldo Carvalho de Melo <> Cc: Frederic Weisbecker <> LKML-Reference: <> Signed-off-by: Ingo Molnar <>
2009-10-28perf_event: Add alignment-faults and emulation-faults software eventsAnton Blanchard1-0/+2
Add two more software events that are common to many cpus. Alignment faults: When a load or store is not aligned properly. Emulation faults: When an instruction is emulated in software. Both cause a very significant slowdown (100x or worse), so identifying and fixing them is very important. Signed-off-by: Anton Blanchard <> Signed-off-by: Paul Mackerras <>
2009-10-06perf_event: Provide vmalloc() based mmap() backingPeter Zijlstra1-0/+3
Some architectures such as Sparc, ARM and MIPS (basically everything with flush_dcache_page()) need to deal with dcache aliases by carefully placing pages in both kernel and user maps. These architectures typically have to use vmalloc_user() for this. However, on other architectures, vmalloc() is not needed and has the downsides of being more restricted and slower than regular allocations. Signed-off-by: Peter Zijlstra <> Acked-by: David Miller <> Cc: Andrew Morton <> Cc: Jens Axboe <> Cc: Paul Mackerras <> LKML-Reference: <1254830228.21044.272.camel@laptop> Signed-off-by: Ingo Molnar <>
2009-09-21perf: Do the big rename: Performance Counters -> Performance EventsIngo Molnar1-29/+29
Bye-bye Performance Counters, welcome Performance Events! In the past few months the perfcounters subsystem has grown out its initial role of counting hardware events, and has become (and is becoming) a much broader generic event enumeration, reporting, logging, monitoring, analysis facility. Naming its core object 'perf_counter' and naming the subsystem 'perfcounters' has become more and more of a misnomer. With pending code like hw-breakpoints support the 'counter' name is less and less appropriate. All in one, we've decided to rename the subsystem to 'performance events' and to propagate this rename through all fields, variables and API names. (in an ABI compatible fashion) The word 'event' is also a bit shorter than 'counter' - which makes it slightly more convenient to write/handle as well. Thanks goes to Stephane Eranian who first observed this misnomer and suggested a rename. User-space tooling and ABI compatibility is not affected - this patch should be function-invariant. (Also, defconfigs were not touched to keep the size down.) This patch has been generated via the following script: FILES=$(find * -type f | grep -vE 'oprofile|[^K]config') sed -i \ -e 's/PERF_EVENT_/PERF_RECORD_/g' \ -e 's/PERF_COUNTER/PERF_EVENT/g' \ -e 's/perf_counter/perf_event/g' \ -e 's/nb_counters/nb_events/g' \ -e 's/swcounter/swevent/g' \ -e 's/tpcounter_event/tp_event/g' \ $FILES for N in $(find . -name perf_counter.[ch]); do M=$(echo $N | sed 's/perf_counter/perf_event/g') mv $N $M done FILES=$(find . -name perf_event.*) sed -i \ -e 's/COUNTER_MASK/REG_MASK/g' \ -e 's/COUNTER/EVENT/g' \ -e 's/\<event\>/event_id/g' \ -e 's/counter/event/g' \ -e 's/Counter/Event/g' \ $FILES ... to keep it as correct as possible. This script can also be used by anyone who has pending perfcounters patches - it converts a Linux kernel tree over to the new naming. We tried to time this change to the point in time where the amount of pending patches is the smallest: the end of the merge window. Namespace clashes were fixed up in a preparatory patch - and some stylistic fallout will be fixed up in a subsequent patch. ( NOTE: 'counters' are still the proper terminology when we deal with hardware registers - and these sed scripts are a bit over-eager in renaming them. I've undone some of that, but in case there's something left where 'counter' would be better than 'event' we can undo that on an individual basis instead of touching an otherwise nicely automated patch. ) Suggested-by: Stephane Eranian <> Acked-by: Peter Zijlstra <> Acked-by: Paul Mackerras <> Reviewed-by: Arjan van de Ven <> Cc: Mike Galbraith <> Cc: Arnaldo Carvalho de Melo <> Cc: Frederic Weisbecker <> Cc: Steven Rostedt <> Cc: Benjamin Herrenschmidt <> Cc: David Howells <> Cc: Kyle McMartin <> Cc: Martin Schwidefsky <> Cc: "David S. Miller" <> Cc: Thomas Gleixner <> Cc: "H. Peter Anvin" <> Cc: <> LKML-Reference: <new-submission> Signed-off-by: Ingo Molnar <>
2009-06-12perf_counter: Start documenting HAVE_PERF_COUNTERS requirementsMike Frysinger1-0/+15
Help out arch porters who want to support perf counters by listing some basic requirements. Signed-off-by: Mike Frysinger <> Cc: Peter Zijlstra <> Cc: Paul Mackerras <> LKML-Reference: <> Signed-off-by: Ingo Molnar <>
2009-06-11perf_counter: Standardize event namesPeter Zijlstra1-14/+14
Pure renames only, to PERF_COUNT_HW_* and PERF_COUNT_SW_*. Signed-off-by: Peter Zijlstra <> Cc: Mike Galbraith <> Cc: Paul Mackerras <> Cc: Arnaldo Carvalho de Melo <> LKML-Reference: <new-submission> Signed-off-by: Ingo Molnar <>
2009-06-06perf_counter tools: Move from Documentation/perf_counter/ to tools/perf/Ingo Molnar1-0/+442
Several people have suggested that 'perf' has become a full-fledged tool that should be moved out of Documentation/. Move it to the (new) tools/ directory. Cc: Peter Zijlstra <> Cc: Mike Galbraith <> Cc: Paul Mackerras <> Cc: Arnaldo Carvalho de Melo <> LKML-Reference: <new-submission> Signed-off-by: Ingo Molnar <>