staging: rtl8723bs: os_dep: simplify the return statement.
PATCH 1/1 staging: rtl8723bs: os_dep: simplify the return statement.
Remove the unneeded and redundant check of variable on goto out. Simplify the return using multiple goto label to avoid unneeded check.
--- .../staging/rtl8723bs/os_dep/ioctl_cfg80211.c | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-)
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +15 -14
@@ -2282,18 +2282,18 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, strif (!name) { ret = -EINVAL ; - goto out; + goto err_out; }if (pwdev_priv->pmon_ndev) { ret = -EBUSY ; - goto out; + goto err_out; } mon_ndev =alloc_etherdev (sizeof (struct rtw_netdev_priv_indicator ));if (!mon_ndev) { ret = -ENOMEM ; - goto out; + goto err_out; } mon_ndev->type =ARPHRD_IEEE80211_RADIOTAP ;
@@ -2312,7 +2312,7 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str mon_wdev =rtw_zmalloc (sizeof (struct wireless_dev ));if (!mon_wdev) { ret = -ENOMEM ; - goto out; + goto err_zmalloc; } mon_wdev->wiphy = padapter->rtw_wdev->wiphy;
@@ -2322,22 +2322,23 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str ret =cfg80211_register_netdevice (mon_ndev);if (ret) { - goto out; + goto err_register; } *ndev = pwdev_priv->pmon_ndev = mon_ndev;memcpy (pwdev_priv->ifname_mon, name,IFNAMSIZ +1 ); -out: -if (ret && mon_wdev) { -kfree (mon_wdev); - mon_wdev =NULL ; - } +err_register: -if (ret && mon_ndev) { -free_netdev (mon_ndev); - *ndev = mon_ndev =NULL ; - } +kfree (mon_wdev); + mon_wdev =NULL ; + +err_zmalloc: + +free_netdev (mon_ndev); + *ndev = mon_ndev =NULL ; + +err_out:return ret; }
--
2.32.0
drivers/
Quoted 10 lines · CEST Saurav Girepunje
Remove the unneeded and redundant check of variable on goto out. Simplify the return using multiple goto label to avoid unneeded check.
Signed-off-by Saurav Girepunje <[email protected]>--- .../staging/rtl8723bs/os_dep/ioctl_cfg80211.c | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-)drivers/ renamed from drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0
staging/rtl8723bs/os_dep/ioctl_cfg80211.c
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct
Quoted 4 lines
index
0868f56e2979..574fdb6adce7100644drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0@@ -2282,18 +2282,18 @@ static int rtw_cfg80211_add_monitor_if(struct
adapter *padapter, char *name, str
Quoted 4 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-1if (!name) { ret = -EINVAL ; - goto out;
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str
Quoted 10 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +2
-1+ goto err_out; }if (pwdev_priv->pmon_ndev) { ret = -EBUSY ; - goto out; + goto err_out; } mon_ndev = alloc_etherdev(sizeof(struct
rtw_netdev_priv_indicator));
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter
Quoted 8 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1if (!mon_ndev) { ret = -ENOMEM ; - goto out; + goto err_out; } mon_ndev->type =ARPHRD_IEEE80211_RADIOTAP ;@@ -2312,7 +2312,7 @@ static int rtw_cfg80211_add_monitor_if(struct adapter
*padapter, char *name, str
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct
Quoted 9 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1mon_wdev =rtw_zmalloc (sizeof (struct wireless_dev ));if (!mon_wdev) { ret = -ENOMEM ; - goto out; + goto err_zmalloc; } mon_wdev->wiphy = padapter->rtw_wdev->wiphy;@@ -2322,22 +2322,23 @@ static int rtw_cfg80211_add_monitor_if(struct
adapter *padapter, char *name, str
Quoted 34 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +11
-11ret =cfg80211_register_netdevice (mon_ndev);if (ret) { - goto out; + goto err_register; } *ndev = pwdev_priv->pmon_ndev = mon_ndev;memcpy (pwdev_priv->ifname_mon, name,IFNAMSIZ +1 ); -out: -if (ret && mon_wdev) { -kfree (mon_wdev); - mon_wdev =NULL ; - } +err_register: -if (ret && mon_ndev) { -free_netdev (mon_ndev); - *ndev = mon_ndev =NULL ; - } +kfree (mon_wdev); + mon_wdev =NULL ; + +err_zmalloc: + +free_netdev (mon_ndev); + *ndev = mon_ndev =NULL ; + +err_out:return ret; } --
Quoted 2 lines
2.32.0
At a quick look it seems that now you unconditionally free memory and free a network device immediately after the last memcpy().
Why are you doing this even if no errors are returned from device and memory allocations (i.e., while "ret" is still equal to zero)?
Thanks,
Fabio
Quoted 90 lines · Fabio M. De Francesco
drivers/
Quoted 10 lines · CEST Saurav Girepunje
Remove the unneeded and redundant check of variable on goto out. Simplify the return using multiple goto label to avoid unneeded check.
Signed-off-by Saurav Girepunje <[email protected]>--- .../staging/rtl8723bs/os_dep/ioctl_cfg80211.c | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-)drivers/ renamed from drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0
staging/rtl8723bs/os_dep/ioctl_cfg80211.cdrivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct
Quoted 4 lines
index
0868f56e2979..574fdb6adce7100644drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0@@ -2282,18 +2282,18 @@ static int rtw_cfg80211_add_monitor_if(structadapter *padapter, char *name, str
Quoted 4 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-1if (!name) { ret = -EINVAL ; - goto out;drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str
Quoted 10 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +2
-1+ goto err_out; }if (pwdev_priv->pmon_ndev) { ret = -EBUSY ; - goto out; + goto err_out; } mon_ndev = alloc_etherdev(sizeof(struct
rtw_netdev_priv_indicator));drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter
Quoted 8 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1if (!mon_ndev) { ret = -ENOMEM ; - goto out; + goto err_out; } mon_ndev->type =ARPHRD_IEEE80211_RADIOTAP ;@@ -2312,7 +2312,7 @@ static int rtw_cfg80211_add_monitor_if(struct adapter*padapter, char *name, str
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct
Quoted 9 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1mon_wdev =rtw_zmalloc (sizeof (struct wireless_dev ));if (!mon_wdev) { ret = -ENOMEM ; - goto out; + goto err_zmalloc; } mon_wdev->wiphy = padapter->rtw_wdev->wiphy;@@ -2322,22 +2322,23 @@ static int rtw_cfg80211_add_monitor_if(structadapter *padapter, char *name, str
Quoted 34 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +11
-11ret =cfg80211_register_netdevice (mon_ndev);if (ret) { - goto out; + goto err_register; } *ndev = pwdev_priv->pmon_ndev = mon_ndev;memcpy (pwdev_priv->ifname_mon, name,IFNAMSIZ +1 ); -out: -if (ret && mon_wdev) { -kfree (mon_wdev); - mon_wdev =NULL ; - } +err_register: -if (ret && mon_ndev) { -free_netdev (mon_ndev); - *ndev = mon_ndev =NULL ; - } +kfree (mon_wdev); + mon_wdev =NULL ; + +err_zmalloc: + +free_netdev (mon_ndev); + *ndev = mon_ndev =NULL ; + +err_out:return ret; } --Quoted 2 lines
2.32.0
At a quick look it seems that now you unconditionally free memory and free a network device immediately after the last
memcpy().
Quoted 10 lines
Why are you doing this even if no errors are returned from device and memory allocations (i.e., while "ret" is still equal to zero)?
Thanks,
Fabio
Thanks Fabio for review. Yes, That is missed.
I can do that in either one of the way.
Either I should check for ret before free or I should use goto out(may be I will rename err_out goto label to "out" only) just after the memcpy statement so that function will not free for no error case and return ret value only.
Please let me know you input on above.
Regards,
Saurav Girepunje
This introduces a use after free on the sucess path. You need to be a lot more careful.
Quoted 14 lines · Saurav Girepunje
Remove the unneeded and redundant check of variable on goto out. Simplify the return using multiple goto label to avoid unneeded check.
Signed-off-by Saurav Girepunje <[email protected]>--- .../staging/rtl8723bs/os_dep/ioctl_cfg80211.c | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-)drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2285
Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1@@ -2282,18 +2282,18 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, strif (!name) { ret = -EINVAL ; - goto out; + goto err_out;
Just return directly. "return -EINVAL;" but what does "goto err_out;" do? No one knows without scrolling down to the very bottom of the function, then scrolling all the way up again. At this point you have lost your place in the code and your train of thought is de-railed.
Plus it introduces "forgot to set the error code" bugs.
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2315
Quoted 6 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1@@ -2312,7 +2312,7 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str mon_wdev =rtw_zmalloc (sizeof (struct wireless_dev ));if (!mon_wdev) { ret = -ENOMEM ; - goto out; + goto err_zmalloc;
This is a Come From style naming. Imagine if instead of naming functions after what they do we instead named them after the first caller which was introduced. kmalloc() would be named called_from_boot_510(). It's a usless naming scheme. We have to scroll down to the bottom to see what it does.
Quoted 17 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-4} mon_wdev->wiphy = padapter->rtw_wdev->wiphy;@@ -2322,22 +2322,23 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str ret =cfg80211_register_netdevice (mon_ndev);if (ret) { - goto out; + goto err_register; } *ndev = pwdev_priv->pmon_ndev = mon_ndev;memcpy (pwdev_priv->ifname_mon, name,IFNAMSIZ +1 ); -out: -if (ret && mon_wdev) { -kfree (mon_wdev);
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2334
Quoted 10 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +3
-6- mon_wdev =NULL ; - } +err_register: -if (ret && mon_ndev) { -free_netdev (mon_ndev); - *ndev = mon_ndev =NULL ; - } +kfree (mon_wdev); + mon_wdev =NULL ;
This is an on stack variable. Think about what you are doing. You're not writing carefully at all.
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2339
Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +5
-0+ +err_zmalloc: + +free_netdev (mon_ndev); + *ndev = mon_ndev =NULL ;
mon_ndev is local too.
regards,
dan carpenter
Quoted 31 lines · Dan Carpenter
This introduces a use after free on the sucess path. You need to be a lot more careful.
Quoted 14 lines · Saurav Girepunje
Remove the unneeded and redundant check of variable on goto out. Simplify the return using multiple goto label to avoid unneeded check.
Signed-off-by Saurav Girepunje <[email protected]>--- .../staging/rtl8723bs/os_dep/ioctl_cfg80211.c | 29 ++++++++++--------- 1 file changed, 15 insertions(+), 14 deletions(-)drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +0
-0drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2285
Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1@@ -2282,18 +2282,18 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, strif (!name) { ret = -EINVAL ; - goto out; + goto err_out;Just return directly. "return
-EINVAL;" but what does "gotoerr_out;" do? No one knows without scrolling down to the very bottom of the function, then scrolling all the way up again. At this point you have lost your place in the code and your train of thought is de-railed.Plus it introduces "forgot to set the error code" bugs.
Quoted 14 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2315
Quoted 6 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +1
-1@@ -2312,7 +2312,7 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str mon_wdev =rtw_zmalloc (sizeof (struct wireless_dev ));if (!mon_wdev) { ret = -ENOMEM ; - goto out; + goto err_zmalloc;This is a Come From style naming. Imagine if instead of naming functions after what they do we instead named them after the first caller which was introduced.
kmalloc()would be namedcalled_from_boot_510(). It's a usless naming scheme. We have to scroll down to the bottom to see what it does.
I will send another patch to remove goto and simply return ret value.
Quoted 21 lines
Quoted 21 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +2
-6} mon_wdev->wiphy = padapter->rtw_wdev->wiphy;@@ -2322,22 +2322,23 @@ static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str ret =cfg80211_register_netdevice (mon_ndev);if (ret) { - goto out; + goto err_register; } *ndev = pwdev_priv->pmon_ndev = mon_ndev;memcpy (pwdev_priv->ifname_mon, name,IFNAMSIZ +1 ); -out: -if (ret && mon_wdev) { -kfree (mon_wdev); - mon_wdev =NULL ; - } +err_register:
Quoted 10 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2334
Quoted 6 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +2
-4-if (ret && mon_ndev) { -free_netdev (mon_ndev); - *ndev = mon_ndev =NULL ; - } +kfree (mon_wdev); + mon_wdev =NULL ;This is an on stack variable. Think about what you are doing. You're not writing carefully at all.
I didn't removed local variable assignment to NULL on this patch.
However I agree this is another improvement possible on this function and can be done along with other changes. Please let me know you opinion whether I should send one patch or multiple patch in a single series.
Quoted 8 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c static int rtw_cfg80211_add_monitor_if(struct adapter *padapter, char *name, str · line 2339
Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/ioctl_cfg80211.c +5
-0+ +err_zmalloc: + +free_netdev (mon_ndev); + *ndev = mon_ndev =NULL ;
mon_ndevis local too.
Quoted 4 lines
regards,
dan carpenter
Regards,
Saurav
Quoted 4 lines · Saurav Girepunje
I didn't removed local variable assignment to NULL on this patch.
However I agree this is another improvement possible on this function and can be done along with other changes. Please let me know you opinion whether I should send one patch or multiple patch in a single series.
Since it's on the same line then do it in one patch.
regards,
dan carpenter