Skip to contentSkip to conversation

jffs2: fix sparse errors: directive in argument list

PATCH In review Erico Nunes 6 participants 14 messages Nov 17, 2013 – Nov 20, 2013

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

PATCH 1/1 jffs2: fix sparse errors: directive in argument list

This patch fixes the following errors reported when running sparse:
fs/jffs2/super.c:378:1: error: directive in argument list fs/jffs2/super.c:380:1: error: directive in argument list fs/jffs2/super.c:381:1: error: directive in argument list fs/jffs2/super.c:383:1: error: directive in argument list

---
 fs/jffs2/super.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
fs/jffs2/super.c +9 -8
index 0defb1c..ec9e16f 100644
@@ -361,6 +361,14 @@ MODULE_ALIAS_FS("jffs2");
 static int __init init_jffs2_fs(void)
 {
 	int ret;
+	const char desc[] = "version 2.2."
+#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
+		" (NAND)"
+#endif
+#ifdef CONFIG_JFFS2_SUMMARY
+		" (SUMMARY) "
+#endif
+		" © 2001-2006 Red Hat, Inc.";
 
 	/* Paranoia checks for on-medium structures. If we ask GCC
 	   to pack them with __attribute__((packed)) then it _also_
@@ -374,14 +382,7 @@ static int __init init_jffs2_fs(void)
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
 
-	pr_info("version 2.2."
-#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
-	       " (NAND)"
-#endif
-#ifdef CONFIG_JFFS2_SUMMARY
-	       " (SUMMARY) "
-#endif
-	       " © 2001-2006 Red Hat, Inc.\n");
+	pr_info("%s\n", desc);
 
 	jffs2_inode_cachep = kmem_cache_create("jffs2_i",
 					     sizeof(struct jffs2_inode_info),
Signature · 1 line
1.8.4.2
#1 lore raw
Quoted 5 lines · Erico Nunes

This patch fixes the following errors reported when running sparse:
fs/jffs2/super.c:378:1: error: directive in argument list fs/jffs2/super.c:380:1: error: directive in argument list fs/jffs2/super.c:381:1: error: directive in argument list fs/jffs2/super.c:383:1: error: directive in argument list

Seems like a sparse error more than anything else. (adding sparse mailing list)

Also you need to add a "Signed-off-by:" line
with your email address.

see: Documentation/SubmittingPatches

Quoted 29 lines
---
 fs/jffs2/super.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
fs/jffs2/super.c +8 -2
index 0defb1c..ec9e16f 100644
@@ -361,6 +361,14 @@ MODULE_ALIAS_FS("jffs2");
 static int __init init_jffs2_fs(void)
 {
 	int ret;
+	const char desc[] = "version 2.2."
+#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
+		" (NAND)"
+#endif
+#ifdef CONFIG_JFFS2_SUMMARY
+		" (SUMMARY) "
+#endif
+		" © 2001-2006 Red Hat, Inc.";
 
 	/* Paranoia checks for on-medium structures. If we ask GCC
 	   to pack them with __attribute__((packed)) then it _also_
@@ -374,14 +382,7 @@ static int __init init_jffs2_fs(void)
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
 
-	pr_info("version 2.2."
-#ifdef CONFIG_JFFS2_FS_WRITEBUFFER

fs/jffs2/super.c static int __init init_jffs2_fs(void) · line 388

Quoted 10 lines
fs/jffs2/super.c +1 -6
-	       " (NAND)"
-#endif
-#ifdef CONFIG_JFFS2_SUMMARY
-	       " (SUMMARY) "
-#endif
-	       " © 2001-2006 Red Hat, Inc.\n");
+	pr_info("%s\n", desc);
 
 	jffs2_inode_cachep = kmem_cache_create("jffs2_i",
 					     sizeof(struct jffs2_inode_info),

--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#2 lore raw

Thanks for your reply.

I'll resubmit shortly.

Do you mean it as an error in the sparse tool?
I don't think so, I took a look and it seems to be designed to output an error for that case.

Quoted 52 lines · Joe Perches
Quoted 5 lines · Erico Nunes

This patch fixes the following errors reported when running sparse:
fs/jffs2/super.c:378:1: error: directive in argument list fs/jffs2/super.c:380:1: error: directive in argument list fs/jffs2/super.c:381:1: error: directive in argument list fs/jffs2/super.c:383:1: error: directive in argument list

Seems like a sparse error more than anything else. (adding sparse mailing list)

Also you need to add a "Signed-off-by:" line
with your email address.

see: Documentation/SubmittingPatches

Quoted 37 lines
---
 fs/jffs2/super.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
fs/jffs2/super.c +9 -8
index 0defb1c..ec9e16f 100644
@@ -361,6 +361,14 @@ MODULE_ALIAS_FS("jffs2");
 static int __init init_jffs2_fs(void)
 {
      int ret;
+     const char desc[] = "version 2.2."
+#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
+             " (NAND)"
+#endif
+#ifdef CONFIG_JFFS2_SUMMARY
+             " (SUMMARY) "
+#endif
+             " © 2001-2006 Red Hat, Inc.";
 
      /* Paranoia checks for on-medium structures. If we ask GCC
         to pack them with __attribute__((packed)) then it _also_
@@ -374,14 +382,7 @@ static int __init init_jffs2_fs(void)
      BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
      BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
 
-     pr_info("version 2.2."
-#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
-            " (NAND)"
-#endif
-#ifdef CONFIG_JFFS2_SUMMARY
-            " (SUMMARY) "
-#endif
-            " © 2001-2006 Red Hat, Inc.\n");
+     pr_info("%s\n", desc);
 
Quoted 5 lines

fs/jffs2/super.c static int __init init_jffs2_fs(void) · line 388

Quoted 2 lines
fs/jffs2/super.c +0 -0
      jffs2_inode_cachep = kmem_cache_create("jffs2_i",
                                           sizeof(struct jffs2_inode_info),

--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

#3 lore raw

PATCH 1/1 jffs2: fix sparse errors: directive in argument list

This patch fixes the following errors reported when running sparse:
fs/jffs2/super.c:378:1: error: directive in argument list fs/jffs2/super.c:380:1: error: directive in argument list fs/jffs2/super.c:381:1: error: directive in argument list fs/jffs2/super.c:383:1: error: directive in argument list

---
 fs/jffs2/super.c | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)
fs/jffs2/super.c +9 -8
index 0defb1c..ec9e16f 100644
@@ -361,6 +361,14 @@ MODULE_ALIAS_FS("jffs2");
 static int __init init_jffs2_fs(void)
 {
 	int ret;
+	const char desc[] = "version 2.2."
+#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
+		" (NAND)"
+#endif
+#ifdef CONFIG_JFFS2_SUMMARY
+		" (SUMMARY) "
+#endif
+		" © 2001-2006 Red Hat, Inc.";
 
 	/* Paranoia checks for on-medium structures. If we ask GCC
 	   to pack them with __attribute__((packed)) then it _also_
@@ -374,14 +382,7 @@ static int __init init_jffs2_fs(void)
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_inode) != 68);
 	BUILD_BUG_ON(sizeof(struct jffs2_raw_summary) != 32);
 
-	pr_info("version 2.2."
-#ifdef CONFIG_JFFS2_FS_WRITEBUFFER
-	       " (NAND)"
-#endif
-#ifdef CONFIG_JFFS2_SUMMARY
-	       " (SUMMARY) "
-#endif
-	       " © 2001-2006 Red Hat, Inc.\n");
+	pr_info("%s\n", desc);
 
 	jffs2_inode_cachep = kmem_cache_create("jffs2_i",
 					     sizeof(struct jffs2_inode_info),
Signature · 1 line
1.8.4.2
#4 lore raw
In reply to Erico Nunes
Quoted 1 line · Erico Nunes

Do you mean it as an error in the sparse tool?

Yes. I think it's a defect in how sparse
treats string concatenation.

That style:

	printk("%s\n",
#ifdef FOO
	"foo"
#endif
#ifdef BAR
	"bar"
#endif
	"string");

is pretty common in the kernel sources.

The patch itself is otherwise fine, but
perhaps unnecessary.

#5 lore raw
Quoted 17 lines · Joe Perches
Quoted 1 line · Erico Nunes

Do you mean it as an error in the sparse tool?

Yes. I think it's a defect in how sparse
treats string concatenation.

That style:

        printk("%s\n",
#ifdef FOO
        "foo"
#endif
#ifdef BAR
        "bar"
#endif
        "string");
Quoted 4 lines

is pretty common in the kernel sources.

The patch itself is otherwise fine, but
perhaps unnecessary.

I agree with Joe, the patch fixes a non-issue.

Signature · 2 lines
Thanks,
//richard
#6 lore raw
In reply to Joe Perches
Quoted 17 lines · Joe Perches
Quoted 1 line · Erico Nunes

Do you mean it as an error in the sparse tool?

Yes. I think it's a defect in how sparse
treats string concatenation.

That style:

	printk("%s\n",
#ifdef FOO
	"foo"
#endif
#ifdef BAR
	"bar"
#endif
	"string");
Quoted 1 line

is pretty common in the kernel sources.

... and it's perfectly fine, until somebody starts playing in nasal daemon country and do that in *macro* arguments. And a nasal daemon country it is - it's an undefined behaviour. See 6.10.3p11 in C99. And trying to define a semantics for that gets real ugly real fast. sparse matches gcc behaviour (I hope), but it warns about such abuses. It's a defect, all right - one being reported by sparse.

Folks, please, RTFStandard if you decide to play clever games with preprocessing. Chapter 6.10 is not particulary long or complicated. C99 has improved the preprocessor semantics a whole lot compared to the earlier horrible mess (mostly by defining it in terms of token stream transformations rather then text ones), but it's still very easy to abuse...

#7 lore raw

PATCH 1/1 Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

[+linux-sparse and Chris]

Quoted 4 lines · Al Viro
Quoted 3 lines · Joe Perches

Yes. I think it's a defect in how sparse
treats string concatenation.

Quoted 8 lines
Quoted 1 line

That style [... with printk ...] is pretty common in the kernel sources.

... and it's perfectly fine, until somebody starts playing in nasal daemon country and do that in *macro* arguments. And a nasal daemon country it is - it's an undefined behaviour. See 6.10.3p11 in C99. And trying to define a semantics for that gets real ugly real fast. sparse matches gcc behaviour (I hope), but it warns about such abuses. It's a defect, all right - one being reported by sparse.

Perhaps the following tweak to the error message would make this subtlety clearer?

Cheers,
Greg

From: Greg Price <[email protected]>
Date: Sun, 17 Nov 2013 17:57:41 -0800
Subject: [PATCH] Clarify error on directive in macro arguments

Preprocessor directives in the arguments of a real function are innocuous and in some contexts common. If a developer doesn't realize that a "function" is implemented as a macro, they may mistake this error for a false alarm.

See http://www.spinics.net/lists/kernel/msg1636974.html
and http://www.spinics.net/lists/kernel/msg1636976.html
for an example.

Easy enough to clarify that this is a macro, so do it.

---
 pre-process.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
pre-process.c +1 -1
index d521318..db58a97 100644
@@ -204,7 +204,7 @@ static struct token *collect_arg(struct token *prev, int vararg, struct position
 		if (next->pos.newline && match_op(next, '#')) {
 			if (!next->pos.noexpand) {
 				sparse_error(next->pos,
-					     "directive in argument list");
+					     "directive in macro argument list");
 				preprocessor_line(stream, p);
 				__free_token(next);	/* Free the '#' token */
 				continue;
Signature · 5 lines
1.8.3.2

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
#8 lore raw

Re: [PATCH] Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

Quoted 16 lines · Greg Price

[+linux-sparse and Chris]

Quoted 4 lines · Al Viro
Quoted 3 lines · Joe Perches

Yes. I think it's a defect in how sparse
treats string concatenation.

Quoted 8 lines
Quoted 1 line

That style [... with printk ...] is pretty common in the kernel sources.

... and it's perfectly fine, until somebody starts playing in nasal daemon country and do that in *macro* arguments. And a nasal daemon country it is - it's an undefined behaviour. See 6.10.3p11 in C99. And trying to define a semantics for that gets real ugly real fast. sparse matches gcc behaviour (I hope), but it warns about such abuses. It's a defect, all right - one being reported by sparse.

Quoted 2 lines

Perhaps the following tweak to the error message would make this subtlety clearer?

Maybe, but this case isn't a macro. It's a function. Dunno if differentiating when it's a macro or a function is difficult though.

#9 lore raw

Re: [PATCH] Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

Quoted 7 lines · Joe Perches

On Sun, 2013-11-17 at 21:07 -0500, Greg Price wrote:

Maybe, but this case isn't a macro. It's a function. Dunno if differentiating when it's a macro or a function is difficult though.

The case which was initially reported by sparse at
http://www.spinics.net/lists/kernel/msg1636974.html was using pr_info (which is a macro) and not printk.

#10 lore raw

Re: [PATCH] Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

In reply to Joe Perches
Quoted 9 lines · Joe Perches
Quoted 5 lines
Quoted 2 lines

sparse matches gcc behaviour (I hope), but it warns about such abuses. It's a defect, all right - one being reported by sparse.

Perhaps the following tweak to the error message would make this subtlety clearer?

Maybe, but this case isn't a macro. It's a function. Dunno if differentiating when it's a macro or a function is difficult though.

In which case? With printk() it's perfectly fine and sparse will not complain at all. With pr_info(), OTOH, we have

#define pr_info(fmt, ...) \
        printk(KERN_INFO pr_fmt(fmt), ##__VA_ARGS__)

and when you start playing that kind of games with it, you get warnings.

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

#11 lore raw

Re: [PATCH] Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

In reply to Joe Perches
Quoted 7 lines · Joe Perches
Quoted 2 lines · Greg Price

Perhaps the following tweak to the error message would make this subtlety clearer?

Maybe, but this case isn't a macro. It's a function. Dunno if differentiating when it's a macro or a function is difficult though.

Yeah, this error message is already only emitted for directives in macro arguments -- in this case, pr_info. It's in sparse's preprocessor code; the error arises when a directive is spotted while parsing a macro's arguments. By the time sparse (or an idealized C compiler) parses the arguments of a real function, the token stream is already the output of the preprocessor and any directives are gone.

Cheers,
Greg

Reviewed-by on v1 1/1
#12 lore raw

Re: [PATCH] Clarify error on directive in macro arguments (Re: [PATCH] jffs2: fix sparse errors: directive in argument list)

In reply to Greg Price
Quoted 9 lines · Greg Price

From: Greg Price <[email protected]>
Date: Sun, 17 Nov 2013 17:57:41 -0800
Subject: [PATCH] Clarify error on directive in macro arguments

Preprocessor directives in the arguments of a real function are innocuous and in some contexts common. If a developer doesn't realize that a "function" is implemented as a macro, they may mistake this error for a false alarm.

Quoted 7 lines

See http://www.spinics.net/lists/kernel/msg1636974.html
and http://www.spinics.net/lists/kernel/msg1636976.html
for an example.

Easy enough to clarify that this is a macro, so do it.

Good call.

Quoted 22 lines
 pre-process.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
pre-process.c +1 -1
index d521318..db58a97 100644
@@ -204,7 +204,7 @@ static struct token *collect_arg(struct token *prev, int vararg, struct position
 		if (next->pos.newline && match_op(next, '#')) {
 			if (!next->pos.noexpand) {
 				sparse_error(next->pos,
-					     "directive in argument list");
+					     "directive in macro argument list");
 				preprocessor_line(stream, p);
 				__free_token(next);	/* Free the '#' token */
 				continue;
Signature · 5 lines
1.8.3.2
--
To unsubscribe from this list: send the line "unsubscribe linux-sparse" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
#13 lore raw
In reply to Al Viro
Quoted 27 lines · Al Viro
Quoted 17 lines · Joe Perches
Quoted 1 line · Erico Nunes

Do you mean it as an error in the sparse tool?

Yes. I think it's a defect in how sparse
treats string concatenation.

That style:

	printk("%s\n",
#ifdef FOO
	"foo"
#endif
#ifdef BAR
	"bar"
#endif
	"string");
Quoted 1 line

is pretty common in the kernel sources.

... and it's perfectly fine, until somebody starts playing in nasal daemon country and do that in *macro* arguments. And a nasal daemon country it is - it's an undefined behaviour. See 6.10.3p11 in C99. And trying to define a semantics for that gets real ugly real fast. sparse matches gcc behaviour (I hope), but it warns about such abuses. It's a defect, all right - one being reported by sparse.

Quoted 6 lines

Folks, please, RTFStandard if you decide to play clever games with preprocessing. Chapter 6.10 is not particulary long or complicated. C99 has improved the preprocessor semantics a whole lot compared to the earlier horrible mess (mostly by defining it in terms of token stream transformations rather then text ones), but it's still very easy to abuse...

And since pr_foo (and the underlying pr_fmt) are already macros, that's exactly the problem.

- Josh Triplett