sysfs: sysfs_add_one tells you _where_ the duplicate file is
PATCH 1/1 sysfs: sysfs_add_one tells you _where_ the duplicate file is
Give a better clue about where we might be creating duplicate files by displaying the parent's name as well.
---
It would be nice to get a full path, but simply printing out the parent is cheap and more useful than what we have now.
fs/sysfs/dir.c +2 -1
@@ -459,7 +459,8 @@ int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) ret =__sysfs_add_one (acxt, sd);WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +"can not be created in %s\n" , + sd->s_name, acxt->parent_sd->s_name);return ret; }
Quoted 7 lines · Alex Chiang
Give a better clue about where we might be creating duplicate files by displaying the parent's name as well.
Signed-off-by Alex Chiang <[email protected]>---
It would be nice to get a full path, but simply printing out the parent is cheap and more useful than what we have now.
What happens if you don't have a parent? will this oops if you are creating a duplicate device in the root of the sysfs tree?
thanks,
greg k-h
* Greg KH <[email protected]>:
Quoted 11 lines · Alex Chiang
Quoted 7 lines
Give a better clue about where we might be creating duplicate files by displaying the parent's name as well.
Signed-off-by Alex Chiang <[email protected]>---
It would be nice to get a full path, but simply printing out the parent is cheap and more useful than what we have now.What happens if you don't have a parent? will this oops if you are creating a duplicate device in the root of the sysfs tree?
We won't oops because if you attempt to create a device in the root of the sysfs tree with a NULL parent, then we say that your parent is sysfs_root:
int sysfs_create_dir(struct kobject * kobj)
{
...
if (kobj->parent)
parent_sd = kobj->parent->sd;
else
parent_sd = &sysfs_root;
...But I do notice that we're not giving sysfs_root a name, so if you do hit the WARN for a duplicate entry in sysfs_root, you get a blank string for the location of the duplicate.
How about this instead?
From: Alex Chiang <[email protected]>
sysfs: give sysfs_root a proper name; display parent in duplicate entry WARN
Name sysfs_root "/".
Make sysfs_add_one tell you _where_ you're attempting to create a duplicate file to help debug.
Giving sysfs_root a proper name covers the case when trying to create multiple entries with the same name in the root of the sysfs tree.
---
Still would be nicer to get a full path.
I think that in the context of a sysfs WARN, claiming that you're trying to create a duplicate file in "/" really means "/sys" and shouldn't be confusing. Sample output:
sysfs: duplicate filename 'alex' can not be created in /
This maybe wants to be 2 patches, and I can split it up that way if you prefer.
---
fs/sysfs/dir.c +2 -1
@@ -459,7 +459,8 @@ int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) ret =__sysfs_add_one (acxt, sd);WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +"cannot be created in %s\n" , + sd->s_name, acxt->parent_sd->s_name);return ret; }
fs/sysfs/mount.c +1 -1
@@ -33,7 +33,7 @@ static const struct super_operations sysfs_ops = { };struct sysfs_dirent sysfs_root = { - .s_name ="" , + .s_name ="/" , .s_count =ATOMIC_INIT (1 ), .s_flags =SYSFS_DIR , .s_mode =S_IFDIR |S_IRWXU |S_IRUGO |S_IXUGO ,
Quoted 41 lines · Alex Chiang
* Greg KH <[email protected]>:
Quoted 11 lines · Alex Chiang
Quoted 7 lines
Give a better clue about where we might be creating duplicate files by displaying the parent's name as well.
Signed-off-by Alex Chiang <[email protected]>---
It would be nice to get a full path, but simply printing out the parent is cheap and more useful than what we have now.What happens if you don't have a parent? will this oops if you are creating a duplicate device in the root of the sysfs tree?
We won't oops because if you attempt to create a device in the root of the sysfs tree with a NULL parent, then we say that your parent is
sysfs_root:int
sysfs_create_dir(struct kobject * kobj){ ... if (kobj->parent) parent_sd = kobj->parent->sd; else parent_sd = &sysfs_root; ...But I do notice that we're not giving
sysfs_roota name, so if you do hit the WARN for a duplicate entry insysfs_root, you get a blank string for the location of the duplicate.How about this instead?
From: Alex Chiang <[email protected]>
sysfs: give
sysfs_roota proper name; display parent in duplicate entry WARNName
sysfs_root"/".Make
sysfs_add_onetell you _where_ you're attempting to create a duplicate file to help debug.
Quoted 7 lines
Giving
sysfs_roota proper name covers the case when trying to create multiple entries with the same name in the root of the sysfs tree.Signed-off-by Alex Chiang <[email protected]>---
Still would be nicer to get a full path.
It would, and you _almost_ might be able to get it, but it might take some work. We do store the last sysfs file accessed, and can compute the path of that as we have a struct file * to play with. You could walk the tree of devices backwards to reconstruct the full path to emulate this if you want to.
Quoted 3 lines
I think that in the context of a sysfs WARN, claiming that you're trying to create a duplicate file in "/" really means "/sys" and shouldn't be confusing. Sample output:
While you and I mount sysfs at /sys/ and it is the "expected" place for it to be, we shouldn't just assume that is where it is in the filesystem, especially as I don't where the container people are placing sysfs.
Quoted 4 lines
sysfs: duplicate filename 'alex' can not be created in /
This maybe wants to be 2 patches, and I can split it up that way if you prefer.
Sure, that would probably be best.
thanks,
greg k-h
* Greg KH <[email protected]>:
Quoted 65 lines · Alex Chiang
Quoted 41 lines
* Greg KH <[email protected]>:
Quoted 11 lines · Alex Chiang
Quoted 7 lines
Give a better clue about where we might be creating duplicate files by displaying the parent's name as well.
Signed-off-by Alex Chiang <[email protected]>---
It would be nice to get a full path, but simply printing out the parent is cheap and more useful than what we have now.What happens if you don't have a parent? will this oops if you are creating a duplicate device in the root of the sysfs tree?
We won't oops because if you attempt to create a device in the root of the sysfs tree with a NULL parent, then we say that your parent is
sysfs_root:int
sysfs_create_dir(struct kobject * kobj){ ... if (kobj->parent) parent_sd = kobj->parent->sd; else parent_sd = &sysfs_root; ...But I do notice that we're not giving
sysfs_roota name, so if you do hit the WARN for a duplicate entry insysfs_root, you get a blank string for the location of the duplicate.How about this instead?
From: Alex Chiang <[email protected]>
sysfs: give
sysfs_roota proper name; display parent in duplicate entry WARNName
sysfs_root"/".Make
sysfs_add_onetell you _where_ you're attempting to create a duplicate file to help debug.Quoted 7 lines
Giving
sysfs_roota proper name covers the case when trying to create multiple entries with the same name in the root of the sysfs tree.Signed-off-by Alex Chiang <[email protected]>---
Still would be nicer to get a full path.It would, and you _almost_ might be able to get it, but it might take some work. We do store the last sysfs file accessed, and can compute the path of that as we have a struct file * to play with. You could walk the tree of devices backwards to reconstruct the full path to emulate this if you want to.
Quoted 3 lines
I think that in the context of a sysfs WARN, claiming that you're trying to create a duplicate file in "/" really means "/sys" and shouldn't be confusing. Sample output:
While you and I mount sysfs at
/sys/and it is the "expected" place for it to be, we shouldn't just assume that is where it is in the filesystem, especially as I don't where the container people are placing sysfs.
Quoted 6 lines
Quoted 4 lines
sysfs: duplicate filename 'alex' can not be created in /
This maybe wants to be 2 patches, and I can split it up that way if you prefer.
Sure, that would probably be best.
Here's v3.
Seems like 1 patch makes sense because the logical change is that sysfs_add_one() now displays the full sysfs path to a duplicate entry. The fact that it relies on a helper function is an implementation detail. ;)
I tested it by hacking up a kernel to create duplicate entries in both sysfs_root, as well as creating duplicate entries under a random sysfs directory.
Examples:
-----------[ cut here ]------------
WARNING: at fs/sysfs/dir.c:488 sysfs_add_one+0xe0/0x100()
sysfs: cannot create duplicate filename '/alex'
------------[ cut here ]------------ WARNING: at fs/sysfs/dir.c:488 sysfs_add_one+0xe0/0x100() Hardware name: server rx6600
sysfs: cannot create duplicate filename '/bus/pci/slots/5/alex'
From: Alex Chiang <[email protected]>
sysfs: sysfs_add_one WARNs with full path to duplicate filename
As a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
We now will display warnings such as:
sysfs: cannot create duplicate filename '/foo'
when attempting to create multiple files named 'foo' in the sysfs root, or:
sysfs: cannot create duplicate filename '/bus/pci/slots/5/foo'
when attempting to create multiple files named 'foo' under a given directory in sysfs.
The path displayed is always a relative path to sysfs_root. The leading '/' in the path name refers to the sysfs_root mount point, and should not be confused with the "real" '/'.
Thanks to Alex Williamson for essentially writing sysfs_pathname.
---
The strcat(strcat()) is a little ugly, but concise and accurate.
Without the memset, I get all sorts of stack garbage when the path is finally printed out.
dir.c | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-)
fs/sysfs/dir.c +30 -2
@@ -434,6 +434,27 @@ int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) }/** +* sysfs_pathname - return full path to sysfs dirent +* @sd: sysfs_dirent whose path we want +* @path: caller allocated buffer +* +* Gives the name "/" to the sysfs_root entry; any path returned +* is relative to wherever sysfs is mounted. +* +* XXX: does no error checking on @path; assumes caller did something +* sane, like char path[PATH_MAX] +*/ +static char *sysfs_pathname (struct sysfs_dirent *sd,char *path) +{ +if (sd->s_parent) { +sysfs_pathname (sd->s_parent, path); +strcat (path,"/" ); + } +strcat (path, sd->s_name); +return path; +} + +/** * sysfs_add_one - add sysfs_dirent to parent * @acxt: addrm context to use * @sd: sysfs_dirent to be added
@@ -458,8 +479,15 @@ int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)int ret; ret =__sysfs_add_one (acxt, sd); -WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +if (ret == -EEXIST ) { +char path[PATH_MAX ]; +memset (path,0 ,PATH_MAX ); +WARN (1 ,KERN_WARNING +"sysfs: cannot create duplicate filename '%s'\n" , +strcat (strcat (sysfs_pathname (acxt->parent_sd, path),"/" ), + sd->s_name)); + } +return ret; }
fs/sysfs/dir.c int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) · line 483
Quoted 10 lines · Alex Chiang
sysfs:
sysfs_add_oneWARNs with full path to duplicate filenameAs a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
ret = __sysfs_add_one(acxt, sd);fs/sysfs/dir.c +2
-2-WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +if (ret == -EEXIST ) { +char path[PATH_MAX ];
Isn't that 4k on the stack, and a bit large to put there?
Thanks,
Kay
Quoted 7 lines · Kay Sievers
Quoted 4 lines · Alex Chiang
sysfs:
sysfs_add_oneWARNs with full path to duplicate filenameAs a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
Quoted 7 lines
fs/sysfs/dir.c int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) · line 483
Quoted 5 lines
ret = __sysfs_add_one(acxt, sd);fs/sysfs/dir.c +2
-2-WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +if (ret == -EEXIST ) { +char path[PATH_MAX ];Isn't that 4k on the stack, and a bit large to put there?
I agree, that's not ok. Alex, care to redo this?
thanks,
greg k-h
* Greg KH <[email protected]>:
Quoted 14 lines · Kay Sievers
Quoted 13 lines · Alex Chiang
Quoted 11 lines
sysfs:
sysfs_add_oneWARNs with full path to duplicate filenameAs a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
ret = __sysfs_add_one(acxt, sd);(quoted diff) +2
-2- WARN(ret == -EEXIST, KERN_WARNING "sysfs: duplicate filename '%s' " - "can not be created\n", sd->s_name); + if (ret == -EEXIST) { + char path[PATH_MAX];
Quoted 3 lines
Quoted 1 line
Isn't that 4k on the stack, and a bit large to put there?
I agree, that's not ok. Alex, care to redo this?
Here's v4. Adding Arjan to cc because I realized this may cause problems for kerneloops.org.
If we're displaying a full path now to something like:
/sys/bus/pci/devices/.../foo
Then the "..." will highly likely be different on every machine (even though the programming error is still the same).
Is this patch going to cause major heartburn?
Maybe it's more trouble than it's worth... :-/
Thanks.
/ac
From: Alex Chiang <[email protected]>
sysfs: sysfs_add_one WARNs with full path to duplicate filename
As a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
We now will display warnings such as:
sysfs: cannot create duplicate filename '/foo'
when attempting to create multiple files named 'foo' in the sysfs root, or:
sysfs: cannot create duplicate filename '/bus/pci/slots/5/foo'
when attempting to create multiple files named 'foo' under a given directory in sysfs.
The path displayed is always a relative path to sysfs_root. The leading '/' in the path name refers to the sysfs_root mount point, and should not be confused with the "real" '/'.
Thanks to Alex Williamson for essentially writing sysfs_pathname.
--- dir.c | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-)
---
fs/sysfs/dir.c +29 -2
@@ -434,6 +434,26 @@ int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) }/** +* sysfs_pathname - return full path to sysfs dirent +* @sd: sysfs_dirent whose path we want +* @path: caller allocated buffer +* +* Gives the name "/" to the sysfs_root entry; any path returned +* is relative to wherever sysfs is mounted. +* +* XXX: does no error checking on @path size +*/ +static char *sysfs_pathname (struct sysfs_dirent *sd,char *path) +{ +if (sd->s_parent) { +sysfs_pathname (sd->s_parent, path); +strcat (path,"/" ); + } +strcat (path, sd->s_name); +return path; +} + +/** * sysfs_add_one - add sysfs_dirent to parent * @acxt: addrm context to use * @sd: sysfs_dirent to be added
@@ -458,8 +478,15 @@ int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)int ret; ret =__sysfs_add_one (acxt, sd); -WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +if (ret == -EEXIST ) { +char *path =kzalloc (PATH_MAX ,GFP_KERNEL ); +WARN (1 ,KERN_WARNING +"sysfs: cannot create duplicate filename '%s'\n" , +strcat (strcat (sysfs_pathname (acxt->parent_sd, path),"/" ), + sd->s_name)); +kfree (path); + } +return ret; }
fs/sysfs/dir.c int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) · line 482
Quoted 2 lines · Alex Chiang
fs/sysfs/dir.c +2
-0+if (ret == -EEXIST ) { +char *path =kzalloc (PATH_MAX ,GFP_KERNEL );
You forgot to check the return value of kzalloc().
Another try?
8th time's a charm? :)
thanks,
greg k-h
* Greg KH <[email protected]>:
Quoted 9 lines · Alex Chiang
Review
Quoted 2 lines
(quoted diff) +2
-0+ if (ret == -EEXIST) { + char *path = kzalloc(PATH_MAX, GFP_KERNEL);You forgot to check the return value of
kzalloc().Another try?
8th time's a charm? :)
Yeah, you're too fast for me. I thought about that just as I walked away from my desk. ;)
What are we on, v6?
From: Alex Chiang <[email protected]>
sysfs: sysfs_add_one WARNs with full path to duplicate filename
As a debugging aid, it can be useful to know the full path to a duplicate file being created in sysfs.
We now will display warnings such as:
sysfs: cannot create duplicate filename '/foo'
when attempting to create multiple files named 'foo' in the sysfs root, or:
sysfs: cannot create duplicate filename '/bus/pci/slots/5/foo'
when attempting to create multiple files named 'foo' under a given directory in sysfs.
The path displayed is always a relative path to sysfs_root. The leading '/' in the path name refers to the sysfs_root mount point, and should not be confused with the "real" '/'.
Thanks to Alex Williamson for essentially writing sysfs_pathname.
--- dir.c | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-)
---
fs/sysfs/dir.c +30 -2
@@ -434,6 +434,26 @@ int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) }/** +* sysfs_pathname - return full path to sysfs dirent +* @sd: sysfs_dirent whose path we want +* @path: caller allocated buffer +* +* Gives the name "/" to the sysfs_root entry; any path returned +* is relative to wherever sysfs is mounted. +* +* XXX: does no error checking on @path size +*/ +static char *sysfs_pathname (struct sysfs_dirent *sd,char *path) +{ +if (sd->s_parent) { +sysfs_pathname (sd->s_parent, path); +strcat (path,"/" ); + } +strcat (path, sd->s_name); +return path; +} + +/** * sysfs_add_one - add sysfs_dirent to parent * @acxt: addrm context to use * @sd: sysfs_dirent to be added
@@ -458,8 +478,16 @@ int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)int ret; ret =__sysfs_add_one (acxt, sd); -WARN (ret == -EEXIST ,KERN_WARNING "sysfs: duplicate filename '%s' " -"can not be created\n" , sd->s_name); +if (ret == -EEXIST ) { +char *path =kzalloc (PATH_MAX ,GFP_KERNEL ); +WARN (1 ,KERN_WARNING +"sysfs: cannot create duplicate filename '%s'\n" , + (path ==NULL ) ? sd->s_name : +strcat (strcat (sysfs_pathname (acxt->parent_sd, path),"/" ), + sd->s_name)); +kfree (path); + } +return ret; }