Home | History | Annotate | Line # | Download | only in linux
      1  1.17  riastrad /*	$NetBSD: mutex.h,v 1.17 2021/12/19 11:33:31 riastradh Exp $	*/
      2   1.2  riastrad 
      3   1.2  riastrad /*-
      4   1.2  riastrad  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5   1.2  riastrad  * All rights reserved.
      6   1.2  riastrad  *
      7   1.2  riastrad  * This code is derived from software contributed to The NetBSD Foundation
      8   1.2  riastrad  * by Taylor R. Campbell.
      9   1.2  riastrad  *
     10   1.2  riastrad  * Redistribution and use in source and binary forms, with or without
     11   1.2  riastrad  * modification, are permitted provided that the following conditions
     12   1.2  riastrad  * are met:
     13   1.2  riastrad  * 1. Redistributions of source code must retain the above copyright
     14   1.2  riastrad  *    notice, this list of conditions and the following disclaimer.
     15   1.2  riastrad  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.2  riastrad  *    notice, this list of conditions and the following disclaimer in the
     17   1.2  riastrad  *    documentation and/or other materials provided with the distribution.
     18   1.2  riastrad  *
     19   1.2  riastrad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20   1.2  riastrad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21   1.2  riastrad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22   1.2  riastrad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23   1.2  riastrad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24   1.2  riastrad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25   1.2  riastrad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26   1.2  riastrad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27   1.2  riastrad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28   1.2  riastrad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29   1.2  riastrad  * POSSIBILITY OF SUCH DAMAGE.
     30   1.2  riastrad  */
     31   1.2  riastrad 
     32   1.2  riastrad #ifndef _LINUX_MUTEX_H_
     33   1.2  riastrad #define _LINUX_MUTEX_H_
     34   1.2  riastrad 
     35   1.2  riastrad #include <sys/mutex.h>
     36   1.2  riastrad 
     37   1.3  riastrad #include <lib/libkern/libkern.h> /* KASSERT */
     38  1.12      maya 
     39  1.12      maya #include <asm/processor.h>
     40  1.12      maya 
     41   1.8  riastrad #include <linux/list.h>
     42  1.13  riastrad #include <linux/spinlock.h>
     43   1.3  riastrad 
     44   1.2  riastrad struct mutex {
     45   1.2  riastrad 	kmutex_t mtx_lock;
     46   1.2  riastrad };
     47   1.2  riastrad 
     48   1.5  riastrad struct lock_class_key {
     49   1.5  riastrad };
     50   1.5  riastrad 
     51   1.2  riastrad /* Name collision.  Pooh.  */
     52   1.2  riastrad static inline void
     53   1.2  riastrad linux_mutex_init(struct mutex *mutex)
     54   1.2  riastrad {
     55   1.2  riastrad 	mutex_init(&mutex->mtx_lock, MUTEX_DEFAULT, IPL_NONE);
     56   1.2  riastrad }
     57   1.2  riastrad 
     58   1.5  riastrad /* Lockdep stuff.  */
     59   1.5  riastrad static inline void
     60   1.5  riastrad __mutex_init(struct mutex *mutex, const char *name __unused,
     61   1.5  riastrad     struct lock_class_key *key __unused)
     62   1.5  riastrad {
     63   1.5  riastrad 	linux_mutex_init(mutex);
     64   1.5  riastrad }
     65   1.5  riastrad 
     66   1.2  riastrad /* Another name collision.  */
     67   1.2  riastrad static inline void
     68   1.2  riastrad linux_mutex_destroy(struct mutex *mutex)
     69   1.2  riastrad {
     70   1.2  riastrad 	mutex_destroy(&mutex->mtx_lock);
     71   1.2  riastrad }
     72   1.2  riastrad 
     73   1.2  riastrad static inline void
     74   1.2  riastrad mutex_lock(struct mutex *mutex)
     75   1.2  riastrad {
     76   1.2  riastrad 	mutex_enter(&mutex->mtx_lock);
     77   1.2  riastrad }
     78   1.2  riastrad 
     79   1.2  riastrad static inline int
     80   1.2  riastrad mutex_lock_interruptible(struct mutex *mutex)
     81   1.2  riastrad {
     82   1.2  riastrad 	mutex_enter(&mutex->mtx_lock); /* XXX */
     83   1.2  riastrad 	return 0;
     84   1.2  riastrad }
     85   1.2  riastrad 
     86   1.2  riastrad static inline int
     87   1.2  riastrad mutex_trylock(struct mutex *mutex)
     88   1.2  riastrad {
     89   1.2  riastrad 	return mutex_tryenter(&mutex->mtx_lock);
     90   1.2  riastrad }
     91   1.2  riastrad 
     92   1.2  riastrad static inline void
     93   1.2  riastrad mutex_unlock(struct mutex *mutex)
     94   1.2  riastrad {
     95   1.2  riastrad 	mutex_exit(&mutex->mtx_lock);
     96   1.2  riastrad }
     97   1.2  riastrad 
     98   1.2  riastrad static inline bool
     99   1.2  riastrad mutex_is_locked(struct mutex *mutex)
    100   1.2  riastrad {
    101   1.2  riastrad 	return mutex_owned(&mutex->mtx_lock);
    102   1.2  riastrad }
    103   1.2  riastrad 
    104   1.3  riastrad static inline void
    105   1.3  riastrad mutex_lock_nest_lock(struct mutex *mutex, struct mutex *already)
    106   1.3  riastrad {
    107   1.3  riastrad 
    108   1.3  riastrad 	KASSERT(mutex_is_locked(already));
    109   1.3  riastrad 	mutex_lock(mutex);
    110   1.3  riastrad }
    111   1.3  riastrad 
    112   1.6  riastrad static inline void
    113   1.6  riastrad mutex_lock_nested(struct mutex *mutex, unsigned subclass __unused)
    114   1.6  riastrad {
    115   1.6  riastrad 	mutex_lock(mutex);
    116   1.6  riastrad }
    117   1.6  riastrad 
    118  1.17  riastrad static inline int
    119  1.17  riastrad mutex_lock_interruptible_nested(struct mutex *mutex,
    120  1.17  riastrad     unsigned subclass __unused)
    121  1.17  riastrad {
    122  1.17  riastrad 	return mutex_lock_interruptible(mutex);
    123  1.17  riastrad }
    124  1.17  riastrad 
    125  1.16  riastrad /*
    126  1.16  riastrad  * `recursive locking is bad, do not use this ever.'
    127  1.16  riastrad  * -- linux/scripts/checkpath.pl
    128  1.16  riastrad  */
    129  1.16  riastrad static inline enum {
    130  1.16  riastrad 	MUTEX_TRYLOCK_FAILED,
    131  1.16  riastrad 	MUTEX_TRYLOCK_SUCCESS,
    132  1.16  riastrad 	MUTEX_TRYLOCK_RECURSIVE,
    133  1.16  riastrad }
    134  1.16  riastrad mutex_trylock_recursive(struct mutex *mutex)
    135  1.16  riastrad {
    136  1.16  riastrad 	if (mutex_owned(&mutex->mtx_lock))
    137  1.16  riastrad 		return MUTEX_TRYLOCK_RECURSIVE;
    138  1.16  riastrad 	else if (mutex_tryenter(&mutex->mtx_lock))
    139  1.16  riastrad 		return MUTEX_TRYLOCK_SUCCESS;
    140  1.16  riastrad 	else
    141  1.16  riastrad 		return MUTEX_TRYLOCK_FAILED;
    142  1.16  riastrad }
    143  1.16  riastrad 
    144   1.2  riastrad #endif  /* _LINUX_MUTEX_H_ */
    145