From 94906938d7d94e1b91b1d205ae8b12b530795baf Mon Sep 17 00:00:00 2001 From: William Cohen Date: Thu, 6 Nov 2008 23:44:42 -0500 Subject: Editing Chapter 3, sections 3.1-3.2. --- doc/SystemTap_Beginners_Guide/en-US/Scripts.xml | 558 +++++++++++++++--------- 1 file changed, 340 insertions(+), 218 deletions(-) (limited to 'doc/SystemTap_Beginners_Guide/en-US/Scripts.xml') diff --git a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml index ca360e06..dc087222 100644 --- a/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml +++ b/doc/SystemTap_Beginners_Guide/en-US/Scripts.xml @@ -3,121 +3,171 @@ ]>
- SystemTap Scripts + SystemTap Scripts - - For the most part, SystemTap scripts are the foundation of each SystemTap session. SystemTap scripts instruct SystemTap on what type of information to collect, and what to do once that information is collected. - + + For the most part, SystemTap scripts are the foundation of each SystemTap + session. SystemTap scripts instruct SystemTap on what type of information to + collect, and what to do once that information is collected. + + + + As stated in , SystemTap + scripts are made up of two components: events and + handlers. Once a SystemTap session is underway, + SystemTap monitors the operating system for the specified events and + executes the handlers as they occur. + + + + Note + + An event and its corresponding handler is collectively called a + probe. A SystemTap script can have multiple probes. + - - As stated in , SystemTap scripts are made up of two components: events and handlers. Once a SystemTap session is underway, SystemTap monitors the operating system for the specified events and executes the handlers as they occur. - - - - - Note - An event and its corresponding handler is collectively called a probe. A SystemTap script can have multiple probes. - - A probe's handler is also commonly referred to as a probe body. - - - - In terms of application development, using events and handlers is similar to inserting diagnostic print statements in a program's sequence of commands. These diagnostic print statements allow you to view a history of commands executed once the program is run. - + + A probe's handler is commonly referred to as a probe + body. + + + + + In terms of application development, using events and handlers is similar to + instrumenting the code by inserting diagnostic print statements in a + program's sequence of commands. These diagnostic print statements allow you + to view a history of commands executed once the program is run. + - - SystemTap scripts go one step further by allowing you more flexibility with regard to handlers. Events serve as the triggers for handlers to run; handlers can be specified to trap specified data and print it in a certain manner. - + + SystemTap scripts allow insertion of the instrumentation code without + recompilation of the code. and allows more flexibility with regard to + handlers. Events serve as the triggers for handlers to run; handlers can be + specified to record specified data and print it in a certain manner. + - - Format - - SystemTap scripts use the file extension .stp, and are written in the following format: - - + + Format + + SystemTap scripts use the file extension .stp, and + are conatains probes written in the following format: + + -probe event, {handler} +probe event {statements} - - Sometimes, you may need to recycle a handler accross multiple probes. Rather than rewrite handler statements accross probes, you can simply recycle them using functions, as in: - + + SystemTap supports multiple events per probe; multiple events are delimited + by a comma (,). If multiple events are specified in a + single probe, SystemTap will execute the handler when any of the specified + events occur. + + + + Systemtap allow you to write functions to factor out code to be used by a + number of probes. Thus, rather than repeatedly writing the same sequence of + series of statements in multiple probes, you can just place the instructions + in a function, as in: + -function function_name {handler1} -probe event {function_name} +function function_name(arguments {statements} +probe event {function_name(arguments)} -Here, the probe executes handler1 as the handler for the probed event. - - + + The statements in + function_name are executed when the probe for + event executes. The + arguments are optional values passed into the + function. + - - Important - - is designed to introduce readers to the basics of SystemTap scripts. To understand SystemTap scripts better, it is advisable that you refer to ; each section therein provides a detailed explanation of the script, its events, handlers, and expected output. - - -
- Event + + Important + + is designed to introduce readers to the basics + of SystemTap scripts. To understand SystemTap scripts better, it is + advisable that you refer to ; + each section therein provides a detailed explanation of the script, its + events, handlers, and expected output. + + + +
+ Event -SystemTap events can be broadly classified into two types: synchronous and asynchronous. - -Synchronous Events -A synchronous event occurs when any process executes an instruction that references a particular location in kernel code. This gives other events a reference point from which more contextual data may be available. - + + SystemTap events can be broadly classified into two types: + synchronous and + asynchronous. + + + + Synchronous Events + + A synchronous event occurs when any process + executes an instruction that references a particular location in kernel + code. This gives other events a reference point from which more + contextual data may be available. + + -Examples of synchronous events include: + Examples of synchronous events include: + + + syscall.system_call + + The entry to the system call system_call. Similar to kernel.function, appending a return to the statement specifies the exit of the system call. For example, to specify the entry of the system call close, use syscall.close.return. + + To identify what system calls are made by a specific program/command, use strace command. + + + kernel.function("function") The entry to the kernel function function. For example, kernel.function("sys_open") refers to the "event" that occurs when the kernel function sys_open is called by any thread in the system. To specify the return of the kernel function sys_open, append the return string to the event statement; i.e. kernel.function("sys_open").return. When defining functions, you can use asterisk (*) for wildcards. You can also trace the entry or exit of a function in a kernel source file. Consider the following example: -wildcards.stp + + +wildcards.stp probe kernel.function("*@net/socket.c") { } probe kernel.function("*@net/socket.c").return { } - + In the previous example, the first probe's event specifies the entry of ALL functions in the kernel source file net/socket.c. The second probe specifies the exit of all those functions. Note that in this example, no handler was specified; as such, no information will be displayed. - - - - syscall.system_call - - The entry to the system call system_call. Similar to kernel.function, appending a return to the statement specifies the exit of the system call. For example, to specify the entry of the system call close, use syscall.close.return. - - To identify what system calls are made by a specific program/command, use strace command. - - - - + + + module("module").function("function") - Allows you to probe functions within modules. For example: + Allows you to probe functions within modules. For example: moduleprobe.stp probe module("ext3").function("*") { } probe module("ext3").function("*").return { } - + The first probe in points to the entry of all functions for the ext3 module. The second probe points to the exits of all entries for that same module; the use of the .return suffix is similar to kernel.function(). Note that the probes in also do not contain probe bodies, and as such will not print any useful data (as in ). @@ -127,57 +177,65 @@ probe module("ext3").function("*").return { } A system's loaded modules are typically located in /lib/modules/kernel version, where kernel version refers to the currently loaded kernel. Modules use the filename extension .ko. - - - - - - - Asynchronous Events - Asynchronous events, on the other hand, occur as instructed in the probe itself, rather than waiting for a particular instruction in kernel code to be executed by a process. This family of probe points consists mainly of counters, timers, and similar constructs. + + + + + + Asynchronous Events + + Asynchronous events are not tied to a particular + instruction or location in code. This family of probe points consists + mainly of counters, timers, and similar constructs. + - + - Examples of asynchronous events include: + Examples of asynchronous events include: - - - + + + begin - The startup of a SystemTap session; i.e. as soon as the SystemTap script is run. + + The startup of a SystemTap session; i.e. as soon as the SystemTap + script is run. + - + - + end - The end of a SystemTap session. + The end of a SystemTap session. - - - - - + + timer events - An event that specifies a handler to be executed every specified period of time. For example: + + An event that specifies a handler to be executed every specified + period of time. For example: + -timer-ms.stp +timer-s.stp -probe timer.ms(4000) +probe timer.s(4) { - printf("hello world\n") + printf("hello world\n") } - - is an example of a probe that prints hello world every 4000 milliseconds. Note that you can also use the following timer events: - + + is an example of a probe that prints + hello world every 4 seconds. Note that you can + also use the following timer events: + -timer.s(seconds) +timer.ms(milliseconds) timer.us(microseconds) @@ -186,54 +244,39 @@ probe timer.ms(4000) timer.hz(hertz) timer.jiffies(jiffies) - - - When used in conjunction with another probe that collects information that updates periodically, timer events allows you to see how that information changes over time. - - - - - - - - - - - - - - Important - - SystemTap supports the use of a large collection of probe events. For more information about supported events, refer to man stapprobes. The SEE ALSO section of man stapprobes also contains links to other man pages that discuss supported events for specific subsystems and components. - - + + When used in conjunction with another probe that collects + information that updates periodically, timer events allows you to + see how that information changes over time. + - - SystemTap supports multiple events per probe; as shown in , multiple events are delimited by a comma (,). If multiple events are specified in a single probe, SystemTap will execute the handler when any of the specified events occur. - + + + + + + + Important + + SystemTap supports the use of a large collection of probe events. For + more information about supported events, refer to man + stapprobes. The SEE ALSO section of + man stapprobes also contains links to other + man pages that discuss supported events for specific + subsystems and components. + + is reference appropriate? too advanced for readers (it seems so to me)? please advise. -
- -
- Handler/Probe Body +
- -Consider the following sample script: - +
+ Systemtap Handler/Boddy + + Consider the following sample script: helloworld.stp @@ -245,65 +288,85 @@ probe begin - - In , the event begin (i.e. the start of the session) triggers the handler enclosed in { }, which simply prints hello world, then exits. - - - - - Note - - Many SystemTap scripts, such as , do not contain an exit() handler. Such scripts need to be interrupted manually; to do so, use CtrlC. - - - - - - printf ( ) Statements - - The printf () statement is one of the simplest functions for printing data. printf () can also be used to display data using a wide variety of SystemTap functions in the following format: - - - + + In , the event begin + (i.e. the start of the session) triggers the handler enclosed in + { }, which simply prints hello + world, then exits. + + + + Note + + SystemTap scripts continue to run until the + exit() function executes. If the users wants to stop + the execution of the script, it can interrupted manually with + CtrlC. + + + + + printf ( ) Statements + + The printf () statement is one of the simplest + functions for printing data. printf () can also be + used to display data using a wide variety of SystemTap functions in the + following format: + + printf ("format string\n", argument) - - The format string region specifies how argument should be displayed. The format string of simply instructs SystemTap to print hello world, and contains no arguments. - - - - You can use the variables %s (for strings) and %d (for numbers) in format strings, depending on your list of arguments. Format strings can have multiple variables, each matching a corresponding argument; multiple arguments are delimited by a comma (,) and space. - - - - Note - Semantically, the SystemTap printf function is very similar to its C language counterpart. The aforementioned syntax and format for SystemTap's printf function is identical to that of the C-style printf. - - - - To illustrate this, consider the following probe example: - + + The format string specifies how + argument should be printed. The format string + of simply instructs SystemTap to print + hello world, and contains no format specifiers. + + + + You can use the format specifiers %s (for strings) + and %d (for numbers) in format strings, depending on + your list of arguments. Format strings can have multiple format + specifiers, each matching a corresponding argument; multiple arguments + are delimited by a comma (,). + + + + Note + Semantically, the SystemTap printf function is + very similar to its C language counterpart. The aforementioned syntax + and format for SystemTap's printf function is + identical to that of the C-style printf. + + + + To illustrate this, consider the following probe example: - variables-in-printf-statements.stp +variables-in-printf-statements.stp probe syscall.open { printf ("%s(%d) open\n", execname(), pid()) } - - + - - instructs SystemTap to probe all entries to the system call open; for each event, it prints the current execname() (which is a string) and pid() (which is a number), followed by the word open. A snippet of this probe's output would look like: - + + instructs SystemTap to probe all entries to + the system call open; for each event, it prints the + current execname() (which is a string) and + pid() (which is a number), followed by the word + open. A snippet of this probe's output would look like: + -editorial review: does a clarification that "variable1" is to "argument1", "variable2" is to "argument2", or is this clear enough? + editorial review: does a clarification that "format specifier1" is + to "argument1", "format specifier2" is to "argument2", or is this clear + enough? vmware-guestd(2206) open @@ -316,14 +379,20 @@ df(3433) open hald(2360) open - - SystemTap Functions - SystemTap supports a wide variety of functions that can be used as printf () arguments. uses the SystemTap functions execname() (name of the process that called a kernel function/performed a system call) and pid() (current process ID). - + + SystemTap Functions + + SystemTap supports a wide variety of functions that can be used as + printf () arguments. + uses the SystemTap functions execname() (name of the + process that called a kernel function/performed a system call) and + pid() (current process ID). + + -is "handler function" an appropriate term? wcohen: use "SystemTap functions" to match up language in man pages + is "handler function" an appropriate term? wcohen: use "SystemTap functions" to match up language in man pages - The following is a list of commonly-used SystemTap functions: + The following is a list of commonly-used SystemTap functions: @@ -379,30 +448,55 @@ hald(2360) open thread_indent() - This particular function is quite useful, providing you with a way to better organize your print results. When used with an indentation parameter (for example, -1), it allows the probe to internally store an "indentation counter" for each thread (identified by ID, as in tid). It then returns a string with some generic trace data along with an appropriate number of indentation spaces. - - The generic data included in the returned string includes a timestamp (number of microseconds since the most recent initial indentation), a process name, and the thread ID. This allows you to identify what functions were called, who called them, and the duration of each function call. - + + This particular function is quite useful, providing you with a way + to better organize your print results. When used with an indentation + parameter (for example, -1), it allows the probe + to internally store an "indentation counter" for each thread + (identified by ID, as in tid). It then returns a + string with some generic trace data along with an appropriate number + of indentation spaces. + - If call entries and exits immediately precede each other, it is easy to match them. However, in most cases, after a first function call entry is made several other call entries and exits may be made before the first call exits. The indentation counter helps you match an entry with its corresponding exit by indenting the next function call if it is not the exit of the previous one. + + The generic data included in the returned string includes a + timestamp (number of microseconds since the most recent initial + indentation), a process name, and the thread ID. This allows you to + identify what functions were called, who called them, and the + duration of each function call. + + + + If call entries and exits immediately precede each other, it is easy + to match them. However, in most cases, after a first function call + entry is made several other call entries and exits may be made + before the first call exits. The indentation counter helps you match + an entry with its corresponding exit by indenting the next function + call if it is not the exit of the previous one. + - - Consider the following example on the use of thread_indent(): - + + Consider the following example on the use of + thread_indent(): + thread_indent.stp probe kernel.function("*@net/socket.c") { - printf ("%s -> %s\n", thread_indent(1), probefunc()) + printf ("%s -> %s\n", thread_indent(1), probefunc()) } probe kernel.function("*@net/socket.c").return { - printf ("%s <- %s\n", thread_indent(-1), probefunc()) + printf ("%s <- %s\n", thread_indent(-1), probefunc()) } - prints out the thread_indent() and probe functions at each event in the following format: + + + prints out the + thread_indent() and probe functions at each event + in the following format: 0 ftp(7223): -> sys_socketcall @@ -423,44 +517,71 @@ probe kernel.function("*@net/socket.c").return 4775 ftp(7223): <- sys_socketcall -remember to add a reference later to "tapsets" from here, to clarify that thread_indent is defined in tapsets as a special function of sorts +remember to add a reference later to "tapsets" from here, to clarify +that thread_indent is defined in tapsets as a special function of sorts - + - + name - Identifies the name of a specific system call. This function can only be used in probes that use the event syscall.system_call. + Identifies the name of a specific system call. This function can + only be used in probes that use the event + syscall.system_call. + - + - + target() - Used in conjunction with stap script -x process ID or stap script -c command. If you want to specify a script to take an argument of a process ID or command, use target() as the variable in the script to refer to it. For example: + + Used in conjunction with stap + script -x process + ID or stap + script -c + command. If you want to specify + a script to take an argument of a process ID or command, use + target() as the variable in the script to refer + to it. For example: + - targetexample.stp +targetexample.stp probe syscall.* { - if (pid() == target()) { - printf("%s/n", name) - }} + if (pid() == target()) + printf("%s/n", name) +} - When is run with the argument -x process ID, it watches all system calls (as specified by the event syscall.*) and prints out the name of all system calls made by the specified process. + + When is run with the argument + -x process ID, it + watches all system calls (as specified by the event + syscall.*) and prints out the name of all system + calls made by the specified process. + - This has the same effect as specifying if (pid() == process ID) each time you wish to target a specific process. However, using target() makes it easier for you to re-use the script, giving you the ability to simply pass a process ID as an argument each time you wish to run the script (e.g. stap targetexample.stp -x process ID). + + This has the same effect as specifying if (pid() == + process ID) each time you wish + to target a specific process. However, using + target() makes it easier for you to re-use the + script, giving you the ability to simply pass a process ID as an + argument each time you wish to run the script (e.g. stap + targetexample.stp -x process ID). + - - - + + + - + -For more information about supported SystemTap functions, refer to man stapfuncs. + For more information about supported SystemTap functions, refer to + man stapfuncs. + will need a complete listing of supported handler functions? also, SystemTap function descriptions seem ambiguous, please advise. @@ -492,7 +615,6 @@ probe syscall.* { --> - -
+
-- cgit