src/forb.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   forb.c
  49  * @author Michal Sojka <sojkam1@fel.cvut.cz>
  50  * @date   Sun Oct 12 16:57:01 2008
  51  *
  52  * @brief  Implementation of basic FORB's functions.
  53  *
  54  *
  55  */
  56
  57 #define _BSD_SOURCE             /* Because of on_exit()  */
  58 #include "proto.h"
  59 #include "regref.h"
  60 #include "regref.h"
  61 #include <fcntl.h>
  62 #include <forb/config.h>
  63 #include <forb/forb-internal.h>
  64 #include <forb.h>
  65 #include "forb-idl.h"
  66 #include <forb/iop.h>
  67 #include <forb/object.h>
  68 #include <forb/uuid.h>
  69 #include <stdio.h>
  70 #include <stdlib.h>
  71 #include <string.h>
  72 #include <sys/stat.h>
  73 #include <sys/types.h>
  74 #include <ul_gavlcust.h>
  75 #include <ul_log.h>
  76 #include <ul_logreg.h>
  77 #include <unistd.h>
  78 #ifdef CONFIG_FORB_PROTO_UNIX
  79 #include <forb/proto_unix.h>
  80 #endif
  81
  82 #ifdef DEBUG
  83 #define UL_LOGL_DEF UL_LOGL_DEB
  84 #else
  85 #define UL_LOGL_DEF UL_LOGL_ERR
  86 #endif
  87 #include "log_domains.inc"
  88
  89 extern UL_LOG_CUST(ulogd_forb);
  90
  91
  92 static void
  93 destroy_forb_on_exit(int exitcode, void *arg)
  94 {
  95         forb_orb orb = arg;
  96         forb_destroy(orb);
  97 }
  98
  99 static void
 100 forb_is_alive(forb_orb _obj, CORBA_Environment *ev)
 101 {
 102         ul_logdeb("%s called\n", __FUNCTION__);
 103 }
 104
 105 static struct forb_forb_orb_impl forb_implementation = {
 106         .is_alive = forb_is_alive,
 107 };
 108
 109 /**
 110  * Prepares #FORB_TMP_DIR directory for use by forb
 111  *
 112  * @return Zero on succes, -1 on error and errno is set appropriately.
 113  */
 114 int
 115 forb_init_tmp_dir(void)
 116 {
 117         struct stat st;
 118         int ret;
 119
 120         ret = stat(FORB_TMP_DIR, &st);
 121
 122         if (ret == 0 && !S_ISDIR(st.st_mode)) {
 123                 ret = unlink(FORB_TMP_DIR);
 124                 if (ret) return -1;
 125         } else if (ret == 0) {
 126                 return 0;
 127         }
 128         return mkdir(FORB_TMP_DIR, 0777);
 129 }
 130
 131 /**
 132  * Thread for execution of remote requests for a FORB object.
 133  *
 134  * @param arg
 135  *
 136  * @return
 137  */
 138 static void *
 139 forb_execution_thread(void *arg)
 140 {
 141         forb_orb orb = arg;
 142
 143         forb_execute_object(orb);
 144         return NULL;
 145 }
 146
 147 forb_orb
 148 forb_init(int *argc, char **argv[], const char *orb_id)
 149 {
 150         forb_orb orb;
 151         forb_t *forb;
 152         int ret;
 153
 154         forb = forb_malloc(sizeof(*forb));
 155         if (!forb) goto err;
 156         memset(forb, 0, sizeof(*forb));
 157
 158         /* Initialize ULUT logging facility */
 159         ul_logreg_domains_static(ul_log_domains_array,
 160                                  sizeof(ul_log_domains_array)/sizeof(ul_log_domains_array[0]));
 161
 162         forb_server_id_init(&forb->server_id);
 163         forb_server_id_to_string(forb->server_id_str, &forb->server_id,
 164                                  sizeof(forb->server_id_str));
 165         ul_logdeb("Initializing forb %s\n", forb->server_id_str);
 166
 167         if (fosa_mutex_init(&forb->request_id_mutex, 0) != 0) goto err2;
 168         if (fosa_mutex_init(&forb->port_mutex, 0) != 0) goto err2;
 169         forb_port_init_head(forb);
 170
 171         if (fosa_mutex_init(&forb->request_mutex, 0) != 0) goto err2;
 172         forb_request_nolock_init_root_field(forb);
 173
 174         if (fosa_mutex_init(&forb->peer_mutex, 0) != 0) goto err2;
 175         forb_peer_nolock_init_root_field(forb);
 176
 177         if (fosa_mutex_init(&forb->objkey_mutex, 0) != 0) goto err2;
 178         forb_objects_nolock_init_root_field(forb);
 179
 180         if (fosa_mutex_init(&forb->regref_mutex, 0) != 0) goto err2;
 181         forb_regref_nolock_init_root_field(forb);
 182
 183         ret = forb_init_tmp_dir();
 184         if (ret != 0) {
 185                 ul_logerr("Cannot prepare " FORB_TMP_DIR "\n");
 186                 return NULL;
 187         }
 188
 189         orb = forb_forb_orb_new(NULL, &forb_implementation, forb);
 190         if (!orb) goto err2;
 191         /* Server ID must be assigned manualy */
 192         orb->server = forb->server_id;
 193
 194         /* Insert our object reference to objects tree, so that we
 195          * can accept remote request to our new ORB. */
 196         forb_objects_nolock_insert(forb, orb);
 197
 198         ret = fosa_thread_create(&forb->execution_thread, NULL,
 199                                  forb_execution_thread, orb);
 200         if (ret != 0)
 201                 goto err2;
 202
 203         on_exit(destroy_forb_on_exit, orb);
 204
 205 #ifdef CONFIG_FORB_PROTO_UNIX
 206         {
 207                 forb_port_t *port = forb_malloc(sizeof(*port));
 208                 if (port) {
 209                         forb_unix_port_init(port, &forb->server_id);
 210                         forb_register_port(forb, port);
 211                 }
 212         }
 213 #endif
 214         return orb;
 215
 216 err2:   forb_free(forb);
 217 err:    return NULL;
 218 }
 219
 220 /* FIXME: forb_destroy is now called automatically on exit. Therefore
 221  * forb_destroy() should be either static or should deregister on_exit
 222  * handler (how???).  */
 223 void forb_destroy(forb_orb orb)
 224 {
 225         forb_t *forb = forb_object_to_forb(orb);
 226         forb_port_t *port;
 227         forb_regref_t *regref;
 228
 229         pthread_cancel(forb->execution_thread.pthread_id);
 230         pthread_join(forb->execution_thread.pthread_id, NULL);
 231
 232         /* Unregister all registered references */
 233         while ((regref = forb_regref_first(forb))) {
 234                 forb_unregister_reference(orb, regref->name);
 235         }
 236
 237         ul_list_for_each_cut(forb_port, forb, port) {
 238                 forb_destroy_port(port);
 239         }
 240         forb_object_release(orb);
 241         forb_free(forb);
 242 }
 243
 244 /* void */
 245 /* forb_register_interface(const struct forb_interface *interface) */
 246 /* { */
 247 /*      gavl_insert(&type_registry, &interface->node); */
 248 /* } */
 249 /**
 250  * Initializes server ID variable.
 251  *
 252  * @param server_id Serer ID to initialize.
 253  */
 254 void
 255 forb_server_id_init(forb_server_id *server_id)
 256 {
 257         forb_uuid_generate((forb_uuid_t*)server_id->uuid);
 258 }
 259
 260 void *
 261 forb_instance_data(const forb_object obj)
 262 {
 263         return forb_object_instance_data(obj);
 264 }
 265
 266
 267 /**
 268  * Registers a given object reference so that other FORBs on the same
 269  * node can find it by using forb_resolve_reference().
 270  *
 271  * @param object Object reference to register.
 272  * @param name Name under which to register the reference.
 273  *
 274  * @return Zero on success, -1 on error.
 275  */
 276 int
 277 forb_register_reference(forb_object object, const char *name)
 278 {
 279         forb_regref_t *regref;
 280         forb_regref_name_t regname;
 281         forb_t *forb = forb_object_to_forb(object);
 282         char fn[100], fntmp[100];
 283         char *objref;
 284         FILE *f;
 285         int ret;
 286
 287         strncpy(regname, name, FORB_REGREF_NAME_LEN-1);
 288         regname[FORB_REGREF_NAME_LEN-1]='\0';
 289
 290         regref = forb_regref_new(object, regname);
 291         if (!regref) goto err;
 292
 293         forb_regref_insert(forb, regref);
 294
 295         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname);
 296         snprintf(fntmp, sizeof(fntmp), FORB_TMP_DIR "/%s.%s", regname,
 297                  forb->server_id_str);
 298
 299         f = fopen(fntmp, "w");
 300         if (!f) goto unalloc_err;
 301
 302         objref = forb_object_to_string(object);
 303         if (!objref) goto unalloc_err;
 304
 305         ret = fprintf(f, "%s", objref);
 306         forb_free(objref);
 307         if (ret < 0) goto unalloc_err;
 308
 309         ret = fclose(f);
 310         if (ret == EOF) goto unalloc_err;
 311
 312         /* Make the atomic registration in filesystem */
 313         ret = link(fntmp, fn);
 314         if (ret < 0) {
 315                 /* TODO: If the reference exists, try whether it is
 316                  * still active. */
 317                 goto unlink_err;
 318         }
 319
 320         /* Unlink the temporary filename */
 321         unlink(fntmp);
 322
 323         return 0;
 324 unlink_err:
 325         ret = errno;
 326         unlink(fntmp);
 327         errno = ret;
 328 unalloc_err:
 329         ret = errno;
 330         forb_regref_delete(forb, regref);
 331         forb_regref_release(regref);
 332         errno = ret;
 333 err:
 334         return -1;
 335 }
 336
 337 int
 338 forb_unregister_reference(forb_orb orb, const char *name)
 339 {
 340         forb_regref_t *regref;
 341         forb_regref_name_t regname;
 342         forb_t *forb = forb_object_to_forb(orb);
 343         char fn[100];
 344
 345         strncpy(regname, name, FORB_REGREF_NAME_LEN-1);
 346         regname[FORB_REGREF_NAME_LEN-1]='\0';
 347
 348         regref = forb_regref_find(forb, &regname);
 349         if (!regref) goto err;
 350
 351         forb_regref_delete(forb, regref);
 352         forb_regref_release(regref);
 353
 354         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname);
 355         return unlink(fn);
 356
 357         return 0;
 358 err:
 359         return -1;
 360 }
 361
 362 /**
 363  * Returns a named reference previously registered by
 364  * forb_register_reference(). This function can be called event if the
 365  * reference was registered in a diferent process (but on the same
 366  * node).
 367  *
 368  * @param orb Local orb object reference
 369  * @param name Name under which the reference was registered.
 370  *
 371  * @return Object reference on NULL in case of error.
 372  */
 373 forb_object
 374 forb_resolve_reference(const forb_orb orb, const char *name)
 375 {
 376         forb_regref_name_t regname;
 377         char fn[100];
 378         char str[100];
 379         int fd;
 380         forb_object object;
 381
 382         strncpy(regname, name, FORB_REGREF_NAME_LEN-1);
 383         regname[FORB_REGREF_NAME_LEN-1]='\0';
 384
 385         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname);
 386
 387         fd = open(fn, 0);
 388         if (fd < 0) {
 389                 return NULL;
 390         }
 391         read(fd, str, sizeof(str)-1);
 392         str[sizeof(str)-1] = '\0';
 393         object = forb_string_to_object(orb, str);
 394         close(fd);
 395
 396         return object;
 397 }
 398
 399 /**
 400  * Returns object reference of forb::orb object associated with a
 401  * given object.
 402  *
 403  * @param obj
 404  *
 405  * @return
 406  */
 407 forb_orb
 408 forb_get_orb_of(const forb_object obj)
 409 {
 410         forb_orb orb;
 411
 412         if (forb_server_id_cmp(&obj->server, &obj->orb->server) == 0) {
 413                 orb = forb_object_duplicate(orb);
 414         } else {
 415                 orb = forb_object_new(obj->orb, &obj->server, 0);
 416         }
 417         return orb;
 418 }
 419
 420 /**
 421  * Return instance data registered when the object was created by
 422  * forb_XXX_new().
 423  *
 424  * @param obj Object reference
 425  *
 426  * @return Pointer to the registered data.
 427  */
 428 void *
 429 forb_instance_data(const forb_object obj)
 430 {
 431         return forb_object_instance_data(obj);
 432 }
 433
 434 /**
 435  * Returns error message correspondings FORB exception.
 436  *
 437  * @param env Environemnt
 438  *
 439  * @return Non-NULL pointer to a string.
 440  */
 441 const char *
 442 forb_strerror(CORBA_Environment *env)
 443 {
 444         if (!env) {
 445                 return "Invalid environemnt";
 446         }
 447 #define ex(e) case FORB_EX_##e: return #e; break;
 448         switch (env->major) {
 449         ex(NONE);
 450         ex(UNKNOWN);
 451         ex(BAD_PARAM);
 452         ex(NO_MEMORY);
 453         ex(IMP_LIMIT);
 454         ex(COMM_FAILURE);
 455         ex(INV_OBJREF);
 456         ex(NO_PERMISSION);
 457         ex(INTERNAL);
 458         ex(MARSHAL);
 459         ex(INITIALIZE);
 460         ex(NO_IMPLEMENT);
 461         ex(BAD_OPERATION);
 462         ex(NO_RESOURCES);
 463         ex(NO_RESPONSE);
 464         ex(TRANSIENT);
 465         ex(FREE_MEM);
 466         ex(INV_IDENT);
 467         ex(INV_FLAG);
 468         ex(DATA_CONVERSION);
 469         ex(OBJECT_NOT_EXIST);
 470         ex(TIMEOUT);
 471         }
 472 #undef ex
 473         return "Invalid error number";
 474 }