seq_file: fix clang warning for NULL pointer arithmetic
PATCH v2 1/1 seq_file: fix clang warning for NULL pointer arithmetic
From: Arnd Bergmann <[email protected]>
Clang points out that adding something to NULL is notallowed in standard C:
fs/kernfs/file.c:127:15: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
return NULL + !*ppos;
~~~~ ^
fs/seq_file.c:529:14: warning: performing pointer arithmetic on a
null pointer has undefined behavior [-Wnull-pointer-arithmetic]
return NULL + (*pos == 0);Rephrase the code to be extra explicit about the valid, giving them named SEQ_OPEN_EOF and SEQ_OPEN_SINGLE definitions. The instance in kernfs was copied from single_start, so fix both at once.
---
v2: add the named macros after Christoph Hellwig pointed out that my original logic was too ugly.
Suggestions for better names welcome
--- fs/kernfs/file.c | 8 ++++---- fs/seq_file.c | 4 ++-- include/linux/seq_file.h | 3 +++ 3 files changed, 9 insertions(+), 6 deletions(-)
fs/kernfs/file.c +4 -4
@@ -121,10 +121,10 @@ static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)return next; }else {/* -* The same behavior and code as single_open(). Returns -* !NULL if pos is at the beginning; otherwise, NULL. +* The same behavior and code as single_open(). Continues +* if pos is at the beginning; otherwise, EOF. */ -return NULL + !*ppos; +return *ppos ?SEQ_OPEN_SINGLE :SEQ_OPEN_EOF ; } }
@@ -145,7 +145,7 @@ static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos)* terminate after the initial read. */ ++*ppos; -return NULL ; +return SEQ_OPEN_EOF ; } }
fs/seq_file.c +2 -2
@@ -526,13 +526,13 @@ EXPORT_SYMBOL(seq_dentry);static void *single_start (struct seq_file *p,loff_t *pos) { -return NULL + (*pos ==0 ); +return *pos ==0 ?SEQ_OPEN_SINGLE :SEQ_OPEN_EOF ; }static void *single_next (struct seq_file *p,void *v,loff_t *pos) { ++*pos; -return NULL ; +return SEQ_OPEN_EOF ; }static void single_stop (struct seq_file *p,void *v)
include/linux/seq_file.h +3 -0
@@ -37,6 +37,9 @@ struct seq_operations {#define SEQ_SKIP 1 +#define SEQ_OPEN_EOF (void *)0 +#define SEQ_OPEN_SINGLE (void *)1 +/** * seq_has_overflowed - check if the buffer has overflowed * @m: the seq_file handle
Signature · 1 line
2.27.0
Quoted 5 lines
fs/kernfs/file.c +0
-0
fs/kernfs/file.c static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos) · line 127
Quoted 10 lines
fs/kernfs/file.c +3
-3@@ -121,10 +121,10 @@ static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)return next; }else {/* -* The same behavior and code as single_open(). Returns -* !NULL if pos is at the beginning; otherwise, NULL. +* The same behavior and code as single_open(). Continues +* if pos is at the beginning; otherwise, EOF. */ -return NULL + !*ppos; +return *ppos ?SEQ_OPEN_SINGLE :SEQ_OPEN_EOF ;
Why the somewhat obsfucating unary expression instead of a good old if?
e.g.
return next; } if (*ppos) retun SEQ_OPEN_SINGLE; return NULL;
fs/kernfs/file.c static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos) · line 148
Quoted 3 lines
fs/kernfs/file.c +1
-1++*ppos; -return NULL ; +return SEQ_OPEN_EOF ;
I don't think SEQ_OPEN_EOF is all that useful. NULL is the documented end case already.
include/linux/seq_file.h struct seq_operations { · line 41
Quoted 10 lines
include/linux/seq_file.h +2
-0@@ -37,6 +37,9 @@ struct seq_operations {#define SEQ_SKIP 1 +#define SEQ_OPEN_EOF (void *)0 +#define SEQ_OPEN_SINGLE (void *)1
I think SEQ_OPEN_SINGLE also wants a comment documenting it. AFAICS the reason for it is that ->start needs to return something non-NULL for the seq_file code to make progress, and there is nothing better for the single_open case.
Quoted 28 lines · Christoph Hellwig
Quoted 5 lines
fs/kernfs/file.c +0
-0fs/kernfs/file.c static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos) · line 127
Quoted 10 lines
fs/kernfs/file.c +3
-3@@ -121,10 +121,10 @@ static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)return next; }else {/* -* The same behavior and code as single_open(). Returns -* !NULL if pos is at the beginning; otherwise, NULL. +* The same behavior and code as single_open(). Continues +* if pos is at the beginning; otherwise, EOF. */ -return NULL + !*ppos; +return *ppos ?SEQ_OPEN_SINGLE :SEQ_OPEN_EOF ;Why the somewhat obsfucating unary expression instead of a good old if?
e.g.
return next; } if (*ppos) retun SEQ_OPEN_SINGLE; return NULL;
Quoted 6 lines
fs/kernfs/file.c static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos) · line 148
Quoted 3 lines
fs/kernfs/file.c +1
-1++*ppos; -return NULL ; +return SEQ_OPEN_EOF ;I don't think
SEQ_OPEN_EOFis all that useful. NULL is the documented end case already.
Right, Al already pointed out the same thing on IRC.
Quoted 8 lines
Quoted 8 lines
include/linux/seq_file.h +0
-0@@ -37,6 +37,9 @@ struct seq_operations {#define SEQ_SKIP 1
Quoted 7 lines
include/linux/seq_file.h struct seq_operations { · line 41
Quoted 2 lines
include/linux/seq_file.h +2
-0+#define SEQ_OPEN_EOF (void *)0 +#define SEQ_OPEN_SINGLE (void *)1I think
SEQ_OPEN_SINGLEalso wants a comment documenting it. AFAICS the reason for it is that ->start needs to return something non-NULL for theseq_filecode to make progress, and there is nothing better for thesingle_opencase.
Ok.
Arnd