osfmk/i386/simple_lock.h

   1 /*
   2  * Copyright (c) 2000 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  * Mach Operating System
  35  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  36  * All Rights Reserved.
  37  *
  38  * Permission to use, copy, modify and distribute this software and its
  39  * documentation is hereby granted, provided that both the copyright
  40  * notice and this permission notice appear in all copies of the
  41  * software, derivative works or modified versions, and any portions
  42  * thereof, and that both notices appear in supporting documentation.
  43  *
  44  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  45  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  46  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  47  *
  48  * Carnegie Mellon requests users of this software to return to
  49  *
  50  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  51  *  School of Computer Science
  52  *  Carnegie Mellon University
  53  *  Pittsburgh PA 15213-3890
  54  *
  55  * any improvements or extensions that they make and grant Carnegie Mellon
  56  * the rights to redistribute these changes.
  57  */
  58 /*
  59  *      File:   kern/simple_lock_types.h
  60  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  61  *      Date:   1985
  62  *
  63  *      Simple lock data type definitions
  64  */
  65 #ifdef  KERNEL_PRIVATE
  66
  67 #ifndef _I386_SIMPLE_LOCK_TYPES_H_
  68 #define _I386_SIMPLE_LOCK_TYPES_H_
  69
  70 #include <mach/boolean.h>
  71 #include <kern/kern_types.h>
  72
  73 #include <sys/appleapiopts.h>
  74 #if defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE)
  75 #include <i386/hw_lock_types.h>
  76 #include <mach_ldebug.h>
  77 #endif
  78
  79 #if defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE)
  80
  81 #if     MACH_LDEBUG
  82 #define USLOCK_DEBUG 1
  83 #else
  84 #define USLOCK_DEBUG 0
  85 #endif  /* USLOCK_DEBUG */
  86
  87 typedef struct uslock_debug {
  88         void                    *lock_pc;       /* pc where lock operation began    */
  89         void                    *lock_thread;   /* thread that acquired lock */
  90         unsigned long   duration[2];
  91         unsigned short  state;
  92         unsigned char   lock_cpu;
  93         void                    *unlock_thread; /* last thread to release lock */
  94         unsigned char   unlock_cpu;
  95         void                    *unlock_pc;     /* pc where lock operation ended    */
  96 } uslock_debug;
  97
  98 typedef struct slock {
  99         hw_lock_data_t  interlock;      /* must be first... see lock.c */
 100         unsigned short  lock_type;      /* must be second... see lock.c */
 101 #define USLOCK_TAG      0x5353
 102         uslock_debug    debug;
 103 } usimple_lock_data_t, *usimple_lock_t;
 104
 105 #else
 106
 107 typedef struct slock {
 108         unsigned int    lock_data[10];
 109 } usimple_lock_data_t, *usimple_lock_t;
 110
 111 #endif  /* defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE) */
 112
 113 #define USIMPLE_LOCK_NULL       ((usimple_lock_t) 0)
 114
 115 #if !defined(decl_simple_lock_data)
 116 typedef usimple_lock_data_t     *simple_lock_t;
 117 typedef usimple_lock_data_t     simple_lock_data_t;
 118
 119 #define decl_simple_lock_data(class,name) \
 120         class   simple_lock_data_t      name;
 121
 122 #endif  /* !defined(decl_simple_lock_data) */
 123
 124 #endif /* !_I386_SIMPLE_LOCK_TYPES_H_ */
 125
 126 #endif  /* KERNEL_PRIVATE */