04/07/13

POSIX Threads Programming

Tutorials | Exercises | Abstracts | LC Workshops | Comments | Search | Privacy & Legal Notice

POSIX Threads Programming

Author: Blaise Barney, Lawrence Livermore National Laboratory
UCRL-MI-133316

Table of Contents
1. Abstract 2. Pthreads Overview 1. What is a Thread? 2. What are Pthreads? 3. Why Pthreads? 4. Designing Threaded Programs 3. The Pthreads API 4. Compiling Threaded Programs 5. Thread Management 1. Creating and Terminating Threads 2. Passing Arguments to Threads 3. Joining and Detaching Threads 4. Stack Management 5. Miscellaneous Routines 6. Exercise 1 7. Mutex Variables 1. Mutex Variables Overview 2. Creating and Destroying Mutexes 3. Locking and Unlocking Mutexes 8. Condition Variables 1. Condition Variables Overview 2. Creating and Destroying Condition Variables 3. Waiting and Signaling on Condition Variables 9. Monitoring, Debugging and Performance Analysis Tools for Pthreads 10. LLNL Specific Information and Recommendations 11. Topics Not Covered 12. Exercise 2 13. References and More Information 14. Appendix A: Pthread Library Routines Reference

Abstract
In shared memory multiprocessor architectures, such as SMPs, threads can be used to implement parallelism. Historically, hardware vendors have implemented their own proprietary versions of threads, making portability a concern for software developers. For UNIX systems, a standardized C language threads programming interface has been specified by the IEEE POSIX 1003.1c standard. Implementations that adhere to this standard are referred to as POSIX threads, or Pthreads. The tutorial begins with an introduction to concepts, motivations, and design considerations for using Pthreads. Each of the three major classes of routines in the Pthreads API are then covered: Thread Management, Mutex Variables, and Condition Variables. Example codes are used throughout to demonstrate how to use most of the Pthreads routines needed by a new Pthreads programmer. The tutorial concludes with a discussion of LLNL specifics and how to mix MPI with pthreads. A lab exercise, with numerous example codes (C Language) is also included. Level/Prerequisites: This tutorial is one of the eight tutorials in the 4+ day "Using LLNL's Supercomputers" workshop. It is deal for those who are new to parallel programming with threads. A basic understanding of parallel programming in C is required. For those who are unfamiliar with Parallel Programming in general, the material covered in EC3500: Introduction To Parallel Computing would be helpful.

Pthreads Overview What is a Thread?

Technically, a thread is defined as an independent stream of instructions that can be scheduled to run as such by the operating system. But what does this mean? To the software developer, the concept of a "procedure" that runs independently from its main program may best describe a thread.
https://computing.llnl.gov/tutorials/pthreads/#Routines 1/27

04/07/13

POSIX Threads Programming

To go one step further, imagine a main program (a.out) that contains a number of procedures. Then imagine all of these procedures being able to be scheduled to run simultaneously and/or independently by the operating system. That would describe a "multi-threaded" program. How is this accomplished? Before understanding a thread, one first needs to understand a UNIX process. A process is created by the operating system, and requires a fair amount of "overhead". Processes contain information about program resources and program execution state, including: Process ID, process group ID, user ID, and group ID Environment Working directory. Program instructions Registers Stack Heap File descriptors Signal actions Shared libraries Inter-process communication tools (such as message queues, pipes, semaphores, or shared memory).

UNIX PROCESS

THREADS WITHIN A UNIX PROCESS

Threads use and exist within these process resources, yet are able to be scheduled by the operating system and run as independent entities largely because they duplicate only the bare essential resources that enable them to exist as executable code. This independent flow of control is accomplished because a thread maintains its own: Stack pointer Registers Scheduling properties (such as policy or priority) Set of pending and blocked signals Thread specific data. So, in summary, in the UNIX environment a thread: Exists within a process and uses the process resources Has its own independent flow of control as long as its parent process exists and the OS supports it Duplicates only the essential resources it needs to be independently schedulable May share the process resources with other threads that act equally independently (and dependently) Dies if the parent process dies - or something similar Is "lightweight" because most of the overhead has already been accomplished through the creation of its process. Because threads within the same process share resources: Changes made by one thread to shared system resources (such as closing a file) will be seen by all other threads. Two pointers having the same value point to the same data. Reading and writing to the same memory locations is possible, and therefore requires explicit synchronization by the programmer.

Pthreads Overview What are Pthreads?

Historically, hardware vendors have implemented their own proprietary versions of threads. These implementations differed substantially from each other making it difficult for programmers to develop portable threaded applications.
https://computing.llnl.gov/tutorials/pthreads/#Routines 2/27

04/07/13

POSIX Threads Programming

In order to take full advantage of the capabilities provided by threads, a standardized programming interface was required. For UNIX systems, this interface has been specified by the IEEE POSIX 1003.1c standard (1995). Implementations adhering to this standard are referred to as POSIX threads, or Pthreads. Most hardware vendors now offer Pthreads in addition to their proprietary API's. The POSIX standard has continued to evolve and undergo revisions, including the Pthreads specification. Some useful links: standards.ieee.org/findstds/standard/1003.1-2008.html www.opengroup.org/austin/papers/posix_faq.html www.unix.org/version3/ieee_std.html Pthreads are defined as a set of C language programming types and procedure calls, implemented with a p t h r e a d . hheader/include file and a thread library - though this library may be part of another library, such as l i b c , in some implementations.

Pthreads Overview Why Pthreads?

In the world of high performance computing, the primary motivation for using Pthreads is to realize potential program performance gains. When compared to the cost of creating and managing a process, a thread can be created with much less operating system overhead. Managing threads requires fewer system resources than managing processes. For example, the following table compares timing results for the f o r k ( )subroutine and the p t h r e a d _ c r e a t e ( )subroutine. Timings reflect 50,000 process/thread creations, were performed with the t i m eutility, and units are in seconds, no optimization flags. Note: don't expect the sytem and user times to add up to real time, because these are SMP systems with multiple CPUs working on the problem at the same time. At best, these are approximations run on local machines, past and present. Platform Intel 2.6 GHz Xeon E5-2670 (16 cores/node) Intel 2.8 GHz Xeon 5660 (12 cores/node) AMD 2.3 GHz Opteron (16 cores/node) AMD 2.4 GHz Opteron (8 cores/node) IBM 4.0 GHz POWER6 (8 cpus/node) IBM 1.9 GHz POWER5 p5-575 (8 cpus/node) IBM 1.5 GHz POWER4 (8 cpus/node) INTEL 2.4 GHz Xeon (2 cpus/node) INTEL 1.4 GHz Itanium2 (4 cpus/node) fork_vs_thread.txt All threads within a process share the same address space. Inter-thread communication is more efficient and in many cases, easier to use than inter-process communication. Threaded applications offer potential performance gains and practical advantages over non-threaded applications in several other ways: Overlapping CPU work with I/O: For example, a program may have sections where it is performing a long I/O operation. While one thread is waiting for an I/O system call to complete, CPU intensive work can be performed by other threads. Priority/real-time scheduling: tasks which are more important can be scheduled to supersede or interrupt lower priority tasks. Asynchronous event handling: tasks which service events of indeterminate frequency and duration can be interleaved. For example, a web server can both transfer data from previous requests and manage the arrival of new requests. The primary motivation for considering the use of Pthreads on an SMP architecture is to achieve optimum performance. In particular, if an application is using MPI for on-node communications, there is a potential that performance could be greatly improved by using Pthreads for on-node data transfer instead. For example: MPI libraries usually implement on-node task communication via shared memory, which involves at least one memory copy operation (process to process). For Pthreads there is no intermediate memory copy required because threads share the same address space within a single process. There is no data transfer, per se. It becomes more of a cache-to-CPU or memory-to-CPU bandwidth (worst case) situation. These speeds are much higher. Some local comparisons are shown below:
f o r k ( ) p t h r e a d _ c r e a t e ( )

real 8.1 4.4 12.5 17.6 9.5 64.2 104.5 54.9 54.5

user 0.1 0.4 1.0 2.2 0.6 30.7 48.6 1.5 1.1

sys 2.9 4.3 12.5 15.7 8.8 27.6 47.2 20.8 22.2

real 0.9 0.7 1.2 1.4 1.6 1.7 2.1 1.6 2.0

user 0.2 0.2 0.2 0.3 0.1 0.6 1.0 0.7 1.2

sys 0.3 0.5 1.3 1.3 0.4 1.1 1.5 0.9 0.6

https://computing.llnl.gov/tutorials/pthreads/#Routines

3/27

04/07/13

POSIX Threads Programming

Platform

MPI Shared Memory Bandwidth Pthreads Worst Case (GB/sec) Memory-to-CPU Bandwidth (GB/sec) 4.5 5.6 1.8 1.2 4.1 2.1 0.3 1.8 51.2 32 5.3 5.3 16 4 4.3 6.4

Intel 2.6 GHz Xeon E5-2670 Intel 2.8 GHz Xeon 5660 AMD 2.3 GHz Opteron AMD 2.4 GHz Opteron IBM 1.9 GHz POWER5 p5-575 IBM 1.5 GHz POWER4 Intel 2.4 GHz Xeon Intel 1.4 GHz Itanium 2

Pthreads can also be used for serial applications, to emulate parallel execution and/or take advantage of spare cycles. A perfect example is the typical web browser, which for most people, runs on a single cpu desktop/laptop machine. Many things can "appear" to be happening at the same time. Many other common serial applications and operating systems use threads. An example of the MS Windows OS and applications using threads is shown below.

