Bind Debugger

The debugger can be used to run a bind program against a particular device. It outputs a trace of the bind program’s execution, describing why the driver would or would not bind to the device.

You can run the debugger in the following ways:

  • As a host tool. You provide the bind program source file and a file listing the properties of the device. This is useful during bind program development for testing the outcome of a program against different combinations of device properties.
  • On the target device. You specify the driver path and the device path within the system. This is useful for figuring out why a driver did or did not bind to a particular device.

Note: The debugger can only be used with bind programs written in the bind language described in this page.

Running the debugger as a host tool {#running-the-debugger-host}

You can run the debugger with the --debug option in the bind compiler.

  1. fx bindc debug \
  2.   --include src/devices/bind/fuchsia.usb/fuchsia.usb.bind \
  3.   --debug tools/bindc/examples/gizmo.dev \
  4.   tools/bindc/examples/gizmo.bind

The bind program source and the library sources are in the formats described in the bind rules and bind libraries sections, respectively. The --debug option takes a file containing a specification of the device to run the bind program against.

Note: The --debug and --output options are mutually exclusive, so the C header file will not be generated when running the compiler in debug mode.

Device specification file {#device-specification}

The debugger takes a file specifying the device to run the bind program against. This specification is simply a list of key-value pairs describing the properties of the device.

Example

This example device specification can be found at //tools/bindc/examples/gizmo.dev.

  1. fuchsia.BIND_PROTOCOL = fuchsia.usb.BIND_PROTOCOL.INTERFACE
  2. fuchsia.BIND_USB_VID = fuchsia.usb.BIND_USB_VID.REALTEK
  3. fuchsia.BIND_USB_CLASS = fuchsia.usb.BIND_USB_CLASS.VIDEO
  4. fuchsia.BIND_USB_SUBCLASS = fuchsia.usb.BIND_USB_SUBCLASS.VIDEO_CONTROL

Grammar

  1. device-specification = ( property )* ;
  3. property = compound-identifier , "=" , value ;
  5. compound-identifier = IDENTIFIER ( "." , IDENTIFIER )* ;
  7. value = compound-identifier | STRING-LITERAL | NUMERIC-LITERAL | "true" | "false" ;

An identifier matches the regex [a-zA-Z]([a-zA-Z0-9_]*[a-zA-Z0-9])?.

A string literal matches the regex ”[^”]*”, and a numeric literal matches the regex [0-9]+ or 0x[0-9A-F]+.

The bind compiler will ignore (treat as whitespace) any line prefixed by //, and any multiple lines delimited by /* and */.

Running the debugger on the target device {#running-the-debugger-target}

The debugger is run using its package URL. For example:

  1. fx run fuchsia-pkg://fuchsia.com/bind_debugger#meta/bind_debugger.cmx \
  2.     /system/driver/bt-hci-intel.so \
  3.     class/bt-transport/000

The command takes the path of the driver to debug and the path of the device to debug it against.

Device path

There are two ways to specify the device:

  • Its path within /dev/class, e.g. class/bt-transport/000.
  • Its topological path, e.g. sys/pci/00:14.0/xhci/usb-bus/003/003/ifc-000/bt_transport_usb.

Both of the paths are relative to /dev/.

The topological path can be determined from the ouptut of dm dump. For example, tracing the path to the node [bt_transport_usb] in the output below gives the topological path sys/pci/00:14.0/xhci/usb-bus/003/003/ifc-000/bt_transport_usb.

  1. [root]
  2.    <root> pid=3456
  3.       [null] pid=3456 /boot/driver/builtin.so
  4.       [zero] pid=3456 /boot/driver/builtin.so
  5.    [misc]
  6.       <misc> pid=3525
  7.          [demo-fifo] pid=3525 /boot/driver/demo-fifo.so
  8.          [ktrace] pid=3525 /boot/driver/ktrace.so
  9.    [sys]
  10.       <sys> pid=3369 /boot/driver/platform-bus.so
  11.          [pci] pid=3369 /boot/driver/platform-bus-x86.so
  12.             [00:00.0] pid=3369 /boot/driver/bus-pci.so
  13.             [00:14.0] pid=3369 /boot/driver/bus-pci.so
  14.                <00:14.0> pid=4384 /boot/driver/bus-pci.proxy.so
  15.                   [xhci] pid=4384 /boot/driver/xhci.so
  16.                      [xdc] pid=4384 /boot/driver/xhci.so
  17.                      [usb-bus] pid=4384 /boot/driver/usb-bus.so
  18.                         [001] pid=4384 /boot/driver/usb-bus.so
  19.                            [001] pid=4384 /boot/driver/usb-composite.so
  20.                               [ifc-000] pid=4384 /boot/driver/usb-composite.so
  21.                                  [usb-hid] pid=4384 /boot/driver/usb-hid.so
  22.                                     [hid-device-000] pid=4384 /boot/driver/hid.so
  23.                         [002] pid=4384 /boot/driver/usb-bus.so
  24.                            [002] pid=4384 /boot/driver/usb-composite.so
  25.                               [ifc-000] pid=4384 /boot/driver/usb-composite.so
  26.                                  [usb-hid] pid=4384 /boot/driver/usb-hid.so
  27.                                     [hid-device-000] pid=4384 /boot/driver/hid.so
  28.                         [003] pid=4384 /boot/driver/usb-bus.so
  29.                            [003] pid=4384 /boot/driver/usb-composite.so
  30.                               [ifc-000] pid=4384 /boot/driver/usb-composite.so
  31.                                  [bt_transport_usb] pid=4384 /boot/driver/bt-transport-usb.so
  32.                                     [bt_hci_intel] pid=4384 /system/driver/bt-hci-intel.so
  33.                                        [bt_host] pid=4384 /system/driver/bt-host.so

Debugger output

The output of the debugger is a trace of the bind program’s execution. The trace contains information about whether each statement in the bind program succeeded, and why or why not. For example, if a condition statement failed because the device did not have the required value, the debugger will output what the actual value of the device was (or the fact that the device had no value for that property). The trace also includes information about which branches were taken in if statements.

Example

The output of the debugger when running the host tool command above is:

  1. Line 4: Condition statement succeeded: fuchsia.BIND_PROTOCOL == fuchsia.usb.BIND_PROTOCOL.INTERFACE;
  2. Line 6: If statement condition failed: fuchsia.BIND_USB_VID == fuchsia.usb.BIND_USB_VID.INTEL
  3.     Actual value of `fuchsia.BIND_USB_VID` was `fuchsia.usb.BIND_USB_VID.REALTEK` [0xbda].
  4. Line 9: If statement condition succeeded: fuchsia.BIND_USB_VID == fuchsia.usb.BIND_USB_VID.REALTEK
  5. Line 11: Accept statement succeeded.
  6.     Value of `fuchsia.BIND_USB_CLASS` was `fuchsia.usb.BIND_USB_CLASS.VIDEO` [0xe].
  7. Driver binds to device.

If you run the debugger on the Fuchsia target device, you will see similar output information. However, information such as identifiers and source code snippets may be missing, since the system only stores the bind program bytecode, not the source code.

The trace shows the outcome of each statement that was reached while executing the bind program:

  • The device has the USB device protocol, so the first condition statement is satisfied.
  • The device’s vendor ID is REALTEK, so the second branch of the if statement is taken.
  • The device has one of the two accepted classes (video), so the accept statement is satisfied.

The debugger outputs that the driver would successfully bind to a device with these properties.