Skip to contentSkip to conversation

Port KVM-trace to tracepoints

PATCH In review Mathieu Desnoyers 8 participants 40 messages Jul 17, 2008 – Jul 31, 2008 1 message not in the archive

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

cover Port KVM-trace to tracepoints

Hi,

Here is a port of KVM-trace, currently using macros on top of the Linux Markers, to tracepoints. Note that I cleaned up the instrumentation too, so stuff like

KVMTRACE_3D(CR_WRITE, vcpu, (u32)cr,
(u32)kvm_register_read(vcpu, reg),
(u32)((u64)kvm_register_read(vcpu, reg) >> 32),
handler);

Sprinkled all across the KVM C code becomes :

trace_kvm_cr_write(vcpu, cr, reg);

Which looks much nicer, IMHO.

It applies on top of linux-next patch-v2.6.26-next-20080715.

Mathieu

Signature · 3 lines
Mathieu Desnoyers
Computer Engineering Ph.D. Student, Ecole Polytechnique de Montreal
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#1 lore raw

PATCH 1/4 kvm move VMCS Encodings to system headers

The VMCS Encodings will be needed by the kvm-trace probes. Put them in system-side headers instead of local header.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
---
 arch/x86/kvm/vmx.h         |  142 ---------------------------------------------
 include/asm-x86/kvm_host.h |  142 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 142 insertions(+), 142 deletions(-)
include/asm-x86/kvm_host.h +142 -0
Index: linux-2.6-lttng/include/asm-x86/kvm_host.h
===================================================================
@@ -719,4 +719,146 @@ asmlinkage void kvm_handle_fault_on_rebo
 	KVM_EX_ENTRY " 666b, 667b \n\t" \
 	".popsection"
 
+/* VMCS Encodings */
+enum vmcs_field {
+	VIRTUAL_PROCESSOR_ID            = 0x00000000,
+	GUEST_ES_SELECTOR               = 0x00000800,
+	GUEST_CS_SELECTOR               = 0x00000802,
+	GUEST_SS_SELECTOR               = 0x00000804,
+	GUEST_DS_SELECTOR               = 0x00000806,
+	GUEST_FS_SELECTOR               = 0x00000808,
+	GUEST_GS_SELECTOR               = 0x0000080a,
+	GUEST_LDTR_SELECTOR             = 0x0000080c,
+	GUEST_TR_SELECTOR               = 0x0000080e,
+	HOST_ES_SELECTOR                = 0x00000c00,
+	HOST_CS_SELECTOR                = 0x00000c02,
+	HOST_SS_SELECTOR                = 0x00000c04,
+	HOST_DS_SELECTOR                = 0x00000c06,
+	HOST_FS_SELECTOR                = 0x00000c08,
+	HOST_GS_SELECTOR                = 0x00000c0a,
+	HOST_TR_SELECTOR                = 0x00000c0c,
+	IO_BITMAP_A                     = 0x00002000,
+	IO_BITMAP_A_HIGH                = 0x00002001,
+	IO_BITMAP_B                     = 0x00002002,
+	IO_BITMAP_B_HIGH                = 0x00002003,
+	MSR_BITMAP                      = 0x00002004,
+	MSR_BITMAP_HIGH                 = 0x00002005,
+	VM_EXIT_MSR_STORE_ADDR          = 0x00002006,
+	VM_EXIT_MSR_STORE_ADDR_HIGH     = 0x00002007,
+	VM_EXIT_MSR_LOAD_ADDR           = 0x00002008,
+	VM_EXIT_MSR_LOAD_ADDR_HIGH      = 0x00002009,
+	VM_ENTRY_MSR_LOAD_ADDR          = 0x0000200a,
+	VM_ENTRY_MSR_LOAD_ADDR_HIGH     = 0x0000200b,
+	TSC_OFFSET                      = 0x00002010,
+	TSC_OFFSET_HIGH                 = 0x00002011,
+	VIRTUAL_APIC_PAGE_ADDR          = 0x00002012,
+	VIRTUAL_APIC_PAGE_ADDR_HIGH     = 0x00002013,
+	APIC_ACCESS_ADDR		= 0x00002014,
+	APIC_ACCESS_ADDR_HIGH		= 0x00002015,
+	EPT_POINTER                     = 0x0000201a,
+	EPT_POINTER_HIGH                = 0x0000201b,
+	GUEST_PHYSICAL_ADDRESS          = 0x00002400,
+	GUEST_PHYSICAL_ADDRESS_HIGH     = 0x00002401,
+	VMCS_LINK_POINTER               = 0x00002800,
+	VMCS_LINK_POINTER_HIGH          = 0x00002801,
+	GUEST_IA32_DEBUGCTL             = 0x00002802,
+	GUEST_IA32_DEBUGCTL_HIGH        = 0x00002803,
+	GUEST_PDPTR0                    = 0x0000280a,
+	GUEST_PDPTR0_HIGH               = 0x0000280b,
+	GUEST_PDPTR1                    = 0x0000280c,
+	GUEST_PDPTR1_HIGH               = 0x0000280d,
+	GUEST_PDPTR2                    = 0x0000280e,
+	GUEST_PDPTR2_HIGH               = 0x0000280f,
+	GUEST_PDPTR3                    = 0x00002810,
+	GUEST_PDPTR3_HIGH               = 0x00002811,
+	PIN_BASED_VM_EXEC_CONTROL       = 0x00004000,
+	CPU_BASED_VM_EXEC_CONTROL       = 0x00004002,
+	EXCEPTION_BITMAP                = 0x00004004,
+	PAGE_FAULT_ERROR_CODE_MASK      = 0x00004006,
+	PAGE_FAULT_ERROR_CODE_MATCH     = 0x00004008,
+	CR3_TARGET_COUNT                = 0x0000400a,
+	VM_EXIT_CONTROLS                = 0x0000400c,
+	VM_EXIT_MSR_STORE_COUNT         = 0x0000400e,
+	VM_EXIT_MSR_LOAD_COUNT          = 0x00004010,
+	VM_ENTRY_CONTROLS               = 0x00004012,
+	VM_ENTRY_MSR_LOAD_COUNT         = 0x00004014,
+	VM_ENTRY_INTR_INFO_FIELD        = 0x00004016,
+	VM_ENTRY_EXCEPTION_ERROR_CODE   = 0x00004018,
+	VM_ENTRY_INSTRUCTION_LEN        = 0x0000401a,
+	TPR_THRESHOLD                   = 0x0000401c,
+	SECONDARY_VM_EXEC_CONTROL       = 0x0000401e,
+	VM_INSTRUCTION_ERROR            = 0x00004400,
+	VM_EXIT_REASON                  = 0x00004402,
+	VM_EXIT_INTR_INFO               = 0x00004404,
+	VM_EXIT_INTR_ERROR_CODE         = 0x00004406,
+	IDT_VECTORING_INFO_FIELD        = 0x00004408,
+	IDT_VECTORING_ERROR_CODE        = 0x0000440a,
+	VM_EXIT_INSTRUCTION_LEN         = 0x0000440c,
+	VMX_INSTRUCTION_INFO            = 0x0000440e,
+	GUEST_ES_LIMIT                  = 0x00004800,
+	GUEST_CS_LIMIT                  = 0x00004802,
+	GUEST_SS_LIMIT                  = 0x00004804,
+	GUEST_DS_LIMIT                  = 0x00004806,
+	GUEST_FS_LIMIT                  = 0x00004808,
+	GUEST_GS_LIMIT                  = 0x0000480a,
+	GUEST_LDTR_LIMIT                = 0x0000480c,
+	GUEST_TR_LIMIT                  = 0x0000480e,
+	GUEST_GDTR_LIMIT                = 0x00004810,
+	GUEST_IDTR_LIMIT                = 0x00004812,
+	GUEST_ES_AR_BYTES               = 0x00004814,
+	GUEST_CS_AR_BYTES               = 0x00004816,
+	GUEST_SS_AR_BYTES               = 0x00004818,
+	GUEST_DS_AR_BYTES               = 0x0000481a,
+	GUEST_FS_AR_BYTES               = 0x0000481c,
+	GUEST_GS_AR_BYTES               = 0x0000481e,
+	GUEST_LDTR_AR_BYTES             = 0x00004820,
+	GUEST_TR_AR_BYTES               = 0x00004822,
+	GUEST_INTERRUPTIBILITY_INFO     = 0x00004824,
+	GUEST_ACTIVITY_STATE            = 0X00004826,
+	GUEST_SYSENTER_CS               = 0x0000482A,
+	HOST_IA32_SYSENTER_CS           = 0x00004c00,
+	CR0_GUEST_HOST_MASK             = 0x00006000,
+	CR4_GUEST_HOST_MASK             = 0x00006002,
+	CR0_READ_SHADOW                 = 0x00006004,
+	CR4_READ_SHADOW                 = 0x00006006,
+	CR3_TARGET_VALUE0               = 0x00006008,
+	CR3_TARGET_VALUE1               = 0x0000600a,
+	CR3_TARGET_VALUE2               = 0x0000600c,
+	CR3_TARGET_VALUE3               = 0x0000600e,
+	EXIT_QUALIFICATION              = 0x00006400,
+	GUEST_LINEAR_ADDRESS            = 0x0000640a,
+	GUEST_CR0                       = 0x00006800,
+	GUEST_CR3                       = 0x00006802,
+	GUEST_CR4                       = 0x00006804,
+	GUEST_ES_BASE                   = 0x00006806,
+	GUEST_CS_BASE                   = 0x00006808,
+	GUEST_SS_BASE                   = 0x0000680a,
+	GUEST_DS_BASE                   = 0x0000680c,
+	GUEST_FS_BASE                   = 0x0000680e,
+	GUEST_GS_BASE                   = 0x00006810,
+	GUEST_LDTR_BASE                 = 0x00006812,
+	GUEST_TR_BASE                   = 0x00006814,
+	GUEST_GDTR_BASE                 = 0x00006816,
+	GUEST_IDTR_BASE                 = 0x00006818,
+	GUEST_DR7                       = 0x0000681a,
+	GUEST_RSP                       = 0x0000681c,
+	GUEST_RIP                       = 0x0000681e,
+	GUEST_RFLAGS                    = 0x00006820,
+	GUEST_PENDING_DBG_EXCEPTIONS    = 0x00006822,
+	GUEST_SYSENTER_ESP              = 0x00006824,
+	GUEST_SYSENTER_EIP              = 0x00006826,
+	HOST_CR0                        = 0x00006c00,
+	HOST_CR3                        = 0x00006c02,
+	HOST_CR4                        = 0x00006c04,
+	HOST_FS_BASE                    = 0x00006c06,
+	HOST_GS_BASE                    = 0x00006c08,
+	HOST_TR_BASE                    = 0x00006c0a,
+	HOST_GDTR_BASE                  = 0x00006c0c,
+	HOST_IDTR_BASE                  = 0x00006c0e,
+	HOST_IA32_SYSENTER_ESP          = 0x00006c10,
+	HOST_IA32_SYSENTER_EIP          = 0x00006c12,
+	HOST_RSP                        = 0x00006c14,
+	HOST_RIP                        = 0x00006c16,
+};
+
 #endif
