tools: move to usertools

[dpdk.git] / doc / guides / sample_app_ug / ipv4_multicast.rst

diff --git a/doc/guides/sample_app_ug/ipv4_multicast.rst b/doc/guides/sample_app_ug/ipv4_multicast.rst
index a9c9df8..72da8c4 100644 (file)
--- a/doc/guides/sample_app_ug/ipv4_multicast.rst
+++ b/doc/guides/sample_app_ug/ipv4_multicast.rst
@@ -32,15 +32,14 @@ IPv4 Multicast Sample Application
 =================================
 
 The IPv4 Multicast application is a simple example of packet processing
 =================================
 
 The IPv4 Multicast application is a simple example of packet processing

-using the Intel® Data Plane Development Kit (Intel® DPDK).
+using the Data Plane Development Kit (DPDK).

 The application performs L3 multicasting.
 
 Overview
 --------
 
 The application demonstrates the use of zero-copy buffers for packet forwarding.
 The application performs L3 multicasting.
 
 Overview
 --------
 
 The application demonstrates the use of zero-copy buffers for packet forwarding.

-The initialization and run-time paths are very similar to those of the L2 forwarding application
-(see Chapter 9 "L2 Forwarding Sample Application (in Real and Virtualized Environments)" for details more information).
+The initialization and run-time paths are very similar to those of the :doc:`l2_forward_real_virtual`.

 This guide highlights the differences between the two applications.
 There are two key differences from the L2 Forwarding sample application:
 
 This guide highlights the differences between the two applications.
 There are two key differences from the L2 Forwarding sample application:
 


@@ -76,7 +75,7 @@ To compile the application:
 
         export RTE_TARGET=x86_64-native-linuxapp-gcc
 
 
         export RTE_TARGET=x86_64-native-linuxapp-gcc
 

-See the *Intel® DPDK Getting Started Guide* for possible RTE_TARGET values.
+See the *DPDK Getting Started Guide* for possible RTE_TARGET values.

 
 #.  Build the application:
 
 
 #.  Build the application:
 


@@ -126,7 +125,7 @@ In this command:
 
 *   The -q option assigns 1 queue to each lcore
 
 
 *   The -q option assigns 1 queue to each lcore
 

-Refer to the *Intel® DPDK Getting Started Guide* for general information on running applications
+Refer to the *DPDK Getting Started Guide* for general information on running applications

 and the Environment Abstraction Layer (EAL) options.
 
 Explanation
 and the Environment Abstraction Layer (EAL) options.
 
 Explanation


@@ -134,8 +133,7 @@ Explanation
 
 The following sections provide some explanation of the code.
 As mentioned in the overview section,
 
 The following sections provide some explanation of the code.
 As mentioned in the overview section,

-the initialization and run-time paths are very similar to those of the L2 Forwarding sample application
-(see Chapter 9 "L2 Forwarding Sample Application in Real and Virtualized Environments" for more information).
+the initialization and run-time paths are very similar to those of the :doc:`l2_forward_real_virtual`.

 The following sections describe aspects that are specific to the IPv4 Multicast sample application.
 
 Memory Pool Initialization
 The following sections describe aspects that are specific to the IPv4 Multicast sample application.
 
 Memory Pool Initialization


@@ -195,7 +193,7 @@ Firstly, the Ethernet* header is removed from the packet and the IPv4 address is
     /* Remove the Ethernet header from the input packet */
 
     iphdr = (struct ipv4_hdr *)rte_pktmbuf_adj(m, sizeof(struct ether_hdr));
     /* Remove the Ethernet header from the input packet */
 
     iphdr = (struct ipv4_hdr *)rte_pktmbuf_adj(m, sizeof(struct ether_hdr));

-    RTE_MBUF_ASSERT(iphdr != NULL);
+    RTE_ASSERT(iphdr != NULL);

     dest_addr = rte_be_to_cpu_32(iphdr->dst_addr);
 
 Then, the packet is checked to see if it has a multicast destination address and
     dest_addr = rte_be_to_cpu_32(iphdr->dst_addr);
 
 Then, the packet is checked to see if it has a multicast destination address and


