src/port.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   port.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Sun Oct 12 17:36:13 2008
  51  *
  52  * @brief  Implementation of port manipulation functions.
  53  *
  54  *
  55  */
  56
  57
  58 #include "port.h"
  59 #include "proto.h"
  60 #include "object.h"
  61 #include <forb/config.h>
  62 #include "iop.h"
  63 #include <ul_log.h>
  64 #include "discovery.h"
  65
  66 extern UL_LOG_CUST(ulogd_forb_port);
  67
  68 /**
  69  * Registers a new port in FORB and run receiver thread on it to
  70  * receive FORB messages through this prot.
  71  *
  72  * @param forb Where to register the new port.
  73  *
  74  * @param port Port to register. The @c desc field should be
  75  * initialized prior calling this function. The memory for @a port
  76  * should be forb_malloced, since forb_free() is called on the port on
  77  * destroy operation.
  78  *
  79  * @return Zero on success, FOSA error code on error.
  80  */
  81 int forb_register_port(forb_orb orb, forb_port_t *port)
  82 {
  83         int ret;
  84         forb_t *forb = forb_data(orb);
  85
  86         port->forb = forb;
  87         port->finish = false;
  88
  89         forb_port_peer_init_head(port);
  90
  91         fosa_mutex_lock(&forb->port_mutex);
  92         forb_port_insert(forb, port);
  93         fosa_mutex_unlock(&forb->port_mutex);
  94
  95         forb_syncobj_init(&port->hello, 0);
  96         forb_syncobj_init(&port->reply_processed, 0);
  97
  98         FORB_CDR_codec_init_static(&port->codec, forb->orb);
  99         if (!FORB_CDR_buffer_init(&port->codec, CONFIG_FORB_RECV_BUF_SIZE, 0)) {
 100                 ret = FOSA_ENOMEM;
 101                 goto err;
 102         }
 103
 104         if (port->desc.proto->register_cb) {
 105                 port->desc.proto->register_cb(port);
 106         }
 107
 108         ret = fosa_thread_create(&port->receiver_thread, NULL,
 109                                  forb_iop_receiver_thread, port);
 110         if (ret != 0)
 111                 goto err2;
 112 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 113         /* For reliability reasons, we do not use discovery protocol
 114          * when INET is the default communication protocol. */
 115         ret = fosa_thread_create(&port->discovery_thread, NULL,
 116                                  forb_iop_discovery_thread, port);
 117         if (ret != 0)
 118                 goto err3;
 119 #endif
 120         return 0;
 121 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 122 err3:
 123         port->finish = true;
 124         /* FIXME: This is Aquosa specific - cancelation should be
 125          * added to FOSA. */
 126         pthread_cancel(port->receiver_thread.pthread_id);
 127         pthread_cancel(port->discovery_thread.pthread_id);
 128
 129         pthread_join(port->receiver_thread.pthread_id, NULL);
 130         pthread_join(port->discovery_thread.pthread_id, NULL);
 131 #endif
 132 err2:
 133         FORB_CDR_codec_release_buffer(&port->codec);
 134 err:
 135         fosa_mutex_lock(&forb->port_mutex);
 136         forb_port_delete(forb, port);
 137         fosa_mutex_unlock(&forb->port_mutex);
 138
 139         return ret;
 140 }
 141
 142 /**
 143  * Stop receiving requests on the port.
 144  *
 145  * @param port
 146  */
 147 void forb_stop_port(forb_port_t *port)
 148 {
 149         void *thread_return;
 150
 151         port->finish = true;    /* Exit all the threads */
 152
 153         /* FIXME: There is no FOSA API for thread cancelation. */
 154         pthread_cancel(port->receiver_thread.pthread_id);
 155
 156         /* FIXME: Canceling discovery thread sometimes didn't
 157          * work. The discovery thread stayed forever in the
 158          * pthread_cond_timedwait(). */
 159 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 160         pthread_cancel(port->discovery_thread.pthread_id);
 161 #endif
 162         /* Sometimes, cancelation doesn't work and the
 163          * discovery_thread hangs in pthread_cond_timedwait
 164          * infinitely. */
 165         forb_syncobj_signal(&port->hello);
 166
 167         pthread_join(port->receiver_thread.pthread_id, &thread_return);
 168 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 169         pthread_join(port->discovery_thread.pthread_id, &thread_return);
 170 #endif
 171 }
 172
 173
 174 /**
 175  * Destroys the port and all resources associated with it.
 176  *
 177  * @param port
 178  */
 179 void forb_destroy_port(forb_port_t *port)
 180 {
 181         forb_t *forb = port->forb;
 182
 183         /* Because of no locking of port->peers, this must be called
 184          * after receiver thread is stopped. */
 185         forb_peer_t *peer;
 186         ul_list_for_each_cut(forb_port_peer, port, peer) {
 187                 forb_peer_get(peer);
 188                 forb_peer_disconnected(peer);
 189                 forb_peer_put(peer);
 190         }
 191         if (port->new_peer)
 192                 forb_peer_put(port->new_peer);
 193
 194         if (port->desc.proto->port_destroy) {
 195                 port->desc.proto->port_destroy(port);
 196         }
 197
 198         FORB_CDR_codec_release_buffer(&port->codec);
 199
 200         fosa_mutex_lock(&forb->port_mutex);
 201         forb_port_delete(forb, port);
 202         fosa_mutex_unlock(&forb->port_mutex);
 203
 204         /* TODO: reference counting */
 205         forb_free(port);
 206 }