xref: /freebsd/sys/compat/linuxkpi/common/include/linux/mm_types.h (revision b292c995cfa88cc73d5d77b6b94ae1b78296793f)
1 /*-
2  * Copyright (c) 2017 Mellanox Technologies, Ltd.
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 unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _LINUXKPI_LINUX_MM_TYPES_H_
28 #define	_LINUXKPI_LINUX_MM_TYPES_H_
29 
30 #include <linux/types.h>
31 #include <linux/page.h>
32 #include <linux/rbtree.h>
33 #include <linux/rwsem.h>
34 
35 #include <asm/atomic.h>
36 
37 typedef int vm_fault_t;
38 
39 struct vm_area_struct;
40 struct task_struct;
41 
42 struct mm_struct {
43 	struct vm_area_struct *mmap;
44 	atomic_t mm_count;
45 	atomic_t mm_users;
46 	size_t pinned_vm;
47 	/* Renamed to mmap_lock in v5.8 */
48 	struct rw_semaphore mmap_sem;
49 };
50 
51 extern void linux_mm_dtor(struct mm_struct *mm);
52 
53 static inline void
mmdrop(struct mm_struct * mm)54 mmdrop(struct mm_struct *mm)
55 {
56 	if (__predict_false(atomic_dec_and_test(&mm->mm_count)))
57 		linux_mm_dtor(mm);
58 }
59 
60 static inline bool
mmget_not_zero(struct mm_struct * mm)61 mmget_not_zero(struct mm_struct *mm)
62 {
63 	return (atomic_inc_not_zero(&mm->mm_users));
64 }
65 
66 static inline void
mmput(struct mm_struct * mm)67 mmput(struct mm_struct *mm)
68 {
69 	if (__predict_false(atomic_dec_and_test(&mm->mm_users)))
70 		mmdrop(mm);
71 }
72 
73 static inline void
mmgrab(struct mm_struct * mm)74 mmgrab(struct mm_struct *mm)
75 {
76 	atomic_inc(&mm->mm_count);
77 }
78 
79 extern struct mm_struct *linux_get_task_mm(struct task_struct *);
80 #define	get_task_mm(task) linux_get_task_mm(task)
81 
82 #endif					/* _LINUXKPI_LINUX_MM_TYPES_H_ */
83