summaryrefslogtreecommitdiffstats
path: root/Documentation/kprobes.txt
diff options
context:
space:
mode:
authorDavid A. Long <dave.long@linaro.org>2016-08-12 16:24:44 -0400
committerJonathan Corbet <corbet@lwn.net>2016-08-15 10:19:11 -0600
commit7a9011db32b5a24f29e725220d0ba9e970412f47 (patch)
tree6832292ac95a062d3d3bd5c8c04c5c55f36ee3e0 /Documentation/kprobes.txt
parenta78a136fa9337fdc25fdbaa2d253f9b4dc90ad44 (diff)
downloadlinux-stable-7a9011db32b5a24f29e725220d0ba9e970412f47.tar.gz
linux-stable-7a9011db32b5a24f29e725220d0ba9e970412f47.tar.bz2
linux-stable-7a9011db32b5a24f29e725220d0ba9e970412f47.zip
Documentation: kprobes: Document jprobes stack copying limitations
Some architectures (i.e.: sparc64 and arm64) make reasonable partial stack duplication for jprobes problematic. Document this. Signed-off-by: David A. Long <dave.long@linaro.org> Acked-by: Catalin Marinas <catalin.marinas@arm.com> Acked-by: Masami Hiramatsu <mhiramat@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/kprobes.txt')
-rw-r--r--Documentation/kprobes.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/kprobes.txt b/Documentation/kprobes.txt
index 1f9b3e2b98ae..1f6d45abfe42 100644
--- a/Documentation/kprobes.txt
+++ b/Documentation/kprobes.txt
@@ -103,6 +103,16 @@ Note that the probed function's args may be passed on the stack
or in registers. The jprobe will work in either case, so long as the
handler's prototype matches that of the probed function.
+Note that in some architectures (e.g.: arm64 and sparc64) the stack
+copy is not done, as the actual location of stacked parameters may be
+outside of a reasonable MAX_STACK_SIZE value and because that location
+cannot be determined by the jprobes code. In this case the jprobes
+user must be careful to make certain the calling signature of the
+function does not cause parameters to be passed on the stack (e.g.:
+more than eight function arguments, an argument of more than sixteen
+bytes, or more than 64 bytes of argument data, depending on
+architecture).
+
1.3 Return Probes
1.3.1 How Does a Return Probe Work?