1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2002, Jeffrey Roberson <jeff@freebsd.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 */ 29 30#ifndef _SYS_UMTX_H_ 31#define _SYS_UMTX_H_ 32 33#include <sys/_umtx.h> 34 35#define UMTX_UNOWNED 0x0 36#define UMTX_CONTESTED LONG_MIN 37 38/* Common lock flags */ 39#define USYNC_PROCESS_SHARED 0x0001 /* Process shared sync objs */ 40 41/* umutex flags */ 42#define UMUTEX_PRIO_INHERIT 0x0004 /* Priority inherited mutex */ 43#define UMUTEX_PRIO_PROTECT 0x0008 /* Priority protect mutex */ 44#define UMUTEX_ROBUST 0x0010 /* Robust mutex */ 45#define UMUTEX_NONCONSISTENT 0x0020 /* Robust locked but not consistent */ 46 47/* 48 * The umutex.m_lock values and bits. The m_owner is the word which 49 * serves as the lock. Its high bit is the contention indicator and 50 * rest of bits records the owner TID. TIDs values start with PID_MAX 51 * + 2 and end by INT32_MAX. The low range [1..PID_MAX] is guaranteed 52 * to be useable as the special markers. 53 */ 54#define UMUTEX_UNOWNED 0x0 55#define UMUTEX_CONTESTED 0x80000000U 56#define UMUTEX_RB_OWNERDEAD (UMUTEX_CONTESTED | 0x10) 57#define UMUTEX_RB_NOTRECOV (UMUTEX_CONTESTED | 0x11) 58 59/* urwlock flags */ 60#define URWLOCK_PREFER_READER 0x0002 61 62#define URWLOCK_WRITE_OWNER 0x80000000U 63#define URWLOCK_WRITE_WAITERS 0x40000000U 64#define URWLOCK_READ_WAITERS 0x20000000U 65#define URWLOCK_MAX_READERS 0x1fffffffU 66#define URWLOCK_READER_COUNT(c) ((c) & URWLOCK_MAX_READERS) 67 68/* _usem flags */ 69#define SEM_NAMED 0x0002 70 71/* _usem2 count field */ 72#define USEM_HAS_WAITERS 0x80000000U 73#define USEM_MAX_COUNT 0x7fffffffU 74#define USEM_COUNT(c) ((c) & USEM_MAX_COUNT) 75 76/* op code for _umtx_op */ 77#define UMTX_OP_LOCK 0 /* COMPAT10 */ 78#define UMTX_OP_UNLOCK 1 /* COMPAT10 */ 79#define UMTX_OP_WAIT 2 80#define UMTX_OP_WAKE 3 81#define UMTX_OP_MUTEX_TRYLOCK 4 82#define UMTX_OP_MUTEX_LOCK 5 83#define UMTX_OP_MUTEX_UNLOCK 6 84#define UMTX_OP_SET_CEILING 7 85#define UMTX_OP_CV_WAIT 8 86#define UMTX_OP_CV_SIGNAL 9 87#define UMTX_OP_CV_BROADCAST 10 88#define UMTX_OP_WAIT_UINT 11 89#define UMTX_OP_RW_RDLOCK 12 90#define UMTX_OP_RW_WRLOCK 13 91#define UMTX_OP_RW_UNLOCK 14 92#define UMTX_OP_WAIT_UINT_PRIVATE 15 93#define UMTX_OP_WAKE_PRIVATE 16 94#define UMTX_OP_MUTEX_WAIT 17 95#define UMTX_OP_MUTEX_WAKE 18 /* deprecated */ 96#define UMTX_OP_SEM_WAIT 19 /* deprecated */ 97#define UMTX_OP_SEM_WAKE 20 /* deprecated */ 98#define UMTX_OP_NWAKE_PRIVATE 21 99#define UMTX_OP_MUTEX_WAKE2 22 100#define UMTX_OP_SEM2_WAIT 23 101#define UMTX_OP_SEM2_WAKE 24 102#define UMTX_OP_SHM 25 103#define UMTX_OP_ROBUST_LISTS 26 104#define UMTX_OP_GET_MIN_TIMEOUT 27 105#define UMTX_OP_SET_MIN_TIMEOUT 28 106 107/* 108 * Flags for ops; the double-underbar convention must be maintained for future 109 * additions for the sake of libsysdecode. 110 */ 111#define UMTX_OP__I386 0x40000000 112#define UMTX_OP__32BIT 0x80000000 113 114/* Flags for UMTX_OP_CV_WAIT */ 115#define CVWAIT_CHECK_UNPARKING 0x01 116#define CVWAIT_ABSTIME 0x02 117#define CVWAIT_CLOCKID 0x04 118 119#define UMTX_ABSTIME 0x01 120 121#define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING 122 123/* Flags for UMTX_OP_SHM */ 124#define UMTX_SHM_CREAT 0x0001 125#define UMTX_SHM_LOOKUP 0x0002 126#define UMTX_SHM_DESTROY 0x0004 127#define UMTX_SHM_ALIVE 0x0008 128 129struct umtx_robust_lists_params { 130 uintptr_t robust_list_offset; 131 uintptr_t robust_priv_list_offset; 132 uintptr_t robust_inact_offset; 133}; 134 135__BEGIN_DECLS 136 137int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2); 138int _umtx_op_err(void *obj, int op, u_long val, void *uaddr, void *uaddr2); 139 140__END_DECLS 141 142#endif /* !_SYS_UMTX_H_ */ 143