kdb: prevent possible null deref in kdb_msg_write
PATCH 1/1 kdb: prevent possible null deref in kdb_msg_write
kdb_msg_write operates on a global struct kgdb_io * called dbg_io_ops.
Although it is initialized in debug_core.c, there's a null check in kdb_msg_write which implies that it can be null whenever we dereference it in this function call.
Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if dbg_io_ops is not properly initialized.
--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)
kernel/debug/kdb/kdb_io.c +8 -7
@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ; -while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +const char *cp = msg; +int len = msg_len; + +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {
Signature · 1 line
2.27.0
Quoted 22 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.Although it is initialized in
debug_core.c, there's a null check inkdb_msg_writewhich implies that it can be null whenever we dereference it in this function call.Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if
dbg_io_opsis not properly initialized.Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0
kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 8 lines
kernel/debug/kdb/kdb_io.c +2
-3@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ;
This looks wrong. The message should be printed to the consoles even when dbg_io_ops is NULL. I mean that the for_each_console(c) cycle should always get called.
Well, the code really looks racy. dbg_io_ops is set under kgdb_registration_lock. IMHO, it should also get accessed under this lock.
It seems that the race is possible. kdb_msg_write() is called from vkdb_printf(). This function is serialized on more CPUs using kdb_printf_cpu lock. But it is not serialized with kgdb_register_io_module() and kgdb_unregister_io_module() calls.
But I might miss something. dbg_io_ops is dereferenced on many other locations without any check.
Quoted 4 lines
kernel/debug/kdb/kdb_io.c +0
-3-while (len--) { - dbg_io_ops->write_char (*cp); - cp++;
kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 563
Quoted 10 lines
kernel/debug/kdb/kdb_io.c +6
-1- } +const char *cp = msg; +int len = msg_len; + +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {
You probably got confused by this new code:
if (c == dbg_io_ops->cons) continue;
It dereferences dbg_io_ops without NULL check. It should probably get replaced by:
if (dbg_io_ops && c == dbg_io_ops->cons) continue;
Daniel, Sumit, could you please put some light on this?
Best Regards,
Petr
Quoted 26 lines · Petr Mladek
Quoted 25 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.Although it is initialized in
debug_core.c, there's a null check inkdb_msg_writewhich implies that it can be null whenever we dereference it in this function call.Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if
dbg_io_opsis not properly initialized.Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ;
Quoted 9 lines
kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 5 lines
kernel/debug/kdb/kdb_io.c +2
-3-if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ;This looks wrong. The message should be printed to the consoles even when
dbg_io_opsis NULL. I mean that thefor_each_console(c)cycle should always get called.
Please, forget this mail. Daniel explained that dbg_io_ops must have been set when this function gets called.
I am sorry for the noise.
Best Regards,
Petr
Quoted 36 lines · Petr Mladek
Quoted 22 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.Although it is initialized in
debug_core.c, there's a null check inkdb_msg_writewhich implies that it can be null whenever we dereference it in this function call.Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if
dbg_io_opsis not properly initialized.Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 8 lines
kernel/debug/kdb/kdb_io.c +2
-3@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ;This looks wrong. The message should be printed to the consoles even when
dbg_io_opsis NULL. I mean that thefor_each_console(c)cycle should always get called.
Quoted 7 lines
Well, the code really looks racy.
dbg_io_opsis set underkgdb_registration_lock. IMHO, it should also get accessed under this lock.It seems that the race is possible.
kdb_msg_write()is called fromvkdb_printf(). This function is serialized on more CPUs usingkdb_printf_cpulock. But it is not serialized withkgdb_register_io_module()andkgdb_unregister_io_module()calls.
We can't take the lock from the trap handler itself since we cannot have spinlocks contended between regular threads and the debug trap (which could be an NMI).
Instead, the call to kgdb_unregister_callbacks() at the beginning of kgdb_unregister_io_module() should render kdb_msg_write() unreachable prior to dbg_io_ops becoming NULL.
As it happens I am starting to believe there is a race in this area but the race is between register/unregister calls rather than against the trap handler (if there were register/unregister races then the trap handler is be a potential victim of the race though).
Quoted 2 lines
But I might miss something.
dbg_io_opsis dereferenced on many other locations without any check.
There is already a paranoid "just in case there are bugs" check in kgdb_io_ready() so in any case I think the check in kdb_msg_write() can simply be removed.
As I said in my other post, if dbg_io_ops were ever NULL then the system is completely hosed anyway: we can never receive the keystroke needed to leave the debugger... and may not be able to tell anybody why.
Quoted 20 lines
Quoted 4 lines
kernel/debug/kdb/kdb_io.c +0
-3-while (len--) { - dbg_io_ops->write_char (*cp); - cp++;kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 563
Quoted 10 lines
kernel/debug/kdb/kdb_io.c +6
-1- } +const char *cp = msg; +int len = msg_len; + +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {You probably got confused by this new code:
if (c == dbg_io_ops->cons) continue;
Quoted 7 lines
It dereferences
dbg_io_opswithout NULL check. It should probably get replaced by:if (dbg_io_ops && c == dbg_io_ops->cons) continue;Daniel, Sumit, could you please put some light on this?
As above, I think the NULL check that confuses coverity can simply be removed.
Daniel.
PATCH v2 1/1 kdb: remove unnecessary null check of dbg_io_ops
kdb_msg_write operates on a global struct kgdb_io * called dbg_io_ops.
It's initialized in debug_core.c and checked throughout the debug flow.
There's a null check in kdb_msg_write which triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.
Coverity scanner caught this as CID 1465042.
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
--- kernel/debug/kdb/kdb_io.c | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
kernel/debug/kdb/kdb_io.c +5 -7
@@ -549,14 +549,12 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +const char *cp = msg; +int len = msg_len; -while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {
Signature · 1 line
2.27.0
Doug Anderson
reviewerRe: [PATCH v2] kdb: remove unnecessary null check of dbg_io_ops
Hi,
Quoted 25 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.It's initialized in
debug_core.cand checked throughout the debug flow.There's a null check in
kdb_msg_writewhich triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.Coverity scanner caught this as CID 1465042.
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0
kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 8 lines
kernel/debug/kdb/kdb_io.c +2
-3@@ -549,14 +549,12 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +const char *cp = msg; +int len = msg_len;
kernel/debug/kdb/kdb_io.c:552:14:
warning: ISO C90 forbids mixing declarations and code [-Wdeclaration-after-statement]
-Doug
Re: [PATCH v2] kdb: remove unnecessary null check of dbg_io_ops
Quoted 31 lines · On June 30, 2020 00:16:54 Doug Anderson <[email protected]> wrote:
Hi,
Quoted 28 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.It's initialized in
debug_core.cand checked throughout the debug flow.There's a null check in
kdb_msg_writewhich triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.Coverity scanner caught this as CID 1465042.
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
Signed-off-by Cengiz Can <[email protected]>---
kernel/debug/kdb/kdb_io.c| 12 +++++-------1 file changed, 5 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0@@ -549,14 +549,12 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ;
Quoted 9 lines
kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 5 lines
kernel/debug/kdb/kdb_io.c +2
-3-if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +const char *cp = msg; +int len = msg_len;
kernel/debug/kdb/kdb_io.c:552:14:
warning: ISO C90 forbids mixing declarations and code [-Wdeclaration-after-statement]
Oops!
Sorry for that..
I admit I didn't compile check my second attempt.
/me ducks and covers
Will fix it asap.
Thanks!
Quoted 2 lines
-Doug
Quoted 96 lines · Daniel Thompson
Quoted 36 lines · Petr Mladek
Quoted 22 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.Although it is initialized in
debug_core.c, there's a null check inkdb_msg_writewhich implies that it can be null whenever we dereference it in this function call.Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if
dbg_io_opsis not properly initialized.Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +0
-0kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 553
Quoted 8 lines
kernel/debug/kdb/kdb_io.c +2
-3@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ;This looks wrong. The message should be printed to the consoles even when
dbg_io_opsis NULL. I mean that thefor_each_console(c)cycle should always get called.Quoted 7 lines
Well, the code really looks racy.
dbg_io_opsis set underkgdb_registration_lock. IMHO, it should also get accessed under this lock.It seems that the race is possible.
kdb_msg_write()is called fromvkdb_printf(). This function is serialized on more CPUs usingkdb_printf_cpulock. But it is not serialized withkgdb_register_io_module()andkgdb_unregister_io_module()calls.We can't take the lock from the trap handler itself since we cannot have spinlocks contended between regular threads and the debug trap (which could be an NMI).
Instead, the call to
kgdb_unregister_callbacks()at the beginning ofkgdb_unregister_io_module()should renderkdb_msg_write()unreachable prior todbg_io_opsbecoming NULL.As it happens I am starting to believe there is a race in this area but the race is between register/unregister calls rather than against the trap handler (if there were register/unregister races then the trap handler is be a potential victim of the race though).
Quoted 2 lines
But I might miss something.
dbg_io_opsis dereferenced on many other locations without any check.There is already a paranoid "just in case there are bugs" check in
kgdb_io_ready()so in any case I think the check inkdb_msg_write()can simply be removed.As I said in my other post, if
dbg_io_opswere ever NULL then the system is completely hosed anyway: we can never receive the keystroke needed to leave the debugger... and may not be able to tell anybody why.Quoted 23 lines
Quoted 4 lines
kernel/debug/kdb/kdb_io.c +0
-3-while (len--) { - dbg_io_ops->write_char (*cp); - cp++;kernel/debug/kdb/kdb_io.c static void kdb_msg_write(const char *msg, int msg_len) · line 563
Quoted 10 lines
kernel/debug/kdb/kdb_io.c +6
-1- } +const char *cp = msg; +int len = msg_len; + +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {You probably got confused by this new code:
if (c == dbg_io_ops->cons) continue;It dereferences
dbg_io_opswithout NULL check. It should probably get replaced by:
Quoted 8 lines
Quoted 4 lines
if (dbg_io_ops && c == dbg_io_ops->cons) continue;Daniel, Sumit, could you please put some light on this?
As above, I think the NULL check that confuses coverity can simply be removed.
+1
-Sumit
Quoted 2 lines
Daniel.
PATCH v3 1/1 kdb: remove unnecessary null check of dbg_io_ops
kdb_msg_write operates on a global struct kgdb_io * called dbg_io_ops.
It's initialized in debug_core.c and checked throughout the debug flow.
There's a null check in kdb_msg_write which triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.
Coverity scanner caught this as CID 1465042.
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
--- kernel/debug/kdb/kdb_io.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
kernel/debug/kdb/kdb_io.c +7 -7
@@ -545,18 +545,18 @@ static int kdb_search_string(char *searched, char *searchfor)static void kdb_msg_write (const char *msg,int msg_len) {struct console *c; +const char *cp; +int len;if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; + cp = msg; + len = msg_len; -while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {
Signature · 1 line
2.27.0
Re: [PATCH v3] kdb: remove unnecessary null check of dbg_io_ops
Quoted 12 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.It's initialized in
debug_core.cand checked throughout the debug flow.There's a null check in
kdb_msg_writewhich triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.Coverity scanner caught this as CID 1465042.
Quoted 8 lines
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
Quoted 33 lines
kernel/debug/kdb/kdb_io.c +7
-8@@ -545,18 +545,18 @@ static int kdb_search_string(char *searched, char *searchfor)static void kdb_msg_write (const char *msg,int msg_len) {struct console *c; +const char *cp; +int len;if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; + cp = msg; + len = msg_len; -while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) { --2.27.0
Re: [PATCH v3] kdb: remove unnecessary null check of dbg_io_ops
Quoted 16 lines · Sumit Garg
Quoted 14 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.It's initialized in
debug_core.cand checked throughout the debug flow.There's a null check in
kdb_msg_writewhich triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.Coverity scanner caught this as CID 1465042.
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
Quoted 8 lines
kernel/debug/kdb/kdb_io.c static int kdb_search_string(char *searched, char *searchfor) · line 560
Quoted 8 lines
kernel/debug/kdb/kdb_io.c +3
-4-while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }
Despite being in the original code this can be simple done in two lines:
while (len--) dbg_io_ops->write_char(*cp++);
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3] kdb: remove unnecessary null check of dbg_io_ops
In reply to Cengiz CanHi,
Quoted 12 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.It's initialized in
debug_core.cand checked throughout the debug flow.There's a null check in
kdb_msg_writewhich triggers static analyzers and gives the (almost entirely wrong) impression that it can be null.Coverity scanner caught this as CID 1465042.
Quoted 7 lines
I have removed the unnecessary null check and eliminated false-positive forward null dereference warning.
Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
Re: [PATCH v3] kdb: remove unnecessary null check of dbg_io_ops
Hello Daniel,
Quoted 3 lines · Doug Anderson
Reviewed-by Douglas Anderson <[email protected]>Tested-by Douglas Anderson <[email protected]>
Wanted to ask about the status of this proposed patch.
I have checked your tree in git.kernel.org but you might be collecting them somewhere else perhaps.
Thank you for your time
Signature · 2 lines
Cengiz Can @cengiz_io
Re: [PATCH v3] kdb: remove unnecessary null check of dbg_io_ops
Quoted 11 lines · Cengiz Can
Hello Daniel,
Quoted 3 lines · Doug Anderson
Reviewed-by Douglas Anderson <[email protected]>Tested-by Douglas Anderson <[email protected]>Wanted to ask about the status of this proposed patch.
I have checked your tree in git.kernel.org but you might be collecting them somewhere else perhaps.
It's applied... but then holiday happened. Should be pushed out soon.
Daniel.
Quoted 11 lines · Cengiz Can
kdb_msg_writeoperates on a globalstruct kgdb_io *calleddbg_io_ops.Although it is initialized in
debug_core.c, there's a null check inkdb_msg_writewhich implies that it can be null whenever we dereference it in this function call.Coverity scanner caught this as CID 1465042.
I have modified the function to bail out if
dbg_io_opsis not properly initialized.
That can't possibly be the right fix!
If dbg_io_ops were NULL in this part of the code then the system is seriously broken and we would need to panic()... but since we know that is isn't NULL (as you said, we already checked it before we entered kdb) then we can just remove the check.
Daniel.
Quoted 36 lines
Signed-off-by Cengiz Can <[email protected]>--- kernel/debug/kdb/kdb_io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)kernel/debug/kdb/kdb_io.c +8
-7@@ -549,14 +549,15 @@ static void kdb_msg_write(const char *msg, int msg_len)if (msg_len ==0 )return ; -if (dbg_io_ops) { -const char *cp = msg; -int len = msg_len; +if (!dbg_io_ops) +return ; -while (len--) { - dbg_io_ops->write_char (*cp); - cp++; - } +const char *cp = msg; +int len = msg_len; + +while (len--) { + dbg_io_ops->write_char (*cp); + cp++; }for_each_console (c) {Signature · 1 line
2.27.0