blob: 01530781a4b254ef0ce3919ee6351add7e713caa [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);
576 alloc_cfg_compltd_map[k] = &cfg_result;
577 bcmos_errno err = BCM_ERR_OK;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530578
579 // Try to pop the result from BAL with a timeout of ALLOC_CFG_COMPLETE_WAIT_TIMEOUT ms
580 std::pair<alloc_cfg_complete_result, bool> result = cfg_result.pop(ALLOC_CFG_COMPLETE_WAIT_TIMEOUT);
581 if (result.second == false) {
582 OPENOLT_LOG(ERROR, openolt_log_id, "timeout waiting for alloc cfg complete indication intf_id %d, alloc_id %d\n",
583 intf_id, alloc_id);
584 // Invalidate the queue pointer.
585 bcmos_fastlock_lock(&alloc_cfg_wait_lock);
586 alloc_cfg_compltd_map[k] = NULL;
587 bcmos_fastlock_unlock(&alloc_cfg_wait_lock, 0);
588 err = BCM_ERR_INTERNAL;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530589 }
590 else if (result.first.status == ALLOC_CFG_STATUS_FAIL) {
591 OPENOLT_LOG(ERROR, openolt_log_id, "error processing alloc cfg request intf_id %d, alloc_id %d\n",
592 intf_id, alloc_id);
593 err = BCM_ERR_INTERNAL;
594 }
595
596 if (err == BCM_ERR_OK) {
597 if (action == ALLOC_OBJECT_CREATE) {
598 if (result.first.state != ALLOC_OBJECT_STATE_ACTIVE) {
599 OPENOLT_LOG(ERROR, openolt_log_id, "alloc object not in active state intf_id %d, alloc_id %d alloc_obj_state %d\n",
600 intf_id, alloc_id, result.first.state);
601 err = BCM_ERR_INTERNAL;
602 } else {
603 OPENOLT_LOG(INFO, openolt_log_id, "Create upstream bandwidth allocation success, intf_id %d, alloc_id %d\n",
604 intf_id, alloc_id);
605 }
606 } else { // ALLOC_OBJECT_DELETE
607 if (result.first.state != ALLOC_OBJECT_STATE_NOT_CONFIGURED) {
608 OPENOLT_LOG(ERROR, openolt_log_id, "alloc object is not reset intf_id %d, alloc_id %d alloc_obj_state %d\n",
609 intf_id, alloc_id, result.first.state);
610 err = BCM_ERR_INTERNAL;
611 } else {
612 OPENOLT_LOG(INFO, openolt_log_id, "Remove alloc object success, intf_id %d, alloc_id %d\n",
613 intf_id, alloc_id);
614 }
615 }
616 }
617
618 // Remove entry from map
619 bcmos_fastlock_lock(&alloc_cfg_wait_lock);
620 alloc_cfg_compltd_map.erase(k);
621 bcmos_fastlock_unlock(&alloc_cfg_wait_lock, 0);
Girish Gowdra7a79dae2020-02-10 18:22:11 +0530622 return err;
623}
624
625// This method handles waiting for OnuDeactivate Completed Indication
626bcmos_errno wait_for_onu_deactivate_complete(uint32_t intf_id, uint32_t onu_id) {
627 Queue<onu_deactivate_complete_result> deact_result;
628 onu_deact_compltd_key k(intf_id, onu_id);
629 onu_deact_compltd_map[k] = &deact_result;
630 bcmos_errno err = BCM_ERR_OK;
631
632 // Try to pop the result from BAL with a timeout of ONU_DEACTIVATE_COMPLETE_WAIT_TIMEOUT ms
633 std::pair<onu_deactivate_complete_result, bool> result = deact_result.pop(ONU_DEACTIVATE_COMPLETE_WAIT_TIMEOUT);
634 if (result.second == false) {
635 OPENOLT_LOG(ERROR, openolt_log_id, "timeout waiting for onu deactivate complete indication intf_id %d, onu_id %d\n",
636 intf_id, onu_id);
637 // Invalidate the queue pointer.
638 bcmos_fastlock_lock(&onu_deactivate_wait_lock);
639 onu_deact_compltd_map[k] = NULL;
640 bcmos_fastlock_unlock(&onu_deactivate_wait_lock, 0);
641 err = BCM_ERR_INTERNAL;
642 }
643 else if (result.first.result == BCMOLT_RESULT_FAIL) {
644 OPENOLT_LOG(ERROR, openolt_log_id, "error processing onu deactivate request intf_id %d, onu_id %d, fail_reason %d\n",
645 intf_id, onu_id, result.first.reason);
646 err = BCM_ERR_INTERNAL;
647 } else if (result.first.result == BCMOLT_RESULT_SUCCESS) {
648 OPENOLT_LOG(INFO, openolt_log_id, "success processing onu deactivate request intf_id %d, onu_id %d\n",
649 intf_id, onu_id);
650 }
651
652 // Remove entry from map
653 bcmos_fastlock_lock(&onu_deactivate_wait_lock);
654 onu_deact_compltd_map.erase(k);
655 bcmos_fastlock_unlock(&onu_deactivate_wait_lock, 0);
656
Girish Gowdraddf9a162020-01-27 12:56:27 +0530657 return err;
658}
659
660char* openolt_read_sysinfo(const char* field_name, char* field_val)
661{
662 FILE *fp;
663 /* Prepare the command*/
664 char command[150];
665
666 snprintf(command, sizeof command, "bash -l -c \"onlpdump -s\" | perl -ne 'print $1 if /%s: (\\S+)/'", field_name);
667 /* Open the command for reading. */
668 fp = popen(command, "r");
669 if (fp == NULL) {
670 /*The client has to check for a Null field value in this case*/
671 OPENOLT_LOG(INFO, openolt_log_id, "Failed to query the %s\n", field_name);
672 return field_val;
673 }
674
675 /*Read the field value*/
676 if (fp) {
677 uint8_t ret;
678 ret = fread(field_val, OPENOLT_FIELD_LEN, 1, fp);
679 if (ret >= OPENOLT_FIELD_LEN)
680 OPENOLT_LOG(INFO, openolt_log_id, "Read data length %u\n", ret);
681 pclose(fp);
682 }
683 return field_val;
684}
685
686Status pushOltOperInd(uint32_t intf_id, const char *type, const char *state)
687{
Girish Gowdra252f4972020-09-07 21:24:01 -0700688 ::openolt::Indication ind;
689 ::openolt::IntfOperIndication* intf_oper_ind = new ::openolt::IntfOperIndication;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530690
691 intf_oper_ind->set_type(type);
692 intf_oper_ind->set_intf_id(intf_id);
693 intf_oper_ind->set_oper_state(state);
694 ind.set_allocated_intf_oper_ind(intf_oper_ind);
695 oltIndQ.push(ind);
696 return Status::OK;
697}
698
699#define CLI_HOST_PROMPT_FORMAT "BCM.%u> "
700
701/* Build CLI prompt */
702void openolt_cli_get_prompt_cb(bcmcli_session *session, char *buf, uint32_t max_len)
703{
704 snprintf(buf, max_len, CLI_HOST_PROMPT_FORMAT, dev_id);
705}
706
707int _bal_apiend_cli_thread_handler(long data)
708{
709 char init_string[]="\n";
710 bcmcli_session *sess = current_session;
711 bcmos_task_parm bal_cli_task_p_dummy;
712
713 /* Switch to interactive mode if not stopped in the init script */
714 if (!bcmcli_is_stopped(sess)) {
715 /* Force a CLI command prompt
716 * The string passed into the parse function
717 * must be modifiable, so a string constant like
718 * bcmcli_parse(current_session, "\n") will not
719 * work.
720 */
721 bcmcli_parse(sess, init_string);
722
723 /* Process user input until EOF or quit command */
724 bcmcli_driver(sess);
725 }
726 OPENOLT_LOG(INFO, openolt_log_id, "BAL API End CLI terminated\n");
727
728 /* Cleanup */
729 bcmcli_session_close(current_session);
730 bcmcli_token_destroy(NULL);
731 return 0;
732}
733
734/* Init API CLI commands for the current device */
735bcmos_errno bcm_openolt_api_cli_init(bcmcli_entry *parent_dir, bcmcli_session *session)
736{
737 bcmos_errno rc;
738
739 api_parent_dir = parent_dir;
740
741 rc = bcm_api_cli_set_commands(session);
742
743#ifdef BCM_SUBSYSTEM_HOST
744 /* Subscribe for device change indication */
745 rc = rc ? rc : bcmolt_olt_sel_ind_register(_api_cli_olt_change_ind);
746#endif
747
748 return rc;
749}
750
751bcmos_errno bcm_cli_quit(bcmcli_session *session, const bcmcli_cmd_parm parm[], uint16_t n_parms)
752{
753 bcmcli_stop(session);
754 bcmcli_session_print(session, "CLI terminated by 'Quit' command\n");
755 status_bcm_cli_quit = BCMOS_TRUE;
756
757 return BCM_ERR_OK;
758}
759
760int get_status_bcm_cli_quit(void) {
761 return status_bcm_cli_quit;
762}
763
764bcmos_errno bcmolt_apiend_cli_init() {
765 bcmos_errno ret;
766 bcmos_task_parm bal_cli_task_p = {};
767 bcmos_task_parm bal_cli_task_p_dummy;
768
769 /** before creating the task, check if it is already created by the other half of BAL i.e. Core side */
770 if (BCM_ERR_OK != bcmos_task_query(&bal_cli_thread, &bal_cli_task_p_dummy)) {
771 /* Create BAL CLI thread */
772 bal_cli_task_p.name = bal_cli_thread_name;
773 bal_cli_task_p.handler = _bal_apiend_cli_thread_handler;
774 bal_cli_task_p.priority = TASK_PRIORITY_CLI;
775
776 ret = bcmos_task_create(&bal_cli_thread, &bal_cli_task_p);
777 if (BCM_ERR_OK != ret) {
778 bcmos_printf("Couldn't create BAL API end CLI thread\n");
779 return ret;
780 }
781 }
782}
783
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530784bcmos_errno get_onu_status(bcmolt_interface pon_ni, int onu_id, bcmolt_onu_state *onu_state) {
785 bcmos_errno err;
786 bcmolt_onu_cfg onu_cfg;
787 bcmolt_onu_key onu_key;
788 onu_key.pon_ni = pon_ni;
789 onu_key.onu_id = onu_id;
790
791 BCMOLT_CFG_INIT(&onu_cfg, onu, onu_key);
792 BCMOLT_FIELD_SET_PRESENT(&onu_cfg.data, onu_cfg_data, onu_state);
793 BCMOLT_FIELD_SET_PRESENT(&onu_cfg.data, onu_cfg_data, itu);
794 #ifdef TEST_MODE
795 // It is impossible to mock the setting of onu_cfg.data.onu_state because
796 // the actual bcmolt_cfg_get passes the address of onu_cfg.hdr and we cannot
797 // set the onu_cfg.data.onu_state. So a new stub function is created and address
798 // of onu_cfg is passed. This is one-of case where we need to add test specific
799 // code in production code.
800 err = bcmolt_cfg_get__onu_state_stub(dev_id, &onu_cfg);
801 #else
802 err = bcmolt_cfg_get(dev_id, &onu_cfg.hdr);
803 #endif
804 *onu_state = onu_cfg.data.onu_state;
805 return err;
806}
807
808bcmos_errno get_pon_interface_status(bcmolt_interface pon_ni, bcmolt_interface_state *state, bcmolt_status *los_status) {
Girish Gowdraddf9a162020-01-27 12:56:27 +0530809 bcmos_errno err;
810 bcmolt_pon_interface_key pon_key;
811 bcmolt_pon_interface_cfg pon_cfg;
812 pon_key.pon_ni = pon_ni;
813
814 BCMOLT_CFG_INIT(&pon_cfg, pon_interface, pon_key);
815 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, state);
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530816 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, los_status);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530817 BCMOLT_FIELD_SET_PRESENT(&pon_cfg.data, pon_interface_cfg_data, itu);
818 #ifdef TEST_MODE
819 // It is impossible to mock the setting of pon_cfg.data.state because
820 // the actual bcmolt_cfg_get passes the address of pon_cfg.hdr and we cannot
821 // set the pon_cfg.data.state. So a new stub function is created and address
822 // of pon_cfg is passed. This is one-of case where we need to add test specific
823 // code in production code.
824 err = bcmolt_cfg_get__pon_intf_stub(dev_id, &pon_cfg);
825 #else
826 err = bcmolt_cfg_get(dev_id, &pon_cfg.hdr);
827 #endif
828 *state = pon_cfg.data.state;
Thiyagarajan Subramaniad463232020-02-28 19:10:43 +0530829 *los_status = pon_cfg.data.los_status;
Girish Gowdraddf9a162020-01-27 12:56:27 +0530830 return err;
831}
832
833/* Same as bcmolt_cfg_get but with added logic of retrying the API
834 in case of some specific failures like timeout or object not yet ready
835*/
836bcmos_errno bcmolt_cfg_get_mult_retry(bcmolt_oltid olt, bcmolt_cfg *cfg) {
837 bcmos_errno err;
838 uint32_t current_try = 0;
839
840 while (current_try < MAX_BAL_API_RETRY_COUNT) {
841 err = bcmolt_cfg_get(olt, cfg);
842 current_try++;
843
844 if (err == BCM_ERR_STATE || err == BCM_ERR_TIMEOUT) {
845 OPENOLT_LOG(WARNING, openolt_log_id, "bcmolt_cfg_get: err = %s\n", bcmos_strerror(err));
846 bcmos_usleep(BAL_API_RETRY_TIME_IN_USECS);
847 continue;
848 }
849 else {
850 break;
851 }
852 }
853
854 if (err != BCM_ERR_OK) {
855 OPENOLT_LOG(ERROR, openolt_log_id, "bcmolt_cfg_get tried (%d) times with retry time(%d usecs) err = %s\n",
856 current_try,
857 BAL_API_RETRY_TIME_IN_USECS,
858 bcmos_strerror(err));
859 }
860 return err;
861}
862
863
864unsigned NumNniIf_() {return num_of_nni_ports;}
865unsigned NumPonIf_() {return num_of_pon_ports;}
866
867bcmos_errno get_nni_interface_status(bcmolt_interface id, bcmolt_interface_state *state) {
868 bcmos_errno err;
869 bcmolt_nni_interface_key nni_key;
870 bcmolt_nni_interface_cfg nni_cfg;
871 nni_key.id = id;
872
873 BCMOLT_CFG_INIT(&nni_cfg, nni_interface, nni_key);
874 BCMOLT_FIELD_SET_PRESENT(&nni_cfg.data, nni_interface_cfg_data, state);
875 #ifdef TEST_MODE
876 // It is impossible to mock the setting of nni_cfg.data.state because
877 // the actual bcmolt_cfg_get passes the address of nni_cfg.hdr and we cannot
878 // set the nni_cfg.data.state. So a new stub function is created and address
879 // of nni_cfg is passed. This is one-of case where we need to add test specific
880 // code in production code.
881 err = bcmolt_cfg_get__nni_intf_stub(dev_id, &nni_cfg);
882 #else
883 err = bcmolt_cfg_get(dev_id, &nni_cfg.hdr);
884 #endif
885 *state = nni_cfg.data.state;
886 return err;
887}
888
889Status install_gem_port(int32_t intf_id, int32_t onu_id, int32_t gemport_id) {
890 bcmos_errno err;
891 bcmolt_itupon_gem_cfg cfg; /* declare main API struct */
892 bcmolt_itupon_gem_key key = {}; /* declare key */
893 bcmolt_gem_port_configuration configuration = {};
894
895 key.pon_ni = intf_id;
896 key.gem_port_id = gemport_id;
897
898 BCMOLT_CFG_INIT(&cfg, itupon_gem, key);
899
900 bcmolt_gem_port_direction configuration_direction;
901 configuration_direction = BCMOLT_GEM_PORT_DIRECTION_BIDIRECTIONAL;
902 BCMOLT_FIELD_SET(&configuration, gem_port_configuration, direction, configuration_direction);
903
904 bcmolt_gem_port_type configuration_type;
905 configuration_type = BCMOLT_GEM_PORT_TYPE_UNICAST;
906 BCMOLT_FIELD_SET(&configuration, gem_port_configuration, type, configuration_type);
907
908 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, configuration, configuration);
909
910 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, onu_id, onu_id);
911
912 bcmolt_control_state encryption_mode;
913 encryption_mode = BCMOLT_CONTROL_STATE_DISABLE;
914 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, encryption_mode, encryption_mode);
915
916 bcmolt_us_gem_port_destination upstream_destination_queue;
917 upstream_destination_queue = BCMOLT_US_GEM_PORT_DESTINATION_DATA;
918 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, upstream_destination_queue, upstream_destination_queue);
919
920 bcmolt_control_state control;
921 control = BCMOLT_CONTROL_STATE_ENABLE;
922 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, control, control);
923
924 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
925 if(err != BCM_ERR_OK) {
Burak Gurdaga0523592021-02-24 15:17:47 +0000926 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 +0530927 return bcm_to_grpc_err(err, "Access_Control set ITU PON Gem port failed");
928 }
929
930 OPENOLT_LOG(INFO, openolt_log_id, "gem port installed successfully = %d\n", gemport_id);
931
932 return Status::OK;
933}
934
935Status remove_gem_port(int32_t intf_id, int32_t gemport_id) {
936 bcmolt_itupon_gem_cfg gem_cfg;
937 bcmolt_itupon_gem_key key = {
938 .pon_ni = (bcmolt_interface)intf_id,
939 .gem_port_id = (bcmolt_gem_port_id)gemport_id
940 };
941 bcmos_errno err;
942
943 BCMOLT_CFG_INIT(&gem_cfg, itupon_gem, key);
944 err = bcmolt_cfg_clear(dev_id, &gem_cfg.hdr);
945 if (err != BCM_ERR_OK)
946 {
Burak Gurdaga0523592021-02-24 15:17:47 +0000947 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 +0530948 return bcm_to_grpc_err(err, "Access_Control clear ITU PON Gem port failed");
949 }
950
951 OPENOLT_LOG(INFO, openolt_log_id, "gem port removed successfully = %d\n", gemport_id);
952
953 return Status::OK;
954}
955
Burak Gurdaga0523592021-02-24 15:17:47 +0000956Status enable_encryption_for_gem_port(int32_t intf_id, int32_t gemport_id) {
957 bcmos_errno err;
958 bcmolt_itupon_gem_cfg cfg;
959 bcmolt_itupon_gem_key key = {
960 .pon_ni = (bcmolt_interface)intf_id,
961 .gem_port_id = (bcmolt_gem_port_id)gemport_id
962 };
963
964 BCMOLT_CFG_INIT(&cfg, itupon_gem, key);
965
966 bcmolt_control_state encryption_mode;
967 encryption_mode = BCMOLT_CONTROL_STATE_ENABLE;
968 BCMOLT_FIELD_SET(&cfg.data, itupon_gem_cfg_data, encryption_mode, encryption_mode);
969
970 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
971 if(err != BCM_ERR_OK) {
972 OPENOLT_LOG(ERROR, openolt_log_id, "failed to set encryption on pon = %d gem_port = %d, err = %s (%d)\n",
973 intf_id, gemport_id, cfg.hdr.hdr.err_text, err);
974 return bcm_to_grpc_err(err, "Failed to set encryption on GEM port");;
975 }
976
977 OPENOLT_LOG(INFO, openolt_log_id, "encryption set successfully on pon = %d gem_port = %d\n", intf_id, gemport_id);
978
979 return Status::OK;
980}
981
Girish Gowdraddf9a162020-01-27 12:56:27 +0530982Status update_acl_interface(int32_t intf_id, bcmolt_interface_type intf_type, uint32_t access_control_id,
983 bcmolt_members_update_command acl_cmd) {
984 bcmos_errno err;
985 bcmolt_access_control_interfaces_update oper; /* declare main API struct */
986 bcmolt_access_control_key acl_key = {}; /* declare key */
987 bcmolt_intf_ref interface_ref_list_elem = {};
988 bcmolt_interface_type interface_ref_list_elem_intf_type;
989 bcmolt_interface_id interface_ref_list_elem_intf_id;
990 bcmolt_intf_ref_list_u8 interface_ref_list = {};
991
992 if (acl_cmd != BCMOLT_MEMBERS_UPDATE_COMMAND_ADD && acl_cmd != BCMOLT_MEMBERS_UPDATE_COMMAND_REMOVE) {
993 OPENOLT_LOG(ERROR, openolt_log_id, "acl cmd = %d not supported currently\n", acl_cmd);
994 return bcm_to_grpc_err(BCM_ERR_PARM, "unsupported acl cmd");
995 }
996 interface_ref_list.arr = (bcmolt_intf_ref*)bcmos_calloc(sizeof(bcmolt_intf_ref)*1);
997
998 if (interface_ref_list.arr == NULL)
999 return bcm_to_grpc_err(BCM_ERR_PARM, "allocate interface_ref_list failed");
1000 OPENOLT_LOG(INFO, openolt_log_id, "update acl interface received for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1001 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1002 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1003
1004 acl_key.id = access_control_id;
1005
1006 /* Initialize the API struct. */
1007 BCMOLT_OPER_INIT(&oper, access_control, interfaces_update, acl_key);
1008
1009 bcmolt_members_update_command command;
1010 command = acl_cmd;
1011 BCMOLT_FIELD_SET(&oper.data, access_control_interfaces_update_data, command, command);
1012
1013 interface_ref_list_elem_intf_type = intf_type;
1014 BCMOLT_FIELD_SET(&interface_ref_list_elem, intf_ref, intf_type, interface_ref_list_elem_intf_type);
1015
1016 interface_ref_list_elem_intf_id = intf_id;
1017 BCMOLT_FIELD_SET(&interface_ref_list_elem, intf_ref, intf_id, interface_ref_list_elem_intf_id);
1018
1019 interface_ref_list.len = 1;
1020 BCMOLT_ARRAY_ELEM_SET(&interface_ref_list, 0, interface_ref_list_elem);
1021
1022 BCMOLT_FIELD_SET(&oper.data, access_control_interfaces_update_data, interface_ref_list, interface_ref_list);
1023
1024 err = bcmolt_oper_submit(dev_id, &oper.hdr);
1025 if (err != BCM_ERR_OK) {
1026 OPENOLT_LOG(ERROR, openolt_log_id, "update acl interface fail for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1027 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1028 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1029 return bcm_to_grpc_err(err, "Access_Control submit interface failed");
1030 }
1031
1032 bcmos_free(interface_ref_list.arr);
1033 OPENOLT_LOG(INFO, openolt_log_id, "update acl interface success for intf_id = %d, intf_type = %s, acl_id = %d, acl_cmd = %s\n",
1034 intf_id, intf_type == BCMOLT_INTERFACE_TYPE_PON? "pon": "nni", access_control_id,
1035 acl_cmd == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD? "add": "remove");
1036
1037 return Status::OK;
1038}
1039
1040Status install_acl(const acl_classifier_key acl_key) {
Girish Gowdraddf9a162020-01-27 12:56:27 +05301041 bcmos_errno err;
1042 bcmolt_access_control_cfg cfg;
1043 bcmolt_access_control_key key = { };
1044 bcmolt_classifier c_val = { };
1045 // hardcode the action for now.
1046 bcmolt_access_control_fwd_action_type action_type = BCMOLT_ACCESS_CONTROL_FWD_ACTION_TYPE_TRAP_TO_HOST;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301047 int acl_id = get_acl_id();
1048 if (acl_id < 0) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001049 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",
1050 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 +05301051 return bcm_to_grpc_err(BCM_ERR_INTERNAL, "exhausted acl id");
1052 }
1053
1054 key.id = acl_id;
1055 /* config access control instance */
1056 BCMOLT_CFG_INIT(&cfg, access_control, key);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301057 if (acl_key.ether_type > 0) {
1058 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify ether_type 0x%04x\n", acl_key.ether_type);
1059 BCMOLT_FIELD_SET(&c_val, classifier, ether_type, acl_key.ether_type);
1060 }
1061
1062 if (acl_key.ip_proto > 0) {
1063 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify ip_proto %d\n", acl_key.ip_proto);
1064 BCMOLT_FIELD_SET(&c_val, classifier, ip_proto, acl_key.ip_proto);
1065 }
1066
1067 if (acl_key.dst_port > 0) {
1068 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify dst_port %d\n", acl_key.dst_port);
1069 BCMOLT_FIELD_SET(&c_val, classifier, dst_port, acl_key.dst_port);
1070 }
1071
1072 if (acl_key.src_port > 0) {
1073 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify src_port %d\n", acl_key.src_port);
1074 BCMOLT_FIELD_SET(&c_val, classifier, src_port, acl_key.src_port);
1075 }
1076
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001077 // Make sure that max_acls_with_vlan_classifiers_hit is not true to consider o_vid for ACL classification.
1078 if (acl_key.o_vid > 0 && acl_key.o_vid != ANY_VLAN && !max_acls_with_vlan_classifiers_hit) {
1079 OPENOLT_LOG(DEBUG, openolt_log_id, "Access_Control classify o_vid %d\n", acl_key.o_vid);
1080 BCMOLT_FIELD_SET(&c_val, classifier, o_vid, acl_key.o_vid);
1081 }
1082
Girish Gowdraddf9a162020-01-27 12:56:27 +05301083 BCMOLT_MSG_FIELD_SET(&cfg, classifier, c_val);
1084 BCMOLT_MSG_FIELD_SET(&cfg, priority, 10000);
1085 BCMOLT_MSG_FIELD_SET(&cfg, statistics_control, BCMOLT_CONTROL_STATE_ENABLE);
1086
1087 BCMOLT_MSG_FIELD_SET(&cfg, forwarding_action.action, action_type);
1088
1089 err = bcmolt_cfg_set(dev_id, &cfg.hdr);
1090 if (err != BCM_ERR_OK) {
1091 OPENOLT_LOG(ERROR, openolt_log_id, "Access_Control set configuration failed, Error %d\n", err);
1092 // Free the acl_id
1093 free_acl_id(acl_id);
1094 return bcm_to_grpc_err(err, "Access_Control set configuration failed");
1095 }
1096
1097 ACL_LOG(INFO, "ACL add ok", err);
1098
1099 // Update the map that we have installed an acl for the given classfier.
1100 acl_classifier_to_acl_id_map[acl_key] = acl_id;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001101 // 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
1102 // After max_acls_with_vlan_classifiers_hit is set to true no more ACLs can have vlan as an ACL classifier.
1103 if (acl_key.o_vid > 0 && acl_key.o_vid != ANY_VLAN && acl_id >= MAX_ACL_WITH_VLAN_CLASSIFIER) {
1104 max_acls_with_vlan_classifiers_hit = true;
1105 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301106 return Status::OK;
1107}
1108
1109Status remove_acl(int acl_id) {
1110 bcmos_errno err;
1111 bcmolt_access_control_cfg cfg; /* declare main API struct */
1112 bcmolt_access_control_key key = {}; /* declare key */
1113
1114 key.id = acl_id;
1115
1116 /* Initialize the API struct. */
1117 BCMOLT_CFG_INIT(&cfg, access_control, key);
1118 BCMOLT_FIELD_SET_PRESENT(&cfg.data, access_control_cfg_data, state);
1119 err = bcmolt_cfg_get(dev_id, &cfg.hdr);
1120 if (err != BCM_ERR_OK) {
1121 OPENOLT_LOG(ERROR, openolt_log_id, "Access_Control get state failed\n");
1122 return bcm_to_grpc_err(err, "Access_Control get state failed");
1123 }
1124
1125 if (cfg.data.state == BCMOLT_CONFIG_STATE_CONFIGURED) {
1126 key.id = acl_id;
1127 /* Initialize the API struct. */
1128 BCMOLT_CFG_INIT(&cfg, access_control, key);
1129
1130 err = bcmolt_cfg_clear(dev_id, &cfg.hdr);
1131 if (err != BCM_ERR_OK) {
1132 // Should we free acl_id here ? We should ideally never land here..
1133 OPENOLT_LOG(ERROR, openolt_log_id, "Error %d while removing Access_Control rule ID %d\n",
1134 err, acl_id);
1135 return Status(grpc::StatusCode::INTERNAL, "Failed to remove Access_Control");
1136 }
1137 }
1138
1139 // Free up acl_id
1140 free_acl_id(acl_id);
1141
1142 OPENOLT_LOG(INFO, openolt_log_id, "acl removed successfully %d\n", acl_id);
1143
1144 return Status::OK;
1145}
1146
1147// Formulates ACL Classifier Key based on the following fields
1148// a. ether_type b. ip_proto c. src_port d. dst_port
1149// If any of the field is not available it is populated as -1.
1150void formulate_acl_classifier_key(acl_classifier_key *key, const ::openolt::Classifier& classifier) {
1151
1152 // TODO: Is 0 a valid value for any of the following classifiers?
1153 // because in the that case, the 'if' check would fail and -1 would be filled as value.
1154 //
1155 if (classifier.eth_type()) {
1156 OPENOLT_LOG(DEBUG, openolt_log_id, "classify ether_type 0x%04x\n", classifier.eth_type());
1157 key->ether_type = classifier.eth_type();
1158 } else key->ether_type = -1;
1159
1160 if (classifier.ip_proto()) {
1161 OPENOLT_LOG(DEBUG, openolt_log_id, "classify ip_proto %d\n", classifier.ip_proto());
1162 key->ip_proto = classifier.ip_proto();
1163 } else key->ip_proto = -1;
1164
1165
1166 if (classifier.src_port()) {
1167 OPENOLT_LOG(DEBUG, openolt_log_id, "classify src_port %d\n", classifier.src_port());
1168 key->src_port = classifier.src_port();
1169 } else key->src_port = -1;
1170
1171
1172 if (classifier.dst_port()) {
1173 OPENOLT_LOG(DEBUG, openolt_log_id, "classify dst_port %d\n", classifier.dst_port());
1174 key->dst_port = classifier.dst_port();
1175 } else key->dst_port = -1;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001176
1177 // We should also check the max_acls_with_vlan_classifiers_hit flag is not false to consider the vlan for flow classifier key
1178 if (classifier.o_vid() && !max_acls_with_vlan_classifiers_hit) {
1179 OPENOLT_LOG(DEBUG, openolt_log_id, "classify o_vid %d\n", classifier.o_vid());
1180 key->o_vid = classifier.o_vid();
1181 } else key->o_vid = ANY_VLAN;
1182
Girish Gowdraddf9a162020-01-27 12:56:27 +05301183}
1184
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001185Status handle_acl_rule_install(int32_t onu_id, uint64_t flow_id, int32_t gemport_id,
Girish Gowdraddf9a162020-01-27 12:56:27 +05301186 const std::string flow_type, int32_t access_intf_id,
Girish Gowdra252f4972020-09-07 21:24:01 -07001187 int32_t network_intf_id,
Girish Gowdraddf9a162020-01-27 12:56:27 +05301188 const ::openolt::Classifier& classifier) {
1189 int acl_id;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001190 uint32_t intf_id = flow_type.compare(upstream) == 0? access_intf_id: network_intf_id;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301191 const std::string intf_type = flow_type.compare(upstream) == 0? "pon": "nni";
1192 bcmolt_interface_type olt_if_type = intf_type == "pon"? BCMOLT_INTERFACE_TYPE_PON: BCMOLT_INTERFACE_TYPE_NNI;
1193
1194 Status resp;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001195 trap_to_host_packet_type pkt_type = get_trap_to_host_packet_type(classifier);
1196 if (pkt_type == unsupported_trap_to_host_pkt_type) {
1197 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported pkt trap type");
1198 return Status(grpc::StatusCode::UNIMPLEMENTED, "unsupported pkt trap type");
1199 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301200
1201 // few map keys we are going to use later.
1202 flow_id_flow_direction fl_id_fl_dir(flow_id, flow_type);
Girish Gowdra252f4972020-09-07 21:24:01 -07001203
Girish Gowdraddf9a162020-01-27 12:56:27 +05301204 acl_classifier_key acl_key;
1205 formulate_acl_classifier_key(&acl_key, classifier);
1206 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 -07001207 .src_port=acl_key.src_port, .dst_port=acl_key.dst_port, .o_vid=acl_key.o_vid};
1208 bcmos_fastlock_lock(&acl_packet_trap_handler_lock);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301209
1210 // Check if the acl is already installed
1211 if (acl_classifier_to_acl_id_map.count(acl_key_const) > 0) {
1212 // retreive the acl_id
1213 acl_id = acl_classifier_to_acl_id_map[acl_key_const];
Girish Gowdra252f4972020-09-07 21:24:01 -07001214
1215
Girish Gowdraddf9a162020-01-27 12:56:27 +05301216 if (flow_to_acl_map.count(fl_id_fl_dir)) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001217 // could happen if same trap flow is received again
Girish Gowdraddf9a162020-01-27 12:56:27 +05301218 OPENOLT_LOG(INFO, openolt_log_id, "flow and related acl already handled, nothing more to do\n");
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001219 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301220 return Status::OK;
1221 }
1222
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001223 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",
1224 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 +05301225
1226 // The acl_ref_cnt is needed to know how many flows refer an ACL.
1227 // When the flow is removed, we decrement the reference count.
1228 // When the reference count becomes 0, we remove the ACL.
1229 if (acl_ref_cnt.count(acl_id) > 0) {
1230 acl_ref_cnt[acl_id] ++;
1231 } else {
1232 // We should ideally not land here. The acl_ref_cnt should have been
1233 // initialized the first time acl was installed.
1234 acl_ref_cnt[acl_id] = 1;
1235 }
1236
1237 } else {
1238 resp = install_acl(acl_key_const);
1239 if (!resp.ok()) {
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001240 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",
1241 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);
1242 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301243 return resp;
1244 }
1245
1246 acl_id = acl_classifier_to_acl_id_map[acl_key_const];
1247
1248 // Initialize the acl reference count
1249 acl_ref_cnt[acl_id] = 1;
1250
Girish Gowdra252f4972020-09-07 21:24:01 -07001251 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 +05301252 }
1253
1254 // Register the interface for the given acl
1255 acl_id_intf_id_intf_type ac_id_inf_id_inf_type(acl_id, intf_id, intf_type);
1256 // This is needed to keep a track of which interface (pon/nni) has registered for an ACL.
1257 // If it is registered, how many flows refer to it.
1258 if (intf_acl_registration_ref_cnt.count(ac_id_inf_id_inf_type) > 0) {
1259 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type]++;
1260 } else {
1261 // The given interface is not registered for the ACL. We need to do it now.
1262 resp = update_acl_interface(intf_id, olt_if_type, acl_id, BCMOLT_MEMBERS_UPDATE_COMMAND_ADD);
1263 if (!resp.ok()){
1264 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);
1265 // TODO: Ideally we should return error from hear and clean up other other stateful
1266 // counters we creaed earlier. Will leave it out for now.
Girish Gowdra252f4972020-09-07 21:24:01 -07001267 }
Girish Gowdraddf9a162020-01-27 12:56:27 +05301268 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type] = 1;
1269 }
1270
Girish Gowdra252f4972020-09-07 21:24:01 -07001271 acl_id_intf_id ac_id_if_id(acl_id, intf_id);
1272 flow_to_acl_map[fl_id_fl_dir] = ac_id_if_id;
Girish Gowdraddf9a162020-01-27 12:56:27 +05301273
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001274 // Populate the trap_to_host_pkt_info_with_vlan corresponding to the trap-to-host voltha flow_id key.
1275 // When the trap-to-host voltha flow-id is being removed, this entry is cleared too from the map.
1276 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());
1277 trap_to_host_pkt_info_with_vlan_for_flow_id[flow_id] = pkt_info_with_vlan;
1278 trap_to_host_pkt_info pkt_info((int32_t)olt_if_type, intf_id, (int32_t)pkt_type, gemport_id);
1279 bool duplicate = false;
1280 // Check if the vlan_id corresponding to the trap_to_host_pkt_info key is found. Set the 'duplicate' flag accordingly.
1281 if (trap_to_host_vlan_ids_for_trap_to_host_pkt_info.count(pkt_info) > 0) {
1282 auto& vlan_id_list = trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info];
1283 auto it = std::find(vlan_id_list.begin(), vlan_id_list.end(), acl_key.o_vid);
1284 if (it != vlan_id_list.end()) {
1285 OPENOLT_LOG(DEBUG, openolt_log_id, "cvid = %d exists already in list", acl_key.o_vid);
1286 duplicate = true;
1287 }
1288 }
1289 // If the vlan_id is not found corresponding to the trap_to_host_pkt_info key, update it.
1290 // This will be used to validate the vlan_id in the trapped packet. If vlan_id in the
1291 // trapped packet is not match with the stored value, packet is dropped.
1292 if (!duplicate) {
1293 trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info].push_back(acl_key.o_vid);
1294 }
1295
1296 bcmos_fastlock_unlock(&acl_packet_trap_handler_lock, 0);
Girish Gowdraddf9a162020-01-27 12:56:27 +05301297
1298 return Status::OK;
1299}
1300
Girish Gowdra252f4972020-09-07 21:24:01 -07001301Status handle_acl_rule_cleanup(int16_t acl_id, int32_t intf_id, const std::string flow_type) {
Girish Gowdraddf9a162020-01-27 12:56:27 +05301302 const std::string intf_type= flow_type.compare(upstream) == 0 ? "pon": "nni";
1303 acl_id_intf_id_intf_type ac_id_inf_id_inf_type(acl_id, intf_id, intf_type);
1304 intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type]--;
1305 if (intf_acl_registration_ref_cnt[ac_id_inf_id_inf_type] == 0) {
1306 bcmolt_interface_type olt_if_type = intf_type == "pon"? BCMOLT_INTERFACE_TYPE_PON: BCMOLT_INTERFACE_TYPE_NNI;
1307 Status resp = update_acl_interface(intf_id, olt_if_type, acl_id, BCMOLT_MEMBERS_UPDATE_COMMAND_REMOVE);
1308 if (!resp.ok()){
1309 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);
1310 }
1311 intf_acl_registration_ref_cnt.erase(ac_id_inf_id_inf_type);
1312 }
1313
1314 acl_ref_cnt[acl_id]--;
1315 if (acl_ref_cnt[acl_id] == 0) {
1316 remove_acl(acl_id);
1317 acl_ref_cnt.erase(acl_id);
1318 // Iterate acl_classifier_to_acl_id_map and delete classifier the key corresponding to acl_id
1319 std::map<acl_classifier_key, uint16_t>::iterator it;
1320 for (it=acl_classifier_to_acl_id_map.begin(); it!=acl_classifier_to_acl_id_map.end(); ++it) {
1321 if (it->second == acl_id) {
1322 OPENOLT_LOG(INFO, openolt_log_id, "cleared classifier key corresponding to acl_id = %d\n", acl_id);
1323 acl_classifier_to_acl_id_map.erase(it->first);
1324 break;
1325 }
1326 }
1327 }
1328
Girish Gowdraddf9a162020-01-27 12:56:27 +05301329 return Status::OK;
1330}
1331
1332Status check_bal_ready() {
1333 bcmos_errno err;
1334 int maxTrials = 30;
1335 bcmolt_olt_cfg olt_cfg = { };
1336 bcmolt_olt_key olt_key = { };
1337
1338 BCMOLT_CFG_INIT(&olt_cfg, olt, olt_key);
1339 BCMOLT_MSG_FIELD_GET(&olt_cfg, bal_state);
1340
1341 while (olt_cfg.data.bal_state != BCMOLT_BAL_STATE_BAL_AND_SWITCH_READY) {
1342 if (--maxTrials == 0)
1343 return grpc::Status(grpc::StatusCode::UNAVAILABLE, "check bal ready failed");
1344 sleep(5);
1345 #ifdef TEST_MODE
1346 // It is impossible to mock the setting of olt_cfg.data.bal_state because
1347 // the actual bcmolt_cfg_get passes the address of olt_cfg.hdr and we cannot
1348 // set the olt_cfg.data.bal_state. So a new stub function is created and address
1349 // of olt_cfg is passed. This is one-of case where we need to add test specific
1350 // code in production code.
1351 if (bcmolt_cfg_get__bal_state_stub(dev_id, &olt_cfg)) {
1352 #else
1353 if (bcmolt_cfg_get(dev_id, &olt_cfg.hdr)) {
1354 #endif
1355 continue;
1356 }
1357 else
1358 OPENOLT_LOG(INFO, openolt_log_id, "waiting for BAL ready ...\n");
1359 }
1360
1361 OPENOLT_LOG(INFO, openolt_log_id, "BAL is ready\n");
1362 return Status::OK;
1363}
1364
1365Status check_connection() {
1366 int maxTrials = 60;
1367 while (!bcmolt_api_conn_mgr_is_connected(dev_id)) {
1368 sleep(1);
1369 if (--maxTrials == 0)
1370 return grpc::Status(grpc::StatusCode::UNAVAILABLE, "check connection failed");
1371 else
1372 OPENOLT_LOG(INFO, openolt_log_id, "waiting for daemon connection ...\n");
1373 }
1374 OPENOLT_LOG(INFO, openolt_log_id, "daemon is connected\n");
1375 return Status::OK;
1376}
1377
Thiyagarajan Subramani03bc66f2020-04-01 15:58:53 +05301378std::string get_ip_address(const char* nw_intf){
1379 std::string ipAddress = "0.0.0.0";
1380 struct ifaddrs *interfaces = NULL;
1381 struct ifaddrs *temp_addr = NULL;
1382 int success = 0;
1383 /* retrieve the current interfaces - returns 0 on success */
1384 success = getifaddrs(&interfaces);
1385 if (success == 0) {
1386 /* Loop through linked list of interfaces */
1387 temp_addr = interfaces;
1388 while(temp_addr != NULL) {
1389 if(temp_addr->ifa_addr->sa_family == AF_INET) {
1390 /* Check if interface given present in OLT, if yes return its IP Address */
1391 if(strcmp(temp_addr->ifa_name, nw_intf) == 0){
1392 ipAddress=inet_ntoa(((struct sockaddr_in*)temp_addr->ifa_addr)->sin_addr);
1393 break;
1394 }
1395 }
1396 temp_addr = temp_addr->ifa_next;
1397 }
1398 }
1399 /* Free memory */
1400 freeifaddrs(interfaces);
1401 return ipAddress;
1402}
Jason Huang1d9cfce2020-05-20 22:58:47 +08001403
1404bcmos_errno getOnuMaxLogicalDistance(uint32_t intf_id, uint32_t *mld) {
1405 bcmos_errno err = BCM_ERR_OK;
1406 bcmolt_pon_distance pon_distance = {};
1407 bcmolt_pon_interface_cfg pon_cfg; /* declare main API struct */
1408 bcmolt_pon_interface_key key = {}; /* declare key */
1409
1410 key.pon_ni = intf_id;
1411
1412 if (!state.is_activated()) {
1413 OPENOLT_LOG(ERROR, openolt_log_id, "ONU maximum logical distance is not available since OLT is not activated yet\n");
1414 return BCM_ERR_STATE;
1415 }
1416
1417 /* Initialize the API struct. */
1418 BCMOLT_CFG_INIT(&pon_cfg, pon_interface, key);
1419 BCMOLT_FIELD_SET_PRESENT(&pon_distance, pon_distance, max_log_distance);
1420 BCMOLT_FIELD_SET(&pon_cfg.data, pon_interface_cfg_data, pon_distance, pon_distance);
1421 #ifdef TEST_MODE
1422 // It is impossible to mock the setting of pon_cfg.data.state because
1423 // the actual bcmolt_cfg_get passes the address of pon_cfg.hdr and we cannot
1424 // set the pon_cfg.data.state. So a new stub function is created and address
1425 // of pon_cfg is passed. This is one-of case where we need to add test specific
1426 // code in production code.
1427 err = bcmolt_cfg_get__pon_intf_stub(dev_id, &pon_cfg);
1428 #else
1429 err = bcmolt_cfg_get(dev_id, &pon_cfg.hdr);
1430 #endif
1431 if (err != BCM_ERR_OK) {
1432 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);
1433 return err;
1434 }
1435 *mld = pon_distance.max_log_distance;
1436
1437 return BCM_ERR_OK;
1438}
Humera Kouser6143c9e2020-06-17 22:37:31 +05301439
1440/**
1441* Gets mac address based on interface name.
1442*
1443* @param intf_name interface name
1444* @param mac_address mac address field
1445* @param max_size_of_mac_address max sixe of the mac_address
1446* @return mac_address value in case of success or return NULL in case of failure.
1447*/
1448
1449char* get_intf_mac(const char* intf_name, char* mac_address, unsigned int max_size_of_mac_address){
1450 int fd;
1451 struct ifreq ifr;
1452 char *mac;
1453
1454 fd = socket(AF_INET, SOCK_DGRAM, 0);
1455 if ( fd == -1) {
1456 OPENOLT_LOG(ERROR, openolt_log_id, "failed to get mac, could not create file descriptor");
1457 return NULL;
1458 }
1459
1460 ifr.ifr_addr.sa_family = AF_INET;
1461 strncpy((char *)ifr.ifr_name , (const char *)intf_name , IFNAMSIZ-1);
1462 if( ioctl(fd, SIOCGIFHWADDR, &ifr) == -1)
1463 {
1464 OPENOLT_LOG(ERROR, openolt_log_id, "failed to get mac, ioctl failed and returned err");
1465 close(fd);
1466 return NULL;
1467 }
1468
1469 close(fd);
1470 mac = (char *)ifr.ifr_hwaddr.sa_data;
1471
1472 // formatted mac address
1473 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]);
1474
1475 return mac_address;
1476}
Girish Gowdra252f4972020-09-07 21:24:01 -07001477
1478void update_voltha_flow_to_cache(uint64_t voltha_flow_id, device_flow dev_flow) {
1479 OPENOLT_LOG(DEBUG, openolt_log_id, "updating voltha flow=%lu to cache\n", voltha_flow_id)
1480 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1481 voltha_flow_to_device_flow[voltha_flow_id] = dev_flow;
1482 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1483}
1484
1485void remove_voltha_flow_from_cache(uint64_t voltha_flow_id) {
1486 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1487 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1488 if (it != voltha_flow_to_device_flow.end()) {
1489 voltha_flow_to_device_flow.erase(it);
1490 }
1491 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1492}
1493
1494bool is_voltha_flow_installed(uint64_t voltha_flow_id ) {
1495 int count;
1496 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1497 count = voltha_flow_to_device_flow.count(voltha_flow_id);
1498 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1499
1500 return count > 0 ? true : false;
1501}
1502
1503const device_flow_params* get_device_flow_params(uint64_t voltha_flow_id) {
1504 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1505 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1506 if (it != voltha_flow_to_device_flow.end()) {
1507 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1508 return it->second.params;
1509 }
1510 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1511
1512 return NULL;
1513}
1514
1515const device_flow* get_device_flow(uint64_t voltha_flow_id) {
1516 bcmos_fastlock_lock(&voltha_flow_to_device_flow_lock);
1517 std::map<uint64_t, device_flow>::const_iterator it = voltha_flow_to_device_flow.find(voltha_flow_id);
1518 if (it != voltha_flow_to_device_flow.end()) {
1519 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1520 return &it->second;
1521 }
1522 bcmos_fastlock_unlock(&voltha_flow_to_device_flow_lock, 0);
1523
1524 return NULL;
1525}
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001526
1527trap_to_host_packet_type get_trap_to_host_packet_type(const ::openolt::Classifier& classifier) {
1528 trap_to_host_packet_type type = unsupported_trap_to_host_pkt_type;
1529 if (classifier.eth_type() == EAP_ETH_TYPE) {
1530 type = eap;
1531 } else if (classifier.src_port() == DHCP_SERVER_SRC_PORT || classifier.src_port() == DHCP_CLIENT_SRC_PORT) {
1532 type = dhcpv4;
1533 } else if (classifier.eth_type() == LLDP_ETH_TYPE) {
1534 type = lldp;
1535 } else if (classifier.ip_proto() == IGMPv4_PROTOCOL) {
1536 type = igmpv4;
Marcos Aurelio Carrero (Furukawa)c4c56b32021-03-08 12:20:34 -03001537 } else if (classifier.eth_type() == PPPoED_ETH_TYPE) {
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -03001538 type = pppoed;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001539 }
1540
1541 return type;
1542}
1543
1544// is_packet_allowed extracts the VLAN, packet-type, interface-type, interface-id from incoming trap-to-host packet.
1545// Then it verifies if this packet can be allowed upstream to host. It does this by checking if the vlan in the incoming packet
1546//exists in trap_to_host_vlan_ids_for_trap_to_host_pkt_info map for (interface-type, interface-id, packet-type) key.
1547bool is_packet_allowed(bcmolt_access_control_receive_eth_packet_data *data, int32_t gemport_id) {
1548 bcmolt_interface_type intf_type = data->interface_ref.intf_type;
1549 uint32_t intf_id = data->interface_ref.intf_id;
1550 trap_to_host_packet_type pkt_type = unsupported_trap_to_host_pkt_type;
1551 uint16_t vlan_id = 0;
1552 int ethType;
1553
1554 struct timeval dummy_tv = {0, 0};
1555 bool free_memory_of_raw_packet = false; // This indicates the pcap library to not free the message buffer. It will freed by the caller.
1556
1557 pcpp::RawPacket rawPacket(data->buffer.arr, data->buffer.len, dummy_tv, free_memory_of_raw_packet, pcpp::LINKTYPE_ETHERNET);
1558 pcpp::Packet parsedPacket(&rawPacket);
1559 pcpp::EthLayer* ethernetLayer = parsedPacket.getLayerOfType<pcpp::EthLayer>();
1560 if (ethernetLayer == NULL)
1561 {
1562 OPENOLT_LOG(ERROR, openolt_log_id, "Something went wrong, couldn't find Ethernet layer\n");
1563 return false;
1564 }
1565
1566 // Getting Vlan layer
1567 pcpp::VlanLayer* vlanLayer = parsedPacket.getLayerOfType<pcpp::VlanLayer>();
1568 if (vlanLayer == NULL)
1569 {
1570 // Allow Untagged LLDP Ether type packet to trap from NNI
1571 if (ntohs(ethernetLayer->getEthHeader()->etherType) == LLDP_ETH_TYPE && intf_type == BCMOLT_INTERFACE_TYPE_NNI) {
1572 return true;
1573 } else {
1574 OPENOLT_LOG(WARNING, openolt_log_id, "untagged packets other than lldp packets are dropped. ethertype=%d, intftype=%d, intf_id=%d\n",
1575 ntohs(ethernetLayer->getEthHeader()->etherType), intf_type, intf_id);
1576 return false;
1577 }
1578 } else {
1579 ethType = ntohs(vlanLayer->getVlanHeader()->etherType);
1580 if (ethType == EAP_ETH_TYPE) { // single tagged packet with EAPoL payload
1581 vlan_id = vlanLayer->getVlanID();
1582 pkt_type = eap;
Marcos Aurelio Carrero (Furukawa)cfe3e0d2021-03-03 10:36:56 -03001583 } else if (ethType == PPPoED_ETH_TYPE) { // single tagged packet with PPPOeD payload
1584 vlan_id = vlanLayer->getVlanID();
1585 pkt_type = pppoed;
Girish Gowdra1935e6a2020-10-31 21:48:22 -07001586 } else if (ethType == IPV4_ETH_TYPE) { // single tagged packet with IPv4 payload
1587 vlan_id = vlanLayer->getVlanID();
1588 vlanLayer->parseNextLayer();
1589 pcpp::IPv4Layer *ipv4Layer = (pcpp::IPv4Layer*)vlanLayer->getNextLayer();
1590 if(ipv4Layer->getIPv4Header()->protocol == UDP_PROTOCOL) { // UDP payload
1591 // Check the UDP Ports to see if it is a DHCPv4 packet
1592 ipv4Layer->parseNextLayer();
1593 pcpp::UdpLayer *udpLayer = (pcpp::UdpLayer*)ipv4Layer->getNextLayer();
1594 if (ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_SERVER_SRC_PORT|| ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_CLIENT_SRC_PORT) {
1595 pkt_type = dhcpv4;
1596 } else {
1597 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported udp source port = %d\n", ntohs(udpLayer->getUdpHeader()->portSrc));
1598 return false;
1599 }
1600 } else if (ipv4Layer->getIPv4Header()->protocol == IGMPv4_PROTOCOL) { // Igmpv4 payload
1601 pkt_type = igmpv4;
1602 } else {
1603 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ip protocol = %d\n", ipv4Layer->getIPv4Header()->protocol);
1604 return false;
1605 }
1606 } else if (ethType == VLAN_ETH_TYPE) { // double tagged packet
1607
1608 // Trap-to-host from NNI flows do not specify the VLANs, so no vlan validation is necessary.
1609 if (intf_type == BCMOLT_INTERFACE_TYPE_NNI) {
1610 return true;
1611 }
1612
1613 // Here we parse the inner vlan payload and currently support only IPv4 packets
1614
1615 // Extract the vlan_id for trap-to-host packets arriving from the PON
1616 // trap-to-host ACLs from the NNI do not care about VLAN.
1617 if (intf_type == BCMOLT_INTERFACE_TYPE_PON) {
1618 vlan_id = vlanLayer->getVlanID(); // This is the outer vlan id
1619 }
1620 vlanLayer->parseNextLayer();
1621 vlanLayer = (pcpp::VlanLayer*)vlanLayer->getNextLayer(); // Here we extract the inner vlan layer
1622 ethType = ntohs(vlanLayer->getVlanHeader()->etherType);
1623 if (ethType == IPV4_ETH_TYPE) { // IPv4
1624 uint16_t _inner_vlan_id = vlanLayer->getVlanID();
1625 vlanLayer->parseNextLayer();
1626 pcpp::IPv4Layer *ipv4Layer = (pcpp::IPv4Layer*)vlanLayer->getNextLayer(); // here we extract the inner vlan IPv4 payload
1627 if(ipv4Layer->getIPv4Header()->protocol == UDP_PROTOCOL) { // UDP payload
1628 // Check the UDP Ports to see if it is a DHCPv4 packet
1629 ipv4Layer->parseNextLayer();
1630 pcpp::UdpLayer *udpLayer = (pcpp::UdpLayer*)ipv4Layer->getNextLayer();
1631 if (ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_SERVER_SRC_PORT || ntohs(udpLayer->getUdpHeader()->portSrc) == DHCP_CLIENT_SRC_PORT) {
1632 pkt_type = dhcpv4;
1633 } else {
1634 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported udp source port = %d\n", ntohs(udpLayer->getUdpHeader()->portSrc));
1635 return false;
1636 }
1637 } else if (ipv4Layer->getIPv4Header()->protocol == IGMPv4_PROTOCOL) { // Igmpv4 payload
1638 pkt_type = igmpv4;
1639 } else {
1640 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ip protocol = %d\n", ipv4Layer->getIPv4Header()->protocol)
1641 return false;
1642 }
1643 }
1644 } else {
1645 OPENOLT_LOG(ERROR, openolt_log_id, "unsupported ether type = 0x%x\n", ntohs((vlanLayer->getVlanHeader()->etherType)));
1646 return false;
1647 }
1648 }
1649
1650#if 0 // Debug logs for test purpose only
1651 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";
1652 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();
1653 it != trap_to_host_vlan_ids_for_trap_to_host_pkt_info.end(); ++it)
1654 {
1655 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";
1656 std::cout << "vlans for the above key are => ";
1657 for (std::list<uint16_t>::const_iterator _it=it->second.begin();
1658 _it != it->second.end();
1659 ++_it) {
1660 std::cout << *_it << " ";
1661 }
1662 std::cout << "\n\n";
1663 }
1664#endif
1665
1666 trap_to_host_pkt_info pkt_info(intf_type, intf_id, pkt_type, gemport_id);
1667 // 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
1668 if (trap_to_host_vlan_ids_for_trap_to_host_pkt_info.count(pkt_info) > 0) {
1669 // Iterate throught the vlan list to find matching vlan
1670 auto& vlan_id_list = trap_to_host_vlan_ids_for_trap_to_host_pkt_info[pkt_info];
1671 for (auto allowed_vlan_id : vlan_id_list) {
1672 // Found exact matching vlan in the allowed list of vlans for the trap_to_host_pkt_info key or
1673 // there is generic match ANY_VLAN in the list in the allowed vlan list.
1674 if (allowed_vlan_id == vlan_id || allowed_vlan_id == ANY_VLAN) {
1675 return true;
1676 }
1677 }
1678 }
1679 return false;
1680}
Orhan Kupusoglu1fd77072021-03-23 08:13:25 -07001681
1682std::pair<grpc_ssl_client_certificate_request_type, bool> get_grpc_tls_option(const char* tls_option) {
1683 static std::map<std::string,grpc_ssl_client_certificate_request_type> grpc_security_option_map = {{"GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE",
1684 grpc_ssl_client_certificate_request_type::GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE},
1685 {"GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY",
1686 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_BUT_DONT_VERIFY},
1687 {"GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY",
1688 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_CLIENT_CERTIFICATE_AND_VERIFY},
1689 {"GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY",
1690 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_BUT_DONT_VERIFY},
1691 {"GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY",
1692 grpc_ssl_client_certificate_request_type::GRPC_SSL_REQUEST_AND_REQUIRE_CLIENT_CERTIFICATE_AND_VERIFY}};
1693
1694 auto it = grpc_security_option_map.find(tls_option);
1695 if (it == grpc_security_option_map.end()) {
1696 OPENOLT_LOG(ERROR, openolt_log_id, "invalid gRPC Server security option: %s\n", tls_option);
1697 return {grpc_ssl_client_certificate_request_type::GRPC_SSL_DONT_REQUEST_CLIENT_CERTIFICATE, false};
1698 } else {
1699 OPENOLT_LOG(INFO, openolt_log_id, "valid gRPC Server security option: %s\n", tls_option);
1700 tls_option_arg = std::string{tls_option};
1701 return {it->second, true};
1702 }
1703}
1704
1705const std::string &get_grpc_tls_option() {
1706 return tls_option_arg;
1707}
1708
1709bool is_grpc_secure() {
1710 return !tls_option_arg.empty();
1711}
1712
1713std::pair<std::string, bool> read_from_txt_file(const std::string& file_name) {
1714 std::ifstream in_file(file_name);
1715
1716 if (!in_file.is_open()) {
1717 OPENOLT_LOG(ERROR, openolt_log_id, "error opening file '%s'\n", file_name.c_str());
1718 return {"", false};
1719 }
1720
1721 std::stringstream buffer;
1722 buffer << in_file.rdbuf();
1723
1724 return {buffer.str(), in_file.good()};
1725}