net: packet: document available fanout policies
authorDaniel Borkmann <dborkman@redhat.com>
Wed, 28 Aug 2013 20:13:11 +0000 (22:13 +0200)
committerDavid S. Miller <davem@davemloft.net>
Thu, 29 Aug 2013 20:43:29 +0000 (16:43 -0400)
Update documentation to add fanout policies that are available.

Signed-off-by: Daniel Borkmann <dborkman@redhat.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/networking/packet_mmap.txt

index 8572796b1eb64f97560d63a410a972cbcced08fc..c01223628a87ae5e522b714c8a3a86edda15dea5 100644 (file)
@@ -543,6 +543,14 @@ TPACKET_V2 --> TPACKET_V3:
 In the AF_PACKET fanout mode, packet reception can be load balanced among
 processes. This also works in combination with mmap(2) on packet sockets.
 
+Currently implemented fanout policies are:
+
+  - PACKET_FANOUT_HASH: schedule to socket by skb's rxhash
+  - PACKET_FANOUT_LB: schedule to socket by round-robin
+  - PACKET_FANOUT_CPU: schedule to socket by CPU packet arrives on
+  - PACKET_FANOUT_RND: schedule to socket by random selection
+  - PACKET_FANOUT_ROLLOVER: if one socket is full, rollover to another
+
 Minimal example code by David S. Miller (try things like "./test eth0 hash",
 "./test eth0 lb", etc.):