Thu, Jul
2 New Articles

The Most Lightweight Mutually Exclusive Synchronization Mechanism

  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Implement the mutex primitive via MI instructions CHKLKVAL and CLRLKVAL.


Efforts of numerous computer scientists have been devoted to solving performance problems in different performance-critical circumstances. One of these performance problems is the expense in thread synchronization. Thread synchronization is the application of particular mechanisms to ensure that two concurrently executing threads do not execute specific portions of a program at the same time. By using MUTual EXclusion (mutex), access to shared resources from multiple threads can be serialized, and mutually exclusive program logic can be guaranteed to run in a single thread at any time. Thread synchronization is not limited to threads in the same process; it also applies to synchronization between different processes, or in other words, threads in different processes.


Mutex is the most frequently used thread synchronization primitive. Only one thread can lock (or own) a mutex at any given time. No other thread can own that mutex until the owning thread unlocks (or gives up) that mutex. Thus, access to shared resource or mutually exclusive program logics can be protected between a successful acquisition of a mutex and an unlock operation on the mutex.


i5/OS implements the mutex primitive via pointer-based mutexes at the MI level. In i5/OS, both POSIX thread (Pthread) mutexes and conditional variables are implemented using pointer-based mutexes. ILE high-level language (HLL) programs can use pointer-based mutexes either directly via mutex management MI instructions or through Pthread mutex synchronization APIs. As a frequently used thread synchronization mechanism, pointer-based mutexes are more lightweight than many other synchronization mechanisms, such as object locks or space location locks. Locking a pointer-based mutex uses about 50 RISC instructions, while acquiring a space location lock uses about 500 RISC instructions. But pointer-based mutexes are not lightweight enough where thread synchronization is heavily used. First, a pointer-based mutex uses about 1000 RISC instructions for creation or deletion. It's obviously a big performance overhead when pointer-based mutexes are to be created and then destroyed frequently. Second, when creating a pointer-based mutex, system resources are allocated for it; performance degradation of the whole system can occur as the number of created pointer-based mutexes increases. So is there a more lightweight mutually exclusive synchronization mechanism in i5/OS?


The answer lies in two MI instructions: Check Lock Value (CHKLKVAL) and Clear Lock Value (CLRLKVAL). Unlike pointer-based mutexes, these two MI instructions implement mutually exclusive synchronization basing on a shared 8-byte signed binary scalar, rather than a mutex object; therefore, they have no creation or deletion costs associated with them and will not lead to system resource overhead. Let's take a close look at these instructions and see how to use them to implement mutually exclusive synchronization.

Implementing the Mutex Primitive via MI Instructions CHKLKVAL and CLRLKVAL

The CHKLKVAL and CLRLKVAL instructions should be used in combination when implementing mutually exclusive synchronization between two or more threads. The following ILE RPG prototypes of the system built-ins of these instructions are extracted from mih54.rpgleinc of open-source project i5/OS Programmer's Toolkit:



      * CHKLKVAL, check lock value


     d chklkval        pr            10i 0 extproc('_CHKLKVAL')

     d     lock                      20i 0

     d     old_val                   20i 0 value

     d     new_val                   20i 0 value


     /* CLRKLVAL, check lock value */

     d clrlkval        pr                  extproc('_CLRLKVAL')

     d     lock                      20i 0

     d     new_val                   20i 0 value


CHKLKVAL performs the following atomic (not interruptible) sequence of operations: the value of lock is compared to the value of old_val. If the two values are equal, the value of new_val is stored into lock and the numeric value 0 is returned. If the two values are not equal, the numeric value 1 is returned. CLRLKVAL stores the value of new_val to lock atomically. Note that the 8-byte signed binary scalar lock should be accessible to all threads to be synchronized.


Here's a basic example of implementing mutually exclusive synchronization via the CHKLKVAL and CLRLKVAL instructions:



           // Try to acquire the lock.

           dow chklkval(lock : 0 : 1) = 1;

               // Wait for a short time.



           // After acquiring the lock, access shared resources

           // or run mutually exclusive program logics.


           // Release the lock.

           clrlkval(lock : 0);



In this example, lock is a shared 8-byte signed binary scalar with initial value zero. To acquire the ownership of lock, each thread loops until invoking CHKLKVAL on lock returns zero. After a successful acquisition of lock, a thread becomes the owner of lock and is permitted to access shared resources or run mutually exclusive program logics protected by lock.


Since CHKLKVAL performs the comparison of lock to numeric value zero and the update operation of lock atomically, when multiple threads invoke CHKLKVAL concurrently, only one thread can see the state that lock is equal to zero, change lock's value to one, and then become the owner of lock. Once the ownership of lock is acquired by one thread, all other threads trying to acquire lock are kept outside the door. After doing its jobs, the owning thread gives up its ownership of lock by invoking CLRLKVAL to restore lock's value to zero atomically. This allows other threads to acquire lock. By now, a high-performance mutually exclusive synchronization mechanism has been implemented. For a complete code example, please refer to t105.rpgle.

