Skip to contentSkip to conversation

on static kobjects and double frees...

PATCH Arthur Jones 3 participants 7 messages Jun 10, 2008

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

Hi Greg, The edac pci sysfs generic layer uses a static kobject as a placeholder parent where edac pci drivers are inserted. An atomic count is used to know when to kobject_init_add_add or kobject_put the static kobject. The issue with this is that the name gets double freed on the second module load as edac does not clear it, and kobject_cleanup does not clear it.

The quick fix was to clear the static kobj name before calling kobject_init, but that seems a bit fragile as it involves knowing the internals of kobject_put. Perhaps the name should be cleared before calling the kobject release method? Something like this (not even compile tested):

lib/kobject.c +3 -0
index 718e510..7dfe906 100644
@@ -552,6 +552,9 @@ static void kobject_cleanup(struct kobject *kobj)
 	if (t && t->release) {
 		pr_debug("kobject: '%s' (%p): calling ktype release\n",
 			 kobject_name(kobj), kobj);
+
+		/* avoid double free with static kobjects... */
+		kobj->name = NULL;
 		t->release(kobj);
 	}
 

What do you think? I'm happy to implement and test whatever you think is best...

The edac code in question is drivers/edac/edac_pci_sysfs.c, the static kobject is called edac_pci_top_main_kobj...

Arthur

#1 lore raw
Quoted 3 lines · Arthur Jones

Hi Greg, The edac pci sysfs generic layer uses a static kobject as a placeholder parent where edac pci drivers are inserted.

Hm, stop right there.

kobjects are not supposed to be static, bad things happen if you do that (including the kernel itself will warn you about them, unless you gave it an empty release function, and if so, then see Documentation/kobject.txt and prepare to be mocked...)

Quoted 2 lines

An atomic count is used to know when to kobject_init_add_add or kobject_put the static kobject.

No, the kobject itself should handle stuff like this.

Quoted 3 lines

The issue with this is that the name gets double freed on the second module load as edac does not clear it, and kobject_cleanup does not clear it.

Yup, that's because you should not be doing this :)

Quoted 6 lines

The quick fix was to clear the static kobj name before calling kobject_init, but that seems a bit fragile as it involves knowing the internals of kobject_put. Perhaps the name should be cleared before calling the kobject release method? Something like this (not even compile tested):

No, please just dynamically create your kobject. It's easier than ever to do this today (just one function call!).

Quoted 18 lines
lib/kobject.c +3 -0
index 718e510..7dfe906 100644
@@ -552,6 +552,9 @@ static void kobject_cleanup(struct kobject *kobj)
 	if (t && t->release) {
 		pr_debug("kobject: '%s' (%p): calling ktype release\n",
 			 kobject_name(kobj), kobj);
+
+		/* avoid double free with static kobjects... */
+		kobj->name = NULL;
 		t->release(kobj);
 	}
 

What do you think? I'm happy to implement and test whatever you think is best...

Quoted 2 lines

The edac code in question is drivers/edac/edac_pci_sysfs.c, the static kobject is called edac_pci_top_main_kobj...

In looking at that code, I really don't understand what you are trying to do with this "tracking" kobject. Why do that at all, and not just create a kobject and hang things off of it if you want to have that. The whole lifetime of it will be properly handled automatically if you do that.

thanks,

greg k-h

#2 lore raw

Hi Greg, ...

Quoted 11 lines · Greg KH
Quoted 3 lines · Arthur Jones

Hi Greg, The edac pci sysfs generic layer uses a static kobject as a placeholder parent where edac pci drivers are inserted.

Hm, stop right there.

kobjects are not supposed to be static, bad things happen if you do that (including the kernel itself will warn you about them, unless you gave it an empty release function, and if so, then see Documentation/kobject.txt and prepare to be mocked...)

OK, I wondered about this, but I didn't see anything in Documentation/kobject.txt that said that kobjects can not be static. But now that I've fixed the double free bug, I'm seeing the warning you mentioned above...

I don't know how the current code came to be, so I can't speak to your issues below. But, with these pointers, I think I can get things cleaned up properly.

Thank you!

Arthur

Quoted 51 lines
Quoted 2 lines

An atomic count is used to know when to kobject_init_add_add or kobject_put the static kobject.

No, the kobject itself should handle stuff like this.

Quoted 3 lines

The issue with this is that the name gets double freed on the second module load as edac does not clear it, and kobject_cleanup does not clear it.

Yup, that's because you should not be doing this :)

Quoted 6 lines

The quick fix was to clear the static kobj name before calling kobject_init, but that seems a bit fragile as it involves knowing the internals of kobject_put. Perhaps the name should be cleared before calling the kobject release method? Something like this (not even compile tested):

No, please just dynamically create your kobject. It's easier than ever to do this today (just one function call!).

