linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Arnaldo Carvalho de Melo <acme@infradead.org>
To: Ingo Molnar <mingo@kernel.org>
Cc: linux-kernel@vger.kernel.org,
	Ramkumar Ramachandra <artagnon@gmail.com>,
	David Ahern <dsahern@gmail.com>, Jiri Olsa <jolsa@redhat.com>,
	Arnaldo Carvalho de Melo <acme@redhat.com>
Subject: [PATCH 12/13] perf tools: Update some code references in design.txt
Date: Tue, 18 Mar 2014 18:26:04 -0300	[thread overview]
Message-ID: <1395177965-8879-13-git-send-email-acme@infradead.org> (raw)
In-Reply-To: <1395177965-8879-1-git-send-email-acme@infradead.org>

From: Ramkumar Ramachandra <artagnon@gmail.com>

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 <artagnon@gmail.com>
Cc: David Ahern <dsahern@gmail.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Link: http://lkml.kernel.org/r/1395169804-1293-1-git-send-email-artagnon@gmail.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 tools/perf/design.txt | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/tools/perf/design.txt b/tools/perf/design.txt
index 63a0e6f04a01..a28dca2582aa 100644
--- a/tools/perf/design.txt
+++ b/tools/perf/design.txt
@@ -18,7 +18,7 @@ underlying hardware counters.
 Performance counters are accessed via special file descriptors.
 There's one file descriptor per virtual counter used.
 
-The special file descriptor is opened via the perf_event_open()
+The special file descriptor is opened via the sys_perf_event_open()
 system call:
 
    int sys_perf_event_open(struct perf_event_attr *hw_event_uptr,
@@ -82,7 +82,7 @@ machine-specific.
 If 'raw_type' is 0, then the 'type' field says what kind of counter
 this is, with the following encoding:
 
-enum perf_event_types {
+enum perf_type_id {
 	PERF_TYPE_HARDWARE		= 0,
 	PERF_TYPE_SOFTWARE		= 1,
 	PERF_TYPE_TRACEPOINT		= 2,
@@ -95,7 +95,7 @@ specified by 'event_id':
  * Generalized performance counter event types, used by the hw_event.event_id
  * parameter of the sys_perf_event_open() syscall:
  */
-enum hw_event_ids {
+enum perf_hw_id {
 	/*
 	 * Common hardware events, generalized by the kernel:
 	 */
@@ -129,7 +129,7 @@ software events, selected by 'event_id':
  * physical and sw events of the kernel (and allow the profiling of them as
  * well):
  */
-enum sw_event_ids {
+enum perf_sw_ids {
 	PERF_COUNT_SW_CPU_CLOCK		= 0,
 	PERF_COUNT_SW_TASK_CLOCK	= 1,
 	PERF_COUNT_SW_PAGE_FAULTS	= 2,
@@ -230,7 +230,7 @@ these events are recorded in the ring-buffer (see below).
 The 'comm' bit allows tracking of process comm data on process creation.
 This too is recorded in the ring-buffer (see below).
 
-The 'pid' parameter to the perf_event_open() system call allows the
+The 'pid' parameter to the sys_perf_event_open() system call allows the
 counter to be specific to a task:
 
  pid == 0: if the pid parameter is zero, the counter is attached to the
@@ -260,7 +260,7 @@ The 'flags' parameter is currently unused and must be zero.
 
 The 'group_fd' parameter allows counter "groups" to be set up.  A
 counter group has one counter which is the group "leader".  The leader
-is created first, with group_fd = -1 in the perf_event_open call
+is created first, with group_fd = -1 in the sys_perf_event_open call
 that creates it.  The rest of the group members are created
 subsequently, with group_fd giving the fd of the group leader.
 (A single counter on its own is created with group_fd = -1 and is
-- 
1.8.1.4


  parent reply	other threads:[~2014-03-18 21:26 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-18 21:25 [GIT PULL 00/13] perf/core improvements and fixes Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 01/13] perf timechart: Fix off-by-one error in 'record' argv handling Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 02/13] perf sched: Fixup header alignment in 'latency' output Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 03/13] perf symbols: Record the reason for filtering an address_location Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 04/13] perf symbols: Apply all filters to an addr_location Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 05/13] perf report: Merge al->filtered with hist_entry->filtered Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 06/13] perf tools: Use tid in mmap/mmap2 events to find maps Arnaldo Carvalho de Melo
2014-03-19  7:13   ` Adrian Hunter
2014-03-19 10:19     ` Jiri Olsa
     [not found]     ` <20140319131945.GW25953@redhat.com>
2014-03-19 13:30       ` Jiri Olsa
2014-03-19 14:27         ` Adrian Hunter
2014-03-19 14:43           ` Don Zickus
2014-03-19 15:17             ` Adrian Hunter
2014-03-20 14:44         ` Arnaldo Carvalho de Melo
2014-03-18 21:25 ` [PATCH 07/13] perf tools: Fix memory leak when synthesizing thread records Arnaldo Carvalho de Melo
2014-03-18 21:26 ` [PATCH 08/13] perf report: Use ui__has_annotation() Arnaldo Carvalho de Melo
2014-03-18 21:26 ` [PATCH 09/13] perf annotate: Print the evsel name in the stdio output Arnaldo Carvalho de Melo
2014-03-18 21:26 ` [PATCH 10/13] perf tools: Remove thread__find_map function Arnaldo Carvalho de Melo
2014-03-18 21:26 ` [PATCH 11/13] perf evsel: Update function names in debug messages Arnaldo Carvalho de Melo
2014-03-18 21:26 ` Arnaldo Carvalho de Melo [this message]
2014-03-18 21:26 ` [PATCH 13/13] perf tools: Remove unused simple_strtoul() function Arnaldo Carvalho de Melo
2014-03-19  7:07 ` [GIT PULL 00/13] perf/core improvements and fixes Ingo Molnar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1395177965-8879-13-git-send-email-acme@infradead.org \
    --to=acme@infradead.org \
    --cc=acme@redhat.com \
    --cc=artagnon@gmail.com \
    --cc=dsahern@gmail.com \
    --cc=jolsa@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).