This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH v3] manual/probes.texi: Add documentation of setjmp/longjmp probes
- From: Will Newton <will dot newton at linaro dot org>
- To: libc-alpha at sourceware dot org
- Cc: patches at linaro dot org
- Date: Wed, 5 Feb 2014 09:55:45 +0000
- Subject: [PATCH v3] manual/probes.texi: Add documentation of setjmp/longjmp probes
- Authentication-results: sourceware.org; auth=none
Add some documentation of the setjmp, longjmp and longjmp_target
Systemtap probe points.
ChangeLog:
2014-01-28 Will Newton <will.newton@linaro.org>
* manual/probes.texi (Internal Probes): Add documentation
of setjmp, longjmp and longjmp_target probes.
---
manual/probes.texi | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
Changes in v3:
- Use @code annotation more consistently
- Drop duplicated paragraph from longjmp_target description
diff --git a/manual/probes.texi b/manual/probes.texi
index 25d06e5..3bf5421 100644
--- a/manual/probes.texi
+++ b/manual/probes.texi
@@ -17,6 +17,7 @@ arguments.
@menu
* Memory Allocation Probes:: Probes in the memory allocation subsystem
* Mathematical Function Probes:: Probes in mathematical functions
+* setjmp and longjmp Probes:: Probes in setjmp and longjmp
@end menu
@node Memory Allocation Probes
@@ -368,3 +369,40 @@ results in multiple precision computation with precision 32. Argument
@var{$arg1} is the input to the function, @var{$arg2} is the error bound of
@var{$arg1} and @var{$arg3} is the computed result.
@end deftp
+
+@node setjmp and longjmp Probes
+@section setjmp and longjmp Probes
+
+These probes are used to signal calls to @code{setjmp}, @code{sigsetjmp},
+@code{longjmp} or @code{siglongjmp}.
+
+@deftp Probe setjmp (void *@var{$arg1}, int @var{$arg2}, void *@var{$arg3})
+This probe is hit whenever @code{setjmp} or @code{sigsetjmp} is called.
+Argument @var{$arg1} is a pointer to the @code{jmp_buf} passed as the first
+argument of @code{setjmp} or @code{sigsetjmp}, @var{$arg2} is the second
+argument of @code{sigsetjmp} or zero if this is a call to @code{setjmp}
+and @var{$arg3} is a pointer to the return address that will be stored
+in the @code{jmp_buf}.
+@end deftp
+
+@deftp Probe longjmp (void *@var{$arg1}, int @var{$arg2}, void *@var{$arg3})
+This probe is hit whenever @code{longjmp} or @code{siglongjmp} is called.
+Argument @var{$arg1} is a pointer to the @code{jmp_buf} passed as the first
+argument of @code{longjmp} or @code{siglongjmp}, @var{$arg2} is the return
+value passed as the second argument of @code{longjmp} or @code{siglongjmp}
+and @var{$arg3} is a pointer to the return address @code{longjmp} or
+@code{siglongjmp} will return to.
+
+The @code{longjmp} probe is hit at a point where the registers have not yet
+been restored to the values in the @code{jmp_buf} and unwinding will show a
+call stack including the caller of @code{longjmp} or @code{siglongjmp}.
+@end deftp
+
+@deftp Probe longjmp_target (void *@var{$arg1}, int @var{$arg2}, void *@var{$arg3})
+This probe is hit under the same conditions and with the same arguments
+as the @code{longjmp} probe.
+
+The @code{longjmp_target} probe is hit at a point where the registers have
+been restored to the values in the @code{jmp_buf} and unwinding will show a
+call stack including the caller of @code{setjmp} or @code{sigsetjmp}.
+@end deftp
--
1.8.1.4