blob: d277904bb90e61d5761f600989d9b9335177dcec [file] [log] [blame]
Shad Ansarib7b0ced2018-05-11 21:53:32 +00001/*
Girish Gowdraa707e7c2019-11-07 11:36:13 +05302 * Copyright 2018-present Open Networking Foundation
Shad Ansarib7b0ced2018-05-11 21:53:32 +00003
Girish Gowdraa707e7c2019-11-07 11:36:13 +05304 * 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
Shad Ansarib7b0ced2018-05-11 21:53:32 +00007
Girish Gowdraa707e7c2019-11-07 11:36:13 +05308 * http://www.apache.org/licenses/LICENSE-2.0
Shad Ansarib7b0ced2018-05-11 21:53:32 +00009
Girish Gowdraa707e7c2019-11-07 11:36:13 +053010 * 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 */
Shad Ansarib7b0ced2018-05-11 21:53:32 +000016
17#ifndef OPENOLT_CORE_H_
18#define OPENOLT_CORE_H_
19
20#include <grpc++/grpc++.h>
21using grpc::Status;
Thiyagarajan Subramani89fffc02019-05-13 21:33:20 +000022#include <voltha_protos/openolt.grpc.pb.h>
Shad Ansarib7b0ced2018-05-11 21:53:32 +000023
Shad Ansariedef2132018-08-10 22:14:50 +000024#include "state.h"
25
Girish Gowdraddf9a162020-01-27 12:56:27 +053026extern "C"
27{
28#include <bcmolt_api.h>
29#include <bcmolt_api_model_supporting_enums.h>
30
31#include <bcmolt_api_conn_mgr.h>
32//CLI header files
33#include <bcmcli_session.h>
34#include <bcmcli.h>
35#include <bcm_api_cli.h>
36
37#include <bcmos_common.h>
38#include <bcm_config.h>
39// FIXME : dependency problem
40// #include <bcm_common_gpon.h>
41// #include <bcm_dev_log_task.h>
42}
43// ************************//
44// Macros used by the core //
45// ************************//
46
Thiyagarajan Subramani89fffc02019-05-13 21:33:20 +000047#define NONE "\033[m"
48#define LIGHT_RED "\033[1;31m"
49#define BROWN "\033[0;33m"
50#define LIGHT_GREEN "\033[1;32m"
51#define OPENOLT_LOG(level, id, fmt, ...) \
52 if (DEV_LOG_LEVEL_##level == DEV_LOG_LEVEL_ERROR) \
53 BCM_LOG(level, id, "%s" fmt "%s", LIGHT_RED, ##__VA_ARGS__, NONE); \
54 else if (DEV_LOG_LEVEL_##level == DEV_LOG_LEVEL_INFO) \
55 BCM_LOG(level, id, "%s" fmt "%s", NONE, ##__VA_ARGS__, NONE); \
56 else if (DEV_LOG_LEVEL_##level == DEV_LOG_LEVEL_WARNING) \
57 BCM_LOG(level, id, "%s" fmt "%s", BROWN, ##__VA_ARGS__, NONE); \
58 else if (DEV_LOG_LEVEL_##level == DEV_LOG_LEVEL_DEBUG) \
59 BCM_LOG(level, id, "%s" fmt "%s", LIGHT_GREEN, ##__VA_ARGS__, NONE); \
60 else \
61 BCM_LOG(INFO, id, fmt, ##__VA_ARGS__);
Girish Gowdraddf9a162020-01-27 12:56:27 +053062
63
64#define ACL_LOG(level,msg,err) \
65 do { \
66 OPENOLT_LOG(level, openolt_log_id, "--------> %s (acl_id %d) err: %d <--------\n", msg, key.id, err); \
67 OPENOLT_LOG(level, openolt_log_id, "action_type %s\n", \
68 GET_ACL_ACTION_TYPE(action_type)); \
69 OPENOLT_LOG(level, openolt_log_id, "classifier(ether type %d), ip_proto %d, src_port %d, dst_port %d\n", \
70 acl_key.ether_type, acl_key.ip_proto, acl_key.src_port, acl_key.dst_port); \
71 } while(0)
72
73#define FLOW_LOG(level,msg,err) \
74 do { \
75 OPENOLT_LOG(level, openolt_log_id, "--------> %s (flow_id %d) err: %d <--------\n", msg, key.flow_id, err); \
76 OPENOLT_LOG(level, openolt_log_id, "intf_id %d, onu_id %d, uni_id %d, port_no %u, cookie %"PRIu64"\n", \
77 access_intf_id, onu_id, uni_id, port_no, cookie); \
78 OPENOLT_LOG(level, openolt_log_id, "flow_type %s, queue_id %d, sched_id %d\n", flow_type.c_str(), \
79 cfg.data.egress_qos.u.fixed_queue.queue_id, cfg.data.egress_qos.tm_sched.id); \
80 OPENOLT_LOG(level, openolt_log_id, "Ingress(intfd_type %s, intf_id %d), Egress(intf_type %s, intf_id %d)\n", \
81 GET_FLOW_INTERFACE_TYPE(cfg.data.ingress_intf.intf_type), cfg.data.ingress_intf.intf_id, \
82 GET_FLOW_INTERFACE_TYPE(cfg.data.egress_intf.intf_type), cfg.data.egress_intf.intf_id); \
83 OPENOLT_LOG(level, openolt_log_id, "classifier(o_vid %d, o_pbits %d, i_vid %d, i_pbits %d, ether type 0x%x)\n", \
84 c_val.o_vid, c_val.o_pbits, c_val.i_vid, c_val.i_pbits, classifier.eth_type()); \
85 OPENOLT_LOG(level, openolt_log_id, "classifier(ip_proto 0x%x, gemport_id %d, src_port %d, dst_port %d, pkt_tag_type %s)\n", \
86 c_val.ip_proto, gemport_id, c_val.src_port, c_val.dst_port, GET_PKT_TAG_TYPE(c_val.pkt_tag_type)); \
87 OPENOLT_LOG(level, openolt_log_id, "action(cmds_bitmask %s, o_vid %d, o_pbits %d, i_vid %d, i_pbits %d)\n\n", \
88 get_flow_acton_command(a_val.cmds_bitmask), a_val.o_vid, a_val.o_pbits, a_val.i_vid, a_val.i_pbits); \
89 } while(0)
90
91#define FLOW_PARAM_LOG() \
92 do { \
93 OPENOLT_LOG(INFO, openolt_log_id, "--------> flow comparison (now before) <--------\n"); \
94 OPENOLT_LOG(INFO, openolt_log_id, "flow_id (%d %d)\n", \
95 key.flow_id, it->first.first); \
96 OPENOLT_LOG(INFO, openolt_log_id, "onu_id (%d %lu)\n", \
97 cfg.data.onu_id , get_flow_status(it->first.first, it->first.second, ONU_ID)); \
98 OPENOLT_LOG(INFO, openolt_log_id, "type (%d %lu)\n", \
99 key.flow_type, get_flow_status(it->first.first, it->first.second, FLOW_TYPE)); \
100 OPENOLT_LOG(INFO, openolt_log_id, "svc_port_id (%d %lu)\n", \
101 cfg.data.svc_port_id, get_flow_status(it->first.first, it->first.second, SVC_PORT_ID)); \
102 OPENOLT_LOG(INFO, openolt_log_id, "priority (%d %lu)\n", \
103 cfg.data.priority, get_flow_status(it->first.first, it->first.second, PRIORITY)); \
104 OPENOLT_LOG(INFO, openolt_log_id, "cookie (%lu %lu)\n", \
105 cfg.data.cookie, get_flow_status(it->first.first, it->first.second, COOKIE)); \
106 OPENOLT_LOG(INFO, openolt_log_id, "ingress intf_type (%s %s)\n", \
107 GET_FLOW_INTERFACE_TYPE(cfg.data.ingress_intf.intf_type), \
108 GET_FLOW_INTERFACE_TYPE(get_flow_status(it->first.first, it->first.second, INGRESS_INTF_TYPE))); \
109 OPENOLT_LOG(INFO, openolt_log_id, "ingress intf id (%d %lu)\n", \
110 cfg.data.ingress_intf.intf_id , get_flow_status(it->first.first, it->first.second, INGRESS_INTF_ID)); \
111 OPENOLT_LOG(INFO, openolt_log_id, "egress intf_type (%d %lu)\n", \
112 cfg.data.egress_intf.intf_type , get_flow_status(it->first.first, it->first.second, EGRESS_INTF_TYPE)); \
113 OPENOLT_LOG(INFO, openolt_log_id, "egress intf_id (%d %lu)\n", \
114 cfg.data.egress_intf.intf_id , get_flow_status(it->first.first, it->first.second, EGRESS_INTF_ID)); \
115 OPENOLT_LOG(INFO, openolt_log_id, "classifier o_vid (%d %lu)\n", \
116 c_val.o_vid , get_flow_status(it->first.first, it->first.second, CLASSIFIER_O_VID)); \
117 OPENOLT_LOG(INFO, openolt_log_id, "classifier o_pbits (%d %lu)\n", \
118 c_val.o_pbits , get_flow_status(it->first.first, it->first.second, CLASSIFIER_O_PBITS)); \
119 OPENOLT_LOG(INFO, openolt_log_id, "classifier i_vid (%d %lu)\n", \
120 c_val.i_vid , get_flow_status(it->first.first, it->first.second, CLASSIFIER_I_VID)); \
121 OPENOLT_LOG(INFO, openolt_log_id, "classifier i_pbits (%d %lu)\n", \
122 c_val.i_pbits , get_flow_status(it->first.first, it->first.second, CLASSIFIER_I_PBITS)); \
123 OPENOLT_LOG(INFO, openolt_log_id, "classifier ether_type (0x%x 0x%lx)\n", \
124 c_val.ether_type , get_flow_status(it->first.first, it->first.second, CLASSIFIER_ETHER_TYPE)); \
125 OPENOLT_LOG(INFO, openolt_log_id, "classifier ip_proto (%d %lu)\n", \
126 c_val.ip_proto , get_flow_status(it->first.first, it->first.second, CLASSIFIER_IP_PROTO)); \
127 OPENOLT_LOG(INFO, openolt_log_id, "classifier src_port (%d %lu)\n", \
128 c_val.src_port , get_flow_status(it->first.first, it->first.second, CLASSIFIER_SRC_PORT)); \
129 OPENOLT_LOG(INFO, openolt_log_id, "classifier dst_port (%d %lu)\n", \
130 c_val.dst_port , get_flow_status(it->first.first, it->first.second, CLASSIFIER_DST_PORT)); \
131 OPENOLT_LOG(INFO, openolt_log_id, "classifier pkt_tag_type (%s %s)\n", \
132 GET_PKT_TAG_TYPE(c_val.pkt_tag_type), \
133 GET_PKT_TAG_TYPE(get_flow_status(it->first.first, it->first.second, CLASSIFIER_PKT_TAG_TYPE))); \
134 OPENOLT_LOG(INFO, openolt_log_id, "classifier egress_qos type (%d %lu)\n", \
135 cfg.data.egress_qos.type , get_flow_status(it->first.first, it->first.second, EGRESS_QOS_TYPE)); \
136 OPENOLT_LOG(INFO, openolt_log_id, "classifier egress_qos queue_id (%d %lu)\n", \
137 cfg.data.egress_qos.u.fixed_queue.queue_id, \
138 get_flow_status(it->first.first, it->first.second, EGRESS_QOS_QUEUE_ID)); \
139 OPENOLT_LOG(INFO, openolt_log_id, "classifier egress_qos sched_id (%d %lu)\n", \
140 cfg.data.egress_qos.tm_sched.id, \
141 get_flow_status(it->first.first, it->first.second, EGRESS_QOS_TM_SCHED_ID)); \
142 OPENOLT_LOG(INFO, openolt_log_id, "classifier cmds_bitmask (%s %s)\n", \
143 get_flow_acton_command(a_val.cmds_bitmask), \
144 get_flow_acton_command(get_flow_status(it->first.first, it->first.second, ACTION_CMDS_BITMASK))); \
145 OPENOLT_LOG(INFO, openolt_log_id, "action o_vid (%d %lu)\n", \
146 a_val.o_vid , get_flow_status(it->first.first, it->first.second, ACTION_O_VID)); \
147 OPENOLT_LOG(INFO, openolt_log_id, "action i_vid (%d %lu)\n", \
148 a_val.i_vid , get_flow_status(it->first.first, it->first.second, ACTION_I_VID)); \
149 OPENOLT_LOG(INFO, openolt_log_id, "action o_pbits (%d %lu)\n", \
150 a_val.o_pbits , get_flow_status(it->first.first, it->first.second, ACTION_O_PBITS)); \
151 OPENOLT_LOG(INFO, openolt_log_id, "action i_pbits (%d %lu)\n\n", \
152 a_val.i_pbits, get_flow_status(it->first.first, it->first.second, ACTION_I_PBITS)); \
153 OPENOLT_LOG(INFO, openolt_log_id, "group_id (%d %lu)\n\n", \
154 a_val.group_id, get_flow_status(it->first.first, it->first.second, GROUP_ID)); \
155 } while(0)
156
Girish Gowdra96461052019-11-22 20:13:59 +0530157#define COLLECTION_PERIOD 15 // in seconds
Girish Gowdru376b33c2019-05-06 21:46:31 -0700158#define BAL_DYNAMIC_LIST_BUFFER_SIZE (32 * 1024)
159#define MAX_REGID_LENGTH 36
Shad Ansari627b5782018-08-13 22:49:32 +0000160
Girish Gowdraddf9a162020-01-27 12:56:27 +0530161#define BAL_RSC_MANAGER_BASE_TM_SCHED_ID 16384
162#define MAX_TM_QMP_ID 16
163#define TMQ_MAP_PROFILE_SIZE 8
164#define MAX_TM_SCHED_ID 1023
165#define MAX_SUBS_TM_SCHED_ID (MAX_SUPPORTED_PON == 16 ? MAX_TM_SCHED_ID-4-16 : MAX_TM_SCHED_ID-10-64)
166#define EAP_ETHER_TYPE 34958
167#define XGS_BANDWIDTH_GRANULARITY 16000
168#define GPON_BANDWIDTH_GRANULARITY 32000
169#define NUM_OF_PRIORITIES 8
170#define NUMBER_OF_DEFAULT_INTERFACE_QUEUES 4 // <= NUM_OF_PRIORITIES
171#define FILL_ARRAY(ARRAY,START,END,VALUE) for(int i=START;i<END;ARRAY[i++]=VALUE);
172#define COUNT_OF(array) (sizeof(array) / sizeof(array[0]))
173
174#define GET_FLOW_INTERFACE_TYPE(type) \
175 (type == BCMOLT_FLOW_INTERFACE_TYPE_PON) ? "PON" : \
176 (type == BCMOLT_FLOW_INTERFACE_TYPE_NNI) ? "NNI" : \
177 (type == BCMOLT_FLOW_INTERFACE_TYPE_HOST) ? "HOST" : "unknown"
178#define GET_PKT_TAG_TYPE(type) \
179 (type == BCMOLT_PKT_TAG_TYPE_UNTAGGED) ? "UNTAG" : \
180 (type == BCMOLT_PKT_TAG_TYPE_SINGLE_TAG) ? "SINGLE_TAG" : \
181 (type == BCMOLT_PKT_TAG_TYPE_DOUBLE_TAG) ? "DOUBLE_TAG" : "unknown"
182#define GET_ACL_ACTION_TYPE(type) \
183 (type == BCMOLT_ACCESS_CONTROL_FWD_ACTION_TYPE_TRAP_TO_HOST) ? "trap_to_host" : \
184 (type == BCMOLT_ACCESS_CONTROL_FWD_ACTION_TYPE_DROP) ? "drop" : \
185 (type == BCMOLT_ACCESS_CONTROL_FWD_ACTION_TYPE_REDIRECT) ? "redirction" : "unknown"
186#define GET_ACL_MEMBERS_UPDATE_COMMAND(command) \
187 (command == BCMOLT_MEMBERS_UPDATE_COMMAND_ADD) ? "add" : \
188 (command == BCMOLT_MEMBERS_UPDATE_COMMAND_REMOVE) ? "remove" : \
189 (command == BCMOLT_MEMBERS_UPDATE_COMMAND_SET) ? "set" : "unknown"
190#define GET_INTERFACE_TYPE(type) \
191 (type == BCMOLT_INTERFACE_TYPE_PON) ? "PON" : \
192 (type == BCMOLT_INTERFACE_TYPE_NNI) ? "NNI" : \
193 (type == BCMOLT_INTERFACE_TYPE_HOST) ? "HOST" : "unknown"
194
Jason Huang1d9cfce2020-05-20 22:58:47 +0800195#define LOGICAL_DISTANCE(MLD,EQD,TD) (MLD-(EQD*TD)*102) /* Round-trip time of 102 meters is 1us */
Shad Ansariedef2132018-08-10 22:14:50 +0000196extern State state;
197
Girish Gowdraddf9a162020-01-27 12:56:27 +0530198//***************************************//
199// Function declations used by the core. //
200//***************************************//
Shad Ansari627b5782018-08-13 22:49:32 +0000201Status Enable_(int argc, char *argv[]);
Shad Ansarib7b0ced2018-05-11 21:53:32 +0000202Status ActivateOnu_(uint32_t intf_id, uint32_t onu_id,
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700203 const char *vendor_id, const char *vendor_specific, uint32_t pir);
Jonathan Davis70c21812018-07-19 15:32:10 -0400204Status DeactivateOnu_(uint32_t intf_id, uint32_t onu_id,
205 const char *vendor_id, const char *vendor_specific);
206Status DeleteOnu_(uint32_t intf_id, uint32_t onu_id,
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700207 const char *vendor_id, const char *vendor_specific);
Shad Ansarib7b0ced2018-05-11 21:53:32 +0000208Status EnablePonIf_(uint32_t intf_id);
Nicolas Palpacuer05ea0ea2018-07-06 11:47:21 -0400209Status DisablePonIf_(uint32_t intf_id);
Thiyagarajan Subramani89fffc02019-05-13 21:33:20 +0000210Status SetStateUplinkIf_(uint32_t intf_id, bool set_state);
Craig Lutgen88a22ad2018-10-04 12:30:46 -0500211unsigned NumNniIf_();
212unsigned NumPonIf_();
Shad Ansarib7b0ced2018-05-11 21:53:32 +0000213Status OmciMsgOut_(uint32_t intf_id, uint32_t onu_id, const std::string pkt);
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800214Status OnuPacketOut_(uint32_t intf_id, uint32_t onu_id, uint32_t port_no, uint32_t gemport_id, const std::string pkt);
Craig Lutgen88a22ad2018-10-04 12:30:46 -0500215Status ProbeDeviceCapabilities_();
216Status ProbePonIfTechnology_();
Nicolas Palpacuerb78def42018-06-07 12:55:26 -0400217Status UplinkPacketOut_(uint32_t intf_id, const std::string pkt);
Craig Lutgen967a1d02018-11-27 10:41:51 -0600218Status FlowAdd_(int32_t access_intf_id, int32_t onu_id, int32_t uni_id, uint32_t port_no,
Shad Ansarib7b0ced2018-05-11 21:53:32 +0000219 uint32_t flow_id, const std::string flow_type,
Girish Gowdru7c4ec2d2018-10-25 00:29:54 -0700220 int32_t alloc_id, int32_t network_intf_id,
221 int32_t gemport_id, const ::openolt::Classifier& classifier,
Burak Gurdagc78b9e12019-11-29 11:14:51 +0000222 const ::openolt::Action& action, int32_t priority_value,
Burak Gurdag2f2618c2020-04-23 13:20:30 +0000223 uint64_t cookie, int32_t group_id, uint32_t tech_profile_id);
Nicolas Palpacueredfaa0c2018-07-05 15:05:27 -0400224Status FlowRemove_(uint32_t flow_id, const std::string flow_type);
Nicolas Palpacuere3fc0d22018-08-02 16:51:05 -0400225Status Disable_();
226Status Reenable_();
Nicolas Palpacuerdff96792018-09-06 14:59:32 -0400227Status GetDeviceInfo_(openolt::DeviceInfo* device_info);
Girish Gowdruc8ed2ef2019-02-13 08:18:44 -0800228Status CreateTrafficSchedulers_(const tech_profile::TrafficSchedulers *traffic_scheds);
229Status RemoveTrafficSchedulers_(const tech_profile::TrafficSchedulers *traffic_scheds);
230Status CreateTrafficQueues_(const tech_profile::TrafficQueues *traffic_queues);
231Status RemoveTrafficQueues_(const tech_profile::TrafficQueues *traffic_queues);
Burak Gurdagc78b9e12019-11-29 11:14:51 +0000232Status PerformGroupOperation_(const openolt::Group *group_cfg);
Burak Gurdageb4ca2e2020-06-15 07:48:26 +0000233Status DeleteGroup_(uint32_t group_id);
Jason Huang5d9ab1a2020-04-15 16:53:49 +0800234Status OnuItuPonAlarmSet_(const openolt::OnuItuPonAlarm* request);
Craig Lutgen967a1d02018-11-27 10:41:51 -0600235uint32_t GetPortNum_(uint32_t flow_id);
Jason Huang1d9cfce2020-05-20 22:58:47 +0800236Status GetLogicalOnuDistanceZero_(uint32_t intf_id, openolt::OnuLogicalDistance* response);
237Status GetLogicalOnuDistance_(uint32_t intf_id, uint32_t onu_id, openolt::OnuLogicalDistance* response);
Thiyagarajan Subramani89fffc02019-05-13 21:33:20 +0000238int get_status_bcm_cli_quit(void);
Jason Huangbf45ffb2019-10-30 17:29:02 +0800239uint16_t get_dev_id(void);
Thiyagarajan Subramani89fffc02019-05-13 21:33:20 +0000240Status pushOltOperInd(uint32_t intf_id, const char *type, const char *state);
241uint64_t get_flow_status(uint16_t flow_id, uint16_t flow_type, uint16_t data_id);
Nicolas Palpacuere3fc0d22018-08-02 16:51:05 -0400242
Nicolas Palpacuer6a63ea92018-09-05 17:21:37 -0400243void stats_collection();
Jason Huangbf45ffb2019-10-30 17:29:02 +0800244Status check_connection();
245Status check_bal_ready();
Thiyagarajan Subramani03bc66f2020-04-01 15:58:53 +0530246std::string get_ip_address(const char* nw_intf);
Girish Gowdraddf9a162020-01-27 12:56:27 +0530247
248// Stubbed defntions of bcmolt_cfg_get required for unit-test
249#ifdef TEST_MODE
250extern bcmos_errno bcmolt_cfg_get__bal_state_stub(bcmolt_oltid olt_id, void* ptr);
251extern bcmos_errno bcmolt_cfg_get__onu_state_stub(bcmolt_oltid olt_id, void* ptr);
252extern bcmos_errno bcmolt_cfg_get__tm_sched_stub(bcmolt_oltid olt_id, void* ptr);
253extern bcmos_errno bcmolt_cfg_get__pon_intf_stub(bcmolt_oltid olt_id, void* ptr);
254extern bcmos_errno bcmolt_cfg_get__nni_intf_stub(bcmolt_oltid olt_id, void* ptr);
255extern bcmos_errno bcmolt_cfg_get__olt_topology_stub(bcmolt_oltid olt_id, void* ptr);
256extern bcmos_errno bcmolt_cfg_get__flow_stub(bcmolt_oltid olt_id, void* ptr);
257#endif //TEST_MODE
258
Shad Ansarib7b0ced2018-05-11 21:53:32 +0000259#endif