FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gtp6_d.c
Go to the documentation of this file.
1 /*
2  * srv6_end_m_gtp6_d.c
3  *
4  * Copyright (c) 2019 Arrcus Inc and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #include <vnet/vnet.h>
19 #include <vnet/adj/adj.h>
20 #include <vnet/plugin/plugin.h>
21 #include <vpp/app/version.h>
22 #include <srv6-mobile/mobile.h>
23 
25 
26 static void
28 {
29 }
30 
31 static void
33 {
34 }
35 
36 static u8 *
37 clb_dpo_format_srv6_end_m_gtp6_d (u8 * s, va_list * args)
38 {
39  index_t index = va_arg (*args, index_t);
40  CLIB_UNUSED (u32 indent) = va_arg (*args, u32);
41 
42  return (format (s, "SR: dynamic_proxy_index:[%u]", index));
43 }
44 
45 const static dpo_vft_t dpo_vft = {
49 };
50 
51 const static char *const srv6_end_m_gtp6_d_nodes[] = {
52  "srv6-end-m-gtp6-d",
53  NULL,
54 };
55 
56 const static char *const *const dpo_nodes[DPO_PROTO_NUM] = {
58 };
59 
60 static u8 fn_name[] = "SRv6-End.M.GTP6.D-plugin";
61 static u8 keyword_str[] = "end.m.gtp6.d";
62 static u8 def_str[] =
63  "Endpoint function with dencapsulation for IPv6/GTP tunnel";
64 static u8 param_str[] = "<sr-prefix>/<sr-prefixlen> [nhtype <nhtype>]";
65 
66 static u8 *
67 clb_format_srv6_end_m_gtp6_d (u8 * s, va_list * args)
68 {
69  srv6_end_gtp6_param_t *ls_mem = va_arg (*args, void *);
70 
71  s = format (s, "SRv6 End gtp6.d\n\t");
72 
73  s =
74  format (s, "SR Prefix: %U/%d", format_ip6_address, &ls_mem->sr_prefix,
75  ls_mem->sr_prefixlen);
76 
77  if (ls_mem->nhtype != SRV6_NHTYPE_NONE)
78  {
79  if (ls_mem->nhtype == SRV6_NHTYPE_IPV4)
80  s = format (s, ", NHType IPv4\n");
81  else if (ls_mem->nhtype == SRV6_NHTYPE_IPV6)
82  s = format (s, ", NHType IPv6\n");
83  else if (ls_mem->nhtype == SRV6_NHTYPE_NON_IP)
84  s = format (s, ", NHType Non-IP\n");
85  else
86  s = format (s, ", NHType Unknow(%d)\n", ls_mem->nhtype);
87  }
88  else
89  s = format (s, "\n");
90 
91  return s;
92 }
93 
94 static uword
96 {
97  void **plugin_mem_p = va_arg (*args, void **);
98  srv6_end_gtp6_param_t *ls_mem;
99  ip6_address_t sr_prefix;
100  u32 sr_prefixlen;
101  u8 nhtype;
102 
103  if (unformat (input, "end.m.gtp6.d %U/%d nh-type ipv4",
104  unformat_ip6_address, &sr_prefix, &sr_prefixlen))
105  {
106  nhtype = SRV6_NHTYPE_IPV4;
107  }
108  else if (unformat (input, "end.m.gtp6.d %U/%d nh-type ipv6",
109  unformat_ip6_address, &sr_prefix, &sr_prefixlen))
110  {
111  nhtype = SRV6_NHTYPE_IPV6;
112  }
113  else if (unformat (input, "end.m.gtp6.d %U/%d nh-type none",
114  unformat_ip6_address, &sr_prefix, &sr_prefixlen))
115  {
116  nhtype = SRV6_NHTYPE_NON_IP;
117  }
118  else if (unformat (input, "end.m.gtp6.d %U/%d",
119  unformat_ip6_address, &sr_prefix, &sr_prefixlen))
120  {
121  nhtype = SRV6_NHTYPE_NONE;
122  }
123  else
124  {
125  return 0;
126  }
127 
128  ls_mem = clib_mem_alloc_aligned_at_offset (sizeof *ls_mem, 0, 0, 1);
129  clib_memset (ls_mem, 0, sizeof *ls_mem);
130  *plugin_mem_p = ls_mem;
131 
132  ls_mem->sr_prefix = sr_prefix;
133  ls_mem->sr_prefixlen = sr_prefixlen;
134 
135  ls_mem->nhtype = nhtype;
136 
137  return 1;
138 }
139 
140 static int
142 {
143  return 0;
144 }
145 
146 static int
148 {
149  srv6_end_gtp6_param_t *ls_mem;
150 
151  ls_mem = localsid->plugin_mem;
152 
153  clib_mem_free (ls_mem);
154 
155  return 0;
156 }
157 
158 static clib_error_t *
160 {
162  ip6_header_t *ip6;
163  dpo_type_t dpo_type;
164  vlib_node_t *node;
165  int rc;
166 
167  sm->vlib_main = vm;
168  sm->vnet_main = vnet_get_main ();
169 
170  node = vlib_get_node_by_name (vm, (u8 *) "srv6-end-m-gtp6-d");
171  sm->end_m_gtp6_d_node_index = node->index;
172 
173  node = vlib_get_node_by_name (vm, (u8 *) "error-drop");
174  sm->error_node_index = node->index;
175 
176  ip6 = &sm->cache_hdr;
177 
178  clib_memset_u8 (ip6, 0, sizeof (ip6_header_t));
179 
180  // IPv6 header (default)
181  ip6->ip_version_traffic_class_and_flow_label = 0x60;
182  ip6->hop_limit = 64;
183  ip6->protocol = IP_PROTOCOL_IPV6;
184 
185  dpo_type = dpo_register_new_type (&dpo_vft, dpo_nodes);
186 
188  &dpo_type,
193  if (rc < 0)
194  clib_error_return (0, "SRv6 Endpoint GTP6.D LocalSID function"
195  "couldn't be registered");
196  return 0;
197 }
198 
199 /* *INDENT-OFF* */
201 {
202  .arc_name = "ip6-unicast",
203  .node_name = "srv6-end-m-gtp6-d",
204  .runs_before = 0,
205 };
206 
208 /* *INDENT-ON* */
209 
210 /*
211  * fd.io coding-style-patch-verification: ON
212  *
213  * Local Variables:
214  * eval: (c-set-style "gnu")
215  * End:
216  */
adj.h
dpo_nodes
const static char *const *const dpo_nodes[DPO_PROTO_NUM]
Definition: gtp6_d.c:56
dpo_register_new_type
dpo_type_t dpo_register_new_type(const dpo_vft_t *vft, const char *const *const *nodes)
Create and register a new DPO type.
Definition: dpo.c:349
VNET_FEATURE_INIT
VNET_FEATURE_INIT(srv6_end_m_gtp6_d, static)
ip6_sr_localsid_t
SR LocalSID.
Definition: sr.h:122
sr_localsid_register_function
int sr_localsid_register_function(vlib_main_t *vm, u8 *fn_name, u8 *keyword_str, u8 *def_str, u8 *params_str, u8 prefix_length, dpo_type_t *dpo, format_function_t *ls_format, unformat_function_t *ls_unformat, sr_plugin_callback_t *creation_fn, sr_plugin_callback_t *removal_fn)
SR LocalSID plugin registry.
Definition: sr_localsid.c:2347
clib_mem_free
static void clib_mem_free(void *p)
Definition: mem.h:311
ip6_sr_localsid_t::plugin_mem
void * plugin_mem
Memory to be used by the plugin callback functions.
Definition: sr.h:155
node
vlib_main_t vlib_node_runtime_t * node
Definition: nat44_ei.c:3047
keyword_str
static u8 keyword_str[]
Definition: gtp6_d.c:61
clib_error_return
#define clib_error_return(e, args...)
Definition: error.h:99
clb_format_srv6_end_m_gtp6_d
static u8 * clb_format_srv6_end_m_gtp6_d(u8 *s, va_list *args)
Definition: gtp6_d.c:67
SRV6_NHTYPE_NON_IP
#define SRV6_NHTYPE_NON_IP
Definition: mobile.h:34
clb_dpo_format_srv6_end_m_gtp6_d
static u8 * clb_dpo_format_srv6_end_m_gtp6_d(u8 *s, va_list *args)
Definition: gtp6_d.c:37
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
srv6_end_main_v6_decap
srv6_end_main_v6_decap_t srv6_end_main_v6_decap
Definition: gtp6_d.c:24
unformat_input_t
struct _unformat_input_t unformat_input_t
clb_dpo_lock_srv6_end_m_gtp6_d
static void clb_dpo_lock_srv6_end_m_gtp6_d(dpo_id_t *dpo)
Definition: gtp6_d.c:27
SRV6_NHTYPE_IPV6
#define SRV6_NHTYPE_IPV6
Definition: mobile.h:33
unformat
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
clb_dpo_unlock_srv6_end_m_gtp6_d
static void clb_dpo_unlock_srv6_end_m_gtp6_d(dpo_id_t *dpo)
Definition: gtp6_d.c:32
CLIB_UNUSED
#define CLIB_UNUSED(x)
Definition: clib.h:90
SRV6_NHTYPE_NONE
#define SRV6_NHTYPE_NONE
Definition: mobile.h:31
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: pnat_test_stubs.h:56
index_t
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:43
srv6_end_main_v6_decap_s::error_node_index
u32 error_node_index
Definition: mobile.h:266
mobile.h
uword
u64 uword
Definition: types.h:112
srv6_end_main_v6_decap_s::vnet_main
vnet_main_t * vnet_main
Definition: mobile.h:263
dpo_type_t
enum dpo_type_t_ dpo_type_t
Common types of data-path objects New types can be dynamically added using dpo_register_new_type()
dpo_vft_t_::dv_lock
dpo_lock_fn_t dv_lock
A reference counting lock function.
Definition: dpo.h:428
clb_removal_srv6_end_m_gtp6_d
static int clb_removal_srv6_end_m_gtp6_d(ip6_sr_localsid_t *localsid)
Definition: gtp6_d.c:147
clib_memset_u8
static_always_inline void clib_memset_u8(void *p, u8 val, uword count)
Definition: string.h:441
SRV6_NHTYPE_IPV4
#define SRV6_NHTYPE_IPV4
Definition: mobile.h:32
plugin.h
srv6_end_gtp6_param_s::nhtype
u8 nhtype
Definition: mobile.h:179
srv6_end_m_gtp6_d_nodes
const static char *const srv6_end_m_gtp6_d_nodes[]
Definition: gtp6_d.c:51
index
u32 index
Definition: flow_types.api:221
vlib_get_node_by_name
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
srv6_end_gtp6_param_s::sr_prefixlen
u32 sr_prefixlen
Definition: mobile.h:182
format
description fragment has unexpected format
Definition: map.api:433
srv6_end_main_v6_decap_s::vlib_main
vlib_main_t * vlib_main
Definition: mobile.h:262
DPO_PROTO_IP6
@ DPO_PROTO_IP6
Definition: dpo.h:65
param_str
static u8 param_str[]
Definition: gtp6_d.c:64
u32
unsigned int u32
Definition: types.h:88
VLIB_INIT_FUNCTION
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:172
ip6
vl_api_ip6_address_t ip6
Definition: one.api:424
srv6_end_gtp6_param_s::sr_prefix
ip6_address_t sr_prefix
Definition: mobile.h:181
srv6_end_m_gtp6_d
vlib_node_registration_t srv6_end_m_gtp6_d
(constructor) VLIB_REGISTER_NODE (srv6_end_m_gtp6_d)
Definition: node.c:2975
ip6_header_t
Definition: ip6_packet.h:294
clb_creation_srv6_end_m_gtp6_d
static int clb_creation_srv6_end_m_gtp6_d(ip6_sr_localsid_t *localsid)
Definition: gtp6_d.c:141
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
vlib_node_t
Definition: node.h:247
dpo_vft_t_
A virtual function table regisitered for a DPO type.
Definition: dpo.h:423
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
srv6_end_main_v6_decap_s
Definition: mobile.h:260
vlib_init_function_t
clib_error_t *() vlib_init_function_t(struct vlib_main_t *vm)
Definition: init.h:51
format_ip6_address
format_function_t format_ip6_address
Definition: format.h:91
clb_unformat_srv6_end_m_gtp6_d
static uword clb_unformat_srv6_end_m_gtp6_d(unformat_input_t *input, va_list *args)
Definition: gtp6_d.c:95
fn_name
static u8 fn_name[]
Definition: gtp6_d.c:60
clib_mem_alloc_aligned_at_offset
static void * clib_mem_alloc_aligned_at_offset(uword size, uword align, uword align_offset, int os_out_of_memory_on_failure)
Definition: mem.h:222
def_str
static u8 def_str[]
Definition: gtp6_d.c:62
dpo_id_t_
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:172
unformat_ip6_address
unformat_function_t unformat_ip6_address
Definition: format.h:89
srv6_end_main_v6_decap_s::end_m_gtp6_d_node_index
u32 end_m_gtp6_d_node_index
Definition: mobile.h:265
vnet.h
srv6_end_main_v6_decap_s::cache_hdr
ip6_header_t cache_hdr
Definition: mobile.h:268
dpo_vft
const static dpo_vft_t dpo_vft
Definition: gtp6_d.c:45
DPO_PROTO_NUM
#define DPO_PROTO_NUM
Definition: dpo.h:72
srv6_end_m_gtp6_d_init
static clib_error_t * srv6_end_m_gtp6_d_init(vlib_main_t *vm)
Definition: gtp6_d.c:159
srv6_end_gtp6_param_s
Definition: mobile.h:177