lttng-ust(3): reorganize the "Context information" section
[lttng-ust.git] / doc / man / lttng-ust.3.txt
index 9865547eea36b3b1732408cb6206a6c1b97e01fb..e6887f8d08cb058a28a04e05962c884d48434a90 100644 (file)
@@ -755,7 +755,9 @@ man:lttng-add-context(1).
 
 The following context fields are supported by LTTng-UST:
 
-`cpu_id`::
+General context fields::
++
+`cpu_id`:::
     CPU ID.
 +
 NOTE: This context field is always enabled, and it cannot be added
@@ -763,68 +765,106 @@ with man:lttng-add-context(1). Its main purpose is to be used for
 dynamic event filtering. See man:lttng-enable-event(1) for more
 information about event filtering.
 
-`ip`::
+`ip`:::
     Instruction pointer: enables recording the exact address from which
     an event was emitted. This context field can be used to
     reverse-lookup the source location that caused the event
     to be emitted.
 
-`perf:thread:COUNTER`::
+`pthread_id`:::
+    POSIX thread identifier.
++
+Can be used on architectures where `pthread_t` maps nicely to an
+`unsigned long` type.
+
+Process context fields::
++
+`procname`:::
+    Thread name, as set by man:exec(3) or man:prctl(2). It is
+    recommended that programs set their thread name with man:prctl(2)
+    before hitting the first tracepoint for that thread.
+
+`vpid`:::
+    Virtual process ID: process ID as seen from the point of view of the
+    current process ID namespace (see man:pid_namespaces(7)).
+
+`vtid`:::
+    Virtual thread ID: thread ID as seen from the point of view of the
+    current process ID namespace (see man:pid_namespaces(7)).
+
+perf context fields::
++
+`perf:thread:COUNTER`:::
     perf counter named 'COUNTER'. Use `lttng add-context --list` to
     list the available perf counters.
 +
 Only available on IA-32 and x86-64 architectures.
 
-`perf:thread:raw:rN:NAME`::
+`perf:thread:raw:rN:NAME`:::
     perf counter with raw ID 'N' and custom name 'NAME'. See
     man:lttng-add-context(1) for more details.
 
-`pthread_id`::
-    POSIX thread identifier. Can be used on architectures where
-    `pthread_t` maps nicely to an `unsigned long` type.
+Namespace context fields (see man:namespaces(7))::
++
+`cgroup_ns`:::
+    Inode number of the current control group namespace (see
+    man:cgroup_namespaces(7)) in the proc file system.
 
-`procname`::
-    Thread name, as set by man:exec(3) or man:prctl(2). It is
-    recommended that programs set their thread name with man:prctl(2)
-    before hitting the first tracepoint for that thread.
+`ipc_ns`:::
+    Inode number of the current IPC namespace (see
+    man:ipc_namespaces(7)) in the proc file system.
 
-`vpid`::
-    Virtual process ID: process ID as seen from the point of view of
-    the current man:pid_namespaces(7).
+`mnt_ns`:::
+    Inode number of the current mount point namespace (see
+    man:mount_namespaces(7)) in the proc file system.
 
-`vtid`::
-    Virtual thread ID: thread ID as seen from the point of view of
-    the current man:pid_namespaces(7).
+`net_ns`:::
+    Inode number of the current network namespace (see
+    man:network_namespaces(7)) in the proc file system.
 
-The following man:namespaces(7) context fields are supported by LTTng-UST:
+`pid_ns`:::
+    Inode number of the current process ID namespace (see
+    man:pid_namespaces(7)) in the proc file system.
 
-`cgroup_ns`::
-    Cgroup root directory namespace: inode number of the current
-    man:cgroup_namespaces(7) in the proc filesystem.
+`time_ns`:::
+    Inode number of the current clock namespace (see
+    man:time_namespaces(7)) in the proc file system.
 
-`ipc_ns`::
-    System V IPC, POSIX message queues namespace: inode number of the
-    current IPC namespace in the proc filesystem.
+`user_ns`:::
+    Inode number of the current user namespace (see
+    man:user_namespaces(7)) in the proc file system.
 
-`mnt_ns`::
-    Mount points namespace: inode number of the current Mount namespace
-    in the proc filesystem.
+`uts_ns`:::
+    Inode number of the current UTS namespace (see
+    man:uts_namespaces(7)) in the proc file system.
 
-`net_ns`::
-    Network devices, stacks, ports namespace: inode number of the
-    current Network namespace in the proc filesystem.
+Credential context fields (see man:credentials(7))::
++
+`vuid`:::
+    Virtual real user ID: real user ID as seen from the point of view of
+    the current user namespace (see man:user_namespaces(7)).
+
+`vgid`:::
+    Virtual real group ID: real group ID as seen from the point of view
+    of the current user namespace (see man:user_namespaces(7)).
 
-`pid_ns`::
-    Process IDs namespace: inode number of the current
-    man:pid_namespaces(7) in the proc filesystem.
+`veuid`:::
+    Virtual effective user ID: effective user ID as seen from the point
+    of view of the current user namespace (see man:user_namespaces(7)).
 
-`user_ns`::
-    User and group IDs namespace: inode number of the current
-    man:user_namespaces(7) in the proc filesystem.
+`vegid`:::
+    Virtual effective group ID: effective group ID as seen from the
+    point of view of the current user namespace (see
+    man:user_namespaces(7)).
 
-`uts_ns`::
-    Hostname and NIS domain name namespace: inode number of the
-    current UTS namespace in the proc filesystem.
+`vsuid`:::
+    Virtual saved set-user ID: saved set-user ID as seen from the point
+    of view of the current user namespace (see man:user_namespaces(7)).
+
+`vsgid`:::
+    Virtual saved set-group ID: saved set-group ID as seen from the
+    point of view of the current user namespace (see
+    man:user_namespaces(7)).
 
 
 [[state-dump]]
@@ -926,6 +966,20 @@ Fields:
 |Debug link file name.
 |===
 
+`lttng_ust_statedump:procname`::
+    The process procname at process start.
++
+Fields:
++
+[options="header"]
+|===
+|Field name |Description
+
+|`procname`
+|The process name.
+
+|===
+
 
 [[ust-lib]]
 Shared library load/unload tracking
@@ -1369,6 +1423,10 @@ Default: {lttng_ust_register_timeout}.
     If set, prevents `liblttng-ust` from performing a base address state
     dump (see the <<state-dump,LTTng-UST state dump>> section above).
 
+`LTTNG_UST_WITHOUT_PROCNAME_STATEDUMP`::
+    If set, prevents `liblttng-ust` from performing a procname state
+    dump (see the <<state-dump,LTTng-UST state dump>> section above).
+
 
 include::common-footer.txt[]
 
This page took 0.026476 seconds and 4 git commands to generate.