Initial commit of vpp code.
[vpp.git] / vnet / vnet / l2 / l2_bd.h
1 /*
2  * l2_bd.h : layer 2 bridge domain
3  *
4  * Copyright (c) 2013 Cisco and/or its affiliates.
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #ifndef included_l2bd_h
19 #define included_l2bd_h
20
21 #include <vlib/vlib.h>
22 #include <vnet/vnet.h>
23
24 typedef struct {
25   // hash bd_id -> bd_index
26   uword * bd_index_by_bd_id;
27
28   // Busy bd_index bitmap
29   uword * bd_index_bitmap;
30
31   // convenience
32   vlib_main_t * vlib_main;
33   vnet_main_t * vnet_main;
34 } bd_main_t;
35
36 bd_main_t bd_main;
37
38 // Bridge domain member 
39
40 #define L2_FLOOD_MEMBER_NORMAL 0
41 #define L2_FLOOD_MEMBER_BVI    1
42
43 typedef struct {
44   u32  sw_if_index;  // the output L2 interface
45   u8   flags;        // 0=normal, 1=bvi
46   u8   shg;          // split horizon group number 
47   u16  spare;
48 } l2_flood_member_t;
49
50
51 // Per-bridge domain configuration
52
53 typedef struct {
54   u32 feature_bitmap; 
55   // Contains bit enables for flooding, learning, and forwarding.
56   // All other feature bits should always be set.
57
58   // identity of the bridge-domain's BVI interface
59   // set to ~0 if there is no BVI
60   u32 bvi_sw_if_index;
61
62   // output node index for bvi interface before it was changed to l2-input
63   u32 saved_bvi_output_node_index;
64
65   // bridge domain id, not to be confused with bd_index
66   u32 bd_id;
67
68   // Vector of members in the replication group
69   l2_flood_member_t * members;
70
71   // hash ip4/ip6 -> mac for arp termination
72   uword *mac_by_ip4;
73   uword *mac_by_ip6;
74
75 } l2_bridge_domain_t;
76
77 // Return 1 if bridge domain has been initialized
78 always_inline u32
79 bd_is_valid (l2_bridge_domain_t * bd_config) 
80 {
81   return (bd_config->feature_bitmap != 0);
82 }
83
84 // Init bridge domain if not done already
85 inline void
86 bd_validate (l2_bridge_domain_t * bd_config);
87
88
89 void
90 bd_add_member (l2_bridge_domain_t * bd_config,
91                l2_flood_member_t * member);
92
93 u32
94 bd_remove_member (l2_bridge_domain_t * bd_config,
95                   u32 sw_if_index);
96
97
98 #define L2_LEARN   (1<<0)
99 #define L2_FWD     (1<<1)
100 #define L2_FLOOD   (1<<2)
101 #define L2_UU_FLOOD (1<<3)
102 #define L2_ARP_TERM (1<<4)
103
104 u32 
105 bd_set_flags (vlib_main_t * vm,
106               u32 bd_index,
107               u32 flags,
108               u32 enable);
109
110 u32 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id);
111 int bd_delete_bd_index (bd_main_t * bdm, u32 bd_id);
112
113 u32 bd_add_del_ip_mac(u32 bd_index,
114                       u8 *ip_addr,
115                       u8 *mac_addr,
116                       u8 is_ip6,
117                       u8 is_add);
118
119 #endif
120