diff mbox series

can: remove WARN() statement from list operation sanity check

Message ID 20201126192140.14350-1-socketcan@hartkopp.net (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series can: remove WARN() statement from list operation sanity check | expand

Checks

Context Check Description
netdev/tree_selection success Series ignored based on subject

Commit Message

Oliver Hartkopp Nov. 26, 2020, 7:21 p.m. UTC
To detect potential bugs in CAN protocol implementations (double removal
of receiver entries) a WARN() statement has been used if no matching list
item was found for removal.

The fault injection issued by syzkaller was able to create a situation
where the closing of a socket runs simultaneously to the notifier call
chain for removing the CAN network device in use.

This case is very unlikely in real life but it doesn't break anything.
Therefore we just replace the WARN() statement with pr_warn() to
preserve the notification for the CAN protocol development.

Reported-by: syzbot+381d06e0c8eaacb8706f@syzkaller.appspotmail.com
Reported-by: syzbot+d0ddd88c9a7432f041e6@syzkaller.appspotmail.com
Reported-by: syzbot+76d62d3b8162883c7d11@syzkaller.appspotmail.com
Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
---
 net/can/af_can.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Marc Kleine-Budde Nov. 27, 2020, 7:28 a.m. UTC | #1
On 11/26/20 8:21 PM, Oliver Hartkopp wrote:
> To detect potential bugs in CAN protocol implementations (double removal
> of receiver entries) a WARN() statement has been used if no matching list
> item was found for removal.
> 
> The fault injection issued by syzkaller was able to create a situation
> where the closing of a socket runs simultaneously to the notifier call
> chain for removing the CAN network device in use.
> 
> This case is very unlikely in real life but it doesn't break anything.
> Therefore we just replace the WARN() statement with pr_warn() to
> preserve the notification for the CAN protocol development.
> 
> Reported-by: syzbot+381d06e0c8eaacb8706f@syzkaller.appspotmail.com
> Reported-by: syzbot+d0ddd88c9a7432f041e6@syzkaller.appspotmail.com
> Reported-by: syzbot+76d62d3b8162883c7d11@syzkaller.appspotmail.com
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>

applied to can/testing.

tnx,
Marc
Marc Kleine-Budde Nov. 27, 2020, 9:48 a.m. UTC | #2
On 11/26/20 8:21 PM, Oliver Hartkopp wrote:
> To detect potential bugs in CAN protocol implementations (double removal
> of receiver entries) a WARN() statement has been used if no matching list
> item was found for removal.
> 
> The fault injection issued by syzkaller was able to create a situation
> where the closing of a socket runs simultaneously to the notifier call
> chain for removing the CAN network device in use.
> 
> This case is very unlikely in real life but it doesn't break anything.
> Therefore we just replace the WARN() statement with pr_warn() to
> preserve the notification for the CAN protocol development.
> 
> Reported-by: syzbot+381d06e0c8eaacb8706f@syzkaller.appspotmail.com
> Reported-by: syzbot+d0ddd88c9a7432f041e6@syzkaller.appspotmail.com
> Reported-by: syzbot+76d62d3b8162883c7d11@syzkaller.appspotmail.com
> Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
> ---
>  net/can/af_can.c | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/net/can/af_can.c b/net/can/af_can.c
> index 5d124c155904..7c5ccdec89e1 100644
> --- a/net/can/af_can.c
> +++ b/net/can/af_can.c
> @@ -539,14 +539,17 @@ void can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
>  			break;
>  	}
>  
>  	/* Check for bugs in CAN protocol implementations using af_can.c:
>  	 * 'rcv' will be NULL if no matching list item was found for removal.
> +	 * As this case may potentially happen when closing a socket while
> +	 * the notifier for removing the CAN netdev is running we just print
> +	 * a warning here. Reported by syskaller (see commit message)
I've removed the "Reported by syskaller (see commit message)" while applying the
patch, to keep this comment short and to the point. Use tig/git blame (or any
other future tool) to figure out the commit message for details :D

>  	 */
>  	if (!rcv) {
> -		WARN(1, "BUG: receive list entry not found for dev %s, id %03X, mask %03X\n",
> -		     DNAME(dev), can_id, mask);
> +		pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
> +			DNAME(dev), can_id, mask);
>  		goto out;
>  	}
>  
>  	hlist_del_rcu(&rcv->list);
>  	dev_rcv_lists->entries--;
> 

Marc
Oliver Hartkopp Nov. 27, 2020, 1:16 p.m. UTC | #3
On 27.11.20 10:48, Marc Kleine-Budde wrote:

>>   	/* Check for bugs in CAN protocol implementations using af_can.c:
>>   	 * 'rcv' will be NULL if no matching list item was found for removal.
>> +	 * As this case may potentially happen when closing a socket while
>> +	 * the notifier for removing the CAN netdev is running we just print
>> +	 * a warning here. Reported by syskaller (see commit message)
> I've removed the "Reported by syskaller (see commit message)" while applying the
> patch, to keep this comment short and to the point. Use tig/git blame (or any
> other future tool) to figure out the commit message for details :D
> 

Is fine for me ;-)

Thanks Marc!
diff mbox series

Patch

diff --git a/net/can/af_can.c b/net/can/af_can.c
index 5d124c155904..7c5ccdec89e1 100644
--- a/net/can/af_can.c
+++ b/net/can/af_can.c
@@ -539,14 +539,17 @@  void can_rx_unregister(struct net *net, struct net_device *dev, canid_t can_id,
 			break;
 	}
 
 	/* Check for bugs in CAN protocol implementations using af_can.c:
 	 * 'rcv' will be NULL if no matching list item was found for removal.
+	 * As this case may potentially happen when closing a socket while
+	 * the notifier for removing the CAN netdev is running we just print
+	 * a warning here. Reported by syskaller (see commit message)
 	 */
 	if (!rcv) {
-		WARN(1, "BUG: receive list entry not found for dev %s, id %03X, mask %03X\n",
-		     DNAME(dev), can_id, mask);
+		pr_warn("can: receive list entry not found for dev %s, id %03X, mask %03X\n",
+			DNAME(dev), can_id, mask);
 		goto out;
 	}
 
 	hlist_del_rcu(&rcv->list);
 	dev_rcv_lists->entries--;