Click on image for a larger version

Pthreads Overview Designing Threaded Programs

Parallel Programming: On modern, multi-cpu machines, pthreads are ideally suited for parallel programming, and whatever applies to parallel programming in general, applies to parallel pthreads programs. There are many considerations for designing parallel programs, such as:
https://computing.llnl.gov/tutorials/pthreads/#Routines 4/27

04/07/13

POSIX Threads Programming

What type of parallel programming model to use? Problem partitioning Load balancing Communications Data dependencies Synchronization and race conditions Memory issues I/O issues Program complexity Programmer effort/costs/time ... Covering these topics is beyond the scope of this tutorial, however interested readers can obtain a quick overview in the Introduction to Parallel Computing tutorial. In general though, in order for a program to take advantage of Pthreads, it must be able to be organized into discrete, independent tasks which can execute concurrently. For example, if routine1 and routine2 can be interchanged, interleaved and/or overlapped in real time, they are candidates for threading.

Programs having the following characteristics may be well suited for pthreads: Work that can be executed, or data that can be operated on, by multiple tasks simultaneously: Block for potentially long I/O waits Use many CPU cycles in some places but not others Must respond to asynchronous events Some work is more important than other work (priority interrupts) Several common models for threaded programs exist: Manager/worker: a single thread, the manager assigns work to other threads, the workers. Typically, the manager handles all input and parcels out work to the other tasks. At least two forms of the manager/worker model are common: static worker pool and dynamic worker pool. Pipeline: a task is broken into a series of suboperations, each of which is handled in series, but concurrently, by a different thread. An automobile assembly line best describes this model. Peer: similar to the manager/worker model, but after the main thread creates other threads, it participates in the work. Shared Memory Model: All threads have access to the same global, shared memory Threads also have their own private data Programmers are responsible for synchronizing access (protecting) globally shared data.

https://computing.llnl.gov/tutorials/pthreads/#Routines

5/27

04/07/13

POSIX Threads Programming

Thread-safeness: Thread-safeness: in a nutshell, refers an application's ability to execute multiple threads simultaneously without "clobbering" shared data or creating "race" conditions. For example, suppose that your application creates several threads, each of which makes a call to the same library routine: This library routine accesses/modifies a global structure or location in memory. As each thread calls this routine it is possible that they may try to modify this global structure/memory location at the same time. If the routine does not employ some sort of synchronization constructs to prevent data corruption, then it is not thread-safe.

The implication to users of external library routines is that if you aren't 100% certain the routine is thread-safe, then you take your chances with problems that could arise. Recommendation: Be careful if your application uses libraries or other objects that don't explicitly guarantee thread-safeness. When in doubt, assume that they are not thread-safe until proven otherwise. This can be done by "serializing" the calls to the uncertain routine, etc. Thread Limits: Although the Pthreads API is an ANSI/IEEE standard, implementations can, and usually do, vary in ways not specified by the standard. Because of this, a program that runs fine on one platform, may fail or produce wrong results on another platform. For example, the maximum number of threads permitted, and the default thread stack size are two important limits to consider when designing your program. Several thread limits are discussed in more detail later in this tutorial.

The Pthreads API

https://computing.llnl.gov/tutorials/pthreads/#Routines 6/27

04/07/13

POSIX Threads Programming

The original Pthreads API was defined in the ANSI/IEEE POSIX 1003.1 - 1995 standard. The POSIX standard has continued to evolve and undergo revisions, including the Pthreads specification. Copies of the standard can be purchased from IEEE or downloaded for free from other sites online. The subroutines which comprise the Pthreads API can be informally grouped into four major groups: 1. Thread management: Routines that work directly on threads - creating, detaching, joining, etc. They also include functions to set/query thread attributes (joinable, scheduling etc.) 2. Mutexes: Routines that deal with synchronization, called a "mutex", which is an abbreviation for "mutual exclusion". Mutex functions provide for creating, destroying, locking and unlocking mutexes. These are supplemented by mutex attribute functions that set or modify attributes associated with mutexes. 3. Condition variables: Routines that address communications between threads that share a mutex. Based upon programmer specified conditions. This group includes functions to create, destroy, wait and signal based upon specified variable values. Functions to set/query condition variable attributes are also included. 4. Synchronization: Routines that manage read/write locks and barriers. Naming conventions: All identifiers in the threads library begin with pthread_. Some examples are shown below. Routine Prefix pthread_ pthread_attr_ pthread_mutex_ pthread_mutexattr_ pthread_cond_ pthread_condattr_ pthread_key_ pthread_rwlock_ pthread_barrier_ Functional Group Threads themselves and miscellaneous subroutines Thread attributes objects Mutexes Mutex attributes objects. Condition variables Condition attributes objects Thread-specific data keys Read/write locks Synchronization barriers

The concept of opaque objects pervades the design of the API. The basic calls work to create or modify opaque objects - the opaque objects can be modified by calls to attribute functions, which deal with opaque attributes. The Pthreads API contains around 100 subroutines. This tutorial will focus on a subset of these - specifically, those which are most likely to be immediately useful to the beginning Pthreads programmer. For portability, the p t h r e a d . hheader file should be included in each source file using the Pthreads library. The current POSIX standard is defined only for the C language. Fortran programmers can use wrappers around C function calls. Some Fortran compilers (like IBM AIX Fortran) may provide a Fortram pthreads API. A number of excellent books about Pthreads are available. Several of these are listed in the References section of this tutorial.

Compiling Threaded Programs

Several examples of compile commands used for pthreads codes are listed in the table below. Compiler / Platform INTEL Linux PGI Linux GNU Linux, Blue Gene IBM Blue Gene
https://computing.llnl.gov/tutorials/pthreads/#Routines

Compiler Command
i c cp t h r e a d i c p cp t h r e a d p g c cl p t h r e a d p g C Cl p t h r e a d g c cp t h r e a d g + +p t h r e a d b g x l c _ r / b g c c _ r b g x l C _ r ,b g x l c + + _ r

Description C C++ C C++ GNU C GNU C++ C (ANSI / non-ANSI) C++

7/27

04/07/13

POSIX Threads Programming

Thread Management Creating and Terminating Threads

Routines:
p t h r e a d _ c r e a t e( t h r e a d , a t t r , s t a r t _ r o u t i n e , a r g ) p t h r e a d _ e x i t( s t a t u s ) p t h r e a d _ c a n c e l( t h r e a d ) p t h r e a d _ a t t r _ i n i t( a t t r ) p t h r e a d _ a t t r _ d e s t r o y( a t t r )

Creating Threads: Initially, your m a i n ( )program comprises a single, default thread. All other threads must be explicitly created by the programmer.
p t h r e a d _ c r e a t ecreates a new thread p t h r e a d _ c r e a t earguments: t h r e a d : An opaque, a t t r : An opaque attribute object that may be used

and makes it executable. This routine can be called any number of times from anywhere within your code.

unique identifier for the new thread returned by the subroutine. to set thread attributes. You can specify a thread attributes object, or NULL for the default

values.
s t a r t _ r o u t i n e : the C

routine that the thread will execute once it is created. to start_routine. It must be passed by reference as a pointer cast of type void. NULL may be used if no argument is to be passed.
a r g : A single argument that may be passed

The maximum number of threads that may be created by a process is implementation dependent. Programs that attempt to exceed the limit can fail or produce wrong results. Querying and setting your implementation's thread limit - Linux example shown. Demonstrates querying the default (soft) limits and then setting the maximum number of processes (including threads) to the hard limit. Then verifying that the limit has been overridden. bash / ksh / sh
$u l i m i ta c o r ef i l es i z e ( b l o c k s ,c )1 6 d a t as e gs i z e ( k b y t e s ,d )u n l i m i t e d s c h e d u l i n gp r i o r i t y ( e )0 f i l es i z e ( b l o c k s ,f )u n l i m i t e d p e n d i n gs i g n a l s ( i )2 5 5 9 5 6 m a xl o c k e dm e m o r y ( k b y t e s ,l )6 4 m a xm e m o r ys i z e ( k b y t e s ,m )u n l i m i t e d o p e nf i l e s ( n )1 0 2 4 p i p es i z e ( 5 1 2b y t e s ,p )8 P O S I Xm e s s a g eq u e u e s ( b y t e s ,q )8 1 9 2 0 0 r e a l t i m ep r i o r i t y ( r )0 s t a c ks i z e ( k b y t e s ,s )u n l i m i t e d c p ut i m e ( s e c o n d s ,t )u n l i m i t e d m a xu s e rp r o c e s s e s ( u )1 0 2 4 v i r t u a lm e m o r y ( k b y t e s ,v )u n l i m i t e d f i l el o c k s ( x )u n l i m i t e d $u l i m i tH u 7 1 6 8 $u l i m i tu7 1 6 8 $u l i m i ta c o r ef i l es i z e ( b l o c k s ,c )1 6 d a t as e gs i z e ( k b y t e s ,d )u n l i m i t e d s c h e d u l i n gp r i o r i t y ( e )0 f i l es i z e ( b l o c k s ,f )u n l i m i t e d p e n d i n gs i g n a l s ( i )2 5 5 9 5 6 m a xl o c k e dm e m o r y ( k b y t e s ,l )6 4 m a xm e m o r ys i z e ( k b y t e s ,m )u n l i m i t e d o p e nf i l e s ( n )1 0 2 4 p i p es i z e ( 5 1 2b y t e s ,p )8 P O S I Xm e s s a g eq u e u e s ( b y t e s ,q )8 1 9 2 0 0 r e a l t i m ep r i o r i t y ( r )0 s t a c ks i z e ( k b y t e s ,s )u n l i m i t e d c p ut i m e ( s e c o n d s ,t )u n l i m i t e d m a xu s e rp r o c e s s e s ( u )7 1 6 8 v i r t u a lm e m o r y ( k b y t e s ,v )u n l i m i t e d f i l el o c k s ( x )u n l i m i t e d

