Skip to contentSkip to conversation

decouple spinlock stats from XENO_OPT_STATS

PATCH In review Jan Kiszka 3 participants 7 messages Nov 20, 2006 – Dec 4, 2006 Generic include/asm header files

lore
Share & tools
lore

Jan Kiszka

author
#0 lore raw

PATCH 1/3 decouple spinlock stats from XENO_OPT_STATS

As recently discussed, the current implicit coupling of spinlock statistics/debugging with the XENO_OPT_STATS switch is suboptimal. The
reason: on SMP, it adds noticeable overhead to the STATS feature which may only be used for thread statistics collection (as also advertised in the kconfig help).

This patch makes the spinlock debugging and lock length collection feature only depend on XENO_OPT_DEBUG (as a first step).

Jan

---
 include/asm-generic/system.h |   35 ++++++++++++++++-------------------
 ksrc/nucleus/module.c        |   22 +++++++++++-----------
 2 files changed, 27 insertions(+), 30 deletions(-)
include/asm-generic/system.h +16 -19
Index: xenomai/include/asm-generic/system.h
===================================================================
@@ -71,9 +71,7 @@ typedef unsigned long spl_t;
 #define spltest()   rthal_local_irq_test()
 #define splget(x)   rthal_local_irq_flags(x)
 
-#if defined(CONFIG_SMP) && \
-    (defined(CONFIG_XENO_OPT_STATS) || defined(CONFIG_XENO_OPT_DEBUG))
-
+#if defined(CONFIG_SMP) && defined(CONFIG_XENO_OPT_DEBUG)
 typedef struct {
 
         unsigned long long spin_time;
@@ -96,25 +94,24 @@ typedef struct {
 
 } xnlock_t;
 
-#define XNARCH_LOCK_UNLOCKED (xnlock_t) {       \
-	{ ~0 },				        \
-        NULL,                                   \
-        NULL,                                   \
-        0,                                      \
-        -1,                                     \
-        0LL,                                    \
-        0LL,                                    \
+#define XNARCH_LOCK_UNLOCKED (xnlock_t) {	\
+	{ ~0 },					\
+	NULL,					\
+	NULL,					\
+	0,					\
+	-1,					\
+	0LL,					\
+	0LL,					\
 }
 
 #define CONFIG_XENO_SPINLOCK_DEBUG  1
 
-#else /* !(CONFIG_XENO_OPT_STATS && CONFIG_SMP) */
+#else /* !(CONFIG_SMP && CONFIG_XENO_OPT_DEBUG) */
 
 typedef struct { atomic_t owner; } xnlock_t;
 
 #define XNARCH_LOCK_UNLOCKED (xnlock_t) { { ~0 } }
-
-#endif /* CONFIG_XENO_OPT_STATS && CONFIG_SMP */
+#endif /* CONFIG_SMP && CONFIG_XENO_OPT_DEBUG */
 
 #define XNARCH_NR_CPUS               RTHAL_NR_CPUS
 
