<?xml version="1.0"?>

<!--
  Copyright (C) Nginx, Inc.
  -->

<!DOCTYPE article SYSTEM "../../../dtd/article.dtd">

<article name="Debugging nginx with DTrace pid provider"
	link="/en/docs/nginx_dtrace_pid_provider.html"
	lang="en"
	rev="4"
	toc="no">

<section>

<para>
This article assumes the reader has a general knowledge of nginx internals and
<link id="see_also">DTrace</link>.
</para>

<para>
Although nginx built with the <link doc="debugging_log.xml">--with-debug</link>
option already provides a lot of information about request processing,
it is sometimes desirable to trace particular parts of code path more
thoroughly and at the same time omit the rest of debugging output.
DTrace pid provider (available on Solaris, macOS) is a useful tool to
explore userland program’s internals, since it doesn’t require any code
changes and it can help with the task.
A simple DTrace script to trace and print nginx function calls
may look like this:

<programlisting>
#pragma D option flowindent

pid$target:nginx::entry {
}

pid$target:nginx::return {
}
</programlisting>

</para>

<para>
DTrace capabilities for function calls tracing provide only a limited amount
of useful information, though.
Real-time inspection of function arguments is typically more interesting,
but also a bit more complicated.
Examples below are intended to help the reader become more familiar with
DTrace and the process of analyzing nginx behavior using DTrace.
</para>

<para>
One of the common scenarios for using DTrace with nginx is the following:
attach to the nginx worker process to log request lines and request start times.
The corresponding function to attach is
<c-func>ngx_http_process_request</c-func>, and the argument in question
is a pointer to the <literal>ngx_http_request_t</literal> structure.
DTrace script for such request logging can be as simple as:

<programlisting>
pid$target::*ngx_http_process_request:entry
{
    this->request = (ngx_http_request_t *)copyin(arg0, sizeof(ngx_http_request_t));
    this->request_line = stringof(copyin((uintptr_t)this->request->request_line.data,
                                         this->request->request_line.len));
    printf("request line = %s\n", this->request_line);
    printf("request start sec = %d\n", this->request->start_sec);
}
</programlisting>

</para>

<para>
It should be noted that in the example above DTrace requires some knowledge
about the <literal>ngx_http_request_t</literal> structure.
Unfortunately while it is possible to use a specific <literal>#include</literal>
directive in the DTrace script and then pass it to a C preprocessor
(with the <literal>-C</literal> flag), that doesn’t really work.
Due to a lot of cross dependencies, almost all nginx header files
have to be included.
In turn, based on <command>configure</command> script settings,
nginx headers will include PCRE,
OpenSSL and a variety of system header files.
While in theory all those header files related to a specific nginx build
might be included in DTrace script preprocessing and compilation, in reality
DTrace script most probably will fail to compile because of unknown syntax in
some header files.
</para>

<para>
The problem above can be solved by including only the relevant and
necessary structure and type definitions in the DTrace script.
DTrace has to know sizes of structures, types, and fields offsets.
Thus dependencies can be further reduced by manually optimizing
structure definitions for use with DTrace.
</para>

<para>
Let’s use DTrace script example above and see what structure definitions
it needs to work properly.
</para>

<para>
First of all <literal>objs/ngx_auto_config.h</literal> file generated by
configure should be included, because it defines a number of constants
affecting various <literal>#ifdef</literal>’s.
After that, some basic types and definitions
like <literal>ngx_str_t</literal>, <literal>ngx_table_elt_t</literal>,
<literal>ngx_uint_t</literal> etc. should be put at the beginning of the
DTrace script.
These definitions are compact, commonly used and unlikely to be
frequently changed.
</para>

<para>
Then there’s the <literal>ngx_http_request_t</literal> structure that
contains a lot of pointers to other structures.
Because these pointers are really irrelevant to this script, and because they
have the same size, it is possible to just replace them with void pointers.
Instead of changing definitions, it is better to add appropriate typedefs,
though:

<programlisting>
typedef ngx_http_upstream_t     void;
typedef ngx_http_request_body_t void;
</programlisting>

Last but not least it is necessary to add definitions of two member structures
(<literal>ngx_http_headers_in_t</literal>,
<literal>ngx_http_headers_out_t</literal>),
declarations of callback functions and definitions of constants.
</para>

<para>
The final DTrace script can be downloaded from
<link url="http://nginx.org/download/trace_process_request.d">here</link>.
</para>

<para>
The following example shows the output of running this script:

<programlisting>
# dtrace -C -I ./objs -s trace_process_request.d -p 4848
dtrace: script 'trace_process_request.d' matched 1 probe
CPU     ID                    FUNCTION:NAME
  1      4 .XAbmO.ngx_http_process_request:entry request line = GET / HTTP/1.1
request start sec = 1349162898

  0      4 .XAbmO.ngx_http_process_request:entry request line = GET /en/docs/nginx_dtrace_pid_provider.html HTTP/1.1
request start sec = 1349162899
</programlisting>

</para>

<para>Using similar techniques the reader should be able to trace other
nginx function calls.
</para>

</section>


<section id="see_also"
         name="See also">

<para>
<list type="bullet">

<listitem>
<link url="http://docs.oracle.com/cd/E19253-01/817-6223/index.html">
Solaris Dynamic Tracing Guide</link>
</listitem>

<listitem>
<link url="http://dtrace.org/blogs/brendan/2011/02/09/dtrace-pid-provider/">
Introduction article on DTrace pid provider</link>
</listitem>

</list>
</para>

</section>

</article>