1db29eaea8
* RPC: Add App start, lock status - Add RPC commands Application start, lock status acquiring. - Write tests for RPC App system. - Replace Unit Tests application with CLI command. This is for CI needs and for tests that run application. * Fix NDEBUG build * Update PB submodule * Fix RPC print (ENABLE DEBUG PRINT!) * snprintf -> string_t * Fix Hard Fault (early mutex free) * printf -> string_t, format, enable tests * Update submodule: protobuf * Applications: rollback unit test naming scheme. Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
469 lines
15 KiB
C
469 lines
15 KiB
C
#include "cmsis_os.h"
|
|
#include "cmsis_os2.h"
|
|
#include "flipper.pb.h"
|
|
#include "furi-hal-delay.h"
|
|
#include "furi/check.h"
|
|
#include "furi/log.h"
|
|
#include <m-string.h>
|
|
#include "pb.h"
|
|
#include "pb_decode.h"
|
|
#include "pb_encode.h"
|
|
#include "portmacro.h"
|
|
#include "status.pb.h"
|
|
#include "storage.pb.h"
|
|
#include <stdint.h>
|
|
#include <stdio.h>
|
|
#include <furi.h>
|
|
#include <stream_buffer.h>
|
|
#include <m-dict.h>
|
|
#include "rpc_i.h"
|
|
|
|
#define RPC_TAG "RPC"
|
|
|
|
#define RPC_EVENT_NEW_DATA (1 << 0)
|
|
#define RPC_EVENT_DISCONNECT (1 << 1)
|
|
#define RPC_EVENTS_ALL (RPC_EVENT_DISCONNECT | RPC_EVENT_NEW_DATA)
|
|
|
|
#define DEBUG_PRINT 0
|
|
|
|
DICT_DEF2(RpcHandlerDict, pb_size_t, M_DEFAULT_OPLIST, RpcHandler, M_POD_OPLIST)
|
|
|
|
typedef struct {
|
|
RpcSystemAlloc alloc;
|
|
RpcSystemFree free;
|
|
void* context;
|
|
} RpcSystemCallbacks;
|
|
|
|
static RpcSystemCallbacks rpc_systems[] = {
|
|
{
|
|
.alloc = rpc_system_status_alloc,
|
|
.free = NULL,
|
|
},
|
|
{
|
|
.alloc = rpc_system_storage_alloc,
|
|
.free = rpc_system_storage_free,
|
|
},
|
|
{
|
|
.alloc = rpc_system_app_alloc,
|
|
.free = NULL,
|
|
},
|
|
};
|
|
|
|
struct RpcSession {
|
|
RpcSendBytesCallback send_bytes_callback;
|
|
void* send_bytes_context;
|
|
osMutexId_t send_bytes_mutex;
|
|
Rpc* rpc;
|
|
bool terminate_session;
|
|
void** system_contexts;
|
|
};
|
|
|
|
struct Rpc {
|
|
bool busy;
|
|
osMutexId_t busy_mutex;
|
|
RpcSession session;
|
|
osEventFlagsId_t events;
|
|
StreamBufferHandle_t stream;
|
|
RpcHandlerDict_t handlers;
|
|
PB_Main* decoded_message;
|
|
};
|
|
|
|
static bool content_callback(pb_istream_t* stream, const pb_field_t* field, void** arg);
|
|
|
|
static size_t rpc_sprintf_msg_file(
|
|
string_t str,
|
|
const char* prefix,
|
|
const PB_Storage_File* msg_file,
|
|
size_t msg_files_size) {
|
|
size_t cnt = 0;
|
|
|
|
for(int i = 0; i < msg_files_size; ++i, ++msg_file) {
|
|
string_cat_printf(
|
|
str,
|
|
"%s[%c] size: %5ld",
|
|
prefix,
|
|
msg_file->type == PB_Storage_File_FileType_DIR ? 'd' : 'f',
|
|
msg_file->size);
|
|
|
|
if(msg_file->name) {
|
|
string_cat_printf(str, " \'%s\'", msg_file->name);
|
|
}
|
|
|
|
if(msg_file->data && msg_file->data->size) {
|
|
string_cat_printf(
|
|
str,
|
|
" (%d):\'%.*s%s\'",
|
|
msg_file->data->size,
|
|
MIN(msg_file->data->size, 30),
|
|
msg_file->data->bytes,
|
|
msg_file->data->size > 30 ? "..." : "");
|
|
}
|
|
|
|
string_cat_printf(str, "\r\n");
|
|
}
|
|
|
|
return cnt;
|
|
}
|
|
|
|
void rpc_print_message(const PB_Main* message) {
|
|
string_t str;
|
|
string_init(str);
|
|
|
|
string_cat_printf(
|
|
str,
|
|
"PB_Main: {\r\n\tresult: %d cmd_id: %ld (%s)\r\n",
|
|
message->command_status,
|
|
message->command_id,
|
|
message->has_next ? "has_next" : "last");
|
|
switch(message->which_content) {
|
|
default:
|
|
/* not implemented yet */
|
|
string_cat_printf(str, "\tNOT_IMPLEMENTED (%d) {\r\n", message->which_content);
|
|
break;
|
|
case PB_Main_app_start_tag: {
|
|
string_cat_printf(str, "\tapp_start {\r\n");
|
|
const char* name = message->content.app_start.name;
|
|
const char* args = message->content.app_start.args;
|
|
if(name) {
|
|
string_cat_printf(str, "\t\tname: %s\r\n", name);
|
|
}
|
|
if(args) {
|
|
string_cat_printf(str, "\t\targs: %s\r\n", args);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_app_lock_status_request_tag: {
|
|
string_cat_printf(str, "\tapp_lock_status_request {\r\n");
|
|
break;
|
|
}
|
|
case PB_Main_app_lock_status_response_tag: {
|
|
string_cat_printf(str, "\tapp_lock_status_response {\r\n");
|
|
bool lock_status = message->content.app_lock_status_response.locked;
|
|
string_cat_printf(str, "\t\tlocked: %s\r\n", lock_status ? "true" : "false");
|
|
break;
|
|
}
|
|
case PB_Main_storage_md5sum_request_tag: {
|
|
string_cat_printf(str, "\tmd5sum_request {\r\n");
|
|
const char* path = message->content.storage_md5sum_request.path;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tpath: %s\r\n", path);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_storage_md5sum_response_tag: {
|
|
string_cat_printf(str, "\tmd5sum_response {\r\n");
|
|
const char* path = message->content.storage_md5sum_response.md5sum;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tmd5sum: %s\r\n", path);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_ping_request_tag:
|
|
string_cat_printf(str, "\tping_request {\r\n");
|
|
break;
|
|
case PB_Main_ping_response_tag:
|
|
string_cat_printf(str, "\tping_response {\r\n");
|
|
break;
|
|
case PB_Main_storage_mkdir_request_tag:
|
|
string_cat_printf(str, "\tmkdir {\r\n");
|
|
break;
|
|
case PB_Main_storage_delete_request_tag: {
|
|
string_cat_printf(str, "\tdelete {\r\n");
|
|
const char* path = message->content.storage_delete_request.path;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tpath: %s\r\n", path);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_empty_tag:
|
|
string_cat_printf(str, "\tempty {\r\n");
|
|
break;
|
|
case PB_Main_storage_list_request_tag: {
|
|
string_cat_printf(str, "\tlist_request {\r\n");
|
|
const char* path = message->content.storage_list_request.path;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tpath: %s\r\n", path);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_storage_read_request_tag: {
|
|
string_cat_printf(str, "\tread_request {\r\n");
|
|
const char* path = message->content.storage_read_request.path;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tpath: %s\r\n", path);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_storage_write_request_tag: {
|
|
string_cat_printf(str, "\twrite_request {\r\n");
|
|
const char* path = message->content.storage_write_request.path;
|
|
if(path) {
|
|
string_cat_printf(str, "\t\tpath: %s\r\n", path);
|
|
}
|
|
if(message->content.storage_write_request.has_file) {
|
|
const PB_Storage_File* msg_file = &message->content.storage_write_request.file;
|
|
rpc_sprintf_msg_file(str, "\t\t\t", msg_file, 1);
|
|
}
|
|
break;
|
|
}
|
|
case PB_Main_storage_read_response_tag:
|
|
string_cat_printf(str, "\tread_response {\r\n");
|
|
if(message->content.storage_read_response.has_file) {
|
|
const PB_Storage_File* msg_file = &message->content.storage_read_response.file;
|
|
rpc_sprintf_msg_file(str, "\t\t\t", msg_file, 1);
|
|
}
|
|
break;
|
|
case PB_Main_storage_list_response_tag: {
|
|
const PB_Storage_File* msg_file = message->content.storage_list_response.file;
|
|
size_t msg_file_count = message->content.storage_list_response.file_count;
|
|
string_cat_printf(str, "\tlist_response {\r\n");
|
|
rpc_sprintf_msg_file(str, "\t\t", msg_file, msg_file_count);
|
|
}
|
|
}
|
|
string_cat_printf(str, "\t}\r\n}\r\n");
|
|
printf("%s", string_get_cstr(str));
|
|
|
|
string_clear(str);
|
|
}
|
|
|
|
static Rpc* rpc_alloc(void) {
|
|
Rpc* rpc = furi_alloc(sizeof(Rpc));
|
|
rpc->busy_mutex = osMutexNew(NULL);
|
|
rpc->busy = false;
|
|
rpc->events = osEventFlagsNew(NULL);
|
|
rpc->stream = xStreamBufferCreate(256, 1);
|
|
|
|
rpc->decoded_message = furi_alloc(sizeof(PB_Main));
|
|
rpc->decoded_message->cb_content.funcs.decode = content_callback;
|
|
rpc->decoded_message->cb_content.arg = rpc;
|
|
|
|
RpcHandlerDict_init(rpc->handlers);
|
|
|
|
return rpc;
|
|
}
|
|
|
|
RpcSession* rpc_open_session(Rpc* rpc) {
|
|
furi_assert(rpc);
|
|
bool result = false;
|
|
furi_check(osMutexAcquire(rpc->busy_mutex, osWaitForever) == osOK);
|
|
if(rpc->busy) {
|
|
result = false;
|
|
} else {
|
|
rpc->busy = true;
|
|
result = true;
|
|
}
|
|
furi_check(osMutexRelease(rpc->busy_mutex) == osOK);
|
|
|
|
if(result) {
|
|
RpcSession* session = &rpc->session;
|
|
session->send_bytes_mutex = osMutexNew(NULL);
|
|
session->rpc = rpc;
|
|
session->terminate_session = false;
|
|
session->system_contexts = furi_alloc(COUNT_OF(rpc_systems) * sizeof(void*));
|
|
for(int i = 0; i < COUNT_OF(rpc_systems); ++i) {
|
|
session->system_contexts[i] = rpc_systems[i].alloc(rpc);
|
|
}
|
|
FURI_LOG_D(RPC_TAG, "Session started\r\n");
|
|
}
|
|
|
|
return result ? &rpc->session : NULL; /* support 1 open session for now */
|
|
}
|
|
|
|
void rpc_close_session(RpcSession* session) {
|
|
furi_assert(session);
|
|
furi_assert(session->rpc);
|
|
furi_assert(session->rpc->busy);
|
|
|
|
rpc_set_send_bytes_callback(session, NULL, NULL);
|
|
osEventFlagsSet(session->rpc->events, RPC_EVENT_DISCONNECT);
|
|
}
|
|
|
|
void rpc_set_send_bytes_callback(RpcSession* session, RpcSendBytesCallback callback, void* context) {
|
|
furi_assert(session);
|
|
furi_assert(session->rpc);
|
|
furi_assert(session->rpc->busy);
|
|
|
|
osMutexAcquire(session->send_bytes_mutex, osWaitForever);
|
|
session->send_bytes_callback = callback;
|
|
session->send_bytes_context = context;
|
|
osMutexRelease(session->send_bytes_mutex);
|
|
}
|
|
|
|
size_t
|
|
rpc_feed_bytes(RpcSession* session, uint8_t* encoded_bytes, size_t size, TickType_t timeout) {
|
|
furi_assert(session);
|
|
Rpc* rpc = session->rpc;
|
|
furi_assert(rpc->busy);
|
|
|
|
size_t bytes_sent = xStreamBufferSend(rpc->stream, encoded_bytes, size, timeout);
|
|
osEventFlagsSet(rpc->events, RPC_EVENT_NEW_DATA);
|
|
|
|
return bytes_sent;
|
|
}
|
|
|
|
bool rpc_pb_stream_read(pb_istream_t* istream, pb_byte_t* buf, size_t count) {
|
|
Rpc* rpc = istream->state;
|
|
uint32_t flags = 0;
|
|
size_t bytes_received = 0;
|
|
|
|
while(1) {
|
|
bytes_received +=
|
|
xStreamBufferReceive(rpc->stream, buf + bytes_received, count - bytes_received, 0);
|
|
if(count == bytes_received) {
|
|
break;
|
|
} else {
|
|
flags = osEventFlagsWait(rpc->events, RPC_EVENTS_ALL, 0, osWaitForever);
|
|
if(flags & RPC_EVENT_DISCONNECT) {
|
|
if(xStreamBufferIsEmpty(rpc->stream)) {
|
|
rpc->session.terminate_session = true;
|
|
break;
|
|
} else {
|
|
/* Save disconnect flag and continue reading buffer */
|
|
osEventFlagsSet(rpc->events, RPC_EVENT_DISCONNECT);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return (count == bytes_received);
|
|
}
|
|
|
|
void rpc_encode_and_send(Rpc* rpc, PB_Main* main_message) {
|
|
furi_assert(rpc);
|
|
furi_assert(main_message);
|
|
RpcSession* session = &rpc->session;
|
|
pb_ostream_t ostream = PB_OSTREAM_SIZING;
|
|
|
|
#if DEBUG_PRINT
|
|
FURI_LOG_I(RPC_TAG, "OUTPUT:");
|
|
rpc_print_message(main_message);
|
|
#endif
|
|
|
|
bool result = pb_encode_ex(&ostream, &PB_Main_msg, main_message, PB_ENCODE_DELIMITED);
|
|
furi_check(result && ostream.bytes_written);
|
|
|
|
uint8_t* buffer = furi_alloc(ostream.bytes_written);
|
|
ostream = pb_ostream_from_buffer(buffer, ostream.bytes_written);
|
|
|
|
pb_encode_ex(&ostream, &PB_Main_msg, main_message, PB_ENCODE_DELIMITED);
|
|
|
|
{
|
|
#if DEBUG_PRINT
|
|
string_t str;
|
|
string_init(str);
|
|
string_reserve(str, 100 + ostream.bytes_written * 5);
|
|
|
|
string_cat_printf(str, "\r\nREPONSE DEC(%d): {", ostream.bytes_written);
|
|
for(int i = 0; i < ostream.bytes_written; ++i) {
|
|
string_cat_printf(str, "%d, ", buffer[i]);
|
|
}
|
|
string_cat_printf(str, "}\r\n");
|
|
|
|
printf("%s", string_get_cstr(str));
|
|
string_clean(str);
|
|
string_reserve(str, 100 + ostream.bytes_written * 3);
|
|
|
|
string_cat_printf(str, "REPONSE HEX(%d): {", ostream.bytes_written);
|
|
for(int i = 0; i < ostream.bytes_written; ++i) {
|
|
string_cat_printf(str, "%02X", buffer[i]);
|
|
}
|
|
string_cat_printf(str, "}\r\n\r\n");
|
|
|
|
printf("%s", string_get_cstr(str));
|
|
#endif // DEBUG_PRINT
|
|
|
|
osMutexAcquire(session->send_bytes_mutex, osWaitForever);
|
|
if(session->send_bytes_callback) {
|
|
session->send_bytes_callback(
|
|
session->send_bytes_context, buffer, ostream.bytes_written);
|
|
}
|
|
osMutexRelease(session->send_bytes_mutex);
|
|
}
|
|
free(buffer);
|
|
}
|
|
|
|
static bool content_callback(pb_istream_t* stream, const pb_field_t* field, void** arg) {
|
|
furi_assert(stream);
|
|
Rpc* rpc = *arg;
|
|
|
|
RpcHandler* handler = RpcHandlerDict_get(rpc->handlers, field->tag);
|
|
|
|
if(handler && handler->decode_submessage) {
|
|
handler->decode_submessage(stream, field, arg);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
int32_t rpc_srv(void* p) {
|
|
Rpc* rpc = rpc_alloc();
|
|
furi_record_create("rpc", rpc);
|
|
|
|
while(1) {
|
|
pb_istream_t istream = {
|
|
.callback = rpc_pb_stream_read,
|
|
.state = rpc,
|
|
.errmsg = NULL,
|
|
.bytes_left = 0x7FFFFFFF,
|
|
};
|
|
|
|
if(pb_decode_ex(&istream, &PB_Main_msg, rpc->decoded_message, PB_DECODE_DELIMITED)) {
|
|
#if DEBUG_PRINT
|
|
FURI_LOG_I(RPC_TAG, "INPUT:");
|
|
rpc_print_message(rpc->decoded_message);
|
|
#endif
|
|
RpcHandler* handler =
|
|
RpcHandlerDict_get(rpc->handlers, rpc->decoded_message->which_content);
|
|
|
|
if(handler && handler->message_handler) {
|
|
handler->message_handler(rpc->decoded_message, handler->context);
|
|
} else if(!handler) {
|
|
FURI_LOG_E(
|
|
RPC_TAG,
|
|
"Unhandled message, tag: %d\r\n",
|
|
rpc->decoded_message->which_content);
|
|
}
|
|
pb_release(&PB_Main_msg, rpc->decoded_message);
|
|
} else {
|
|
pb_release(&PB_Main_msg, rpc->decoded_message);
|
|
RpcSession* session = &rpc->session;
|
|
if(session->terminate_session) {
|
|
session->terminate_session = false;
|
|
osEventFlagsClear(rpc->events, RPC_EVENTS_ALL);
|
|
FURI_LOG_D(RPC_TAG, "Session terminated\r\n");
|
|
for(int i = 0; i < COUNT_OF(rpc_systems); ++i) {
|
|
if(rpc_systems[i].free) {
|
|
rpc_systems[i].free(session->system_contexts[i]);
|
|
}
|
|
}
|
|
free(session->system_contexts);
|
|
osMutexDelete(session->send_bytes_mutex);
|
|
RpcHandlerDict_clean(rpc->handlers);
|
|
rpc->busy = false;
|
|
} else {
|
|
xStreamBufferReset(rpc->stream);
|
|
FURI_LOG_E(
|
|
RPC_TAG, "Decode failed, error: \'%.128s\'\r\n", PB_GET_ERROR(&istream));
|
|
}
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
void rpc_add_handler(Rpc* rpc, pb_size_t message_tag, RpcHandler* handler) {
|
|
furi_assert(RpcHandlerDict_get(rpc->handlers, message_tag) == NULL);
|
|
|
|
RpcHandlerDict_set_at(rpc->handlers, message_tag, *handler);
|
|
}
|
|
|
|
void rpc_encode_and_send_empty(Rpc* rpc, uint32_t command_id, PB_CommandStatus status) {
|
|
PB_Main message = {
|
|
.command_id = command_id,
|
|
.command_status = status,
|
|
.has_next = false,
|
|
.which_content = PB_Main_empty_tag,
|
|
};
|
|
rpc_encode_and_send(rpc, &message);
|
|
pb_release(&PB_Main_msg, &message);
|
|
}
|