* [PATCH 2/3] systemtap: marker tapset document
@ 2008-09-12 22:23 Masami Hiramatsu
0 siblings, 0 replies; only message in thread
From: Masami Hiramatsu @ 2008-09-12 22:23 UTC (permalink / raw)
To: systemtap-ml; +Cc: ltt-dev, Hideo AOKI, Takahiro Yasui
[-- Attachment #1: Type: text/plain, Size: 249 bytes --]
Hi,
Here is a patch which adds a document of marker tapset
(stapprobes.marker.5 online manual).
Thank you,
--
Masami Hiramatsu
Software Engineer
Hitachi Computer Products (America) Inc.
Software Solutions Division
e-mail: mhiramat@redhat.com
[-- Attachment #2: docs-add-marker.patch --]
[-- Type: text/plain, Size: 12768 bytes --]
---
Makefile.am | 2
Makefile.in | 9 -
configure | 3
configure.ac | 2
man/stapprobes.marker.5.in | 390 +++++++++++++++++++++++++++++++++++++++++++++
stapprobes.5.in | 1
6 files changed, 401 insertions(+), 6 deletions(-)
Index: systemtap/man/stapprobes.marker.5.in
===================================================================
--- /dev/null 1970-01-01 00:00:00.000000000 +0000
+++ systemtap/man/stapprobes.marker.5.in 2008-09-12 13:26:07.000000000 -0400
@@ -0,0 +1,390 @@
+.\" -*- nroff -*-
+.TH STAPPROBES.MARKER 5 @DATE@ ""
+.SH NAME
+stapprobes.marker \- systemtap Kernel Marker probe points
+
+.\" macros
+.de SAMPLE
+.br
+.RS
+.nf
+.nh
+..
+.de ESAMPLE
+.hy
+.fi
+.RE
+..
+
+.SH DESCRIPTION
+
+This family of probe points is used to probe core kernel activities which are
+hooked by kernel markers, including irq, process and scheduler.
+
+It contains the following probe points:
+
+.P
+.TP
+.B marker.irq.hardirq.entry
+
+Fires just before handing a hard interrupt.
+
+
+.B Context:
+
+A hard interrupt occurs.
+
+
+.B Arguments:
+
+
+.I irq_id
+
+ the id of hard irq.
+
+.I kernel_mode
+
+ boolean indicating whether the interrupt occurred
+in kernel mode.
+
+.P
+.TP
+.B marker.irq.hardirq.exit
+
+Fires after handling a hard interrupt.
+
+
+.B Context:
+
+A hard interrupt was handled.
+
+
+.B Arguments:
+
+
+.I irq_id
+
+ the id of hard irq (if possible).
+
+.I retval
+
+ return value of handle_IRQ_event().
+
+.P
+.TP
+.B marker.irq.softirq.enter
+
+Fires before calling softirq handler.
+
+
+.B Context:
+
+Softirq handler will be invoked.
+
+
+.B Arguments:
+
+
+.I softirq_id
+
+ the id of softirq.
+
+.I func
+
+ the pointer of softirq handler (if possible).
+
+.B Note:
+
+On specific architecture(ex. ia64) the "func" is not the address of
+the actuall function. You might need to derefer *func for getting
+actuall address.
+
+.P
+.TP
+.B marker.irq.softirq.exit
+
+Fires after calling softirq handler.
+
+
+.B Context:
+
+Softirq handler was handled.
+
+
+.B Arguments:
+
+
+.I softirq_id
+
+ the id of softirq.
+
+.P
+.TP
+.B marker.irq.tasklet_low.enter
+
+Fires before calling tasklet_low handler.
+
+
+.B Context:
+
+Tasklet(low) handler will be invoked.
+
+
+.B Arguments:
+
+
+.I func
+
+ the pointer of tasklet_low handler.
+
+.I data
+
+ the data passed to the handler.
+
+.B Note:
+
+On specific architecture(ex. ia64) the "func" is not the address of
+the actuall function. You might need to derefer *func for getting
+actuall address.
+
+.P
+.TP
+.B marker.irq.tasklet_low.exit
+
+Fires after calling tasklet_low handler.
+
+
+.B Context:
+
+Tasklet(low) handler was handled.
+
+
+.B Arguments:
+
+
+.I func
+
+ the pointer of tasklet_low handler.
+
+.I data
+
+ the data passed to the handler.
+
+.B Note:
+
+On specific architecture(ex. ia64) the "func" is not the address of
+the actuall function. You might need to derefer *func for getting
+actuall address.
+
+.P
+.TP
+.B marker.irq.tasklet_high.enter
+
+Fires before calling tasklet_high handler.
+
+
+.B Context:
+
+Tasklet(high) handler will be invoked.
+
+
+.B Arguments:
+
+
+.I func
+
+ the pointer of tasklet_high handler.
+
+.I data
+
+ the data passed to the handler.
+
+.B Note:
+
+On specific architecture(ex. ia64) the "func" is not the address of
+the actuall function. You might need to derefer *func for getting
+actuall address.
+
+.P
+.TP
+.B marker.irq.tasklet_high.exit
+
+Fires after calling tasklet_high handler.
+
+
+.B Context:
+
+Tasklet(high) handler was handled.
+
+
+.B Arguments:
+
+
+.I func
+
+ the pointer of tasklet_high handler.
+
+.I data
+
+ the data passed to the handler.
+
+.B Note:
+
+On specific architecture(ex. ia64) the "func" is not the address of
+the actuall function. You might need to derefer *func for getting
+actuall address.
+
+.P
+.TP
+.B marker.process.free
+
+Fires when task_struct will be released.
+
+
+.B Context:
+
+A process is released.
+
+
+.B Arguments:
+
+
+.I pid
+
+ released process pid.
+
+.P
+.TP
+.B marker.process.wait
+
+Fires when do_wait() is called.
+
+
+.B Context:
+
+Current process waits another process.
+
+
+.B Arguments:
+
+
+.I pid
+
+ waiting target pid.
+
+.P
+.TP
+.B marker.process.exit
+
+Fires when do_exit() is called.
+
+
+.B Context:
+
+A process exits.
+
+
+.B Arguments:
+
+
+.I pid
+
+ exit process pid.
+
+.P
+.TP
+.B marker.process.fork
+
+Fires when a process forked/cloned.
+
+
+.B Context:
+
+A process forked/cloned.
+
+
+.B Arguments:
+
+
+.I pid
+
+ parent pid.
+
+.I parent_pid
+
+ same as above "pid".
+
+.I child_pid
+
+ forked child pid.
+
+.I child_tgid
+
+ forked child thread group id.
+
+.P
+.TP
+.B marker.scheduler.wakeup
+
+Fires a process wakeup.
+
+
+.B Context:
+
+A process wakeup.
+
+
+.B Arguments:
+
+
+.I pid
+
+ wakeup process pid.
+
+.I state
+
+ process task state.
+
+.I cpu_id
+
+ the id of cpu where the process wakeup.
+
+.P
+.TP
+.B marker.scheduler.switch
+
+Fires scheduler switches tasks.
+
+
+.B Context:
+
+A process is switching to another process.
+
+
+.B Arguments:
+
+
+.I prev_pid
+
+ the pid of the process from which next task is switched.
+
+.I next_pid
+
+ the pid of the process to which previous task switches.
+
+.I prev_state
+
+ task state of previous process
+
+.I prev_prio
+
+ task priority of previous process (if possible)
+
+.I next_prio
+
+ task priority of next process (if possible)
+
+
+.SH SEE ALSO
+.IR stap (1),
+.IR stapprobes (5),
Index: systemtap/configure.ac
===================================================================
--- systemtap.orig/configure.ac 2008-09-12 13:20:42.000000000 -0400
+++ systemtap/configure.ac 2008-09-12 13:26:07.000000000 -0400
@@ -221,7 +221,7 @@
AC_LANG_POP(C++)
AC_CONFIG_HEADERS([config.h:config.in])
-AC_CONFIG_FILES(Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5)
+AC_CONFIG_FILES(Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 man/stapprobes.marker.5)
AC_CONFIG_SUBDIRS(testsuite)
AC_OUTPUT
Index: systemtap/Makefile.am
===================================================================
--- systemtap.orig/Makefile.am 2008-09-12 13:21:16.000000000 -0400
+++ systemtap/Makefile.am 2008-09-12 13:26:07.000000000 -0400
@@ -10,7 +10,7 @@
AM_CFLAGS = -D_GNU_SOURCE -fexceptions -Wall -Werror -Wunused -Wformat=2 -W
AM_CXXFLAGS = -Wall -Werror
-man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
+man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 man/stapprobes.marker.5
# see also configure.ac
bin_PROGRAMS = stap staprun
Index: systemtap/stapprobes.5.in
===================================================================
--- systemtap.orig/stapprobes.5.in 2008-09-12 13:20:42.000000000 -0400
+++ systemtap/stapprobes.5.in 2008-09-12 13:26:07.000000000 -0400
@@ -615,4 +615,5 @@
.IR stapprobes.socket (5),
.IR stapprobes.tcp (5),
.IR stapprobes.udp (5),
+.IR stapprobes.marker (5),
.IR proc (5)
Index: systemtap/Makefile.in
===================================================================
--- systemtap.orig/Makefile.in 2008-09-12 13:21:16.000000000 -0400
+++ systemtap/Makefile.in 2008-09-12 13:26:07.000000000 -0400
@@ -63,7 +63,8 @@
$(top_srcdir)/man/stapprobes.signal.5.in \
$(top_srcdir)/man/stapprobes.socket.5.in \
$(top_srcdir)/man/stapprobes.tcp.5.in \
- $(top_srcdir)/man/stapprobes.udp.5.in depcomp
+ $(top_srcdir)/man/stapprobes.udp.5.in \
+ $(top_srcdir)/man/stapprobes.marker.5.in depcomp
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
am__aclocal_m4_deps = $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
@@ -79,7 +80,7 @@
man/stapprobes.process.5 man/stapprobes.rpc.5 \
man/stapprobes.scsi.5 man/stapprobes.signal.5 \
man/stapprobes.socket.5 man/stapprobes.tcp.5 \
- man/stapprobes.udp.5
+ man/stapprobes.udp.5 man/stapprobes.marker.5
am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(pkglibexecdir)" \
"$(DESTDIR)$(bindir)" "$(DESTDIR)$(man1dir)" \
"$(DESTDIR)$(man5dir)" "$(DESTDIR)$(man8dir)"
@@ -260,7 +261,7 @@
AM_CPPFLAGS = -DBINDIR='"$(bindir)"' -DPKGDATADIR='"${pkgdatadir}"' -DPKGLIBDIR='"$(pkglibexecdir)"'
AM_CFLAGS = -D_GNU_SOURCE -fexceptions -Wall -Werror -Wunused -Wformat=2 -W
AM_CXXFLAGS = -Wall -Werror
-man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5
+man_MANS = stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 man/stapprobes.marker.5
bin_SCRIPTS = stap-client stap-server stap-serverd stap-find-servers stap-start-server stap-find-or-start-server stap-stop-server
stap_SOURCES = main.cxx \
parse.cxx staptree.cxx elaborate.cxx translate.cxx \
@@ -414,6 +415,8 @@
cd $(top_builddir) && $(SHELL) ./config.status $@
man/stapprobes.udp.5: $(top_builddir)/config.status $(top_srcdir)/man/stapprobes.udp.5.in
cd $(top_builddir) && $(SHELL) ./config.status $@
+man/stapprobes.marker.5: $(top_builddir)/config.status $(top_srcdir)/man/stapprobes.marker.5.in
+ cd $(top_builddir) && $(SHELL) ./config.status $@
install-binPROGRAMS: $(bin_PROGRAMS)
@$(NORMAL_INSTALL)
test -z "$(bindir)" || $(MKDIR_P) "$(DESTDIR)$(bindir)"
Index: systemtap/configure
===================================================================
--- systemtap.orig/configure 2008-09-12 13:20:42.000000000 -0400
+++ systemtap/configure 2008-09-12 13:26:07.000000000 -0400
@@ -6995,7 +6995,7 @@
ac_config_headers="$ac_config_headers config.h:config.in"
-ac_config_files="$ac_config_files Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5"
+ac_config_files="$ac_config_files Makefile doc/Makefile stap.1 stapprobes.5 stapfuncs.5 stapvars.5 stapex.5 staprun.8 stap-server.8 man/stapprobes.iosched.5 man/stapprobes.netdev.5 man/stapprobes.nfs.5 man/stapprobes.nfsd.5 man/stapprobes.pagefault.5 man/stapprobes.process.5 man/stapprobes.rpc.5 man/stapprobes.scsi.5 man/stapprobes.signal.5 man/stapprobes.socket.5 man/stapprobes.tcp.5 man/stapprobes.udp.5 man/stapprobes.marker.5"
subdirs="$subdirs testsuite"
@@ -7642,6 +7642,7 @@
"man/stapprobes.socket.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.socket.5" ;;
"man/stapprobes.tcp.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.tcp.5" ;;
"man/stapprobes.udp.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.udp.5" ;;
+ "man/stapprobes.marker.5") CONFIG_FILES="$CONFIG_FILES man/stapprobes.marker.5" ;;
*) { { echo "$as_me:$LINENO: error: invalid argument: $ac_config_target" >&5
echo "$as_me: error: invalid argument: $ac_config_target" >&2;}
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2008-09-12 22:23 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2008-09-12 22:23 [PATCH 2/3] systemtap: marker tapset document Masami Hiramatsu
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).