summaryrefslogtreecommitdiffstats
path: root/tapset/context.stp
diff options
context:
space:
mode:
authorDave Brolley <brolley@redhat.com>2009-11-23 19:08:51 -0500
committerDave Brolley <brolley@redhat.com>2009-11-23 19:08:51 -0500
commit5d1c958ce2dcc0f28c1bd13b8e005c0c2ad1cdba (patch)
treee44ad8807e0b5b2e1bb85682f677d492f1195dbf /tapset/context.stp
parent562d60b004e3d7ae73c1c7508be529006bd6430f (diff)
parent90bba7158de040705a101ba1fdf6062866b4b4e9 (diff)
downloadsystemtap-steved-5d1c958ce2dcc0f28c1bd13b8e005c0c2ad1cdba.tar.gz
systemtap-steved-5d1c958ce2dcc0f28c1bd13b8e005c0c2ad1cdba.tar.xz
systemtap-steved-5d1c958ce2dcc0f28c1bd13b8e005c0c2ad1cdba.zip
Merge branch 'master' of ssh://sources.redhat.com/git/systemtap
Conflicts: configure
Diffstat (limited to 'tapset/context.stp')
-rw-r--r--tapset/context.stp33
1 files changed, 18 insertions, 15 deletions
diff --git a/tapset/context.stp b/tapset/context.stp
index 14128589..36701e6e 100644
--- a/tapset/context.stp
+++ b/tapset/context.stp
@@ -210,7 +210,12 @@ function user_mode:long () %{ /* pure */ /* unprivileged */
}
%}
-
+/**
+ * sfunction is_return - Whether the current probe context is a return probe.
+ *
+ * Description: Returns 1 if the current probe context is a return probe,
+ * returns 0 otherwise.
+ */
function is_return:long () %{ /* pure */
if (CONTEXT->pi)
THIS->__retvalue = 1;
@@ -225,24 +230,22 @@ function target:long () %{ /* pure */ /* unprivileged */
THIS->__retvalue = _stp_target;
%}
-///<formalpara id="module_name">
-/// <title>module_name:string()</title>
-/// <indexterm><primary>module_name</primary></indexterm>
-/// <para>
-/// <remark>FIXME: need description.</remark>
-/// </para>
-///</formalpara>
+/**
+ * sfunction module_name - The module name of the current script.
+ *
+ * Returns the name of the stap module. Either generated randomly
+ * (stap_[0-9a-f]+_[0-9a-f]+) or set by stap -m <module_name>.
+ */
function module_name:string () %{ /* pure */ /* unprivileged */
strlcpy(THIS->__retvalue, THIS_MODULE->name, MAXSTRINGLEN);
%}
-///<formalpara id="stp_pid">
-/// <title>stp_pid:long()</title>
-/// <indexterm><primary>stp_pid</primary></indexterm>
-/// <para>
-/// <remark>FIXME: need description.</remark>
-/// </para>
-///</formalpara>
+/**
+ * sfunction stp_pid - The process id of the stapio process.
+ *
+ * Returns the process id of the stapio process that launched
+ * this script.
+ */
function stp_pid:long () %{ /* pure */
THIS->__retvalue = _stp_pid;
%}