f51251442ea87477d9b9a7657045f0aa32f7872c
[platform/core/connectivity/zigbee-manager.git] / zigbee-daemon / zigbee-lib / src / zblib_service.c
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd. All rights reserved.
3  *
4  * Contact: Suresh Kumar N (suresh.n@samsung.com)
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18
19 #include <dlfcn.h>
20 #include <sys/stat.h>
21
22 #include <zblib.h>
23 #include <zblib_service.h>
24 #include <zblib_plugin.h>
25 #include <zblib_service_interface.h>
26 #include <zblib_request.h>
27 #include <zblib_driver.h>
28 #include <zblib_driver_manager.h>
29
30 struct _zblib_async_init_info {
31         gboolean is_initialized; /**< Does initialization succeeded? */
32         gboolean is_finished; /**< Does initialization finished? */
33
34         ZigBeePlugin *plugin; /**< ZigBee plugin */
35         void *user_data; /**< User data */
36 };
37
38 /**< ZigBee Service object */
39 struct zblib_service_type {
40         GMainLoop *main_loop; /**< Service main-loop */
41
42         GSList *interface_objs; /**< ZigBee Service interface objects */
43         GSList *plugins; /**< ZigBee plug-ins */
44
45         GHashTable *request_table; /**< Request Hash table */
46         guint request_id; /**< Request ID */
47
48         GSList *async_initializer; /**< Hash table for asynchronous initializer */
49         zblib_plugin_init_finished_cb callback; /**< Callback */
50 };
51
52 static GSList *__zblib_service_ref_async_initializer(ZigBeeService* service)
53 {
54         zblib_check_null_ret_error("service", service, NULL);
55
56         return service->async_initializer;
57 }
58
59 static void __zblib_service_set_async_initializer(ZigBeeService* service, GSList* list)
60 {
61         zblib_check_null_ret("service", service);
62
63         service->async_initializer = list;
64 }
65
66 static void __on_zblib_init_async_finished(gboolean result, void *user_data)
67 {
68         GSList *list_async = NULL;
69         ZigBeeService *service = NULL;
70         ZigBeePlugin *plugin = NULL;
71         struct _zblib_async_init_info *info = (struct _zblib_async_init_info*)user_data;
72         char *plugin_name = NULL;
73
74         int i = 0;
75         int _finished_count = 0;
76         int _succeeded_count = 0;
77
78         zblib_check_null_ret("info", info);
79
80         plugin = info->plugin;
81         service = zblib_plugin_ref_service(plugin);
82         zblib_check_null_ret("service", service);
83
84         plugin_name = zblib_plugin_get_plugin_name(plugin);
85
86         info->is_finished = TRUE;
87         if (result) {
88                 Z_LOGD("Plugin [%s] succeeded async init", plugin_name);
89                 info->is_initialized = TRUE;
90         } else {
91                 Z_LOGE("Plugin [%s] failed to init !", plugin_name);
92         }
93         g_free(plugin_name);
94
95         /* Check all async initializer list */
96         list_async = __zblib_service_ref_async_initializer(service);
97         while (list_async != NULL) {
98                 /* Initialize each plug-in */
99                 struct _zblib_async_init_info *in =
100                                 (struct _zblib_async_init_info *)(list_async->data);
101                 i++;
102                 if (G_UNLIKELY(NULL == in)) {
103                         Z_LOGE("Invalid parameter !");
104                         list_async = g_slist_next(list_async);
105                         continue;
106                 }
107
108                 if (in->is_finished)
109                         _finished_count++;
110                 if (in->is_initialized)
111                         _succeeded_count++;
112
113                 list_async = g_slist_next(list_async);
114         }
115
116         if (i == _finished_count) {
117                 gboolean ret = TRUE;
118                 guint driver_noti_id = (ZBLIB_DRIVER_TYPE_MANAGER << 24)
119                                 | ZBLIB_MANAGER_NOTI_ZIGBEE_ENABLED;
120
121                 if (_finished_count == _succeeded_count) {
122                         /* All initializer finished successfully */
123                         Z_LOGD("All async init finished !");
124                         ret = TRUE;
125                 } else {
126                         /* Some initializers are failed */
127                         Z_LOGE("There are some failed plugin initializer !");
128                         ret = FALSE;
129                 }
130                 /* Notify whether zigbee service is enabled or not */
131                 zblib_plugin_send_notification(plugin,
132                         driver_noti_id, &ret, sizeof(ret));
133         }
134 }
135
136 static void *__zblib_service_load_plugin(gchar *filename,
137         ZblibPluginDescriptor_t **descriptor_out)
138 {
139         ZblibPluginDescriptor_t *descriptor = NULL;
140         void *handle = NULL;
141         struct stat stat_buf;
142         char file_date[27];
143
144         zblib_check_null_ret_error("descriptor_out", descriptor_out, NULL);
145
146         /* Open .so */
147         handle = dlopen(filename, RTLD_LAZY);
148         if (G_UNLIKELY(NULL == handle)) {
149                 Z_LOGE("dlopen() failed:[%s]", filename);
150                 return NULL;
151         }
152
153         /* Get symbol - "zigbee_plugin_descriptor" */
154         descriptor = dlsym(handle, "zigbee_plugin_descriptor");
155         if (G_UNLIKELY(NULL == descriptor)) {
156                 Z_LOGE("dlsym() failed:[%s]", "plugin_define_desc");
157                 dlclose(handle);
158                 return NULL;
159         }
160
161         Z_LOGD("%s plugin", descriptor->name);
162         Z_LOGD(" - path = %s", filename);
163         Z_LOGD(" - version = %d", descriptor->version);
164
165         memset(&stat_buf, 0x00, sizeof(stat_buf));
166         memset(&file_date, '\0', sizeof(file_date));
167
168         if (0 == stat(filename, &stat_buf)) {
169                 if (NULL != ctime_r(&stat_buf.st_mtime, file_date)) {
170                         if (1 < strlen(file_date))
171                                 file_date[strlen(file_date)-1] = '\0';
172                         Z_LOGD(" - date = %s", file_date);
173                 }
174         }
175
176         /* Load plug-in */
177         if (G_LIKELY(descriptor->load)) {
178                 if (G_UNLIKELY(FALSE == descriptor->load())) {
179                         Z_LOGW("load() failed... Skip this plugin!");
180                         dlclose(handle);
181                         return NULL;
182                 } else {
183                         Z_LOGI("Plug-in (%s) loaded!", descriptor->name);
184                 }
185         }
186
187         *descriptor_out = descriptor;
188
189         return handle;
190 }
191
192 static gboolean __zblib_service_init_plugin(ZigBeePlugin *plugin)
193 {
194         const ZblibPluginDescriptor_t *descriptor = zblib_plugin_get_descriptor(plugin);
195
196         zblib_check_null_ret_error("descriptor", descriptor, FALSE);
197         if (NULL == descriptor->init) {
198                 Z_LOGD("descriptor->init is NULL, trying async init");
199                 return FALSE;
200         }
201
202         if (G_UNLIKELY(FALSE == descriptor->init(plugin))) {
203                 char *plugin_name = zblib_plugin_get_plugin_name(plugin);
204                 if (G_UNLIKELY(NULL != plugin_name)) {
205                         Z_LOGE("plugin(%s) init failed!", plugin_name);
206                         g_free(plugin_name);
207                 }
208                 return FALSE;
209         }
210
211         return TRUE;
212 }
213
214 static gboolean __zblib_service_init_async_plugin(ZigBeePlugin *plugin,
215                 zblib_plugin_init_finished_cb callback, void *user_data)
216 {
217         const ZblibPluginDescriptor_t *descriptor = zblib_plugin_get_descriptor(plugin);
218         char *plugin_name = NULL;
219
220         zblib_check_null_ret_error("descriptor", descriptor, FALSE);
221         zblib_check_null_ret_error("descriptor->init_async", descriptor->init_async, FALSE);
222
223         plugin_name = zblib_plugin_get_plugin_name(plugin);
224         if (G_UNLIKELY(NULL != plugin_name))
225                 plugin_name = g_strdup("NONAME");
226
227         if (G_UNLIKELY(FALSE == descriptor->init_async(plugin, callback, user_data))) {
228                 Z_LOGE("plugin(%s) init failed!", plugin_name);
229                 g_free(plugin_name);
230                 return FALSE;
231         }
232
233         g_free(plugin_name);
234         return TRUE;
235 }
236
237 static gboolean __zblib_service_unload_plugin(ZigBeePlugin *plugin)
238 {
239         const ZblibPluginDescriptor_t *descriptor = zblib_plugin_get_descriptor(plugin);
240         char *plugin_name = NULL;
241
242         zblib_check_null_ret_error("descriptor", descriptor, FALSE);
243         zblib_check_null_ret_error("descriptor->unload", descriptor->unload, FALSE);
244
245         plugin_name = zblib_plugin_get_plugin_name(plugin);
246
247         descriptor->unload(plugin);
248         Z_LOGI("plugin(%s) unloaded!", plugin_name);
249
250         g_free(plugin_name);
251
252         return TRUE;
253 }
254
255 static void __zblib_service_remove_request_table_iter(gpointer key,
256         gpointer value, gpointer user_data)
257 {
258         ZigBeeServiceInterface *service_interface = (ZigBeeServiceInterface *)user_data;
259         gint request_id = GPOINTER_TO_INT(key);
260
261         NOT_USED(value);
262
263         zblib_check_null_ret("service_interface", service_interface);
264
265         Z_LOGD("Removing request id [%d]", request_id);
266         zblib_request_free(service_interface, request_id);
267 }
268
269 ZigBeeService *zblib_service_new()
270 {
271         ZigBeeService *service;
272
273         service = g_malloc0(sizeof(struct zblib_service_type));
274
275         /* Create g-main loop */
276         service->main_loop = g_main_loop_new(NULL, FALSE);
277         if (G_UNLIKELY(NULL == service->main_loop)) {
278                 Z_LOGE("g-main loop creation failed!!!");
279                 g_free(service);
280                 return NULL;
281         }
282
283         /* Create request hash table */
284         service->request_table = g_hash_table_new_full(g_direct_hash,
285                 g_direct_equal, NULL, NULL);
286
287         return service;
288 }
289
290 void zblib_service_free(ZigBeeService *service)
291 {
292         zblib_check_null_ret("service", service);
293
294         if (service->request_table) {
295                 GSList *interface_objs = NULL;
296                 ZigBeeServiceInterface *service_interface = NULL;
297
298                 interface_objs = service->interface_objs;
299                 if (NULL == interface_objs) {
300                         Z_LOGE("interface_objs is NULL");
301                 } else {
302                         while (interface_objs) {
303                                 service_interface = (ZigBeeServiceInterface *)interface_objs->data;
304
305                                 /* Remove left request */
306                                 g_hash_table_foreach(service->request_table,
307                                                 __zblib_service_remove_request_table_iter,
308                                                 service_interface);
309
310                                 /* Move to next service interface */
311                                 interface_objs = g_slist_next(interface_objs);
312                         }
313                         g_hash_table_remove_all(service->request_table);
314                         g_hash_table_destroy(service->request_table);
315                         service->request_table = NULL;
316                 }
317         }
318
319         /* Free async initializer */
320         if (service->async_initializer) {
321                 g_slist_free(service->async_initializer);
322                 service->async_initializer = NULL;
323         }
324
325         /* Free plug-ins */
326         if (service->plugins) {
327                 g_slist_free(service->plugins);
328                 service->plugins = NULL;
329         }
330
331         /* Unref 'g-main loop' */
332         if (service->main_loop)
333                 g_main_loop_unref(service->main_loop);
334
335         g_free(service);
336 }
337
338 gboolean zblib_service_run(ZigBeeService *service)
339 {
340         zblib_check_null_ret_error("service", service, FALSE);
341         zblib_check_null_ret_error("service->main_loop", service->main_loop, FALSE);
342
343         g_main_loop_run(service->main_loop);
344
345         return TRUE;
346 }
347
348 gboolean zblib_service_exit(ZigBeeService *service)
349 {
350         zblib_check_null_ret_error("service", service, FALSE);
351         zblib_check_null_ret_error("service->main_loop", service->main_loop, FALSE);
352
353         g_main_loop_quit(service->main_loop);
354
355         return TRUE;
356 }
357
358 gboolean zblib_service_add_plugin(ZigBeeService *service, ZigBeePlugin *plugin)
359 {
360         gchar *plugin_name;
361
362         zblib_check_null_ret_error("service", service, FALSE);
363         zblib_check_null_ret_error("plugin", plugin, FALSE);
364
365         plugin_name = zblib_plugin_get_plugin_name(plugin);
366
367         /* All plug-ins would be appended */
368         service->plugins = g_slist_append(service->plugins, plugin);
369         Z_LOGD("%s added", plugin_name);
370         g_free(plugin_name);
371
372         return TRUE;
373 }
374
375 gboolean zblib_service_remove_plugin(ZigBeeService *service, ZigBeePlugin *plugin)
376 {
377         zblib_check_null_ret_error("service", service, FALSE);
378         zblib_check_null_ret_error("plugin", plugin, FALSE);
379
380         /* Specific vendor plug-in would be removed */
381         service->plugins = g_slist_remove(service->plugins, plugin);
382
383         /* Deinitialize plugin */
384         zblib_plugin_free(plugin);
385
386         return TRUE;
387 }
388
389 gboolean zblib_service_load_plugins(ZigBeeService *service, const char *plugin_path)
390 {
391         const gchar *file = NULL;
392         gchar *filename = NULL;
393         GDir *dir = NULL;
394         void *handle = NULL;
395         ZblibPluginDescriptor_t *descriptor = NULL;
396         ZigBeePlugin *plugin = NULL;
397         gboolean ret;
398
399         zblib_check_null_ret_error("service", service, FALSE);
400         zblib_check_null_ret_error("plugin_path", plugin_path, FALSE);
401
402         /* Open plug-in directory */
403         dir = g_dir_open(plugin_path, 0, NULL);
404         if (G_UNLIKELY(dir == NULL)) {
405                 Z_LOGE("Directory open failed!");
406                 return FALSE;
407         }
408
409         /* Scan through all libraries in plug-in directory */
410         while ((file = g_dir_read_name(dir)) != NULL) {
411                 if ((g_str_has_prefix(file, "lib") == TRUE)
412                                 || (g_str_has_suffix(file, ".so") == FALSE))
413                         continue;
414
415                 filename = g_build_filename(plugin_path, file, NULL);
416
417                 /* Load plug-in */
418                 handle = __zblib_service_load_plugin(filename, &descriptor);
419                 if (G_UNLIKELY(NULL == handle)) {
420                         g_free(filename);
421                         continue;
422                 }
423
424                 /* Create new plug-in */
425                 plugin = zblib_plugin_new(service, filename, descriptor, handle);
426                 if (G_UNLIKELY(NULL == plugin)) {
427                         dlclose(handle);
428                         g_free(filename);
429                         continue;
430                 }
431
432                 /* Add new plug-in */
433                 ret = zblib_service_add_plugin(service, plugin);
434                 if (G_UNLIKELY(FALSE == ret))
435                         zblib_plugin_free(plugin);
436
437                 g_free(filename);
438         }
439         g_dir_close(dir);
440
441         return TRUE;
442 }
443
444 gboolean zblib_service_initialize_plugins(ZigBeeService *service)
445 {
446         GSList *list;
447         GSList *list_async;
448
449         zblib_check_null_ret_error("service", service, FALSE);
450
451         /* Refer plug-in list */
452         list = zblib_service_ref_plugins(service);
453         list_async = __zblib_service_ref_async_initializer(service);
454         while (list != NULL) {
455                 /* Initialize each plug-in */
456                 ZigBeePlugin *plugin = (ZigBeePlugin *)(list->data);
457                 if (FALSE == __zblib_service_init_plugin(plugin)) {
458                         /* If there is no initializer, it should have asynchronous one */
459                         const ZblibPluginDescriptor_t *descriptor =
460                                         zblib_plugin_get_descriptor(plugin);
461                         if (NULL != descriptor && NULL != descriptor->init_async) {
462                                 /* Register async initializer */
463                                 struct _zblib_async_init_info *info =
464                                         g_try_new0(struct _zblib_async_init_info, 1);
465                                 if (NULL == info) {
466                                         Z_LOGE("Fatal : Failed to allocate memory");
467                                         return FALSE;
468                                 }
469                                 info->is_finished = FALSE;
470                                 info->is_initialized = FALSE;
471                                 info->plugin = plugin;
472                                 info->user_data = NULL;
473
474                                 list_async = g_slist_append(list_async, info);
475                         } else {
476                                 Z_LOGE("Fatal : Failed to initialize plugin");
477                                 return FALSE;
478                         }
479                 }
480                 list = g_slist_next(list);
481         }
482
483         __zblib_service_set_async_initializer(service, list_async);
484
485         return TRUE;
486 }
487
488 gboolean zblib_service_initialize_async_plugins(ZigBeeService *service)
489 {
490         GSList *list_async;
491
492         zblib_check_null_ret_error("service", service, FALSE);
493
494         /* Refer async initializer list */
495         list_async = __zblib_service_ref_async_initializer(service);
496         while (list_async != NULL) {
497                 /* Initialize each plug-in */
498                 struct _zblib_async_init_info *info =
499                                 (struct _zblib_async_init_info *)(list_async->data);
500
501                 if (G_UNLIKELY(NULL == info)) {
502                         Z_LOGE("Invalid parameter !");
503                         list_async = g_slist_next(list_async);
504                         continue;
505                 }
506
507                 if (G_UNLIKELY(FALSE == __zblib_service_init_async_plugin(
508                                         info->plugin, __on_zblib_init_async_finished, info))) {
509                         Z_LOGE("Fatal : Failed to initialize mandatory plugin");
510                         return FALSE;
511                 }
512                 list_async = g_slist_next(list_async);
513         }
514
515         return TRUE;
516 }
517
518 gboolean zblib_service_unload_plugins(ZigBeeService *service)
519 {
520         GSList *list;
521
522         zblib_check_null_ret_error("service", service, FALSE);
523
524         list = zblib_service_ref_plugins(service);
525         while (list != NULL) {
526                 ZigBeePlugin *plugin = list->data;
527
528                 /* Unload each plug-in */
529                 if (G_UNLIKELY(FALSE == __zblib_service_unload_plugin(plugin))) {
530                         list = g_slist_next(list);
531                         continue;
532                 }
533
534                 list = g_slist_next(list);
535                 zblib_service_remove_plugin(service, plugin);
536         }
537
538         return TRUE;
539 }
540
541 GSList *zblib_service_ref_plugins(ZigBeeService *service)
542 {
543         zblib_check_null_ret_error("service", service, NULL);
544
545         return service->plugins;
546 }
547
548 gboolean zblib_service_add_service_interface(ZigBeeService *service,
549         ZigBeeServiceInterface *service_interface)
550 {
551         gchar *object_name;
552
553         zblib_check_null_ret_error("service", service, FALSE);
554         zblib_check_null_ret_error("service_interface_name", service_interface, FALSE);
555
556         object_name = zblib_service_interface_get_name(service_interface);
557
558         /*
559          * All service interface objects would be appended
560          */
561         service->interface_objs = g_slist_append(service->interface_objs, service_interface);
562         Z_LOGD("%s added", object_name);
563         g_free(object_name);
564
565         return TRUE;
566 }
567
568 gboolean zblib_service_remove_service_interface(ZigBeeService *service,
569         ZigBeeServiceInterface *service_interface)
570 {
571         zblib_check_null_ret_error("service", service, FALSE);
572         zblib_check_null_ret_error("service_interface_name", service_interface, FALSE);
573
574         /*
575          * service interface object would be removed
576          */
577         service->interface_objs = g_slist_remove(service->interface_objs, service_interface);
578
579         return TRUE;
580 }
581
582 ZigBeeServiceInterface *zblib_service_ref_service_interface(ZigBeeService *service,
583         const gchar *service_interface_name)
584 {
585         ZigBeeServiceInterface *service_interface = NULL;
586         ZigBeeServiceInterface *tmp_service_interface = NULL;
587         gchar *object_name;
588
589         GSList *list;
590
591         zblib_check_null_ret_error("service", service, NULL);
592         zblib_check_null_ret_error("service_interface_name", service_interface_name, NULL);
593
594         list = service->interface_objs;
595         while (list) {
596                 tmp_service_interface = (ZigBeeServiceInterface *)list->data;
597
598                 /* Get object name of service_interface */
599                 object_name = zblib_service_interface_get_name(tmp_service_interface);
600                 if (g_strcmp0(service_interface_name, object_name) == 0) {
601                         g_free(object_name);
602
603                         service_interface = tmp_service_interface;
604                         break;
605                 }
606                 g_free(object_name);
607
608                 list = g_slist_next(list);
609         }
610
611         if (NULL == service_interface) {
612                 Z_LOGE("Service interface object of name '%s' not found!",
613                         service_interface_name);
614                 return NULL;
615         }
616
617         Z_LOGD("'%s' found", service_interface_name);
618
619         return service_interface;
620 }
621
622 GHashTable *zblib_service_ref_request_hash_table(ZigBeeService *service)
623 {
624         zblib_check_null_ret_error("service", service, NULL);
625
626         return service->request_table;
627 }
628
629 gint zblib_service_generate_request_id(ZigBeeService *service)
630 {
631         zblib_check_null_ret_error("service", service, -1);
632
633         /* Increment request ID */
634         service->request_id++;
635
636         return (gint)service->request_id;
637 }
638
639 gboolean zblib_service_dispatch_request(ZigBeeService *service,
640         guint request_id)
641 {
642         ZigBeePlugin *plugin = NULL;
643         GSList *plugin_list = NULL;
644         gboolean ret = FALSE;
645
646         zblib_check_null_ret_error("service", service, FALSE);
647
648         /* Fetch plugin_list */
649         plugin_list = service->plugins;
650         zblib_check_null_ret_error("plugin_list", plugin_list, FALSE);
651
652         while (plugin_list) {
653                 plugin = (ZigBeePlugin *)plugin_list->data;
654
655                 /* Dispatch request to plugin */
656                 ret = zblib_plugin_dispatch_request(plugin, request_id);
657
658                 /* Move to next plugin */
659                 plugin_list = g_slist_next(plugin_list);
660         }
661
662         return ret;
663 }
664
665 void zblib_service_send_response(ZigBeeService *service,
666         guint request_id, gpointer resp_data, guint resp_data_len)
667 {
668         ZigBeeServiceInterface *service_interface = NULL;
669
670         zblib_check_null_ret("service", service);
671
672         service_interface = zblib_request_ref_service_interface(service, request_id);
673         zblib_check_null_ret("service_interface", service_interface);
674
675         /* Send response to service interface */
676         zblib_service_interface_send_response(service_interface,
677                 request_id, resp_data, resp_data_len);
678 }
679
680 void zblib_service_send_notification(ZigBeeService *service,
681         guint noti_id, gpointer noti_data, guint noti_data_len)
682 {
683         GSList *interface_objs = NULL;
684         ZigBeeServiceInterface *service_interface = NULL;
685
686         zblib_check_null_ret("service", service);
687
688         interface_objs = service->interface_objs;
689         zblib_check_null_ret("interface_objs", interface_objs);
690
691         while (interface_objs) {
692                 service_interface = (ZigBeeServiceInterface *)interface_objs->data;
693
694                 /* Send notification to service interface */
695                 zblib_service_interface_send_notification(service_interface,
696                         noti_id, noti_data, noti_data_len);
697
698                 /* Move to next service interface */
699                 interface_objs = g_slist_next(interface_objs);
700         }
701 }