aboutsummaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/nat_binding_cmds.hpp
blob: bb9404872ebc1b5b85cbc5fa31f1195bc7b70ebc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __VOM_NAT_BINDING_CMDS_H__
#define __VOM_NAT_BINDING_CMDS_H__

#include "vom/dump_cmd.hpp"
#include "vom/nat_binding.hpp"
#include "vom/rpc_cmd.hpp"

#include <vapi/nat.api.vapi.hpp>

namespace VOM {
namespace nat_binding_cmds {
/**
 * A functor class that binds a NAT configuration to an input interface
 */
class bind_44_input_cmd
  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Nat44_interface_add_del_feature>
{
public:
  /**
   * Constructor
   */
  bind_44_input_cmd(HW::item<bool>& item,
                    const handle_t& itf,
                    const nat_binding::zone_t& zone);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const bind_44_input_cmd& i) const;

private:
  /**
   * The interface to bind
   */
  const handle_t m_itf;

  /**
   * The zone the interface is in
   */
  const nat_binding::zone_t m_zone;
};

/**
 * A cmd class that unbinds a NAT configuration from an input interface
 */
class unbind_44_input_cmd
  : public rpc_cmd<HW::item<bool>, rc_t, vapi::Nat44_interface_add_del_feature>
{
public:
  /**
   * Constructor
   */
  unbind_44_input_cmd(HW::item<bool>& item,
                      const handle_t& itf,
                      const nat_binding::zone_t& zone);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const unbind_44_input_cmd& i) const;

private:
  /**
   * The interface to bind
   */
  const handle_t m_itf;

  /**
   * The zone the interface is in
   */
  const nat_binding::zone_t m_zone;
};

/**
 * A functor class that binds a NAT configuration to an output interface
 */
class bind_44_output_cmd
  : public rpc_cmd<HW::item<bool>,
                   rc_t,
                   vapi::Nat44_interface_add_del_output_feature>
{
public:
  /**
   * Constructor
   */
  bind_44_output_cmd(HW::item<bool>& item,
                     const handle_t& itf,
                     const nat_binding::zone_t& zone);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const bind_44_output_cmd& i) const;

private:
  /**
   * The interface to bind
   */
  const handle_t m_itf;

  /**
   * The zone the interface is in
   */
  const nat_binding::zone_t m_zone;
};

/**
 * A cmd class that unbinds a NAT configuration from an output interface
 */
class unbind_44_output_cmd
  : public rpc_cmd<HW::item<bool>,
                   rc_t,
                   vapi::Nat44_interface_add_del_output_feature>
{
public:
  /**
   * Constructor
   */
  unbind_44_output_cmd(HW::item<bool>& item,
                       const handle_t& itf,
                       const nat_binding::zone_t& zone);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const unbind_44_output_cmd& i) const;

private:
  /**
   * The interface to bind
   */
  const handle_t m_itf;

  /**
   * The zone the interface is in
   */
  const nat_binding::zone_t m_zone;
};

/**
 * A cmd class that Dumps all the nat_statics
 */
class dump_input_44_cmd : public dump_cmd<vapi::Nat44_interface_dump>
{
public:
  /**
   * Constructor
   */
  dump_input_44_cmd();
  dump_input_44_cmd(const dump_input_44_cmd& d);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const dump_input_44_cmd& i) const;

private:
  /**
   * HW reutrn code
   */
  HW::item<bool> item;
};

/**
 * A cmd class that Dumps all the nat_statics
 */
class dump_output_44_cmd
  : public dump_cmd<vapi::Nat44_interface_output_feature_dump>
{
public:
  /**
   * Constructor
   */
  dump_output_44_cmd();
  dump_output_44_cmd(const dump_output_44_cmd& d);

  /**
   * Issue the command to VPP/HW
   */
  rc_t issue(connection& con);
  /**
   * convert to string format for debug purposes
   */
  std::string to_string() const;

  /**
   * Comparison operator - only used for UT
   */
  bool operator==(const dump_output_44_cmd& i) const;

private:
  /**
   * HW reutrn code
   */
  HW::item<bool> item;
};

}; // namespace nat_binding_cmds
}; // namespace VOM

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */

