From 92829f66c84da50a8b77aeb88792a6d888f0372a Mon Sep 17 00:00:00 2001 From: RichFalk Date: Sun, 17 Oct 2021 20:58:00 -0700 Subject: [PATCH] esp_ringbuf: Fix assertion xQueueGenericSend queue.c:818 The release of the semaphore indicating the item was successfully sent must be the last semaphore released. The receiver may be in another task and may delete the Ringbuffer (such as with a return code across tasks design pattern) if they are through with the Ringbuffer. The function xRingbufferSendAcquire followed by xRingbufferSendComplete had the semaphores released in the proper order and that same pattern should have been used in xRingbufferSend and xRingbufferSendFromISR. This commit fixes this order. Issue (IDFGH-6030) #7716 describes the problem in more detail. Closes IDFGH-6030, https://github.com/espressif/esp-idf/issues/7716 Closes IDFGH-6036, https://github.com/espressif/esp-idf/pull/7721 --- components/esp_ringbuf/ringbuf.c | 30 +++++++++++------------------- 1 file changed, 11 insertions(+), 19 deletions(-) diff --git a/components/esp_ringbuf/ringbuf.c b/components/esp_ringbuf/ringbuf.c index 2ccb93eaf3..d8d3cbe6ee 100644 --- a/components/esp_ringbuf/ringbuf.c +++ b/components/esp_ringbuf/ringbuf.c @@ -1,16 +1,8 @@ -// Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. +/* + * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ #include #include @@ -1076,13 +1068,13 @@ BaseType_t xRingbufferSend(RingbufHandle_t xRingbuffer, */ } + if (xReturnSemaphore == pdTRUE) { + xSemaphoreGive(rbGET_TX_SEM_HANDLE(pxRingbuffer)); //Give back semaphore so other tasks can send + } if (xReturn == pdTRUE) { //Indicate item was successfully sent xSemaphoreGive(rbGET_RX_SEM_HANDLE(pxRingbuffer)); } - if (xReturnSemaphore == pdTRUE) { - xSemaphoreGive(rbGET_TX_SEM_HANDLE(pxRingbuffer)); //Give back semaphore so other tasks can send - } return xReturn; } @@ -1118,13 +1110,13 @@ BaseType_t xRingbufferSendFromISR(RingbufHandle_t xRingbuffer, } portEXIT_CRITICAL_ISR(&pxRingbuffer->mux); + if (xReturnSemaphore == pdTRUE) { + xSemaphoreGiveFromISR(rbGET_TX_SEM_HANDLE(pxRingbuffer), pxHigherPriorityTaskWoken); //Give back semaphore so other tasks can send + } if (xReturn == pdTRUE) { //Indicate item was successfully sent xSemaphoreGiveFromISR(rbGET_RX_SEM_HANDLE(pxRingbuffer), pxHigherPriorityTaskWoken); } - if (xReturnSemaphore == pdTRUE) { - xSemaphoreGiveFromISR(rbGET_TX_SEM_HANDLE(pxRingbuffer), pxHigherPriorityTaskWoken); //Give back semaphore so other tasks can send - } return xReturn; }