Add documentation about how to debug non-stable PNaCl pexes in Pepper 35.

native_client_sdk/src/doc/devguide/devcycle/debugging.rst

 .. _devcycle-debugging:
 
 #########
 Debugging
 #########
 
 This document describes tools and techniques you can use to debug, monitor,
 and measure your application's performance.
 
 .. contents:: Table Of Contents
@@ skipping 196 matching lines @@
 <http://www.gnu.org/software/gdb/>`_, and is located at
 ``toolchain/<platform>_x86_newlib/bin/x86_64-nacl-gdb`` (where *<platform>*
 is the platform of your development machine: ``win``, ``mac``, or
 ``linux``).
 
 Note that this same copy of GDB can be used to debug any NaCl program,
 whether built using newlib or glibc for x86-32, x86-64 or ARM.  In the SDK,
 ``i686-nacl-gdb`` is an alias for ``x86_64-nacl-gdb``, and the ``newlib``
 and ``glibc`` toolchains both contain the same version of GDB.
 
-Debugging PNaCl pexes
-~~~~~~~~~~~~~~~~~~~~~
+Debugging PNaCl pexes (with Pepper 35+)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you want to use GDB to debug a program that is compiled with the PNaCl
+toolchain, you must have a copy of the pexe from **before** running
+``pnacl-finalize``. The ``pnacl-finalize`` tool converts LLVM bitcode
+to the stable PNaCl bitcode format, but it also strips out debug
+metadata, which we need for debugging.
+
+**Note** unlike the finalized copy of the pexe, the non-finalized debug copy
+is not considered stable. This means that a debug copy of the PNaCl
+application created by a Pepper N SDK is only guaranteed to run
+with a matching Chrome version N. If the version of the debug bitcode pexe
+does not match that of Chrome then the translation process may fail, and
+you will see and error message in the JavaScript console.
+
+Also, make sure you are passing the ``-g`` :ref:`compile option
+<compile_flags>` to ``pnacl-clang`` to enable generating debugging info.
+You might also want to omit ``-O2`` from the compile-time and link-time
+options, otherwise GDB not might be able to print variables' values when
+debugging (this is more of a problem with the PNaCl/LLVM toolchain than
+with GCC).
+
+Once you have built a non-stable debug copy of the pexe, list the URL of
+that copy in your application's manifest file:
+
+.. naclcode::
+
+  {
+    "program": {
+      "pnacl-translate": {
+        "url": "release_version.pexe",
+        "optlevel": 2
+      },
+      "pnacl-debug": {
+        "url": "debug_version.bc",
+        "optlevel": 0
+      }
+    }
+  }
+
+Copy the ``debug_version.bc`` and ``nmf`` files to the location that
+your local web server serves files from.
+
+When you run Chrome with ``--enable-nacl-debug``, Chrome will translate
+and run the ``debug_version.bc`` instead of ``release_version.pexe``.
+Once the debug version is loaded, you are ready to :ref:`run nacl-gdb
+<running_nacl_gdb>`
+
+Whether you publish the NMF file containing the debug URL to the release
+web server, is up to you. One reason to avoid publishing the debug URL
+is that it is only guaranteed to work for the Chrome version that matches
+the SDK version. Developers who may have left the ``--enable-nacl-debug``
+flag turned on may end up loading the debug copy of your application
+(which may or may not work, depending on their version of Chrome).
+
+
+Debugging PNaCl pexes (with older Pepper toolchains)

[jvoung (off chromium), 2014/03/28 22:05:42]

My though is we can leave this for a few more releases in case people haven't
migrated to a newer Pepper version (seems like some people are still using
pepper 31)...

Does that sound reasonable?

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you want to use GDB to debug a program that is compiled with the PNaCl
 toolchain, you must convert the ``pexe`` file to a ``nexe``.  (You can skip
-this step if you are using the GCC toolchain.)
+this step if you are using the GCC toolchain, or if you are using
+pepper 35 or later.)
 
 * Firstly, make sure you are passing the ``-g`` :ref:`compile option
   <compile_flags>` to ``pnacl-clang`` to enable generating debugging info.
   You might also want to omit ``-O2`` from the compile-time and link-time
-  options, otherwise GDB not might be able to print variables' values when
-  debugging (this is more of a problem with the PNaCl/LLVM toolchain than
-  with GCC).
+  options.
 
 * Secondly, use ``pnacl-translate`` to convert your ``pexe`` to one or more
   ``nexe`` files.  For example:
 
   .. naclcode::
     :prettyprint: 0
 
     <NACL_SDK_ROOT>/toolchain/win_pnacl/bin/pnacl-translate ^
       --allow-llvm-bitcode-input hello_world.pexe -arch x86-32 -o hello_world_x86_32.nexe
     <NACL_SDK_ROOT>/toolchain/win_pnacl/bin/pnacl-translate ^
