xref: /OK3568_Linux_fs/kernel/include/linux/parman.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * include/linux/parman.h - Manager for linear priority array areas
3*4882a593Smuzhiyun  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
4*4882a593Smuzhiyun  * Copyright (c) 2017 Jiri Pirko <jiri@mellanox.com>
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Redistribution and use in source and binary forms, with or without
7*4882a593Smuzhiyun  * modification, are permitted provided that the following conditions are met:
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * 1. Redistributions of source code must retain the above copyright
10*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer.
11*4882a593Smuzhiyun  * 2. Redistributions in binary form must reproduce the above copyright
12*4882a593Smuzhiyun  *    notice, this list of conditions and the following disclaimer in the
13*4882a593Smuzhiyun  *    documentation and/or other materials provided with the distribution.
14*4882a593Smuzhiyun  * 3. Neither the names of the copyright holders nor the names of its
15*4882a593Smuzhiyun  *    contributors may be used to endorse or promote products derived from
16*4882a593Smuzhiyun  *    this software without specific prior written permission.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  * Alternatively, this software may be distributed under the terms of the
19*4882a593Smuzhiyun  * GNU General Public License ("GPL") version 2 as published by the Free
20*4882a593Smuzhiyun  * Software Foundation.
21*4882a593Smuzhiyun  *
22*4882a593Smuzhiyun  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23*4882a593Smuzhiyun  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24*4882a593Smuzhiyun  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25*4882a593Smuzhiyun  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26*4882a593Smuzhiyun  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27*4882a593Smuzhiyun  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28*4882a593Smuzhiyun  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29*4882a593Smuzhiyun  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30*4882a593Smuzhiyun  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31*4882a593Smuzhiyun  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32*4882a593Smuzhiyun  * POSSIBILITY OF SUCH DAMAGE.
33*4882a593Smuzhiyun  */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #ifndef _PARMAN_H
36*4882a593Smuzhiyun #define _PARMAN_H
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #include <linux/list.h>
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun enum parman_algo_type {
41*4882a593Smuzhiyun 	PARMAN_ALGO_TYPE_LSORT,
42*4882a593Smuzhiyun };
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun struct parman_item {
45*4882a593Smuzhiyun 	struct list_head list;
46*4882a593Smuzhiyun 	unsigned long index;
47*4882a593Smuzhiyun };
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun struct parman_prio {
50*4882a593Smuzhiyun 	struct list_head list;
51*4882a593Smuzhiyun 	struct list_head item_list;
52*4882a593Smuzhiyun 	unsigned long priority;
53*4882a593Smuzhiyun };
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun struct parman_ops {
56*4882a593Smuzhiyun 	unsigned long base_count;
57*4882a593Smuzhiyun 	unsigned long resize_step;
58*4882a593Smuzhiyun 	int (*resize)(void *priv, unsigned long new_count);
59*4882a593Smuzhiyun 	void (*move)(void *priv, unsigned long from_index,
60*4882a593Smuzhiyun 		     unsigned long to_index, unsigned long count);
61*4882a593Smuzhiyun 	enum parman_algo_type algo;
62*4882a593Smuzhiyun };
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun struct parman;
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun struct parman *parman_create(const struct parman_ops *ops, void *priv);
67*4882a593Smuzhiyun void parman_destroy(struct parman *parman);
68*4882a593Smuzhiyun void parman_prio_init(struct parman *parman, struct parman_prio *prio,
69*4882a593Smuzhiyun 		      unsigned long priority);
70*4882a593Smuzhiyun void parman_prio_fini(struct parman_prio *prio);
71*4882a593Smuzhiyun int parman_item_add(struct parman *parman, struct parman_prio *prio,
72*4882a593Smuzhiyun 		    struct parman_item *item);
73*4882a593Smuzhiyun void parman_item_remove(struct parman *parman, struct parman_prio *prio,
74*4882a593Smuzhiyun 			struct parman_item *item);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun #endif
77