snapclient/components/audio_sal/audio_sys.c

/*
 * ESPRESSIF MIT License
 *
 * Copyright (c) 2019 <ESPRESSIF SYSTEMS (SHANGHAI) CO., LTD>
 *
 * Permission is hereby granted for use on all ESPRESSIF SYSTEMS products, in
 * which case, it is free of charge, to any person obtaining a copy of this
 * software and associated documentation files (the "Software"), to deal in the
 * Software without restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#include "audio_sys.h"

#include <inttypes.h>
#include <sys/time.h>

#include "audio_error.h"
#include "audio_mem.h"
#include "esp_log.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "soc/soc_memory_layout.h"

static const char *TAG = "AUDIO_SYS";

#define ARRAY_SIZE_OFFSET \
  8  // Increase this if audio_sys_get_real_time_stats returns
     // ESP_ERR_INVALID_SIZE
#define AUDIO_SYS_TASKS_ELAPSED_TIME_MS 1000  // Period of stats measurement

const char *task_state[] = {"Running", "Ready", "Blocked", "Suspended",
                            "Deleted"};

/** @brief
 * "Extr": Allocated task stack from psram, "Intr": Allocated task stack from
 * internel
 */
const char *task_stack[] = {"Extr", "Intr"};

int audio_sys_get_tick_by_time_ms(int ms) { return (ms / portTICK_PERIOD_MS); }

int64_t audio_sys_get_time_ms(void) {
  struct timeval te;
  gettimeofday(&te, NULL);
  int64_t milliseconds = te.tv_sec * 1000LL + te.tv_usec / 1000;
  return milliseconds;
}

esp_err_t audio_sys_get_real_time_stats(void) {
#if (CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID && \
     CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS)
  TaskStatus_t *start_array = NULL, *end_array = NULL;
  UBaseType_t start_array_size, end_array_size;
  uint32_t start_run_time, end_run_time;
  uint32_t task_elapsed_time, percentage_time;
  esp_err_t ret;

  // Allocate array to store current task states
  start_array_size = uxTaskGetNumberOfTasks() + ARRAY_SIZE_OFFSET;
  start_array = audio_malloc(sizeof(TaskStatus_t) * start_array_size);
  AUDIO_MEM_CHECK(TAG, start_array, {
    ret = ESP_FAIL;
    goto exit;
  });
  // Get current task states
  start_array_size =
      uxTaskGetSystemState(start_array, start_array_size, &start_run_time);
  if (start_array_size == 0) {
    ESP_LOGE(TAG,
             "Insufficient array size for uxTaskGetSystemState. Trying "
             "increasing ARRAY_SIZE_OFFSET");
    ret = ESP_FAIL;
    goto exit;
  }

  vTaskDelay(pdMS_TO_TICKS(AUDIO_SYS_TASKS_ELAPSED_TIME_MS));

  // Allocate array to store tasks states post delay
  end_array_size = uxTaskGetNumberOfTasks() + ARRAY_SIZE_OFFSET;
  end_array = audio_malloc(sizeof(TaskStatus_t) * end_array_size);
  AUDIO_MEM_CHECK(TAG, start_array, {
    ret = ESP_FAIL;
    goto exit;
  });

  // Get post delay task states
  end_array_size =
      uxTaskGetSystemState(end_array, end_array_size, &end_run_time);
  if (end_array_size == 0) {
    ESP_LOGE(TAG,
             "Insufficient array size for uxTaskGetSystemState. Trying "
             "increasing ARRAY_SIZE_OFFSET");
    ret = ESP_FAIL;
    goto exit;
  }

  // Calculate total_elapsed_time in units of run time stats clock period.
  uint32_t total_elapsed_time = (end_run_time - start_run_time);
  if (total_elapsed_time == 0) {
    ESP_LOGE(TAG,
             "Delay duration too short. Trying increasing "
             "AUDIO_SYS_TASKS_ELAPSED_TIME_MS");
    ret = ESP_FAIL;
    goto exit;
  }

  ESP_LOGI(TAG,
           "| Task              | Run Time    | Per | Prio | HWM       | State "
           "  | CoreId   | Stack ");

  // Match each task in start_array to those in the end_array
  for (int i = 0; i < start_array_size; i++) {
    for (int j = 0; j < end_array_size; j++) {
      if (start_array[i].xHandle == end_array[j].xHandle) {
        task_elapsed_time =
            end_array[j].ulRunTimeCounter - start_array[i].ulRunTimeCounter;
        percentage_time = (task_elapsed_time * 100UL) /
                          (total_elapsed_time * portNUM_PROCESSORS);
        ESP_LOGI(
            TAG, "| %-17s | %-11d |%2d%%  | %-4u | %-9u | %-7s | %-8x | %s",
            start_array[i].pcTaskName, (int)task_elapsed_time,
            (int)percentage_time, start_array[i].uxCurrentPriority,
            (int)start_array[i].usStackHighWaterMark,
            task_state[(start_array[i].eCurrentState)], start_array[i].xCoreID,
            task_stack[esp_ptr_internal(
                pxTaskGetStackStart(start_array[i].xHandle))]);

        // Mark that task have been matched by overwriting their handles
        start_array[i].xHandle = NULL;
        end_array[j].xHandle = NULL;
        break;
      }
    }
  }

  // Print unmatched tasks
  for (int i = 0; i < start_array_size; i++) {
    if (start_array[i].xHandle != NULL) {
      ESP_LOGI(TAG, "| %s | Deleted", start_array[i].pcTaskName);
    }
  }
  for (int i = 0; i < end_array_size; i++) {
    if (end_array[i].xHandle != NULL) {
      ESP_LOGI(TAG, "| %s | Created", end_array[i].pcTaskName);
    }
  }
  printf("\n");
  ret = ESP_OK;

exit:  // Common return path
  if (start_array) {
    audio_free(start_array);
    start_array = NULL;
  }
  if (end_array) {
    audio_free(end_array);
    end_array = NULL;
  }
  return ret;
#else
  ESP_LOGW(TAG,
           "Please enbale `CONFIG_FREERTOS_VTASKLIST_INCLUDE_COREID` and "
           "`CONFIG_FREERTOS_GENERATE_RUN_TIME_STATS` in menuconfig");
  return ESP_FAIL;
#endif
}