@@ skipping 28 matching lines @@
 
 .. Note::
   :class: note
 
   **Note:** If you know whether Chrome is using the x86-32 or x86-64
   version of the NaCl sandbox on your system, you can translate the
   ``pexe`` once to a single x86-32 or x86-64 ``nexe``.  Otherwise, you
   might find it easier to translate the ``pexe`` to both ``nexe``
   formats as described above.
 
+.. _running_nacl_gdb:
+
 Running nacl-gdb
 ~~~~~~~~~~~~~~~~
 
 Before you start using nacl-gdb, make sure you can :doc:`build <building>` your
 module and :doc:`run <running>` your application normally. This will verify
 that you have created all the required :doc:`application parts
 <../coding/application-structure>` (.html, .nmf, and .nexe files, shared
 libraries, etc.), that your server can access those resources, and that you've
 configured Chrome correctly to run your application.  The instructions below
 assume that you are using a :ref:`local server <web_server>` to run your
@@ skipping 36 matching lines @@
      Prevents Chrome from displaying a warning when a tab is unresponsive.
 
    ``--user-data-dir=<directory>``
      Specifies the `user data directory
      <http://www.chromium.org/user-experience/user-data-directory>`_ from which
      Chrome should load its state.  You can specify a different user data
      directory so that changes you make to Chrome in your debugging session do
      not affect your personal Chrome data (history, cookies, bookmarks, themes,
      and settings).
 
+   ``--nacl-debug-mask=<nmf_url_mask1,nmf_url_mask2,...>``
+     Specifies a set of debug mask patterns. This allows you to selectively
+     choose to debug certain applications and not debug others. For example,
+     if you only want to debug the NMF files for your applications at
+     ``https://example.com/app``, and no other PNaCl applications found
+     on the web, specify ``--nacl-debug-mask=https://example.com/app/*.nmf``.
+     This helps accidentally debugging other PNaCl applications if you like

[Sam Clegg, 2014/03/28 22:18:29]

Use say PNaCl here rather than NaCl.  Is that intentional?

[jvoung (off chromium), 2014/03/28 22:39:33]

Not intentional -- It helps with NaCl as well, so changed to NaCl to be more
general.

+     to leave the ``--enable-nacl-debug`` flag turned on.
+     The pattern language for the mask follows `chrome extension match patterns
+     <http://developer.chrome.com/extensions/match_patterns>`_.
+     The pattern set can be inverted by prefixing the pattern set with
+     the ``!`` character.
+
    ``<URL>``
      Specifies the URL Chrome should open when it launches. The local server
      that comes with the SDK listens on port 5103 by default, so the URL when
      you're debugging is typically ``localhost:5103`` (assuming that your
      application's page is called index.html and that you run the local server
      in the directory where that page is located).
 
 #. Navigate to your application's page in Chrome. (You don't need to do this if
    you specified a URL when you launched Chrome in the previous step.) Chrome
    will start loading the application, then pause and wait until you start
    nacl-gdb and run the ``continue`` command.
 
 #. Go to the directory with your source code, and run nacl-gdb from there. For
    example::
 
      cd <NACL_SDK_ROOT>/examples/hello_world_gles
      <NACL_SDK_ROOT>/toolchain/win_x86_newlib/bin/x86_64-nacl-gdb
 
    The debugger will start and show you a gdb prompt::
 
      (gdb)
 
-#. Run the following three commands from the gdb command line::
+#. For debugging PNaCl pexes run the following gdb command lines
+   (skip to the next item if you are using NaCl instead of PNaCl)::
 
+     (gdb) target remote localhost:4014
+     (gdb) remote get nexe <path-to-save-translated-nexe-with-debug-info>
+     (gdb) file <path-to-save-translated-nexe-with-debug-info>
+     (gdb) remote get irt <path-to-save-NaCl-integrated-runtime>
+     (gdb) nacl-irt <path-to-saved-NaCl-integrated-runtime>
+
+#. For NaCl nexes, run the following commands from the gdb command line::
+
+     (gdb) target remote localhost:4014
      (gdb) nacl-manifest <path-to-your-.nmf-file>
-     (gdb) nacl-irt <path-to-Chrome-NaCl-integrated-runtime>
-     (gdb) target remote localhost:4014
+     (gdb) remote get irt <path-to-save-NaCl-integrated-runtime>
+     (gdb) nacl-irt <path-to-saved-NaCl-integrated-runtime>
 
