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_SOURCE (1 << 2)
  36 #define PIM_OIF_FLAG_PROTO_STAR   (1 << 3)
  37 #define PIM_OIF_FLAG_PROTO_ANY    (PIM_OIF_FLAG_PROTO_IGMP | \
  38                                    PIM_OIF_FLAG_PROTO_PIM | \
  39                                    PIM_OIF_FLAG_PROTO_SOURCE | \
  40                                    PIM_OIF_FLAG_PROTO_STAR)
  41
  42 /*
  43  * We need a pimreg vif id from the kernel.
  44  * Since ifindex == vif id for most cases and the number
  45  * of expected interfaces is at most 100, using MAXVIFS -1
  46  * is probably ok.
  47  * Don't come running to me if this assumption is bad,
  48  * fix it.
  49  */
  50 #define PIM_OIF_PIM_REGISTER_VIF   0
  51 #define PIM_MAX_USABLE_VIFS        (MAXVIFS - 1)
  52
  53
  54 struct channel_counts
  55 {
  56   unsigned long long lastused;
  57   unsigned long pktcnt;
  58   unsigned long oldpktcnt;
  59   unsigned long bytecnt;
  60   unsigned long oldbytecnt;
  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
  72 struct channel_oil {
  73   struct mfcctl oil;
  74   int           installed;
  75   int           oil_inherited_rescan;
  76   int           oil_size;
  77   int           oil_ref_count;
  78   time_t        oif_creation[MAXVIFS];
  79   uint32_t      oif_flags[MAXVIFS];
  80   struct channel_counts cc;
  81   struct pim_upstream *up;
  82 };
  83
  84 extern struct list *pim_channel_oil_list;
  85
  86 void pim_oil_init (void);
  87 void pim_oil_terminate (void);
  88
  89 void pim_channel_oil_free(struct channel_oil *c_oil);
  90 struct channel_oil *pim_channel_oil_add(struct prefix_sg *sg,
  91                                         int input_vif_index);
  92 void pim_channel_oil_del(struct channel_oil *c_oil);
  93
  94 int pim_channel_add_oif(struct channel_oil *c_oil,
  95                         struct interface *oif,
  96                         uint32_t proto_mask);
  97 int pim_channel_del_oif (struct channel_oil *c_oil,
  98                          struct interface *oif,
  99                          uint32_t proto_mask);
 100
 101 int pim_channel_oil_empty (struct channel_oil *c_oil);
 102
 103 char *pim_channel_oil_dump (struct channel_oil *c_oil, char *buf, size_t size);
 104 #endif /* PIM_OIL_H */