blob: 0168f69b216858a64e2c74d020ea38d850c74eb0 [file] [log] [blame]
Girish Gowdraddf9a162020-01-27 12:56:27 +05301/*
2 * Copyright 2018-present Open Networking Foundation
3
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7
8 * http://www.apache.org/licenses/LICENSE-2.0
9
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16#ifndef OPENOLT_CORE_DATA_H_
17#define OPENOLT_CORE_DATA_H_
18
19#include <bitset>
20
21#include "core.h"
22#include "Queue.h"
Girish Gowdra252f4972020-09-07 21:24:01 -070023#include "device.h"
Girish Gowdraddf9a162020-01-27 12:56:27 +053024
Girish Gowdra1935e6a2020-10-31 21:48:22 -070025// pcapplusplus packet decoder include files
26#include "Packet.h"
27#include "EthLayer.h"
28#include "IPv4Layer.h"
29#include "UdpLayer.h"
30#include "VlanLayer.h"
31
32#include <time.h>
33#include <arpa/inet.h>
34
Girish Gowdraddf9a162020-01-27 12:56:27 +053035extern "C"
36{
37#include <bcmolt_api.h>
38#include <bcmolt_api_model_supporting_enums.h>
39
40#include <bcmolt_api_conn_mgr.h>
41//CLI header files
42#include <bcmcli_session.h>
43#include <bcmcli.h>
44#include <bcm_api_cli.h>
45
46#include <bcmos_common.h>
47#include <bcm_config.h>
48// FIXME : dependency problem
49// #include <bcm_common_gpon.h>
50// #include <bcm_dev_log_task.h>
51}
52
Girish Gowdra5057a3d2020-05-29 18:49:56 -070053#define ALLOC_CFG_COMPLETE_WAIT_TIMEOUT 5000 // in milli-seconds
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +053054#define GEM_CFG_COMPLETE_WAIT_TIMEOUT 5000 // in milli-seconds
55
56// max retry count to find gem config key in gem_cfg_compltd_map
57#define MAX_GEM_CFG_KEY_CHECK 5
Girish Gowdraddf9a162020-01-27 12:56:27 +053058
Girish Gowdra5057a3d2020-05-29 18:49:56 -070059#define ONU_DEACTIVATE_COMPLETE_WAIT_TIMEOUT 5000 // in milli-seconds
Girish Gowdra7a79dae2020-02-10 18:22:11 +053060
Girish Gowdraddf9a162020-01-27 12:56:27 +053061
62#define MAX_ACL_ID 33
Girish Gowdra1935e6a2020-10-31 21:48:22 -070063#define MAX_ACL_WITH_VLAN_CLASSIFIER 10
64
65#define ANY_VLAN 4095
Girish Gowdraddf9a162020-01-27 12:56:27 +053066
67// **************************************//
68// Enums and structures used by the core //
69// **************************************//
70enum FLOW_CFG {
71 ONU_ID = 0,
72 FLOW_TYPE = 1,
73 SVC_PORT_ID = 2,
74 PRIORITY = 3,
75 COOKIE = 4,
76 INGRESS_INTF_TYPE= 5,
77 EGRESS_INTF_TYPE= 6,
78 INGRESS_INTF_ID = 7,
79 EGRESS_INTF_ID = 8,
80 CLASSIFIER_O_VID = 9,
81 CLASSIFIER_O_PBITS = 10,
82 CLASSIFIER_I_VID = 11,
83 CLASSIFIER_I_PBITS = 12,
84 CLASSIFIER_ETHER_TYPE = 13,
85 CLASSIFIER_IP_PROTO =14,
86 CLASSIFIER_SRC_PORT = 15,
87 CLASSIFIER_DST_PORT = 16,
88 CLASSIFIER_PKT_TAG_TYPE = 17,
89 EGRESS_QOS_TYPE = 18,
90 EGRESS_QOS_QUEUE_ID = 19,
91 EGRESS_QOS_TM_SCHED_ID = 20,
92 ACTION_CMDS_BITMASK = 21,
93 ACTION_O_VID = 22,
94 ACTION_O_PBITS = 23,
95 ACTION_I_VID = 24,
96 ACTION_I_PBITS = 25,
97 STATE = 26,
98 GROUP_ID = 27
99};
100
101enum AllocCfgAction {
102 ALLOC_OBJECT_CREATE,
103 ALLOC_OBJECT_DELETE
104};
105
106enum AllocObjectState {
107 ALLOC_OBJECT_STATE_NOT_CONFIGURED,
108 ALLOC_OBJECT_STATE_INACTIVE,
109 ALLOC_OBJECT_STATE_PROCESSING,
110 ALLOC_OBJECT_STATE_ACTIVE
111};
112
113enum AllocCfgStatus {
114 ALLOC_CFG_STATUS_SUCCESS,
115 ALLOC_CFG_STATUS_FAIL
116};
117
118typedef struct {
119 uint32_t pon_intf_id;
120 uint32_t alloc_id;
121 AllocObjectState state;
122 AllocCfgStatus status;
123} alloc_cfg_complete_result;
124
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530125enum GemCfgAction {
126 GEM_OBJECT_CREATE,
127 GEM_OBJECT_DELETE,
128 GEM_OBJECT_ENCRYPT
129};
130
131enum GemObjectState {
132 GEM_OBJECT_STATE_NOT_CONFIGURED,
133 GEM_OBJECT_STATE_INACTIVE,
134 GEM_OBJECT_STATE_PROCESSING,
135 GEM_OBJECT_STATE_ACTIVE
136};
137
138enum GemCfgStatus {
139 GEM_CFG_STATUS_SUCCESS,
140 GEM_CFG_STATUS_FAIL
141};
142
143typedef struct {
144 uint32_t pon_intf_id;
145 uint32_t gem_port_id;
146 GemObjectState state;
147 GemCfgStatus status;
148} gem_cfg_complete_result;
149
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530150typedef struct {
151 uint32_t pon_intf_id;
152 uint32_t onu_id;
153 bcmolt_result result;
154 bcmolt_deactivation_fail_reason reason;
155} onu_deactivate_complete_result;
156
Girish Gowdraddf9a162020-01-27 12:56:27 +0530157// key for map used for tracking ITU PON Alloc Configuration results from BAL
158typedef std::tuple<uint32_t, uint32_t> alloc_cfg_compltd_key;
159
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530160// key for map used for tracking ITU PON Gem Configuration results from BAL
161typedef std::tuple<uint32_t, uint32_t> gem_cfg_compltd_key;
162
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530163// key for map used for tracking Onu Deactivation Completed Indication
164typedef std::tuple<uint32_t, uint32_t> onu_deact_compltd_key;
165
Girish Gowdraddf9a162020-01-27 12:56:27 +0530166// The elements in this acl_classifier_key structure constitute key to
167// acl_classifier_to_acl_id_map.
168// Fill invalid values in the acl_classifier_key structure to -1.
169typedef struct acl_classifier_key {
170 int32_t ether_type;
171 int16_t ip_proto;
172 int32_t src_port;
173 int32_t dst_port;
Girish Gowdra1935e6a2020-10-31 21:48:22 -0700174 int16_t o_vid;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530175 // Add more classifiers elements as needed here
176 // For now, ACLs will be classified only based on
177 // above elements.
178} acl_classifier_key;
179
Girish Gowdra252f4972020-09-07 21:24:01 -0700180typedef struct device_flow_params {
181 uint8_t pbit; // If pbit classifier is not present in flow, use 0xff to invalidate
182 uint32_t gemport_id;
183 uint16_t flow_id;
184} device_flow_params;
185
186typedef struct device_flow {
187 bool is_flow_replicated; // If true number of replicated flows is to the NUMBER_OF_PBITS, else 1
Girish Gowdrafc6c0bf2022-01-28 18:31:30 -0800188 std::string flow_type; // upstream, downstream, multicast
Girish Gowdra252f4972020-09-07 21:24:01 -0700189 device_flow_params params[NUMBER_OF_REPLICATED_FLOWS]; // A voltha-flow cannot be replicated more than the number of pbits
190 uint64_t voltha_flow_id; // This is corresponding voltha flow-id.
191 uint64_t symmetric_voltha_flow_id; // Is not applicable for trap-to-controller voltha flows.
192 // 0 value means invalid or not-applicable
193 // Applicable for bi-directional data path flows (one flow per direction)
194 // Symmetric flows should share the same device_flow_id.
195
196} device_flow;
197
Orhan Kupusogluec57af02021-05-12 12:38:17 +0000198// key for map used for tracking Onu RSSI Measurement Completed Indication
199typedef std::tuple<uint32_t, uint32_t> onu_rssi_compltd_key;
200
201typedef struct {
202 uint32_t pon_intf_id;
203 uint32_t onu_id;
204 std::string status;
205 bcmolt_rssi_measurement_fail_reason reason;
206 double rx_power_mean_dbm;
207} onu_rssi_complete_result;
208
Girish Gowdraeec0fc92021-05-12 15:37:55 -0700209// Key for map used for tracking symmetric datapath flows ==> <pon, onu, uni, tp_id, flow_type>
210typedef std::tuple<int32_t, int32_t, int32_t, uint32_t, std::string> symmetric_datapath_flow_id_map_key;
211
212// Key and value for the pon_gem_to_onu_uni_map
213typedef std::tuple<uint32_t, uint32_t> pon_gem;
214typedef std::tuple<uint32_t, uint32_t> onu_uni;
215
Girish Gowdraddf9a162020-01-27 12:56:27 +0530216// *******************************************************//
217// Extern Variable/Constant declarations used by the core //
218// *******************************************************//
219extern State state;
220
221extern dev_log_id openolt_log_id;
222extern dev_log_id omci_log_id;
223
224extern unsigned int num_of_nni_ports;
225extern unsigned int num_of_pon_ports;
226
227extern const uint32_t tm_upstream_sched_id_start;
228extern const uint32_t tm_downstream_sched_id_start;
229
230extern const uint32_t queue_id_list[8];
231
232extern const std::string upstream;
233extern const std::string downstream;
234extern const std::string multicast;
235extern bcmolt_oltid dev_id;
236
237extern const uint32_t BAL_API_RETRY_TIME_IN_USECS;
238extern const uint32_t MAX_BAL_API_RETRY_COUNT;
239
240extern const unsigned int OPENOLT_FIELD_LEN;
241
242/* Current session */
243extern bcmcli_session *current_session;
244extern bcmcli_entry *api_parent_dir;
245extern bcmos_bool status_bcm_cli_quit;
246extern bcmos_task bal_cli_thread;
247extern const char *bal_cli_thread_name;
248extern uint16_t flow_id_counters;
249
250extern std::map<uint32_t, uint32_t> flowid_to_port; // For mapping upstream flows to logical ports
251extern std::map<uint32_t, uint32_t> flowid_to_gemport; // For mapping downstream flows into gemports
252extern std::map<uint32_t, std::set<uint32_t> > port_to_flows; // For mapping logical ports to downstream flows
253
254/* This represents the Key to 'sched_map' map.
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000255 Represents (pon_intf_id, onu_id, uni_id, direction, tech_profile_id) */
256typedef std::tuple<uint32_t, uint32_t, uint32_t, std::string, uint32_t> sched_map_key_tuple;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530257/* 'sched_map' maps sched_map_key_tuple to DBA (Upstream) or
258 Subscriber (Downstream) Scheduler ID */
259extern std::map<sched_map_key_tuple, int> sched_map;
260
261/* Flow control is for flow_id and flow_type */
262typedef std::pair<uint16_t, uint16_t> flow_pair;
263extern std::map<flow_pair, int32_t> flow_map;
264
265/* This represents the Key to 'qos_type_map' map.
266 Represents (pon_intf_id, onu_id, uni_id) */
267typedef std::tuple<uint32_t, uint32_t, uint32_t> qos_type_map_key_tuple;
268/* 'qos_type_map' maps qos_type_map_key_tuple to qos_type*/
269extern std::map<qos_type_map_key_tuple, bcmolt_egress_qos_type> qos_type_map;
270
271/* This represents the Key to 'sched_qmp_id_map' map.
272Represents (sched_id, pon_intf_id, onu_id, uni_id) */
273typedef std::tuple<uint32_t, uint32_t, uint32_t, uint32_t> sched_qmp_id_map_key_tuple;
274/* 'sched_qmp_id_map' maps sched_qmp_id_map_key_tuple to TM Queue Mapping Profile ID */
275extern std::map<sched_qmp_id_map_key_tuple, int> sched_qmp_id_map;
276/* 'qmp_id_to_qmp_map' maps TM Queue Mapping Profile ID to TM Queue Mapping Profile */
277extern std::map<int, std::vector < uint32_t > > qmp_id_to_qmp_map;
278
Girish Gowdraddf9a162020-01-27 12:56:27 +0530279// Map used to track response from BAL for ITU PON Alloc Configuration.
280// The key is alloc_cfg_compltd_key and value is a concurrent thread-safe queue which is
281// used for pushing (from BAL) and popping (at application) the results.
282extern std::map<alloc_cfg_compltd_key, Queue<alloc_cfg_complete_result> *> alloc_cfg_compltd_map;
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530283
284// Map used to track response from BAL for ITU PON Gem Configuration.
285// The key is gem_cfg_compltd_key and value is a concurrent thread-safe queue which is
286// used for pushing (from BAL) and popping (at application) the results.
287extern std::map<gem_cfg_compltd_key, Queue<gem_cfg_complete_result> *> gem_cfg_compltd_map;
288
289/* This represents the Key to 'gemport_status_map' map.
290 Represents (pon_intf_id, onu_id, uni_id, gemport_id) */
291typedef std::tuple<uint32_t, uint32_t, uint32_t, uint32_t> gemport_status_map_key_tuple;
292/* 'gemport_status_map' maps gemport_status_map_key_tuple to boolean value */
293extern std::map<gemport_status_map_key_tuple, bool> gemport_status_map;
294
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530295// Map used to track response from BAL for Onu Deactivation Completed Indication
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530296// The key is onu_deact_compltd_key and value is a concurrent thread-safe queue which is
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530297// used for pushing (from BAL) and popping (at application) the results.
298extern std::map<onu_deact_compltd_key, Queue<onu_deactivate_complete_result> *> onu_deact_compltd_map;
299
Girish Gowdraddf9a162020-01-27 12:56:27 +0530300// Lock to protect critical section data structure used for handling AllocObject configuration response.
301extern bcmos_fastlock alloc_cfg_wait_lock;
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530302// Lock to protect critical section data structure used for handling GemObject configuration response.
303extern bcmos_fastlock gem_cfg_wait_lock;
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530304// Lock to protect critical section data structure used for handling Onu deactivation completed Indication
305extern bcmos_fastlock onu_deactivate_wait_lock;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530306
307
308/*** ACL Handling related data start ***/
309
310extern std::map<acl_classifier_key, uint16_t> acl_classifier_to_acl_id_map;
311extern bool operator<(const acl_classifier_key& a1, const acl_classifier_key& a2);
312
Girish Gowdra252f4972020-09-07 21:24:01 -0700313typedef std::tuple<uint64_t, std::string> flow_id_flow_direction;
314typedef std::tuple<int16_t, int32_t> acl_id_intf_id;
315extern std::map<flow_id_flow_direction, acl_id_intf_id> flow_to_acl_map;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530316
317// Keeps a reference count of how many flows are referencing a given ACL ID.
318// Key represents the ACL-ID and value is number of flows referencing the given ACL-ID.
319// When there is at least one flow referencing the ACL-ID, the ACL should be installed.
320// When there are no flows referencing the ACL-ID, the ACL should be removed.
321extern std::map<uint16_t, uint16_t> acl_ref_cnt;
322
Girish Gowdraddf9a162020-01-27 12:56:27 +0530323// Needed to keep track of how many flows for a given acl_id, intf_id and intf_type are
324// installed. When there is at least on flow for this key, we should have interface registered
325// for the given ACL-ID. When there are no flows, the intf should unregister itself from
326// the ACL-ID.
327typedef std::tuple<uint16_t, uint8_t, std::string> acl_id_intf_id_intf_type;
328extern std::map<acl_id_intf_id_intf_type, uint16_t> intf_acl_registration_ref_cnt;
329
Girish Gowdra1935e6a2020-10-31 21:48:22 -0700330// Data structures to work around ACL limits on BAL -- start --
331
332enum trap_to_host_packet_type {
333 dhcpv4 = 0,
334 lldp = 1,
335 eap = 2,
336 igmpv4 = 3,
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -0300337 pppoed = 4,
Girish Gowdra1935e6a2020-10-31 21:48:22 -0700338 unsupported_trap_to_host_pkt_type = 0xff
339};
340
341// Constants useful during trap-to-host packet header field classification
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -0300342#define EAP_ETH_TYPE 0x888e
343#define LLDP_ETH_TYPE 0x88cc
344#define IPV4_ETH_TYPE 0x0800
345#define VLAN_ETH_TYPE 0x8100
346#define PPPoED_ETH_TYPE 0x8863
Girish Gowdra1935e6a2020-10-31 21:48:22 -0700347
348#define IGMPv4_PROTOCOL 2
349#define UDP_PROTOCOL 17
350
351#define DHCP_SERVER_SRC_PORT 67
352#define DHCP_CLIENT_SRC_PORT 68
353
354// This flag is set as soon as ACL count reaches MAX_ACL_WITH_VLAN_CLASSIFIER is hit.
355// It is not reset when ACL count comes below MAX_ACL_WITH_VLAN_CLASSIFIER again
356extern bool max_acls_with_vlan_classifiers_hit;
357
358// Tuple of -> {bcmolt_flow_interface_type, intf-id, trap_to_host_packet_type, gemport-id, c-vid}
359typedef std::tuple<int32_t, uint32_t, int32_t, int32_t, uint16_t> trap_to_host_pkt_info_with_vlan;
360
361// Tuple of -> {bcmolt_flow_interface_type, intf-id, trap_to_host_packet_type, gemport-id}
362typedef std::tuple<int32_t, uint32_t, int32_t, int32_t> trap_to_host_pkt_info;
363
364// Map of flow_id -> trap_to_host_pkt_info_with_vlan
365extern std::map<uint64_t, trap_to_host_pkt_info_with_vlan> trap_to_host_pkt_info_with_vlan_for_flow_id;
366
367// Map of trap_to_host_pkt_info -> cvid_list
368extern std::map<trap_to_host_pkt_info, std::list<uint16_t> > trap_to_host_vlan_ids_for_trap_to_host_pkt_info;
369
370// Data structures to work around ACL limits on BAL -- end --
371
Girish Gowdraddf9a162020-01-27 12:56:27 +0530372extern std::bitset<MAX_ACL_ID> acl_id_bitset;
Girish Gowdra252f4972020-09-07 21:24:01 -0700373extern bcmos_fastlock acl_id_bitset_lock;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530374
375/*** ACL Handling related data end ***/
376
377extern std::bitset<MAX_TM_SCHED_ID> tm_sched_bitset;
Girish Gowdra252f4972020-09-07 21:24:01 -0700378extern bcmos_fastlock tm_sched_bitset_lock;
379
Girish Gowdraddf9a162020-01-27 12:56:27 +0530380extern std::bitset<MAX_TM_QMP_ID> tm_qmp_bitset;
Girish Gowdra252f4972020-09-07 21:24:01 -0700381extern bcmos_fastlock tm_qmp_bitset_lock;
382
383extern std::bitset<MAX_FLOW_ID> flow_id_bitset;
384extern bcmos_fastlock flow_id_bitset_lock;
385
386extern std::map<uint64_t, device_flow> voltha_flow_to_device_flow;
387extern bcmos_fastlock voltha_flow_to_device_flow_lock;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530388
Girish Gowdraeec0fc92021-05-12 15:37:55 -0700389extern std::map<symmetric_datapath_flow_id_map_key, uint64_t> symmetric_datapath_flow_id_map;
390extern bcmos_fastlock symmetric_datapath_flow_id_lock;
391
392extern std::map<pon_gem, onu_uni> pon_gem_to_onu_uni_map;
393extern bcmos_fastlock pon_gem_to_onu_uni_map_lock;
394
Girish Gowdra1935e6a2020-10-31 21:48:22 -0700395// Lock to protect critical section around handling data associated with ACL trap packet handling
396extern bcmos_fastlock acl_packet_trap_handler_lock;
397
Girish Gowdraddf9a162020-01-27 12:56:27 +0530398extern Queue<openolt::Indication> oltIndQ;
399
Girish Gowdra252f4972020-09-07 21:24:01 -0700400/*** ACL Handling related data end ***/
401
Girish Gowdraddf9a162020-01-27 12:56:27 +0530402extern bcmos_fastlock data_lock;
403
Humera Kouser6143c9e2020-06-17 22:37:31 +0530404// Interface name on which grpc server is running on
405// and this can be used to get the mac adress based on interface name.
406extern char* grpc_server_interface_name;
Orhan Kupusogluec57af02021-05-12 12:38:17 +0000407
408extern std::map<onu_rssi_compltd_key, Queue<onu_rssi_complete_result>*> onu_rssi_compltd_map;
409extern bcmos_fastlock onu_rssi_wait_lock;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530410#endif // OPENOLT_CORE_DATA_H_