sys/sys/_rwlock.h

   1 /*-
   2  * Copyright (c) 2006 John Baldwin <jhb@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, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the author nor the names of any co-contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS__RWLOCK_H_
  33 #define _SYS__RWLOCK_H_
  34
  35 #include <machine/param.h>
  36
  37 /*
  38  * Reader/writer lock.
  39  *
  40  * All reader/writer lock implementations must always have a member
  41  * called rw_lock.  Other locking primitive structures are not allowed to
  42  * use this name for their members.
  43  * If this rule needs to change, the bits in the reader/writer lock
  44  * implementation must be modified appropriately.
  45  */
  46 struct rwlock {
  47         struct lock_object      lock_object;
  48         volatile uintptr_t      rw_lock;
  49 };
  50
  51 /*
  52  * Members of struct rwlock_padalign must mirror members of struct rwlock.
  53  * rwlock_padalign rwlocks can use the rwlock(9) API transparently without
  54  * modification.
  55  * Pad-aligned rwlocks used within structures should generally be the
  56  * first member of the struct.  Otherwise, the compiler can generate
  57  * additional padding for the struct to keep a correct alignment for
  58  * the rwlock.
  59  */
  60 struct rwlock_padalign {
  61         struct lock_object      lock_object;
  62         volatile uintptr_t      rw_lock;
  63 } __aligned(CACHE_LINE_SIZE);
  64
  65 #endif /* !_SYS__RWLOCK_H_ */