src/executor.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   executor.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Sun Oct 12 16:18:04 2008
  51  *
  52  * @brief  Implementation of executors.
  53  */
  54
  55
  56 #include "executor.h"
  57 #include "exec_req.h"
  58 #include "object.h"
  59 #include <ul_log.h>
  60 #include <stdio.h>
  61 #include <pthread.h>
  62
  63 extern UL_LOG_CUST(ulogd_forb_executor);
  64
  65 static pthread_key_t forb_executor_key = -1;
  66
  67 int forb_executor_prepare()
  68 {
  69         return pthread_key_create(&forb_executor_key, NULL);
  70 }
  71
  72 /**
  73  * Initializes executor.
  74  *
  75  * @param executor
  76  *
  77  * @return Zero on success, FOSA error code on error.
  78  */
  79 int forb_executor_init(forb_executor_t *executor)
  80 {
  81         int ret;
  82         ret = fosa_mutex_init(&executor->mutex, 0);
  83         if (ret) return ret;
  84
  85         ret = fosa_cond_init(&executor->new_request_in_empty_list);
  86         if (ret) return ret;
  87
  88         forb_exec_req_nolock_init_head(executor);
  89         return 0;
  90 }
  91
  92 void forb_executor_destroy(forb_executor_t *executor)
  93 {
  94         /* TODO: */
  95 }
  96
  97 /**
  98  * Setup the object @a obj so that requests to it are executed within
  99  * the thread of the @a executor.
 100  *
 101  * @param executor
 102  * @param obj
 103  *
 104  * @return Zero on success, non-zero on error.
 105  */
 106 int forb_executor_register_object(forb_executor_t *executor, forb_object obj)
 107 {
 108         if (!obj || obj->executor)
 109                 return -1;
 110
 111         obj->executor = executor;
 112         return 0;
 113 }
 114
 115 /**
 116  * Unregisteres the object @a obj from @a executor.
 117  *
 118  * @param executor
 119  * @param obj
 120  */
 121 void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj)
 122 {
 123         if (obj) {
 124                 obj->executor = NULL;
 125         }
 126 }
 127
 128 /**
 129  * Executor's main loop which executes object implementation methods
 130  * upon request.
 131  *
 132  * The requests are represented by ::forb_exec_req_t and are enqueued
 133  * to the executor's request queue by receiver threads of individual
 134  * ports (forb_iop_receiver_thread()).
 135  *
 136  * @param executor
 137  *
 138  * @return Zero on normal termination, non-zero error codes will be
 139  * defined later.
 140  */
 141 int forb_executor_run(forb_executor_t *executor)
 142 {
 143         int ret;
 144
 145         // setting pointer to executor as thread specific data
 146         if ((ret = pthread_setspecific(forb_executor_key, executor)))
 147                 goto ret;
 148
 149         fosa_mutex_lock(&executor->mutex);
 150         while (1) {
 151                 fosa_cond_wait(&executor->new_request_in_empty_list,
 152                                &executor->mutex);
 153                 while (!forb_exec_req_nolock_is_empty(executor)) {
 154                         forb_exec_req_t *exec_req;
 155                         exec_req = forb_exec_req_nolock_cut_first(executor);
 156                         fosa_mutex_unlock(&executor->mutex);
 157
 158                         forb_exec_req_process(exec_req);
 159
 160                         fosa_mutex_lock(&executor->mutex);
 161                 }
 162         }
 163         fosa_mutex_unlock(&executor->mutex);
 164 ret:
 165         return ret;
 166 }
 167
 168 /**
 169  * Convenience function for executing only one object in one executor.
 170  *
 171  * @param obj The object to execute.
 172  *
 173  * @return Zero in case of success, error code on error.
 174  */
 175 int forb_execute_object(forb_object obj)
 176 {
 177         forb_executor_t executor;
 178         int ret;
 179
 180         ret = forb_executor_init(&executor);
 181         if (ret) goto error;
 182         ret = forb_executor_register_object(&executor, obj);
 183         if (ret) goto destroy_and_error;
 184
 185         ret = forb_executor_run(&executor);
 186
 187 destroy_and_error:
 188         forb_executor_destroy(&executor);
 189 error:
 190         return ret;
 191 }
 192
 193
 194 /**
 195  * Determines the executor we are currently in.
 196  *
 197  * @param executor Current executor pointer.
 198  *
 199  * @return Zero in case of success.
 200  */
 201 int forb_get_current_executor(forb_executor_t **executor)
 202 {
 203         int ret = 0;
 204         *executor = (void *) pthread_getspecific(forb_executor_key);
 205
 206         if (!(*executor))
 207                 ret = 1;
 208         return ret;
 209 }