2021-03-23 01:08:39

by Alex Elder

[permalink] [raw]
Subject: [PATCH net-next] net: ipa: avoid 64-bit modulus

It is possible for a 32 bit x86 build to use a 64 bit DMA address.

There are two remaining spots where the IPA driver does a modulo
operation to check alignment of a DMA address, and under certain
conditions this can lead to a build error on i386 (at least).

The alignment checks we're doing are for power-of-2 values, and this
means the lower 32 bits of the DMA address can be used. This ensures
both operands to the modulo operator are 32 bits wide.

Reported-by: Randy Dunlap <[email protected]>
Signed-off-by: Alex Elder <[email protected]>
---
drivers/net/ipa/gsi.c | 11 +++++++----
drivers/net/ipa/ipa_table.c | 9 ++++++---
2 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/drivers/net/ipa/gsi.c b/drivers/net/ipa/gsi.c
index 7f3e338ca7a72..b6355827bf900 100644
--- a/drivers/net/ipa/gsi.c
+++ b/drivers/net/ipa/gsi.c
@@ -1436,15 +1436,18 @@ static void gsi_evt_ring_rx_update(struct gsi_evt_ring *evt_ring, u32 index)
/* Initialize a ring, including allocating DMA memory for its entries */
static int gsi_ring_alloc(struct gsi *gsi, struct gsi_ring *ring, u32 count)
{
- size_t size = count * GSI_RING_ELEMENT_SIZE;
+ u32 size = count * GSI_RING_ELEMENT_SIZE;
struct device *dev = gsi->dev;
dma_addr_t addr;

- /* Hardware requires a 2^n ring size, with alignment equal to size */
+ /* Hardware requires a 2^n ring size, with alignment equal to size.
+ * The size is a power of 2, so we can check alignment using just
+ * the bottom 32 bits for a DMA address of any size.
+ */
ring->virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);
- if (ring->virt && addr % size) {
+ if (ring->virt && lower_32_bits(addr) % size) {
dma_free_coherent(dev, size, ring->virt, addr);
- dev_err(dev, "unable to alloc 0x%zx-aligned ring buffer\n",
+ dev_err(dev, "unable to alloc 0x%x-aligned ring buffer\n",
size);
return -EINVAL; /* Not a good error value, but distinct */
} else if (!ring->virt) {
diff --git a/drivers/net/ipa/ipa_table.c b/drivers/net/ipa/ipa_table.c
index 988f2c2886b95..4236a50ff03ae 100644
--- a/drivers/net/ipa/ipa_table.c
+++ b/drivers/net/ipa/ipa_table.c
@@ -658,10 +658,13 @@ int ipa_table_init(struct ipa *ipa)
return -ENOMEM;

/* We put the "zero rule" at the base of our table area. The IPA
- * hardware requires rules to be aligned on a 128-byte boundary.
- * Make sure the allocation satisfies this constraint.
+ * hardware requires route and filter table rules to be aligned
+ * on a 128-byte boundary. As long as the alignment constraint
+ * is a power of 2, we can check alignment using just the bottom
+ * 32 bits for a DMA address of any size.
*/
- if (addr % IPA_TABLE_ALIGN) {
+ BUILD_BUG_ON(!is_power_of_2(IPA_TABLE_ALIGN));
+ if (lower_32_bits(addr) % IPA_TABLE_ALIGN) {
dev_err(dev, "table address %pad not %u-byte aligned\n",
&addr, IPA_TABLE_ALIGN);
dma_free_coherent(dev, size, virt, addr);
--
2.27.0


2021-03-23 02:46:33

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH net-next] net: ipa: avoid 64-bit modulus

On 3/22/21 6:05 PM, Alex Elder wrote:
> It is possible for a 32 bit x86 build to use a 64 bit DMA address.
>
> There are two remaining spots where the IPA driver does a modulo
> operation to check alignment of a DMA address, and under certain
> conditions this can lead to a build error on i386 (at least).
>
> The alignment checks we're doing are for power-of-2 values, and this
> means the lower 32 bits of the DMA address can be used. This ensures
> both operands to the modulo operator are 32 bits wide.
>
> Reported-by: Randy Dunlap <[email protected]>
> Signed-off-by: Alex Elder <[email protected]>

Acked-by: Randy Dunlap <[email protected]> # build-tested


Thanks.

> ---
> drivers/net/ipa/gsi.c | 11 +++++++----
> drivers/net/ipa/ipa_table.c | 9 ++++++---
> 2 files changed, 13 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/net/ipa/gsi.c b/drivers/net/ipa/gsi.c
> index 7f3e338ca7a72..b6355827bf900 100644
> --- a/drivers/net/ipa/gsi.c
> +++ b/drivers/net/ipa/gsi.c
> @@ -1436,15 +1436,18 @@ static void gsi_evt_ring_rx_update(struct gsi_evt_ring *evt_ring, u32 index)
> /* Initialize a ring, including allocating DMA memory for its entries */
> static int gsi_ring_alloc(struct gsi *gsi, struct gsi_ring *ring, u32 count)
> {
> - size_t size = count * GSI_RING_ELEMENT_SIZE;
> + u32 size = count * GSI_RING_ELEMENT_SIZE;
> struct device *dev = gsi->dev;
> dma_addr_t addr;
>
> - /* Hardware requires a 2^n ring size, with alignment equal to size */
> + /* Hardware requires a 2^n ring size, with alignment equal to size.
> + * The size is a power of 2, so we can check alignment using just
> + * the bottom 32 bits for a DMA address of any size.
> + */
> ring->virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);
> - if (ring->virt && addr % size) {
> + if (ring->virt && lower_32_bits(addr) % size) {
> dma_free_coherent(dev, size, ring->virt, addr);
> - dev_err(dev, "unable to alloc 0x%zx-aligned ring buffer\n",
> + dev_err(dev, "unable to alloc 0x%x-aligned ring buffer\n",
> size);
> return -EINVAL; /* Not a good error value, but distinct */
> } else if (!ring->virt) {
> diff --git a/drivers/net/ipa/ipa_table.c b/drivers/net/ipa/ipa_table.c
> index 988f2c2886b95..4236a50ff03ae 100644
> --- a/drivers/net/ipa/ipa_table.c
> +++ b/drivers/net/ipa/ipa_table.c
> @@ -658,10 +658,13 @@ int ipa_table_init(struct ipa *ipa)
> return -ENOMEM;
>
> /* We put the "zero rule" at the base of our table area. The IPA
> - * hardware requires rules to be aligned on a 128-byte boundary.
> - * Make sure the allocation satisfies this constraint.
> + * hardware requires route and filter table rules to be aligned
> + * on a 128-byte boundary. As long as the alignment constraint
> + * is a power of 2, we can check alignment using just the bottom
> + * 32 bits for a DMA address of any size.
> */
> - if (addr % IPA_TABLE_ALIGN) {
> + BUILD_BUG_ON(!is_power_of_2(IPA_TABLE_ALIGN));
> + if (lower_32_bits(addr) % IPA_TABLE_ALIGN) {
> dev_err(dev, "table address %pad not %u-byte aligned\n",
> &addr, IPA_TABLE_ALIGN);
> dma_free_coherent(dev, size, virt, addr);
>


--
~Randy

2021-03-24 08:46:48

by patchwork-bot+netdevbpf

[permalink] [raw]
Subject: Re: [PATCH net-next] net: ipa: avoid 64-bit modulus

Hello:

This patch was applied to netdev/net-next.git (refs/heads/master):

On Mon, 22 Mar 2021 20:05:05 -0500 you wrote:
> It is possible for a 32 bit x86 build to use a 64 bit DMA address.
>
> There are two remaining spots where the IPA driver does a modulo
> operation to check alignment of a DMA address, and under certain
> conditions this can lead to a build error on i386 (at least).
>
> The alignment checks we're doing are for power-of-2 values, and this
> means the lower 32 bits of the DMA address can be used. This ensures
> both operands to the modulo operator are 32 bits wide.
>
> [...]

Here is the summary with links:
- [net-next] net: ipa: avoid 64-bit modulus
https://git.kernel.org/netdev/net-next/c/437c78f976f5

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html


2021-03-24 16:31:23

by David Laight

[permalink] [raw]
Subject: RE: [PATCH net-next] net: ipa: avoid 64-bit modulus

From: Alex Elder
> Sent: 23 March 2021 01:05
> It is possible for a 32 bit x86 build to use a 64 bit DMA address.
>
> There are two remaining spots where the IPA driver does a modulo
> operation to check alignment of a DMA address, and under certain
> conditions this can lead to a build error on i386 (at least).
>
> The alignment checks we're doing are for power-of-2 values, and this
> means the lower 32 bits of the DMA address can be used. This ensures
> both operands to the modulo operator are 32 bits wide.
>
> Reported-by: Randy Dunlap <[email protected]>
> Signed-off-by: Alex Elder <[email protected]>
> ---
> drivers/net/ipa/gsi.c | 11 +++++++----
> drivers/net/ipa/ipa_table.c | 9 ++++++---
> 2 files changed, 13 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/net/ipa/gsi.c b/drivers/net/ipa/gsi.c
> index 7f3e338ca7a72..b6355827bf900 100644
> --- a/drivers/net/ipa/gsi.c
> +++ b/drivers/net/ipa/gsi.c
> @@ -1436,15 +1436,18 @@ static void gsi_evt_ring_rx_update(struct gsi_evt_ring *evt_ring, u32 index)
> /* Initialize a ring, including allocating DMA memory for its entries */
> static int gsi_ring_alloc(struct gsi *gsi, struct gsi_ring *ring, u32 count)
> {
> - size_t size = count * GSI_RING_ELEMENT_SIZE;
> + u32 size = count * GSI_RING_ELEMENT_SIZE;
> struct device *dev = gsi->dev;
> dma_addr_t addr;
>
> - /* Hardware requires a 2^n ring size, with alignment equal to size */
> + /* Hardware requires a 2^n ring size, with alignment equal to size.
> + * The size is a power of 2, so we can check alignment using just
> + * the bottom 32 bits for a DMA address of any size.
> + */
> ring->virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);

Doesn't dma_alloc_coherent() guarantee that alignment?
I doubt anywhere else checks?

David

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

2021-03-24 17:14:08

by Alex Elder

[permalink] [raw]
Subject: Re: [PATCH net-next] net: ipa: avoid 64-bit modulus

On 3/24/21 11:27 AM, David Laight wrote:
> From: Alex Elder
>> Sent: 23 March 2021 01:05
>> It is possible for a 32 bit x86 build to use a 64 bit DMA address.
>>
>> There are two remaining spots where the IPA driver does a modulo
>> operation to check alignment of a DMA address, and under certain
>> conditions this can lead to a build error on i386 (at least).
>>
>> The alignment checks we're doing are for power-of-2 values, and this
>> means the lower 32 bits of the DMA address can be used. This ensures
>> both operands to the modulo operator are 32 bits wide.
>>
>> Reported-by: Randy Dunlap <[email protected]>
>> Signed-off-by: Alex Elder <[email protected]>
>> ---
>> drivers/net/ipa/gsi.c | 11 +++++++----
>> drivers/net/ipa/ipa_table.c | 9 ++++++---
>> 2 files changed, 13 insertions(+), 7 deletions(-)
>>
>> diff --git a/drivers/net/ipa/gsi.c b/drivers/net/ipa/gsi.c
>> index 7f3e338ca7a72..b6355827bf900 100644
>> --- a/drivers/net/ipa/gsi.c
>> +++ b/drivers/net/ipa/gsi.c
>> @@ -1436,15 +1436,18 @@ static void gsi_evt_ring_rx_update(struct gsi_evt_ring *evt_ring, u32 index)
>> /* Initialize a ring, including allocating DMA memory for its entries */
>> static int gsi_ring_alloc(struct gsi *gsi, struct gsi_ring *ring, u32 count)
>> {
>> - size_t size = count * GSI_RING_ELEMENT_SIZE;
>> + u32 size = count * GSI_RING_ELEMENT_SIZE;
>> struct device *dev = gsi->dev;
>> dma_addr_t addr;
>>
>> - /* Hardware requires a 2^n ring size, with alignment equal to size */
>> + /* Hardware requires a 2^n ring size, with alignment equal to size.
>> + * The size is a power of 2, so we can check alignment using just
>> + * the bottom 32 bits for a DMA address of any size.
>> + */
>> ring->virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);
>
> Doesn't dma_alloc_coherent() guarantee that alignment?
> I doubt anywhere else checks?

I normally wouldn't check something like this if it
weren't guaranteed. I'm not sure why I did it here.

I see it's "guaranteed to be aligned to the smallest
PAGE_SIZE order which is greater than or equal to
the requested size." So I think the answer to your
question is "yes, it does guarantee that."

I'll make a note to remove this check in a future
patch, and will credit you with the suggestion.

Thanks.

-Alex

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

2021-03-24 17:15:38

by David Laight

[permalink] [raw]
Subject: RE: [PATCH net-next] net: ipa: avoid 64-bit modulus

From: Alex Elder
> Sent: 24 March 2021 17:07
>
> On 3/24/21 11:27 AM, David Laight wrote:
> > From: Alex Elder
> >> Sent: 23 March 2021 01:05
> >> It is possible for a 32 bit x86 build to use a 64 bit DMA address.
> >>
> >> There are two remaining spots where the IPA driver does a modulo
> >> operation to check alignment of a DMA address, and under certain
> >> conditions this can lead to a build error on i386 (at least).
> >>
> >> The alignment checks we're doing are for power-of-2 values, and this
> >> means the lower 32 bits of the DMA address can be used. This ensures
> >> both operands to the modulo operator are 32 bits wide.
> >>
> >> Reported-by: Randy Dunlap <[email protected]>
> >> Signed-off-by: Alex Elder <[email protected]>
> >> ---
> >> drivers/net/ipa/gsi.c | 11 +++++++----
> >> drivers/net/ipa/ipa_table.c | 9 ++++++---
> >> 2 files changed, 13 insertions(+), 7 deletions(-)
> >>
> >> diff --git a/drivers/net/ipa/gsi.c b/drivers/net/ipa/gsi.c
> >> index 7f3e338ca7a72..b6355827bf900 100644
> >> --- a/drivers/net/ipa/gsi.c
> >> +++ b/drivers/net/ipa/gsi.c
> >> @@ -1436,15 +1436,18 @@ static void gsi_evt_ring_rx_update(struct gsi_evt_ring *evt_ring, u32
> index)
> >> /* Initialize a ring, including allocating DMA memory for its entries */
> >> static int gsi_ring_alloc(struct gsi *gsi, struct gsi_ring *ring, u32 count)
> >> {
> >> - size_t size = count * GSI_RING_ELEMENT_SIZE;
> >> + u32 size = count * GSI_RING_ELEMENT_SIZE;
> >> struct device *dev = gsi->dev;
> >> dma_addr_t addr;
> >>
> >> - /* Hardware requires a 2^n ring size, with alignment equal to size */
> >> + /* Hardware requires a 2^n ring size, with alignment equal to size.
> >> + * The size is a power of 2, so we can check alignment using just
> >> + * the bottom 32 bits for a DMA address of any size.
> >> + */
> >> ring->virt = dma_alloc_coherent(dev, size, &addr, GFP_KERNEL);
> >
> > Doesn't dma_alloc_coherent() guarantee that alignment?
> > I doubt anywhere else checks?
>
> I normally wouldn't check something like this if it
> weren't guaranteed. I'm not sure why I did it here.
>
> I see it's "guaranteed to be aligned to the smallest
> PAGE_SIZE order which is greater than or equal to
> the requested size." So I think the answer to your
> question is "yes, it does guarantee that."
>
> I'll make a note to remove this check in a future
> patch, and will credit you with the suggestion.

I think 'count' is also required to be a power of 2.
so you could have checked 'addr & (size - 1)'.

David

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

2021-03-25 03:19:54

by Alex Elder

[permalink] [raw]
Subject: Re: [PATCH net-next] net: ipa: avoid 64-bit modulus

On 3/24/21 12:12 PM, David Laight wrote:
> I think 'count' is also required to be a power of 2.
> so you could have checked 'addr & (size - 1)'.

It is required to be, and that is checked elsewhere
(in gsi_channel_data_valid()). And yes, size would
therefore be a power-of-2, and so your clever test
would be a simple test.

I'll take that into account when I implement the
fix. Thanks for the suggestion.

-Alex