wireguard: add async mode for encryption packets
[vpp.git] / src / plugins / wireguard / wireguard.h
1 /*
2  * Copyright (c) 2020 Doc.ai and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef __included_wg_h__
16 #define __included_wg_h__
17
18 #include <wireguard/wireguard_index_table.h>
19 #include <wireguard/wireguard_messages.h>
20 #include <wireguard/wireguard_timer.h>
21
22 #define WG_DEFAULT_DATA_SIZE 2048
23
24 extern vlib_node_registration_t wg4_input_node;
25 extern vlib_node_registration_t wg6_input_node;
26 extern vlib_node_registration_t wg4_output_tun_node;
27 extern vlib_node_registration_t wg6_output_tun_node;
28
29 typedef struct wg_per_thread_data_t_
30 {
31   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
32   vnet_crypto_op_t *crypto_ops;
33   vnet_crypto_async_frame_t **async_frames;
34   u8 data[WG_DEFAULT_DATA_SIZE];
35 } wg_per_thread_data_t;
36 typedef struct
37 {
38   /* convenience */
39   vlib_main_t *vlib_main;
40
41   u16 msg_id_base;
42
43   wg_index_table_t index_table;
44
45   u32 in4_fq_index;
46   u32 in6_fq_index;
47   u32 out4_fq_index;
48   u32 out6_fq_index;
49
50   wg_per_thread_data_t *per_thread_data;
51   u8 feature_init;
52
53   tw_timer_wheel_16t_2w_512sl_t timer_wheel;
54
55   /* operation mode flags (e.g. async) */
56   u8 op_mode_flags;
57 } wg_main_t;
58
59 typedef struct
60 {
61   /* wg post node index for async crypto */
62   u32 wg4_post_next;
63   u32 wg6_post_next;
64 } wg_async_post_next_t;
65
66 extern wg_async_post_next_t wg_encrypt_async_next;
67 extern wg_main_t wg_main;
68
69 /**
70  * Wireguard operation mode
71  **/
72 #define foreach_wg_op_mode_flags _ (0, ASYNC, "async")
73
74 /**
75  * Helper function to set/unset and check op modes
76  **/
77 typedef enum wg_op_mode_flags_t_
78 {
79 #define _(v, f, s) WG_OP_MODE_FLAG_##f = 1 << v,
80   foreach_wg_op_mode_flags
81 #undef _
82 } __clib_packed wg_op_mode_flags_t;
83
84 #define _(a, v, s)                                                            \
85   always_inline int wg_op_mode_set_##v (void)                                 \
86   {                                                                           \
87     return (wg_main.op_mode_flags |= WG_OP_MODE_FLAG_##v);                    \
88   }                                                                           \
89   always_inline int wg_op_mode_unset_##v (void)                               \
90   {                                                                           \
91     return (wg_main.op_mode_flags &= ~WG_OP_MODE_FLAG_##v);                   \
92   }                                                                           \
93   always_inline int wg_op_mode_is_set_##v (void)                              \
94   {                                                                           \
95     return (wg_main.op_mode_flags & WG_OP_MODE_FLAG_##v);                     \
96   }
97 foreach_wg_op_mode_flags
98 #undef _
99
100   typedef struct
101 {
102   u8 __pad[22];
103   u16 next_index;
104 } wg_post_data_t;
105
106 STATIC_ASSERT (sizeof (wg_post_data_t) <=
107                  STRUCT_SIZE_OF (vnet_buffer_opaque_t, unused),
108                "Custom meta-data too large for vnet_buffer_opaque_t");
109
110 #define wg_post_data(b)                                                       \
111   ((wg_post_data_t *) ((u8 *) ((b)->opaque) +                                 \
112                        STRUCT_OFFSET_OF (vnet_buffer_opaque_t, unused)))
113
114 #define WG_START_EVENT  1
115 void wg_feature_init (wg_main_t * wmp);
116 void wg_set_async_mode (u32 is_enabled);
117
118 #endif /* __included_wg_h__ */
119
120 /*
121  * fd.io coding-style-patch-verification: ON
122  *
123  * Local Variables:
124  * eval: (c-set-style "gnu")
125  * End:
126  */