ring: return free space when enqueuing
[dpdk.git] / examples / l2fwd-cat / cat.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2016 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _CAT_H
35 #define _CAT_H
36
37 /**
38  * @file
39  * PQoS CAT
40  */
41
42 #include <stdint.h>
43 #include <string.h>
44
45 #include <rte_lcore.h>
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 /* L3 cache allocation class of service data structure */
52 struct cat_config {
53         rte_cpuset_t cpumask;           /* CPUs bitmask */
54         int cdp;                        /* data & code masks used if true */
55         union {
56                 uint64_t mask;          /* capacity bitmask (CBM) */
57                 struct {
58                         uint64_t data_mask; /* data capacity bitmask (CBM) */
59                         uint64_t code_mask; /* code capacity bitmask (CBM) */
60                 };
61         };
62 };
63
64 int cat_init(int argc, char **argv);
65
66 void cat_exit(void);
67
68 #ifdef __cplusplus
69 }
70 #endif
71
72 #endif /* _CAT_H */