-   These commands are described below:
-
-   ``nacl-manifest <path>``
-     Tells the debugger about your Native Client application by pointing it to
-     the application's manifest (.nmf) file. The manifest file lists your
-     application's executable (.nexe) files, as well as any libraries that are
-     linked with the application dynamically.
-
-   ``nacl-irt <path>``
-     Tells the debugger where to find the Native Client Integrated Runtime
-     (IRT). The IRT is located in the same directory as the Chrome executable,
-     or in a subdirectory named after the Chrome version. For example, if
-     you're running Chrome canary on Windows, the path to the IRT typically
-     looks something like ``C:/Users/<username>/AppData/Local/Google/Chrome
-     SxS/Application/23.0.1247.1/nacl_irt_x86_64.nexe``.
+#. The command used for PNaCl and NaCl are described below:
 
    ``target remote localhost:4014``
      Tells the debugger how to connect to the debug stub in the Native Client
      application loader. This connection occurs through TCP port 4014 (note
      that this port is distinct from the port which the local web server uses
-     to listen for incoming requests, typically port 5103).
+     to listen for incoming requests, typically port 5103). If you are
+     debugging multiple applications at the same time, the loader may choose
+     a port that is different from the default 4014 port. See the Chrome
+     task manager for the debug port.
+
+   ``remote get nexe <path>``
+     This saves the application's main executable (nexe) to ``<path>``.
+     For PNaCl, this provides a convenient way to access the nexe that is
+     a **result** of translating your pexe. This can then be loaded with
+     the ``file <path>`` command.
+
+   ``nacl-manifest <path>``
+     For NaCl (not PNaCl), this tells the debugger where to find your
+     application's executable (.nexe) files. The application's manifest
+     (.nmf) file lists your application's executable files, as well as any
+     libraries that are linked with the application dynamically.
+
+   ``remote get irt <path>``
+     This saves the Native Client Integrated Runtime (IRT). Normally,
+     the IRT is located in the same directory as the Chrome executable,
+     or in a subdirectory named after the Chrome version. For example, if
+     you're running Chrome canary on Windows, the path to the IRT typically
+     looks something like ``C:/Users/<username>/AppData/Local/Google/Chrome
+     SxS/Application/23.0.1247.1/nacl_irt_x86_64.nexe``.
+     The ``remote get irt <path>`` saves that to the current working
+     directory so that you do not need to find where exactly the IRT
+     is stored alongside Chrome.
+
+   ``nacl-irt <path>``
+     Tells the debugger where to find the Native Client Integrated Runtime
+     (IRT). ``<path>`` can either be the location of the copy saved by
+     ``remote get irt <path>`` or the copy that is installed alongside Chrome.
 
    A couple of notes on how to specify path names in the nacl-gdb commands
    above:
 
    * You can use a forward slash to separate directories on Linux, Mac, and
      Windows. If you use a backslash to separate directories on Windows, you
      must escape the backslash by using a double backslash "\\" between
      directories.
    * If any directories in the path have spaces in their name, you must put
      quotation marks around the path.
 
    As an example, here is a what these nacl-gdb commands might look like on
    Windows::
 
+     target remote localhost:4014
      nacl-manifest "C:/<NACL_SDK_ROOT>/examples/hello_world_gles/newlib/Debug/hello_world_gles.nmf"
      nacl-irt "C:/Users/<username>/AppData/Local/Google/Chrome SxS/Application/23.0.1247.1/nacl_irt_x86_64.nexe"

[Sam Clegg, 2014/03/28 22:18:29]

Is it recommended to set the remove before calling nacl-irt and nacl-manifest?

[jvoung (off chromium), 2014/03/28 22:39:33]

I moved "target remote ..." earlier in case people start using "remote get irt
...".

Otherwise, the original ordering may have been prettier if the IRT had symbol
names. Then the initial breakpoint will have the "_start" name. However, I think
recent IRTs shipped with chrome are fully stripped, so either way of loading the
IRT (from C:/.../Chrome../ or with "remote get irt") is not pretty. We'll have
to figure out a better way to get an IRT with debug info and symbols.

Still, it's useful to have the IRT even if it's stripped, to get stack unwinding
information if people compile without frame pointers.

-     target remote localhost:4014
 
    To save yourself some typing, you can put put these nacl-gdb commands in a
    script file, and execute the file when you run nacl-gdb, like so::
 
      <NACL_SDK_ROOT>/toolchain/win_x86_newlib/bin/x86_64-nacl-gdb -x <nacl-script-file>
 
    If nacl-gdb connects successfully to Chrome, it displays a message such as
    the one below, followed by a gdb prompt::
 
      0x000000000fc00200 in _start ()
@@ skipping 80 matching lines @@
 <http://www.chromium.org/nativeclient>`_ that describe how to do profiling on
 `64-bit Windows
 <https://sites.google.com/a/chromium.org/dev/nativeclient/how-tos/profiling-nacl-apps-on-64-bit-windows>`_
 and `Linux
 <http://www.chromium.org/nativeclient/how-tos/limited-profiling-with-oprofile-on-x86-64>`_
 machines.
 
 
 .. |menu-icon| image:: /images/menu-icon.png
 .. |puzzle| image:: /images/puzzle.png