tport 1.12.11devel
/tmp/buildd/sofia-sip-1.12.11+20110422/libsofia-sip-ua/tport/tport_internal.h
00001 /*
00002  * This file is part of the Sofia-SIP package
00003  *
00004  * Copyright (C) 2005 Nokia Corporation.
00005  *
00006  * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
00007  *
00008  * This library is free software; you can redistribute it and/or
00009  * modify it under the terms of the GNU Lesser General Public License
00010  * as published by the Free Software Foundation; either version 2.1 of
00011  * the License, or (at your option) any later version.
00012  *
00013  * This library is distributed in the hope that it will be useful, but
00014  * WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00016  * Lesser General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU Lesser General Public
00019  * License along with this library; if not, write to the Free Software
00020  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
00021  * 02110-1301 USA
00022  *
00023  */
00024 
00025 #ifndef TPORT_INTERNAL_H
00026 
00027 #define TPORT_INTERNAL_H
00028 
00038 #ifndef SU_H
00039 #include <sofia-sip/su.h>
00040 #endif
00041 
00042 #include <sofia-sip/su_uniqueid.h>
00043 #include <sofia-sip/su_strlst.h>
00044 
00045 #ifndef MSG_ADDR_H
00046 #include <sofia-sip/msg_addr.h>
00047 #endif
00048 #ifndef TPORT_H
00049 #include <sofia-sip/tport.h>
00050 #endif
00051 
00052 #if HAVE_SOFIA_STUN
00053 #include "sofia-sip/stun.h"
00054 #include "sofia-sip/stun_tag.h"
00055 #endif
00056 
00057 #include <sofia-sip/tport_plugins.h>
00058 
00059 #ifndef SU_DEBUG
00060 #define SU_DEBUG 3
00061 #endif
00062 #define SU_LOG   tport_log
00063 
00064 #include <sofia-sip/su_debug.h>
00065 
00066 #if !defined(MSG_NOSIGNAL) || defined(__CYGWIN__) || defined(SYMBIAN)
00067 #undef MSG_NOSIGNAL
00068 #define MSG_NOSIGNAL (0)
00069 #endif
00070 
00071 #if (_WIN32_WINNT >= 0x0600)
00072 #ifndef HAVE_MSG_TRUNC
00073 #define HAVE_MSG_TRUNC 1
00074 #endif
00075 #endif
00076 
00077 #if !HAVE_MSG_TRUNC
00078 #define MSG_TRUNC (0)
00079 #endif
00080 
00081 #ifndef NONE
00082 #define NONE ((void *)(intptr_t)-1)
00083 #endif
00084 
00085 SOFIA_BEGIN_DECLS
00086 
00087 typedef struct tport_master tport_master_t;
00088 typedef struct tport_pending_s tport_pending_t;
00089 typedef struct tport_primary tport_primary_t;
00090 typedef struct tport_vtable tport_vtable_t;
00091 
00092 struct sigcomp_state_handler;
00093 struct sigcomp_algorithm;
00094 struct sigcomp_udvm;
00095 struct sigcomp_magic;
00096 struct sigcomp_compartment;
00097 
00098 typedef long unsigned LU;       /* for printf() and friends */
00099 
00101 typedef struct {
00102   unsigned tpp_mtu;             
00103   unsigned tpp_idle;            
00104   unsigned tpp_timeout;         
00105   unsigned tpp_keepalive;       
00106   unsigned tpp_pingpong;        
00108   unsigned tpp_sigcomp_lifetime;  
00109   unsigned tpp_thrpsize;        
00111   unsigned tpp_thrprqsize;      
00112   unsigned tpp_qsize;           
00114   unsigned tpp_drop;            
00115   int      tpp_tos;             
00117   unsigned tpp_conn_orient:1;   
00118   unsigned tpp_sdwn_error:1;    
00119   unsigned tpp_stun_server:1;   
00120   unsigned tpp_pong2ping:1;     
00122   unsigned :0;
00123 
00124 } tport_params_t;
00125 
00126 
00134 struct tport_s {
00135   su_home_t           tp_home[1];       
00137   unsigned            tp_accepted:1;    
00138   unsigned            tp_conn_orient:1; 
00139   unsigned            tp_has_connection:1; 
00140   unsigned            tp_reusable:1;    
00141   unsigned            tp_closed : 1;
00148   unsigned            tp_recv_close:2;
00150   unsigned            tp_send_close:2;
00151   unsigned            tp_has_keepalive:1;
00152   unsigned            tp_has_stun_server:1;
00153   unsigned            tp_trunc:1;
00154   unsigned            tp_is_connected:1; 
00155   unsigned            tp_verified:1;     
00156   unsigned            tp_error_reported:1; 
00158   /* Red-black tree */
00159   unsigned            tp_black:1;       
00160   unsigned:0;
00161   tport_t *tp_left, *tp_right, *tp_dad; 
00163   tport_master_t     *tp_master;        
00164   tport_primary_t    *tp_pri;           
00166   tport_params_t     *tp_params;        
00168   tp_magic_t         *tp_magic;         
00170   su_timer_t         *tp_timer;         
00172   su_time_t           tp_ktime;         
00173   su_time_t           tp_ptime;         
00175   tp_name_t           tp_name[1];       
00181   su_strlst_t        *tp_subjects;      
00189 #define tp_protoname tp_name->tpn_proto
00190 #define tp_canon     tp_name->tpn_canon
00191 #define tp_host      tp_name->tpn_host
00192 #define tp_port      tp_name->tpn_port
00193 #define tp_ident     tp_name->tpn_ident
00194 
00195   su_socket_t         tp_socket;        
00196   int                 tp_index;         
00197   int                 tp_events;        
00199   su_addrinfo_t       tp_addrinfo[1];   
00200   su_sockaddr_t       tp_addr[1];       
00201 #define tp_addrlen tp_addrinfo->ai_addrlen
00202 
00203   /* ==== Receive queue ================================================== */
00204 
00205   msg_t              *tp_msg;           
00206   msg_t const        *tp_rlogged;       
00207   su_time_t           tp_rtime;         
00208   unsigned short      tp_ping;          
00210   /* ==== Pending messages =============================================== */
00211 
00212   unsigned short      tp_reported;      
00213   unsigned            tp_plen;          
00214   unsigned            tp_pused;         
00215   tport_pending_t    *tp_pending;       
00216   tport_pending_t    *tp_released;      
00218   /* ==== Send queue ===================================================== */
00219 
00220   msg_t             **tp_queue;         
00221   unsigned short      tp_qhead;         
00223   msg_iovec_t        *tp_unsent;        
00224   size_t              tp_unsentlen;     
00226   msg_iovec_t        *tp_iov;           
00227   size_t              tp_iovlen;        
00229   msg_t const        *tp_slogged;       
00230   su_time_t           tp_stime;         
00232   /* ==== Extensions  ===================================================== */
00233 
00234   tport_compressor_t *tp_comp;
00235 
00236   /* ==== Statistics  ===================================================== */
00237 
00238   struct {
00239     uint64_t sent_msgs, sent_errors, sent_bytes, sent_on_line;
00240     uint64_t recv_msgs, recv_errors, recv_bytes, recv_on_line;
00241   } tp_stats;
00242 };
00243 
00245 struct tport_primary {
00246   tport_t             pri_primary[1];   
00247 #if DOXYGEN_ONLY
00248   su_home_t           pri_home[1];
00249 #else
00250 #define pri_home      pri_primary->tp_home
00251 #define pri_master    pri_primary->tp_master
00252 #define pri_protoname pri_primary->tp_name->tpn_proto
00253 #endif
00254   tport_vtable_t const
00255                      *pri_vtable;
00256   int                 pri_public;       
00261   tport_primary_t    *pri_next;         
00263   tport_t            *pri_open;         
00264   tport_t            *pri_closed;       
00266   unsigned            pri_updating:1;   
00267   unsigned            pri_natted:1;     
00268   unsigned            pri_has_tls:1;    
00269   unsigned:0;
00270 
00271   void               *pri_stun_handle;
00272 
00273   tport_params_t      pri_params[1];      
00274 };
00275 
00277 struct tport_master {
00278   tport_t             mr_master[1];
00279 #if DOXYGEN_ONLY
00280   su_home_t           mr_home[1];
00281 #else
00282 #define mr_home mr_master->tp_home
00283 #endif
00284 
00285   int                 mr_stun_step_ready; 
00287   tp_stack_t         *mr_stack;         
00288   tp_stack_class_t
00289                const *mr_tpac;          
00290   int                 mr_log;           
00291   su_root_t          *mr_root;          
00294   su_timer_t         *mr_timer;
00296   FILE               *mr_dump_file;
00297   char               *mr_dump;  
00298   tport_primary_t    *mr_primaries;        
00300   tport_params_t      mr_params[1];
00301 
00302   unsigned            mr_boundserver:1; 
00303   unsigned            mr_bindv6only:1; 
00304   unsigned :0;
00305 
00306   /* Delivery context */
00307   struct tport_delivery {
00308     tport_t              *d_tport;
00309     msg_t                *d_msg;
00310     tp_name_t             d_from[1];
00311     tport_compressor_t   *d_comp;
00312   } mr_delivery[1];
00313 
00314   tport_stun_server_t *mr_stun_server;
00315 
00316 #if 0
00317   struct tport_nat_s {
00318     int initialized;
00319     int bound;
00320     int stun_enabled;
00321     char *external_ip_address;
00322 #if HAVE_UPNP || HAVE_SOFIA_STUN
00323     int try_stun;
00324 #endif
00325 #if HAVE_UPNP
00326 #endif
00327 #if HAVE_SOFIA_STUN
00328     tport_master_t *tport;
00329     char *stun_server;
00330     /* stun_socket_t *stun_socket; */
00331     stun_handle_t *stun;
00332     su_socket_t stun_socket;
00333     su_sockaddr_t sockaddr;
00334 #endif
00335   }                   mr_nat[1];
00336 #endif
00337 };
00338 
00340 struct tport_vtable
00341 {
00342   char const *vtp_name;
00343   enum tport_via vtp_public;
00344 
00345   size_t vtp_pri_size;          /* Size of primary tport */
00346   int (*vtp_init_primary)(tport_primary_t *pri,
00347                           tp_name_t tpn[1],
00348                           su_addrinfo_t *ai, tagi_t const *,
00349                           char const **return_culprit);
00350   void (*vtp_deinit_primary)(tport_primary_t *pri);
00351   int (*vtp_wakeup_pri)(tport_primary_t *pri, int events);
00352   tport_t *(*vtp_connect)(tport_primary_t *pri, su_addrinfo_t *ai,
00353                           tp_name_t const *tpn);
00354 
00355   size_t vtp_secondary_size;    /* Size of secondary tport */
00356 
00357   int (*vtp_init_secondary)(tport_t *, int socket, int accepted,
00358                             char const **return_reason);
00359   void (*vtp_deinit_secondary)(tport_t *);
00360   void (*vtp_shutdown)(tport_t *, int how);
00361   int (*vtp_set_events)(tport_t const *self);
00362   int (*vtp_wakeup)(tport_t *self, int events);
00363   int (*vtp_recv)(tport_t *self);
00364   ssize_t (*vtp_send)(tport_t const *self, msg_t *msg,
00365                       msg_iovec_t iov[], size_t iovused);
00366   void (*vtp_deliver)(tport_t *self,  msg_t *msg, su_time_t now);
00367   int (*vtp_prepare)(tport_t *self, msg_t *msg,
00368                      tp_name_t const *tpn,
00369                      struct sigcomp_compartment *cc,
00370                      unsigned mtu);
00371   int (*vtp_keepalive)(tport_t *self, su_addrinfo_t const *ai,
00372                        tagi_t const *taglist);
00373   int (*vtp_stun_response)(tport_t const *self,
00374                            void *msg, size_t msglen,
00375                            void *addr, socklen_t addrlen);
00376   int (*vtp_next_secondary_timer)(tport_t *self, su_time_t *,
00377                                   char const **return_why);
00378   void (*vtp_secondary_timer)(tport_t *self, su_time_t);
00379 };
00380 
00381 int tport_register_type(tport_vtable_t const *vtp);
00382 
00384 su_inline int tport_is_connection_oriented(tport_t const *self)
00385 {
00386   return self->tp_conn_orient;
00387 }
00388 
00390 su_inline int tport_has_connection(tport_t const *self)
00391 {
00392   return self->tp_has_connection;
00393 }
00394 
00395 void tport_has_been_updated(tport_t *tport);
00396 
00397 int tport_primary_compression(tport_primary_t *pri,
00398                               char const *compression,
00399                               tagi_t const *tl);
00400 
00401 void tport_set_tos(su_socket_t socket, su_addrinfo_t *ai, int tos);
00402 
00403 tport_t *tport_base_connect(tport_primary_t *pri,
00404                             su_addrinfo_t *ai,
00405                             su_addrinfo_t *name,
00406                             tp_name_t const *tpn);
00407 
00408 int tport_stream_init_primary(tport_primary_t *pri,
00409                               su_socket_t socket,
00410                               tp_name_t tpn[1],
00411                               su_addrinfo_t *ai,
00412                               tagi_t const *tags,
00413                               char const **return_reason);
00414 
00415 tport_t *tport_alloc_secondary(tport_primary_t *pri,
00416                                int socket,
00417                                int accepted,
00418                                char const **return_reason);
00419 
00420 int tport_accept(tport_primary_t *pri, int events);
00421 int tport_register_secondary(tport_t *self, su_wakeup_f wakeup, int events);
00422 void tport_zap_secondary(tport_t *self);
00423 
00424 int tport_set_secondary_timer(tport_t *self);
00425 void tport_base_timer(tport_t *self, su_time_t now);
00426 
00427 int tport_bind_socket(int socket,
00428                       su_addrinfo_t *ai,
00429                       char const **return_culprit);
00430 void tport_close(tport_t *self);
00431 int tport_shutdown0(tport_t *self, int how);
00432 
00433 int tport_has_queued(tport_t const *self);
00434 
00435 int tport_error_event(tport_t *self);
00436 void tport_recv_event(tport_t *self);
00437 void tport_send_event(tport_t *self);
00438 void tport_hup_event(tport_t *self);
00439 int tport_setname(tport_t *, char const *, su_addrinfo_t const *, char const *);
00440 
00441 int tport_wakeup(su_root_magic_t *magic, su_wait_t *w, tport_t *self);
00442 
00443 ssize_t tport_recv_iovec(tport_t const *self,
00444                          msg_t **mmsg,
00445                          msg_iovec_t iovec[msg_n_fragments], size_t N,
00446                          int exact);
00447 
00448 msg_t *tport_msg_alloc(tport_t const *self, usize_t size);
00449 
00450 int tport_prepare_and_send(tport_t *self, msg_t *msg,
00451                            tp_name_t const *tpn,
00452                            struct sigcomp_compartment *cc,
00453                            unsigned mtu);
00454 int tport_send_msg(tport_t *self, msg_t *msg,
00455                    tp_name_t const *tpn,
00456                    struct sigcomp_compartment *cc);
00457 
00458 void tport_send_queue(tport_t *self);
00459 
00460 void tport_deliver(tport_t *self, msg_t *msg, msg_t *next,
00461                    tport_compressor_t *comp,
00462                    su_time_t now);
00463 void tport_base_deliver(tport_t *self, msg_t *msg, su_time_t now);
00464 
00465 int tport_recv_error_report(tport_t *self);
00466 void tport_error_report(tport_t *self, int errcode,
00467                         su_sockaddr_t const *addr);
00468 
00469 int tport_open_log(tport_master_t *mr, tagi_t *tags);
00470 void tport_log_msg(tport_t *tp, msg_t *msg, char const *what,
00471                    char const *via, su_time_t now);
00472 void tport_dump_iovec(tport_t const *self, msg_t *msg,
00473                       size_t n, su_iovec_t const iov[], size_t iovused,
00474                       char const *what, char const *how);
00475 
00476 int tport_tcp_ping(tport_t *self, su_time_t now);
00477 int tport_tcp_pong(tport_t *self);
00478 
00479 extern tport_vtable_t const tport_udp_vtable;
00480 extern tport_vtable_t const tport_udp_client_vtable;
00481 
00482 int tport_udp_init_primary(tport_primary_t *,
00483                            tp_name_t tpn[1],
00484                            su_addrinfo_t *,
00485                            tagi_t const *,
00486                            char const **return_culprit);
00487 void tport_udp_deinit_primary(tport_primary_t *);
00488 int tport_recv_dgram(tport_t *self);
00489 ssize_t tport_send_dgram(tport_t const *self, msg_t *msg,
00490                          msg_iovec_t iov[], size_t iovused);
00491 int tport_udp_error(tport_t const *self, su_sockaddr_t name[1]);
00492 
00493 extern tport_vtable_t const tport_tcp_vtable;
00494 extern tport_vtable_t const tport_tcp_client_vtable;
00495 
00496 int tport_tcp_init_primary(tport_primary_t *,
00497                           tp_name_t  tpn[1],
00498                           su_addrinfo_t *, tagi_t const *,
00499                           char const **return_culprit);
00500 int tport_tcp_init_client(tport_primary_t *,
00501                          tp_name_t tpn[1],
00502                          su_addrinfo_t *, tagi_t const *,
00503                          char const **return_culprit);
00504 int tport_tcp_init_secondary(tport_t *self, int socket, int accepted,
00505                              char const **return_reason);
00506 int tport_recv_stream(tport_t *self);
00507 ssize_t tport_send_stream(tport_t const *self, msg_t *msg,
00508                           msg_iovec_t iov[], size_t iovused);
00509 
00510 int tport_tcp_next_timer(tport_t *self, su_time_t *, char const **);
00511 void tport_tcp_timer(tport_t *self, su_time_t);
00512 
00513 int tport_next_recv_timeout(tport_t *, su_time_t *, char const **);
00514 void tport_recv_timeout_timer(tport_t *self, su_time_t now);
00515 
00516 int tport_next_keepalive(tport_t *self, su_time_t *, char const **);
00517 void tport_keepalive_timer(tport_t *self, su_time_t now);
00518 
00519 extern tport_vtable_t const tport_sctp_vtable;
00520 extern tport_vtable_t const tport_sctp_client_vtable;
00521 extern tport_vtable_t const tport_tls_vtable;
00522 extern tport_vtable_t const tport_tls_client_vtable;
00523 extern tport_vtable_t const tport_stun_vtable;
00524 extern tport_vtable_t const tport_http_connect_vtable;
00525 extern tport_vtable_t const tport_threadpool_vtable;
00526 
00527 typedef struct tport_descriptor_s {
00528   char const *tpd_name;
00529   tport_vtable_t *tpd_vtable;
00530   su_addrinfo_t *tpd_hints;
00531   int tpd_is_client_only;
00532 } tport_descriptor_t;
00533 
00534 typedef int const *(tport_set_f)(tport_master_t *mr,
00535                                  tp_name_t const *tpn,
00536                                  tagi_t const *taglist,
00537                                  tport_descriptor_t **return_set,
00538                                  int return_set_size);
00539 
00540 /* STUN plugin */
00541 
00542 int tport_init_stun_server(tport_master_t *mr, tagi_t const *tags);
00543 void tport_deinit_stun_server(tport_master_t *mr);
00544 int tport_recv_stun_dgram(tport_t const *self, msg_t **in_out_msg,
00545                           su_sockaddr_t *from, socklen_t fromlen);
00546 
00547 int tport_stun_server_add_socket(tport_t *tp);
00548 int tport_stun_server_remove_socket(tport_t *tp);
00549 
00550 void tport_recv_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
00551 void tport_recv_message(tport_t *self, msg_t *msg, int error);
00552 
00553 void tport_sent_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
00554 void tport_sent_message(tport_t *self, msg_t *msg, int error);
00555 
00556 /* ---------------------------------------------------------------------- */
00557 /* Compressor plugin */
00558 extern tport_comp_vtable_t const *tport_comp_vtable;
00559 
00560 char const *tport_canonize_comp(char const *comp);
00561 
00562 int tport_init_compressor(tport_t *,
00563                           char const *comp_name,
00564                           tagi_t const *tags);
00565 void tport_deinit_compressor(tport_t *);
00566 
00567 struct sigcomp_compartment *
00568 tport_sigcomp_assign_if_needed(tport_t *self,
00569                                struct sigcomp_compartment *cc);
00570 
00571 struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
00572 
00573 void tport_sigcomp_accept_incomplete(tport_t *self, msg_t *msg);
00574 
00575 int tport_recv_comp_dgram(tport_t const *self,
00576                           tport_compressor_t *sc,
00577                           msg_t **in_out_msg,
00578                           su_sockaddr_t *from,
00579                           socklen_t fromlen);
00580 
00581 ssize_t tport_send_comp(tport_t const *self,
00582                     msg_t *msg,
00583                     msg_iovec_t iov[],
00584                     size_t iovused,
00585                     struct sigcomp_compartment *cc,
00586                     tport_compressor_t *sc);
00587 
00588 SOFIA_END_DECLS
00589 
00590 #endif /* TPORT_INTERNAL_H */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

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