Add missing clean_up step for the OSI module.

Now the OSI module's shut_down processing is split into "shut_down"
and "clean_up".

Previously, there was an ordering issue manipulating some of the
internal state during graceful shutdown/cleanup. Some of the modules
had two steps: shut_down, followed by clean_up, while other had only
shut_down step. This triggered the following assert in file alarm.c

    alarm_cancel: assertion "alarms != NULL" failed

Bug: 21406940
Change-Id: Iab1f033a69cbff646a6b0f346760ae82f8b00b8f

diff --git a/btcore/src/osi_module.c b/btcore/src/osi_module.c
index 40c27d5..a9fff61 100644 (file)
--- a/btcore/src/osi_module.c
+++ b/btcore/src/osi_module.c
@@ -34,11 +34,16 @@ future_t *osi_shut_down(void) {
   return NULL;
 }
 
+future_t *osi_clean_up(void) {
+  alarm_cleanup();
+  return NULL;
+}
+
 const module_t osi_module = {
   .name = OSI_MODULE,
   .init = NULL,
   .start_up = osi_start_up,
   .shut_down = osi_shut_down,
-  .clean_up = NULL,
+  .clean_up = osi_clean_up,
   .dependencies = {NULL}
 };

diff --git a/btif/src/stack_manager.c b/btif/src/stack_manager.c
index 3b64648..2fa8fc3 100644 (file)
--- a/btif/src/stack_manager.c
+++ b/btif/src/stack_manager.c
@@ -186,6 +186,7 @@ static void event_clean_up_stack(UNUSED_ATTR void *context) {
 
   btif_shutdown_bluetooth();
   module_clean_up(get_module(BTIF_CONFIG_MODULE));
+  module_clean_up(get_module(OSI_MODULE));
   module_clean_up(get_module(BT_UTILS_MODULE));
 
   future_await(hack_future);

diff --git a/osi/include/alarm.h b/osi/include/alarm.h
index 5a372dc..470c482 100644 (file)
--- a/osi/include/alarm.h
+++ b/osi/include/alarm.h
@@ -55,3 +55,6 @@ void alarm_cancel(alarm_t *alarm);
 // Shuts down the alarm dispatch callback. To be called during module/stack
 // shutdown only.
 void alarm_shutdown(void);
+
+// Alarm-related state cleanup
+void alarm_cleanup(void);

diff --git a/osi/src/alarm.c b/osi/src/alarm.c
index 6a10b83..1ec090f 100644 (file)
--- a/osi/src/alarm.c
+++ b/osi/src/alarm.c
@@ -190,6 +190,12 @@ void alarm_shutdown(void) {
   semaphore_free(alarm_expired);
   alarm_expired = NULL;
   timer_delete(&timer);
+}
+
+void alarm_cleanup(void) {
+  // If lazy_initialize never ran there is nothing to do
+  if (!alarms)
+    return;
 
   list_free(alarms);
   alarms = NULL;

diff --git a/osi/test/AlarmTestHarness.cpp b/osi/test/AlarmTestHarness.cpp
index ce7a62f..98b25af 100644 (file)
--- a/osi/test/AlarmTestHarness.cpp
+++ b/osi/test/AlarmTestHarness.cpp
@@ -53,6 +53,7 @@ void AlarmTestHarness::SetUp() {
 
 void AlarmTestHarness::TearDown() {
   alarm_shutdown();
+  alarm_cleanup();
   timer_delete(timer);
   AllocationTestHarness::TearDown();
 }