This is the mail archive of the
systemtap@sourceware.org
mailing list for the systemtap project.
[PATCH 07/10] Correct and consistent .meta files for example
- From: "Oestman, Fredrik" <Fredrik_Oestman at mentor dot com>
- To: "systemtap at sourceware dot org" <systemtap at sourceware dot org>
- Cc: "Oestman, Fredrik" <Fredrik_Oestman at mentor dot com>
- Date: Fri, 23 Dec 2011 08:30:30 +0000
- Subject: [PATCH 07/10] Correct and consistent .meta files for example
Signed-off-by: Fredrik Östman <fredrik_oestman@mentor.com>
---
testsuite/systemtap.examples/process/chng_cpu.meta | 2 +-
.../systemtap.examples/process/cycle_thief.meta | 4 ++--
testsuite/systemtap.examples/process/errsnoop.meta | 12 +++++++++---
testsuite/systemtap.examples/process/migrate.meta | 2 +-
testsuite/systemtap.examples/process/noptrace.meta | 12 +++++++++---
testsuite/systemtap.examples/process/pf2.meta | 6 +++---
testsuite/systemtap.examples/process/pfiles.meta | 11 +++++++++--
testsuite/systemtap.examples/process/plimit.meta | 10 ++++++++--
.../systemtap.examples/process/schedtimes.meta | 2 +-
testsuite/systemtap.examples/process/sigkill.meta | 2 +-
testsuite/systemtap.examples/process/sigmon.meta | 4 ++--
.../process/sleepingBeauties.meta | 8 +++++++-
.../systemtap.examples/process/sleeptime.meta | 4 ++--
.../systemtap.examples/process/syscalltimes.meta | 2 +-
14 files changed, 56 insertions(+), 25 deletions(-)
diff --git a/testsuite/systemtap.examples/process/chng_cpu.meta b/testsuite/systemtap.examples/process/chng_cpu.meta
index 7be73b7..5c8efe1 100644
--- a/testsuite/systemtap.examples/process/chng_cpu.meta
+++ b/testsuite/systemtap.examples/process/chng_cpu.meta
@@ -7,7 +7,7 @@ subsystem: scheduler
status: production
exit: user-controlled
output: trace
-scope: pid
+scope: process
description: The chng_cpu.stp script takes an argument which is the executable name of the task it should monitor. Each time a task with that executable name is found running on a different processor, the script prints out the thread id (tid), the executable name, the processor now running the task, the thread state, and a backtrace showing the kernel functions that triggered the running of the task on the processor.
arg_1: The name of the executable to monitor
test_check: stap -p4 chng_cpu.stp bash
diff --git a/testsuite/systemtap.examples/process/cycle_thief.meta b/testsuite/systemtap.examples/process/cycle_thief.meta
index 8bf05b5..628ab0e 100644
--- a/testsuite/systemtap.examples/process/cycle_thief.meta
+++ b/testsuite/systemtap.examples/process/cycle_thief.meta
@@ -1,4 +1,4 @@
-title: Track IRQs and Other Processes Stealing Cycles from a Task
+title: Track IRQ's and Other Processes Stealing Cycles from a Task
name: cycle_thief.stp
version: 1.0
author: William Cohen
@@ -7,7 +7,7 @@ subsystem: scheduler
status: experimental
exit: user-controlled
output: sorted-list
-scope: system-wide
+scope: process
description: The cycle_thief.stp script instruments the scheduler and IRQ handler to determine which processes and interrupts are competing with the specified task for the cpu cycles. This script uses the '-c' or '-x' options to focus on a specific task. The script output the number of times the task migrates between processors, histograms showing the length of time on and off processor, lists of processes running while the task is off the processor, and the interrupts that occurred while the task was running.
test_support: stap -l 'kernel.trace("sched_switch")' && stap -l 'kernel.trace("irq_handler_entry")!, kernel.trace("irq_entry")' && stap -l 'kernel.trace("irq_handler_exit")!, kernel.trace("irq_exit")'
test_check: stap -p4 cycle_thief.stp
diff --git a/testsuite/systemtap.examples/process/errsnoop.meta b/testsuite/systemtap.examples/process/errsnoop.meta
index 8afcdd9..7a1bc2a 100644
--- a/testsuite/systemtap.examples/process/errsnoop.meta
+++ b/testsuite/systemtap.examples/process/errsnoop.meta
@@ -1,7 +1,13 @@
-title: tabulate system call errors
+title: Tabulate System Call Errors
name: errsnoop.stp
+version: 1.0
+author: anonymous
keywords: process syscall
-subsystem: general
-description: The script prints a periodic tabular report about failing system calls, by process and by syscall failure. The first optional argument specifies the reporting interval (in seconds, default 5); the second optional argument gives a screen height (number of lines in the report, default 20).
+subsystem: syscall
+status: proposed
+exit: user-controlled
+output: timed
+scope: system-wide
+description: Prints a periodic tabular report about failing system calls, by process and by syscall failure. The first optional argument specifies the reporting interval (in seconds, default 5); the second optional argument gives a screen height (number of lines in the report, default 20).
test_check: stap -p4 errsnoop.stp
test_installcheck: stap errsnoop.stp 1 10 -c "sleep 1"
diff --git a/testsuite/systemtap.examples/process/migrate.meta b/testsuite/systemtap.examples/process/migrate.meta
index 24e8bdc..3c14ef5 100644
--- a/testsuite/systemtap.examples/process/migrate.meta
+++ b/testsuite/systemtap.examples/process/migrate.meta
@@ -7,7 +7,7 @@ subsystem: scheduler
status: production
exit: user-controlled
output: trace
-scope: pid
+scope: process
description: The migrate.stp script takes an argument which is the executable name of the task it should monitor. Each time a task with that executable name migrates between processors an entry is printed with the process id (pid), the executable name, the processor off loading the task, and the process taking the task. Note that the task may or may not be executing at the time of the migration.
arg_1: The name of the executable to watch
test_check: stap -p4 migrate.stp bash
diff --git a/testsuite/systemtap.examples/process/noptrace.meta b/testsuite/systemtap.examples/process/noptrace.meta
index a8068a7..98b3a1b 100644
--- a/testsuite/systemtap.examples/process/noptrace.meta
+++ b/testsuite/systemtap.examples/process/noptrace.meta
@@ -1,8 +1,14 @@
-title: disable ptrace(2) from hierarchies of processes
+title: Disable ptrace from Hierarchies of Processes
name: noptrace.stp
+version: 1.0
+author: anonymous
keywords: process security
-description: noptrace.stp blocks ptrace(2) attempts from processes identified by stap -c/-x, as also specifiable from /proc/systemtap/stap_XXX/ control files. Processes may be added or removed from the blocked list.
+subsystem: process
+status: proposed
+exit: user-controlled
+output: on-exit
+scope: system-wide
+description: Blocks ptrace(2) attempts from processes identified by stap -c/-x, as also specifiable from /proc/systemtap/stap_XXX/ control files. Processes may be added or removed from the blocked list.
test_support: test -e /etc/redhat-release && grep -v "Nahant" /etc/redhat-release
test_check: stap -gp4 noptrace.stp -x $$
test_installcheck: stap -g noptrace.stp -c 'strace ls || true'
-
diff --git a/testsuite/systemtap.examples/process/pf2.meta b/testsuite/systemtap.examples/process/pf2.meta
index 8fa14d0..291d310 100644
--- a/testsuite/systemtap.examples/process/pf2.meta
+++ b/testsuite/systemtap.examples/process/pf2.meta
@@ -1,12 +1,12 @@
-title: Profile kernel functions
+title: Profile Kernel Functions
name: pf2.stp
version: 1.0
author: anonymous
keywords: profiling
-subsystem: kernel
+subsystem: any
status: production
exit: user-controlled
-output: sorted-list
+output: sorted-list timed
scope: system-wide
description: The pf2.stp script sets up time-based sampling. Every five seconds it prints out a sorted list with the top ten kernel functions with samples.
test_check: stap -p4 pf2.stp
diff --git a/testsuite/systemtap.examples/process/pfiles.meta b/testsuite/systemtap.examples/process/pfiles.meta
index f5b623c..b8cea4d 100644
--- a/testsuite/systemtap.examples/process/pfiles.meta
+++ b/testsuite/systemtap.examples/process/pfiles.meta
@@ -1,6 +1,13 @@
-title: print process file descriptors
+title: Print Process File Descriptors
name: pfiles.stp
-keywords: process files
+version: 1.0
+author: anonymous
+keywords: process file
+subsystem: file
+status: proposed
+exit: user-controlled
+output: on-exit
+scope: process
description: Run pfiles.stp to produce a human-readable summary of all open file descriptors of a given process. Specify the process-id as -x PID for fastest performance.
test_check: stap -gp4 pfiles.stp -x $$
test_installcheck: stap -g pfiles.stp -x $$
diff --git a/testsuite/systemtap.examples/process/plimit.meta b/testsuite/systemtap.examples/process/plimit.meta
index d5cd4e8..720475a 100644
--- a/testsuite/systemtap.examples/process/plimit.meta
+++ b/testsuite/systemtap.examples/process/plimit.meta
@@ -1,7 +1,13 @@
-title: print resource limits
+title: Print Resource Limits of Process
name: plimit.stp
+version: 1.0
+author: anonymous
keywords: process
-subsystem: general
+subsystem: any
+status: proposed
+exit: event-ended
+output: batch on-exit
+scope: process
description: The script prints a variety of resource limits for a given pid, like /proc/$$/limits on recent kernels.
test_check: stap -gp4 plimit.stp $$
test_installcheck: stap -g plimit.stp $$
diff --git a/testsuite/systemtap.examples/process/schedtimes.meta b/testsuite/systemtap.examples/process/schedtimes.meta
index a8636b6..8a05d72 100644
--- a/testsuite/systemtap.examples/process/schedtimes.meta
+++ b/testsuite/systemtap.examples/process/schedtimes.meta
@@ -1,4 +1,4 @@
-title: Track Time Processes Spend in Various States using Tracepoints
+title: Track Time Processes Spend in Various States Using Tracepoints
name: schedtimes.stp
version: 1.0
author: Jason Baron
diff --git a/testsuite/systemtap.examples/process/sigkill.meta b/testsuite/systemtap.examples/process/sigkill.meta
index fed49a0..d3deb5d 100644
--- a/testsuite/systemtap.examples/process/sigkill.meta
+++ b/testsuite/systemtap.examples/process/sigkill.meta
@@ -7,7 +7,7 @@ subsystem: signals
status: production
exit: user-controlled
output: trace
-scope: systemwide
+scope: system-wide
description: The script traces any SIGKILL signals. When that SIGKILL signal is sent to a process, the script prints out the signal name, the destination executable and process ID, the executable name and user ID that sents the signal.
arg_1: The name of the signal to look for on selected process.
test_check: stap -p4 sigkill.stp
diff --git a/testsuite/systemtap.examples/process/sigmon.meta b/testsuite/systemtap.examples/process/sigmon.meta
index 03c54f9..029c5e4 100644
--- a/testsuite/systemtap.examples/process/sigmon.meta
+++ b/testsuite/systemtap.examples/process/sigmon.meta
@@ -1,4 +1,4 @@
-title: Track a particular signal to a specific process
+title: Track a Particular Signal to a Specific Process
name: sigmon.stp
version: 1.0
author: IBM
@@ -7,7 +7,7 @@ subsystem: signals
status: experimental
exit: user-controlled
output: trace
-scope: pid
+scope: process
description: The script watches for a particular signal sent to a specific process. When that signal is sent to the specified process, the script prints out the PID and executable of the process sending the signal, the PID and executable name of the process receiving the signal, and the signal number and name.
arg_1: The name of the signal to look for on selected process.
test_check: stap -p4 sigmon.stp SIGKILL
diff --git a/testsuite/systemtap.examples/process/sleepingBeauties.meta b/testsuite/systemtap.examples/process/sleepingBeauties.meta
index 693a778..2b0944a 100644
--- a/testsuite/systemtap.examples/process/sleepingBeauties.meta
+++ b/testsuite/systemtap.examples/process/sleepingBeauties.meta
@@ -1,7 +1,13 @@
-title: Generating Backtraces of Threads Waiting for IO Operations
+title: Generate Backtraces of Threads Waiting for IO Operations
name: sleepingBeauties.stp
+version: 1.0
+author: anonymous
keywords: io scheduler backtrace
subsystem: scheduler
+status: proposed
+exit: user-controlled
+output: trace
+scope: system-wide
description: The script monitors the time that threads spend in waiting for IO operations (in "D" state) in the wait_for_completion function. If a thread spends over 10ms, its name and backtrace is printed, and later so is the total delay.
test_check: stap -p4 sleepingBeauties.stp
test_installcheck: stap sleepingBeauties.stp -c "sleep 0.2"
diff --git a/testsuite/systemtap.examples/process/sleeptime.meta b/testsuite/systemtap.examples/process/sleeptime.meta
index e5aa4f3..d069ba6 100644
--- a/testsuite/systemtap.examples/process/sleeptime.meta
+++ b/testsuite/systemtap.examples/process/sleeptime.meta
@@ -1,8 +1,8 @@
-title: Trace Time Spent in nanosleep Syscalls
+title: Trace Time Spent in Nanosleep Syscalls
name: sleeptime.stp
version: 1.0
author: Daniel Berrange and Will Cohen
-keywords: syscall sleep
+keywords: syscall nanosleep
subsystem: syscall
status: production
exit: user-controlled
diff --git a/testsuite/systemtap.examples/process/syscalltimes.meta b/testsuite/systemtap.examples/process/syscalltimes.meta
index b7a1381..4080829 100644
--- a/testsuite/systemtap.examples/process/syscalltimes.meta
+++ b/testsuite/systemtap.examples/process/syscalltimes.meta
@@ -1,4 +1,4 @@
-title: System wide syscall statistics with filtering on exec, uid or pid.
+title: System-Wide Syscall Statistics with Filtering
name: syscalltimes
version: 1.0
author: IBM Corp.
--
1.7.6.4