2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include "vom/route.hpp"
17 #include "vom/singular_db.hpp"
19 #include <vapi/ip.api.vapi.hpp>
23 singular_db<ip_route::key_t, ip_route> ip_route::m_db;
25 const path::special_t path::special_t::STANDARD(0, "standard");
26 const path::special_t path::special_t::LOCAL(0, "local");
27 const path::special_t path::special_t::DROP(0, "standard");
28 const path::special_t path::special_t::UNREACH(0, "unreachable");
29 const path::special_t path::special_t::PROHIBIT(0, "prohibit");
31 path::special_t::special_t(int v, const std::string& s)
32 : enum_base<path::special_t>(v, s)
36 path::path(special_t special)
38 , m_nh_proto(nh_proto_t::IPV4)
41 , m_interface(nullptr)
47 path::path(const boost::asio::ip::address& nh,
48 const interface& interface,
51 : m_type(special_t::STANDARD)
52 , m_nh_proto(nh_proto_t::from_address(nh))
55 , m_interface(interface.singular())
57 , m_preference(preference)
61 path::path(const route_domain& rd,
62 const boost::asio::ip::address& nh,
65 : m_type(special_t::STANDARD)
66 , m_nh_proto(nh_proto_t::from_address(nh))
69 , m_interface(nullptr)
71 , m_preference(preference)
75 path::path(const interface& interface,
76 const nh_proto_t& proto,
79 : m_type(special_t::STANDARD)
83 , m_interface(interface.singular())
85 , m_preference(preference)
89 path::path(const path& p)
91 , m_nh_proto(p.m_nh_proto)
94 , m_interface(p.m_interface)
95 , m_weight(p.m_weight)
96 , m_preference(p.m_preference)
101 path::operator<(const path& p) const
103 if (m_type < p.m_type)
105 if (m_rd->table_id() < p.m_rd->table_id())
109 if (m_interface->handle() < p.m_interface->handle())
116 path::to_vpp(vapi_payload_ip_add_del_route& payload) const
119 payload.is_unreach = 0;
120 payload.is_prohibit = 0;
121 payload.is_local = 0;
122 payload.is_classify = 0;
123 payload.is_multipath = 0;
124 payload.is_resolve_host = 0;
125 payload.is_resolve_attached = 0;
127 if (nh_proto_t::ETHERNET == m_nh_proto) {
128 payload.is_l2_bridged = 1;
131 if (special_t::STANDARD == m_type) {
133 to_bytes(m_nh, &path_v6, payload.next_hop_address);
136 payload.next_hop_table_id = m_rd->table_id();
139 payload.next_hop_sw_if_index = m_interface->handle().value();
141 } else if (special_t::DROP == m_type) {
143 } else if (special_t::UNREACH == m_type) {
144 payload.is_unreach = 1;
145 } else if (special_t::PROHIBIT == m_type) {
146 payload.is_prohibit = 1;
147 } else if (special_t::LOCAL == m_type) {
148 payload.is_local = 1;
150 payload.next_hop_weight = m_weight;
151 payload.next_hop_preference = m_preference;
152 payload.next_hop_via_label = 0;
153 payload.classify_table_index = 0;
157 path::to_string() const
159 std::ostringstream s;
162 << "type:" << m_type.to_string() << " proto:" << m_nh_proto.to_string()
163 << " neighbour:" << m_nh.to_string();
165 s << " " << m_rd->to_string();
168 s << " " << m_interface->to_string();
170 s << " weight:" << static_cast<int>(m_weight)
171 << " preference:" << static_cast<int>(m_preference) << "]";
176 ip_route::ip_route(const prefix_t& prefix)
178 , m_rd(route_domain::get_default())
184 ip_route::ip_route(const ip_route& r)
187 , m_prefix(r.m_prefix)
192 ip_route::ip_route(const route_domain& rd, const prefix_t& prefix)
194 , m_rd(rd.singular())
200 ip_route::~ip_route()
204 // not in the DB anymore.
205 m_db.release(std::make_pair(m_rd->table_id(), m_prefix), this);
209 ip_route::add(const path& path)
211 m_paths.insert(path);
215 ip_route::remove(const path& path)
224 HW::enqueue(new delete_cmd(m_hw, m_rd->table_id(), m_prefix));
233 HW::enqueue(new update_cmd(m_hw, m_rd->table_id(), m_prefix, m_paths));
237 ip_route::to_string() const
239 std::ostringstream s;
240 s << "route:[" << m_rd->to_string() << ", " << m_prefix.to_string() << " ["
248 ip_route::update(const ip_route& r)
251 * create the table if it is not yet created
253 if (rc_t::OK != m_hw.rc()) {
254 HW::enqueue(new update_cmd(m_hw, m_rd->table_id(), m_prefix, m_paths));
258 std::shared_ptr<ip_route>
259 ip_route::find_or_add(const ip_route& temp)
261 return (m_db.find_or_add(std::make_pair(temp.m_rd->table_id(), temp.m_prefix),
265 std::shared_ptr<ip_route>
266 ip_route::singular() const
268 return find_or_add(*this);
272 ip_route::dump(std::ostream& os)
277 ip_route::event_handler::event_handler()
279 OM::register_listener(this);
280 inspect::register_handler({ "ip-route" }, "ip route configurations", this);
284 ip_route::event_handler::handle_replay()
290 ip_route::event_handler::handle_populate(const client_db::key_t& key)
292 std::shared_ptr<ip_route::dump_v4_cmd> cmd_v4(new ip_route::dump_v4_cmd());
293 std::shared_ptr<ip_route::dump_v6_cmd> cmd_v6(new ip_route::dump_v6_cmd());
299 for (auto& record : *cmd_v4) {
300 auto& payload = record.get_payload();
302 prefix_t pfx(0, payload.address, payload.address_length);
305 * populating the route domain here
307 route_domain rd_temp(payload.table_id);
308 std::shared_ptr<route_domain> rd = route_domain::find(rd_temp);
310 OM::commit(key, rd_temp);
312 ip_route ip_r(rd_temp, pfx);
314 for (unsigned int i = 0; i < payload.count; i++) {
315 vapi_type_fib_path p = payload.path[i];
317 path path_v4(path::special_t::LOCAL);
319 } else if (p.is_drop) {
320 path path_v4(path::special_t::DROP);
322 } else if (p.is_unreach) {
323 path path_v4(path::special_t::UNREACH);
325 } else if (p.is_prohibit) {
326 path path_v4(path::special_t::PROHIBIT);
329 std::shared_ptr<interface> itf = interface::find(p.sw_if_index);
330 boost::asio::ip::address address = from_bytes(0, p.next_hop);
331 path path_v4(address, *itf, p.weight, p.preference);
335 VOM_LOG(log_level_t::DEBUG) << "ip-route-dump: " << ip_r.to_string();
338 * Write each of the discovered interfaces into the OM,
339 * but disable the HW Command q whilst we do, so that no
340 * commands are sent to VPP
342 OM::commit(key, ip_r);
345 for (auto& record : *cmd_v6) {
346 auto& payload = record.get_payload();
348 prefix_t pfx(1, payload.address, payload.address_length);
349 route_domain rd_temp(payload.table_id);
350 std::shared_ptr<route_domain> rd = route_domain::find(rd_temp);
352 OM::commit(key, rd_temp);
354 ip_route ip_r(rd_temp, pfx);
356 for (unsigned int i = 0; i < payload.count; i++) {
357 vapi_type_fib_path p = payload.path[i];
359 path path_v6(path::special_t::LOCAL);
361 } else if (p.is_drop) {
362 path path_v6(path::special_t::DROP);
364 } else if (p.is_unreach) {
365 path path_v6(path::special_t::UNREACH);
367 } else if (p.is_prohibit) {
368 path path_v6(path::special_t::PROHIBIT);
371 std::shared_ptr<interface> itf = interface::find(p.sw_if_index);
372 boost::asio::ip::address address = from_bytes(1, p.next_hop);
373 path path_v6(address, *itf, p.weight, p.preference);
377 VOM_LOG(log_level_t::DEBUG) << "ip-route-dump: " << ip_r.to_string();
380 * Write each of the discovered interfaces into the OM,
381 * but disable the HW Command q whilst we do, so that no
382 * commands are sent to VPP
384 OM::commit(key, ip_r);
389 ip_route::event_handler::order() const
391 return (dependency_t::BINDING);
395 ip_route::event_handler::show(std::ostream& os)
401 operator<<(std::ostream& os, const ip_route::key_t& key)
403 os << "[" << key.first << ", " << key.second.to_string() << "]";
409 operator<<(std::ostream& os, const path_list_t& key)
413 os << k.to_string() << " ";
422 * fd.io coding-style-patch-verification: ON
425 * eval: (c-set-style "mozilla")