tcsh / csh
%l i m i t c p u t i m e u n l i m i t e d f i l e s i z e u n l i m i t e d d a t a s i z e u n l i m i t e d s t a c k s i z e u n l i m i t e d c o r e d u m p s i z e1 6k b y t e s m e m o r y u s e u n l i m i t e d v m e m o r y u s e u n l i m i t e d d e s c r i p t o r s 1 0 2 4 m e m o r y l o c k e d6 4k b y t e s m a x p r o c 1 0 2 4 %l i m i tm a x p r o cu n l i m i t e d %l i m i t c p u t i m e u n l i m i t e d f i l e s i z e u n l i m i t e d d a t a s i z e u n l i m i t e d s t a c k s i z e u n l i m i t e d c o r e d u m p s i z e1 6k b y t e s m e m o r y u s e u n l i m i t e d v m e m o r y u s e u n l i m i t e d d e s c r i p t o r s 1 0 2 4 m e m o r y l o c k e d6 4k b y t e s m a x p r o c 7 1 6 8

Once created, threads are peers, and may create other threads. There is no implied hierarchy or dependency between threads.
https://computing.llnl.gov/tutorials/pthreads/#Routines 8/27

04/07/13

POSIX Threads Programming

Thread Attributes: By default, a thread is created with certain attributes. Some of these attributes can be changed by the programmer via the thread attribute object.
p t h r e a d _ a t t r _ i n i tand p t h r e a d _ a t t r _ d e s t r o yare used

to initialize/destroy the thread attribute object.

Other routines are then used to query/set specific attributes in the thread attribute object. Attributes include: Detached or joinable state Scheduling inheritance Scheduling policy Scheduling parameters Scheduling contention scope Stack size Stack address Stack guard (overflow) size Some of these attributes will be discussed later. Thread Binding and Scheduling: Question: After a thread has been created, how do you know a)when it will be scheduled to run by the operating system, and b)which processor/core it will run on?
Answer

The Pthreads API provides several routines that may be used to specify how threads are scheduled for execution. For example, threads can be scheduled to run FIFO (first-in first-out), RR (round-robin) or OTHER (operating system determines). It also provides the ability to set a thread's scheduling priority value. These topics are not covered here, however a good overview of "how things work" under Linux can be found in the s c h e d _ s e t s c h e d u l e rman page. The Pthreads API does not provide routines for binding threads to specific cpus/cores. However, local implementations may include this functionality - such as providing the non-standard p t h r e a d _ s e t a f f i n i t y _ n proutine. Note that "_np" in the name stands for "non-portable". Also, the local operating system may provide a way to do this. For example, Linux provides the s c h e d _ s e t a f f i n i t yroutine. Terminating Threads & p t h r e a d _ e x i t ( ) : There are several ways in which a thread may be terminated: The thread returns normally from its starting routine. It's work is done. The thread makes a call to the p t h r e a d _ e x i tsubroutine - whether its work is done or not. The thread is canceled by another thread via the p t h r e a d _ c a n c e lroutine. The entire process is terminated due to making a call to either the e x e c ( )or e x i t ( ) If main() finishes first, without calling p t h r e a d _ e x i texplicitly itself The p t h r e a d _ e x i t ( )routine allows the programmer to specify an optional termination status parameter. This optional parameter is typically returned to threads "joining" the terminated thread (covered later). In subroutines that execute to completion normally, you can often dispense with calling p t h r e a d _ e x i t ( )- unless, of course, you want to pass the optional status code back. Cleanup: the p t h r e a d _ e x i t ( )routine does not close files; any files opened inside the thread will remain open after the thread is terminated. Discussion on calling p t h r e a d _ e x i t ( )from main():
https://computing.llnl.gov/tutorials/pthreads/#Routines 9/27

04/07/13

POSIX Threads Programming

There is a definite problem if main() finishes before the threads it spawned if you don't call p t h r e a d _ e x i t ( )explicitly. All of the threads it created will terminate because main() is done and no longer exists to support the threads. By having main() explicitly call p t h r e a d _ e x i t ( )as the last thing it does, main() will block and be kept alive to support the threads it created until they are done.

Example: Pthread Creation and Termination

This simple example code creates 5 threads with the p t h r e a d _ c r e a t e ( )routine. Each thread prints a "Hello World!" message, and then terminates with a call to p t h r e a d _ e x i t ( ) . Example Code - Pthread Creation and Termination
# i n c l u d e< p t h r e a d . h > # i n c l u d e< s t d i o . h > # d e f i n eN U M _ T H R E A D S

v o i d* P r i n t H e l l o ( v o i d* t h r e a d i d ) { l o n gt i d ; t i d=( l o n g ) t h r e a d i d ; p r i n t f ( " H e l l oW o r l d !I t ' sm e ,t h r e a d# % l d ! \ n " ,t i d ) ; p t h r e a d _ e x i t ( N U L L ) ; } i n tm a i n( i n ta r g c ,c h a r* a r g v [ ] ) { p t h r e a d _ tt h r e a d s [ N U M _ T H R E A D S ] ; i n tr c ; l o n gt ; f o r ( t = 0 ;t < N U M _ T H R E A D S ;t + + ) { p r i n t f ( " I nm a i n :c r e a t i n gt h r e a d% l d \ n " ,t ) ; r c=p t h r e a d _ c r e a t e ( & t h r e a d s [ t ] ,N U L L ,P r i n t H e l l o ,( v o i d* ) t ) ; i f( r c ) { p r i n t f ( " E R R O R ;r e t u r nc o d ef r o mp t h r e a d _ c r e a t e ( )i s% d \ n " ,r c ) ; e x i t ( 1 ) ; } } / *L a s tt h i n gt h a tm a i n ( )s h o u l dd o* / p t h r e a d _ e x i t ( N U L L ) ; }

Thread Management Passing Arguments to Threads

The p t h r e a d _ c r e a t e ( )routine permits the programmer to pass one argument to the thread start routine. For cases where multiple arguments must be passed, this limitation is easily overcome by creating a structure which contains all of the arguments, and then passing a pointer to that structure in the p t h r e a d _ c r e a t e ( )routine. All arguments must be passed by reference and cast to (void *). Question: How can you safely pass data to newly created threads, given their non-deterministic start-up and scheduling?
Answer

Example 1 - Thread Argument Passing This code fragment demonstrates how to pass a simple integer to each thread. The calling thread uses a unique data structure for each thread, insuring that each thread's argument remains intact throughout the program.
l o n g* t a s k i d s [ N U M _ T H R E A D S ] ; f o r ( t = 0 ;t < N U M _ T H R E A D S ;t + + ) { t a s k i d s [ t ]=( l o n g* )m a l l o c ( s i z e o f ( l o n g ) ) ; * t a s k i d s [ t ]=t ; p r i n t f ( " C r e a t i n gt h r e a d% l d \ n " ,t ) ; r c=p t h r e a d _ c r e a t e ( & t h r e a d s [ t ] ,N U L L ,P r i n t H e l l o ,( v o i d* )t a s k i d s [ t ] ) ; . . . }

Example 2 - Thread Argument Passing

https://computing.llnl.gov/tutorials/pthreads/#Routines 10/27

04/07/13

POSIX Threads Programming

This example shows how to setup/pass multiple arguments via a structure. Each thread receives a unique instance of the structure.
s t r u c tt h r e a d _ d a t a { i n t t h r e a d _ i d ; i n t s u m ; c h a r* m e s s a g e ; } ; s t r u c tt h r e a d _ d a t at h r e a d _ d a t a _ a r r a y [ N U M _ T H R E A D S ] ; v o i d* P r i n t H e l l o ( v o i d* t h r e a d a r g ) { s t r u c tt h r e a d _ d a t a* m y _ d a t a ; . . . m y _ d a t a=( s t r u c tt h r e a d _ d a t a* )t h r e a d a r g ; t a s k i d=m y _ d a t a > t h r e a d _ i d ; s u m=m y _ d a t a > s u m ; h e l l o _ m s g=m y _ d a t a > m e s s a g e ; . . . } i n tm a i n( i n ta r g c ,c h a r* a r g v [ ] ) { . . . t h r e a d _ d a t a _ a r r a y [ t ] . t h r e a d _ i d=t ; t h r e a d _ d a t a _ a r r a y [ t ] . s u m=s u m ; t h r e a d _ d a t a _ a r r a y [ t ] . m e s s a g e=m e s s a g e s [ t ] ; r c=p t h r e a d _ c r e a t e ( & t h r e a d s [ t ] ,N U L L ,P r i n t H e l l o , ( v o i d* )& t h r e a d _ d a t a _ a r r a y [ t ] ) ; . . . }

