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 #ifndef _BSD_SOURCE
  58 #define _BSD_SOURCE             /* Because of on_exit()  */
  59 #endif
  60 #include "proto.h"
  61 #include "regref.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 <string.h>
  71 #include <sys/stat.h>
  72 #include <sys/types.h>
  73 #include <ul_gavlcust.h>
  74 #include <ul_log.h>
  75 #include <ul_logreg.h>
  76 #include <unistd.h>
  77 #include "discovery.h"
  78 #ifdef CONFIG_FORB_PROTO_UNIX
  79 #include <forb/proto_unix.h>
  80 #endif
  81 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
  82 #include <forb/proto_inet.h>
  83 #endif
  84 #ifdef CONFIG_FCB
  85 #include <fcb.h>
  86 #include <fcb_contact_info.h>
  87 #endif
  88 #include <fcntl.h>
  89
  90 #ifdef DEBUG
  91 #define UL_LOGL_DEF UL_LOGL_DEB
  92 #else
  93 #define UL_LOGL_DEF UL_LOGL_ERR
  94 #endif
  95 #include "log_domains.inc"
  96
  97 extern UL_LOG_CUST(ulogd_forb);
  98 static int init_ul_log(void);
  99
 100 UL_LOGREG_DOMAINS_INIT_FUNCTION(forb_logreg_domains, forb_logreg_domains_array);
 101
 102 #if 0
 103 static void
 104 destroy_forb_on_exit(int exitcode, void *arg)
 105 {
 106         forb_orb orb = arg;
 107         forb_destroy(orb);
 108 }
 109 #endif
 110
 111 static void
 112 forb_is_alive(forb_orb _obj, CORBA_Environment *ev)
 113 {
 114         ul_logdeb("%s called\n", __FUNCTION__);
 115 }
 116
 117 static struct forb_forb_orb_impl forb_implementation = {
 118         .is_alive = forb_is_alive,
 119 };
 120
 121 /**
 122  * Prepares #FORB_TMP_DIR directory for use by forb
 123  *
 124  * @return Zero on succes, -1 on error and errno is set appropriately.
 125  */
 126 int
 127 forb_init_tmp_dir(void)
 128 {
 129         struct stat st;
 130         int ret;
 131
 132         ret = stat(FORB_TMP_DIR, &st);
 133
 134         if (ret == 0 && !S_ISDIR(st.st_mode)) {
 135                 ret = unlink(FORB_TMP_DIR);
 136                 if (ret) return -1;
 137         } else if (ret == 0) {
 138                 return 0;
 139         }
 140         return mkdir(FORB_TMP_DIR, 0777);
 141 }
 142
 143 /**
 144  * Thread for execution of remote requests for a FORB object.
 145  *
 146  * @param arg
 147  *
 148  * @return
 149  */
 150 static void *
 151 forb_execution_thread(void *arg)
 152 {
 153         forb_orb orb = arg;
 154
 155         forb_execute_object(orb);
 156         return NULL;
 157 }
 158
 159 #ifdef CONFIG_FCB
 160 void hack_register_fcb(forb_orb orb, forb_port_t *port)
 161 {
 162         forb_object fcb = forb_object_new(orb, &FCB_SERVER_ID, 1);
 163         if (!fcb) {
 164                 ul_logerr("Cannot allocate FCB reference\n");
 165                 return;
 166         }
 167         forb_register_reference(fcb, fres_contract_broker_reg_name);
 168         forb_object_release(fcb);
 169 }
 170 #else
 171 #define hack_register_fcb(orb)
 172 #endif
 173
 174
 175
 176 forb_orb
 177 forb_init(int *argc, char **argv[], const struct forb_init_attr *attr)
 178 {
 179         forb_orb orb;
 180         forb_t *forb;
 181         int ret;
 182
 183         forb = forb_malloc(sizeof(*forb));
 184         if (!forb) goto err;
 185         memset(forb, 0, sizeof(*forb));
 186
 187         /* Initialize ULUT logging facility */
 188         init_ul_log();
 189         forb_logreg_domains();
 190
 191         if (attr) {
 192                 forb->attr = *attr;
 193         } else {
 194                 memset(&forb->attr, 0, sizeof(forb->attr));
 195         }
 196
 197         sem_init(&forb->server_ready, 0, 0);
 198
 199         if (forb_server_id_empty(&forb->attr.fixed_server_id)) {
 200                 forb_server_id_init(&forb->server_id);
 201         } else {
 202                 forb->server_id = forb->attr.fixed_server_id;
 203         }
 204         forb_server_id_to_string(forb->server_id_str, &forb->server_id,
 205                                  sizeof(forb->server_id_str));
 206         ul_logdeb("Initializing forb %s\n", forb->server_id_str);
 207
 208         if (fosa_mutex_init(&forb->request_id_mutex, 0) != 0) goto err2;
 209         if (fosa_mutex_init(&forb->port_mutex, 0) != 0) goto err2;
 210         forb_port_init_head(forb);
 211
 212         if (fosa_mutex_init(&forb->request_mutex, 0) != 0) goto err2;
 213         forb_request_nolock_init_root_field(forb);
 214
 215         if (forb_discovery_init(forb) != 0) goto err2;
 216
 217         if (fosa_mutex_init(&forb->regref_mutex, 0) != 0) goto err2;
 218         forb_regref_nolock_init_root_field(forb);
 219
 220         ret = forb_init_tmp_dir();
 221         if (ret != 0) {
 222                 ul_logerr("Cannot prepare " FORB_TMP_DIR "\n");
 223                 return NULL;
 224         }
 225
 226         forb_executor_prepare();
 227
 228         orb = forb_forb_orb_new(NULL, &forb_implementation, forb);
 229         if (!orb) goto err2;
 230         /* Server ID must be assigned manualy */
 231         orb->server = forb->server_id;
 232
 233         forb->orb = orb;
 234
 235         /* Insert our object reference to objects tree, so that we
 236          * can accept remote request to our new ORB. */
 237         forb_objects_nolock_insert(forb, orb);
 238
 239         ret = fosa_thread_create(&forb->execution_thread, NULL,
 240                                  forb_execution_thread, orb);
 241         if (ret != 0)
 242                 goto err2;
 243
 244         /* FIXME: I do not know how to deregister the exit handler if
 245          * forb_destroy() is called manually. */
 246         /* on_exit(destroy_forb_on_exit, orb); */
 247
 248 #ifdef CONFIG_FORB_PROTO_UNIX
 249         {
 250                 forb_port_t *port = forb_malloc(sizeof(*port));
 251                 if (port) {
 252                         memset(port, 0, sizeof(*port));
 253                         ret = forb_unix_port_init(&port->desc, &forb->server_id);
 254                         if (ret) goto err_free_unix;
 255                         ret = forb_register_port(orb, port);
 256                         if (ret) goto err_free_unix; /* TODO: forb_unix_port_done() */
 257                         goto unix_ok;
 258                 }
 259         err_free_unix:
 260                 free(port);
 261                 goto err2;
 262         unix_ok:;
 263         }
 264 #endif
 265 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
 266         {
 267                 forb_port_t *port = forb_malloc(sizeof(*port));
 268                 if (port) {
 269                         struct in_addr listen_on;
 270
 271                         memset(port, 0, sizeof(*port));
 272                         listen_on.s_addr = INADDR_ANY;
 273                         ret = forb_inet_port_init(&port->desc, listen_on,
 274                                                   forb->attr.fixed_tcp_port);
 275                         if (ret) goto err_free_inet;
 276                         ret = forb_register_port(orb, port);
 277                         if (ret) goto err_free_inet; /* TODO: forb_inet_port_done() */
 278                         goto inet_ok;
 279                 }
 280         err_free_inet:
 281                 free(port);
 282                 goto err2;
 283         inet_ok:;
 284                 hack_register_fcb(orb, port);
 285         }
 286 #endif
 287         return orb;
 288
 289 err2:   forb_free(forb);
 290 err:    return NULL;
 291 }
 292
 293 void forb_destroy(forb_orb orb)
 294 {
 295         forb_t *forb = forb_object_to_forb(orb);
 296         forb_port_t *port;
 297         forb_regref_t *regref;
 298
 299         pthread_cancel(forb->execution_thread.pthread_id);
 300         pthread_join(forb->execution_thread.pthread_id, NULL);
 301
 302         /* Unregister all registered references */
 303         while ((regref = forb_regref_first(forb))) {
 304                 forb_unregister_reference(orb, regref->name.str);
 305         }
 306
 307         ul_list_for_each_cut(forb_port, forb, port) {
 308                 forb_destroy_port(port);
 309         }
 310         forb_object_release(orb);
 311         forb_free(forb);
 312 }
 313
 314 /* void */
 315 /* forb_register_interface(const struct forb_interface *interface) */
 316 /* { */
 317 /*      gavl_insert(&type_registry, &interface->node); */
 318 /* } */
 319
 320 /**
 321  * Initializes server ID variable.
 322  *
 323  * @param server_id Serer ID to initialize.
 324  */
 325 void
 326 forb_server_id_init(forb_server_id *server_id)
 327 {
 328         forb_uuid_generate((forb_uuid_t*)server_id->uuid);
 329 }
 330
 331 /**
 332  * Checks whether the @a object is stale. Stale object is an object
 333  * reference whose server cannot be contacted to handle requests.
 334  *
 335  * @param object Object reference to check.
 336  *
 337  * @return True if the object is stale, false otherwise.
 338  */
 339 bool forb_object_is_stale(forb_object object)
 340 {
 341         forb_orb remote_orb;
 342         struct forb_env env;
 343         bool stale = true;
 344
 345         remote_orb = forb_get_orb_of(object);
 346         if (!remote_orb) {      /* This shohuld never happen */
 347                 goto err;
 348         }
 349         /* TODO: Check not only the ORB, but also whether the object
 350          * is still registered with the remote orb. */
 351         forb_orb_is_alive(remote_orb, &env);
 352         if (env.major == FORB_EX_COMM_FAILURE) {
 353                 /* Orb is not alive */
 354                 stale = true;
 355         } else {
 356                 if (forb_exception_occurred(&env)) {
 357                         ul_logerr("%s: unexpected exception: %s\n", __FUNCTION__, forb_strerror(&env));
 358                 }
 359                 stale = false;
 360         }
 361
 362         forb_object_release(remote_orb);
 363 err:
 364         return stale;
 365 }
 366
 367
 368 /**
 369  * Returns object reference of forb::orb object associated with the
 370  * given object.
 371  *
 372  * @param obj
 373  *
 374  * @return
 375  */
 376 forb_orb
 377 forb_get_orb_of(const forb_object obj)
 378 {
 379         forb_orb orb;
 380
 381         if (forb_server_id_cmp(&obj->server, &obj->orb->server) == 0) {
 382                 orb = forb_object_duplicate(obj->orb);
 383         } else {
 384                 orb = forb_object_new(obj->orb, &obj->server, 0);
 385         }
 386         return orb;
 387 }
 388
 389 /**
 390  * Returns server ID of an object reference.
 391  *
 392  * @param obj
 393  * @param dest
 394  */
 395 void
 396 forb_get_server_id(const forb_object obj, forb_server_id *dest)
 397 {
 398         if (obj) {
 399                 *dest = obj->server;
 400         }
 401 }
 402
 403
 404 /**
 405  * Return instance data registered when the object was created by
 406  * forb_XXX_new().
 407  *
 408  * @param obj Object reference
 409  *
 410  * @return Pointer to the registered data.
 411  */
 412 void *
 413 forb_instance_data(const forb_object obj)
 414 {
 415         return forb_object_instance_data(obj);
 416 }
 417
 418 /**
 419  * Returns error message correspondings FORB exception.
 420  *
 421  * @param env Environemnt
 422  *
 423  * @return Non-NULL pointer to a string.
 424  */
 425 const char *
 426 forb_strerror(CORBA_Environment *env)
 427 {
 428         if (!env) {
 429                 return "Invalid environemnt";
 430         }
 431 #define ex(e) case FORB_EX_##e: return #e; break;
 432         switch (env->major) {
 433         ex(NONE);
 434         ex(UNKNOWN);
 435         ex(BAD_PARAM);
 436         ex(NO_MEMORY);
 437         ex(IMP_LIMIT);
 438         ex(COMM_FAILURE);
 439         ex(INV_OBJREF);
 440         ex(NO_PERMISSION);
 441         ex(INTERNAL);
 442         ex(MARSHAL);
 443         ex(INITIALIZE);
 444         ex(NO_IMPLEMENT);
 445         ex(BAD_OPERATION);
 446         ex(NO_RESOURCES);
 447         ex(NO_RESPONSE);
 448         ex(TRANSIENT);
 449         ex(FREE_MEM);
 450         ex(INV_IDENT);
 451         ex(INV_FLAG);
 452         ex(DATA_CONVERSION);
 453         ex(OBJECT_NOT_EXIST);
 454         ex(TIMEOUT);
 455         ex(APPLICATION);
 456         }
 457 #undef ex
 458         return "Invalid error number";
 459 }
 460
 461 /**
 462  * Return server id of the requesting application.
 463  *
 464  * This function should be only called from within interface
 465  * implementation,
 466  *
 467  * @param[in] obj Object being requested
 468  * @param[out] req_source Server ID of the requesting application
 469  */
 470 void
 471 forb_get_req_source(const forb_object obj, forb_server_id *req_source)
 472 {
 473         if (req_source) {
 474                 if (obj && obj->exec_req) {
 475                         *req_source = obj->exec_req->source;
 476                 } else {
 477                         memset(req_source, 0, sizeof(*req_source));
 478                 }
 479         }
 480 }
 481
 482 /**
 483  * Internal function for allocation of sequence bufers. Used by
 484  * forb_sequence_alloc_buf().
 485  *
 486  * @param seq
 487  * @param seq_size
 488  * @param buf_pptr
 489  * @param maximum_ptr
 490  * @param num_elements
 491  * @param elem_size
 492  *
 493  * @return CORBA_TRUE if the allocation was sucessfull, CORBA_FALSE if
 494  * it wasn't.
 495  */
 496 CORBA_boolean
 497 __forb_sequence_alloc_buf_internal(void *seq, size_t seq_size,
 498                                    void **buf_pptr, CORBA_unsigned_long *maximum_ptr,
 499                                    unsigned num_elements, size_t elem_size)
 500 {
 501         memset(seq, 0, seq_size);
 502         /*(seq)._length = 0;*/
 503         if (num_elements && elem_size) *buf_pptr = forb_malloc(num_elements * elem_size);
 504         else *buf_pptr = NULL;
 505         *maximum_ptr = *buf_pptr ? num_elements : 0;
 506         return (*buf_pptr != NULL) || (num_elements == 0);
 507 }
 508
 509 static FILE *forb_ul_log_file;
 510 static char progname[64] = "";
 511
 512 void
 513 forb_ul_log_fnc(ul_log_domain_t *domain, int level,
 514                 const char *format, va_list ap)
 515 {
 516         struct timespec now;
 517         if(!(level&UL_LOGL_CONT)) {
 518                 level&=UL_LOGL_MASK;
 519                 clock_gettime(CLOCK_MONOTONIC, &now);
 520                 fprintf(forb_ul_log_file,"%ld.%6ld: ", now.tv_sec, now.tv_nsec/1000);
 521                 if (progname[0])
 522                         fprintf(forb_ul_log_file,"%s: ", progname);
 523                 if(domain && domain->name)
 524                         fprintf(forb_ul_log_file,"%s: ",domain->name);
 525         }
 526         vfprintf(forb_ul_log_file, format, ap);
 527         fflush(forb_ul_log_file);
 528 }
 529
 530 static int init_ul_log(void)
 531 {
 532         char *s;
 533         char *log_fname;
 534         int fd;
 535         int flg = 0;
 536         char path[128];
 537
 538 /*      if(ul_log_output != NULL) */
 539 /*              return 0; */
 540
 541         fd = open("/proc/self/cmdline", O_RDONLY);
 542         if (fd >= 0) {
 543                 int ret;
 544                 ret = read(fd, path, sizeof(path)-1);
 545                 if (ret > 0) {
 546                         path[ret]=0;
 547                         s = strrchr(path, '/');
 548                         if (s) s++;
 549                         else s = path;
 550                         strncpy(progname, s, sizeof(progname)-1);
 551                 }
 552                 close(fd);
 553         }
 554
 555         if((log_fname=getenv("UL_LOG_FILENAME"))!=NULL){
 556                 forb_ul_log_file=fopen(log_fname,"a");
 557         }
 558         if(forb_ul_log_file==NULL)
 559                 forb_ul_log_file=stderr;
 560
 561         if((s=getenv("UL_DEBUG_FLG")) != NULL){
 562                 flg=atoi(s);
 563         }
 564
 565         ul_log_redir(forb_ul_log_fnc, flg);
 566
 567         if((s = getenv("UL_LOG_LEVELS")) != NULL)
 568                 ul_log_domain_arg2levels(s);
 569
 570         return 0;
 571 }
 572
 573 /**
 574  * Wait for the server to be ready. Internal function intended forb
 575  * forbrun.
 576  *
 577  * @param orb ORB.
 578  *
 579  * @return Zero on success; on error -1 is returned, and errno is set
 580  * to indicate the error.
 581  */
 582 int forb_wait_for_server_ready(forb_orb orb)
 583 {
 584         forb_t *forb = forb_object_to_forb(orb);
 585         return sem_wait(&forb->server_ready);
 586 }
 587
 588 /**
 589  * Signal the the FORB core that the server is ready for accepting
 590  * requests.
 591  *
 592  * This function should be called at the initialization of server
 593  * implementation at the time when all objects are registered with
 594  * executors. All other servers in the same address space are
 595  * initialized after this function is called which allows the other
 596  * servers to use the services provided by the calling server.
 597  *
 598  * @param orb ORB object.
 599  *
 600  * @return Zero on success; on error -1 is returned, and errno is set
 601  * to indicate the error.
 602  */
 603 int forb_signal_server_ready(forb_orb orb)
 604 {
 605         forb_t *forb = forb_object_to_forb(orb);
 606         return sem_post(&forb->server_ready);
 607 }