blob: 083e4f6aea270f5a09d2a4fb89c039a0793dbd14 [file] [log] [blame]
Ben Menchaca84f36632014-02-28 20:57:38 +00001/*
2 **************************************************************************
Murat Sezgina05befb2019-10-08 17:00:37 -07003 * Copyright (c) 2014-2015, 2018-2020 The Linux Foundation. All rights reserved.
Ben Menchaca84f36632014-02-28 20:57:38 +00004 * Permission to use, copy, modify, and/or distribute this software for
5 * any purpose with or without fee is hereby granted, provided that the
6 * above copyright notice and this permission notice appear in all copies.
7 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
13 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 **************************************************************************
15 */
16
17struct ecm_classifier_instance;
18
19/*
20 * Classifier types.
21 * MUST BE RECORDED IN ASCENDING ORDER OF PRIORITY
22 */
23enum ecm_classifier_types {
24 ECM_CLASSIFIER_TYPE_DEFAULT = 0, /* MUST BE FIRST, Default classifier */
Murat Sezginf4f7ab42018-10-12 17:01:46 -070025#ifdef ECM_CLASSIFIER_MARK_ENABLE
26 ECM_CLASSIFIER_TYPE_MARK, /* Mark classifier */
27#endif
Hai Shalom81f4e202014-06-04 09:30:27 -070028#ifdef ECM_CLASSIFIER_HYFI_ENABLE
Ben Menchaca84f36632014-02-28 20:57:38 +000029 ECM_CLASSIFIER_TYPE_HYFI, /* HyFi classifier */
Hai Shalom81f4e202014-06-04 09:30:27 -070030#endif
Murat Sezginb3731e82014-11-26 12:20:59 -080031#ifdef ECM_CLASSIFIER_DSCP_ENABLE
Gareth Williams8932a912014-06-11 18:06:25 -070032 ECM_CLASSIFIER_TYPE_DSCP, /* Provides DSCP and DSCP remarking support */
Murat Sezginb3731e82014-11-26 12:20:59 -080033#endif
34#ifdef ECM_CLASSIFIER_NL_ENABLE
Ben Menchaca84f36632014-02-28 20:57:38 +000035 ECM_CLASSIFIER_TYPE_NL, /* Provides netlink interface */
Murat Sezginb3731e82014-11-26 12:20:59 -080036#endif
Murat Sezgina05befb2019-10-08 17:00:37 -070037#ifdef ECM_CLASSIFIER_OVS_ENABLE
38 ECM_CLASSIFIER_TYPE_OVS, /* OVS classifier */
39#endif
Gareth Williamsdcda9b92015-05-13 10:08:15 +010040#ifdef ECM_CLASSIFIER_PCC_ENABLE
41 ECM_CLASSIFIER_TYPE_PCC, /* Parental control subsystem support classifier */
42#endif
Ben Menchaca84f36632014-02-28 20:57:38 +000043 ECM_CLASSIFIER_TYPES, /* MUST BE LAST */
44};
45typedef enum ecm_classifier_types ecm_classifier_type_t;
46
47/*
48 * enum ecm_classifier_relevances
49 * Whether a classifier is relevant to a connection
50 */
51enum ecm_classifier_relevances {
52 ECM_CLASSIFIER_RELEVANCE_MAYBE = 0, /* Classifier has not yet determined relevance */
53 ECM_CLASSIFIER_RELEVANCE_NO, /* Classifier is not relevant to a connection (classifier will be unassigned from the connection after returning this from a process() call) */
54 ECM_CLASSIFIER_RELEVANCE_YES, /* Classifier is relevant to the connection, process actions will be inspected by the front end when returning this from a process() call */
55};
56typedef enum ecm_classifier_relevances ecm_classifier_relevence_t;
57
58/*
59 * enum ecm_classifier_acceleration_modes
60 * Modes in which a connection may be accelerated
Murat Sezgind701ac52014-08-20 14:02:30 -070061 *
62 * These are used by a classifier to indicate its desire to accelerate.
Ben Menchaca84f36632014-02-28 20:57:38 +000063 */
64enum ecm_classifier_acceleration_modes {
65 ECM_CLASSIFIER_ACCELERATION_MODE_DONT_CARE = 0, /* Classifier does not care if the connection is accelerated */
66 ECM_CLASSIFIER_ACCELERATION_MODE_NO, /* Connection must not be accelerated */
67 ECM_CLASSIFIER_ACCELERATION_MODE_ACCEL, /* Connection can be accelerated whenever */
68};
69typedef enum ecm_classifier_acceleration_modes ecm_classifier_acceleration_mode_t;
70
71/*
72 * Process actions
73 * A process result, that is relevant, may contain zero or more actions for the front end.
74 * Due to the parallel processing nature of classifiers, *usually* the action(s) of the highest priority
75 * classifier will override any lower priority actions. This is up to front end discretion, of course.
76 */
Gareth Williams27c3db12014-06-11 17:37:56 -070077#define ECM_CLASSIFIER_PROCESS_ACTION_DROP 0x00000001 /* Drop */
78#define ECM_CLASSIFIER_PROCESS_ACTION_QOS_TAG 0x00000002 /* Contains flow & return qos tags */
Ben Menchaca84f36632014-02-28 20:57:38 +000079#define ECM_CLASSIFIER_PROCESS_ACTION_ACCEL_MODE 0x00000004 /* Contains an accel mode */
80#define ECM_CLASSIFIER_PROCESS_ACTION_TIMER_GROUP 0x00000008 /* Contains a timer group change */
Murat Sezgin62c92832015-03-06 16:08:31 -080081
82#ifdef ECM_CLASSIFIER_DSCP_ENABLE
Gareth Williamsbd03e232014-06-11 17:55:28 -070083#define ECM_CLASSIFIER_PROCESS_ACTION_DSCP 0x00000010 /* Contains DSCP marking information */
84#define ECM_CLASSIFIER_PROCESS_ACTION_DSCP_DENY 0x00000020 /* Denies any DSCP changes */
Manish Vermaed493782019-05-27 12:56:02 +053085
86#define ECM_CLASSIFIER_PROCESS_ACTION_IGS_QOS_TAG 0x00000040 /* Contains flow & return ingress qos tags */
Murat Sezgin62c92832015-03-06 16:08:31 -080087#endif
Ben Menchaca84f36632014-02-28 20:57:38 +000088
Murat Sezgin964bfd82019-11-18 14:28:37 -080089#ifdef ECM_CLASSIFIER_OVS_ENABLE
90#define ECM_CLASSIFIER_PROCESS_ACTION_OVS_VLAN_TAG 0x00000080 /* Contains OVS VLAN tags */
Suman Ghoshe1c939c2019-11-12 20:43:04 +053091#define ECM_CLASSIFIER_PROCESS_ACTION_OVS_VLAN_QINQ_TAG 0x00000100 /* Contains OVS QinQ VLAN tags */
92#define ECM_CLASSIFIER_PROCESS_ACTION_OVS_MCAST_DENY_ACCEL 0x00000200 /* Multicast OVS flow */
Murat Sezgin964bfd82019-11-18 14:28:37 -080093#endif
94
Ben Menchaca84f36632014-02-28 20:57:38 +000095/*
96 * struct ecm_classifier_process_response
97 * Response structure returned by a process call
98 */
99struct ecm_classifier_process_response {
100 ecm_classifier_relevence_t relevance; /* Is this classifier relevant to the connection? */
101 uint32_t became_relevant; /* DB time the classifier became relevant or not relevant, if relevance is maybe this field is not relevant! */
102
103 uint32_t process_actions; /* Actions this process response contains */
104
105 /*
106 * The following fields are only to be inspected if this response is relevant AND the process_actions indicates so
107 */
108 bool drop; /* Drop packet at hand */
Gareth Williams27c3db12014-06-11 17:37:56 -0700109 uint32_t flow_qos_tag; /* QoS tag to use for the packet */
110 uint32_t return_qos_tag; /* QoS tag to use for the packet */
Manish Vermaed493782019-05-27 12:56:02 +0530111 uint16_t igs_flow_qos_tag; /* Ingress QoS tag to use for the packet */
112 uint16_t igs_return_qos_tag; /* Ingress QoS tag to use for the return packet */
Murat Sezgin62c92832015-03-06 16:08:31 -0800113#ifdef ECM_CLASSIFIER_DSCP_ENABLE
Gareth Williamsbd03e232014-06-11 17:55:28 -0700114 uint8_t flow_dscp; /* DSCP mark for flow */
115 uint8_t return_dscp; /* DSCP mark for return */
Murat Sezgin62c92832015-03-06 16:08:31 -0800116#endif
Murat Sezgin964bfd82019-11-18 14:28:37 -0800117#ifdef ECM_CLASSIFIER_OVS_ENABLE
118 uint32_t ingress_vlan_tag[2]; /* Ingress VLAN tags */
119 uint32_t egress_vlan_tag[2]; /* Egress VLAN tags */
120#endif
Ben Menchaca84f36632014-02-28 20:57:38 +0000121 ecm_classifier_acceleration_mode_t accel_mode; /* Acceleration needed for this connection */
122 ecm_db_timer_group_t timer_group; /* Timer group the connection should be in */
123};
124
125/*
Murat Sezginb2676062015-06-12 17:05:31 -0700126 * Sync rule structure.
127 * Acceleration engine's sync parameters will be stored
128 * in this data structure to update the classifiers.
129 */
130struct ecm_classifier_rule_sync {
Murat Sezgina05befb2019-10-08 17:00:37 -0700131 /*
132 * TODO: Use directional arrays for flow/return.
133 */
Murat Sezginb2676062015-06-12 17:05:31 -0700134 uint32_t flow_tx_packet_count;
Murat Sezgina05befb2019-10-08 17:00:37 -0700135 uint32_t flow_tx_byte_count;
136 uint32_t flow_rx_packet_count;
137 uint32_t flow_rx_byte_count;
Murat Sezginb2676062015-06-12 17:05:31 -0700138 uint32_t return_tx_packet_count;
Murat Sezgina05befb2019-10-08 17:00:37 -0700139 uint32_t return_tx_byte_count;
140 uint32_t return_rx_packet_count;
141 uint32_t return_rx_byte_count;
Murat Sezginb2676062015-06-12 17:05:31 -0700142 uint32_t reason;
143};
144
145/*
146 * Create rule structure.
147 * Additional create rule parameters from the classifiers
148 * will be copied to this data structure before pushing them to
149 * the underlying accelaration engine.
150 */
151struct ecm_classifier_rule_create {
152
153};
154
155/*
Ben Menchaca84f36632014-02-28 20:57:38 +0000156 * To be implemented by all classifiers
157 */
158typedef void (*ecm_classifier_ref_method_t)(struct ecm_classifier_instance *ci);
159typedef int (*ecm_classifier_deref_callback_t)(struct ecm_classifier_instance *ci);
160typedef void (*ecm_classifier_process_callback_t)(struct ecm_classifier_instance *ci, ecm_tracker_sender_type_t sender, struct ecm_tracker_ip_header *ip_hdr, struct sk_buff *skb, struct ecm_classifier_process_response *process_response);
161 /* Process new data for connection, process_response is populated with the response of processing */
Murat Sezginb2676062015-06-12 17:05:31 -0700162typedef void (*ecm_classifier_sync_from_v4_callback_t)(struct ecm_classifier_instance *ci, struct ecm_classifier_rule_create *ecrc);
163 /* Sync the accel engine state with state from the classifier */
164typedef void (*ecm_classifier_sync_to_v4_callback_t)(struct ecm_classifier_instance *ci, struct ecm_classifier_rule_sync *sync);
165 /* Sync the classifier state with current accel engine state */
166typedef void (*ecm_classifier_sync_from_v6_callback_t)(struct ecm_classifier_instance *ci, struct ecm_classifier_rule_create *ecrc);
167 /* Sync the accel engine state with state from the classifier */
168typedef void (*ecm_classifier_sync_to_v6_callback_t)(struct ecm_classifier_instance *ci, struct ecm_classifier_rule_sync *sync);
169 /* Sync the classifier state with current accel engine state */
Ben Menchaca84f36632014-02-28 20:57:38 +0000170typedef ecm_classifier_type_t (*ecm_classifier_type_get_callback_t)(struct ecm_classifier_instance *ci);
171 /* Get type of classifier this is */
172typedef bool (*ecm_classifier_reclassify_allowed_get_callback_t)(struct ecm_classifier_instance *ci);
173 /* Get whether reclassification is allowed */
174typedef void (*ecm_classifier_reclassify_callback_t)(struct ecm_classifier_instance *ci);
175 /* Reclassify */
176typedef void (*ecm_classifier_last_process_response_get_callback_t)(struct ecm_classifier_instance *ci, struct ecm_classifier_process_response *process_response);
177 /* Get last process response */
Gareth Williamsf98d4192015-03-11 16:55:41 +0000178#ifdef ECM_STATE_OUTPUT_ENABLE
Gareth Williamsd5618a82015-05-20 11:13:32 +0100179typedef int (*ecm_classifier_state_get_callback_t)(struct ecm_classifier_instance *ci, struct ecm_state_file_instance *sfi);
180 /* Get state output. Returns 0 upon success. */
Gareth Williamsf98d4192015-03-11 16:55:41 +0000181#endif
Ben Menchaca84f36632014-02-28 20:57:38 +0000182
183/*
Murat Sezgine34b0172015-11-05 21:58:14 -0800184 * Determines if a connection should be kept.
185 */
186typedef bool (*ecm_classifier_should_keep_connection_t)
187 (struct ecm_classifier_instance *ci, uint8_t *mac);
188
189/*
Ben Menchaca84f36632014-02-28 20:57:38 +0000190 * Base class for all types of classifiers
191 */
192struct ecm_classifier_instance {
193 struct ecm_classifier_instance *ca_next; /* DB use only: Connection assignment next pointer */
194 struct ecm_classifier_instance *ca_prev; /* DB use only: Connection assignment prev pointer */
195
196 ecm_classifier_process_callback_t process; /* Process new skb */
197 ecm_classifier_sync_from_v4_callback_t sync_from_v4;
Murat Sezginb2676062015-06-12 17:05:31 -0700198 /* Sync the accel engine with state from the classifier */
199 ecm_classifier_sync_to_v4_callback_t sync_to_v4;/* Sync the classifier with state from the accel engine */
Ben Menchaca84f36632014-02-28 20:57:38 +0000200 ecm_classifier_sync_from_v6_callback_t sync_from_v6;
Murat Sezginb2676062015-06-12 17:05:31 -0700201 /* Sync the accel engine with state from the classifier */
202 ecm_classifier_sync_to_v6_callback_t sync_to_v6;/* Sync the classifier with state from the accel engine */
Ben Menchaca84f36632014-02-28 20:57:38 +0000203 ecm_classifier_type_get_callback_t type_get; /* Get type of classifier */
204 ecm_classifier_reclassify_allowed_get_callback_t reclassify_allowed;
205 /* Get whether reclassification is allowed */
206 ecm_classifier_reclassify_callback_t reclassify;
207 /* Reclassify */
208 ecm_classifier_last_process_response_get_callback_t last_process_response_get;
209 /* Return last process response */
Murat Sezgine34b0172015-11-05 21:58:14 -0800210 ecm_classifier_should_keep_connection_t should_keep_connection;
211 /* Check if connection should be kept when FDB updates */
Gareth Williamsf98d4192015-03-11 16:55:41 +0000212#ifdef ECM_STATE_OUTPUT_ENABLE
Gareth Williamsd5618a82015-05-20 11:13:32 +0100213 ecm_classifier_state_get_callback_t state_get;
214 /* Return its state */
Gareth Williamsf98d4192015-03-11 16:55:41 +0000215#endif
Ben Menchaca84f36632014-02-28 20:57:38 +0000216 ecm_classifier_ref_method_t ref;
217 ecm_classifier_deref_callback_t deref;
218};
219
Gareth Williamsf98d4192015-03-11 16:55:41 +0000220#ifdef ECM_STATE_OUTPUT_ENABLE
Ben Menchaca84f36632014-02-28 20:57:38 +0000221/*
Gareth Williamsd5618a82015-05-20 11:13:32 +0100222 * ecm_classifier_process_response_state_get()
223 * Output detail for the process response
Ben Menchaca84f36632014-02-28 20:57:38 +0000224 *
Gareth Williamsd5618a82015-05-20 11:13:32 +0100225 * Returns 0 on success.
Ben Menchaca84f36632014-02-28 20:57:38 +0000226 */
Gareth Williamsd5618a82015-05-20 11:13:32 +0100227static inline int ecm_classifier_process_response_state_get(struct ecm_state_file_instance *sfi, struct ecm_classifier_process_response *pr)
Ben Menchaca84f36632014-02-28 20:57:38 +0000228{
Gareth Williamsd5618a82015-05-20 11:13:32 +0100229 int result;
230
231 if ((result = ecm_state_prefix_add(sfi, "pr"))) {
232 return result;
233 }
Ben Menchaca84f36632014-02-28 20:57:38 +0000234
235 if (pr->relevance == ECM_CLASSIFIER_RELEVANCE_NO) {
Gareth Williamsd5618a82015-05-20 11:13:32 +0100236 return ecm_state_write(sfi, "relevant", "%s", "no");
Ben Menchaca84f36632014-02-28 20:57:38 +0000237 }
238
239 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_DROP) {
240 if (pr->drop) {
Gareth Williamsd5618a82015-05-20 11:13:32 +0100241 if ((result = ecm_state_write(sfi, "drop", "yes"))) {
242 return result;
243 }
Ben Menchaca84f36632014-02-28 20:57:38 +0000244 } else {
Gareth Williamsd5618a82015-05-20 11:13:32 +0100245 if ((result = ecm_state_write(sfi, "drop", "no"))) {
246 return result;
247 }
Ben Menchaca84f36632014-02-28 20:57:38 +0000248 }
249 }
250
Ben Menchaca84f36632014-02-28 20:57:38 +0000251 if (pr->relevance == ECM_CLASSIFIER_RELEVANCE_MAYBE) {
Gareth Williamsd5618a82015-05-20 11:13:32 +0100252 if ((result = ecm_state_write(sfi, "accel", "denied"))) {
253 return result;
254 }
255 if ((result = ecm_state_write(sfi, "relevant", "maybe"))) {
256 return result;
257 }
Ben Menchaca84f36632014-02-28 20:57:38 +0000258 } else {
Gareth Williamsd5618a82015-05-20 11:13:32 +0100259 if ((result = ecm_state_write(sfi, "relevant", "yes"))) {
260 return result;
261 }
262 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_ACCEL_MODE) {
263 if (pr->accel_mode == ECM_CLASSIFIER_ACCELERATION_MODE_ACCEL) {
264 if ((result = ecm_state_write(sfi, "accel", "wanted"))) {
265 return result;
266 }
267 }
268 else if (pr->accel_mode == ECM_CLASSIFIER_ACCELERATION_MODE_NO) {
269 if ((result = ecm_state_write(sfi, "accel", "denied"))) {
270 return result;
271 }
272 }
273 /* Else don't care */
274 }
Ben Menchaca84f36632014-02-28 20:57:38 +0000275 }
276
Murat Sezgin964bfd82019-11-18 14:28:37 -0800277#ifdef ECM_CLASSIFIER_OVS_ENABLE
278 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_OVS_VLAN_TAG) {
279 if ((result = ecm_state_write(sfi, "ingress_vlan_tag[0]", "0x%x", pr->ingress_vlan_tag[0]))) {
280 return result;
281 }
282 if ((result = ecm_state_write(sfi, "egress_vlan_tag[0]", "0x%x", pr->egress_vlan_tag[0]))) {
283 return result;
284 }
285 }
286
287 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_OVS_VLAN_QINQ_TAG) {
288 if ((result = ecm_state_write(sfi, "ingress_vlan_tag[1]", "0x%x", pr->ingress_vlan_tag[1]))) {
289 return result;
290 }
291 if ((result = ecm_state_write(sfi, "egress_vlan_tag[1]", "0x%x", pr->egress_vlan_tag[1]))) {
292 return result;
293 }
294 }
295#endif
296
Manish Vermaed493782019-05-27 12:56:02 +0530297#ifdef ECM_CLASSIFIER_DSCP_ENABLE
Gareth Williamsd5618a82015-05-20 11:13:32 +0100298 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_QOS_TAG) {
299 if ((result = ecm_state_write(sfi, "flow_qos_tag", "%u", pr->flow_qos_tag))) {
300 return result;
301 }
302 if ((result = ecm_state_write(sfi, "return_qos_tag", "%u", pr->return_qos_tag))) {
303 return result;
304 }
305 }
Manish Vermaed493782019-05-27 12:56:02 +0530306
307 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_IGS_QOS_TAG) {
308 if ((result = ecm_state_write(sfi, "igs_flow_qos_tag", "%u", pr->igs_flow_qos_tag))) {
309 return result;
310 }
311 if ((result = ecm_state_write(sfi, "igs_return_qos_tag", "%u", pr->igs_return_qos_tag))) {
312 return result;
313 }
314 }
315
Gareth Williamsd5618a82015-05-20 11:13:32 +0100316 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_DSCP) {
317 if ((result = ecm_state_write(sfi, "flow_dscp", "%u", pr->flow_dscp))) {
318 return result;
319 }
320 if ((result = ecm_state_write(sfi, "return_dscp", "%u", pr->return_dscp))) {
321 return result;
322 }
323 }
324#endif
325 if (pr->process_actions & ECM_CLASSIFIER_PROCESS_ACTION_TIMER_GROUP) {
326 if ((result = ecm_state_write(sfi, "timer_group", "%d", pr->timer_group))) {
327 return result;
328 }
329 }
330
331 return ecm_state_prefix_remove(sfi);
Ben Menchaca84f36632014-02-28 20:57:38 +0000332}
Gareth Williamsf98d4192015-03-11 16:55:41 +0000333#endif
334
Murat Sezginc725ad82016-04-13 17:12:50 -0700335extern struct ecm_classifier_instance *ecm_classifier_assign_classifier(struct ecm_db_connection_instance *ci, ecm_classifier_type_t type);
336extern bool ecm_classifier_reclassify(struct ecm_db_connection_instance *ci, int assignment_count, struct ecm_classifier_instance *assignments[]);
Ben Menchaca84f36632014-02-28 20:57:38 +0000337