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