[DTrace-devel] [PATCH 04/14] Test: caller and stackdepth tests for fbt provider
eugene.loh at oracle.com
eugene.loh at oracle.com
Thu May 22 18:01:08 UTC 2025
From: Eugene Loh <eugene.loh at oracle.com>
We will introduce a set of tests for the caller and stackdepth
built-in variables for a wide selection of providers.
For the caller test, we will essentially call
stack(2);
sym(caller);
and then compare the caller to the second stack frame using
the new script check_caller_to_stack2.awk.
For the stackdepth test, we will essentially call
printf("%d\n", stackdepth);
stack();
and then compare the stackdepth to the reported frames using
the new script check_stackdepth_to_stack.awk.
In this patch, introduce tests for the fbt provider, along with
the support scripts they need. Subsequent patches will handle
other providers.
The old tst.caller2.d and tst.stackdepth2.d, which tested fbt,
become obsolete. Remove them.
Signed-off-by: Eugene Loh <eugene.loh at oracle.com>
---
.../variables/bvar/check_caller_to_stack2.awk | 32 +++++++++++++++++
...pth2.r.p => check_stackdepth_to_stack.awk} | 16 ++++++---
test/unittest/variables/bvar/tst.caller-fbt.d | 25 +++++++++++++
test/unittest/variables/bvar/tst.caller-fbt.r | 1 +
.../variables/bvar/tst.caller-fbt.r.p | 1 +
test/unittest/variables/bvar/tst.caller2.d | 31 ----------------
test/unittest/variables/bvar/tst.caller2.r | 1 -
test/unittest/variables/bvar/tst.caller2.r.p | 11 ------
.../variables/bvar/tst.stackdepth-fbt.d | 27 ++++++++++++++
...tst.stackdepth2.r => tst.stackdepth-fbt.r} | 0
.../variables/bvar/tst.stackdepth-fbt.r.p | 1 +
.../unittest/variables/bvar/tst.stackdepth2.d | 36 -------------------
12 files changed, 99 insertions(+), 83 deletions(-)
create mode 100755 test/unittest/variables/bvar/check_caller_to_stack2.awk
rename test/unittest/variables/bvar/{tst.stackdepth2.r.p => check_stackdepth_to_stack.awk} (63%)
create mode 100644 test/unittest/variables/bvar/tst.caller-fbt.d
create mode 100644 test/unittest/variables/bvar/tst.caller-fbt.r
create mode 120000 test/unittest/variables/bvar/tst.caller-fbt.r.p
delete mode 100644 test/unittest/variables/bvar/tst.caller2.d
delete mode 100644 test/unittest/variables/bvar/tst.caller2.r
delete mode 100755 test/unittest/variables/bvar/tst.caller2.r.p
create mode 100644 test/unittest/variables/bvar/tst.stackdepth-fbt.d
rename test/unittest/variables/bvar/{tst.stackdepth2.r => tst.stackdepth-fbt.r} (100%)
create mode 120000 test/unittest/variables/bvar/tst.stackdepth-fbt.r.p
delete mode 100644 test/unittest/variables/bvar/tst.stackdepth2.d
diff --git a/test/unittest/variables/bvar/check_caller_to_stack2.awk b/test/unittest/variables/bvar/check_caller_to_stack2.awk
new file mode 100755
index 000000000..8499852a7
--- /dev/null
+++ b/test/unittest/variables/bvar/check_caller_to_stack2.awk
@@ -0,0 +1,32 @@
+#!/usr/bin/gawk -f
+
+# Check output of tst.caller-$provider.d tests of the form
+#
+# {
+# stack(2);
+# sym(caller);
+# }
+#
+# Confirm that the caller information matches the stack information.
+
+# Look for the first nonblank line.
+NF != 0 {
+ # It is the current frame. Skip it.
+ if (getline != 1) { print "ERROR: missing expected output"; exit(1); }
+
+ # Now we have the caller frame. Strip off the offset.
+ expect=$1
+ sub("+0x[0-9a-f]*$", "", expect);
+
+ # Finally, get the sym(caller) output.
+ if (getline != 1) { print "ERROR: missing expected output"; exit(1); }
+
+ # Compare.
+ if (expect == $1) {
+ print "success";
+ exit(0);
+ } else {
+ print "ERROR: expect", expect, "but got", $1;
+ exit(1);
+ }
+}
diff --git a/test/unittest/variables/bvar/tst.stackdepth2.r.p b/test/unittest/variables/bvar/check_stackdepth_to_stack.awk
similarity index 63%
rename from test/unittest/variables/bvar/tst.stackdepth2.r.p
rename to test/unittest/variables/bvar/check_stackdepth_to_stack.awk
index 9b071181f..fba1f4242 100755
--- a/test/unittest/variables/bvar/tst.stackdepth2.r.p
+++ b/test/unittest/variables/bvar/check_stackdepth_to_stack.awk
@@ -1,8 +1,16 @@
#!/usr/bin/gawk -f
-# Oracle Linux DTrace.
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
-# Licensed under the Universal Permissive License v 1.0 as shown at
-# http://oss.oracle.com/licenses/upl.
+#
+# Check output of tst.stackdepth-$provider.d tests of the form
+#
+# {
+# printf("DEPTH %d\n", stackdepth);
+# printf("TRACE BEGIN\n");
+# stack();
+# printf("TRACE END\n");
+# exit(0);
+# }
+#
+# Confirm that the stackdepth information matches the stack information.
/^DEPTH/ {
depth = int($2);
diff --git a/test/unittest/variables/bvar/tst.caller-fbt.d b/test/unittest/variables/bvar/tst.caller-fbt.d
new file mode 100644
index 000000000..695104134
--- /dev/null
+++ b/test/unittest/variables/bvar/tst.caller-fbt.d
@@ -0,0 +1,25 @@
+/*
+ * Oracle Linux DTrace.
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * http://oss.oracle.com/licenses/upl.
+ */
+/*
+ * @@trigger: periodic_output
+ */
+
+#pragma D option quiet
+
+fbt::ksys_write:entry
+/pid == $target/
+{
+ stack(2);
+ sym(caller);
+ exit(0);
+}
+
+ERROR
+{
+ printf("error encountered\n");
+ exit(1);
+}
diff --git a/test/unittest/variables/bvar/tst.caller-fbt.r b/test/unittest/variables/bvar/tst.caller-fbt.r
new file mode 100644
index 000000000..2e9ba477f
--- /dev/null
+++ b/test/unittest/variables/bvar/tst.caller-fbt.r
@@ -0,0 +1 @@
+success
diff --git a/test/unittest/variables/bvar/tst.caller-fbt.r.p b/test/unittest/variables/bvar/tst.caller-fbt.r.p
new file mode 120000
index 000000000..954ca96aa
--- /dev/null
+++ b/test/unittest/variables/bvar/tst.caller-fbt.r.p
@@ -0,0 +1 @@
+check_caller_to_stack2.awk
\ No newline at end of file
diff --git a/test/unittest/variables/bvar/tst.caller2.d b/test/unittest/variables/bvar/tst.caller2.d
deleted file mode 100644
index ca6dbfd22..000000000
--- a/test/unittest/variables/bvar/tst.caller2.d
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * Oracle Linux DTrace.
- * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
- * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
- */
-
-/*
- * ASSERTION: The 'caller' should be consistent with stack().
- *
- * SECTION: Variables/Built-in Variables/caller
- */
-
-#pragma D option quiet
-#pragma D option destructive
-
-BEGIN
-{
- system("echo write something > /dev/null");
-}
-
-fbt::ksys_write:entry
-{
- stack(2);
- sym(caller);
- exit(0);
-}
-
-ERROR {
- exit(1);
-}
diff --git a/test/unittest/variables/bvar/tst.caller2.r b/test/unittest/variables/bvar/tst.caller2.r
deleted file mode 100644
index 0cfbf0888..000000000
--- a/test/unittest/variables/bvar/tst.caller2.r
+++ /dev/null
@@ -1 +0,0 @@
-2
diff --git a/test/unittest/variables/bvar/tst.caller2.r.p b/test/unittest/variables/bvar/tst.caller2.r.p
deleted file mode 100755
index 1a26a4df2..000000000
--- a/test/unittest/variables/bvar/tst.caller2.r.p
+++ /dev/null
@@ -1,11 +0,0 @@
-#!/bin/bash
-
-# sed: remove +0x{ptr} offsets
-# awk: look for the ksys_write frame, then write the next two lines
-# uniq: count unique lines
-# awk: report the counts
-
-sed 's/+0x.*$//' \
-| /usr/bin/gawk '/ksys_write/ {getline; print $1; getline; print $1; exit(0)}' \
-| uniq -c \
-| /usr/bin/gawk '{print $1}'
diff --git a/test/unittest/variables/bvar/tst.stackdepth-fbt.d b/test/unittest/variables/bvar/tst.stackdepth-fbt.d
new file mode 100644
index 000000000..10b05399e
--- /dev/null
+++ b/test/unittest/variables/bvar/tst.stackdepth-fbt.d
@@ -0,0 +1,27 @@
+/*
+ * Oracle Linux DTrace.
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * Licensed under the Universal Permissive License v 1.0 as shown at
+ * http://oss.oracle.com/licenses/upl.
+ */
+/*
+ * @@trigger: periodic_output
+ */
+
+#pragma D option quiet
+
+fbt::ksys_write:entry
+/pid == $target/
+{
+ printf("DEPTH %d\n", stackdepth);
+ printf("TRACE BEGIN\n");
+ stack(100);
+ printf("TRACE END\n");
+ exit(0);
+}
+
+ERROR
+{
+ printf("error encountered\n");
+ exit(1);
+}
diff --git a/test/unittest/variables/bvar/tst.stackdepth2.r b/test/unittest/variables/bvar/tst.stackdepth-fbt.r
similarity index 100%
rename from test/unittest/variables/bvar/tst.stackdepth2.r
rename to test/unittest/variables/bvar/tst.stackdepth-fbt.r
diff --git a/test/unittest/variables/bvar/tst.stackdepth-fbt.r.p b/test/unittest/variables/bvar/tst.stackdepth-fbt.r.p
new file mode 120000
index 000000000..e50f12822
--- /dev/null
+++ b/test/unittest/variables/bvar/tst.stackdepth-fbt.r.p
@@ -0,0 +1 @@
+check_stackdepth_to_stack.awk
\ No newline at end of file
diff --git a/test/unittest/variables/bvar/tst.stackdepth2.d b/test/unittest/variables/bvar/tst.stackdepth2.d
deleted file mode 100644
index 2b1c0866a..000000000
--- a/test/unittest/variables/bvar/tst.stackdepth2.d
+++ /dev/null
@@ -1,36 +0,0 @@
-/*
- * Oracle Linux DTrace.
- * Copyright (c) 2006, 2021, Oracle and/or its affiliates. All rights reserved.
- * Licensed under the Universal Permissive License v 1.0 as shown at
- * http://oss.oracle.com/licenses/upl.
- */
-
-#pragma D option destructive
-#pragma D option quiet
-
-/*
- * ASSERTION:
- * Test the stackdepth variable. Verify its value against the stack trace.
- *
- * SECTION: Variables/Built-in Variables
- *
- */
-
-BEGIN
-{
- system("echo write something > /dev/null");
-}
-
-fbt::ksys_write:entry
-{
- printf("DEPTH %d\n", stackdepth);
- printf("TRACE BEGIN\n");
- stack();
- printf("TRACE END\n");
- exit(0);
-}
-
-ERROR
-{
- exit(1);
-}
--
2.43.5
More information about the DTrace-devel
mailing list