Example 3 - Thread Argument Passing (Incorrect) This example performs argument passing incorrectly. It passes the address of variable t , which is shared memory space and visible to all threads. As the loop iterates, the value of this memory location changes, possibly before the created threads can access it.
i n tr c ; l o n gt ; f o r ( t = 0 ;t < N U M _ T H R E A D S ;t + + ) { p r i n t f ( " C r e a t i n gt h r e a d% l d \ n " ,t ) ; r c=p t h r e a d _ c r e a t e ( & t h r e a d s [ t ] ,N U L L ,P r i n t H e l l o ,( v o i d* )& t ) ; . . . }

Thread Management Joining and Detaching Threads

Routines:
p t h r e a d _ j o i n( t h r e a d i d , s t a t u s ) p t h r e a d _ d e t a c h( t h r e a d i d ) p t h r e a d _ a t t r _ s e t d e t a c h s t a t e( a t t r , d e t a c h s t a t e ) p t h r e a d _ a t t r _ g e t d e t a c h s t a t e( a t t r , d e t a c h s t a t e )

Joining: "Joining" is one way to accomplish synchronization between threads. For example:

https://computing.llnl.gov/tutorials/pthreads/#Routines

11/27

04/07/13

POSIX Threads Programming

The p t h r e a d _ j o i n ( )subroutine blocks the calling thread until the specified t h r e a d i dthread terminates. The programmer is able to obtain the target thread's termination return s t a t u sif it was specified in the target thread's call to p t h r e a d _ e x i t ( ) . A joining thread can match one p t h r e a d _ j o i n ( )call. It is a logical error to attempt multiple joins on the same thread. Two other synchronization methods, mutexes and condition variables, will be discussed later. Joinable or Not? When a thread is created, one of its attributes defines whether it is joinable or detached. Only threads that are created as joinable can be joined. If a thread is created as detached, it can never be joined. The final draft of the POSIX standard specifies that threads should be created as joinable. To explicitly create a thread as joinable or detached, the a t t rargument in the p t h r e a d _ c r e a t e ( )routine is used. The typical 4 step process is: 1. Declare a pthread attribute variable of the p t h r e a d _ a t t r _ tdata type 2. Initialize the attribute variable with p t h r e a d _ a t t r _ i n i t ( ) 3. Set the attribute detached status with p t h r e a d _ a t t r _ s e t d e t a c h s t a t e ( ) 4. When done, free library resources used by the attribute with p t h r e a d _ a t t r _ d e s t r o y ( ) Detaching: The p t h r e a d _ d e t a c h ( )routine can be used to explicitly detach a thread even though it was created as joinable. There is no converse routine. Recommendations: If a thread requires joining, consider explicitly creating it as joinable. This provides portability as not all implementations may create threads as joinable by default. If you know in advance that a thread will never need to join with another thread, consider creating it in a detached state. Some system resources may be able to be freed.

Example: Pthread Joining

Example Code - Pthread Joining This example demonstrates how to "wait" for thread completions by using the Pthread join routine. Since some implementations of Pthreads may not create threads in a joinable state, the threads in this example are explicitly created in a joinable state so that they can be joined later.
# i n c l u d e< p t h r e a d . h > # i n c l u d e< s t d i o . h > # i n c l u d e< s t d l i b . h > # i n c l u d e< m a t h . h > # d e f i n eN U M _ T H R E A D S

v o i d* B u s y W o r k ( v o i d* t ) { i n ti ; l o n gt i d ; d o u b l er e s u l t = 0 . 0 ; t i d=( l o n g ) t ; p r i n t f ( " T h r e a d% l ds t a r t i n g . . . \ n " , t i d ) ; f o r( i = 0 ;i < 1 0 0 0 0 0 0 ;i + + ) { r e s u l t=r e s u l t+s i n ( i )*t a n ( i ) ; } p r i n t f ( " T h r e a d% l dd o n e .R e s u l t=% e \ n " , t i d ,r e s u l t ) ; p t h r e a d _ e x i t ( ( v o i d * )t ) ; } i n tm a i n( i n ta r g c ,c h a r* a r g v [ ] )

https://computing.llnl.gov/tutorials/pthreads/#Routines

12/27

04/07/13
{ p t h r e a d _ tt h r e a d [ N U M _ T H R E A D S ] ; p t h r e a d _ a t t r _ ta t t r ; i n tr c ; l o n gt ; v o i d* s t a t u s ;

POSIX Threads Programming

/ *I n i t i a l i z ea n ds e tt h r e a dd e t a c h e da t t r i b u t e* / p t h r e a d _ a t t r _ i n i t ( & a t t r ) ; p t h r e a d _ a t t r _ s e t d e t a c h s t a t e ( & a t t r ,P T H R E A D _ C R E A T E _ J O I N A B L E ) ; f o r ( t = 0 ;t < N U M _ T H R E A D S ;t + + ){ p r i n t f ( " M a i n :c r e a t i n gt h r e a d% l d \ n " ,t ) ; r c=p t h r e a d _ c r e a t e ( & t h r e a d [ t ] ,& a t t r ,B u s y W o r k ,( v o i d* ) t ) ; i f( r c ){ p r i n t f ( " E R R O R ;r e t u r nc o d ef r o mp t h r e a d _ c r e a t e ( ) i s% d \ n " ,r c ) ; e x i t ( 1 ) ; } } / *F r e ea t t r i b u t ea n dw a i tf o rt h eo t h e rt h r e a d s* / p t h r e a d _ a t t r _ d e s t r o y ( & a t t r ) ; f o r ( t = 0 ;t < N U M _ T H R E A D S ;t + + ){ r c=p t h r e a d _ j o i n ( t h r e a d [ t ] ,& s t a t u s ) ; i f( r c ){ p r i n t f ( " E R R O R ;r e t u r nc o d ef r o mp t h r e a d _ j o i n ( ) i s% d \ n " ,r c ) ; e x i t ( 1 ) ; } p r i n t f ( " M a i n :c o m p l e t e dj o i nw i t ht h r e a d% l dh a v i n gas t a t u s o f% l d \ n " , t , ( l o n g ) s t a t u s ) ; } p r i n t f ( " M a i n :p r o g r a mc o m p l e t e d .E x i t i n g . \ n " ) ; p t h r e a d _ e x i t ( N U L L ) ; }

Thread Management Stack Management

Routines:
p t h r e a d _ a t t r _ g e t s t a c k s i z e( a t t r ,s t a c k s i z e ) p t h r e a d _ a t t r _ s e t s t a c k s i z e( a t t r ,s t a c k s i z e ) p t h r e a d _ a t t r _ g e t s t a c k a d d r( a t t r ,s t a c k a d d r ) p t h r e a d _ a t t r _ s e t s t a c k a d d r( a t t r ,s t a c k a d d r )

Preventing Stack Problems: The POSIX standard does not dictate the size of a thread's stack. This is implementation dependent and varies. Exceeding the default stack limit is often very easy to do, with the usual results: program termination and/or corrupted data. Safe and portable programs do not depend upon the default stack limit, but instead, explicitly allocate enough stack for each thread by using the p t h r e a d _ a t t r _ s e t s t a c k s i z eroutine. The p t h r e a d _ a t t r _ g e t s t a c k a d d rand p t h r e a d _ a t t r _ s e t s t a c k a d d rroutines can be used by applications in an environment where the stack for a thread must be placed in some particular region of memory. Some Practical Examples at LC: Default thread stack size varies greatly. The maximum size that can be obtained also varies greatly, and may depend upon the number of threads per node. Both past and present architectures are shown to demonstrate the wide variation in default thread stack size. Node Architecture Intel Xeon E5-2670 Intel Xeon 5660 AMD Opteron Intel IA64 #CPUs Memory (GB) Default Size (bytes) 16 12 8 4 32 24 16 8 2,097,152 2,097,152 2,097,152 33,554,432
13/27

https://computing.llnl.gov/tutorials/pthreads/#Routines

04/07/13

POSIX Threads Programming

Intel IA32 IBM Power5 IBM Power4 IBM Power3

2 8 8 16

4 32 16 16

2,097,152 196,608 196,608 98,304

Example: Stack Management

