SetCriticalSectionSpinCount

The SetCriticalSectionSpinCount function sets the spin count for the specified critical section.

DWORD SetCriticalSectionSpinCount(
  LPCRITICAL_SECTION lpCriticalSection, // critical section
  DWORD dwSpinCount                     // spin count
);

Parameters

lpCriticalSection

[in/out] Pointer to the critical section object.

dwSpinCount

[in] Specifies the spin count for the critical section object. On uniprocessor systems, the spin count is ignored and the critical section spin count is set to 0. On multiprocessor systems, if contention for the critical section occurs, the calling thread will spin dwSpinCount times before waiting on a semaphore associated with the critical section. If the critical section becomes free during the spin operation, the wait is avoided.

Return Values

The function returns the previous spin count for the critical section.

Remarks

The threads of a single process can use a critical section object for mutual-exclusion synchronization. The process is responsible for allocating the memory used by a critical section object, which it can do by declaring a variable of type CRITICAL_SECTION. Before using a critical section, some thread of the process must call the InitializeCriticalSection or InitializeCriticalSectionAndSpinCount function to initialize the object. You can subsequently modify the spin count by calling the SetCriticalSectionSpinCount function.

The spin count is useful for critical sections of short duration that can experience high levels of contention. Consider a worst-case scenario, in which an application on an SMP system has two or three threads constantly allocating and releasing memory from the heap. The application serializes the heap with a critical section. In the worst-case scenario, contention for the critical section is constant, and each thread makes an expensive call to the WaitForSingleObject function. However, if the spin count is set properly, the calling thread will not immediately call WaitForSingleObject when contention occurs. Instead, the calling thread can acquire ownership of the critical section if it is released during the spin operation.

You can improve performance significantly by choosing a small spin count for a critical section of short duration. The heap manager uses a spin count of roughly 4000 for its per-heap critical sections. This gives great performance and scalability in almost all worst-case scenarios.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 SP3 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Winbase.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

Synchronization Overview, Synchronization Functions, InitializeCriticalSection, InitializeCriticalSectionAndSpinCount, WaitForSingleObject