include/linux/mroute.h

   1 #ifndef __LINUX_MROUTE_H
   2 #define __LINUX_MROUTE_H
   3
   4 #include <linux/sockios.h>
   5 #include <linux/types.h>
   6 #ifdef __KERNEL__
   7 #include <linux/in.h>
   8 #endif
   9
  10 /*
  11  *      Based on the MROUTING 3.5 defines primarily to keep
  12  *      source compatibility with BSD.
  13  *
  14  *      See the mrouted code for the original history.
  15  *
  16  *      Protocol Independent Multicast (PIM) data structures included
  17  *      Carlos Picoto (cap@di.fc.ul.pt)
  18  *
  19  */
  20
  21 #define MRT_BASE        200
  22 #define MRT_INIT        (MRT_BASE)      /* Activate the kernel mroute code      */
  23 #define MRT_DONE        (MRT_BASE+1)    /* Shutdown the kernel mroute           */
  24 #define MRT_ADD_VIF     (MRT_BASE+2)    /* Add a virtual interface              */
  25 #define MRT_DEL_VIF     (MRT_BASE+3)    /* Delete a virtual interface           */
  26 #define MRT_ADD_MFC     (MRT_BASE+4)    /* Add a multicast forwarding entry     */
  27 #define MRT_DEL_MFC     (MRT_BASE+5)    /* Delete a multicast forwarding entry  */
  28 #define MRT_VERSION     (MRT_BASE+6)    /* Get the kernel multicast version     */
  29 #define MRT_ASSERT      (MRT_BASE+7)    /* Activate PIM assert mode             */
  30 #define MRT_PIM         (MRT_BASE+8)    /* enable PIM code      */
  31
  32 #define SIOCGETVIFCNT   SIOCPROTOPRIVATE        /* IP protocol privates */
  33 #define SIOCGETSGCNT    (SIOCPROTOPRIVATE+1)
  34 #define SIOCGETRPF      (SIOCPROTOPRIVATE+2)
  35
  36 #define MAXVIFS         32
  37 typedef unsigned long vifbitmap_t;      /* User mode code depends on this lot */
  38 typedef unsigned short vifi_t;
  39 #define ALL_VIFS        ((vifi_t)(-1))
  40
  41 /*
  42  *      Same idea as select
  43  */
  44
  45 #define VIFM_SET(n,m)   ((m)|=(1<<(n)))
  46 #define VIFM_CLR(n,m)   ((m)&=~(1<<(n)))
  47 #define VIFM_ISSET(n,m) ((m)&(1<<(n)))
  48 #define VIFM_CLRALL(m)  ((m)=0)
  49 #define VIFM_COPY(mfrom,mto)    ((mto)=(mfrom))
  50 #define VIFM_SAME(m1,m2)        ((m1)==(m2))
  51
  52 /*
  53  *      Passed by mrouted for an MRT_ADD_VIF - again we use the
  54  *      mrouted 3.6 structures for compatibility
  55  */
  56
  57 struct vifctl {
  58         vifi_t  vifc_vifi;              /* Index of VIF */
  59         unsigned char vifc_flags;       /* VIFF_ flags */
  60         unsigned char vifc_threshold;   /* ttl limit */
  61         unsigned int vifc_rate_limit;   /* Rate limiter values (NI) */
  62         union {
  63                 struct in_addr vifc_lcl_addr;     /* Local interface address */
  64                 int            vifc_lcl_ifindex;  /* Local interface index   */
  65         };
  66         struct in_addr vifc_rmt_addr;   /* IPIP tunnel addr */
  67 };
  68
  69 #define VIFF_TUNNEL             0x1     /* IPIP tunnel */
  70 #define VIFF_SRCRT              0x2     /* NI */
  71 #define VIFF_REGISTER           0x4     /* register vif */
  72 #define VIFF_USE_IFINDEX        0x8     /* use vifc_lcl_ifindex instead of
  73                                            vifc_lcl_addr to find an interface */
  74
  75 /*
  76  *      Cache manipulation structures for mrouted and PIMd
  77  */
  78
  79 struct mfcctl {
  80         struct in_addr mfcc_origin;             /* Origin of mcast      */
  81         struct in_addr mfcc_mcastgrp;           /* Group in question    */
  82         vifi_t  mfcc_parent;                    /* Where it arrived     */
  83         unsigned char mfcc_ttls[MAXVIFS];       /* Where it is going    */
  84         unsigned int mfcc_pkt_cnt;              /* pkt count for src-grp */
  85         unsigned int mfcc_byte_cnt;
  86         unsigned int mfcc_wrong_if;
  87         int          mfcc_expire;
  88 };
  89
  90 /*
  91  *      Group count retrieval for mrouted
  92  */
  93
  94 struct sioc_sg_req {
  95         struct in_addr src;
  96         struct in_addr grp;
  97         unsigned long pktcnt;
  98         unsigned long bytecnt;
  99         unsigned long wrong_if;
 100 };
 101
 102 /*
 103  *      To get vif packet counts
 104  */
 105
 106 struct sioc_vif_req {
 107         vifi_t  vifi;           /* Which iface */
 108         unsigned long icount;   /* In packets */
 109         unsigned long ocount;   /* Out packets */
 110         unsigned long ibytes;   /* In bytes */
 111         unsigned long obytes;   /* Out bytes */
 112 };
 113
 114 /*
 115  *      This is the format the mroute daemon expects to see IGMP control
 116  *      data. Magically happens to be like an IP packet as per the original
 117  */
 118
 119 struct igmpmsg {
 120         __u32 unused1,unused2;
 121         unsigned char im_msgtype;               /* What is this */
 122         unsigned char im_mbz;                   /* Must be zero */
 123         unsigned char im_vif;                   /* Interface (this ought to be a vifi_t!) */
 124         unsigned char unused3;
 125         struct in_addr im_src,im_dst;
 126 };
 127
 128 /*
 129  *      That's all usermode folks
 130  */
 131
 132 #ifdef __KERNEL__
 133 #include <linux/pim.h>
 134 #include <net/sock.h>
 135
 136 #ifdef CONFIG_IP_MROUTE
 137 static inline int ip_mroute_opt(int opt)
 138 {
 139         return (opt >= MRT_BASE) && (opt <= MRT_BASE + 10);
 140 }
 141 #else
 142 static inline int ip_mroute_opt(int opt)
 143 {
 144         return 0;
 145 }
 146 #endif
 147
 148 #ifdef CONFIG_IP_MROUTE
 149 extern int ip_mroute_setsockopt(struct sock *, int, char __user *, unsigned int);
 150 extern int ip_mroute_getsockopt(struct sock *, int, char __user *, int __user *);
 151 extern int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg);
 152 extern int ip_mr_init(void);
 153 #else
 154 static inline
 155 int ip_mroute_setsockopt(struct sock *sock,
 156                          int optname, char __user *optval, unsigned int optlen)
 157 {
 158         return -ENOPROTOOPT;
 159 }
 160
 161 static inline
 162 int ip_mroute_getsockopt(struct sock *sock,
 163                          int optname, char __user *optval, int __user *optlen)
 164 {
 165         return -ENOPROTOOPT;
 166 }
 167
 168 static inline
 169 int ipmr_ioctl(struct sock *sk, int cmd, void __user *arg)
 170 {
 171         return -ENOIOCTLCMD;
 172 }
 173
 174 static inline int ip_mr_init(void)
 175 {
 176         return 0;
 177 }
 178 #endif
 179
 180 struct vif_device {
 181         struct net_device       *dev;                   /* Device we are using */
 182         unsigned long   bytes_in,bytes_out;
 183         unsigned long   pkt_in,pkt_out;         /* Statistics                   */
 184         unsigned long   rate_limit;             /* Traffic shaping (NI)         */
 185         unsigned char   threshold;              /* TTL threshold                */
 186         unsigned short  flags;                  /* Control flags                */
 187         __be32          local,remote;           /* Addresses(remote for tunnels)*/
 188         int             link;                   /* Physical interface index     */
 189 };
 190
 191 #define VIFF_STATIC 0x8000
 192
 193 struct mfc_cache {
 194         struct mfc_cache *next;                 /* Next entry on cache line     */
 195 #ifdef CONFIG_NET_NS
 196         struct net *mfc_net;
 197 #endif
 198         __be32 mfc_mcastgrp;                    /* Group the entry belongs to   */
 199         __be32 mfc_origin;                      /* Source of packet             */
 200         vifi_t mfc_parent;                      /* Source interface             */
 201         int mfc_flags;                          /* Flags on line                */
 202
 203         union {
 204                 struct {
 205                         unsigned long expires;
 206                         struct sk_buff_head unresolved; /* Unresolved buffers           */
 207                 } unres;
 208                 struct {
 209                         unsigned long last_assert;
 210                         int minvif;
 211                         int maxvif;
 212                         unsigned long bytes;
 213                         unsigned long pkt;
 214                         unsigned long wrong_if;
 215                         unsigned char ttls[MAXVIFS];    /* TTL thresholds               */
 216                 } res;
 217         } mfc_un;
 218 };
 219
 220 static inline
 221 struct net *mfc_net(const struct mfc_cache *mfc)
 222 {
 223         return read_pnet(&mfc->mfc_net);
 224 }
 225
 226 static inline
 227 void mfc_net_set(struct mfc_cache *mfc, struct net *net)
 228 {
 229         write_pnet(&mfc->mfc_net, hold_net(net));
 230 }
 231
 232 #define MFC_STATIC              1
 233 #define MFC_NOTIFY              2
 234
 235 #define MFC_LINES               64
 236
 237 #ifdef __BIG_ENDIAN
 238 #define MFC_HASH(a,b)   (((((__force u32)(__be32)a)>>24)^(((__force u32)(__be32)b)>>26))&(MFC_LINES-1))
 239 #else
 240 #define MFC_HASH(a,b)   ((((__force u32)(__be32)a)^(((__force u32)(__be32)b)>>2))&(MFC_LINES-1))
 241 #endif
 242
 243 #endif
 244
 245
 246 #define MFC_ASSERT_THRESH (3*HZ)                /* Maximal freq. of asserts */
 247
 248 /*
 249  *      Pseudo messages used by mrouted
 250  */
 251
 252 #define IGMPMSG_NOCACHE         1               /* Kern cache fill request to mrouted */
 253 #define IGMPMSG_WRONGVIF        2               /* For PIM assert processing (unused) */
 254 #define IGMPMSG_WHOLEPKT        3               /* For PIM Register processing */
 255
 256 #ifdef __KERNEL__
 257 struct rtmsg;
 258 extern int ipmr_get_route(struct net *net, struct sk_buff *skb,
 259                           struct rtmsg *rtm, int nowait);
 260 #endif
 261
 262 #endif