xref: /OK3568_Linux_fs/kernel/drivers/md/dm-cache-policy.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (C) 2012 Red Hat. All rights reserved.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * This file is released under the GPL.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include "dm-cache-policy-internal.h"
8*4882a593Smuzhiyun #include "dm.h"
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun #include <linux/module.h>
11*4882a593Smuzhiyun #include <linux/slab.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /*----------------------------------------------------------------*/
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun #define DM_MSG_PREFIX "cache-policy"
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun static DEFINE_SPINLOCK(register_lock);
18*4882a593Smuzhiyun static LIST_HEAD(register_list);
19*4882a593Smuzhiyun 
__find_policy(const char * name)20*4882a593Smuzhiyun static struct dm_cache_policy_type *__find_policy(const char *name)
21*4882a593Smuzhiyun {
22*4882a593Smuzhiyun 	struct dm_cache_policy_type *t;
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun 	list_for_each_entry(t, &register_list, list)
25*4882a593Smuzhiyun 		if (!strcmp(t->name, name))
26*4882a593Smuzhiyun 			return t;
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun 	return NULL;
29*4882a593Smuzhiyun }
30*4882a593Smuzhiyun 
__get_policy_once(const char * name)31*4882a593Smuzhiyun static struct dm_cache_policy_type *__get_policy_once(const char *name)
32*4882a593Smuzhiyun {
33*4882a593Smuzhiyun 	struct dm_cache_policy_type *t = __find_policy(name);
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 	if (t && !try_module_get(t->owner)) {
36*4882a593Smuzhiyun 		DMWARN("couldn't get module %s", name);
37*4882a593Smuzhiyun 		t = ERR_PTR(-EINVAL);
38*4882a593Smuzhiyun 	}
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	return t;
41*4882a593Smuzhiyun }
42*4882a593Smuzhiyun 
get_policy_once(const char * name)43*4882a593Smuzhiyun static struct dm_cache_policy_type *get_policy_once(const char *name)
44*4882a593Smuzhiyun {
45*4882a593Smuzhiyun 	struct dm_cache_policy_type *t;
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	spin_lock(&register_lock);
48*4882a593Smuzhiyun 	t = __get_policy_once(name);
49*4882a593Smuzhiyun 	spin_unlock(&register_lock);
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 	return t;
52*4882a593Smuzhiyun }
53*4882a593Smuzhiyun 
get_policy(const char * name)54*4882a593Smuzhiyun static struct dm_cache_policy_type *get_policy(const char *name)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun 	struct dm_cache_policy_type *t;
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 	t = get_policy_once(name);
59*4882a593Smuzhiyun 	if (IS_ERR(t))
60*4882a593Smuzhiyun 		return NULL;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	if (t)
63*4882a593Smuzhiyun 		return t;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	request_module("dm-cache-%s", name);
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	t = get_policy_once(name);
68*4882a593Smuzhiyun 	if (IS_ERR(t))
69*4882a593Smuzhiyun 		return NULL;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 	return t;
72*4882a593Smuzhiyun }
73*4882a593Smuzhiyun 
put_policy(struct dm_cache_policy_type * t)74*4882a593Smuzhiyun static void put_policy(struct dm_cache_policy_type *t)
75*4882a593Smuzhiyun {
76*4882a593Smuzhiyun 	module_put(t->owner);
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun 
dm_cache_policy_register(struct dm_cache_policy_type * type)79*4882a593Smuzhiyun int dm_cache_policy_register(struct dm_cache_policy_type *type)
80*4882a593Smuzhiyun {
81*4882a593Smuzhiyun 	int r;
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	/* One size fits all for now */
84*4882a593Smuzhiyun 	if (type->hint_size != 0 && type->hint_size != 4) {
85*4882a593Smuzhiyun 		DMWARN("hint size must be 0 or 4 but %llu supplied.", (unsigned long long) type->hint_size);
86*4882a593Smuzhiyun 		return -EINVAL;
87*4882a593Smuzhiyun 	}
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	spin_lock(&register_lock);
90*4882a593Smuzhiyun 	if (__find_policy(type->name)) {
91*4882a593Smuzhiyun 		DMWARN("attempt to register policy under duplicate name %s", type->name);
92*4882a593Smuzhiyun 		r = -EINVAL;
93*4882a593Smuzhiyun 	} else {
94*4882a593Smuzhiyun 		list_add(&type->list, &register_list);
95*4882a593Smuzhiyun 		r = 0;
96*4882a593Smuzhiyun 	}
97*4882a593Smuzhiyun 	spin_unlock(&register_lock);
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	return r;
100*4882a593Smuzhiyun }
101*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_register);
102*4882a593Smuzhiyun 
dm_cache_policy_unregister(struct dm_cache_policy_type * type)103*4882a593Smuzhiyun void dm_cache_policy_unregister(struct dm_cache_policy_type *type)
104*4882a593Smuzhiyun {
105*4882a593Smuzhiyun 	spin_lock(&register_lock);
106*4882a593Smuzhiyun 	list_del_init(&type->list);
107*4882a593Smuzhiyun 	spin_unlock(&register_lock);
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_unregister);
110*4882a593Smuzhiyun 
dm_cache_policy_create(const char * name,dm_cblock_t cache_size,sector_t origin_size,sector_t cache_block_size)111*4882a593Smuzhiyun struct dm_cache_policy *dm_cache_policy_create(const char *name,
112*4882a593Smuzhiyun 					       dm_cblock_t cache_size,
113*4882a593Smuzhiyun 					       sector_t origin_size,
114*4882a593Smuzhiyun 					       sector_t cache_block_size)
115*4882a593Smuzhiyun {
116*4882a593Smuzhiyun 	struct dm_cache_policy *p = NULL;
117*4882a593Smuzhiyun 	struct dm_cache_policy_type *type;
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun 	type = get_policy(name);
120*4882a593Smuzhiyun 	if (!type) {
121*4882a593Smuzhiyun 		DMWARN("unknown policy type");
122*4882a593Smuzhiyun 		return ERR_PTR(-EINVAL);
123*4882a593Smuzhiyun 	}
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	p = type->create(cache_size, origin_size, cache_block_size);
126*4882a593Smuzhiyun 	if (!p) {
127*4882a593Smuzhiyun 		put_policy(type);
128*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
129*4882a593Smuzhiyun 	}
130*4882a593Smuzhiyun 	p->private = type;
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 	return p;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_create);
135*4882a593Smuzhiyun 
dm_cache_policy_destroy(struct dm_cache_policy * p)136*4882a593Smuzhiyun void dm_cache_policy_destroy(struct dm_cache_policy *p)
137*4882a593Smuzhiyun {
138*4882a593Smuzhiyun 	struct dm_cache_policy_type *t = p->private;
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	p->destroy(p);
141*4882a593Smuzhiyun 	put_policy(t);
142*4882a593Smuzhiyun }
143*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_destroy);
144*4882a593Smuzhiyun 
dm_cache_policy_get_name(struct dm_cache_policy * p)145*4882a593Smuzhiyun const char *dm_cache_policy_get_name(struct dm_cache_policy *p)
146*4882a593Smuzhiyun {
147*4882a593Smuzhiyun 	struct dm_cache_policy_type *t = p->private;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	/* if t->real is set then an alias was used (e.g. "default") */
150*4882a593Smuzhiyun 	if (t->real)
151*4882a593Smuzhiyun 		return t->real->name;
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	return t->name;
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_get_name);
156*4882a593Smuzhiyun 
dm_cache_policy_get_version(struct dm_cache_policy * p)157*4882a593Smuzhiyun const unsigned *dm_cache_policy_get_version(struct dm_cache_policy *p)
158*4882a593Smuzhiyun {
159*4882a593Smuzhiyun 	struct dm_cache_policy_type *t = p->private;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	return t->version;
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_get_version);
164*4882a593Smuzhiyun 
dm_cache_policy_get_hint_size(struct dm_cache_policy * p)165*4882a593Smuzhiyun size_t dm_cache_policy_get_hint_size(struct dm_cache_policy *p)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun 	struct dm_cache_policy_type *t = p->private;
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	return t->hint_size;
170*4882a593Smuzhiyun }
171*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(dm_cache_policy_get_hint_size);
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun /*----------------------------------------------------------------*/
174