osfmk/kern/sync_lock.h

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