summaryrefslogtreecommitdiffstats
path: root/VNFs/vCGNAPT/pipeline/pipeline_cgnapt_common.h
blob: 4f4253cda6f3975e566e179e48579499fd78c52c (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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/*
// Copyright (c) 2017 Intel Corporation
//
// 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 __INCLUDE_PIPELINE_CGNAPT_COMMON_H__
#define __INCLUDE_PIPELINE_CGNAPT_COMMON_H__

#include "pipeline_common_fe.h"

extern uint8_t CGNAPT_DEBUG;

struct pipeline_cgnapt_entry_key {
	uint32_t ip;
	uint16_t port;		/* L4 port */
	uint16_t pid;		/* if port id */
};

/*
 * CGNAPY Entry
 */
enum cgnapt_entry_type {
	CGNAPT_ENTRY_IPV4,
	CGNAPT_ENTRY_IPV6
};

#ifdef PCP_ENABLE
/**
 * An enum defining the CG-NAPT entry creation type
 */

enum {
	STATIC_CGNAPT_ENTRY,
	DYNAMIC_CGNAPT_ENTRY,
	PCP_CGNAPT_ENTRY,
};
#endif

struct app_pipeline_cgnapt_entry_params {
	enum cgnapt_entry_type type;
	union {
		uint32_t prv_ip;	/* private ip address */
		uint8_t prv_ipv6[16];
		uint16_t u16_prv_ipv6[8];
		uint32_t u32_prv_ipv6[4];
	} u;
	uint32_t prv_ip;
	uint16_t prv_port;	/* private port */
	uint32_t pub_ip;	/* public ip address */
	uint16_t pub_port;	/* public port */
	uint16_t prv_phy_port;	/* physical port on private side */
	uint16_t pub_phy_port;	/* physical port on public side */
	uint32_t ttl;		/* time to live */
	long long int timeout;
	#ifdef PCP_ENABLE
	struct rte_timer *timer;
	#endif
};

/*
 *CGNAPT table
 */

struct cgnapt_table_entry {
	struct rte_pipeline_table_entry head;
	struct app_pipeline_cgnapt_entry_params data;
} __rte_cache_aligned;

/**
 * A structure defining the CG-NAPT multiple entry parameter.
 */
struct app_pipeline_cgnapt_mentry_params {
	enum cgnapt_entry_type type;
	union {
		uint32_t prv_ip;	/* private ip address */
		uint8_t prv_ipv6[16];
		uint16_t u16_prv_ipv6[8];
		uint32_t u32_prv_ipv6[4];
	} u;
	uint32_t prv_ip;	/* private ip address */
	uint16_t prv_port;	/* private port start */
	uint32_t pub_ip;	/* public ip address */
	uint16_t pub_port;	/* public port start */
	uint16_t prv_phy_port;	/* physical port on private side */
	uint16_t pub_phy_port;	/* physical port on public side */
	uint32_t ttl;		/* time to live */
	uint32_t num_ue;	/* number of UEs to add */
	uint16_t prv_port_max;	/* max value for private port */
	uint16_t pub_port_max;	/* max value for public port */
};

/**
 * A structure defining the NAT64 Network Specific Prefix.
 */
struct pipeline_cgnapt_nsp_t {
	uint8_t prefix[16];
	uint8_t depth;
};


/*
 * Messages
 */
enum pipeline_cgnapt_msg_req_type {
	PIPELINE_CGNAPT_MSG_REQ_ENTRY_ADD,
	PIPELINE_CGNAPT_MSG_REQ_ENTRY_DEL,
	/* to be used for periodic synchronization */
	PIPELINE_CGNAPT_MSG_REQ_ENTRY_SYNC,
	/* to be used for debug purposes */
	PIPELINE_CGNAPT_MSG_REQ_ENTRY_DBG,
	/* Multiple (bulk) add */
	PIPELINE_CGNAPT_MSG_REQ_ENTRY_ADDM,
	PIPELINE_CGNAPT_MSG_REQ_VER,
	PIPELINE_CGNAPT_MSG_REQ_NSP_ADD,
	PIPELINE_CGNAPT_MSG_REQ_NSP_DEL,
	#ifdef PCP_ENABLE
	PIPELINE_CGNAPT_MSG_REQ_PCP,
	#endif
	PIPELINE_CGNAPT_MSG_REQS
};

/**
 * A structure defining MSG ENTRY ADD request.
 */
struct pipeline_cgnapt_entry_add_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* key */
	struct pipeline_cgnapt_entry_key key;

	/* data */
	struct app_pipeline_cgnapt_entry_params data;
};

/**
 * A structure defining MSG ENTRY ADD response.
 */
struct pipeline_cgnapt_entry_add_msg_rsp {
	int status;
	int key_found;
	void *entry_ptr;
};

/**
 * A structure defining MSG ENTRY MADD request.
 */
struct pipeline_cgnapt_entry_addm_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* data */
	struct app_pipeline_cgnapt_mentry_params data;
};

struct pipeline_cgnapt_entry_addm_msg_rsp {
	int status;
	int key_found;
	void *entry_ptr;
};

/**
 * A structure defining MSG ENTRY DELETE request.
 */
struct pipeline_cgnapt_entry_delete_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* key */
	struct pipeline_cgnapt_entry_key key;
};

/**
 * A structure defining MSG ENTRY DELETE response.
 */
struct pipeline_cgnapt_entry_delete_msg_rsp {
	int status;
	int key_found;
};

/*
 * MSG ENTRY SYNC
 */
struct pipeline_cgnapt_entry_sync_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* data */
	struct app_pipeline_cgnapt_entry_params data;
};

struct pipeline_cgnapt_entry_sync_msg_rsp {
	int status;
	void *entry_ptr;
};

/**
 * A structure defining the debug command response message.
 */
struct pipeline_cgnapt_entry_dbg_msg_rsp {
	int status;
	void *entry_ptr;
};

/**
 * A structure defining the NSP add request.
 */
struct pipeline_cgnapt_nsp_add_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* Network Specific Prefix and prefix length */
	struct pipeline_cgnapt_nsp_t nsp;
};

/**
 * A structure defining the NSP add response.
 */
struct pipeline_cgnapt_nsp_add_msg_rsp {
	int status;
	int key_found;
};

/**
 * A structure defining MSG NSP DEL request
 */
struct pipeline_cgnapt_nsp_del_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* Network Specific Prefix and prefix length */
	struct pipeline_cgnapt_nsp_t nsp;

};

/**
 * A structure defining MSG NSP DEL response
 */
struct pipeline_cgnapt_nsp_del_msg_rsp {
	int status;
	int key_found;
};

/**
 * A structure defining the debug command request message.
 */
struct pipeline_cgnapt_entry_dbg_msg_req {
	enum pipeline_msg_req_type type;
	enum pipeline_cgnapt_msg_req_type subtype;

	/* data */
	uint8_t data[5];
};

extern struct pipeline_be_ops pipeline_cgnapt_be_ops;
void print_num_ip_clients(void);
void all_cgnapt_stats(void);
void all_cgnapt_clear_stats(void);
void print_static_cgnapt_entries(void);
#endif