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 96fb731f7212a5e025a059f498e3f6d94315f7cd..6c08b79435165b96e77f21fe5999f118751660cf 100644 (file)
--- 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 fde30d270ff2cdbaf1307c331997077b0e830475..b0006833b2923b3a73da32bb30a1e6563b40a23d 100644 (file)
--- 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 924677491b12b343c096eeaa486c4c6228162f42..b3647ecd27c7378d3960512809318f779e2ef731 100644 (file)
--- 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 bd63ed09ceebda18410da8f6dcd076060f329589..63a900f619b2ac5b5b96eb0991c410462384f8b5 100644 (file)
--- 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 bd88945124285608df97c82dc4325c574169ce91..e88a97aa3addbf3fbe9abba8a930b0a014fcba4f 100644 (file)
--- 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),