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 #include "executor.h"
  48 #include "exec_req.h"
  49 #include "object.h"
  50
  51 int forb_executor_init(forb_executor_t *executor)
  52 {
  53         int ret;
  54         ret = fosa_mutex_init(&executor->mutex, 0);
  55         if (ret) return ret;
  56
  57         ret = fosa_cond_init(&executor->new_request_in_empty_list);
  58         if (ret) return ret;
  59
  60         forb_exec_req_nolock_init_head(executor);
  61         return 0;
  62 }
  63 void forb_executor_destroy(forb_executor_t *executor)
  64 {
  65         /* TODO: */
  66 }
  67
  68 /**
  69  * Setup the object @a obj so that requests to it are executed within
  70  * the thread of the @a executor.
  71  *
  72  * @param executor
  73  * @param obj
  74  *
  75  * @return Zero on success, non-zero on error.
  76  */
  77 int forb_executor_register_object(forb_executor_t *executor, forb_object obj)
  78 {
  79         if (!obj || obj->executor)
  80                 return -1;
  81
  82         obj->executor = executor;
  83         return 0;
  84 }
  85
  86 /**
  87  * Executor's main loop which processes requests.
  88  *
  89  * @param executor
  90  *
  91  * @return Will be defined later.
  92  */
  93 int forb_executor_run(forb_executor_t *executor)
  94 {
  95         fosa_mutex_lock(&executor->mutex);
  96         while (1) {
  97                 fosa_cond_wait(&executor->new_request_in_empty_list,
  98                                &executor->mutex);
  99                 while (!forb_exec_req_nolock_is_empty(executor)) {
 100                         forb_exec_req_t *exec_req;
 101                         exec_req = forb_exec_req_nolock_cut_first(executor);
 102                         fosa_mutex_unlock(&executor->mutex);
 103
 104                         forb_exec_req_process(exec_req);
 105
 106                         fosa_mutex_lock(&executor->mutex);
 107                 }
 108         }
 109         fosa_mutex_unlock(&executor->mutex);
 110         return 0;
 111 }
 112
 113 /**
 114  * Convenience function for executing only one object in one executor.
 115  *
 116  * @param obj The object to execute.
 117  *
 118  * @return Zero in case of success, error code on error.
 119  */
 120 int forb_execute_object(forb_object obj)
 121 {
 122         forb_executor_t executor;
 123         int ret;
 124
 125         ret = forb_executor_init(&executor);
 126         if (ret) goto error;
 127         ret = forb_executor_register_object(&executor, obj);
 128         if (ret) goto destroy_and_error;
 129
 130         ret = forb_executor_run(&executor);
 131
 132 destroy_and_error:
 133         forb_executor_destroy(&executor);
 134 error:
 135         return ret;
 136 }