src/forb/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         if (forb_server_id_empty(&forb->attr.fixed_server_id)) {
 198                 forb_server_id_init(&forb->server_id);
 199         } else {
 200                 forb->server_id = forb->attr.fixed_server_id;
 201         }
 202         forb_server_id_to_string(forb->server_id_str, &forb->server_id,
 203                                  sizeof(forb->server_id_str));
 204         ul_logdeb("Initializing forb %s\n", forb->server_id_str);
 205
 206         if (fosa_mutex_init(&forb->request_id_mutex, 0) != 0) goto err2;
 207         if (fosa_mutex_init(&forb->port_mutex, 0) != 0) goto err2;
 208         forb_port_init_head(forb);
 209
 210         if (fosa_mutex_init(&forb->request_mutex, 0) != 0) goto err2;
 211         forb_request_nolock_init_root_field(forb);
 212
 213         if (forb_discovery_init(forb) != 0) goto err2;
 214
 215         if (fosa_mutex_init(&forb->regref_mutex, 0) != 0) goto err2;
 216         forb_regref_nolock_init_root_field(forb);
 217
 218         ret = forb_init_tmp_dir();
 219         if (ret != 0) {
 220                 ul_logerr("Cannot prepare " FORB_TMP_DIR "\n");
 221                 return NULL;
 222         }
 223
 224         forb_executor_prepare();
 225
 226         orb = forb_forb_orb_new(NULL, &forb_implementation, forb);
 227         if (!orb) goto err2;
 228         /* Server ID must be assigned manualy */
 229         orb->server = forb->server_id;
 230
 231         forb->orb = orb;
 232
 233         /* Insert our object reference to objects tree, so that we
 234          * can accept remote request to our new ORB. */
 235         forb_objects_nolock_insert(forb, orb);
 236
 237         ret = fosa_thread_create(&forb->execution_thread, NULL,
 238                                  forb_execution_thread, orb);
 239         if (ret != 0)
 240                 goto err2;
 241
 242         /* FIXME: I do not know how to deregister the exit handler if
 243          * forb_destroy() is called manually. */
 244         /* on_exit(destroy_forb_on_exit, orb); */
 245
 246 #ifdef CONFIG_FORB_PROTO_UNIX
 247         {
 248                 forb_port_t *port = forb_malloc(sizeof(*port));
 249                 if (port) {
 250                         memset(port, 0, sizeof(*port));
 251                         ret = forb_unix_port_init(&port->desc, &forb->server_id);
 252                         if (ret) goto err_free_unix;
 253                         ret = forb_register_port(orb, port);
 254                         if (ret) goto err_free_unix; /* TODO: forb_unix_port_done() */
 255                         goto unix_ok;
 256                 }
 257         err_free_unix:
 258                 free(port);
 259                 goto err2;
 260         unix_ok:;
 261         }
 262 #endif
 263 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
 264         {
 265                 forb_port_t *port = forb_malloc(sizeof(*port));
 266                 if (port) {
 267                         struct in_addr listen_on;
 268
 269                         memset(port, 0, sizeof(*port));
 270                         listen_on.s_addr = INADDR_ANY;
 271                         ret = forb_inet_port_init(&port->desc, listen_on,
 272                                                   forb->attr.fixed_tcp_port);
 273                         if (ret) goto err_free_inet;
 274                         ret = forb_register_port(orb, port);
 275                         if (ret) goto err_free_inet; /* TODO: forb_inet_port_done() */
 276                         goto inet_ok;
 277                 }
 278         err_free_inet:
 279                 free(port);
 280                 goto err2;
 281         inet_ok:;
 282                 hack_register_fcb(orb, port);
 283         }
 284 #endif
 285         return orb;
 286
 287 err2:   forb_free(forb);
 288 err:    return NULL;
 289 }
 290
 291 void forb_destroy(forb_orb orb)
 292 {
 293         forb_t *forb = forb_object_to_forb(orb);
 294         forb_port_t *port;
 295         forb_regref_t *regref;
 296
 297         pthread_cancel(forb->execution_thread.pthread_id);
 298         pthread_join(forb->execution_thread.pthread_id, NULL);
 299
 300         /* Unregister all registered references */
 301         while ((regref = forb_regref_first(forb))) {
 302                 forb_unregister_reference(orb, regref->name.str);
 303         }
 304
 305         ul_list_for_each_cut(forb_port, forb, port) {
 306                 forb_destroy_port(port);
 307         }
 308         forb_object_release(orb);
 309         forb_free(forb);
 310 }
 311
 312 /* void */
 313 /* forb_register_interface(const struct forb_interface *interface) */
 314 /* { */
 315 /*      gavl_insert(&type_registry, &interface->node); */
 316 /* } */
 317
 318 /**
 319  * Initializes server ID variable.
 320  *
 321  * @param server_id Serer ID to initialize.
 322  */
 323 void
 324 forb_server_id_init(forb_server_id *server_id)
 325 {
 326         forb_uuid_generate((forb_uuid_t*)server_id->uuid);
 327 }
 328
 329 /**
 330  * Checks whether the @a object is stale. Stale object is an object
 331  * reference whose server cannot be contacted to handle requests.
 332  *
 333  * @param object Object reference to check.
 334  *
 335  * @return True if the object is stale, false otherwise.
 336  */
 337 bool forb_object_is_stale(forb_object object)
 338 {
 339         forb_orb remote_orb;
 340         struct forb_env env;
 341         bool stale = true;
 342
 343         remote_orb = forb_get_orb_of(object);
 344         if (!remote_orb) {      /* This shohuld never happen */
 345                 goto err;
 346         }
 347         /* TODO: Check not only the ORB, but also whether the object
 348          * is still registered with the remote orb. */
 349         forb_orb_is_alive(remote_orb, &env);
 350         if (env.major == FORB_EX_COMM_FAILURE) {
 351                 /* Orb is not alive */
 352                 stale = true;
 353         } else {
 354                 if (forb_exception_occurred(&env)) {
 355                         ul_logerr("%s: unexpected exception: %s\n", __FUNCTION__, forb_strerror(&env));
 356                 }
 357                 stale = false;
 358         }
 359
 360         forb_object_release(remote_orb);
 361 err:
 362         return stale;
 363 }
 364
 365
 366 /**
 367  * Returns object reference of forb::orb object associated with the
 368  * given object.
 369  *
 370  * @param obj
 371  *
 372  * @return
 373  */
 374 forb_orb
 375 forb_get_orb_of(const forb_object obj)
 376 {
 377         forb_orb orb;
 378
 379         if (forb_server_id_cmp(&obj->server, &obj->orb->server) == 0) {
 380                 orb = forb_object_duplicate(obj->orb);
 381         } else {
 382                 orb = forb_object_new(obj->orb, &obj->server, 0);
 383         }
 384         return orb;
 385 }
 386
 387 /**
 388  * Returns server ID of an object reference.
 389  *
 390  * @param obj
 391  * @param dest
 392  */
 393 void
 394 forb_get_server_id(const forb_object obj, forb_server_id *dest)
 395 {
 396         if (obj) {
 397                 *dest = obj->server;
 398         }
 399 }
 400
 401
 402 /**
 403  * Return instance data registered when the object was created by
 404  * forb_XXX_new().
 405  *
 406  * @param obj Object reference
 407  *
 408  * @return Pointer to the registered data.
 409  */
 410 void *
 411 forb_instance_data(const forb_object obj)
 412 {
 413         return forb_object_instance_data(obj);
 414 }
 415
 416 /**
 417  * Returns error message correspondings FORB exception.
 418  *
 419  * @param env Environemnt
 420  *
 421  * @return Non-NULL pointer to a string.
 422  */
 423 const char *
 424 forb_strerror(CORBA_Environment *env)
 425 {
 426         if (!env) {
 427                 return "Invalid environemnt";
 428         }
 429 #define ex(e) case FORB_EX_##e: return #e; break;
 430         switch (env->major) {
 431         ex(NONE);
 432         ex(UNKNOWN);
 433         ex(BAD_PARAM);
 434         ex(NO_MEMORY);
 435         ex(IMP_LIMIT);
 436         ex(COMM_FAILURE);
 437         ex(INV_OBJREF);
 438         ex(NO_PERMISSION);
 439         ex(INTERNAL);
 440         ex(MARSHAL);
 441         ex(INITIALIZE);
 442         ex(NO_IMPLEMENT);
 443         ex(BAD_OPERATION);
 444         ex(NO_RESOURCES);
 445         ex(NO_RESPONSE);
 446         ex(TRANSIENT);
 447         ex(FREE_MEM);
 448         ex(INV_IDENT);
 449         ex(INV_FLAG);
 450         ex(DATA_CONVERSION);
 451         ex(OBJECT_NOT_EXIST);
 452         ex(TIMEOUT);
 453         ex(APPLICATION);
 454         }
 455 #undef ex
 456         return "Invalid error number";
 457 }
 458
 459 /**
 460  * Return server id of the requesting application.
 461  *
 462  * This function should be only called from within interface
 463  * implementation,
 464  *
 465  * @param[in] obj Object being requested
 466  * @param[out] req_source Server ID of the requesting application
 467  */
 468 void
 469 forb_get_req_source(const forb_object obj, forb_server_id *req_source)
 470 {
 471         if (req_source) {
 472                 if (obj && obj->exec_req) {
 473                         *req_source = obj->exec_req->source;
 474                 } else {
 475                         memset(req_source, 0, sizeof(*req_source));
 476                 }
 477         }
 478 }
 479
 480 /**
 481  * Internal function for allocation of sequence bufers. Used by
 482  * forb_sequence_alloc_buf().
 483  *
 484  * @param seq
 485  * @param seq_size
 486  * @param buf_pptr
 487  * @param maximum_ptr
 488  * @param num_elements
 489  * @param elem_size
 490  *
 491  * @return CORBA_TRUE if the allocation was sucessfull, CORBA_FALSE if
 492  * it wasn't.
 493  */
 494 CORBA_boolean
 495 __forb_sequence_alloc_buf_internal(void *seq, size_t seq_size,
 496                                    void **buf_pptr, CORBA_unsigned_long *maximum_ptr,
 497                                    unsigned num_elements, size_t elem_size)
 498 {
 499         memset(seq, 0, seq_size);
 500         /*(seq)._length = 0;*/
 501         if (num_elements && elem_size) *buf_pptr = forb_malloc(num_elements * elem_size);
 502         else *buf_pptr = NULL;
 503         *maximum_ptr = *buf_pptr ? num_elements : 0;
 504         return (*buf_pptr != NULL) || (num_elements == 0);
 505 }
 506
 507 static FILE *forb_ul_log_file;
 508 static char progname[64] = "";
 509
 510 void
 511 forb_ul_log_fnc(ul_log_domain_t *domain, int level,
 512                 const char *format, va_list ap)
 513 {
 514         struct timespec now;
 515         if(!(level&UL_LOGL_CONT)) {
 516                 level&=UL_LOGL_MASK;
 517                 clock_gettime(CLOCK_MONOTONIC, &now);
 518                 fprintf(forb_ul_log_file,"%ld.%6ld: ", now.tv_sec, now.tv_nsec/1000);
 519                 if (progname[0])
 520                         fprintf(forb_ul_log_file,"%s: ", progname);
 521                 if(domain && domain->name)
 522                         fprintf(forb_ul_log_file,"%s: ",domain->name);
 523         }
 524         vfprintf(forb_ul_log_file, format, ap);
 525         fflush(forb_ul_log_file);
 526 }
 527
 528 static int init_ul_log(void)
 529 {
 530         char *s;
 531         char *log_fname;
 532         int fd;
 533         int flg = 0;
 534         char path[128];
 535
 536 /*      if(ul_log_output != NULL) */
 537 /*              return 0; */
 538
 539         fd = open("/proc/self/cmdline", O_RDONLY);
 540         if (fd >= 0) {
 541                 int ret;
 542                 ret = read(fd, path, sizeof(path)-1);
 543                 if (ret > 0) {
 544                         path[ret]=0;
 545                         s = strrchr(path, '/');
 546                         if (s) s++;
 547                         else s = path;
 548                         strncpy(progname, s, sizeof(progname)-1);
 549                 }
 550                 close(fd);
 551         }
 552
 553         if((log_fname=getenv("UL_LOG_FILENAME"))!=NULL){
 554                 forb_ul_log_file=fopen(log_fname,"a");
 555         }
 556         if(forb_ul_log_file==NULL)
 557                 forb_ul_log_file=stderr;
 558
 559         if((s=getenv("UL_DEBUG_FLG")) != NULL){
 560                 flg=atoi(s);
 561         }
 562
 563         ul_log_redir(forb_ul_log_fnc, flg);
 564
 565         if((s = getenv("UL_LOG_LEVELS")) != NULL)
 566                 ul_log_domain_arg2levels(s);
 567
 568         return 0;
 569 }