# 使用外部堆栈调用函数

[English]

## 概述

执行某个给定函数时，可以使用用户分配的堆栈空间，且该堆栈空间独立于当前任务的堆栈。如果有多个任务需要占用同一个使用大量堆栈空间的公共函数，如 `printf`，这一机制能够节省各个任务的堆栈空间。具体而言，将给定函数作为参数传入 `esp_execute_shared_stack_function()` 中，给定函数便会在共享堆栈空间内执行。

警告

`esp_execute_shared_stack_function()` 只会为所提供的共享堆栈内存做最基础的设置。传递给该函数以在共享堆栈空间上执行的函数，或该函数调用的任何函数，都不应执行以下任何操作：

- 使用线程局部存储 (TLS)

- 调用 vTaskDelete(NULL) 删除当前运行的任务

此外，从共享堆栈上运行的函数中，或该函数调用的任何函数中调用回溯，回溯信息都可能不正确。这方面的限制十分严格，因此将来 `esp_execute_shared_stack_function()` 可能会被弃用。如有用例必须使用 `esp_execute_shared_stack_function()` 函数才能实现，请提交 GitHub Issue。

## 使用方法

`esp_execute_shared_stack_function()` 需要四个参数：

- 由调用者分配的互斥锁，用于保护共享堆栈

- 指向分配的堆栈的指针

- 以字节为单位的堆栈的大小

- 指向需要使用共享堆栈的函数的指针

通过这一功能，用户指定的函数被作为回调函数立即执行，并在用户分配的空间中调用，无需从当前任务堆栈中获取空间。

该函数的使用方式如下所示：

    void external_stack_function(void)
    {
        printf("Executing this printf from external stack! \n");
    }

    //假设要使用一个单独的堆栈空间来调用 printf 函数
    //允许应用程序减小其堆栈大小
    void app_main()
    {
        //从堆中或以静态方式分配一个堆栈 buffer：
        StackType_t *shared_stack = malloc(8192 * sizeof(StackType_t));
        assert(shared_stack != NULL);

        //分配一个互斥锁：
        SemaphoreHandle_t printf_lock = xSemaphoreCreateMutex();
        assert(printf_lock != NULL);

        //使用宏助手调用所需函数：
        esp_execute_shared_stack_function(printf_lock,
                                        shared_stack,
                                        8192,
                                        external_stack_function);

        vSemaphoreDelete(printf_lock);
        free(shared_stack);
    }

## API 参考

### Header File

- components/esp_system/include/esp_expression_with_stack.h

- This header file can be included with:

  >     #include "esp_expression_with_stack.h"

### Functions

void esp_execute_shared_stack_function(SemaphoreHandle_t lock, void *stack, size_t stack_size, shared_stack_function function)

  Calls function on user defined shared stack space.

  After returning, the original stack is used again.

  备注

  if either lock, stack or stack size is invalid, the expression will be called using the current stack.

  警告

  This function does minimal preparation of the provided piece of memory (`stack`). DO NOT do any of the following in `function` or any of its callees:

  - Use Thread-local storage

  - Use the Floating-point unit on ESP32-P4

  - Use the AI co-processor on ESP32-P4

  - Call vTaskDelete(NULL) (deleting the currently running task) Furthermore, backtraces will be wrong when called from `function` or any of its callees. The limitations are quite sever, so that we might deprecate this function in the future. If you have any use case which can only be implemented using this function, please open an issue on github.

  参数:

    - lock -- Mutex object to protect in case of shared stack

    - stack -- Pointer to user allocated stack

    - stack_size -- Size of current stack in bytes

    - function -- pointer to the shared stack function to be executed

### Macros

ESP_EXECUTE_EXPRESSION_WITH_STACK(lock, stack, stack_size, expression)

### Type Definitions

typedef void (*shared_stack_function)(void)

此文档对您有帮助吗？

- 反馈已收到，谢谢！
- 如果您有其他意见，欢迎填写乐鑫文档反馈表。

- 我们重视您的反馈。
- 您可以填写乐鑫文档反馈表告诉我们如何改进该文档。