Quoted 18 lines
lib/kobject.c +3 -0
index 718e510..7dfe906 100644
@@ -552,6 +552,9 @@ static void kobject_cleanup(struct kobject *kobj)
      if (t && t->release) {
              pr_debug("kobject: '%s' (%p): calling ktype release\n",
                       kobject_name(kobj), kobj);
+
+             /* avoid double free with static kobjects... */
+             kobj->name = NULL;
              t->release(kobj);
      }
 

What do you think? I'm happy to implement and test whatever you think is best...

Quoted 2 lines

The edac code in question is drivers/edac/edac_pci_sysfs.c, the static kobject is called edac_pci_top_main_kobj...

In looking at that code, I really don't understand what you are trying to do with this "tracking" kobject. Why do that at all, and not just create a kobject and hang things off of it if you want to have that. The whole lifetime of it will be properly handled automatically if you do that.

thanks,

greg k-h

#3 lore raw
Quoted 15 lines · Arthur Jones

Hi Greg, ...

Quoted 11 lines · Greg KH
Quoted 3 lines · Arthur Jones

Hi Greg, The edac pci sysfs generic layer uses a static kobject as a placeholder parent where edac pci drivers are inserted.

Hm, stop right there.

kobjects are not supposed to be static, bad things happen if you do that (including the kernel itself will warn you about them, unless you gave it an empty release function, and if so, then see Documentation/kobject.txt and prepare to be mocked...)

Quoted 4 lines

OK, I wondered about this, but I didn't see anything in Documentation/kobject.txt that said that kobjects can not be static. But now that I've fixed the double free bug, I'm seeing the warning you mentioned above...

Hm, there is the following text in that file:
Because kobjects are dynamic, they must not be declared statically or on the stack, but instead, always allocated dynamically. Future versions of the kernel will contain a run-time check for kobjects that are created statically and will warn the developer of this improper usage.

Quoted 3 lines

I don't know how the current code came to be, so I can't speak to your issues below. But, with these pointers, I think I can get things cleaned up properly.

Great, if you want me to review it, I'd be glad to do so.

thanks,

greg k-h

#4 lore raw

Hi Greg, ...

Quoted 6 lines · Greg KH
Quoted 5 lines

[...]
OK, I wondered about this, but I didn't see anything in Documentation/kobject.txt that said that kobjects can not be static. But now that I've fixed the double free bug, I'm seeing the warning you mentioned above...

Quoted 6 lines

Hm, there is the following text in that file:
Because kobjects are dynamic, they must not be declared statically or on the stack, but instead, always allocated dynamically. Future versions of the kernel will contain a run-time check for kobjects that are created statically and will warn the developer of this improper usage.

Indeed, I see that now. Sorry for the noise, I should have read more carefully...

Quoted 5 lines
Quoted 3 lines

I don't know how the current code came to be, so I can't speak to your issues below. But, with these pointers, I think I can get things cleaned up properly.

Great, if you want me to review it, I'd be glad to do so.

Thanks!

Arthur

Acked-by
#5 lore raw
In reply to Arthur Jones
Quoted 14 lines · --- Arthur Jones

Hi Greg, ...

Quoted 11 lines · Greg KH
Quoted 3 lines · Arthur Jones

Hi Greg, The edac pci sysfs generic layer uses a static kobject as a placeholder parent where edac pci drivers are inserted.

Hm, stop right there.

kobjects are not supposed to be static, bad things happen if you do that (including the kernel itself will warn you about them, unless you gave it an empty release function, and if so, then see Documentation/kobject.txt and prepare to be mocked...)

The edac_pci was my first coding with kobjects sometime ago and I have not reviewed them for quite awhile, since I have been working more on memory controllers. Thus it was my bad.

Arthur, thanks for tracking that down and reviewing it. All the memory controller kobjects are all dynamic. The edac PCI code needed to be refactored and it looks like you did it.

thanks again

doug t

For the patch:

W1DUG

#6 lore raw

Hi Doug, ...

Quoted 3 lines · Doug Thompson

[...]
Arthur, thanks for tracking that down and reviewing it. All the memory controller kobjects are all dynamic. [...]

You're welcome, I learned a lot about kobjects that I should have already known...

AFAICS, mc is not quite clean yet, though, as mc_kset is static and I don't think that is right. It does, however, look like less work than edac_pci_sysfs.c...

Quoted 1 line

[...] The edac PCI code needed to be refactored and it looks like you did it.

I only did the bare minimum, there's a lot of kobject stuff in there that looks suspect to me, e.g.:

* the "pci" object should be a kset rather than a kobject?
* if the "pci" object is a kset, can the whole global list thing in edac_pci just go away?
* do we really need the atomic_inc counter, wouldn't a mutex be clearer?
* can we initialize "pci" at init time thereby removing the need even for a mutex on the "pci" initializer? This does change the sysfs semantics slightly, though, as the "pci" object would no longer be created lazily. I'm not sure if that's a problem.

and other minor things. It looks to me like it could use a thorough scrubbing. The good news is that I don't think the API would change much if at all. I can have a closer look if you are interested...

Arthur