summaryrefslogtreecommitdiffstats
path: root/src/vnet/mpls/packet.h
blob: 8573bc3bef5feed3360474945e92c2e7fa36adb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * MPLS packet format
 *
 * Copyright (c) 2012 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef included_vnet_mpls_packet_h
#define included_vnet_mpls_packet_h

#include <vnet/ip/ip_packet.h>

/**
 * A label value only, i.e. 20bits.
 */
typedef u32 mpls_label_t;

typedef struct {
    /* Label: top 20 bits [in network byte order] */
    /* Experimental: 3 bits ... */
    /* S (bottom of label stack): 1 bit */
    /* TTL: 8 bits */
    mpls_label_t label_exp_s_ttl;
} mpls_unicast_header_t;

typedef enum mpls_eos_bit_t_
{
    MPLS_NON_EOS = 0,
    MPLS_EOS     = 1,
} mpls_eos_bit_t;

#define MPLS_EOS_BITS {				\
    [MPLS_NON_EOS] = "neos",		      	\
    [MPLS_EOS] = "eos",				\
}

/**
 * The Default TTL added to MPLS label headers when no other value is available
 */
#define MPLS_LABEL_DEFAULT_TTL 64

/**
 * The Default EXP added to MPLS label headers when no other value is available
 */
#define MPLS_LABEL_DEFAULT_EXP 0

/**
 * When in uniform mode convert an IPv[46] DSCP value to an MPLS EXP value
 */
static inline u8 ip_dscp_to_mpls_exp (ip_dscp_t tos)
{
    return (tos >> 5);
}

/**
 * When in uniform mode convert an MPLS EXP value to an IPv[46] DSCP value
 */
static inline u8 mpls_exp_to_ip_dscp (u8 exp)
{
    return (exp << 5);
}

#define FOR_EACH_MPLS_EOS_BIT(_eos) \
    for (_eos = MPLS_NON_EOS; _eos <= MPLS_EOS; _eos++)

#define MPLS_ENTRY_LABEL_OFFSET        0
#define MPLS_ENTRY_LABEL_SHIFT 12
#define MPLS_ENTRY_LABEL_MASK  0x000fffff
#define MPLS_ENTRY_LABEL_BITS  \
    (MPLS_ENTRY_LABEL_MASK << MPLS_ENTRY_LABEL_SHIFT)

#define MPLS_ENTRY_EXP_OFFSET   2       /* byte offset to EXP bits */
#define MPLS_ENTRY_EXP_SHIFT   9
#define MPLS_ENTRY_EXP_MASK    0x07
#define MPLS_ENTRY_EXP(mpls)   \
    (((mpls)>>MPLS_ENTRY_EXP_SHIFT) & MPLS_ENTRY_EXP_MASK)
#define MPLS_ENTRY_EXP_BITS    \
    (MPLS_ENTRY_EXP_MASK << MPLS_ENTRY_EXP_SHIFT)

#define MPLS_ENTRY_EOS_OFFSET   2       /* byte offset to EOS bit */
#define MPLS_ENTRY_EOS_SHIFT   8
#define MPLS_ENTRY_EOS_MASK    0x01    /* EOS bit in its byte */
#define        MPLS_ENTRY_EOS(mpls)    \
    (((mpls) >> MPLS_ENTRY_EOS_SHIFT) & MPLS_ENTRY_EOS_MASK)
#define MPLS_ENTRY_EOS_BIT     (MPLS_ENTRY_EOS_MASK << MPLS_ENTRY_EOS_SHIFT)

#define MPLS_ENTRY_TTL_OFFSET  3  /* byte offset to ttl field */
#define MPLS_ENTRY_TTL_SHIFT   0
#define MPLS_ENTRY_TTL_MASK    0xff
#define MPLS_ENTRY_TTL(mpls)   \
    (((mpls) >> MPLS_ENTRY_TTL_SHIFT) & MPLS_ENTRY_TTL_MASK)
#define MPLS_ENTRY_TTL_BITS    \
    (MPLS_ENTRY_TTL_MASK << MPLS_ENTRY_TTL_SHIFT)

