pimd/pim_oil.h

   1 /*
   2  * PIM for Quagga
   3  * Copyright (C) 2008  Everton da Silva Marques
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; see the file COPYING; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #ifndef PIM_OIL_H
  21 #define PIM_OIL_H
  22
  23 #include "pim_mroute.h"
  24 #include "pim_iface.h"
  25
  26 /*
  27  * Where did we get this (S,G) from?
  28  *
  29  * IGMP - Learned from IGMP
  30  * PIM - Learned from PIM
  31  * SOURCE - Learned from Source multicast packet received
  32  * STAR - Inherited
  33  */
  34 #define PIM_OIF_FLAG_PROTO_IGMP   (1 << 0)
  35 #define PIM_OIF_FLAG_PROTO_PIM    (1 << 1)
  36 #define PIM_OIF_FLAG_PROTO_STAR   (1 << 2)
  37 #define PIM_OIF_FLAG_PROTO_VXLAN  (1 << 3)
  38 #define PIM_OIF_FLAG_PROTO_ANY                                 \
  39         (PIM_OIF_FLAG_PROTO_IGMP | PIM_OIF_FLAG_PROTO_PIM      \
  40          | PIM_OIF_FLAG_PROTO_STAR | PIM_OIF_FLAG_PROTO_VXLAN)
  41
  42 /* OIF is present in the OIL but must not be used for forwarding traffic */
  43 #define PIM_OIF_FLAG_MUTE         (1 << 4)
  44 /*
  45  * We need a pimreg vif id from the kernel.
  46  * Since ifindex == vif id for most cases and the number
  47  * of expected interfaces is at most 100, using MAXVIFS -1
  48  * is probably ok.
  49  * Don't come running to me if this assumption is bad,
  50  * fix it.
  51  */
  52 #define PIM_OIF_PIM_REGISTER_VIF   0
  53 #define PIM_MAX_USABLE_VIFS        (MAXVIFS - 1)
  54
  55 struct channel_counts {
  56         unsigned long long lastused;
  57         unsigned long origpktcnt;
  58         unsigned long pktcnt;
  59         unsigned long oldpktcnt;
  60         unsigned long origbytecnt;
  61         unsigned long bytecnt;
  62         unsigned long oldbytecnt;
  63         unsigned long origwrong_if;
  64         unsigned long wrong_if;
  65         unsigned long oldwrong_if;
  66 };
  67
  68 /*
  69   qpim_channel_oil_list holds a list of struct channel_oil.
  70
  71   Each channel_oil.oil is used to control an (S,G) entry in the Kernel
  72   Multicast Forwarding Cache.
  73
  74   There is a case when we create a channel_oil but don't install in the kernel
  75
  76   Case where (S, G) entry not installed in the kernel:
  77     FRR receives IGMP/PIM (*, G) join and RP is not configured or
  78     not-reachable, then create a channel_oil for the group G with the incoming
  79     interface(channel_oil.oil.mfcc_parent) as invalid i.e "MAXVIF" and populate
  80     the outgoing interface where join is received. Keep this entry in the stack,
  81     but don't install in the kernel(channel_oil.installed = 0).
  82
  83   Case where (S, G) entry installed in the kernel:
  84     When RP is configured and is reachable for the group G, and receiving a
  85     join if channel_oil is already present then populate the incoming interface
  86     and install the entry in the kernel, if channel_oil not present, then create
  87     a new_channel oil(channel_oil.installed = 1).
  88
  89   is_valid: indicate if this entry is valid to get installed in kernel.
  90   installed: indicate if this entry is installed in the kernel.
  91
  92 */
  93
  94 struct channel_oil {
  95         struct pim_instance *pim;
  96
  97         struct mfcctl oil;
  98         int installed;
  99         int oil_inherited_rescan;
 100         int oil_size;
 101         int oil_ref_count;
 102         time_t oif_creation[MAXVIFS];
 103         uint32_t oif_flags[MAXVIFS];
 104         struct channel_counts cc;
 105         struct pim_upstream *up;
 106         time_t mroute_creation;
 107 };
 108
 109 extern struct list *pim_channel_oil_list;
 110
 111 void pim_oil_init(struct pim_instance *pim);
 112 void pim_oil_terminate(struct pim_instance *pim);
 113
 114 void pim_channel_oil_free(struct channel_oil *c_oil);
 115 struct channel_oil *pim_find_channel_oil(struct pim_instance *pim,
 116                                          struct prefix_sg *sg);
 117 struct channel_oil *pim_channel_oil_add(struct pim_instance *pim,
 118                                         struct prefix_sg *sg,
 119                                         const char *name);
 120 void pim_channel_oil_change_iif(struct pim_instance *pim,
 121                                 struct channel_oil *c_oil, int input_vif_index,
 122                                 const char *name);
 123 struct channel_oil *pim_channel_oil_del(struct channel_oil *c_oil,
 124                 const char *name);
 125
 126 int pim_channel_add_oif(struct channel_oil *c_oil, struct interface *oif,
 127                         uint32_t proto_mask, const char *caller);
 128 int pim_channel_del_oif(struct channel_oil *c_oil, struct interface *oif,
 129                         uint32_t proto_mask, const char *caller);
 130
 131 int pim_channel_oil_empty(struct channel_oil *c_oil);
 132
 133 char *pim_channel_oil_dump(struct channel_oil *c_oil, char *buf, size_t size);
 134
 135 void pim_channel_update_oif_mute(struct channel_oil *c_oil,
 136                 struct pim_interface *pim_ifp);
 137
 138 void pim_channel_oil_upstream_deref(struct channel_oil *c_oil);
 139 void pim_channel_del_inherited_oif(struct channel_oil *c_oil,
 140                 struct interface *oif, const char *caller);
 141
 142 #endif /* PIM_OIL_H */