include/linux/futex.h

   1 #ifndef _LINUX_FUTEX_H
   2 #define _LINUX_FUTEX_H
   3
   4 #include <linux/compiler.h>
   5 #include <linux/types.h>
   6
   7 struct inode;
   8 struct mm_struct;
   9 struct task_struct;
  10 union ktime;
  11
  12 /* Second argument to futex syscall */
  13
  14
  15 #define FUTEX_WAIT              0
  16 #define FUTEX_WAKE              1
  17 #define FUTEX_FD                2
  18 #define FUTEX_REQUEUE           3
  19 #define FUTEX_CMP_REQUEUE       4
  20 #define FUTEX_WAKE_OP           5
  21 #define FUTEX_LOCK_PI           6
  22 #define FUTEX_UNLOCK_PI         7
  23 #define FUTEX_TRYLOCK_PI        8
  24 #define FUTEX_WAIT_BITSET       9
  25 #define FUTEX_WAKE_BITSET       10
  26 #define FUTEX_WAIT_REQUEUE_PI   11
  27 #define FUTEX_REQUEUE_PI        12
  28 #define FUTEX_CMP_REQUEUE_PI    13
  29
  30 #define FUTEX_PRIVATE_FLAG      128
  31 #define FUTEX_CLOCK_REALTIME    256
  32 #define FUTEX_CMD_MASK          ~(FUTEX_PRIVATE_FLAG | FUTEX_CLOCK_REALTIME)
  33
  34 #define FUTEX_WAIT_PRIVATE      (FUTEX_WAIT | FUTEX_PRIVATE_FLAG)
  35 #define FUTEX_WAKE_PRIVATE      (FUTEX_WAKE | FUTEX_PRIVATE_FLAG)
  36 #define FUTEX_REQUEUE_PRIVATE   (FUTEX_REQUEUE | FUTEX_PRIVATE_FLAG)
  37 #define FUTEX_CMP_REQUEUE_PRIVATE (FUTEX_CMP_REQUEUE | FUTEX_PRIVATE_FLAG)
  38 #define FUTEX_WAKE_OP_PRIVATE   (FUTEX_WAKE_OP | FUTEX_PRIVATE_FLAG)
  39 #define FUTEX_LOCK_PI_PRIVATE   (FUTEX_LOCK_PI | FUTEX_PRIVATE_FLAG)
  40 #define FUTEX_UNLOCK_PI_PRIVATE (FUTEX_UNLOCK_PI | FUTEX_PRIVATE_FLAG)
  41 #define FUTEX_TRYLOCK_PI_PRIVATE (FUTEX_TRYLOCK_PI | FUTEX_PRIVATE_FLAG)
  42 #define FUTEX_WAIT_BITSET_PRIVATE       (FUTEX_WAIT_BITS | FUTEX_PRIVATE_FLAG)
  43 #define FUTEX_WAKE_BITSET_PRIVATE       (FUTEX_WAKE_BITS | FUTEX_PRIVATE_FLAG)
  44 #define FUTEX_WAIT_REQUEUE_PI_PRIVATE   (FUTEX_WAIT_REQUEUE_PI | \
  45                                          FUTEX_PRIVATE_FLAG)
  46 #define FUTEX_REQUEUE_PI_PRIVATE        (FUTEX_REQUEUE_PI | FUTEX_PRIVATE_FLAG)
  47 #define FUTEX_CMP_REQUEUE_PI_PRIVATE    (FUTEX_CMP_REQUEUE_PI | \
  48                                          FUTEX_PRIVATE_FLAG)
  49
  50 /*
  51  * Support for robust futexes: the kernel cleans up held futexes at
  52  * thread exit time.
  53  */
  54
  55 /*
  56  * Per-lock list entry - embedded in user-space locks, somewhere close
  57  * to the futex field. (Note: user-space uses a double-linked list to
  58  * achieve O(1) list add and remove, but the kernel only needs to know
  59  * about the forward link)
  60  *
  61  * NOTE: this structure is part of the syscall ABI, and must not be
  62  * changed.
  63  */
  64 struct robust_list {
  65         struct robust_list __user *next;
  66 };
  67
  68 /*
  69  * Per-thread list head:
  70  *
  71  * NOTE: this structure is part of the syscall ABI, and must only be
  72  * changed if the change is first communicated with the glibc folks.
  73  * (When an incompatible change is done, we'll increase the structure
  74  *  size, which glibc will detect)
  75  */
  76 struct robust_list_head {
  77         /*
  78          * The head of the list. Points back to itself if empty:
  79          */
  80         struct robust_list list;
  81
  82         /*
  83          * This relative offset is set by user-space, it gives the kernel
  84          * the relative position of the futex field to examine. This way
  85          * we keep userspace flexible, to freely shape its data-structure,
  86          * without hardcoding any particular offset into the kernel:
  87          */
  88         long futex_offset;
  89
  90         /*
  91          * The death of the thread may race with userspace setting
  92          * up a lock's links. So to handle this race, userspace first
  93          * sets this field to the address of the to-be-taken lock,
  94          * then does the lock acquire, and then adds itself to the
  95          * list, and then clears this field. Hence the kernel will
  96          * always have full knowledge of all locks that the thread
  97          * _might_ have taken. We check the owner TID in any case,
  98          * so only truly owned locks will be handled.
  99          */
 100         struct robust_list __user *list_op_pending;
 101 };
 102
 103 /*
 104  * Are there any waiters for this robust futex:
 105  */
 106 #define FUTEX_WAITERS           0x80000000
 107
 108 /*
 109  * The kernel signals via this bit that a thread holding a futex
 110  * has exited without unlocking the futex. The kernel also does
 111  * a FUTEX_WAKE on such futexes, after setting the bit, to wake
 112  * up any possible waiters:
 113  */
 114 #define FUTEX_OWNER_DIED        0x40000000
 115
 116 /*
 117  * The rest of the robust-futex field is for the TID:
 118  */
 119 #define FUTEX_TID_MASK          0x3fffffff
 120
 121 /*
 122  * This limit protects against a deliberately circular list.
 123  * (Not worth introducing an rlimit for it)
 124  */
 125 #define ROBUST_LIST_LIMIT       2048
 126
 127 /*
 128  * bitset with all bits set for the FUTEX_xxx_BITSET OPs to request a
 129  * match of any bit.
 130  */
 131 #define FUTEX_BITSET_MATCH_ANY  0xffffffff
 132
 133 #ifdef __KERNEL__
 134 long do_futex(u32 __user *uaddr, int op, u32 val, union ktime *timeout,
 135               u32 __user *uaddr2, u32 val2, u32 val3);
 136
 137 extern int
 138 handle_futex_death(u32 __user *uaddr, struct task_struct *curr, int pi);
 139
 140 /*
 141  * Futexes are matched on equal values of this key.
 142  * The key type depends on whether it's a shared or private mapping.
 143  * Don't rearrange members without looking at hash_futex().
 144  *
 145  * offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
 146  * We use the two low order bits of offset to tell what is the kind of key :
 147  *  00 : Private process futex (PTHREAD_PROCESS_PRIVATE)
 148  *       (no reference on an inode or mm)
 149  *  01 : Shared futex (PTHREAD_PROCESS_SHARED)
 150  *      mapped on a file (reference on the underlying inode)
 151  *  10 : Shared futex (PTHREAD_PROCESS_SHARED)
 152  *       (but private mapping on an mm, and reference taken on it)
 153 */
 154
 155 #define FUT_OFF_INODE    1 /* We set bit 0 if key has a reference on inode */
 156 #define FUT_OFF_MMSHARED 2 /* We set bit 1 if key has a reference on mm */
 157
 158 union futex_key {
 159         struct {
 160                 unsigned long pgoff;
 161                 struct inode *inode;
 162                 int offset;
 163         } shared;
 164         struct {
 165                 unsigned long address;
 166                 struct mm_struct *mm;
 167                 int offset;
 168         } private;
 169         struct {
 170                 unsigned long word;
 171                 void *ptr;
 172                 int offset;
 173         } both;
 174 };
 175
 176 #define FUTEX_KEY_INIT (union futex_key) { .both = { .ptr = NULL } }
 177
 178 #ifdef CONFIG_FUTEX
 179 extern void exit_robust_list(struct task_struct *curr);
 180 extern void exit_pi_state_list(struct task_struct *curr);
 181 extern int futex_cmpxchg_enabled;
 182 #else
 183 static inline void exit_robust_list(struct task_struct *curr)
 184 {
 185 }
 186 static inline void exit_pi_state_list(struct task_struct *curr)
 187 {
 188 }
 189 #endif
 190 #endif /* __KERNEL__ */
 191
 192 #define FUTEX_OP_SET            0       /* *(int *)UADDR2 = OPARG; */
 193 #define FUTEX_OP_ADD            1       /* *(int *)UADDR2 += OPARG; */
 194 #define FUTEX_OP_OR             2       /* *(int *)UADDR2 |= OPARG; */
 195 #define FUTEX_OP_ANDN           3       /* *(int *)UADDR2 &= ~OPARG; */
 196 #define FUTEX_OP_XOR            4       /* *(int *)UADDR2 ^= OPARG; */
 197
 198 #define FUTEX_OP_OPARG_SHIFT    8       /* Use (1 << OPARG) instead of OPARG.  */
 199
 200 #define FUTEX_OP_CMP_EQ         0       /* if (oldval == CMPARG) wake */
 201 #define FUTEX_OP_CMP_NE         1       /* if (oldval != CMPARG) wake */
 202 #define FUTEX_OP_CMP_LT         2       /* if (oldval < CMPARG) wake */
 203 #define FUTEX_OP_CMP_LE         3       /* if (oldval <= CMPARG) wake */
 204 #define FUTEX_OP_CMP_GT         4       /* if (oldval > CMPARG) wake */
 205 #define FUTEX_OP_CMP_GE         5       /* if (oldval >= CMPARG) wake */
 206
 207 /* FUTEX_WAKE_OP will perform atomically
 208    int oldval = *(int *)UADDR2;
 209    *(int *)UADDR2 = oldval OP OPARG;
 210    if (oldval CMP CMPARG)
 211      wake UADDR2;  */
 212
 213 #define FUTEX_OP(op, oparg, cmp, cmparg) \
 214   (((op & 0xf) << 28) | ((cmp & 0xf) << 24)             \
 215    | ((oparg & 0xfff) << 12) | (cmparg & 0xfff))
 216
 217 #endif