static inline u32 vnet_mpls_uc_get_label (mpls_label_t label_exp_s_ttl)
{
    return (label_exp_s_ttl>>MPLS_ENTRY_LABEL_SHIFT);
}

static inline u32 vnet_mpls_uc_get_exp (mpls_label_t label_exp_s_ttl)
{
    return (MPLS_ENTRY_EXP(label_exp_s_ttl));
}

static inline u32 vnet_mpls_uc_get_s (mpls_label_t label_exp_s_ttl)
{
    return (MPLS_ENTRY_EOS(label_exp_s_ttl));
}

static inline u32 vnet_mpls_uc_get_ttl (mpls_label_t label_exp_s_ttl)
{
    return (MPLS_ENTRY_TTL(label_exp_s_ttl));
}

static inline void vnet_mpls_uc_set_label (mpls_label_t *label_exp_s_ttl,
                                           u32 value)
{
    *label_exp_s_ttl = (((*label_exp_s_ttl) & ~(MPLS_ENTRY_LABEL_BITS)) |
                        ((value  & MPLS_ENTRY_LABEL_MASK) << MPLS_ENTRY_LABEL_SHIFT));
}

static inline void vnet_mpls_uc_set_exp (mpls_label_t *label_exp_s_ttl,
                                         u32 exp)
{
    *label_exp_s_ttl = (((*label_exp_s_ttl) & ~(MPLS_ENTRY_EXP_BITS)) |
                        ((exp & MPLS_ENTRY_EXP_MASK) << MPLS_ENTRY_EXP_SHIFT));
}
 
static inline void vnet_mpls_uc_set_s (mpls_label_t *label_exp_s_ttl,
                                       u32 eos)
{
    *label_exp_s_ttl = (((*label_exp_s_ttl) & ~(MPLS_ENTRY_EOS_BIT)) |
                        ((eos & MPLS_ENTRY_EOS_MASK) << MPLS_ENTRY_EOS_SHIFT));
}
 
static inline void vnet_mpls_uc_set_ttl (mpls_label_t *label_exp_s_ttl,
                                         u32 ttl)
{
    *label_exp_s_ttl = (((*label_exp_s_ttl) & ~(MPLS_ENTRY_TTL_BITS)) |
                        ((ttl & MPLS_ENTRY_TTL_MASK)));
}

