Statistics
| Branch: | Revision:

ml / transmissionHandler.h @ 6f256447

History | View | Annotate | Download (15.9 KB)

1
/*
2
 *          Policy Management
3
 *
4
 *          NEC Europe Ltd. PROPRIETARY INFORMATION
5
 *
6
 * This software is supplied under the terms of a license agreement
7
 * or nondisclosure agreement with NEC Europe Ltd. and may not be
8
 * copied or disclosed except in accordance with the terms of that
9
 * agreement.
10
 *
11
 *      Copyright (c) 2009 NEC Europe Ltd. All Rights Reserved.
12
 *
13
 * Authors: Kristian Beckers  <beckers@nw.neclab.eu>
14
 *          Sebastian Kiesel  <kiesel@nw.neclab.eu>
15
 *          
16
 *
17
 * NEC Europe Ltd. DISCLAIMS ALL WARRANTIES, EITHER EXPRESS OR IMPLIED,
18
 * INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY
19
 * AND FITNESS FOR A PARTICULAR PURPOSE AND THE WARRANTY AGAINST LATENT
20
 * DEFECTS, WITH RESPECT TO THE PROGRAM AND THE ACCOMPANYING
21
 * DOCUMENTATION.
22
 *
23
 * No Liability For Consequential Damages IN NO EVENT SHALL NEC Europe
24
 * Ltd., NEC Corporation OR ANY OF ITS SUBSIDIARIES BE LIABLE FOR ANY
25
 * DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
26
 * OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF INFORMATION, OR
27
 * OTHER PECUNIARY LOSS AND INDIRECT, CONSEQUENTIAL, INCIDENTAL,
28
 * ECONOMIC OR PUNITIVE DAMAGES) ARISING OUT OF THE USE OF OR INABILITY
29
 * TO USE THIS PROGRAM, EVEN IF NEC Europe Ltd. HAS BEEN ADVISED OF THE
30
 * POSSIBILITY OF SUCH DAMAGES.
31
 *
32
 *     THIS HEADER MAY NOT BE EXTRACTED OR MODIFIED IN ANY WAY.
33
 */
34

    
35
/**
36
 * @file transmissionHandler.h
37
 * @brief The transmissionHandler takes care of connecting peers and exchanging data between them.
38
 *
39
 * @author Kristian Beckers  <beckers@nw.neclab.eu>                             
40
 * @author Sebastian Kiesel  <kiesel@nw.neclab.eu> 
41
 *
42
 *                                                                              
43
 * @date 7/28/2009 
44
 */
45

    
46
#ifndef TRANSMISSIONHANDLER_H
47
#define TRANSMISSIONHANDLER_H
48
#include <sys/time.h>
49
#include <netinet/in.h>
50
#include <sys/socket.h>
51
#include <fcntl.h>
52
#include <event2/event.h>
53
#include <sys/types.h>
54
#include <netinet/in.h>
55
#include <arpa/inet.h>
56
#include <sys/uio.h>
57
#include "util/udpSocket.h"
58
#include "util/stun.h"
59
#include "ml.h"
60

    
61
#ifndef boolean
62
typedef bool boolean;
63
#endif
64
#ifndef TRUE
65
#define TRUE ((bool)1)
66
#endif
67
#ifndef FALSE
68
#define FALSE ((bool)0)
69
#endif
70

    
71
/**
72
 * This is the maximum size of the monitoring module header that can be added to the messaging layer header
73
 */
74
#define MON_HEADER_SPACE 32
75

    
76

    
77
/**
78
  * Define the size of the messaging layer header 
79
  */
80
#define MSGL_HEADER_SIZE 18
81

    
82
#define MAX_TRIALS 3
83

    
84
/**
85
  * Define a type that is a pointer to a libevent event 
86
  */
87
typedef struct event *sock_event_ptr;
88

    
89
/**
90
 * Defined a mtu size - IP size - UDP size
91
 */
92
typedef enum {MAX = 1472, DSL = 1464, DSLMEDIUM = 1422, DSLSLIM = 1372, BELOWDSL = 1172, MIN = 472,ERROR = -1} pmtu;
93

    
94
/**
95
 * Define connection command types
96
 */
97
typedef enum {INVITE = 0, CONNECT, READY} con_msg_types;
98

    
99
/**
100
 * Define receiver buffer status
101
 */
102

    
103
typedef enum {ACTIVE = 0, INACTIVE, COMPLETE} recvbuf_status_types;
104

    
105
/**
106
 * A union that considers IPv4 and IPv6 addresses 
107
 */
108
typedef union{
109

    
110
  struct sockaddr_in udpaddr; ///< ipv4 address
111
  struct sockaddr_in6 udpaddr6; ///< ipv6 address
112

    
113
} socketaddrgen;
114

    
115
/**
116
  the socketID contains the internal and the external IP+Port 
117
 */
