2022-04-01 21:59:24

by Sevinj Aghayeva

[permalink] [raw]
Subject: [PATCH] staging: rtl8723bs: simplify control flow

The function iterates an index from 0 to NUM_PMKID_CACHE and returns
the first index for which the condition is true. If no such index is
found, the function returns -1. Current code has a complex control
flow that obfuscates this simple task. Replace it with a loop.

Also, given the shortened function body, replace the long variable
name psecuritypriv with a short variable name p.

Reported by checkpatch:

WARNING: else is not generally useful after a break or return

Signed-off-by: Sevinj Aghayeva <[email protected]>
---
drivers/staging/rtl8723bs/core/rtw_mlme.c | 28 ++++++-----------------
1 file changed, 7 insertions(+), 21 deletions(-)

diff --git a/drivers/staging/rtl8723bs/core/rtw_mlme.c b/drivers/staging/rtl8723bs/core/rtw_mlme.c
index d5bb3a5bd2fb..3eacf8f9d236 100644
--- a/drivers/staging/rtl8723bs/core/rtw_mlme.c
+++ b/drivers/staging/rtl8723bs/core/rtw_mlme.c
@@ -2036,28 +2036,14 @@ int rtw_restruct_wmm_ie(struct adapter *adapter, u8 *in_ie, u8 *out_ie, uint in_

static int SecIsInPMKIDList(struct adapter *Adapter, u8 *bssid)
{
- struct security_priv *psecuritypriv = &Adapter->securitypriv;
- int i = 0;
-
- do {
- if ((psecuritypriv->PMKIDList[i].bUsed) &&
- (!memcmp(psecuritypriv->PMKIDList[i].Bssid, bssid, ETH_ALEN))) {
- break;
- } else {
- i++;
- /* continue; */
- }
-
- } while (i < NUM_PMKID_CACHE);
-
- if (i == NUM_PMKID_CACHE) {
- i = -1;/* Could not find. */
- } else {
- /* There is one Pre-Authentication Key for the specific BSSID. */
- }
-
- return i;
+ struct security_priv *p = &Adapter->securitypriv;
+ int i;

+ for (i = 0; i < NUM_PMKID_CACHE; i++)
+ if ((p->PMKIDList[i].bUsed) &&
+ (!memcmp(p->PMKIDList[i].Bssid, bssid, ETH_ALEN)))
+ return i;
+ return -1;
}

/* */
--
2.25.1


2022-04-04 14:04:49

by Ira Weiny

[permalink] [raw]
Subject: Re: [PATCH] staging: rtl8723bs: simplify control flow

On Fri, Apr 01, 2022 at 07:46:35AM -0400, Sevinj Aghayeva wrote:
> The function iterates an index from 0 to NUM_PMKID_CACHE and returns
> the first index for which the condition is true. If no such index is
> found, the function returns -1. Current code has a complex control
> flow that obfuscates this simple task. Replace it with a loop.
>
> Also, given the shortened function body, replace the long variable
> name psecuritypriv with a short variable name p.
>
> Reported by checkpatch:
>
> WARNING: else is not generally useful after a break or return
>
> Signed-off-by: Sevinj Aghayeva <[email protected]>

Wow! Nice find! This is a huge clean up. Extra kudos recognizing that it is
not just the else statement which is broken here!

The only issue for the patch is that I don't see any maintainer emailed?
However, I don't see a maintainer listed in the MAINTAINERS file so ...

Reviewed-by: Ira Weiny <[email protected]>

> ---
> drivers/staging/rtl8723bs/core/rtw_mlme.c | 28 ++++++-----------------
> 1 file changed, 7 insertions(+), 21 deletions(-)
>
> diff --git a/drivers/staging/rtl8723bs/core/rtw_mlme.c b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> index d5bb3a5bd2fb..3eacf8f9d236 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_mlme.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> @@ -2036,28 +2036,14 @@ int rtw_restruct_wmm_ie(struct adapter *adapter, u8 *in_ie, u8 *out_ie, uint in_
>
> static int SecIsInPMKIDList(struct adapter *Adapter, u8 *bssid)
> {
> - struct security_priv *psecuritypriv = &Adapter->securitypriv;
> - int i = 0;
> -
> - do {
> - if ((psecuritypriv->PMKIDList[i].bUsed) &&
> - (!memcmp(psecuritypriv->PMKIDList[i].Bssid, bssid, ETH_ALEN))) {
> - break;
> - } else {
> - i++;
> - /* continue; */
> - }
> -
> - } while (i < NUM_PMKID_CACHE);
> -
> - if (i == NUM_PMKID_CACHE) {
> - i = -1;/* Could not find. */
> - } else {
> - /* There is one Pre-Authentication Key for the specific BSSID. */
> - }
> -
> - return i;
> + struct security_priv *p = &Adapter->securitypriv;
> + int i;
>
> + for (i = 0; i < NUM_PMKID_CACHE; i++)
> + if ((p->PMKIDList[i].bUsed) &&
> + (!memcmp(p->PMKIDList[i].Bssid, bssid, ETH_ALEN)))
> + return i;
> + return -1;
> }
>
> /* */
> --
> 2.25.1
>

2022-04-05 00:47:56

by Sevinj Aghayeva

[permalink] [raw]
Subject: Re: [PATCH] staging: rtl8723bs: simplify control flow

On Fri, Apr 01, 2022 at 02:34:04PM -0700, Ira Weiny wrote:
> On Fri, Apr 01, 2022 at 07:46:35AM -0400, Sevinj Aghayeva wrote:
> > The function iterates an index from 0 to NUM_PMKID_CACHE and returns
> > the first index for which the condition is true. If no such index is
> > found, the function returns -1. Current code has a complex control
> > flow that obfuscates this simple task. Replace it with a loop.
> >
> > Also, given the shortened function body, replace the long variable
> > name psecuritypriv with a short variable name p.
> >
> > Reported by checkpatch:
> >
> > WARNING: else is not generally useful after a break or return
> >
> > Signed-off-by: Sevinj Aghayeva <[email protected]>
>
> Wow! Nice find! This is a huge clean up. Extra kudos recognizing that it is
> not just the else statement which is broken here!

Thanks! It took me a while to realize what this loop is doing.

> The only issue for the patch is that I don't see any maintainer emailed?
> However, I don't see a maintainer listed in the MAINTAINERS file so ...
>
> Reviewed-by: Ira Weiny <[email protected]>

Thanks for the review!

Greg, please do not apply this yet. After I sent out the patch, I
noticed the comment at the top of the function:

/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */

So I did a git grep to find the original function and fix it as well,
and it looks like there are three copies of the same function in
different files:

$ git grep IsInPreAuthKeyList
r8188eu/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
rtl8712/rtl871x_mlme.c: * Ported from 8185: IsInPreAuthKeyList().
rtl8723bs/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */

I will later send a v2 patch that replaces all of them.

Thanks

> > ---
> > drivers/staging/rtl8723bs/core/rtw_mlme.c | 28 ++++++-----------------
> > 1 file changed, 7 insertions(+), 21 deletions(-)
> >
> > diff --git a/drivers/staging/rtl8723bs/core/rtw_mlme.c b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> > index d5bb3a5bd2fb..3eacf8f9d236 100644
> > --- a/drivers/staging/rtl8723bs/core/rtw_mlme.c
> > +++ b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> > @@ -2036,28 +2036,14 @@ int rtw_restruct_wmm_ie(struct adapter *adapter, u8 *in_ie, u8 *out_ie, uint in_
> >
> > static int SecIsInPMKIDList(struct adapter *Adapter, u8 *bssid)
> > {
> > - struct security_priv *psecuritypriv = &Adapter->securitypriv;
> > - int i = 0;
> > -
> > - do {
> > - if ((psecuritypriv->PMKIDList[i].bUsed) &&
> > - (!memcmp(psecuritypriv->PMKIDList[i].Bssid, bssid, ETH_ALEN))) {
> > - break;
> > - } else {
> > - i++;
> > - /* continue; */
> > - }
> > -
> > - } while (i < NUM_PMKID_CACHE);
> > -
> > - if (i == NUM_PMKID_CACHE) {
> > - i = -1;/* Could not find. */
> > - } else {
> > - /* There is one Pre-Authentication Key for the specific BSSID. */
> > - }
> > -
> > - return i;
> > + struct security_priv *p = &Adapter->securitypriv;
> > + int i;
> >
> > + for (i = 0; i < NUM_PMKID_CACHE; i++)
> > + if ((p->PMKIDList[i].bUsed) &&
> > + (!memcmp(p->PMKIDList[i].Bssid, bssid, ETH_ALEN)))
> > + return i;
> > + return -1;
> > }
> >
> > /* */
> > --
> > 2.25.1
> >

2022-04-05 02:18:13

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] staging: rtl8723bs: simplify control flow

On Fri, Apr 01, 2022 at 06:46:19PM -0400, Sevinj Aghayeva wrote:
> On Fri, Apr 01, 2022 at 02:34:04PM -0700, Ira Weiny wrote:
> > On Fri, Apr 01, 2022 at 07:46:35AM -0400, Sevinj Aghayeva wrote:
> > > The function iterates an index from 0 to NUM_PMKID_CACHE and returns
> > > the first index for which the condition is true. If no such index is
> > > found, the function returns -1. Current code has a complex control
> > > flow that obfuscates this simple task. Replace it with a loop.
> > >
> > > Also, given the shortened function body, replace the long variable
> > > name psecuritypriv with a short variable name p.
> > >
> > > Reported by checkpatch:
> > >
> > > WARNING: else is not generally useful after a break or return
> > >
> > > Signed-off-by: Sevinj Aghayeva <[email protected]>
> >
> > Wow! Nice find! This is a huge clean up. Extra kudos recognizing that it is
> > not just the else statement which is broken here!
>
> Thanks! It took me a while to realize what this loop is doing.
>
> > The only issue for the patch is that I don't see any maintainer emailed?
> > However, I don't see a maintainer listed in the MAINTAINERS file so ...
> >
> > Reviewed-by: Ira Weiny <[email protected]>
>
> Thanks for the review!
>
> Greg, please do not apply this yet. After I sent out the patch, I
> noticed the comment at the top of the function:
>
> /* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
>
> So I did a git grep to find the original function and fix it as well,
> and it looks like there are three copies of the same function in
> different files:
>
> $ git grep IsInPreAuthKeyList
> r8188eu/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
> rtl8712/rtl871x_mlme.c: * Ported from 8185: IsInPreAuthKeyList().
> rtl8723bs/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
>
> I will later send a v2 patch that replaces all of them.

No, please do one patch per driver. These are all different drivers
(cut/pasted from some original source), so this patch is fine as-is.
You can make 2 other patches as well for the other drivers.

thanks,

greg k-h

2022-04-05 03:28:06

by Sevinj Aghayeva

[permalink] [raw]
Subject: Re: [PATCH] staging: rtl8723bs: simplify control flow

On Sat, Apr 2, 2022 at 5:13 AM Greg Kroah-Hartman
<[email protected]> wrote:
>
> On Fri, Apr 01, 2022 at 06:46:19PM -0400, Sevinj Aghayeva wrote:
> > On Fri, Apr 01, 2022 at 02:34:04PM -0700, Ira Weiny wrote:
> > > On Fri, Apr 01, 2022 at 07:46:35AM -0400, Sevinj Aghayeva wrote:
> > > > The function iterates an index from 0 to NUM_PMKID_CACHE and returns
> > > > the first index for which the condition is true. If no such index is
> > > > found, the function returns -1. Current code has a complex control
> > > > flow that obfuscates this simple task. Replace it with a loop.
> > > >
> > > > Also, given the shortened function body, replace the long variable
> > > > name psecuritypriv with a short variable name p.
> > > >
> > > > Reported by checkpatch:
> > > >
> > > > WARNING: else is not generally useful after a break or return
> > > >
> > > > Signed-off-by: Sevinj Aghayeva <[email protected]>
> > >
> > > Wow! Nice find! This is a huge clean up. Extra kudos recognizing that it is
> > > not just the else statement which is broken here!
> >
> > Thanks! It took me a while to realize what this loop is doing.
> >
> > > The only issue for the patch is that I don't see any maintainer emailed?
> > > However, I don't see a maintainer listed in the MAINTAINERS file so ...
> > >
> > > Reviewed-by: Ira Weiny <[email protected]>
> >
> > Thanks for the review!
> >
> > Greg, please do not apply this yet. After I sent out the patch, I
> > noticed the comment at the top of the function:
> >
> > /* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
> >
> > So I did a git grep to find the original function and fix it as well,
> > and it looks like there are three copies of the same function in
> > different files:
> >
> > $ git grep IsInPreAuthKeyList
> > r8188eu/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
> > rtl8712/rtl871x_mlme.c: * Ported from 8185: IsInPreAuthKeyList().
> > rtl8723bs/core/rtw_mlme.c:/* Ported from 8185: IsInPreAuthKeyList(). (Renamed from SecIsInPreAuthKeyList(), 2006-10-13.) */
> >
> > I will later send a v2 patch that replaces all of them.
>
> No, please do one patch per driver. These are all different drivers
> (cut/pasted from some original source), so this patch is fine as-is.
> You can make 2 other patches as well for the other drivers.

Sure, will send two more patches.

Thanks

>
> thanks,
>
> greg k-h



--

Sevinj.Aghayeva