pimd/pim_pim.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
  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
  21 #ifndef PIM_PIM_H
  22 #define PIM_PIM_H
  23
  24 #include <zebra.h>
  25
  26 #include "if.h"
  27
  28 #define PIM_PIM_BUFSIZE_READ  (20000)
  29 #define PIM_PIM_BUFSIZE_WRITE (20000)
  30
  31 #define PIM_DEFAULT_HELLO_PERIOD                 (30)   /* seconds, RFC 4601: 4.11 */
  32 #define PIM_DEFAULT_TRIGGERED_HELLO_DELAY        (5)    /* seconds, RFC 4601: 4.11 */
  33 #define PIM_DEFAULT_DR_PRIORITY                  (1)    /* RFC 4601: 4.3.1 */
  34 #define PIM_DEFAULT_PROPAGATION_DELAY_MSEC       (500)  /* RFC 4601: 4.11.  Timer Values */
  35 #define PIM_DEFAULT_OVERRIDE_INTERVAL_MSEC       (2500) /* RFC 4601: 4.11.  Timer Values */
  36 #define PIM_DEFAULT_CAN_DISABLE_JOIN_SUPPRESSION (0)    /* boolean */
  37 #define PIM_DEFAULT_T_PERIODIC                   (60)   /* RFC 4601: 4.11.  Timer Values */
  38
  39 enum pim_msg_type {
  40   PIM_MSG_TYPE_HELLO = 0,
  41   PIM_MSG_TYPE_REGISTER,
  42   PIM_MSG_TYPE_REG_STOP,
  43   PIM_MSG_TYPE_JOIN_PRUNE,
  44   PIM_MSG_TYPE_BOOTSTRAP,
  45   PIM_MSG_TYPE_ASSERT,
  46   PIM_MSG_TYPE_GRAFT,
  47   PIM_MSG_TYPE_GRAFT_ACK,
  48   PIM_MSG_TYPE_CANDIDATE
  49 };
  50
  51 #define PIM_MSG_HDR_OFFSET_VERSION(pim_msg) (pim_msg)
  52 #define PIM_MSG_HDR_OFFSET_TYPE(pim_msg) (pim_msg)
  53 #define PIM_MSG_HDR_OFFSET_RESERVED(pim_msg) (((char *)(pim_msg)) + 1)
  54 #define PIM_MSG_HDR_OFFSET_CHECKSUM(pim_msg) (((char *)(pim_msg)) + 2)
  55
  56 #define PIM_MSG_HDR_GET_VERSION(pim_msg) ((*(uint8_t*) PIM_MSG_HDR_OFFSET_VERSION(pim_msg)) >> 4)
  57 #define PIM_MSG_HDR_GET_TYPE(pim_msg) ((*(uint8_t*) PIM_MSG_HDR_OFFSET_TYPE(pim_msg)) & 0xF)
  58 #define PIM_MSG_HDR_GET_CHECKSUM(pim_msg) (*(uint16_t*) PIM_MSG_HDR_OFFSET_CHECKSUM(pim_msg))
  59
  60 void pim_ifstat_reset(struct interface *ifp);
  61 void pim_sock_reset(struct interface *ifp);
  62 int pim_sock_add(struct interface *ifp);
  63 void pim_sock_delete(struct interface *ifp, const char *delete_message);
  64 void pim_hello_restart_now(struct interface *ifp);
  65 void pim_hello_restart_triggered(struct interface *ifp);
  66
  67 int pim_pim_packet(struct interface *ifp, uint8_t *buf, size_t len);
  68
  69 int pim_msg_send(int fd,
  70                  struct in_addr src,
  71                  struct in_addr dst,
  72                  uint8_t *pim_msg,
  73                  int pim_msg_size,
  74                  const char *ifname);
  75
  76 #endif /* PIM_PIM_H */