esp_event.c 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888
  1. // Copyright 2018 Espressif Systems (Shanghai) PTE LTD
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. // http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  13. #include <stdlib.h>
  14. #include <string.h>
  15. #include <stdio.h>
  16. #include <stdbool.h>
  17. #include "esp_log.h"
  18. #include "esp_event.h"
  19. #include "esp_event_internal.h"
  20. #include "esp_event_private.h"
  21. #ifdef CONFIG_EVENT_LOOP_PROFILING
  22. #include "esp_timer.h"
  23. #endif
  24. /* ---------------------------- Definitions --------------------------------- */
  25. #ifdef CONFIG_EVENT_LOOP_PROFILING
  26. // LOOP @<address, name> rx:<recieved events no.> dr:<dropped events no.>
  27. #define LOOP_DUMP_FORMAT "LOOP @%p,%s rx:%u dr:%u\n"
  28. // handler @<address> ev:<base, id> inv:<times invoked> time:<runtime>
  29. #define HANDLER_DUMP_FORMAT " HANDLER @%p ev:%s,%s inv:%u time:%lld us\n"
  30. #define PRINT_DUMP_INFO(dst, sz, ...) do { \
  31. int cb = snprintf(dst, sz, __VA_ARGS__); \
  32. dst += cb; \
  33. sz -= cb; \
  34. } while(0);
  35. #endif
  36. /* ------------------------- Static Variables ------------------------------- */
  37. static const char* TAG = "event";
  38. static const char* esp_event_any_base = "any";
  39. #ifdef CONFIG_EVENT_LOOP_PROFILING
  40. static SLIST_HEAD(esp_event_loop_instance_list_t, esp_event_loop_instance) s_event_loops =
  41. SLIST_HEAD_INITIALIZER(s_event_loops);
  42. static portMUX_TYPE s_event_loops_spinlock = portMUX_INITIALIZER_UNLOCKED;
  43. #endif
  44. /* ------------------------- Static Functions ------------------------------- */
  45. #ifdef CONFIG_EVENT_LOOP_PROFILING
  46. static int esp_event_dump_prepare()
  47. {
  48. esp_event_loop_instance_t* loop_it;
  49. esp_event_loop_node_t *loop_node_it;
  50. esp_event_base_node_t* base_node_it;
  51. esp_event_id_node_t* id_node_it;
  52. esp_event_handler_instance_t* handler_it;
  53. // Count the number of items to be printed. This is needed to compute how much memory to reserve.
  54. int loops = 0, handlers = 0;
  55. portENTER_CRITICAL(&s_event_loops_spinlock);
  56. SLIST_FOREACH(loop_it, &s_event_loops, next) {
  57. SLIST_FOREACH(loop_node_it, &(loop_it->loop_nodes), next) {
  58. SLIST_FOREACH(handler_it, &(loop_node_it->handlers), next) {
  59. handlers++;
  60. }
  61. SLIST_FOREACH(base_node_it, &(loop_node_it->base_nodes), next) {
  62. SLIST_FOREACH(handler_it, &(base_node_it->handlers), next) {
  63. handlers++;
  64. }
  65. SLIST_FOREACH(id_node_it, &(base_node_it->id_nodes), next) {
  66. SLIST_FOREACH(handler_it, &(id_node_it->handlers), next) {
  67. handlers++;
  68. }
  69. }
  70. }
  71. }
  72. loops++;
  73. }
  74. portEXIT_CRITICAL(&s_event_loops_spinlock);
  75. // Reserve slightly more memory than computed
  76. int allowance = 3;
  77. int size = (((loops + allowance) * (sizeof(LOOP_DUMP_FORMAT) + 10 + 20 + 2 * 11)) +
  78. ((handlers + allowance) * (sizeof(HANDLER_DUMP_FORMAT) + 10 + 2 * 20 + 11 + 20)));
  79. return size;
  80. }
  81. #endif
  82. static void esp_event_loop_run_task(void* args)
  83. {
  84. esp_err_t err;
  85. esp_event_loop_handle_t event_loop = (esp_event_loop_handle_t) args;
  86. ESP_LOGD(TAG, "running task for loop %p", event_loop);
  87. while(1) {
  88. err = esp_event_loop_run(event_loop, portMAX_DELAY);
  89. if (err != ESP_OK) {
  90. break;
  91. }
  92. }
  93. ESP_LOGE(TAG, "suspended task for loop %p", event_loop);
  94. vTaskSuspend(NULL);
  95. }
  96. static void handler_execute(esp_event_loop_instance_t* loop, esp_event_handler_instance_t *handler, esp_event_post_instance_t post)
  97. {
  98. ESP_LOGD(TAG, "running post %s:%d with handler %p on loop %p", post.base, post.id, handler->handler, loop);
  99. #ifdef CONFIG_EVENT_LOOP_PROFILING
  100. int64_t start, diff;
  101. start = esp_timer_get_time();
  102. #endif
  103. // Execute the handler
  104. (*(handler->handler))(handler->arg, post.base, post.id, post.data);
  105. #ifdef CONFIG_EVENT_LOOP_PROFILING
  106. diff = esp_timer_get_time() - start;
  107. xSemaphoreTake(loop->profiling_mutex, portMAX_DELAY);
  108. handler->invoked++;
  109. handler->time += diff;
  110. xSemaphoreGive(loop->profiling_mutex);
  111. #endif
  112. }
  113. static esp_err_t handler_instances_add(esp_event_handler_instances_t* handlers, esp_event_handler_t handler, void* handler_arg)
  114. {
  115. esp_event_handler_instance_t* handler_instance = calloc(1, sizeof(*handler_instance));
  116. if (!handler_instance) {
  117. return ESP_ERR_NO_MEM;
  118. }
  119. handler_instance->handler = handler;
  120. handler_instance->arg = handler_arg;
  121. if(SLIST_EMPTY(handlers)) {
  122. SLIST_INSERT_HEAD(handlers, handler_instance, next);
  123. }
  124. else {
  125. esp_event_handler_instance_t *it = NULL, *last = NULL;
  126. SLIST_FOREACH(it, handlers, next) {
  127. if (handler == it->handler) {
  128. it->arg = handler_arg;
  129. ESP_LOGW(TAG, "handler already registered, overwriting");
  130. free(handler_instance);
  131. return ESP_OK;
  132. }
  133. last = it;
  134. }
  135. SLIST_INSERT_AFTER(last, handler_instance, next);
  136. }
  137. return ESP_OK;
  138. }
  139. static esp_err_t base_node_add_handler(esp_event_base_node_t* base_node, int32_t id, esp_event_handler_t handler, void* handler_arg)
  140. {
  141. if (id == ESP_EVENT_ANY_ID) {
  142. return handler_instances_add(&(base_node->handlers), handler, handler_arg);
  143. }
  144. else {
  145. esp_err_t err = ESP_OK;
  146. esp_event_id_node_t *it = NULL, *id_node = NULL, *last_id_node = NULL;
  147. SLIST_FOREACH(it, &(base_node->id_nodes), next) {
  148. if (it->id == id) {
  149. id_node = it;
  150. }
  151. last_id_node = it;
  152. }
  153. if (!last_id_node || !id_node) {
  154. id_node = (esp_event_id_node_t*) calloc(1, sizeof(*id_node));
  155. if (!id_node) {
  156. ESP_LOGE(TAG, "alloc for new id node failed");
  157. return ESP_ERR_NO_MEM;
  158. }
  159. id_node->id = id;
  160. SLIST_INIT(&(id_node->handlers));
  161. err = handler_instances_add(&(id_node->handlers), handler, handler_arg);
  162. if (err == ESP_OK) {
  163. if (!last_id_node) {
  164. SLIST_INSERT_HEAD(&(base_node->id_nodes), id_node, next);
  165. }
  166. else {
  167. SLIST_INSERT_AFTER(last_id_node, id_node, next);
  168. }
  169. } else {
  170. free(id_node);
  171. }
  172. return err;
  173. }
  174. else {
  175. return handler_instances_add(&(id_node->handlers), handler, handler_arg);
  176. }
  177. }
  178. }
  179. static esp_err_t loop_node_add_handler(esp_event_loop_node_t* loop_node, esp_event_base_t base, int32_t id, esp_event_handler_t handler, void* handler_arg)
  180. {
  181. if (base == esp_event_any_base && id == ESP_EVENT_ANY_ID) {
  182. return handler_instances_add(&(loop_node->handlers), handler, handler_arg);
  183. }
  184. else {
  185. esp_err_t err = ESP_OK;
  186. esp_event_base_node_t *it = NULL, *base_node = NULL, *last_base_node = NULL;
  187. SLIST_FOREACH(it, &(loop_node->base_nodes), next) {
  188. if (it->base == base) {
  189. base_node = it;
  190. }
  191. last_base_node = it;
  192. }
  193. if (!last_base_node ||
  194. !base_node ||
  195. (base_node && !SLIST_EMPTY(&(base_node->id_nodes)) && id == ESP_EVENT_ANY_ID) ||
  196. (last_base_node && last_base_node->base != base && !SLIST_EMPTY(&(last_base_node->id_nodes)) && id == ESP_EVENT_ANY_ID)) {
  197. base_node = (esp_event_base_node_t*) calloc(1, sizeof(*base_node));
  198. if (!base_node) {
  199. ESP_LOGE(TAG, "alloc mem for new base node failed");
  200. return ESP_ERR_NO_MEM;
  201. }
  202. base_node->base = base;
  203. SLIST_INIT(&(base_node->handlers));
  204. SLIST_INIT(&(base_node->id_nodes));
  205. err = base_node_add_handler(base_node, id, handler, handler_arg);
  206. if (err == ESP_OK) {
  207. if (!last_base_node) {
  208. SLIST_INSERT_HEAD(&(loop_node->base_nodes), base_node, next);
  209. }
  210. else {
  211. SLIST_INSERT_AFTER(last_base_node, base_node, next);
  212. }
  213. } else {
  214. free(base_node);
  215. }
  216. return err;
  217. } else {
  218. return base_node_add_handler(base_node, id, handler, handler_arg);
  219. }
  220. }
  221. }
  222. static esp_err_t handler_instances_remove(esp_event_handler_instances_t* handlers, esp_event_handler_t handler)
  223. {
  224. esp_event_handler_instance_t *it, *temp;
  225. SLIST_FOREACH_SAFE(it, handlers, next, temp) {
  226. if (it->handler == handler) {
  227. SLIST_REMOVE(handlers, it, esp_event_handler_instance, next);
  228. free(it);
  229. return ESP_OK;
  230. }
  231. }
  232. return ESP_ERR_NOT_FOUND;
  233. }
  234. static esp_err_t base_node_remove_handler(esp_event_base_node_t* base_node, int32_t id, esp_event_handler_t handler)
  235. {
  236. if (id == ESP_EVENT_ANY_ID) {
  237. return handler_instances_remove(&(base_node->handlers), handler);
  238. }
  239. else {
  240. esp_event_id_node_t *it, *temp;
  241. SLIST_FOREACH_SAFE(it, &(base_node->id_nodes), next, temp) {
  242. if (it->id == id) {
  243. esp_err_t res = handler_instances_remove(&(it->handlers), handler);
  244. if (res == ESP_OK) {
  245. if (SLIST_EMPTY(&(it->handlers))) {
  246. SLIST_REMOVE(&(base_node->id_nodes), it, esp_event_id_node, next);
  247. free(it);
  248. return ESP_OK;
  249. }
  250. }
  251. }
  252. }
  253. }
  254. return ESP_ERR_NOT_FOUND;
  255. }
  256. static esp_err_t loop_node_remove_handler(esp_event_loop_node_t* loop_node, esp_event_base_t base, int32_t id, esp_event_handler_t handler)
  257. {
  258. if (base == esp_event_any_base && id == ESP_EVENT_ANY_ID) {
  259. return handler_instances_remove(&(loop_node->handlers), handler);
  260. }
  261. else {
  262. esp_event_base_node_t *it, *temp;
  263. SLIST_FOREACH_SAFE(it, &(loop_node->base_nodes), next, temp) {
  264. if (it->base == base) {
  265. esp_err_t res = base_node_remove_handler(it, id, handler);
  266. if (res == ESP_OK) {
  267. if (SLIST_EMPTY(&(it->handlers)) && SLIST_EMPTY(&(it->id_nodes))) {
  268. SLIST_REMOVE(&(loop_node->base_nodes), it, esp_event_base_node, next);
  269. free(it);
  270. return ESP_OK;
  271. }
  272. }
  273. }
  274. }
  275. }
  276. return ESP_ERR_NOT_FOUND;
  277. }
  278. static void handler_instances_remove_all(esp_event_handler_instances_t* handlers)
  279. {
  280. esp_event_handler_instance_t *it, *temp;
  281. SLIST_FOREACH_SAFE(it, handlers, next, temp) {
  282. SLIST_REMOVE(handlers, it, esp_event_handler_instance, next);
  283. free(it);
  284. }
  285. }
  286. static void base_node_remove_all_handler(esp_event_base_node_t* base_node)
  287. {
  288. handler_instances_remove_all(&(base_node->handlers));
  289. esp_event_id_node_t *it, *temp;
  290. SLIST_FOREACH_SAFE(it, &(base_node->id_nodes), next, temp) {
  291. handler_instances_remove_all(&(it->handlers));
  292. SLIST_REMOVE(&(base_node->id_nodes), it, esp_event_id_node, next);
  293. free(it);
  294. }
  295. }
  296. static void loop_node_remove_all_handler(esp_event_loop_node_t* loop_node)
  297. {
  298. handler_instances_remove_all(&(loop_node->handlers));
  299. esp_event_base_node_t *it, *temp;
  300. SLIST_FOREACH_SAFE(it, &(loop_node->base_nodes), next, temp) {
  301. base_node_remove_all_handler(it);
  302. SLIST_REMOVE(&(loop_node->base_nodes), it, esp_event_base_node, next);
  303. free(it);
  304. }
  305. }
  306. static esp_err_t post_instance_create(esp_event_base_t event_base, int32_t event_id, void* event_data, int32_t event_data_size, esp_event_post_instance_t* post)
  307. {
  308. void* event_data_copy = NULL;
  309. // Make persistent copy of event data on heap.
  310. if (event_data != NULL && event_data_size != 0) {
  311. event_data_copy = calloc(1, event_data_size);
  312. if (event_data_copy == NULL) {
  313. ESP_LOGE(TAG, "alloc for post data to event %s:%d failed", event_base, event_id);
  314. return ESP_ERR_NO_MEM;
  315. }
  316. memcpy(event_data_copy, event_data, event_data_size);
  317. }
  318. post->base = event_base;
  319. post->id = event_id;
  320. post->data = event_data_copy;
  321. ESP_LOGD(TAG, "created post for event %s:%d", event_base, event_id);
  322. return ESP_OK;
  323. }
  324. static void post_instance_delete(esp_event_post_instance_t* post)
  325. {
  326. free(post->data);
  327. }
  328. /* ---------------------------- Public API --------------------------------- */
  329. esp_err_t esp_event_loop_create(const esp_event_loop_args_t* event_loop_args, esp_event_loop_handle_t* event_loop)
  330. {
  331. if (event_loop_args == NULL) {
  332. ESP_LOGE(TAG, "event_loop_args was NULL");
  333. return ESP_ERR_INVALID_ARG;
  334. }
  335. if (event_loop == NULL) {
  336. ESP_LOGE(TAG, "event_loop was NULL");
  337. return ESP_ERR_INVALID_ARG;
  338. }
  339. esp_event_loop_instance_t* loop;
  340. esp_err_t err = ESP_ERR_NO_MEM; // most likely error
  341. loop = calloc(1, sizeof(*loop));
  342. if (loop == NULL) {
  343. ESP_LOGE(TAG, "alloc for event loop failed");
  344. return err;
  345. }
  346. loop->queue = xQueueCreate(event_loop_args->queue_size , sizeof(esp_event_post_instance_t));
  347. if (loop->queue == NULL) {
  348. ESP_LOGE(TAG, "create event loop queue failed");
  349. goto on_err;
  350. }
  351. loop->mutex = xSemaphoreCreateRecursiveMutex();
  352. if (loop->mutex == NULL) {
  353. ESP_LOGE(TAG, "create event loop mutex failed");
  354. goto on_err;
  355. }
  356. #ifdef CONFIG_EVENT_LOOP_PROFILING
  357. loop->profiling_mutex = xSemaphoreCreateMutex();
  358. if (loop->profiling_mutex == NULL) {
  359. ESP_LOGE(TAG, "create event loop profiling mutex failed");
  360. goto on_err;
  361. }
  362. #endif
  363. SLIST_INIT(&(loop->loop_nodes));
  364. // Create the loop task if requested
  365. if (event_loop_args->task_name != NULL) {
  366. BaseType_t task_created = xTaskCreatePinnedToCore(esp_event_loop_run_task, event_loop_args->task_name,
  367. event_loop_args->task_stack_size, (void*) loop,
  368. event_loop_args->task_priority, &(loop->task), event_loop_args->task_core_id);
  369. if (task_created != pdPASS) {
  370. ESP_LOGE(TAG, "create task for loop failed");
  371. err = ESP_FAIL;
  372. goto on_err;
  373. }
  374. loop->name = event_loop_args->task_name;
  375. ESP_LOGD(TAG, "created task for loop %p", loop);
  376. } else {
  377. loop->name = "";
  378. loop->task = NULL;
  379. }
  380. loop->running_task = NULL;
  381. #ifdef CONFIG_EVENT_LOOP_PROFILING
  382. portENTER_CRITICAL(&s_event_loops_spinlock);
  383. SLIST_INSERT_HEAD(&s_event_loops, loop, next);
  384. portEXIT_CRITICAL(&s_event_loops_spinlock);
  385. #endif
  386. *event_loop = (esp_event_loop_handle_t) loop;
  387. ESP_LOGD(TAG, "created event loop %p", loop);
  388. return ESP_OK;
  389. on_err:
  390. if(loop->queue != NULL) {
  391. vQueueDelete(loop->queue);
  392. }
  393. if(loop->mutex != NULL) {
  394. vSemaphoreDelete(loop->mutex);
  395. }
  396. #ifdef CONFIG_EVENT_LOOP_PROFILING
  397. if(loop->profiling_mutex != NULL) {
  398. vSemaphoreDelete(loop->profiling_mutex);
  399. }
  400. #endif
  401. free(loop);
  402. return err;
  403. }
  404. // On event lookup performance: The library implements the event list as a linked list, which results to O(n)
  405. // lookup time. The test comparing this implementation to the O(lg n) performance of rbtrees
  406. // (https://github.com/freebsd/freebsd/blob/master/sys/sys/tree.h)
  407. // indicate that the difference is not that substantial, especially considering the additional
  408. // pointers per node of rbtrees. Code for the rbtree implementation of the event loop library is archived
  409. // in feature/esp_event_loop_library_rbtrees if needed.
  410. esp_err_t esp_event_loop_run(esp_event_loop_handle_t event_loop, TickType_t ticks_to_run)
  411. {
  412. assert(event_loop);
  413. esp_event_loop_instance_t* loop = (esp_event_loop_instance_t*) event_loop;
  414. esp_event_post_instance_t post;
  415. TickType_t marker = xTaskGetTickCount();
  416. TickType_t end = 0;
  417. #if( configUSE_16_BIT_TICKS == 1 )
  418. int32_t remaining_ticks = ticks_to_run;
  419. #else
  420. int64_t remaining_ticks = ticks_to_run;
  421. #endif
  422. while(xQueueReceive(loop->queue, &post, ticks_to_run) == pdTRUE) {
  423. // The event has already been unqueued, so ensure it gets executed.
  424. xSemaphoreTakeRecursive(loop->mutex, portMAX_DELAY);
  425. loop->running_task = xTaskGetCurrentTaskHandle();
  426. bool exec = false;
  427. esp_event_handler_instance_t *handler, *temp_handler;
  428. esp_event_loop_node_t *loop_node, *temp_node;
  429. esp_event_base_node_t *base_node, *temp_base;
  430. esp_event_id_node_t *id_node, *temp_id_node;
  431. SLIST_FOREACH_SAFE(loop_node, &(loop->loop_nodes), next, temp_node) {
  432. // Execute loop level handlers
  433. SLIST_FOREACH_SAFE(handler, &(loop_node->handlers), next, temp_handler) {
  434. handler_execute(loop, handler, post);
  435. exec |= true;
  436. }
  437. SLIST_FOREACH_SAFE(base_node, &(loop_node->base_nodes), next, temp_base) {
  438. if (base_node->base == post.base) {
  439. // Execute base level handlers
  440. SLIST_FOREACH_SAFE(handler, &(base_node->handlers), next, temp_handler) {
  441. handler_execute(loop, handler, post);
  442. exec |= true;
  443. }
  444. SLIST_FOREACH_SAFE(id_node, &(base_node->id_nodes), next, temp_id_node) {
  445. if (id_node->id == post.id) {
  446. // Execute id level handlers
  447. SLIST_FOREACH_SAFE(handler, &(id_node->handlers), next, temp_handler) {
  448. handler_execute(loop, handler, post);
  449. exec |= true;
  450. }
  451. // Skip to next base node
  452. break;
  453. }
  454. }
  455. }
  456. }
  457. }
  458. post_instance_delete(&post);
  459. if (ticks_to_run != portMAX_DELAY) {
  460. end = xTaskGetTickCount();
  461. remaining_ticks -= end - marker;
  462. // If the ticks to run expired, return to the caller
  463. if (remaining_ticks <= 0) {
  464. xSemaphoreGiveRecursive(loop->mutex);
  465. break;
  466. } else {
  467. marker = end;
  468. }
  469. }
  470. loop->running_task = NULL;
  471. xSemaphoreGiveRecursive(loop->mutex);
  472. if (!exec) {
  473. // No handlers were registered, not even loop/base level handlers
  474. ESP_LOGW(TAG, "no handlers have been registered for event %s:%d posted to loop %p", post.base, post.id, event_loop);
  475. }
  476. }
  477. return ESP_OK;
  478. }
  479. esp_err_t esp_event_loop_delete(esp_event_loop_handle_t event_loop)
  480. {
  481. assert(event_loop);
  482. esp_event_loop_instance_t* loop = (esp_event_loop_instance_t*) event_loop;
  483. SemaphoreHandle_t loop_mutex = loop->mutex;
  484. #ifdef CONFIG_EVENT_LOOP_PROFILING
  485. SemaphoreHandle_t loop_profiling_mutex = loop->profiling_mutex;
  486. #endif
  487. xSemaphoreTakeRecursive(loop->mutex, portMAX_DELAY);
  488. #ifdef CONFIG_EVENT_LOOP_PROFILING
  489. xSemaphoreTakeRecursive(loop->profiling_mutex, portMAX_DELAY);
  490. portENTER_CRITICAL(&s_event_loops_spinlock);
  491. SLIST_REMOVE(&s_event_loops, loop, esp_event_loop_instance, next);
  492. portEXIT_CRITICAL(&s_event_loops_spinlock);
  493. #endif
  494. // Delete the task if it was created
  495. if (loop->task != NULL) {
  496. vTaskDelete(loop->task);
  497. }
  498. // Remove all registered events and handlers in the loop
  499. esp_event_loop_node_t *it, *temp;
  500. SLIST_FOREACH_SAFE(it, &(loop->loop_nodes), next, temp) {
  501. loop_node_remove_all_handler(it);
  502. SLIST_REMOVE(&(loop->loop_nodes), it, esp_event_loop_node, next);
  503. free(it);
  504. }
  505. // Drop existing posts on the queue
  506. esp_event_post_instance_t post;
  507. while(xQueueReceive(loop->queue, &post, 0) == pdTRUE) {
  508. free(post.data);
  509. }
  510. // Cleanup loop
  511. vQueueDelete(loop->queue);
  512. free(loop);
  513. // Free loop mutex before deleting
  514. xSemaphoreGiveRecursive(loop_mutex);
  515. #ifdef CONFIG_EVENT_LOOP_PROFILING
  516. xSemaphoreGiveRecursive(loop_profiling_mutex);
  517. vSemaphoreDelete(loop_profiling_mutex);
  518. #endif
  519. vSemaphoreDelete(loop_mutex);
  520. ESP_LOGD(TAG, "deleted loop %p", (void*) event_loop);
  521. return ESP_OK;
  522. }
  523. esp_err_t esp_event_handler_register_with(esp_event_loop_handle_t event_loop, esp_event_base_t event_base,
  524. int32_t event_id, esp_event_handler_t event_handler, void* event_handler_arg)
  525. {
  526. assert(event_loop);
  527. assert(event_handler);
  528. if (event_base == ESP_EVENT_ANY_BASE && event_id != ESP_EVENT_ANY_ID) {
  529. ESP_LOGE(TAG, "registering to any event base with specific id unsupported");
  530. return ESP_ERR_INVALID_ARG;
  531. }
  532. esp_event_loop_instance_t* loop = (esp_event_loop_instance_t*) event_loop;
  533. if (event_base == ESP_EVENT_ANY_BASE) {
  534. event_base = esp_event_any_base;
  535. }
  536. esp_err_t err = ESP_OK;
  537. xSemaphoreTakeRecursive(loop->mutex, portMAX_DELAY);
  538. esp_event_loop_node_t *loop_node = NULL, *last_loop_node = NULL;
  539. SLIST_FOREACH(loop_node, &(loop->loop_nodes), next) {
  540. last_loop_node = loop_node;
  541. }
  542. bool is_loop_level_handler = (event_base == esp_event_any_base) && (event_id == ESP_EVENT_ANY_ID);
  543. if (!last_loop_node ||
  544. (last_loop_node && !SLIST_EMPTY(&(last_loop_node->base_nodes)) && is_loop_level_handler)) {
  545. loop_node = (esp_event_loop_node_t*) calloc(1, sizeof(*loop_node));
  546. SLIST_INIT(&(loop_node->handlers));
  547. SLIST_INIT(&(loop_node->base_nodes));
  548. if (!loop_node) {
  549. ESP_LOGE(TAG, "alloc for new loop node failed");
  550. err = ESP_ERR_NO_MEM;
  551. goto on_err;
  552. }
  553. err = loop_node_add_handler(loop_node, event_base, event_id, event_handler, event_handler_arg);
  554. if (err == ESP_OK) {
  555. if (!last_loop_node) {
  556. SLIST_INSERT_HEAD(&(loop->loop_nodes), loop_node, next);
  557. }
  558. else {
  559. SLIST_INSERT_AFTER(last_loop_node, loop_node, next);
  560. }
  561. } else {
  562. free(loop_node);
  563. }
  564. }
  565. else {
  566. err = loop_node_add_handler(last_loop_node, event_base, event_id, event_handler, event_handler_arg);
  567. }
  568. on_err:
  569. xSemaphoreGiveRecursive(loop->mutex);
  570. return err;
  571. }
  572. esp_err_t esp_event_handler_unregister_with(esp_event_loop_handle_t event_loop, esp_event_base_t event_base,
  573. int32_t event_id, esp_event_handler_t event_handler)
  574. {
  575. assert(event_loop);
  576. assert(event_handler);
  577. if (event_base == ESP_EVENT_ANY_BASE && event_id != ESP_EVENT_ANY_ID) {
  578. ESP_LOGE(TAG, "unregistering to any event base with specific id unsupported");
  579. return ESP_FAIL;
  580. }
  581. if (event_base == ESP_EVENT_ANY_BASE) {
  582. event_base = esp_event_any_base;
  583. }
  584. esp_event_loop_instance_t* loop = (esp_event_loop_instance_t*) event_loop;
  585. xSemaphoreTakeRecursive(loop->mutex, portMAX_DELAY);
  586. esp_event_loop_node_t *it, *temp;
  587. SLIST_FOREACH_SAFE(it, &(loop->loop_nodes), next, temp) {
  588. esp_err_t res = loop_node_remove_handler(it, event_base, event_id, event_handler);
  589. if (res == ESP_OK && SLIST_EMPTY(&(it->base_nodes)) && SLIST_EMPTY(&(it->handlers))) {
  590. SLIST_REMOVE(&(loop->loop_nodes), it, esp_event_loop_node, next);
  591. free(it);
  592. break;
  593. }
  594. }
  595. xSemaphoreGiveRecursive(loop->mutex);
  596. return ESP_OK;
  597. }
  598. esp_err_t esp_event_post_to(esp_event_loop_handle_t event_loop, esp_event_base_t event_base, int32_t event_id,
  599. void* event_data, size_t event_data_size, TickType_t ticks_to_wait)
  600. {
  601. assert(event_loop);
  602. if (event_base == ESP_EVENT_ANY_BASE || event_id == ESP_EVENT_ANY_ID) {
  603. ESP_LOGE(TAG, "posting nonspecific event base or id unsupported");
  604. return ESP_ERR_INVALID_ARG;
  605. }
  606. esp_event_loop_instance_t* loop = (esp_event_loop_instance_t*) event_loop;
  607. esp_event_post_instance_t post;
  608. esp_err_t err = post_instance_create(event_base, event_id, event_data, event_data_size, &post);
  609. if (err != ESP_OK) {
  610. return err;
  611. }
  612. BaseType_t result = pdFALSE;
  613. // Find the task that currently executes the loop. It is safe to query loop->task since it is
  614. // not mutated since loop creation. ENSURE THIS REMAINS TRUE.
  615. if (loop->task == NULL) {
  616. // The loop has no dedicated task. Find out what task is currently running it.
  617. result = xSemaphoreTakeRecursive(loop->mutex, ticks_to_wait);
  618. if (result == pdTRUE) {
  619. if (loop->running_task != xTaskGetCurrentTaskHandle()) {
  620. xSemaphoreGiveRecursive(loop->mutex);
  621. result = xQueueSendToBack(loop->queue, &post, ticks_to_wait);
  622. } else {
  623. xSemaphoreGiveRecursive(loop->mutex);
  624. result = xQueueSendToBack(loop->queue, &post, 0);
  625. }
  626. }
  627. } else {
  628. // The loop has a dedicated task.
  629. if (loop->task != xTaskGetCurrentTaskHandle()) {
  630. result = xQueueSendToBack(loop->queue, &post, ticks_to_wait);
  631. } else {
  632. result = xQueueSendToBack(loop->queue, &post, 0);
  633. }
  634. }
  635. if (result != pdTRUE) {
  636. post_instance_delete(&post);
  637. #ifdef CONFIG_EVENT_LOOP_PROFILING
  638. xSemaphoreTake(loop->profiling_mutex, portMAX_DELAY);
  639. loop->events_dropped++;
  640. xSemaphoreGive(loop->profiling_mutex);
  641. #endif
  642. return ESP_ERR_TIMEOUT;
  643. }
  644. #ifdef CONFIG_EVENT_LOOP_PROFILING
  645. xSemaphoreTake(loop->profiling_mutex, portMAX_DELAY);
  646. loop->events_recieved++;
  647. xSemaphoreGive(loop->profiling_mutex);
  648. #endif
  649. ESP_LOGD(TAG, "posted %s:%d to loop %p", post.base, post.id, event_loop);
  650. return ESP_OK;
  651. }
  652. esp_err_t esp_event_dump(FILE* file)
  653. {
  654. #ifdef CONFIG_EVENT_LOOP_PROFILING
  655. assert(file);
  656. esp_event_loop_instance_t* loop_it;
  657. esp_event_loop_node_t *loop_node_it;
  658. esp_event_base_node_t* base_node_it;
  659. esp_event_id_node_t* id_node_it;
  660. esp_event_handler_instance_t* handler_it;
  661. // Allocate memory for printing
  662. int sz = esp_event_dump_prepare();
  663. char* buf = calloc(sz, sizeof(char));
  664. char* dst = buf;
  665. char id_str_buf[20];
  666. // Print info to buffer
  667. portENTER_CRITICAL(&s_event_loops_spinlock);
  668. SLIST_FOREACH(loop_it, &s_event_loops, next) {
  669. PRINT_DUMP_INFO(dst, sz, LOOP_DUMP_FORMAT, loop_it, loop_it->task != NULL ? loop_it->name : "none" ,
  670. loop_it->events_recieved, loop_it->events_dropped);
  671. int sz_bak = sz;
  672. SLIST_FOREACH(loop_node_it, &(loop_it->loop_nodes), next) {
  673. SLIST_FOREACH(handler_it, &(loop_node_it->handlers), next) {
  674. PRINT_DUMP_INFO(dst, sz, HANDLER_DUMP_FORMAT, handler_it->handler, "ESP_EVENT_ANY_BASE",
  675. "ESP_EVENT_ANY_ID", handler_it->invoked, handler_it->time);
  676. }
  677. SLIST_FOREACH(base_node_it, &(loop_node_it->base_nodes), next) {
  678. SLIST_FOREACH(handler_it, &(base_node_it->handlers), next) {
  679. PRINT_DUMP_INFO(dst, sz, HANDLER_DUMP_FORMAT, handler_it->handler, base_node_it->base ,
  680. "ESP_EVENT_ANY_ID", handler_it->invoked, handler_it->time);
  681. }
  682. SLIST_FOREACH(id_node_it, &(base_node_it->id_nodes), next) {
  683. SLIST_FOREACH(handler_it, &(id_node_it->handlers), next) {
  684. memset(id_str_buf, 0, sizeof(id_str_buf));
  685. snprintf(id_str_buf, sizeof(id_str_buf), "%d", id_node_it->id);
  686. PRINT_DUMP_INFO(dst, sz, HANDLER_DUMP_FORMAT, handler_it->handler, base_node_it->base ,
  687. id_str_buf, handler_it->invoked, handler_it->time);
  688. }
  689. }
  690. }
  691. }
  692. // No handlers registered for this loop
  693. if (sz == sz_bak) {
  694. PRINT_DUMP_INFO(dst, sz, " NO HANDLERS REGISTERED\n");
  695. }
  696. }
  697. portEXIT_CRITICAL(&s_event_loops_spinlock);
  698. // Print the contents of the buffer to the file
  699. fprintf(file, buf);
  700. // Free the allocated buffer
  701. free(buf);
  702. #endif
  703. return ESP_OK;
  704. }