Merge 8c2dec097b into 62bd622ffc

feat(freertos/smp): Add Granular Locking V4 proposal documents
Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
2025-07-05 11:57:15 -04:00 · 2025-06-11 15:38:49 +00:00 · 2025-06-11 17:38:36 +02:00 · 2025-06-11 17:38:36 +02:00 · 2025-06-11 17:38:36 +02:00 · 2025-06-11 17:38:36 +02:00
1 changed files with 27 additions and 33 deletions
--- a/include/task.h
+++ b/include/task.h
@ -298,18 +298,12 @@ typedef enum
        vTaskPreemptionDisable( NULL );                                                   \
        {                                                                                 \
            const BaseType_t xCoreID = ( BaseType_t ) portGET_CORE_ID();                  \
-            if( portGET_CRITICAL_NESTING_COUNT( xCoreID ) == 0U ) {                       \
-                /* Task spinlock is always taken first */                                 \
-                portGET_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxTaskSpinlock );      \
-                /* Disable interrupts */                                                  \
-                portDISABLE_INTERRUPTS();                                                 \
-                /* Take the ISR spinlock next */                                          \
-                portGET_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxISRSpinlock );       \
-            }                                                                             \
-            else                                                                          \
-            {                                                                             \
-                mtCOVERAGE_TEST_MARKER();                                                 \
-            }                                                                             \
+            /* Task spinlock is always taken first */                                     \
+            portGET_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxTaskSpinlock );          \
+            /* Disable interrupts */                                                      \
+            portDISABLE_INTERRUPTS();                                                     \
+            /* Take the ISR spinlock next */                                              \
+            portGET_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxISRSpinlock );           \
            /* Increment the critical nesting count */                                    \
            portINCREMENT_CRITICAL_NESTING_COUNT( xCoreID );                              \
        }                                                                                 \
@ -345,27 +339,27 @@ typedef enum
 * \ingroup GranularLocks
 */
 #if ( portUSING_GRANULAR_LOCKS == 1 )
-    #define taskDATA_GROUP_EXIT_CRITICAL( pxTaskSpinlock, pxISRSpinlock )            \
-    do {                                                                             \
-        const BaseType_t xCoreID = ( BaseType_t ) portGET_CORE_ID();                 \
-        configASSERT( portGET_CRITICAL_NESTING_COUNT( xCoreID ) > 0U );              \
-        /* Decrement the critical nesting count */                                   \
-        portDECREMENT_CRITICAL_NESTING_COUNT( xCoreID );                             \
-        if( portGET_CRITICAL_NESTING_COUNT( xCoreID ) == 0 )                         \
-        {                                                                            \
-            /* Release the ISR spinlock */                                           \
-            portRELEASE_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxISRSpinlock );  \
-            /* Enable interrupts */                                                  \
-            portENABLE_INTERRUPTS();                                                 \
-            /* Release the task spinlock */                                          \
-            portRELEASE_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxTaskSpinlock ); \
-        }                                                                            \
-        else                                                                         \
-        {                                                                            \
-            mtCOVERAGE_TEST_MARKER();                                                \
-        }                                                                            \
-        /* Re-enable preemption */                                                   \
-        vTaskPreemptionEnable( NULL );                                               \
+    #define taskDATA_GROUP_EXIT_CRITICAL( pxTaskSpinlock, pxISRSpinlock )        \
+    do {                                                                         \
+        const BaseType_t xCoreID = ( BaseType_t ) portGET_CORE_ID();             \
+        configASSERT( portGET_CRITICAL_NESTING_COUNT( xCoreID ) > 0U );          \
+        /* Release the ISR spinlock */                                           \
+        portRELEASE_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxISRSpinlock );  \
+        /* Release the task spinlock */                                          \
+        portRELEASE_SPINLOCK( xCoreID, ( portSPINLOCK_TYPE * ) pxTaskSpinlock ); \
+        /* Decrement the critical nesting count */                               \
+        portDECREMENT_CRITICAL_NESTING_COUNT( xCoreID );                         \
+        /* Enable interrupts only if the critical nesting count is 0 */          \
+        if( portGET_CRITICAL_NESTING_COUNT( xCoreID ) == 0 )                     \
+        {                                                                        \
+            portENABLE_INTERRUPTS();                                             \
+        }                                                                        \
+        else                                                                     \
+        {                                                                        \
+            mtCOVERAGE_TEST_MARKER();                                            \
+        }                                                                        \
+        /* Re-enable preemption */                                               \
+        vTaskPreemptionEnable( NULL );                                           \
    } while( 0 )
 #endif /* #if ( portUSING_GRANULAR_LOCKS == 1 ) */
