% ======================================================================
% ======================================================================
\chapter{Mutex Statement}\label{s:mutexstmt}
% ======================================================================
% ======================================================================

The mutex statement is a concurrent language feature that aims to support easy lock usage. 
The mutex statement is in the form of a clause and following statement, similar to a loop or conditional statement. 
In the clause the mutex statement accepts a number of lockable objects, and then locks them for the duration of the following statement. 
The locks are acquired in a deadlock free manner and released using \gls{raii}. 
The mutex statement provides an avenue for easy lock usage in the common case where locks are used to wrap a critical section. 
Additionally, it provides the safety guarantee of deadlock-freedom, both by acquiring the locks in a deadlock-free manner, and by ensuring that the locks release on error, or normal program execution via \gls{raii}.

\begin{cfacode}[tabsize=3,caption={\CFA mutex statement usage},label={l:cfa_mutex_ex}]
owner_lock lock1, lock2, lock3;
int count = 0; 
mutex( lock1, lock2, lock3 ) {
    // can use block statement
    // ...
}
mutex( lock2, lock3 ) count++; // or inline statement
\end{cfacode}

\section{Other Languages}
There are similar concepts to the mutex statement that exist in other languages. 
Java has a feature called a synchronized statement, which looks identical to \CFA's mutex statement, but it has some differences. 
The synchronized statement only accepts a single object in its clause. 
Any object can be passed to the synchronized statement in Java since all objects in Java are monitors, and the synchronized statement acquires that object's monitor. 
In \CC there is a feature in the standard library \code{<mutex>} header called scoped\_lock, which is also similar to the mutex statement. 
The scoped\_lock is a class that takes in any number of locks in its constructor, and acquires them in a deadlock-free manner. 
It then releases them when the scoped\_lock object is deallocated, thus using \gls{raii}. 
An example of \CC scoped\_lock usage is shown in Listing~\ref{l:cc_scoped_lock}.

\begin{cppcode}[tabsize=3,caption={\CC scoped\_lock usage},label={l:cc_scoped_lock}]
std::mutex lock1, lock2, lock3;
{
    scoped_lock s( lock1, lock2, lock3 )
    // locks are released via raii at end of scope
}
\end{cppcode}

\section{\CFA implementation}
The \CFA mutex statement takes some ideas from both the Java and \CC features. 
The mutex statement can acquire more that one lock in a deadlock-free manner, and releases them via \gls{raii} like \CC, however the syntax is identical to the Java synchronized statement. 
This syntactic choice was made so that the body of the mutex statement is its own scope. 
Compared to the scoped\_lock, which relies on its enclosing scope, the mutex statement's introduced scope can provide visual clarity as to what code is being protected by the mutex statement, and where the mutual exclusion ends. 
\CFA's mutex statement and \CC's scoped\_lock both use parametric polymorphism to allow user defined types to work with the feature. 
\CFA's implementation requires types to support the routines \code{lock()} and \code{unlock()}, whereas \CC requires those routines, plus \code{try_lock()}. 
The scoped\_lock requires an additional routine since it differs from the mutex statement in how it implements deadlock avoidance.

The parametric polymorphism allows for locking to be defined for types that may want convenient mutual exclusion. 
An example of one such use case in \CFA is \code{sout}. 
The output stream in \CFA is called \code{sout}, and functions similarly to \CC's \code{cout}. 
\code{sout} has routines that satisfy the mutex statement trait, so the mutex statement can be used to lock the output stream while producing output. 
In this case, the mutex statement allows the programmer to acquire mutual exclusion over an object without having to know the internals of the object or what locks need to be acquired. 
The ability to do so provides both improves safety and programmer productivity since it abstracts away the concurrent details and provides an interface for optional thread-safety. 
This is a commonly used feature when producing output from a concurrent context, since producing output is not thread safe by default. 
This use case is shown in Listing~\ref{l:sout}.

\begin{cfacode}[tabsize=3,caption={\CFA sout with mutex statement},label={l:sout}]
mutex( sout )
    sout | "This output is protected by mutual exclusion!"; 
\end{cfacode}

\section{Deadlock Avoidance}
The mutex statement uses the deadlock prevention technique of lock ordering, where the circular-wait condition of a deadlock cannot occur if all locks are acquired in the same order. 
The scoped\_lock uses a deadlock avoidance algorithm where all locks after the first are acquired using \code{try_lock} and if any of the attempts to lock fails, all locks so far are released. 
This repeats until all locks are acquired successfully. 
The deadlock avoidance algorithm used by scoped\_lock is shown in Listing~\ref{l:cc_deadlock_avoid}. 
The algorithm presented is taken directly from the source code of the \code{<mutex>} header, with some renaming and comments for clarity.

\begin{cppcode}[caption={\CC scoped\_lock deadlock avoidance algorithm},label={l:cc_deadlock_avoid}]
int first = 0;  // first lock to attempt to lock
do {
    // locks is the array of locks to acquire
    locks[first].lock();    // lock first lock
    for (int i = 1; i < Num_Locks; ++i) {   // iterate over rest of locks
        const int idx = (first + i) % Num_Locks;
        if (!locks[idx].try_lock()) {       // try lock each one
            for (int j = i; j != 0; --j)    // release all locks
                locks[(first + j - 1) % Num_Locks].unlock();
            first = idx;    // rotate which lock to acquire first
            break;
        }
    }
// if first lock is still held then all have been acquired
} while (!locks[first].owns_lock());  // is first lock held?
\end{cppcode}

