Feature/smp granular locks v4#1154
Draft
sudeep-mohanty wants to merge 11 commits into
Draft
Conversation
Contributor
Author
|
@chinglee-iot @aggarg This PR introduces the granular locks changes to the FreeRTOS kernel. Please have a look and we could have discussions/changes in this PR context. Thank you. cc: @ESP-Marius @Dazza0 |
Member
|
Thank you for your contribution, I'll forward this request to the team. There are few error in the PR can you please try fixing them |
Member
|
Hello @sudeep-mohanty, I am just following up if you had time to fix the build issues |
Contributor
Author
|
@rawalexe Yes! I shall work on the failures and would also do some refactoring for an easier review process. For now, I've put this PR in draft. |
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
9 times, most recently
from
0159a4a to
5bf8c33
Compare
Member
|
Hi @sudeep-mohanty, |
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
5bf8c33 to
9f8acc7
Compare
Contributor
Author
Hi @ActoryOu, I've made some updates which should fix the CI failures however I could not understand why the link-verifier action fails. Seems more like a script failure to me. So this action would still fail. If you have more information on what is causing it, could you let me know and I shall fix it. Thanks. |
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
2 times, most recently
from
c79962d to
f50d476
Compare
Closed
1 task
Contributor
Author
|
Created a PR to fix the CI failure - FreeRTOS/FreeRTOS#1292 |
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
4 times, most recently
from
70eb466 to
edc1c98
Compare
|
chinglee-iot
reviewed
Dec 9, 2024
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
b20d191 to
1b91c54
Compare
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
5830f5c to
e850728
Compare
|
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
2555192 to
5463443
Compare
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
5463443 to
d33a460
Compare
|
|
Contributor
There was a problem hiding this comment.
- Update to adapt to the unit test, C89 and GNU C extension.
- Suggest not to include configQUEUE_DIRECT_TRANSFER. We can consider this feature individually.
- Suggest to remove configLIGHTWEIGHT_CRITICAL_SECTION.
- Documentation for 'prvKernelEnterISROnlyCritical' and 'prvKernelExitISROnlyCritical'. The name of the function may be updated to
prvKernelEnterNestedCriticalSectionor other to imply this should be called when task lock of a data group is acquired already. - queue prvNotifyQueueSetContainer take only ISR spinlock only
- xTaskIncrementTick function update for vApplicationTickHook()
- Use macro to reduce lines of code for portBASE_TYPE_ENTER/EXIT_CRITICAL
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
64219a4 to
f06f3a5
Compare
…herit() xTaskPriorityInherit() is called inside a critical section from queue.c. This commit moves the critical section into xTaskPriorityInherit(). Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
Changed xPreemptionDisable to be a count rather than a pdTRUE/pdFALSE. This allows nested calls to vTaskPreemptionEnable(), where a yield only occurs when xPreemptionDisable is 0. Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
Adds the required checks for granular locking port macros.
Port Config:
- portUSING_GRANULAR_LOCKS to enable granular locks
- portCRITICAL_NESTING_IN_TCB should be disabled
Granular Locking Port Macros:
- Spinlocks
- portSPINLOCK_TYPE
- portINIT_SPINLOCK( pxSpinlock )
- portINIT_SPINLOCK_STATIC
- Locking
- portGET_SPINLOCK()
- portRELEASE_SPINLOCK()
Co-authored-by: Sudeep Mohanty <sudeep.mohanty@espressif.com>
- 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>
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>
chinglee-iot
reviewed
Jun 8, 2026
Contributor
chinglee-iot
left a comment
chinglee-iot
left a comment
There was a problem hiding this comment.
- Update for deferred deletion problem.
- Update for compiler condition. We should review the usage of portUSING_GRANULAR_LOCKS and configUSE_TASK_PREEMPTION_DISABLE for correctness.
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
2 times, most recently
from
aa96056 to
30ce00f
Compare
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>
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>
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>
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>
The design document captures the **Dual Spinlock With Data Group Locking** scheme used by the granular-locks implementation: data-group definitions and hierarchy, public and port-layer API, TCB locks, deferred state changes, ISR-only kernel critical-section helpers, event-list TOCTOU considerations, and current limitations.
sudeep-mohanty
force-pushed
the
feature/smp_granular_locks_v4
branch
from
30ce00f to
177f878
Compare
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds support for granular locking to the FreeRTOS kernel.
Description
Granular locking introduces the concept of having localized locks per kernel data group for SMP configuration. This method is an optional replacement of the existing kernel locks and is controlled by a new port layer configuration, viz.,
portUSING_GRANULAR_LOCKS. More details about the approach can be found here.Test Steps
The implementation has been tested on Espressif SoC targets, viz., the ESP32 using the ESP-IDF framework.
1. Testing on an
esp32targetesp32, setup the ESP-IDF environment on your local machine. The steps to follow are listed in the Getting Started Guide.components/freertos/test_apps/freertoswhere all the test cases are located.performancesubfolder at the same location.idf.py seet-target esp32.menuconfigoptions. To do this you must enter the command-idf.py menuconfig->Component config->FreeRTOS->Kernel->Run the Amazon SMP FreeRTOS kernel instead (FEATURE UNDER DEVELOPMENT). Save the configuration and exit the menuconfig.idf.py build flash monitor.TODO
Checklist:
Related Issue
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.