[dpdk-dev,v8,2/3] ring: introduce new header file to include common functions
Checks
Commit Message
Move the common part of rte_ring.h into rte_ring_generic.h.
Move the memory barrier part into update_tail().
No functional changes here.
Signed-off-by: Jia He <jia.he@hxt-semitech.com>
Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
---
lib/librte_eventdev/rte_event_ring.h | 6 +-
lib/librte_ring/Makefile | 3 +-
lib/librte_ring/rte_ring.h | 161 +---------------------------
lib/librte_ring/rte_ring_generic.h | 202 +++++++++++++++++++++++++++++++++++
4 files changed, 210 insertions(+), 162 deletions(-)
create mode 100644 lib/librte_ring/rte_ring_generic.h
Comments
Hi Jia,
On 1/17/2018 9:33 AM, Jia He wrote:
> Move the common part of rte_ring.h into rte_ring_generic.h.
> Move the memory barrier part into update_tail().
>
> No functional changes here.
>
> Signed-off-by: Jia He <jia.he@hxt-semitech.com>
> Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> Acked-by: Olivier Matz <olivier.matz@6wind.com>
> ---
> diff --git a/lib/librte_ring/rte_ring_generic.h b/lib/librte_ring/rte_ring_generic.h
> new file mode 100644
> index 0000000..01f2cae
> --- /dev/null
> +++ b/lib/librte_ring/rte_ring_generic.h
> @@ -0,0 +1,202 @@
> +/*-
> + * Copyright(c) 2017 Intel Corporation. All rights reserved.
> + * All rights reserved.
> + *
> + * SPDX-License-Identifier: BSD-3-Clause
The SPDX should be first line. See other files for Intel or NXP.
> + */
> +
> +/*
> + * Derived from FreeBSD's bufring.h
> + *
> + **************************************************************************
> + *
> + * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
> + * All rights reserved.
> + *
> + * Redistribution and use in source and binary forms, with or without
> + * modification, are permitted provided that the following conditions are met:
> + *
> + * 1. Redistributions of source code must retain the above copyright notice,
> + * this list of conditions and the following disclaimer.
> + *
> + * 2. The name of Kip Macy nor the names of other
> + * contributors may be used to endorse or promote products derived from
> + * this software without specific prior written permission.
> + *
> + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
> + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
> + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
> + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
> + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
> + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
> + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
> + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
> + * POSSIBILITY OF SUCH DAMAGE.
> + *
> + ***************************************************************************/
> +
This is BSD-2-freebsd, which is not a approved license for DPDK.
Can you ask Kip Macy, if he/she is ok to re-license it with BSD-3?
Please check with legal, if you can just keep the copyright of Kip Macy
and re license it with BSD-3.
I see the BSD-3 license to be permissive enough to be re-licensed as
BSD-3. But I am not a lawyer.
Hi Hemant,
On Fri, Jan 19, 2018 at 07:45:30PM +0530, Hemant Agrawal wrote:
> Hi Jia,
>
> On 1/17/2018 9:33 AM, Jia He wrote:
> > Move the common part of rte_ring.h into rte_ring_generic.h.
> > Move the memory barrier part into update_tail().
> >
> > No functional changes here.
> >
> > Signed-off-by: Jia He <jia.he@hxt-semitech.com>
> > Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > Acked-by: Olivier Matz <olivier.matz@6wind.com>
> > ---
> > diff --git a/lib/librte_ring/rte_ring_generic.h b/lib/librte_ring/rte_ring_generic.h
> > new file mode 100644
> > index 0000000..01f2cae
> > --- /dev/null
> > +++ b/lib/librte_ring/rte_ring_generic.h
> > @@ -0,0 +1,202 @@
> > +/*-
> > + * Copyright(c) 2017 Intel Corporation. All rights reserved.
> > + * All rights reserved.
> > + *
> > + * SPDX-License-Identifier: BSD-3-Clause
>
> The SPDX should be first line. See other files for Intel or NXP.
>
> > + */
> > +
> > +/*
> > + * Derived from FreeBSD's bufring.h
> > + *
> > + **************************************************************************
> > + *
> > + * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
> > + * All rights reserved.
> > + *
> > + * Redistribution and use in source and binary forms, with or without
> > + * modification, are permitted provided that the following conditions are met:
> > + *
> > + * 1. Redistributions of source code must retain the above copyright notice,
> > + * this list of conditions and the following disclaimer.
> > + *
> > + * 2. The name of Kip Macy nor the names of other
> > + * contributors may be used to endorse or promote products derived from
> > + * this software without specific prior written permission.
> > + *
> > + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
> > + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> > + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> > + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
> > + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
> > + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
> > + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
> > + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
> > + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
> > + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
> > + * POSSIBILITY OF SUCH DAMAGE.
> > + *
> > + ***************************************************************************/
> > +
>
> This is BSD-2-freebsd, which is not a approved license for DPDK.
> Can you ask Kip Macy, if he/she is ok to re-license it with BSD-3?
>
> Please check with legal, if you can just keep the copyright of Kip Macy and
> re license it with BSD-3.
>
> I see the BSD-3 license to be permissive enough to be re-licensed as BSD-3.
> But I am not a lawyer.
>
I agree this is something we should do, as a maintainer of librte_ring,
I can do it.
But here, Jia is just moving code in a new file. I don't think this should
block his patchset from beeing included.
Hi Olivier,
> On Fri, Jan 19, 2018 at 07:45:30PM +0530, Hemant Agrawal wrote:
> > Hi Jia,
> >
> > On 1/17/2018 9:33 AM, Jia He wrote:
> > > Move the common part of rte_ring.h into rte_ring_generic.h.
> > > Move the memory barrier part into update_tail().
> > >
> > > No functional changes here.
> > >
> > > Signed-off-by: Jia He <jia.he@hxt-semitech.com>
> > > Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > > Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
> > > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > > Acked-by: Olivier Matz <olivier.matz@6wind.com>
> > > ---
> > > diff --git a/lib/librte_ring/rte_ring_generic.h
> > > b/lib/librte_ring/rte_ring_generic.h
> > > new file mode 100644
> > > index 0000000..01f2cae
> > > --- /dev/null
> > > +++ b/lib/librte_ring/rte_ring_generic.h
> > > @@ -0,0 +1,202 @@
> > > +/*-
> > > + * Copyright(c) 2017 Intel Corporation. All rights reserved.
> > > + * All rights reserved.
> > > + *
> > > + * SPDX-License-Identifier: BSD-3-Clause
> >
> > The SPDX should be first line. See other files for Intel or NXP.
[Hemant] Don't add SPDX to this file.
This file is not BSD-3 licensed. Please keep the full text as in the original file.
>
> > > + */
> > > +
> > > +/*
> > > + * Derived from FreeBSD's bufring.h
> > > + *
> > > +
> > >
> +*********************************************************
> **********
> > > +*******
> > > + *
> > > + * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
> > > + * All rights reserved.
> > > + *
> > > + * Redistribution and use in source and binary forms, with or
> > > +without
> > > + * modification, are permitted provided that the following conditions
> are met:
> > > + *
> > > + * 1. Redistributions of source code must retain the above copyright
> notice,
> > > + * this list of conditions and the following disclaimer.
> > > + *
> > > + * 2. The name of Kip Macy nor the names of other
> > > + * contributors may be used to endorse or promote products derived
> from
> > > + * this software without specific prior written permission.
> > > + *
> > > + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
> CONTRIBUTORS "AS IS"
> > > + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> > > +LIMITED TO, THE
> > > + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
> > > +PARTICULAR PURPOSE
> > > + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
> > > +CONTRIBUTORS BE
> > > + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
> EXEMPLARY,
> > > +OR
> > > + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
> > > +PROCUREMENT OF
> > > + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
> OR
> > > +BUSINESS
> > > + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
> LIABILITY,
> > > +WHETHER IN
> > > + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
> > > +OTHERWISE)
> > > + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
> > > +ADVISED OF THE
> > > + * POSSIBILITY OF SUCH DAMAGE.
> > > + *
> > > +
> > >
> +*********************************************************
> **********
> > > +********/
> > > +
> >
> > This is BSD-2-freebsd, which is not a approved license for DPDK.
> > Can you ask Kip Macy, if he/she is ok to re-license it with BSD-3?
> >
> > Please check with legal, if you can just keep the copyright of Kip
> > Macy and re license it with BSD-3.
> >
> > I see the BSD-3 license to be permissive enough to be re-licensed as BSD-3.
> > But I am not a lawyer.
> >
>
> I agree this is something we should do, as a maintainer of librte_ring, I can
> do it.
>
> But here, Jia is just moving code in a new file. I don't think this should block
> his patchset from beeing included.
[Hemant] I thought of blocking this kind of moves, so that we get the license complaint of DPDK faster 😊
Jia, shall keep the original copyrights and headers in this file (i.e. No SPDX). You need to fix it along with rte_ring.h in near future.
Regards,
Hemant
Hi Hermant
On 1/20/2018 12:47 AM, Hemant Agrawal Wrote:
> Hi Olivier,
>
>> On Fri, Jan 19, 2018 at 07:45:30PM +0530, Hemant Agrawal wrote:
>>> Hi Jia,
>>>
>>> On 1/17/2018 9:33 AM, Jia He wrote:
>>>> Move the common part of rte_ring.h into rte_ring_generic.h.
>>>> Move the memory barrier part into update_tail().
>>>>
>>>> No functional changes here.
>>>>
>>>> Signed-off-by: Jia He <jia.he@hxt-semitech.com>
>>>> Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
>>>> Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
>>>> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
>>>> Acked-by: Olivier Matz <olivier.matz@6wind.com>
>>>> ---
>>>> diff --git a/lib/librte_ring/rte_ring_generic.h
>>>> b/lib/librte_ring/rte_ring_generic.h
>>>> new file mode 100644
>>>> index 0000000..01f2cae
>>>> --- /dev/null
>>>> +++ b/lib/librte_ring/rte_ring_generic.h
>>>> @@ -0,0 +1,202 @@
>>>> +/*-
>>>> + * Copyright(c) 2017 Intel Corporation. All rights reserved.
>>>> + * All rights reserved.
>>>> + *
>>>> + * SPDX-License-Identifier: BSD-3-Clause
>>> The SPDX should be first line. See other files for Intel or NXP.
> [Hemant] Don't add SPDX to this file.
> This file is not BSD-3 licensed. Please keep the full text as in the original file.
>
>
>>>> + */
>>>> +
>>>> +/*
>>>> + * Derived from FreeBSD's bufring.h
>>>> + *
>>>> +
>>>>
>> +*********************************************************
>> **********
>>>> +*******
>>>> + *
>>>> + * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
>>>> + * All rights reserved.
>>>> + *
>>>> + * Redistribution and use in source and binary forms, with or
>>>> +without
>>>> + * modification, are permitted provided that the following conditions
>> are met:
>>>> + *
>>>> + * 1. Redistributions of source code must retain the above copyright
>> notice,
>>>> + * this list of conditions and the following disclaimer.
>>>> + *
>>>> + * 2. The name of Kip Macy nor the names of other
>>>> + * contributors may be used to endorse or promote products derived
>> from
>>>> + * this software without specific prior written permission.
>>>> + *
>>>> + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
>> CONTRIBUTORS "AS IS"
>>>> + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
>>>> +LIMITED TO, THE
>>>> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
>>>> +PARTICULAR PURPOSE
>>>> + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
>>>> +CONTRIBUTORS BE
>>>> + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
>> EXEMPLARY,
>>>> +OR
>>>> + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
>>>> +PROCUREMENT OF
>>>> + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
>> OR
>>>> +BUSINESS
>>>> + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
>> LIABILITY,
>>>> +WHETHER IN
>>>> + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
>>>> +OTHERWISE)
>>>> + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
>>>> +ADVISED OF THE
>>>> + * POSSIBILITY OF SUCH DAMAGE.
>>>> + *
>>>> +
>>>>
>> +*********************************************************
>> **********
>>>> +********/
>>>> +
>>> This is BSD-2-freebsd, which is not a approved license for DPDK.
>>> Can you ask Kip Macy, if he/she is ok to re-license it with BSD-3?
>>>
>>> Please check with legal, if you can just keep the copyright of Kip
>>> Macy and re license it with BSD-3.
>>>
>>> I see the BSD-3 license to be permissive enough to be re-licensed as BSD-3.
>>> But I am not a lawyer.
>>>
>> I agree this is something we should do, as a maintainer of librte_ring, I can
>> do it.
>>
>> But here, Jia is just moving code in a new file. I don't think this should block
>> his patchset from beeing included.
> [Hemant] I thought of blocking this kind of moves, so that we get the license complaint of DPDK faster 😊
>
> Jia, shall keep the original copyrights and headers in this file (i.e. No SPDX). You need to fix it along with rte_ring.h in near future.
>
> Regards,
> Hemant
>
Ok, I will
Besides ,I got the allowance from Kip Macy just now. He/She allowed dpdk
to license librte_ring.h as BSD-3.
My question:
>Would you mind allowing dpdk librte_ring.h to be licensed as BSD 3
instead of BSD 2?
His/her reply:
"I think that's fine. If you're using it be careful I think there's a
fix to memory barrier usage needed more relaxed memory models such as
ARM. I'll check reviews to see if it made it in or not."
Hi hermant
On 1/22/2018 1:15 PM, Hemant Agrawal Wrote:
> Hi Jia,
>
> On 1/22/2018 7:23 AM, Jia He wrote:
>>>>> This is BSD-2-freebsd, which is not a approved license for DPDK.
>>>>> Can you ask Kip Macy, if he/she is ok to re-license it with BSD-3?
>>>>>
>>>>> Please check with legal, if you can just keep the copyright of Kip
>>>>> Macy and re license it with BSD-3.
>>>>>
>>>>> I see the BSD-3 license to be permissive enough to be re-licensed as
>>>>> BSD-3.
>>>>> But I am not a lawyer.
>>>>>
>>>> I agree this is something we should do, as a maintainer of
>>>> librte_ring, I can
>>>> do it.
>>>>
>>>> But here, Jia is just moving code in a new file. I don't think this
>>>> should block
>>>> his patchset from beeing included.
>>> [Hemant] I thought of blocking this kind of moves, so that we get
>>> the license complaint of DPDK faster 😊
>>>
>>> Jia, shall keep the original copyrights and headers in this file (i.e.
>>> No SPDX). You need to fix it along with rte_ring.h in near future.
>>>
>>> Regards,
>>> Hemant
>>>
>> Ok, I will
>> Besides ,I got the allowance from Kip Macy just now. He/She allowed dpdk
>> to license librte_ring.h as BSD-3.
>>
>> My question:
>>> Would you mind allowing dpdk librte_ring.h to be licensed as BSD 3
>> instead of BSD 2?
>> His/her reply:
>>
>> "I think that's fine. If you're using it be careful I think there's a
>> fix to memory barrier usage needed more relaxed memory models such as
>> ARM. I'll check reviews to see if it made it in or not."
>>
>
> That is good. Your Patch v9 looks ok.
>
> Will you please also add another patch for following:
> (all files in librte_ring - having BSD-2 license)
>
> /* SPDX-License-Identifier: BSD-3-Clause
> *
> * Copyright ..... (Intel or your company)
> * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
> * All rights reserved.
> * Derived from FreeBSD's bufring.h
> * Used as BSD-3 Licensed with permission from Kip Macy.
> */
>
>
With pleasure, thanks
On Fri, 19 Jan 2018 16:47:36 +0000
Hemant Agrawal <hemant.agrawal@nxp.com> wrote:
> Hi Olivier,
>
> > On Fri, Jan 19, 2018 at 07:45:30PM +0530, Hemant Agrawal wrote:
> > > Hi Jia,
> > >
> > > On 1/17/2018 9:33 AM, Jia He wrote:
> > > > Move the common part of rte_ring.h into rte_ring_generic.h.
> > > > Move the memory barrier part into update_tail().
> > > >
> > > > No functional changes here.
> > > >
> > > > Signed-off-by: Jia He <jia.he@hxt-semitech.com>
> > > > Suggested-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > > > Suggested-by: Ananyev Konstantin <konstantin.ananyev@intel.com>
> > > > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> > > > Acked-by: Olivier Matz <olivier.matz@6wind.com>
> > > > ---
> > > > diff --git a/lib/librte_ring/rte_ring_generic.h
> > > > b/lib/librte_ring/rte_ring_generic.h
> > > > new file mode 100644
> > > > index 0000000..01f2cae
> > > > --- /dev/null
> > > > +++ b/lib/librte_ring/rte_ring_generic.h
> > > > @@ -0,0 +1,202 @@
> > > > +/*-
> > > > + * Copyright(c) 2017 Intel Corporation. All rights reserved.
> > > > + * All rights reserved.
> > > > + *
> > > > + * SPDX-License-Identifier: BSD-3-Clause
> > >
> > > The SPDX should be first line. See other files for Intel or NXP.
>
> [Hemant] Don't add SPDX to this file.
> This file is not BSD-3 licensed. Please keep the full text as in the original file.
If it can't be BSD-3 licensed, then it needs to be removed. Mixing licenses is a real problem
@@ -98,9 +98,8 @@ rte_event_ring_enqueue_burst(struct rte_event_ring *r,
goto end;
ENQUEUE_PTRS(&r->r, &r[1], prod_head, events, n, struct rte_event);
- rte_smp_wmb();
- update_tail(&r->r.prod, prod_head, prod_next, 1);
+ update_tail(&r->r.prod, prod_head, prod_next, 1, 1);
end:
if (free_space != NULL)
*free_space = free_entries - n;
@@ -140,9 +139,8 @@ rte_event_ring_dequeue_burst(struct rte_event_ring *r,
goto end;
DEQUEUE_PTRS(&r->r, &r[1], cons_head, events, n, struct rte_event);
- rte_smp_rmb();
- update_tail(&r->r.cons, cons_head, cons_next, 1);
+ update_tail(&r->r.cons, cons_head, cons_next, 1, 0);
end:
if (available != NULL)
@@ -17,6 +17,7 @@ LIBABIVER := 1
SRCS-$(CONFIG_RTE_LIBRTE_RING) := rte_ring.c
# install includes
-SYMLINK-$(CONFIG_RTE_LIBRTE_RING)-include := rte_ring.h
+SYMLINK-$(CONFIG_RTE_LIBRTE_RING)-include := rte_ring.h \
+ rte_ring_generic.h
include $(RTE_SDK)/mk/rte.lib.mk
@@ -356,91 +356,8 @@ void rte_ring_dump(FILE *f, const struct rte_ring *r);
} \
} while (0)
-static __rte_always_inline void
-update_tail(struct rte_ring_headtail *ht, uint32_t old_val, uint32_t new_val,
- uint32_t single)
-{
- /*
- * If there are other enqueues/dequeues in progress that preceded us,
- * we need to wait for them to complete
- */
- if (!single)
- while (unlikely(ht->tail != old_val))
- rte_pause();
-
- ht->tail = new_val;
-}
-
-/**
- * @internal This function updates the producer head for enqueue
- *
- * @param r
- * A pointer to the ring structure
- * @param is_sp
- * Indicates whether multi-producer path is needed or not
- * @param n
- * The number of elements we will want to enqueue, i.e. how far should the
- * head be moved
- * @param behavior
- * RTE_RING_QUEUE_FIXED: Enqueue a fixed number of items from a ring
- * RTE_RING_QUEUE_VARIABLE: Enqueue as many items as possible from ring
- * @param old_head
- * Returns head value as it was before the move, i.e. where enqueue starts
- * @param new_head
- * Returns the current/new head value i.e. where enqueue finishes
- * @param free_entries
- * Returns the amount of free space in the ring BEFORE head was moved
- * @return
- * Actual number of objects enqueued.
- * If behavior == RTE_RING_QUEUE_FIXED, this will be 0 or n only.
- */
-static __rte_always_inline unsigned int
-__rte_ring_move_prod_head(struct rte_ring *r, int is_sp,
- unsigned int n, enum rte_ring_queue_behavior behavior,
- uint32_t *old_head, uint32_t *new_head,
- uint32_t *free_entries)
-{
- const uint32_t capacity = r->capacity;
- unsigned int max = n;
- int success;
-
- do {
- /* Reset n to the initial burst count */
- n = max;
-
- *old_head = r->prod.head;
-
- /* add rmb barrier to avoid load/load reorder in weak
- * memory model. It is noop on x86
- */
- rte_smp_rmb();
-
- const uint32_t cons_tail = r->cons.tail;
- /*
- * The subtraction is done between two unsigned 32bits value
- * (the result is always modulo 32 bits even if we have
- * *old_head > cons_tail). So 'free_entries' is always between 0
- * and capacity (which is < size).
- */
- *free_entries = (capacity + cons_tail - *old_head);
-
- /* check that we have enough room in ring */
- if (unlikely(n > *free_entries))
- n = (behavior == RTE_RING_QUEUE_FIXED) ?
- 0 : *free_entries;
-
- if (n == 0)
- return 0;
-
- *new_head = *old_head + n;
- if (is_sp)
- r->prod.head = *new_head, success = 1;
- else
- success = rte_atomic32_cmpset(&r->prod.head,
- *old_head, *new_head);
- } while (unlikely(success == 0));
- return n;
-}
+/* Move common functions to generic file */
+#include "rte_ring_generic.h"
/**
* @internal Enqueue several objects on the ring
@@ -476,9 +393,8 @@ __rte_ring_do_enqueue(struct rte_ring *r, void * const *obj_table,
goto end;
ENQUEUE_PTRS(r, &r[1], prod_head, obj_table, n, void *);
- rte_smp_wmb();
- update_tail(&r->prod, prod_head, prod_next, is_sp);
+ update_tail(&r->prod, prod_head, prod_next, is_sp, 1);
end:
if (free_space != NULL)
*free_space = free_entries - n;
@@ -486,74 +402,6 @@ __rte_ring_do_enqueue(struct rte_ring *r, void * const *obj_table,
}
/**
- * @internal This function updates the consumer head for dequeue
- *
- * @param r
- * A pointer to the ring structure
- * @param is_sc
- * Indicates whether multi-consumer path is needed or not
- * @param n
- * The number of elements we will want to enqueue, i.e. how far should the
- * head be moved
- * @param behavior
- * RTE_RING_QUEUE_FIXED: Dequeue a fixed number of items from a ring
- * RTE_RING_QUEUE_VARIABLE: Dequeue as many items as possible from ring
- * @param old_head
- * Returns head value as it was before the move, i.e. where dequeue starts
- * @param new_head
- * Returns the current/new head value i.e. where dequeue finishes
- * @param entries
- * Returns the number of entries in the ring BEFORE head was moved
- * @return
- * - Actual number of objects dequeued.
- * If behavior == RTE_RING_QUEUE_FIXED, this will be 0 or n only.
- */
-static __rte_always_inline unsigned int
-__rte_ring_move_cons_head(struct rte_ring *r, int is_sc,
- unsigned int n, enum rte_ring_queue_behavior behavior,
- uint32_t *old_head, uint32_t *new_head,
- uint32_t *entries)
-{
- unsigned int max = n;
- int success;
-
- /* move cons.head atomically */
- do {
- /* Restore n as it may change every loop */
- n = max;
-
- *old_head = r->cons.head;
-
- /* add rmb barrier to avoid load/load reorder in weak
- * memory model. It is noop on x86
- */
- rte_smp_rmb();
-
- const uint32_t prod_tail = r->prod.tail;
- /* The subtraction is done between two unsigned 32bits value
- * (the result is always modulo 32 bits even if we have
- * cons_head > prod_tail). So 'entries' is always between 0
- * and size(ring)-1. */
- *entries = (prod_tail - *old_head);
-
- /* Set the actual entries for dequeue */
- if (n > *entries)
- n = (behavior == RTE_RING_QUEUE_FIXED) ? 0 : *entries;
-
- if (unlikely(n == 0))
- return 0;
-
- *new_head = *old_head + n;
- if (is_sc)
- r->cons.head = *new_head, success = 1;
- else
- success = rte_atomic32_cmpset(&r->cons.head, *old_head,
- *new_head);
- } while (unlikely(success == 0));
- return n;
-}
-
-/**
* @internal Dequeue several objects from the ring
*
* @param r
@@ -587,9 +435,8 @@ __rte_ring_do_dequeue(struct rte_ring *r, void **obj_table,
goto end;
DEQUEUE_PTRS(r, &r[1], cons_head, obj_table, n, void *);
- rte_smp_rmb();
- update_tail(&r->cons, cons_head, cons_next, is_sc);
+ update_tail(&r->cons, cons_head, cons_next, is_sc, 0);
end:
if (available != NULL)
new file mode 100644
@@ -0,0 +1,202 @@
+/*-
+ * Copyright(c) 2017 Intel Corporation. All rights reserved.
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+/*
+ * Derived from FreeBSD's bufring.h
+ *
+ **************************************************************************
+ *
+ * Copyright (c) 2007-2009 Kip Macy kmacy@freebsd.org
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. The name of Kip Macy nor the names of other
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ***************************************************************************/
+
+#ifndef _RTE_RING_GENERIC_H_
+#define _RTE_RING_GENERIC_H_
+
+static __rte_always_inline void
+update_tail(struct rte_ring_headtail *ht, uint32_t old_val, uint32_t new_val,
+ uint32_t single, uint32_t enqueue)
+{
+ if (enqueue)
+ rte_smp_wmb();
+ else
+ rte_smp_rmb();
+ /*
+ * If there are other enqueues/dequeues in progress that preceded us,
+ * we need to wait for them to complete
+ */
+ if (!single)
+ while (unlikely(ht->tail != old_val))
+ rte_pause();
+
+ ht->tail = new_val;
+}
+
+/**
+ * @internal This function updates the producer head for enqueue
+ *
+ * @param r
+ * A pointer to the ring structure
+ * @param is_sp
+ * Indicates whether multi-producer path is needed or not
+ * @param n
+ * The number of elements we will want to enqueue, i.e. how far should the
+ * head be moved
+ * @param behavior
+ * RTE_RING_QUEUE_FIXED: Enqueue a fixed number of items from a ring
+ * RTE_RING_QUEUE_VARIABLE: Enqueue as many items as possible from ring
+ * @param old_head
+ * Returns head value as it was before the move, i.e. where enqueue starts
+ * @param new_head
+ * Returns the current/new head value i.e. where enqueue finishes
+ * @param free_entries
+ * Returns the amount of free space in the ring BEFORE head was moved
+ * @return
+ * Actual number of objects enqueued.
+ * If behavior == RTE_RING_QUEUE_FIXED, this will be 0 or n only.
+ */
+static __rte_always_inline unsigned int
+__rte_ring_move_prod_head(struct rte_ring *r, int is_sp,
+ unsigned int n, enum rte_ring_queue_behavior behavior,
+ uint32_t *old_head, uint32_t *new_head,
+ uint32_t *free_entries)
+{
+ const uint32_t capacity = r->capacity;
+ unsigned int max = n;
+ int success;
+
+ do {
+ /* Reset n to the initial burst count */
+ n = max;
+
+ *old_head = r->prod.head;
+
+ /* add rmb barrier to avoid load/load reorder in weak
+ * memory model. It is noop on x86
+ */
+ rte_smp_rmb();
+
+ const uint32_t cons_tail = r->cons.tail;
+ /*
+ * The subtraction is done between two unsigned 32bits value
+ * (the result is always modulo 32 bits even if we have
+ * *old_head > cons_tail). So 'free_entries' is always between 0
+ * and capacity (which is < size).
+ */
+ *free_entries = (capacity + cons_tail - *old_head);
+
+ /* check that we have enough room in ring */
+ if (unlikely(n > *free_entries))
+ n = (behavior == RTE_RING_QUEUE_FIXED) ?
+ 0 : *free_entries;
+
+ if (n == 0)
+ return 0;
+
+ *new_head = *old_head + n;
+ if (is_sp)
+ r->prod.head = *new_head, success = 1;
+ else
+ success = rte_atomic32_cmpset(&r->prod.head,
+ *old_head, *new_head);
+ } while (unlikely(success == 0));
+ return n;
+}
+
+/**
+ * @internal This function updates the consumer head for dequeue
+ *
+ * @param r
+ * A pointer to the ring structure
+ * @param is_sc
+ * Indicates whether multi-consumer path is needed or not
+ * @param n
+ * The number of elements we will want to enqueue, i.e. how far should the
+ * head be moved
+ * @param behavior
+ * RTE_RING_QUEUE_FIXED: Dequeue a fixed number of items from a ring
+ * RTE_RING_QUEUE_VARIABLE: Dequeue as many items as possible from ring
+ * @param old_head
+ * Returns head value as it was before the move, i.e. where dequeue starts
+ * @param new_head
+ * Returns the current/new head value i.e. where dequeue finishes
+ * @param entries
+ * Returns the number of entries in the ring BEFORE head was moved
+ * @return
+ * - Actual number of objects dequeued.
+ * If behavior == RTE_RING_QUEUE_FIXED, this will be 0 or n only.
+ */
+static __rte_always_inline unsigned int
+__rte_ring_move_cons_head(struct rte_ring *r, int is_sc,
+ unsigned int n, enum rte_ring_queue_behavior behavior,
+ uint32_t *old_head, uint32_t *new_head,
+ uint32_t *entries)
+{
+ unsigned int max = n;
+ int success;
+
+ /* move cons.head atomically */
+ do {
+ /* Restore n as it may change every loop */
+ n = max;
+
+ *old_head = r->cons.head;
+
+ /* add rmb barrier to avoid load/load reorder in weak
+ * memory model. It is noop on x86
+ */
+ rte_smp_rmb();
+
+ const uint32_t prod_tail = r->prod.tail;
+ /* The subtraction is done between two unsigned 32bits value
+ * (the result is always modulo 32 bits even if we have
+ * cons_head > prod_tail). So 'entries' is always between 0
+ * and size(ring)-1.
+ */
+ *entries = (prod_tail - *old_head);
+
+ /* Set the actual entries for dequeue */
+ if (n > *entries)
+ n = (behavior == RTE_RING_QUEUE_FIXED) ? 0 : *entries;
+
+ if (unlikely(n == 0))
+ return 0;
+
+ *new_head = *old_head + n;
+ if (is_sc)
+ r->cons.head = *new_head, success = 1;
+ else
+ success = rte_atomic32_cmpset(&r->cons.head, *old_head,
+ *new_head);
+ } while (unlikely(success == 0));
+ return n;
+}
+
+#endif /* _RTE_RING_GENERIC_H_ */