1 /*
2  * Copyright(c) 2016 Intel Corporation.
3  *
4  * This file is provided under a dual BSD/GPLv2 license.  When using or
5  * redistributing this file, you may do so under either license.
6  *
7  * GPL LICENSE SUMMARY
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * BSD LICENSE
19  *
20  * Redistribution and use in source and binary forms, with or without
21  * modification, are permitted provided that the following conditions
22  * are met:
23  *
24  *  - Redistributions of source code must retain the above copyright
25  *    notice, this list of conditions and the following disclaimer.
26  *  - Redistributions in binary form must reproduce the above copyright
27  *    notice, this list of conditions and the following disclaimer in
28  *    the documentation and/or other materials provided with the
29  *    distribution.
30  *  - Neither the name of Intel Corporation nor the names of its
31  *    contributors may be used to endorse or promote products derived
32  *    from this software without specific prior written permission.
33  *
34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45  *
46  */
47 #ifndef _HFI1_MMU_RB_H
48 #define _HFI1_MMU_RB_H
49 
50 #include "hfi.h"
51 
52 struct mmu_rb_node {
53 	unsigned long addr;
54 	unsigned long len;
55 	unsigned long __last;
56 	struct rb_node node;
57 	struct list_head list;
58 };
59 
60 /*
61  * NOTE: filter, insert, invalidate, and evict must not sleep.  Only remove is
62  * allowed to sleep.
63  */
64 struct mmu_rb_ops {
65 	bool (*filter)(struct mmu_rb_node *node, unsigned long addr,
66 		       unsigned long len);
67 	int (*insert)(void *ops_arg, struct mmu_rb_node *mnode);
68 	void (*remove)(void *ops_arg, struct mmu_rb_node *mnode);
69 	int (*invalidate)(void *ops_arg, struct mmu_rb_node *node);
70 	int (*evict)(void *ops_arg, struct mmu_rb_node *mnode,
71 		     void *evict_arg, bool *stop);
72 };
73 
74 int hfi1_mmu_rb_register(void *ops_arg, struct mm_struct *mm,
75 			 struct mmu_rb_ops *ops,
76 			 struct workqueue_struct *wq,
77 			 struct mmu_rb_handler **handler);
78 void hfi1_mmu_rb_unregister(struct mmu_rb_handler *handler);
79 int hfi1_mmu_rb_insert(struct mmu_rb_handler *handler,
80 		       struct mmu_rb_node *mnode);
81 void hfi1_mmu_rb_evict(struct mmu_rb_handler *handler, void *evict_arg);
82 void hfi1_mmu_rb_remove(struct mmu_rb_handler *handler,
83 			struct mmu_rb_node *mnode);
84 struct mmu_rb_node *hfi1_mmu_rb_extract(struct mmu_rb_handler *handler,
85 					unsigned long addr, unsigned long len);
86 
87 #endif /* _HFI1_MMU_RB_H */
88