xref: /netbsd-src/external/cddl/dtracetoolkit/dist/Shell/Readme (revision c29d51755812ace2e87aeefdb06cb2b4dac7087a)
1Shell - DTracing Shell Scripting
2
3   These scripts trace activity of various shell programming languages,
4   and make use of specific shell DTrace providers, which are either
5   integrated or available for download from the shells page listed below.
6   Each script has a prefix to make the shell language clear.
7
8	http://www.opensolaris.org/os/community/dtrace/shells/
9
10   sh - the Bourne Shell. This provider was written by Alan Hargreaves and
11   is currently available both as a diff and in binary form from the shells
12   page.
13
14   Since the DTrace Shell providers are under development, there is a chance
15   that they have changed slightly by the time you are reading this, causing
16   these scripts to either break or behave oddly. Firstly, check for newer
17   versions of the DTraceToolkit; if it hasn't been updated and you need
18   to use these scripts immediately, then updating them shouldn't take
19   too long. The following was the state of the providers when these scripts
20   were written - check for changes and update the scripts accordingly,
21
22	provider sh {
23	    probe function-entry(file, function, lineno);
24	    probe function-return(file, function, rval);
25	    probe builtin-entry(file, function, lineno);
26	    probe builtin-return(file, function, rval);
27	    probe command-entry(file, function, lineno);
28	    probe command-return(file, function, rval);
29	    probe script-start(file);
30	    probe script-done(file, rval);
31	    probe subshell-entry(file, childpid);
32	    probe subshell-return(file, rval);
33	    probe line(file, lineno);
34	};
35
36