Blame view

kernel/linux-imx6_3.14.28/Documentation/DocBook/tracepoint.tmpl 3.33 KB
6b13f685e   김민수   BSP 최초 추가
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  	"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
  
  <book id="Tracepoints">
   <bookinfo>
    <title>The Linux Kernel Tracepoint API</title>
  
    <authorgroup>
     <author>
      <firstname>Jason</firstname>
      <surname>Baron</surname>
      <affiliation>
       <address>
        <email>jbaron@redhat.com</email>
       </address>
      </affiliation>
     </author>
     <author>
      <firstname>William</firstname>
      <surname>Cohen</surname>
      <affiliation>
       <address>
        <email>wcohen@redhat.com</email>
       </address>
      </affiliation>
     </author>
    </authorgroup>
  
    <legalnotice>
     <para>
       This documentation is free software; you can redistribute
       it and/or modify it under the terms of the GNU General Public
       License as published by the Free Software Foundation; either
       version 2 of the License, or (at your option) any later
       version.
     </para>
  
     <para>
       This program is distributed in the hope that it will be
       useful, but WITHOUT ANY WARRANTY; without even the implied
       warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
       See the GNU General Public License for more details.
     </para>
  
     <para>
       You should have received a copy of the GNU General Public
       License along with this program; if not, write to the Free
       Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
       MA 02111-1307 USA
     </para>
  
     <para>
       For more details see the file COPYING in the source
       distribution of Linux.
     </para>
    </legalnotice>
   </bookinfo>
  
   <toc></toc>
    <chapter id="intro">
     <title>Introduction</title>
     <para>
       Tracepoints are static probe points that are located in strategic points
       throughout the kernel. 'Probes' register/unregister with tracepoints
       via a callback mechanism. The 'probes' are strictly typed functions that
       are passed a unique set of parameters defined by each tracepoint.
     </para>
  
     <para>
       From this simple callback mechanism, 'probes' can be used to profile, debug,
       and understand kernel behavior. There are a number of tools that provide a
       framework for using 'probes'. These tools include Systemtap, ftrace, and
       LTTng.
     </para>
  
     <para>
       Tracepoints are defined in a number of header files via various macros. Thus,
       the purpose of this document is to provide a clear accounting of the available
       tracepoints. The intention is to understand not only what tracepoints are
       available but also to understand where future tracepoints might be added.
     </para>
  
     <para>
       The API presented has functions of the form:
       <function>trace_tracepointname(function parameters)</function>. These are the
       tracepoints callbacks that are found throughout the code. Registering and
       unregistering probes with these callback sites is covered in the
       <filename>Documentation/trace/*</filename> directory.
     </para>
    </chapter>
  
    <chapter id="irq">
     <title>IRQ</title>
  !Iinclude/trace/events/irq.h
    </chapter>
  
    <chapter id="signal">
     <title>SIGNAL</title>
  !Iinclude/trace/events/signal.h
    </chapter>
  
    <chapter id="block">
     <title>Block IO</title>
  !Iinclude/trace/events/block.h
    </chapter>
  
    <chapter id="workqueue">
     <title>Workqueue</title>
  !Iinclude/trace/events/workqueue.h
    </chapter>
  </book>