118
typedef struct _socket_ID {
119

    
120
  socketaddrgen internal_addr; ///< internal address
121
  socketaddrgen external_addr; ///< external or reflexive address
122
} socket_ID;
123

    
124
/**
125
  * A struct that contains information about data that is being received
126
  */
127
typedef struct {
128

    
129
  int recvID; ///< the receive ID
130
  int connectionID; ///< The connectionID
131
  int seqnr; ///< The sequence number
132
  char *recvbuf; ///< A pointer to the receive buffer
133
  int bufsize; ///< The  buffersize
134
  int status; ///< The receive status. 1 if reveived finished
135
  char msgtype; ///< The message type
136
  char firstPacketArrived; ///< did the first packet arrive 
137
  int recvFragments; ///< the number of received framgents
138
  int arrivedBytes; ///< the number of received Bytes
139
  int monitoringDataHeaderLen; ///< size of the monitoring data header (0 == no header)
140
  struct event *timeout; ///< a timeout event
141
  struct timeval timeout_value; ///< the value for a libevent timeout
142
  time_t starttime; ///< the start time
143
} recvdata;
144

    
145
struct receive_connection_cb_list{
146
        struct receive_connection_cb_list *next;
147
        receive_connection_cb connection_cb;
148
        void *arg;
149
};
150

    
151
/**
152
 * A struct with information about a connection that exist or a connection that is being established
153
 */
154
typedef struct {
155

    
156
  int connectionID; ///< the connection ID
157
  socket_ID external_socketID; ///< the external socketID
158
  int external_connectionID; ///< the internal connectionID
159
  pmtu pmtusize; ///< the pmtu size
160
  bool delay;
161
  int trials;
162
  char *ctrl_msg_buf;
163
  int status; ///< the status of the connection. status has the following encoding: 0: INVITE send, 1: CONNECT send, 2: connection established
164
  time_t starttime; ///< the time when the first connection attempt was made
165
  uint32_t seqnr; ///< sequence number for connections that have been tried
166
  //struct event *timeout;
167
  struct timeval timeout_value; ///< the timeout value for the connection estahlishment
168
  bool internal_connect; ///< set to true if a connection to the internall address could be established
169
  struct receive_connection_cb_list *connection_head;
170
  struct receive_connection_cb_list *connection_last;
171
  send_params defaultSendParams;
172
} connect_data;
173

    
174
#define ML_CON_MSG 127
175

    
176
/**
177
 * A struct with the messaging layer header for connection handling messages
178
 */
