From: Michael Jeanson <mjeanson@efficios.com>
Date: Wed, 8 May 2024 18:47:09 +0000 (-0400)
Subject: cleanup: document 'pipe' syscall override
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=2335796b2c5fbc3c432d9952cb447d87c34fbeb4;p=lttng-modules.git

cleanup: document 'pipe' syscall override

Change-Id: Iec84c10b774c1001ff2035024a1d05fdd31c8d9d
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/include/instrumentation/syscalls/arm-32-syscalls_pointers_override.h b/include/instrumentation/syscalls/arm-32-syscalls_pointers_override.h
index 96fb731f..6c08b794 100644
--- a/include/instrumentation/syscalls/arm-32-syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/arm-32-syscalls_pointers_override.h
@@ -31,6 +31,10 @@
 #endif /* CONFIG_COMPAT_OLD_SIGACTION */
 #endif
 
+/*
+ * Override 'pipe' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_32_pipe
 SC_LTTNG_TRACEPOINT_EVENT(pipe,
 	TP_PROTO(sc_exit(long ret,) int * fildes),
diff --git a/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h b/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
index fde30d27..b0006833 100644
--- a/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/powerpc-32-syscalls_pointers_override.h
@@ -4,6 +4,10 @@
 
 #ifndef CREATE_SYSCALL_TABLE
 
+/*
+ * Override 'pipe' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_32_pipe
 SC_LTTNG_TRACEPOINT_EVENT(pipe,
 	TP_PROTO(sc_exit(long ret,) int * fildes),
diff --git a/include/instrumentation/syscalls/syscalls_pointers_override.h b/include/instrumentation/syscalls/syscalls_pointers_override.h
index 92467749..b3647ecd 100644
--- a/include/instrumentation/syscalls/syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/syscalls_pointers_override.h
@@ -193,6 +193,10 @@ SC_LTTNG_TRACEPOINT_EVENT(getcpu,
 	)
 )
 
+/*
+ * Override 'pipe2' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_32_pipe2
 #define OVERRIDE_64_pipe2
 SC_LTTNG_TRACEPOINT_EVENT(pipe2,
diff --git a/include/instrumentation/syscalls/x86-32-syscalls_pointers_override.h b/include/instrumentation/syscalls/x86-32-syscalls_pointers_override.h
index bd63ed09..63a900f6 100644
--- a/include/instrumentation/syscalls/x86-32-syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/x86-32-syscalls_pointers_override.h
@@ -29,6 +29,10 @@
 #endif /* CONFIG_COMPAT_OLD_SIGACTION */
 #endif
 
+/*
+ * Override 'pipe' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_32_pipe
 #define OVERRIDE_64_pipe
 SC_LTTNG_TRACEPOINT_EVENT(pipe,
diff --git a/include/instrumentation/syscalls/x86-64-syscalls_pointers_override.h b/include/instrumentation/syscalls/x86-64-syscalls_pointers_override.h
index bd889451..e88a97aa 100644
--- a/include/instrumentation/syscalls/x86-64-syscalls_pointers_override.h
+++ b/include/instrumentation/syscalls/x86-64-syscalls_pointers_override.h
@@ -155,6 +155,10 @@ SC_LTTNG_TRACEPOINT_EVENT_CODE(accept4,
 	TP_code_post()
 )
 
+/*
+ * Override 'pipe' to set the output field 'fildes' to an array of 2 integers
+ * instead of the default integer pointer.
+ */
 #define OVERRIDE_64_pipe
 SC_LTTNG_TRACEPOINT_EVENT(pipe,
 	TP_PROTO(sc_exit(long ret,) int * fildes),