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
  25 /*
  26  * Where did we get this (S,G) from?
  27  *
  28  * IGMP - Learned from IGMP
  29  * PIM - Learned from PIM
  30  * SOURCE - Learned from Source multicast packet received
  31  * STAR - Inherited
  32  */
  33 #define PIM_OIF_FLAG_PROTO_IGMP   (1 << 0)
  34 #define PIM_OIF_FLAG_PROTO_PIM    (1 << 1)
  35 #define PIM_OIF_FLAG_PROTO_STAR   (1 << 2)
  36 #define PIM_OIF_FLAG_PROTO_VXLAN  (1 << 3)
  37 #define PIM_OIF_FLAG_PROTO_ANY                                 \
  38         (PIM_OIF_FLAG_PROTO_IGMP | PIM_OIF_FLAG_PROTO_PIM      \
  39          | PIM_OIF_FLAG_PROTO_STAR | PIM_OIF_FLAG_PROTO_VXLAN)
  40
  41 /*
  42  * We need a pimreg vif id from the kernel.
  43  * Since ifindex == vif id for most cases and the number
  44  * of expected interfaces is at most 100, using MAXVIFS -1
  45  * is probably ok.
  46  * Don't come running to me if this assumption is bad,
  47  * fix it.
  48  */
  49 #define PIM_OIF_PIM_REGISTER_VIF   0
  50 #define PIM_MAX_USABLE_VIFS        (MAXVIFS - 1)
  51
  52 struct channel_counts {
  53         unsigned long long lastused;
  54         unsigned long origpktcnt;
  55         unsigned long pktcnt;
  56         unsigned long oldpktcnt;
  57         unsigned long origbytecnt;
  58         unsigned long bytecnt;
  59         unsigned long oldbytecnt;
  60         unsigned long origwrong_if;
  61         unsigned long wrong_if;
  62         unsigned long oldwrong_if;
  63 };
  64
  65 /*
  66   qpim_channel_oil_list holds a list of struct channel_oil.
  67
  68   Each channel_oil.oil is used to control an (S,G) entry in the Kernel
  69   Multicast Forwarding Cache.
  70
  71   There is a case when we create a channel_oil but don't install in the kernel
  72
  73   Case where (S, G) entry not installed in the kernel:
  74     FRR receives IGMP/PIM (*, G) join and RP is not configured or
  75     not-reachable, then create a channel_oil for the group G with the incoming
  76     interface(channel_oil.oil.mfcc_parent) as invalid i.e "MAXVIF" and populate
  77     the outgoing interface where join is received. Keep this entry in the stack,
  78     but don't install in the kernel(channel_oil.installed = 0).
  79
  80   Case where (S, G) entry installed in the kernel:
  81     When RP is configured and is reachable for the group G, and receiving a
  82     join if channel_oil is already present then populate the incoming interface
  83     and install the entry in the kernel, if channel_oil not present, then create
  84     a new_channel oil(channel_oil.installed = 1).
  85
  86   is_valid: indicate if this entry is valid to get installed in kernel.
  87   installed: indicate if this entry is installed in the kernel.
  88
  89 */
  90
  91 struct channel_oil {
  92         struct pim_instance *pim;
  93
  94         struct mfcctl oil;
  95         int installed;
  96         int oil_inherited_rescan;
  97         int oil_size;
  98         int oil_ref_count;
  99         time_t oif_creation[MAXVIFS];
 100         uint32_t oif_flags[MAXVIFS];
 101         struct channel_counts cc;
 102         struct pim_upstream *up;
 103         time_t mroute_creation;
 104 };
 105
 106 extern struct list *pim_channel_oil_list;
 107
 108 void pim_oil_init(struct pim_instance *pim);
 109 void pim_oil_terminate(struct pim_instance *pim);
 110
 111 void pim_channel_oil_free(struct channel_oil *c_oil);
 112 struct channel_oil *pim_find_channel_oil(struct pim_instance *pim,
 113                                          struct prefix_sg *sg);
 114 struct channel_oil *pim_channel_oil_add(struct pim_instance *pim,
 115                                         struct prefix_sg *sg,
 116                                         int input_vif_index, const char *name);
 117 void pim_channel_oil_del(struct channel_oil *c_oil, const char *name);
 118
 119 int pim_channel_add_oif(struct channel_oil *c_oil, struct interface *oif,
 120                         uint32_t proto_mask);
 121 int pim_channel_del_oif(struct channel_oil *c_oil, struct interface *oif,
 122                         uint32_t proto_mask);
 123
 124 int pim_channel_oil_empty(struct channel_oil *c_oil);
 125
 126 char *pim_channel_oil_dump(struct channel_oil *c_oil, char *buf, size_t size);
 127 #endif /* PIM_OIL_H */