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 #ifndef __VOM_INTERFACE_H__
17 #define __VOM_INTERFACE_H__
19 #include "vom/enum_base.hpp"
21 #include "vom/inspect.hpp"
22 #include "vom/object_base.hpp"
24 #include "vom/prefix.hpp"
25 #include "vom/route_domain.hpp"
26 #include "vom/rpc_cmd.hpp"
27 #include "vom/singular_db.hpp"
31 * Forward declaration of the stats and events command
33 namespace interface_cmds {
39 * A representation of an interface in VPP
41 class interface : public object_base
44 struct stats_type_t : public enum_base<stats_type_t>
46 const static stats_type_t DETAILED;
47 const static stats_type_t NORMAL;
50 stats_type_t(int v, const std::string& s);
54 * The key for interface's key
56 typedef std::string key_t;
61 typedef singular_db<const std::string, interface>::const_iterator
67 struct type_t : enum_base<type_t>
72 const static type_t UNKNOWN;
74 * A brideged Virtual interface (aka SVI or IRB)
76 const static type_t BVI;
80 const static type_t VXLAN;
82 * Ethernet interface type
84 const static type_t ETHERNET;
86 * AF-Packet interface type
88 const static type_t AFPACKET;
90 * loopback interface type
92 const static type_t LOOPBACK;
94 * Local interface type (specific to VPP)
96 const static type_t LOCAL;
99 * TAPv2 interface type
101 const static type_t TAPV2;
104 * vhost-user interface type
106 const static type_t VHOST;
109 * bond interface type
111 const static type_t BOND;
116 const static type_t PIPE;
121 const static type_t PIPE_END;
124 * Convert VPP's name of the interface to a type
126 static type_t from_string(const std::string& str);
130 * Private constructor taking the value and the string name
132 type_t(int v, const std::string& s);
136 * The admin state of the interface
138 struct admin_state_t : enum_base<admin_state_t>
143 const static admin_state_t DOWN;
147 const static admin_state_t UP;
150 * Convert VPP's numerical value to enum type
152 static admin_state_t from_int(uint8_t val);
156 * Private constructor taking the value and the string name
158 admin_state_t(int v, const std::string& s);
162 * The oper state of the interface
164 struct oper_state_t : enum_base<oper_state_t>
167 * Operational DOWN state
169 const static oper_state_t DOWN;
171 * Operational UP state
173 const static oper_state_t UP;
176 * Convert VPP's numerical value to enum type
178 static oper_state_t from_int(uint8_t val);
182 * Private constructor taking the value and the string name
184 oper_state_t(int v, const std::string& s);
194 counter_t m_rx_unicast;
195 counter_t m_tx_unicast;
196 counter_t m_rx_multicast;
197 counter_t m_tx_multicast;
198 counter_t m_rx_broadcast;
199 counter_t m_tx_broadcast;
203 * Construct a new object matching the desried state
205 interface(const std::string& name,
208 const std::string& tag = "");
210 * Construct a new object matching the desried state mapped
211 * to a specific route_domain
213 interface(const std::string& name,
216 const route_domain& rd,
217 const std::string& tag = "");
221 virtual ~interface();
226 interface(const interface& o);
228 static const_iterator_t cbegin();
229 static const_iterator_t cend();
232 * Return the matching'singular' of the interface
234 std::shared_ptr<interface> singular() const;
237 * convert to string format for debug purposes
239 virtual std::string to_string(void) const;
242 * Return VPP's handle to this object
244 const handle_t& handle() const;
247 * Return the interface type
249 const type_t& type() const;
252 * Return the interface type
254 const std::string& name() const;
257 * Return the interface type
259 const key_t& key() const;
262 * Return the L2 Address
264 const l2_address_t& l2_address() const;
267 * Set the admin state of the interface
269 void set(const admin_state_t& state);
274 void set(const l2_address_t& addr);
277 * Set the operational state of the interface, as reported by VPP
279 void set(const oper_state_t& state);
282 * Set the tag to the interface
284 void set(const std::string& tag);
287 * Get the interface stats
289 const stats_t& get_stats(void) const;
292 * Comparison operator - only used for UT
294 virtual bool operator==(const interface& i) const;
297 * A base class for interface Create commands
299 template <typename MSG>
300 class create_cmd : public rpc_cmd<HW::item<handle_t>, MSG>
303 create_cmd(HW::item<handle_t>& item, const std::string& name)
304 : rpc_cmd<HW::item<handle_t>, MSG>(item)
312 virtual ~create_cmd() = default;
315 * Comparison operator - only used for UT
317 virtual bool operator==(const create_cmd& o) const
319 return (m_name == o.m_name);
323 * Indicate the succeeded, when the HW Q is disabled.
327 rpc_cmd<HW::item<handle_t>, MSG>::succeeded();
328 interface::add(m_name, this->item());
332 * add the created interface to the DB
334 void insert_interface() { interface::add(m_name, this->item()); }
336 virtual vapi_error_e operator()(MSG& reply)
338 int sw_if_index = reply.get_response().get_payload().sw_if_index;
339 int retval = reply.get_response().get_payload().retval;
341 VOM_LOG(log_level_t::DEBUG) << this->to_string() << " res:" << retval
342 << " sw-if-index:" << sw_if_index;
344 rc_t rc = rc_t::from_vpp_retval(retval);
345 handle_t handle = handle_t::INVALID;
347 if (rc_t::OK == rc) {
348 handle = sw_if_index;
351 this->fulfill(HW::item<handle_t>(handle, rc));
358 * The name of the interface to be created
360 const std::string& m_name;
364 * Base class for intterface Delete commands
366 template <typename MSG>
367 class delete_cmd : public rpc_cmd<HW::item<handle_t>, MSG>
370 delete_cmd(HW::item<handle_t>& item, const std::string& name)
371 : rpc_cmd<HW::item<handle_t>, MSG>(item)
376 delete_cmd(HW::item<handle_t>& item)
377 : rpc_cmd<HW::item<handle_t>, MSG>(item)
385 virtual ~delete_cmd() = default;
388 * Comparison operator - only used for UT
390 virtual bool operator==(const delete_cmd& o) const
392 return (this->m_hw_item == o.m_hw_item);
396 * Indicate the succeeded, when the HW Q is disabled.
401 * remove the deleted interface from the DB
403 void remove_interface() { interface::remove(this->item()); }
407 * The name of the interface to be created
409 const std::string m_name;
414 event(const interface& itf, const interface::oper_state_t& state)
420 const interface& itf;
421 interface::oper_state_t state;
425 * A class that listens to interface Events
431 * Default Constructor
436 * Virtual function called on the listener when the command has data
439 virtual void handle_interface_event(std::vector<event> es) = 0;
442 * Return the HW::item representing the status
444 HW::item<bool>& status();
448 * The status of the subscription
450 HW::item<bool> m_status;
454 * A class that listens to interface Stats
460 * Default Constructor
464 virtual ~stat_listener() = default;
467 * Virtual function called on the listener when the command has data
470 virtual void handle_interface_stat(const interface&) = 0;
473 * Return the HW::item representing the status
475 HW::item<bool>& status();
479 * The status of the subscription
481 HW::item<bool> m_status;
485 * The the singular instance of the interface in the DB by handle
487 static std::shared_ptr<interface> find(const handle_t& h);
490 * The the singular instance of the interface in the DB by key
492 static std::shared_ptr<interface> find(const key_t& k);
495 * Dump all interfaces into the stream provided
497 static void dump(std::ostream& os);
500 * Enable stats for this interface
502 void enable_stats(stat_listener* el,
503 const stats_type_t& st = stats_type_t::NORMAL);
506 * Disable stats for this interface
508 void disable_stats();
511 * Enable the reception of events of all interfaces
513 static void enable_events(interface::event_listener& el);
516 * disable the reception of events of all interfaces
518 static void disable_events();
522 * Set the handle of an interface object. Only called by the interface
523 * factory during the populate
525 void set(const handle_t& handle);
526 friend class interface_factory;
529 * The SW interface handle VPP has asigned to the interface
531 HW::item<handle_t> m_hdl;
534 * Return the matching 'singular' of the interface
536 virtual std::shared_ptr<interface> singular_i() const;
539 * release/remove an interface form the singular store
544 * Virtual functions to construct an interface create commands.
545 * Overridden in derived classes like the sub_interface
547 virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
550 * Virtual functions to construct an interface delete commands.
551 * Overridden in derived classes like the sub_interface
553 virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
556 * Sweep/reap the object if still stale
558 virtual void sweep(void);
561 * A map of all interfaces key against the interface's name
563 static singular_db<key_t, interface> m_db;
566 * Add an interface to the DB keyed on handle
568 static void add(const key_t& name, const HW::item<handle_t>& item);
571 * remove an interface from the DB keyed on handle
573 static void remove(const HW::item<handle_t>& item);
577 * Class definition for listeners to OM events
579 class event_handler : public OM::listener, public inspect::command_handler
583 virtual ~event_handler() = default;
586 * Handle a populate event
588 void handle_populate(const client_db::key_t& key);
591 * Handle a replay event
593 void handle_replay();
596 * Show the object in the Singular DB
598 void show(std::ostream& os);
601 * Get the sortable Id of the listener
603 dependency_t order() const;
606 static event_handler m_evh;
609 * friend with stat_reader
616 void publish_stats();
619 * Set the interface stat
621 void set(const counter_t& count, const std::string& stat_type);
624 * enable the interface stats in the singular instance
626 void enable_stats_i(stat_listener* el, const stats_type_t& st);
629 * disable the interface stats in the singular instance
631 void disable_stats_i();
634 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
636 void update(const interface& obj);
639 * return the interface's handle in the singular instance
641 const handle_t& handle_i() const;
644 * It's the OM class that calls singular()
649 * It's the singular_db class that calls replay()
651 friend class singular_db<key_t, interface>;
654 * The interfaces name
656 const std::string m_name;
659 * The interface type. clearly this cannot be changed
660 * once the interface has been created.
665 * shared pointer to the routeDoamin the interface is in.
666 * NULL is not mapped - i.e. in the default table
668 std::shared_ptr<route_domain> m_rd;
671 * The state of the interface
673 HW::item<admin_state_t> m_state;
676 * HW state of the VPP table mapping
678 HW::item<route::table_id_t> m_table_id;
681 * HW state of the L2 address
683 HW::item<l2_address_t> m_l2_address;
686 * The state of the detailed stats collection
688 HW::item<stats_type_t> m_stats_type;
696 * reference to stat listener
698 stat_listener* m_listener;
701 * Operational state of the interface
706 * tag of the interface
711 * A map of all interfaces keyed against VPP's handle
713 static std::map<handle_t, std::weak_ptr<interface>> m_hdl_db;
716 * replay the object to create it in hardware
718 virtual void replay(void);
721 * Create commands are firends so they can add interfaces to the
724 template <typename MSG>
725 friend class create_cmd;
728 * Create commands are firends so they can remove interfaces from the
731 template <typename MSG>
732 friend class delete_cmd;
734 static std::shared_ptr<interface_cmds::events_cmd> m_events_cmd;
738 * stream insertion operator for interface stats
740 std::ostream& operator<<(std::ostream& os, const interface::stats_t& stats);
743 * fd.io coding-style-patch-verification: ON
746 * eval: (c-set-style "mozilla")