#endif /* included_vnet_mpls_packet_h */
n">ip4_reass_hash; dlist_elt_t *ip4_reass_lru_list_pool; dlist_elt_t *ip4_frags_list_pool; u32 ip4_reass_head_index; u16 ip4_reass_n; clib_spinlock_t ip4_reass_lock; /* IPv6 runtime */ nat_reass_ip6_t *ip6_reass_pool; clib_bihash_48_8_t ip6_reass_hash; dlist_elt_t *ip6_reass_lru_list_pool; dlist_elt_t *ip6_frags_list_pool; u32 ip6_reass_head_index; u16 ip6_reass_n; clib_spinlock_t ip6_reass_lock; /* convenience */ vlib_main_t *vlib_main; vnet_main_t *vnet_main; } nat_reass_main_t; /** * @brief Set NAT virtual fragmentation reassembly configuration. * * @param timeout Reassembly timeout. * @param max_reass Maximum number of concurrent reassemblies. * @param max_frag Maximum number of fragmets per reassembly * @param drop_frag If zero translate fragments, otherwise drop fragments. * @param is_ip6 1 if IPv6, 0 if IPv4. * * @returns 0 on success, non-zero value otherwise. */ int nat_reass_set (u32 timeout, u16 max_reass, u8 max_frag, u8 drop_frag, u8 is_ip6); /** * @brief Get reassembly timeout. * * @param is_ip6 1 if IPv6, 0 if IPv4. * * @returns reassembly timeout. */ u32 nat_reass_get_timeout (u8 is_ip6); /** * @brief Get maximum number of concurrent reassemblies. * * @param is_ip6 1 if IPv6, 0 if IPv4. * * @returns maximum number of concurrent reassemblies. */ u16 nat_reass_get_max_reass (u8 is_ip6); /** * @brief Get maximum number of fragmets per reassembly. * * @param is_ip6 1 if IPv6, 0 if IPv4. * * @returns maximum number of fragmets per reassembly. */ u8 nat_reass_get_max_frag (u8 is_ip6); /** * @brief Get status of virtual fragmentation reassembly. * * @param is_ip6 1 if IPv6, 0 if IPv4. * * @returns zero if translate fragments, non-zero value if drop fragments. */ u8 nat_reass_is_drop_frag (u8 is_ip6); /** * @brief Initialize NAT virtual fragmentation reassembly. * * @param vm vlib main. * * @return error code. */ clib_error_t *nat_reass_init (vlib_main_t * vm); /** * @brief Find reassembly. * * @param src Source IPv4 address. * @param dst Destination IPv4 address. * @param frag_id Fragment ID. * @param proto L4 protocol. * * @returns Reassembly data or 0 if not found. */ nat_reass_ip4_t *nat_ip4_reass_find (ip4_address_t src, ip4_address_t dst, u16 frag_id, u8 proto); /** * @brief Find or create reassembly. * * @param src Source IPv4 address. * @param dst Destination IPv4 address. * @param frag_id Fragment ID. * @param proto L4 protocol. * @param reset_timeout If non-zero value reset timeout. * @param bi_to_drop Fragments to drop. * * @returns Reassembly data or 0 on failure. */ nat_reass_ip4_t *nat_ip4_reass_find_or_create (ip4_address_t src, ip4_address_t dst, u16 frag_id, u8 proto, u8 reset_timeout, u32 ** bi_to_drop); /** * @brief Cache fragment. * * @param reass Reassembly data. * @param bi Buffer index. * @param bi_to_drop Fragments to drop. * * @returns 0 on success, non-zero value otherwise. */ int nat_ip4_reass_add_fragment (nat_reass_ip4_t * reass, u32 bi, u32 ** bi_to_drop); /** * @brief Get cached fragments. * * @param reass Reassembly data. * @param bi Vector of buffer indexes. */ void nat_ip4_reass_get_frags (nat_reass_ip4_t * reass, u32 ** bi); /** * @breif Call back function when walking IPv4 reassemblies, non-zero return * value stop walk. */ typedef int (*nat_ip4_reass_walk_fn_t) (nat_reass_ip4_t * reass, void *ctx); /** * @brief Walk IPv4 reassemblies. * * @param fn The function to invoke on each entry visited. * @param ctx A context passed in the visit function. */ void nat_ip4_reass_walk (nat_ip4_reass_walk_fn_t fn, void *ctx); /** * @brief Find or create reassembly. * * @param src Source IPv6 address. * @param dst Destination IPv6 address. * @param frag_id Fragment ID. * @param proto L4 protocol. * @param reset_timeout If non-zero value reset timeout. * @param bi_to_drop Fragments to drop. * * @returns Reassembly data or 0 on failure. */ nat_reass_ip6_t *nat_ip6_reass_find_or_create (ip6_address_t src, ip6_address_t dst, u32 frag_id, u8 proto, u8 reset_timeout, u32 ** bi_to_drop); /** * @brief Cache fragment. * * @param reass Reassembly data. * @param bi Buffer index. * @param bi_to_drop Fragments to drop. * * @returns 0 on success, non-zero value otherwise. */ int nat_ip6_reass_add_fragment (nat_reass_ip6_t * reass, u32 bi, u32 ** bi_to_drop); /** * @brief Get cached fragments. * * @param reass Reassembly data. * @param bi Vector of buffer indexes. */ void nat_ip6_reass_get_frags (nat_reass_ip6_t * reass, u32 ** bi); /** * @breif Call back function when walking IPv6 reassemblies, non-zero return * value stop walk. */ typedef int (*nat_ip6_reass_walk_fn_t) (nat_reass_ip6_t * reass, void *ctx); /** * @brief Walk IPv6 reassemblies. * * @param fn The function to invoke on each entry visited. * @param ctx A context passed in the visit function. */ void nat_ip6_reass_walk (nat_ip6_reass_walk_fn_t fn, void *ctx); #endif /* __included_nat_reass_h__ */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */