From df812cbc77d205d0f919bbb516f9fc9ddb4deb2a Mon Sep 17 00:00:00 2001 From: William Cohen Date: Mon, 24 Nov 2008 10:19:07 -0500 Subject: [PATCH] Remove the old SystemTap_Tapset_Reference. --- doc/ChangeLog | 4 + doc/SystemTap_Tapset_Reference/Makefile | 19 - .../en-US/Author_Group.xml | 15 - doc/SystemTap_Tapset_Reference/en-US/Book_Info.xml | 33 - doc/SystemTap_Tapset_Reference/en-US/Chapter.xml | 25 - .../en-US/Introduction.xml | 62 - doc/SystemTap_Tapset_Reference/en-US/Preface.xml | 13 - .../en-US/Revision_History.xml | 28 - .../en-US/Tapset_Reference.ent | 5 - .../en-US/Tapset_Reference.xml | 16 - doc/SystemTap_Tapset_Reference/en-US/context.xml | 226 -- .../en-US/images/icon.svg | 3936 -------------------- doc/SystemTap_Tapset_Reference/en-US/memory.xml | 182 - .../en-US/networking.xml | 100 - doc/SystemTap_Tapset_Reference/en-US/timestamp.xml | 50 - doc/SystemTap_Tapset_Reference/extractxml.pl | 137 - 16 files changed, 4 insertions(+), 4847 deletions(-) delete mode 100644 doc/SystemTap_Tapset_Reference/Makefile delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Author_Group.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Book_Info.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Chapter.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Introduction.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Preface.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Revision_History.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.ent delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/context.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/images/icon.svg delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/memory.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/networking.xml delete mode 100644 doc/SystemTap_Tapset_Reference/en-US/timestamp.xml delete mode 100755 doc/SystemTap_Tapset_Reference/extractxml.pl diff --git a/doc/ChangeLog b/doc/ChangeLog index d0b02ad..e59e240 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2008-11-24 Will Cohen + + * SystemTap_Tapset_Reference: Remove. + 2008-10-23 Will Cohen * SystemTap_Tapset_Reference: New. diff --git a/doc/SystemTap_Tapset_Reference/Makefile b/doc/SystemTap_Tapset_Reference/Makefile deleted file mode 100644 index 5212c16..0000000 --- a/doc/SystemTap_Tapset_Reference/Makefile +++ /dev/null @@ -1,19 +0,0 @@ -#Makefile for SystemTap_Tapset_Reference - -XML_LANG = en-US -BRAND = common - -SHOW_REMARKS=1 - -#OTHER_LANGS = as-IN bn-IN de-DE es-ES fr-FR gu-IN hi-IN it-IT ja-JP kn-IN ko-KR ml-IN mr-IN or-IN pa-IN pt-BR ru-RU si-LK ta-IN te-IN zh-CN zh-TW - -# Extra Parameters start here - -# Extra Parameters stop here -COMMON_CONFIG = /usr/share/publican -include $(COMMON_CONFIG)/make/Makefile.common - -#Pull the xml out of the tapset -TAPSETS=../../tapset -extract-xml: - ./extractxml.pl $(TAPSETS) ./en-US diff --git a/doc/SystemTap_Tapset_Reference/en-US/Author_Group.xml b/doc/SystemTap_Tapset_Reference/en-US/Author_Group.xml deleted file mode 100644 index 1f39c66..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Author_Group.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - William - Cohen - - Tools - Engineering - - wcohen@redhat.com - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Book_Info.xml b/doc/SystemTap_Tapset_Reference/en-US/Book_Info.xml deleted file mode 100644 index c0fc2eb..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Book_Info.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - Tapset Reference - Systemtap - - 0.7.1 - 0 - 0 - - Describes the various instrumentation points and functions - available in SystemTap tapsets. - - - - - - - Logo - - - - &YEAR; - &HOLDER; - - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Chapter.xml b/doc/SystemTap_Tapset_Reference/en-US/Chapter.xml deleted file mode 100644 index 64b94c9..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Chapter.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - Test - - This is a test paragraph - -
- Section 1 Test - - Test of a section - -
- -
- Section 2 Test - - Test of a section - -
- - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml b/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml deleted file mode 100644 index 31e8a78..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Introduction.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - Introduction - - SystemTap provides free software (GPL) infrastructure to simplify the - gathering of information about the running Linux system. This assists - diagnosis of a performance or functional problem. SystemTap eliminates the - need for the developer to go through the tedious and disruptive instrument, - recompile, install, and reboot sequence that may be otherwise required to - collect data. - - - - SystemTap provides a simple command line interface and scripting language - for writing instrumentation for a live running kernel. The instrumentation - makes extensive use of the probe points and functions provided in the - tapset library. This document describes the various - probe points and functions. - - -
- Tapset Name Format - -In this guide, tapset definitions appear in the following format: - - -name:return (parameters) - definition - - - - The return field specifies what data type the tapset extracts - and returns from the kernel during a probe (and thus, returns). - Tapsets use 2 data types for return: - long (tapset extracts and returns an integer) and - string (tapset extracts and returns a string). - - - - In some cases, tapsets do not have a return value. This - simply means that the tapset does not extract anything from the kernel. This is common among - asynchronous events such as timers, exit functions, and print functions. - - - - - - -
- - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Preface.xml b/doc/SystemTap_Tapset_Reference/en-US/Preface.xml deleted file mode 100644 index 09c00a1..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Preface.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - Preface - - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Revision_History.xml b/doc/SystemTap_Tapset_Reference/en-US/Revision_History.xml deleted file mode 100644 index 2c92d4b..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Revision_History.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Revision History - - - - 1.0 - October 24, 2008 - - William - Cohen - wcohen@redhat.com - - - - Initial creation of - SystemTap Reference Manual - - - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.ent b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.ent deleted file mode 100644 index 45fb709..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.ent +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml deleted file mode 100644 index 404b654..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/context.xml b/doc/SystemTap_Tapset_Reference/en-US/context.xml deleted file mode 100644 index 2fa8c63..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/context.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - Context Functions - - The context functions provide additional information about the where - the event occurred. - The contact functions can provide information such as a backtrace - where the event occured - and the current register values for the processor. - - - print_regs() - print_regs - - Print a register dump. - - - - print_backtrace() - print_backtrace - - Equivalent to print_stack(backtrace()), - except that deeper stack nesting may be supported. Return nothing. - - - - backtrace:string() - backtrace - - Return a string of hex addresses that are a backtrace of the - stack. It may be truncated due to maximum string length. - - - - execname:string() - execname - - Return the name of the current process. - - - - pid:long () - pid - - Return the id of the current process. - - - - tid:long() - tid - - Return the id of the current thread. - - - - ppid:long() - ppid - - Return the id of the parent process. - - - - pexecname:string() - pexecname - - Return the name of the parent process. - - - - gid:long() - gid - - Return the gid of the current process. - - - - egid:long() - egid - - Return the effective gid of the current process. - - - - uid:long() - uid - - Return the uid of the current process. - - - - euid:long() - euid - - Return the effective uid of the current process. - - - - cpu:long() - cpu - - Return the current cpu number. - - - - print_stack(stk:string) - print_stack - - Perform a symbolic lookup of the addresses in the given string, - which is assumed to be the result of a prior call to - . - Print one line per address, including the address, the - name of the function containing the address, and an estimate of - its position within that function. Return nothing. - - - - pp:string() - pp - - Return the probe point associated with the currently running - probe handler, including alias and wildcard expansion effects. - - - - probefunc:string() - probefunc - - Return the probe point's function name, if known. - - - - probemod:string() - probemod - - Return the probe point's module name, if known. - - - - registers_valid:long() - registers_valid - - Return 1 if register() and u_register() can be used - in the current context, or 0 otherwise. - For example, registers_valid() returns 0 - when called from a begin or end probe. - - - - user_mode:long() - user_mode - - Return 1 if the probe point occurred in user-mode. - - - - is_return:long() - is_return - - Return 1 if the probe point is a return probe. - Deprecated. - - - - target:long() - target - - Return the pid of the target process. - - - - module_name:string() - module_name - - FIXME: need description. - - - - stp_pid:long() - stp_pid - - FIXME: need description. - - - - stack_size:long() - stack_size - - Return the size of the kernel stack. - - - - stack_used:long () - stack_used - - Return how many bytes are currently used in the kernel stack. - - - - stack_unused:long() - stack_unused - - Return how many bytes are currently available in the kernel stack. - - - - caller_addr:long() - caller_addr - - Return the address of the calling function. - Works only for return probes at this time. - - - - - caller:string() - caller - - Return the address and name of the calling function. - Works only for return probes at this time. - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/images/icon.svg b/doc/SystemTap_Tapset_Reference/en-US/images/icon.svg deleted file mode 100644 index c471a60..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/images/icon.svg +++ /dev/null @@ -1,3936 +0,0 @@ - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - id="path2858" /> - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/memory.xml b/doc/SystemTap_Tapset_Reference/en-US/memory.xml deleted file mode 100644 index 7bceaa1..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/memory.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - Memory Tapset - - This family of probe points is used to probe page fault events. - It contains the following probe points: - - - vm.pagefault - vm.pagefault - - Records that a page fault occurred. - The context is the process which triggered the fault. - - - Arguments: - address - - The address of the faulting memory access. - - - write_access - - Indicates whether this was a write. - - - - - - vm.pagefault.return - vm.pagefault.return - - Records type of fault that occurred. - The context is the process which triggered the fault. - - - - Arguments: - fault_type - The possible values of fault_type are: - Fault values - - - - - - DefineValueReason - - - - VM_FAULT_OOM - 0 - out of memory - - - VM_FAULT_SIGBUS - 1 - if not oom, minor, or major fault, this val - - - VM_FAULT_MINOR - 2 - no blocking operation to handle fault - - - VM_FAULT_MAJOR - 3 - required blocking operation to handle fault - - - -
- - - - - - vm.write_shared - vm.write_shared - - Fires when a process attempts to write to a shared page. - If a copy is necessary, this will be followed by a - . - The context is the process attempting the write. - - - - Arguments: - address - The address of the shared write. - - - - - vm.write_shared_copy - vm.write_shared_copy - - Fires when a write to a shared page requires a page copy. - This is always preceded by a . - The context is the process attempting the write. - - - - Arguments: - address - - The address of the shared write. - - - zero - - Boolean indicating whether it is a zero page - (can do a clear instead of a copy). - - - - - - vm.mmap - vm.mmap - - Fires when an mmap is requested. - The context is the process calling mmap. - - - - Arguments: - address - The requested address. - - length - The length of the memory segment. - - - - - vm.munmap - vm.munmap - Fires when an munmap is requested. - - - Arguments: - address - The requested address. - - length - The length of the memory segment. - - - - - vm.brk - vm.brk - Fires when a brk is requested (resizing a heap). - - - Arguments: - address - The requested address. - - length - The length of the memory segment. - - - - - vm.oom_kill - vm.oom_kill - Fires when a thread is targetted by the OOM killer. - - - Arguments: - task - The task being killed. - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/networking.xml b/doc/SystemTap_Tapset_Reference/en-US/networking.xml deleted file mode 100644 index bb5cfea..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/networking.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Networking Tapset - - This family of probe points is used to probe the activities of - network device. - - - netdev.receive - netdev.receive - Fires when data arrives on network device. - - - Arguments: - dev_name - - The name of the device. e.g: eth0, ath1 - - - - length - - The length of the receiving buffer - - - - protocol - The possible values of protocol could be: - Protocol Values - - - - - Value(Hex)Protocol - - - 0001802.3 - 0002AX.25 - 0004802.2 - 0005SNAP - 0009Localtalk - 0800IP - 0805X.25 - 0806ARP - 8035RARP - 8100802.1Q VLAN - 8137IPX - 86DDIPv6 - - -
- - - - truesize - - The size of the received data. - - - - - - - netdev.transmit - netdev.transmit - Fires when the network device wants to transmit a buffer. - - - Arguments: - dev_name - - The name of the device. e.g: eth0, ath1 - - - - length - - The length of the transmit buffer - - - - protocol - - The protocol of this packet. - - - - truesize - - The size of the the data to be transmitted. - - - - - - diff --git a/doc/SystemTap_Tapset_Reference/en-US/timestamp.xml b/doc/SystemTap_Tapset_Reference/en-US/timestamp.xml deleted file mode 100644 index 714f16b..0000000 --- a/doc/SystemTap_Tapset_Reference/en-US/timestamp.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - Timestamp Functions - - Each timestamp function returns a value to indicate when - the function is executed. - Thus, these returned values can be used to indicate - when an event occurs, provide an ordering for events, or compute - the amount of time elapsed between to time stamps. - - - get_cycles:long() - get_cycles - - Return the processor cycle counter value, or 0 if unavailable. - - - - gettimeofday_ns:long () - gettimeofday_ns - - Return the number of nanoseconds since the UNIX epoch. - - - - gettimeofday_us:long () - gettimeofday_us - - Return the number of microseconds since the UNIX epoch. - - - - gettimeofday_ms:long () - gettimeofday_ms - - Return the number of milliseconds since the UNIX epoch. - - - - gettimeofday_s:long () - gettimeofday_s - - Return the number of seconds since the UNIX epoch. - - - diff --git a/doc/SystemTap_Tapset_Reference/extractxml.pl b/doc/SystemTap_Tapset_Reference/extractxml.pl deleted file mode 100755 index 492a29c..0000000 --- a/doc/SystemTap_Tapset_Reference/extractxml.pl +++ /dev/null @@ -1,137 +0,0 @@ -#! /usr/bin/perl -# Generates xml files from tapset .stp files. -# Copyright (C) 2008 Red Hat Inc. -# -# This file is part of systemtap, and is free software. You can -# redistribute it and/or modify it under the terms of the GNU General -# Public License (GPL); either version 2, or (at your option) any -# later version. - -use strict; -use warnings; - -use Cwd 'abs_path'; -use File::Copy; -use File::Find; -use File::Path; -use Text::Wrap; -use IO::File; -use POSIX qw(tmpnam); - -my $XMLHEADER = - "\n" - . "\n" - ."\n" - . "\n" - . "\n" - . "\n" - . "\n" -; -my $XMLFOOTER = - "\n" - . "\n" - ."\n"; - -my $XML_CHAPTER_HEADER = - "\n" - . "\n" - . "\n"; - -my $XML_CHAPTER_FOOTER = ""; - -my $inputdir; -if ($#ARGV >= 0) { - $inputdir = $ARGV[0]; -} else { - $inputdir = "."; -} -$inputdir = abs_path($inputdir); - -my $outputdir; -if ($#ARGV >= 1) { - $outputdir = $ARGV[1]; -} else { - $outputdir = $inputdir; -} -$outputdir = abs_path($outputdir); - -#attempt to create the output directory -if ($inputdir ne $outputdir) { - if (! -d "$outputdir") { - mkpath("$outputdir", 1, 0711); - } -} - -my %scripts = (); - -print "Extracting xml from .stp files in $inputdir...\n"; -find(\&extract_xml, $inputdir); - - -# Output list of extracted xml files -my $tapsetxml = "$outputdir/Tapset_Reference.xml"; -open (TAPSETXML, ">$tapsetxml") - || die "couldn't open $tapsetxml: $!"; -print "Creating $tapsetxml...\n"; -print TAPSETXML $XMLHEADER; - -my $tapset; -foreach $tapset (sort keys %scripts) { - print TAPSETXML "\n" - -} -print TAPSETXML $XMLFOOTER; -close (TAPSETXML); - - -sub extract_xml { - my $file = $_; - my $filename = $File::Find::name; - my $ofile; - my $ofilefullt; - my $ofilefull; - - if (-f $file && $file =~ /\.stp$/) { - open FILE, $file or die "couldn't open '$file': $!\n"; - - $ofilefullt = tmpnam(); - open OFILET, ">$ofilefullt" or die "couldn't open '$ofilefullt': $!\n"; - - print "Extracting xml from $filename...\n"; - - while () { - print OFILET if s/\s*\/\/\///; - } - close OFILET; - close FILE; - - #If xml was extracted make a .xml file - if (-s $ofilefullt) { - #get rid of the inputdir part and .stp, add .xml - # chop off the search dir prefix. - $inputdir =~ s/\/$//; - $ofile = substr $filename, (length $inputdir) + 1; - $ofile =~ s/.stp/.xml/; - $ofile =~ s/\//_/g; - $scripts{$ofile} = $ofile; - print "$ofile\n"; - $ofilefull = "$outputdir/$ofile"; - open OFILE, ">$ofilefull" - or die "couldn't open '$ofilefull': $!\n"; - open OFILET, "$ofilefullt" - or die "couldn't open '$ofilefullt': $!\n"; - print OFILE "$XML_CHAPTER_HEADER"; - while () { - print OFILE ; - } - print OFILE "$XML_CHAPTER_FOOTER"; - close OFILET; - close OFILE; - } - unlink($ofilefullt); - } -} -- 1.5.6.5