1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_LOCAL_LOCK_H
3#define _LINUX_LOCAL_LOCK_H
4
5#include <linux/local_lock_internal.h>
6
7/**
8 * local_lock_init - Runtime initialize a lock instance
9 */
10#define local_lock_init(lock) __local_lock_init(lock)
11
12/**
13 * local_lock - Acquire a per CPU local lock
14 * @lock: The lock variable
15 */
16#define local_lock(lock) __local_lock(this_cpu_ptr(lock))
17
18/**
19 * local_lock_irq - Acquire a per CPU local lock and disable interrupts
20 * @lock: The lock variable
21 */
22#define local_lock_irq(lock) __local_lock_irq(this_cpu_ptr(lock))
23
24/**
25 * local_lock_irqsave - Acquire a per CPU local lock, save and disable
26 * interrupts
27 * @lock: The lock variable
28 * @flags: Storage for interrupt flags
29 */
30#define local_lock_irqsave(lock, flags) \
31 __local_lock_irqsave(this_cpu_ptr(lock), flags)
32
33/**
34 * local_unlock - Release a per CPU local lock
35 * @lock: The lock variable
36 */
37#define local_unlock(lock) __local_unlock(this_cpu_ptr(lock))
38
39/**
40 * local_unlock_irq - Release a per CPU local lock and enable interrupts
41 * @lock: The lock variable
42 */
43#define local_unlock_irq(lock) __local_unlock_irq(this_cpu_ptr(lock))
44
45/**
46 * local_unlock_irqrestore - Release a per CPU local lock and restore
47 * interrupt flags
48 * @lock: The lock variable
49 * @flags: Interrupt flags to restore
50 */
51#define local_unlock_irqrestore(lock, flags) \
52 __local_unlock_irqrestore(this_cpu_ptr(lock), flags)
53
54/**
55 * local_lock_init - Runtime initialize a lock instance
56 */
57#define local_trylock_init(lock) __local_trylock_init(lock)
58
59/**
60 * local_trylock - Try to acquire a per CPU local lock
61 * @lock: The lock variable
62 *
63 * The function can be used in any context such as NMI or HARDIRQ. Due to
64 * locking constrains it will _always_ fail to acquire the lock in NMI or
65 * HARDIRQ context on PREEMPT_RT.
66 */
67#define local_trylock(lock) __local_trylock(this_cpu_ptr(lock))
68
69#define local_lock_is_locked(lock) __local_lock_is_locked(lock)
70
71/**
72 * local_trylock_irqsave - Try to acquire a per CPU local lock, save and disable
73 * interrupts if acquired
74 * @lock: The lock variable
75 * @flags: Storage for interrupt flags
76 *
77 * The function can be used in any context such as NMI or HARDIRQ. Due to
78 * locking constrains it will _always_ fail to acquire the lock in NMI or
79 * HARDIRQ context on PREEMPT_RT.
80 */
81#define local_trylock_irqsave(lock, flags) \
82 __local_trylock_irqsave(this_cpu_ptr(lock), flags)
83
84DEFINE_GUARD(local_lock, local_lock_t __percpu*,
85 local_lock(_T),
86 local_unlock(_T))
87DEFINE_GUARD(local_lock_irq, local_lock_t __percpu*,
88 local_lock_irq(_T),
89 local_unlock_irq(_T))
90DEFINE_LOCK_GUARD_1(local_lock_irqsave, local_lock_t __percpu,
91 local_lock_irqsave(_T->lock, _T->flags),
92 local_unlock_irqrestore(_T->lock, _T->flags),
93 unsigned long flags)
94
95#define local_lock_nested_bh(_lock) \
96 __local_lock_nested_bh(this_cpu_ptr(_lock))
97
98#define local_unlock_nested_bh(_lock) \
99 __local_unlock_nested_bh(this_cpu_ptr(_lock))
100
101DEFINE_GUARD(local_lock_nested_bh, local_lock_t __percpu*,
102 local_lock_nested_bh(_T),
103 local_unlock_nested_bh(_T))
104
105#endif
106