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)
118 print_memif_details ()
125 buf = malloc (buflen);
126 printf ("MEMIF DETAILS\n");
127 printf ("==============================\n");
128 for (i = 0; i < MAX_CONNS; i++)
130 memif_connection_t *c = &memif_connection[i];
132 memset (&md, 0, sizeof (md));
133 memset (buf, 0, buflen);
135 err = memif_get_details (c->conn, &md, buf, buflen);
136 if (err != MEMIF_ERR_SUCCESS)
138 if (err != MEMIF_ERR_NOCONN)
139 INFO ("%s", memif_strerror (err));
143 printf ("interface index: %d\n", i);
145 printf ("\tinterface ip: %u.%u.%u.%u\n",
146 c->ip_addr[0], c->ip_addr[1], c->ip_addr[2], c->ip_addr[3]);
147 printf ("\tinterface name: %s\n", (char *) md.if_name);
148 printf ("\tapp name: %s\n", (char *) md.inst_name);
149 printf ("\tremote interface name: %s\n", (char *) md.remote_if_name);
150 printf ("\tremote app name: %s\n", (char *) md.remote_inst_name);
151 printf ("\tid: %u\n", md.id);
152 printf ("\tsecret: %s\n", (char *) md.secret);
162 printf ("ethernet\n");
168 printf ("punt/inject\n");
171 printf ("unknown\n");
174 printf ("\tsocket filename: %s\n", (char *) md.socket_filename);
175 printf ("\trx queues:\n");
176 for (e = 0; e < md.rx_queues_num; e++)
178 ti = (i * MAX_QUEUES) + e;
179 printf ("\tqueue id: %u\n", md.rx_queues[e].qid);
180 printf ("\t\tring size: %u\n", md.rx_queues[e].ring_size);
181 printf ("\t\tbuffer size: %u\n", md.rx_queues[e].buffer_size);
182 printf ("\t\tthread id: %u\n", thread_data[ti].id);
183 printf ("\t\tthread connection index: %u\n", thread_data[ti].index);
184 printf ("\t\tthread running: ");
185 if (thread_data[ti].isRunning)
190 printf ("\ttx queues:\n");
191 for (e = 0; e < md.tx_queues_num; e++)
193 printf ("\tqueue id: %u\n", md.tx_queues[e].qid);
194 printf ("\t\tring size: %u\n", md.tx_queues[e].ring_size);
195 printf ("\t\tbuffer size: %u\n", md.tx_queues[e].buffer_size);
207 add_epoll_fd (int epfd, int fd, uint32_t events)
211 DBG ("invalid fd %d", fd);
214 struct epoll_event evt;
215 memset (&evt, 0, sizeof (evt));
218 if (epoll_ctl (epfd, EPOLL_CTL_ADD, fd, &evt) < 0)
220 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
223 DBG ("fd %d added to epoll", fd);
228 mod_epoll_fd (int epfd, int fd, uint32_t events)
232 DBG ("invalid fd %d", fd);
235 struct epoll_event evt;
236 memset (&evt, 0, sizeof (evt));
239 if (epoll_ctl (epfd, EPOLL_CTL_MOD, fd, &evt) < 0)
241 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
244 DBG ("fd %d moddified on epoll", fd);
249 del_epoll_fd (int epfd, int fd)
253 DBG ("invalid fd %d", fd);
256 struct epoll_event evt;
257 memset (&evt, 0, sizeof (evt));
258 if (epoll_ctl (epfd, EPOLL_CTL_DEL, fd, &evt) < 0)
260 DBG ("epoll_ctl: %s fd %d", strerror (errno), fd);
263 DBG ("fd %d removed from epoll", fd);
268 memif_rx_poll (void *ptr)
270 memif_thread_data_t *data = (memif_thread_data_t *) ptr;
271 memif_connection_t *c = &memif_connection[data->index];
273 uint16_t rx = 0, tx = 0, fb = 0;
275 data->rx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
276 data->tx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
277 data->rx_buf_num = 0;
278 data->tx_buf_num = 0;
281 INFO ("pthread id %u starts in polling mode", data->id);
288 /* receive data from shared memory buffers */
290 memif_rx_burst (c->conn, data->qid, data->rx_bufs, MAX_MEMIF_BUFS,
292 if (err != MEMIF_ERR_SUCCESS)
294 INFO ("memif_rx_burst: %s", memif_strerror (err));
295 data->rx_buf_num += rx;
298 data->rx_buf_num += rx;
304 DBG ("thread id: %u", data->id);
306 DBG ("received %d buffers. %u/%u alloc/free buffers",
307 rx, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
310 memif_buffer_alloc (c->conn, data->qid, data->tx_bufs,
311 data->rx_buf_num, &tx, 0);
312 if (err != MEMIF_ERR_SUCCESS)
314 INFO ("memif_buffer_alloc: %s", memif_strerror (err));
315 data->tx_buf_num += tx;
318 data->tx_buf_num += tx;
319 DBG ("allocated %d/%d buffers, %u free buffers",
320 tx, data->rx_buf_num, MAX_MEMIF_BUFS - data->tx_buf_num);
323 for (i = 0; i < rx; i++)
325 resolve_packet ((void *) (data->rx_bufs + i)->data,
326 (data->rx_bufs + i)->len,
327 (void *) (data->tx_bufs + i)->data,
328 &(data->tx_bufs + i)->len, c->ip_addr);
331 /* mark memif buffers and shared memory buffers as free */
332 err = memif_refill_queue (c->conn, data->qid, rx, 0);
333 if (err != MEMIF_ERR_SUCCESS)
334 INFO ("memif_buffer_free: %s", memif_strerror (err));
335 data->rx_buf_num -= fb;
337 DBG ("freed %d buffers. %u/%u alloc/free buffers",
338 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
341 memif_tx_burst (c->conn, data->qid, data->tx_bufs, data->tx_buf_num,
343 if (err != MEMIF_ERR_SUCCESS)
345 INFO ("memif_tx_burst: %s", memif_strerror (err));
348 DBG ("tx: %d/%u", tx, data->tx_buf_num);
349 data->tx_buf_num -= tx;
353 INFO ("thread %u error!", data->id);
357 err = memif_refill_queue (c->conn, data->qid, rx, 0);
358 if (err != MEMIF_ERR_SUCCESS)
359 INFO ("memif_buffer_free: %s", memif_strerror (err));
360 data->rx_buf_num -= fb;
361 DBG ("freed %d buffers. %u/%u alloc/free buffers",
362 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
363 free (data->rx_bufs);
364 free (data->tx_bufs);
366 INFO ("pthread id %u exit", data->id);
371 memif_rx_interrupt (void *ptr)
373 memif_thread_data_t *data = (memif_thread_data_t *) ptr;
374 memif_connection_t *c = &memif_connection[data->index];
376 uint16_t rx = 0, tx = 0, fb = 0;
377 struct epoll_event evt;
381 signal (SIGUSR1, user_signal_handler);
383 data->rx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
384 data->tx_bufs = malloc (sizeof (memif_buffer_t) * MAX_MEMIF_BUFS);
385 data->rx_buf_num = 0;
386 data->tx_buf_num = 0;
389 INFO ("pthread id %u starts in interrupt mode", data->id);
390 int thread_epfd = epoll_create (1);
392 /* get interrupt queue id */
394 err = memif_get_queue_efd (c->conn, data->qid, &fd);
395 if (err != MEMIF_ERR_SUCCESS)
397 INFO ("memif_get_queue_efd: %s", memif_strerror (err));
400 add_epoll_fd (thread_epfd, fd, EPOLLIN);
404 memset (&evt, 0, sizeof (evt));
405 evt.events = EPOLLIN | EPOLLOUT;
406 sigemptyset (&sigset);
407 en = epoll_pwait (thread_epfd, &evt, 1, -1, &sigset);
412 DBG ("epoll_pwait: %s", strerror (errno));
417 /* receive data from shared memory buffers */
419 memif_rx_burst (c->conn, data->qid, data->rx_bufs, MAX_MEMIF_BUFS,
421 if (err != MEMIF_ERR_SUCCESS)
423 INFO ("memif_rx_burst: %s", memif_strerror (err));
424 data->rx_buf_num += rx;
427 data->rx_buf_num += rx;
433 DBG ("thread id: %u", data->id);
435 DBG ("received %d buffers. %u/%u alloc/free buffers",
436 rx, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
439 memif_buffer_alloc (c->conn, data->qid, data->tx_bufs,
440 data->rx_buf_num, &tx, 0);
441 if (err != MEMIF_ERR_SUCCESS)
443 INFO ("memif_buffer_alloc: %s", memif_strerror (err));
444 data->tx_buf_num += tx;
447 data->tx_buf_num += tx;
448 DBG ("allocated %d/%d buffers, %u free buffers",
449 tx, data->rx_buf_num, MAX_MEMIF_BUFS - data->tx_buf_num);
452 for (i = 0; i < rx; i++)
454 resolve_packet ((void *) (data->rx_bufs + i)->data,
455 (data->rx_bufs + i)->len,
456 (void *) (data->tx_bufs + i)->data,
457 &(data->tx_bufs + i)->len, c->ip_addr);
460 /* mark memif buffers and shared memory buffers as free */
461 err = memif_refill_queue (c->conn, data->qid, rx, 0);
462 if (err != MEMIF_ERR_SUCCESS)
463 INFO ("memif_buffer_free: %s", memif_strerror (err));
464 data->rx_buf_num -= fb;
466 DBG ("freed %d buffers. %u/%u alloc/free buffers",
467 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
470 memif_tx_burst (c->conn, data->qid, data->tx_bufs,
471 data->tx_buf_num, &tx);
472 if (err != MEMIF_ERR_SUCCESS)
474 INFO ("memif_tx_burst: %s", memif_strerror (err));
477 DBG ("tx: %d/%u", tx, data->tx_buf_num);
478 data->tx_buf_num -= tx;
483 INFO ("thread %u error!", data->id);
487 err = memif_refill_queue (c->conn, data->qid, rx, 0);
488 if (err != MEMIF_ERR_SUCCESS)
489 INFO ("memif_buffer_free: %s", memif_strerror (err));
490 data->rx_buf_num -= fb;
491 DBG ("freed %d buffers. %u/%u alloc/free buffers",
492 fb, data->rx_buf_num, MAX_MEMIF_BUFS - data->rx_buf_num);
493 free (data->rx_bufs);
494 free (data->tx_bufs);
496 INFO ("pthread id %u exit", data->id);
501 /* informs user about connected status. private_ctx is used by user to identify connection
502 (multiple connections WIP) */
504 on_connect (memif_conn_handle_t conn, void *private_ctx)
506 long index = (*(long *) private_ctx);
508 INFO ("memif connected! index %ld", index);
509 memif_connection_t *c = &memif_connection[index];
512 for (i = 0; i < MAX_QUEUES; i++)
514 err = memif_set_rx_mode (c->conn, MEMIF_RX_MODE_POLLING, i);
515 if (err != MEMIF_ERR_SUCCESS)
516 INFO ("memif_set_rx_mode: %s qid: %u", memif_strerror (err), i);
519 ti = (index * MAX_QUEUES) + i;
520 if (thread_data[ti].isRunning)
522 INFO ("thread id: %d already running!", ti);
525 thread_data[ti].index = index;
526 thread_data[ti].qid = i;
527 thread_data[ti].id = ti;
529 pthread_create (&thread[ti],
530 NULL, memif_rx_poll, (void *) &thread_data[ti]);
532 pthread_create (&thread[ti],
533 NULL, memif_rx_interrupt,
534 (void *) &thread_data[ti]);
541 /* informs user about disconnected status. private_ctx is used by user to identify connection
542 (multiple connections WIP) */
544 on_disconnect (memif_conn_handle_t conn, void *private_ctx)
547 long index = (*(long *) private_ctx);
548 memif_connection_t *c = &memif_connection[index];
550 INFO ("memif disconnected!");
551 /* inform thread in polling mode about memif disconenction */
553 for (i = 0; i < MAX_QUEUES; i++)
555 ti = (index * MAX_QUEUES) + i;
556 if (!thread_data[ti].isRunning)
559 pthread_kill (thread[ti], SIGUSR1); /* interrupt thread in interrupt mode */
560 pthread_join (thread[ti], &ptr);
565 /* user needs to watch new fd or stop watching fd that is about to be closed.
566 control fd will be modified during connection establishment to minimize CPU usage */
568 control_fd_update (int fd, uint8_t events, void *ctx)
570 /* convert memif event definitions to epoll events */
571 if (events & MEMIF_FD_EVENT_DEL)
572 return del_epoll_fd (main_epfd, fd);
575 if (events & MEMIF_FD_EVENT_READ)
577 if (events & MEMIF_FD_EVENT_WRITE)
580 if (events & MEMIF_FD_EVENT_MOD)
581 return mod_epoll_fd (main_epfd, fd, evt);
583 return add_epoll_fd (main_epfd, fd, evt);
587 icmpr_memif_create (long index)
589 if (index >= MAX_CONNS)
591 INFO ("connection array overflow");
596 INFO ("don't even try...");
599 memif_connection_t *c = &memif_connection[index];
601 /* setting memif connection arguments */
602 memif_conn_args_t args;
603 memset (&args, 0, sizeof (args));
605 args.log2_ring_size = 10;
606 args.buffer_size = 2048;
607 args.num_s2m_rings = 2;
608 args.num_m2s_rings = 2;
609 strncpy ((char *) args.interface_name, IF_NAME, strlen (IF_NAME));
611 /* socket filename is not specified, because this app is supposed to
612 connect to VPP over memif. so default socket filename will be used */
613 /* default socketfile = /run/vpp/memif.sock */
615 args.interface_id = index;
616 /* last argument for memif_create (void * private_ctx) is used by user
617 to identify connection. this context is returned with callbacks */
618 int err = memif_create (&c->conn,
619 &args, on_connect, on_disconnect, NULL,
621 if (err != MEMIF_ERR_SUCCESS)
623 INFO ("memif_create: %s", memif_strerror (err));
631 c->ip_addr[2] = c->index + 1;
637 icmpr_memif_delete (long index)
639 if (index >= MAX_CONNS)
641 INFO ("connection array overflow");
646 INFO ("don't even try...");
649 memif_connection_t *c = &memif_connection[index];
652 /* disconenct then delete memif connection */
653 err = memif_delete (&c->conn);
654 if (err != MEMIF_ERR_SUCCESS)
655 INFO ("memif_delete: %s", memif_strerror (err));
662 printf ("LIBMEMIF EXAMPLE APP: %s", APP_NAME);
667 printf ("==============================\n");
668 printf ("libmemif version: %s", LIBMEMIF_VERSION);
673 printf ("memif version: %d\n", memif_get_version ());
674 printf ("commands:\n");
675 printf ("\thelp - prints this help\n");
676 printf ("\texit - exit app\n");
677 printf ("\tconn <index> - create memif (slave-mode)\n");
678 printf ("\tdel <index> - delete memif\n");
679 printf ("\tshow - show connection details\n");
680 printf ("\tip-set <index> <ip-addr> - set interface ip address\n");
686 /* application cleanup */
689 for (i = 0; i < MAX_CONNS; i++)
691 memif_connection_t *c = &memif_connection[i];
693 icmpr_memif_delete (i);
696 err = memif_cleanup ();
697 if (err != MEMIF_ERR_SUCCESS)
698 INFO ("memif_delete: %s", memif_strerror (err));
704 icmpr_set_ip (long index, char *ip)
706 if (index >= MAX_CONNS)
708 INFO ("connection array overflow");
713 INFO ("don't even try...");
716 memif_connection_t *c = &memif_connection[index];
719 INFO ("no connection at index %ld", index);
726 ui = strtok (ip, ".");
729 tmp[0] = strtol (ui, &end, 10);
731 ui = strtok (NULL, ".");
734 tmp[1] = strtol (ui, &end, 10);
736 ui = strtok (NULL, ".");
739 tmp[2] = strtol (ui, &end, 10);
741 ui = strtok (NULL, ".");
744 tmp[3] = strtol (ui, &end, 10);
746 c->ip_addr[0] = tmp[0];
747 c->ip_addr[1] = tmp[1];
748 c->ip_addr[2] = tmp[2];
749 c->ip_addr[3] = tmp[3];
751 INFO ("memif %ld ip address set to %u.%u.%u.%u",
752 index, c->ip_addr[0], c->ip_addr[1], c->ip_addr[2], c->ip_addr[3]);
757 INFO ("invalid ip address");
763 user_input_handler ()
765 char *in = (char *) malloc (256);
766 char *ui = fgets (in, 256, stdin);
770 ui = strtok (in, " ");
771 if (strncmp (ui, "exit", 4) == 0)
777 else if (strncmp (ui, "help", 4) == 0)
782 else if (strncmp (ui, "conn", 4) == 0)
784 ui = strtok (NULL, " ");
786 icmpr_memif_create (strtol (ui, &end, 10));
788 INFO ("expected id");
791 else if (strncmp (ui, "del", 3) == 0)
793 ui = strtok (NULL, " ");
795 icmpr_memif_delete (strtol (ui, &end, 10));
797 INFO ("expected id");
800 else if (strncmp (ui, "show", 4) == 0)
802 print_memif_details ();
805 else if (strncmp (ui, "ip-set", 6) == 0)
807 ui = strtok (NULL, " ");
809 icmpr_set_ip (strtol (ui, &end, 10), strtok (NULL, " "));
811 INFO ("expected id");
816 DBG ("unknown command: %s", ui);
827 poll_event (int timeout)
829 struct epoll_event evt;
830 int app_err = 0, memif_err = 0, en = 0;
832 memset (&evt, 0, sizeof (evt));
833 evt.events = EPOLLIN | EPOLLOUT;
835 sigemptyset (&sigset);
836 en = epoll_pwait (main_epfd, &evt, 1, timeout, &sigset);
839 DBG ("epoll_pwait: %s", strerror (errno));
844 /* this app does not use any other file descriptors than stds and memif control fds */
847 /* event of memif control fd */
848 /* convert epolle events to memif events */
849 if (evt.events & EPOLLIN)
850 events |= MEMIF_FD_EVENT_READ;
851 if (evt.events & EPOLLOUT)
852 events |= MEMIF_FD_EVENT_WRITE;
853 if (evt.events & EPOLLERR)
854 events |= MEMIF_FD_EVENT_ERROR;
855 memif_err = memif_control_fd_handler (evt.data.fd, events);
856 if (memif_err != MEMIF_ERR_SUCCESS)
857 INFO ("memif_control_fd_handler: %s", memif_strerror (memif_err));
859 else if (evt.data.fd == 0)
861 app_err = user_input_handler ();
865 DBG ("unexpected event at memif_epfd. fd %d", evt.data.fd);
869 if ((app_err < 0) || (memif_err < 0))
872 DBG ("user input handler error");
874 DBG ("memif control fd handler error");
884 main_epfd = epoll_create (1);
885 add_epoll_fd (main_epfd, 0, EPOLLIN);
887 /* initialize memory interface */
889 /* if valid callback is passed as argument, fd event polling will be done by user
890 all file descriptors and events will be passed to user in this callback */
891 /* if callback is set to NULL libmemif will handle fd event polling */
892 err = memif_init (control_fd_update, APP_NAME, NULL, NULL, NULL);
893 if (err != MEMIF_ERR_SUCCESS)
894 INFO ("memif_init: %s", memif_strerror (err));
896 for (i = 0; i < MAX_CONNS; i++)
898 memif_connection[i].conn = NULL;
902 memset (&thread_data, 0, sizeof (memif_thread_data_t) * MAX_THREADS);
909 if (poll_event (-1) < 0)
911 DBG ("poll_event error!");