179
#pragma pack(push)  /* push current alignment to stack */
180
#pragma pack(1)     /* set alignment to 1 byte boundary */
181
struct conn_msg {
182
        uint32_t comand_type; ///< see con_msg_types
183
        int32_t pmtu_size;        /// the pmtu size 
184
        socket_ID sock_id;        /// the socketId of the sender
185
};
186

    
187
struct msg_header {
188
        uint8_t msg_type; ///< set to ML_CON_MSG
189
        uint8_t len_mon_data_hdr;
190
        uint8_t len_mon_packet_hdr;
191
        uint32_t offset;
192
        uint32_t msg_length;
193
        int32_t local_con_id;        ///> the local connection id
194
        int32_t remote_con_id;        ///> the remote connection id
195
        int32_t msg_seq_num;
196
};
197
#define MSG_HEADER_SIZE 23
198
#pragma pack(pop)   /* restore original alignment from stack */
199

    
200
//
201
///**
202
// * The init method needs to be called to initialise the transmissionHandler
203
// * @param recv_data_cb This is a boolean that decides how an upper layer receives data. When the boolean is set to true data is received via callback. When it is set to false the upper layer has to poll with the recv_data function.
204
// * @param timeout_value A timeout value for the data receival
205
// * @param port A port that will be used to create a new UDP socket
206
// * @param ipaddr An ipaddress that will be used to create a new UDP socket. If left NULL th
207
//e messaging layer binds it to localhost.
208
// * @param stun_port The port of the stun server.
209
// * @param stun_ipaddr The ip address of the stun server.
210
// * @param local_socketID_cb A callback from the type receive_localsocketID_cb that is envoke once the socketID is ready to use.
211
// * @param arg A void pointer that is used in this implementation to handover the libevent pointer.
212
// */
213
//void init_transmissionHandler(bool recv_data_cb,struct timeval timeout_value,const int port,const char *ipaddr,const int stun_port,const char *stun_ipaddr,receive_localsocketID_cb local_socketID_cb,void *arg);
214
//
215
///**
216
// * create a socket: returns a socketID handle
217
// * A socketID handle is a pointer to the opague data structre
218
// * @param port A port that will be used to create a new UDP socket
219
// * @param ipaddr An ipaddress that will be used to create a new UDP socket. If left NULL the messaging layer binds it to localhost.
220
// */
221
//void create_socket(const int port,const char *ipaddr);
222
//
223
///**
224
// * destroys a socket
225
// * @param socketID The socketID handle to the socket ID that shall be destroyed.
226
// */
227
//void close_socket(socketID_handle socketID);
228
//
229
///**
230
// * opens a connection between two socketIDs
231
// * @param local_socketID The local socketID
232
// * @param external_socketID The remote socketID
233
// * @param connectionID A pointer to an int. The connectionID will be stored in that int.
234
// * @param connection_cb  A function pointer to a callback function from the type receive_connection_cb
235
// * @param arg A void pointer that is returned via the callback.
236
// * @return returnValue the connectionId, < 0 for a failure.
237
// */
238
//int open_connection(socketID_handle external_socketID,receive_connection_cb connection_cb,void *arg);
239
//
240
///**
241
// * destroys a connections
242
// * @param connectionID
243
// */
244
//void close_connection(const int connectionID);
245
//
246
//
247
///**
248
//  * Send a NAT traversal keep alive
249
//  * @param connectionID
250
//  */
251
//void keep_connection_alive(const int connectionID);
252
//
253
///**
254
// * send all data
255
// * @param connectionID The connection the data should be send to.
256
// * @param container A container for several buffer pointer and length pairs from type send_all_data_container
257
// * @param nr_entries The number of buffer pointer and length pairs in the container. The maximum nr is 5.
258
// * @param msgtype The message type.
259
// * @param sParams A pointer to a send_params struct.
260
// * @return 0 if a problem occured, 1 if everything was alright.
261
// */
262
//int send_all_data(const int connectionID,send_all_data_container *container,int nr_entries,unsigned char msgtype,send_params *sParams);
263
//
264
///**
265
// * send data
266
// * @param connectionID The connection the data should be send to.
267
// * @param sendbuf A pointer to the send buffer.
268
// * @param bufsize The buffersize of the send buffer.
269
// * @param msgtype The message type.
270
// * @param sParams A pointer to a send_params struct.
271
// */
272
//void send_data(const int connectionID,char *sendbuf,int bufsize,int msgtype,send_params *sParams);
273
//
274
//void send_msg(int con_id, int msg_type, char* msg, int msg_len, bool truncable, send_params * sparam);
275
///**
276
// * receive data
277
// * @param connectionID The connection the data came from.
278
// * @param recvbuf A pointer to a buffer the data will be stored in.
279
// * @param bufsize A pointer to an int that tells the size of the received data.
280
// * @param rParams A pointer to a recv_params struct.
281
// */
282
//int recv_data(const int connectionID,char *recvbuf,int *bufsize,recv_params *rParams);
283
//
284
///**
285
// * set the stun server
286
// * @param port The port of the stun server.
287
// * @param ipaddr The ip address of the stun server.
288
// */
289
//void setStunServer(const int port,const char *ipaddr);
290
//
291
///**
292
// * unset the stun server
293
// */
294
//void unsetStunServer();
295
//
296
///**
297
// * checks whether a stun server was defined
298
// * @returns true if a stun serve rwas defined
299
// */
300
//bool isStunDefined();
301
//
302
///**
303
// * set recv timeout
304
// * @param timeout_value The timeout value for receiving data.
305
// */
306
//void setRecv1Timeout(struct timeval timeout_value);
307
//
308
///**
309
//  * create a message for the connection establishment
310
//  * @param *msgbuf A buffer for the message
311
//  * @param bufsize The buffersize
312
//  * @param local_connectionID The local connectionID
313
//  * @param local_socketID The local socketID
314
//  * @param command_type The command type
315
//  * @return -1 for failure otherwise the size of the allocated control message buffer
316
//  */
317
//
318
//int
319
//create_conn_msg(int pmtusize,int local_connectionID, socketID_handle local_socketID, con_msg_types command_type);
320
//
321
///**
322
//  * send a connect message to another peer
323
//  * @param connectionID the connectionID
324
//  * @param *msgbuf A pointer to the message buffer
325
//  * @param bufsize The buffersize
326
//  */
327
//void send_conn_msg(const int connectionID,int bufsize, int command);
328
//
329
///**
330
//  * process an incoming conenction message
331
//  * @param local_socketID
332
//  * @param bufsize
333
//  */
334
//void recv_conn_msg(struct msg_header *msg_h,char *msgbuf,int bufsize);
335
//
336
///**
337
//  * process an incoming message
338
//  * @param fd A file descriptor
339
//  * @param event A libevent event
340
//  * @param arg An arg pointer
341
//  */
342
//void recv_pkg(int fd, short event, void *arg);
343
//
344
///**
345
//  * receive a stun message
346
//  * @param *msgbuf A pointer to a message buffer
347
//  * @param recvSize The buffersize
348
//  */
349
//void recv_stun_msg(char *msgbuf,int recvSize);
350
//
351
///**
352
//  * process an incoming data message
353
//  * @param *msgbuf A pointer to a message buffer
354
//  * @param bufsize The buffersize
355
//  * @param ttl The ttl value of the packet
356
//  */
357
//void recv_data_msg(struct msg_header *msg_h, char *msgbuf, int bufsize);
358
//
359
///**
360
//  * A receive timeout callback for the connections
361
//  * @param fd A file descriptor
362
//  * @param event A libevent event
363
//  * @param arg An arg pointer
364
//  */
365
//void recv_timeout_cb(int fd,short event,void *arg);
366
//
367
///**
368
//  * A pmtu timeout callback
369
//  * @param fd A file descriptor
370
//  * @param event A libevent event
371
//  * @param arg An arg pointer
372
//  */
373
//void pmtu_timeout_cb(int fd,short event,void *arg);
374
//
375
///**
376
//  * A function to decrement the pmtu value
377
//  * @param pmtusize A pmtusize
378
//  */
379
//pmtu pmtu_decrement(pmtu pmtusize);
380
//
381
///**
382
//  * A pmtu error callback
383
//  * @param *msg A pointer to a message buffer
384
//  * @param msglen The buffersize
385
//  */
386
//void pmtu_error_cb_th(char *msg,int msglen);
387
//
388
///**
389
// * Compare two socket IDs and check if the external IPaddresses match
390
// * @param sock1 The first socketID
391
// * @param sock2 The second socketID
392
// * @return 0 if they match, otherwise 1
393
// */
394
//int compare_external_address_socketIDs(socketID_handle sock1,socketID_handle sock2);
395
//
396
///**
397
//  * Compare two socket IDs
398
//  * @param sock1 The first socketID
399
//  * @param sock2 The second socketID
400
//  * @return 0 if they match, otherwise 1
401
//  */
402
//int mlCompareSocketIDs(socketID_handle sock1,socketID_handle sock2);
403
//
404
///**
405
//  * A NAT traversal timeout callback
406
//  * @param fd A file descriptor
407
//  * @param event A libevent event
408
//  * @param arg An arg pointer
409
//  */
410
//void nat_traversal_timeout(int fd, short event, void *arg);
411
//
412
///**
413
// * A function that returns the standard TTL value the operating system places i
414
//n every IP packet
415
// * @param socketID A local socketID
416
// * @param ttl A pointer to an integer
417
// * @return 0 if everything went well and -1 if an error occured
418
// */
419
//int get_standard_ttl(socketID_handle socketID,uint8_t *ttl);
420
//
421
///**
422
// * A funtion that returns a handle for the local socketID
423
// * @param errorstatus Returns 0 if the socketID is operational and 2 if the NAT traversal failed
424
// * @return A socketID handle
425
// */
426
//socketID_handle get_local_socketID(int *errorstatus);
427
//
428
///**
429
// * A funtion that returns the external IP from the local socketID
430
// * @param external_addr A pointer to a char buffer that holds the externall address
431
// * @return -1 if an error occurred and 0 if it succeded
432
// */
433
//int get_external_IP(char* external_addr);
434
//
435
///**
436
// * A funtion that returns a string from a socketID handler
437
// * @param socketID
438
// * @param socketID_string
439
// * @param len size of socketID_string buffer
440
// * @return -1 if an error occurred and 0 if it succeded
441
// */
442
//int mlSoc2ketIDToString(socketID_handle socketID,char* socketID_string, size_t len);
443
//
444
///**
445
// * A funtion that returns a socketID handler from a string
446
// * @param socketID A socketID in string format
447
// * @return a pointer to a socketID
448
// */
449
//int string_to_socketID(const char* socketID_string, socketID_handle socketID);
450
//
451
///**
452
// * A funtion that returns the whenever a connection is ready to use or not.
453
// * @param connectionID The connectionID of the connection that is queried.
454
// * @return the status or -1 if the connectionID does not exist
455
// */
456
//int get_connection_status(int connectionID);
457
//
458
///**
459
// * A funtion that returns the whenever a connection is ready to use or not.
460
// * @param socketID A remote socketID to which the connection has been established.
461
// * @param ready if true,return the connID for READY connections only
462
// * @return -1 if the connection does not exist and the connection ID if it exists.
463
// */
464
//int connection_exist(socketID_handle socketID,bool ready);
465
//
466
///**
467
// * Resolve a hostname to an unsigned long ready to be loaded into struct in_addr.s_addr
468
// * @param ipaddr the ip addr in a textual format
469
// * @return the resolved address, in network byte ordering
470
// */
471
//unsigned long resolve(const char *ipaddr);
472
//
473
//int get_path_mtu(int ConnectionId);
474

    
475

    
476
#endif