Example Code - Stack Management This example demonstrates how to query and set a thread's stack size.
# i n c l u d e< p t h r e a d . h > # i n c l u d e< s t d i o . h > # d e f i n eN T H R E A D S4 # d e f i n eN1 0 0 0 # d e f i n eM E G E X T R A1 0 0 0 0 0 0 p t h r e a d _ a t t r _ ta t t r ; v o i d* d o w o r k ( v o i d* t h r e a d i d ) { d o u b l eA [ N ] [ N ] ; i n ti , j ; l o n gt i d ; s i z e _ tm y s t a c k s i z e ; t i d=( l o n g ) t h r e a d i d ; p t h r e a d _ a t t r _ g e t s t a c k s i z e( & a t t r ,& m y s t a c k s i z e ) ; p r i n t f ( " T h r e a d% l d :s t a c ks i z e=% l ib y t e s\ n " ,t i d ,m y s t a c k s i z e ) ; f o r( i = 0 ;i < N ;i + + ) f o r( j = 0 ;j < N ;j + + ) A [ i ] [ j ]=( ( i * j ) / 3 . 4 5 2 )+( N i ) ; p t h r e a d _ e x i t ( N U L L ) ; } i n tm a i n ( i n ta r g c ,c h a r* a r g v [ ] ) { p t h r e a d _ tt h r e a d s [ N T H R E A D S ] ; s i z e _ ts t a c k s i z e ; i n tr c ; l o n gt ; p t h r e a d _ a t t r _ i n i t ( & a t t r ) ; p t h r e a d _ a t t r _ g e t s t a c k s i z e( & a t t r ,& s t a c k s i z e ) ; p r i n t f ( " D e f a u l ts t a c ks i z e=% l i \ n " ,s t a c k s i z e ) ; s t a c k s i z e=s i z e o f ( d o u b l e ) * N * N + M E G E X T R A ; p r i n t f ( " A m o u n to fs t a c kn e e d e dp e rt h r e a d=% l i \ n " , s t a c k s i z e ) ; p t h r e a d _ a t t r _ s e t s t a c k s i z e( & a t t r ,s t a c k s i z e ) ; p r i n t f ( " C r e a t i n gt h r e a d sw i t hs t a c ks i z e=% l ib y t e s \ n " , s t a c k s i z e ) ; f o r ( t = 0 ;t < N T H R E A D S ;t + + ) { r c=p t h r e a d _ c r e a t e ( & t h r e a d s [ t ] ,& a t t r ,d o w o r k ,( v o i d* ) t ) ; i f( r c ) { p r i n t f ( " E R R O R ;r e t u r nc o d ef r o mp t h r e a d _ c r e a t e ( )i s% d \ n " ,r c ) ; e x i t ( 1 ) ; } } p r i n t f ( " C r e a t e d% l dt h r e a d s . \ n " ,t ) ; p t h r e a d _ e x i t ( N U L L ) ; }

Thread Management Miscellaneous Routines

p t h r e a d _ s e l f( ) p t h r e a d _ e q u a l( t h r e a d 1 , t h r e a d 2 ) p t h r e a d _ s e l freturns the unique, p t h r e a d _ e q u a lcompares two

system assigned thread ID of the calling thread.

thread IDs. If the two IDs are different 0 is returned, otherwise a non-zero value is returned.

Note that for both of these routines, the thread identifier objects are opaque and can not be easily inspected. Because thread IDs are opaque objects, the C language equivalence operator = =should not be used to compare two thread IDs against each other, or to compare a single thread ID against another value.
p t h r e a d _ o n c e( o n c e _ c o n t r o l ,i n i t _ r o u t i n e )

https://computing.llnl.gov/tutorials/pthreads/#Routines

14/27

04/07/13
i n i t _ r o u t i n e , without parameters.

POSIX Threads Programming

p t h r e a d _ o n c eexecutes the i n i t _ r o u t i n eexactly once in a process.

The first call to this routine by any thread in the process executes the given Any subsequent call will have no effect.

The init_routine routine is typically an initialization routine. The o n c e _ c o n t r o lparameter is a synchronization control structure that requires initialization prior to calling p t h r e a d _ o n c e . For example:
p t h r e a d _ o n c e _ to n c e _ c o n t r o l=P T H R E A D _ O N C E _ I N I T ;

Pthread Exercise 1 Getting Started and Thread Management Routines

Overview: Login to an LC cluster using your workshop username and OTP token Copy the exercise files to your home directory Familiarize yourself with LC's Pthreads environment Write a simple "Hello World" Pthreads program Successfully compile your program Successfully run your program - several different ways Review, compile, run and/or debug some related Pthreads programs (provided) Go to the exercise now

Mutex Variables Overview

Mutex is an abbreviation for "mutual exclusion". Mutex variables are one of the primary means of implementing thread synchronization and for protecting shared data when multiple writes occur. A mutex variable acts like a "lock" protecting access to a shared data resource. The basic concept of a mutex as used in Pthreads is that only one thread can lock (or own) a mutex variable at any given time. Thus, even if several threads try to lock a mutex only one thread will be successful. No other thread can own that mutex until the owning thread unlocks that mutex. Threads must "take turns" accessing protected data. Mutexes can be used to prevent "race" conditions. An example of a race condition involving a bank transaction is shown below: Thread 1 Read balance: $1000 Read balance: $1000 Deposit $200 Deposit $200 Update balance $1000+$200 Update balance $1000+$200 In the above example, a mutex should be used to lock the "Balance" while a thread is using this shared data resource. Very often the action performed by a thread owning a mutex is the updating of global variables. This is a safe way to ensure that when several threads update the same variable, the final value is the same as what it would be if only one thread performed the update. The variables being updated belong to a "critical section". A typical sequence in the use of a mutex is as follows: Create and initialize a mutex variable Several threads attempt to lock the mutex Only one succeeds and that thread owns the mutex
https://computing.llnl.gov/tutorials/pthreads/#Routines 15/27

Thread 2

Balance $1000 $1000 $1000 $1000 $1200 $1200

04/07/13

POSIX Threads Programming

The owner thread performs some set of actions The owner unlocks the mutex Another thread acquires the mutex and repeats the process Finally the mutex is destroyed When several threads compete for a mutex, the losers block at that call - an unblocking call is available with "trylock" instead of the "lock" call. When protecting shared data, it is the programmer's responsibility to make sure every thread that needs to use a mutex does so. For example, if 4 threads are updating the same data, but only one uses a mutex, the data can still be corrupted.

Mutex Variables Creating and Destroying Mutexes

Routines:
p t h r e a d _ m u t e x _ i n i t( m u t e x , a t t r ) p t h r e a d _ m u t e x _ d e s t r o y( m u t e x ) p t h r e a d _ m u t e x a t t r _ i n i t( a t t r ) p t h r e a d _ m u t e x a t t r _ d e s t r o y( a t t r )

Usage: Mutex variables must be declared with type p t h r e a d _ m u t e x _ t , and must be initialized before they can be used. There are two ways to initialize a mutex variable: 1. Statically, when it is declared. For example:
p t h r e a d _ m u t e x _ tm y m u t e x=P T H R E A D _ M U T E X _ I N I T I A L I Z E R ;

2. Dynamically, with the p t h r e a d _ m u t e x _ i n i t ( )routine. This method permits setting mutex object attributes, attr. The mutex is initially unlocked. The attr object is used to establish properties for the mutex object, and must be of type p t h r e a d _ m u t e x a t t r _ tif used (may be specified as NULL to accept defaults). The Pthreads standard defines three optional mutex attributes: Protocol: Specifies the protocol used to prevent priority inversions for a mutex. Prioceiling: Specifies the priority ceiling of a mutex. Process-shared: Specifies the process sharing of a mutex. Note that not all implementations may provide the three optional mutex attributes. The p t h r e a d _ m u t e x a t t r _ i n i t ( )and p t h r e a d _ m u t e x a t t r _ d e s t r o y ( )routines are used to create and destroy mutex attribute objects respectively.
p t h r e a d _ m u t e x _ d e s t r o y ( )should

be used to free a mutex object which is no longer needed.

Mutex Variables Locking and Unlocking Mutexes

Routines:
p t h r e a d _ m u t e x _ l o c k( m u t e x ) p t h r e a d _ m u t e x _ t r y l o c k( m u t e x ) p t h r e a d _ m u t e x _ u n l o c k( m u t e x )

Usage: The p t h r e a d _ m u t e x _ l o c k ( )routine is used by a thread to acquire a lock on the specified mutex variable. If the mutex is already locked by another thread, this call will block the calling thread until the mutex is unlocked.
p t h r e a d _ m u t e x _ t r y l o c k ( )will attempt to

lock a mutex. However, if the mutex is already locked, the routine will return immediately with a "busy" error code. This routine may be useful in preventing deadlock conditions, as in a priority-inversion situation.
p t h r e a d _ m u t e x _ u n l o c k ( )will unlock

a mutex if called by the owning thread. Calling this routine is required after a thread has completed its use of protected data if other threads are to acquire the mutex for their work with the protected data. An error will be returned if: If the mutex was already unlocked If the mutex is owned by another thread
https://computing.llnl.gov/tutorials/pthreads/#Routines 16/27

04/07/13

POSIX Threads Programming

There is nothing "magical" about mutexes...in fact they are akin to a "gentlemen's agreement" between participating threads. It is up to the code writer to insure that the necessary threads all make the the mutex lock and unlock calls correctly. The following scenario demonstrates a logical error:
T h r e a d1 L o c k A=2 U n l o c k T h r e a d2 L o c k A=A + 1 U n l o c k T h r e a d3 A=A * B

Question: When more than one thread is waiting for a locked mutex, which thread will be granted the lock first after it is released?
Answer

Example: Using Mutexes

