Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (OpenBSD-5.7)
Apropos / Subsearch:
optional field

PIM(4)                   BSD Kernel Interfaces Manual                   PIM(4)

     pim -- Protocol Independent Multicast

     options MROUTING
     options PIM

     #include <&lt;sys/types.h>&gt;
     #include <&lt;sys/socket.h>&gt;
     #include <&lt;netinet/in.h>&gt;
     #include <&lt;netinet/ip_mroute.h>&gt;
     #include <&lt;netinet/pim.h>&gt;

     getsockopt(int s, IPPROTO_IP, MRT_PIM, void *optval, socklen_t *optlen);

     setsockopt(int s, IPPROTO_IP, MRT_PIM, const void *optval,
           socklen_t optlen);

     getsockopt(int s, IPPROTO_IPV6, MRT6_PIM, void *optval,
           socklen_t *optlen);

     setsockopt(int s, IPPROTO_IPV6, MRT6_PIM, const void *optval,
           socklen_t optlen);

     PIM is the common name for two multicast routing protocols: Protocol
     Independent Multicast - Sparse Mode (PIM-SM) and Protocol Independent
     Multicast - Dense Mode (PIM-DM).

     PIM-SM is a multicast routing protocol that can use the underlying uni-
     cast routing information base or a separate multicast-capable routing
     information base.  It builds unidirectional shared trees rooted at a Ren-
     dezvous Point (RP) per group, and optionally creates shortest-path trees
     per source.

     PIM-DM is a multicast routing protocol that uses the underlying unicast
     routing information base to flood multicast datagrams to all multicast
     routers.  Prune messages are used to prevent future datagrams from propa-
     gating to routers with no group membership information.

     Both PIM-SM and PIM-DM are fairly complex protocols, though PIM-SM is
     much more complex.  To enable PIM-SM or PIM-DM multicast routing in a
     router, the user must enable multicast forwarding via the
     net.inet.ip.mforwarding sysctl(8) and PIM processing in the kernel (see
     SYNOPSIS for the correct kernel configuration option).  The user must
     also run a PIM-SM or PIM-DM capable user-level process.  From a devel-
     oper's point of view, the programming guide described in the Programming
     Guide section should be used to control the PIM processing in the kernel.

   Programming Guide
     After a multicast routing socket is open and multicast forwarding is
     enabled in the kernel (see multicast(4)), one of the following socket
     options should be used to enable or disable PIM processing in the kernel.
     Note that those options require certain privilege (i.e., root privilege):

         /* IPv4 */
         int v = 1;        /* 1 to enable, or 0 to disable */
         setsockopt(mrouter_s4, IPPROTO_IP, MRT_PIM, (void *)&v, sizeof(v));

         /* IPv6 */
         int v = 1;        /* 1 to enable, or 0 to disable */
         setsockopt(mrouter_s6, IPPROTO_IPV6, MRT6_PIM, (void *)&v, sizeof(v));

     After PIM processing is enabled, the multicast-capable interfaces should
     be added (see multicast(4)).  For PIM-SM, the PIM-Register virtual inter-
     face must be added as well.  This can be accomplished by using the fol-
     lowing options:

           /* IPv4 */
           struct vifctl vc;
           memset(&vc, 0, sizeof(vc));
           /* Assign all vifctl fields as appropriate */
           if (is_pim_register_vif)
               vc.vifc_flags |= VIFF_REGISTER;
           setsockopt(mrouter_s4, IPPROTO_IP, MRT_ADD_VIF, (void *)&vc,

           /* IPv6 */
           struct mif6ctl mc;
           memset(&mc, 0, sizeof(mc));
           /* Assign all mif6ctl fields as appropriate */
           if (is_pim_register_vif)
               mc.mif6c_flags |= MIFF_REGISTER;
           setsockopt(mrouter_s6, IPPROTO_IPV6, MRT6_ADD_MIF, (void *)&mc,

     Sending or receiving of PIM packets can be accomplished by first opening
     a ``raw socket'' (see socket(2)), with protocol value of IPPROTO_PIM:

           /* IPv4 */
           int pim_s4;
           pim_s4 = socket(AF_INET, SOCK_RAW, IPPROTO_PIM);

           /* IPv6 */
           int pim_s6;
           pim_s6 = socket(AF_INET6, SOCK_RAW, IPPROTO_PIM);

     Then the following system calls can be used to send or receive PIM pack-
     ets: sendto(2), sendmsg(2), recvfrom(2), and recvmsg(2).

     getsockopt(2), recvfrom(2), recvmsg(2), sendmsg(2), sendto(2),
     setsockopt(2), socket(2), inet(4), intro(4), ip(4), multicast(4),

     A. Adams, J. Nicholas, and W. Siadak, Protocol Independent Multicast -
     Dense Mode (PIM-DM): Protocol Specification (Revised), RFC 3973, January

     B. Fenner, M. Handley, H. Holbrook, and I. Kouvelas, Protocol Independent
     Multicast - Sparse Mode (PIM-SM): Protocol Specification (Revised), RFC
     4601, August 2006.

     N. Bhaskar, A. Gall, J. Lingard, and S. Venaas, Bootstrap Router (BSR)
     Mechanism for Protocol Independent Multicast (PIM), RFC 5059, January

     The original IPv4 PIM kernel support for IRIX and SunOS-4.x was imple-
     mented by Ahmed Helmy (USC and SGI).  Later the code was ported to vari-
     ous BSD flavors and modified by George Edmond Eddy (Rusty) (ISI), Hitoshi
     Asaeda (WIDE Project), and Pavlin Radoslavov (USC/ISI and ICSI).

     The IPv6 PIM kernel support was implemented by the KAME project
     (http://www.kame.net), and was based on the IPv4 PIM kernel support.

     This manual page was written by Pavlin Radoslavov (ICSI).

BSD                             March 24, 2017                             BSD