tport_internal.h

Go to the documentation of this file.
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 
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;       /* for printf() and friends */
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   /* ==== Receive queue ================================================== */
00177 
00178   msg_t              *tp_msg;           
00180   /* ==== Pending messages =============================================== */
00181 
00182   tport_pending_t    *tp_pending;       
00183   tport_pending_t    *tp_released;      
00184   unsigned            tp_plen;          
00185   unsigned            tp_pused;         
00186   unsigned short      tp_reported;      
00187   unsigned short      tp_pad;
00188 
00189   /* ==== Send queue ===================================================== */
00190 
00191   msg_t             **tp_queue;         
00192   unsigned short      tp_qhead;         
00194   msg_iovec_t        *tp_unsent;        
00195   size_t              tp_unsentlen;     
00197   msg_iovec_t        *tp_iov;           
00198   size_t              tp_iovlen;        
00200   /* ==== Extensions  ===================================================== */
00201 
00202   tport_compressor_t *tp_comp;
00203 
00204   /* ==== Statistics  ===================================================== */
00205   
00206   struct {
00207     uint64_t sent_bytes, sent_on_line, recv_bytes, recv_on_line;
00208     uint64_t sent_msgs, recv_msgs;
00209   } tp_stats;
00210 };
00211 
00213 struct tport_primary {
00214   tport_t             pri_primary[1];   
00215 #if DOXYGEN_ONLY
00216   su_home_t           pri_home[1];
00217 #else
00218 #define pri_home      pri_primary->tp_home
00219 #define pri_master    pri_primary->tp_master
00220 #define pri_protoname pri_primary->tp_name->tpn_proto
00221 #endif
00222   tport_vtable_t const
00223                      *pri_vtable;
00224   int                 pri_public;       
00229   char                pri_ident[16];
00230   tport_primary_t    *pri_next;         
00232   tport_t            *pri_secondary;    
00234   unsigned            pri_updating:1;   
00235   unsigned            pri_natted:1;     
00236   unsigned            pri_has_tls:1;    
00237   unsigned:0;
00238 
00239   void               *pri_stun_handle;
00240 
00241   tport_params_t      pri_params[1];      
00243 };
00244 
00246 struct tport_master {
00247   tport_t             mr_master[1];
00248 #if DOXYGEN_ONLY
00249   su_home_t           mr_home[1];
00250 #else
00251 #define mr_home mr_master->tp_home
00252 #endif
00253 
00254   int                 mr_stun_step_ready; 
00256   tp_stack_t         *mr_stack;         
00257   tp_stack_class_t 
00258                const *mr_tpac;          
00259   int                 mr_log;           
00260   su_root_t          *mr_root;          
00263   su_timer_t         *mr_timer;         
00265   FILE               *mr_dump_file;     
00266 
00267   tport_primary_t    *mr_primaries;        
00269   tport_params_t      mr_params[1];
00270   
00271   unsigned            mr_boundserver:1; 
00272   unsigned            mr_bindv6only:1; 
00273   unsigned :0;
00274 
00275   /* Delivery context */
00276   struct tport_delivery {
00277     tport_t              *d_tport;
00278     msg_t                *d_msg;
00279     tp_name_t             d_from[1];
00280     tport_compressor_t   *d_comp;
00281   } mr_delivery[1];
00282 
00283   tport_stun_server_t *mr_stun_server;
00284 
00285 #if 0
00286   struct tport_nat_s {
00287     int initialized;
00288     int bound;
00289     int stun_enabled;
00290     char *external_ip_address;
00291 #if HAVE_UPNP || HAVE_SOFIA_STUN
00292     int try_stun;
00293 #endif
00294 #if HAVE_UPNP
00295 #endif
00296 #if HAVE_SOFIA_STUN
00297     tport_master_t *tport;
00298     char *stun_server;
00299     /* stun_socket_t *stun_socket; */
00300     stun_handle_t *stun;
00301     su_socket_t stun_socket;
00302     su_sockaddr_t sockaddr;
00303 #endif
00304   }                   mr_nat[1];
00305 #endif
00306 };
00307 
00309 struct tport_vtable
00310 {
00311   char const *vtp_name;
00312   enum tport_via vtp_public;
00313 
00314   size_t vtp_pri_size;          /* Size of primary tport */
00315   int (*vtp_init_primary)(tport_primary_t *pri,
00316                           tp_name_t tpn[1],
00317                           su_addrinfo_t *ai, tagi_t const *,
00318                           char const **return_culprit);
00319   void (*vtp_deinit_primary)(tport_primary_t *pri);
00320   int (*vtp_wakeup_pri)(tport_primary_t *pri, int events);
00321   tport_t *(*vtp_connect)(tport_primary_t *pri, su_addrinfo_t *ai, 
00322                           tp_name_t const *tpn);
00323 
00324   size_t vtp_secondary_size;    /* Size of secondary tport */
00325 
00326   int (*vtp_init_secondary)(tport_t *, int socket, int accepted,
00327                             char const **return_reason);
00328   void (*vtp_deinit_secondary)(tport_t *);
00329   void (*vtp_shutdown)(tport_t *, int how);
00330   int (*vtp_set_events)(tport_t const *self);
00331   int (*vtp_wakeup)(tport_t *self, int events);
00332   int (*vtp_recv)(tport_t *self);
00333   ssize_t (*vtp_send)(tport_t const *self, msg_t *msg,
00334                       msg_iovec_t iov[], size_t iovused);
00335   void (*vtp_deliver)(tport_t *self,  msg_t *msg, su_time_t now);
00336   int (*vtp_prepare)(tport_t *self, msg_t *msg, 
00337                      tp_name_t const *tpn, 
00338                      struct sigcomp_compartment *cc,
00339                      unsigned mtu);
00340   int (*vtp_keepalive)(tport_t *self, su_addrinfo_t const *ai,
00341                        tagi_t const *taglist);
00342   int (*vtp_stun_response)(tport_t const *self,
00343                            void *msg, size_t msglen,
00344                            void *addr, socklen_t addrlen);
00345 };
00346 
00347 int tport_register_type(tport_vtable_t const *vtp);
00348 
00350 static inline int tport_is_connection_oriented(tport_t const *self)
00351 {
00352   return self->tp_conn_orient;
00353 }
00354 
00356 static inline int tport_is_connected(tport_t const *self)
00357 {
00358   return self->tp_connected;
00359 }
00360 
00361 void tport_has_been_updated(tport_t *tport);
00362 
00363 int tport_primary_compression(tport_primary_t *pri,
00364                               char const *compression,
00365                               tagi_t const *tl);
00366 
00367 tport_t *tport_base_connect(tport_primary_t *pri, 
00368                             su_addrinfo_t *ai,
00369                             su_addrinfo_t *name,
00370                             tp_name_t const *tpn);
00371 
00372 int tport_stream_init_primary(tport_primary_t *pri, 
00373                               su_socket_t socket,
00374                               tp_name_t tpn[1],
00375                               su_addrinfo_t *ai,
00376                               tagi_t const *tags,
00377                               char const **return_reason);
00378 
00379 tport_t *tport_alloc_secondary(tport_primary_t *pri,
00380                                int socket,
00381                                int accepted,
00382                                char const **return_reason);
00383 
00384 int tport_accept(tport_primary_t *pri, int events);
00385 void tport_zap_secondary(tport_t *self);
00386 
00387 int tport_bind_socket(int socket,
00388                       su_addrinfo_t *ai,
00389                       char const **return_culprit);
00390 void tport_close(tport_t *self);
00391 
00392 
00393 int tport_error_event(tport_t *self);
00394 void tport_recv_event(tport_t *self);
00395 void tport_send_event(tport_t *self);
00396 void tport_hup_event(tport_t *self);
00397 
00398 ssize_t tport_recv_iovec(tport_t const *self, 
00399                          msg_t **mmsg,
00400                          msg_iovec_t iovec[msg_n_fragments], size_t N, 
00401                          int exact);
00402 
00403 msg_t *tport_msg_alloc(tport_t const *self, usize_t size);
00404 
00405 int tport_prepare_and_send(tport_t *self, msg_t *msg, 
00406                            tp_name_t const *tpn, 
00407                            struct sigcomp_compartment *cc,
00408                            unsigned mtu);
00409 int tport_send_msg(tport_t *self, msg_t *msg, 
00410                    tp_name_t const *tpn, 
00411                    struct sigcomp_compartment *cc);
00412 
00413 void tport_deliver(tport_t *self, msg_t *msg, msg_t *next, 
00414                    tport_compressor_t *comp,
00415                    su_time_t now);
00416 void tport_base_deliver(tport_t *self, msg_t *msg, su_time_t now);
00417 
00418 int tport_recv_error_report(tport_t *self);
00419 void tport_error_report(tport_t *self, int errcode, 
00420                         su_sockaddr_t const *addr);
00421 
00422 void tport_open_log(tport_master_t *mr, tagi_t *tags);
00423 void tport_log_msg(tport_t *tp, msg_t *msg, char const *what, 
00424                    char const *via, su_time_t now);
00425 void tport_dump_iovec(tport_t const *self, msg_t *msg, 
00426                       size_t n, su_iovec_t const iov[], size_t iovused,
00427                       char const *what, char const *how);
00428 
00429 extern tport_vtable_t const tport_udp_vtable;
00430 extern tport_vtable_t const tport_udp_client_vtable;
00431 
00432 int tport_udp_init_primary(tport_primary_t *, 
00433                            tp_name_t tpn[1], 
00434                            su_addrinfo_t *, 
00435                            tagi_t const *,
00436                            char const **return_culprit);
00437 void tport_udp_deinit_primary(tport_primary_t *);
00438 int tport_recv_dgram(tport_t *self);
00439 ssize_t tport_send_dgram(tport_t const *self, msg_t *msg,
00440                          msg_iovec_t iov[], size_t iovused);
00441 int tport_udp_error(tport_t const *self, su_sockaddr_t name[1]);
00442 
00443 extern tport_vtable_t const tport_tcp_vtable;
00444 extern tport_vtable_t const tport_tcp_client_vtable;
00445 
00446 int tport_tcp_init_primary(tport_primary_t *, 
00447                           tp_name_t  tpn[1], 
00448                           su_addrinfo_t *, tagi_t const *,
00449                           char const **return_culprit);
00450 int tport_tcp_init_client(tport_primary_t *, 
00451                          tp_name_t tpn[1], 
00452                          su_addrinfo_t *, tagi_t const *,
00453                          char const **return_culprit);
00454 int tport_tcp_init_secondary(tport_t *self, int socket, int accepted,
00455                              char const **return_reason);
00456 int tport_recv_stream(tport_t *self);
00457 ssize_t tport_send_stream(tport_t const *self, msg_t *msg,
00458                           msg_iovec_t iov[], size_t iovused);
00459 
00460 extern tport_vtable_t const tport_sctp_vtable;
00461 extern tport_vtable_t const tport_sctp_client_vtable;
00462 extern tport_vtable_t const tport_tls_vtable;
00463 extern tport_vtable_t const tport_tls_client_vtable;
00464 extern tport_vtable_t const tport_stun_vtable;
00465 extern tport_vtable_t const tport_http_connect_vtable;
00466 extern tport_vtable_t const tport_threadpool_vtable;
00467 
00468 typedef struct tport_descriptor_s {
00469   char const *tpd_name;
00470   tport_vtable_t *tpd_vtable;
00471   su_addrinfo_t *tpd_hints;
00472   int tpd_is_client_only;
00473 } tport_descriptor_t;
00474 
00475 typedef int const *(tport_set_f)(tport_master_t *mr, 
00476                                  tp_name_t const *tpn,
00477                                  tagi_t const *taglist,
00478                                  tport_descriptor_t **return_set,
00479                                  int return_set_size);
00480 
00481 /* STUN plugin */
00482 
00483 int tport_init_stun_server(tport_master_t *mr, tagi_t const *tags);
00484 void tport_deinit_stun_server(tport_master_t *mr);
00485 int tport_recv_stun_dgram(tport_t const *self, msg_t **in_out_msg,
00486                           su_sockaddr_t *from, socklen_t fromlen);
00487 
00488 int tport_stun_server_add_socket(tport_t *tp);
00489 int tport_stun_server_remove_socket(tport_t *tp);
00490 
00491 /* ---------------------------------------------------------------------- */
00492 /* Compressor plugin */
00493 extern tport_comp_vtable_t const *tport_comp_vtable;
00494 
00495 char const *tport_canonize_comp(char const *comp);
00496 
00497 int tport_init_compressor(tport_t *,
00498                           char const *comp_name,
00499                           tagi_t const *tags);
00500 void tport_deinit_compressor(tport_t *);
00501 
00502 struct sigcomp_compartment *
00503 tport_sigcomp_assign_if_needed(tport_t *self,
00504                                struct sigcomp_compartment *cc);
00505 
00506 struct sigcomp_udvm **tport_get_udvm_slot(tport_t *self);
00507 
00508 void tport_sigcomp_accept_incomplete(tport_t *self, msg_t *msg);
00509 
00510 int tport_recv_comp_dgram(tport_t const *self,
00511                           tport_compressor_t *sc,
00512                           msg_t **in_out_msg,
00513                           su_sockaddr_t *from,
00514                           socklen_t fromlen);
00515 
00516 ssize_t tport_send_comp(tport_t const *self,
00517                     msg_t *msg, 
00518                     msg_iovec_t iov[], 
00519                     size_t iovused,
00520                     struct sigcomp_compartment *cc,
00521                     tport_compressor_t *sc);
00522 
00523 SOFIA_END_DECLS
00524 
00525 #endif /* TPORT_INTERNAL_H */

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