From ba4b1d99384b208b8bcda2be3cc0e27d0b03a915 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Thu, 13 Nov 2008 15:51:24 -0500 Subject: Add xml documentation for memory.stp. --- .../en-US/Tapset_Reference.xml | 1 + doc/SystemTap_Tapset_Reference/en-US/memory.xml | 182 +++++++++++++++++++++ 2 files changed, 183 insertions(+) create mode 100644 doc/SystemTap_Tapset_Reference/en-US/memory.xml (limited to 'doc/SystemTap_Tapset_Reference/en-US') diff --git a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml index f10159b8..404b6543 100644 --- a/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml +++ b/doc/SystemTap_Tapset_Reference/en-US/Tapset_Reference.xml @@ -8,6 +8,7 @@ + diff --git a/doc/SystemTap_Tapset_Reference/en-US/memory.xml b/doc/SystemTap_Tapset_Reference/en-US/memory.xml new file mode 100644 index 00000000..7bceaa16 --- /dev/null +++ b/doc/SystemTap_Tapset_Reference/en-US/memory.xml @@ -0,0 +1,182 @@ + + + + + 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. + + + + -- cgit