blob: c2f3016b8512d78e3da1668d4ca026abf22b9682 [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
Orhan Kupusoglu1fd77072021-03-23 08:13:25 -070017#include <fstream>
18#include <sstream>
Girish Gowdraddf9a162020-01-27 12:56:27 +053019#include "core_utils.h"
20
Orhan Kupusoglu1fd77072021-03-23 08:13:25 -070021// save the TLS option
22static std::string tls_option_arg{};
23
Girish Gowdraddf9a162020-01-27 12:56:27 +053024std::string serial_number_to_str(bcmolt_serial_number* serial_number) {
25#define SERIAL_NUMBER_SIZE 12
26 char buff[SERIAL_NUMBER_SIZE+1];
27
28 sprintf(buff, "%c%c%c%c%1X%1X%1X%1X%1X%1X%1X%1X",
29 serial_number->vendor_id.arr[0],
30 serial_number->vendor_id.arr[1],
31 serial_number->vendor_id.arr[2],
32 serial_number->vendor_id.arr[3],
33 serial_number->vendor_specific.arr[0]>>4 & 0x0f,
34 serial_number->vendor_specific.arr[0] & 0x0f,
35 serial_number->vendor_specific.arr[1]>>4 & 0x0f,
36 serial_number->vendor_specific.arr[1] & 0x0f,
37 serial_number->vendor_specific.arr[2]>>4 & 0x0f,
38 serial_number->vendor_specific.arr[2] & 0x0f,
39 serial_number->vendor_specific.arr[3]>>4 & 0x0f,
40 serial_number->vendor_specific.arr[3] & 0x0f);
41
42 return buff;
43}
44
45std::string vendor_specific_to_str(char const * const vendor_specific) {
46 char buff[SERIAL_NUMBER_SIZE+1];
47
48 sprintf(buff, "%1X%1X%1X%1X%1X%1X%1X%1X",
49 vendor_specific[0]>>4 & 0x0f,
50 vendor_specific[0] & 0x0f,
51 vendor_specific[1]>>4 & 0x0f,
52 vendor_specific[1] & 0x0f,
53 vendor_specific[2]>>4 & 0x0f,
54 vendor_specific[2] & 0x0f,
55 vendor_specific[3]>>4 & 0x0f,
56 vendor_specific[3] & 0x0f);
57
58 return buff;
59}
60/**
61* Returns the default NNI (Upstream direction) or PON (Downstream direction) scheduler
62* Every NNI port and PON port have default scheduler.
63* The NNI0 default scheduler ID is 18432, and NNI1 is 18433 and so on.
64* Similarly, PON0 default scheduler ID is 16384. PON1 is 16385 and so on.
65*
66* @param intf_id NNI or PON interface ID
67* @param direction "upstream" or "downstream"
68*
69* @return default scheduler ID for the given interface.
70*/
71
72uint16_t get_dev_id(void) {
73 return dev_id;
74}
75
76int get_default_tm_sched_id(int intf_id, std::string direction) {
77 if (direction.compare(upstream) == 0) {
78 return tm_upstream_sched_id_start + intf_id;
79 } else if (direction.compare(downstream) == 0) {
80 return tm_downstream_sched_id_start + intf_id;
81 }
82 else {
83 OPENOLT_LOG(ERROR, openolt_log_id, "invalid direction - %s\n", direction.c_str());
84 return 0;
85 }
86}
87
88/**
89* Gets a unique tm_sched_id for a given intf_id, onu_id, uni_id, gemport_id, direction
90* The tm_sched_id is locally cached in a map, so that it can rendered when necessary.
Burak Gurdag2f2618c2020-04-23 13:20:30 +000091* VOLTHA replays whole configuration on OLT reboot, so caching locally is not a problem.
92* Note that tech_profile_id is used to differentiate service schedulers in downstream direction.
Girish Gowdraddf9a162020-01-27 12:56:27 +053093*
94* @param intf_id NNI or PON intf ID
95* @param onu_id ONU ID
96* @param uni_id UNI ID
97* @param gemport_id GEM Port ID
98* @param direction Upstream or downstream
Burak Gurdag2f2618c2020-04-23 13:20:30 +000099* @param tech_profile_id Technology Profile ID
Girish Gowdraddf9a162020-01-27 12:56:27 +0530100*
101* @return tm_sched_id
102*/
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000103uint32_t get_tm_sched_id(int pon_intf_id, int onu_id, int uni_id, std::string direction, int tech_profile_id) {
104 sched_map_key_tuple key(pon_intf_id, onu_id, uni_id, direction, tech_profile_id);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530105 int sched_id = -1;
106
Girish Gowdra252f4972020-09-07 21:24:01 -0700107 bcmos_fastlock_lock(&tm_sched_bitset_lock);
108
Girish Gowdraddf9a162020-01-27 12:56:27 +0530109 std::map<sched_map_key_tuple, int>::const_iterator it = sched_map.find(key);
110 if (it != sched_map.end()) {
111 sched_id = it->second;
112 }
113 if (sched_id != -1) {
Girish Gowdra252f4972020-09-07 21:24:01 -0700114 bcmos_fastlock_unlock(&tm_sched_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530115 return sched_id;
116 }
117
Girish Gowdraddf9a162020-01-27 12:56:27 +0530118 // Complexity of O(n). Is there better way that can avoid linear search?
119 for (sched_id = 0; sched_id < MAX_TM_SCHED_ID; sched_id++) {
120 if (tm_sched_bitset[sched_id] == 0) {
121 tm_sched_bitset[sched_id] = 1;
122 break;
123 }
124 }
Girish Gowdraddf9a162020-01-27 12:56:27 +0530125
126 if (sched_id < MAX_TM_SCHED_ID) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530127 sched_map[key] = sched_id;
Girish Gowdra252f4972020-09-07 21:24:01 -0700128 bcmos_fastlock_unlock(&tm_sched_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530129 return sched_id;
130 } else {
Girish Gowdra252f4972020-09-07 21:24:01 -0700131 bcmos_fastlock_unlock(&tm_sched_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530132 return -1;
133 }
134}
135
136/**
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000137* Free tm_sched_id for a given intf_id, onu_id, uni_id, gemport_id, direction, tech_profile_id
Girish Gowdraddf9a162020-01-27 12:56:27 +0530138*
139* @param intf_id NNI or PON intf ID
140* @param onu_id ONU ID
141* @param uni_id UNI ID
142* @param gemport_id GEM Port ID
143* @param direction Upstream or downstream
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000144* @param tech_profile_id Technology Profile ID
Girish Gowdraddf9a162020-01-27 12:56:27 +0530145*/
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000146void free_tm_sched_id(int pon_intf_id, int onu_id, int uni_id, std::string direction, int tech_profile_id) {
147 sched_map_key_tuple key(pon_intf_id, onu_id, uni_id, direction, tech_profile_id);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530148 std::map<sched_map_key_tuple, int>::const_iterator it;
Girish Gowdra252f4972020-09-07 21:24:01 -0700149 bcmos_fastlock_lock(&tm_sched_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530150 it = sched_map.find(key);
151 if (it != sched_map.end()) {
152 tm_sched_bitset[it->second] = 0;
153 sched_map.erase(it);
154 }
Girish Gowdra252f4972020-09-07 21:24:01 -0700155 bcmos_fastlock_unlock(&tm_sched_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530156}
157
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000158bool is_tm_sched_id_present(int pon_intf_id, int onu_id, int uni_id, std::string direction, int tech_profile_id) {
159 sched_map_key_tuple key(pon_intf_id, onu_id, uni_id, direction, tech_profile_id);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530160 std::map<sched_map_key_tuple, int>::const_iterator it = sched_map.find(key);
161 if (it != sched_map.end()) {
162 return true;
163 }
164 return false;
165}
166
167/**
168* Check whether given two tm qmp profiles are equal or not
169*
170* @param tmq_map_profileA <vector> TM QUEUE MAPPING PROFILE
171* @param tmq_map_profileB <vector> TM QUEUE MAPPING PROFILE
172*
173* @return boolean, true if given tmq_map_profiles are equal else false
174*/
175
176bool check_tm_qmp_equality(std::vector<uint32_t> tmq_map_profileA, std::vector<uint32_t> tmq_map_profileB) {
177 for (uint32_t i = 0; i < TMQ_MAP_PROFILE_SIZE; i++) {
178 if (tmq_map_profileA[i] != tmq_map_profileB[i]) {
179 return false;
180 }
181 }
182 return true;
183}
184
185/**
186* Modifies given queues_pbit_map to parsable format
187* e.g: Modifes "0b00000101" to "10100000"
188*
189* @param queues_pbit_map PBIT MAP configured for each GEM in TECH PROFILE
190* @param size Queue count
191*
192* @return string queues_pbit_map
193*/
194std::string* get_valid_queues_pbit_map(std::string *queues_pbit_map, uint32_t size) {
195 for(uint32_t i=0; i < size; i++) {
196 /* Deletes 2 characters from index number 0 */
197 queues_pbit_map[i].erase(0, 2);
198 std::reverse(queues_pbit_map[i].begin(), queues_pbit_map[i].end());
199 }
200 return queues_pbit_map;
201}
202
203/**
204* Creates TM QUEUE MAPPING PROFILE for given queues_pbit_map and queues_priority_q
205*
206* @param queues_pbit_map PBIT MAP configured for each GEM in TECH PROFILE
207* @param queues_priority_q PRIORITY_Q configured for each GEM in TECH PROFILE
208* @param size Queue count
209*
210* @return <vector> TM QUEUE MAPPING PROFILE
211*/
212std::vector<uint32_t> get_tmq_map_profile(std::string *queues_pbit_map, uint32_t *queues_priority_q, uint32_t size) {
213 std::vector<uint32_t> tmq_map_profile(8,0);
214
215 for(uint32_t i=0; i < size; i++) {
216 for (uint32_t j = 0; j < queues_pbit_map[i].size(); j++) {
217 if (queues_pbit_map[i][j]=='1') {
218 tmq_map_profile.at(j) = queue_id_list[queues_priority_q[i]];
219 }
220 }
221 }
222 return tmq_map_profile;
223}
224
225/**
226* Gets corresponding tm_qmp_id for a given tmq_map_profile
227*
228* @param <vector> TM QUEUE MAPPING PROFILE
229*
230* @return tm_qmp_id
231*/
232int get_tm_qmp_id(std::vector<uint32_t> tmq_map_profile) {
233 int tm_qmp_id = -1;
234
235 std::map<int, std::vector < uint32_t > >::const_iterator it = qmp_id_to_qmp_map.begin();
236 while(it != qmp_id_to_qmp_map.end()) {
237 if(check_tm_qmp_equality(tmq_map_profile, it->second)) {
238 tm_qmp_id = it->first;
239 break;
240 }
241 it++;
242 }
243 return tm_qmp_id;
244}
245
246/**
247* Updates sched_qmp_id_map with given sched_id, pon_intf_id, onu_id, uni_id, tm_qmp_id
248*
249* @param upstream/downstream sched_id
250* @param PON intf ID
251* @param onu_id ONU ID
252* @param uni_id UNI ID
253* @param tm_qmp_id TM QUEUE MAPPING PROFILE ID
254*/
255void update_sched_qmp_id_map(uint32_t sched_id,uint32_t pon_intf_id, uint32_t onu_id, \
256 uint32_t uni_id, int tm_qmp_id) {
Girish Gowdra252f4972020-09-07 21:24:01 -0700257 bcmos_fastlock_lock(&tm_qmp_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530258 sched_qmp_id_map_key_tuple key(sched_id, pon_intf_id, onu_id, uni_id);
259 sched_qmp_id_map.insert(make_pair(key, tm_qmp_id));
Girish Gowdra252f4972020-09-07 21:24:01 -0700260 bcmos_fastlock_unlock(&tm_qmp_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530261}
262
263/**
264* Gets corresponding tm_qmp_id for a given sched_id, pon_intf_id, onu_id, uni_id
265*
266* @param upstream/downstream sched_id
267* @param PON intf ID
268* @param onu_id ONU ID
269* @param uni_id UNI ID
270*
271* @return tm_qmp_id
272*/
273int get_tm_qmp_id(uint32_t sched_id,uint32_t pon_intf_id, uint32_t onu_id, uint32_t uni_id) {
274 sched_qmp_id_map_key_tuple key(sched_id, pon_intf_id, onu_id, uni_id);
275 int tm_qmp_id = -1;
276
277 std::map<sched_qmp_id_map_key_tuple, int>::const_iterator it = sched_qmp_id_map.find(key);
278 if (it != sched_qmp_id_map.end()) {
279 tm_qmp_id = it->second;
280 }
281 return tm_qmp_id;
282}
283
284/**
285* Gets a unique tm_qmp_id for a given tmq_map_profile
286* The tm_qmp_id is locally cached in a map, so that it can be rendered when necessary.
287* VOLTHA replays whole configuration on OLT reboot, so caching locally is not a problem
288*
289* @param upstream/downstream sched_id
290* @param PON intf ID
291* @param onu_id ONU ID
292* @param uni_id UNI ID
293* @param <vector> TM QUEUE MAPPING PROFILE
294*
295* @return tm_qmp_id
296*/
297int get_tm_qmp_id(uint32_t sched_id,uint32_t pon_intf_id, uint32_t onu_id, uint32_t uni_id, \
298 std::vector<uint32_t> tmq_map_profile) {
299 int tm_qmp_id;
300
Girish Gowdra252f4972020-09-07 21:24:01 -0700301 bcmos_fastlock_lock(&tm_qmp_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530302 /* Complexity of O(n). Is there better way that can avoid linear search? */
303 for (tm_qmp_id = 0; tm_qmp_id < MAX_TM_QMP_ID; tm_qmp_id++) {
304 if (tm_qmp_bitset[tm_qmp_id] == 0) {
305 tm_qmp_bitset[tm_qmp_id] = 1;
306 break;
307 }
308 }
Girish Gowdraddf9a162020-01-27 12:56:27 +0530309
310 if (tm_qmp_id < MAX_TM_QMP_ID) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530311 qmp_id_to_qmp_map.insert(make_pair(tm_qmp_id, tmq_map_profile));
Girish Gowdra252f4972020-09-07 21:24:01 -0700312 bcmos_fastlock_unlock(&tm_qmp_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530313 update_sched_qmp_id_map(sched_id, pon_intf_id, onu_id, uni_id, tm_qmp_id);
314 return tm_qmp_id;
315 } else {
Girish Gowdra252f4972020-09-07 21:24:01 -0700316 bcmos_fastlock_unlock(&tm_qmp_bitset_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530317 return -1;
318 }
319}
320
321/**
322* Free tm_qmp_id for a given sched_id, pon_intf_id, onu_id, uni_id
323*
324* @param upstream/downstream sched_id
325* @param PON intf ID
326* @param onu_id ONU ID
327* @param uni_id UNI ID
328* @param tm_qmp_id TM QUEUE MAPPING PROFILE ID
329*
330* @return boolean, true if no more reference for TM QMP else false
331*/
332bool free_tm_qmp_id(uint32_t sched_id,uint32_t pon_intf_id, uint32_t onu_id, \
333 uint32_t uni_id, int tm_qmp_id) {
334 bool result;
335 sched_qmp_id_map_key_tuple key(sched_id, pon_intf_id, onu_id, uni_id);
336 std::map<sched_qmp_id_map_key_tuple, int>::const_iterator it = sched_qmp_id_map.find(key);
Girish Gowdra252f4972020-09-07 21:24:01 -0700337 bcmos_fastlock_lock(&tm_qmp_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530338 if (it != sched_qmp_id_map.end()) {
339 sched_qmp_id_map.erase(it);
340 }
Girish Gowdraddf9a162020-01-27 12:56:27 +0530341
342 uint32_t tm_qmp_ref_count = 0;
343 std::map<sched_qmp_id_map_key_tuple, int>::const_iterator it2 = sched_qmp_id_map.begin();
344 while(it2 != sched_qmp_id_map.end()) {
345 if(it2->second == tm_qmp_id) {
346 tm_qmp_ref_count++;
347 }
348 it2++;
349 }
350
351 if (tm_qmp_ref_count == 0) {
352 std::map<int, std::vector < uint32_t > >::const_iterator it3 = qmp_id_to_qmp_map.find(tm_qmp_id);
353 if (it3 != qmp_id_to_qmp_map.end()) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530354 tm_qmp_bitset[tm_qmp_id] = 0;
355 qmp_id_to_qmp_map.erase(it3);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530356 OPENOLT_LOG(INFO, openolt_log_id, "Reference count for tm qmp profile id %d is : %d. So clearing it\n", \
357 tm_qmp_id, tm_qmp_ref_count);
358 result = true;
359 }
360 } else {
361 OPENOLT_LOG(INFO, openolt_log_id, "Reference count for tm qmp profile id %d is : %d. So not clearing it\n", \
362 tm_qmp_id, tm_qmp_ref_count);
363 result = false;
364 }
Girish Gowdra252f4972020-09-07 21:24:01 -0700365 bcmos_fastlock_unlock(&tm_qmp_bitset_lock, 0);
366
Girish Gowdraddf9a162020-01-27 12:56:27 +0530367 return result;
368}
369
Thiyagarajan Subramani1744c922020-02-16 18:55:02 +0530370/* ACL ID is a shared resource, caller of this function has to ensure atomicity using locks
371 Gets free ACL ID if available, else -1. */
Girish Gowdraddf9a162020-01-27 12:56:27 +0530372int get_acl_id() {
373 int acl_id;
Thiyagarajan Subramani1744c922020-02-16 18:55:02 +0530374
Girish Gowdra252f4972020-09-07 21:24:01 -0700375 bcmos_fastlock_lock(&acl_id_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530376 /* Complexity of O(n). Is there better way that can avoid linear search? */
377 for (acl_id = 0; acl_id < MAX_ACL_ID; acl_id++) {
378 if (acl_id_bitset[acl_id] == 0) {
379 acl_id_bitset[acl_id] = 1;
380 break;
381 }
382 }
Girish Gowdra252f4972020-09-07 21:24:01 -0700383 bcmos_fastlock_unlock(&acl_id_bitset_lock, 0);
384
Girish Gowdraddf9a162020-01-27 12:56:27 +0530385 if (acl_id < MAX_ACL_ID) {
386 return acl_id ;
387 } else {
388 return -1;
389 }
390}
391
Thiyagarajan Subramani1744c922020-02-16 18:55:02 +0530392/* ACL ID is a shared resource, caller of this function has to ensure atomicity using locks
393 Frees up the ACL ID. */
Girish Gowdraddf9a162020-01-27 12:56:27 +0530394void free_acl_id (int acl_id) {
Girish Gowdra252f4972020-09-07 21:24:01 -0700395 bcmos_fastlock_lock(&acl_id_bitset_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530396 if (acl_id < MAX_ACL_ID) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530397 acl_id_bitset[acl_id] = 0;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530398 }
Girish Gowdra252f4972020-09-07 21:24:01 -0700399 bcmos_fastlock_unlock(&acl_id_bitset_lock, 0);
400}
401
402/* Gets a free Flow ID if available, else INVALID_FLOW_ID */
403uint16_t get_flow_id() {
404 uint16_t flow_id;
405
406 bcmos_fastlock_lock(&flow_id_bitset_lock);
407 /* Complexity of O(n). Is there better way that can avoid linear search? */
408 // start flow_id from 1 as 0 is invalid
409 for (flow_id = FLOW_ID_START; flow_id <= FLOW_ID_END; flow_id++) {
410 if (flow_id_bitset[flow_id] == 0) {
411 flow_id_bitset[flow_id] = 1;
412 break;
413 }
414 }
415 bcmos_fastlock_unlock(&flow_id_bitset_lock, 0);
416
417 if (flow_id <= MAX_FLOW_ID) {
418 return flow_id ;
419 } else {
420 return INVALID_FLOW_ID;
421 }
422}
423
424/* Gets requested number of Flow IDs.
425 'num_of_flow_ids' is number of flow_ids requested. This cannot be more than NUMBER_OF_PBITS
426 'flow_ids' is pointer to array of size NUMBER_OF_PBITS
427 If the operation is successful, returns true else false
428 The operation is successful if we can allocate fully the number of flow_ids requested.
429 */
430bool get_flow_ids(int num_of_flow_ids, uint16_t *flow_ids) {
431 if (num_of_flow_ids > NUMBER_OF_PBITS) {
432 OPENOLT_LOG(ERROR, openolt_log_id, "requested number of flow_ids is more than 8\n");
433 return false;
434 }
435 int cnt = 0;
436
437 bcmos_fastlock_lock(&flow_id_bitset_lock);
438 /* Complexity of O(n). Is there better way that can avoid linear search? */
439 // start flow_id from 1 as 0 is invalid
440 for (uint16_t flow_id = FLOW_ID_START; flow_id <= FLOW_ID_END && cnt < num_of_flow_ids; flow_id++) {
441 if (flow_id_bitset[flow_id] == 0) {
442 flow_id_bitset[flow_id] = 1;
443 flow_ids[cnt] = flow_id;
444 cnt++;
445 }
446 }
447 bcmos_fastlock_unlock(&flow_id_bitset_lock, 0);
448 // If we could not allocate the requested number of flow_ids free the allocated flow_ids
449 // and return false
450 if (cnt != num_of_flow_ids) {
451 OPENOLT_LOG(ERROR, openolt_log_id, "could not allocated the rquested number of flows ids. requested=%d, allocated=%d", num_of_flow_ids, cnt);
452 if (cnt > 0) {
453 for(int i=0; i < cnt; i++) {
454 free_flow_id(flow_ids[i]);
455 }
456 }
457 return false;
458 }
459 return true;
460}
461
462/* Frees up the FLOW ID. */
463void free_flow_id (uint16_t flow_id) {
464 bcmos_fastlock_lock(&flow_id_bitset_lock);
465 if (flow_id <= MAX_FLOW_ID) {
466 flow_id_bitset[flow_id] = 0;
467 }
468 bcmos_fastlock_unlock(&flow_id_bitset_lock, 0);
469}
470
471void free_flow_ids(uint8_t num_flows, uint16_t *flow_ids) {
472 for (uint8_t i = 0; i < num_flows; i++) {
473 bcmos_fastlock_lock(&flow_id_bitset_lock);
474 if (flow_ids[i] <= MAX_FLOW_ID) {
475 flow_id_bitset[flow_ids[i]] = 0;
476 }
477 bcmos_fastlock_unlock(&flow_id_bitset_lock, 0);
478 }
Girish Gowdraddf9a162020-01-27 12:56:27 +0530479}
480
481/**
482* Returns qos type as string
483*
484* @param qos_type bcmolt_egress_qos_type enum
485*/
486std::string get_qos_type_as_string(bcmolt_egress_qos_type qos_type) {
487 switch (qos_type)
488 {
489 case BCMOLT_EGRESS_QOS_TYPE_FIXED_QUEUE: return "FIXED_QUEUE";
490 case BCMOLT_EGRESS_QOS_TYPE_TC_TO_QUEUE: return "TC_TO_QUEUE";
491 case BCMOLT_EGRESS_QOS_TYPE_PBIT_TO_TC: return "PBIT_TO_TC";
492 case BCMOLT_EGRESS_QOS_TYPE_NONE: return "NONE";
493 case BCMOLT_EGRESS_QOS_TYPE_PRIORITY_TO_QUEUE: return "PRIORITY_TO_QUEUE";
494 default: OPENOLT_LOG(ERROR, openolt_log_id, "qos-type-not-supported %d\n", qos_type);
495 return "qos-type-not-supported";
496 }
497}
498
499/**
500* Gets/Updates qos type for given pon_intf_id, onu_id, uni_id
501*
502* @param PON intf ID
503* @param onu_id ONU ID
504* @param uni_id UNI ID
505* @param queue_size TrafficQueues Size
506*
507* @return qos_type
508*/
509bcmolt_egress_qos_type get_qos_type(uint32_t pon_intf_id, uint32_t onu_id, uint32_t uni_id, uint32_t queue_size) {
510 qos_type_map_key_tuple key(pon_intf_id, onu_id, uni_id);
511 bcmolt_egress_qos_type egress_qos_type = BCMOLT_EGRESS_QOS_TYPE_FIXED_QUEUE;
512 std::string qos_string;
513
514 std::map<qos_type_map_key_tuple, bcmolt_egress_qos_type>::const_iterator it = qos_type_map.find(key);
515 if (it != qos_type_map.end()) {
516 egress_qos_type = it->second;
517 qos_string = get_qos_type_as_string(egress_qos_type);
518 OPENOLT_LOG(INFO, openolt_log_id, "Qos-type for subscriber connected to pon_intf_id %d, onu_id %d and uni_id %d is %s\n", \
519 pon_intf_id, onu_id, uni_id, qos_string.c_str());
520 }
521 else {
522 /* QOS Type has been pre-defined as Fixed Queue but it will be updated based on number of GEMPORTS
523 associated for a given subscriber. If GEM count = 1 for a given subscriber, qos_type will be Fixed Queue
524 else Priority to Queue */
525 egress_qos_type = (queue_size > 1) ? \
526 BCMOLT_EGRESS_QOS_TYPE_PRIORITY_TO_QUEUE : BCMOLT_EGRESS_QOS_TYPE_FIXED_QUEUE;
527 bcmos_fastlock_lock(&data_lock);
528 qos_type_map.insert(make_pair(key, egress_qos_type));
529 bcmos_fastlock_unlock(&data_lock, 0);
530 qos_string = get_qos_type_as_string(egress_qos_type);
531 OPENOLT_LOG(INFO, openolt_log_id, "Qos-type for subscriber connected to pon_intf_id %d, onu_id %d and uni_id %d is %s\n", \
532 pon_intf_id, onu_id, uni_id, qos_string.c_str());
533 }
534 return egress_qos_type;
535}
536
537/**
538* Clears qos type for given pon_intf_id, onu_id, uni_id
539*
540* @param PON intf ID
541* @param onu_id ONU ID
542* @param uni_id UNI ID
543*/
544void clear_qos_type(uint32_t pon_intf_id, uint32_t onu_id, uint32_t uni_id) {
545 qos_type_map_key_tuple key(pon_intf_id, onu_id, uni_id);
546 std::map<qos_type_map_key_tuple, bcmolt_egress_qos_type>::const_iterator it = qos_type_map.find(key);
547 bcmos_fastlock_lock(&data_lock);
548 if (it != qos_type_map.end()) {
549 qos_type_map.erase(it);
550 OPENOLT_LOG(INFO, openolt_log_id, "Cleared Qos-type for subscriber connected to pon_intf_id %d, onu_id %d and uni_id %d\n", \
551 pon_intf_id, onu_id, uni_id);
552 }
553 bcmos_fastlock_unlock(&data_lock, 0);
554}
555
556/**
557* Returns Scheduler/Queue direction as string
558*
559* @param direction as specified in tech_profile.proto
560*/
561std::string GetDirection(int direction) {
562 switch (direction)
563 {
564 case tech_profile::Direction::UPSTREAM: return upstream;
565 case tech_profile::Direction::DOWNSTREAM: return downstream;
566 default: OPENOLT_LOG(ERROR, openolt_log_id, "direction-not-supported %d\n", direction);
567 return "direction-not-supported";
568 }
569}
570
571// This method handles waiting for AllocObject configuration.
572// Returns error if the AllocObject is not in the appropriate state based on action requested.
573bcmos_errno wait_for_alloc_action(uint32_t intf_id, uint32_t alloc_id, AllocCfgAction action) {
574 Queue<alloc_cfg_complete_result> cfg_result;
575 alloc_cfg_compltd_key k(intf_id, alloc_id);
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530576 bcmos_fastlock_lock(&alloc_cfg_wait_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530577 alloc_cfg_compltd_map[k] = &cfg_result;
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530578 bcmos_fastlock_unlock(&alloc_cfg_wait_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530579 bcmos_errno err = BCM_ERR_OK;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530580
581 // Try to pop the result from BAL with a timeout of ALLOC_CFG_COMPLETE_WAIT_TIMEOUT ms
582 std::pair<alloc_cfg_complete_result, bool> result = cfg_result.pop(ALLOC_CFG_COMPLETE_WAIT_TIMEOUT);
583 if (result.second == false) {
584 OPENOLT_LOG(ERROR, openolt_log_id, "timeout waiting for alloc cfg complete indication intf_id %d, alloc_id %d\n",
585 intf_id, alloc_id);
586 // Invalidate the queue pointer.
587 bcmos_fastlock_lock(&alloc_cfg_wait_lock);
588 alloc_cfg_compltd_map[k] = NULL;
589 bcmos_fastlock_unlock(&alloc_cfg_wait_lock, 0);
590 err = BCM_ERR_INTERNAL;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530591 }
592 else if (result.first.status == ALLOC_CFG_STATUS_FAIL) {
593 OPENOLT_LOG(ERROR, openolt_log_id, "error processing alloc cfg request intf_id %d, alloc_id %d\n",
594 intf_id, alloc_id);
595 err = BCM_ERR_INTERNAL;
596 }
597
598 if (err == BCM_ERR_OK) {
599 if (action == ALLOC_OBJECT_CREATE) {
600 if (result.first.state != ALLOC_OBJECT_STATE_ACTIVE) {
601 OPENOLT_LOG(ERROR, openolt_log_id, "alloc object not in active state intf_id %d, alloc_id %d alloc_obj_state %d\n",
602 intf_id, alloc_id, result.first.state);
603 err = BCM_ERR_INTERNAL;
604 } else {
605 OPENOLT_LOG(INFO, openolt_log_id, "Create upstream bandwidth allocation success, intf_id %d, alloc_id %d\n",
606 intf_id, alloc_id);
607 }
608 } else { // ALLOC_OBJECT_DELETE
609 if (result.first.state != ALLOC_OBJECT_STATE_NOT_CONFIGURED) {
610 OPENOLT_LOG(ERROR, openolt_log_id, "alloc object is not reset intf_id %d, alloc_id %d alloc_obj_state %d\n",
611 intf_id, alloc_id, result.first.state);
612 err = BCM_ERR_INTERNAL;
613 } else {
614 OPENOLT_LOG(INFO, openolt_log_id, "Remove alloc object success, intf_id %d, alloc_id %d\n",
615 intf_id, alloc_id);
616 }
617 }
618 }
619
620 // Remove entry from map
621 bcmos_fastlock_lock(&alloc_cfg_wait_lock);
622 alloc_cfg_compltd_map.erase(k);
623 bcmos_fastlock_unlock(&alloc_cfg_wait_lock, 0);
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530624 return err;
625}
626
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530627// This method handles waiting for GemObject configuration.
628// Returns error if the GemObject is not in the appropriate state based on action requested.
629bcmos_errno wait_for_gem_action(uint32_t intf_id, uint32_t gem_port_id, GemCfgAction action) {
630 Queue<gem_cfg_complete_result> cfg_result;
631 gem_cfg_compltd_key k(intf_id, gem_port_id);
632 bcmos_fastlock_lock(&gem_cfg_wait_lock);
633 gem_cfg_compltd_map[k] = &cfg_result;
634 bcmos_fastlock_unlock(&gem_cfg_wait_lock, 0);
635 bcmos_errno err = BCM_ERR_OK;
636
637 // Try to pop the result from BAL with a timeout of GEM_CFG_COMPLETE_WAIT_TIMEOUT ms
638 std::pair<gem_cfg_complete_result, bool> result = cfg_result.pop(GEM_CFG_COMPLETE_WAIT_TIMEOUT);
639 if (result.second == false) {
640 OPENOLT_LOG(ERROR, openolt_log_id, "timeout waiting for gem cfg complete indication intf_id %d, gem_port_id %d\n",
641 intf_id, gem_port_id);
642 // Invalidate the queue pointer.
643 bcmos_fastlock_lock(&gem_cfg_wait_lock);
644 gem_cfg_compltd_map[k] = NULL;
645 bcmos_fastlock_unlock(&gem_cfg_wait_lock, 0);
646 err = BCM_ERR_INTERNAL;
647 }
648 else if (result.first.status == GEM_CFG_STATUS_FAIL) {
649 OPENOLT_LOG(ERROR, openolt_log_id, "error processing gem cfg request intf_id %d, gem_port_id %d\n",
650 intf_id, gem_port_id);
651 err = BCM_ERR_INTERNAL;
652 }
653
654 if (err == BCM_ERR_OK) {
655 if (action == GEM_OBJECT_CREATE) {
656 if (result.first.state != GEM_OBJECT_STATE_ACTIVE) {
657 OPENOLT_LOG(ERROR, openolt_log_id, "gem object not in active state intf_id %d, gem_port_id %d gem_obj_state %d\n",
658 intf_id, gem_port_id, result.first.state);
659 err = BCM_ERR_INTERNAL;
660 } else {
661 OPENOLT_LOG(INFO, openolt_log_id, "Create itupon gem object success, intf_id %d, gem_port_id %d\n",
662 intf_id, gem_port_id);
663 }
664 } else if (action == GEM_OBJECT_ENCRYPT) {
665 if (result.first.state != GEM_OBJECT_STATE_ACTIVE) {
666 OPENOLT_LOG(ERROR, openolt_log_id, "gem object not in active state intf_id %d, gem_port_id %d gem_obj_state %d\n",
667 intf_id, gem_port_id, result.first.state);
668 err = BCM_ERR_INTERNAL;
669 } else {
670 OPENOLT_LOG(INFO, openolt_log_id, "Enable itupon gem object encryption success, intf_id %d, gem_port_id %d\n",
671 intf_id, gem_port_id);
672 }
673 } else { // GEM_OBJECT_DELETE
674 if (result.first.state != GEM_OBJECT_STATE_NOT_CONFIGURED) {
675 OPENOLT_LOG(ERROR, openolt_log_id, "gem object is not reset intf_id %d, gem_port_id %d gem_obj_state %d\n",
676 intf_id, gem_port_id, result.first.state);
677 err = BCM_ERR_INTERNAL;
678 } else {
679 OPENOLT_LOG(INFO, openolt_log_id, "Remove itupon gem object success, intf_id %d, gem_port_id %d\n",
680 intf_id, gem_port_id);
681 }
682 }
683 }
684
685 // Remove entry from map
686 bcmos_fastlock_lock(&gem_cfg_wait_lock);
687 gem_cfg_compltd_map.erase(k);
688 bcmos_fastlock_unlock(&gem_cfg_wait_lock, 0);
689 return err;
690}
691
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530692// This method handles waiting for OnuDeactivate Completed Indication
693bcmos_errno wait_for_onu_deactivate_complete(uint32_t intf_id, uint32_t onu_id) {
694 Queue<onu_deactivate_complete_result> deact_result;
695 onu_deact_compltd_key k(intf_id, onu_id);
696 onu_deact_compltd_map[k] = &deact_result;
697 bcmos_errno err = BCM_ERR_OK;
698
699 // Try to pop the result from BAL with a timeout of ONU_DEACTIVATE_COMPLETE_WAIT_TIMEOUT ms
700 std::pair<onu_deactivate_complete_result, bool> result = deact_result.pop(ONU_DEACTIVATE_COMPLETE_WAIT_TIMEOUT);
701 if (result.second == false) {
702 OPENOLT_LOG(ERROR, openolt_log_id, "timeout waiting for onu deactivate complete indication intf_id %d, onu_id %d\n",
703 intf_id, onu_id);
704 // Invalidate the queue pointer.
705 bcmos_fastlock_lock(&onu_deactivate_wait_lock);
706 onu_deact_compltd_map[k] = NULL;
707 bcmos_fastlock_unlock(&onu_deactivate_wait_lock, 0);
708 err = BCM_ERR_INTERNAL;
709 }
710 else if (result.first.result == BCMOLT_RESULT_FAIL) {
711 OPENOLT_LOG(ERROR, openolt_log_id, "error processing onu deactivate request intf_id %d, onu_id %d, fail_reason %d\n",
712 intf_id, onu_id, result.first.reason);
713 err = BCM_ERR_INTERNAL;
714 } else if (result.first.result == BCMOLT_RESULT_SUCCESS) {
715 OPENOLT_LOG(INFO, openolt_log_id, "success processing onu deactivate request intf_id %d, onu_id %d\n",
716 intf_id, onu_id);
717 }
718
719 // Remove entry from map
720 bcmos_fastlock_lock(&onu_deactivate_wait_lock);
721 onu_deact_compltd_map.erase(k);
722 bcmos_fastlock_unlock(&onu_deactivate_wait_lock, 0);
723
Girish Gowdraddf9a162020-01-27 12:56:27 +0530724 return err;
725}
726
727char* openolt_read_sysinfo(const char* field_name, char* field_val)
728{
729 FILE *fp;
730 /* Prepare the command*/
731 char command[150];
732
733 snprintf(command, sizeof command, "bash -l -c \"onlpdump -s\" | perl -ne 'print $1 if /%s: (\\S+)/'", field_name);
734 /* Open the command for reading. */
735 fp = popen(command, "r");
736 if (fp == NULL) {
737 /*The client has to check for a Null field value in this case*/
738 OPENOLT_LOG(INFO, openolt_log_id, "Failed to query the %s\n", field_name);
739 return field_val;
740 }
741
742 /*Read the field value*/
743 if (fp) {
744 uint8_t ret;
745 ret = fread(field_val, OPENOLT_FIELD_LEN, 1, fp);
746 if (ret >= OPENOLT_FIELD_LEN)
747 OPENOLT_LOG(INFO, openolt_log_id, "Read data length %u\n", ret);
748 pclose(fp);
749 }
750 return field_val;
751}
752
753Status pushOltOperInd(uint32_t intf_id, const char *type, const char *state)
754{
Girish Gowdra252f4972020-09-07 21:24:01 -0700755 ::openolt::Indication ind;
756 ::openolt::IntfOperIndication* intf_oper_ind = new ::openolt::IntfOperIndication;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530757
758 intf_oper_ind->set_type(type);
759 intf_oper_ind->set_intf_id(intf_id);
760 intf_oper_ind->set_oper_state(state);
761 ind.set_allocated_intf_oper_ind(intf_oper_ind);
762 oltIndQ.push(ind);
763 return Status::OK;
764}
765
766#define CLI_HOST_PROMPT_FORMAT "BCM.%u> "
767
768/* Build CLI prompt */
769void openolt_cli_get_prompt_cb(bcmcli_session *session, char *buf, uint32_t max_len)
770{
771 snprintf(buf, max_len, CLI_HOST_PROMPT_FORMAT, dev_id);
772}
773
774int _bal_apiend_cli_thread_handler(long data)
775{
776 char init_string[]="\n";
777 bcmcli_session *sess = current_session;
778 bcmos_task_parm bal_cli_task_p_dummy;
779
780 /* Switch to interactive mode if not stopped in the init script */
781 if (!bcmcli_is_stopped(sess)) {
782 /* Force a CLI command prompt
783 * The string passed into the parse function
784 * must be modifiable, so a string constant like
785 * bcmcli_parse(current_session, "\n") will not
786 * work.
787 */
788 bcmcli_parse(sess, init_string);
789
790 /* Process user input until EOF or quit command */
791 bcmcli_driver(sess);
792 }
793 OPENOLT_LOG(INFO, openolt_log_id, "BAL API End CLI terminated\n");
794
795 /* Cleanup */
796 bcmcli_session_close(current_session);
797 bcmcli_token_destroy(NULL);
798 return 0;
799}
800
801/* Init API CLI commands for the current device */
802bcmos_errno bcm_openolt_api_cli_init(bcmcli_entry *parent_dir, bcmcli_session *session)
803{
804 bcmos_errno rc;
805
806 api_parent_dir = parent_dir;
807
808 rc = bcm_api_cli_set_commands(session);
809
810#ifdef BCM_SUBSYSTEM_HOST
811 /* Subscribe for device change indication */
812 rc = rc ? rc : bcmolt_olt_sel_ind_register(_api_cli_olt_change_ind);
813#endif
814
815 return rc;
816}
817
818bcmos_errno bcm_cli_quit(bcmcli_session *session, const bcmcli_cmd_parm parm[], uint16_t n_parms)
819{
820 bcmcli_stop(session);
821 bcmcli_session_print(session, "CLI terminated by 'Quit' command\n");
822 status_bcm_cli_quit = BCMOS_TRUE;
823
824 return BCM_ERR_OK;
825}
826
827int get_status_bcm_cli_quit(void) {
828 return status_bcm_cli_quit;
829}
830
831bcmos_errno bcmolt_apiend_cli_init() {
832 bcmos_errno ret;
833 bcmos_task_parm bal_cli_task_p = {};
834 bcmos_task_parm bal_cli_task_p_dummy;
835
836 /** before creating the task, check if it is already created by the other half of BAL i.e. Core side */
837 if (BCM_ERR_OK != bcmos_task_query(&bal_cli_thread, &bal_cli_task_p_dummy)) {
838 /* Create BAL CLI thread */
839 bal_cli_task_p.name = bal_cli_thread_name;
840 bal_cli_task_p.handler = _bal_apiend_cli_thread_handler;
841 bal_cli_task_p.priority = TASK_PRIORITY_CLI;
842
843 ret = bcmos_task_create(&bal_cli_thread, &bal_cli_task_p);
844 if (BCM_ERR_OK != ret) {
845 bcmos_printf("Couldn't create BAL API end CLI thread\n");
846 return ret;
847 }
848 }
849}
850
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530851bcmos_errno get_onu_status(bcmolt_interface pon_ni, int onu_id, bcmolt_onu_state *onu_state) {
852 bcmos_errno err;
853 bcmolt_onu_cfg onu_cfg;
854 bcmolt_onu_key onu_key;
855 onu_key.pon_ni = pon_ni;
856 onu_key.onu_id = onu_id;
857
858 BCMOLT_CFG_INIT(&onu_cfg, onu, onu_key);
859 BCMOLT_FIELD_SET_PRESENT(&onu_cfg.data, onu_cfg_data, onu_state);
860 BCMOLT_FIELD_SET_PRESENT(&onu_cfg.data, onu_cfg_data, itu);
861 #ifdef TEST_MODE
862 // It is impossible to mock the setting of onu_cfg.data.onu_state because
863 // the actual bcmolt_cfg_get passes the address of onu_cfg.hdr and we cannot
864 // set the onu_cfg.data.onu_state. So a new stub function is created and address
865 // of onu_cfg is passed. This is one-of case where we need to add test specific
866 // code in production code.
867 err = bcmolt_cfg_get__onu_state_stub(dev_id, &onu_cfg);
868 #else
869 err = bcmolt_cfg_get(dev_id, &onu_cfg.hdr);
870 #endif
871 *onu_state = onu_cfg.data.onu_state;
872 return err;
873}
874
875bcmos_errno get_pon_interface_status(bcmolt_interface pon_ni, bcmolt_interface_state *state, bcmolt_status *los_status) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530876 bcmos_errno err;
877 bcmolt_pon_interface_key pon_key;
878 bcmolt_pon_interface_cfg pon_cfg;
879 pon_key.pon_ni = pon_ni;
880
881 BCMOLT_CFG_INIT(&pon_cfg, pon_interface, pon_key);
882 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, state);
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530883 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, los_status);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530884 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, itu);
885 #ifdef TEST_MODE
886 // It is impossible to mock the setting of pon_cfg.data.state because
887 // the actual bcmolt_cfg_get passes the address of pon_cfg.hdr and we cannot
888 // set the pon_cfg.data.state. So a new stub function is created and address
889 // of pon_cfg is passed. This is one-of case where we need to add test specific
890 // code in production code.
891 err = bcmolt_cfg_get__pon_intf_stub(dev_id, &pon_cfg);
892 #else
893 err = bcmolt_cfg_get(dev_id, &pon_cfg.hdr);
894 #endif
895 *state = pon_cfg.data.state;
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530896 *los_status = pon_cfg.data.los_status;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530897 return err;
898}
899
900/* Same as bcmolt_cfg_get but with added logic of retrying the API
901 in case of some specific failures like timeout or object not yet ready
902*/
903bcmos_errno bcmolt_cfg_get_mult_retry(bcmolt_oltid olt, bcmolt_cfg *cfg) {
904 bcmos_errno err;
905 uint32_t current_try = 0;
906
907 while (current_try < MAX_BAL_API_RETRY_COUNT) {
908 err = bcmolt_cfg_get(olt, cfg);
909 current_try++;
910
911 if (err == BCM_ERR_STATE || err == BCM_ERR_TIMEOUT) {
912 OPENOLT_LOG(WARNING, openolt_log_id, "bcmolt_cfg_get: err = %s\n", bcmos_strerror(err));
913 bcmos_usleep(BAL_API_RETRY_TIME_IN_USECS);
914 continue;
915 }
916 else {
917 break;
918 }
919 }
920
921 if (err != BCM_ERR_OK) {
922 OPENOLT_LOG(ERROR, openolt_log_id, "bcmolt_cfg_get tried (%d) times with retry time(%d usecs) err = %s\n",
923 current_try,
924 BAL_API_RETRY_TIME_IN_USECS,
925 bcmos_strerror(err));
926 }
927 return err;
928}
929
930
931unsigned NumNniIf_() {return num_of_nni_ports;}
932unsigned NumPonIf_() {return num_of_pon_ports;}
933
934bcmos_errno get_nni_interface_status(bcmolt_interface id, bcmolt_interface_state *state) {
935 bcmos_errno err;
936 bcmolt_nni_interface_key nni_key;
937 bcmolt_nni_interface_cfg nni_cfg;
938 nni_key.id = id;
939
940 BCMOLT_CFG_INIT(&nni_cfg, nni_interface, nni_key);
941 BCMOLT_FIELD_SET_PRESENT(&nni_cfg.data, nni_interface_cfg_data, state);
942 #ifdef TEST_MODE
943 // It is impossible to mock the setting of nni_cfg.data.state because
944 // the actual bcmolt_cfg_get passes the address of nni_cfg.hdr and we cannot
945 // set the nni_cfg.data.state. So a new stub function is created and address
946 // of nni_cfg is passed. This is one-of case where we need to add test specific
947 // code in production code.
948 err = bcmolt_cfg_get__nni_intf_stub(dev_id, &nni_cfg);
949 #else
950 err = bcmolt_cfg_get(dev_id, &nni_cfg.hdr);
951 #endif
952 *state = nni_cfg.data.state;
953 return err;
954}
955
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +0530956Status install_gem_port(int32_t intf_id, int32_t onu_id, int32_t uni_id, int32_t gemport_id, std::string board_technology) {
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +0530957 gemport_status_map_key_tuple gem_status_key(intf_id, onu_id, uni_id, gemport_id);
958
959 bcmos_fastlock_lock(&data_lock);
960 std::map<gemport_status_map_key_tuple, bool>::const_iterator it = gemport_status_map.find(gem_status_key);
961 if (it != gemport_status_map.end()) {
962 if (it->second) {
963 bcmos_fastlock_unlock(&data_lock, 0);
964 OPENOLT_LOG(INFO, openolt_log_id, "gem port already installed = %d\n", gemport_id);
965 return Status::OK;
966 }
967 }
968 bcmos_fastlock_unlock(&data_lock, 0);
969
Girish Gowdraddf9a162020-01-27 12:56:27 +0530970 bcmos_errno err;
971 bcmolt_itupon_gem_cfg cfg; /* declare main API struct */
972 bcmolt_itupon_gem_key key = {}; /* declare key */
973 bcmolt_gem_port_configuration configuration = {};
974
975 key.pon_ni = intf_id;
976 key.gem_port_id = gemport_id;
977
978 BCMOLT_CFG_INIT(&cfg, itupon_gem, key);
979
980 bcmolt_gem_port_direction configuration_direction;
981 configuration_direction = BCMOLT_GEM_PORT_DIRECTION_BIDIRECTIONAL;
982 BCMOLT_FIELD_SET(&configuration, gem_port_configuration, direction, configuration_direction);
983
984 bcmolt_gem_port_type configuration_type;
985 configuration_type = BCMOLT_GEM_PORT_TYPE_UNICAST;
986 BCMOLT_FIELD_SET(&configuration, gem_port_configuration, type, configuration_type);
987
988 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, configuration, configuration);
989
990 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, onu_id, onu_id);
991
992 bcmolt_control_state encryption_mode;
993 encryption_mode = BCMOLT_CONTROL_STATE_DISABLE;
994 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, encryption_mode, encryption_mode);
995
996 bcmolt_us_gem_port_destination upstream_destination_queue;
997 upstream_destination_queue = BCMOLT_US_GEM_PORT_DESTINATION_DATA;
998 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, upstream_destination_queue, upstream_destination_queue);
999
1000 bcmolt_control_state control;
1001 control = BCMOLT_CONTROL_STATE_ENABLE;
1002 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, control, control);
1003
1004 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
1005 if(err != BCM_ERR_OK) {
Burak Gurdaga0523592021-02-24 15:17:47 +00001006 OPENOLT_LOG(ERROR, openolt_log_id, "failed to install gem_port = %d err = %s (%d)\n", gemport_id, cfg.hdr.hdr.err_text, err);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301007 return bcm_to_grpc_err(err, "Access_Control set ITU PON Gem port failed");
1008 }
1009
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301010#ifndef SCALE_AND_PERF
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301011 if (board_technology == "GPON") {
1012 err = wait_for_gem_action(intf_id, gemport_id, GEM_OBJECT_CREATE);
1013 if (err) {
1014 OPENOLT_LOG(ERROR, openolt_log_id, "failed to install gem_port = %d err = %s\n", gemport_id, bcmos_strerror(err));
1015 return bcm_to_grpc_err(err, "Access_Control set ITU PON Gem port failed");
1016 }
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301017 }
1018#endif
1019
Girish Gowdraddf9a162020-01-27 12:56:27 +05301020 OPENOLT_LOG(INFO, openolt_log_id, "gem port installed successfully = %d\n", gemport_id);
1021
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301022 bcmos_fastlock_lock(&data_lock);
1023 gemport_status_map[gem_status_key] = true;
1024 bcmos_fastlock_unlock(&data_lock, 0);
1025
Girish Gowdraddf9a162020-01-27 12:56:27 +05301026 return Status::OK;
1027}
1028
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301029Status remove_gem_port(int32_t intf_id, int32_t onu_id, int32_t uni_id, int32_t gemport_id, std::string board_technology) {
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301030 gemport_status_map_key_tuple gem_status_key(intf_id, onu_id, uni_id, gemport_id);
1031
1032 bcmos_fastlock_lock(&data_lock);
1033 std::map<gemport_status_map_key_tuple, bool>::const_iterator it = gemport_status_map.find(gem_status_key);
1034 if (it == gemport_status_map.end()) {
1035 bcmos_fastlock_unlock(&data_lock, 0);
1036 OPENOLT_LOG(INFO, openolt_log_id, "gem port already removed = %d\n", gemport_id);
1037 return Status::OK;
1038 }
1039 bcmos_fastlock_unlock(&data_lock, 0);
1040
Girish Gowdraddf9a162020-01-27 12:56:27 +05301041 bcmolt_itupon_gem_cfg gem_cfg;
1042 bcmolt_itupon_gem_key key = {
1043 .pon_ni = (bcmolt_interface)intf_id,
1044 .gem_port_id = (bcmolt_gem_port_id)gemport_id
1045 };
1046 bcmos_errno err;
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301047 bcmolt_interface_state state;
1048 bcmolt_status los_status;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301049
1050 BCMOLT_CFG_INIT(&gem_cfg, itupon_gem, key);
1051 err = bcmolt_cfg_clear(dev_id, &gem_cfg.hdr);
1052 if (err != BCM_ERR_OK)
1053 {
Burak Gurdaga0523592021-02-24 15:17:47 +00001054 OPENOLT_LOG(ERROR, openolt_log_id, "failed to remove gem_port = %d err = %s (%d)\n", gemport_id, gem_cfg.hdr.hdr.err_text, err);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301055 return bcm_to_grpc_err(err, "Access_Control clear ITU PON Gem port failed");
1056 }
1057
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301058 if (board_technology == "GPON") {
1059 err = get_pon_interface_status((bcmolt_interface)intf_id, &state, &los_status);
1060 if (err == BCM_ERR_OK) {
1061 if (state == BCMOLT_INTERFACE_STATE_ACTIVE_WORKING && los_status == BCMOLT_STATUS_OFF) {
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301062#ifndef SCALE_AND_PERF
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301063 OPENOLT_LOG(INFO, openolt_log_id, "PON interface: %d is enabled and LoS status is OFF, waiting for gem cfg clear response\n",
1064 intf_id);
1065 err = wait_for_gem_action(intf_id, gemport_id, GEM_OBJECT_DELETE);
1066 if (err) {
1067 OPENOLT_LOG(ERROR, openolt_log_id, "failed to remove gem_port = %d err = %s\n", gemport_id, bcmos_strerror(err));
1068 return bcm_to_grpc_err(err, "Access_Control clear ITU PON Gem port failed");
1069 }
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301070#endif
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301071 }
1072 else if (state == BCMOLT_INTERFACE_STATE_ACTIVE_WORKING && los_status == BCMOLT_STATUS_ON) {
1073 OPENOLT_LOG(INFO, openolt_log_id, "PON interface: %d is enabled but LoS status is ON, not waiting for gem cfg clear response\n",
1074 intf_id);
1075 }
1076 else if (state == BCMOLT_INTERFACE_STATE_INACTIVE) {
1077 OPENOLT_LOG(INFO, openolt_log_id, "PON interface: %d is disabled, not waiting for gem cfg clear response\n",
1078 intf_id);
1079 }
1080 } else {
1081 OPENOLT_LOG(ERROR, openolt_log_id, "Failed to fetch PON interface status, intf_id = %d, err = %s\n",
1082 intf_id, bcmos_strerror(err));
1083 return bcm_to_grpc_err(err, "Access_Control clear ITU PON Gem port failed");
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301084 }
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301085 }
1086
Girish Gowdraddf9a162020-01-27 12:56:27 +05301087 OPENOLT_LOG(INFO, openolt_log_id, "gem port removed successfully = %d\n", gemport_id);
1088
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301089 bcmos_fastlock_lock(&data_lock);
1090 it = gemport_status_map.find(gem_status_key);
1091 if (it != gemport_status_map.end()) {
1092 gemport_status_map.erase(it);
1093 }
1094 bcmos_fastlock_unlock(&data_lock, 0);
1095
Girish Gowdraddf9a162020-01-27 12:56:27 +05301096 return Status::OK;
1097}
1098
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301099Status enable_encryption_for_gem_port(int32_t intf_id, int32_t gemport_id, std::string board_technology) {
Burak Gurdaga0523592021-02-24 15:17:47 +00001100 bcmos_errno err;
1101 bcmolt_itupon_gem_cfg cfg;
1102 bcmolt_itupon_gem_key key = {
1103 .pon_ni = (bcmolt_interface)intf_id,
1104 .gem_port_id = (bcmolt_gem_port_id)gemport_id
1105 };
1106
1107 BCMOLT_CFG_INIT(&cfg, itupon_gem, key);
1108
1109 bcmolt_control_state encryption_mode;
1110 encryption_mode = BCMOLT_CONTROL_STATE_ENABLE;
1111 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, encryption_mode, encryption_mode);
1112
1113 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
1114 if(err != BCM_ERR_OK) {
1115 OPENOLT_LOG(ERROR, openolt_log_id, "failed to set encryption on pon = %d gem_port = %d, err = %s (%d)\n",
1116 intf_id, gemport_id, cfg.hdr.hdr.err_text, err);
1117 return bcm_to_grpc_err(err, "Failed to set encryption on GEM port");;
1118 }
1119
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301120#ifndef SCALE_AND_PERF
Thiyagarajan Subramani19168f52021-05-25 23:26:41 +05301121 if (board_technology == "GPON") {
1122 err = wait_for_gem_action(intf_id, gemport_id, GEM_OBJECT_ENCRYPT);
1123 if (err) {
1124 OPENOLT_LOG(ERROR, openolt_log_id, "failed to enable gemport encryption, gem_port = %d err = %s\n", gemport_id, bcmos_strerror(err));
1125 return bcm_to_grpc_err(err, "Access_Control ITU PON Gem port encryption failed");
1126 }
Thiyagarajan Subramanie976fcf2021-05-07 22:46:57 +05301127 }
1128#endif
1129
Burak Gurdaga0523592021-02-24 15:17:47 +00001130 OPENOLT_LOG(INFO, openolt_log_id, "encryption set successfully on pon = %d gem_port = %d\n", intf_id, gemport_id);
1131
1132 return Status::OK;
1133}
1134
Girish Gowdraddf9a162020-01-27 12:56:27 +05301135Status update_acl_interface(int32_t intf_id, bcmolt_interface_type intf_type, uint32_t access_control_id,
1136 bcmolt_members_update_command acl_cmd) {
1137 bcmos_errno err;
1138 bcmolt_access_control_interfaces_update oper; /* declare main API struct */
1139 bcmolt_access_control_key acl_key = {}; /* declare key */
1140 bcmolt_intf_ref interface_ref_list_elem = {};
1141 bcmolt_interface_type interface_ref_list_elem_intf_type;
1142 bcmolt_interface_id interface_ref_list_elem_intf_id;
1143 bcmolt_intf_ref_list_u8 interface_ref_list = {};
1144
1145 if (acl_cmd != BCMOLT_MEMBERS_UPDATE_COMMAND_ADD && acl_cmd != BCMOLT_MEMBERS_UPDATE_COMMAND_REMOVE) {
1146 OPENOLT_LOG(ERROR, openolt_log_id, "acl cmd = %d not supported currently\n", acl_cmd);
1147 return bcm_to_grpc_err(BCM_ERR_PARM, "unsupported acl cmd");
1148 }
1149 interface_ref_list.arr = (bcmolt_intf_ref*)bcmos_calloc(sizeof(bcmolt_intf_ref)*1);
1150
1151 if (interface_ref_list.arr == NULL)
1152 return bcm_to_grpc_err(BCM_ERR_PARM, "allocate interface_ref_list failed");
1153 OPENOLT_LOG(INFO, openolt_log_id, "update acl interface received for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1154 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1155 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1156
1157 acl_key.id = access_control_id;
1158
1159 /* Initialize the API struct. */
1160 BCMOLT_OPER_INIT(&oper, access_control, interfaces_update, acl_key);
1161
1162 bcmolt_members_update_command command;
1163 command = acl_cmd;
1164 BCMOLT_FIELD_SET(&oper.data, access_control_interfaces_update_data, command, command);
1165
1166 interface_ref_list_elem_intf_type = intf_type;
1167 BCMOLT_FIELD_SET(&interface_ref_list_elem, intf_ref, intf_type, interface_ref_list_elem_intf_type);
1168
1169 interface_ref_list_elem_intf_id = intf_id;
1170 BCMOLT_FIELD_SET(&interface_ref_list_elem, intf_ref, intf_id, interface_ref_list_elem_intf_id);
1171
1172 interface_ref_list.len = 1;
1173 BCMOLT_ARRAY_ELEM_SET(&interface_ref_list, 0, interface_ref_list_elem);
1174
1175 BCMOLT_FIELD_SET(&oper.data, access_control_interfaces_update_data, interface_ref_list, interface_ref_list);
1176
1177 err = bcmolt_oper_submit(dev_id, &oper.hdr);
1178 if (err != BCM_ERR_OK) {
1179 OPENOLT_LOG(ERROR, openolt_log_id, "update acl interface fail for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1180 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1181 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1182 return bcm_to_grpc_err(err, "Access_Control submit interface failed");
1183 }
1184
1185 bcmos_free(interface_ref_list.arr);
1186 OPENOLT_LOG(INFO, openolt_log_id, "update acl interface success for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1187 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1188 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1189
1190 return Status::OK;
1191}
1192
1193Status install_acl(const acl_classifier_key acl_key) {
Girish Gowdraddf9a162020-01-27 12:56:27 +05301194 bcmos_errno err;
1195 bcmolt_access_control_cfg cfg;
1196 bcmolt_access_control_key key = { };
1197 bcmolt_classifier c_val = { };
1198 // hardcode the action for now.
1199 bcmolt_access_control_fwd_action_type action_type = BCMOLT_ACCESS_CONTROL_FWD_ACTION_TYPE_TRAP_TO_HOST;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301200 int acl_id = get_acl_id();
1201 if (acl_id < 0) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001202 OPENOLT_LOG(ERROR, openolt_log_id, "exhausted acl_id for eth_type = %d, ip_proto = %d, src_port = %d, dst_port = %d o_vid = %d, max_acl_hit=%d\n",
1203 acl_key.ether_type, acl_key.ip_proto, acl_key.src_port, acl_key.dst_port, acl_key.o_vid, max_acls_with_vlan_classifiers_hit);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301204 return bcm_to_grpc_err(BCM_ERR_INTERNAL, "exhausted acl id");
1205 }
1206
1207 key.id = acl_id;
1208 /* config access control instance */
1209 BCMOLT_CFG_INIT(&cfg, access_control, key);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301210 if (acl_key.ether_type > 0) {
1211 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify ether_type 0x%04x\n", acl_key.ether_type);
1212 BCMOLT_FIELD_SET(&c_val, classifier, ether_type, acl_key.ether_type);
1213 }
1214
1215 if (acl_key.ip_proto > 0) {
1216 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify ip_proto %d\n", acl_key.ip_proto);
1217 BCMOLT_FIELD_SET(&c_val, classifier, ip_proto, acl_key.ip_proto);
1218 }
1219
1220 if (acl_key.dst_port > 0) {
1221 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify dst_port %d\n", acl_key.dst_port);
1222 BCMOLT_FIELD_SET(&c_val, classifier, dst_port, acl_key.dst_port);
1223 }
1224
1225 if (acl_key.src_port > 0) {
1226 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify src_port %d\n", acl_key.src_port);
1227 BCMOLT_FIELD_SET(&c_val, classifier, src_port, acl_key.src_port);
1228 }
1229
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001230 // Make sure that max_acls_with_vlan_classifiers_hit is not true to consider o_vid for ACL classification.
1231 if (acl_key.o_vid > 0 && acl_key.o_vid != ANY_VLAN && !max_acls_with_vlan_classifiers_hit) {
1232 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify o_vid %d\n", acl_key.o_vid);
1233 BCMOLT_FIELD_SET(&c_val, classifier, o_vid, acl_key.o_vid);
1234 }
1235
Girish Gowdraddf9a162020-01-27 12:56:27 +05301236 BCMOLT_MSG_FIELD_SET(&cfg, classifier, c_val);
1237 BCMOLT_MSG_FIELD_SET(&cfg, priority, 10000);
1238 BCMOLT_MSG_FIELD_SET(&cfg, statistics_control, BCMOLT_CONTROL_STATE_ENABLE);
1239
1240 BCMOLT_MSG_FIELD_SET(&cfg, forwarding_action.action, action_type);
1241
1242 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
1243 if (err != BCM_ERR_OK) {
1244 OPENOLT_LOG(ERROR, openolt_log_id, "Access_Control set configuration failed, Error %d\n", err);
1245 // Free the acl_id
1246 free_acl_id(acl_id);
1247 return bcm_to_grpc_err(err, "Access_Control set configuration failed");
1248 }
1249
1250 ACL_LOG(INFO, "ACL add ok", err);
1251
1252 // Update the map that we have installed an acl for the given classfier.
1253 acl_classifier_to_acl_id_map[acl_key] = acl_id;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001254 // If there was a valid vlan classifier in the ACL and the ACL ID hit the ceiling, set max_acls_with_vlan_classifiers_hit to true
1255 // After max_acls_with_vlan_classifiers_hit is set to true no more ACLs can have vlan as an ACL classifier.
1256 if (acl_key.o_vid > 0 && acl_key.o_vid != ANY_VLAN && acl_id >= MAX_ACL_WITH_VLAN_CLASSIFIER) {
1257 max_acls_with_vlan_classifiers_hit = true;
1258 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301259 return Status::OK;
1260}
1261
1262Status remove_acl(int acl_id) {
1263 bcmos_errno err;
1264 bcmolt_access_control_cfg cfg; /* declare main API struct */
1265 bcmolt_access_control_key key = {}; /* declare key */
1266
1267 key.id = acl_id;
1268
1269 /* Initialize the API struct. */
1270 BCMOLT_CFG_INIT(&cfg, access_control, key);
1271 BCMOLT_FIELD_SET_PRESENT(&cfg.data, access_control_cfg_data, state);
1272 err = bcmolt_cfg_get(dev_id, &cfg.hdr);
1273 if (err != BCM_ERR_OK) {
1274 OPENOLT_LOG(ERROR, openolt_log_id, "Access_Control get state failed\n");
1275 return bcm_to_grpc_err(err, "Access_Control get state failed");
1276 }
1277
1278 if (cfg.data.state == BCMOLT_CONFIG_STATE_CONFIGURED) {
1279 key.id = acl_id;
1280 /* Initialize the API struct. */
1281 BCMOLT_CFG_INIT(&cfg, access_control, key);
1282
1283 err = bcmolt_cfg_clear(dev_id, &cfg.hdr);
1284 if (err != BCM_ERR_OK) {
1285 // Should we free acl_id here ? We should ideally never land here..
1286 OPENOLT_LOG(ERROR, openolt_log_id, "Error %d while removing Access_Control rule ID %d\n",
1287 err, acl_id);
1288 return Status(grpc::StatusCode::INTERNAL, "Failed to remove Access_Control");
1289 }
1290 }
1291
1292 // Free up acl_id
1293 free_acl_id(acl_id);
1294
1295 OPENOLT_LOG(INFO, openolt_log_id, "acl removed successfully %d\n", acl_id);
1296
1297 return Status::OK;
1298}
1299
1300// Formulates ACL Classifier Key based on the following fields
1301// a. ether_type b. ip_proto c. src_port d. dst_port
1302// If any of the field is not available it is populated as -1.
1303void formulate_acl_classifier_key(acl_classifier_key *key, const ::openolt::Classifier& classifier) {
1304
1305 // TODO: Is 0 a valid value for any of the following classifiers?
1306 // because in the that case, the 'if' check would fail and -1 would be filled as value.
1307 //
1308 if (classifier.eth_type()) {
1309 OPENOLT_LOG(DEBUG, openolt_log_id, "classify ether_type 0x%04x\n", classifier.eth_type());
1310 key->ether_type = classifier.eth_type();
1311 } else key->ether_type = -1;
1312
1313 if (classifier.ip_proto()) {
1314 OPENOLT_LOG(DEBUG, openolt_log_id, "classify ip_proto %d\n", classifier.ip_proto());
1315 key->ip_proto = classifier.ip_proto();
1316 } else key->ip_proto = -1;
1317
1318
1319 if (classifier.src_port()) {
1320 OPENOLT_LOG(DEBUG, openolt_log_id, "classify src_port %d\n", classifier.src_port());
1321 key->src_port = classifier.src_port();
1322 } else key->src_port = -1;
1323
1324
1325 if (classifier.dst_port()) {
1326 OPENOLT_LOG(DEBUG, openolt_log_id, "classify dst_port %d\n", classifier.dst_port());
1327 key->dst_port = classifier.dst_port();
1328 } else key->dst_port = -1;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001329
1330 // We should also check the max_acls_with_vlan_classifiers_hit flag is not false to consider the vlan for flow classifier key
1331 if (classifier.o_vid() && !max_acls_with_vlan_classifiers_hit) {
1332 OPENOLT_LOG(DEBUG, openolt_log_id, "classify o_vid %d\n", classifier.o_vid());
1333 key->o_vid = classifier.o_vid();
1334 } else key->o_vid = ANY_VLAN;
1335
Girish Gowdraddf9a162020-01-27 12:56:27 +05301336}
1337
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001338Status handle_acl_rule_install(int32_t onu_id, uint64_t flow_id, int32_t gemport_id,
Girish Gowdraddf9a162020-01-27 12:56:27 +05301339 const std::string flow_type, int32_t access_intf_id,
Girish Gowdra252f4972020-09-07 21:24:01 -07001340 int32_t network_intf_id,
Girish Gowdraddf9a162020-01-27 12:56:27 +05301341 const ::openolt::Classifier& classifier) {
1342 int acl_id;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001343 uint32_t intf_id = flow_type.compare(upstream) == 0? access_intf_id: network_intf_id;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301344 const std::string intf_type = flow_type.compare(upstream) == 0? "pon": "nni";
1345 bcmolt_interface_type olt_if_type = intf_type == "pon"? BCMOLT_INTERFACE_TYPE_PON: BCMOLT_INTERFACE_TYPE_NNI;
1346
1347 Status resp;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001348 trap_to_host_packet_type pkt_type = get_trap_to_host_packet_type(classifier);
1349 if (pkt_type == unsupported_trap_to_host_pkt_type) {
1350 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported pkt trap type");
1351 return Status(grpc::StatusCode::UNIMPLEMENTED, "unsupported pkt trap type");
1352 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301353
1354 // few map keys we are going to use later.
1355 flow_id_flow_direction fl_id_fl_dir(flow_id, flow_type);
Girish Gowdra252f4972020-09-07 21:24:01 -07001356
Girish Gowdraddf9a162020-01-27 12:56:27 +05301357 acl_classifier_key acl_key;
1358 formulate_acl_classifier_key(&acl_key, classifier);
1359 const acl_classifier_key acl_key_const = {.ether_type=acl_key.ether_type, .ip_proto=acl_key.ip_proto,
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001360 .src_port=acl_key.src_port, .dst_port=acl_key.dst_port, .o_vid=acl_key.o_vid};
1361 bcmos_fastlock_lock(&acl_packet_trap_handler_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301362
1363 // Check if the acl is already installed
1364 if (acl_classifier_to_acl_id_map.count(acl_key_const) > 0) {
1365 // retreive the acl_id
1366 acl_id = acl_classifier_to_acl_id_map[acl_key_const];
Girish Gowdra252f4972020-09-07 21:24:01 -07001367
1368
Girish Gowdraddf9a162020-01-27 12:56:27 +05301369 if (flow_to_acl_map.count(fl_id_fl_dir)) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001370 // could happen if same trap flow is received again
Girish Gowdraddf9a162020-01-27 12:56:27 +05301371 OPENOLT_LOG(INFO, openolt_log_id, "flow and related acl already handled, nothing more to do\n");
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001372 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301373 return Status::OK;
1374 }
1375
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001376 OPENOLT_LOG(INFO, openolt_log_id, "Acl for flow_id=%lu with eth_type = %d, ip_proto = %d, src_port = %d, dst_port = %d o_vid = %d already installed with acl id = %u\n",
1377 flow_id, acl_key.ether_type, acl_key.ip_proto, acl_key.src_port, acl_key.dst_port, acl_key.o_vid, acl_id);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301378
1379 // The acl_ref_cnt is needed to know how many flows refer an ACL.
1380 // When the flow is removed, we decrement the reference count.
1381 // When the reference count becomes 0, we remove the ACL.
1382 if (acl_ref_cnt.count(acl_id) > 0) {
1383 acl_ref_cnt[acl_id] ++;
1384 } else {
1385 // We should ideally not land here. The acl_ref_cnt should have been
1386 // initialized the first time acl was installed.
1387 acl_ref_cnt[acl_id] = 1;
1388 }
1389
1390 } else {
1391 resp = install_acl(acl_key_const);
1392 if (!resp.ok()) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001393 OPENOLT_LOG(ERROR, openolt_log_id, "Acl for flow_id=%lu with eth_type = %d, ip_proto = %d, src_port = %d, dst_port = %d o_vid = %d failed\n",
1394 flow_id, acl_key_const.ether_type, acl_key_const.ip_proto, acl_key_const.src_port, acl_key_const.dst_port, acl_key_const.o_vid);
1395 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301396 return resp;
1397 }
1398
1399 acl_id = acl_classifier_to_acl_id_map[acl_key_const];
1400
1401 // Initialize the acl reference count
1402 acl_ref_cnt[acl_id] = 1;
1403
Girish Gowdra252f4972020-09-07 21:24:01 -07001404 OPENOLT_LOG(INFO, openolt_log_id, "acl add success for flow_id=%lu with acl_id=%d\n", flow_id, acl_id);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301405 }
1406
1407 // Register the interface for the given acl
1408 acl_id_intf_id_intf_type ac_id_inf_id_inf_type(acl_id, intf_id, intf_type);
1409 // This is needed to keep a track of which interface (pon/nni) has registered for an ACL.
1410 // If it is registered, how many flows refer to it.
1411 if (intf_acl_registration_ref_cnt.count(ac_id_inf_id_inf_type) > 0) {
1412 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type]++;
1413 } else {
1414 // The given interface is not registered for the ACL. We need to do it now.
1415 resp = update_acl_interface(intf_id, olt_if_type, acl_id, BCMOLT_MEMBERS_UPDATE_COMMAND_ADD);
1416 if (!resp.ok()){
1417 OPENOLT_LOG(ERROR, openolt_log_id, "failed to update acl interfaces intf_id=%d, intf_type=%s, acl_id=%d", intf_id, intf_type.c_str(), acl_id);
1418 // TODO: Ideally we should return error from hear and clean up other other stateful
1419 // counters we creaed earlier. Will leave it out for now.
Girish Gowdra252f4972020-09-07 21:24:01 -07001420 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301421 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type] = 1;
1422 }
1423
Girish Gowdra252f4972020-09-07 21:24:01 -07001424 acl_id_intf_id ac_id_if_id(acl_id, intf_id);
1425 flow_to_acl_map[fl_id_fl_dir] = ac_id_if_id;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301426
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001427 // Populate the trap_to_host_pkt_info_with_vlan corresponding to the trap-to-host voltha flow_id key.
1428 // When the trap-to-host voltha flow-id is being removed, this entry is cleared too from the map.
1429 trap_to_host_pkt_info_with_vlan pkt_info_with_vlan((int32_t)olt_if_type, intf_id, (int32_t)pkt_type, gemport_id, (short unsigned int)classifier.o_vid());
1430 trap_to_host_pkt_info_with_vlan_for_flow_id[flow_id] = pkt_info_with_vlan;
1431 trap_to_host_pkt_info pkt_info((int32_t)olt_if_type, intf_id, (int32_t)pkt_type, gemport_id);
1432 bool duplicate = false;
1433 // Check if the vlan_id corresponding to the trap_to_host_pkt_info key is found. Set the 'duplicate' flag accordingly.
1434 if (trap_to_host_vlan_ids_for_trap_to_host_pkt_info.count(pkt_info) > 0) {
1435 auto& vlan_id_list = trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info];
1436 auto it = std::find(vlan_id_list.begin(), vlan_id_list.end(), acl_key.o_vid);
1437 if (it != vlan_id_list.end()) {
1438 OPENOLT_LOG(DEBUG, openolt_log_id, "cvid = %d exists already in list", acl_key.o_vid);
1439 duplicate = true;
1440 }
1441 }
1442 // If the vlan_id is not found corresponding to the trap_to_host_pkt_info key, update it.
1443 // This will be used to validate the vlan_id in the trapped packet. If vlan_id in the
1444 // trapped packet is not match with the stored value, packet is dropped.
1445 if (!duplicate) {
1446 trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info].push_back(acl_key.o_vid);
1447 }
1448
1449 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301450
1451 return Status::OK;
1452}
1453
Girish Gowdra252f4972020-09-07 21:24:01 -07001454Status handle_acl_rule_cleanup(int16_t acl_id, int32_t intf_id, const std::string flow_type) {
Girish Gowdraddf9a162020-01-27 12:56:27 +05301455 const std::string intf_type= flow_type.compare(upstream) == 0 ? "pon": "nni";
1456 acl_id_intf_id_intf_type ac_id_inf_id_inf_type(acl_id, intf_id, intf_type);
1457 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type]--;
1458 if (intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type] == 0) {
1459 bcmolt_interface_type olt_if_type = intf_type == "pon"? BCMOLT_INTERFACE_TYPE_PON: BCMOLT_INTERFACE_TYPE_NNI;
1460 Status resp = update_acl_interface(intf_id, olt_if_type, acl_id, BCMOLT_MEMBERS_UPDATE_COMMAND_REMOVE);
1461 if (!resp.ok()){
1462 OPENOLT_LOG(ERROR, openolt_log_id, "failed to update acl interfaces intf_id=%d, intf_type=%s, acl_id=%d", intf_id, intf_type.c_str(), acl_id);
1463 }
1464 intf_acl_registration_ref_cnt.erase(ac_id_inf_id_inf_type);
1465 }
1466
1467 acl_ref_cnt[acl_id]--;
1468 if (acl_ref_cnt[acl_id] == 0) {
1469 remove_acl(acl_id);
1470 acl_ref_cnt.erase(acl_id);
1471 // Iterate acl_classifier_to_acl_id_map and delete classifier the key corresponding to acl_id
1472 std::map<acl_classifier_key, uint16_t>::iterator it;
1473 for (it=acl_classifier_to_acl_id_map.begin(); it!=acl_classifier_to_acl_id_map.end(); ++it) {
1474 if (it->second == acl_id) {
1475 OPENOLT_LOG(INFO, openolt_log_id, "cleared classifier key corresponding to acl_id = %d\n", acl_id);
1476 acl_classifier_to_acl_id_map.erase(it->first);
1477 break;
1478 }
1479 }
1480 }
1481
Girish Gowdraddf9a162020-01-27 12:56:27 +05301482 return Status::OK;
1483}
1484
1485Status check_bal_ready() {
1486 bcmos_errno err;
1487 int maxTrials = 30;
1488 bcmolt_olt_cfg olt_cfg = { };
1489 bcmolt_olt_key olt_key = { };
1490
1491 BCMOLT_CFG_INIT(&olt_cfg, olt, olt_key);
1492 BCMOLT_MSG_FIELD_GET(&olt_cfg, bal_state);
1493
1494 while (olt_cfg.data.bal_state != BCMOLT_BAL_STATE_BAL_AND_SWITCH_READY) {
1495 if (--maxTrials == 0)
1496 return grpc::Status(grpc::StatusCode::UNAVAILABLE, "check bal ready failed");
1497 sleep(5);
1498 #ifdef TEST_MODE
1499 // It is impossible to mock the setting of olt_cfg.data.bal_state because
1500 // the actual bcmolt_cfg_get passes the address of olt_cfg.hdr and we cannot
1501 // set the olt_cfg.data.bal_state. So a new stub function is created and address
1502 // of olt_cfg is passed. This is one-of case where we need to add test specific
1503 // code in production code.
1504 if (bcmolt_cfg_get__bal_state_stub(dev_id, &olt_cfg)) {
1505 #else
1506 if (bcmolt_cfg_get(dev_id, &olt_cfg.hdr)) {
1507 #endif
1508 continue;
1509 }
1510 else
1511 OPENOLT_LOG(INFO, openolt_log_id, "waiting for BAL ready ...\n");
1512 }
1513
1514 OPENOLT_LOG(INFO, openolt_log_id, "BAL is ready\n");
1515 return Status::OK;
1516}
1517
1518Status check_connection() {
1519 int maxTrials = 60;
1520 while (!bcmolt_api_conn_mgr_is_connected(dev_id)) {
1521 sleep(1);
1522 if (--maxTrials == 0)
1523 return grpc::Status(grpc::StatusCode::UNAVAILABLE, "check connection failed");
1524 else
1525 OPENOLT_LOG(INFO, openolt_log_id, "waiting for daemon connection ...\n");
1526 }
1527 OPENOLT_LOG(INFO, openolt_log_id, "daemon is connected\n");
1528 return Status::OK;
1529}
1530
Thiyagarajan Subramani03bc66f2020-04-01 15:58:53 +05301531std::string get_ip_address(const char* nw_intf){
1532 std::string ipAddress = "0.0.0.0";
1533 struct ifaddrs *interfaces = NULL;
1534 struct ifaddrs *temp_addr = NULL;
1535 int success = 0;
1536 /* retrieve the current interfaces - returns 0 on success */
1537 success = getifaddrs(&interfaces);
1538 if (success == 0) {
1539 /* Loop through linked list of interfaces */
1540 temp_addr = interfaces;
1541 while(temp_addr != NULL) {
1542 if(temp_addr->ifa_addr->sa_family == AF_INET) {
1543 /* Check if interface given present in OLT, if yes return its IP Address */
1544 if(strcmp(temp_addr->ifa_name, nw_intf) == 0){
1545 ipAddress=inet_ntoa(((struct sockaddr_in*)temp_addr->ifa_addr)->sin_addr);
1546 break;
1547 }
1548 }
1549 temp_addr = temp_addr->ifa_next;
1550 }
1551 }
1552 /* Free memory */
1553 freeifaddrs(interfaces);
1554 return ipAddress;
1555}
Jason Huang1d9cfce2020-05-20 22:58:47 +08001556
1557bcmos_errno getOnuMaxLogicalDistance(uint32_t intf_id, uint32_t *mld) {
1558 bcmos_errno err = BCM_ERR_OK;
1559 bcmolt_pon_distance pon_distance = {};
1560 bcmolt_pon_interface_cfg pon_cfg; /* declare main API struct */
1561 bcmolt_pon_interface_key key = {}; /* declare key */
1562
1563 key.pon_ni = intf_id;
1564
1565 if (!state.is_activated()) {
1566 OPENOLT_LOG(ERROR, openolt_log_id, "ONU maximum logical distance is not available since OLT is not activated yet\n");
1567 return BCM_ERR_STATE;
1568 }
1569
1570 /* Initialize the API struct. */
1571 BCMOLT_CFG_INIT(&pon_cfg, pon_interface, key);
1572 BCMOLT_FIELD_SET_PRESENT(&pon_distance, pon_distance, max_log_distance);
1573 BCMOLT_FIELD_SET(&pon_cfg.data, pon_interface_cfg_data, pon_distance, pon_distance);
1574 #ifdef TEST_MODE
1575 // It is impossible to mock the setting of pon_cfg.data.state because
1576 // the actual bcmolt_cfg_get passes the address of pon_cfg.hdr and we cannot
1577 // set the pon_cfg.data.state. So a new stub function is created and address
1578 // of pon_cfg is passed. This is one-of case where we need to add test specific
1579 // code in production code.
1580 err = bcmolt_cfg_get__pon_intf_stub(dev_id, &pon_cfg);
1581 #else
1582 err = bcmolt_cfg_get(dev_id, &pon_cfg.hdr);
1583 #endif
1584 if (err != BCM_ERR_OK) {
1585 OPENOLT_LOG(ERROR, openolt_log_id, "Failed to retrieve ONU maximum logical distance for PON %d, err = %s (%d)\n", intf_id, bcmos_strerror(err), err);
1586 return err;
1587 }
1588 *mld = pon_distance.max_log_distance;
1589
1590 return BCM_ERR_OK;
1591}
Humera Kouser6143c9e2020-06-17 22:37:31 +05301592
1593/**
1594* Gets mac address based on interface name.
1595*
1596* @param intf_name interface name
1597* @param mac_address mac address field
1598* @param max_size_of_mac_address max sixe of the mac_address
1599* @return mac_address value in case of success or return NULL in case of failure.
1600*/
1601
1602char* get_intf_mac(const char* intf_name, char* mac_address, unsigned int max_size_of_mac_address){
1603 int fd;
1604 struct ifreq ifr;
1605 char *mac;
1606
1607 fd = socket(AF_INET, SOCK_DGRAM, 0);
1608 if ( fd == -1) {
1609 OPENOLT_LOG(ERROR, openolt_log_id, "failed to get mac, could not create file descriptor");
1610 return NULL;
1611 }
1612
1613 ifr.ifr_addr.sa_family = AF_INET;
1614 strncpy((char *)ifr.ifr_name , (const char *)intf_name , IFNAMSIZ-1);
1615 if( ioctl(fd, SIOCGIFHWADDR, &ifr) == -1)
1616 {
1617 OPENOLT_LOG(ERROR, openolt_log_id, "failed to get mac, ioctl failed and returned err");
1618 close(fd);
1619 return NULL;
1620 }
1621
1622 close(fd);
1623 mac = (char *)ifr.ifr_hwaddr.sa_data;
1624
1625 // formatted mac address
1626 snprintf(mac_address, max_size_of_mac_address, (const char *)"%.2x:%.2x:%.2x:%.2x:%.2x:%.2x", (unsigned char)mac[0], (unsigned char)mac[1], (unsigned char)mac[2], (unsigned char)mac[3], (unsigned char)mac[4], (unsigned char)mac[5]);
1627
1628 return mac_address;
1629}
Girish Gowdra252f4972020-09-07 21:24:01 -07001630
1631void update_voltha_flow_to_cache(uint64_t voltha_flow_id, device_flow dev_flow) {
1632 OPENOLT_LOG(DEBUG, openolt_log_id, "updating voltha flow=%lu to cache\n", voltha_flow_id)
1633 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1634 voltha_flow_to_device_flow[voltha_flow_id] = dev_flow;
1635 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1636}
1637
1638void remove_voltha_flow_from_cache(uint64_t voltha_flow_id) {
1639 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1640 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1641 if (it != voltha_flow_to_device_flow.end()) {
1642 voltha_flow_to_device_flow.erase(it);
1643 }
1644 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1645}
1646
1647bool is_voltha_flow_installed(uint64_t voltha_flow_id ) {
1648 int count;
1649 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1650 count = voltha_flow_to_device_flow.count(voltha_flow_id);
1651 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1652
1653 return count > 0 ? true : false;
1654}
1655
1656const device_flow_params* get_device_flow_params(uint64_t voltha_flow_id) {
1657 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1658 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1659 if (it != voltha_flow_to_device_flow.end()) {
1660 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1661 return it->second.params;
1662 }
1663 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1664
1665 return NULL;
1666}
1667
1668const device_flow* get_device_flow(uint64_t voltha_flow_id) {
1669 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1670 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1671 if (it != voltha_flow_to_device_flow.end()) {
1672 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1673 return &it->second;
1674 }
1675 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1676
1677 return NULL;
1678}
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001679
1680trap_to_host_packet_type get_trap_to_host_packet_type(const ::openolt::Classifier& classifier) {
1681 trap_to_host_packet_type type = unsupported_trap_to_host_pkt_type;
1682 if (classifier.eth_type() == EAP_ETH_TYPE) {
1683 type = eap;
1684 } else if (classifier.src_port() == DHCP_SERVER_SRC_PORT || classifier.src_port() == DHCP_CLIENT_SRC_PORT) {
1685 type = dhcpv4;
1686 } else if (classifier.eth_type() == LLDP_ETH_TYPE) {
1687 type = lldp;
1688 } else if (classifier.ip_proto() == IGMPv4_PROTOCOL) {
1689 type = igmpv4;
Marcos Aurelio Carrero (Furukawa)c4c56b32021-03-08 12:20:34 -03001690 } else if (classifier.eth_type() == PPPoED_ETH_TYPE) {
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -03001691 type = pppoed;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001692 }
1693
1694 return type;
1695}
1696
1697// is_packet_allowed extracts the VLAN, packet-type, interface-type, interface-id from incoming trap-to-host packet.
1698// Then it verifies if this packet can be allowed upstream to host. It does this by checking if the vlan in the incoming packet
1699//exists in trap_to_host_vlan_ids_for_trap_to_host_pkt_info map for (interface-type, interface-id, packet-type) key.
1700bool is_packet_allowed(bcmolt_access_control_receive_eth_packet_data *data, int32_t gemport_id) {
1701 bcmolt_interface_type intf_type = data->interface_ref.intf_type;
1702 uint32_t intf_id = data->interface_ref.intf_id;
1703 trap_to_host_packet_type pkt_type = unsupported_trap_to_host_pkt_type;
1704 uint16_t vlan_id = 0;
1705 int ethType;
1706
1707 struct timeval dummy_tv = {0, 0};
1708 bool free_memory_of_raw_packet = false; // This indicates the pcap library to not free the message buffer. It will freed by the caller.
1709
1710 pcpp::RawPacket rawPacket(data->buffer.arr, data->buffer.len, dummy_tv, free_memory_of_raw_packet, pcpp::LINKTYPE_ETHERNET);
1711 pcpp::Packet parsedPacket(&rawPacket);
1712 pcpp::EthLayer* ethernetLayer = parsedPacket.getLayerOfType<pcpp::EthLayer>();
1713 if (ethernetLayer == NULL)
1714 {
1715 OPENOLT_LOG(ERROR, openolt_log_id, "Something went wrong, couldn't find Ethernet layer\n");
1716 return false;
1717 }
1718
1719 // Getting Vlan layer
1720 pcpp::VlanLayer* vlanLayer = parsedPacket.getLayerOfType<pcpp::VlanLayer>();
1721 if (vlanLayer == NULL)
1722 {
1723 // Allow Untagged LLDP Ether type packet to trap from NNI
1724 if (ntohs(ethernetLayer->getEthHeader()->etherType) == LLDP_ETH_TYPE && intf_type == BCMOLT_INTERFACE_TYPE_NNI) {
1725 return true;
1726 } else {
1727 OPENOLT_LOG(WARNING, openolt_log_id, "untagged packets other than lldp packets are dropped. ethertype=%d, intftype=%d, intf_id=%d\n",
1728 ntohs(ethernetLayer->getEthHeader()->etherType), intf_type, intf_id);
1729 return false;
1730 }
1731 } else {
1732 ethType = ntohs(vlanLayer->getVlanHeader()->etherType);
1733 if (ethType == EAP_ETH_TYPE) { // single tagged packet with EAPoL payload
1734 vlan_id = vlanLayer->getVlanID();
1735 pkt_type = eap;
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -03001736 } else if (ethType == PPPoED_ETH_TYPE) { // single tagged packet with PPPOeD payload
1737 vlan_id = vlanLayer->getVlanID();
1738 pkt_type = pppoed;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001739 } else if (ethType == IPV4_ETH_TYPE) { // single tagged packet with IPv4 payload
1740 vlan_id = vlanLayer->getVlanID();
1741 vlanLayer->parseNextLayer();
1742 pcpp::IPv4Layer *ipv4Layer = (pcpp::IPv4Layer*)vlanLayer->getNextLayer();
1743 if(ipv4Layer->getIPv4Header()->protocol == UDP_PROTOCOL) { // UDP payload
1744 // Check the UDP Ports to see if it is a DHCPv4 packet
1745 ipv4Layer->parseNextLayer();
1746 pcpp::UdpLayer *udpLayer = (pcpp::UdpLayer*)ipv4Layer->getNextLayer();
1747 if (ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_SERVER_SRC_PORT|| ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_CLIENT_SRC_PORT) {
1748 pkt_type = dhcpv4;
1749 } else {
1750 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported udp source port = %d\n", ntohs(udpLayer->getUdpHeader()->portSrc));
1751 return false;
1752 }
1753 } else if (ipv4Layer->getIPv4Header()->protocol == IGMPv4_PROTOCOL) { // Igmpv4 payload
1754 pkt_type = igmpv4;
1755 } else {
1756 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ip protocol = %d\n", ipv4Layer->getIPv4Header()->protocol);
1757 return false;
1758 }
1759 } else if (ethType == VLAN_ETH_TYPE) { // double tagged packet
1760
1761 // Trap-to-host from NNI flows do not specify the VLANs, so no vlan validation is necessary.
1762 if (intf_type == BCMOLT_INTERFACE_TYPE_NNI) {
1763 return true;
1764 }
1765
1766 // Here we parse the inner vlan payload and currently support only IPv4 packets
1767
1768 // Extract the vlan_id for trap-to-host packets arriving from the PON
1769 // trap-to-host ACLs from the NNI do not care about VLAN.
1770 if (intf_type == BCMOLT_INTERFACE_TYPE_PON) {
1771 vlan_id = vlanLayer->getVlanID(); // This is the outer vlan id
1772 }
1773 vlanLayer->parseNextLayer();
1774 vlanLayer = (pcpp::VlanLayer*)vlanLayer->getNextLayer(); // Here we extract the inner vlan layer
1775 ethType = ntohs(vlanLayer->getVlanHeader()->etherType);
1776 if (ethType == IPV4_ETH_TYPE) { // IPv4
1777 uint16_t _inner_vlan_id = vlanLayer->getVlanID();
1778 vlanLayer->parseNextLayer();
1779 pcpp::IPv4Layer *ipv4Layer = (pcpp::IPv4Layer*)vlanLayer->getNextLayer(); // here we extract the inner vlan IPv4 payload
1780 if(ipv4Layer->getIPv4Header()->protocol == UDP_PROTOCOL) { // UDP payload
1781 // Check the UDP Ports to see if it is a DHCPv4 packet
1782 ipv4Layer->parseNextLayer();
1783 pcpp::UdpLayer *udpLayer = (pcpp::UdpLayer*)ipv4Layer->getNextLayer();
1784 if (ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_SERVER_SRC_PORT || ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_CLIENT_SRC_PORT) {
1785 pkt_type = dhcpv4;
1786 } else {
1787 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported udp source port = %d\n", ntohs(udpLayer->getUdpHeader()->portSrc));
1788 return false;
1789 }
1790 } else if (ipv4Layer->getIPv4Header()->protocol == IGMPv4_PROTOCOL) { // Igmpv4 payload
1791 pkt_type = igmpv4;
1792 } else {
1793 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ip protocol = %d\n", ipv4Layer->getIPv4Header()->protocol)
1794 return false;
1795 }
1796 }
1797 } else {
1798 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ether type = 0x%x\n", ntohs((vlanLayer->getVlanHeader()->etherType)));
1799 return false;
1800 }
1801 }
1802
1803#if 0 // Debug logs for test purpose only
1804 std::cout << "vlan of received packet " << vlan_id << " intf_type " << intf_type << " intf_id " <<intf_id << " pkt_type " <<pkt_type << " gem_port_id" << gemport_id << "\n";
1805 for(std::map<trap_to_host_pkt_info, std::list<uint16_t> >::const_iterator it = trap_to_host_vlan_ids_for_trap_to_host_pkt_info.begin();
1806 it != trap_to_host_vlan_ids_for_trap_to_host_pkt_info.end(); ++it)
1807 {
1808 std::cout << "value entries" << " " << std::get<0>(it->first) << " "<< std::get<1>(it->first) << " "<< std::get<2>(it->first) << " "<< std::get<3>(it->first) << "\n\n";
1809 std::cout << "vlans for the above key are => ";
1810 for (std::list<uint16_t>::const_iterator _it=it->second.begin();
1811 _it != it->second.end();
1812 ++_it) {
1813 std::cout << *_it << " ";
1814 }
1815 std::cout << "\n\n";
1816 }
1817#endif
1818
1819 trap_to_host_pkt_info pkt_info(intf_type, intf_id, pkt_type, gemport_id);
1820 // Check for matching vlan only if the trap_to_host_pkt_info exists in the trap_to_host_vlan_ids_for_trap_to_host_pkt_info map
1821 if (trap_to_host_vlan_ids_for_trap_to_host_pkt_info.count(pkt_info) > 0) {
1822 // Iterate throught the vlan list to find matching vlan
1823 auto& vlan_id_list = trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info];
1824 for (auto allowed_vlan_id : vlan_id_list) {
1825 // Found exact matching vlan in the allowed list of vlans for the trap_to_host_pkt_info key or
1826 // there is generic match ANY_VLAN in the list in the allowed vlan list.
1827 if (allowed_vlan_id == vlan_id || allowed_vlan_id == ANY_VLAN) {
1828 return true;
1829 }
1830 }
1831 }
1832 return false;
1833}
Orhan Kupusoglu1fd77072021-03-23 08:13:25 -07001834
1835std::pair<grpc_ssl_client_certificate_request_type, bool> get_grpc_tls_option(const char* tls_option) {
1836 static std::map<std::string,grpc_ssl_client_certificate_request_type> grpc_security_option_map = {{"GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE",
1837 grpc_ssl_client_certificate_request_type::GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE},
1838 {"GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY",
1839 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY},
1840 {"GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY",
1841 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY},
1842 {"GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY",
1843 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY},
1844 {"GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY",
1845 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY}};
1846
1847 auto it = grpc_security_option_map.find(tls_option);
1848 if (it == grpc_security_option_map.end()) {
1849 OPENOLT_LOG(ERROR, openolt_log_id, "invalid gRPC Server security option: %s\n", tls_option);
1850 return {grpc_ssl_client_certificate_request_type::GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE, false};
1851 } else {
1852 OPENOLT_LOG(INFO, openolt_log_id, "valid gRPC Server security option: %s\n", tls_option);
1853 tls_option_arg = std::string{tls_option};
1854 return {it->second, true};
1855 }
1856}
1857
1858const std::string &get_grpc_tls_option() {
1859 return tls_option_arg;
1860}
1861
1862bool is_grpc_secure() {
1863 return !tls_option_arg.empty();
1864}
1865
1866std::pair<std::string, bool> read_from_txt_file(const std::string& file_name) {
1867 std::ifstream in_file(file_name);
1868
1869 if (!in_file.is_open()) {
1870 OPENOLT_LOG(ERROR, openolt_log_id, "error opening file '%s'\n", file_name.c_str());
1871 return {"", false};
1872 }
1873
1874 std::stringstream buffer;
1875 buffer << in_file.rdbuf();
1876
1877 return {buffer.str(), in_file.good()};
1878}
Orhan Kupusogluec57af02021-05-12 12:38:17 +00001879
1880bool save_to_txt_file(const std::string& file_name, const std::string& content) {
1881 std::ofstream out_file;
1882 out_file.exceptions(std::ofstream::failbit | std::ofstream::badbit);
1883
1884 try {
1885 out_file.open(file_name, std::ios::out | std::ios::trunc);
1886
1887 if (!out_file.is_open()) {
1888 std::cerr << "error while opening file '" << file_name << "'\n";
1889 return false;
1890 }
1891
1892 out_file << content;
1893 out_file.close();
1894
1895 return true;
1896 } catch (const std::ofstream::failure& e) {
1897 std::cerr << "exception while writing to file '" << file_name << "' | err: " << e.what() << '\n';
1898 return false;
1899 }
1900}