The algorithm in \ref{l:cc_deadlock_avoid} successfully avoids deadlock, however there is a potential livelock scenario. 
Given two threads $A$ and $B$, who create a scoped\_lock with two locks $L1$ and $L2$, a livelock can form as follows. 
Thread $A$ creates a scoped\_lock with $L1$, $L2$, and $B$ creates a scoped lock with the order $L2$, $L1$. 
Both threads acquire the first lock in their order and then fail the try\_lock since the other lock is held. 
They then reset their start lock to be their 2nd lock and try again. 
This time $A$ has order $L2$, $L1$, and $B$ has order $L1$, $L2$. 
This is identical to the starting setup, but with the ordering swapped among threads. 
As such, if they each acquire their first lock before the other acquires their second, they can livelock indefinitely.

The lock ordering algorithm used in the mutex statement in \CFA is both deadlock and livelock free. 
It sorts the locks based on memory address and then acquires them. 
For locks fewer than 7, it sorts using hard coded sorting methods that perform the minimum number of swaps for a given number of locks. 
For 7 or more locks insertion sort is used. 
These sorting algorithms were chosen since it is rare to have to hold more than  a handful of locks at a time. 
It is worth mentioning that the downside to the sorting approach is that it is not fully compatible with usages of the same locks outside the mutex statement. 
If more than one lock is held by a mutex statement, if more than one lock is to be held elsewhere, it must be acquired via the mutex statement, or else the required ordering will not occur. 
Comparitively, if the scoped\_lock is used and the same locks are acquired elsewhere, there is no concern of the scoped\_lock deadlocking, due to its avoidance scheme, but it may livelock.

\begin{figure}
    \centering
    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/nasus_Aggregate_Lock_2.pgf}}
        \subcaption{AMD}
    \end{subfigure}\hfill
    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/pyke_Aggregate_Lock_2.pgf}}
        \subcaption{Intel}
    \end{subfigure}

    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/nasus_Aggregate_Lock_4.pgf}}
        \subcaption{AMD}
    \end{subfigure}\hfill
    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/pyke_Aggregate_Lock_4.pgf}}
        \subcaption{Intel}
    \end{subfigure}

    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/nasus_Aggregate_Lock_8.pgf}}
        \subcaption{AMD}\label{f:mutex_bench8_AMD}
    \end{subfigure}\hfill
    \begin{subfigure}{0.5\textwidth}
        \centering
        \scalebox{0.5}{\input{figures/pyke_Aggregate_Lock_8.pgf}}
        \subcaption{Intel}\label{f:mutex_bench8_Intel}
    \end{subfigure}
    \caption{The aggregate lock benchmark comparing \CC scoped\_lock and \CFA mutex statement throughput (higher is better).}
    \label{f:mutex_bench}
\end{figure}

\section{Performance}
Performance is compared between \CC's scoped\_lock and \CFA's mutex statement. 
Comparison with Java is omitted, since it only takes a single lock. 
To ensure that the comparison between \CC and \CFA exercises the implementation of each feature, an identical spinlock is implemented in each language using a set of builtin atomics available in both \CFA and \CC. 
Each feature is evaluated on a benchmark which acquires a fixed number of locks in a random order and then releases them. 
A baseline is included that acquires the locks directly without a mutex statement or scoped\_lock in a fixed ordering and then releases them. 
The baseline helps highlight the cost of the deadlock avoidance/prevention algorithms for each implementation. 
The benchmarks are run for a fixed duration of 10 seconds and then terminate and return the total number of times the group of locks were acquired. 
Each variation is run 11 times on a variety up to 32 cores and with 2, 4, and 8 locks being acquired. 
The median is calculated and is plotted alongside the 95\% confidence intervals for each point.

Figure~\ref{f:mutex_bench} shows the results of the benchmark. 
The baseline runs for both languages are mostly comparable, except for the 8 locks results in \ref{f:mutex_bench8_AMD} and \ref{f:mutex_bench8_Intel}, where the \CFA baseline is slower. 
\CFA's mutex statement achieves throughput that is magnitudes higher than \CC's scoped\_lock. 
This is likely due to the scoped\_lock deadlock avoidance implementation. 
Since it uses a retry based mechanism, it can take a long time for threads to progress. 
Additionally the potential for livelock in the algorithm can result in very little throughput under high contention. 
It was observed on the AMD machine that with 32 threads and 8 locks the benchmarks would occasionally livelock indefinitely, with no threads making any progress for 3 hours before the experiment was terminated manually. 
It is likely that shorter bouts of livelock occured in many of the experiments, which would explain large confidence intervals for some of the data points in the \CC data. 
In Figures~\ref{f:mutex_bench8_AMD} and \ref{f:mutex_bench8_Intel} the mutex statement performs better than the baseline. 
At 7 locks and above the mutex statement switches from a hard coded sort to insertion sort. 
It is likely that the improvement in throughput compared to baseline is due to the time spent in the insertion sort, which decreases contention on the locks.
