# Tutorial
-This tutorial shows how to compile the Exatracer and use it for testing on a HIP
+This tutorial shows how to compile the Exatracer and use it for testing a HIP
hello world program.
# User program
# Create an LTTng session and dump the trace to `my-traces' directory.
lttng create --output $TRACE_OUTPUT
-# Enable all event defined by the Exatracer. For every public function of HIP,
+# Enable all events defined by the Exatracer. For every public function of HIP,
# HSA there are two events. `enter' and `exit'. For every public function of
# ROC-TX, there is a single event.
#
# All events have some context information, like timestamp, hostname and CPU ID.
#
-# A `enter' event has all the arguments passed to the function, plus a pair of
+# An `enter' event has all the arguments passed to the function, plus a pair of
# IDs that when concatenated, forms a unique ID in the trace.
#
-# A `exit' event only has the corresponding pair of IDs to do correlation with
+# An `exit' event only has the corresponding pair of IDs to do correlation with
# the `enter' event.
lttng enable-event --userspace 'hsa:*'
lttng enable-event --userspace 'hip:*'
lttng start
# The application is executed with the Exatracer LD_PRELOAD onto it. This
-# assumes that `libextracer.so' can be found by the dynamic loader. See
-# ld-linux(8).
+# assumes that `libexatracer.so' can be found by the dynamic loader. See
+# ld-linux(8) for more information.
LD_PRELOAD=libexatracer.so ./hello-world
# When done, the tracing session can be destroyed to flush all pending events.
[12:35:27.404342780] (+0.000001610) HOST hip:hipDeviceSynchronize_exit: { cpu_id = 11 }, { lttng_thread_id = 0, lttng_local_id = 8, lttng_has_ret = 1, lttng_ret = 0 }
```
-Each line represents an event. Events are printed in chronolical order. The
-anatomy of a event is like so:
+Each line represents an event. Events are printed in chronological order. The
+anatomy of a event is like so:
`[TIMESTAMP] (PREVIOUS-DIFF) HOSTNAME PROVIDER:EVENT_NAME CONTEXT ... { FIELDS ... }`
Refer to the [Babeltrace
documentation](https://babeltrace.org/docs/v2.0/man1/babeltrace2-convert.1/) for
interpreting the events.
-
-
-