Author	SHA1	Message	Date
Sudeep Mohanty	ed90c6ac80	Merge `8c2dec097b` into `62bd622ffc`	2025-06-11 15:38:49 +00:00
Darian Leung	8c2dec097b	feat(freertos/smp): Add Granular Locking V4 proposal documents Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	42fce69365	change(freertos/smp): Update timers.c locking Updated timers.c to use granular locking - Added xTaskSpinlock and xISRSpinlock - Replaced critical section macros with data group critical section macros such as taskENTER/EXIT_CRITICAL() with tmrENTER/EXIT_CRITICAL(). - Added vTimerEnterCritical() and vTimerExitCritical() to map to the data group critical section macros. Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	7f2c159dee	change(freertos/smp): Update stream_buffer.c locking Updated stream_buffer.c to use granular locking - Added xTaskSpinlock and xISRSpinlock - Replaced critical section macros with data group critical section macros such as taskENTER/EXIT_CRITICAL/_FROM_ISR() with sbENTER/EXIT_CRITICAL_FROM_ISR(). - Added vStreambuffersEnterCritical/FromISR() and vStreambuffersExitCritical/FromISR() to map to the data group critical section macros. - Added prvLockStreamBufferForTasks() and prvUnlockStreamBufferForTasks() to suspend the stream buffer when executing non-deterministic code. Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	1b6b659c68	change(freertos/smp): Update event_groups.c locking Updated event_groups.c to use granular locking - Added xTaskSpinlock and xISRSpinlock - Replaced critical section macros with data group critical section macros such as taskENTER/EXIT_CRITICAL/_FROM_ISR() with event_groupsENTER/EXIT_CRITICAL/_FROM_ISR(). - Added vEventGroupsEnterCritical/FromISR() and vEventGroupsExitCriti/FromISR() functions that map to the data group critical section macros. - Added prvLockEventGroupForTasks() and prvUnlockEventGroupForTasks() to suspend the event group when executing non-deterministic code. - xEventGroupSetBits() and vEventGroupDelete() accesses the kernel data group directly. Thus, added vTaskSuspendAll()/xTaskResumeAll() to these fucntions. Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	9ad6c81b31	change(freertos/smp): Update queue.c locking Updated queue.c to use granular locking - Added xTaskSpinlock and xISRSpinlock - Replaced critical section macros with data group critical section macros such as taskENTER/EXIT_CRITICAL/_FROM_ISR() with queueENTER/EXIT_CRITICAL_FROM_ISR(). - Added vQueueEnterCritical/FromISR() and vQueueExitCritical/FromISR() which map to the data group critical section macros. - Added prvLockQueueForTasks() and prvUnlockQueueForTasks() as the granular locking equivalents to prvLockQueue() and prvUnlockQueue() respectively Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	fd47eba3c7	change(freertos/smp): Update tasks.c locking Updated critical section macros with granular locks. Some tasks.c API relied on their callers to enter critical sections. This assumption no longer works under granular locking. Critical sections added to the following functions: - `vTaskInternalSetTimeOutState()` - `xTaskIncrementTick()` - `vTaskSwitchContext()` - `xTaskRemoveFromEventList()` - `vTaskInternalSetTimeOutState()` - `eTaskConfirmSleepModeStatus()` - `xTaskPriorityDisinherit()` - `pvTaskIncrementMutexHeldCount()` Added missing suspensions to the following functions: - `vTaskPlaceOnEventList()` - `vTaskPlaceOnUnorderedEventList()` - `vTaskPlaceOnEventListRestricted()` Fixed the locking in vTaskSwitchContext() vTaskSwitchContext() must aquire both kernel locks, viz., task lock and ISR lock. This is because, vTaskSwitchContext() can be called from either task context or ISR context. Also, vTaskSwitchContext() must not alter the interrupt state prematurely. Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:36 +02:00
Darian Leung	322512c65b	feat(granular_locks): Add granular locking functions - Updated prvCheckForRunStateChange() for granular locks - Updated vTaskSuspendAll() and xTaskResumeAll() - Now holds the xTaskSpinlock during kernel suspension - Increments/decrements xPreemptionDisable. Only yields when 0, thus allowing for nested suspensions across different data groups Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>	2025-06-11 17:38:29 +02:00