Additional Considerations

Attention should be paid to several additional points.


First, the lock operand of CHKLKVAL and CLRLKVAL must be 8-byte aligned. Failure to have lock aligned properly will not be detected, but the results of the CHKLKVAL and CLRLKVAL instructions are undefined.


Second, where can the lock be stored? For synchronization between threads belonging to different i5/OS jobs, it can be stored in space objects or associated spaces of other i5/OS objects that can be accessed from jobs to be synchronized. For synchronization between threads within a job, it can be stored in any form of global program storage. For example, it can be a data object exported by a service program, or it can be allocated from static storage, activation group-based heap storage, or teraspace storage by the initial thread of the job and then passed to threads to synchronize.


Third, in the mutex implementation discussed here, the owner of a mutex should not hold the lock for the mutex too long—for example, while waiting to receive a message from a message queue or waiting for user input from the STDIN. At the time a mutex is being owned by one thread, there are probably other threads that are trying to acquire this mutex by invoking CHKLKVAL repeatedly, which obviously will waste processor time.


Last, as low-level synchronization instructions, CHKLKVAL and CLRLKVAL provide no options for deadlock detection or prevention, as would be available with pointer-based mutexes. To implement recursive locks using CHKLKVAL and CLRLKVAL, additional design and implementation efforts are needed. For example, the following two procedures implement a reentrant mutex that can be locked recursively only by its current owner.


     /* Acquire a mutually exclusive lock recursively. */

     d recursive_lock...

     d                 pr

     d     old_value                 20i 0

     d     new_value                 20i 0

     d     wait_tmpl                       likeds(wait_tmpl_t)


     /* Release a mutually exclusive lock recursively. */

     d recursive_unlock...

     d                 pr

     d     old_value                 20i 0

     d     new_value                 20i 0

     d     wait_tmpl                       likeds(wait_tmpl_t)


     /* ... ... */


     /* Implementation of procedure recursive_lock. */

     p recursive_lock  b


     d                 pi

     d     old_value                 20i 0

     d     new_value                 20i 0

     d     wait_tmpl                       likeds(wait_tmpl_t)



           // Acquire lock.

           dow chklkval(lock : old_value : new_value) = 1;




           // Increase old_value and new_value by 1.

           old_value += 1;

           new_value += 1;


     p recursive_lock  e


     /* Implementation of procedure recursive_unlock. */

     p recursive_unlock...

     p                 b


     d                 pi

     d     old_value                 20i 0

     d     new_value                 20i 0

     d     wait_tmpl                       likeds(wait_tmpl_t)



           // Decrease old_value and new_value by 1.

           old_value -= 1;

           new_value -= 1;


           // Release lock.

           clrlkval(lock : old_value);


     p recursive_unlock...

     p                 e


In the above reentrant mutex implementation, by incrementing the old_val and new_val operands of CHKLKVAL by 1 at each recursion, the owner of lock can successfully lock it twice, three times, four times, n times, and unlock it n times with CLRLKVAL. Data structure wait_tmpl_t is declared in mih52.rpgleinc as the instruction template of MI instruction WAITTIME. The complete example code is available at t106.rpgle.

Implementing Mutex

This article explains the most efficient way to implement the mutex primitive in i5/OS via the CHKLKVAL and CLRLKVAL instructions. As specifically designed MI instructions for implementing low-level locking protocols, CHKLKVAL and CLRLKVAL bring us extra gains in efficiency in thread synchronization, whereas extra design efforts have to be made when more complicated synchronization logic, such as recursive locks, are needed. So is there a compromise between performance and simplicity of design? If you'd like to find out, please let me know.

as/400, os/400, iseries, system i, i5/os, ibm i, power systems, 6.1, 7.1, V7, RPG


Junlei Li

Junlei Li is a programmer from Tianjin, China, with 10 years of experience in software design and programming. Junlei Li began programming under i5/OS (formerly known as AS/400, iSeries) in late 2005. He is familiar with most programming languages available on i5/OS—from special-purpose languages such as OPM/ILE RPG to CL to general-purpose languages such as C, C++, Java; from strong-typed languages to script languages such as QShell and REXX. One of his favorite programming languages on i5/OS is machine interface (MI) instructions, through which one can discover some of the internal behaviors of i5/OS and some of the highlights of i5/OS in terms of operating system design.


Junlei Li's Web site is http://i5toolkit.sourceforge.net/, where his open-source project i5/OS Programmer's Toolkit (https://sourceforge.net/projects/i5toolkit/) is documented.



Support MC Press Online


Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: