linux-kernel - Re: Documenting kernel tracepoints

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <49C140F7.9060301@redhat.com>
Date:	Wed, 18 Mar 2009 14:44:07 -0400
From:	William Cohen <wcohen@...hat.com>
To:	Ingo Molnar <mingo@...e.hu>
CC:	Steven Rostedt <rostedt@...dmis.org>,
	Frédéric Weisbecker 
	<fweisbec@...il.com>, Peter Zijlstra <a.p.zijlstra@...llo.nl>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: Documenting kernel tracepoints

Ingo Molnar wrote:
> * William Cohen <wcohen@...hat.com> wrote:
> 
>> There are a number of tracepoints in the latest kernels, but not 
>> much documentation on the tracepoints.  If a very recent version 
>> of systemtap is available on the system, a list of the probe 
>> points can be obtained with:
>>
>> stap -p2 -e 'probe kernel.trace("*") {exit()}'|sort
>>
>> However, this only provides the names. It doesn't provide 
>> information about what information the probe point provides or the 
>> arguments available at the probe point.
>>
>> Currently, a number of kernel functions and structures are 
>> documented with embedded comments that are extracted with 
>> kernel-doc. Seems like it would be reasonable to extend this to 
>> support tracepoints. Any thoughts or comments about this approach?
> 
> FYI, in the latest tracing tree (targeted for 2.6.30) all 
> tracepoints show up under /debug/tracing/events/.
> 
> 	Ingo

The /debug/tracing/events provides event names and information about the
available arguments. However, it doesn't provide the detail comparable to
kerneldoc embedded comments summarizing the tracepoint's purpose or what the
arguments are.

-Will
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/