pimd/pim_msdp.h

   1 /*
   2  * IP MSDP for Quagga
   3  * Copyright (C) 2016 Cumulus Networks, Inc.
   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 #ifndef PIM_MSDP_H
  21 #define PIM_MSDP_H
  22
  23 enum pim_msdp_peer_state {
  24   PIM_MSDP_DISABLED,
  25   PIM_MSDP_INACTIVE,
  26   PIM_MSDP_LISTEN,
  27   PIM_MSDP_CONNECTING,
  28   PIM_MSDP_ESTABLISHED
  29 };
  30
  31 /* SA and KA TLVs are processed; rest ignored */
  32 enum pim_msdp_tlv {
  33   PIM_MSDP_V4_SOURCE_ACTIVE = 1,
  34   PIM_MSDP_V4_SOURCE_ACTIVE_REQUEST,
  35   PIM_MSDP_V4_SOURCE_ACTIVE_RESPONSE,
  36   PIM_MSDP_KEEPALIVE,
  37   PIM_MSDP_RESERVED,
  38   PIM_MSDP_TRACEROUTE_PROGRESS,
  39   PIM_MSDP_TRACEROUTE_REPLY,
  40 };
  41
  42 /* MSDP error codes */
  43 enum pim_msdp_err {
  44   PIM_MSDP_ERR_NONE = 0,
  45   PIM_MSDP_ERR_OOM = -1,
  46   PIM_MSDP_ERR_PEER_EXISTS = -2,
  47   PIM_MSDP_ERR_MAX_MESH_GROUPS = -3,
  48   PIM_MSDP_ERR_NO_PEER = -4,
  49   PIM_MSDP_ERR_MG_MBR_EXISTS = -5,
  50   PIM_MSDP_ERR_NO_MG = -6,
  51   PIM_MSDP_ERR_NO_MG_MBR = -7,
  52   PIM_MSDP_ERR_SIP_EQ_DIP = -8,
  53 };
  54
  55 #define PIM_MSDP_STATE_STRLEN 16
  56 #define PIM_MSDP_UPTIME_STRLEN 80
  57 #define PIM_MSDP_TIMER_STRLEN 12
  58 #define PIM_MSDP_TCP_PORT 639
  59 #define PIM_MSDP_SOCKET_SNDBUF_SIZE 65536
  60
  61 enum pim_msdp_sa_flags {
  62   PIM_MSDP_SAF_NONE = 0,
  63   /* There are two cases where we can pickup an active source locally -
  64    * 1. We are RP and got a source-register from the FHR
  65    * 2. We are RP and FHR and learnt a new directly connected source on a
  66    * DR interface */
  67   PIM_MSDP_SAF_LOCAL = (1 << 0),
  68   /* We got this in the MSDP SA TLV from a peer (and this passed peer-RPF
  69    * checks) */
  70   PIM_MSDP_SAF_PEER = (1 << 1),
  71   PIM_MSDP_SAF_REF = (PIM_MSDP_SAF_LOCAL | PIM_MSDP_SAF_PEER),
  72   PIM_MSDP_SAF_STALE = (1 << 2), /* local entries can get kicked out on
  73                                  * misc pim events such as RP change */
  74   PIM_MSDP_SAF_UP_DEL_IN_PROG = (1 << 3)
  75 };
  76
  77 struct pim_msdp_sa {
  78   struct prefix_sg sg;
  79   char sg_str[PIM_SG_LEN];
  80   struct in_addr rp; /* Last RP address associated with this SA */
  81   struct in_addr peer; /* last peer from who we heard this SA */
  82   enum pim_msdp_sa_flags flags;
  83
  84   /* rfc-3618 is missing default value for SA-hold-down-Period. pulled
  85    * this number from industry-standards */
  86 #define PIM_MSDP_SA_HOLD_TIME ((3*60)+30)
  87   struct thread *sa_state_timer;  // 5.6
  88   int64_t uptime;
  89
  90   struct pim_upstream *up;
  91 };
  92
  93 enum pim_msdp_peer_flags {
  94   PIM_MSDP_PEERF_NONE = 0,
  95   PIM_MSDP_PEERF_LISTENER = (1 << 0),
  96 #define PIM_MSDP_PEER_IS_LISTENER(mp) (mp->flags & PIM_MSDP_PEERF_LISTENER)
  97   PIM_MSDP_PEERF_SA_JUST_SENT = (1 << 1)
  98 };
  99
 100 struct pim_msdp_peer {
 101   /* configuration */
 102   struct in_addr local;
 103   struct in_addr peer;
 104   char *mesh_group_name;
 105   char key_str[INET_ADDRSTRLEN];
 106
 107   /* state */
 108   enum pim_msdp_peer_state state;
 109   enum pim_msdp_peer_flags flags;
 110
 111   /* TCP socket info */
 112   union sockunion su_local;
 113   union sockunion su_peer;
 114   int fd;
 115
 116   /* protocol timers */
 117 #define PIM_MSDP_PEER_HOLD_TIME 75
 118   struct thread *hold_timer;   // 5.4
 119 #define PIM_MSDP_PEER_KA_TIME 60
 120   struct thread *ka_timer;  // 5.5
 121 #define PIM_MSDP_PEER_CONNECT_RETRY_TIME 30
 122   struct thread *cr_timer;  // 5.6
 123
 124   /* packet thread and buffers */
 125   uint32_t packet_size;
 126   struct stream *ibuf;
 127   struct stream_fifo *obuf;
 128   struct thread *t_read;
 129   struct thread *t_write;
 130
 131   /* stats */
 132   uint32_t conn_attempts;
 133   uint32_t est_flaps;
 134   uint32_t sa_cnt; /* number of SAs attributed to this peer */
 135 #define PIM_MSDP_PEER_LAST_RESET_STR 20
 136   char last_reset[PIM_MSDP_PEER_LAST_RESET_STR];
 137
 138   /* packet stats */
 139   uint32_t ka_tx_cnt;
 140   uint32_t sa_tx_cnt;
 141   uint32_t ka_rx_cnt;
 142   uint32_t sa_rx_cnt;
 143   uint32_t unk_rx_cnt;
 144
 145   /* timestamps */
 146   int64_t uptime;
 147 };
 148
 149 struct pim_msdp_mg_mbr {
 150   struct in_addr mbr_ip;
 151   struct pim_msdp_peer *mp;
 152 };
 153
 154 /* PIM MSDP mesh-group */
 155 struct pim_msdp_mg {
 156   char *mesh_group_name;
 157   struct in_addr src_ip;
 158   uint32_t mbr_cnt;
 159   struct list *mbr_list;
 160 };
 161
 162 enum pim_msdp_flags {
 163   PIM_MSDPF_NONE = 0,
 164   PIM_MSDPF_ENABLE = (1 << 0),
 165   PIM_MSDPF_LISTENER = (1 << 1)
 166 };
 167
 168 struct pim_msdp_listener {
 169   int fd;
 170   union sockunion su;
 171   struct thread *thread;
 172 };
 173
 174 struct pim_msdp {
 175   enum pim_msdp_flags flags;
 176   struct thread_master *master;
 177   struct pim_msdp_listener listener;
 178   uint32_t rejected_accepts;
 179
 180   /* MSDP peer info */
 181   struct hash *peer_hash;
 182   struct list *peer_list;
 183
 184   /* MSDP active-source info */
 185 #define PIM_MSDP_SA_ADVERTISMENT_TIME 60
 186   struct thread *sa_adv_timer;  // 5.6
 187   struct hash *sa_hash;
 188   struct list *sa_list;
 189   uint32_t local_cnt;
 190
 191   /* keep a scratch pad for building SA TLVs */
 192   struct stream *work_obuf;
 193
 194   struct in_addr originator_id;
 195
 196   /* currently only one mesh-group is supported - so just stash it here */
 197   struct pim_msdp_mg *mg;
 198 };
 199
 200 #define PIM_MSDP_PEER_READ_ON(mp) THREAD_READ_ON(msdp->master, mp->t_read, pim_msdp_read, mp, mp->fd);
 201 #define PIM_MSDP_PEER_WRITE_ON(mp) THREAD_WRITE_ON(msdp->master, mp->t_write, pim_msdp_write, mp, mp->fd);
 202
 203 #define PIM_MSDP_PEER_READ_OFF(mp) THREAD_READ_OFF(mp->t_read)
 204 #define PIM_MSDP_PEER_WRITE_OFF(mp) THREAD_WRITE_OFF(mp->t_write)
 205
 206 extern struct pim_msdp *msdp;
 207 void pim_msdp_init(struct thread_master *master);
 208 void pim_msdp_exit(void);
 209 enum pim_msdp_err pim_msdp_peer_add(struct in_addr peer, struct in_addr local, const char *mesh_group_name, struct pim_msdp_peer **mp_p);
 210 enum pim_msdp_err pim_msdp_peer_del(struct in_addr peer_addr);
 211 char *pim_msdp_state_dump(enum pim_msdp_peer_state state, char *buf, int buf_size);
 212 struct pim_msdp_peer *pim_msdp_peer_find(struct in_addr peer_addr);
 213 void pim_msdp_peer_established(struct pim_msdp_peer *mp);
 214 void pim_msdp_peer_pkt_rxed(struct pim_msdp_peer *mp);
 215 void pim_msdp_peer_stop_tcp_conn(struct pim_msdp_peer *mp, bool chg_state);
 216 void pim_msdp_peer_reset_tcp_conn(struct pim_msdp_peer *mp, const char *rc_str);
 217 int pim_msdp_write(struct thread *thread);
 218 char *pim_msdp_peer_key_dump(struct pim_msdp_peer *mp, char *buf, int buf_size, bool long_format);
 219 int pim_msdp_config_write(struct vty *vty);
 220 void pim_msdp_peer_pkt_txed(struct pim_msdp_peer *mp);
 221 void pim_msdp_sa_ref(struct pim_msdp_peer *mp, struct prefix_sg *sg, struct in_addr rp);
 222 void pim_msdp_sa_local_update(struct pim_upstream *up);
 223 void pim_msdp_sa_local_del(struct prefix_sg *sg);
 224 void pim_msdp_i_am_rp_changed(void);
 225 bool pim_msdp_peer_rpf_check(struct pim_msdp_peer *mp, struct in_addr rp);
 226 void pim_msdp_up_join_state_changed(struct pim_upstream *xg_up);
 227 void pim_msdp_up_del(struct prefix_sg *sg);
 228 enum pim_msdp_err pim_msdp_mg_mbr_add(const char *mesh_group_name, struct in_addr mbr_ip);
 229 enum pim_msdp_err pim_msdp_mg_mbr_del(const char *mesh_group_name, struct in_addr mbr_ip);
 230 enum pim_msdp_err pim_msdp_mg_src_del(const char *mesh_group_name);
 231 enum pim_msdp_err pim_msdp_mg_src_add(const char *mesh_group_name, struct in_addr src_ip);
 232 enum pim_msdp_err pim_msdp_mg_del(const char *mesh_group_name);
 233 #endif