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

version 1.1, 2011/11/20 20:55:21 version 1.10, 2014/09/18 15:01:25
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  
   ## TODO for netbsd-7
 Load the solaris and dtrace modules, and the SDT (Statically Defined Tracing) and FBT (Function Boundary Tracing) modules:  
      * Rename provider modules to `dtrace_*.kmod`: `dtrace_fbt.kmod`, &c.
     modload solaris  * Measure effect of `options KDTRACE_HOOKS` on system performance.
     modload dtrace  * Determine whether the profile module works and list it here.
     modload sdt  * Put a dtrace target in /dev/MAKEDEV.
     modload fbt  * Integrate [[riz|users/riz]]'s syscall provider patch.
      
   ## TODO for netbsd-6
 Make the dtrace device node:  
      Need to identify changes to pull up to netbsd-6 and pull them up.
     mkdir /dev/dtrace  Candidates:
     mknod /dev/dtrace/dtrace c dtrace 0  
      * Profile provider.
   
 List the dtrace probes  # How to use
      
     dtrace -l  ##  Building DTrace 
      
        ID   PROVIDER            MODULE                          FUNCTION NAME  You need the following options in your kernel: 
         1     dtrace                                                     BEGIN      
         2     dtrace                                                     END      options         INSECURE
         3     dtrace                                                     ERROR      options         KDTRACE_HOOKS   # kernel DTrace hooks
         4        fbt            netbsd             AcpiAcquireGlobalLock entry      options         MODULAR
         5        fbt            netbsd             AcpiAcquireGlobalLock return      
         6        fbt            netbsd             AcpiAllocateRootTable entry  
         7        fbt            netbsd                    AcpiAttachData entry  You also need to build distribution with the options MKDTRACE=yes.
         .  
         .  ##  Running hello world 
     29129        fbt           solaris                   zfs_vop_getattr entry  
     29130        fbt           solaris                   zfs_vop_getattr return  Load the solaris and dtrace modules, and the SDT (Statically Defined Tracing) and FBT (Function Boundary Tracing) modules: 
     29131       proc                                                     create      
     29132       proc                                                     exec      modload solaris
         .      modload dtrace
         .      modload sdt
     29140       proc                                                     lwp_start      modload fbt
     29141       proc                                                     lwp_exit      
      
   Make the dtrace device node: 
        
       mkdir /dev/dtrace
       mknod /dev/dtrace/dtrace c dtrace 0
 Put the following into the file hello.d      
      
     BEGIN  List the dtrace probes 
     {      
         trace("Hello world");      dtrace -l
         exit(0);      
     }         ID   PROVIDER            MODULE                          FUNCTION NAME
              1     dtrace                                                     BEGIN
           2     dtrace                                                     END
 Run the hello world script:          3     dtrace                                                     ERROR
              4        fbt            netbsd             AcpiAcquireGlobalLock entry
     dtrace -s hello.d          5        fbt            netbsd             AcpiAcquireGlobalLock return
              6        fbt            netbsd             AcpiAllocateRootTable entry
     dtrace: script './hello.d' matched 1 probe          7        fbt            netbsd                    AcpiAttachData entry
     CPU     ID                    FUNCTION:NAME          . 
       0      1                           :BEGIN   Hello world          .
          29129        fbt           solaris                   zfs_vop_getattr entry 
       29130        fbt           solaris                   zfs_vop_getattr return
 A more complex example that traces the execution of a sleep operation in the kernel:      29131       proc                                                     create
          29132       proc                                                     exec 
     #pragma D option flowindent          .
              .
     fbt::syscall:entry      29140       proc                                                     lwp_start
     /execname == "sleep" && guard++ == 0/      29141       proc                                                     lwp_exit
     {      
             self->traceme = 1;  
             printf("fd: %d", arg0);    
     }  
      
     fbt:::  Put the following into the file hello.d:
     /self->traceme/      
     {}      BEGIN
          {
     fbt::syscall:return          trace("Hello world");
     /self->traceme/          exit(0);
     {      }
             self->traceme = 0;      
             exit(0);  
     }  Run the hello world script: 
          
       dtrace -s hello.d
 Start the script running (dtrace -s <scriptname.d>) and then execute a sleep 2 in another shell.      
       dtrace: script './hello.d' matched 1 probe
       CPU     ID                    FUNCTION:NAME
         0      1                           :BEGIN   Hello world
       
   
   A more complex example that traces the execution of a sleep operation
   in the kernel. Put it in sleep.d:
       
       #pragma D option flowindent
       
       fbt::syscall:entry
       /execname == "sleep" && guard++ == 0/
       {
               self->traceme = 1;
               printf("fd: %d", arg0);
       }
       
       fbt::syscall:entry /self->traceme/ {}
       
       fbt::syscall:return
       /self->traceme/
       {
               self->traceme = 0;
               exit(0);
       }
       
   
   Start the script running (dtrace -s sleep.d) and then execute a "sleep 2" in another shell. 

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


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