NAT: total users and sessions gauges (VPP-1484)
[vpp.git] / src / plugins / nat / dslite.c
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 #include <nat/dslite.h>
16 #include <nat/dslite_dpo.h>
17 #include <vnet/fib/fib_table.h>
18
19 dslite_main_t dslite_main;
20
21 void
22 dslite_init (vlib_main_t * vm)
23 {
24   dslite_main_t *dm = &dslite_main;
25   vlib_thread_registration_t *tr;
26   vlib_thread_main_t *tm = vlib_get_thread_main ();
27   uword *p;
28   dslite_per_thread_data_t *td;
29   u32 translation_buckets = 1024;
30   u32 translation_memory_size = 128 << 20;
31   u32 b4_buckets = 128;
32   u32 b4_memory_size = 64 << 20;
33
34   dm->first_worker_index = 0;
35   dm->num_workers = 0;
36
37   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
38   if (p)
39     {
40       tr = (vlib_thread_registration_t *) p[0];
41       if (tr)
42         {
43           dm->num_workers = tr->count;
44           dm->first_worker_index = tr->first_index;
45         }
46     }
47
48   if (dm->num_workers)
49     dm->port_per_thread = (0xffff - 1024) / dm->num_workers;
50   else
51     dm->port_per_thread = 0xffff - 1024;
52
53   vec_validate (dm->per_thread_data, tm->n_vlib_mains - 1);
54
55   /* *INDENT-OFF* */
56   vec_foreach (td, dm->per_thread_data)
57     {
58       clib_bihash_init_24_8 (&td->in2out, "in2out", translation_buckets,
59                              translation_memory_size);
60
61       clib_bihash_init_8_8 (&td->out2in, "out2in", translation_buckets,
62                             translation_memory_size);
63
64       clib_bihash_init_16_8 (&td->b4_hash, "b4s", b4_buckets, b4_memory_size);
65     }
66   /* *INDENT-ON* */
67
68   dm->is_ce = 0;
69
70   /* Init counters */
71   dm->total_b4s.name = "total-b4s";
72   dm->total_b4s.stat_segment_name = "/dslite/total-b4s";
73   vlib_validate_simple_counter (&dm->total_b4s, 0);
74   vlib_zero_simple_counter (&dm->total_b4s, 0);
75   dm->total_sessions.name = "total-sessions";
76   dm->total_sessions.stat_segment_name = "/dslite/total-sessions";
77   vlib_validate_simple_counter (&dm->total_sessions, 0);
78   vlib_zero_simple_counter (&dm->total_sessions, 0);
79
80   dslite_dpo_module_init ();
81 }
82
83 void
84 dslite_set_ce (dslite_main_t * dm, u8 set)
85 {
86   dm->is_ce = (set != 0);
87 }
88
89 int
90 dslite_set_aftr_ip6_addr (dslite_main_t * dm, ip6_address_t * addr)
91 {
92   dpo_id_t dpo = DPO_INVALID;
93
94   if (dm->is_ce)
95     {
96       dslite_ce_dpo_create (DPO_PROTO_IP4, 0, &dpo);
97       fib_prefix_t pfx = {
98         .fp_proto = FIB_PROTOCOL_IP4,
99         .fp_len = 0,
100         .fp_addr.ip4.as_u32 = 0,
101       };
102       fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
103                                        FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
104     }
105   else
106     {
107       dslite_dpo_create (DPO_PROTO_IP6, 0, &dpo);
108       fib_prefix_t pfx = {
109         .fp_proto = FIB_PROTOCOL_IP6,
110         .fp_len = 128,
111         .fp_addr.ip6.as_u64[0] = addr->as_u64[0],
112         .fp_addr.ip6.as_u64[1] = addr->as_u64[1],
113       };
114       fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
115                                        FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
116     }
117
118   dpo_reset (&dpo);
119
120   dm->aftr_ip6_addr.as_u64[0] = addr->as_u64[0];
121   dm->aftr_ip6_addr.as_u64[1] = addr->as_u64[1];
122   return 0;
123 }
124
125 int
126 dslite_set_aftr_ip4_addr (dslite_main_t * dm, ip4_address_t * addr)
127 {
128   dm->aftr_ip4_addr.as_u32 = addr->as_u32;
129   return 0;
130 }
131
132 int
133 dslite_set_b4_ip6_addr (dslite_main_t * dm, ip6_address_t * addr)
134 {
135   if (dm->is_ce)
136     {
137       dpo_id_t dpo = DPO_INVALID;
138
139       dslite_ce_dpo_create (DPO_PROTO_IP6, 0, &dpo);
140       fib_prefix_t pfx = {
141         .fp_proto = FIB_PROTOCOL_IP6,
142         .fp_len = 128,
143         .fp_addr.ip6.as_u64[0] = addr->as_u64[0],
144         .fp_addr.ip6.as_u64[1] = addr->as_u64[1],
145       };
146       fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
147                                        FIB_ENTRY_FLAG_EXCLUSIVE, &dpo);
148
149       dpo_reset (&dpo);
150
151       dm->b4_ip6_addr.as_u64[0] = addr->as_u64[0];
152       dm->b4_ip6_addr.as_u64[1] = addr->as_u64[1];
153     }
154   else
155     {
156       return VNET_API_ERROR_FEATURE_DISABLED;
157     }
158
159   return 0;
160 }
161
162 int
163 dslite_set_b4_ip4_addr (dslite_main_t * dm, ip4_address_t * addr)
164 {
165   if (dm->is_ce)
166     {
167       dm->b4_ip4_addr.as_u32 = addr->as_u32;
168     }
169   else
170     {
171       return VNET_API_ERROR_FEATURE_DISABLED;
172     }
173
174   return 0;
175 }
176
177 int
178 dslite_add_del_pool_addr (dslite_main_t * dm, ip4_address_t * addr, u8 is_add)
179 {
180   vlib_thread_main_t *tm = vlib_get_thread_main ();
181   snat_address_t *a = 0;
182   int i = 0;
183   dpo_id_t dpo_v4 = DPO_INVALID;
184   fib_prefix_t pfx = {
185     .fp_proto = FIB_PROTOCOL_IP4,
186     .fp_len = 32,
187     .fp_addr.ip4.as_u32 = addr->as_u32,
188   };
189
190   for (i = 0; i < vec_len (dm->addr_pool); i++)
191     {
192       if (dm->addr_pool[i].addr.as_u32 == addr->as_u32)
193         {
194           a = dm->addr_pool + i;
195           break;
196         }
197     }
198   if (is_add)
199     {
200       if (a)
201         return VNET_API_ERROR_VALUE_EXIST;
202       vec_add2 (dm->addr_pool, a, 1);
203       a->addr = *addr;
204 #define _(N, i, n, s) \
205       clib_bitmap_alloc (a->busy_##n##_port_bitmap, 65535); \
206       a->busy_##n##_ports = 0; \
207       vec_validate_init_empty (a->busy_##n##_ports_per_thread, tm->n_vlib_mains - 1, 0);
208       foreach_snat_protocol
209 #undef _
210         dslite_dpo_create (DPO_PROTO_IP4, 0, &dpo_v4);
211       fib_table_entry_special_dpo_add (0, &pfx, FIB_SOURCE_PLUGIN_HI,
212                                        FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
213       dpo_reset (&dpo_v4);
214     }
215   else
216     {
217       if (!a)
218         return VNET_API_ERROR_NO_SUCH_ENTRY;
219 #define _(N, id, n, s) \
220       clib_bitmap_free (a->busy_##n##_port_bitmap); \
221       vec_free (a->busy_##n##_ports_per_thread);
222       foreach_snat_protocol
223 #undef _
224         fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_PLUGIN_HI);
225       vec_del1 (dm->addr_pool, i);
226     }
227   return 0;
228 }
229
230 u8 *
231 format_dslite_trace (u8 * s, va_list * args)
232 {
233   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
234   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
235   dslite_trace_t *t = va_arg (*args, dslite_trace_t *);
236
237   s =
238     format (s, "next index %d, session %d", t->next_index, t->session_index);
239
240   return s;
241 }
242
243 u8 *
244 format_dslite_ce_trace (u8 * s, va_list * args)
245 {
246   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
247   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
248   dslite_ce_trace_t *t = va_arg (*args, dslite_ce_trace_t *);
249
250   s = format (s, "next index %d", t->next_index);
251
252   return s;
253 }
254
255 /*
256  * fd.io coding-style-patch-verification: ON
257  *
258  * Local Variables:
259  * eval: (c-set-style "gnu")
260  * End:
261  */