3 * Copyright 2015 Cumulus Networks, Inc.
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published
9 * by the Free Software Foundation; either version 2, or (at your
10 * option) any later version.
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef _QUAGGA_MPLS_H
23 #define _QUAGGA_MPLS_H
25 #include <arpa/inet.h>
31 #define MPLS_LABEL_HELPSTR \
32 "Specify label(s) for this route\nOne or more " \
33 "labels in the range (16-1048575) separated by '/'\n"
35 /* Well-known MPLS label values (RFC 3032 etc). */
36 #define MPLS_LABEL_IPV4_EXPLICIT_NULL 0 /* [RFC3032] */
37 #define MPLS_LABEL_ROUTER_ALERT 1 /* [RFC3032] */
38 #define MPLS_LABEL_IPV6_EXPLICIT_NULL 2 /* [RFC3032] */
39 #define MPLS_LABEL_IMPLICIT_NULL 3 /* [RFC3032] */
40 #define MPLS_LABEL_ELI 7 /* [RFC6790] */
41 #define MPLS_LABEL_GAL 13 /* [RFC5586] */
42 #define MPLS_LABEL_OAM_ALERT 14 /* [RFC3429] */
43 #define MPLS_LABEL_EXTENSION 15 /* [RFC7274] */
44 #define MPLS_LABEL_MAX 1048575
45 #define MPLS_LABEL_NONE 0xFFFFFFFF /* for internal use only */
47 /* Minimum and maximum label values */
48 #define MPLS_LABEL_RESERVED_MIN 0
49 #define MPLS_LABEL_RESERVED_MAX 15
50 #define MPLS_LABEL_UNRESERVED_MIN 16
51 #define MPLS_LABEL_UNRESERVED_MAX 1048575
53 /* Default min and max SRGB label range */
54 /* Even if the SRGB allows to manage different Label space between routers,
55 * if an operator want to use the same SRGB for all its router, we must fix
56 * a common range. However, Cisco start its SRGB at 16000 and Juniper ends
57 * its SRGB at 16384 for OSPF. Thus, by fixing the minimum SRGB label to
58 * 8000 we could deal with both Cisco and Juniper.
60 #define MPLS_DEFAULT_MIN_SRGB_LABEL 8000
61 #define MPLS_DEFAULT_MAX_SRGB_LABEL 50000
62 #define MPLS_DEFAULT_MIN_SRGB_SIZE 5000
63 #define MPLS_DEFAULT_MAX_SRGB_SIZE 20000
65 /* Maximum # labels that can be pushed. */
66 #define MPLS_MAX_LABELS 16
68 #define IS_MPLS_RESERVED_LABEL(label) \
69 (label >= MPLS_LABEL_RESERVED_MIN && label <= MPLS_LABEL_RESERVED_MAX)
71 #define IS_MPLS_UNRESERVED_LABEL(label) \
72 (label >= MPLS_LABEL_UNRESERVED_MIN \
73 && label <= MPLS_LABEL_UNRESERVED_MAX)
75 /* Definitions for a MPLS label stack entry (RFC 3032). This encodes the
76 * label, EXP, BOS and TTL fields.
78 typedef unsigned int mpls_lse_t
;
80 #define MPLS_LS_LABEL_MASK 0xFFFFF000
81 #define MPLS_LS_LABEL_SHIFT 12
82 #define MPLS_LS_EXP_MASK 0x00000E00
83 #define MPLS_LS_EXP_SHIFT 9
84 #define MPLS_LS_S_MASK 0x00000100
85 #define MPLS_LS_S_SHIFT 8
86 #define MPLS_LS_TTL_MASK 0x000000FF
87 #define MPLS_LS_TTL_SHIFT 0
89 #define MPLS_LABEL_VALUE(lse) \
90 ((lse & MPLS_LS_LABEL_MASK) >> MPLS_LS_LABEL_SHIFT)
91 #define MPLS_LABEL_EXP(lse) ((lse & MPLS_LS_EXP_MASK) >> MPLS_LS_EXP_SHIFT)
92 #define MPLS_LABEL_BOS(lse) ((lse & MPLS_LS_S_MASK) >> MPLS_LS_S_SHIFT)
93 #define MPLS_LABEL_TTL(lse) ((lse & MPLS_LS_TTL_MASK) >> MPLS_LS_TTL_SHIFT)
95 #define IS_MPLS_LABEL_BOS(ls) (MPLS_LABEL_BOS(ls) == 1)
97 #define MPLS_LABEL_LEN_BITS 20
99 /* MPLS label value as a 32-bit (mostly we only care about the label value). */
100 typedef unsigned int mpls_label_t
;
102 struct mpls_label_stack
{
105 mpls_label_t label
[0]; /* 1 or more labels */
108 /* The MPLS explicit-null label is 0 which means when you memset a mpls_label_t
109 * to zero you have set that variable to explicit-null which was probably not
110 * your intent. The work-around is to use one bit to indicate if the
111 * mpls_label_t has been set by the user. MPLS_INVALID_LABEL has this bit clear
112 * so that we can use MPLS_INVALID_LABEL to initialize mpls_label_t variables.
114 #define MPLS_INVALID_LABEL 0xFFFDFFFF
118 ZEBRA_LSP_NONE
= 0, /* No LSP. */
119 ZEBRA_LSP_STATIC
= 1, /* Static LSP. */
120 ZEBRA_LSP_LDP
= 2, /* LDP LSP. */
121 ZEBRA_LSP_BGP
= 3, /* BGP LSP. */
122 ZEBRA_LSP_SR
= 4, /* Segment Routing LSP. */
123 ZEBRA_LSP_SHARP
= 5, /* Identifier for test protocol */
126 /* Functions for basic label operations. */
128 /* Encode a label stack entry from fields; convert to network byte-order as
129 * the Netlink interface expects MPLS labels to be in this format.
131 static inline mpls_lse_t
mpls_lse_encode(mpls_label_t label
, uint32_t ttl
,
132 uint32_t exp
, uint32_t bos
)
135 lse
= htonl((label
<< MPLS_LS_LABEL_SHIFT
) | (exp
<< MPLS_LS_EXP_SHIFT
)
136 | (bos
? (1 << MPLS_LS_S_SHIFT
) : 0)
137 | (ttl
<< MPLS_LS_TTL_SHIFT
));
141 /* Extract the fields from a label stack entry after converting to host-byte
142 * order. This is expected to be called only for messages received over the
145 static inline void mpls_lse_decode(mpls_lse_t lse
, mpls_label_t
*label
,
146 uint32_t *ttl
, uint32_t *exp
, uint32_t *bos
)
148 mpls_lse_t local_lse
;
150 local_lse
= ntohl(lse
);
151 *label
= MPLS_LABEL_VALUE(local_lse
);
152 *exp
= MPLS_LABEL_EXP(local_lse
);
153 *bos
= MPLS_LABEL_BOS(local_lse
);
154 *ttl
= MPLS_LABEL_TTL(local_lse
);
157 /* Invalid label index value (when used with BGP Prefix-SID). Should
158 * match the BGP definition.
160 #define MPLS_INVALID_LABEL_INDEX 0xFFFFFFFF
162 /* Printable string for labels (with consideration for reserved values). */
163 static inline char *label2str(mpls_label_t label
, char *buf
, size_t len
)
166 case MPLS_LABEL_IPV4_EXPLICIT_NULL
:
167 strlcpy(buf
, "IPv4 Explicit Null", len
);
169 case MPLS_LABEL_ROUTER_ALERT
:
170 strlcpy(buf
, "Router Alert", len
);
172 case MPLS_LABEL_IPV6_EXPLICIT_NULL
:
173 strlcpy(buf
, "IPv6 Explict Null", len
);
175 case MPLS_LABEL_IMPLICIT_NULL
:
176 strlcpy(buf
, "implicit-null", len
);
179 strlcpy(buf
, "Entropy Label Indicator", len
);
182 strlcpy(buf
, "Generic Associated Channel", len
);
184 case MPLS_LABEL_OAM_ALERT
:
185 strlcpy(buf
, "OAM Alert", len
);
187 case MPLS_LABEL_EXTENSION
:
188 strlcpy(buf
, "Extension", len
);
192 snprintf(buf
, len
, "Reserved (%u)", label
);
194 snprintf(buf
, len
, "%u", label
);
200 * String to label conversion, labels separated by '/'.
202 int mpls_str2label(const char *label_str
, uint8_t *num_labels
,
203 mpls_label_t
*labels
);
206 * Label to string conversion, labels in string separated by '/'.
208 char *mpls_label2str(uint8_t num_labels
, mpls_label_t
*labels
, char *buf
,
209 int len
, int pretty
);