ldpd/ldp.h

   1 /*      $OpenBSD$ */
   2
   3 /*
   4  * Copyright (c) 2013, 2016 Renato Westphal <renato@openbsd.org>
   5  * Copyright (c) 2009 Michele Marchetto <michele@openbsd.org>
   6  * Copyright (c) 2004, 2005, 2008 Esben Norby <norby@openbsd.org>
   7  *
   8  * Permission to use, copy, modify, and distribute this software for any
   9  * purpose with or without fee is hereby granted, provided that the above
  10  * copyright notice and this permission notice appear in all copies.
  11  *
  12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  16  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  17  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  18  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  19  */
  20
  21 /* LDP protocol definitions */
  22
  23 #ifndef _LDP_H_
  24 #define _LDP_H_
  25
  26 /* misc */
  27 #define LDP_VERSION             1
  28 #define LDP_PORT                646
  29 #define LDP_MAX_LEN             4096
  30
  31 /* All Routers on this Subnet group multicast addresses */
  32 #define AllRouters_v4           "224.0.0.2"
  33 #define AllRouters_v6           "ff02::2"
  34
  35 #define LINK_DFLT_HOLDTIME      15
  36 #define TARGETED_DFLT_HOLDTIME  45
  37 #define MIN_HOLDTIME            3
  38 #define MAX_HOLDTIME            0xffff
  39 #define INFINITE_HOLDTIME       0xffff
  40
  41 #define DEFAULT_KEEPALIVE       180
  42 #define MIN_KEEPALIVE           3
  43 #define MAX_KEEPALIVE           0xffff
  44 #define KEEPALIVE_PER_PERIOD    3
  45 #define INIT_FSM_TIMEOUT        15
  46
  47 #define DEFAULT_HELLO_INTERVAL  5
  48 #define MIN_HELLO_INTERVAL      1
  49 #define MAX_HELLO_INTERVAL      0xffff
  50
  51 #define INIT_DELAY_TMR          15
  52 #define MAX_DELAY_TMR           120
  53
  54 #define MIN_PWID_ID             1
  55 #define MAX_PWID_ID             0xffffffff
  56
  57 #define DEFAULT_L2VPN_MTU       1500
  58 #define MIN_L2VPN_MTU           512
  59 #define MAX_L2VPN_MTU           0xffff
  60
  61 /* LDP message types */
  62 #define MSG_TYPE_NOTIFICATION   0x0001
  63 #define MSG_TYPE_HELLO          0x0100
  64 #define MSG_TYPE_INIT           0x0200
  65 #define MSG_TYPE_KEEPALIVE      0x0201
  66 #define MSG_TYPE_CAPABILITY     0x0202 /* RFC 5561 */
  67 #define MSG_TYPE_ADDR           0x0300
  68 #define MSG_TYPE_ADDRWITHDRAW   0x0301
  69 #define MSG_TYPE_LABELMAPPING   0x0400
  70 #define MSG_TYPE_LABELREQUEST   0x0401
  71 #define MSG_TYPE_LABELWITHDRAW  0x0402
  72 #define MSG_TYPE_LABELRELEASE   0x0403
  73 #define MSG_TYPE_LABELABORTREQ  0x0404
  74
  75 /* LDP TLV types */
  76 #define TLV_TYPE_FEC            0x0100
  77 #define TLV_TYPE_ADDRLIST       0x0101
  78 #define TLV_TYPE_HOPCOUNT       0x0103
  79 #define TLV_TYPE_PATHVECTOR     0x0104
  80 #define TLV_TYPE_GENERICLABEL   0x0200
  81 #define TLV_TYPE_ATMLABEL       0x0201
  82 #define TLV_TYPE_FRLABEL        0x0202
  83 #define TLV_TYPE_STATUS         0x0300
  84 #define TLV_TYPE_EXTSTATUS      0x0301
  85 #define TLV_TYPE_RETURNEDPDU    0x0302
  86 #define TLV_TYPE_RETURNEDMSG    0x0303
  87 #define TLV_TYPE_COMMONHELLO    0x0400
  88 #define TLV_TYPE_IPV4TRANSADDR  0x0401
  89 #define TLV_TYPE_CONFIG         0x0402
  90 #define TLV_TYPE_IPV6TRANSADDR  0x0403
  91 #define TLV_TYPE_COMMONSESSION  0x0500
  92 #define TLV_TYPE_ATMSESSIONPAR  0x0501
  93 #define TLV_TYPE_FRSESSION      0x0502
  94 #define TLV_TYPE_LABELREQUEST   0x0600
  95 /* RFC 4447 */
  96 #define TLV_TYPE_PW_STATUS      0x896A
  97 #define TLV_TYPE_PW_IF_PARAM    0x096B
  98 #define TLV_TYPE_PW_GROUP_ID    0x096C
  99 /* RFC 5561 */
 100 #define TLV_TYPE_RETURNED_TLVS  0x8304
 101 #define TLV_TYPE_DYNAMIC_CAP    0x8506
 102 /* RFC 5918 */
 103 #define TLV_TYPE_TWCARD_CAP     0x850B
 104 /* RFC 7552 */
 105 #define TLV_TYPE_DUALSTACK      0x8701
 106
 107 /* LDP header */
 108 struct ldp_hdr {
 109         uint16_t        version;
 110         uint16_t        length;
 111         uint32_t        lsr_id;
 112         uint16_t        lspace_id;
 113 } __attribute__ ((packed));
 114
 115 #define LDP_HDR_SIZE            10      /* actual size of the LDP header */
 116 #define LDP_HDR_PDU_LEN         6       /* minimum "PDU Length" */
 117 #define LDP_HDR_DEAD_LEN        4
 118
 119 /* TLV record */
 120 struct tlv {
 121         uint16_t        type;
 122         uint16_t        length;
 123 };
 124 #define TLV_HDR_SIZE            4
 125
 126 struct ldp_msg {
 127         uint16_t        type;
 128         uint16_t        length;
 129         uint32_t        id;
 130         /* Mandatory Parameters */
 131         /* Optional Parameters */
 132 } __attribute__ ((packed));
 133
 134 #define LDP_MSG_SIZE            8       /* minimum size of LDP message */
 135 #define LDP_MSG_LEN             4       /* minimum "Message Length" */
 136 #define LDP_MSG_DEAD_LEN        4
 137
 138 #define UNKNOWN_FLAG            0x8000
 139 #define FORWARD_FLAG            0xc000
 140
 141 struct hello_prms_tlv {
 142         uint16_t        type;
 143         uint16_t        length;
 144         uint16_t        holdtime;
 145         uint16_t        flags;
 146 };
 147 #define F_HELLO_TARGETED        0x8000
 148 #define F_HELLO_REQ_TARG        0x4000
 149 #define F_HELLO_GTSM            0x2000
 150
 151 struct hello_prms_opt4_tlv {
 152         uint16_t        type;
 153         uint16_t        length;
 154         uint32_t        value;
 155 };
 156
 157 struct hello_prms_opt16_tlv {
 158         uint16_t        type;
 159         uint16_t        length;
 160         uint8_t         value[16];
 161 };
 162
 163 #define DUAL_STACK_LDPOV4       4
 164 #define DUAL_STACK_LDPOV6       6
 165
 166 #define F_HELLO_TLV_RCVD_ADDR   0x01
 167 #define F_HELLO_TLV_RCVD_CONF   0x02
 168 #define F_HELLO_TLV_RCVD_DS     0x04
 169
 170 #define S_SUCCESS       0x00000000
 171 #define S_BAD_LDP_ID    0x80000001
 172 #define S_BAD_PROTO_VER 0x80000002
 173 #define S_BAD_PDU_LEN   0x80000003
 174 #define S_UNKNOWN_MSG   0x00000004
 175 #define S_BAD_MSG_LEN   0x80000005
 176 #define S_UNKNOWN_TLV   0x00000006
 177 #define S_BAD_TLV_LEN   0x80000007
 178 #define S_BAD_TLV_VAL   0x80000008
 179 #define S_HOLDTIME_EXP  0x80000009
 180 #define S_SHUTDOWN      0x8000000A
 181 #define S_LOOP_DETECTED 0x0000000B
 182 #define S_UNKNOWN_FEC   0x0000000C
 183 #define S_NO_ROUTE      0x0000000D
 184 #define S_NO_LABEL_RES  0x0000000E
 185 #define S_AVAILABLE     0x0000000F
 186 #define S_NO_HELLO      0x80000010
 187 #define S_PARM_ADV_MODE 0x80000011
 188 #define S_MAX_PDU_LEN   0x80000012
 189 #define S_PARM_L_RANGE  0x80000013
 190 #define S_KEEPALIVE_TMR 0x80000014
 191 #define S_LAB_REQ_ABRT  0x00000015
 192 #define S_MISS_MSG      0x00000016
 193 #define S_UNSUP_ADDR    0x00000017
 194 #define S_KEEPALIVE_BAD 0x80000018
 195 #define S_INTERN_ERR    0x80000019
 196 /* RFC 4447 */
 197 #define S_ILLEGAL_CBIT  0x00000024
 198 #define S_WRONG_CBIT    0x00000025
 199 #define S_INCPT_BITRATE 0x00000026
 200 #define S_CEP_MISCONF   0x00000027
 201 #define S_PW_STATUS     0x00000028
 202 #define S_UNASSIGN_TAI  0x00000029
 203 #define S_MISCONF_ERR   0x0000002A
 204 #define S_WITHDRAW_MTHD 0x0000002B
 205 /* RFC 5561 */
 206 #define S_UNSSUPORTDCAP 0x0000002E
 207 /* RFC 7552 */
 208 #define S_TRANS_MISMTCH 0x80000032
 209 #define S_DS_NONCMPLNCE 0x80000033
 210
 211 struct sess_prms_tlv {
 212         uint16_t        type;
 213         uint16_t        length;
 214         uint16_t        proto_version;
 215         uint16_t        keepalive_time;
 216         uint8_t         reserved;
 217         uint8_t         pvlim;
 218         uint16_t        max_pdu_len;
 219         uint32_t        lsr_id;
 220         uint16_t        lspace_id;
 221 } __attribute__ ((packed));
 222
 223 #define SESS_PRMS_SIZE          18
 224 #define SESS_PRMS_LEN           14
 225
 226 struct status_tlv {
 227         uint16_t        type;
 228         uint16_t        length;
 229         uint32_t        status_code;
 230         uint32_t        msg_id;
 231         uint16_t        msg_type;
 232 } __attribute__ ((packed));
 233
 234 #define STATUS_SIZE             14
 235 #define STATUS_TLV_LEN          10
 236 #define STATUS_FATAL            0x80000000
 237
 238 struct capability_tlv {
 239         uint16_t        type;
 240         uint16_t        length;
 241         uint8_t         reserved;
 242 };
 243 #define STATE_BIT               0x80
 244
 245 #define F_CAP_TLV_RCVD_DYNAMIC  0x01
 246 #define F_CAP_TLV_RCVD_TWCARD   0x02
 247
 248 #define CAP_TLV_DYNAMIC_SIZE    5
 249 #define CAP_TLV_DYNAMIC_LEN     1
 250
 251 #define CAP_TLV_TWCARD_SIZE     5
 252 #define CAP_TLV_TWCARD_LEN      1
 253
 254 #define AF_IPV4                 0x1
 255 #define AF_IPV6                 0x2
 256
 257 struct address_list_tlv {
 258         uint16_t        type;
 259         uint16_t        length;
 260         uint16_t        family;
 261         /* address entries */
 262 } __attribute__ ((packed));
 263
 264 #define ADDR_LIST_SIZE          6
 265
 266 #define FEC_ELM_WCARD_LEN       1
 267 #define FEC_ELM_PREFIX_MIN_LEN  4
 268 #define FEC_PWID_ELM_MIN_LEN    8
 269 #define FEC_PWID_SIZE           4
 270 #define FEC_ELM_TWCARD_MIN_LEN  3
 271
 272 #define MAP_TYPE_WILDCARD       0x01
 273 #define MAP_TYPE_PREFIX         0x02
 274 #define MAP_TYPE_TYPED_WCARD    0x05
 275 #define MAP_TYPE_PWID           0x80
 276 #define MAP_TYPE_GENPWID        0x81
 277
 278 #define CONTROL_WORD_FLAG       0x8000
 279 #define PW_TYPE_ETHERNET_TAGGED 0x0004
 280 #define PW_TYPE_ETHERNET        0x0005
 281 #define DEFAULT_PW_TYPE         PW_TYPE_ETHERNET
 282
 283 /* RFC 4447 Sub-TLV record */
 284 struct subtlv {
 285         uint8_t         type;
 286         uint8_t         length;
 287 };
 288 #define SUBTLV_HDR_SIZE         2
 289
 290 #define SUBTLV_IFMTU            0x01
 291 #define SUBTLV_VLANID           0x06
 292
 293 #define FEC_SUBTLV_IFMTU_SIZE   4
 294 #define FEC_SUBTLV_VLANID_SIZE  4
 295
 296 struct label_tlv {
 297         uint16_t        type;
 298         uint16_t        length;
 299         uint32_t        label;
 300 };
 301 #define LABEL_TLV_SIZE          8
 302 #define LABEL_TLV_LEN           4
 303
 304 struct reqid_tlv {
 305         uint16_t        type;
 306         uint16_t        length;
 307         uint32_t        reqid;
 308 };
 309 #define REQID_TLV_SIZE          8
 310 #define REQID_TLV_LEN           4
 311
 312 struct pw_status_tlv {
 313         uint16_t        type;
 314         uint16_t        length;
 315         uint32_t        value;
 316 };
 317 #define PW_STATUS_TLV_SIZE      8
 318 #define PW_STATUS_TLV_LEN       4
 319
 320 #define PW_FORWARDING           0
 321 #define PW_NOT_FORWARDING       (1 << 0)
 322 #define PW_LOCAL_RX_FAULT       (1 << 1)
 323 #define PW_LOCAL_TX_FAULT       (1 << 2)
 324 #define PW_PSN_RX_FAULT         (1 << 3)
 325 #define PW_PSN_TX_FAULT         (1 << 4)
 326
 327 #define NO_LABEL                UINT32_MAX
 328
 329 #endif /* !_LDP_H_ */