arch/x86/kvm/vmx.h +0 -142

148 lines not on this page · raw message

Signature · 3 lines
Mathieu Desnoyers
Computer Engineering Ph.D. Student, Ecole Polytechnique de Montreal
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#2 lore raw

PATCH 2/4 kvm move VMCS read to system headers

In reply to Mathieu Desnoyers

The VMCS read will be needed by the kvm-trace probes. Put them in static inline functions in system-side headers instead of in the C file.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
---
 arch/x86/kvm/vmx.c         |   28 ----------------------------
 include/asm-x86/kvm_host.h |   30 ++++++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 28 deletions(-)
arch/x86/kvm/vmx.c +0 -28
Index: linux-2.6-lttng/arch/x86/kvm/vmx.c
===================================================================
@@ -388,34 +388,6 @@ static inline void ept_sync_individual_a
 	}
 }
 
-static unsigned long vmcs_readl(unsigned long field)
-{
-	unsigned long value;
-
-	asm volatile (__ex(ASM_VMX_VMREAD_RDX_RAX)
-		      : "=a"(value) : "d"(field) : "cc");
-	return value;
-}
-
-static u16 vmcs_read16(unsigned long field)
-{
-	return vmcs_readl(field);
-}
-
-static u32 vmcs_read32(unsigned long field)
-{
-	return vmcs_readl(field);
-}
-
-static u64 vmcs_read64(unsigned long field)
-{
-#ifdef CONFIG_X86_64
-	return vmcs_readl(field);
-#else
-	return vmcs_readl(field) | ((u64)vmcs_readl(field+1) << 32);
-#endif
-}
-
 static noinline void vmwrite_error(unsigned long field, unsigned long value)
 {
 	printk(KERN_ERR "vmwrite error: reg %lx value %lx (err %d)\n",
include/asm-x86/kvm_host.h +30 -0
Index: linux-2.6-lttng/include/asm-x86/kvm_host.h
===================================================================
@@ -719,6 +719,8 @@ asmlinkage void kvm_handle_fault_on_rebo
 	KVM_EX_ENTRY " 666b, 667b \n\t" \
 	".popsection"
 
+#define __ex(x) __kvm_handle_fault_on_reboot(x)
+
 /* VMCS Encodings */
 enum vmcs_field {
 	VIRTUAL_PROCESSOR_ID            = 0x00000000,
@@ -861,4 +863,32 @@ enum vmcs_field {
 	HOST_RIP                        = 0x00006c16,
 };
 
+static inline unsigned long vmcs_readl(unsigned long field)
+{
+	unsigned long value;
+
+	asm volatile (__ex(ASM_VMX_VMREAD_RDX_RAX)
+		      : "=a"(value) : "d"(field) : "cc");
+	return value;
+}
+
+static inline u16 vmcs_read16(unsigned long field)
+{
+	return vmcs_readl(field);
+}
+
+static inline u32 vmcs_read32(unsigned long field)
+{
+	return vmcs_readl(field);
+}
+
+static inline u64 vmcs_read64(unsigned long field)
+{
+#ifdef CONFIG_X86_64
+	return vmcs_readl(field);
+#else
+	return vmcs_readl(field) | ((u64)vmcs_readl(field+1) << 32);
+#endif
+}
+
 #endif
Signature · 3 lines
Mathieu Desnoyers
Computer Engineering Ph.D. Student, Ecole Polytechnique de Montreal
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#3 lore raw

PATCH 3/4 KVM move register read-write to system headers

In reply to Mathieu Desnoyers

Needed by kvm_tracer probes, which are outside of arch/x86/kvm.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
---
 arch/x86/kvm/kvm_cache_regs.h    |   32 --------------------------------
 arch/x86/kvm/lapic.c             |    2 +-
 arch/x86/kvm/svm.c               |    2 +-
 arch/x86/kvm/vmx.c               |    2 +-
 arch/x86/kvm/x86.c               |    2 +-
 arch/x86/kvm/x86_emulate.c       |    2 +-
 include/asm-x86/kvm_cache_regs.h |   32 ++++++++++++++++++++++++++++++++
 7 files changed, 37 insertions(+), 37 deletions(-)
arch/x86/kvm/kvm_cache_regs.h deleted +0 -32
Index: linux-2.6-lttng/arch/x86/kvm/kvm_cache_regs.h
===================================================================
@@ -1,32 +0,0 @@
-#ifndef ASM_KVM_CACHE_REGS_H
-#define ASM_KVM_CACHE_REGS_H
-
-static inline unsigned long kvm_register_read(struct kvm_vcpu *vcpu,
-					      enum kvm_reg reg)
-{
-	if (!test_bit(reg, (unsigned long *)&vcpu->arch.regs_avail))
-		kvm_x86_ops->cache_reg(vcpu, reg);
-
-	return vcpu->arch.regs[reg];
-}
-
-static inline void kvm_register_write(struct kvm_vcpu *vcpu,
-				      enum kvm_reg reg,
-				      unsigned long val)
-{
-	vcpu->arch.regs[reg] = val;
-	__set_bit(reg, (unsigned long *)&vcpu->arch.regs_dirty);
-	__set_bit(reg, (unsigned long *)&vcpu->arch.regs_avail);
-}
-
-static inline unsigned long kvm_rip_read(struct kvm_vcpu *vcpu)
-{
-	return kvm_register_read(vcpu, VCPU_REGS_RIP);
-}
-
-static inline void kvm_rip_write(struct kvm_vcpu *vcpu, unsigned long val)
-{
-	kvm_register_write(vcpu, VCPU_REGS_RIP, val);
-}
-
-#endif
include/asm-x86/kvm_cache_regs.h new file +32 -0
Index: linux-2.6-lttng/include/asm-x86/kvm_cache_regs.h
===================================================================
@@ -0,0 +1,32 @@
+#ifndef ASM_KVM_CACHE_REGS_H
+#define ASM_KVM_CACHE_REGS_H
+
+static inline unsigned long kvm_register_read(struct kvm_vcpu *vcpu,
+					      enum kvm_reg reg)
+{
+	if (!test_bit(reg, (unsigned long *)&vcpu->arch.regs_avail))
+		kvm_x86_ops->cache_reg(vcpu, reg);
+
+	return vcpu->arch.regs[reg];
+}
+
+static inline void kvm_register_write(struct kvm_vcpu *vcpu,
+				      enum kvm_reg reg,
+				      unsigned long val)
+{
+	vcpu->arch.regs[reg] = val;
+	__set_bit(reg, (unsigned long *)&vcpu->arch.regs_dirty);
+	__set_bit(reg, (unsigned long *)&vcpu->arch.regs_avail);
+}
+
+static inline unsigned long kvm_rip_read(struct kvm_vcpu *vcpu)
+{
+	return kvm_register_read(vcpu, VCPU_REGS_RIP);
+}
+
+static inline void kvm_rip_write(struct kvm_vcpu *vcpu, unsigned long val)
+{
+	kvm_register_write(vcpu, VCPU_REGS_RIP, val);
+}
+
+#endif
arch/x86/kvm/lapic.c +1 -1
Index: linux-2.6-lttng/arch/x86/kvm/lapic.c
===================================================================
@@ -32,7 +32,7 @@
 #include <asm/current.h>
 #include <asm/apicdef.h>
 #include <asm/atomic.h>
-#include "kvm_cache_regs.h"
+#include <asm/kvm_cache_regs.h>
 #include "irq.h"
 
 #define PRId64 "d"
arch/x86/kvm/svm.c +1 -1
Index: linux-2.6-lttng/arch/x86/kvm/svm.c
===================================================================
@@ -18,7 +18,6 @@
 #include "kvm_svm.h"
 #include "irq.h"
 #include "mmu.h"
-#include "kvm_cache_regs.h"
 
 #include <linux/module.h>
 #include <linux/kernel.h>
@@ -26,6 +25,7 @@
 #include <linux/highmem.h>
 #include <linux/sched.h>
 
+#include <asm/kvm_cache_regs.h>
 #include <asm/desc.h>
 
 #define __ex(x) __kvm_handle_fault_on_reboot(x)
arch/x86/kvm/vmx.c +1 -1
Index: linux-2.6-lttng/arch/x86/kvm/vmx.c
===================================================================
@@ -26,9 +26,9 @@
 #include <linux/highmem.h>
 #include <linux/sched.h>
 #include <linux/moduleparam.h>
-#include "kvm_cache_regs.h"
 #include "x86.h"
 
+#include <asm/kvm_cache_regs.h>
 #include <asm/io.h>
 #include <asm/desc.h>
 
arch/x86/kvm/x86.c +1 -1
Index: linux-2.6-lttng/arch/x86/kvm/x86.c
===================================================================
@@ -19,7 +19,6 @@
 #include "mmu.h"
 #include "i8254.h"
 #include "tss.h"
-#include "kvm_cache_regs.h"
 #include "x86.h"
 
 #include <linux/clocksource.h>
@@ -30,6 +29,7 @@
 #include <linux/mman.h>
 #include <linux/highmem.h>
 
+#include <asm/kvm_cache_regs.h>
 #include <asm/uaccess.h>
 #include <asm/msr.h>
 #include <asm/desc.h>
arch/x86/kvm/x86_emulate.c +1 -1
Index: linux-2.6-lttng/arch/x86/kvm/x86_emulate.c
===================================================================
@@ -26,10 +26,10 @@
 #define DPRINTF(_f, _a ...) printf(_f , ## _a)
 #else
 #include <linux/kvm_host.h>
-#include "kvm_cache_regs.h"
 #define DPRINTF(x...) do {} while (0)
 #endif
 #include <linux/module.h>
+#include <asm/kvm_cache_regs.h>
 #include <asm/kvm_x86_emulate.h>
 
 /*
Signature · 3 lines
Mathieu Desnoyers
Computer Engineering Ph.D. Student, Ecole Polytechnique de Montreal
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#4 lore raw

PATCH 4/4 KVM-trace port to tracepoints

In reply to Mathieu Desnoyers

Port/cleanup of KVM-trace to tracepoints.

Tracepoints allow dormat instrumentation, like the kernel markers, but also allows to describe the trace points in global headers so they can be easily managed. They also do not use format strings.

Anything that would involve an action (dereference a pointer, vmcs read, ...) only required when tracing is placed in the probes created in kvm_trace.c

This patch depends on the "Tracepoints" patch.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
---
 arch/x86/kvm/vmx.c   |   38 ++---
 arch/x86/kvm/x86.c   |   43 ++----
 include/trace/kvm.h  |   83 ++++++++++++
 virt/kvm/kvm_trace.c |  336 +++++++++++++++++++++++++++++++++++++++++++--------
 4 files changed, 398 insertions(+), 102 deletions(-)
arch/x86/kvm/vmx.c +14 -24
Index: linux-2.6-lttng/arch/x86/kvm/vmx.c
===================================================================
@@ -26,6 +26,7 @@
 #include <linux/highmem.h>
 #include <linux/sched.h>
 #include <linux/moduleparam.h>
+#include <trace/kvm.h>
 #include "x86.h"
 
 #include <asm/kvm_cache_regs.h>
@@ -2094,7 +2095,7 @@ static void vmx_inject_irq(struct kvm_vc
 {
 	struct vcpu_vmx *vmx = to_vmx(vcpu);
 
-	KVMTRACE_1D(INJ_VIRQ, vcpu, (u32)irq, handler);
+	trace_kvm_inj_virq(vcpu, irq);
 
 	if (vcpu->arch.rmode.active) {
 		vmx->rmode.irq.pending = true;
@@ -2252,8 +2253,7 @@ static int handle_exception(struct kvm_v
 		if (vm_need_ept())
 			BUG();
 		cr2 = vmcs_readl(EXIT_QUALIFICATION);
-		KVMTRACE_3D(PAGE_FAULT, vcpu, error_code, (u32)cr2,
-			    (u32)((u64)cr2 >> 32), handler);
+		trace_kvm_page_fault(vcpu, error_code, cr2);
 		return kvm_mmu_page_fault(vcpu, cr2, error_code);
 	}
 
@@ -2282,7 +2282,7 @@ static int handle_external_interrupt(str
 				     struct kvm_run *kvm_run)
 {
 	++vcpu->stat.irq_exits;
-	KVMTRACE_1D(INTR, vcpu, vmcs_read32(VM_EXIT_INTR_INFO), handler);
+	trace_kvm_intr(vcpu);
 	return 1;
 }
 
@@ -2340,10 +2340,7 @@ static int handle_cr(struct kvm_vcpu *vc
 	reg = (exit_qualification >> 8) & 15;
 	switch ((exit_qualification >> 4) & 3) {
 	case 0: /* mov to cr */
-		KVMTRACE_3D(CR_WRITE, vcpu, (u32)cr,
-			    (u32)kvm_register_read(vcpu, reg),
-			    (u32)((u64)kvm_register_read(vcpu, reg) >> 32),
-			    handler);
+		trace_kvm_cr_write(vcpu, cr, reg);
 		switch (cr) {
 		case 0:
 			kvm_set_cr0(vcpu, kvm_register_read(vcpu, reg));
@@ -2371,23 +2368,19 @@ static int handle_cr(struct kvm_vcpu *vc
 		vcpu->arch.cr0 &= ~X86_CR0_TS;
 		vmcs_writel(CR0_READ_SHADOW, vcpu->arch.cr0);
 		vmx_fpu_activate(vcpu);
-		KVMTRACE_0D(CLTS, vcpu, handler);
+		trace_kvm_clts(vcpu);
 		skip_emulated_instruction(vcpu);
 		return 1;
 	case 1: /*mov from cr*/
 		switch (cr) {
 		case 3:
 			kvm_register_write(vcpu, reg, vcpu->arch.cr3);
-			KVMTRACE_3D(CR_READ, vcpu, (u32)cr,
-				    (u32)kvm_register_read(vcpu, reg),
-				    (u32)((u64)kvm_register_read(vcpu, reg) >> 32),
-				    handler);
+			trace_kvm_cr_read(vcpu, cr, reg);
 			skip_emulated_instruction(vcpu);
 			return 1;
 		case 8:
 			kvm_register_write(vcpu, reg, kvm_get_cr8(vcpu));
-			KVMTRACE_2D(CR_READ, vcpu, (u32)cr,
-				    (u32)kvm_register_read(vcpu, reg), handler);
+			trace_kvm_cr_read(vcpu, cr, reg);
 			skip_emulated_instruction(vcpu);
 			return 1;
 		}
@@ -2432,7 +2425,7 @@ static int handle_dr(struct kvm_vcpu *vc
 			val = 0;
 		}
 		kvm_register_write(vcpu, reg, val);
-		KVMTRACE_2D(DR_READ, vcpu, (u32)dr, (u32)val, handler);
+		trace_kvm_dr_read(vcpu, dr, val);
 	} else {
 		/* mov to dr */
 	}
@@ -2456,8 +2449,7 @@ static int handle_rdmsr(struct kvm_vcpu 
 		return 1;
 	}
 
-	KVMTRACE_3D(MSR_READ, vcpu, ecx, (u32)data, (u32)(data >> 32),
-		    handler);
+	trace_kvm_msr_read(vcpu, ecx, data);
 
 	/* FIXME: handling of bits 32:63 of rax, rdx */
 	vcpu->arch.regs[VCPU_REGS_RAX] = data & -1u;
@@ -2472,8 +2464,7 @@ static int handle_wrmsr(struct kvm_vcpu 
 	u64 data = (vcpu->arch.regs[VCPU_REGS_RAX] & -1u)
 		| ((u64)(vcpu->arch.regs[VCPU_REGS_RDX] & -1u) << 32);
 
-	KVMTRACE_3D(MSR_WRITE, vcpu, ecx, (u32)data, (u32)(data >> 32),
-		    handler);
+	trace_kvm_msr_write(vcpu, ecx, data);
 
 	if (vmx_set_msr(vcpu, ecx, data) != 0) {
 		kvm_inject_gp(vcpu, 0);
@@ -2500,7 +2491,7 @@ static int handle_interrupt_window(struc
 	cpu_based_vm_exec_control &= ~CPU_BASED_VIRTUAL_INTR_PENDING;
 	vmcs_write32(CPU_BASED_VM_EXEC_CONTROL, cpu_based_vm_exec_control);
 
-	KVMTRACE_0D(PEND_INTR, vcpu, handler);
+	trace_kvm_pend_intr(vcpu);
 
 	/*
 	 * If the user space waits to inject interrupts, exit as soon as
@@ -2680,8 +2671,7 @@ static int kvm_handle_exit(struct kvm_ru
 	struct vcpu_vmx *vmx = to_vmx(vcpu);
 	u32 vectoring_info = vmx->idt_vectoring_info;
 
-	KVMTRACE_3D(VMEXIT, vcpu, exit_reason, (u32)kvm_rip_read(vcpu),
-		    (u32)((u64)kvm_rip_read(vcpu) >> 32), entryexit);
+	trace_kvm_vmexit(vcpu, exit_reason);
 
 	/* Access CR3 don't cause VMExit in paging mode, so we need
 	 * to sync with guest real CR3. */
@@ -3037,7 +3027,7 @@ static void vmx_vcpu_run(struct kvm_vcpu
 	/* We need to handle NMIs before interrupts are enabled */
 	if ((intr_info & INTR_INFO_INTR_TYPE_MASK) == 0x200 &&
 	    (intr_info & INTR_INFO_VALID_MASK)) {
-		KVMTRACE_0D(NMI, vcpu, handler);
+		trace_kvm_nmi(vcpu);
 		asm("int $2");
 	}
 
arch/x86/kvm/x86.c +14 -29

110 lines not on this page · raw message

include/trace/kvm.h new file +83 -0

83 lines not on this page · raw message

virt/kvm/kvm_trace.c +287 -49

402 lines not on this page · raw message

Signature · 3 lines
Mathieu Desnoyers
Computer Engineering Ph.D. Student, Ecole Polytechnique de Montreal
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#5 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 16 lines · Mathieu Desnoyers

Port/cleanup of KVM-trace to tracepoints.

Tracepoints allow dormat instrumentation, like the kernel markers, but also allows to describe the trace points in global headers so they can be easily managed. They also do not use format strings.

Anything that would involve an action (dereference a pointer, vmcs read, ...) only required when tracing is placed in the probes created in kvm_trace.c

This patch depends on the "Tracepoints" patch.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
Quoted 6 lines
---
 arch/x86/kvm/vmx.c   |   38 ++---
 arch/x86/kvm/x86.c   |   43 ++----
 include/trace/kvm.h  |   83 ++++++++++++
 virt/kvm/kvm_trace.c |  336 +++++++++++++++++++++++++++++++++++++++++++--------
 4 files changed, 398 insertions(+), 102 deletions(-)

Is it a specific property of KVM-trace that causes this LOC blow-up? Or is this a generic side-effect of tracepoints?

[ Hmm, hope I didn't missed too much of the tracepoint discussion... ]

Jan

Signature · 2 lines
Siemens AG, Corporate Technology, CT SE 2
Corporate Competence Center Embedded Linux
#6 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 24 lines · * Jan Kiszka ([email protected]) wrote:
Quoted 16 lines · Mathieu Desnoyers

Port/cleanup of KVM-trace to tracepoints.

Tracepoints allow dormat instrumentation, like the kernel markers, but also allows to describe the trace points in global headers so they can be easily managed. They also do not use format strings.

Anything that would involve an action (dereference a pointer, vmcs read, ...) only required when tracing is placed in the probes created in kvm_trace.c

This patch depends on the "Tracepoints" patch.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
Quoted 6 lines
---
 arch/x86/kvm/vmx.c   |   38 ++---
 arch/x86/kvm/x86.c   |   43 ++----
 include/trace/kvm.h  |   83 ++++++++++++
 virt/kvm/kvm_trace.c |  336 +++++++++++++++++++++++++++++++++++++++++++--------
 4 files changed, 398 insertions(+), 102 deletions(-)
Quoted 5 lines

Is it a specific property of KVM-trace that causes this LOC blow-up? Or is this a generic side-effect of tracepoints?

[ Hmm, hope I didn't missed too much of the tracepoint discussion... ]

This LOC blow-up is caused by the creation of one probe per instrumentation site. So instead of placing the argument setup of everything that goes in the trace (0 to 5 u32 arguments) in the kvm code, it can be placed separately in a probe object, which could eventually be a dynamically loadable module.

The primary objective of tracepoints is to make sure the kernel code does not become harder to read because of added instrumentation and to provide type-checking at compile-time without needing to put format strings into the kernel code, which, to some, looks like debugging code. The other aspect it try to address is maintainability of trace points :
it's much easier to look at all the prototype definitions in include/trace/*.h and to manage them (and external tracers which would like to connect on those points) than to try to figure out in which C files tracing statements has been hidden. We can think of it as a standard tracing API providing a more or less stable list of kernel tracepoints.

So, while KVMTRACE_?D() statements suits closely kvm-trace specificities, it's useless to impose constraints such as splitting unsigned longs into two u32 for tracers which can support a wider variety of data types.

After refactoring the patch to put the probes in arch/x86/kvm, the result is :

 arch/x86/kvm/Makefile           |    1
 arch/x86/kvm/kvm_trace_probes.c |  251 ++++++++++++++++++++++++++++++++++++++++
 arch/x86/kvm/vmx.c              |   38 ++----
 arch/x86/kvm/x86.c              |   43 ++----
 include/asm-x86/kvm_host.h      |    8 +
 include/trace/kvm.h             |   83 +++++++++++++
 virt/kvm/kvm_trace.c            |   93 ++++++--------
 7 files changed, 414 insertions(+), 103 deletions(-)

So actually, is it better to have less LOC which looks like this :

        KVMTRACE_5D(CPUID, vcpu, function,
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RAX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RBX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RCX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RDX), handler);

or more LOC looking like this :

include/trace/kvm.h:
DEFINE_TRACE(kvm_cpuid,
TPPROTO(struct kvm_vcpu *vcpu, u32 function), TPARGS(vcpu, function));

arch/x86/kvm/x86.c:

        trace_kvm_cpuid(vcpu, function);

arch/x86/kvm/kvm_trace_probes.c:
static void probe_kvm_cpuid(struct kvm_vcpu *vcpu, u32 function)

{
        kvm_add_trace(KVM_TRC_CPUID, vcpu, 5,
                (u32 []){ function,
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RAX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RBX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RCX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RDX) });
}

int register_kvm_tracepoints(void)
{
...
ret = register_trace_kvm_cpuid(probe_kvm_cpuid); WARN_ON(ret);
...
}

void unregister_kvm_tracepoints(void)
{
...
unregister_trace_kvm_cpuid(probe_kvm_cpuid);
...
}

?

Notice that only a single line of code is inserted to the kernel code, while all the rest sits outsite in a separated probe module. So I think it's very important to distinguish between LOC which impair kernel code readability and LOC which sit in their own sandbox.

Mathieu

Quoted 5 lines

Jan

Signature · 2 lines
Siemens AG, Corporate Technology, CT SE 2
Corporate Competence Center Embedded Linux
Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#7 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 110 lines · Mathieu Desnoyers
Quoted 23 lines · * Jan Kiszka ([email protected]) wrote:
Quoted 16 lines · Mathieu Desnoyers

Port/cleanup of KVM-trace to tracepoints.

Tracepoints allow dormat instrumentation, like the kernel markers, but also allows to describe the trace points in global headers so they can be easily managed. They also do not use format strings.

Anything that would involve an action (dereference a pointer, vmcs read, ...) only required when tracing is placed in the probes created in kvm_trace.c

This patch depends on the "Tracepoints" patch.

CC 'Peter Zijlstra' <[email protected]>
CC 'Feng(Eric) Liu' <[email protected]>
CC Avi Kivity <[email protected]>
Quoted 6 lines
---
 arch/x86/kvm/vmx.c   |   38 ++---
 arch/x86/kvm/x86.c   |   43 ++----
 include/trace/kvm.h  |   83 ++++++++++++
 virt/kvm/kvm_trace.c |  336 +++++++++++++++++++++++++++++++++++++++++++--------
 4 files changed, 398 insertions(+), 102 deletions(-)
Quoted 5 lines

Is it a specific property of KVM-trace that causes this LOC blow-up? Or is this a generic side-effect of tracepoints?

[ Hmm, hope I didn't missed too much of the tracepoint discussion... ]

This LOC blow-up is caused by the creation of one probe per instrumentation site. So instead of placing the argument setup of everything that goes in the trace (0 to 5 u32 arguments) in the kvm code, it can be placed separately in a probe object, which could eventually be a dynamically loadable module.

The primary objective of tracepoints is to make sure the kernel code does not become harder to read because of added instrumentation and to provide type-checking at compile-time without needing to put format strings into the kernel code, which, to some, looks like debugging code. The other aspect it try to address is maintainability of trace points :
it's much easier to look at all the prototype definitions in include/trace/*.h and to manage them (and external tracers which would like to connect on those points) than to try to figure out in which C files tracing statements has been hidden. We can think of it as a standard tracing API providing a more or less stable list of kernel tracepoints.

So, while KVMTRACE_?D() statements suits closely kvm-trace specificities, it's useless to impose constraints such as splitting unsigned longs into two u32 for tracers which can support a wider variety of data types.

After refactoring the patch to put the probes in arch/x86/kvm, the result is :

 arch/x86/kvm/Makefile           |    1
 arch/x86/kvm/kvm_trace_probes.c |  251 ++++++++++++++++++++++++++++++++++++++++
 arch/x86/kvm/vmx.c              |   38 ++----
 arch/x86/kvm/x86.c              |   43 ++----
 include/asm-x86/kvm_host.h      |    8 +
 include/trace/kvm.h             |   83 +++++++++++++
 virt/kvm/kvm_trace.c            |   93 ++++++--------
 7 files changed, 414 insertions(+), 103 deletions(-)

So actually, is it better to have less LOC which looks like this :

        KVMTRACE_5D(CPUID, vcpu, function,
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RAX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RBX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RCX),
                    (u32)kvm_register_read(vcpu, VCPU_REGS_RDX), handler);

or more LOC looking like this :

include/trace/kvm.h:
DEFINE_TRACE(kvm_cpuid,
TPPROTO(struct kvm_vcpu *vcpu, u32 function), TPARGS(vcpu, function));

arch/x86/kvm/x86.c:

        trace_kvm_cpuid(vcpu, function);

arch/x86/kvm/kvm_trace_probes.c:
static void probe_kvm_cpuid(struct kvm_vcpu *vcpu, u32 function)

{
        kvm_add_trace(KVM_TRC_CPUID, vcpu, 5,
                (u32 []){ function,
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RAX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RBX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RCX),
                        (u32)kvm_register_read(vcpu, VCPU_REGS_RDX) });
}

int register_kvm_tracepoints(void)

{
   ...
   ret = register_trace_kvm_cpuid(probe_kvm_cpuid);
   WARN_ON(ret);
   ...
}

void unregister_kvm_tracepoints(void)

{
   ...
   unregister_trace_kvm_cpuid(probe_kvm_cpuid);
   ...
}
Quoted 6 lines

?

Notice that only a single line of code is inserted to the kernel code, while all the rest sits outsite in a separated probe module. So I think it's very important to distinguish between LOC which impair kernel code readability and LOC which sit in their own sandbox.

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Jan

Signature · 2 lines
Siemens AG, Corporate Technology, CT SE 2
Corporate Competence Center Embedded Linux
#8 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 7 lines · Jan Kiszka

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Tracepoints aren't stable; they are artefacts of the implementation.

Signature · 2 lines
I have a truly marvellous patch that fixes the bug which this
signature is too narrow to contain.
#9 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 10 lines · Avi Kivity
Quoted 7 lines · Jan Kiszka

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Tracepoints aren't stable; they are artefacts of the implementation.

Which IMHO makes it unsuitable for trace_mark() as that will be exported to user-space, and every time you change your tracepoints you'll change user visible things - not nice.

#10 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 12 lines · Peter Zijlstra
Quoted 10 lines · Avi Kivity
Quoted 8 lines · Jan Kiszka

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Quoted 7 lines
Quoted 2 lines

Tracepoints aren't stable; they are artefacts of the implementation.

Which IMHO makes it unsuitable for trace_mark() as that will be exported to user-space, and every time you change your tracepoints you'll change user visible things - not nice.

They are used for debugging (mostly performance related), so changes are expected.

What uses of trace_mark() depend on a stable interface? blktrace?

Signature · 1 line
error compiling committee.c: too many arguments to function
#11 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 21 lines · Avi Kivity
Quoted 12 lines · Peter Zijlstra
Quoted 10 lines · Avi Kivity
Quoted 8 lines · Jan Kiszka

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Quoted 7 lines
Quoted 2 lines

Tracepoints aren't stable; they are artefacts of the implementation.

Which IMHO makes it unsuitable for trace_mark() as that will be exported to user-space, and every time you change your tracepoints you'll change user visible things - not nice.

Quoted 4 lines

They are used for debugging (mostly performance related), so changes are expected.

What uses of trace_mark() depend on a stable interface? blktrace?

There are currently no trace_mark() sites in the kernel that I'm aware of (except for the scheduler :-/, and those should be converted to tracepoints ASAP).

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

What that means is that trace_mark() can only be used for really stable points.

This in turn means we might as well use trace points.

Which allows for the conclusion that trace_mark() is not needed and could be removed from the kernel.

However - it might be handy for ad-hoc debugging purposes that never see the light of day (linus' git tree in this case). So on those grounds one could argue against removing trace_mark.

#12 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 11 lines · Peter Zijlstra

There are currently no trace_mark() sites in the kernel that I'm aware of (except for the scheduler :-/, and those should be converted to tracepoints ASAP).

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

What that means is that trace_mark() can only be used for really stable points.

Quoted 8 lines

This in turn means we might as well use trace points.

Which allows for the conclusion that trace_mark() is not needed and could be removed from the kernel.

However - it might be handy for ad-hoc debugging purposes that never see the light of day (linus' git tree in this case). So on those grounds one could argue against removing trace_mark

But trace_mark() is so wonderful. Can't we just declare the tracemarks as a non-stable interface?

Perhaps add an unstable_trace_mark() to make it clear.

Signature · 1 line
error compiling committee.c: too many arguments to function
#13 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 14 lines · Avi Kivity
Quoted 13 lines · Peter Zijlstra

There are currently no trace_mark() sites in the kernel that I'm aware of (except for the scheduler :-/, and those should be converted to tracepoints ASAP).

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

What that means is that trace_mark() can only be used for really stable points.

This in turn means we might as well use trace points.

Quoted 8 lines
Quoted 6 lines

Which allows for the conclusion that trace_mark() is not needed and could be removed from the kernel.

However - it might be handy for ad-hoc debugging purposes that never see the light of day (linus' git tree in this case). So on those grounds one could argue against removing trace_mark

But trace_mark() is so wonderful.

I guess tastes differ...

Quoted 4 lines

Can't we just declare the tracemarks
as a non-stable interface?

Perhaps add an unstable_trace_mark() to make it clear.

At the very least it would need its own output channel. But I'm afraid this will be KS material.

#14 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 26 lines · * Peter Zijlstra ([email protected]) wrote:
Quoted 14 lines · Avi Kivity
Quoted 13 lines · Peter Zijlstra

There are currently no trace_mark() sites in the kernel that I'm aware of (except for the scheduler :-/, and those should be converted to tracepoints ASAP).

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

What that means is that trace_mark() can only be used for really stable points.

This in turn means we might as well use trace points.

Quoted 8 lines
Quoted 6 lines

Which allows for the conclusion that trace_mark() is not needed and could be removed from the kernel.

However - it might be handy for ad-hoc debugging purposes that never see the light of day (linus' git tree in this case). So on those grounds one could argue against removing trace_mark

But trace_mark() is so wonderful.

I guess tastes differ...

Quoted 8 lines
Quoted 4 lines

Can't we just declare the tracemarks
as a non-stable interface?

Perhaps add an unstable_trace_mark() to make it clear.

At the very least it would need its own output channel. But I'm afraid this will be KS material.

Hi Peter,

Currently what I have in LTTng includes this output channel. It works for me, but if I can make it work for others that would be great.

- Tracepoints in kernel code to instrument the kernel.
- LTTng probes connect on those relatively stable tracepoints. They format the data so it's meaningful to userspace (e.g. extracts the pid of the prev and next process at sched_switch).
- The LTTng serializer is connected on those markers. It parses the format string to dynamically reserve space in the relay buffer, write a timestamp and event ID (one event ID is pre-assigned to a marker name) and copy the arguments from the stack to the event record (which has a variable size).

Event IDs and timestamps are added by LTTng, thus not required by markers. However, one can think of this flow as an efficient and compact binary data export mechanism to userspace.

Headers exports data type sizes and endianness, a special data channel exports the mappings between { marker name, ID, format string } so events are self-described. Therefore, one can add any event he likes and it will be automatically understood by the tracing toolchain.

If an event is removed or filtered out or modified (by changing its field name), the userspace trace analyser will detect it and the specific probe which expects this event will fail to load, leading to missing analyses, but nothing more than that.

So currently what we would have is, more or less : trace_marks located within LTTng are kept in sync with userland, but the whole chain also allows to add "debug-style" trace_marks directly in the kernel code (this is really useful when trying to perform a low-impact printk-like runtime bissection of a bug in the kernel code.

I actually see the trace_marks/LTTng combination as a printk which would extract information in its binary form instead of using text-formatting. The actual formatting can then be done later, in userland, if ever needed (many analyses use the raw binary format directly). I guess KS would be a good opportunity to discuss this interface topic.

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#15 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

In reply to Peter Zijlstra
Quoted 3 lines · Peter Zijlstra

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

I'm not sure why this comes up again and again, but it's utter bullshit. trace_mark does not generate any kind of user interface, just purely a kernel internal interface.

#16 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 11 lines · Christoph Hellwig
Quoted 4 lines · Peter Zijlstra

Andrew raised the whole point about trace_mark() generating an user-visible interface and thus it should be stable, and I agree with that.

I'm not sure why this comes up again and again, but it's utter bullshit. trace_mark does not generate any kind of user interface, just purely a kernel internal interface.

trace_mark() is implement kvmtrace, which is propagated to userspace. So while trace_mark() itself is not a userspace interface, one of its users is.

It's an unstable interface. But so is dmesg; that's the nature of tracing.

Signature · 1 line
error compiling committee.c: too many arguments to function
#17 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 5 lines · Avi Kivity

trace_mark() is implement kvmtrace, which is propagated to userspace. So while trace_mark() itself is not a userspace interface, one of its users is.

It's an unstable interface. But so is dmesg; that's the nature of tracing.

Trace_mark is as stable as any other kernel interface, and the data you pass through it is as stable as you want it to. In most cases like kvmtrace or my spu scheduler tracing code the trace data is directly forwarded through a userspace interface, and that is as stable as any freeform interface, e.g. as like printk mentioned above.

#18 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

In reply to Avi Kivity
Quoted 20 lines · * Avi Kivity ([email protected]) wrote:
Quoted 11 lines · Peter Zijlstra
Quoted 9 lines · Avi Kivity
Quoted 7 lines · Jan Kiszka

That's true - as long as you don't have to add/remove/modify tracepoints. I had to do this job in the past (not for KVM). Having 1 spot in 1 file (based on generic probes) would be handier in that case than 5 spots in 3 files. But if the KVM tracepoints are considered stable in their number and structure, that shouldn't be an issue here.

Quoted 7 lines
Quoted 2 lines

Tracepoints aren't stable; they are artefacts of the implementation.

Which IMHO makes it unsuitable for trace_mark() as that will be exported to user-space, and every time you change your tracepoints you'll change user visible things - not nice.

Quoted 5 lines

They are used for debugging (mostly performance related), so changes are expected.

What uses of trace_mark() depend on a stable interface? blktrace?

Actually, LTTng likes to have the { marker name, field name } pairs unchanged for the markers it looks for, but that's about it. If a userspace analysis plugin fails to see a marker (because it is disabled or changed), it just does not apply its particular analysis on the trace.

Since the markers and marker types are self-described in the trace, userspace can detect any change the the present markers, so there is no need to rely on "version numbers" because we are able to proceed to a complete marker list verification (names, field names, types) before starting the trace analysis.

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#19 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

In reply to Mathieu Desnoyers

Hi Mathieu,

It's difficult to review your patches because they aren't inlined.

At any rate, this patches are unusable with SVM. They try to execute VT instructions unconditionally. For instance, you changed:

arch/x86/kvm/vmx.c static int handle_external_interrupt(str · line 2285

Quoted 3 lines
arch/x86/kvm/vmx.c +1 -1
-    KVMTRACE_1D(INTR, vcpu, vmcs_read32(VM_EXIT_INTR_INFO), handler);
+    trace_kvm_intr(vcpu);

Which lived in VT-specific code (vmx.c)

To:

virt/kvm/kvm_trace.c int kvm_trace_ioctl(unsigned int ioctl, · line 412

Quoted 6 lines
virt/kvm/kvm_trace.c +6 -0
+static void probe_kvm_intr(struct kvm_vcpu *vcpu)
+{
+    kvm_add_trace(KVM_TRC_INTR, vcpu, 1,
+        (u32 []){ vmcs_read32(VM_EXIT_INTR_INFO) });
+}
+

Which lives in common code (kvm_trace.c). But vmcs_read32() is VT-specific and should not be used in common code so this motion is wrong. Why not just pass more arguments to probe_kvm_intr()? Then your first two patches can be dropped completely.

Regards,

Anthony Liguori

Mathieu Desnoyers wrote:

#20 lore raw

Re: [patch 4/4] KVM-trace port to tracepoints

Quoted 2 lines · * Anthony Liguori ([email protected]) wrote:

Hi Mathieu,

Hi Anthony,

Quoted 12 lines

It's difficult to review your patches because they aren't inlined.

At any rate, this patches are unusable with SVM. They try to execute VT instructions unconditionally. For instance, you changed:

arch/x86/kvm/vmx.c static int handle_external_interrupt(str · line 2285

Quoted 3 lines
arch/x86/kvm/vmx.c +1 -1
-    KVMTRACE_1D(INTR, vcpu, vmcs_read32(VM_EXIT_INTR_INFO), handler);
+    trace_kvm_intr(vcpu);

Which lived in VT-specific code (vmx.c)

To:

Quoted 12 lines

virt/kvm/kvm_trace.c int kvm_trace_ioctl(unsigned int ioctl, · line 412

Quoted 6 lines
virt/kvm/kvm_trace.c +6 -0
+static void probe_kvm_intr(struct kvm_vcpu *vcpu)
+{
+    kvm_add_trace(KVM_TRC_INTR, vcpu, 1,
+        (u32 []){ vmcs_read32(VM_EXIT_INTR_INFO) });
+}
+

Which lives in common code (kvm_trace.c). But vmcs_read32() is VT-specific and should not be used in common code so this motion is wrong. Why not just pass more arguments to probe_kvm_intr()? Then your first two patches can be dropped completely.

Yes, I just noticed that I made a small mistake : the probe code should actually go in arch/x86/kvm/kvm_trace_probes.c, which is x86-specific.

The reason why I would try to move the vmcs_read32(VM_EXIT_INTR_INFO) to the probe code is because, unlike the Markers, when a function call with potential side-effects is put within the arguments, it's really an argument to a static inline function. In the markers, since it was a parameter passed to a macro, I could shuffle it into the branch and it would not be executed when markers were disabled.

However, we don't have this with tracepoints.

kvm-move-register-read-write-to-system-headers.patch becomes obsolete since I put the probe code in arch/x86/kvm/.

But it would still be required to move vmcs read and encodings to headers, either to include/asm-x86 or arch/x86/kvm.

Mathieu

Quoted 5 lines

Regards,

Anthony Liguori

Mathieu Desnoyers wrote:

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#21 lore raw
In reply to Mathieu Desnoyers
Quoted 10 lines · Mathieu Desnoyers

Hi,

Here is a port of KVM-trace, currently using macros on top of the Linux Markers, to tracepoints. Note that I cleaned up the instrumentation too, so stuff like

KVMTRACE_3D(CR_WRITE, vcpu, (u32)cr,
(u32)kvm_register_read(vcpu, reg),
(u32)((u64)kvm_register_read(vcpu, reg) >> 32),
handler);

Quoted 9 lines

Sprinkled all across the KVM C code becomes :

trace_kvm_cr_write(vcpu, cr, reg);

Which looks much nicer, IMHO.

It applies on top of linux-next patch-v2.6.26-next-20080715.

It does look nicer; but it means maintaining tracepoints becomes much harder, because the information is scattered across many files.

kvm tracepoints are heavily tied into the implementation; and making them harder to write means we will have less information. In fact, I am contemplating moving in another direction (when looking at the pgprintk()s scattered around arch/x86/kvm/mmu.c:

kvm_trace("pfentry", "page_fault entry addr %lx error code %x\n",
cr2, error_code);

Unlike printk()s, no actual formatting would occur during runtime. Instead, at initialization time all the strings would be parsed into a data structure that describes the data types, and the runtime would simply consult this structure and copy the arguments into trace records. User space would also be able to pull this structure and so recreate the formatted string.

The advantages I see to this are:

- easy to add traces; the most important advantage
- when the code changes, obsolete traces are completely removed
- good performance
- no need to have a formats file in userspace (which is tied to the
kernel version)
- can also send printk()s along, for synchronization with other kvm
and kernel events

In fact, why not convert printk() to do this, making it a high-performance logging system? Of course it would retain the dmesg interface, but we could say that messages at the KERN_TRACE level bypass dmesg and only go to the trace system.

Signature · 2 lines
I have a truly marvellous patch that fixes the bug which this
signature is too narrow to contain.
#22 lore raw
Quoted 10 lines · Avi Kivity

[...]
kvm tracepoints are heavily tied into the implementation; and making them harder to write means we will have less information. In fact, I am contemplating moving in another direction (when looking at the pgprintk()s scattered around arch/x86/kvm/mmu.c:

kvm_trace("pfentry", "page_fault entry addr %lx error code %x\n",
cr2, error_code);

Unlike printk()s, no actual formatting would occur during runtime.

Have you considered using trace_mark() directly - eliminating the KVM_TRACEN() middlemen?

Quoted 5 lines

Instead, at initialization time all the strings would be parsed into a data structure that describes the data types, and the runtime would simply consult this structure and copy the arguments into trace records. User space would also be able to pull this structure and so recreate the formatted string.

If one really wanted to, one could build such a mechanism on top of marker-based callbacks.

Quoted 5 lines

The advantages I see to this are:

- easy to add traces; the most important advantage
- when the code changes, obsolete traces are completely removed
- good performance

Ditto.

Quoted 2 lines

- no need to have a formats file in userspace (which is tied to the
kernel version)

OTOH, you'd have the kernel collecting compact binary records containing just the parameters, which are at least as tied to kernel version.

Quoted 2 lines

- can also send printk()s along, for synchronization with other kvm
and kernel events

Ditto. It is elementary to attach a printk-generating marker callback.

- FChE

#23 lore raw
Quoted 9 lines · Frank Ch. Eigler
Quoted 6 lines · Avi Kivity

[...]
kvm tracepoints are heavily tied into the implementation; and making them harder to write means we will have less information. In fact, I am contemplating moving in another direction (when looking at the pgprintk()s scattered around arch/x86/kvm/mmu.c:

Quoted 10 lines
Quoted 5 lines

kvm_trace("pfentry", "page_fault entry addr %lx error code %x\n",
cr2, error_code);

Unlike printk()s, no actual formatting would occur during runtime.

Have you considered using trace_mark() directly - eliminating the KVM_TRACEN() middlemen?

Eliminating KVM_TRACEN -- yes. There are too many of them, they aren't type-aware, and they're in uppercase.

Using trace_mark() directly -- looking at it, seems to fit the requirements exactly. Should have looked at it earlier. Is there a way to get a list of all markers?

Perhaps the kvmtrace marker->relay integration should be made a marker feature, since there is nothing specific to kvm in it.

Quoted 11 lines
Quoted 6 lines

Instead, at initialization time all the strings would be parsed into a data structure that describes the data types, and the runtime would simply consult this structure and copy the arguments into trace records. User space would also be able to pull this structure and so recreate the formatted string.

If one really wanted to, one could build such a mechanism on top of marker-based callbacks.

One does want to.

Quoted 9 lines
Quoted 3 lines

- no need to have a formats file in userspace (which is tied to the
kernel version)

OTOH, you'd have the kernel collecting compact binary records containing just the parameters, which are at least as tied to kernel version.

Yes, but the userspace side would collect the format strings as well (just once) and could put them in the same file. The aggregation is portable across kernel versions.

Signature · 2 lines
I have a truly marvellous patch that fixes the bug which this
signature is too narrow to contain.
#24 lore raw
Quoted 9 lines · Avi Kivity

[...]

Quoted 2 lines

Have you considered using trace_mark() directly - eliminating the KVM_TRACEN() middlemen?

[...]
Using trace_mark() directly -- looking at it, seems to fit the requirements exactly. Should have looked at it earlier. Is there a way to get a list of all markers?

From kernel-space, I can't find just now an API for listing them, but

there probably is / could be one.

Quoted 1 line

From user-space, lttng tools can probably do it. systemtap can too:

     % stap -l 'kernel.mark("*")'

You could prototype binary tracing thusly:

     % stap -e 'probe kernel.mark("kvm_foobar") { 
         printf("%4b%4b%4b", # three 4-byte ints
                cpu(), $arg1, $arg2)
       }'
Quoted 2 lines

Perhaps the kvmtrace marker->relay integration should be made a marker feature, since there is nothing specific to kvm in it.

Right, I believe something like that is in the lttng patch suite.

- FChE

#25 lore raw

Re: [patch 0/4] Port KVM-trace to tracepoints -> LTTng ?

In reply to Avi Kivity
Quoted 55 lines · * Avi Kivity ([email protected]) wrote:
Quoted 9 lines · Frank Ch. Eigler
Quoted 6 lines · Avi Kivity

[...]
kvm tracepoints are heavily tied into the implementation; and making them harder to write means we will have less information. In fact, I am contemplating moving in another direction (when looking at the pgprintk()s scattered around arch/x86/kvm/mmu.c:

Quoted 10 lines
Quoted 5 lines

kvm_trace("pfentry", "page_fault entry addr %lx error code %x\n",
cr2, error_code);

Unlike printk()s, no actual formatting would occur during runtime.

Have you considered using trace_mark() directly - eliminating the KVM_TRACEN() middlemen?

Eliminating KVM_TRACEN -- yes. There are too many of them, they aren't type-aware, and they're in uppercase.

Using trace_mark() directly -- looking at it, seems to fit the requirements exactly. Should have looked at it earlier. Is there a way to get a list of all markers?

Perhaps the kvmtrace marker->relay integration should be made a marker feature, since there is nothing specific to kvm in it.

Quoted 11 lines
Quoted 6 lines

Instead, at initialization time all the strings would be parsed into a data structure that describes the data types, and the runtime would simply consult this structure and copy the arguments into trace records. User space would also be able to pull this structure and so recreate the formatted string.

If one really wanted to, one could build such a mechanism on top of marker-based callbacks.

One does want to.

Quoted 9 lines
Quoted 3 lines

- no need to have a formats file in userspace (which is tied to the
kernel version)

OTOH, you'd have the kernel collecting compact binary records containing just the parameters, which are at least as tied to kernel version.

Quoted 4 lines

Yes, but the userspace side would collect the format strings as well (just once) and could put them in the same file. The aggregation is portable across kernel versions.

Yes,

LTTng does exactly all that.

Please have a look at the current LTTng patchset :

http://ltt.polymtl.ca/lttng/patch-2.6.26-0.11.tar.bz2

The interface to list markers is currently found in /proc/ltt

Commands like :

cat /proc/ltt (list markers)
And echo -n "connect marker_name default dynamic channel_name"

See the script ltt-armall.sh in the package :

http://ltt.polymtl.ca/lttng/ltt-control-0.50-17072008.tar.gz

To see how to arm all markers listed.

General information (compatibility list and quickstart guide are available at http://ltt.polymtl.ca). Packages also useful : lttv (trace analyser, including text dump, filtering, gui...) and a userspace marker package (only supports x86 32/64 currently).

All these packages support any kind of custom markers, because the marker names/types are listed in the "facilities_*" control tracefile at trace start, so the traces are self-described. I also list other stuff (memory maps, irq handler names, system call handler names) at trace start so we can dynamically have these mapping, independently of the architecture.

See :
http://ltt.polymtl.ca/packages/lttv-0.10.0-pre14-17072008.tar.gz
http://ltt.polymtl.ca/packages/markers-userspace-0.5.tar.bz2

I'll be more than happy to answer your questions.

Mathieu

Quoted 4 lines
Signature · 2 lines
I have a truly marvellous patch that fixes the bug which this
signature is too narrow to contain.
Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#26 lore raw

Re: [patch 0/4] Port KVM-trace to tracepoints -> LTTng ?

Quoted 10 lines · Mathieu Desnoyers
Quoted 3 lines

Yes, but the userspace side would collect the format strings as well (just once) and could put them in the same file. The aggregation is portable across kernel versions.

Yes,

LTTng does exactly all that.

[snip goodies]

Quoted 2 lines

I'll be more than happy to answer your questions.

What's the merge plan for this?

Signature · 1 line
error compiling committee.c: too many arguments to function
#27 lore raw

[RFC] LTTng merge plan

Quoted 16 lines · * Avi Kivity ([email protected]) wrote:
Quoted 6 lines · Mathieu Desnoyers
Quoted 5 lines

Yes, but the userspace side would collect the format strings as well (just once) and could put them in the same file. The aggregation is portable across kernel versions.

Quoted 6 lines

Yes,

LTTng does exactly all that.

Quoted 7 lines

[snip goodies]

Quoted 2 lines

I'll be more than happy to answer your questions.

What's the merge plan for this?

Hi Avi,

Thanks for asking. Given the amount of expectation from kernel developers, distributions and users I have seen for kernel tracing at this year's OLS, I think giving a detailed merge plan for my LTTng work is appropriate.

Currently, it looks like :

In Ingo's trees :
- Tracepoints, scheduler tracepoints instrumentation, ftrace port to tracepoints
- Should make it into 2.6.27 since ftrace needs those.
- Immediate Values (faster branch based on load immediate instruction) Useful for markers and tracepoints, but can also be used for any compiled-in code that has to be dynamically enabled.
- Aims at 2.6.28
- Text Edit Lock : protection of kernel text modification with a mutex. Synchronises kprobes and immediate values.
- Aims at 2.6.28

Short-term submission plan

In LTTng patchset
(http://ltt.polymtl.ca/lttng/patch-2.6.26-0.12.tar.bz2)

- Instrumentation
- LTTng tracepoints
- Used by LTTng, SystemTAP and usable specialized probes.
- Port specific sets of tracepoints along with their current users
- ftrace (port currently in Ingo's tree), KVM trace, blktrace.

- Data extraction
- LTTng timestamping
- Based on the CPU cycle counter when synchronized across CPUs.
- Fallback on a simple cache-bouncing atomic counter if no synchronized fast time source is available. Basically, the idea is that having the correct event _order_ is more important than having an approximate time, because this "timestamp" is used to reorder events which are written in per-CPU buffers. Time updates can always be recorded as an event in the trace to get an idea of the kernel time flow.
- LTTng trace management
- netlink interface to start/stop tracing and set the buffer sizes.
- Supports multiple channels (high/medium/low event rate). Metadata (marker types, list of interrupt handlers...) can be exported in low event rate channels.
- Supports flight recorder mode (overwriting oldest buffer data), normal mode (writes to disk, drops events if buffer is full) or hybrid, or mixed, mode, where the high event rate buffers only are in flight recorder mode.
- Data relay
- Atomic buffering mechanism which does not call into kernel primitives except preempt disable. Only touches variables atomically, does not use any lock. Aims at having minimal intrusiveness and allowing the largest code coverage (thus not calling kernel code).
- LTTng marker control
- Currently a /proc/ltt interface with read and write operations to list markers and connect LTTng probe to individual markers, specifying in which channel to send the data (I know, should probably belong to /sys instead, comments welcome) It's not part of the core marker infrastructure because it depends both on markers and on the LTTng trace management. It's also responsible for allocating a numeric ID to a marker which is guaranteed to be unique as long as there is at least one active trace.

Medium-term submission plan

In LTTng patchset

- Instrumentation
- Userspace tracing interface
- Allow userspace to declare tracepoints and/or markers
- Provide a data extraction interface to collect the tracing data.
- More work needed in this area.
- LTTng statedump
- Exports the kernel data structures to the trace buffers at trace start. List interrupts, system calls, threads, memory maps, ... It does not use /proc because :
1 - /proc has nasty races which makes the information "generally correct" but not more.
2 - /proc exports the information in text format, which is not as compact as LTTng binary format.

Longer term wishlist
- GCC support for static branch patching
- Improvement on the immediate values for dynamic code activation

A bit more information is available in the slides I just presented at OLS at :

http://ltt.polymtl.ca/slides/desnoyers-talk-ols2008.pdf

I'll gladly answer to questions/comments.

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#28 lore raw

Re: [RFC] LTTng merge plan

Hi, Mathieu -

Quoted 8 lines

[...]
Currently, [my merge plan] looks like :

In Ingo's trees :
- Tracepoints, scheduler tracepoints instrumentation, ftrace port to tracepoints
- Should make it into 2.6.27 since ftrace needs those.
[...]

This is the tracepoints infrastructure, and ...

Quoted 9 lines

Short-term submission plan

In LTTng patchset
(http://ltt.polymtl.ca/lttng/patch-2.6.26-0.12.tar.bz2)

- Instrumentation
- LTTng tracepoints
- Used by LTTng, SystemTAP and usable specialized probes.
[...]

... this is the "meat", which includes both the tracepoints and the the tracepoint-to-marker conversion modules, such as those in "lttng-instrumentation-*-tracepoint-probes.patch", right?

- FChE

#29 lore raw

Re: [RFC] LTTng merge plan

Quoted 23 lines · * Frank Ch. Eigler ([email protected]) wrote:

Hi, Mathieu -

Quoted 8 lines

[...]
Currently, [my merge plan] looks like :

In Ingo's trees :
- Tracepoints, scheduler tracepoints instrumentation, ftrace port to tracepoints
- Should make it into 2.6.27 since ftrace needs those.
[...]

This is the tracepoints infrastructure, and ...

Quoted 9 lines

Short-term submission plan

In LTTng patchset
(http://ltt.polymtl.ca/lttng/patch-2.6.26-0.12.tar.bz2)

- Instrumentation
- LTTng tracepoints
- Used by LTTng, SystemTAP and usable specialized probes.
[...]

Quoted 5 lines

... this is the "meat", which includes both the tracepoints and the the tracepoint-to-marker conversion modules, such as those in "lttng-instrumentation-*-tracepoint-probes.patch", right?

- FChE

Exactly. The tracepoint-to-markers conversion modules bridge between the in-kernel API (tracepoints) which declares standard location for kernel instrumentation and user-space visible "markers", so that there is an indirection level between the instrumented kernel code and what is visible from userspace.

For instance, we have

in kernel/sched.c:context_switch()
trace_sched_switch(rq, prev, next);

Which exports a struct rq * and two struct task_struct *. They are used by both ftrace, which needs access to these data structures, and by the LTTng probes, which extracts the previous PID and state (running, waiting..) and next PID to be scheduled in.

Basically, these modules turn the data exported by tracepoints, meaningful only to kernel modules, into data useful for userspace trace analysis.

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68

A message that is not in the archive (sent off-list or not yet received): [email protected]

#31 lore raw

Re: module-placed markers/tracepoints

Quoted 7 lines · * Frank Ch. Eigler ([email protected]) wrote:

Hi -

Some locals are wondering -- is there code for (or need for new code for) incrementing module reference counts while markers and/or tracepoints resident in modules have active clients?

- FChE

Hi Frank,

Probe module unloading is supposed to be done automatically assuming the following module unload behavior :

1 - Module unload code takes the stop machine lock.
2 - It is assumed that the module exit function is called at that time,
while no preempt-disabled section is executed. This function unregisters the callbacks.
3 - Given that preemption is disabled around tracepoint/marker calls, no
calls are left to a freed module.

Actually, I notice that it might not be the case. I took for granted what (I can't remember who ? Rusty ?) told me about module unload code. If we look at sys_delete_module() :

        /* Stop the machine so refcounts can't move and disable module. */
        ret = try_stop_module(mod, flags, &forced);
        if (ret != 0)
                goto out;

        /* Never wait if forced. */
        if (!forced && module_refcount(mod) != 0)
                wait_for_zero_refcount(mod);

        mutex_unlock(&module_mutex);
        /* Final destruction now noone is using it. */
        if (mod->exit != NULL)
                mod->exit();

So we see that mod->exit(), which I believe is responsible for calling the module exit() functions, is called after the stop_machine, not during the stop machine.

Therefore, what would be needed here is to add a synchronize_sched() after mod->exit() in module.c or after each tracepoint/marker unregister in marker.c/tracepoint.c. However, I'd really prefer to add this to module.c since adding this for _every_ unregister will slow down processing or multiple probe unregistration too much.

Rusty, am I understanding that correctly ?

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#32 lore raw

Re: module-placed markers/tracepoints

Hi -

Quoted 6 lines · Mathieu Desnoyers
Quoted 3 lines

Some locals are wondering -- is there code for (or need for new code for) incrementing module reference counts while markers and/or tracepoints resident in modules have active clients?

Probe module unloading is supposed to be done automatically assuming the following module unload behavior [...]

The question was more that if module-placed markers/tracepoints are armed, is there any mechanism to prevent the modules' unloading. For kprobes, there is.

- FChE

#33 lore raw

Re: module-placed markers/tracepoints

Quoted 7 lines · * Frank Ch. Eigler ([email protected]) wrote:

Hi -

Quoted 4 lines · Mathieu Desnoyers
Quoted 3 lines

Some locals are wondering -- is there code for (or need for new code for) incrementing module reference counts while markers and/or tracepoints resident in modules have active clients?

Quoted 8 lines
Quoted 2 lines

Probe module unloading is supposed to be done automatically assuming the following module unload behavior [...]

The question was more that if module-placed markers/tracepoints are armed, is there any mechanism to prevent the modules' unloading. For kprobes, there is.

- FChE

I see, it's the other way around : declaring a marker/tracepoint in a module.

When you register to a marker/tracepoint, you actually register the probe in a hash table. It will be connected to every placed marker/tracepoint with that given name. Upon module load, markers/tp that match the name are connected, and upon module unload all markers/tp are simply freed by module.c : unlike kprobes, there is no need for the marker/tp infrastructures to keep track of every marker/tp. So we don't need any refcount on the module which has the marker/tp.

However, the probe question is important; I think a synchronize_sched() is missing to handle unload of marker/tp probes modules.

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#34 lore raw

Re: module-placed markers/tracepoints

In reply to Mathieu Desnoyers
Quoted 9 lines · On Wednesday 30 July 2008 08:41:16 Mathieu Desnoyers wrote:

Therefore, what would be needed here is to add a synchronize_sched() after mod->exit() in module.c or after each tracepoint/marker unregister in marker.c/tracepoint.c. However, I'd really prefer to add this to module.c since adding this for _every_ unregister will slow down processing or multiple probe unregistration too much.

Rusty, am I understanding that correctly ?

Mathieu

Hi Mathieu,

Yes: stop_machine is merely used to atomically check the module refcount
for zero and set the state so it can't be incremented again (ie. try_module_get will fail).

So placing a tracepoint or marker in a module does not bump the module
refcount? If that's true, then there needs to be some kind of remove_markers_from_module() call after module->exit(), which should do the synchronize_sched() or whatever, right?

Rusty.

#35 lore raw

PATCH 1/1 Module : call synchronize_sched() between module exit() and free.

Quoted 6 lines

Hi Mathieu,

Yes: stop_machine is merely used to atomically check the module refcount
for zero and set the state so it can't be incremented again (ie. try_module_get will fail).

Quoted 6 lines

So placing a tracepoint or marker in a module does not bump the module
refcount? If that's true, then there needs to be some kind of remove_markers_from_module() call after module->exit(), which should do the synchronize_sched() or whatever, right?

Rusty.

Actually, it's not placing a marker/tracepoint in a module which causes a problem, this is a simple function call after all, and correctly dealt with by current module.c code.

The problem comes from a probe function (the callback) that would be registered to be called from a marker and would sit in an unloadable kernel module. I would not want to tie the refcount of the probe modules to the fact that they are connected to a marker because it would then become impossible to unload them due to the fact that unregistration is done in module exit().

This is one of the reasons why I disable preemption around the marker site (the function call) : to make sure I can can unregister the callback, wait for a quiescent state (with synchronize_sched()) and then free the module memory.

This would give the following supplementary guarantee about module teardown : every function called with preemption off and unregistered in the module exit() would reach a quiescent state before the module is freed. Given this does apply to rarely used code (module unload), I think it might be ok to simply add a call to synchronize_sched() before the module memory is freed. Not tying this to markers/tracepoints would keep the behavior consistant across various build options, which is IMHO a good thing.

I could also just document that a mandatory "synchronize_sched()" should be called at the end of the probe module exit() function which makes sure the probes has reached a quiescent state.

I don't want to add a synchronize_sched() into the marker/tracepoint probe unregistration code because I want to keep batch probe unregistration fast enough so it does no take ~5 seconds to unload ~100 probes. (may take longer on a loaded SMP system)

Mathieu

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#36 lore raw

Re: [PATCH] Module : call synchronize_sched() between module exit() and free.

Quoted 17 lines · On Wednesday 30 July 2008 12:27:51 Mathieu Desnoyers wrote:
Quoted 6 lines

Hi Mathieu,

Yes: stop_machine is merely used to atomically check the module
refcount for zero and set the state so it can't be incremented again (ie. try_module_get will fail).

Quoted 6 lines

So placing a tracepoint or marker in a module does not bump the module
refcount? If that's true, then there needs to be some kind of remove_markers_from_module() call after module->exit(), which should do the synchronize_sched() or whatever, right?

Rusty.

Actually, it's not placing a marker/tracepoint in a module which causes a problem, this is a simple function call after all, and correctly dealt with by current module.c code.

Quoted 6 lines

The problem comes from a probe function (the callback) that would be registered to be called from a marker and would sit in an unloadable kernel module. I would not want to tie the refcount of the probe modules to the fact that they are connected to a marker because it would then become impossible to unload them due to the fact that unregistration is done in module exit().

Hi Mathieu,

Still confused, sorry. Why don't you don't do a synchronize_sched() at
the end of your module's exit routine? "You must be completely finished by the time ->exit() returns" is the rule so far...

Rusty.

#37 lore raw

Re: [PATCH] Module : call synchronize_sched() between module exit() and free.

Quoted 25 lines · * Rusty Russell ([email protected]) wrote:
Quoted 17 lines · On Wednesday 30 July 2008 12:27:51 Mathieu Desnoyers wrote:
Quoted 6 lines

Hi Mathieu,

Yes: stop_machine is merely used to atomically check the module
refcount for zero and set the state so it can't be incremented again (ie. try_module_get will fail).

Quoted 6 lines

So placing a tracepoint or marker in a module does not bump the module
refcount? If that's true, then there needs to be some kind of remove_markers_from_module() call after module->exit(), which should do the synchronize_sched() or whatever, right?

Rusty.

Actually, it's not placing a marker/tracepoint in a module which causes a problem, this is a simple function call after all, and correctly dealt with by current module.c code.

Quoted 6 lines

The problem comes from a probe function (the callback) that would be registered to be called from a marker and would sit in an unloadable kernel module. I would not want to tie the refcount of the probe modules to the fact that they are connected to a marker because it would then become impossible to unload them due to the fact that unregistration is done in module exit().

Quoted 6 lines

Hi Mathieu,

Still confused, sorry. Why don't you don't do a synchronize_sched() at
the end of your module's exit routine? "You must be completely finished by the time ->exit() returns" is the rule so far...

Hi Rusty,

Yes, this is I think the right solution. Sorry for the title of the previous email : I started writing a patch and changed my mind half-way. Doing a synchronize_sched() at the end of the exit() function seems like the right thing to do. I'll have to update the documentation and examples accordingly.

Thanks,

Mathieu

Quoted 1 line

Rusty.

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#38 lore raw

Re: [PATCH] Module : call synchronize_sched() between module exit() and free.

In reply to Mathieu Desnoyers

Hi -

Quoted 5 lines · Mathieu Desnoyers

[...]
Actually, it's not placing a marker/tracepoint in a module which causes a problem, this is a simple function call after all, and correctly dealt with by current module.c code.
[...]

Just to spell it out, it is this scenario I'd like to see documented:

module-foo.c:
foo() { ... trace_mark (foo, "..."); ... }

module-bar.c:
setup() { ... marker_probe_register ("foo" , ..., &foo_handler ); } teardown() { ... marker_probe_unregister ("foo" , ..., &foo_handler ); } foo_handler() { }

1)  module-foo loads
2)  module-bar loads
3)  module-bar.c:setup()
4)  module-foo unloads

What happens here? Certainly no more calls to foo_handler, but is that all? (Would it not be desirable for an active marker to cause module-foo's refcount to increase, so as to prevent unloading at this time?)

5) module-bar.c:teardown()

Can this teardown code succeed fully even if module-foo is already dead and gone?

- FChE

#39 lore raw

Re: [PATCH] Module : call synchronize_sched() between module exit() and free.

Quoted 19 lines · * Frank Ch. Eigler ([email protected]) wrote:

Hi -

Quoted 5 lines · Mathieu Desnoyers

[...]
Actually, it's not placing a marker/tracepoint in a module which causes a problem, this is a simple function call after all, and correctly dealt with by current module.c code.
[...]

Just to spell it out, it is this scenario I'd like to see documented:

module-foo.c:

   foo() { ... trace_mark (foo, "..."); ... }

module-bar.c:

   setup() { ... marker_probe_register ("foo" , ..., &foo_handler ); }
   teardown() { ... marker_probe_unregister ("foo" , ..., &foo_handler ); }
   foo_handler() { }
Quoted 7 lines
1)  module-foo loads
2)  module-bar loads
3)  module-bar.c:setup()
4)  module-foo unloads

What happens here? Certainly no more calls to foo_handler, but is that all?

Yep, that's it. However a hash table still keeps track of the "foo" handler so that it's reconnected whenever module-foo is reloaded.

Quoted 3 lines

(Would it not be desirable for an active marker to cause module-foo's refcount to increase, so as to prevent unloading at this time?)

No, because I want to be able to unload the marked module and I don't want the fact that a probe is connected to it to change that.

Quoted 6 lines

5) module-bar.c:teardown()

Can this teardown code succeed fully even if module-foo is already dead and gone?

Yes.

Actually there is a detail missing here. Your teardown should be :

 teardown() { ... marker_probe_unregister ("foo" , ..., &foo_handler );
                  synchronize_sched(); /* Before returning from exit */ }

This makes sure that every live marker call are finished and that it is safe to unload module-bar (the probe).

Mathieu

Quoted 2 lines

- FChE

Signature · 2 lines
Mathieu Desnoyers
OpenPGP key fingerprint: 8CD5 52C3 8E3C 4140 715F  BA06 3F25 A8FE 3BAE 9A68
#40 lore raw

Re: [PATCH] Module : call synchronize_sched() between module exit() and free.

Quoted 7 lines · On Thursday 31 July 2008 00:09:38 Mathieu Desnoyers wrote:
Quoted 3 lines · * Frank Ch. Eigler ([email protected]) wrote:

(Would it not be desirable for an active marker to cause module-foo's refcount to increase, so as to prevent unloading at this time?)

No, because I want to be able to unload the marked module and I don't want the fact that a probe is connected to it to change that.

Also you might want to put a marker in the module's exit code.

Quoted 6 lines

Actually there is a detail missing here. Your teardown should be :

 teardown() { ... marker_probe_unregister ("foo" , ..., &foo_handler );
                  synchronize_sched(); /* Before returning from exit */ }

This makes sure that every live marker call are finished and that it is safe to unload module-bar (the probe).

Perhaps create a synchronize_marker_unregister() wrapper for such uses; it's better documentation and the caller doesn't have to know exactly how it works...

Cheers,
Rusty.