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         forb->orb = orb;
 195
 196         /* Insert our object reference to objects tree, so that we
 197          * can accept remote request to our new ORB. */
 198         forb_objects_nolock_insert(forb, orb);
 199
 200         ret = fosa_thread_create(&forb->execution_thread, NULL,
 201                                  forb_execution_thread, orb);
 202         if (ret != 0)
 203                 goto err2;
 204
 205         on_exit(destroy_forb_on_exit, orb);
 206
 207 #ifdef CONFIG_FORB_PROTO_UNIX
 208         {
 209                 forb_port_t *port = forb_malloc(sizeof(*port));
 210                 if (port) {
 211                         memset(port, 0, sizeof(*port));
 212                         forb_unix_port_init(&port->desc, &forb->server_id);
 213                         forb_register_port(forb, port);
 214                 }
 215         }
 216 #endif
 217         return orb;
 218
 219 err2:   forb_free(forb);
 220 err:    return NULL;
 221 }
 222
 223 /* FIXME: forb_destroy is now called automatically on exit. Therefore
 224  * forb_destroy() should be either static or should deregister on_exit
 225  * handler (how???).  */
 226 void forb_destroy(forb_orb orb)
 227 {
 228         forb_t *forb = forb_object_to_forb(orb);
 229         forb_port_t *port;
 230         forb_regref_t *regref;
 231
 232         pthread_cancel(forb->execution_thread.pthread_id);
 233         pthread_join(forb->execution_thread.pthread_id, NULL);
 234
 235         /* Unregister all registered references */
 236         while ((regref = forb_regref_first(forb))) {
 237                 forb_unregister_reference(orb, regref->name.str);
 238         }
 239
 240         ul_list_for_each_cut(forb_port, forb, port) {
 241                 forb_destroy_port(port);
 242         }
 243         forb_object_release(orb);
 244         forb_free(forb);
 245 }
 246
 247 /* void */
 248 /* forb_register_interface(const struct forb_interface *interface) */
 249 /* { */
 250 /*      gavl_insert(&type_registry, &interface->node); */
 251 /* } */
 252
 253 /**
 254  * Initializes server ID variable.
 255  *
 256  * @param server_id Serer ID to initialize.
 257  */
 258 void
 259 forb_server_id_init(forb_server_id *server_id)
 260 {
 261         forb_uuid_generate((forb_uuid_t*)server_id->uuid);
 262 }
 263
 264 /**
 265  * Checks whether the @a object is stale. Stale object is an object
 266  * reference whose server cannot be contacted to handle requests.
 267  *
 268  * @param object Object reference to check.
 269  *
 270  * @return True if the object is stale, false otherwise.
 271  */
 272 bool forb_object_is_stale(forb_object object)
 273 {
 274         forb_orb remote_orb;
 275         struct forb_env env;
 276         bool stale = true;
 277
 278         remote_orb = forb_get_orb_of(object);
 279         if (!remote_orb) {      /* This shohuld never happen */
 280                 goto err;
 281         }
 282         /* TODO: Check not only the ORB, but also whether the object
 283          * is still registered with the remote orb. */
 284         forb_orb_is_alive(remote_orb, &env);
 285         if (env.major == FORB_EX_COMM_FAILURE) {
 286                 /* Orb is not alive */
 287                 stale = true;
 288         } else {
 289                 if (forb_exception_occurred(&env)) {
 290                         ul_logerr("%s: unexpected exception: %s\n", __FUNCTION__, forb_strerror(&env));
 291                 }
 292                 stale = false;
 293         }
 294
 295         forb_object_release(remote_orb);
 296 err:
 297         return stale;
 298 }
 299
 300 /**
 301  *
 302  *
 303  * @param fd
 304  * @param objref
 305  *
 306  * @return Zero on success, -1 on error.
 307  */
 308 static int
 309 rewrite_regref(int fd, const char *objref)
 310 {
 311         int ret;
 312         int len = strlen(objref);
 313         lseek(fd, 0, SEEK_SET);
 314         ftruncate(fd, 0);
 315
 316         while (len > 0) {
 317                 ret = write(fd, objref, len);
 318                 if (ret < 0) goto out;
 319                 len -= ret;
 320                 objref += ret;
 321         }
 322         ret = 0;        /* Success */
 323 out:
 324         return ret;
 325 }
 326
 327 /**
 328  *
 329  *
 330  * @param orb
 331  * @param fn File name
 332  * @param objref string form of the object reference
 333  *
 334  * @return -1 on error, 0 if reference was replaced and 1 in the
 335  * reference is valid.
 336  */
 337 static int
 338 replace_regref_if_stale(forb_orb orb, const char *fn, const char *objref)
 339 {
 340         int fd, ret = 0;
 341         char str[100];
 342         forb_object object;
 343
 344         fd = open(fn, O_RDWR);
 345         if (fd < 0) {
 346                 ret = -1;
 347                 goto out;
 348         }
 349         ret = lockf(fd, F_LOCK, 0);
 350         if (ret < 0) goto close_err;
 351         ret = read(fd, str, sizeof(str)-1);
 352         if (ret < 0) goto unlock_err;
 353         /* TODO: Check that we have read the whole file */
 354
 355         str[ret] = '\0';
 356         object = forb_string_to_object(orb, str);
 357         if (!object) {
 358                 /* reference is unreadable, so we can replace it */
 359                 ret = rewrite_regref(fd, objref);
 360                 /* We are done for now */
 361                 goto unlock_err;
 362         }
 363         if (forb_object_is_stale(object)) {
 364                 /* Orb is not alive */
 365                 ret = rewrite_regref(fd, objref);
 366         } else {
 367                 /* Reference's FORB is alive :-( */
 368                 ret = 1;
 369         }
 370
 371         forb_object_release(object);
 372 unlock_err:
 373         lockf(fd, F_ULOCK, 0);
 374 close_err:
 375         close(fd);
 376 out:
 377         return ret;
 378 }
 379
 380
 381 /**
 382  * Registers a given object reference so that other FORBs on the same
 383  * node can find it by using forb_resolve_reference().
 384  *
 385  * @param object Object reference to register.
 386  * @param name Name under which to register the reference.
 387  *
 388  * @return Zero on success, -1 on error.
 389  */
 390 int
 391 forb_register_reference(forb_object object, const char *name)
 392 {
 393         forb_regref_t *regref;
 394         forb_regref_name_t regname;
 395         forb_t *forb = forb_object_to_forb(object);
 396         char fn[100], fntmp[100];
 397         char *objref;
 398         FILE *f;
 399         int ret;
 400
 401         strncpy(regname.str, name, FORB_REGREF_NAME_LEN-1);
 402         regname.str[FORB_REGREF_NAME_LEN-1]='\0';
 403
 404         regref = forb_regref_new(object, regname);
 405         if (!regref) goto err;
 406
 407         forb_regref_insert(forb, regref);
 408
 409         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname.str);
 410         snprintf(fntmp, sizeof(fntmp), FORB_TMP_DIR "/%s.%s", regname.str,
 411                  forb->server_id_str);
 412
 413         f = fopen(fntmp, "w");
 414         if (!f) goto unalloc_err;
 415
 416         objref = forb_object_to_string(object);
 417         if (!objref) goto unlink_err;
 418
 419         ret = fprintf(f, "%s", objref);
 420         if (ret < 0) goto free_objref_err;
 421
 422         ret = fclose(f);
 423         if (ret == EOF) goto free_objref_err;
 424
 425         /* Make the atomic registration in filesystem */
 426         ret = link(fntmp, fn);
 427
 428         if (ret < 0 && errno == EEXIST) {
 429                 /* The reference exists. Try whether it is still
 430                  * active. */
 431                 if (replace_regref_if_stale(object->orb, fn, objref) != 0) {
 432                         goto free_objref_err;
 433                 }
 434                 ul_logdeb("Stale registration replaced\n");
 435         } else if (ret < 0) {
 436                 goto free_objref_err;
 437         }
 438
 439         forb_free(objref);
 440
 441         /* Unlink the temporary filename */
 442         unlink(fntmp);
 443
 444         return 0;
 445 free_objref_err:
 446         ret = errno;
 447         forb_free(objref);
 448         errno = ret;
 449 unlink_err:
 450         ret = errno;
 451         unlink(fntmp);
 452         errno = ret;
 453 unalloc_err:
 454         ret = errno;
 455         forb_regref_delete(forb, regref);
 456         forb_regref_release(regref);
 457         errno = ret;
 458 err:
 459         return -1;
 460 }
 461
 462 /**
 463  * Unregister reference previously registered by
 464  * forb_register_reference().
 465  *
 466  * @param orb forb::orb reference
 467  * @param name Name to unregister.
 468  *
 469  * @return Zero on success, -1 on error.
 470  */
 471 int
 472 forb_unregister_reference(forb_orb orb, const char *name)
 473 {
 474         forb_regref_t *regref;
 475         forb_regref_name_t regname;
 476         forb_t *forb = forb_object_to_forb(orb);
 477         char fn[100];
 478
 479         strncpy(regname.str, name, FORB_REGREF_NAME_LEN-1);
 480         regname.str[FORB_REGREF_NAME_LEN-1]='\0';
 481
 482         regref = forb_regref_find(forb, &regname);
 483         if (!regref) goto err;
 484
 485         forb_regref_delete(forb, regref);
 486         forb_regref_release(regref);
 487
 488         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname.str);
 489         return unlink(fn);
 490
 491         return 0;
 492 err:
 493         return -1;
 494 }
 495
 496 /**
 497  * Returns a named reference previously registered by
 498  * forb_register_reference(). This function can be called event if the
 499  * reference was registered in a diferent process (but on the same
 500  * node).
 501  *
 502  * @param orb Local orb object reference
 503  * @param name Name under which the reference was registered.
 504  *
 505  * @return Object reference on NULL in case of error.
 506  */
 507 forb_object
 508 forb_resolve_reference(const forb_orb orb, const char *name)
 509 {
 510         forb_regref_name_t regname;
 511         char fn[100];
 512         char str[100];
 513         int fd, ret;
 514         forb_object object;
 515
 516         strncpy(regname.str, name, FORB_REGREF_NAME_LEN-1);
 517         regname.str[FORB_REGREF_NAME_LEN-1]='\0';
 518
 519         snprintf(fn,    sizeof(fn),    FORB_TMP_DIR "/%s",    regname.str);
 520
 521         fd = open(fn, 0);
 522         if (fd < 0) {
 523                 return NULL;
 524         }
 525         ret = read(fd, str, sizeof(str)-1);
 526         /* TODO: Check that we have read the whole file */
 527         str[ret] = '\0';
 528         object = forb_string_to_object(orb, str);
 529         close(fd);
 530
 531         if (forb_object_is_stale(object)) {
 532                 forb_object_release(object);
 533                 object = NULL;
 534         }
 535
 536         return object;
 537 }
 538
 539 /**
 540  * Returns object reference of forb::orb object associated with a
 541  * given object.
 542  *
 543  * @param obj
 544  *
 545  * @return
 546  */
 547 forb_orb
 548 forb_get_orb_of(const forb_object obj)
 549 {
 550         forb_orb orb;
 551
 552         if (forb_server_id_cmp(&obj->server, &obj->orb->server) == 0) {
 553                 orb = forb_object_duplicate(obj->orb);
 554         } else {
 555                 orb = forb_object_new(obj->orb, &obj->server, 0);
 556         }
 557         return orb;
 558 }
 559
 560 /**
 561  * Returns server ID of an object reference.
 562  *
 563  * @param obj
 564  * @param dest
 565  */
 566 void
 567 forb_get_server_id(const forb_object obj, forb_server_id *dest)
 568 {
 569         if (obj) {
 570                 *dest = obj->server;
 571         }
 572 }
 573
 574
 575 /**
 576  * Return instance data registered when the object was created by
 577  * forb_XXX_new().
 578  *
 579  * @param obj Object reference
 580  *
 581  * @return Pointer to the registered data.
 582  */
 583 void *
 584 forb_instance_data(const forb_object obj)
 585 {
 586         return forb_object_instance_data(obj);
 587 }
 588
 589 /**
 590  * Returns error message correspondings FORB exception.
 591  *
 592  * @param env Environemnt
 593  *
 594  * @return Non-NULL pointer to a string.
 595  */
 596 const char *
 597 forb_strerror(CORBA_Environment *env)
 598 {
 599         if (!env) {
 600                 return "Invalid environemnt";
 601         }
 602 #define ex(e) case FORB_EX_##e: return #e; break;
 603         switch (env->major) {
 604         ex(NONE);
 605         ex(UNKNOWN);
 606         ex(BAD_PARAM);
 607         ex(NO_MEMORY);
 608         ex(IMP_LIMIT);
 609         ex(COMM_FAILURE);
 610         ex(INV_OBJREF);
 611         ex(NO_PERMISSION);
 612         ex(INTERNAL);
 613         ex(MARSHAL);
 614         ex(INITIALIZE);
 615         ex(NO_IMPLEMENT);
 616         ex(BAD_OPERATION);
 617         ex(NO_RESOURCES);
 618         ex(NO_RESPONSE);
 619         ex(TRANSIENT);
 620         ex(FREE_MEM);
 621         ex(INV_IDENT);
 622         ex(INV_FLAG);
 623         ex(DATA_CONVERSION);
 624         ex(OBJECT_NOT_EXIST);
 625         ex(TIMEOUT);
 626         ex(APPLICATION);
 627         }
 628 #undef ex
 629         return "Invalid error number";
 630 }
 631
 632 /**
 633  * Return server id of the requesting application.
 634  *
 635  * This function should be only called from within interface
 636  * implementation,
 637  *
 638  * @param[in] obj Object being requested
 639  * @param[out] req_source Server ID of the requesting application
 640  */
 641 void
 642 forb_get_req_source(const forb_object obj, forb_server_id *req_source)
 643 {
 644         if (req_source) {
 645                 if (obj && obj->exec_req) {
 646                         *req_source = obj->exec_req->source;
 647                 } else {
 648                         memset(req_source, 0, sizeof(*req_source));
 649                 }
 650         }
 651 }