doc: use code snippets in sample app guides

[dpdk.git] / examples / flow_filtering / main.c

diff --git a/examples/flow_filtering/main.c b/examples/flow_filtering/main.c
index f1940bc..29fb4b3 100644 (file)
--- a/examples/flow_filtering/main.c
+++ b/examples/flow_filtering/main.c
@@ -51,6 +51,7 @@ print_ether_addr(const char *what, struct rte_ether_addr *eth_addr)
        printf("%s%s", what, buf);
 }
 
+/* Main_loop for flow filtering. 8< */
 static int
 main_loop(void)
 {
@@ -62,6 +63,7 @@ main_loop(void)
        uint16_t j;
        int ret;
 
+       /* Reading the packets from all queues. 8< */
        while (!force_quit) {
                for (i = 0; i < nr_queues; i++) {
                        nb_rx = rte_eth_rx_burst(port_id,
@@ -85,6 +87,7 @@ main_loop(void)
                        }
                }
        }
+       /* >8 End of reading the packets from all queues. */
 
        /* closing and releasing resources */
        rte_flow_flush(port_id, &error);
@@ -95,6 +98,7 @@ main_loop(void)
        rte_eth_dev_close(port_id);
        return ret;
 }
+/* >8 End of main_loop for flow filtering. */
 
 #define CHECK_INTERVAL 1000  /* 100ms */
 #define MAX_REPEAT_TIMES 90  /* 9s (90 * 100ms) in total */
@@ -121,11 +125,13 @@ assert_link_status(void)
                rte_exit(EXIT_FAILURE, ":: error: link is still down\n");
 }
 
+/* Port initialization used in flow filtering. 8< */
 static void
 init_port(void)
 {
        int ret;
        uint16_t i;
+       /* Ethernet port configured with default settings. 8< */
        struct rte_eth_conf port_conf = {
                .rxmode = {
                        .split_hdr_size = 0,
@@ -162,6 +168,9 @@ init_port(void)
 
        rxq_conf = dev_info.default_rxconf;
        rxq_conf.offloads = port_conf.rxmode.offloads;
+       /* >8 End of ethernet port configured with default settings. */
+
+       /* Configuring number of RX and TX queues connected to single port. 8< */
        for (i = 0; i < nr_queues; i++) {
                ret = rte_eth_rx_queue_setup(port_id, i, 512,
                                     rte_eth_dev_socket_id(port_id),
@@ -187,24 +196,30 @@ init_port(void)
                                ret, port_id);
                }
        }
+       /* >8 End of Configuring RX and TX queues connected to single port. */
 
+       /* Setting the RX port to promiscuous mode. 8< */
        ret = rte_eth_promiscuous_enable(port_id);
        if (ret != 0)
                rte_exit(EXIT_FAILURE,
                        ":: promiscuous mode enable failed: err=%s, port=%u\n",
                        rte_strerror(-ret), port_id);
+       /* >8 End of setting the RX port to promiscuous mode. */
 
+       /* Starting the port. 8< */
        ret = rte_eth_dev_start(port_id);
        if (ret < 0) {
                rte_exit(EXIT_FAILURE,
                        "rte_eth_dev_start:err=%d, port=%u\n",
                        ret, port_id);
        }
+       /* >8 End of starting the port. */
 
        assert_link_status();
 
        printf(":: initializing port: %d done\n", port_id);
 }
+/* >8 End of Port initialization used in flow filtering. */
 
 static void
 signal_handler(int signum)
@@ -223,9 +238,11 @@ main(int argc, char **argv)
        uint16_t nr_ports;
        struct rte_flow_error error;
 
+       /* Initialize EAL. 8< */
        ret = rte_eal_init(argc, argv);
        if (ret < 0)
                rte_exit(EXIT_FAILURE, ":: invalid EAL arguments\n");
+       /* >8 End of Initialization of EAL. */
 
        force_quit = false;
        signal(SIGINT, signal_handler);
@@ -239,26 +256,34 @@ main(int argc, char **argv)
                printf(":: warn: %d ports detected, but we use only one: port %u\n",
                        nr_ports, port_id);
        }
+       /* Allocates a mempool to hold the mbufs. 8< */
        mbuf_pool = rte_pktmbuf_pool_create("mbuf_pool", 4096, 128, 0,
                                            RTE_MBUF_DEFAULT_BUF_SIZE,
                                            rte_socket_id());
+       /* >8 End of allocating a mempool to hold the mbufs. */
        if (mbuf_pool == NULL)
                rte_exit(EXIT_FAILURE, "Cannot init mbuf pool\n");
 
+       /* Initializes all the ports using the user defined init_port(). 8< */
        init_port();
+       /* >8 End of Initializing the ports using user defined init_port(). */
 
-       /* create flow for send packet with */
+       /* Create flow for send packet with. 8< */
        flow = generate_ipv4_flow(port_id, selected_queue,
                                SRC_IP, EMPTY_MASK,
                                DEST_IP, FULL_MASK, &error);
+       /* >8 End of create flow and the flow rule. */
        if (!flow) {
                printf("Flow can't be created %d message: %s\n",
                        error.type,
                        error.message ? error.message : "(no stated reason)");
                rte_exit(EXIT_FAILURE, "error in creating flow");
        }
+       /* >8 End of creating flow for send packet with. */
 
+       /* Launching main_loop(). 8< */
        ret = main_loop();
+       /* >8 End of launching main_loop(). */
 
        /* clean up the EAL */
        rte_eal_cleanup();