00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025 #ifndef TPORT_INTERNAL_H
00026
00027 #define TPORT_INTERNAL_H
00028
00037 #ifndef SU_H
00038 #include <sofia-sip/su.h>
00039 #endif
00040
00041 #include <sofia-sip/su_uniqueid.h>
00042
00043 #ifndef MSG_ADDR_H
00044 #include <sofia-sip/msg_addr.h>
00045 #endif
00046 #ifndef TPORT_H
00047 #include <sofia-sip/tport.h>
00048 #endif
00049
00050 #if HAVE_SOFIA_STUN
00051 #include "sofia-sip/stun.h"
00052 #include "sofia-sip/stun_tag.h"
00053 #endif
00054
00055 #include <sofia-sip/tport_plugins.h>
00056
00057 #ifndef SU_DEBUG
00058 #define SU_DEBUG 3
00059 #endif
00060 #define SU_LOG tport_log
00061
00062 #include <sofia-sip/su_debug.h>
00063
00064 #if !defined(MSG_NOSIGNAL) || defined(__CYGWIN__)
00065 #undef MSG_NOSIGNAL
00066 #define MSG_NOSIGNAL (0)
00067 #endif
00068
00069 #if !HAVE_MSG_TRUNC
00070 #define MSG_TRUNC (0)
00071 #endif
00072
00073 #ifndef NONE
00074 #define NONE ((void *)-1)
00075 #endif
00076
00077 SOFIA_BEGIN_DECLS
00078
00079 typedef struct tport_master tport_master_t;
00080 typedef struct tport_pending_s tport_pending_t;
00081 typedef struct tport_primary tport_primary_t;
00082 typedef struct tport_vtable tport_vtable_t;
00083
00084 struct sigcomp_state_handler;
00085 struct sigcomp_algorithm;
00086 struct sigcomp_udvm;
00087 struct sigcomp_magic;
00088 struct sigcomp_compartment;
00089
00090 typedef long unsigned LU;
00091
00093 typedef struct {
00094 unsigned tpp_mtu;
00095 unsigned tpp_idle;
00096 unsigned tpp_timeout;
00097 unsigned tpp_sigcomp_lifetime;
00098 unsigned tpp_thrpsize;
00100 unsigned tpp_thrprqsize;
00101 unsigned tpp_qsize;
00103 unsigned tpp_drop;
00105 unsigned tpp_conn_orient:1;
00106 unsigned tpp_sdwn_error:1;
00107 unsigned tpp_stun_server:1;
00109 unsigned :0;
00110
00111 } tport_params_t;
00112
00113
00121 struct tport_s {
00122 su_home_t tp_home[1];
00124 int tp_refs;
00126 unsigned tp_black:1;
00128 unsigned tp_accepted:1;
00129 unsigned tp_conn_orient:1;
00130 unsigned tp_connected : 1;
00131 unsigned tp_reusable:1;
00132 unsigned tp_closed : 1;
00134 unsigned tp_recv_close:2;
00136 unsigned tp_send_close:2;
00137 unsigned tp_has_keepalive:1;
00138 unsigned tp_has_stun_server:1;
00139 unsigned tp_trunc:1;
00140 unsigned:0;
00141
00142 tport_t *tp_left, *tp_right, *tp_dad;
00144 tport_master_t *tp_master;
00145 tport_primary_t *tp_pri;
00147 tport_params_t *tp_params;
00149 tp_magic_t *tp_magic;
00151 msg_t const *tp_rlogged;
00152 msg_t const *tp_slogged;
00154 unsigned tp_time;
00156 tp_name_t tp_name[1];
00162 #define tp_protoname tp_name->tpn_proto
00163 #define tp_canon tp_name->tpn_canon
00164 #define tp_host tp_name->tpn_host
00165 #define tp_port tp_name->tpn_port
00166 #define tp_ident tp_name->tpn_ident
00167
00168 su_socket_t tp_socket;
00169 int tp_index;
00170 int tp_events;
00172 su_addrinfo_t tp_addrinfo[1];
00173 su_sockaddr_t tp_addr[1];
00174 #define tp_addrlen tp_addrinfo->ai_addrlen
00175
00176
00177
00178 msg_t *tp_msg;
00180
00181
00182 tport_pending_t *tp_pending;
00183 tport_pending_t *tp_released;
00184 unsigned tp_plen;
00185 unsigned tp_pused;
00186 unsigned tp_reported;
00188
00189
00190 msg_t **tp_queue;
00191 unsigned short tp_qhead;
00193 msg_iovec_t *tp_unsent;
00194 unsigned tp_unsentlen;
00196 msg_iovec_t *tp_iov;
00197 unsigned tp_iovlen;
00199
00200
00201 tport_compressor_t *tp_comp;
00202
00203
00204
00205 struct {
00206 uint64_t sent_bytes, sent_on_line, recv_bytes, recv_on_line;
00207 uint64_t sent_msgs, recv_msgs;
00208 } tp_stats;
00209 };
00210
00212 struct tport_primary {
00213 tport_t pri_primary[1];
00214 #if DOX
00215 su_home_t pri_home[1];
00216 #else
00217 #define pri_home pri_primary->tp_home
00218 #define pri_master pri_primary->tp_master
00219 #define pri_protoname pri_primary->tp_name->tpn_proto
00220 #endif
00221 tport_vtable_t const
00222 *pri_vtable;
00223 int pri_public;
00228 char pri_ident[16];
00229 tport_primary_t *pri_next;
00231 tport_t *pri_secondary;
00233 unsigned pri_updating:1;
00234 unsigned pri_natted:1;
00235 unsigned pri_has_tls:1;
00236 unsigned:0;
00237
00238 void *pri_stun_handle;
00239
00240 tport_params_t pri_params[1];
00242 };
00243
00245 struct tport_master {
00246 tport_t mr_master[1];
00247 #if DOX
00248 su_home_t mr_home[1];
00249 #else
00250 #define mr_home mr_master->tp_home
00251 #endif
00252
00253 int mr_stun_step_ready;
00255 tp_stack_t *mr_stack;
00256 tp_stack_class_t
00257 const *mr_tpac;
00258 int mr_log;
00259 su_root_t *mr_root;
00262 su_timer_t *mr_timer;
00264 FILE *mr_dump_file;
00265
00266 tport_primary_t *mr_primaries;
00268 tport_params_t mr_params[1];
00269
00270 unsigned mr_boundserver:1;
00271 unsigned mr_bindv6only:1;
00272 unsigned :0;
00273
00274
00275 struct tport_delivery {
00276 tport_t *d_tport;
00277 msg_t *d_msg;
00278 tp_name_t d_from[1];
00279 tport_compressor_t *d_comp;
00280 } mr_delivery[1];
00281
00282 tport_stun_server_t *mr_stun_server;
00283
00284 #if 0
00285 struct tport_nat_s {
00286 int initialized;
00287 int bound;
00288 int stun_enabled;
00289 char *external_ip_address;
00290 #if HAVE_UPNP || HAVE_SOFIA_STUN
00291 int try_stun;
00292 #endif
00293 #if HAVE_UPNP
00294 #endif
00295 #if HAVE_SOFIA_STUN
00296 tport_master_t *tport;
00297 char *stun_server;
00298
00299 stun_handle_t *stun;
00300 su_socket_t stun_socket;
00301 su_sockaddr_t sockaddr;
00302 #endif
00303 } mr_nat[1];
00304 #endif
00305 };
00306
00308 struct tport_vtable
00309 {
00310 char const *vtp_name;
00311 enum tport_via vtp_public;
00312
00313 int vtp_pri_size;
00314 int (*vtp_init_primary)(tport_primary_t *pri,
00315 tp_name_t tpn[1],
00316 su_addrinfo_t *ai, tagi_t const *,
00317 char const **return_culprit);
00318 void (*vtp_deinit_primary)(tport_primary_t *pri);
00319 int (*vtp_wakeup_pri)(tport_primary_t *pri, int events);
00320 tport_t *(*vtp_connect)(tport_primary_t *pri, su_addrinfo_t *ai,
00321 tp_name_t const *tpn);
00322
00323 int vtp_secondary_size;
00324
00325 int (*vtp_init_secondary)(tport_t *, int socket, int accepted,
00326 char const **return_reason);
00327 void (*vtp_deinit_secondary)(tport_t *);
00328 void (*vtp_shutdown)(tport_t *, int how);
00329 int (*vtp_set_events)(tport_t const *self);
00330 int (*vtp_wakeup)(tport_t *self, int events);
00331 int (*vtp_recv)(tport_t *self);
00332 int (*vtp_send)(tport_t const *self, msg_t *msg,
00333 msg_iovec_t iov[], int iovused);
00334 void (*vtp_deliver)(tport_t *self, msg_t *msg, su_time_t now);
00335 int (*vtp_prepare)(tport_t *self, msg_t *msg,
00336 tp_name_t const *tpn,
00337 struct sigcomp_compartment *cc,
00338 unsigned mtu);
00339 int (*vtp_keepalive)(tport_t *self, su_addrinfo_t const *ai,
00340 tagi_t const *taglist);
00341 int (*vtp_stun_response)(tport_t const *self,
00342 void *msg, size_t msglen,
00343 void *addr, socklen_t addrlen);
00344 };
00345
00346 int tport_register_type(tport_vtable_t const *vtp);
00347
00349 static inline int tport_is_connection_oriented(tport_t const *self)
00350 {
00351 return self->tp_conn_orient;
00352 }
00353
00355 static inline int tport_is_connected(tport_t const *self)
00356 {
00357 return self->tp_connected;
00358 }
00359
00360 void tport_has_been_updated(tport_t *tport);
00361
00362 int tport_primary_compression(tport_primary_t *pri,
00363 char const *compression,
00364 tagi_t const *tl);
00365
00366 tport_t *tport_base_connect(tport_primary_t *pri,
00367 su_addrinfo_t *ai,
00368 su_addrinfo_t *name,
00369 tp_name_t const *tpn);
00370
00371 int tport_stream_init_primary(tport_primary_t *pri,
00372 su_socket_t socket,
00373 tp_name_t tpn[1],
00374 su_addrinfo_t *ai,
00375 tagi_t const *tags,
00376 char const **return_reason);
00377
00378 tport_t *tport_alloc_secondary(tport_primary_t *pri,
00379 int socket,
00380 int accepted,
00381 char const **return_reason);
00382
00383 int tport_accept(tport_primary_t *pri, int events);
00384 void tport_zap_secondary(tport_t *self);
00385
00386 int tport_bind_socket(int socket,
00387 su_addrinfo_t *ai,
00388 char const **return_culprit);
00389 void tport_close(tport_t *self);
00390
00391
00392 int tport_error_event(tport_t *self);
00393 void tport_recv_event(tport_t *self);
00394 void tport_send_event(tport_t *self);
00395 void tport_hup_event(tport_t *self);
00396
00397 int tport_recv_iovec(tport_t const *self,
00398 msg_t **mmsg,
00399 msg_iovec_t iovec[msg_n_fragments], int N,
00400 int exact);
00401
00402 msg_t *tport_msg_alloc(tport_t const *self, unsigned size);
00403
00404 int tport_prepare_and_send(tport_t *self, msg_t *msg,
00405 tp_name_t const *tpn,
00406 struct sigcomp_compartment *cc,
00407 unsigned mtu);
00408 int tport_send_msg(tport_t *self, msg_t *msg,
00409 tp_name_t const *tpn,
00410 struct sigcomp_compartment *cc);
00411
00412 void tport_deliver(tport_t *self, msg_t *msg, msg_t *next,
00413 tport_compressor_t *comp,
00414 su_time_t now);
00415 void tport_base_deliver(tport_t *self, msg_t *msg, su_time_t now);
00416
00417 int tport_recv_error_report(tport_t *self);
00418 void tport_error_report(tport_t *self, int errcode,
00419 su_sockaddr_t const *addr);
00420
00421 void tport_open_log(tport_master_t *mr, tagi_t *tags);
00422 void tport_log_msg(tport_t *tp, msg_t *msg, char const *what,
00423 char const *via, char const *indent, su_time_t now);
00424 void tport_dump_iovec(tport_t const *self, msg_t *msg,
00425 int n, su_iovec_t const iov[], int iovused,
00426 char const *what, char const *how);
00427
00428 extern tport_vtable_t const tport_udp_vtable;
00429 extern tport_vtable_t const tport_udp_client_vtable;
00430
00431 int tport_udp_init_primary(tport_primary_t *,
00432 tp_name_t tpn[1],
00433 su_addrinfo_t *,
00434 tagi_t const *,
00435 char const **return_culprit);
00436 void tport_udp_deinit_primary(tport_primary_t *);
00437 int tport_recv_dgram(tport_t *self);
00438 int tport_send_dgram(tport_t const *self, msg_t *msg,
00439 msg_iovec_t iov[], int iovused);
00440 int tport_udp_error(tport_t const *self, su_sockaddr_t name[1]);
00441
00442 extern tport_vtable_t const tport_tcp_vtable;
00443 extern tport_vtable_t const tport_tcp_client_vtable;
00444
00445 int tport_tcp_init_primary(tport_primary_t *,
00446 tp_name_t tpn[1],
00447 su_addrinfo_t *, tagi_t const *,
00448 char const **return_culprit);
00449 int tport_tcp_init_client(tport_primary_t *,
00450 tp_name_t tpn[1],
00451 su_addrinfo_t *, tagi_t const *,
00452 char const **return_culprit);
00453 int tport_tcp_init_secondary(tport_t *self, int socket, int accepted,
00454 char const **return_reason);
00455 int tport_recv_stream(tport_t *self);
00456 int tport_send_stream(tport_t const *self, msg_t *msg,
00457 msg_iovec_t iov[], int iovused);
00458
00459 extern tport_vtable_t const tport_sctp_vtable;
00460 extern tport_vtable_t const tport_sctp_client_vtable;
00461 extern tport_vtable_t const tport_tls_vtable;
00462 extern tport_vtable_t const tport_tls_client_vtable;
00463 extern tport_vtable_t const tport_stun_vtable;
00464 extern tport_vtable_t const tport_http_connect_vtable;
00465 extern tport_vtable_t const tport_threadpool_vtable;
00466
00467 typedef struct tport_descriptor_s {
00468 char const *tpd_name;
00469 tport_vtable_t *tpd_vtable;
00470 su_addrinfo_t *tpd_hints;
00471 int tpd_is_client_only;
00472 } tport_descriptor_t;
00473
00474 typedef int const *(tport_set_f)(tport_master_t *mr,
00475 tp_name_t const *tpn,
00476 tagi_t const *taglist,
00477 tport_descriptor_t **return_set,
00478 int return_set_size);
00479
00480
00481
00482 int tport_init_stun_server(tport_master_t *mr, tagi_t const *tags);
00483 void tport_deinit_stun_server(tport_master_t *mr);
00484 int tport_recv_stun_dgram(tport_t const *self, msg_t **in_out_msg,
00485 su_sockaddr_t *from, socklen_t fromlen);
00486
00487 int tport_stun_server_add_socket(tport_t *tp);
00488 int tport_stun_server_remove_socket(tport_t *tp);
00489
00490
00491
00492 extern tport_comp_vtable_t const *tport_comp_vtable;
00493
00494 char const *tport_canonize_comp(char const *comp);
00495
00496 int tport_init_compressor(tport_t *,
00497 char const *comp_name,
00498 tagi_t const *tags);
00499 void tport_deinit_compressor(tport_t *);
00500
00501 struct sigcomp_compartment *
00502 tport_sigcomp_assign_if_needed(tport_t *self,
00503 struct sigcomp_compartment *cc);
00504
00505 struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
00506
00507 void tport_sigcomp_accept_incomplete(tport_t *self, msg_t *msg);
00508
00509 int tport_recv_comp_dgram(tport_t const *self,
00510 tport_compressor_t *sc,
00511 msg_t **in_out_msg,
00512 su_sockaddr_t *from,
00513 socklen_t fromlen);
00514
00515 int tport_send_comp(tport_t const *self,
00516 msg_t *msg,
00517 msg_iovec_t iov[],
00518 int iovused,
00519 struct sigcomp_compartment *cc,
00520 tport_compressor_t *sc);
00521
00522 SOFIA_END_DECLS
00523
00524 #endif