@@ -253,7 +250,7 @@ static inline int __xnlock_get (xnlock_t
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 static inline int __xnlock_get (xnlock_t *lock)
 {
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
     rthal_declare_cpuid;
     int recursing;
 
@@ -304,7 +301,7 @@ static inline void xnlock_put (xnlock_t 
     rthal_load_cpuid();
     if (likely(atomic_read(&lock->owner) == cpuid)) {
 
-#ifdef CONFIG_XENO_OPT_STATS
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
 	    extern xnlockinfo_t xnlock_stats[];
 
 	    unsigned long long lock_time = rthal_rdtsc() - lock->lock_date;
@@ -316,7 +313,7 @@ static inline void xnlock_put (xnlock_t 
 		    xnlock_stats[cpuid].function = lock->function;
 		    xnlock_stats[cpuid].line = lock->line;
 	    }
-#endif /* CONFIG_XENO_OPT_STATS */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 	    atomic_set(&lock->owner, ~0);
     }
 #ifdef CONFIG_XENO_SPINLOCK_DEBUG
@@ -343,7 +340,7 @@ static inline spl_t __xnlock_get_irqsave
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 static inline spl_t __xnlock_get_irqsave (xnlock_t *lock)
 {
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
     unsigned long flags;
 
     rthal_local_irq_save(flags);
@@ -354,7 +351,7 @@ static inline spl_t __xnlock_get_irqsave
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
     if (__xnlock_get(lock))
 	    flags |= 2;
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 	
     return flags;
 }
ksrc/nucleus/module.c +11 -11
Index: xenomai/ksrc/nucleus/module.c
===================================================================
@@ -472,7 +472,9 @@ static struct file_operations stat_seq_o
 	.release = seq_release_private,
 };
 
-#ifdef CONFIG_SMP
+#endif /* CONFIG_XENO_OPT_STATS */
+
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
 
 xnlockinfo_t xnlock_stats[RTHAL_NR_CPUS];
 
@@ -520,9 +522,7 @@ static int lock_read_proc(char *page,
 
 EXPORT_SYMBOL(xnlock_stats);
 
-#endif /* CONFIG_SMP */
-
-#endif /* CONFIG_XENO_OPT_STATS */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 
 static int latency_read_proc(char *page,
 			     char **start,
@@ -741,12 +741,12 @@ void xnpod_init_proc(void)
 
 #ifdef CONFIG_XENO_OPT_STATS
 	add_proc_fops("stat", &stat_seq_operations, 0, rthal_proc_root);
-#ifdef CONFIG_SMP
-	add_proc_leaf("lock", &lock_read_proc, NULL, NULL, rthal_proc_root);
-#endif /* CONFIG_SMP */
-
 #endif /* CONFIG_XENO_OPT_STATS */
 
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
+	add_proc_leaf("lock", &lock_read_proc, NULL, NULL, rthal_proc_root);
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
+
 	add_proc_leaf("latency",
 		      &latency_read_proc,
 		      &latency_write_proc, NULL, rthal_proc_root);
@@ -786,10 +786,10 @@ void xnpod_delete_proc(void)
 	remove_proc_entry("sched", rthal_proc_root);
 #ifdef CONFIG_XENO_OPT_STATS
 	remove_proc_entry("stat", rthal_proc_root);
-#ifdef CONFIG_SMP
-	remove_proc_entry("lock", rthal_proc_root);
-#endif /* CONFIG_SMP */
 #endif /* CONFIG_XENO_OPT_STATS */
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
+	remove_proc_entry("lock", rthal_proc_root);
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 }
 
 #ifdef CONFIG_XENO_OPT_PERVASIVE
#1 lore raw

include/asm-generic/system.h static inline spl_t __xnlock_get_irqsave · line 343

Quoted 7 lines · Jan Kiszka

#ifdef CONFIG_XENO_SPINLOCK_DEBUG

include/asm-generic/system.h +1 -1
@@ -343,7 +340,7 @@ static inline spl_t __xnlock_get_irqsave
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 static inline spl_t __xnlock_get_irqsave (xnlock_t *lock)
 {
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */

I prefer the notation:

#if cond
#endif /* cond */

and

#if cond
#else /* !cond */
#endif /* !cond */

to

#if cond
#endif /* cond */

and

#if cond
#else /* !cond */
#endif /* cond */

Because in the first case, when I see a #endif in the middle of a lot of code, I immediately know what predicate is true above the #endif.

Signature · 1 line
                                                 Gilles Chanteperdrix
author
#2 lore raw
Quoted 25 lines · Gilles Chanteperdrix

include/asm-generic/system.h static inline spl_t __xnlock_get_irqsave · line 343

Quoted 7 lines · Jan Kiszka

#ifdef CONFIG_XENO_SPINLOCK_DEBUG

include/asm-generic/system.h +1 -1
@@ -343,7 +340,7 @@ static inline spl_t __xnlock_get_irqsave
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 static inline spl_t __xnlock_get_irqsave (xnlock_t *lock)
 {
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */

I prefer the notation:

#if cond
#endif /* cond */

and

#if cond
#else /* !cond */
#endif /* !cond */

to

#if cond
#endif /* cond */

Quoted 9 lines

and

#if cond
#else /* !cond */
#endif /* cond */

Because in the first case, when I see a #endif in the middle of a lot of code, I immediately know what predicate is true above the #endif.

Ok, I understand the logic. Nevertheless, I had the impression the first scheme is used far more often than the second one in Xenomai and I-pipe, so I took the chance to consolidate the code.

So, what should be the common rule from now on? Is there a kernel-style rule for this issue we should follow, or are we free and should convert to your preferred scheme?

Jan

#3 lore raw
Quoted 32 lines · Jan Kiszka
Quoted 31 lines · Gilles Chanteperdrix

include/asm-generic/system.h static inline spl_t __xnlock_get_irqsave · line 343

Quoted 7 lines · Jan Kiszka

#ifdef CONFIG_XENO_SPINLOCK_DEBUG

include/asm-generic/system.h +1 -1
@@ -343,7 +340,7 @@ static inline spl_t __xnlock_get_irqsave
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 static inline spl_t __xnlock_get_irqsave (xnlock_t *lock)
 {
-#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */

I prefer the notation:

#if cond
#endif /* cond */

and

#if cond
#else /* !cond */
#endif /* !cond */

to

#if cond
#endif /* cond */

and

#if cond
#else /* !cond */
#endif /* cond */

Quoted 7 lines
Quoted 3 lines

Because in the first case, when I see a #endif in the middle of a lot of code, I immediately know what predicate is true above the #endif.

Ok, I understand the logic. Nevertheless, I had the impression the first scheme is used far more often than the second one in Xenomai and I-pipe, so I took the chance to consolidate the code.

Basically because I wrote those using the first convention.

Quoted 5 lines

So, what should be the common rule from now on? Is there a kernel-style rule for this issue we should follow, or are we free and should convert to your preferred scheme?

Let's move to Gilles's convention; it's more readable.

Quoted 6 lines

Jan

_______________________________________________
Xenomai-core mailing list
[email protected]
https://mail.gna.org/listinfo/xenomai-core

Signature · 1 line
Philippe.
author
#4 lore raw
In reply to Jan Kiszka

Here comes version 2 of this patch, now following the new #if-#else-#endif comment style.

Jan

---
 include/asm-generic/system.h |   35 ++++++++++++++++-------------------
 ksrc/nucleus/module.c        |   22 +++++++++++-----------
 2 files changed, 27 insertions(+), 30 deletions(-)
include/asm-generic/system.h +16 -19
Index: xenomai/include/asm-generic/system.h
===================================================================
@@ -66,14 +66,12 @@ typedef unsigned long spl_t;
 #define splexit(x)  rthal_local_irq_restore((x) & 1)
 #else /* !CONFIG_SMP */
 #define splexit(x)  rthal_local_irq_restore(x)
-#endif /* CONFIG_SMP */
+#endif /* !CONFIG_SMP */
 #define splnone()   rthal_local_irq_enable()
 #define spltest()   rthal_local_irq_test()
 #define splget(x)   rthal_local_irq_flags(x)
 
-#if defined(CONFIG_SMP) && \
-    (defined(CONFIG_XENO_OPT_STATS) || defined(CONFIG_XENO_OPT_DEBUG))
-
+#if defined(CONFIG_SMP) && defined(CONFIG_XENO_OPT_DEBUG)
 typedef struct {
 
         unsigned long long spin_time;
@@ -96,25 +94,24 @@ typedef struct {
 
 } xnlock_t;
 
-#define XNARCH_LOCK_UNLOCKED (xnlock_t) {       \
-	{ ~0 },				        \
-        NULL,                                   \
-        NULL,                                   \
-        0,                                      \
-        -1,                                     \
-        0LL,                                    \
-        0LL,                                    \
+#define XNARCH_LOCK_UNLOCKED (xnlock_t) {	\
+	{ ~0 },					\
+	NULL,					\
+	NULL,					\
+	0,					\
+	-1,					\
+	0LL,					\
+	0LL,					\
 }
 
 #define CONFIG_XENO_SPINLOCK_DEBUG  1
 
-#else /* !(CONFIG_XENO_OPT_STATS && CONFIG_SMP) */
+#else /* !(CONFIG_SMP && CONFIG_XENO_OPT_DEBUG) */
 
 typedef struct { atomic_t owner; } xnlock_t;
 
 #define XNARCH_LOCK_UNLOCKED (xnlock_t) { { ~0 } }
-
-#endif /* CONFIG_XENO_OPT_STATS && CONFIG_SMP */
+#endif /* !(CONFIG_SMP && CONFIG_XENO_OPT_DEBUG) */
 
 #define XNARCH_NR_CPUS               RTHAL_NR_CPUS
 
@@ -231,7 +228,7 @@ static inline int xnarch_setimask (int i
 #else /* !CONFIG_XENO_SPINLOCK_DEBUG */
 #define xnlock_get(lock)            __xnlock_get(lock)
 #define xnlock_get_irqsave(lock,x)  ((x) = __xnlock_get_irqsave(lock))
-#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
+#endif /* !CONFIG_XENO_SPINLOCK_DEBUG */
 #define xnlock_clear_irqoff(lock)   xnlock_put_irqrestore(lock,1)
 #define xnlock_clear_irqon(lock)    xnlock_put_irqrestore(lock,0)
 
@@ -304,7 +301,7 @@ static inline void xnlock_put (xnlock_t 
     rthal_load_cpuid();
     if (likely(atomic_read(&lock->owner) == cpuid)) {
 
-#ifdef CONFIG_XENO_OPT_STATS
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
 	    extern xnlockinfo_t xnlock_stats[];
 
 	    unsigned long long lock_time = rthal_rdtsc() - lock->lock_date;
@@ -316,7 +313,7 @@ static inline void xnlock_put (xnlock_t 
 		    xnlock_stats[cpuid].function = lock->function;
 		    xnlock_stats[cpuid].line = lock->line;
 	    }
-#endif /* CONFIG_XENO_OPT_STATS */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 	    atomic_set(&lock->owner, ~0);
     }
 #ifdef CONFIG_XENO_SPINLOCK_DEBUG
@@ -377,7 +374,7 @@ static inline void xnlock_put_irqrestore
 #define xnlock_clear_irqoff(lock)      rthal_local_irq_disable()
 #define xnlock_clear_irqon(lock)       rthal_local_irq_enable()
 
-#endif /* CONFIG_SMP */
+#endif /* !CONFIG_SMP */
 
 static inline int xnarch_remap_vm_page(struct vm_area_struct *vma,
 				       unsigned long from,
ksrc/nucleus/module.c +11 -11
Index: xenomai/ksrc/nucleus/module.c
===================================================================
@@ -472,7 +472,9 @@ static struct file_operations stat_seq_o
 	.release = seq_release_private,
 };
 
-#ifdef CONFIG_SMP
+#endif /* CONFIG_XENO_OPT_STATS */
+
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
 
 xnlockinfo_t xnlock_stats[RTHAL_NR_CPUS];
 
@@ -520,9 +522,7 @@ static int lock_read_proc(char *page,
 
 EXPORT_SYMBOL(xnlock_stats);
 
-#endif /* CONFIG_SMP */
-
-#endif /* CONFIG_XENO_OPT_STATS */
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 
 static int latency_read_proc(char *page,
 			     char **start,
@@ -741,12 +741,12 @@ void xnpod_init_proc(void)
 
 #ifdef CONFIG_XENO_OPT_STATS
 	add_proc_fops("stat", &stat_seq_operations, 0, rthal_proc_root);
-#ifdef CONFIG_SMP
-	add_proc_leaf("lock", &lock_read_proc, NULL, NULL, rthal_proc_root);
-#endif /* CONFIG_SMP */
-
 #endif /* CONFIG_XENO_OPT_STATS */
 
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
+	add_proc_leaf("lock", &lock_read_proc, NULL, NULL, rthal_proc_root);
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
+
 	add_proc_leaf("latency",
 		      &latency_read_proc,
 		      &latency_write_proc, NULL, rthal_proc_root);
@@ -786,10 +786,10 @@ void xnpod_delete_proc(void)
 	remove_proc_entry("sched", rthal_proc_root);
 #ifdef CONFIG_XENO_OPT_STATS
 	remove_proc_entry("stat", rthal_proc_root);
-#ifdef CONFIG_SMP
-	remove_proc_entry("lock", rthal_proc_root);
-#endif /* CONFIG_SMP */
 #endif /* CONFIG_XENO_OPT_STATS */
+#ifdef CONFIG_XENO_SPINLOCK_DEBUG
+	remove_proc_entry("lock", rthal_proc_root);
+#endif /* CONFIG_XENO_SPINLOCK_DEBUG */
 }
 
 #ifdef CONFIG_XENO_OPT_PERVASIVE
#5 lore raw

Ok, I ended up finding such decoupling cleaner, given that we don't drag the full debug overhead when activating /proc/xenomai/locks in SMP mode, thanks to the reorganized debug options. Gilles, is this patch series ok for you too, and particularly the POSIX changes?

Signature · 1 line
Philippe.
#6 lore raw
Quoted 5 lines · Philippe Gerum

Ok, I ended up finding such decoupling cleaner, given that we don't drag the full debug overhead when activating /proc/xenomai/locks in SMP mode, thanks to the reorganized debug options. Gilles, is this patch series ok for you too, and particularly the POSIX changes?

Yes, it is Ok.

Signature · 1 line
                                                 Gilles Chanteperdrix