src/forb-internal.h

   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   forb-internal.h
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  *
  51  * @brief  Declarationd necessary for IDL-generated code and other parts of FORB.
  52  *
  53  * This header is not intended to be included by applications.
  54  *
  55  */
  56
  57 #ifndef FORB_INTERNAL_H
  58 #define FORB_INTERNAL_H
  59
  60 #include <forb/basic_types.h>
  61 #include <forb/cdr.h>
  62 #include <forb.h>
  63 #include <forb/uuid.h>
  64 #include <ul_list.h>
  65 #include <ul_gavlcust.h>
  66 #include <forb.h>
  67 #include <string.h>
  68
  69
  70 /**
  71  * Temporary directory for FORB's housekeeping.
  72  *
  73  * It is used for proto_unix.c sockets and for registered references
  74  * (forb_register_reference()).
  75  */
  76 #define FORB_TMP_DIR "/tmp/forb"
  77
  78 #define FORB_METHOD_INDEX(m) (m ## __method_index)
  79
  80 /**
  81  * Internal data of every FORB instance.
  82  *
  83  */
  84 typedef struct forb {
  85         forb_server_id server_id;
  86         char server_id_str[sizeof(forb_server_id)*2+1]; /**< Server ID string - for easier debuggin messages */
  87
  88         fosa_mutex_t request_id_mutex;  /**< Mutex for request_id */
  89         CORBA_long request_id;  /**< Value of next sent request_id */
  90
  91         fosa_mutex_t objkey_mutex; /**< Mutex for objkey and objects */
  92         forb_object_key objkey; /**< Objkey value of last created object  */
  93         gavl_cust_root_field_t objects; /**< Tree of objects registered with this FORB. */
  94
  95         //forb_rt rt;           /**< Routing table */
  96         //gavl_cust_root_field_t types;
  97
  98         fosa_mutex_t request_mutex; /**< Mutex for requests */
  99         gavl_cust_root_field_t requests; /**< Container for ::forb_request_t */
 100
 101         fosa_mutex_t port_mutex;
 102         ul_list_head_t ports;   /**< Container for ::forb_port_t */
 103
 104         fosa_mutex_t peer_mutex; /**< Mutex for @a peers */
 105         gavl_cust_root_field_t peers; /**< Container for ::forb_peer_t */
 106
 107         fosa_mutex_t regref_mutex;
 108         gavl_cust_root_field_t regrefs; /**< Container for ::forb_regref_t */
 109
 110         fosa_thread_id_t execution_thread; /**< Thread which executes remote requests for this forb::orb interface. */
 111 } forb_t;
 112
 113 typedef void (*forb_skel_func)(CDR_Codec *cin,
 114                                CDR_Codec *cout,
 115                                struct forb_object *obj,
 116                                struct forb_env *env);
 117
 118
 119 int
 120 forb_init_tmp_dir(void);
 121
 122 void
 123 forb_server_id_init(forb_server_id *serer);
 124
 125 /**
 126  * Compares to server IDs.
 127  *
 128  * @param id1
 129  * @param id2
 130  *
 131  * @return -1, 0 or 1 if the @a id1 is less, equal on greated to @a id2 respectively.
 132  */
 133 static inline int forb_server_id_cmp(const forb_server_id *id1, const forb_server_id *id2)
 134 {
 135         return memcmp(id1, id2, sizeof(forb_server_id));
 136 }
 137
 138 /**
 139  * Converts a server ID to string.
 140  *
 141  * @param dest Where to store the converted string.
 142  * @param server_id Server ID to convert.
 143  * @param n The size of @a dest memory buffer.
 144  *
 145  * @return Same value as @a dest.
 146  */
 147 static inline char *
 148 forb_server_id_to_string(char *dest, const forb_server_id *server_id, size_t n)
 149 {
 150         return forb_uuid_to_string(dest, (forb_uuid_t*)server_id->uuid, n);
 151 }
 152
 153 /**
 154  * Initializes server ID from string.
 155  *
 156  * @param server_id Initialized server ID.
 157  * @param string String form of server ID.
 158  *
 159  * @return Same value as @a server_id.
 160  */
 161 static inline forb_server_id *
 162 forb_server_id_from_string(forb_server_id *server_id, const char *string)
 163 {
 164         return (forb_server_id *)forb_uuid_from_string((forb_uuid_t*)&server_id->uuid, string);
 165 }
 166
 167 #endif