netdev - RE: [PATCH net v2 1/1] igc: read before write to SRRCTL register

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <4dc9ea6c77ff49138a49d7f73f7301fd@AcuMS.aculab.com>
Date:   Fri, 14 Apr 2023 12:32:27 +0000
From:   David Laight <David.Laight@...LAB.COM>
To:     "'Song, Yoong Siang'" <yoong.siang.song@...el.com>,
        Jesper Dangaard Brouer <jbrouer@...hat.com>,
        "Brandeburg, Jesse" <jesse.brandeburg@...el.com>,
        "Nguyen, Anthony L" <anthony.l.nguyen@...el.com>,
        "David S . Miller" <davem@...emloft.net>,
        Eric Dumazet <edumazet@...gle.com>,
        Jakub Kicinski <kuba@...nel.org>,
        Paolo Abeni <pabeni@...hat.com>,
        Alexei Starovoitov <ast@...nel.org>,
        Daniel Borkmann <daniel@...earbox.net>,
        "Jesper Dangaard Brouer" <hawk@...nel.org>,
        John Fastabend <john.fastabend@...il.com>,
        "Fijalkowski, Maciej" <maciej.fijalkowski@...el.com>,
        Vedang Patel <vedang.patel@...el.com>,
        "Joseph, Jithu" <jithu.joseph@...el.com>,
        "Andre Guedes" <andre.guedes@...el.com>,
        Stanislav Fomichev <sdf@...gle.com>,
        "Keller, Jacob E" <jacob.e.keller@...el.com>
CC:     "Brouer, Jesper" <brouer@...hat.com>,
        "intel-wired-lan@...ts.osuosl.org" <intel-wired-lan@...ts.osuosl.org>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        "bpf@...r.kernel.org" <bpf@...r.kernel.org>,
        "xdp-hints@...-project.net" <xdp-hints@...-project.net>,
        "stable@...r.kernel.org" <stable@...r.kernel.org>
Subject: RE: [PATCH net v2 1/1] igc: read before write to SRRCTL register

From: Song, Yoong Siang
> Sent: 14 April 2023 12:16
...
> >I have checked Foxville manual for SRRCTL (Split and Replication Receive
> >Control) register and below GENMASKs looks correct.
> >
> >> -#define IGC_SRRCTL_BSIZEPKT_SHIFT		10 /* Shift _right_ */
> >> -#define IGC_SRRCTL_BSIZEHDRSIZE_SHIFT		2  /* Shift _left_ */
> >> +#define IGC_SRRCTL_BSIZEPKT_MASK	GENMASK(6, 0)
> >> +#define IGC_SRRCTL_BSIZEPKT_SHIFT	10 /* Shift _right_ */
> >
> >Shift due to 1 KB resolution of BSIZEPKT (manual field BSIZEPACKET)
> 
> Ya, 1K = BIT(10), so need to shift right 10 bits.

I bet the code would be easier to read if it did 'value / 1024u'.
The object code will be (much) the same.

> >> +#define IGC_SRRCTL_BSIZEHDRSIZE_MASK	GENMASK(13, 8)
> >> +#define IGC_SRRCTL_BSIZEHDRSIZE_SHIFT	2  /* Shift _left_ */
> >
> >This shift is suspicious, but as you inherited it I guess it works.
> >I did the math, and it happens to work, knowing (from manual) value is in 64 bytes
> >resolution.
> 
> It is in 64 = BIT(6) resolution, so need to shift right 6 bits.
> But it start on 8th bit, so need to shift left 8 bits.
> Thus, total = shift left 2 bits.
> 
> I dint put the explanation into the header file because it is too lengthy
> and user can know from databook.
> 
> How do you feel on the necessary of explaining the shifting logic?

Not everyone trying to grok the code will have the manual.
Even writing (8 - 6) will help.
Or (I think) if the value is in bits 13-8 in units of 64 then just:
	((value >> 8) & 0x1f) * 64
gcc will do a single shift right and a mask 9at some point).
You might want some defines, but if they aren't used much
just comments that refer to the names in the manual/datasheet
can be enough.

	David

-
Registered Address Lakeside, Bramley Road, Mount Farm, Milton Keynes, MK1 1PT, UK
Registration No: 1397386 (Wales)