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
  65 extern UL_LOG_CUST(ulogd_forb_port);
  66
  67 /**
  68  * Registers a new port in FORB and run receiver thread on it to
  69  * receive FORB messages through this prot.
  70  *
  71  * @param forb Where to register the new port.
  72  *
  73  * @param port Port to register. The @c desc field should be
  74  * initialized prior calling this function. The memory for @a port
  75  * should be forb_malloced, since forb_free() is called on the port on
  76  * destroy operation.
  77  *
  78  * @return Zero on success, FOSA error code on error.
  79  */
  80 int forb_register_port(forb_orb orb, forb_port_t *port)
  81 {
  82         int ret;
  83         forb_t *forb = forb_data(orb);
  84
  85         port->forb = forb;
  86         port->finish = false;
  87
  88         forb_port_peer_init_head(port);
  89
  90         fosa_mutex_lock(&forb->port_mutex);
  91         forb_port_insert(forb, port);
  92         fosa_mutex_unlock(&forb->port_mutex);
  93
  94         forb_syncobj_init(&port->hello, 0);
  95         forb_syncobj_init(&port->reply_processed, 0);
  96
  97         FORB_CDR_codec_init_static(&port->codec, forb->orb);
  98         if (!FORB_CDR_buffer_init(&port->codec, CONFIG_FORB_RECV_BUF_SIZE, 0)) {
  99                 ret = FOSA_ENOMEM;
 100                 goto err;
 101         }
 102
 103         if (port->desc.proto->register_cb) {
 104                 port->desc.proto->register_cb(port);
 105         }
 106
 107         ret = fosa_thread_create(&port->receiver_thread, NULL,
 108                                  forb_iop_receiver_thread, port);
 109         if (ret != 0)
 110                 goto err2;
 111 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 112         /* For reliability reasons, we do not use discovery protocol
 113          * when INET is the default communication protocol. */
 114         ret = fosa_thread_create(&port->discovery_thread, NULL,
 115                                  forb_iop_discovery_thread, port);
 116         if (ret != 0)
 117                 goto err3;
 118 #endif
 119         return 0;
 120 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 121 err3:
 122         port->finish = true;
 123         /* FIXME: This is Aquosa specific - cancelation should be
 124          * added to FOSA. */
 125         pthread_cancel(port->receiver_thread.pthread_id);
 126         pthread_cancel(port->discovery_thread.pthread_id);
 127
 128         pthread_join(port->receiver_thread.pthread_id, NULL);
 129         pthread_join(port->discovery_thread.pthread_id, NULL);
 130 #endif
 131 err2:
 132         FORB_CDR_codec_release_buffer(&port->codec);
 133 err:
 134         fosa_mutex_lock(&forb->port_mutex);
 135         forb_port_delete(forb, port);
 136         fosa_mutex_unlock(&forb->port_mutex);
 137
 138         return ret;
 139 }
 140
 141 /**
 142  * Destroys the port and all resources associated with it.
 143  *
 144  * @param port
 145  */
 146 void forb_destroy_port(forb_port_t *port)
 147 {
 148         forb_t *forb = port->forb;
 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         //pthread_cancel(port->discovery_thread.pthread_id);
 160
 161         /* Sometimes, cancelation doesn't work and the
 162          * discovery_thread hangs in pthread_cond_timedwait
 163          * infinitely. */
 164         forb_syncobj_signal(&port->hello);
 165
 166         pthread_join(port->receiver_thread.pthread_id, &thread_return);
 167 #ifndef CONFIG_FORB_PROTO_INET_DEFAULT
 168         pthread_join(port->discovery_thread.pthread_id, &thread_return);
 169 #endif
 170
 171         if (port->desc.proto->port_destroy) {
 172                 port->desc.proto->port_destroy(port);
 173         }
 174
 175         /* Because of no locking of port->peers, this must be called
 176          * after receiver thread is stopped. */
 177         forb_peer_delete_by_port(forb, port);
 178
 179         FORB_CDR_codec_release_buffer(&port->codec);
 180
 181         fosa_mutex_lock(&forb->port_mutex);
 182         forb_port_delete(forb, port);
 183         fosa_mutex_unlock(&forb->port_mutex);
 184
 185         /* TODO: reference counting */
 186         forb_free(port);
 187 }