doc: add AMD CCP guide
[dpdk.git] / lib / librte_distributor / rte_distributor_v20.c
index be297ec..9566b53 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       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.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
  */
 
 #include <stdio.h>
 #include <rte_memory.h>
 #include <rte_memzone.h>
 #include <rte_errno.h>
+#include <rte_compat.h>
 #include <rte_string_fns.h>
 #include <rte_eal_memconfig.h>
+#include <rte_pause.h>
+
 #include "rte_distributor_v20.h"
 #include "rte_distributor_private.h"
 
-TAILQ_HEAD(rte_distributor_list, rte_distributor);
+TAILQ_HEAD(rte_distributor_list, rte_distributor_v20);
 
 static struct rte_tailq_elem rte_distributor_tailq = {
        .name = "RTE_DISTRIBUTOR",
@@ -53,22 +27,23 @@ EAL_REGISTER_TAILQ(rte_distributor_tailq)
 /**** APIs called by workers ****/
 
 void
-rte_distributor_request_pkt(struct rte_distributor *d,
+rte_distributor_request_pkt_v20(struct rte_distributor_v20 *d,
                unsigned worker_id, struct rte_mbuf *oldpkt)
 {
-       union rte_distributor_buffer *buf = &d->bufs[worker_id];
+       union rte_distributor_buffer_v20 *buf = &d->bufs[worker_id];
        int64_t req = (((int64_t)(uintptr_t)oldpkt) << RTE_DISTRIB_FLAG_BITS)
                        | RTE_DISTRIB_GET_BUF;
        while (unlikely(buf->bufptr64 & RTE_DISTRIB_FLAGS_MASK))
                rte_pause();
        buf->bufptr64 = req;
 }
+VERSION_SYMBOL(rte_distributor_request_pkt, _v20, 2.0);
 
 struct rte_mbuf *
-rte_distributor_poll_pkt(struct rte_distributor *d,
+rte_distributor_poll_pkt_v20(struct rte_distributor_v20 *d,
                unsigned worker_id)
 {
-       union rte_distributor_buffer *buf = &d->bufs[worker_id];
+       union rte_distributor_buffer_v20 *buf = &d->bufs[worker_id];
        if (buf->bufptr64 & RTE_DISTRIB_GET_BUF)
                return NULL;
 
@@ -76,28 +51,31 @@ rte_distributor_poll_pkt(struct rte_distributor *d,
        int64_t ret = buf->bufptr64 >> RTE_DISTRIB_FLAG_BITS;
        return (struct rte_mbuf *)((uintptr_t)ret);
 }
+VERSION_SYMBOL(rte_distributor_poll_pkt, _v20, 2.0);
 
 struct rte_mbuf *
-rte_distributor_get_pkt(struct rte_distributor *d,
+rte_distributor_get_pkt_v20(struct rte_distributor_v20 *d,
                unsigned worker_id, struct rte_mbuf *oldpkt)
 {
        struct rte_mbuf *ret;
-       rte_distributor_request_pkt(d, worker_id, oldpkt);
-       while ((ret = rte_distributor_poll_pkt(d, worker_id)) == NULL)
+       rte_distributor_request_pkt_v20(d, worker_id, oldpkt);
+       while ((ret = rte_distributor_poll_pkt_v20(d, worker_id)) == NULL)
                rte_pause();
        return ret;
 }
+VERSION_SYMBOL(rte_distributor_get_pkt, _v20, 2.0);
 
 int
-rte_distributor_return_pkt(struct rte_distributor *d,
+rte_distributor_return_pkt_v20(struct rte_distributor_v20 *d,
                unsigned worker_id, struct rte_mbuf *oldpkt)
 {
-       union rte_distributor_buffer *buf = &d->bufs[worker_id];
+       union rte_distributor_buffer_v20 *buf = &d->bufs[worker_id];
        uint64_t req = (((int64_t)(uintptr_t)oldpkt) << RTE_DISTRIB_FLAG_BITS)
                        | RTE_DISTRIB_RETURN_BUF;
        buf->bufptr64 = req;
        return 0;
 }
+VERSION_SYMBOL(rte_distributor_return_pkt, _v20, 2.0);
 
 /**** APIs called on distributor core ***/
 
@@ -123,7 +101,7 @@ backlog_pop(struct rte_distributor_backlog *bl)
 
 /* stores a packet returned from a worker inside the returns array */
 static inline void
-store_return(uintptr_t oldbuf, struct rte_distributor *d,
+store_return(uintptr_t oldbuf, struct rte_distributor_v20 *d,
                unsigned *ret_start, unsigned *ret_count)
 {
        /* store returns in a circular buffer - code is branch-free */
@@ -134,7 +112,7 @@ store_return(uintptr_t oldbuf, struct rte_distributor *d,
 }
 
 static inline void
-handle_worker_shutdown(struct rte_distributor *d, unsigned wkr)
+handle_worker_shutdown(struct rte_distributor_v20 *d, unsigned int wkr)
 {
        d->in_flight_tags[wkr] = 0;
        d->in_flight_bitmask &= ~(1UL << wkr);
@@ -164,7 +142,7 @@ handle_worker_shutdown(struct rte_distributor *d, unsigned wkr)
                 * Note that the tags were set before first level call
                 * to rte_distributor_process.
                 */
-               rte_distributor_process(d, pkts, i);
+               rte_distributor_process_v20(d, pkts, i);
                bl->count = bl->start = 0;
        }
 }
@@ -174,7 +152,7 @@ handle_worker_shutdown(struct rte_distributor *d, unsigned wkr)
  * to do a partial flush.
  */
 static int
-process_returns(struct rte_distributor *d)
+process_returns(struct rte_distributor_v20 *d)
 {
        unsigned wkr;
        unsigned flushed = 0;
@@ -213,7 +191,7 @@ process_returns(struct rte_distributor *d)
 
 /* process a set of packets to distribute them to workers */
 int
-rte_distributor_process(struct rte_distributor *d,
+rte_distributor_process_v20(struct rte_distributor_v20 *d,
                struct rte_mbuf **mbufs, unsigned num_mbufs)
 {
        unsigned next_idx = 0;
@@ -237,7 +215,7 @@ rte_distributor_process(struct rte_distributor *d,
                        next_value = (((int64_t)(uintptr_t)next_mb)
                                        << RTE_DISTRIB_FLAG_BITS);
                        /*
-                        * User is advocated to set tag vaue for each
+                        * User is advocated to set tag value for each
                         * mbuf before calling rte_distributor_process.
                         * User defined tags are used to identify flows,
                         * or sessions.
@@ -314,10 +292,11 @@ rte_distributor_process(struct rte_distributor *d,
        d->returns.count = ret_count;
        return num_mbufs;
 }
+VERSION_SYMBOL(rte_distributor_process, _v20, 2.0);
 
 /* return to the caller, packets returned from workers */
 int
-rte_distributor_returned_pkts(struct rte_distributor *d,
+rte_distributor_returned_pkts_v20(struct rte_distributor_v20 *d,
                struct rte_mbuf **mbufs, unsigned max_mbufs)
 {
        struct rte_distributor_returned_pkts *returns = &d->returns;
@@ -334,11 +313,13 @@ rte_distributor_returned_pkts(struct rte_distributor *d,
 
        return retval;
 }
+VERSION_SYMBOL(rte_distributor_returned_pkts, _v20, 2.0);
 
 /* return the number of packets in-flight in a distributor, i.e. packets
- * being workered on or queued up in a backlog. */
+ * being worked on or queued up in a backlog.
+ */
 static inline unsigned
-total_outstanding(const struct rte_distributor *d)
+total_outstanding(const struct rte_distributor_v20 *d)
 {
        unsigned wkr, total_outstanding;
 
@@ -353,33 +334,35 @@ total_outstanding(const struct rte_distributor *d)
 /* flush the distributor, so that there are no outstanding packets in flight or
  * queued up. */
 int
-rte_distributor_flush(struct rte_distributor *d)
+rte_distributor_flush_v20(struct rte_distributor_v20 *d)
 {
        const unsigned flushed = total_outstanding(d);
 
        while (total_outstanding(d) > 0)
-               rte_distributor_process(d, NULL, 0);
+               rte_distributor_process_v20(d, NULL, 0);
 
        return flushed;
 }
+VERSION_SYMBOL(rte_distributor_flush, _v20, 2.0);
 
 /* clears the internal returns array in the distributor */
 void
-rte_distributor_clear_returns(struct rte_distributor *d)
+rte_distributor_clear_returns_v20(struct rte_distributor_v20 *d)
 {
        d->returns.start = d->returns.count = 0;
 #ifndef __OPTIMIZE__
        memset(d->returns.mbufs, 0, sizeof(d->returns.mbufs));
 #endif
 }
+VERSION_SYMBOL(rte_distributor_clear_returns, _v20, 2.0);
 
 /* creates a distributor instance */
-struct rte_distributor *
-rte_distributor_create(const char *name,
+struct rte_distributor_v20 *
+rte_distributor_create_v20(const char *name,
                unsigned socket_id,
                unsigned num_workers)
 {
-       struct rte_distributor *d;
+       struct rte_distributor_v20 *d;
        struct rte_distributor_list *distributor_list;
        char mz_name[RTE_MEMZONE_NAMESIZE];
        const struct rte_memzone *mz;
@@ -415,3 +398,4 @@ rte_distributor_create(const char *name,
 
        return d;
 }
+VERSION_SYMBOL(rte_distributor_create, _v20, 2.0);