1 /* SPDX-License-Identifier: Apache-2.0
2 * Copyright(c) 2021 Cisco Systems, Inc.
6 #include <vnet/plugin/plugin.h>
7 #include <vpp/app/version.h>
8 #include <snort/snort.h>
10 #include <sys/eventfd.h>
12 snort_main_t snort_main;
14 VLIB_REGISTER_LOG_CLASS (snort_log, static) = {
15 .class_name = "snort",
18 #define log_debug(fmt, ...) vlib_log_debug (snort_log.class, fmt, __VA_ARGS__)
19 #define log_err(fmt, ...) vlib_log_err (snort_log.class, fmt, __VA_ARGS__)
22 snort_client_disconnect (clib_file_t *uf)
24 vlib_main_t *vm = vlib_get_main ();
26 snort_main_t *sm = &snort_main;
27 snort_client_t *c = pool_elt_at_index (sm->clients, uf->private_data);
29 if (c->instance_index != ~0)
31 snort_per_thread_data_t *ptd =
32 vec_elt_at_index (sm->per_thread_data, vm->thread_index);
33 snort_instance_t *si =
34 pool_elt_at_index (sm->instances, c->instance_index);
35 vec_foreach (qp, si->qpairs)
36 __atomic_store_n (&qp->ready, 1, __ATOMIC_RELEASE);
38 si->client_index = ~0;
39 clib_interrupt_set (ptd->interrupts, uf->private_data);
40 vlib_node_set_interrupt_pending (vm, snort_deq_node.index);
43 clib_file_del (&file_main, uf);
44 clib_socket_close (&c->socket);
45 pool_put (sm->clients, c);
48 static snort_instance_t *
49 snort_get_instance_by_name (char *name)
51 snort_main_t *sm = &snort_main;
53 if ((p = hash_get_mem (sm->instance_by_name, name)) == 0)
56 return vec_elt_at_index (sm->instances, p[0]);
61 snort_conn_fd_read_ready (clib_file_t *uf)
63 vlib_main_t *vm = vlib_get_main ();
64 snort_main_t *sm = &snort_main;
65 snort_client_t *c = pool_elt_at_index (sm->clients, uf->private_data);
66 vlib_buffer_pool_t *bp;
69 snort_client_msg_queue_elt *e;
75 log_debug ("fd_read_ready: client %u", uf->private_data);
77 if ((err = clib_socket_recvmsg (&c->socket, &msg, sizeof (msg), 0, 0)))
79 log_err ("client recvmsg error: %U", format_clib_error, err);
80 snort_client_disconnect (uf);
81 clib_error_free (err);
85 if (msg.type != DAQ_VPP_MSG_TYPE_HELLO)
87 log_err ("unexpeced message recieved from client", 0);
88 snort_client_disconnect (uf);
92 msg.hello.inst_name[DAQ_VPP_INST_NAME_LEN - 1] = 0;
93 name = msg.hello.inst_name;
95 log_debug ("fd_read_ready: connect instance %s", name);
97 if ((si = snort_get_instance_by_name (name)) == 0)
99 log_err ("unknown instance '%s' requested by client", name);
100 snort_client_disconnect (uf);
104 vec_foreach (qp, si->qpairs)
106 u32 ready = __atomic_load_n (&qp->ready, __ATOMIC_ACQUIRE);
109 log_err ("instance '%s' is not ready to accept connections", name);
110 snort_client_disconnect (uf);
115 base = (u8 *) si->shm_base;
117 if (si->client_index != ~0)
119 log_err ("client already connected to instance '%s'", name);
120 snort_client_disconnect (uf);
123 si->client_index = uf->private_data;
124 c->instance_index = si->index;
126 log_debug ("fd_read_ready: connect instance index %u", si->index);
128 clib_fifo_add2 (c->msg_queue, e);
129 e->msg.type = DAQ_VPP_MSG_TYPE_CONFIG;
130 e->msg.config.num_bpools = vec_len (vm->buffer_main->buffer_pools);
131 e->msg.config.num_qpairs = vec_len (si->qpairs);
132 e->msg.config.shm_size = si->shm_size;
133 e->fds[0] = si->shm_fd;
136 vec_foreach (bp, vm->buffer_main->buffer_pools)
138 vlib_physmem_map_t *pm;
139 pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
140 clib_fifo_add2 (c->msg_queue, e);
141 e->msg.type = DAQ_VPP_MSG_TYPE_BPOOL;
142 e->msg.bpool.size = pm->n_pages << pm->log2_page_size;
147 vec_foreach (qp, si->qpairs)
149 clib_fifo_add2 (c->msg_queue, e);
150 e->msg.type = DAQ_VPP_MSG_TYPE_QPAIR;
151 e->msg.qpair.log2_queue_size = qp->log2_queue_size;
152 e->msg.qpair.desc_table_offset = (u8 *) qp->descriptors - base;
153 e->msg.qpair.enq_ring_offset = (u8 *) qp->enq_ring - base;
154 e->msg.qpair.deq_ring_offset = (u8 *) qp->deq_ring - base;
155 e->msg.qpair.enq_head_offset = (u8 *) qp->enq_head - base;
156 e->msg.qpair.deq_head_offset = (u8 *) qp->deq_head - base;
157 e->fds[0] = qp->enq_fd;
158 e->fds[1] = qp->deq_fd;
162 clib_file_set_data_available_to_write (&file_main, c->file_index, 1);
166 static clib_error_t *
167 snort_conn_fd_write_ready (clib_file_t *uf)
169 snort_main_t *sm = &snort_main;
170 snort_client_t *c = pool_elt_at_index (sm->clients, uf->private_data);
171 snort_client_msg_queue_elt *e;
173 log_debug ("fd_write_ready: client %u", uf->private_data);
174 clib_fifo_sub2 (c->msg_queue, e);
176 if (clib_fifo_elts (c->msg_queue) == 0)
177 clib_file_set_data_available_to_write (&file_main, c->file_index, 0);
179 return clib_socket_sendmsg (&c->socket, &e->msg, sizeof (*e), e->fds,
184 snort_conn_fd_error (clib_file_t *uf)
186 log_debug ("fd_error: client %u", uf->private_data);
190 static clib_error_t *
191 snort_deq_ready (clib_file_t *uf)
193 vlib_main_t *vm = vlib_get_main ();
194 snort_main_t *sm = &snort_main;
195 snort_per_thread_data_t *ptd =
196 vec_elt_at_index (sm->per_thread_data, vm->thread_index);
199 if (read (uf->file_descriptor, &counter, sizeof (counter)) < 0)
200 return clib_error_return (0, "client closed socket");
202 clib_interrupt_set (ptd->interrupts, uf->private_data);
203 vlib_node_set_interrupt_pending (vm, snort_deq_node.index);
207 static clib_error_t *
208 snort_conn_fd_accept_ready (clib_file_t *uf)
210 snort_main_t *sm = &snort_main;
213 clib_error_t *err = 0;
214 clib_file_t t = { 0 };
216 pool_get_zero (sm->clients, c);
217 c->instance_index = ~0;
220 if ((err = clib_socket_accept (sm->listener, s)))
222 log_err ("%U", format_clib_error, err);
223 pool_put (sm->clients, c);
227 t.read_function = snort_conn_fd_read_ready;
228 t.write_function = snort_conn_fd_write_ready;
229 t.error_function = snort_conn_fd_error;
230 t.file_descriptor = s->fd;
231 t.private_data = c - sm->clients;
232 t.description = format (0, "snort client");
233 c->file_index = clib_file_add (&file_main, &t);
235 log_debug ("snort_conn_fd_accept_ready: client %u", t.private_data);
239 static clib_error_t *
240 snort_listener_init (vlib_main_t *vm)
242 snort_main_t *sm = &snort_main;
244 clib_file_t t = { 0 };
250 s = clib_mem_alloc (sizeof (clib_socket_t));
251 clib_memset (s, 0, sizeof (clib_socket_t));
252 s->config = (char *) sm->socket_name;
253 s->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
254 CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
256 if ((err = clib_socket_init (s)))
262 t.read_function = snort_conn_fd_accept_ready;
263 t.file_descriptor = s->fd;
264 t.description = format (0, "snort listener %s", s->config);
265 log_debug ("%v", t.description);
266 clib_file_add (&file_main, &t);
274 snort_instance_create (vlib_main_t *vm, char *name, u8 log2_queue_sz,
275 u8 drop_on_disconnect)
277 vlib_thread_main_t *tm = vlib_get_thread_main ();
278 snort_main_t *sm = &snort_main;
279 snort_instance_t *si;
280 clib_error_t *err = 0;
282 u8 *base = CLIB_MEM_VM_MAP_FAILED;
285 u32 qpair_mem_sz = 0;
286 u32 qsz = 1 << log2_queue_sz;
287 u8 align = CLIB_CACHE_LINE_BYTES;
289 if (snort_get_instance_by_name (name))
290 return clib_error_return (0, "instance already exists");
292 /* descriptor table */
293 qpair_mem_sz += round_pow2 (qsz * sizeof (daq_vpp_desc_t), align);
295 /* enq and deq ring */
296 qpair_mem_sz += 2 * round_pow2 (qsz * sizeof (u32), align);
298 /* enq and deq head pointer */
299 qpair_mem_sz += 2 * round_pow2 (sizeof (u32), align);
302 round_pow2 (tm->n_vlib_mains * qpair_mem_sz, clib_mem_get_page_size ());
303 fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "snort instance %s",
308 err = clib_error_return (0, "memory fd failure: %U", format_clib_error,
309 clib_mem_get_last_error ());
313 if ((ftruncate (fd, size)) == -1)
315 err = clib_error_return (0, "ftruncate failure");
319 base = clib_mem_vm_map_shared (0, size, fd, 0, "snort instance %s", name);
321 if (base == CLIB_MEM_VM_MAP_FAILED)
323 err = clib_error_return (0, "mmap failure");
327 pool_get_zero (sm->instances, si);
328 si->index = si - sm->instances;
329 si->client_index = ~0;
333 si->name = format (0, "%s%c", name, 0);
334 si->drop_on_disconnect = drop_on_disconnect;
335 index = si - sm->instances;
336 hash_set_mem (sm->instance_by_name, si->name, index);
338 log_debug ("instnce '%s' createed with fd %d at %p, len %u", name, fd, base,
341 vec_validate_aligned (sm->per_thread_data, tm->n_vlib_mains - 1,
342 CLIB_CACHE_LINE_BYTES);
343 vec_validate_aligned (si->qpairs, tm->n_vlib_mains - 1,
344 CLIB_CACHE_LINE_BYTES);
346 for (int i = 0; i < tm->n_vlib_mains; i++)
348 snort_qpair_t *qp = vec_elt_at_index (si->qpairs, i);
349 snort_per_thread_data_t *ptd = vec_elt_at_index (sm->per_thread_data, i);
350 clib_file_t t = { 0 };
352 qp->log2_queue_size = log2_queue_sz;
353 qp->descriptors = (void *) base;
354 base += round_pow2 (qsz * sizeof (daq_vpp_desc_t), align);
355 qp->enq_ring = (void *) base;
356 base += round_pow2 (qsz * sizeof (u32), align);
357 qp->deq_ring = (void *) base;
358 base += round_pow2 (qsz * sizeof (u32), align);
359 qp->enq_head = (void *) base;
360 base += round_pow2 (sizeof (u32), align);
361 qp->deq_head = (void *) base;
362 base += round_pow2 (sizeof (u32), align);
363 qp->enq_fd = eventfd (0, EFD_NONBLOCK);
364 qp->deq_fd = eventfd (0, EFD_NONBLOCK);
365 vec_validate_aligned (qp->buffer_indices, qsz - 1,
366 CLIB_CACHE_LINE_BYTES);
367 vec_validate_aligned (qp->next_indices, qsz - 1, CLIB_CACHE_LINE_BYTES);
368 clib_memset_u32 (qp->buffer_indices, ~0, qsz);
370 /* pre-populate freelist */
371 vec_validate_aligned (qp->freelist, qsz - 1, CLIB_CACHE_LINE_BYTES);
372 snort_freelist_init (qp->freelist);
374 /* listen on dequeue events */
375 t.read_function = snort_deq_ready;
376 t.file_descriptor = qp->deq_fd;
377 t.private_data = si->index;
379 format (0, "snort dequeue for instance '%s' qpair %u", si->name, i);
380 qp->deq_fd_file_index = clib_file_add (&file_main, &t);
382 clib_file_set_polling_thread (&file_main, qp->deq_fd_file_index, i);
383 clib_interrupt_resize (&ptd->interrupts, vec_len (sm->instances));
386 for (i = 0; i < vlib_get_n_threads (); i++)
387 vlib_node_set_state (vlib_get_main_by_index (i), snort_deq_node.index,
393 if (base != CLIB_MEM_VM_MAP_FAILED)
394 clib_mem_vm_unmap (base);
402 snort_interface_enable_disable (vlib_main_t *vm, char *instance_name,
403 u32 sw_if_index, int is_enable)
405 snort_main_t *sm = &snort_main;
406 vnet_main_t *vnm = vnet_get_main ();
407 snort_instance_t *si;
408 clib_error_t *err = 0;
413 if ((si = snort_get_instance_by_name (instance_name)) == 0)
415 err = clib_error_return (0, "unknown instance '%s'", instance_name);
419 vec_validate_init_empty (sm->instance_by_sw_if_index, sw_if_index, ~0);
421 index = sm->instance_by_sw_if_index[sw_if_index];
424 si = vec_elt_at_index (sm->instances, index);
425 err = clib_error_return (0,
426 "interface %U already assgined to "
428 format_vnet_sw_if_index_name, vnm,
429 sw_if_index, si->name);
433 index = sm->instance_by_sw_if_index[sw_if_index] = si->index;
434 vnet_feature_enable_disable ("ip4-unicast", "snort-enq", sw_if_index, 1,
435 &index, sizeof (index));
439 if (sw_if_index >= vec_len (sm->instance_by_sw_if_index) ||
440 sm->instance_by_sw_if_index[sw_if_index] == ~0)
443 clib_error_return (0,
444 "interface %U is not assigned to snort "
446 format_vnet_sw_if_index_name, vnm, sw_if_index);
449 index = sm->instance_by_sw_if_index[sw_if_index];
450 si = vec_elt_at_index (sm->instances, index);
452 sm->instance_by_sw_if_index[sw_if_index] = ~0;
453 vnet_feature_enable_disable ("ip4-unicast", "snort-enq", sw_if_index, 0,
454 &index, sizeof (index));
459 log_err ("%U", format_clib_error, err);
464 snort_set_node_mode (vlib_main_t *vm, u32 mode)
467 snort_main.input_mode = mode;
468 for (i = 0; i < vlib_get_n_threads (); i++)
469 vlib_node_set_state (vlib_get_main_by_index (i), snort_deq_node.index,
475 snort_set_default_socket (snort_main_t *sm, u8 *socket_name)
481 socket_name = (u8 *) DAQ_VPP_DEFAULT_SOCKET_FILE;
484 format (0, "%s/%s", vlib_unix_get_runtime_dir (), socket_name);
485 vec_terminate_c_string (sm->socket_name);
488 static clib_error_t *
489 snort_init (vlib_main_t *vm)
491 snort_main_t *sm = &snort_main;
492 sm->input_mode = VLIB_NODE_STATE_INTERRUPT;
493 sm->instance_by_name = hash_create_string (0, sizeof (uword));
494 vlib_buffer_pool_t *bp;
496 vec_foreach (bp, vm->buffer_main->buffer_pools)
498 vlib_physmem_map_t *pm =
499 vlib_physmem_get_map (vm, bp->physmem_map_index);
500 vec_add1 (sm->buffer_pool_base_addrs, pm->base);
503 if (!sm->socket_name)
504 snort_set_default_socket (sm, 0);
506 return snort_listener_init (vm);
509 VLIB_INIT_FUNCTION (snort_init);
511 VLIB_PLUGIN_REGISTER () = {
512 .version = VPP_BUILD_VER,
513 .description = "Snort",
516 VNET_FEATURE_INIT (snort_enq, static) = {
517 .arc_name = "ip4-unicast",
518 .node_name = "snort-enq",
519 .runs_before = VNET_FEATURES ("ip4-lookup"),