Refactored events (#621)
Event handling: - Added unified event handling for application, system, and Wi‑Fi events. - Updated all apps to reflect event handling changes Wi-Fi: - Refactored event handling from listener interface to task & event group. - Added direct Wi‑Fi radio controls and improved event subscriptions. - Wi‑Fi screens now refresh asynchronously and handle unavailable devices more gracefully. - Enabled Wi‑Fi by default on in dts files, but radio on/off is still done by code. The main reason was reliable event subscription and consistent devicetree states. - Improved Wi‑Fi shutdown cleanup and radio-state handling. Other: - Renamed the Kernel Display app to Display.
This commit is contained in:
committed by
GitHub
parent
db48dfe812
commit
ab75d2022d
@@ -6,10 +6,12 @@
|
||||
#include <tactility/delay.h>
|
||||
#include <tactility/time.h>
|
||||
|
||||
TEST_CASE("app_event_subscribe/_await deliver events in FIFO order") {
|
||||
TEST_CASE("app_event_subscribe/_poll deliver events in FIFO order") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 1;
|
||||
CHECK_EQ(app_event_subscribe(&sub), ERROR_NONE);
|
||||
CHECK_EQ(app_event_subscribe_with_app_id(&sub, &event_group, 1), ERROR_NONE);
|
||||
|
||||
for (uint32_t i = 0; i < 3; i++) {
|
||||
AppEvent event { .type = APP_EVENT_RESULT, .timestamp = 0, .result = { .launch_id = i, .result = 0 } };
|
||||
@@ -18,32 +20,38 @@ TEST_CASE("app_event_subscribe/_await deliver events in FIFO order") {
|
||||
|
||||
for (uint32_t i = 0; i < 3; i++) {
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, 0), ERROR_NONE);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_NONE);
|
||||
CHECK_EQ(out.type, APP_EVENT_RESULT);
|
||||
CHECK_EQ(out.result.launch_id, i);
|
||||
}
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_emit only delivers to subscriptions for that app_instance_id") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 10;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe_with_app_id(&sub, &event_group, 10);
|
||||
|
||||
AppEvent event { .type = APP_EVENT_CLOSE, .timestamp = 0, .result = {} };
|
||||
CHECK_EQ(app_event_emit(11, &event), ERROR_NOT_FOUND);
|
||||
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, 0), ERROR_TIMEOUT);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_TIMEOUT);
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_emit returns ERROR_RESOURCE and drops the newest event once a subscription's queue is full") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 20;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe_with_app_id(&sub, &event_group, 20);
|
||||
|
||||
for (uint32_t i = 0; i < APP_EVENT_QUEUE_CAPACITY; i++) {
|
||||
AppEvent event { .type = APP_EVENT_RESULT, .timestamp = 0, .result = { .launch_id = i, .result = 0 } };
|
||||
@@ -57,42 +65,52 @@ TEST_CASE("app_event_emit returns ERROR_RESOURCE and drops the newest event once
|
||||
// The already-queued events survive, in order, and the dropped one never arrives.
|
||||
for (uint32_t i = 0; i < APP_EVENT_QUEUE_CAPACITY; i++) {
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, 0), ERROR_NONE);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_NONE);
|
||||
CHECK_EQ(out.result.launch_id, i);
|
||||
}
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, 0), ERROR_TIMEOUT);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_TIMEOUT);
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_unsubscribe stops further delivery") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 30;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe_with_app_id(&sub, &event_group, 30);
|
||||
|
||||
CHECK_EQ(app_event_unsubscribe(&sub), ERROR_NONE);
|
||||
CHECK_EQ(app_event_unsubscribe(&sub), ERROR_NOT_FOUND);
|
||||
|
||||
AppEvent event { .type = APP_EVENT_CLOSE, .timestamp = 0, .result = {} };
|
||||
CHECK_EQ(app_event_emit(30, &event), ERROR_NOT_FOUND);
|
||||
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_await times out when no event has arrived") {
|
||||
TEST_CASE("app_event_poll times out when no event has arrived") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 40;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe_with_app_id(&sub, &event_group, 40);
|
||||
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, 0), ERROR_TIMEOUT);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_TIMEOUT);
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_emit stamps the event with the current boot-relative time") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 50;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe_with_app_id(&sub, &event_group, 50);
|
||||
|
||||
auto before = static_cast<uint64_t>(get_micros_since_boot());
|
||||
AppEvent event { .type = APP_EVENT_CLOSE, .timestamp = 0, .result = {} };
|
||||
@@ -100,17 +118,20 @@ TEST_CASE("app_event_emit stamps the event with the current boot-relative time")
|
||||
auto after = static_cast<uint64_t>(get_micros_since_boot());
|
||||
|
||||
AppEvent out {};
|
||||
REQUIRE_EQ(app_event_await(&sub, &out, 0), ERROR_NONE);
|
||||
REQUIRE_EQ(app_event_poll(&sub, &out), ERROR_NONE);
|
||||
CHECK_GE(out.timestamp, before);
|
||||
CHECK_LE(out.timestamp, after);
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
TEST_CASE("app_event_await wakes when the event is emitted from another task") {
|
||||
TEST_CASE("task_event_group_wait wakes when the event is emitted from another task") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = 60;
|
||||
CHECK_EQ(app_event_subscribe(&sub), ERROR_NONE);
|
||||
CHECK_EQ(app_event_subscribe_with_app_id(&sub, &event_group, 60), ERROR_NONE);
|
||||
|
||||
auto* thread = thread_alloc_full(
|
||||
"app-event-emitter",
|
||||
@@ -126,12 +147,14 @@ TEST_CASE("app_event_await wakes when the event is emitted from another task") {
|
||||
);
|
||||
CHECK_EQ(thread_start(thread), ERROR_NONE);
|
||||
|
||||
CHECK_EQ(task_event_group_wait(&event_group, sub.bit, false, nullptr, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
AppEvent out {};
|
||||
CHECK_EQ(app_event_await(&sub, &out, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
CHECK_EQ(app_event_poll(&sub, &out), ERROR_NONE);
|
||||
CHECK_EQ(out.type, APP_EVENT_CLOSE);
|
||||
|
||||
CHECK_EQ(thread_join(thread, pdMS_TO_TICKS(2000), 1), ERROR_NONE);
|
||||
thread_free(thread);
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
#include <app/event.h>
|
||||
#include <app/loader.h>
|
||||
#include <app/manager.h>
|
||||
#include <app/scheduler.h>
|
||||
|
||||
#include <service/manager.h>
|
||||
|
||||
@@ -55,7 +56,7 @@ void stash_received_arguments(int argc, char* argv[]) {
|
||||
// parameter (app_manager_start_for_result()), acts as a modal dialog instead: returns the
|
||||
// requested result (argv[0], parsed as an int) immediately (the app's own return value IS the
|
||||
// delivered APP_EVENT_RESULT.result - see app_scheduler.cpp's thread_main()).
|
||||
int32_t fake_run(void*, uint32_t app_instance_id, int argc, char* argv[]) {
|
||||
int32_t fake_run(void*, uint32_t /*app_instance_id*/, int argc, char* argv[]) {
|
||||
stash_received_arguments(argc, argv);
|
||||
|
||||
if (argc == 1) {
|
||||
@@ -66,21 +67,30 @@ int32_t fake_run(void*, uint32_t app_instance_id, int argc, char* argv[]) {
|
||||
return static_cast<int32_t>(strtol(argv[0], nullptr, 10));
|
||||
}
|
||||
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription sub {};
|
||||
sub.app_instance_id = app_instance_id;
|
||||
app_event_subscribe(&sub);
|
||||
app_event_subscribe(&sub, &event_group);
|
||||
|
||||
while (true) {
|
||||
AppEvent event {};
|
||||
if (app_event_await(&sub, &event, pdMS_TO_TICKS(5000)) != ERROR_NONE) {
|
||||
if (task_event_group_wait_any(&event_group, nullptr, pdMS_TO_TICKS(5000)) != ERROR_NONE) {
|
||||
break; // safety net so a bug here can't hang the test suite
|
||||
}
|
||||
if (event.type == APP_EVENT_CLOSE) {
|
||||
break;
|
||||
|
||||
bool done = false;
|
||||
AppEvent event {};
|
||||
while (app_event_poll(&sub, &event) == ERROR_NONE) {
|
||||
if (event.type == APP_EVENT_CLOSE) {
|
||||
done = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (done) break;
|
||||
}
|
||||
|
||||
app_event_unsubscribe(&sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -129,8 +139,8 @@ void ensure_memory_loader_registered() {
|
||||
|
||||
// Same subscribe-until-close contract as fake_run() above, but called directly as an AppMainFn -
|
||||
// this is what a real internal app's entry point looks like.
|
||||
int32_t fake_app_main(uint32_t app_instance_id, int argc, char* argv[]) {
|
||||
return fake_run(nullptr, app_instance_id, argc, argv);
|
||||
int32_t fake_app_main(int argc, char* argv[]) {
|
||||
return fake_run(nullptr, app_scheduler_current_app_id(), argc, argv);
|
||||
}
|
||||
|
||||
// Wraps app_manager_get_topmost_instance_id() for terse assertions: 0 if no app is Active.
|
||||
@@ -329,9 +339,11 @@ TEST_CASE("app_manager_start_for_result delivers APP_EVENT_RESULT to the parent,
|
||||
REQUIRE_EQ(app_manager_start("test.app.parent", &parent_id), ERROR_NONE);
|
||||
CHECK(wait_for_state(parent_id, APP_INSTANCE_STATE_ACTIVE, 1000));
|
||||
|
||||
TaskEventGroup parent_event_group {};
|
||||
task_event_group_construct(&parent_event_group);
|
||||
|
||||
AppEventSubscription parent_sub {};
|
||||
parent_sub.app_instance_id = parent_id;
|
||||
REQUIRE_EQ(app_event_subscribe(&parent_sub), ERROR_NONE);
|
||||
REQUIRE_EQ(app_event_subscribe_with_app_id(&parent_sub, &parent_event_group, parent_id), ERROR_NONE);
|
||||
|
||||
const char* argv[] = { "42" };
|
||||
uint32_t child_id = 0;
|
||||
@@ -340,13 +352,15 @@ TEST_CASE("app_manager_start_for_result delivers APP_EVENT_RESULT to the parent,
|
||||
// Launching a modal child never touches the parent's own task/state.
|
||||
CHECK_EQ(app_manager_get_state(parent_id), APP_INSTANCE_STATE_ACTIVE);
|
||||
|
||||
REQUIRE_EQ(task_event_group_wait(&parent_event_group, parent_sub.bit, false, nullptr, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
AppEvent event {};
|
||||
REQUIRE_EQ(app_event_await(&parent_sub, &event, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
REQUIRE_EQ(app_event_poll(&parent_sub, &event), ERROR_NONE);
|
||||
CHECK_EQ(event.type, APP_EVENT_RESULT);
|
||||
CHECK_EQ(event.result.launch_id, child_id);
|
||||
CHECK_EQ(event.result.result, 42);
|
||||
|
||||
app_event_unsubscribe(&parent_sub);
|
||||
task_event_group_destruct(&parent_event_group);
|
||||
app_manager_stop(child_id);
|
||||
app_manager_stop(parent_id);
|
||||
app_manager_remove("test.app.parent");
|
||||
@@ -365,9 +379,11 @@ TEST_CASE("app_manager_start_for_result delivers the child's own return value as
|
||||
REQUIRE_EQ(app_manager_start("test.app.parent2", &parent_id), ERROR_NONE);
|
||||
CHECK(wait_for_state(parent_id, APP_INSTANCE_STATE_ACTIVE, 1000));
|
||||
|
||||
TaskEventGroup parent_event_group {};
|
||||
task_event_group_construct(&parent_event_group);
|
||||
|
||||
AppEventSubscription parent_sub {};
|
||||
parent_sub.app_instance_id = parent_id;
|
||||
REQUIRE_EQ(app_event_subscribe(&parent_sub), ERROR_NONE);
|
||||
REQUIRE_EQ(app_event_subscribe_with_app_id(&parent_sub, &parent_event_group, parent_id), ERROR_NONE);
|
||||
|
||||
uint32_t child_id = 0;
|
||||
// No parameters - fake_run falls through to its normal CLOSE loop instead of acting as a
|
||||
@@ -377,13 +393,15 @@ TEST_CASE("app_manager_start_for_result delivers the child's own return value as
|
||||
|
||||
app_manager_stop(child_id); // force-close
|
||||
|
||||
REQUIRE_EQ(task_event_group_wait(&parent_event_group, parent_sub.bit, false, nullptr, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
AppEvent event {};
|
||||
REQUIRE_EQ(app_event_await(&parent_sub, &event, pdMS_TO_TICKS(2000)), ERROR_NONE);
|
||||
REQUIRE_EQ(app_event_poll(&parent_sub, &event), ERROR_NONE);
|
||||
CHECK_EQ(event.type, APP_EVENT_RESULT);
|
||||
CHECK_EQ(event.result.launch_id, child_id);
|
||||
CHECK_EQ(event.result.result, 0); // fake_run's CLOSE loop always returns 0
|
||||
|
||||
app_event_unsubscribe(&parent_sub);
|
||||
task_event_group_destruct(&parent_event_group);
|
||||
app_manager_stop(parent_id);
|
||||
app_manager_remove("test.app.parent2");
|
||||
app_manager_remove("test.app.child2");
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
#include "doctest.h"
|
||||
|
||||
#include <app/event.h>
|
||||
|
||||
#include <tactility/system_event.h>
|
||||
|
||||
// Regression coverage for the primary motivation behind TaskEventGroup: a task subscribed to
|
||||
// both an app_event and a system_event must be able to block once and wake for either, without
|
||||
// losing an event or regressing either subsystem's own delivery semantics (FIFO for app_event,
|
||||
// coalescing for system_event).
|
||||
|
||||
TEST_CASE("a task can wait on app_event and system_event together via one TaskEventGroup") {
|
||||
TaskEventGroup event_group {};
|
||||
task_event_group_construct(&event_group);
|
||||
|
||||
AppEventSubscription app_sub {};
|
||||
CHECK_EQ(app_event_subscribe_with_app_id(&app_sub, &event_group, 100), ERROR_NONE);
|
||||
|
||||
SystemEventSubscription sys_sub {};
|
||||
sys_sub.event.type = KERNEL_EVENT_BOOT_COMPLETED;
|
||||
CHECK_EQ(system_event_subscribe(&sys_sub, &event_group), ERROR_NONE);
|
||||
|
||||
// Distinct bits, so a combined wait can tell (via out_flags) which source(s) fired.
|
||||
CHECK_NE(app_sub.bit, sys_sub.bit);
|
||||
|
||||
uint32_t both_bits = app_sub.bit | sys_sub.bit;
|
||||
|
||||
// Only app_event fires: combined wait matches just that bit, and only app_event_poll()
|
||||
// finds something to pop.
|
||||
AppEvent emitted { .type = APP_EVENT_CLOSE, .timestamp = 0, .result = {} };
|
||||
CHECK_EQ(app_event_emit(100, &emitted), ERROR_NONE);
|
||||
|
||||
uint32_t out_flags = 0;
|
||||
CHECK_EQ(task_event_group_wait(&event_group, both_bits, false, &out_flags, 0), ERROR_NONE);
|
||||
CHECK_EQ(out_flags, app_sub.bit);
|
||||
|
||||
AppEvent app_out {};
|
||||
CHECK_EQ(app_event_poll(&app_sub, &app_out), ERROR_NONE);
|
||||
CHECK_EQ(app_out.type, APP_EVENT_CLOSE);
|
||||
CHECK_EQ(system_event_poll(&sys_sub), ERROR_TIMEOUT);
|
||||
|
||||
// Only system_event fires: combined wait matches just that bit, and only
|
||||
// system_event_poll() finds something pending.
|
||||
CHECK_EQ(system_event_emit(KERNEL_EVENT_BOOT_COMPLETED, nullptr, 0), ERROR_NONE);
|
||||
|
||||
out_flags = 0;
|
||||
CHECK_EQ(task_event_group_wait(&event_group, both_bits, false, &out_flags, 0), ERROR_NONE);
|
||||
CHECK_EQ(out_flags, sys_sub.bit);
|
||||
|
||||
CHECK_EQ(system_event_poll(&sys_sub), ERROR_NONE);
|
||||
AppEvent app_out2 {};
|
||||
CHECK_EQ(app_event_poll(&app_sub, &app_out2), ERROR_TIMEOUT);
|
||||
|
||||
// Both fire before the wait: combined wait matches both bits, and both subsystems' own
|
||||
// polls (which re-check their own state rather than trusting the bit) still deliver.
|
||||
CHECK_EQ(app_event_emit(100, &emitted), ERROR_NONE);
|
||||
CHECK_EQ(system_event_emit(KERNEL_EVENT_BOOT_COMPLETED, nullptr, 0), ERROR_NONE);
|
||||
|
||||
out_flags = 0;
|
||||
CHECK_EQ(task_event_group_wait(&event_group, both_bits, false, &out_flags, 0), ERROR_NONE);
|
||||
CHECK_EQ(out_flags, both_bits);
|
||||
|
||||
CHECK_EQ(app_event_poll(&app_sub, &app_out), ERROR_NONE);
|
||||
CHECK_EQ(system_event_poll(&sys_sub), ERROR_NONE);
|
||||
|
||||
// Unsubscribe order (system_event before app_event) must not matter - the group outlives
|
||||
// both and is destructed last.
|
||||
system_event_unsubscribe(&sys_sub);
|
||||
app_event_unsubscribe(&app_sub);
|
||||
task_event_group_destruct(&event_group);
|
||||
}
|
||||
Reference in New Issue
Block a user