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 {
34 class stats_enable_cmd;
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;
100 const static type_t TAP;
103 * TAPv2 interface type
105 const static type_t TAPV2;
108 * vhost-user interface type
110 const static type_t VHOST;
113 * bond interface type
115 const static type_t BOND;
120 const static type_t PIPE;
125 const static type_t PIPE_END;
128 * Convert VPP's name of the interface to a type
130 static type_t from_string(const std::string& str);
134 * Private constructor taking the value and the string name
136 type_t(int v, const std::string& s);
140 * The admin state of the interface
142 struct admin_state_t : enum_base<admin_state_t>
147 const static admin_state_t DOWN;
151 const static admin_state_t UP;
154 * Convert VPP's numerical value to enum type
156 static admin_state_t from_int(uint8_t val);
160 * Private constructor taking the value and the string name
162 admin_state_t(int v, const std::string& s);
166 * The oper state of the interface
168 struct oper_state_t : enum_base<oper_state_t>
171 * Operational DOWN state
173 const static oper_state_t DOWN;
175 * Operational UP state
177 const static oper_state_t UP;
180 * Convert VPP's numerical value to enum type
182 static oper_state_t from_int(uint8_t val);
186 * Private constructor taking the value and the string name
188 oper_state_t(int v, const std::string& s);
192 * Construct a new object matching the desried state
194 interface(const std::string& name,
197 const std::string& tag = "");
199 * Construct a new object matching the desried state mapped
200 * to a specific route_domain
202 interface(const std::string& name,
205 const route_domain& rd,
206 const std::string& tag = "");
210 virtual ~interface();
215 interface(const interface& o);
217 static const_iterator_t cbegin();
218 static const_iterator_t cend();
221 * Return the matching'singular' of the interface
223 std::shared_ptr<interface> singular() const;
226 * convert to string format for debug purposes
228 virtual std::string to_string(void) const;
231 * Return VPP's handle to this object
233 const handle_t& handle() const;
236 * Return the interface type
238 const type_t& type() const;
241 * Return the interface type
243 const std::string& name() const;
246 * Return the interface type
248 const key_t& key() const;
251 * Return the L2 Address
253 const l2_address_t& l2_address() const;
256 * Set the admin state of the interface
258 void set(const admin_state_t& state);
263 void set(const l2_address_t& addr);
266 * Set the operational state of the interface, as reported by VPP
268 void set(const oper_state_t& state);
271 * Set the tag to the interface
273 void set(const std::string& tag);
276 * Comparison operator - only used for UT
278 virtual bool operator==(const interface& i) const;
281 * A base class for interface Create commands
283 template <typename MSG>
284 class create_cmd : public rpc_cmd<HW::item<handle_t>, MSG>
287 create_cmd(HW::item<handle_t>& item, const std::string& name)
288 : rpc_cmd<HW::item<handle_t>, MSG>(item)
296 virtual ~create_cmd() = default;
299 * Comparison operator - only used for UT
301 virtual bool operator==(const create_cmd& o) const
303 return (m_name == o.m_name);
307 * Indicate the succeeded, when the HW Q is disabled.
311 rpc_cmd<HW::item<handle_t>, MSG>::succeeded();
312 interface::add(m_name, this->item());
316 * add the created interface to the DB
318 void insert_interface() { interface::add(m_name, this->item()); }
320 virtual vapi_error_e operator()(MSG& reply)
322 int sw_if_index = reply.get_response().get_payload().sw_if_index;
323 int retval = reply.get_response().get_payload().retval;
325 VOM_LOG(log_level_t::DEBUG) << this->to_string() << " " << retval;
327 rc_t rc = rc_t::from_vpp_retval(retval);
328 handle_t handle = handle_t::INVALID;
330 if (rc_t::OK == rc) {
331 handle = sw_if_index;
334 this->fulfill(HW::item<handle_t>(handle, rc));
341 * The name of the interface to be created
343 const std::string& m_name;
347 * Base class for intterface Delete commands
349 template <typename MSG>
350 class delete_cmd : public rpc_cmd<HW::item<handle_t>, MSG>
353 delete_cmd(HW::item<handle_t>& item, const std::string& name)
354 : rpc_cmd<HW::item<handle_t>, MSG>(item)
359 delete_cmd(HW::item<handle_t>& item)
360 : rpc_cmd<HW::item<handle_t>, MSG>(item)
368 virtual ~delete_cmd() = default;
371 * Comparison operator - only used for UT
373 virtual bool operator==(const delete_cmd& o) const
375 return (this->m_hw_item == o.m_hw_item);
379 * Indicate the succeeded, when the HW Q is disabled.
384 * remove the deleted interface from the DB
386 void remove_interface() { interface::remove(this->item()); }
390 * The name of the interface to be created
392 const std::string m_name;
396 * A class that listens to interface Events
402 * Default Constructor
407 * Virtual function called on the listener when the command has data
410 virtual void handle_interface_event(interface_cmds::events_cmd* cmd) = 0;
413 * Return the HW::item representing the status
415 HW::item<bool>& status();
419 * The status of the subscription
421 HW::item<bool> m_status;
425 * A class that listens to interface Stats
431 * Default Constructor
436 * Virtual function called on the listener when the command has data
439 virtual void handle_interface_stat(
440 interface_cmds::stats_enable_cmd* cmd) = 0;
443 * Return the HW::item representing the status
445 HW::item<bool>& status();
449 * The status of the subscription
451 HW::item<bool> m_status;
455 * The the singular instance of the interface in the DB by handle
457 static std::shared_ptr<interface> find(const handle_t& h);
460 * The the singular instance of the interface in the DB by key
462 static std::shared_ptr<interface> find(const key_t& k);
465 * Dump all interfaces into the stream provided
467 static void dump(std::ostream& os);
470 * Enable stats for this interface
472 void enable_stats(stat_listener& el,
473 const stats_type_t& st = stats_type_t::NORMAL);
477 * Set the handle of an interface object. Only called by the interface
478 * factory during the populate
480 void set(const handle_t& handle);
481 friend class interface_factory;
485 * The SW interface handle VPP has asigned to the interface
487 HW::item<handle_t> m_hdl;
490 * Return the matching 'singular' of the interface
492 virtual std::shared_ptr<interface> singular_i() const;
495 * release/remove an interface form the singular store
500 * Virtual functions to construct an interface create commands.
501 * Overridden in derived classes like the sub_interface
503 virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
506 * Virtual functions to construct an interface delete commands.
507 * Overridden in derived classes like the sub_interface
509 virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
512 * Sweep/reap the object if still stale
514 virtual void sweep(void);
517 * A map of all interfaces key against the interface's name
519 static singular_db<key_t, interface> m_db;
522 * Add an interface to the DB keyed on handle
524 static void add(const key_t& name, const HW::item<handle_t>& item);
527 * remove an interface from the DB keyed on handle
529 static void remove(const HW::item<handle_t>& item);
533 * Class definition for listeners to OM events
535 class event_handler : public OM::listener, public inspect::command_handler
539 virtual ~event_handler() = default;
542 * Handle a populate event
544 void handle_populate(const client_db::key_t& key);
547 * Handle a replay event
549 void handle_replay();
552 * Show the object in the Singular DB
554 void show(std::ostream& os);
557 * Get the sortable Id of the listener
559 dependency_t order() const;
562 static event_handler m_evh;
565 * enable the interface stats in the singular instance
567 void enable_stats_i(stat_listener& el, const stats_type_t& st);
570 * Commit the acculmulated changes into VPP. i.e. to a 'HW" write.
572 void update(const interface& obj);
575 * return the interface's handle in the singular instance
577 const handle_t& handle_i() const;
580 * It's the OM class that calls singular()
585 * It's the singular_db class that calls replay()
587 friend class singular_db<key_t, interface>;
590 * The interfaces name
592 const std::string m_name;
595 * The interface type. clearly this cannot be changed
596 * once the interface has been created.
601 * shared pointer to the routeDoamin the interface is in.
602 * NULL is not mapped - i.e. in the default table
604 std::shared_ptr<route_domain> m_rd;
607 * shared pointer to the stats object for this interface.
609 std::shared_ptr<interface_cmds::stats_enable_cmd> m_stats;
612 * The state of the interface
614 HW::item<admin_state_t> m_state;
617 * HW state of the VPP table mapping
619 HW::item<route::table_id_t> m_table_id;
622 * HW state of the L2 address
624 HW::item<l2_address_t> m_l2_address;
627 * The state of the detailed stats collection
629 HW::item<stats_type_t> m_stats_type;
632 * Operational state of the interface
637 * tag of the interface
642 * A map of all interfaces keyed against VPP's handle
644 static std::map<handle_t, std::weak_ptr<interface>> m_hdl_db;
647 * replay the object to create it in hardware
649 virtual void replay(void);
652 * Create commands are firends so they can add interfaces to the
655 template <typename MSG>
656 friend class create_cmd;
659 * Create commands are firends so they can remove interfaces from the
662 template <typename MSG>
663 friend class delete_cmd;
667 * fd.io coding-style-patch-verification: ON
670 * eval: (c-set-style "mozilla")