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
16  along with this program; see the file COPYING; if not, write to the
17  Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
18  MA 02110-1301 USA
19
20  $QuaggaId: $Format:%an, %ai, %h$ $
21*/
22
23#ifndef PIMD_H
24#define PIMD_H
25
26#include <stdint.h>
27
28#include "pim_mroute.h"
29#include "pim_assert.h"
30
31#define PIMD_PROGNAME       "pimd"
32#define PIMD_DEFAULT_CONFIG "pimd.conf"
33#define PIMD_VTY_PORT       2611
34#define PIMD_BUG_ADDRESS    "https://github.com/udhos/qpimd"
35
36#define PIM_IP_HEADER_MIN_LEN         (20)
37#define PIM_IP_HEADER_MAX_LEN         (60)
38#define PIM_IP_PROTO_IGMP             (2)
39#define PIM_IP_PROTO_PIM              (103)
40#define PIM_IGMP_MIN_LEN              (8)
41#define PIM_MSG_HEADER_LEN            (4)
42#define PIM_PIM_MIN_LEN               PIM_MSG_HEADER_LEN
43#define PIM_PROTO_VERSION             (2)
44
45#define MCAST_ALL_SYSTEMS      "224.0.0.1"
46#define MCAST_ALL_ROUTERS      "224.0.0.2"
47#define MCAST_ALL_PIM_ROUTERS  "224.0.0.13"
48#define MCAST_ALL_IGMP_ROUTERS "224.0.0.22"
49
50#define PIM_FORCE_BOOLEAN(expr) ((expr) != 0)
51
52#define PIM_NET_INADDR_ANY (htonl(INADDR_ANY))
53#define PIM_INADDR_IS_ANY(addr) ((addr).s_addr == PIM_NET_INADDR_ANY) /* struct in_addr addr */
54#define PIM_INADDR_ISNOT_ANY(addr) ((addr).s_addr != PIM_NET_INADDR_ANY) /* struct in_addr addr */
55
56#define PIM_MASK_PIM_EVENTS          (1 << 0)
57#define PIM_MASK_PIM_PACKETS         (1 << 1)
58#define PIM_MASK_PIM_PACKETDUMP_SEND (1 << 2)
59#define PIM_MASK_PIM_PACKETDUMP_RECV (1 << 3)
60#define PIM_MASK_PIM_TRACE           (1 << 4)
61#define PIM_MASK_IGMP_EVENTS         (1 << 5)
62#define PIM_MASK_IGMP_PACKETS        (1 << 6)
63#define PIM_MASK_IGMP_TRACE          (1 << 7)
64#define PIM_MASK_ZEBRA               (1 << 8)
65#define PIM_MASK_SSMPINGD            (1 << 9)
66#define PIM_MASK_MROUTE              (1 << 10)
67#define PIM_MASK_PIM_HELLO	     (1 << 11)
68#define PIM_MASK_PIM_J_P	     (1 << 12)
69
70const char *const PIM_ALL_SYSTEMS;
71const char *const PIM_ALL_ROUTERS;
72const char *const PIM_ALL_PIM_ROUTERS;
73const char *const PIM_ALL_IGMP_ROUTERS;
74
75struct thread_master     *master;
76uint32_t                  qpim_debugs;
77int                       qpim_mroute_socket_fd;
78int64_t                   qpim_mroute_socket_creation; /* timestamp of creation */
79struct thread            *qpim_mroute_socket_reader;
80int                       qpim_mroute_oif_highest_vif_index;
81struct list              *qpim_channel_oil_list; /* list of struct channel_oil */
82struct in_addr            qpim_all_pim_routers_addr;
83int                       qpim_t_periodic; /* Period between Join/Prune Messages */
84struct list              *qpim_upstream_list; /* list of struct pim_upstream */
85struct zclient           *qpim_zclient_update;
86struct zclient           *qpim_zclient_lookup;
87struct pim_assert_metric  qpim_infinite_assert_metric;
88long                      qpim_rpf_cache_refresh_delay_msec;
89struct thread            *qpim_rpf_cache_refresher;
90int64_t                   qpim_rpf_cache_refresh_requests;
91int64_t                   qpim_rpf_cache_refresh_events;
92int64_t                   qpim_rpf_cache_refresh_last;
93struct in_addr            qpim_inaddr_any;
94struct list              *qpim_ssmpingd_list; /* list of struct ssmpingd_sock */
95struct in_addr            qpim_ssmpingd_group_addr;
96int64_t                   qpim_scan_oil_events;
97int64_t                   qpim_scan_oil_last;
98int64_t                   qpim_mroute_add_events;
99int64_t                   qpim_mroute_add_last;
100int64_t                   qpim_mroute_del_events;
101int64_t                   qpim_mroute_del_last;
102
103#define PIM_JP_HOLDTIME (qpim_t_periodic * 7 / 2)
104
105#define PIM_MROUTE_IS_ENABLED  (qpim_mroute_socket_fd >= 0)
106#define PIM_MROUTE_IS_DISABLED (qpim_mroute_socket_fd < 0)
107
108#define PIM_DEBUG_PIM_EVENTS          (qpim_debugs & PIM_MASK_PIM_EVENTS)
109#define PIM_DEBUG_PIM_PACKETS         (qpim_debugs & PIM_MASK_PIM_PACKETS)
110#define PIM_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_SEND)
111#define PIM_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs & PIM_MASK_PIM_PACKETDUMP_RECV)
112#define PIM_DEBUG_PIM_TRACE           (qpim_debugs & PIM_MASK_PIM_TRACE)
113#define PIM_DEBUG_IGMP_EVENTS         (qpim_debugs & PIM_MASK_IGMP_EVENTS)
114#define PIM_DEBUG_IGMP_PACKETS        (qpim_debugs & PIM_MASK_IGMP_PACKETS)
115#define PIM_DEBUG_IGMP_TRACE          (qpim_debugs & PIM_MASK_IGMP_TRACE)
116#define PIM_DEBUG_ZEBRA               (qpim_debugs & PIM_MASK_ZEBRA)
117#define PIM_DEBUG_SSMPINGD            (qpim_debugs & PIM_MASK_SSMPINGD)
118#define PIM_DEBUG_MROUTE              (qpim_debugs & PIM_MASK_MROUTE)
119#define PIM_DEBUG_PIM_HELLO	      (qpim_debugs & PIM_MASK_PIM_HELLO)
120#define PIM_DEBUG_PIM_J_P	      (qpim_debugs & PIM_MASK_PIM_J_P)
121
122#define PIM_DEBUG_EVENTS       (qpim_debugs & (PIM_MASK_PIM_EVENTS | PIM_MASK_IGMP_EVENTS))
123#define PIM_DEBUG_PACKETS      (qpim_debugs & (PIM_MASK_PIM_PACKETS | PIM_MASK_IGMP_PACKETS))
124#define PIM_DEBUG_TRACE        (qpim_debugs & (PIM_MASK_PIM_TRACE | PIM_MASK_IGMP_TRACE))
125
126#define PIM_DO_DEBUG_PIM_EVENTS          (qpim_debugs |= PIM_MASK_PIM_EVENTS)
127#define PIM_DO_DEBUG_PIM_PACKETS         (qpim_debugs |= PIM_MASK_PIM_PACKETS)
128#define PIM_DO_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_SEND)
129#define PIM_DO_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs |= PIM_MASK_PIM_PACKETDUMP_RECV)
130#define PIM_DO_DEBUG_PIM_TRACE           (qpim_debugs |= PIM_MASK_PIM_TRACE)
131#define PIM_DO_DEBUG_IGMP_EVENTS         (qpim_debugs |= PIM_MASK_IGMP_EVENTS)
132#define PIM_DO_DEBUG_IGMP_PACKETS        (qpim_debugs |= PIM_MASK_IGMP_PACKETS)
133#define PIM_DO_DEBUG_IGMP_TRACE          (qpim_debugs |= PIM_MASK_IGMP_TRACE)
134#define PIM_DO_DEBUG_ZEBRA               (qpim_debugs |= PIM_MASK_ZEBRA)
135#define PIM_DO_DEBUG_SSMPINGD            (qpim_debugs |= PIM_MASK_SSMPINGD)
136#define PIM_DO_DEBUG_MROUTE              (qpim_debugs |= PIM_MASK_MROUTE)
137#define PIM_DO_DEBUG_PIM_HELLO           (qpim_debugs |= PIM_MASK_PIM_HELLO)
138#define PIM_DO_DEBUG_PIM_J_P             (qpim_debugs |= PIM_MASK_PIM_J_P)
139
140#define PIM_DONT_DEBUG_PIM_EVENTS          (qpim_debugs &= ~PIM_MASK_PIM_EVENTS)
141#define PIM_DONT_DEBUG_PIM_PACKETS         (qpim_debugs &= ~PIM_MASK_PIM_PACKETS)
142#define PIM_DONT_DEBUG_PIM_PACKETDUMP_SEND (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_SEND)
143#define PIM_DONT_DEBUG_PIM_PACKETDUMP_RECV (qpim_debugs &= ~PIM_MASK_PIM_PACKETDUMP_RECV)
144#define PIM_DONT_DEBUG_PIM_TRACE           (qpim_debugs &= ~PIM_MASK_PIM_TRACE)
145#define PIM_DONT_DEBUG_IGMP_EVENTS         (qpim_debugs &= ~PIM_MASK_IGMP_EVENTS)
146#define PIM_DONT_DEBUG_IGMP_PACKETS        (qpim_debugs &= ~PIM_MASK_IGMP_PACKETS)
147#define PIM_DONT_DEBUG_IGMP_TRACE          (qpim_debugs &= ~PIM_MASK_IGMP_TRACE)
148#define PIM_DONT_DEBUG_ZEBRA               (qpim_debugs &= ~PIM_MASK_ZEBRA)
149#define PIM_DONT_DEBUG_SSMPINGD            (qpim_debugs &= ~PIM_MASK_SSMPINGD)
150#define PIM_DONT_DEBUG_MROUTE              (qpim_debugs &= ~PIM_MASK_MROUTE)
151#define PIM_DONT_DEBUG_PIM_HELLO           (qpim_debugs &= ~PIM_MASK_PIM_HELLO)
152#define PIM_DONT_DEBUG_PIM_J_P             (qpim_debugs &= ~PIM_MASK_PIM_J_P)
153
154void pim_init(void);
155void pim_terminate(void);
156
157#endif /* PIMD_H */
158