diff options
Diffstat (limited to 'doc/SystemTap_Beginners_Guide/en-US/Scripts.xml')
| -rw-r--r-- | doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 238 |
1 files changed, 119 insertions, 119 deletions
diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml index fe2e69f4..88aa42ab 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml @@ -129,7 +129,7 @@ </indexterm> <para> SystemTap scripts use the file extension <filename>.stp</filename>, and - are conatains probes written in the following format: + contains probes written in the following format: </para> </formalpara> <screen> @@ -555,21 +555,21 @@ probe timer.s(4) </indexterm> <para> Consider the following sample script: </para> - <example id="helloworld"><title>helloworld.stp</title> - <programlisting> - probe begin - { - printf ("hello world\n") - exit () - } - </programlisting> - </example> +<example id="helloworld"><title>helloworld.stp</title> +<programlisting> +probe begin +{ + printf ("hello world\n") + exit () +} +</programlisting> +</example> <para> In <xref linkend="helloworld"/>, the event <command>begin</command> (i.e. the start of the session) triggers the handler enclosed in <command>{ }</command>, which simply prints <command>hello - world</command>, then exits. + world</command> followed by a new-line, then exits. </para> <note> @@ -581,7 +581,7 @@ probe timer.s(4) <indexterm> <primary><command>exit()</command></primary> - <secondary>Handlers</secondary> + <secondary>functions</secondary> </indexterm> <para> SystemTap scripts continue to run until the @@ -666,15 +666,15 @@ probe timer.s(4) <para> To illustrate this, consider the following probe example: </para> - <example id="syscall-open"> - <title>variables-in-printf-statements.stp</title> - <programlisting> - probe syscall.open - { - printf ("%s(%d) open\n", execname(), pid()) - } - </programlisting> - </example> +<example id="syscall-open"> +<title>variables-in-printf-statements.stp</title> +<programlisting> +probe syscall.open +{ + printf ("%s(%d) open\n", execname(), pid()) +} +</programlisting> +</example> <para> <xref linkend="syscall-open"/> instructs SystemTap to probe all entries to @@ -688,16 +688,16 @@ probe timer.s(4) to "argument1", "format specifier2" is to "argument2", or is this clear enough? </remark> - <screen> - vmware-guestd(2206) open - hald(2360) open - hald(2360) open - hald(2360) open - df(3433) open - df(3433) open - df(3433) open - hald(2360) open - </screen> +<screen> +vmware-guestd(2206) open +hald(2360) open +hald(2360) open +hald(2360) open +df(3433) open +df(3433) open +df(3433) open +hald(2360) open +</screen> <formalpara id="systemtapscript-functions"> <title>SystemTap Functions</title> @@ -732,20 +732,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>tid()</command></tertiary> + <secondary><command>tid()</command></secondary> +<!-- <tertiary><command>tid()</command></tertiary> --> </indexterm> <indexterm> - <primary>handler functions</primary> - <secondary>Handlers</secondary> - <tertiary><command>tid()</command></tertiary> + <primary>functions</primary> + <secondary><command>tid()</command></secondary> +<!-- <tertiary></tertiary> --> </indexterm> <indexterm> <primary><command>tid()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler </tertiary> --> </indexterm> <para>The ID of the current thread.</para> @@ -757,20 +757,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>uid()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>uid()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>uid()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>uid()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para>The ID of the current user.</para> </listitem> @@ -781,20 +781,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>cpu()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>cpu()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>cpu()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>cpu()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para>The current CPU number.</para> </listitem> @@ -805,20 +805,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>gettimeofday_s()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>gettimeofday_s()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>gettimeofday_s()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>gettimeofday_s()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para>The number of seconds since UNIX epoch (January 1, 1970).</para> @@ -830,20 +830,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>ctime()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>ctime()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>ctime()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>ctime()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para> Convert number of seconds since UNIX epoch to date. @@ -865,20 +865,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>pp()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>pp()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>pp()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>pp()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para>A string describing the probe point currently being handled.</para> </listitem> @@ -897,20 +897,20 @@ probe timer.s(4) <listitem> <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>thread_indent()</command></tertiary> + <!--<secondary>handler functions</secondary>--> + <secondary><command>thread_indent()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>thread_indent()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>thread_indent()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para> This particular function is quite useful, providing you with a way @@ -945,42 +945,42 @@ probe timer.s(4) <command>thread_indent()</command>: </para> - <example id="thread_indent"><title>thread_indent.stp</title> - <programlisting> - probe kernel.function("*@net/socket.c") - { - printf ("%s -> %s\n", thread_indent(1), probefunc()) - } - probe kernel.function("*@net/socket.c").return - { - printf ("%s <- %s\n", thread_indent(-1), probefunc()) - } - </programlisting> - </example> +<example id="thread_indent"><title>thread_indent.stp</title> +<programlisting> +probe kernel.function("*@net/socket.c") +{ + printf ("%s -> %s\n", thread_indent(1), probefunc()) +} +probe kernel.function("*@net/socket.c").return +{ + printf ("%s <- %s\n", thread_indent(-1), probefunc()) +} +</programlisting> +</example> <para> <xref linkend="thread_indent"/> prints out the <command>thread_indent()</command> and probe functions at each event in the following format:</para> - <screen> - 0 ftp(7223): -> sys_socketcall - 1159 ftp(7223): -> sys_socket - 2173 ftp(7223): -> __sock_create - 2286 ftp(7223): -> sock_alloc_inode - 2737 ftp(7223): <- sock_alloc_inode - 3349 ftp(7223): -> sock_alloc - 3389 ftp(7223): <- sock_alloc - 3417 ftp(7223): <- __sock_create - 4117 ftp(7223): -> sock_create - 4160 ftp(7223): <- sock_create - 4301 ftp(7223): -> sock_map_fd - 4644 ftp(7223): -> sock_map_file - 4699 ftp(7223): <- sock_map_file - 4715 ftp(7223): <- sock_map_fd - 4732 ftp(7223): <- sys_socket - 4775 ftp(7223): <- sys_socketcall - </screen> +<screen> +0 ftp(7223): -> sys_socketcall +1159 ftp(7223): -> sys_socket +2173 ftp(7223): -> __sock_create +2286 ftp(7223): -> sock_alloc_inode +2737 ftp(7223): <- sock_alloc_inode +3349 ftp(7223): -> sock_alloc +3389 ftp(7223): <- sock_alloc +3417 ftp(7223): <- __sock_create +4117 ftp(7223): -> sock_create +4160 ftp(7223): <- sock_create +4301 ftp(7223): -> sock_map_fd +4644 ftp(7223): -> sock_map_file +4699 ftp(7223): <- sock_map_file +4715 ftp(7223): <- sock_map_fd +4732 ftp(7223): <- sys_socket +4775 ftp(7223): <- sys_socketcall +</screen> <para>This sample output contains the following information:</para> @@ -1047,20 +1047,20 @@ probe timer.s(4) <indexterm> <primary>functions</primary> - <secondary>handler functions</secondary> - <tertiary><command>target()</command></tertiary> +<!-- <secondary>handler functions</secondary> --> + <secondary><command>target()</command></secondary> </indexterm> - +<!-- <indexterm> <primary>handler functions</primary> <secondary>Handlers</secondary> <tertiary><command>target()</command></tertiary> </indexterm> - + --> <indexterm> <primary><command>target()</command></primary> - <secondary>Handlers</secondary> - <tertiary>handler functions</tertiary> + <secondary>functions</secondary> +<!-- <tertiary>handler functions</tertiary> --> </indexterm> <para> Used in conjunction with <command>stap @@ -1073,15 +1073,15 @@ probe timer.s(4) to it. For example: </para> - <example id="targetexample"> - <title>targetexample.stp</title> - <programlisting> - probe syscall.* { - if (pid() == target()) - printf("%s/n", name) - } - </programlisting> - </example> +<example id="targetexample"> +<title>targetexample.stp</title> +<programlisting> +probe syscall.* { + if (pid() == target()) + printf("%s/n", name) +} +</programlisting> +</example> <para> When <xref linkend="targetexample"/> is run with the argument |