debugobjects: insulate non-fixup logic related to static obj from fixup callbacks
Subsystems (5)
PATCH 1/1 debugobjects: insulate non-fixup logic related to static obj from fixup callbacks
From: "Du, Changbin" <[email protected]>
When activate a static object, we need make sure that the object is tracked in the object tracker. If it is a non-static object, then the activation illegal.
In previous implementation, each subsystem need take care of this in their fixup callbacks. Actually we can put it into debugobjects core. Thus we can save duplicated code, and have *pure* fixup callbacks.
To achieve this, a new callback "is_static_object" is introduced to let the type specific code decide whether a object is static or not. If yes, we take it into object tracker, otherwise give warning and invoke fixup callback.
This change has paassed debugobjects selftest, and I also do some test with all debugobjects supports enabled.
At last, I have a concern about the fixups that can it change the object which is in incorrect state on fixup? Because the 'addr' may not point to any valid object if a non-static object is not tracked. Then Change such object can overwrite someone's memory and cause unexpected behaviour. For example, the timer_fixup_activate bind timer to function stub_timer.
---
This patch depends on patch set:
[PATCH 0/7] Make debugobjects fixup functions return bool type
--- include/linux/debugobjects.h | 2 ++ kernel/rcu/update.c | 26 +++----------------------- kernel/time/hrtimer.c | 7 +------ kernel/time/timer.c | 43 ++++++++++++++----------------------------- kernel/workqueue.c | 42 ++++++++---------------------------------- lib/debugobjects.c | 38 +++++++++++++++++++++++++------------- 6 files changed, 53 insertions(+), 105 deletions(-)
include/linux/debugobjects.h +2 -0
@@ -38,6 +38,7 @@ struct debug_obj {* @name: name of the object typee * @debug_hint: function returning address, which have associated * kernel symbol, to allow identify the object +* @is_static_object return true if the obj is static, otherwise return false * @fixup_init: fixup function, which is called when the init check * fails. All fixup functions must return true if fixup * was successful, otherwise return false
@@ -53,6 +54,7 @@ struct debug_obj {struct debug_obj_descr {const char *name;void *(*debug_hint)(void *addr); +bool (*is_static_object)(void *addr);bool (*fixup_init)(void *addr,enum debug_obj_state state);bool (*fixup_activate)(void *addr,enum debug_obj_state state);bool (*fixup_destroy)(void *addr,enum debug_obj_state state);
kernel/rcu/update.c +3 -23
@@ -380,29 +380,9 @@ void destroy_rcu_head(struct rcu_head *head)debug_object_free (head, &rcuhead_debug_descr); } -/* -* fixup_activate is called when: -* - an active object is activated -* - an unknown object is activated (might be a statically initialized object) -* Activation is performed internally by call_rcu(). -*/ -static bool rcuhead_fixup_activate (void *addr,enum debug_obj_state state) +static bool rcuhead_is_static_object (void *addr) { -struct rcu_head *head = addr; - -switch (state) { - -case ODEBUG_STATE_NOTAVAILABLE : -/* -* This is not really a fixup. We just make sure that it is -* tracked in the object tracker. -*/ -debug_object_init (head, &rcuhead_debug_descr); -debug_object_activate (head, &rcuhead_debug_descr); -return false; -default : -return true; - } +return true; }/**
@@ -440,7 +420,7 @@ EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);struct debug_obj_descr rcuhead_debug_descr = { .name ="rcu_head" , - .fixup_activate = rcuhead_fixup_activate, + .is_static_object = rcuhead_is_static_object, };EXPORT_SYMBOL_GPL (rcuhead_debug_descr);#endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */
kernel/time/hrtimer.c +1 -6
@@ -351,16 +351,11 @@ static bool hrtimer_fixup_init(void *addr, enum debug_obj_state state)/* * fixup_activate is called when: * - an active object is activated -* - an unknown object is activated (might be a statically initialized object) +* - an unknown non-static object is activated */ static bool hrtimer_fixup_activate (void *addr,enum debug_obj_state state) {switch (state) { - -case ODEBUG_STATE_NOTAVAILABLE : -WARN_ON_ONCE (1 ); -return false; -case ODEBUG_STATE_ACTIVE :WARN_ON (1 );
kernel/time/timer.c +14 -29
74 lines not on this page · raw message
kernel/workqueue.c +8 -34
61 lines not on this page · raw message
lib/debugobjects.c +25 -13
@@ -435,10 +435,15 @@ int debug_object_activate(void *addr, struct debug_obj_descr *descr)* let the type specific code decide whether this is * true or not. */ -if (debug_object_fixup (descr->fixup_activate, addr, -ODEBUG_STATE_NOTAVAILABLE )) { +if (descr->is_static_object && descr->is_static_object (addr)) { +/* Just make sure that it is tracked in the object tracker */ +debug_object_init (addr, descr); +debug_object_activate (addr, descr); + }else {debug_print_object (&o,"activate" ); -return -EINVAL ; + ret =debug_object_fixup (descr->fixup_activate, addr, +ODEBUG_STATE_NOTAVAILABLE ); +return ret ?0 : -EINVAL ; }return 0 ; }
@@ -602,12 +607,17 @@ void debug_object_assert_init(void *addr, struct debug_obj_descr *descr)raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do. */ -if (debug_object_fixup (descr->fixup_assert_init, addr, -ODEBUG_STATE_NOTAVAILABLE )) +if (descr->is_static_object && descr->is_static_object (addr)) { +/* Make sure that it is tracked in the object tracker */ +debug_object_init (addr, descr); + }else {debug_print_object (&o,"assert_init" ); +debug_object_fixup (descr->fixup_assert_init, addr, +ODEBUG_STATE_NOTAVAILABLE ); + }return ; }
@@ -792,6 +802,13 @@ struct self_test {static __initdata struct debug_obj_descr descr_type_test; +static bool __init is_static_object (void *addr) +{ +struct self_test *obj = addr; + +return obj->static_init; +} +/* * fixup_init is called when: * - an active object is initialized
@@ -813,7 +830,7 @@ static bool __init fixup_init(void *addr, enum debug_obj_state state)/* * fixup_activate is called when: * - an active object is activated -* - an unknown object is activated (might be a statically initialized object) +* - an unknown non-static object is activated */ static bool __init fixup_activate (void *addr,enum debug_obj_state state) {
@@ -821,13 +838,7 @@ static bool __init fixup_activate(void *addr, enum debug_obj_state state)switch (state) {case ODEBUG_STATE_NOTAVAILABLE : -if (obj->static_init ==1 ) { -debug_object_init (obj, &descr_type_test); -debug_object_activate (obj, &descr_type_test); -return false; - }return true; -case ODEBUG_STATE_ACTIVE :debug_object_deactivate (obj, &descr_type_test);debug_object_activate (obj, &descr_type_test);
@@ -916,6 +927,7 @@ out:static __initdata struct debug_obj_descr descr_type_test = { .name ="selftest" , + .is_static_object = is_static_object, .fixup_init = fixup_init, .fixup_activate = fixup_activate, .fixup_destroy = fixup_destroy,
Signature · 1 line
2.7.4
kbuild test robot
build boturl: https://github.com/0day-ci/linux/commits/changbin-du-intel-com/debugobjects-insulate-non-fixup-logic-related-to-static-obj-from-fixup-callbacks/20160507-072318 reproduce: make htmldocs
Hi,
[auto build test WARNING on next-20160506]
[cannot apply to tip/timers/core rcu/rcu/next v4.6-rc6 v4.6-rc5 v4.6-rc4 v4.6-rc6] [if your patch is applied to the wrong git tree, please drop us a note to help improving the system]
url: https://github.com/0day-ci/linux/commits/changbin-du-intel-com/debugobjects-insulate-non-fixup-logic-related-to-static-obj-from-fixup-callbacks/20160507-072318
reproduce: make htmldocs
All warnings (new ones prefixed by >>):
>> include/linux/debugobjects.h:63: warning: No description found for parameter 'is_static_object'
vim +/is_static_object +63 include/linux/debugobjects.h
3ac7fe5a Thomas Gleixner 2008-04-30 47 * @fixup_destroy: fixup function, which is called when the destroy check
3ac7fe5a Thomas Gleixner 2008-04-30 48 * fails
3ac7fe5a Thomas Gleixner 2008-04-30 49 * @fixup_free: fixup function, which is called when the free check
3ac7fe5a Thomas Gleixner 2008-04-30 50 * fails
b84d435c Christine Chan 2011-11-07 51 * @fixup_assert_init: fixup function, which is called when the assert_init
b84d435c Christine Chan 2011-11-07 52 * check fails
3ac7fe5a Thomas Gleixner 2008-04-30 53 */
3ac7fe5a Thomas Gleixner 2008-04-30 54 struct debug_obj_descr {
3ac7fe5a Thomas Gleixner 2008-04-30 55 const char *name;
99777288 Stanislaw Gruszka 2011-03-07 56 void *(*debug_hint)(void *addr);
ae293450 Du, Changbin 2016-05-07 57 bool (*is_static_object)(void *addr);
5133056d Du, Changbin 2016-05-06 58 bool (*fixup_init)(void *addr, enum debug_obj_state state);
5133056d Du, Changbin 2016-05-06 59 bool (*fixup_activate)(void *addr, enum debug_obj_state state);
5133056d Du, Changbin 2016-05-06 60 bool (*fixup_destroy)(void *addr, enum debug_obj_state state);
5133056d Du, Changbin 2016-05-06 61 bool (*fixup_free)(void *addr, enum debug_obj_state state);
5133056d Du, Changbin 2016-05-06 62 bool (*fixup_assert_init)(void *addr, enum debug_obj_state state);
3ac7fe5a Thomas Gleixner 2008-04-30 @63 };
3ac7fe5a Thomas Gleixner 2008-04-30 64
3ac7fe5a Thomas Gleixner 2008-04-30 65 #ifdef CONFIG_DEBUG_OBJECTS
3ac7fe5a Thomas Gleixner 2008-04-30 66 extern void debug_object_init (void *addr, struct debug_obj_descr *descr);
3ac7fe5a Thomas Gleixner 2008-04-30 67 extern void
3ac7fe5a Thomas Gleixner 2008-04-30 68 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
b778ae25 Paul E. McKenney 2013-04-23 69 extern int debug_object_activate (void *addr, struct debug_obj_descr *descr);
3ac7fe5a Thomas Gleixner 2008-04-30 70 extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
3ac7fe5a Thomas Gleixner 2008-04-30 71 extern void debug_object_destroy (void *addr, struct debug_obj_descr *descr);:::::: The code at line 63 was first introduced by commit
:::::: 3ac7fe5a4aab409bd5674d0b070bce97f9d20872 infrastructure to debug (dynamic) objects
:::::: TO: Thomas Gleixner <[email protected]> :::::: CC: Linus Torvalds <[email protected]>
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
On Sat, 7 May 2016, [email protected] wrote:
Can you please fix your mail client. Every mail you send has:
Cc: .....
"Du, Changbin" <[email protected]>,
Du
And that stray 'Du' is just broken.
Quoted 6 lines
At last, I have a concern about the fixups that can it change the object which is in incorrect state on fixup? Because the 'addr' may not point to any valid object if a non-static object is not tracked. Then Change such object can overwrite someone's memory and cause unexpected behaviour. For example, the
timer_fixup_activatebind timer to functionstub_timer.
Well, you have the choice of:
1) Leave the object uninitialized and watch the resulting explosion
2) Assume that the pointer is a valid object and initialize it
The latter has been chosen as the lesser of two evils.
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 611
Quoted 5 lines
lib/debugobjects.c +1
-1raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do.
Instead of doing white space changes you really want to explain the logic here.
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 622
Quoted 13 lines
lib/debugobjects.c +7
-2*/ -if (debug_object_fixup (descr->fixup_assert_init, addr, -ODEBUG_STATE_NOTAVAILABLE )) +if (descr->is_static_object && descr->is_static_object (addr)) { +/* Make sure that it is tracked in the object tracker */ +debug_object_init (addr, descr); + }else {debug_print_object (&o,"assert_init" ); +debug_object_fixup (descr->fixup_assert_init, addr, +ODEBUG_STATE_NOTAVAILABLE ); + }return ; }
Other than the missing comment this looks good.
Thanks,
tglx
Quoted 34 lines · Thomas Gleixner
On Sat, 7 May 2016, [email protected] wrote:
Can you please fix your mail client. Every mail you send has:
Cc: .....
"Du, Changbin" <[email protected]>,
DuAnd that stray 'Du' is just broken.
Quoted 6 lines
At last, I have a concern about the fixups that can it change the object which is in incorrect state on fixup? Because the 'addr' may not point to any valid object if a non-static object is not tracked. Then Change such object can overwrite someone's memory and cause unexpected behaviour. For example, the
timer_fixup_activatebind timer to functionstub_timer.Well, you have the choice of:
1) Leave the object uninitialized and watch the resulting explosion
2) Assume that the pointer is a valid object and initialize it
The latter has been chosen as the lesser of two evils.
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 611
Quoted 5 lines
lib/debugobjects.c +1
-1raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do. Instead of doing white space changes you really want to explain the logic here.
Quoted 15 lines
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 622
Quoted 13 lines
lib/debugobjects.c +7
-2*/ -if (debug_object_fixup (descr->fixup_assert_init, addr, -ODEBUG_STATE_NOTAVAILABLE )) +if (descr->is_static_object && descr->is_static_object (addr)) { +/* Make sure that it is tracked in the object tracker */ +debug_object_init (addr, descr); + }else {debug_print_object (&o,"assert_init" ); +debug_object_fixup (descr->fixup_assert_init, addr, +ODEBUG_STATE_NOTAVAILABLE ); + }return ; }Other than the missing comment this looks good.
The transformation to the RCU code looks fine. So given changes so that Thomas is good with the overall change, I am good with it from an RCU perspective.
Thanx, Paul
Quoted 9 lines
From: Thomas Gleixner [mailto:[email protected]] Can you please fix your mail client. Every mail you send has:
Cc: .....
"Du, Changbin" <[email protected]>,
DuAnd that stray 'Du' is just broken.
Yes, I should add "" around my name or fix the git-sendemail perl script. The script may add a "" auto. :)
Quoted 7 lines
Quoted 6 lines
At last, I have a concern about the fixups that can it change the object which is in incorrect state on fixup? Because the 'addr' may not point to any valid object if a non-static object is not tracked. Then Change such object can overwrite someone's memory and cause unexpected behaviour. For example, the
timer_fixup_activatebind timer to functionstub_timer.
Quoted 8 lines
Well, you have the choice of:
1) Leave the object uninitialized and watch the resulting explosion
2) Assume that the pointer is a valid object and initialize it
The latter has been chosen as the lesser of two evils.
Hmm, seems nothing more we can do to reduce further damage.
Quoted 9 lines
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 611
Quoted 5 lines
lib/debugobjects.c +1
-1raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do. Instead of doing white space changes you really want to explain the logic here.
Comments is in following code.
Quoted 17 lines
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr)
Quoted 4 lines
lib/debugobjects.c +1
-2*/ -if (debug_object_fixup (descr->fixup_assert_init, addr, -ODEBUG_STATE_NOTAVAILABLE )) +if (descr->is_static_object && descr->is_static_object (addr)){
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 622
Quoted 9 lines
lib/debugobjects.c +6
-0+/* Make sure that it is tracked in the object tracker */ +debug_object_init (addr, descr); + }else {debug_print_object (&o,"assert_init" ); +debug_object_fixup (descr->fixup_assert_init, addr, +ODEBUG_STATE_NOTAVAILABLE ); + }return ; }Other than the missing comment this looks good.
Quoted 3 lines
Thanks,
tglx
Thanks for reviewing.
Du, Changbin
Quoted 11 lines · Changbin
Quoted 10 lines
From: Thomas Gleixner [mailto:[email protected]]
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 611
Quoted 5 lines
lib/debugobjects.c +1
-1raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do. Instead of doing white space changes you really want to explain the logic here.
Comments is in following code.
Well. It's a comment, but the code you replace has better explanations about statically initialized objects. This should move here.
Thanks,
tglx
Quoted 12 lines
From: Thomas Gleixner [mailto:[email protected]]
Quoted 10 lines · Changbin
Quoted 10 lines
From: Thomas Gleixner [mailto:[email protected]]
lib/debugobjects.c void debug_object_assert_init(void *addr, struct debug_obj_descr *descr) · line 611
Quoted 5 lines
lib/debugobjects.c +1
-1raw_spin_unlock_irqrestore (&db->lock, flags);/* -* Maybe the object is static. Let the type specific +* Maybe the object is static. Let the type specific * code decide what to do. Instead of doing white space changes you really want to explain the logic here.
Quoted 8 lines
Quoted 1 line
Comments is in following code.
Well. It's a comment, but the code you replace has better explanations about statically initialized objects. This should move here.
Thanks,
tglx
Ok, let me improve the comment for patch v2.
Best Regards,
Du, Changbin
PATCH v2 1/1 debugobjects: insulate non-fixup logic related to static obj from fixup callbacks
In reply to Thomas GleixnerFrom: "Du, Changbin" <[email protected]>
When activate a static object, we need make sure that the object is tracked in the object tracker. If it is a non-static object, then the activation illegal.
In previous implementation, each subsystem need take care of this in their fixup callbacks. Actually we can put it into debugobjects core. Thus we can save duplicated code, and have *pure* fixup callbacks.
To achieve this, a new callback "is_static_object" is introduced to let the type specific code decide whether a object is static or not. If yes, we take it into object tracker, otherwise give warning and invoke fixup callback.
This change has paassed debugobjects selftest, and I also do some test with all debugobjects supports enabled.
At last, I have a concern about the fixups that can it change the object which is in incorrect state on fixup? Because the 'addr' may not point to any valid object if a non-static object is not tracked. Then Change such object can overwrite someone's memory and cause unexpected behaviour. For example, the timer_fixup_activate bind timer to function stub_timer.
---
This patch depends on patch set:
[PATCH 0/7] Make debugobjects fixup functions return bool type
v2:
improve code comments where invoke the new is_static_object callback
--- include/linux/debugobjects.h | 2 ++ kernel/rcu/update.c | 26 +++-------------------- kernel/time/hrtimer.c | 7 +------ kernel/time/timer.c | 43 +++++++++++++------------------------- kernel/workqueue.c | 42 ++++++++----------------------------- lib/debugobjects.c | 49 +++++++++++++++++++++++++++++--------------- 6 files changed, 60 insertions(+), 109 deletions(-)
include/linux/debugobjects.h +2 -0
@@ -38,6 +38,7 @@ struct debug_obj {* @name: name of the object typee * @debug_hint: function returning address, which have associated * kernel symbol, to allow identify the object +* @is_static_object return true if the obj is static, otherwise return false * @fixup_init: fixup function, which is called when the init check * fails. All fixup functions must return true if fixup * was successful, otherwise return false
@@ -53,6 +54,7 @@ struct debug_obj {struct debug_obj_descr {const char *name;void *(*debug_hint)(void *addr); +bool (*is_static_object)(void *addr);bool (*fixup_init)(void *addr,enum debug_obj_state state);bool (*fixup_activate)(void *addr,enum debug_obj_state state);bool (*fixup_destroy)(void *addr,enum debug_obj_state state);
kernel/rcu/update.c +3 -23
@@ -380,29 +380,9 @@ void destroy_rcu_head(struct rcu_head *head)debug_object_free (head, &rcuhead_debug_descr); } -/* -* fixup_activate is called when: -* - an active object is activated -* - an unknown object is activated (might be a statically initialized object) -* Activation is performed internally by call_rcu(). -*/ -static bool rcuhead_fixup_activate (void *addr,enum debug_obj_state state) +static bool rcuhead_is_static_object (void *addr) { -struct rcu_head *head = addr; - -switch (state) { - -case ODEBUG_STATE_NOTAVAILABLE : -/* -* This is not really a fixup. We just make sure that it is -* tracked in the object tracker. -*/ -debug_object_init (head, &rcuhead_debug_descr); -debug_object_activate (head, &rcuhead_debug_descr); -return false; -default : -return true; - } +return true; }/**
@@ -440,7 +420,7 @@ EXPORT_SYMBOL_GPL(destroy_rcu_head_on_stack);struct debug_obj_descr rcuhead_debug_descr = { .name ="rcu_head" , - .fixup_activate = rcuhead_fixup_activate, + .is_static_object = rcuhead_is_static_object, };EXPORT_SYMBOL_GPL (rcuhead_debug_descr);#endif /* #ifdef CONFIG_DEBUG_OBJECTS_RCU_HEAD */
kernel/time/hrtimer.c +1 -6
@@ -351,16 +351,11 @@ static bool hrtimer_fixup_init(void *addr, enum debug_obj_state state)/* * fixup_activate is called when: * - an active object is activated -* - an unknown object is activated (might be a statically initialized object) +* - an unknown non-static object is activated */ static bool hrtimer_fixup_activate (void *addr,enum debug_obj_state state) {switch (state) { - -case ODEBUG_STATE_NOTAVAILABLE : -WARN_ON_ONCE (1 ); -return false; -case ODEBUG_STATE_ACTIVE :WARN_ON (1 );
kernel/time/timer.c +14 -29
74 lines not on this page · raw message
kernel/workqueue.c +8 -34
61 lines not on this page · raw message
lib/debugobjects.c +32 -17
90 lines not on this page · raw message
Signature · 1 line
2.7.4