tport  1.13.16
tport_internal.h
1 /*
2  * This file is part of the Sofia-SIP package
3  *
4  * Copyright (C) 2005 Nokia Corporation.
5  *
6  * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation; either version 2.1 of
11  * the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21  * 02110-1301 USA
22  *
23  */
24 
25 #ifndef TPORT_INTERNAL_H
27 #define TPORT_INTERNAL_H
28 
38 #ifndef SU_H
39 #include <sofia-sip/su.h>
40 #endif
41 
42 #include <sofia-sip/su_uniqueid.h>
43 #include <sofia-sip/su_strlst.h>
44 
45 #ifndef MSG_ADDR_H
46 #include <sofia-sip/msg_addr.h>
47 #endif
48 #ifndef TPORT_H
49 #include <sofia-sip/tport.h>
50 #endif
51 
52 #if HAVE_SOFIA_STUN
53 #include "sofia-sip/stun.h"
54 #include "sofia-sip/stun_tag.h"
55 #endif
56 
58 
59 #ifndef SU_DEBUG
60 #define SU_DEBUG 3
61 #endif
62 #define SU_LOG tport_log
63 
64 #include <sofia-sip/su_debug.h>
65 
66 #if !defined(MSG_NOSIGNAL) || defined(__CYGWIN__) || defined(SYMBIAN)
67 #undef MSG_NOSIGNAL
68 #define MSG_NOSIGNAL (0)
69 #endif
70 
71 #if (_WIN32_WINNT >= 0x0600)
72 #ifndef HAVE_MSG_TRUNC
73 #define HAVE_MSG_TRUNC 1
74 #endif
75 #endif
76 
77 #if !HAVE_MSG_TRUNC
78 #define MSG_TRUNC (0)
79 #endif
80 
81 #ifndef NONE
82 #ifndef _MSC_VER
83 #define NONE ((void *)-1)
84 #else
85 #define NONE ((void *)(INT_PTR)-1)
86 #endif
87 #endif
88 
89 SOFIA_BEGIN_DECLS
90 
91 typedef struct tport_master tport_master_t;
92 typedef struct tport_pending_s tport_pending_t;
93 typedef struct tport_primary tport_primary_t;
94 typedef struct tport_vtable tport_vtable_t;
95 
96 struct sigcomp_state_handler;
97 struct sigcomp_algorithm;
98 struct sigcomp_udvm;
99 struct sigcomp_magic;
100 struct sigcomp_compartment;
101 
102 typedef long unsigned LU; /* for printf() and friends */
103 
105 typedef struct {
106  unsigned tpp_mtu;
107  unsigned tpp_idle;
108  unsigned tpp_timeout;
109  unsigned tpp_socket_keepalive;
110  unsigned tpp_keepalive;
111  unsigned tpp_pingpong;
113  unsigned tpp_sigcomp_lifetime;
114  unsigned tpp_thrpsize;
116  unsigned tpp_thrprqsize;
117  unsigned tpp_qsize;
119  unsigned tpp_drop;
120  int tpp_tos;
122  unsigned tpp_conn_orient:1;
123  unsigned tpp_sdwn_error:1;
124  unsigned tpp_stun_server:1;
125  unsigned tpp_pong2ping:1;
127  unsigned :0;
128 
129 } tport_params_t;
130 
131 
139 struct tport_s {
140  su_home_t tp_home[1];
142  ssize_t tp_refs;
144  unsigned tp_black:1;
146  unsigned tp_accepted:1;
147  unsigned tp_conn_orient:1;
148  unsigned tp_has_connection:1;
149  unsigned tp_reusable:1;
150  unsigned tp_closed : 1;
157  unsigned tp_recv_close:2;
159  unsigned tp_send_close:2;
160  unsigned tp_has_keepalive:1;
161  unsigned tp_has_stun_server:1;
162  unsigned tp_trunc:1;
163  unsigned tp_is_connected:1;
164  unsigned tp_verified:1;
165  unsigned tp_pre_framed:1;
166  unsigned:0;
167 
168  tport_t *tp_left, *tp_right, *tp_dad;
170  tport_master_t *tp_master;
171  tport_primary_t *tp_pri;
173  tport_params_t *tp_params;
175  tp_magic_t *tp_magic;
177  su_timer_t *tp_timer;
179  su_time_t tp_ktime;
180  su_time_t tp_ptime;
182  tp_name_t tp_name[1];
188  su_strlst_t *tp_subjects;
196 #define tp_protoname tp_name->tpn_proto
197 #define tp_canon tp_name->tpn_canon
198 #define tp_host tp_name->tpn_host
199 #define tp_port tp_name->tpn_port
200 #define tp_ident tp_name->tpn_ident
201 
202  su_socket_t tp_socket;
203  int tp_index;
204  int tp_events;
206  su_addrinfo_t tp_addrinfo[1];
207  su_sockaddr_t tp_addr[1];
208 #define tp_addrlen tp_addrinfo->ai_addrlen
209 
210  /* ==== Receive queue ================================================== */
211 
212  msg_t *tp_msg;
213  msg_t const *tp_rlogged;
214  su_time_t tp_rtime;
215  unsigned short tp_ping;
217  /* ==== Pending messages =============================================== */
218 
219  unsigned short tp_reported;
220  unsigned tp_plen;
221  unsigned tp_pused;
222  tport_pending_t *tp_pending;
223  tport_pending_t *tp_released;
225  /* ==== Send queue ===================================================== */
226 
227  msg_t **tp_queue;
228  unsigned short tp_qhead;
230  msg_iovec_t *tp_unsent;
231  size_t tp_unsentlen;
233  msg_iovec_t *tp_iov;
234  size_t tp_iovlen;
236  msg_t const *tp_slogged;
237  su_time_t tp_stime;
239  /* ==== Extensions ===================================================== */
240 
241  tport_compressor_t *tp_comp;
242 
243  /* ==== Statistics ===================================================== */
244 
245  struct {
246  uint64_t sent_msgs, sent_errors, sent_bytes, sent_on_line;
247  uint64_t recv_msgs, recv_errors, recv_bytes, recv_on_line;
248  } tp_stats;
249 };
250 
252 struct tport_primary {
253  tport_t pri_primary[1];
254 #if DOXYGEN_ONLY
255  su_home_t pri_home[1];
256 #else
257 #define pri_home pri_primary->tp_home
258 #define pri_master pri_primary->tp_master
259 #define pri_protoname pri_primary->tp_name->tpn_proto
260 #endif
261  tport_vtable_t const
262  *pri_vtable;
263  int pri_public;
268  tport_primary_t *pri_next;
270  tport_t *pri_open;
271  tport_t *pri_closed;
273  unsigned pri_updating:1;
274  unsigned pri_natted:1;
275  unsigned pri_has_tls:1;
276  unsigned:0;
277 
278  void *pri_stun_handle;
279 
280  tport_params_t pri_params[1];
281 };
282 
284 struct tport_master {
285  tport_t mr_master[1];
286 #if DOXYGEN_ONLY
287  su_home_t mr_home[1];
288 #else
289 #define mr_home mr_master->tp_home
290 #endif
291 
292  int mr_stun_step_ready;
294  tp_stack_t *mr_stack;
296  const *mr_tpac;
297  int mr_log;
298  su_root_t *mr_root;
301  su_timer_t *mr_timer;
303  FILE *mr_dump_file;
304  char *mr_dump;
306  su_socket_t mr_capt_sock;
307  char *mr_capt_name;
308  su_addrinfo_t *mr_capt_src_addr;
309  tport_primary_t *mr_primaries;
310  unsigned mr_prot_ver; /* hep version */
311  unsigned mr_agent_id; /* agent version */
312 
313  tport_params_t mr_params[1];
314 
315  unsigned mr_boundserver:1;
316  unsigned mr_bindv6only:1;
317  unsigned :0;
318 
319  /* Delivery context */
320  struct tport_delivery {
321  tport_t *d_tport;
322  msg_t *d_msg;
323  tp_name_t d_from[1];
324  tport_compressor_t *d_comp;
325  } mr_delivery[1];
326 
327  tport_stun_server_t *mr_stun_server;
328 
329 #if 0
330  struct tport_nat_s {
331  int initialized;
332  int bound;
333  int stun_enabled;
334  char *external_ip_address;
335 #if HAVE_UPNP || HAVE_SOFIA_STUN
336  int try_stun;
337 #endif
338 #if HAVE_UPNP
339 #endif
340 #if HAVE_SOFIA_STUN
341  tport_master_t *tport;
342  char *stun_server;
343  /* stun_socket_t *stun_socket; */
344  stun_handle_t *stun;
345  su_socket_t stun_socket;
346  su_sockaddr_t sockaddr;
347 #endif
348  } mr_nat[1];
349 #endif
350 };
351 
353 struct tport_vtable
354 {
355  char const *vtp_name;
356  enum tport_via vtp_public;
357 
358  size_t vtp_pri_size; /* Size of primary tport */
359  int (*vtp_init_primary)(tport_primary_t *pri,
360  tp_name_t tpn[1],
361  su_addrinfo_t *ai, tagi_t const *,
362  char const **return_culprit);
363  void (*vtp_deinit_primary)(tport_primary_t *pri);
364  int (*vtp_wakeup_pri)(tport_primary_t *pri, int events);
365  tport_t *(*vtp_connect)(tport_primary_t *pri, su_addrinfo_t *ai,
366  tp_name_t const *tpn);
367 
368  size_t vtp_secondary_size; /* Size of secondary tport */
369 
370  int (*vtp_init_secondary)(tport_t *, int socket, int accepted,
371  char const **return_reason);
372  void (*vtp_deinit_secondary)(tport_t *);
373  void (*vtp_shutdown)(tport_t *, int how);
374  int (*vtp_set_events)(tport_t const *self);
375  int (*vtp_wakeup)(tport_t *self, int events);
376  int (*vtp_recv)(tport_t *self);
377  ssize_t (*vtp_send)(tport_t const *self, msg_t *msg,
378  msg_iovec_t iov[], size_t iovused);
379  void (*vtp_deliver)(tport_t *self, msg_t *msg, su_time_t now);
380  int (*vtp_prepare)(tport_t *self, msg_t *msg,
381  tp_name_t const *tpn,
382  struct sigcomp_compartment *cc,
383  unsigned mtu);
384  int (*vtp_keepalive)(tport_t *self, su_addrinfo_t const *ai,
385  tagi_t const *taglist);
386  int (*vtp_stun_response)(tport_t const *self,
387  void *msg, size_t msglen,
388  void *addr, socklen_t addrlen);
389  int (*vtp_next_secondary_timer)(tport_t *self, su_time_t *,
390  char const **return_why);
391  void (*vtp_secondary_timer)(tport_t *self, su_time_t);
392 };
393 
394 int tport_register_type(tport_vtable_t const *vtp);
395 
397 su_inline int tport_is_connection_oriented(tport_t const *self)
398 {
399  return self->tp_conn_orient;
400 }
401 
403 su_inline int tport_has_connection(tport_t const *self)
404 {
405  return self->tp_has_connection;
406 }
407 
408 void tport_has_been_updated(tport_t *tport);
409 
410 int tport_primary_compression(tport_primary_t *pri,
411  char const *compression,
412  tagi_t const *tl);
413 
414 void tport_set_tos(su_socket_t socket, su_addrinfo_t *ai, int tos);
415 
416 tport_t *tport_base_connect(tport_primary_t *pri,
417  su_addrinfo_t *ai,
418  su_addrinfo_t *name,
419  tp_name_t const *tpn);
420 
421 int tport_stream_init_primary(tport_primary_t *pri,
422  su_socket_t socket,
423  tp_name_t tpn[1],
424  su_addrinfo_t *ai,
425  tagi_t const *tags,
426  char const **return_reason);
427 
428 tport_t *tport_alloc_secondary(tport_primary_t *pri,
429  int socket,
430  int accepted,
431  char const **return_reason);
432 
433 int tport_accept(tport_primary_t *pri, int events);
434 int tport_register_secondary(tport_t *self, su_wakeup_f wakeup, int events);
435 void tport_zap_secondary(tport_t *self);
436 
437 int tport_set_secondary_timer(tport_t *self);
438 void tport_base_timer(tport_t *self, su_time_t now);
439 
440 int tport_bind_socket(int socket,
441  su_addrinfo_t *ai,
442  char const **return_culprit);
443 void tport_close(tport_t *self);
444 int tport_shutdown0(tport_t *self, int how);
445 
446 int tport_has_queued(tport_t const *self);
447 
448 int tport_error_event(tport_t *self);
449 void tport_recv_event(tport_t *self);
450 void tport_send_event(tport_t *self);
451 void tport_hup_event(tport_t *self);
452 int tport_setname(tport_t *, char const *, su_addrinfo_t const *, char const *);
453 
454 int tport_wakeup(su_root_magic_t *magic, su_wait_t *w, tport_t *self);
455 
456 ssize_t tport_recv_iovec(tport_t const *self,
457  msg_t **mmsg,
458  msg_iovec_t iovec[msg_n_fragments], size_t N,
459  int exact);
460 
461 msg_t *tport_msg_alloc(tport_t const *self, usize_t size);
462 
463 int tport_prepare_and_send(tport_t *self, msg_t *msg,
464  tp_name_t const *tpn,
465  struct sigcomp_compartment *cc,
466  unsigned mtu);
467 int tport_send_msg(tport_t *self, msg_t *msg,
468  tp_name_t const *tpn,
469  struct sigcomp_compartment *cc);
470 
471 void tport_send_queue(tport_t *self);
472 
473 void tport_deliver(tport_t *self, msg_t *msg, msg_t *next,
474  tport_compressor_t *comp,
475  su_time_t now);
476 void tport_base_deliver(tport_t *self, msg_t *msg, su_time_t now);
477 
478 int tport_recv_error_report(tport_t *self);
479 void tport_error_report(tport_t *self, int errcode,
480  su_sockaddr_t const *addr);
481 
482 int tport_open_log(tport_master_t *mr, tagi_t *tags);
483 void tport_log_msg(tport_t *tp, msg_t *msg, char const *what,
484  char const *via, su_time_t now);
485 void tport_dump_iovec(tport_t const *self, msg_t *msg,
486  size_t n, su_iovec_t const iov[], size_t iovused,
487  char const *what, char const *how);
488 
489 void tport_capt_msg(tport_t const *self, msg_t *msg, size_t n,
490  su_iovec_t const iov[], size_t iovused, char const *what);
491 
492 int tport_capt_msg_hepv2(tport_t const *self, msg_t *msg, size_t n,
493  su_iovec_t const iov[], size_t iovused, char const *what, char **buffer);
494 
495 int tport_capt_msg_hepv3(tport_t const *self, msg_t *msg, size_t n,
496  su_iovec_t const iov[], size_t iovused, char const *what, char **buffer);
497 
498 int tport_tcp_ping(tport_t *self, su_time_t now);
499 int tport_tcp_pong(tport_t *self);
500 
501 extern tport_vtable_t const tport_udp_vtable;
502 extern tport_vtable_t const tport_udp_client_vtable;
503 
504 int tport_udp_init_primary(tport_primary_t *,
505  tp_name_t tpn[1],
506  su_addrinfo_t *,
507  tagi_t const *,
508  char const **return_culprit);
509 void tport_udp_deinit_primary(tport_primary_t *);
510 int tport_recv_dgram(tport_t *self);
511 ssize_t tport_send_dgram(tport_t const *self, msg_t *msg,
512  msg_iovec_t iov[], size_t iovused);
513 int tport_udp_error(tport_t const *self, su_sockaddr_t name[1]);
514 
515 extern tport_vtable_t const tport_tcp_vtable;
516 extern tport_vtable_t const tport_tcp_client_vtable;
517 
518 int tport_tcp_init_primary(tport_primary_t *,
519  tp_name_t tpn[1],
520  su_addrinfo_t *, tagi_t const *,
521  char const **return_culprit);
522 int tport_tcp_init_client(tport_primary_t *,
523  tp_name_t tpn[1],
524  su_addrinfo_t *, tagi_t const *,
525  char const **return_culprit);
526 int tport_tcp_init_secondary(tport_t *self, int socket, int accepted,
527  char const **return_reason);
528 int tport_recv_stream(tport_t *self);
529 ssize_t tport_send_stream(tport_t const *self, msg_t *msg,
530  msg_iovec_t iov[], size_t iovused);
531 
532 int tport_tcp_next_timer(tport_t *self, su_time_t *, char const **);
533 void tport_tcp_timer(tport_t *self, su_time_t);
534 
535 int tport_next_recv_timeout(tport_t *, su_time_t *, char const **);
536 void tport_recv_timeout_timer(tport_t *self, su_time_t now);
537 
538 int tport_next_keepalive(tport_t *self, su_time_t *, char const **);
539 void tport_keepalive_timer(tport_t *self, su_time_t now);
540 
541 extern tport_vtable_t const tport_ws_vtable;
542 extern tport_vtable_t const tport_ws_client_vtable;
543 extern tport_vtable_t const tport_wss_vtable;
544 extern tport_vtable_t const tport_wss_client_vtable;
545 extern tport_vtable_t const tport_sctp_vtable;
546 extern tport_vtable_t const tport_sctp_client_vtable;
547 extern tport_vtable_t const tport_tls_vtable;
548 extern tport_vtable_t const tport_tls_client_vtable;
549 extern tport_vtable_t const tport_stun_vtable;
550 extern tport_vtable_t const tport_http_connect_vtable;
551 extern tport_vtable_t const tport_threadpool_vtable;
552 
553 typedef struct tport_descriptor_s {
554  char const *tpd_name;
555  tport_vtable_t *tpd_vtable;
556  su_addrinfo_t *tpd_hints;
557  int tpd_is_client_only;
558 } tport_descriptor_t;
559 
560 typedef int const *(tport_set_f)(tport_master_t *mr,
561  tp_name_t const *tpn,
562  tagi_t const *taglist,
563  tport_descriptor_t **return_set,
564  int return_set_size);
565 
566 /* STUN plugin */
567 
568 int tport_init_stun_server(tport_master_t *mr, tagi_t const *tags);
569 void tport_deinit_stun_server(tport_master_t *mr);
570 int tport_recv_stun_dgram(tport_t const *self, msg_t **in_out_msg,
571  su_sockaddr_t *from, socklen_t fromlen);
572 
573 int tport_stun_server_add_socket(tport_t *tp);
574 int tport_stun_server_remove_socket(tport_t *tp);
575 
576 void tport_recv_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
577 void tport_recv_message(tport_t *self, msg_t *msg, int error);
578 
579 void tport_sent_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
580 void tport_sent_message(tport_t *self, msg_t *msg, int error);
581 
582 /* ---------------------------------------------------------------------- */
583 /* Compressor plugin */
584 extern tport_comp_vtable_t const *tport_comp_vtable;
585 
586 char const *tport_canonize_comp(char const *comp);
587 
588 int tport_init_compressor(tport_t *,
589  char const *comp_name,
590  tagi_t const *tags);
591 void tport_deinit_compressor(tport_t *);
592 
593 struct sigcomp_compartment *
594 tport_sigcomp_assign_if_needed(tport_t *self,
595  struct sigcomp_compartment *cc);
596 
597 struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
598 
599 void tport_sigcomp_accept_incomplete(tport_t *self, msg_t *msg);
600 
601 int tport_recv_comp_dgram(tport_t const *self,
602  tport_compressor_t *sc,
603  msg_t **in_out_msg,
604  su_sockaddr_t *from,
605  socklen_t fromlen);
606 
607 ssize_t tport_send_comp(tport_t const *self,
608  msg_t *msg,
609  msg_iovec_t iov[],
610  size_t iovused,
611  struct sigcomp_compartment *cc,
612  tport_compressor_t *sc);
613 
614 SOFIA_END_DECLS
615 
616 #endif /* TPORT_INTERNAL_H */
Transport name.
Definition: tport.h:156
Interface towards stack.
Definition: tport.h:93
int su_socket_t
struct addrinfo su_addrinfo_t
SU_HOME_T su_home_t
#define su_inline
SU_U64_T uint64_t
struct su_root_t su_root_t
SU_ROOT_MAGIC_T su_root_magic_t
struct pollfd su_wait_t
struct su_timer_s su_timer_t
Transport interface.
TP_STACK_T tp_stack_t
Type of stack object.
Definition: tport.h:71
TP_MAGIC_T tp_magic_t
Type of transport-protocol-specific context object.
Definition: tport.h:78
Transport plugin interface.
TPORT_STUN_SERVER_T tport_stun_server_t
Safe type for tport server object.
Definition: tport_plugins.h:43
tport_via
Define how the public transport connects to Internet.
Definition: tport_tag.h:81

Sofia-SIP 1.13.16 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.