Diff for /wikisrc/tutorials/how_to_enable_and_run_dtrace.mdwn between versions 1.1 and 1.5

version 1.1, 2011/11/20 20:55:21 version 1.5, 2014/04/03 11:55:12
Line 1 Line 1
 DTrace is a Dynamic Tracing framework developed by Sun and ported to NetBSD. It enables extensive instrumentation of the kernel and user space. See the [DTrace Community Page](http://hub.opensolaris.org/bin/view/Community+Group+dtrace/WebHome) for more information. Also see [DTrace Introduction](http://wikis.sun.com/display/DTrace/Introduction).  DTrace is a Dynamic Tracing framework developed by Sun and ported to NetBSD. It enables extensive instrumentation of the kernel and user space. See the [DTrace Community Page](http://dtrace.org) for more information. Also see [DTrace Introduction](http://dtrace.org/guide/preface.html). 
   
   # Current status
 DTrace is a work-in-progress effort and it is for i386 systems only. Two providers are available; the Statically Defined Tracing (SDT) provider and the Function Boundary Tracer (FBT) provider.  
   ## Supported platforms
 You can currently run a hello world DScript.  
   DTrace is a work-in-progress effort and it is for x86 systems and some arm boards.
 ##  Building DTrace  
   * i386 and amd64
 You need the following options in your kernel:  * evbarm
          * BEAGLEBONE and SHEEVAPLUG
     options         INSECURE  
     options         KDTRACE_HOOKS   # DTrace support  ## Supported providers
     options         MODULAR  
      * SDT: Statically Defined Tracing
   * FBT: Function Boundary Tracing
 You also need to build distribution with the options MKMODULAR=yes and MKDTRACE=yes.  
   You can currently run a hello world DScript. 
 ##  Running hello world  
   # How to use
 Load the solaris and dtrace modules, and the SDT (Statically Defined Tracing) and FBT (Function Boundary Tracing) modules:  
      ##  Building DTrace 
     modload solaris  
     modload dtrace  You need the following options in your kernel: 
     modload sdt      
     modload fbt      options         INSECURE
          options         KDTRACE_HOOKS   # DTrace support
       options         MODULAR
 Make the dtrace device node:      
      
     mkdir /dev/dtrace  You also need to build distribution with the options MKMODULAR=yes and MKDTRACE=yes. 
     mknod /dev/dtrace/dtrace c dtrace 0  
      ##  Running hello world 
   
 List the dtrace probes  Load the solaris and dtrace modules, and the SDT (Statically Defined Tracing) and FBT (Function Boundary Tracing) modules: 
          
     dtrace -l      modload solaris
          modload dtrace
        ID   PROVIDER            MODULE                          FUNCTION NAME      modload sdt
         1     dtrace                                                     BEGIN      modload fbt
         2     dtrace                                                     END      
         3     dtrace                                                     ERROR  
         4        fbt            netbsd             AcpiAcquireGlobalLock entry  Make the dtrace device node: 
         5        fbt            netbsd             AcpiAcquireGlobalLock return      
         6        fbt            netbsd             AcpiAllocateRootTable entry      mkdir /dev/dtrace
         7        fbt            netbsd                    AcpiAttachData entry      mknod /dev/dtrace/dtrace c dtrace 0
         .      
         .  
     29129        fbt           solaris                   zfs_vop_getattr entry  List the dtrace probes 
     29130        fbt           solaris                   zfs_vop_getattr return      
     29131       proc                                                     create      dtrace -l
     29132       proc                                                     exec      
         .         ID   PROVIDER            MODULE                          FUNCTION NAME
         .          1     dtrace                                                     BEGIN
     29140       proc                                                     lwp_start          2     dtrace                                                     END
     29141       proc                                                     lwp_exit          3     dtrace                                                     ERROR
              4        fbt            netbsd             AcpiAcquireGlobalLock entry
           5        fbt            netbsd             AcpiAcquireGlobalLock return
            6        fbt            netbsd             AcpiAllocateRootTable entry
           7        fbt            netbsd                    AcpiAttachData entry
           . 
 Put the following into the file hello.d          .
          29129        fbt           solaris                   zfs_vop_getattr entry 
     BEGIN      29130        fbt           solaris                   zfs_vop_getattr return
     {      29131       proc                                                     create
         trace("Hello world");      29132       proc                                                     exec 
         exit(0);          .
     }          .
          29140       proc                                                     lwp_start
       29141       proc                                                     lwp_exit
 Run the hello world script:      
      
     dtrace -s hello.d    
      
     dtrace: script './hello.d' matched 1 probe  
     CPU     ID                    FUNCTION:NAME  Put the following into the file hello.d 
       0      1                           :BEGIN   Hello world      
          BEGIN
       {
 A more complex example that traces the execution of a sleep operation in the kernel:          trace("Hello world");
              exit(0);
     #pragma D option flowindent      }
          
     fbt::syscall:entry  
     /execname == "sleep" && guard++ == 0/  Run the hello world script: 
     {      
             self->traceme = 1;      dtrace -s hello.d
             printf("fd: %d", arg0);      
     }      dtrace: script './hello.d' matched 1 probe
          CPU     ID                    FUNCTION:NAME
     fbt:::        0      1                           :BEGIN   Hello world
     /self->traceme/      
     {}  
      A more complex example that traces the execution of a sleep operation in the kernel: 
     fbt::syscall:return      
     /self->traceme/      #pragma D option flowindent
     {      
             self->traceme = 0;      fbt::syscall:entry
             exit(0);      /execname == "sleep" && guard++ == 0/
     }      {
                  self->traceme = 1;
               printf("fd: %d", arg0);
 Start the script running (dtrace -s <scriptname.d>) and then execute a sleep 2 in another shell.      }
       
       fbt:::
       /self->traceme/
       {}
       
       fbt::syscall:return
       /self->traceme/
       {
               self->traceme = 0;
               exit(0);
       }
       
   
   Start the script running (dtrace -s <scriptname.d>) and then execute a sleep 2 in another shell. 

Removed from v.1.1  
changed lines
  Added in v.1.5


CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb