Index: share/sgml/freebsd.ent =================================================================== RCS file: /home/dcvs/doc/share/sgml/freebsd.ent,v retrieving revision 1.105 diff -u -r1.105 freebsd.ent --- freebsd.ent 3 Nov 2008 19:21:44 -0000 1.105 +++ freebsd.ent 18 Nov 2008 06:46:19 -0000 @@ -50,6 +50,11 @@ + + + + Index: en_US.ISO8859-1/books/handbook/dtrace/chapter.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/handbook/dtrace/chapter.sgml,v retrieving revision 1.5 diff -u -r1.5 chapter.sgml --- dtrace/chapter.sgml 20 Oct 2008 12:50:42 -0000 1.5 +++ dtrace/chapter.sgml 18 Nov 2008 06:45:36 -0000 @@ -22,44 +22,44 @@ - DTrace + &dtrace; Synopsis - DTrace + &dtrace; - DTrace support - DTrace + &dtrace; support + &dtrace; - DTrace, also known as Dynamic Tracing, was developed by + &dtrace;, also known as Dynamic Tracing, was developed by &sun; as a tool for locating performance bottlenecks in production and pre-production systems. It is not, in any way, a debugging tool, but a tool for real time system analysis to locate performance and other issues. - DTrace is a remarkable profiling tool, with an impressive + &dtrace; is a remarkable profiling tool, with an impressive array of features for diagnosing system issues. It may also be used to run pre-written scripts to take advantage of its capabilities. Users may even author their own utilities using - the DTrace D Language, allowing them to customize their profiling + the &dtrace; D Language, allowing them to customize their profiling based on specific needs. After reading this chapter, you will know: - What DTrace is and what features it provides. + What &dtrace; is and what features it provides. - Differences between the &solaris; DTrace implementation + Differences between the &solaris; &dtrace; implementation and the one provided by &os;. - How to enable and use DTrace on &os;. + How to enable and use &dtrace; on &os;. @@ -104,11 +104,11 @@ Implementation Differences - While the DTrace in &os; is very similar to that found + While the &dtrace; in &os; is very similar to that found in &solaris;, differences exist that should be explained before continuing. The primary difference users will notice is that - on &os;, DTrace needs to be specifically enabled. There are - kernel options and modules which must be enabled for DTrace to + on &os;, &dtrace; needs to be specifically enabled. There are + kernel options and modules which must be enabled for &dtrace; to work properly. These will be explained later. There is a DDB_CTF kernel option which @@ -132,29 +132,29 @@ allows tracing malloc() by type in the &os; kernel. - Only root may use DTrace on &os;. + Only root may use &dtrace; on &os;. This is related to security differences, &solaris; has a few low level security checks which do not yet exist in &os;. As such, the /dev/dtrace/dtrace is strictly limited to root users only. - Finally, the DTrace software falls under &sun;'s + Finally, the &dtrace; software falls under &sun;'s CDDL license. The Common Development and Distribution License comes with &os;, see the /usr/src/cddl/contrib/opensolaris/OPENSOLARIS.LICENSE or view it online at . - This license means that a &os; kernel with the DTrace options + This license means that a &os; kernel with the &dtrace; options is still BSD licensed; however the CDDL kicks in when the modules are distributed in binary form, or the binaries are loaded. - Enabling DTrace Support + Enabling &dtrace; Support - To enable support for DTrace, add the following lines to + To enable support for &dtrace;, add the following lines to the kernel configuration file: options KDTRACE_HOOKS @@ -167,7 +167,7 @@ options KDTRACE_FRAME This option provides support for the FBT - feature. DTrace will work without this option; however, there + feature. &dtrace; will work without this option; however, there will be limited support for function boundary tracing. @@ -190,14 +190,14 @@ After rebooting and allowing the new kernel to be loaded into memory, support for the Korn shell should be added. This - is needed as the DTrace toolkit has several utilities written + is needed as the &dtrace; toolkit has several utilities written in ksh. Install the shells/ksh93. It is also possible to run these tools under shells/pdksh or shells/mksh. - Finally, obtain the current DTrace toolkit. The current + Finally, obtain the current &dtrace; toolkit. The current version is available at . There is an install mechanism included; however, installation @@ -205,26 +205,26 @@ - Using DTrace + Using &dtrace; - Before making use of DTrace functionality, the DTrace device + Before making use of &dtrace; functionality, the &dtrace; device must exist. To load the device, issue the following command: &prompt.root; kldload dtraceall - DTrace support should now be available. To view all probes + &dtrace; support should now be available. To view all probes the administrator may now execute the following command: &prompt.root; dtrace -l | more All output is passed to the more utility as it will quickly overflow the screen buffer. At - this point, DTrace should be considered working. It is now + this point, &dtrace; should be considered working. It is now time to review the toolkit. The toolkit is a collection of ready-made scripts to run - with DTrace to collect system information. There are scripts + with &dtrace; to collect system information. There are scripts to check open files, memory, CPU usage and a lot more. Extract the scripts with the following command: @@ -247,14 +247,14 @@ At this point it is prudent to remind the reader that - DTrace support in &os; is incomplete + &dtrace; support in &os; is incomplete and experimental. Many of these scripts will not work as they are either too &solaris;-specific or use probes which are unsupported at this time. At the time of this writing only two of the scripts of the - DTrace Toolkit are fully supported in &os;: + &dtrace; Toolkit are fully supported in &os;: the hotkernel and procsystime scripts. These are the two we will explore in the following parts of this section. @@ -371,8 +371,8 @@ The D Language - The DTrace Toolkit includes many scripts in the special language of - DTrace. This language is called the D language by &sun; + The &dtrace; Toolkit includes many scripts in the special language of + &dtrace;. This language is called the D language by &sun; documentation, and it is very similar to C++. An in depth discussion of the language is beyond the scope of this document. It is extensively discussed Index: en_US.ISO8859-1/books/handbook/preface/preface.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/handbook/preface/preface.sgml,v retrieving revision 1.42 diff -u -r1.42 preface.sgml --- preface/preface.sgml 17 Nov 2008 09:07:40 -0000 1.42 +++ preface/preface.sgml 18 Nov 2008 06:45:36 -0000 @@ -428,9 +428,9 @@ - , DTrace + , &dtrace; - Describes how to configure and use the DTrace tool from &sun; + Describes how to configure and use the &dtrace; tool from &sun; in &os;. Dynamic tracing can help locate performance issues, by performing real time system analysis.