tport 1.12.10

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 
00044 #ifndef MSG_ADDR_H
00045 #include <sofia-sip/msg_addr.h>
00046 #endif
00047 #ifndef TPORT_H
00048 #include <sofia-sip/tport.h>
00049 #endif
00050 
00051 #if HAVE_SOFIA_STUN
00052 #include "sofia-sip/stun.h"
00053 #include "sofia-sip/stun_tag.h"
00054 #endif
00055 
00056 #include <sofia-sip/tport_plugins.h>
00057 
00058 #ifndef SU_DEBUG
00059 #define SU_DEBUG 3
00060 #endif
00061 #define SU_LOG   tport_log
00062 
00063 #include <sofia-sip/su_debug.h>
00064 
00065 #if !defined(MSG_NOSIGNAL) || defined(__CYGWIN__) || defined(SYMBIAN)
00066 #undef MSG_NOSIGNAL
00067 #define MSG_NOSIGNAL (0)
00068 #endif
00069 
00070 #if (_WIN32_WINNT >= 0x0600)
00071 #ifndef HAVE_MSG_TRUNC
00072 #define HAVE_MSG_TRUNC 1
00073 #endif
00074 #endif
00075 
00076 #if !HAVE_MSG_TRUNC
00077 #define MSG_TRUNC (0)
00078 #endif
00079 
00080 #ifndef NONE
00081 #define NONE ((void *)-1)
00082 #endif
00083 
00084 SOFIA_BEGIN_DECLS
00085 
00086 typedef struct tport_master tport_master_t;
00087 typedef struct tport_pending_s tport_pending_t;
00088 typedef struct tport_primary tport_primary_t;
00089 typedef struct tport_vtable tport_vtable_t;
00090 
00091 struct sigcomp_state_handler;
00092 struct sigcomp_algorithm;
00093 struct sigcomp_udvm;
00094 struct sigcomp_magic;
00095 struct sigcomp_compartment;
00096 
00097 typedef long unsigned LU;       /* for printf() and friends */
00098 
00100 typedef struct {
00101   unsigned tpp_mtu;             
00102   unsigned tpp_idle;            
00103   unsigned tpp_timeout;         
00104   unsigned tpp_keepalive;       
00105   unsigned tpp_pingpong;        
00107   unsigned tpp_sigcomp_lifetime;  
00108   unsigned tpp_thrpsize;        
00110   unsigned tpp_thrprqsize;      
00111   unsigned tpp_qsize;           
00113   unsigned tpp_drop;            
00114   int      tpp_tos;             
00116   unsigned tpp_conn_orient:1;   
00117   unsigned tpp_sdwn_error:1;    
00118   unsigned tpp_stun_server:1;   
00119   unsigned tpp_pong2ping:1;     
00121   unsigned :0;
00122 
00123 } tport_params_t;
00124 
00125 
00133 struct tport_s {
00134   su_home_t           tp_home[1];       
00136   ssize_t             tp_refs;          
00138   unsigned            tp_black:1;       
00140   unsigned            tp_accepted:1;    
00141   unsigned            tp_conn_orient:1; 
00142   unsigned            tp_has_connection:1; 
00143   unsigned            tp_reusable:1;    
00144   unsigned            tp_closed : 1;
00151   unsigned            tp_recv_close:2;
00153   unsigned            tp_send_close:2;
00154   unsigned            tp_has_keepalive:1;
00155   unsigned            tp_has_stun_server:1;
00156   unsigned            tp_trunc:1;
00157   unsigned            tp_is_connected:1; 
00158   unsigned:0;
00159 
00160   tport_t *tp_left, *tp_right, *tp_dad; 
00162   tport_master_t     *tp_master;        
00163   tport_primary_t    *tp_pri;           
00165   tport_params_t     *tp_params;        
00167   tp_magic_t         *tp_magic;         
00169   su_timer_t         *tp_timer;         
00171   su_time_t           tp_ktime;         
00172   su_time_t           tp_ptime;         
00174   tp_name_t           tp_name[1];       
00180 #define tp_protoname tp_name->tpn_proto
00181 #define tp_canon     tp_name->tpn_canon
00182 #define tp_host      tp_name->tpn_host
00183 #define tp_port      tp_name->tpn_port
00184 #define tp_ident     tp_name->tpn_ident
00185 
00186   su_socket_t         tp_socket;        
00187   int                 tp_index;         
00188   int                 tp_events;        
00190   su_addrinfo_t       tp_addrinfo[1];   
00191   su_sockaddr_t       tp_addr[1];       
00192 #define tp_addrlen tp_addrinfo->ai_addrlen
00193 
00194   /* ==== Receive queue ================================================== */
00195 
00196   msg_t              *tp_msg;           
00197   msg_t const        *tp_rlogged;       
00198   su_time_t           tp_rtime;         
00199   unsigned short      tp_ping;          
00201   /* ==== Pending messages =============================================== */
00202 
00203   unsigned short      tp_reported;      
00204   unsigned            tp_plen;          
00205   unsigned            tp_pused;         
00206   tport_pending_t    *tp_pending;       
00207   tport_pending_t    *tp_released;      
00209   /* ==== Send queue ===================================================== */
00210 
00211   msg_t             **tp_queue;         
00212   unsigned short      tp_qhead;         
00214   msg_iovec_t        *tp_unsent;        
00215   size_t              tp_unsentlen;     
00217   msg_iovec_t        *tp_iov;           
00218   size_t              tp_iovlen;        
00220   msg_t const        *tp_slogged;       
00221   su_time_t           tp_stime;         
00223   /* ==== Extensions  ===================================================== */
00224 
00225   tport_compressor_t *tp_comp;
00226 
00227   /* ==== Statistics  ===================================================== */
00228 
00229   struct {
00230     uint64_t sent_msgs, sent_errors, sent_bytes, sent_on_line;
00231     uint64_t recv_msgs, recv_errors, recv_bytes, recv_on_line;
00232   } tp_stats;
00233 };
00234 
00236 struct tport_primary {
00237   tport_t             pri_primary[1];   
00238 #if DOXYGEN_ONLY
00239   su_home_t           pri_home[1];
00240 #else
00241 #define pri_home      pri_primary->tp_home
00242 #define pri_master    pri_primary->tp_master
00243 #define pri_protoname pri_primary->tp_name->tpn_proto
00244 #endif
00245   tport_vtable_t const
00246                      *pri_vtable;
00247   int                 pri_public;       
00252   tport_primary_t    *pri_next;         
00254   tport_t            *pri_open;         
00255   tport_t            *pri_closed;       
00257   unsigned            pri_updating:1;   
00258   unsigned            pri_natted:1;     
00259   unsigned            pri_has_tls:1;    
00260   unsigned:0;
00261 
00262   void               *pri_stun_handle;
00263 
00264   tport_params_t      pri_params[1];      
00265 };
00266 
00268 struct tport_master {
00269   tport_t             mr_master[1];
00270 #if DOXYGEN_ONLY
00271   su_home_t           mr_home[1];
00272 #else
00273 #define mr_home mr_master->tp_home
00274 #endif
00275 
00276   int                 mr_stun_step_ready; 
00278   tp_stack_t         *mr_stack;         
00279   tp_stack_class_t
00280                const *mr_tpac;          
00281   int                 mr_log;           
00282   su_root_t          *mr_root;          
00285   su_timer_t         *mr_timer;
00287   FILE               *mr_dump_file;
00288   char               *mr_dump;  
00289   tport_primary_t    *mr_primaries;        
00291   tport_params_t      mr_params[1];
00292 
00293   unsigned            mr_boundserver:1; 
00294   unsigned            mr_bindv6only:1; 
00295   unsigned :0;
00296 
00297   /* Delivery context */
00298   struct tport_delivery {
00299     tport_t              *d_tport;
00300     msg_t                *d_msg;
00301     tp_name_t             d_from[1];
00302     tport_compressor_t   *d_comp;
00303   } mr_delivery[1];
00304 
00305   tport_stun_server_t *mr_stun_server;
00306 
00307 #if 0
00308   struct tport_nat_s {
00309     int initialized;
00310     int bound;
00311     int stun_enabled;
00312     char *external_ip_address;
00313 #if HAVE_UPNP || HAVE_SOFIA_STUN
00314     int try_stun;
00315 #endif
00316 #if HAVE_UPNP
00317 #endif
00318 #if HAVE_SOFIA_STUN
00319     tport_master_t *tport;
00320     char *stun_server;
00321     /* stun_socket_t *stun_socket; */
00322     stun_handle_t *stun;
00323     su_socket_t stun_socket;
00324     su_sockaddr_t sockaddr;
00325 #endif
00326   }                   mr_nat[1];
00327 #endif
00328 };
00329 
00331 struct tport_vtable
00332 {
00333   char const *vtp_name;
00334   enum tport_via vtp_public;
00335 
00336   size_t vtp_pri_size;          /* Size of primary tport */
00337   int (*vtp_init_primary)(tport_primary_t *pri,
00338                           tp_name_t tpn[1],
00339                           su_addrinfo_t *ai, tagi_t const *,
00340                           char const **return_culprit);
00341   void (*vtp_deinit_primary)(tport_primary_t *pri);
00342   int (*vtp_wakeup_pri)(tport_primary_t *pri, int events);
00343   tport_t *(*vtp_connect)(tport_primary_t *pri, su_addrinfo_t *ai,
00344                           tp_name_t const *tpn);
00345 
00346   size_t vtp_secondary_size;    /* Size of secondary tport */
00347 
00348   int (*vtp_init_secondary)(tport_t *, int socket, int accepted,
00349                             char const **return_reason);
00350   void (*vtp_deinit_secondary)(tport_t *);
00351   void (*vtp_shutdown)(tport_t *, int how);
00352   int (*vtp_set_events)(tport_t const *self);
00353   int (*vtp_wakeup)(tport_t *self, int events);
00354   int (*vtp_recv)(tport_t *self);
00355   ssize_t (*vtp_send)(tport_t const *self, msg_t *msg,
00356                       msg_iovec_t iov[], size_t iovused);
00357   void (*vtp_deliver)(tport_t *self,  msg_t *msg, su_time_t now);
00358   int (*vtp_prepare)(tport_t *self, msg_t *msg,
00359                      tp_name_t const *tpn,
00360                      struct sigcomp_compartment *cc,
00361                      unsigned mtu);
00362   int (*vtp_keepalive)(tport_t *self, su_addrinfo_t const *ai,
00363                        tagi_t const *taglist);
00364   int (*vtp_stun_response)(tport_t const *self,
00365                            void *msg, size_t msglen,
00366                            void *addr, socklen_t addrlen);
00367   int (*vtp_next_secondary_timer)(tport_t *self, su_time_t *,
00368                                   char const **return_why);
00369   void (*vtp_secondary_timer)(tport_t *self, su_time_t);
00370 };
00371 
00372 int tport_register_type(tport_vtable_t const *vtp);
00373 
00375 su_inline int tport_is_connection_oriented(tport_t const *self)
00376 {
00377   return self->tp_conn_orient;
00378 }
00379 
00381 su_inline int tport_has_connection(tport_t const *self)
00382 {
00383   return self->tp_has_connection;
00384 }
00385 
00386 void tport_has_been_updated(tport_t *tport);
00387 
00388 int tport_primary_compression(tport_primary_t *pri,
00389                               char const *compression,
00390                               tagi_t const *tl);
00391 
00392 void tport_set_tos(su_socket_t socket, su_addrinfo_t *ai, int tos);
00393 
00394 tport_t *tport_base_connect(tport_primary_t *pri,
00395                             su_addrinfo_t *ai,
00396                             su_addrinfo_t *name,
00397                             tp_name_t const *tpn);
00398 
00399 int tport_stream_init_primary(tport_primary_t *pri,
00400                               su_socket_t socket,
00401                               tp_name_t tpn[1],
00402                               su_addrinfo_t *ai,
00403                               tagi_t const *tags,
00404                               char const **return_reason);
00405 
00406 tport_t *tport_alloc_secondary(tport_primary_t *pri,
00407                                int socket,
00408                                int accepted,
00409                                char const **return_reason);
00410 
00411 int tport_accept(tport_primary_t *pri, int events);
00412 void tport_zap_secondary(tport_t *self);
00413 
00414 int tport_set_secondary_timer(tport_t *self);
00415 void tport_base_timer(tport_t *self, su_time_t now);
00416 
00417 int tport_bind_socket(int socket,
00418                       su_addrinfo_t *ai,
00419                       char const **return_culprit);
00420 void tport_close(tport_t *self);
00421 int tport_shutdown0(tport_t *self, int how);
00422 
00423 int tport_has_queued(tport_t const *self);
00424 
00425 int tport_error_event(tport_t *self);
00426 void tport_recv_event(tport_t *self);
00427 void tport_send_event(tport_t *self);
00428 void tport_hup_event(tport_t *self);
00429 
00430 ssize_t tport_recv_iovec(tport_t const *self,
00431                          msg_t **mmsg,
00432                          msg_iovec_t iovec[msg_n_fragments], size_t N,
00433                          int exact);
00434 
00435 msg_t *tport_msg_alloc(tport_t const *self, usize_t size);
00436 
00437 int tport_prepare_and_send(tport_t *self, msg_t *msg,
00438                            tp_name_t const *tpn,
00439                            struct sigcomp_compartment *cc,
00440                            unsigned mtu);
00441 int tport_send_msg(tport_t *self, msg_t *msg,
00442                    tp_name_t const *tpn,
00443                    struct sigcomp_compartment *cc);
00444 
00445 void tport_send_queue(tport_t *self);
00446 
00447 void tport_deliver(tport_t *self, msg_t *msg, msg_t *next,
00448                    tport_compressor_t *comp,
00449                    su_time_t now);
00450 void tport_base_deliver(tport_t *self, msg_t *msg, su_time_t now);
00451 
00452 int tport_recv_error_report(tport_t *self);
00453 void tport_error_report(tport_t *self, int errcode,
00454                         su_sockaddr_t const *addr);
00455 
00456 int tport_open_log(tport_master_t *mr, tagi_t *tags);
00457 void tport_log_msg(tport_t *tp, msg_t *msg, char const *what,
00458                    char const *via, su_time_t now);
00459 void tport_dump_iovec(tport_t const *self, msg_t *msg,
00460                       size_t n, su_iovec_t const iov[], size_t iovused,
00461                       char const *what, char const *how);
00462 
00463 int tport_tcp_ping(tport_t *self, su_time_t now);
00464 int tport_tcp_pong(tport_t *self);
00465 
00466 extern tport_vtable_t const tport_udp_vtable;
00467 extern tport_vtable_t const tport_udp_client_vtable;
00468 
00469 int tport_udp_init_primary(tport_primary_t *,
00470                            tp_name_t tpn[1],
00471                            su_addrinfo_t *,
00472                            tagi_t const *,
00473                            char const **return_culprit);
00474 void tport_udp_deinit_primary(tport_primary_t *);
00475 int tport_recv_dgram(tport_t *self);
00476 ssize_t tport_send_dgram(tport_t const *self, msg_t *msg,
00477                          msg_iovec_t iov[], size_t iovused);
00478 int tport_udp_error(tport_t const *self, su_sockaddr_t name[1]);
00479 
00480 extern tport_vtable_t const tport_tcp_vtable;
00481 extern tport_vtable_t const tport_tcp_client_vtable;
00482 
00483 int tport_tcp_init_primary(tport_primary_t *,
00484                           tp_name_t  tpn[1],
00485                           su_addrinfo_t *, tagi_t const *,
00486                           char const **return_culprit);
00487 int tport_tcp_init_client(tport_primary_t *,
00488                          tp_name_t tpn[1],
00489                          su_addrinfo_t *, tagi_t const *,
00490                          char const **return_culprit);
00491 int tport_tcp_init_secondary(tport_t *self, int socket, int accepted,
00492                              char const **return_reason);
00493 int tport_recv_stream(tport_t *self);
00494 ssize_t tport_send_stream(tport_t const *self, msg_t *msg,
00495                           msg_iovec_t iov[], size_t iovused);
00496 
00497 int tport_tcp_next_timer(tport_t *self, su_time_t *, char const **);
00498 void tport_tcp_timer(tport_t *self, su_time_t);
00499 
00500 int tport_next_recv_timeout(tport_t *, su_time_t *, char const **);
00501 void tport_recv_timeout_timer(tport_t *self, su_time_t now);
00502 
00503 int tport_next_keepalive(tport_t *self, su_time_t *, char const **);
00504 void tport_keepalive_timer(tport_t *self, su_time_t now);
00505 
00506 extern tport_vtable_t const tport_sctp_vtable;
00507 extern tport_vtable_t const tport_sctp_client_vtable;
00508 extern tport_vtable_t const tport_tls_vtable;
00509 extern tport_vtable_t const tport_tls_client_vtable;
00510 extern tport_vtable_t const tport_stun_vtable;
00511 extern tport_vtable_t const tport_http_connect_vtable;
00512 extern tport_vtable_t const tport_threadpool_vtable;
00513 
00514 typedef struct tport_descriptor_s {
00515   char const *tpd_name;
00516   tport_vtable_t *tpd_vtable;
00517   su_addrinfo_t *tpd_hints;
00518   int tpd_is_client_only;
00519 } tport_descriptor_t;
00520 
00521 typedef int const *(tport_set_f)(tport_master_t *mr,
00522                                  tp_name_t const *tpn,
00523                                  tagi_t const *taglist,
00524                                  tport_descriptor_t **return_set,
00525                                  int return_set_size);
00526 
00527 /* STUN plugin */
00528 
00529 int tport_init_stun_server(tport_master_t *mr, tagi_t const *tags);
00530 void tport_deinit_stun_server(tport_master_t *mr);
00531 int tport_recv_stun_dgram(tport_t const *self, msg_t **in_out_msg,
00532                           su_sockaddr_t *from, socklen_t fromlen);
00533 
00534 int tport_stun_server_add_socket(tport_t *tp);
00535 int tport_stun_server_remove_socket(tport_t *tp);
00536 
00537 void tport_recv_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
00538 void tport_recv_message(tport_t *self, msg_t *msg, int error);
00539 
00540 void tport_sent_bytes(tport_t *self, ssize_t bytes, ssize_t on_line);
00541 void tport_sent_message(tport_t *self, msg_t *msg, int error);
00542 
00543 /* ---------------------------------------------------------------------- */
00544 /* Compressor plugin */
00545 extern tport_comp_vtable_t const *tport_comp_vtable;
00546 
00547 char const *tport_canonize_comp(char const *comp);
00548 
00549 int tport_init_compressor(tport_t *,
00550                           char const *comp_name,
00551                           tagi_t const *tags);
00552 void tport_deinit_compressor(tport_t *);
00553 
00554 struct sigcomp_compartment *
00555 tport_sigcomp_assign_if_needed(tport_t *self,
00556                                struct sigcomp_compartment *cc);
00557 
00558 struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
00559 
00560 void tport_sigcomp_accept_incomplete(tport_t *self, msg_t *msg);
00561 
00562 int tport_recv_comp_dgram(tport_t const *self,
00563                           tport_compressor_t *sc,
00564                           msg_t **in_out_msg,
00565                           su_sockaddr_t *from,
00566                           socklen_t fromlen);
00567 
00568 ssize_t tport_send_comp(tport_t const *self,
00569                     msg_t *msg,
00570                     msg_iovec_t iov[],
00571                     size_t iovused,
00572                     struct sigcomp_compartment *cc,
00573                     tport_compressor_t *sc);
00574 
00575 SOFIA_END_DECLS
00576 
00577 #endif /* TPORT_INTERNAL_H */
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

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