172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson/****************************************************************************** 272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * 372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * Copyright (C) 2014 Google, Inc. 472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * 572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * Licensed under the Apache License, Version 2.0 (the "License"); 672f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * you may not use this file except in compliance with the License. 772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * You may obtain a copy of the License at: 872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * 972f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * http://www.apache.org/licenses/LICENSE-2.0 1072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * 1172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * Unless required by applicable law or agreed to in writing, software 1272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * distributed under the License is distributed on an "AS IS" BASIS, 1372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * See the License for the specific language governing permissions and 1572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * limitations under the License. 1672f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson * 1772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson ******************************************************************************/ 1872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 19f8027005333c88a2f097cfd70d15c3d54c7764aeChris Manton#define LOG_TAG "bt_core_module" 2072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 21f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He#include <base/logging.h> 2272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson#include <dlfcn.h> 23d1e2206a9e0798e01dc18d7c7309d19f74fca9a9Etan Cohen#include <string.h> 2421da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssen 2521da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssen#include <mutex> 265c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski#include <unordered_map> 2772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 2895b74f252f534ec757aab1fc08e086e02b2cfe8dSharvil Nanavati#include "btcore/include/module.h" 29db554581079863974af8e1289646f5deea6fc044Marie Janssen#include "osi/include/allocator.h" 3044802768c447ab480d4227b3a852a97d923b816dSharvil Nanavati#include "osi/include/log.h" 31db554581079863974af8e1289646f5deea6fc044Marie Janssen#include "osi/include/osi.h" 3272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 3372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnsontypedef enum { 3472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson MODULE_STATE_NONE = 0, 3572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson MODULE_STATE_INITIALIZED = 1, 3672f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson MODULE_STATE_STARTED = 2 3772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} module_state_t; 3872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 395c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowskistatic std::unordered_map<const module_t*, module_state_t> metadata; 405c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski 4121da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssen// TODO(jamuraa): remove this lock after the startup sequence is clean 4221da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssenstatic std::mutex metadata_mutex; 4372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 4472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnsonstatic bool call_lifecycle_function(module_lifecycle_fn function); 45911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic module_state_t get_module_state(const module_t* module); 46911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void set_module_state(const module_t* module, module_state_t state); 4772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 4821da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssenvoid module_management_start(void) {} 4972f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 5072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnsonvoid module_management_stop(void) { 515c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski metadata.clear(); 5272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 5372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 54911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonconst module_t* get_module(const char* name) { 55911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson module_t* module = (module_t*)dlsym(RTLD_DEFAULT, name); 56f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(module); 5703583e8f3161836f2bef56f59a6f7bb2db25e61fZach Johnson return module; 5872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 5972f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 60911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonbool module_init(const module_t* module) { 61f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(module != NULL); 62f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(get_module_state(module) == MODULE_STATE_NONE); 6372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 6472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson if (!call_lifecycle_function(module->init)) { 65911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson LOG_ERROR(LOG_TAG, "%s Failed to initialize module \"%s\"", __func__, 66911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson module->name); 6772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson return false; 6872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson } 6972f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 7072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson set_module_state(module, MODULE_STATE_INITIALIZED); 7172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson return true; 7272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 7372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 74911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonbool module_start_up(const module_t* module) { 75f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(module != NULL); 76911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson // TODO(zachoverflow): remove module->init check once automagic order/call is 77911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson // in place. 78911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson // This hack is here so modules which don't require init don't have to have 79911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson // useless calls 8072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // as we're converting the startup sequence. 81f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(get_module_state(module) == MODULE_STATE_INITIALIZED || 82f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He module->init == NULL); 8372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 841bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov LOG_INFO(LOG_TAG, "%s Starting module \"%s\"", __func__, module->name); 8572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson if (!call_lifecycle_function(module->start_up)) { 86911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson LOG_ERROR(LOG_TAG, "%s Failed to start up module \"%s\"", __func__, 87911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson module->name); 8872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson return false; 8972f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson } 901bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov LOG_INFO(LOG_TAG, "%s Started module \"%s\"", __func__, module->name); 9172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 9272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson set_module_state(module, MODULE_STATE_STARTED); 9372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson return true; 9472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 9572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 96911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonvoid module_shut_down(const module_t* module) { 97f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(module != NULL); 9872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson module_state_t state = get_module_state(module); 99f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(state <= MODULE_STATE_STARTED); 10072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 10172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // Only something to do if the module was actually started 102911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson if (state < MODULE_STATE_STARTED) return; 10372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 1041bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov LOG_INFO(LOG_TAG, "%s Shutting down module \"%s\"", __func__, module->name); 1051bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov if (!call_lifecycle_function(module->shut_down)) { 106911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson LOG_ERROR(LOG_TAG, 107911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson "%s Failed to shutdown module \"%s\". Continuing anyway.", 1081bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov __func__, module->name); 1091bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov } 110911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson LOG_INFO(LOG_TAG, "%s Shutdown of module \"%s\" completed", __func__, 111911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson module->name); 11272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 11372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson set_module_state(module, MODULE_STATE_INITIALIZED); 11472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 11572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 116911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonvoid module_clean_up(const module_t* module) { 117f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(module != NULL); 11872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson module_state_t state = get_module_state(module); 119f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(state <= MODULE_STATE_INITIALIZED); 12072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 12172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // Only something to do if the module was actually initialized 122911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson if (state < MODULE_STATE_INITIALIZED) return; 12372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 1241bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov LOG_INFO(LOG_TAG, "%s Cleaning up module \"%s\"", __func__, module->name); 1251bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov if (!call_lifecycle_function(module->clean_up)) { 1261bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov LOG_ERROR(LOG_TAG, "%s Failed to cleanup module \"%s\". Continuing anyway.", 1271bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov __func__, module->name); 1281bd691cb8ae3c23ffe25b5ca1fcfd11b82a9fbdaPavlin Radoslavov } 129911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson LOG_INFO(LOG_TAG, "%s Cleanup of module \"%s\" completed", __func__, 130911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson module->name); 13172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 13272f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson set_module_state(module, MODULE_STATE_NONE); 13372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 13472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 13572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnsonstatic bool call_lifecycle_function(module_lifecycle_fn function) { 13672f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // A NULL lifecycle function means it isn't needed, so assume success 137911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson if (!function) return true; 13872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 139911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson future_t* future = function(); 14072f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 14172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // A NULL future means synchronous success 142911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson if (!future) return true; 14372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 14472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson // Otherwise fall back to the future 14572f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson return future_await(future); 14672f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 14772f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 148911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic module_state_t get_module_state(const module_t* module) { 14921da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssen std::lock_guard<std::mutex> lock(metadata_mutex); 1505c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski auto map_ptr = metadata.find(module); 15172f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 1525c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski return (map_ptr != metadata.end()) ? map_ptr->second : MODULE_STATE_NONE; 15372f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 15472f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson 155911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void set_module_state(const module_t* module, module_state_t state) { 15621da63773cb7734e699a4dad662b5b84d2f3dfa8Marie Janssen std::lock_guard<std::mutex> lock(metadata_mutex); 1575c2c3039539023d7946021d49a985f6655a1aedaJakub Pawlowski metadata[module] = state; 15872f308ee6d3983ae2c0d67be3de2451f2dd72dcbZach Johnson} 1593c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 1603c511e667e593c8ea594ca24b1d7712214245863Zach Johnson// TODO(zachoverflow): remove when everything modulized 1613c511e667e593c8ea594ca24b1d7712214245863Zach Johnson// Temporary callback-wrapper-related code 1623c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 1633c511e667e593c8ea594ca24b1d7712214245863Zach Johnsontypedef struct { 164911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson const module_t* module; 165911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson thread_t* lifecycle_thread; 166911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson thread_t* callback_thread; // we don't own this thread 1673c511e667e593c8ea594ca24b1d7712214245863Zach Johnson thread_fn callback; 1683c511e667e593c8ea594ca24b1d7712214245863Zach Johnson bool success; 1693c511e667e593c8ea594ca24b1d7712214245863Zach Johnson} callbacked_wrapper_t; 1703c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 171911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void run_wrapped_start_up(void* context); 172911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void post_result_to_callback(void* context); 1733c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 174911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonvoid module_start_up_callbacked_wrapper(const module_t* module, 175911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson thread_t* callback_thread, 176911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson thread_fn callback) { 177911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson callbacked_wrapper_t* wrapper = 178911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson (callbacked_wrapper_t*)osi_calloc(sizeof(callbacked_wrapper_t)); 1793c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 1803c511e667e593c8ea594ca24b1d7712214245863Zach Johnson wrapper->module = module; 1813c511e667e593c8ea594ca24b1d7712214245863Zach Johnson wrapper->lifecycle_thread = thread_new("module_wrapper"); 1823c511e667e593c8ea594ca24b1d7712214245863Zach Johnson wrapper->callback_thread = callback_thread; 1833c511e667e593c8ea594ca24b1d7712214245863Zach Johnson wrapper->callback = callback; 1843c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 1853c511e667e593c8ea594ca24b1d7712214245863Zach Johnson // Run the actual module start up 1863c511e667e593c8ea594ca24b1d7712214245863Zach Johnson thread_post(wrapper->lifecycle_thread, run_wrapped_start_up, wrapper); 1873c511e667e593c8ea594ca24b1d7712214245863Zach Johnson} 1883c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 189911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void run_wrapped_start_up(void* context) { 190f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(context); 1913c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 192911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson callbacked_wrapper_t* wrapper = (callbacked_wrapper_t*)context; 1933c511e667e593c8ea594ca24b1d7712214245863Zach Johnson wrapper->success = module_start_up(wrapper->module); 1943c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 1953c511e667e593c8ea594ca24b1d7712214245863Zach Johnson // Post the result back to the callback 1963c511e667e593c8ea594ca24b1d7712214245863Zach Johnson thread_post(wrapper->callback_thread, post_result_to_callback, wrapper); 1973c511e667e593c8ea594ca24b1d7712214245863Zach Johnson} 1983c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 199911d1ae03efec2d54c3b1b605589d790d1745488Myles Watsonstatic void post_result_to_callback(void* context) { 200f2af1c42ccb2f642b241c2261b42d0be61d45438Jack He CHECK(context); 2013c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 202911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson callbacked_wrapper_t* wrapper = (callbacked_wrapper_t*)context; 2033c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 2043c511e667e593c8ea594ca24b1d7712214245863Zach Johnson // Save the values we need for callback 205911d1ae03efec2d54c3b1b605589d790d1745488Myles Watson void* result = wrapper->success ? FUTURE_SUCCESS : FUTURE_FAIL; 2063c511e667e593c8ea594ca24b1d7712214245863Zach Johnson thread_fn callback = wrapper->callback; 2073c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 2083c511e667e593c8ea594ca24b1d7712214245863Zach Johnson // Clean up the resources we used 209a6f0395de4f636dd1b7cd2e237fe7f5321f114a6Manu Viswanadhan thread_free(wrapper->lifecycle_thread); 2103c511e667e593c8ea594ca24b1d7712214245863Zach Johnson osi_free(wrapper); 2113c511e667e593c8ea594ca24b1d7712214245863Zach Johnson 2123c511e667e593c8ea594ca24b1d7712214245863Zach Johnson callback(result); 2133c511e667e593c8ea594ca24b1d7712214245863Zach Johnson} 214