1 /*
2  * Copyright (C) 2017 Netronome Systems, Inc.
3  *
4  * This software is dual licensed under the GNU General License Version 2,
5  * June 1991 as shown in the file COPYING in the top-level directory of this
6  * source tree or the BSD 2-Clause License provided below.  You have the
7  * option to license this software under the complete terms of either license.
8  *
9  * The BSD 2-Clause License:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      1. Redistributions of source code must retain the above
16  *         copyright notice, this list of conditions and the following
17  *         disclaimer.
18  *
19  *      2. Redistributions in binary form must reproduce the above
20  *         copyright notice, this list of conditions and the following
21  *         disclaimer in the documentation and/or other materials
22  *         provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #ifndef __NFP_FLOWER_H__
35 #define __NFP_FLOWER_H__ 1
36 
37 #include <linux/circ_buf.h>
38 #include <linux/hashtable.h>
39 #include <linux/time64.h>
40 #include <linux/types.h>
41 
42 struct tc_to_netdev;
43 struct net_device;
44 struct nfp_app;
45 
46 #define NFP_FL_STATS_ENTRY_RS		BIT(20)
47 #define NFP_FL_STATS_ELEM_RS		4
48 #define NFP_FL_REPEATED_HASH_MAX	BIT(17)
49 #define NFP_FLOWER_HASH_BITS		19
50 #define NFP_FLOWER_MASK_ENTRY_RS	256
51 #define NFP_FLOWER_MASK_ELEMENT_RS	1
52 #define NFP_FLOWER_MASK_HASH_BITS	10
53 
54 #define NFP_FL_META_FLAG_NEW_MASK	128
55 #define NFP_FL_META_FLAG_LAST_MASK	1
56 
57 #define NFP_FL_MASK_REUSE_TIME_NS	40000
58 #define NFP_FL_MASK_ID_LOCATION		1
59 
60 struct nfp_fl_mask_id {
61 	struct circ_buf mask_id_free_list;
62 	struct timespec64 *last_used;
63 	u8 init_unallocated;
64 };
65 
66 struct nfp_fl_stats_id {
67 	struct circ_buf free_list;
68 	u32 init_unalloc;
69 	u8 repeated_em_count;
70 };
71 
72 /**
73  * struct nfp_flower_priv - Flower APP per-vNIC priv data
74  * @nn:			Pointer to vNIC
75  * @mask_id_seed:	Seed used for mask hash table
76  * @flower_version:	HW version of flower
77  * @stats_ids:		List of free stats ids
78  * @mask_ids:		List of free mask ids
79  * @mask_table:		Hash table used to store masks
80  * @flow_table:		Hash table used to store flower rules
81  */
82 struct nfp_flower_priv {
83 	struct nfp_net *nn;
84 	u32 mask_id_seed;
85 	u64 flower_version;
86 	struct nfp_fl_stats_id stats_ids;
87 	struct nfp_fl_mask_id mask_ids;
88 	DECLARE_HASHTABLE(mask_table, NFP_FLOWER_MASK_HASH_BITS);
89 	DECLARE_HASHTABLE(flow_table, NFP_FLOWER_HASH_BITS);
90 };
91 
92 struct nfp_fl_key_ls {
93 	u32 key_layer_two;
94 	u8 key_layer;
95 	int key_size;
96 };
97 
98 struct nfp_fl_rule_metadata {
99 	u8 key_len;
100 	u8 mask_len;
101 	u8 act_len;
102 	u8 flags;
103 	__be32 host_ctx_id;
104 	__be64 host_cookie __packed;
105 	__be64 flow_version __packed;
106 	__be32 shortcut;
107 };
108 
109 struct nfp_fl_stats {
110 	u64 pkts;
111 	u64 bytes;
112 	u64 used;
113 };
114 
115 struct nfp_fl_payload {
116 	struct nfp_fl_rule_metadata meta;
117 	unsigned long tc_flower_cookie;
118 	struct hlist_node link;
119 	struct rcu_head rcu;
120 	spinlock_t lock; /* lock stats */
121 	struct nfp_fl_stats stats;
122 	char *unmasked_data;
123 	char *mask_data;
124 	char *action_data;
125 };
126 
127 struct nfp_fl_stats_frame {
128 	__be32 stats_con_id;
129 	__be32 pkt_count;
130 	__be64 byte_count;
131 	__be64 stats_cookie;
132 };
133 
134 int nfp_flower_metadata_init(struct nfp_app *app);
135 void nfp_flower_metadata_cleanup(struct nfp_app *app);
136 
137 int nfp_flower_setup_tc(struct nfp_app *app, struct net_device *netdev,
138 			u32 handle, __be16 proto, struct tc_to_netdev *tc);
139 int nfp_flower_compile_flow_match(struct tc_cls_flower_offload *flow,
140 				  struct nfp_fl_key_ls *key_ls,
141 				  struct net_device *netdev,
142 				  struct nfp_fl_payload *nfp_flow);
143 int nfp_flower_compile_action(struct tc_cls_flower_offload *flow,
144 			      struct net_device *netdev,
145 			      struct nfp_fl_payload *nfp_flow);
146 int nfp_compile_flow_metadata(struct nfp_app *app,
147 			      struct tc_cls_flower_offload *flow,
148 			      struct nfp_fl_payload *nfp_flow);
149 int nfp_modify_flow_metadata(struct nfp_app *app,
150 			     struct nfp_fl_payload *nfp_flow);
151 
152 struct nfp_fl_payload *
153 nfp_flower_search_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
154 struct nfp_fl_payload *
155 nfp_flower_remove_fl_table(struct nfp_app *app, unsigned long tc_flower_cookie);
156 
157 void nfp_flower_rx_flow_stats(struct nfp_app *app, struct sk_buff *skb);
158 
159 #endif
160