1/* 2 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* 29 * @OSF_COPYRIGHT@ 30 * 31 */ 32/* 33 * File: kern/sync_lock.h 34 * Author: Joseph CaraDonna 35 * 36 * Contains RT distributed lock synchronization service definitions. 37 */ 38 39#ifndef _KERN_SYNC_LOCK_H_ 40#define _KERN_SYNC_LOCK_H_ 41 42#include <mach/mach_types.h> 43 44#ifdef MACH_KERNEL_PRIVATE 45 46#include <kern/wait_queue.h> 47#include <kern/macro_help.h> 48#include <kern/queue.h> 49#include <kern/locks.h> 50 51typedef struct ulock { 52 queue_chain_t thread_link; /* ulocks owned by thread MUST BE FIRST */ 53 queue_chain_t held_link; /* ulocks held in the lock set */ 54 queue_chain_t handoff_link; /* ulocks w/ active handoffs */ 55 struct lock_set *lock_set; /* the retaining lock set */ 56 thread_t holder; /* thread that holds the lock */ 57 58 struct wait_queue wait_queue; /* queue of blocked threads */ 59 60 decl_lck_mtx_data(,lock) /* ulock lock */ 61 62 unsigned int /* flags */ 63 /* boolean_t */ blocked:1, /* did threads block waiting? */ 64 /* boolean_t */ unstable:1, /* unstable? (holder died) */ 65 /* boolean_t */ ho_wait:1, /* handoff thread waiting? */ 66 /* boolean_t */ accept_wait:1, /* accepting thread waiting? */ 67 :0; /* force to long boundary */ 68} Ulock; 69 70typedef struct ulock *ulock_t; 71 72typedef struct lock_set { 73 queue_chain_t task_link; /* lock sets owned by a task MUST BE FIRST */ 74 task_t owner; /* task that owns the lock set */ 75 ipc_port_t port; /* lock set port */ 76 decl_lck_mtx_data(,lock) /* lock set lock */ 77 uint32_t ref_count; /* reference count */ 78 79 boolean_t active; /* active status */ 80 int n_ulocks; /* number of ulocks in the lock set */ 81 82 struct ulock ulock_list[1]; /* ulock group list place holder */ 83} Lock_Set; 84 85#define ULOCK_NULL ((ulock_t) 0) 86 87#define ULOCK_FREE 0 88#define ULOCK_HELD 1 89 90extern lck_grp_t lock_set_grp; 91extern lck_attr_t lock_set_attr; 92 93/* 94 * Data structure internal lock macros 95 */ 96 97#define lock_set_lock_init(ls) lck_mtx_init(&(ls)->lock, &lock_set_grp, &lock_set_attr) 98#define lock_set_lock(ls) lck_mtx_lock(&(ls)->lock) 99#define lock_set_unlock(ls) lck_mtx_unlock(&(ls)->lock) 100 101#define ulock_lock_init(ul) lck_mtx_init(&(ul)->lock, &lock_set_grp, &lock_set_attr) 102#define ulock_lock(ul) lck_mtx_lock(&(ul)->lock) 103#define ulock_unlock(ul) lck_mtx_unlock(&(ul)->lock) 104 105extern void lock_set_init(void) __attribute__((section("__TEXT, initcode"))); 106 107extern kern_return_t ulock_release_internal( 108 ulock_t ulock, 109 thread_t thread); 110 111extern kern_return_t lock_make_unstable( 112 ulock_t ulock, 113 thread_t thread); 114 115extern void ulock_release_all( 116 thread_t thread); 117 118extern void lock_set_reference (lock_set_t lock_set); 119extern void lock_set_dereference (lock_set_t lock_set); 120 121#endif /* MACH_KERNEL_PRIVATE */ 122 123#endif /* _KERN_SYNC_LOCK_H_ */ 124