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