src/forb/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 /**
  64  * Initializes executor.
  65  *
  66  * @param executor
  67  *
  68  * @return Zero on success, FOSA error code on error.
  69  */
  70 int forb_executor_init(forb_executor_t *executor)
  71 {
  72         int ret;
  73         ret = fosa_mutex_init(&executor->mutex, 0);
  74         if (ret) return ret;
  75
  76         ret = fosa_cond_init(&executor->new_request_in_empty_list);
  77         if (ret) return ret;
  78
  79         forb_exec_req_nolock_init_head(executor);
  80         return 0;
  81 }
  82
  83 void forb_executor_destroy(forb_executor_t *executor)
  84 {
  85         /* TODO: */
  86 }
  87
  88 /**
  89  * Setup the object @a obj so that requests to it are executed within
  90  * the thread of the @a executor.
  91  *
  92  * @param executor
  93  * @param obj
  94  *
  95  * @return Zero on success, non-zero on error.
  96  */
  97 int forb_executor_register_object(forb_executor_t *executor, forb_object obj)
  98 {
  99         if (!obj || obj->executor)
 100                 return -1;
 101
 102         obj->executor = executor;
 103         return 0;
 104 }
 105
 106 /**
 107  * Unregisteres the object @a obj from @a executor.
 108  *
 109  * @param executor
 110  * @param obj
 111  */
 112 void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj)
 113 {
 114         if (obj) {
 115                 obj->executor = NULL;
 116         }
 117 }
 118
 119 /**
 120  * Executor's main loop which executes object implementation methods
 121  * upon request.
 122  *
 123  * The requests are represented by ::forb_exec_req_t and are enqueued
 124  * to the executor's request queue by receiver threads of individual
 125  * ports (forb_iop_receiver_thread()).
 126  *
 127  * @param executor
 128  *
 129  * @return Zero on normal termination, non-zero error codes will be
 130  * defined later.
 131  */
 132 int forb_executor_run(forb_executor_t *executor)
 133 {
 134         fosa_mutex_lock(&executor->mutex);
 135         while (1) {
 136                 fosa_cond_wait(&executor->new_request_in_empty_list,
 137                                &executor->mutex);
 138                 while (!forb_exec_req_nolock_is_empty(executor)) {
 139                         forb_exec_req_t *exec_req;
 140                         exec_req = forb_exec_req_nolock_cut_first(executor);
 141                         fosa_mutex_unlock(&executor->mutex);
 142
 143                         forb_exec_req_process(exec_req);
 144
 145                         fosa_mutex_lock(&executor->mutex);
 146                 }
 147         }
 148         fosa_mutex_unlock(&executor->mutex);
 149         return 0;
 150 }
 151
 152 /**
 153  * Convenience function for executing only one object in one executor.
 154  *
 155  * @param obj The object to execute.
 156  *
 157  * @return Zero in case of success, error code on error.
 158  */
 159 int forb_execute_object(forb_object obj)
 160 {
 161         forb_executor_t executor;
 162         int ret;
 163
 164         ret = forb_executor_init(&executor);
 165         if (ret) goto error;
 166         ret = forb_executor_register_object(&executor, obj);
 167         if (ret) goto destroy_and_error;
 168
 169         ret = forb_executor_run(&executor);
 170
 171 destroy_and_error:
 172         forb_executor_destroy(&executor);
 173 error:
 174         return ret;
 175 }