]>
Commit | Line | Data |
---|---|---|
50f34207 | 1 | /* |
2 | * MPLS definitions | |
3 | * Copyright 2015 Cumulus Networks, Inc. | |
4 | * | |
5 | * This file is part of GNU Zebra. | |
6 | * | |
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. | |
11 | * | |
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. | |
16 | * | |
896014f4 DL |
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 | |
50f34207 | 20 | */ |
21 | ||
22 | #ifndef _QUAGGA_MPLS_H | |
23 | #define _QUAGGA_MPLS_H | |
24 | ||
43e52561 | 25 | #include <zebra.h> |
fea12efb | 26 | #include <arpa/inet.h> |
27 | ||
5e244469 RW |
28 | #ifdef __cplusplus |
29 | extern "C" { | |
30 | #endif | |
31 | ||
70e98a7f DS |
32 | #ifdef MPLS_LABEL_MAX |
33 | #undef MPLS_LABEL_MAX | |
34 | #endif | |
35 | ||
f890b146 DS |
36 | #define MPLS_LABEL_HELPSTR \ |
37 | "Specify label(s) for this route\nOne or more " \ | |
38 | "labels in the range (16-1048575) separated by '/'\n" | |
39 | ||
50f34207 | 40 | /* Well-known MPLS label values (RFC 3032 etc). */ |
70e98a7f DS |
41 | #define MPLS_LABEL_IPV4_EXPLICIT_NULL 0 /* [RFC3032] */ |
42 | #define MPLS_LABEL_ROUTER_ALERT 1 /* [RFC3032] */ | |
43 | #define MPLS_LABEL_IPV6_EXPLICIT_NULL 2 /* [RFC3032] */ | |
44 | #define MPLS_LABEL_IMPLICIT_NULL 3 /* [RFC3032] */ | |
45 | #define MPLS_LABEL_ELI 7 /* [RFC6790] */ | |
46 | #define MPLS_LABEL_GAL 13 /* [RFC5586] */ | |
47 | #define MPLS_LABEL_OAM_ALERT 14 /* [RFC3429] */ | |
48 | #define MPLS_LABEL_EXTENSION 15 /* [RFC7274] */ | |
49 | #define MPLS_LABEL_MAX 1048575 | |
1b3f47d0 | 50 | #define MPLS_LABEL_VALUE_MASK 0x000FFFFF |
42567e00 | 51 | #define MPLS_LABEL_NONE 0xFFFFFFFF /* for internal use only */ |
50f34207 | 52 | |
53 | /* Minimum and maximum label values */ | |
70e98a7f DS |
54 | #define MPLS_LABEL_RESERVED_MIN 0 |
55 | #define MPLS_LABEL_RESERVED_MAX 15 | |
56 | #define MPLS_LABEL_UNRESERVED_MIN 16 | |
57 | #define MPLS_LABEL_UNRESERVED_MAX 1048575 | |
0e3b6a92 | 58 | #define MPLS_LABEL_BASE_ANY 0 |
50f34207 | 59 | |
12929668 | 60 | /* Default min and max SRGB label range */ |
7726c479 OD |
61 | /* Even if the SRGB allows to manage different Label space between routers, |
62 | * if an operator want to use the same SRGB for all its router, we must fix | |
63 | * a common range. However, Cisco start its SRGB at 16000 and Juniper ends | |
64 | * its SRGB at 16384 for OSPF. Thus, by fixing the minimum SRGB label to | |
65 | * 8000 we could deal with both Cisco and Juniper. | |
66 | */ | |
67 | #define MPLS_DEFAULT_MIN_SRGB_LABEL 8000 | |
cf9b9f77 OD |
68 | #define MPLS_DEFAULT_MAX_SRGB_LABEL 50000 |
69 | #define MPLS_DEFAULT_MIN_SRGB_SIZE 5000 | |
70 | #define MPLS_DEFAULT_MAX_SRGB_SIZE 20000 | |
12929668 | 71 | |
52dd3aa4 RW |
72 | /* Maximum # labels that can be pushed. */ |
73 | #define MPLS_MAX_LABELS 16 | |
74 | ||
d62a17ae | 75 | #define IS_MPLS_RESERVED_LABEL(label) \ |
70e98a7f | 76 | (label >= MPLS_LABEL_RESERVED_MIN && label <= MPLS_LABEL_RESERVED_MAX) |
50f34207 | 77 | |
d62a17ae | 78 | #define IS_MPLS_UNRESERVED_LABEL(label) \ |
70e98a7f DS |
79 | (label >= MPLS_LABEL_UNRESERVED_MIN \ |
80 | && label <= MPLS_LABEL_UNRESERVED_MAX) | |
50f34207 | 81 | |
82 | /* Definitions for a MPLS label stack entry (RFC 3032). This encodes the | |
83 | * label, EXP, BOS and TTL fields. | |
84 | */ | |
85 | typedef unsigned int mpls_lse_t; | |
86 | ||
87 | #define MPLS_LS_LABEL_MASK 0xFFFFF000 | |
88 | #define MPLS_LS_LABEL_SHIFT 12 | |
89 | #define MPLS_LS_EXP_MASK 0x00000E00 | |
90 | #define MPLS_LS_EXP_SHIFT 9 | |
91 | #define MPLS_LS_S_MASK 0x00000100 | |
92 | #define MPLS_LS_S_SHIFT 8 | |
93 | #define MPLS_LS_TTL_MASK 0x000000FF | |
94 | #define MPLS_LS_TTL_SHIFT 0 | |
95 | ||
d62a17ae | 96 | #define MPLS_LABEL_VALUE(lse) \ |
97 | ((lse & MPLS_LS_LABEL_MASK) >> MPLS_LS_LABEL_SHIFT) | |
98 | #define MPLS_LABEL_EXP(lse) ((lse & MPLS_LS_EXP_MASK) >> MPLS_LS_EXP_SHIFT) | |
99 | #define MPLS_LABEL_BOS(lse) ((lse & MPLS_LS_S_MASK) >> MPLS_LS_S_SHIFT) | |
100 | #define MPLS_LABEL_TTL(lse) ((lse & MPLS_LS_TTL_MASK) >> MPLS_LS_TTL_SHIFT) | |
50f34207 | 101 | |
102 | #define IS_MPLS_LABEL_BOS(ls) (MPLS_LABEL_BOS(ls) == 1) | |
103 | ||
104 | #define MPLS_LABEL_LEN_BITS 20 | |
105 | ||
106 | /* MPLS label value as a 32-bit (mostly we only care about the label value). */ | |
107 | typedef unsigned int mpls_label_t; | |
108 | ||
8ecdb26e DS |
109 | struct mpls_label_stack { |
110 | uint8_t num_labels; | |
111 | uint8_t reserved[3]; | |
112 | mpls_label_t label[0]; /* 1 or more labels */ | |
113 | }; | |
114 | ||
9bedbb1e DW |
115 | /* The MPLS explicit-null label is 0 which means when you memset a mpls_label_t |
116 | * to zero you have set that variable to explicit-null which was probably not | |
117 | * your intent. The work-around is to use one bit to indicate if the | |
118 | * mpls_label_t has been set by the user. MPLS_INVALID_LABEL has this bit clear | |
119 | * so that we can use MPLS_INVALID_LABEL to initialize mpls_label_t variables. | |
120 | */ | |
121 | #define MPLS_INVALID_LABEL 0xFFFDFFFF | |
50f34207 | 122 | |
ce549947 | 123 | /* LSP types. */ |
d62a17ae | 124 | enum lsp_types_t { |
125 | ZEBRA_LSP_NONE = 0, /* No LSP. */ | |
126 | ZEBRA_LSP_STATIC = 1, /* Static LSP. */ | |
127 | ZEBRA_LSP_LDP = 2, /* LDP LSP. */ | |
cf9b9f77 | 128 | ZEBRA_LSP_BGP = 3, /* BGP LSP. */ |
635a039e | 129 | ZEBRA_LSP_OSPF_SR = 4,/* OSPF Segment Routing LSP. */ |
339e36d2 | 130 | ZEBRA_LSP_SHARP = 5, /* Identifier for test protocol */ |
ce549947 RW |
131 | }; |
132 | ||
50f34207 | 133 | /* Functions for basic label operations. */ |
134 | ||
135 | /* Encode a label stack entry from fields; convert to network byte-order as | |
136 | * the Netlink interface expects MPLS labels to be in this format. | |
137 | */ | |
d7c0a89a QY |
138 | static inline mpls_lse_t mpls_lse_encode(mpls_label_t label, uint32_t ttl, |
139 | uint32_t exp, uint32_t bos) | |
50f34207 | 140 | { |
d62a17ae | 141 | mpls_lse_t lse; |
142 | lse = htonl((label << MPLS_LS_LABEL_SHIFT) | (exp << MPLS_LS_EXP_SHIFT) | |
143 | | (bos ? (1 << MPLS_LS_S_SHIFT) : 0) | |
144 | | (ttl << MPLS_LS_TTL_SHIFT)); | |
145 | return lse; | |
50f34207 | 146 | } |
147 | ||
148 | /* Extract the fields from a label stack entry after converting to host-byte | |
149 | * order. This is expected to be called only for messages received over the | |
150 | * Netlink interface. | |
151 | */ | |
d62a17ae | 152 | static inline void mpls_lse_decode(mpls_lse_t lse, mpls_label_t *label, |
d7c0a89a | 153 | uint32_t *ttl, uint32_t *exp, uint32_t *bos) |
50f34207 | 154 | { |
d62a17ae | 155 | mpls_lse_t local_lse; |
50f34207 | 156 | |
d62a17ae | 157 | local_lse = ntohl(lse); |
158 | *label = MPLS_LABEL_VALUE(local_lse); | |
159 | *exp = MPLS_LABEL_EXP(local_lse); | |
160 | *bos = MPLS_LABEL_BOS(local_lse); | |
161 | *ttl = MPLS_LABEL_TTL(local_lse); | |
50f34207 | 162 | } |
163 | ||
28d58fd7 VV |
164 | /* Invalid label index value (when used with BGP Prefix-SID). Should |
165 | * match the BGP definition. | |
166 | */ | |
167 | #define MPLS_INVALID_LABEL_INDEX 0xFFFFFFFF | |
168 | ||
50f34207 | 169 | /* Printable string for labels (with consideration for reserved values). */ |
d62a17ae | 170 | static inline char *label2str(mpls_label_t label, char *buf, size_t len) |
50f34207 | 171 | { |
d62a17ae | 172 | switch (label) { |
70e98a7f | 173 | case MPLS_LABEL_IPV4_EXPLICIT_NULL: |
d62a17ae | 174 | strlcpy(buf, "IPv4 Explicit Null", len); |
175 | return (buf); | |
70e98a7f | 176 | case MPLS_LABEL_ROUTER_ALERT: |
d62a17ae | 177 | strlcpy(buf, "Router Alert", len); |
178 | return (buf); | |
70e98a7f | 179 | case MPLS_LABEL_IPV6_EXPLICIT_NULL: |
0437e105 | 180 | strlcpy(buf, "IPv6 Explicit Null", len); |
d62a17ae | 181 | return (buf); |
70e98a7f | 182 | case MPLS_LABEL_IMPLICIT_NULL: |
d62a17ae | 183 | strlcpy(buf, "implicit-null", len); |
184 | return (buf); | |
70e98a7f | 185 | case MPLS_LABEL_ELI: |
d62a17ae | 186 | strlcpy(buf, "Entropy Label Indicator", len); |
187 | return (buf); | |
70e98a7f | 188 | case MPLS_LABEL_GAL: |
d62a17ae | 189 | strlcpy(buf, "Generic Associated Channel", len); |
190 | return (buf); | |
70e98a7f | 191 | case MPLS_LABEL_OAM_ALERT: |
d62a17ae | 192 | strlcpy(buf, "OAM Alert", len); |
193 | return (buf); | |
70e98a7f | 194 | case MPLS_LABEL_EXTENSION: |
d62a17ae | 195 | strlcpy(buf, "Extension", len); |
196 | return (buf); | |
197 | default: | |
198 | if (label < 16) | |
199 | snprintf(buf, len, "Reserved (%u)", label); | |
200 | else | |
201 | snprintf(buf, len, "%u", label); | |
202 | return (buf); | |
203 | } | |
50f34207 | 204 | } |
205 | ||
036fdaad DS |
206 | /* |
207 | * String to label conversion, labels separated by '/'. | |
208 | */ | |
209 | int mpls_str2label(const char *label_str, uint8_t *num_labels, | |
210 | mpls_label_t *labels); | |
211 | ||
e4a1ec74 MS |
212 | /* Generic string buffer for label-stack-to-str */ |
213 | #define MPLS_LABEL_STRLEN 1024 | |
214 | ||
036fdaad DS |
215 | /* |
216 | * Label to string conversion, labels in string separated by '/'. | |
217 | */ | |
e4a1ec74 | 218 | char *mpls_label2str(uint8_t num_labels, const mpls_label_t *labels, char *buf, |
036fdaad | 219 | int len, int pretty); |
eac6e3f0 | 220 | |
5e244469 RW |
221 | #ifdef __cplusplus |
222 | } | |
223 | #endif | |
224 | ||
50f34207 | 225 | #endif |