1 /**************************************************************************/
2 /* ---------------------------------------------------------------------- */
3 /* Copyright (C) 2006 - 2008 FRESCOR consortium partners: */
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 */
12 /* Thales Communication S.A. FRANCE */
13 /* Visual Tools S.A. SPAIN */
14 /* Rapita Systems Ltd UK */
17 /* See http://www.frescor.org for a link to partners' websites */
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. */
25 /* This file is part of FORB (Frescor Object Request Broker) */
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. */
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 /**************************************************************************/
49 * @author Michal Sojka <sojkam1@fel.cvut.cz>
50 * @date Sun Oct 12 16:57:01 2008
52 * @brief Implementation of basic FORB's functions.
58 #define _BSD_SOURCE /* Because of on_exit() */
62 #include <forb/config.h>
63 #include <forb/forb-internal.h>
67 #include <forb/object.h>
68 #include <forb/uuid.h>
72 #include <sys/types.h>
73 #include <ul_gavlcust.h>
75 #include <ul_logreg.h>
77 #include "discovery.h"
78 #ifdef CONFIG_FORB_PROTO_UNIX
79 #include <forb/proto_unix.h>
81 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
82 #include <forb/proto_inet.h>
86 #include <fcb_contact_info.h>
91 #define UL_LOGL_DEF UL_LOGL_DEB
93 #define UL_LOGL_DEF UL_LOGL_ERR
95 #include "log_domains.inc"
97 extern UL_LOG_CUST(ulogd_forb);
98 static int init_ul_log(void);
100 UL_LOGREG_DOMAINS_INIT_FUNCTION(forb_logreg_domains, forb_logreg_domains_array);
104 destroy_forb_on_exit(int exitcode, void *arg)
112 forb_is_alive(forb_orb _obj, CORBA_Environment *ev)
114 ul_logdeb("%s called\n", __FUNCTION__);
117 static struct forb_forb_orb_impl forb_implementation = {
118 .is_alive = forb_is_alive,
122 * Prepares #FORB_TMP_DIR directory for use by forb
124 * @return Zero on succes, -1 on error and errno is set appropriately.
127 forb_init_tmp_dir(void)
132 ret = stat(FORB_TMP_DIR, &st);
134 if (ret == 0 && !S_ISDIR(st.st_mode)) {
135 ret = unlink(FORB_TMP_DIR);
137 } else if (ret == 0) {
140 return mkdir(FORB_TMP_DIR, 0777);
144 * Thread for execution of remote requests for a FORB object.
151 forb_execution_thread(void *arg)
155 forb_execute_object(orb);
160 void hack_register_fcb(forb_orb orb, forb_port_t *port)
162 forb_object fcb = forb_object_new(orb, &FCB_SERVER_ID, 1);
164 ul_logerr("Cannot allocate FCB reference\n");
167 forb_register_reference(fcb, fres_contract_broker_reg_name);
168 forb_object_release(fcb);
171 #define hack_register_fcb(orb)
177 forb_init(int *argc, char **argv[], const struct forb_init_attr *attr)
183 forb = forb_malloc(sizeof(*forb));
185 memset(forb, 0, sizeof(*forb));
187 /* Initialize ULUT logging facility */
189 forb_logreg_domains();
194 memset(&forb->attr, 0, sizeof(forb->attr));
197 if (forb_server_id_empty(&forb->attr.fixed_server_id)) {
198 forb_server_id_init(&forb->server_id);
200 forb->server_id = forb->attr.fixed_server_id;
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);
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);
210 if (fosa_mutex_init(&forb->request_mutex, 0) != 0) goto err2;
211 forb_request_nolock_init_root_field(forb);
213 if (forb_discovery_init(forb) != 0) goto err2;
215 if (fosa_mutex_init(&forb->regref_mutex, 0) != 0) goto err2;
216 forb_regref_nolock_init_root_field(forb);
218 ret = forb_init_tmp_dir();
220 ul_logerr("Cannot prepare " FORB_TMP_DIR "\n");
224 orb = forb_forb_orb_new(NULL, &forb_implementation, forb);
226 /* Server ID must be assigned manualy */
227 orb->server = forb->server_id;
231 /* Insert our object reference to objects tree, so that we
232 * can accept remote request to our new ORB. */
233 forb_objects_nolock_insert(forb, orb);
235 ret = fosa_thread_create(&forb->execution_thread, NULL,
236 forb_execution_thread, orb);
240 /* FIXME: I do not know how to deregister the exit handler if
241 * forb_destroy() is called manually. */
242 /* on_exit(destroy_forb_on_exit, orb); */
244 #ifdef CONFIG_FORB_PROTO_UNIX
246 forb_port_t *port = forb_malloc(sizeof(*port));
248 memset(port, 0, sizeof(*port));
249 ret = forb_unix_port_init(&port->desc, &forb->server_id);
250 if (ret) goto err_free_unix;
251 ret = forb_register_port(orb, port);
252 if (ret) goto err_free_unix; /* TODO: forb_unix_port_done() */
261 #ifdef CONFIG_FORB_PROTO_INET_DEFAULT
263 forb_port_t *port = forb_malloc(sizeof(*port));
265 struct in_addr listen_on;
267 memset(port, 0, sizeof(*port));
268 listen_on.s_addr = INADDR_ANY;
269 ret = forb_inet_port_init(&port->desc, listen_on,
270 forb->attr.fixed_tcp_port);
271 if (ret) goto err_free_inet;
272 ret = forb_register_port(orb, port);
273 if (ret) goto err_free_inet; /* TODO: forb_inet_port_done() */
280 hack_register_fcb(orb, port);
285 err2: forb_free(forb);
289 void forb_destroy(forb_orb orb)
291 forb_t *forb = forb_object_to_forb(orb);
293 forb_regref_t *regref;
295 pthread_cancel(forb->execution_thread.pthread_id);
296 pthread_join(forb->execution_thread.pthread_id, NULL);
298 /* Unregister all registered references */
299 while ((regref = forb_regref_first(forb))) {
300 forb_unregister_reference(orb, regref->name.str);
303 ul_list_for_each_cut(forb_port, forb, port) {
304 forb_destroy_port(port);
306 forb_object_release(orb);
311 /* forb_register_interface(const struct forb_interface *interface) */
313 /* gavl_insert(&type_registry, &interface->node); */
317 * Initializes server ID variable.
319 * @param server_id Serer ID to initialize.
322 forb_server_id_init(forb_server_id *server_id)
324 forb_uuid_generate((forb_uuid_t*)server_id->uuid);
328 * Checks whether the @a object is stale. Stale object is an object
329 * reference whose server cannot be contacted to handle requests.
331 * @param object Object reference to check.
333 * @return True if the object is stale, false otherwise.
335 bool forb_object_is_stale(forb_object object)
341 remote_orb = forb_get_orb_of(object);
342 if (!remote_orb) { /* This shohuld never happen */
345 /* TODO: Check not only the ORB, but also whether the object
346 * is still registered with the remote orb. */
347 forb_orb_is_alive(remote_orb, &env);
348 if (env.major == FORB_EX_COMM_FAILURE) {
349 /* Orb is not alive */
352 if (forb_exception_occurred(&env)) {
353 ul_logerr("%s: unexpected exception: %s\n", __FUNCTION__, forb_strerror(&env));
358 forb_object_release(remote_orb);
365 * Returns object reference of forb::orb object associated with the
373 forb_get_orb_of(const forb_object obj)
377 if (forb_server_id_cmp(&obj->server, &obj->orb->server) == 0) {
378 orb = forb_object_duplicate(obj->orb);
380 orb = forb_object_new(obj->orb, &obj->server, 0);
386 * Returns server ID of an object reference.
392 forb_get_server_id(const forb_object obj, forb_server_id *dest)
401 * Return instance data registered when the object was created by
404 * @param obj Object reference
406 * @return Pointer to the registered data.
409 forb_instance_data(const forb_object obj)
411 return forb_object_instance_data(obj);
415 * Returns error message correspondings FORB exception.
417 * @param env Environemnt
419 * @return Non-NULL pointer to a string.
422 forb_strerror(CORBA_Environment *env)
425 return "Invalid environemnt";
427 #define ex(e) case FORB_EX_##e: return #e; break;
428 switch (env->major) {
449 ex(OBJECT_NOT_EXIST);
454 return "Invalid error number";
458 * Return server id of the requesting application.
460 * This function should be only called from within interface
463 * @param[in] obj Object being requested
464 * @param[out] req_source Server ID of the requesting application
467 forb_get_req_source(const forb_object obj, forb_server_id *req_source)
470 if (obj && obj->exec_req) {
471 *req_source = obj->exec_req->source;
473 memset(req_source, 0, sizeof(*req_source));
479 * Internal function for allocation of sequence bufers. Used by
480 * forb_sequence_alloc_buf().
486 * @param num_elements
489 * @return CORBA_TRUE if the allocation was sucessfull, CORBA_FALSE if
493 __forb_sequence_alloc_buf_internal(void *seq, size_t seq_size,
494 void **buf_pptr, CORBA_unsigned_long *maximum_ptr,
495 unsigned num_elements, size_t elem_size)
497 memset(seq, 0, seq_size);
498 /*(seq)._length = 0;*/
499 if (num_elements && elem_size) *buf_pptr = forb_malloc(num_elements * elem_size);
500 else *buf_pptr = NULL;
501 *maximum_ptr = *buf_pptr ? num_elements : 0;
502 return (*buf_pptr != NULL) || (num_elements == 0);
505 static FILE *forb_ul_log_file;
506 static char progname[64] = "";
509 forb_ul_log_fnc(ul_log_domain_t *domain, int level,
510 const char *format, va_list ap)
512 if(!(level&UL_LOGL_CONT)) {
515 fprintf(forb_ul_log_file,"%s: ", progname);
516 if(domain && domain->name)
517 fprintf(forb_ul_log_file,"%s: ",domain->name);
519 vfprintf(forb_ul_log_file, format, ap);
520 fflush(forb_ul_log_file);
523 static int init_ul_log(void)
531 /* if(ul_log_output != NULL) */
534 fd = open("/proc/self/cmdline", O_RDONLY);
537 ret = read(fd, path, sizeof(path)-1);
540 s = strrchr(path, '/');
543 strncpy(progname, s, sizeof(progname)-1);
548 if((log_fname=getenv("UL_LOG_FILENAME"))!=NULL){
549 forb_ul_log_file=fopen(log_fname,"a");
551 if(forb_ul_log_file==NULL)
552 forb_ul_log_file=stderr;
554 if((s=getenv("UL_DEBUG_FLG")) != NULL){
558 ul_log_redir(forb_ul_log_fnc, flg);