1 /******************************************************************************
4 * Company XS Embedded GmbH
5 *****************************************************************************/
6 /******************************************************************************
7 * This Source Code Form is subject to the terms of the
8 * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed
9 * with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 ******************************************************************************/
12 * @file persistence_client_library_dbus_service.c
13 * @ingroup Persistence client library
14 * @author Ingo Huerner
15 * @brief Implementation of the persistence client library dbus service.
20 #include "persistence_client_library_dbus_service.h"
21 #include "persistence_client_library_lc_interface.h"
22 #include "persistence_client_library_pas_interface.h"
23 #include "../include_protected/persistence_client_library_data_organization.h"
31 pthread_cond_t gDbusInitializedCond = PTHREAD_COND_INITIALIZER;
32 pthread_mutex_t gDbusInitializedMtx = PTHREAD_MUTEX_INITIALIZER;
33 pthread_mutex_t gDbusPendingRegMtx = PTHREAD_MUTEX_INITIALIZER;
34 pthread_mutex_t gMainLoopMtx = PTHREAD_MUTEX_INITIALIZER;
39 typedef enum EDBusObjectType
47 typedef struct SObjectEntry
49 tDBusObjectType objtype; /** libdbus' object */
52 DBusWatch * watch; /** watch "object" */
53 DBusTimeout * timeout; /** timeout "object" */
60 typedef struct SPollInfo
63 struct pollfd fds[10];
64 tObjectEntry objects[10];
68 /// polling information
69 static tPollInfo gPollInfo;
73 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
76 /* function to unregister ojbect path message handler */
77 static void unregisterMessageHandler(DBusConnection *connection, void *user_data)
79 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("unregisterObjectPath\n"));
82 /* catches messages not directed to any registered object path ("garbage collector") */
83 static DBusHandlerResult handleObjectPathMessageFallback(DBusConnection * connection, DBusMessage * message, void * user_data)
85 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
87 // org.genivi.persistence.admin S I G N A L
88 if((0==strcmp("org.genivi.persistence.admin", dbus_message_get_interface(message))))
90 if(dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_SIGNAL)
92 if((0==strcmp("PersistenceModeChanged", dbus_message_get_member(message))))
94 // to do handle signal
95 result = signal_persModeChange(connection, message);
99 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback -> unknown signal:"), DLT_STRING(dbus_message_get_interface(message)) );
103 // org.genivi.persistence.admin S I G N A L
104 else if((0==strcmp("org.genivi.persistence.adminconsumer", dbus_message_get_interface(message))))
106 if(dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_SIGNAL)
108 pclNotification_s notifyStruct;
109 int validMessage = 0;
111 if((0==strcmp("PersistenceResChange", dbus_message_get_member(message))))
113 notifyStruct.pclKeyNotify_Status = pclNotifyStatus_changed;
116 else if((0==strcmp("PersistenceResDelete", dbus_message_get_member(message))))
118 notifyStruct.pclKeyNotify_Status = pclNotifyStatus_deleted;
121 else if((0==strcmp("PersistenceRes", dbus_message_get_member(message))))
123 notifyStruct.pclKeyNotify_Status = pclNotifyStatus_created;
127 if(validMessage == 1)
131 dbus_error_init (&error);
136 if (!dbus_message_get_args(message, &error, DBUS_TYPE_STRING, ¬ifyStruct.resource_id,
137 DBUS_TYPE_STRING, &ldbid,
138 DBUS_TYPE_STRING, &user_no,
139 DBUS_TYPE_STRING, &seat_no,
142 reply = dbus_message_new_error(message, error.name, error.message);
146 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback => DBus No memory"), DLT_STRING(dbus_message_get_interface(message)) );
149 if (!dbus_connection_send(connection, reply, 0))
151 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback => DBus No memory"), DLT_STRING(dbus_message_get_interface(message)) );
154 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;;
155 dbus_message_unref(reply);
159 notifyStruct.ldbid = atoi(ldbid);
160 notifyStruct.user_no = atoi(user_no);
161 notifyStruct.seat_no = atoi(seat_no);
163 // call the registered callback function
164 if(gChangeNotifyCallback != NULL )
166 gChangeNotifyCallback(¬ifyStruct);
170 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback => gChangeNotifyCallback is not set (possibly NULL)") );
172 result = DBUS_HANDLER_RESULT_HANDLED;
174 dbus_connection_flush(connection);
178 // org.genivi.persistence.admin P R O P E R T Y
179 else if((0==strcmp("org.freedesktop.DBus.Properties", dbus_message_get_interface(message))))
181 if(dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_SIGNAL)
183 if((0==strcmp("EggDBusChanged", dbus_message_get_member(message))))
185 DBusMessageIter array;
186 DBusMessageIter dict;
187 DBusMessageIter variant;
189 char* dictString = NULL;
192 dbus_message_iter_open_container(&array, DBUS_TYPE_DICT_ENTRY, 0, &dict);
193 dbus_message_iter_get_basic(&dict, &dictString);
195 dbus_message_iter_open_container(&dict,DBUS_TYPE_VARIANT, NULL, &variant);
196 dbus_message_iter_get_basic(&dict, &value);
198 dbus_message_iter_close_container(&dict, &variant);
199 dbus_message_iter_close_container(&array, &dict);
201 // to do handle signal
202 result = DBUS_HANDLER_RESULT_HANDLED;
206 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback -> unknown property:"), DLT_STRING(dbus_message_get_interface(message)) );
211 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("handleObjectPathMessageFallback -> not a signal:"), DLT_STRING(dbus_message_get_member(message)) );
219 static void unregisterObjectPathFallback(DBusConnection *connection, void *user_data)
221 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("unregisterObjectPathFallback\n"));
226 void* run_mainloop(void* dataPtr)
228 // persistence admin message
229 static const struct DBusObjectPathVTable vtablePersAdmin
230 = {unregisterMessageHandler, checkPersAdminMsg, NULL, };
233 static const struct DBusObjectPathVTable vtableLifecycle
234 = {unregisterMessageHandler, checkLifecycleMsg, NULL, };
237 static const struct DBusObjectPathVTable vtableFallback
238 = {unregisterObjectPathFallback, handleObjectPathMessageFallback, NULL, };
241 mainLoop(vtablePersAdmin, vtableLifecycle, vtableFallback, dataPtr);
248 int setup_dbus_mainloop(void)
253 DBusConnection* conn = NULL;
255 const char *pAddress = getenv("PERS_CLIENT_DBUS_ADDRESS");
257 // enable locking of data structures in the D-Bus library for multi threading.
258 dbus_threads_init_default();
259 dbus_error_init(&err);
261 // wain until dbus main loop has been setup and running
262 pthread_mutex_lock(&gDbusInitializedMtx);
264 // Connect to the bus and check for errors
267 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("setup_dbus_mainloop -> Use specific dbus address:"), DLT_STRING(pAddress) );
269 conn = dbus_connection_open_private(pAddress, &err);
273 if(!dbus_bus_register(conn, &err))
275 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("dbus_bus_register() Error :"), DLT_STRING(err.message) );
276 dbus_error_free (&err);
282 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("dbus_connection_open_private() Error :"), DLT_STRING(err.message) );
283 dbus_error_free(&err);
289 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("Use default dbus bus (DBUS_BUS_SYSTEM)"));
291 conn = dbus_bus_get_private(DBUS_BUS_SYSTEM, &err);
294 // create here the dbus connection and pass to main loop
295 rval = pthread_create(&thread, NULL, run_mainloop, conn);
298 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("pthread_create( DBUS run_mainloop ) returned an error:"), DLT_INT(rval) );
302 // wait for condition variable
303 pthread_cond_wait(&gDbusInitializedCond, &gDbusInitializedMtx);
305 pthread_mutex_unlock(&gDbusInitializedMtx);
313 static dbus_bool_t addWatch(DBusWatch *watch, void *data)
315 dbus_bool_t result = FALSE;
317 if (ARRAY_SIZE(gPollInfo.fds)>gPollInfo.nfds)
319 int flags = dbus_watch_get_flags(watch);
321 tObjectEntry * const pEntry = &gPollInfo.objects[gPollInfo.nfds];
322 pEntry->objtype = OT_WATCH;
323 pEntry->watch = watch;
325 gPollInfo.fds[gPollInfo.nfds].fd = dbus_watch_get_unix_fd(watch);
327 if (TRUE==dbus_watch_get_enabled(watch))
329 if (flags&DBUS_WATCH_READABLE)
331 gPollInfo.fds[gPollInfo.nfds].events |= POLLIN;
333 if (flags&DBUS_WATCH_WRITABLE)
335 gPollInfo.fds[gPollInfo.nfds].events |= POLLOUT;
349 static void removeWatch(DBusWatch *watch, void *data)
351 void* w_data = dbus_watch_get_data(watch);
353 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("removeWatch called "), DLT_INT( (int)watch) );
358 dbus_watch_set_data(watch, NULL, NULL);
363 static void watchToggled(DBusWatch *watch, void *data)
365 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("watchToggled called "), DLT_INT( (int)watch) );
367 if(dbus_watch_get_enabled(watch))
368 addWatch(watch, data);
370 removeWatch(watch, data);
375 static dbus_bool_t addTimeout(DBusTimeout *timeout, void *data)
377 dbus_bool_t ret = FALSE;
379 if (ARRAY_SIZE(gPollInfo.fds)>gPollInfo.nfds)
381 const int interval = dbus_timeout_get_interval(timeout);
382 if ((0<interval)&&(TRUE==dbus_timeout_get_enabled(timeout)))
384 const int tfd = timerfd_create(CLOCK_MONOTONIC, TFD_CLOEXEC);
387 const struct itimerspec its = { .it_value= {interval/1000, interval%1000} };
388 if (-1!=timerfd_settime(tfd, 0, &its, NULL))
390 tObjectEntry * const pEntry = &gPollInfo.objects[gPollInfo.nfds];
391 pEntry->objtype = OT_TIMEOUT;
392 pEntry->timeout = timeout;
393 gPollInfo.fds[gPollInfo.nfds].fd = tfd;
394 gPollInfo.fds[gPollInfo.nfds].events |= POLLIN;
400 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("addTimeout => timerfd_settime() failed"), DLT_STRING(strerror(errno)) );
405 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("addTimeout => timerfd_create() failed"), DLT_STRING(strerror(errno)) );
411 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("addTimeout => cannot create another fd to be poll()'ed"));
419 static void removeTimeout(DBusTimeout *timeout, void *data)
422 int i = gPollInfo.nfds;
423 while ((0<i--)&&(timeout!=gPollInfo.objects[i].timeout));
427 if (-1==close(gPollInfo.fds[i].fd))
429 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("removeTimeout => close() timerfd"), DLT_STRING(strerror(errno)) );
433 while (gPollInfo.nfds>i)
435 gPollInfo.fds[i] = gPollInfo.fds[i+1];
436 gPollInfo.objects[i] = gPollInfo.objects[i+1];
440 gPollInfo.fds[gPollInfo.nfds].fd = -1;
441 gPollInfo.objects[gPollInfo.nfds].objtype = OT_NONE;
447 /** callback for libdbus' when timeout changed */
448 static void timeoutToggled(DBusTimeout *timeout, void *data)
450 int i = gPollInfo.nfds;
451 while ((0<i--)&&(timeout!=gPollInfo.objects[i].timeout));
452 DLT_LOG(gDLTContext, DLT_LOG_INFO, DLT_STRING("timeoutToggled") );
455 const int interval = (TRUE==dbus_timeout_get_enabled(timeout))?dbus_timeout_get_interval(timeout):0;
456 const struct itimerspec its = { .it_value= {interval/1000, interval%1000} };
457 if (-1!=timerfd_settime(gPollInfo.fds[i].fd, 0, &its, NULL))
459 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("timeoutToggled => timerfd_settime()"), DLT_STRING(strerror(errno)) );
466 int mainLoop(DBusObjectPathVTable vtable, DBusObjectPathVTable vtable2,
467 DBusObjectPathVTable vtableFallback, void* userData)
470 // lock mutex to make sure dbus main loop is running
471 pthread_mutex_lock(&gDbusInitializedMtx);
473 DBusConnection* conn = (DBusConnection*)userData;
474 dbus_error_init(&err);
476 if (dbus_error_is_set(&err))
478 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => Connection Error:"), DLT_STRING(err.message) );
479 dbus_error_free(&err);
481 else if (NULL != conn)
483 dbus_connection_set_exit_on_disconnect(conn, FALSE);
484 if (-1 == (gEfds = eventfd(0, 0)))
486 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => eventfd() failed w/ errno:"), DLT_INT(errno) );
491 memset(&gPollInfo, 0 , sizeof(gPollInfo));
494 gPollInfo.fds[0].fd = gEfds;
495 gPollInfo.fds[0].events = POLLIN;
497 dbus_bus_add_match(conn, "type='signal',interface='org.genivi.persistence.admin',member='PersistenceModeChanged',path='/org/genivi/persistence/admin'", &err);
499 // register for messages
500 if ( (TRUE==dbus_connection_register_object_path(conn, "/org/genivi/persistence/adminconsumer", &vtable, userData))
501 && (TRUE==dbus_connection_register_object_path(conn, "/org/genivi/NodeStateManager/LifeCycleConsumer", &vtable2, userData))
502 && (TRUE==dbus_connection_register_fallback(conn, "/", &vtableFallback, userData)) )
504 if( (TRUE!=dbus_connection_set_watch_functions(conn, addWatch, removeWatch, watchToggled, NULL, NULL))
505 || (TRUE!=dbus_connection_set_timeout_functions(conn, addTimeout, removeTimeout, timeoutToggled, NULL, NULL)) )
507 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => dbus_connection_set_watch_functions() failed"));
511 pthread_cond_signal(&gDbusInitializedCond);
512 pthread_mutex_unlock(&gDbusInitializedMtx);
515 bContinue = 0; /* assume error */
517 while (DBUS_DISPATCH_DATA_REMAINS==dbus_connection_dispatch(conn));
519 while ((-1==(ret=poll(gPollInfo.fds, gPollInfo.nfds, -1)))&&(EINTR==errno));
523 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => poll() failed w/ errno "), DLT_INT(errno) );
533 for (i=0; gPollInfo.nfds>i; ++i)
536 if (0!=gPollInfo.fds[i].revents)
538 if (OT_TIMEOUT==gPollInfo.objects[i].objtype)
540 /* time-out occured */
541 unsigned long long nExpCount = 0;
542 if ((ssize_t)sizeof(nExpCount)!=read(gPollInfo.fds[i].fd, &nExpCount, sizeof(nExpCount)))
544 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => read failed"));
546 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => timeout"));
548 if (FALSE==dbus_timeout_handle(gPollInfo.objects[i].timeout))
550 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => dbus_timeout_handle() failed!?"));
554 else if (gPollInfo.fds[i].fd == gEfds)
556 /* internal command */
557 if (0!=(gPollInfo.fds[i].revents & POLLIN))
561 while ((-1==(ret = read(gPollInfo.fds[i].fd, buf, 64)))&&(EINTR == errno));
564 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => read() failed"), DLT_STRING(strerror(errno)) );
570 case CMD_PAS_BLOCK_AND_WRITE_BACK:
571 process_block_and_write_data_back((buf[2]), buf[1]);
573 case CMD_LC_PREPARE_SHUTDOWN:
574 process_prepare_shutdown((buf[2]), buf[1]);
576 case CMD_SEND_NOTIFY_SIGNAL:
577 process_send_notification_signal(conn);
579 case CMD_REG_NOTIFY_SIGNAL:
580 process_reg_notification_signal(conn);
582 case CMD_SEND_PAS_REQUEST:
583 process_send_pas_request(conn, (buf[2]), buf[1]);
585 case CMD_SEND_PAS_REGISTER:
586 process_send_pas_register(conn, (buf[1]), buf[2]);
588 case CMD_SEND_LC_REQUEST:
589 process_send_lifecycle_request(conn, (buf[2]), buf[1]);
591 case CMD_SEND_LC_REGISTER:
592 process_send_lifecycle_register(conn, (buf[1]), buf[2]);
598 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("mainLoop => command not handled"), DLT_INT(buf[0]) );
601 pthread_mutex_unlock(&gMainLoopMtx);
608 if (0!=(gPollInfo.fds[i].revents & POLLIN))
610 flags |= DBUS_WATCH_READABLE;
612 if (0!=(gPollInfo.fds[i].revents & POLLOUT))
614 flags |= DBUS_WATCH_WRITABLE;
616 if (0!=(gPollInfo.fds[i].revents & POLLERR))
618 flags |= DBUS_WATCH_ERROR;
620 if (0!=(gPollInfo.fds[i].revents & POLLHUP))
622 flags |= DBUS_WATCH_HANGUP;
625 bContinue = dbus_watch_handle(gPollInfo.objects[i].watch, flags);
631 while (0!=bContinue);
633 dbus_connection_unregister_object_path(conn, "/org/genivi/persistence/adminconsumer");
634 dbus_connection_unregister_object_path(conn, "/org/genivi/NodeStateManager/LifeCycleConsumer");
635 dbus_connection_unregister_object_path(conn, "/");
639 dbus_connection_close(conn);
640 dbus_connection_unref(conn);
644 pthread_cond_signal(&gDbusInitializedCond);
645 pthread_mutex_unlock(&gDbusInitializedMtx);
651 int deliverToMainloop(tCmd mainloopCmd, unsigned int param1, unsigned int param2)
657 pthread_mutex_lock(&gMainLoopMtx);
659 cmd = ( ((uint64_t)param2 << 32) | ((uint64_t)param1 << 16) | mainloopCmd);
661 if(-1 == write(gEfds, &cmd, (sizeof(uint64_t))))
663 DLT_LOG(gDLTContext, DLT_LOG_ERROR, DLT_STRING("deliverToMainloop => failed to write to pipe"), DLT_INT(errno));