199767f8919635c4928607450d9e0abb932109ceToomas Soome/*-
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Copyright (c) 1997 Berkeley Software Design, Inc. All rights reserved.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Redistribution and use in source and binary forms, with or without
199767f8919635c4928607450d9e0abb932109ceToomas Soome * modification, are permitted provided that the following conditions
199767f8919635c4928607450d9e0abb932109ceToomas Soome * are met:
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 1. Redistributions of source code must retain the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome * notice, this list of conditions and the following disclaimer.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 2. Redistributions in binary form must reproduce the above copyright
199767f8919635c4928607450d9e0abb932109ceToomas Soome * notice, this list of conditions and the following disclaimer in the
199767f8919635c4928607450d9e0abb932109ceToomas Soome * documentation and/or other materials provided with the distribution.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * 3. Berkeley Software Design Inc's name may not be used to endorse or
199767f8919635c4928607450d9e0abb932109ceToomas Soome * promote products derived from this software without specific prior
199767f8919635c4928607450d9e0abb932109ceToomas Soome * written permission.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * ARE DISCLAIMED. IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
199767f8919635c4928607450d9e0abb932109ceToomas Soome * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
199767f8919635c4928607450d9e0abb932109ceToomas Soome * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
199767f8919635c4928607450d9e0abb932109ceToomas Soome * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
199767f8919635c4928607450d9e0abb932109ceToomas Soome * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
199767f8919635c4928607450d9e0abb932109ceToomas Soome * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
199767f8919635c4928607450d9e0abb932109ceToomas Soome * SUCH DAMAGE.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * $FreeBSD$
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#ifndef _SYS__MUTEX_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome#define _SYS__MUTEX_H_
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#include <machine/param.h>
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Sleep/spin mutex.
199767f8919635c4928607450d9e0abb932109ceToomas Soome *
199767f8919635c4928607450d9e0abb932109ceToomas Soome * All mutex implementations must always have a member called mtx_lock.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Other locking primitive structures are not allowed to use this name
199767f8919635c4928607450d9e0abb932109ceToomas Soome * for their members.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * If this rule needs to change, the bits in the mutex implementation must
199767f8919635c4928607450d9e0abb932109ceToomas Soome * be modified appropriately.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soomestruct mtx {
199767f8919635c4928607450d9e0abb932109ceToomas Soome struct lock_object lock_object; /* Common lock properties. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome volatile uintptr_t mtx_lock; /* Owner and flags. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome};
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome/*
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Members of struct mtx_padalign must mirror members of struct mtx.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * mtx_padalign mutexes can use the mtx(9) API transparently without
199767f8919635c4928607450d9e0abb932109ceToomas Soome * modification.
199767f8919635c4928607450d9e0abb932109ceToomas Soome * Pad-aligned mutexes used within structures should generally be the
199767f8919635c4928607450d9e0abb932109ceToomas Soome * first member of the struct. Otherwise, the compiler can generate
199767f8919635c4928607450d9e0abb932109ceToomas Soome * additional padding for the struct to keep a correct alignment for
199767f8919635c4928607450d9e0abb932109ceToomas Soome * the mutex.
199767f8919635c4928607450d9e0abb932109ceToomas Soome */
199767f8919635c4928607450d9e0abb932109ceToomas Soomestruct mtx_padalign {
199767f8919635c4928607450d9e0abb932109ceToomas Soome struct lock_object lock_object; /* Common lock properties. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome volatile uintptr_t mtx_lock; /* Owner and flags. */
199767f8919635c4928607450d9e0abb932109ceToomas Soome} __aligned(CACHE_LINE_SIZE);
199767f8919635c4928607450d9e0abb932109ceToomas Soome
199767f8919635c4928607450d9e0abb932109ceToomas Soome#endif /* !_SYS__MUTEX_H_ */