src/peer.c

   1 /**************************************************************************/
   2 /* ---------------------------------------------------------------------- */
   3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners:                 */
   4 /*                                                                        */
   5 /*   Universidad de Cantabria,              SPAIN                         */
   6 /*   University of York,                    UK                            */
   7 /*   Scuola Superiore Sant'Anna,            ITALY                         */
   8 /*   Kaiserslautern University,             GERMANY                       */
   9 /*   Univ. Politécnica  Valencia,           SPAIN                        */
  10 /*   Czech Technical University in Prague,  CZECH REPUBLIC                */
  11 /*   ENEA                                   SWEDEN                        */
  12 /*   Thales Communication S.A.              FRANCE                        */
  13 /*   Visual Tools S.A.                      SPAIN                         */
  14 /*   Rapita Systems Ltd                     UK                            */
  15 /*   Evidence                               ITALY                         */
  16 /*                                                                        */
  17 /*   See http://www.frescor.org for a link to partners' websites          */
  18 /*                                                                        */
  19 /*          FRESCOR project (FP6/2005/IST/5-034026) is funded             */
  20 /*       in part by the European Union Sixth Framework Programme          */
  21 /*       The European Union is not liable of any use that may be          */
  22 /*       made of this code.                                               */
  23 /*                                                                        */
  24 /*                                                                        */
  25 /*  This file is part of FORB (Frescor Object Request Broker)             */
  26 /*                                                                        */
  27 /* FORB is free software; you can redistribute it and/or modify it        */
  28 /* under terms of the GNU General Public License as published by the      */
  29 /* Free Software Foundation; either version 2, or (at your option) any    */
  30 /* later version.  FORB is distributed in the hope that it will be        */
  31 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  32 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  33 /* General Public License for more details. You should have received a    */
  34 /* copy of the GNU General Public License along with FORB; see file       */
  35 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  36 /* Cambridge, MA 02139, USA.                                              */
  37 /*                                                                        */
  38 /* As a special exception, including FORB header files in a file,         */
  39 /* instantiating FORB generics or templates, or linking other files       */
  40 /* with FORB objects to produce an executable application, does not       */
  41 /* by itself cause the resulting executable application to be covered     */
  42 /* by the GNU General Public License. This exception does not             */
  43 /* however invalidate any other reasons why the executable file might be  */
  44 /* covered by the GNU Public License.                                     */
  45 /**************************************************************************/
  46
  47 /**
  48  * @file   peer.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Sun Oct 12 17:30:27 2008
  51  *
  52  * @brief  Implementation of peer manipulation functions.
  53  *
  54  *
  55  */
  56
  57 #include "peer.h"
  58 #include "forb_utils.h"
  59 #include "proto.h"
  60
  61 GAVL_CUST_NODE_INT_IMP(forb_peer_nolock,/* cust_prefix */
  62                        forb_t,          /* cust_root_t */
  63                        forb_peer_t,     /* cust_item_t */
  64                        forb_server_id,  /* cust_key_t */
  65                        peers,           /* cust_root_node */
  66                        gnode,           /* cust_item_node */
  67                        server_id,       /* cust_item_key */
  68                        forb_server_id_cmp);/* cust_cmp_fnc */
  69
  70
  71
  72 forb_peer_t *
  73 forb_peer_new(void)
  74 {
  75         forb_peer_t *peer;
  76
  77         peer = forb_malloc(sizeof(*peer));
  78         if (peer) {
  79                 memset(peer, 0, sizeof(*peer));
  80                 fosa_cond_init(&peer->cond);
  81                 forb_ref_init(&peer->ref);
  82         }
  83         return peer;
  84 }
  85
  86 void
  87 forb_peer_release(forb_ref_t *ref)
  88 {
  89         forb_peer_t *peer = container_of(ref, forb_peer_t, ref);
  90         if (peer->port->proto->peer_destroy) {
  91                 peer->port->proto->peer_destroy(peer);
  92         }
  93         forb_free(peer);
  94 }
  95
  96 void
  97 forb_peer_delete_by_port(forb_t *forb, forb_port_t *port)
  98 {
  99         forb_peer_t *peer;
 100         ul_list_for_each_cut(forb_port_peer, port, peer) {
 101                 forb_peer_delete(forb, peer);
 102                 forb_peer_put(peer);
 103         }
 104 }
 105
 106 /**
 107  * Finds the peer with given @a server_id. If the peer is not
 108  * currently known (not yet discovered or not available), this
 109  * function waits at maximum @a timeout for the peer to be discovered.
 110  *
 111  * @param forb
 112  * @param server_id
 113  * @param timeout
 114  *
 115  * @return The peer structure or NULL if the peer is not known even
 116  * after the timeout elapses.
 117  *
 118  * @note After the returned peer is not needed, forb_peer_put() must
 119  * called on it.
 120  */
 121 forb_peer_t *
 122 forb_peer_find_timed(forb_t *forb, forb_server_id *server_id,
 123                      fosa_abs_time_t *timeout)
 124 {
 125         forb_peer_t *peer;
 126
 127         fosa_mutex_lock(&forb->peer_mutex);
 128         peer = forb_peer_nolock_find(forb, server_id);
 129         if (!peer && !timeout) goto unlock;
 130         if (peer) {
 131                 forb_peer_get(peer);
 132         }
 133         if (!peer) {
 134                 /* We are the first who want to contact this peer */
 135                 peer = forb_peer_new();
 136                 if (!peer) goto unlock;
 137                 peer->server_id = *server_id;
 138                 peer->state = FORB_PEER_WANTED;
 139                 forb_peer_get(peer);
 140                 forb_peer_nolock_insert(forb, peer);
 141         }
 142         while (peer->state == FORB_PEER_WANTED) {
 143                 int ret;
 144                 /* Wait for the peer to be discovered. */
 145                 ret = fosa_cond_timedwait(&peer->cond,
 146                                           &forb->peer_mutex,
 147                                           timeout);
 148                 if (ret == FOSA_ETIMEDOUT) {
 149                         forb_peer_put(peer);
 150                         peer = NULL;
 151                         /* TODO: How to remove the peer from the tree?
 152                          * We should check refcnt and if equal to 1,
 153                          * we should remove it.  */
 154                         break;
 155                 }
 156         }
 157 unlock:
 158         fosa_mutex_unlock(&forb->peer_mutex);
 159
 160         return peer;
 161 }