sys/sys/umtx.h

   1 /*-
   2  * Copyright (c) 2002, Jeffrey Roberson <jeff@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  *
  28  */
  29
  30 #ifndef _SYS_UMTX_H_
  31 #define _SYS_UMTX_H_
  32
  33 #include <sys/limits.h>
  34
  35 /*
  36  * See pthread_*
  37  */
  38
  39 #define UMTX_UNOWNED    0x0
  40 #define UMTX_CONTESTED  LONG_MIN
  41
  42 struct umtx {
  43         uintptr_t       u_owner;        /* Owner of the mutex. */
  44 };
  45
  46 /* op code for _umtx_op */
  47 #define UMTX_OP_LOCK            0
  48 #define UMTX_OP_UNLOCK          1
  49 #define UMTX_OP_WAIT            2
  50 #define UMTX_OP_WAKE            3
  51
  52 #ifndef _KERNEL
  53
  54 /*
  55  * System call for userland mutex operations.
  56  * Bug: assume sizeof(uintptr_t) == sizeof(long)
  57  */
  58 int _umtx_wait(struct umtx *umtx, uintptr_t expect,
  59         const struct timespec *timeout);
  60 int _umtx_wake(struct umtx *umtx, int nr_wakeup);
  61 int _umtx_op(struct umtx *umtx, int op, uintptr_t val,
  62         void *uaddr, void *uaddr2);
  63
  64 /*
  65  * Old (deprecated) userland mutex system calls.
  66  */
  67 int _umtx_lock(struct umtx *mtx);
  68 int _umtx_unlock(struct umtx *mtx);
  69
  70 /*
  71  * Standard api.  Try uncontested acquire/release and asks the
  72  * kernel to resolve failures.
  73  */
  74 static __inline void
  75 umtx_init(struct umtx *umtx)
  76 {
  77         umtx->u_owner = UMTX_UNOWNED;
  78 }
  79
  80 static __inline uintptr_t
  81 umtx_owner(struct umtx *umtx)
  82 {
  83         return (umtx->u_owner & ~LONG_MIN);
  84 }
  85
  86 static __inline int
  87 umtx_lock(struct umtx *umtx, uintptr_t id)
  88 {
  89         if (atomic_cmpset_acq_ptr(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
  90                 if (_umtx_lock(umtx) == -1)
  91                         return (errno);
  92         return (0);
  93 }
  94
  95 static __inline int
  96 umtx_trylock(struct umtx *umtx, uintptr_t id)
  97 {
  98         if (atomic_cmpset_acq_ptr(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
  99                 return (EBUSY);
 100         return (0);
 101 }
 102
 103 static __inline int
 104 umtx_timedlock(struct umtx *umtx, uintptr_t id, const struct timespec *timeout)
 105 {
 106         if (atomic_cmpset_acq_ptr(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
 107                 if (_umtx_op(umtx, UMTX_OP_LOCK, id, 0,
 108                     __DECONST(void *, timeout)) == -1)
 109                         return (errno);
 110         return (0);
 111 }
 112
 113 static __inline int
 114 umtx_unlock(struct umtx *umtx, uintptr_t id)
 115 {
 116         if (atomic_cmpset_rel_ptr(&umtx->u_owner, id, UMTX_UNOWNED) == 0)
 117                 if (_umtx_unlock(umtx) == -1)
 118                         return (errno);
 119         return (0);
 120 }
 121
 122 static __inline int
 123 umtx_wait(struct umtx *umtx, long id, const struct timespec *timeout)
 124 {
 125         if (_umtx_op(umtx, UMTX_OP_WAIT, id, 0,
 126             __DECONST(void *, timeout)) == -1)
 127                 return (errno);
 128         return (0);
 129 }
 130
 131 /* Wake threads waiting on a user address. */
 132 static __inline int
 133 umtx_wake(struct umtx *umtx, int nr_wakeup)
 134 {
 135         if (_umtx_op(umtx, UMTX_OP_WAKE, nr_wakeup, 0, 0) == -1)
 136                 return (errno);
 137         return (0);
 138 }
 139 #else
 140
 141 struct umtx_q *umtxq_alloc(void);
 142 void umtxq_free(struct umtx_q *);
 143 struct thread;
 144 int kern_umtx_wake(struct thread *td, void *uaddr, int n_wake);
 145
 146 #endif /* !_KERNEL */
 147 #endif /* !_SYS_UMTX_H_ */