mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-12-20 17:53:20 +00:00
541 lines
No EOL
18 KiB
C
541 lines
No EOL
18 KiB
C
#include "loader.h"
|
|
#include "core/core_defines.h"
|
|
#include "loader_i.h"
|
|
#include <applications.h>
|
|
#include <storage/storage.h>
|
|
#include <furi_hal.h>
|
|
#include <assets_icons.h>
|
|
|
|
#include <dialogs/dialogs.h>
|
|
#include <toolbox/path.h>
|
|
#include <flipper_application/flipper_application.h>
|
|
#include <loader/firmware_api/firmware_api.h>
|
|
|
|
#define TAG "Loader"
|
|
#define LOADER_MAGIC_THREAD_VALUE 0xDEADBEEF
|
|
|
|
// helpers
|
|
|
|
static const char* loader_find_external_application_by_name(const char* app_name) {
|
|
for(size_t i = 0; i < FLIPPER_EXTERNAL_APPS_COUNT; i++) {
|
|
if(strcmp(FLIPPER_EXTERNAL_APPS[i].name, app_name) == 0) {
|
|
return FLIPPER_EXTERNAL_APPS[i].path;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
// API
|
|
|
|
LoaderStatus
|
|
loader_start(Loader* loader, const char* name, const char* args, FuriString* error_message) {
|
|
LoaderMessage message;
|
|
LoaderMessageLoaderStatusResult result;
|
|
|
|
message.type = LoaderMessageTypeStartByName;
|
|
message.start.name = name;
|
|
message.start.args = args;
|
|
message.start.error_message = error_message;
|
|
message.api_lock = api_lock_alloc_locked();
|
|
message.status_value = &result;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
api_lock_wait_unlock_and_free(message.api_lock);
|
|
return result.value;
|
|
}
|
|
|
|
LoaderStatus loader_start_with_gui_error(Loader* loader, const char* name, const char* args) {
|
|
FuriString* error_message = furi_string_alloc();
|
|
LoaderStatus status = loader_start(loader, name, args, error_message);
|
|
|
|
if(status == LoaderStatusErrorUnknownApp &&
|
|
loader_find_external_application_by_name(name) != NULL) {
|
|
// Special case for external apps
|
|
DialogsApp* dialogs = furi_record_open(RECORD_DIALOGS);
|
|
DialogMessage* message = dialog_message_alloc();
|
|
dialog_message_set_header(message, "Update needed", 64, 3, AlignCenter, AlignTop);
|
|
dialog_message_set_buttons(message, NULL, NULL, NULL);
|
|
dialog_message_set_icon(message, &I_DolphinCommon_56x48, 72, 17);
|
|
dialog_message_set_text(
|
|
message, "Update firmware\nto run this app", 3, 26, AlignLeft, AlignTop);
|
|
dialog_message_show(dialogs, message);
|
|
dialog_message_free(message);
|
|
furi_record_close(RECORD_DIALOGS);
|
|
} else if(status == LoaderStatusErrorUnknownApp || status == LoaderStatusErrorInternal) {
|
|
// TODO FL-3522: we have many places where we can emit a double start, ex: desktop, menu
|
|
// so i prefer to not show LoaderStatusErrorAppStarted error message for now
|
|
DialogsApp* dialogs = furi_record_open(RECORD_DIALOGS);
|
|
DialogMessage* message = dialog_message_alloc();
|
|
dialog_message_set_header(message, "Error", 64, 0, AlignCenter, AlignTop);
|
|
dialog_message_set_buttons(message, NULL, NULL, NULL);
|
|
|
|
furi_string_replace(error_message, "/ext/apps/", "");
|
|
furi_string_replace(error_message, ", ", "\n");
|
|
furi_string_replace(error_message, ": ", "\n");
|
|
|
|
dialog_message_set_text(
|
|
message, furi_string_get_cstr(error_message), 64, 35, AlignCenter, AlignCenter);
|
|
|
|
dialog_message_show(dialogs, message);
|
|
dialog_message_free(message);
|
|
furi_record_close(RECORD_DIALOGS);
|
|
}
|
|
|
|
furi_string_free(error_message);
|
|
return status;
|
|
}
|
|
|
|
bool loader_lock(Loader* loader) {
|
|
LoaderMessage message;
|
|
LoaderMessageBoolResult result;
|
|
message.type = LoaderMessageTypeLock;
|
|
message.api_lock = api_lock_alloc_locked();
|
|
message.bool_value = &result;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
api_lock_wait_unlock_and_free(message.api_lock);
|
|
return result.value;
|
|
}
|
|
|
|
void loader_unlock(Loader* loader) {
|
|
LoaderMessage message;
|
|
message.type = LoaderMessageTypeUnlock;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
}
|
|
|
|
bool loader_is_locked(Loader* loader) {
|
|
LoaderMessage message;
|
|
LoaderMessageBoolResult result;
|
|
message.type = LoaderMessageTypeIsLocked;
|
|
message.api_lock = api_lock_alloc_locked();
|
|
message.bool_value = &result;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
api_lock_wait_unlock_and_free(message.api_lock);
|
|
return result.value;
|
|
}
|
|
|
|
void loader_show_menu(Loader* loader) {
|
|
LoaderMessage message;
|
|
message.type = LoaderMessageTypeShowMenu;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
}
|
|
|
|
FuriPubSub* loader_get_pubsub(Loader* loader) {
|
|
furi_assert(loader);
|
|
// it's safe to return pubsub without locking
|
|
// because it's never freed and loader is never exited
|
|
// also the loader instance cannot be obtained until the pubsub is created
|
|
return loader->pubsub;
|
|
}
|
|
|
|
// callbacks
|
|
|
|
static void loader_menu_closed_callback(void* context) {
|
|
Loader* loader = context;
|
|
LoaderMessage message;
|
|
message.type = LoaderMessageTypeMenuClosed;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
}
|
|
|
|
static void loader_applications_closed_callback(void* context) {
|
|
Loader* loader = context;
|
|
LoaderMessage message;
|
|
message.type = LoaderMessageTypeApplicationsClosed;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
}
|
|
|
|
static void loader_thread_state_callback(FuriThreadState thread_state, void* context) {
|
|
furi_assert(context);
|
|
|
|
Loader* loader = context;
|
|
|
|
if(thread_state == FuriThreadStateRunning) {
|
|
LoaderEvent event;
|
|
event.type = LoaderEventTypeApplicationStarted;
|
|
furi_pubsub_publish(loader->pubsub, &event);
|
|
} else if(thread_state == FuriThreadStateStopped) {
|
|
LoaderMessage message;
|
|
message.type = LoaderMessageTypeAppClosed;
|
|
furi_message_queue_put(loader->queue, &message, FuriWaitForever);
|
|
}
|
|
}
|
|
|
|
// implementation
|
|
|
|
static Loader* loader_alloc() {
|
|
Loader* loader = malloc(sizeof(Loader));
|
|
loader->pubsub = furi_pubsub_alloc();
|
|
loader->queue = furi_message_queue_alloc(1, sizeof(LoaderMessage));
|
|
loader->loader_menu = NULL;
|
|
loader->loader_applications = NULL;
|
|
loader->app.args = NULL;
|
|
loader->app.thread = NULL;
|
|
loader->app.insomniac = false;
|
|
loader->app.fap = NULL;
|
|
return loader;
|
|
}
|
|
|
|
static FlipperInternalApplication const* loader_find_application_by_name_in_list(
|
|
const char* name,
|
|
const FlipperInternalApplication* list,
|
|
const uint32_t n_apps) {
|
|
for(size_t i = 0; i < n_apps; i++) {
|
|
if(strcmp(name, list[i].name) == 0) {
|
|
return &list[i];
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
static const FlipperInternalApplication* loader_find_application_by_name(const char* name) {
|
|
const struct {
|
|
const FlipperInternalApplication* list;
|
|
const uint32_t count;
|
|
} lists[] = {
|
|
{FLIPPER_SETTINGS_APPS, FLIPPER_SETTINGS_APPS_COUNT},
|
|
{FLIPPER_SYSTEM_APPS, FLIPPER_SYSTEM_APPS_COUNT},
|
|
{FLIPPER_DEBUG_APPS, FLIPPER_DEBUG_APPS_COUNT},
|
|
};
|
|
|
|
for(size_t i = 0; i < COUNT_OF(lists); i++) {
|
|
const FlipperInternalApplication* application =
|
|
loader_find_application_by_name_in_list(name, lists[i].list, lists[i].count);
|
|
if(application) {
|
|
return application;
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
static void loader_start_app_thread(Loader* loader, FlipperInternalApplicationFlag flags) {
|
|
// setup heap trace
|
|
FuriHalRtcHeapTrackMode mode = furi_hal_rtc_get_heap_track_mode();
|
|
if(mode > FuriHalRtcHeapTrackModeNone) {
|
|
furi_thread_enable_heap_trace(loader->app.thread);
|
|
} else {
|
|
furi_thread_disable_heap_trace(loader->app.thread);
|
|
}
|
|
|
|
// setup insomnia
|
|
if(!(flags & FlipperInternalApplicationFlagInsomniaSafe)) {
|
|
furi_hal_power_insomnia_enter();
|
|
loader->app.insomniac = true;
|
|
} else {
|
|
loader->app.insomniac = false;
|
|
}
|
|
|
|
// setup thread state callbacks
|
|
furi_thread_set_state_context(loader->app.thread, loader);
|
|
furi_thread_set_state_callback(loader->app.thread, loader_thread_state_callback);
|
|
|
|
// start app thread
|
|
furi_thread_start(loader->app.thread);
|
|
}
|
|
|
|
static void loader_start_internal_app(
|
|
Loader* loader,
|
|
const FlipperInternalApplication* app,
|
|
const char* args) {
|
|
FURI_LOG_I(TAG, "Starting %s", app->name);
|
|
|
|
// store args
|
|
furi_assert(loader->app.args == NULL);
|
|
if(args && strlen(args) > 0) {
|
|
loader->app.args = strdup(args);
|
|
}
|
|
|
|
loader->app.thread =
|
|
furi_thread_alloc_ex(app->name, app->stack_size, app->app, loader->app.args);
|
|
furi_thread_set_appid(loader->app.thread, app->appid);
|
|
|
|
loader_start_app_thread(loader, app->flags);
|
|
}
|
|
|
|
static void loader_log_status_error(
|
|
LoaderStatus status,
|
|
FuriString* error_message,
|
|
const char* format,
|
|
va_list args) {
|
|
if(error_message) {
|
|
furi_string_vprintf(error_message, format, args);
|
|
FURI_LOG_E(TAG, "Status [%d]: %s", status, furi_string_get_cstr(error_message));
|
|
} else {
|
|
FURI_LOG_E(TAG, "Status [%d]", status);
|
|
}
|
|
}
|
|
|
|
static LoaderStatus loader_make_status_error(
|
|
LoaderStatus status,
|
|
FuriString* error_message,
|
|
const char* format,
|
|
...) {
|
|
va_list args;
|
|
va_start(args, format);
|
|
loader_log_status_error(status, error_message, format, args);
|
|
va_end(args);
|
|
return status;
|
|
}
|
|
|
|
static LoaderStatus loader_make_success_status(FuriString* error_message) {
|
|
if(error_message) {
|
|
furi_string_set(error_message, "App started");
|
|
}
|
|
|
|
return LoaderStatusOk;
|
|
}
|
|
|
|
static LoaderStatus loader_start_external_app(
|
|
Loader* loader,
|
|
Storage* storage,
|
|
const char* path,
|
|
const char* args,
|
|
FuriString* error_message) {
|
|
LoaderStatus status = loader_make_success_status(error_message);
|
|
|
|
do {
|
|
loader->app.fap = flipper_application_alloc(storage, firmware_api_interface);
|
|
size_t start = furi_get_tick();
|
|
|
|
FURI_LOG_I(TAG, "Loading %s", path);
|
|
|
|
FlipperApplicationPreloadStatus preload_res =
|
|
flipper_application_preload(loader->app.fap, path);
|
|
if(preload_res != FlipperApplicationPreloadStatusSuccess) {
|
|
const char* err_msg = flipper_application_preload_status_to_string(preload_res);
|
|
status = loader_make_status_error(
|
|
LoaderStatusErrorInternal, error_message, "Preload failed, %s: %s", path, err_msg);
|
|
break;
|
|
}
|
|
|
|
FlipperApplicationLoadStatus load_status =
|
|
flipper_application_map_to_memory(loader->app.fap);
|
|
if(load_status != FlipperApplicationLoadStatusSuccess) {
|
|
const char* err_msg = flipper_application_load_status_to_string(load_status);
|
|
status = loader_make_status_error(
|
|
LoaderStatusErrorInternal, error_message, "Load failed, %s: %s", path, err_msg);
|
|
break;
|
|
}
|
|
|
|
FURI_LOG_I(TAG, "Loaded in %zums", (size_t)(furi_get_tick() - start));
|
|
|
|
loader->app.thread = flipper_application_alloc_thread(loader->app.fap, args);
|
|
FuriString* app_name = furi_string_alloc();
|
|
path_extract_filename_no_ext(path, app_name);
|
|
furi_thread_set_appid(loader->app.thread, furi_string_get_cstr(app_name));
|
|
furi_string_free(app_name);
|
|
|
|
/* This flag is set by the debugger - to break on app start */
|
|
if(furi_hal_debug_is_gdb_session_active()) {
|
|
FURI_LOG_W(TAG, "Triggering BP for debugger");
|
|
/* After hitting this, you can set breakpoints in your .fap's code
|
|
* Note that you have to toggle breakpoints that were set before */
|
|
__asm volatile("bkpt 0");
|
|
}
|
|
|
|
loader_start_app_thread(loader, FlipperInternalApplicationFlagDefault);
|
|
} while(0);
|
|
|
|
if(status != LoaderStatusOk) {
|
|
flipper_application_free(loader->app.fap);
|
|
loader->app.fap = NULL;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
// process messages
|
|
|
|
static void loader_do_menu_show(Loader* loader) {
|
|
if(!loader->loader_menu) {
|
|
loader->loader_menu = loader_menu_alloc(loader_menu_closed_callback, loader);
|
|
}
|
|
}
|
|
|
|
static void loader_do_menu_closed(Loader* loader) {
|
|
if(loader->loader_menu) {
|
|
loader_menu_free(loader->loader_menu);
|
|
loader->loader_menu = NULL;
|
|
}
|
|
}
|
|
|
|
static void loader_do_applications_show(Loader* loader) {
|
|
if(!loader->loader_applications) {
|
|
loader->loader_applications =
|
|
loader_applications_alloc(loader_applications_closed_callback, loader);
|
|
}
|
|
}
|
|
|
|
static void loader_do_applications_closed(Loader* loader) {
|
|
if(loader->loader_applications) {
|
|
loader_applications_free(loader->loader_applications);
|
|
loader->loader_applications = NULL;
|
|
}
|
|
}
|
|
|
|
static bool loader_do_is_locked(Loader* loader) {
|
|
return loader->app.thread != NULL;
|
|
}
|
|
|
|
static LoaderStatus loader_do_start_by_name(
|
|
Loader* loader,
|
|
const char* name,
|
|
const char* args,
|
|
FuriString* error_message) {
|
|
LoaderStatus status;
|
|
do {
|
|
// check lock
|
|
if(loader_do_is_locked(loader)) {
|
|
const char* current_thread_name =
|
|
furi_thread_get_name(furi_thread_get_id(loader->app.thread));
|
|
status = loader_make_status_error(
|
|
LoaderStatusErrorAppStarted,
|
|
error_message,
|
|
"Loader is locked, please close the \"%s\" first",
|
|
current_thread_name);
|
|
break;
|
|
}
|
|
|
|
// check internal apps
|
|
{
|
|
const FlipperInternalApplication* app = loader_find_application_by_name(name);
|
|
if(app) {
|
|
loader_start_internal_app(loader, app, args);
|
|
status = loader_make_success_status(error_message);
|
|
break;
|
|
}
|
|
}
|
|
|
|
// check Applications
|
|
if(strcmp(name, LOADER_APPLICATIONS_NAME) == 0) {
|
|
loader_do_applications_show(loader);
|
|
status = loader_make_success_status(error_message);
|
|
break;
|
|
}
|
|
|
|
// check External Applications
|
|
{
|
|
const char* path = loader_find_external_application_by_name(name);
|
|
if(path) {
|
|
name = path;
|
|
}
|
|
}
|
|
|
|
// check Faps
|
|
{
|
|
Storage* storage = furi_record_open(RECORD_STORAGE);
|
|
if(storage_file_exists(storage, name)) {
|
|
status = loader_start_external_app(loader, storage, name, args, error_message);
|
|
furi_record_close(RECORD_STORAGE);
|
|
break;
|
|
}
|
|
furi_record_close(RECORD_STORAGE);
|
|
}
|
|
|
|
status = loader_make_status_error(
|
|
LoaderStatusErrorUnknownApp, error_message, "Application \"%s\" not found", name);
|
|
} while(false);
|
|
|
|
return status;
|
|
}
|
|
|
|
static bool loader_do_lock(Loader* loader) {
|
|
if(loader->app.thread) {
|
|
return false;
|
|
}
|
|
|
|
loader->app.thread = (FuriThread*)LOADER_MAGIC_THREAD_VALUE;
|
|
return true;
|
|
}
|
|
|
|
static void loader_do_unlock(Loader* loader) {
|
|
furi_check(loader->app.thread == (FuriThread*)LOADER_MAGIC_THREAD_VALUE);
|
|
loader->app.thread = NULL;
|
|
}
|
|
|
|
static void loader_do_app_closed(Loader* loader) {
|
|
furi_assert(loader->app.thread);
|
|
|
|
furi_thread_join(loader->app.thread);
|
|
FURI_LOG_I(TAG, "App returned: %li", furi_thread_get_return_code(loader->app.thread));
|
|
|
|
if(loader->app.args) {
|
|
free(loader->app.args);
|
|
loader->app.args = NULL;
|
|
}
|
|
|
|
if(loader->app.insomniac) {
|
|
furi_hal_power_insomnia_exit();
|
|
}
|
|
|
|
if(loader->app.fap) {
|
|
flipper_application_free(loader->app.fap);
|
|
loader->app.fap = NULL;
|
|
loader->app.thread = NULL;
|
|
} else {
|
|
furi_thread_free(loader->app.thread);
|
|
loader->app.thread = NULL;
|
|
}
|
|
|
|
FURI_LOG_I(TAG, "Application stopped. Free heap: %zu", memmgr_get_free_heap());
|
|
|
|
LoaderEvent event;
|
|
event.type = LoaderEventTypeApplicationStopped;
|
|
furi_pubsub_publish(loader->pubsub, &event);
|
|
}
|
|
|
|
// app
|
|
|
|
int32_t loader_srv(void* p) {
|
|
UNUSED(p);
|
|
Loader* loader = loader_alloc();
|
|
furi_record_create(RECORD_LOADER, loader);
|
|
|
|
FURI_LOG_I(TAG, "Executing system start hooks");
|
|
for(size_t i = 0; i < FLIPPER_ON_SYSTEM_START_COUNT; i++) {
|
|
FLIPPER_ON_SYSTEM_START[i]();
|
|
}
|
|
|
|
if((furi_hal_rtc_get_boot_mode() == FuriHalRtcBootModeNormal) && FLIPPER_AUTORUN_APP_NAME &&
|
|
strlen(FLIPPER_AUTORUN_APP_NAME)) {
|
|
FURI_LOG_I(TAG, "Starting autorun app: %s", FLIPPER_AUTORUN_APP_NAME);
|
|
loader_do_start_by_name(loader, FLIPPER_AUTORUN_APP_NAME, NULL, NULL);
|
|
}
|
|
|
|
LoaderMessage message;
|
|
while(true) {
|
|
if(furi_message_queue_get(loader->queue, &message, FuriWaitForever) == FuriStatusOk) {
|
|
switch(message.type) {
|
|
case LoaderMessageTypeStartByName:
|
|
message.status_value->value = loader_do_start_by_name(
|
|
loader, message.start.name, message.start.args, message.start.error_message);
|
|
api_lock_unlock(message.api_lock);
|
|
break;
|
|
case LoaderMessageTypeShowMenu:
|
|
loader_do_menu_show(loader);
|
|
break;
|
|
case LoaderMessageTypeMenuClosed:
|
|
loader_do_menu_closed(loader);
|
|
break;
|
|
case LoaderMessageTypeIsLocked:
|
|
message.bool_value->value = loader_do_is_locked(loader);
|
|
api_lock_unlock(message.api_lock);
|
|
break;
|
|
case LoaderMessageTypeAppClosed:
|
|
loader_do_app_closed(loader);
|
|
break;
|
|
case LoaderMessageTypeLock:
|
|
message.bool_value->value = loader_do_lock(loader);
|
|
api_lock_unlock(message.api_lock);
|
|
break;
|
|
case LoaderMessageTypeUnlock:
|
|
loader_do_unlock(loader);
|
|
break;
|
|
case LoaderMessageTypeApplicationsClosed:
|
|
loader_do_applications_closed(loader);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
} |