Example Code - Using Mutexes This example program illustrates the use of mutex variables in a threads program that performs a dot product. The main data is made available to all threads through a globally accessible structure. Each thread works on a different part of the data. The main thread waits for all the threads to complete their computations, and then it prints the resulting sum.
# i n c l u d e< p t h r e a d . h > # i n c l u d e< s t d i o . h > # i n c l u d e< s t d l i b . h > / * T h ef o l l o w i n gs t r u c t u r ec o n t a i n st h en e c e s s a r yi n f o r m a t i o n t oa l l o wt h ef u n c t i o n" d o t p r o d "t oa c c e s si t si n p u td a t aa n d p l a c ei t so u t p u ti n t ot h es t r u c t u r e . * / t y p e d e fs t r u c t { d o u b l e * a ; d o u b l e * b ; d o u b l e s u m ; i n t v e c l e n ; }D O T D A T A ; / *D e f i n eg l o b a l l ya c c e s s i b l ev a r i a b l e sa n dam u t e x* / # d e f i n eN U M T H R D S4 # d e f i n eV E C L E N1 0 0 D O T D A T Ad o t s t r ; p t h r e a d _ tc a l l T h d [ N U M T H R D S ] ; p t h r e a d _ m u t e x _ tm u t e x s u m ; / * T h ef u n c t i o nd o t p r o di sa c t i v a t e dw h e nt h et h r e a di sc r e a t e d . A l li n p u tt ot h i sr o u t i n ei so b t a i n e df r o mas t r u c t u r e o ft y p eD O T D A T Aa n da l lo u t p u tf r o mt h i sf u n c t i o ni sw r i t t e ni n t o t h i ss t r u c t u r e .T h eb e n e f i to ft h i sa p p r o a c hi sa p p a r e n tf o rt h e m u l t i t h r e a d e dp r o g r a m :w h e nat h r e a di sc r e a t e dw ep a s sas i n g l e a r g u m e n tt ot h ea c t i v a t e df u n c t i o n-t y p i c a l l yt h i sa r g u m e n t i sat h r e a dn u m b e r .A l l t h eo t h e ri n f o r m a t i o nr e q u i r e db yt h e f u n c t i o ni sa c c e s s e df r o mt h eg l o b a l l ya c c e s s i b l es t r u c t u r e . * / v o i d* d o t p r o d ( v o i d* a r g ) { / *D e f i n ea n du s el o c a lv a r i a b l e sf o rc o n v e n i e n c e* / i n ti ,s t a r t ,e n d ,l e n; l o n go f f s e t ; d o u b l em y s u m ,* x ,* y ; o f f s e t=( l o n g ) a r g ; l e n=d o t s t r . v e c l e n ; s t a r t=o f f s e t * l e n ; e n d =s t a r t+l e n ; x=d o t s t r . a ; y=d o t s t r . b ; / * P e r f o r mt h ed o tp r o d u c ta n da s s i g nr e s u l t t ot h ea p p r o p r i a t ev a r i a b l ei nt h es t r u c t u r e . * / m y s u m=0 ; f o r( i = s t a r t ;i < e n d;i + + ) { m y s u m+ =( x [ i ]*y [ i ] ) ; } / * L o c kam u t e xp r i o rt ou p d a t i n gt h ev a l u ei nt h es h a r e d s t r u c t u r e ,a n du n l o c ki tu p o nu p d a t i n g .

https://computing.llnl.gov/tutorials/pthreads/#Routines

17/27

04/07/13
* / p t h r e a d _ m u t e x _ l o c k( & m u t e x s u m ) ; d o t s t r . s u m+ =m y s u m ; p t h r e a d _ m u t e x _ u n l o c k( & m u t e x s u m ) ; p t h r e a d _ e x i t ( ( v o i d * )0 ) ; }

POSIX Threads Programming

/ * T h em a i np r o g r a mc r e a t e st h r e a d sw h i c hd oa l lt h ew o r ka n dt h e n p r i n to u tr e s u l tu p o nc o m p l e t i o n .B e f o r ec r e a t i n gt h et h r e a d s , t h ei n p u td a t ai sc r e a t e d .S i n c ea l lt h r e a d su p d a t eas h a r e ds t r u c t u r e , w en e e dam u t e xf o rm u t u a le x c l u s i o n .T h em a i nt h r e a dn e e d st ow a i tf o r a l lt h r e a d st oc o m p l e t e ,i tw a i t sf o re a c ho n eo ft h et h r e a d s .W es p e c i f y at h r e a da t t r i b u t ev a l u et h a ta l l o wt h em a i nt h r e a dt oj o i nw i t ht h e t h r e a d si tc r e a t e s .N o t ea l s ot h a tw ef r e eu ph a n d l e sw h e nt h e ya r e n ol o n g e rn e e d e d . * / i n tm a i n( i n ta r g c ,c h a r* a r g v [ ] ) { l o n gi ; d o u b l e* a ,* b ; v o i d* s t a t u s ; p t h r e a d _ a t t r _ ta t t r ; / *A s s i g ns t o r a g ea n di n i t i a l i z ev a l u e s* / a=( d o u b l e * )m a l l o c( N U M T H R D S * V E C L E N * s i z e o f ( d o u b l e ) ) ; b=( d o u b l e * )m a l l o c( N U M T H R D S * V E C L E N * s i z e o f ( d o u b l e ) ) ; f o r( i = 0 ;i < V E C L E N * N U M T H R D S ;i + + ) { a [ i ] = 1 . 0 ; b [ i ] = a [ i ] ; } d o t s t r . v e c l e n=V E C L E N ; d o t s t r . a=a ; d o t s t r . b=b ; d o t s t r . s u m = 0 ; p t h r e a d _ m u t e x _ i n i t ( & m u t e x s u m ,N U L L ) ; / *C r e a t et h r e a d st op e r f o r mt h ed o t p r o d u c t * / p t h r e a d _ a t t r _ i n i t ( & a t t r ) ; p t h r e a d _ a t t r _ s e t d e t a c h s t a t e ( & a t t r ,P T H R E A D _ C R E A T E _ J O I N A B L E ) ; f o r ( i = 0 ;i < N U M T H R D S ;i + + ) { / * E a c ht h r e a dw o r k so nad i f f e r e n ts e to fd a t a . T h eo f f s e ti ss p e c i f i e db y' i ' .T h es i z eo f t h ed a t af o re a c ht h r e a di si n d i c a t e db yV E C L E N . * / p t h r e a d _ c r e a t e ( & c a l l T h d [ i ] ,& a t t r ,d o t p r o d ,( v o i d* ) i ) ; } p t h r e a d _ a t t r _ d e s t r o y ( & a t t r ) ; / *W a i to nt h eo t h e rt h r e a d s* / f o r ( i = 0 ;i < N U M T H R D S ;i + + ) { p t h r e a d _ j o i n ( c a l l T h d [ i ] ,& s t a t u s ) ; } / *A f t e rj o i n i n g ,p r i n to u tt h er e s u l t sa n dc l e a n u p* / p r i n t f( " S u m= % f\ n " ,d o t s t r . s u m ) ; f r e e( a ) ; f r e e( b ) ; p t h r e a d _ m u t e x _ d e s t r o y ( & m u t e x s u m ) ; p t h r e a d _ e x i t ( N U L L ) ; }

Serial version Pthreads version

Condition Variables Overview

Condition variables provide yet another way for threads to synchronize. While mutexes implement synchronization by controlling thread access to data, condition variables allow threads to synchronize based upon the actual value of data.

https://computing.llnl.gov/tutorials/pthreads/#Routines

18/27

04/07/13

POSIX Threads Programming

Without condition variables, the programmer would need to have threads continually polling (possibly in a critical section), to check if the condition is met. This can be very resource consuming since the thread would be continuously busy in this activity. A condition variable is a way to achieve the same goal without polling. A condition variable is always used in conjunction with a mutex lock. A representative sequence for using condition variables is shown below. Main Thread Declare and initialize global data/variables which require synchronization (such as "count") Declare and initialize a condition variable object Declare and initialize an associated mutex Create threads A and B to do work Thread A Thread B Do work up to the point where a certain condition must Do work occur (such as "count" must reach a specified value) Lock associated mutex Lock associated mutex and check value of a global variable Change the value of the global variable that Thread-A is Call p t h r e a d _ c o n d _ w a i t ( )to perform a blocking wait for waiting upon. signal from Thread-B. Note that a call to Check value of the global Thread-A wait variable. If it fulfills p t h r e a d _ c o n d _ w a i t ( )automatically and atomically the desired condition, signal Thread-A. unlocks the associated mutex variable so that it can be used Unlock mutex. by Thread-B. Continue When signalled, wake up. Mutex is automatically and atomically locked. Explicitly unlock mutex Continue Main Thread Join / Continue

Condition Variables Creating and Destroying Condition Variables

Routines:
p t h r e a d _ c o n d _ i n i t( c o n d i t i o n , a t t r ) p t h r e a d _ c o n d _ d e s t r o y( c o n d i t i o n ) p t h r e a d _ c o n d a t t r _ i n i t( a t t r ) p t h r e a d _ c o n d a t t r _ d e s t r o y( a t t r )

Usage: Condition variables must be declared with type p t h r e a d _ c o n d _ t , and must be initialized before they can be used. There are two ways to initialize a condition variable: 1. Statically, when it is declared. For example:
p t h r e a d _ c o n d _ tm y c o n v a r=P T H R E A D _ C O N D _ I N I T I A L I Z E R ;

2. Dynamically, with the p t h r e a d _ c o n d _ i n i t ( )routine. The ID of the created condition variable is returned to the calling thread through the condition parameter. This method permits setting condition variable object attributes, attr. The optional attr object is used to set condition variable attributes. There is only one attribute defined for condition variables: process-shared, which allows the condition variable to be seen by threads in other processes. The attribute object, if used, must be of type p t h r e a d _ c o n d a t t r _ t(may be specified as NULL to accept defaults). Note that not all implementations may provide the process-shared attribute. The p t h r e a d _ c o n d a t t r _ i n i t ( )and p t h r e a d _ c o n d a t t r _ d e s t r o y ( )routines are used to create and destroy condition variable attribute objects.
p t h r e a d _ c o n d _ d e s t r o y ( )should

be used to free a condition variable that is no longer needed.

Condition Variables Waiting and Signaling on Condition Variables

