Add procname to lttng_ust_statedump information

[lttng-ust.git] / doc / man / lttng-ust.3.txt

diff --git a/doc/man/lttng-ust.3.txt b/doc/man/lttng-ust.3.txt
index 2a3003a72382a1efb6dcb8e75079db165957fa49..507aaca5e0ac070328eff4cdee587f1181240015 100644 (file)
--- a/doc/man/lttng-ust.3.txt
+++ b/doc/man/lttng-ust.3.txt
@@ -790,11 +790,67 @@ Only available on IA-32 and x86-64 architectures.
 
 `vpid`::
     Virtual process ID: process ID as seen from the point of view of
-    the process namespace.
+    the current man:pid_namespaces(7).
 
 `vtid`::
     Virtual thread ID: thread ID as seen from the point of view of
-    the process namespace.
+    the current man:pid_namespaces(7).
+
+The following man:namespaces(7) context fields are supported by LTTng-UST:
+
+`cgroup_ns`::
+    Cgroup root directory namespace: inode number of the current
+    man:cgroup_namespaces(7) in the proc filesystem.
+
+`ipc_ns`::
+    System V IPC, POSIX message queues namespace: inode number of the
+    current man:ipc_namespaces(7) namespace in the proc filesystem.
+
+`mnt_ns`::
+    Mount points namespace: inode number of the current
+    man:mount_namespaces(7) in the proc filesystem.
+
+`net_ns`::
+    Network devices, stacks, ports namespace: inode number of the
+    current man:network_namespaces(7) in the proc filesystem.
+
+`pid_ns`::
+    Process IDs namespace: inode number of the current
+    man:pid_namespaces(7) in the proc filesystem.
+
+`user_ns`::
+    User and group IDs namespace: inode number of the current
+    man:user_namespaces(7) in the proc filesystem.
+
+`uts_ns`::
+    Hostname and NIS domain name namespace: inode number of the
+    current man:uts_namespaces(7) in the proc filesystem.
+
+The following man:credentials(7) context fields are supported by LTTng-UST:
+
+`vuid`::
+    Virtual real user ID: real user ID as seen from the point of view of
+    the current man:user_namespaces(7).
+
+`vgid`::
+    Virtual real group ID: real group ID as seen from the point of view of
+    the current man:user_namespaces(7).
+
+`veuid`::
+    Virtual effective user ID: effective user ID as seen from the point of
+    view of the current man:user_namespaces(7).
+
+`vegid`::
+    Virtual effective group ID: effective group ID as seen from the point of
+    view of the current man:user_namespaces(7).
+
+`vsuid`::
+    Virtual saved set-user ID: saved set-user ID as seen from the point of
+    view of the current man:user_namespaces(7).
+
+`vsgid`::
+    Virtual saved set-group ID: saved set-group ID as seen from the point of
+    view of the current man:user_namespaces(7).
 
 
 [[state-dump]]
@@ -896,6 +952,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
@@ -1339,6 +1409,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[]