1 /******************************************************************************
2  *
3  *  Copyright 2014 Google, Inc.
4  *
5  *  Licensed under the Apache License, Version 2.0 (the "License");
6  *  you may not use this file except in compliance with the License.
7  *  You may obtain a copy of the License at:
8  *
9  *  http://www.apache.org/licenses/LICENSE-2.0
10  *
11  *  Unless required by applicable law or agreed to in writing, software
12  *  distributed under the License is distributed on an "AS IS" BASIS,
13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  *  See the License for the specific language governing permissions and
15  *  limitations under the License.
16  *
17  ******************************************************************************/
18 
19 #pragma once
20 
21 #include <stdbool.h>
22 
23 #include "common/message_loop_thread.h"
24 #include "osi/include/future.h"
25 #include "osi/include/thread.h"
26 
27 typedef future_t* (*module_lifecycle_fn)(void);
28 
29 #define BTCORE_MAX_MODULE_DEPENDENCIES 10
30 
31 typedef struct {
32   const char* name;
33   module_lifecycle_fn init;
34   module_lifecycle_fn start_up;
35   module_lifecycle_fn shut_down;
36   module_lifecycle_fn clean_up;
37   const char* dependencies[BTCORE_MAX_MODULE_DEPENDENCIES];
38 } module_t;
39 
40 // Prepares module management. Must be called before doing anything with
41 // modules.
42 void module_management_start(void);
43 // Cleans up all module management resources.
44 void module_management_stop(void);
45 
46 const module_t* get_module(const char* name);
47 
48 // Initialize the provided module. |module| may not be NULL
49 // and must not be initialized.
50 bool module_init(const module_t* module);
51 // Start up the provided module. |module| may not be NULL
52 // and must be initialized or have no init function.
53 bool module_start_up(const module_t* module);
54 // Shut down the provided module. |module| may not be NULL.
55 // If not started, does nothing.
56 void module_shut_down(const module_t* module);
57 // Clean up the provided module. |module| may not be NULL.
58 // If not initialized, does nothing.
59 void module_clean_up(const module_t* module);
60 
61 // Temporary callbacked wrapper for module start up, so real modules can be
62 // spliced into the current janky startup sequence. Runs on a separate thread,
63 // which terminates when the module start up has finished. When module startup
64 // has finished, |callback| is called within the context of |callback_thread|
65 // with |FUTURE_SUCCESS| or |FUTURE_FAIL| depending on whether startup succeeded
66 // or not.
67 void module_start_up_callbacked_wrapper(
68     const module_t* module,
69     bluetooth::common::MessageLoopThread* callback_thread, thread_fn callback);
70