pimd/pim_tlv.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_TLV_H
  22 #define PIM_TLV_H
  23
  24 #include <zebra.h>
  25
  26 #include "config.h"
  27 #include "if.h"
  28 #include "linklist.h"
  29
  30 #define PIM_MSG_OPTION_TYPE_HOLDTIME         (1)
  31 #define PIM_MSG_OPTION_TYPE_LAN_PRUNE_DELAY  (2)
  32 #define PIM_MSG_OPTION_TYPE_DR_PRIORITY      (19)
  33 #define PIM_MSG_OPTION_TYPE_GENERATION_ID    (20)
  34 #define PIM_MSG_OPTION_TYPE_DM_STATE_REFRESH (21)
  35 #define PIM_MSG_OPTION_TYPE_ADDRESS_LIST     (24)
  36
  37 typedef uint32_t pim_hello_options;
  38 #define PIM_OPTION_MASK_HOLDTIME                     (1 << 0) /* recv holdtime */
  39 #define PIM_OPTION_MASK_LAN_PRUNE_DELAY              (1 << 1) /* recv lan_prune_delay */
  40 #define PIM_OPTION_MASK_DR_PRIORITY                  (1 << 2) /* recv dr_priority */
  41 #define PIM_OPTION_MASK_GENERATION_ID                (1 << 3) /* recv generation_id */
  42 #define PIM_OPTION_MASK_ADDRESS_LIST                 (1 << 4) /* recv secondary address list */
  43 #define PIM_OPTION_MASK_CAN_DISABLE_JOIN_SUPPRESSION (1 << 5) /* T bit value (valid if recv lan_prune_delay) */
  44
  45 #define PIM_RPT_BIT_MASK      (1 << 0)
  46 #define PIM_WILDCARD_BIT_MASK (1 << 1)
  47
  48 #define PIM_OPTION_SET(options, option_mask) ((options) |= (option_mask))
  49 #define PIM_OPTION_UNSET(options, option_mask) ((options) &= ~(option_mask))
  50 #define PIM_OPTION_IS_SET(options, option_mask) ((options) & (option_mask))
  51
  52 #define PIM_TLV_GET_UINT16(buf) ntohs(*(const uint16_t *)(buf))
  53 #define PIM_TLV_GET_UINT32(buf) ntohl(*(const uint32_t *)(buf))
  54 #define PIM_TLV_GET_TYPE(buf) PIM_TLV_GET_UINT16(buf)
  55 #define PIM_TLV_GET_LENGTH(buf) PIM_TLV_GET_UINT16(buf)
  56 #define PIM_TLV_GET_HOLDTIME(buf) PIM_TLV_GET_UINT16(buf)
  57 #define PIM_TLV_GET_PROPAGATION_DELAY(buf) (PIM_TLV_GET_UINT16(buf) & 0x7FFF)
  58 #define PIM_TLV_GET_OVERRIDE_INTERVAL(buf) PIM_TLV_GET_UINT16(buf)
  59 #define PIM_TLV_GET_CAN_DISABLE_JOIN_SUPPRESSION(buf) ((*(const uint8_t *)(buf)) & 0x80)
  60 #define PIM_TLV_GET_DR_PRIORITY(buf) PIM_TLV_GET_UINT32(buf)
  61 #define PIM_TLV_GET_GENERATION_ID(buf) PIM_TLV_GET_UINT32(buf)
  62
  63 #define PIM_TLV_TYPE_SIZE               (2)
  64 #define PIM_TLV_LENGTH_SIZE             (2)
  65 #define PIM_TLV_MIN_SIZE                (PIM_TLV_TYPE_SIZE + PIM_TLV_LENGTH_SIZE)
  66 #define PIM_TLV_OPTION_SIZE(option_len) (PIM_TLV_MIN_SIZE + (option_len))
  67
  68 uint8_t *pim_tlv_append_uint16(uint8_t *buf,
  69                                const uint8_t *buf_pastend,
  70                                uint16_t option_type,
  71                                uint16_t option_value);
  72 uint8_t *pim_tlv_append_2uint16(uint8_t *buf,
  73                                 const uint8_t *buf_pastend,
  74                                 uint16_t option_type,
  75                                 uint16_t option_value1,
  76                                 uint16_t option_value2);
  77 uint8_t *pim_tlv_append_uint32(uint8_t *buf,
  78                                const uint8_t *buf_pastend,
  79                                uint16_t option_type,
  80                                uint32_t option_value);
  81 uint8_t *pim_tlv_append_addrlist_ucast(uint8_t *buf,
  82                                        const uint8_t *buf_pastend,
  83                                        struct list *ifconnected);
  84
  85 int pim_tlv_parse_holdtime(const char *ifname, struct in_addr src_addr,
  86                            pim_hello_options *hello_options,
  87                            uint16_t *hello_option_holdtime,
  88                            uint16_t option_len,
  89                            const uint8_t *tlv_curr);
  90 int pim_tlv_parse_lan_prune_delay(const char *ifname, struct in_addr src_addr,
  91                                   pim_hello_options *hello_options,
  92                                   uint16_t *hello_option_propagation_delay,
  93                                   uint16_t *hello_option_override_interval,
  94                                   uint16_t option_len,
  95                                   const uint8_t *tlv_curr);
  96 int pim_tlv_parse_dr_priority(const char *ifname, struct in_addr src_addr,
  97                               pim_hello_options *hello_options,
  98                               uint32_t *hello_option_dr_priority,
  99                               uint16_t option_len,
 100                               const uint8_t *tlv_curr);
 101 int pim_tlv_parse_generation_id(const char *ifname, struct in_addr src_addr,
 102                                 pim_hello_options *hello_options,
 103                                 uint32_t *hello_option_generation_id,
 104                                 uint16_t option_len,
 105                                 const uint8_t *tlv_curr);
 106 int pim_tlv_parse_addr_list(const char *ifname, struct in_addr src_addr,
 107                             pim_hello_options *hello_options,
 108                             struct list **hello_option_addr_list,
 109                             uint16_t option_len,
 110                             const uint8_t *tlv_curr);
 111
 112 int pim_parse_addr_ucast (struct prefix *p,
 113                           const uint8_t *buf,
 114                           int buf_size);
 115 int pim_parse_addr_group (struct prefix *p,
 116                           const uint8_t *buf,
 117                           int buf_size);
 118 int pim_parse_addr_source(struct prefix *p,
 119                           uint8_t *flags,
 120                           const uint8_t *buf,
 121                           int buf_size);
 122
 123 #endif /* PIM_TLV_H */