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