Routines:
https://computing.llnl.gov/tutorials/pthreads/#Routines 19/27

04/07/13
p t h r e a d _ c o n d _ w a i t( c o n d i t i o n , m u t e x ) p t h r e a d _ c o n d _ s i g n a l( c o n d i t i o n ) p t h r e a d _ c o n d _ b r o a d c a s t( c o n d i t i o n )

POSIX Threads Programming

Usage:
p t h r e a d _ c o n d _ w a i t ( )blocks the calling thread

until the specified condition is signalled. This routine should be called while mutex is locked, and it will automatically release the mutex while it waits. After signal is received and thread is awakened, mutex will be automatically locked for use by the thread. The programmer is then responsible for unlocking mutex when the thread is finished with it. The p t h r e a d _ c o n d _ s i g n a l ( )routine is used to signal (or wake up) another thread which is waiting on the condition variable. It should be called after mutex is locked, and must unlock mutex in order for p t h r e a d _ c o n d _ w a i t ( )routine to complete. The p t h r e a d _ c o n d _ b r o a d c a s t ( )routine should be used instead of p t h r e a d _ c o n d _ s i g n a l ( )if more than one thread is in a blocking wait state. It is a logical error to call p t h r e a d _ c o n d _ s i g n a l ( )before calling p t h r e a d _ c o n d _ w a i t ( ) . Proper locking and unlocking of the associated mutex variable is essential when using these routines. For example: Failing to lock the mutex before calling p t h r e a d _ c o n d _ w a i t ( )may cause it NOT to block. Failing to unlock the mutex after calling p t h r e a d _ c o n d _ s i g n a l ( )may not allow a matching p t h r e a d _ c o n d _ w a i t ( )routine to complete (it will remain blocked).

Example: Using Condition Variables

Example Code - Using Condition Variables This simple example code demonstrates the use of several Pthread condition variable routines. The main routine creates three threads. Two of the threads perform work and update a "count" variable. The third thread waits until the count variable reaches a specified value.
# i n c l u d e< p t h r e a d . h > # i n c l u d e< s t d i o . h > # i n c l u d e< s t d l i b . h > # d e f i n eN U M _ T H R E A D S 3 # d e f i n eT C O U N T1 0 # d e f i n eC O U N T _ L I M I T1 2 i n t c o u n t=0 ; i n t t h r e a d _ i d s [ 3 ]={ 0 , 1 , 2 } ; p t h r e a d _ m u t e x _ tc o u n t _ m u t e x ; p t h r e a d _ c o n d _ tc o u n t _ t h r e s h o l d _ c v ; v o i d* i n c _ c o u n t ( v o i d* t ) { i n ti ; l o n gm y _ i d=( l o n g ) t ; f o r( i = 0 ;i < T C O U N T ;i + + ){ p t h r e a d _ m u t e x _ l o c k ( & c o u n t _ m u t e x ) ; c o u n t + + ; / * C h e c kt h ev a l u eo fc o u n ta n ds i g n a lw a i t i n gt h r e a dw h e nc o n d i t i o ni s r e a c h e d . N o t et h a tt h i so c c u r sw h i l em u t e xi sl o c k e d . * / i f( c o u n t= =C O U N T _ L I M I T ){ p t h r e a d _ c o n d _ s i g n a l ( & c o u n t _ t h r e s h o l d _ c v ) ; p r i n t f ( " i n c _ c o u n t ( ) :t h r e a d% l d ,c o u n t=% d T h r e s h o l dr e a c h e d . \ n " , m y _ i d ,c o u n t ) ; } p r i n t f ( " i n c _ c o u n t ( ) :t h r e a d% l d ,c o u n t=% d ,u n l o c k i n gm u t e x \ n " , m y _ i d ,c o u n t ) ; p t h r e a d _ m u t e x _ u n l o c k ( & c o u n t _ m u t e x ) ; / *D os o m e" w o r k "s ot h r e a d sc a na l t e r n a t eo nm u t e xl o c k* / s l e e p ( 1 ) ; } p t h r e a d _ e x i t ( N U L L ) ; } v o i d* w a t c h _ c o u n t ( v o i d* t ) { l o n gm y _ i d=( l o n g ) t ; p r i n t f ( " S t a r t i n gw a t c h _ c o u n t ( ) :t h r e a d% l d \ n " ,m y _ i d ) ; / *

https://computing.llnl.gov/tutorials/pthreads/#Routines

20/27

04/07/13

POSIX Threads Programming

L o c km u t e xa n dw a i tf o rs i g n a l . N o t et h a tt h ep t h r e a d _ c o n d _ w a i t r o u t i n ew i l la u t o m a t i c a l l ya n da t o m i c a l l yu n l o c km u t e xw h i l ei tw a i t s . A l s o ,n o t et h a ti fC O U N T _ L I M I Ti sr e a c h e db e f o r et h i sr o u t i n ei sr u nb y t h ew a i t i n gt h r e a d ,t h el o o pw i l lb es k i p p e dt op r e v e n tp t h r e a d _ c o n d _ w a i t f r o mn e v e rr e t u r n i n g . * / p t h r e a d _ m u t e x _ l o c k ( & c o u n t _ m u t e x ) ; w h i l e( c o u n t < C O U N T _ L I M I T ){ p t h r e a d _ c o n d _ w a i t ( & c o u n t _ t h r e s h o l d _ c v ,& c o u n t _ m u t e x ) ; p r i n t f ( " w a t c h _ c o u n t ( ) :t h r e a d% l dC o n d i t i o ns i g n a lr e c e i v e d . \ n " ,m y _ i d ) ; c o u n t+ =1 2 5 ; p r i n t f ( " w a t c h _ c o u n t ( ) :t h r e a d% l dc o u n tn o w=% d . \ n " ,m y _ i d ,c o u n t ) ; } p t h r e a d _ m u t e x _ u n l o c k ( & c o u n t _ m u t e x ) ; p t h r e a d _ e x i t ( N U L L ) ; } i n tm a i n( i n ta r g c ,c h a r* a r g v [ ] ) { i n ti ,r c ; l o n gt 1 = 1 ,t 2 = 2 ,t 3 = 3 ; p t h r e a d _ tt h r e a d s [ 3 ] ; p t h r e a d _ a t t r _ ta t t r ; / *I n i t i a l i z em u t e xa n dc o n d i t i o nv a r i a b l eo b j e c t s* / p t h r e a d _ m u t e x _ i n i t ( & c o u n t _ m u t e x ,N U L L ) ; p t h r e a d _ c o n d _ i n i t( & c o u n t _ t h r e s h o l d _ c v ,N U L L ) ; / *F o rp o r t a b i l i t y ,e x p l i c i t l yc r e a t et h r e a d si naj o i n a b l es t a t e* / p t h r e a d _ a t t r _ i n i t ( & a t t r ) ; p t h r e a d _ a t t r _ s e t d e t a c h s t a t e ( & a t t r ,P T H R E A D _ C R E A T E _ J O I N A B L E ) ; p t h r e a d _ c r e a t e ( & t h r e a d s [ 0 ] ,& a t t r ,w a t c h _ c o u n t ,( v o i d* ) t 1 ) ; p t h r e a d _ c r e a t e ( & t h r e a d s [ 1 ] ,& a t t r ,i n c _ c o u n t ,( v o i d* ) t 2 ) ; p t h r e a d _ c r e a t e ( & t h r e a d s [ 2 ] ,& a t t r ,i n c _ c o u n t ,( v o i d* ) t 3 ) ; / *W a i tf o ra l lt h r e a d st oc o m p l e t e* / f o r( i = 0 ;i < N U M _ T H R E A D S ;i + + ){ p t h r e a d _ j o i n ( t h r e a d s [ i ] ,N U L L ) ; } p r i n t f( " M a i n ( ) :W a i t e do n% d t h r e a d s .D o n e . \ n " ,N U M _ T H R E A D S ) ; / *C l e a nu pa n de x i t* / p t h r e a d _ a t t r _ d e s t r o y ( & a t t r ) ; p t h r e a d _ m u t e x _ d e s t r o y ( & c o u n t _ m u t e x ) ; p t h r e a d _ c o n d _ d e s t r o y ( & c o u n t _ t h r e s h o l d _ c v ) ; p t h r e a d _ e x i t ( N U L L ) ; }

Monitoring, Debugging and Performance Analysis Tools for Pthreads

Monitoring and Debugging Pthreads: Debuggers vary in their ability to handle Pthreads. The TotalView debugger is LC's recommended debugger for parallel programs. It is well suited for both monitoring and debugging threaded programs. An example screenshot from a TotalView session using a threaded code is shown below. 1. Stack Trace Pane: Displays the call stack of routines that the selected thread is executing. 2. Status Bars: Show status information for the selected thread and its associated process. 3. Stack Frame Pane: Shows a selected thread's stack variables, registers, etc. 4. Source Pane: Shows the source code for the selected thread. 5. Root Window showing all threads 6. Threads Pane: Shows threads associated with the selected process

https://computing.llnl.gov/tutorials/pthreads/#Routines

21/27

04/07/13

POSIX Threads Programming

