Add ref to test framework docs in doxygen output.
[vpp.git] / src / vnet / dhcpv6 / proxy.h
1 /*
2  * proxy.h: dhcp proxy 
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_dhcpv6_proxy_h
19 #define included_dhcpv6_proxy_h
20
21 #include <vnet/vnet.h>
22 #include <vnet/ethernet/ethernet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ip/ip4.h>
25 #include <vnet/ip/ip6_packet.h>
26 #include <vnet/pg/pg.h>
27 #include <vnet/ip/format.h>
28 #include <vnet/ip/udp.h>
29 #include <vnet/dhcpv6/packet.h>
30
31 typedef enum {
32 #define dhcpv6_proxy_error(n,s) DHCPV6_PROXY_ERROR_##n,
33 #include <vnet/dhcpv6/proxy_error.def>
34 #undef dhcpv6_proxy_error
35   DHCPV6_PROXY_N_ERROR,
36 } dhcpv6_proxy_error_t;
37
38 typedef struct {
39   u32 oui;
40   u32 fib_id;
41 } dhcpv6_vss_id;
42
43 typedef union {
44   u8 as_u8[8];
45   dhcpv6_vss_id vpn_id;
46 } dhcpv6_vss_info;
47
48 typedef struct {
49   ip6_address_t dhcp6_server;
50   ip6_address_t dhcp6_src_address;
51   u32 server_fib6_index;
52 } dhcpv6_server_t;
53
54 typedef struct {
55   /* Pool of DHCP servers */
56   dhcpv6_server_t * dhcp6_servers;
57
58   /* Pool of selected DHCP server. Zero is the default server */
59    u32 * dhcp6_server_index_by_rx_fib_index;
60
61   /* all DHCP servers address */
62   ip6_address_t all_dhcpv6_server_address;
63   ip6_address_t all_dhcpv6_server_relay_agent_address;
64
65   /* to drop pkts in server-to-client direction */
66   u32 error_drop_node_index;
67
68   dhcpv6_vss_info *vss;
69
70   /* hash lookup specific vrf_id -> VSS vector index*/
71   u32 *vss_index_by_rx_fib_index;
72    
73   /* convenience */
74   vlib_main_t * vlib_main;
75   vnet_main_t * vnet_main;
76 } dhcpv6_proxy_main_t;
77
78 dhcpv6_proxy_main_t dhcpv6_proxy_main;
79
80 int dhcpv6_proxy_set_vss(u32 tbl_id,
81                          u32 oui,
82                          u32 fib_id, 
83                          int is_del);
84
85 int dhcpv6_proxy_set_server(ip6_address_t *addr,
86                             ip6_address_t *src_address,
87                             u32 rx_fib_id,
88                             u32 server_fib_id,
89                             int is_del);
90
91 void dhcpv6_proxy_dump(void *opaque,
92                        u32 context);
93
94 #endif /* included_dhcpv6_proxy_h */