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