@@ -222,7 +220,7 @@ Then, the number of ports in the destination portmask is calculated with the hel
 
         for (n = 0; v != 0; v &= v - 1, n++)
            ;
 
         for (n = 0; v != 0; v &= v - 1, n++)
            ;

-        return (n);
+        return n;

     }
 
 This is done to determine which forwarding algorithm to use.
     }
 
 This is done to determine which forwarding algorithm to use.


@@ -232,12 +230,12 @@ Thereafter, a destination Ethernet address is constructed:
 
 .. code-block:: c
 
 
 .. code-block:: c
 

-    /* construct destination ethernet address */
+    /* construct destination Ethernet address */

 
     dst_eth_addr = ETHER_ADDR_FOR_IPV4_MCAST(dest_addr);
 
 Since Ethernet addresses are also part of the multicast process, each outgoing packet carries the same destination Ethernet address.
 
     dst_eth_addr = ETHER_ADDR_FOR_IPV4_MCAST(dest_addr);
 
 Since Ethernet addresses are also part of the multicast process, each outgoing packet carries the same destination Ethernet address.

-The destination Ethernet address is constructed from the lower 23 bits of the multicast group ORed
+The destination Ethernet address is constructed from the lower 23 bits of the multicast group OR-ed

 with the Ethernet address 01:00:5e:00:00:00, as per RFC 1112:
 
 .. code-block:: c
 with the Ethernet address 01:00:5e:00:00:00, as per RFC 1112:
 
 .. code-block:: c


@@ -273,7 +271,7 @@ The actual packet transmission is done in the mcast_send_pkt() function:
 
         ethdr = (struct ether_hdr *)rte_pktmbuf_prepend(pkt, (uint16_t) sizeof(*ethdr));
 
 
         ethdr = (struct ether_hdr *)rte_pktmbuf_prepend(pkt, (uint16_t) sizeof(*ethdr));
 

-        RTE_MBUF_ASSERT(ethdr != NULL);
+        RTE_ASSERT(ethdr != NULL);

 
         ether_addr_copy(dest_addr, &ethdr->d_addr);
         ether_addr_copy(&ports_eth_addr[port], &ethdr->s_addr);
 
         ether_addr_copy(dest_addr, &ethdr->d_addr);
         ether_addr_copy(&ports_eth_addr[port], &ethdr->s_addr);


@@ -344,13 +342,13 @@ It is the mcast_out_pkt() function that performs the packet duplication (either
         /* Create new mbuf for the header. */
 
         if (unlikely ((hdr = rte_pktmbuf_alloc(header_pool)) == NULL))
         /* Create new mbuf for the header. */
 
         if (unlikely ((hdr = rte_pktmbuf_alloc(header_pool)) == NULL))

-            return (NULL);
+            return NULL;

 
         /* If requested, then make a new clone packet. */
 
         if (use_clone != 0 && unlikely ((pkt = rte_pktmbuf_clone(pkt, clone_pool)) == NULL)) {
             rte_pktmbuf_free(hdr);
 
         /* If requested, then make a new clone packet. */
 
         if (use_clone != 0 && unlikely ((pkt = rte_pktmbuf_clone(pkt, clone_pool)) == NULL)) {
             rte_pktmbuf_free(hdr);

-            return (NULL);
+            return NULL;

         }
 
         /* prepend new header */
         }
 
         /* prepend new header */


@@ -370,5 +368,5 @@ It is the mcast_out_pkt() function that performs the packet duplication (either
         hdr->ol_flags = pkt->ol_flags;
         rte_mbuf_sanity_check(hdr, RTE_MBUF_PKT, 1);
 
         hdr->ol_flags = pkt->ol_flags;
         rte_mbuf_sanity_check(hdr, RTE_MBUF_PKT, 1);
 

-        return (hdr);
+        return hdr;

     }
     }