See the TotalView Debugger tutorial for details. The Linux p scommand provides several flags for viewing thread information. Some examples are shown below. See the man page for details.
%p sL f U I D P I D P P I D L W P CN L W PS T I M ET T Y b l a i s e 2 2 5 2 92 8 2 4 02 2 5 2 9 0 51 1 : 3 1p t s / 5 3 b l a i s e 2 2 5 2 92 8 2 4 02 2 5 3 09 9 51 1 : 3 1p t s / 5 3 b l a i s e 2 2 5 2 92 8 2 4 02 2 5 3 19 9 51 1 : 3 1p t s / 5 3 b l a i s e 2 2 5 2 92 8 2 4 02 2 5 3 29 9 51 1 : 3 1p t s / 5 3 b l a i s e 2 2 5 2 92 8 2 4 02 2 5 3 39 9 51 1 : 3 1p t s / 5 3 %p sT P I D S P I DT T Y 2 2 5 2 92 2 5 2 9p t s / 5 3 2 2 5 2 92 2 5 3 0p t s / 5 3 2 2 5 2 92 2 5 3 1p t s / 5 3 2 2 5 2 92 2 5 3 2p t s / 5 3 2 2 5 2 92 2 5 3 3p t s / 5 3 %p sL m P I D L W PT T Y 2 2 5 2 9 -p t s / 5 3 -2 2 5 2 9-2 2 5 3 0-2 2 5 3 1-2 2 5 3 2-2 2 5 3 3-

T I M EC M D 0 0 : 0 0 : 0 0a . o u t 0 0 : 0 1 : 2 4a . o u t 0 0 : 0 1 : 2 4a . o u t 0 0 : 0 1 : 2 4a . o u t 0 0 : 0 1 : 2 4a . o u t

T I M EC M D 0 0 : 0 0 : 0 0a . o u t 0 0 : 0 1 : 4 9a . o u t 0 0 : 0 1 : 4 9a . o u t 0 0 : 0 1 : 4 9a . o u t 0 0 : 0 1 : 4 9a . o u t

T I M EC M D 0 0 : 1 8 : 5 6a . o u t 0 0 : 0 0 : 0 00 0 : 0 4 : 4 40 0 : 0 4 : 4 40 0 : 0 4 : 4 40 0 : 0 4 : 4 4-

LC's Linux clusters also provide the t o pcommand to monitor processes on a node. If used with the Hflag, the threads contained within a process will be visible. An example of the t o pHcommand is shown below. The parent process is PID 18010 which spawned three threads, shown as PIDs 18012, 18013 and 18014.

https://computing.llnl.gov/tutorials/pthreads/#Routines

22/27

04/07/13

POSIX Threads Programming

Performance Analysis Tools: There are a variety of performance analysis tools that can be used with threaded programs. Searching the web will turn up a wealth of information. At LC, the list of supported computing tools can be found at: computing.llnl.gov/code/content/software_tools.php. These tools vary significantly in their complexity, functionality and learning curve. Covering them in detail is beyond the scope of this tutorial. Some tools worth investigating, specifically for threaded codes, include: Open|SpeedShop TAU PAPI Intel VTune Amplifier ThreadSpotter

LLNL Specific Information and Recommendations

This section describes details specific to Livermore Computing's systems. Implementations: All LC production systems include a Pthreads implementation that follows draft 10 (final) of the POSIX standard. This is the preferred implementation. Implementations differ in the maximum number of threads that a process may create. They also differ in the default amount of thread stack space. Compiling: LC maintains a number of compilers, and usually several different versions of each - see the LC's Supported Compilers web page. The compiler commands described in the Compiling Threaded Programs section apply to LC systems. Mixing MPI with Pthreads: This is the primary motivation for using Pthreads at LC. Design: Each MPI process typically creates and then manages N threads, where N makes the best use of the available cores/node. Finding the best value for N will vary with the platform and your application's characteristics. In general, there may be problems if multiple threads make MPI calls. The program may fail or behave unexpectedly. If MPI calls must be made from within a thread, they should be made only by one thread. Compiling: Use the appropriate MPI compile command for the platform and language of choice Be sure to include the required Pthreads flag as shown in the Compiling Threaded Programs section. An example code that uses both MPI and Pthreads is available below. The serial, threads-only, MPI-only and MPI-with-threads versions demonstrate one possible progression. Serial Pthreads only MPI only MPI with pthreads makefile

https://computing.llnl.gov/tutorials/pthreads/#Routines

23/27

04/07/13

POSIX Threads Programming

Topics Not Covered

Several features of the Pthreads API are not covered in this tutorial. These are listed below. See the Pthread Library Routines Reference section for more information. Thread Scheduling Implementations will differ on how threads are scheduled to run. In most cases, the default mechanism is adequate. The Pthreads API provides routines to explicitly set thread scheduling policies and priorities which may override the default mechanisms. The API does not require implementations to support these features. Keys: Thread-Specific Data As threads call and return from different routines, the local data on a thread's stack comes and goes. To preserve stack data you can usually pass it as an argument from one routine to the next, or else store the data in a global variable associated with a thread. Pthreads provides another, possibly more convenient and versatile, way of accomplishing this through keys. Mutex Protocol Attributes and Mutex Priority Management for the handling of "priority inversion" problems. Condition Variable Sharing - across processes Thread Cancellation Threads and Signals Synchronization constructs - barriers and locks

Pthread Exercise 2 Mutexes, Condition Variables and Hybrid MPI with Pthreads
Overview: Login to the LC workshop cluster, if you are not already logged in Mutexes: review and run the provided example codes Condition variables: review and run the provided example codes Hybrid MPI with Pthreads: review and run the provided example codes Go to the exercise now

This completes the tutorial.

Please complete the online evaluation form - unless you are doing the exercise, in which case please complete it at the end of the exercise.

Where would you like to go now?

Exercise Agenda Back to the top

https://computing.llnl.gov/tutorials/pthreads/#Routines

24/27

04/07/13

POSIX Threads Programming

References and More Information

Author: Blaise Barney, Livermore Computing. POSIX Standard: www.unix.org/version3/ieee_std.html "Pthreads Programming". B. Nichols et al. O'Reilly and Associates. "Threads Primer". B. Lewis and D. Berg. Prentice Hall "Programming With POSIX Threads". D. Butenhof. Addison Wesley www.awl.com/cseng/titles/0-201-63392-2 "Programming With Threads". S. Kleiman et al. Prentice Hall

Appendix A: Pthread Library Routines Reference

For convenience, an alphabetical list of Pthread routines, linked to their corresponding man page, is provided below. pthread_atfork pthread_attr_destroy pthread_attr_getdetachstate pthread_attr_getguardsize pthread_attr_getinheritsched pthread_attr_getschedparam pthread_attr_getschedpolicy pthread_attr_getscope pthread_attr_getstack pthread_attr_getstackaddr pthread_attr_getstacksize pthread_attr_init pthread_attr_setdetachstate pthread_attr_setguardsize pthread_attr_setinheritsched pthread_attr_setschedparam pthread_attr_setschedpolicy pthread_attr_setscope pthread_attr_setstack pthread_attr_setstackaddr pthread_attr_setstacksize pthread_barrier_destroy pthread_barrier_init pthread_barrier_wait pthread_barrierattr_destroy pthread_barrierattr_getpshared pthread_barrierattr_init pthread_barrierattr_setpshared pthread_cancel pthread_cleanup_pop pthread_cleanup_push pthread_cond_broadcast pthread_cond_destroy pthread_cond_init pthread_cond_signal pthread_cond_timedwait pthread_cond_wait pthread_condattr_destroy pthread_condattr_getclock pthread_condattr_getpshared pthread_condattr_init pthread_condattr_setclock pthread_condattr_setpshared pthread_create pthread_detach pthread_equal pthread_exit pthread_getconcurrency pthread_getcpuclockid
https://computing.llnl.gov/tutorials/pthreads/#Routines 25/27

04/07/13

POSIX Threads Programming

pthread_getschedparam pthread_getspecific pthread_join pthread_key_create pthread_key_delete pthread_kill pthread_mutex_destroy pthread_mutex_getprioceiling pthread_mutex_init pthread_mutex_lock pthread_mutex_setprioceiling pthread_mutex_timedlock pthread_mutex_trylock pthread_mutex_unlock pthread_mutexattr_destroy pthread_mutexattr_getprioceiling pthread_mutexattr_getprotocol pthread_mutexattr_getpshared pthread_mutexattr_gettype pthread_mutexattr_init pthread_mutexattr_setprioceiling pthread_mutexattr_setprotocol pthread_mutexattr_setpshared pthread_mutexattr_settype pthread_once pthread_rwlock_destroy pthread_rwlock_init pthread_rwlock_rdlock pthread_rwlock_timedrdlock pthread_rwlock_timedwrlock pthread_rwlock_tryrdlock pthread_rwlock_trywrlock pthread_rwlock_unlock pthread_rwlock_wrlock pthread_rwlockattr_destroy pthread_rwlockattr_getpshared pthread_rwlockattr_init pthread_rwlockattr_setpshared pthread_self pthread_setcancelstate pthread_setcanceltype pthread_setconcurrency pthread_setschedparam pthread_setschedprio pthread_setspecific pthread_sigmask pthread_spin_destroy pthread_spin_init pthread_spin_lock pthread_spin_trylock pthread_spin_unlock pthread_testcancel
https://computing.llnl.gov/tutorials/pthreads/#Routines Last Modified: 01/11/2013 23:15:49 blaiseb@llnl.gov UCRL-MI-133316

https://computing.llnl.gov/tutorials/pthreads/#Routines

26/27

04/07/13

POSIX Threads Programming

https://computing.llnl.gov/tutorials/pthreads/#Routines

27/27