#endif
t;, format_ip6_address, &am->addr, format_ip6_address, &am->mask); } /* Parse an IP6 address. */ uword unformat_ip6_address (unformat_input_t * input, va_list * args) { ip6_address_t *result = va_arg (*args, ip6_address_t *); u16 hex_quads[8]; uword hex_quad, n_hex_quads, hex_digit, n_hex_digits; uword c, n_colon, double_colon_index; n_hex_quads = hex_quad = n_hex_digits = n_colon = 0; double_colon_index = ARRAY_LEN (hex_quads); while ((c = unformat_get_input (input)) != UNFORMAT_END_OF_INPUT) { hex_digit = 16; if (c >= '0' && c <= '9') hex_digit = c - '0'; else if (c >= 'a' && c <= 'f') hex_digit = c + 10 - 'a'; else if (c >= 'A' && c <= 'F') hex_digit = c + 10 - 'A'; else if (c == ':' && n_colon < 2) n_colon++; else { unformat_put_input (input); break; } /* Too many hex quads. */ if (n_hex_quads >= ARRAY_LEN (hex_quads)) return 0; if (hex_digit < 16) { hex_quad = (hex_quad << 4) | hex_digit; /* Hex quad must fit in 16 bits. */ if (n_hex_digits >= 4) return 0; n_colon = 0; n_hex_digits++; } /* Save position of :: */ if (n_colon == 2) { /* More than one :: ? */ if (double_colon_index < ARRAY_LEN (hex_quads)) return 0; double_colon_index = n_hex_quads; } if (n_colon > 0 && n_hex_digits > 0) { hex_quads[n_hex_quads++] = hex_quad; hex_quad = 0; n_hex_digits = 0; } } if (n_hex_digits > 0) hex_quads[n_hex_quads++] = hex_quad; { word i; /* Expand :: to appropriate number of zero hex quads. */ if (double_colon_index < ARRAY_LEN (hex_quads)) { word n_zero = ARRAY_LEN (hex_quads) - n_hex_quads; for (i = n_hex_quads - 1; i >= (signed) double_colon_index; i--) hex_quads[n_zero + i] = hex_quads[i]; for (i = 0; i < n_zero; i++) { ASSERT ((double_colon_index + i) < ARRAY_LEN (hex_quads)); hex_quads[double_colon_index + i] = 0; } n_hex_quads = ARRAY_LEN (hex_quads); } /* Too few hex quads given. */ if (n_hex_quads < ARRAY_LEN (hex_quads)) return 0; for (i = 0; i < ARRAY_LEN (hex_quads); i++) result->as_u16[i] = clib_host_to_net_u16 (hex_quads[i]); return 1; } } uword unformat_ip6_address_and_mask (unformat_input_t * input, va_list * args) { ip6_address_and_mask_t *am = va_arg (*args, ip6_address_and_mask_t *); ip6_address_t addr, mask; clib_memset (&addr, 0, sizeof (ip6_address_t)); clib_memset (&mask, 0, sizeof (ip6_address_t)); if (unformat (input, "any")) ; else if (unformat (input, "%U/%U", unformat_ip6_address, &addr, unformat_ip6_address, &mask)) ; else if (unformat (input, "%U", unformat_ip6_address, &addr)) mask.as_u64[0] = mask.as_u64[1] = ~0; else return 0; am->addr.as_u64[0] = addr.as_u64[0]; am->addr.as_u64[1] = addr.as_u64[1]; am->mask.as_u64[0] = mask.as_u64[0]; am->mask.as_u64[1] = mask.as_u64[1]; return 1; } /* Format an IP6 header. */ u8 * format_ip6_header (u8 * s, va_list * args) { ip6_header_t *ip = va_arg (*args, ip6_header_t *); u32 max_header_bytes = va_arg (*args, u32); u32 i, ip_version, traffic_class, flow_label; u32 indent; /* Nothing to do. */ if (max_header_bytes < sizeof (ip[0])) return format (s, "IP header truncated"); indent = format_get_indent (s); indent += 2; s = format (s, "%U: %U -> %U", format_ip_protocol, ip->protocol, format_ip6_address, &ip->src_address, format_ip6_address, &ip->dst_address); i = clib_net_to_host_u32 (ip->ip_version_traffic_class_and_flow_label); ip_version = (i >> 28); traffic_class = (i >> 20) & 0xff; flow_label = i & pow2_mask (20); if (ip_version != 6) s = format (s, "\n%Uversion %d", format_white_space, indent, ip_version); s = format (s, "\n%Utos 0x%02x, flow label 0x%x, hop limit %d, payload length %d", format_white_space, indent, traffic_class, flow_label, ip->hop_limit, clib_net_to_host_u16 (ip->payload_length)); /* Recurse into next protocol layer. */ if (max_header_bytes != 0 && sizeof (ip[0]) < max_header_bytes) { ip_main_t *im = &ip_main; ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol); if (pi && pi->format_header) s = format (s, "\n%U%U", format_white_space, indent - 2, pi->format_header, /* next protocol header */ (void *) (ip + 1), max_header_bytes - sizeof (ip[0])); } return s; } /* Parse an IP6 header. */ uword unformat_ip6_header (unformat_input_t * input, va_list * args) { u8 **result = va_arg (*args, u8 **); ip6_header_t *ip; int old_length; /* Allocate space for IP header. */ { void *p; old_length = vec_len (*result); vec_add2 (*result, p, sizeof (ip[0])); ip = p; } clib_memset (ip, 0, sizeof (ip[0])); ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (6 << 28); if (!unformat (input, "%U: %U -> %U", unformat_ip_protocol, &ip->protocol, unformat_ip6_address, &ip->src_address, unformat_ip6_address, &ip->dst_address)) return 0; /* Parse options. */ while (1) { int i; if (unformat (input, "tos %U", unformat_vlib_number, &i)) ip->ip_version_traffic_class_and_flow_label |= clib_host_to_net_u32 ((i & 0xff) << 20); else if (unformat (input, "hop-limit %U", unformat_vlib_number, &i)) ip->hop_limit = i; /* Can't parse input: try next protocol level. */ else break; } /* Recurse into next protocol layer. */ { ip_main_t *im = &ip_main; ip_protocol_info_t *pi = ip_get_protocol_info (im, ip->protocol); if (pi && pi->unformat_header) { if (!unformat_user (input, pi->unformat_header, result)) return 0; /* Result may have moved. */ ip = (void *) *result + old_length; } } ip->payload_length = clib_host_to_net_u16 (vec_len (*result) - (old_length + sizeof (ip[0]))); return 1; } /* Parse an IP46 address. */ uword unformat_ip46_address (unformat_input_t * input, va_list * args) { ip46_address_t *ip46 = va_arg (*args, ip46_address_t *); ip46_type_t type = va_arg (*args, ip46_type_t); if ((type != IP46_TYPE_IP6) && unformat (input, "%U", unformat_ip4_address, &ip46->ip4)) { ip46_address_mask_ip4 (ip46); return 1; } else if ((type != IP46_TYPE_IP4) && unformat (input, "%U", unformat_ip6_address, &ip46->ip6)) { return 1; } return 0; } /* Format an IP46 address. */ u8 * format_ip46_address (u8 * s, va_list * args) { ip46_address_t *ip46 = va_arg (*args, ip46_address_t *); ip46_type_t type = va_arg (*args, ip46_type_t); int is_ip4 = 1; switch (type) { case IP46_TYPE_ANY: is_ip4 = ip46_address_is_ip4 (ip46); break; case IP46_TYPE_IP4: is_ip4 = 1; break; case IP46_TYPE_IP6: is_ip4 = 0; break; } return is_ip4 ? format (s, "%U", format_ip4_address, &ip46->ip4) : format (s, "%U", format_ip6_address, &ip46->ip6); } u8 * format_ip6_frag_hdr (u8 * s, va_list * args) { ip6_frag_hdr_t *h = va_arg (*args, ip6_frag_hdr_t *); u32 max_header_bytes = va_arg (*args, u32); u32 header_bytes; header_bytes = sizeof (h[0]); if (max_header_bytes != 0 && header_bytes > max_header_bytes) return format (s, "ipv6 frag header truncated"); s = format (s, "IPV6_FRAG_HDR: next_hdr: %u, rsv: %u, frag_offset_and_more: %u, id: %u", h->next_hdr, h->rsv, h->fragment_offset_and_more, clib_net_to_host_u32 (h->identification)); return s; } /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */