2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
21 #include <sys/types.h>
23 #include <sys/ioctl.h>
24 #include <sys/socket.h>
28 #include <sys/prctl.h>
34 #include <linux/icmp.h>
35 #include <arpa/inet.h>
37 #include <netinet/if_ether.h>
38 #include <net/if_arp.h>
39 #include <asm/byteorder.h>
42 #include <sys/epoll.h>
49 #include <icmp_proto.h>
51 #define APP_NAME "ICMP_Responder"
52 #define IF_NAME "memif_connection"
56 #define DBG(...) do { \
57 printf (APP_NAME":%s:%d: ", __func__, __LINE__); \
58 printf (__VA_ARGS__); \
65 #define INFO(...) do { \
66 printf ("INFO: "__VA_ARGS__); \
70 /* maximum tx/rx memif buffers */
71 #define MAX_MEMIF_BUFS 256
74 #define MAX_THREADS ((MAX_CONNS) * (MAX_QUEUES))
82 /* memif connection index */
84 /* id of queue to be handled by thread */
90 memif_buffer_t *rx_bufs;
91 memif_buffer_t *tx_bufs;
92 } memif_thread_data_t;
97 /* memif conenction handle */
98 memif_conn_handle_t conn;
99 /* interface ip address */
101 /* inform pthread about connection termination */
103 } memif_connection_t;
105 memif_connection_t memif_connection[MAX_CONNS];
108 /* thread data specific for each thread */
109 memif_thread_data_t thread_data[MAX_THREADS];
110 pthread_t thread[MAX_THREADS];
113 user_signal_handler (int sig)
119 print_memif_details ()
126 buf = malloc (buflen);
127 printf ("MEMIF DETAILS\n");
128 printf ("==============================\n");
129 for (i = 0; i < MAX_CONNS; i++)
131 memif_connection_t *c = &memif_connection[i];
133 memset (&md, 0, sizeof (md));
134 memset (buf, 0, buflen);
136 err = memif_get_details (c->conn, &md, buf, buflen);
137 if (err != MEMIF_ERR_SUCCESS)
139 if (err != MEMIF_ERR_NOCONN)
140 INFO ("%s", memif_strerror (err));
144 printf ("interface index: %d\n", i);
146 printf ("\tinterface ip: %u.%u.%u.%u\n",
147 c->ip_addr[0], c->ip_addr[1], c->ip_addr[2], c->ip_addr[3]);
148 printf ("\tinterface name: %s\n", (char *) md.if_name);
149 printf ("\tapp name: %s\n", (char *) md.inst_name);
150 printf ("\tremote interface name: %s\n", (char *) md.remote_if_name);
151 printf ("\tremote app name: %s\n", (char *) md.remote_inst_name);
152 printf ("\tid: %u\n", md.id);
153 printf ("\tsecret: %s\n", (char *) md.secret);
163 printf ("ethernet\n");
169 printf ("punt/inject\n");
172 printf ("unknown\n");
175 printf ("\tsocket filename: %s\n", (char *) md.socket_filename);
176 printf ("\trx queues:\n");
177 for (e = 0; e < md.rx_queues_num; e++)
179 ti = (i * MAX_QUEUES) + e;
180 printf ("\tqueue id: %u\n", md.rx_queues[e].qid);
181 printf ("\t\tring size: %u\n", md.rx_queues[e].ring_size);
182 printf ("\t\tbuffer size: %u\n", md.rx_queues[e].buffer_size);
183 printf ("\t\tthread id: %u\n", thread_data[ti].id);
184 printf ("\t\tthread connection index: %u\n", thread_data[ti].index);
185 printf ("\t\tthread running: ");
186 if (thread_data[ti].isRunning)
191 printf ("\ttx queues:\n");
192 for (e = 0; e < md.tx_queues_num; e++)
194 printf ("\tqueue id: %u\n", md.tx_queues[e].qid);
195 printf ("\t\tring size: %u\n", md.tx_queues[e].ring_size);
196 printf ("\t\tbuffer size: %u\n", md.tx_queues[e].buffer_size);
208 add_epoll_fd (int epfd, int fd, uint32_t events)
212 DBG ("invalid fd %d", fd);
215 struct epoll_event evt;
216 memset (&evt, 0, sizeof (evt));
219 if (epoll_ctl (epfd, EPOLL_CTL_ADD, fd, &evt) < 0)
221 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
224 DBG ("fd %d added to epoll", fd);
229 mod_epoll_fd (int epfd, int fd, uint32_t events)
233 DBG ("invalid fd %d", fd);
236 struct epoll_event evt;
237 memset (&evt, 0, sizeof (evt));
240 if (epoll_ctl (epfd, EPOLL_CTL_MOD, fd, &evt) < 0)
242 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
245 DBG ("fd %d moddified on epoll", fd);
250 del_epoll_fd (int epfd, int fd)
254 DBG ("invalid fd %d", fd);
257 struct epoll_event evt;
258 memset (&evt, 0, sizeof (evt));
259 if (epoll_ctl (epfd, EPOLL_CTL_DEL, fd, &evt) < 0)
261 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
264 DBG ("fd %d removed from epoll", fd);
269 memif_rx_poll (void *ptr)
271 memif_thread_data_t *data = (memif_thread_data_t *) ptr;
272 memif_connection_t *c = &memif_connection[data->index];
274 uint16_t rx = 0, tx = 0, fb = 0;
276 data->rx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
277 data->tx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
278 data->rx_buf_num = 0;
279 data->tx_buf_num = 0;
282 INFO ("pthread id %u starts in polling mode", data->id);
289 /* receive data from shared memory buffers */
291 memif_rx_burst (c->conn, data->qid, data->rx_bufs, MAX_MEMIF_BUFS,
293 if (err != MEMIF_ERR_SUCCESS)
295 INFO ("memif_rx_burst: %s", memif_strerror (err));
296 data->rx_buf_num += rx;
299 data->rx_buf_num += rx;
305 DBG ("thread id: %u", data->id);
307 DBG ("received %d buffers. %u/%u alloc/free buffers",
308 rx, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
311 memif_buffer_alloc (c->conn, data->qid, data->tx_bufs,
312 data->rx_buf_num, &tx, 0);
313 if (err != MEMIF_ERR_SUCCESS)
315 INFO ("memif_buffer_alloc: %s", memif_strerror (err));
316 data->tx_buf_num += tx;
319 data->tx_buf_num += tx;
320 DBG ("allocated %d/%d buffers, %u free buffers",
321 tx, data->rx_buf_num, MAX_MEMIF_BUFS - data->tx_buf_num);
324 for (i = 0; i < rx; i++)
326 resolve_packet ((void *) (data->rx_bufs + i)->data,
327 (data->rx_bufs + i)->data_len,
328 (void *) (data->tx_bufs + i)->data,
329 &(data->tx_bufs + i)->data_len, c->ip_addr);
332 /* mark memif buffers and shared memory buffers as free */
333 err = memif_buffer_free (c->conn, data->qid, data->rx_bufs, rx, &fb);
334 if (err != MEMIF_ERR_SUCCESS)
335 INFO ("memif_buffer_free: %s", memif_strerror (err));
336 data->rx_buf_num -= fb;
338 DBG ("freed %d buffers. %u/%u alloc/free buffers",
339 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
342 memif_tx_burst (c->conn, data->qid, data->tx_bufs, data->tx_buf_num,
344 if (err != MEMIF_ERR_SUCCESS)
346 INFO ("memif_tx_burst: %s", memif_strerror (err));
349 DBG ("tx: %d/%u", tx, data->tx_buf_num);
350 data->tx_buf_num -= tx;
354 INFO ("thread %u error!", data->id);
358 err = memif_buffer_free (c->conn, data->qid, data->rx_bufs, rx, &fb);
359 if (err != MEMIF_ERR_SUCCESS)
360 INFO ("memif_buffer_free: %s", memif_strerror (err));
361 data->rx_buf_num -= fb;
362 DBG ("freed %d buffers. %u/%u alloc/free buffers",
363 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
364 free (data->rx_bufs);
365 free (data->tx_bufs);
367 INFO ("pthread id %u exit", data->id);
372 memif_rx_interrupt (void *ptr)
374 memif_thread_data_t *data = (memif_thread_data_t *) ptr;
375 memif_connection_t *c = &memif_connection[data->index];
377 uint16_t rx = 0, tx = 0, fb = 0;
378 struct epoll_event evt, *e;
383 signal (SIGUSR1, user_signal_handler);
385 data->rx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
386 data->tx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
387 data->rx_buf_num = 0;
388 data->tx_buf_num = 0;
391 INFO ("pthread id %u starts in interrupt mode", data->id);
392 int thread_epfd = epoll_create (1);
394 /* get interrupt queue id */
396 err = memif_get_queue_efd (c->conn, data->qid, &fd);
397 if (err != MEMIF_ERR_SUCCESS)
399 INFO ("memif_get_queue_efd: %s", memif_strerror (err));
402 add_epoll_fd (thread_epfd, fd, EPOLLIN);
406 memset (&evt, 0, sizeof (evt));
407 evt.events = EPOLLIN | EPOLLOUT;
408 sigemptyset (&sigset);
409 en = epoll_pwait (thread_epfd, &evt, 1, -1, &sigset);
414 DBG ("epoll_pwait: %s", strerror (errno));
419 /* receive data from shared memory buffers */
421 memif_rx_burst (c->conn, data->qid, data->rx_bufs, MAX_MEMIF_BUFS,
423 if (err != MEMIF_ERR_SUCCESS)
425 INFO ("memif_rx_burst: %s", memif_strerror (err));
426 data->rx_buf_num += rx;
429 data->rx_buf_num += rx;
435 DBG ("thread id: %u", data->id);
437 DBG ("received %d buffers. %u/%u alloc/free buffers",
438 rx, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
441 memif_buffer_alloc (c->conn, data->qid, data->tx_bufs,
442 data->rx_buf_num, &tx, 0);
443 if (err != MEMIF_ERR_SUCCESS)
445 INFO ("memif_buffer_alloc: %s", memif_strerror (err));
446 data->tx_buf_num += tx;
449 data->tx_buf_num += tx;
450 DBG ("allocated %d/%d buffers, %u free buffers",
451 tx, data->rx_buf_num, MAX_MEMIF_BUFS - data->tx_buf_num);
454 for (i = 0; i < rx; i++)
456 resolve_packet ((void *) (data->rx_bufs + i)->data,
457 (data->rx_bufs + i)->data_len,
458 (void *) (data->tx_bufs + i)->data,
459 &(data->tx_bufs + i)->data_len, c->ip_addr);
462 /* mark memif buffers and shared memory buffers as free */
464 memif_buffer_free (c->conn, data->qid, data->rx_bufs, rx, &fb);
465 if (err != MEMIF_ERR_SUCCESS)
466 INFO ("memif_buffer_free: %s", memif_strerror (err));
467 data->rx_buf_num -= fb;
469 DBG ("freed %d buffers. %u/%u alloc/free buffers",
470 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
473 memif_tx_burst (c->conn, data->qid, data->tx_bufs,
474 data->tx_buf_num, &tx);
475 if (err != MEMIF_ERR_SUCCESS)
477 INFO ("memif_tx_burst: %s", memif_strerror (err));
480 DBG ("tx: %d/%u", tx, data->tx_buf_num);
481 data->tx_buf_num -= tx;
486 INFO ("thread %u error!", data->id);
490 err = memif_buffer_free (c->conn, data->qid, data->rx_bufs, rx, &fb);
491 if (err != MEMIF_ERR_SUCCESS)
492 INFO ("memif_buffer_free: %s", memif_strerror (err));
493 data->rx_buf_num -= fb;
494 DBG ("freed %d buffers. %u/%u alloc/free buffers",
495 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
496 free (data->rx_bufs);
497 free (data->tx_bufs);
499 INFO ("pthread id %u exit", data->id);
504 /* informs user about connected status. private_ctx is used by user to identify connection
505 (multiple connections WIP) */
507 on_connect (memif_conn_handle_t conn, void *private_ctx)
509 long index = (*(long *) private_ctx);
511 INFO ("memif connected! index %ld", index);
512 memif_connection_t *c = &memif_connection[index];
515 for (i = 0; i < MAX_QUEUES; i++)
517 err = memif_set_rx_mode (c->conn, MEMIF_RX_MODE_POLLING, i);
518 if (err != MEMIF_ERR_SUCCESS)
519 INFO ("memif_set_rx_mode: %s qid: %u", memif_strerror (err), i);
522 ti = (index * MAX_QUEUES) + i;
523 if (thread_data[ti].isRunning)
525 INFO ("thread id: %d already running!", ti);
528 thread_data[ti].index = index;
529 thread_data[ti].qid = i;
530 thread_data[ti].id = ti;
532 pthread_create (&thread[ti],
533 NULL, memif_rx_poll, (void *) &thread_data[ti]);
535 pthread_create (&thread[ti],
536 NULL, memif_rx_interrupt,
537 (void *) &thread_data[ti]);
544 /* informs user about disconnected status. private_ctx is used by user to identify connection
545 (multiple connections WIP) */
547 on_disconnect (memif_conn_handle_t conn, void *private_ctx)
550 long index = (*(long *) private_ctx);
551 memif_connection_t *c = &memif_connection[index];
553 INFO ("memif disconnected!");
554 /* inform thread in polling mode about memif disconenction */
556 for (i = 0; i < MAX_QUEUES; i++)
558 ti = (index * MAX_QUEUES) + i;
559 if (!thread_data[ti].isRunning)
562 pthread_kill (thread[ti], SIGUSR1); /* interrupt thread in interrupt mode */
563 pthread_join (thread[ti], &ptr);
568 /* user needs to watch new fd or stop watching fd that is about to be closed.
569 control fd will be modified during connection establishment to minimize CPU usage */
571 control_fd_update (int fd, uint8_t events)
573 /* convert memif event definitions to epoll events */
574 if (events & MEMIF_FD_EVENT_DEL)
575 return del_epoll_fd (main_epfd, fd);
578 if (events & MEMIF_FD_EVENT_READ)
580 if (events & MEMIF_FD_EVENT_WRITE)
583 if (events & MEMIF_FD_EVENT_MOD)
584 return mod_epoll_fd (main_epfd, fd, evt);
586 return add_epoll_fd (main_epfd, fd, evt);
590 icmpr_memif_create (long index)
592 if (index >= MAX_CONNS)
594 INFO ("connection array overflow");
599 INFO ("don't even try...");
602 memif_connection_t *c = &memif_connection[index];
604 /* setting memif connection arguments */
605 memif_conn_args_t args;
607 memset (&args, 0, sizeof (args));
609 args.log2_ring_size = 10;
610 args.buffer_size = 2048;
611 args.num_s2m_rings = 2;
612 args.num_m2s_rings = 2;
613 strncpy ((char *) args.interface_name, IF_NAME, strlen (IF_NAME));
614 strncpy ((char *) args.instance_name, APP_NAME, strlen (APP_NAME));
616 /* socket filename is not specified, because this app is supposed to
617 connect to VPP over memif. so default socket filename will be used */
618 /* default socketfile = /run/vpp/memif.sock */
620 args.interface_id = index;
621 /* last argument for memif_create (void * private_ctx) is used by user
622 to identify connection. this context is returned with callbacks */
623 int err = memif_create (&c->conn,
624 &args, on_connect, on_disconnect, NULL,
626 if (err != MEMIF_ERR_SUCCESS)
628 INFO ("memif_create: %s", memif_strerror (err));
636 c->ip_addr[2] = c->index + 1;
642 icmpr_memif_delete (long index)
644 if (index >= MAX_CONNS)
646 INFO ("connection array overflow");
651 INFO ("don't even try...");
654 memif_connection_t *c = &memif_connection[index];
657 /* disconenct then delete memif connection */
658 err = memif_delete (&c->conn);
659 if (err != MEMIF_ERR_SUCCESS)
660 INFO ("memif_delete: %s", memif_strerror (err));
667 printf ("LIBMEMIF EXAMPLE APP: %s", APP_NAME);
672 printf ("==============================\n");
673 printf ("libmemif version: %s", LIBMEMIF_VERSION);
678 printf ("memif version: %d\n", MEMIF_VERSION);
679 printf ("commands:\n");
680 printf ("\thelp - prints this help\n");
681 printf ("\texit - exit app\n");
682 printf ("\tconn <index> - create memif (slave-mode)\n");
683 printf ("\tdel <index> - delete memif\n");
684 printf ("\tshow - show connection details\n");
685 printf ("\tip-set <index> <ip-addr> - set interface ip address\n");
691 /* application cleanup */
694 for (i = 0; i < MAX_CONNS; i++)
696 memif_connection_t *c = &memif_connection[i];
698 icmpr_memif_delete (i);
701 err = memif_cleanup ();
702 if (err != MEMIF_ERR_SUCCESS)
703 INFO ("memif_delete: %s", memif_strerror (err));
709 icmpr_set_ip (long index, char *ip)
711 if (index >= MAX_CONNS)
713 INFO ("connection array overflow");
718 INFO ("don't even try...");
721 memif_connection_t *c = &memif_connection[index];
724 INFO ("no connection at index %ld", index);
731 ui = strtok (ip, ".");
734 tmp[0] = strtol (ui, &end, 10);
736 ui = strtok (NULL, ".");
739 tmp[1] = strtol (ui, &end, 10);
741 ui = strtok (NULL, ".");
744 tmp[2] = strtol (ui, &end, 10);
746 ui = strtok (NULL, ".");
749 tmp[3] = strtol (ui, &end, 10);
751 c->ip_addr[0] = tmp[0];
752 c->ip_addr[1] = tmp[1];
753 c->ip_addr[2] = tmp[2];
754 c->ip_addr[3] = tmp[3];
756 INFO ("memif %ld ip address set to %u.%u.%u.%u",
757 index, c->ip_addr[0], c->ip_addr[1], c->ip_addr[2], c->ip_addr[3]);
762 INFO ("invalid ip address");
768 user_input_handler ()
771 char *in = (char *) malloc (256);
772 char *ui = fgets (in, 256, stdin);
776 ui = strtok (in, " ");
777 if (strncmp (ui, "exit", 4) == 0)
783 else if (strncmp (ui, "help", 4) == 0)
788 else if (strncmp (ui, "conn", 4) == 0)
790 ui = strtok (NULL, " ");
792 icmpr_memif_create (strtol (ui, &end, 10));
794 INFO ("expected id");
797 else if (strncmp (ui, "del", 3) == 0)
799 ui = strtok (NULL, " ");
801 icmpr_memif_delete (strtol (ui, &end, 10));
803 INFO ("expected id");
806 else if (strncmp (ui, "show", 4) == 0)
808 print_memif_details ();
811 else if (strncmp (ui, "ip-set", 6) == 0)
813 ui = strtok (NULL, " ");
815 icmpr_set_ip (strtol (ui, &end, 10), strtok (NULL, " "));
817 INFO ("expected id");
822 DBG ("unknown command: %s", ui);
833 poll_event (int timeout)
835 struct epoll_event evt, *e;
836 int app_err = 0, memif_err = 0, en = 0;
839 memset (&evt, 0, sizeof (evt));
840 evt.events = EPOLLIN | EPOLLOUT;
842 sigemptyset (&sigset);
843 en = epoll_pwait (main_epfd, &evt, 1, timeout, &sigset);
846 DBG ("epoll_pwait: %s", strerror (errno));
851 /* this app does not use any other file descriptors than stds and memif control fds */
854 /* event of memif control fd */
855 /* convert epolle events to memif events */
856 if (evt.events & EPOLLIN)
857 events |= MEMIF_FD_EVENT_READ;
858 if (evt.events & EPOLLOUT)
859 events |= MEMIF_FD_EVENT_WRITE;
860 if (evt.events & EPOLLERR)
861 events |= MEMIF_FD_EVENT_ERROR;
862 memif_err = memif_control_fd_handler (evt.data.fd, events);
863 if (memif_err != MEMIF_ERR_SUCCESS)
864 INFO ("memif_control_fd_handler: %s", memif_strerror (memif_err));
866 else if (evt.data.fd == 0)
868 app_err = user_input_handler ();
872 DBG ("unexpected event at memif_epfd. fd %d", evt.data.fd);
876 if ((app_err < 0) || (memif_err < 0))
879 DBG ("user input handler error");
881 DBG ("memif control fd handler error");
891 main_epfd = epoll_create (1);
892 add_epoll_fd (main_epfd, 0, EPOLLIN);
894 /* initialize memory interface */
896 /* if valid callback is passed as argument, fd event polling will be done by user
897 all file descriptors and events will be passed to user in this callback */
898 /* if callback is set to NULL libmemif will handle fd event polling */
899 err = memif_init (control_fd_update, APP_NAME);
900 if (err != MEMIF_ERR_SUCCESS)
901 INFO ("memif_init: %s", memif_strerror (err));
903 for (i = 0; i < MAX_CONNS; i++)
905 memif_connection[i].conn = NULL;
909 memset (&thread_data, 0, sizeof (memif_thread_data_t) * MAX_THREADS);
916 if (poll_event (-1) < 0)
918 DBG ("poll_event error!");