FD.io VPP  v19.01.3-6-g70449b9b9
Vector Packet Processing
ip_punt_redirect.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 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_IP_PUNT_REDIRECT_H__
17 #define __VOM_IP_PUNT_REDIRECT_H__
18 
19 #include "vom/hw.hpp"
20 #include "vom/inspect.hpp"
21 #include "vom/interface.hpp"
22 #include "vom/object_base.hpp"
23 #include "vom/om.hpp"
24 #include "vom/singular_db.hpp"
25 
26 namespace VOM {
27 /**
28  * A representation of IP punt_redirect configuration on an interface
29  */
31 {
32 public:
33  /**
34  * Construct a new object matching the desried state
35  *
36  * @param rx_itf - The interface from where the punt traffic should come.
37  * @param tx_itf - The interface to which traffic should be redirected.
38  * @param addr - The next hop ip address to redirect the traffic.
39  */
40  ip_punt_redirect(const interface& rx_itf,
41  const interface& tx_itf,
43 
44  /**
45  * Construct a new object matching the desried state
46  *
47  * @param tx_itf - The interface to which traffic should be redirected.
48  * @param addr - The next hop ip address to redirect the traffic.
49  */
50  ip_punt_redirect(const interface& tx_itf,
51  const boost::asio::ip::address& addr);
52 
53  /**
54  * Copy Constructor
55  */
57 
58  /**
59  * Destructor
60  */
62 
63  /**
64  * Return the 'singular instance' of the ip_punt_redirect that matches this
65  * object
66  */
67  std::shared_ptr<ip_punt_redirect> singular() const;
68 
69  /**
70  * convert to string format for debug purposes
71  */
72  std::string to_string() const;
73 
74  /**
75  * Dump all ip_punt_redirects into the stream provided
76  */
77  static void dump(std::ostream& os);
78 
79  /**
80  * The key type for ip_punt_redirects
81  */
83 
84  /**
85  * return the object's key
86  */
87  const key_t key() const;
88 
89  /**
90  * Find an singular instance in the DB for the interface passed
91  */
92  static std::shared_ptr<ip_punt_redirect> find(const interface& i);
93 
94 private:
95  /**
96  * Class definition for listeners to OM events
97  */
99  {
100  public:
101  event_handler();
102  virtual ~event_handler() = default;
103 
104  /**
105  * Handle a populate event
106  */
107  void handle_populate(const client_db::key_t& key);
108 
109  /**
110  * Handle a replay event
111  */
112  void handle_replay();
113 
114  /**
115  * Show the object in the Singular DB
116  */
117  void show(std::ostream& os);
118 
119  /**
120  * Get the sortable Id of the listener
121  */
122  dependency_t order() const;
123  };
124 
125  /**
126  * event_handler to register with OM
127  */
128  static event_handler m_evh;
129 
130  /**
131  * Enquue commonds to the VPP command Q for the update
132  */
133  void update(const ip_punt_redirect& obj);
134 
135  /**
136  * Find or add the singular instance in the DB
137  */
138  static std::shared_ptr<ip_punt_redirect> find_or_add(
139  const ip_punt_redirect& temp);
140 
141  /*
142  * It's the VPPHW class that updates the objects in HW
143  */
144  friend class OM;
145 
146  /**
147  * It's the singular_db class that calls replay
148  */
149  friend class singular_db<key_t, ip_punt_redirect>;
150 
151  /**
152  * Sweep/reap the object if still stale
153  */
154  void sweep(void);
155 
156  /**
157  * replay the object to create it in hardware
158  */
159  void replay(void);
160 
161  /**
162  * A reference counting pointer the interface that requires an address.
163  */
164  const std::shared_ptr<interface> m_rx_itf;
165  /**
166  * A reference counting pointer the interface that has an address.
167  */
168  const std::shared_ptr<interface> m_tx_itf;
169 
170  /**
171  * host Ip Prefix to redirect traffic to
172  */
173  const boost::asio::ip::address m_addr;
174 
175  /**
176  * HW configuration for the binding. The bool representing the
177  * do/don't bind.
178  */
179  HW::item<bool> m_config;
180 
181  /**
182  * A map of all ip punt redirect keyed against a combination of the interface.
183  */
185 };
186 };
187 
188 /*
189  * fd.io coding-style-patch-verification: ON
190  *
191  * Local Variables:
192  * eval: (c-set-style "mozilla")
193  * End:
194  */
195 
196 #endif
static std::shared_ptr< ip_punt_redirect > find(const interface &i)
Find an singular instance in the DB for the interface passed.
typedef address
Definition: ip_types.api:30
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
int i
std::string to_string() const
convert to string format for debug purposes
vhost_vring_addr_t addr
Definition: vhost_user.h:121
static void dump(std::ostream &os)
Dump all ip_punt_redirects into the stream provided.
A Database to store the unique &#39;singular&#39; instances of a single object type.
Definition: singular_db.hpp:33
~ip_punt_redirect()
Destructor.
interface::key_t key_t
The key type for ip_punt_redirects.
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
void event_handler(void *tls_async)
Definition: tls_async.c:340
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 key_t key() const
return the object&#39;s key
The interface to writing objects into VPP OM.
Definition: om.hpp:140
std::shared_ptr< ip_punt_redirect > singular() const
Return the &#39;singular instance&#39; of the ip_punt_redirect that matches this object.
A base class for all object_base in the VPP object_base-Model.
Definition: object_base.hpp:29
ip_punt_redirect(const interface &rx_itf, const interface &tx_itf, const boost::asio::ip::address &addr)
Construct a new object matching the desried state.
The VPP Object Model (VOM) library.
Definition: acl_binding.cpp:19
A representation of IP punt_redirect configuration on an interface.
void show(char *chroot_path, int verbose)
Definition: svmtool.c:105
std::string key_t
The key for interface&#39;s key.
Definition: interface.hpp:56