FD.io VPP  v18.04-17-g3a0d853
Vector Packet Processing
tap_interface.hpp
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __VOM_TAP_INTERFACE_H__
17 #define __VOM_TAP_INTERFACE_H__
18 
19 #include "vom/interface.hpp"
20 
21 namespace VOM {
22 /**
23  * A tap-interface. e.g. a tap interface
24  */
25 class tap_interface : public interface
26 {
27 public:
28  tap_interface(const std::string& name,
30  route::prefix_t prefix);
31 
32  tap_interface(const std::string& name,
33  admin_state_t state,
34  route::prefix_t prefix,
35  const l2_address_t& l2_address);
36 
38  tap_interface(const tap_interface& o);
39 
40  /**
41  * Return the matching 'singular instance' of the TAP interface
42  */
43  std::shared_ptr<tap_interface> singular() const;
44 
45 private:
46  /**
47  * Class definition for listeners to OM events
48  */
49  class event_handler : public OM::listener, public inspect::command_handler
50  {
51  public:
52  event_handler();
53  virtual ~event_handler() = default;
54 
55  /**
56  * Handle a populate event
57  */
58  void handle_populate(const client_db::key_t& key);
59 
60  /**
61  * Handle a replay event
62  */
63  void handle_replay();
64 
65  /**
66  * Show the object in the Singular DB
67  */
68  void show(std::ostream& os);
69 
70  /**
71  * Get the sortable Id of the listener
72  */
73  dependency_t order() const;
74  };
75  static event_handler m_evh;
76 
77  /**
78  * Ip Prefix
79  */
80  route::prefix_t m_prefix;
81 
82  l2_address_t m_l2_address;
83 
84  /**
85  * interface is a friend so it can construct with handles
86  */
87  friend class interface;
88 
89  /**
90  * Return the matching 'instance' of the sub-interface
91  * over-ride from the base class
92  */
93  std::shared_ptr<interface> singular_i() const;
94 
95  /**
96  * Virtual functions to construct an interface create commands.
97  */
98  virtual std::queue<cmd*>& mk_create_cmd(std::queue<cmd*>& cmds);
99 
100  /**
101  * Virtual functions to construct an interface delete commands.
102  */
103  virtual std::queue<cmd*>& mk_delete_cmd(std::queue<cmd*>& cmds);
104 
105  /*
106  * It's the OM class that call singular()
107  */
108  friend class OM;
109 };
110 }
111 
112 /*
113  * fd.io coding-style-patch-verification: ON
114  *
115  * Local Variables:
116  * eval: (c-set-style "mozilla")
117  * End:
118  */
119 
120 #endif
A tap-interface.
const std::string key_t
In the opflex world each entity is known by a URI which can be converted into a string.
Definition: client_db.hpp:51
Type def of a L2 address as read from VPP.
Definition: types.hpp:342
const l2_address_t & l2_address() const
Return the L2 Address.
Definition: interface.cpp:144
The admin state of the interface.
Definition: interface.hpp:127
A representation of an interface in VPP.
Definition: interface.hpp:41
Class definition for listeners to OM events.
Definition: om.hpp:284
inspect command handler Handler
Definition: inspect.hpp:54
std::shared_ptr< tap_interface > singular() const
Return the matching &#39;singular instance&#39; of the TAP interface.
dependency_t
There needs to be a strict order in which object types are read from VPP (at boot time) and replayed ...
Definition: types.hpp:43
const std::string & name() const
Return the interface type.
Definition: interface.cpp:264
The interface to writing objects into VPP OM.
Definition: om.hpp:140
vhost_vring_state_t state
Definition: vhost-user.h:82
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
tap_interface(const std::string &name, admin_state_t state, route::prefix_t prefix)
Construct a new object matching the desried state.
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
A prefix defintion.
Definition: prefix.hpp:93
const key_t & key() const
Return the interface type.
Definition: interface.cpp:270