Skip to main content

Mutex (Mutual Exclusion Lock)

LibXR::Mutex provides a lightweight, cross-platform thread mutual exclusion mechanism for protecting critical sections in a multitasking environment. It currently supports POSIX pthread, FreeRTOS, and ThreadX. In bare-metal-style none / webasm paths, the current implementation degrades into a minimal busy-wait lock around a scalar handle and periodically calls Timer::RefreshTimerInIdle() while waiting.

⚠️ Note: Mutex must only be used in thread context. It is not supported in interrupt service routines (ISRs).

Design Highlights

GoalDescription
Cross-platformHides differences like pthread_mutex, xSemaphoreHandle, TX_MUTEX, etc.
RAII-friendlyBuilt-in LockGuard to prevent forgetting Unlock().
RTOS Mutex SemanticsCurrent FreeRTOS path uses the kernel mutex type with priority inheritance, while the current ThreadX path is created with TX_NO_INHERIT.
LightweightCall path is close to low-level system calls for minimal overhead.

Core Interface

class Mutex {
public:
Mutex();
~Mutex();

ErrorCode Lock(); // Blocking lock
ErrorCode TryLock(); // Non-blocking attempt
void Unlock(); // Unlock

class LockGuard {
public:
explicit LockGuard(Mutex& m);
~LockGuard();
};
};

Usage Example

LibXR::Mutex m;
int shared = 0;

void Worker()
{
LibXR::Mutex::LockGuard lock(m); // Locks on construction
shared++; // Safe access
} // Unlocks on destruction