man7/futex.7

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .\"
   7 .\" %%%LICENSE_START(MIT)
   8 .\" This page is made available under the MIT license.
   9 .\" %%%LICENSE_END
  10 .\"
  11 .TH FUTEX 7 2017-09-15 "Linux" "Linux Programmer's Manual"
  12 .SH NAME
  13 futex \- fast user-space locking
  14 .SH SYNOPSIS
  15 .nf
  16 .B #include <linux/futex.h>
  17 .fi
  18 .SH DESCRIPTION
  19 The Linux kernel provides futexes ("Fast user-space mutexes")
  20 as a building block for fast user-space
  21 locking and semaphores.
  22 Futexes are very basic and lend themselves well for building higher-level
  23 locking abstractions such as
  24 mutexes, condition variables, read-write locks, barriers, and semaphores.
  25 .PP
  26 Most programmers will in fact not be using futexes directly but will
  27 instead rely on system libraries built on them,
  28 such as the Native POSIX Thread Library (NPTL) (see
  29 .BR pthreads (7)).
  30 .PP
  31 A futex is identified by a piece of memory which can be
  32 shared between processes or threads.
  33 In these different processes, the futex need not have identical addresses.
  34 In its bare form, a futex has semaphore semantics;
  35 it is a counter that can be incremented and decremented atomically;
  36 processes can wait for the value to become positive.
  37 .PP
  38 Futex operation occurs entirely in user space for the noncontended case.
  39 The kernel is involved only to arbitrate the contended case.
  40 As any sane design will strive for noncontention,
  41 futexes are also optimized for this situation.
  42 .PP
  43 In its bare form, a futex is an aligned integer which is
  44 touched only by atomic assembler instructions.
  45 This integer is four bytes long on all platforms.
  46 Processes can share this integer using
  47 .BR mmap (2),
  48 via shared memory segments, or because they share memory space,
  49 in which case the application is commonly called multithreaded.
  50 .SS Semantics
  51 Any futex operation starts in user space,
  52 but it may be necessary to communicate with the kernel using the
  53 .BR futex (2)
  54 system call.
  55 .PP
  56 To "up" a futex, execute the proper assembler instructions that
  57 will cause the host CPU to atomically increment the integer.
  58 Afterward, check if it has in fact changed from 0 to 1, in which case
  59 there were no waiters and the operation is done.
  60 This is the noncontended case which is fast and should be common.
  61 .PP
  62 In the contended case, the atomic increment changed the counter
  63 from \-1  (or some other negative number).
  64 If this is detected, there are waiters.
  65 User space should now set the counter to 1 and instruct the
  66 kernel to wake up any waiters using the
  67 .B FUTEX_WAKE
  68 operation.
  69 .PP
  70 Waiting on a futex, to "down" it, is the reverse operation.
  71 Atomically decrement the counter and check if it changed to 0,
  72 in which case the operation is done and the futex was uncontended.
  73 In all other circumstances, the process should set the counter to \-1
  74 and request that the kernel wait for another process to up the futex.
  75 This is done using the
  76 .B FUTEX_WAIT
  77 operation.
  78 .PP
  79 The
  80 .BR futex (2)
  81 system call can optionally be passed a timeout specifying how long
  82 the kernel should
  83 wait for the futex to be upped.
  84 In this case, semantics are more complex and the programmer is referred
  85 to
  86 .BR futex (2)
  87 for
  88 more details.
  89 The same holds for asynchronous futex waiting.
  90 .SH VERSIONS
  91 Initial futex support was merged in Linux 2.5.7
  92 but with different semantics from those described above.
  93 Current semantics are available from Linux 2.5.40 onward.
  94 .SH NOTES
  95 To reiterate, bare futexes are not intended as an easy-to-use
  96 abstraction for end users.
  97 Implementors are expected to be assembly literate and to have read
  98 the sources of the futex user-space library referenced
  99 below.
 100 .PP
 101 This man page illustrates the most common use of the
 102 .BR futex (2)
 103 primitives; it is by no means the only one.
 104 .\" .SH AUTHORS
 105 .\" .PP
 106 .\" Futexes were designed and worked on by Hubertus Franke
 107 .\" (IBM Thomas J. Watson Research Center),
 108 .\" Matthew Kirkwood, Ingo Molnar (Red Hat) and
 109 .\" Rusty Russell (IBM Linux Technology Center).
 110 .\" This page written by bert hubert.
 111 .SH SEE ALSO
 112 .BR clone (2),
 113 .BR futex (2),
 114 .BR get_robust_list (2),
 115 .BR set_robust_list (2),
 116 .BR set_tid_address (2),
 117 .BR pthreads (7)
 118 .PP
 119 .IR "Fuss, Futexes and Furwocks: Fast Userlevel Locking in Linux"
 120 (proceedings of the Ottawa Linux Symposium 2002),
 121 futex example library, futex-*.tar.bz2
 122 .UR ftp://ftp.kernel.org\:/pub\:/linux\:/kernel\:/people\:/rusty/
 123 .UE .