blob: 2c146b44d95fc7e14a5705f2934142770f65f79b [file] [log] [blame]
James Bottomley61a7afa2005-08-16 18:27:34 -05001/*
James Bottomleyb1081ea2005-11-06 11:59:08 -06002 * raid_class.c - implementation of a simple raid visualisation class
3 *
4 * Copyright (c) 2005 - James Bottomley <James.Bottomley@steeleye.com>
5 *
6 * This file is licensed under GPLv2
7 *
8 * This class is designed to allow raid attributes to be visualised and
9 * manipulated in a form independent of the underlying raid. Ultimately this
10 * should work for both hardware and software raids.
James Bottomley61a7afa2005-08-16 18:27:34 -050011 */
12#include <linux/init.h>
13#include <linux/module.h>
14#include <linux/list.h>
Tim Schmielau8c65b4a2005-11-07 00:59:43 -080015#include <linux/slab.h>
16#include <linux/string.h>
James Bottomley61a7afa2005-08-16 18:27:34 -050017#include <linux/raid_class.h>
18#include <scsi/scsi_device.h>
19#include <scsi/scsi_host.h>
20
21#define RAID_NUM_ATTRS 3
22
23struct raid_internal {
24 struct raid_template r;
25 struct raid_function_template *f;
26 /* The actual attributes */
Tony Jonesee959b02008-02-22 00:13:36 +010027 struct device_attribute private_attrs[RAID_NUM_ATTRS];
James Bottomley61a7afa2005-08-16 18:27:34 -050028 /* The array of null terminated pointers to attributes
29 * needed by scsi_sysfs.c */
Tony Jonesee959b02008-02-22 00:13:36 +010030 struct device_attribute *attrs[RAID_NUM_ATTRS + 1];
James Bottomley61a7afa2005-08-16 18:27:34 -050031};
32
33struct raid_component {
34 struct list_head node;
Tony Jonesee959b02008-02-22 00:13:36 +010035 struct device dev;
James Bottomley61a7afa2005-08-16 18:27:34 -050036 int num;
37};
38
39#define to_raid_internal(tmpl) container_of(tmpl, struct raid_internal, r)
40
41#define tc_to_raid_internal(tcont) ({ \
42 struct raid_template *r = \
43 container_of(tcont, struct raid_template, raid_attrs); \
44 to_raid_internal(r); \
45})
46
47#define ac_to_raid_internal(acont) ({ \
48 struct transport_container *tc = \
49 container_of(acont, struct transport_container, ac); \
50 tc_to_raid_internal(tc); \
51})
52
Tony Jonesee959b02008-02-22 00:13:36 +010053#define device_to_raid_internal(dev) ({ \
James Bottomley61a7afa2005-08-16 18:27:34 -050054 struct attribute_container *ac = \
Tony Jonesee959b02008-02-22 00:13:36 +010055 attribute_container_classdev_to_container(dev); \
James Bottomley61a7afa2005-08-16 18:27:34 -050056 ac_to_raid_internal(ac); \
57})
58
59
60static int raid_match(struct attribute_container *cont, struct device *dev)
61{
62 /* We have to look for every subsystem that could house
63 * emulated RAID devices, so start with SCSI */
64 struct raid_internal *i = ac_to_raid_internal(cont);
65
James Bottomleyfac829f2010-03-03 11:06:56 +053066#if defined(CONFIG_SCSI) || defined(CONFIG_SCSI_MODULE)
James Bottomley61a7afa2005-08-16 18:27:34 -050067 if (scsi_is_sdev_device(dev)) {
68 struct scsi_device *sdev = to_scsi_device(dev);
69
70 if (i->f->cookie != sdev->host->hostt)
71 return 0;
72
73 return i->f->is_raid(dev);
74 }
James Bottomleyfac829f2010-03-03 11:06:56 +053075#endif
James Bottomley61a7afa2005-08-16 18:27:34 -050076 /* FIXME: look at other subsystems too */
77 return 0;
78}
79
80static int raid_setup(struct transport_container *tc, struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +010081 struct device *cdev)
James Bottomley61a7afa2005-08-16 18:27:34 -050082{
83 struct raid_data *rd;
84
Tony Jonesee959b02008-02-22 00:13:36 +010085 BUG_ON(dev_get_drvdata(cdev));
James Bottomley61a7afa2005-08-16 18:27:34 -050086
James Bottomleyb1081ea2005-11-06 11:59:08 -060087 rd = kzalloc(sizeof(*rd), GFP_KERNEL);
James Bottomley61a7afa2005-08-16 18:27:34 -050088 if (!rd)
89 return -ENOMEM;
90
James Bottomley61a7afa2005-08-16 18:27:34 -050091 INIT_LIST_HEAD(&rd->component_list);
Tony Jonesee959b02008-02-22 00:13:36 +010092 dev_set_drvdata(cdev, rd);
James Bottomley61a7afa2005-08-16 18:27:34 -050093
94 return 0;
95}
96
97static int raid_remove(struct transport_container *tc, struct device *dev,
Tony Jonesee959b02008-02-22 00:13:36 +010098 struct device *cdev)
James Bottomley61a7afa2005-08-16 18:27:34 -050099{
Tony Jonesee959b02008-02-22 00:13:36 +0100100 struct raid_data *rd = dev_get_drvdata(cdev);
James Bottomley61a7afa2005-08-16 18:27:34 -0500101 struct raid_component *rc, *next;
James Bottomleyb1081ea2005-11-06 11:59:08 -0600102 dev_printk(KERN_ERR, dev, "RAID REMOVE\n");
Tony Jonesee959b02008-02-22 00:13:36 +0100103 dev_set_drvdata(cdev, NULL);
James Bottomley61a7afa2005-08-16 18:27:34 -0500104 list_for_each_entry_safe(rc, next, &rd->component_list, node) {
James Bottomley61a7afa2005-08-16 18:27:34 -0500105 list_del(&rc->node);
Tony Jonesee959b02008-02-22 00:13:36 +0100106 dev_printk(KERN_ERR, rc->dev.parent, "RAID COMPONENT REMOVE\n");
107 device_unregister(&rc->dev);
James Bottomley61a7afa2005-08-16 18:27:34 -0500108 }
James Bottomleyb1081ea2005-11-06 11:59:08 -0600109 dev_printk(KERN_ERR, dev, "RAID REMOVE DONE\n");
110 kfree(rd);
James Bottomley61a7afa2005-08-16 18:27:34 -0500111 return 0;
112}
113
114static DECLARE_TRANSPORT_CLASS(raid_class,
115 "raid_devices",
116 raid_setup,
117 raid_remove,
118 NULL);
119
Arjan van de Ven0ad78202005-11-28 16:22:25 +0100120static const struct {
James Bottomley61a7afa2005-08-16 18:27:34 -0500121 enum raid_state value;
122 char *name;
123} raid_states[] = {
James Bottomleyb1081ea2005-11-06 11:59:08 -0600124 { RAID_STATE_UNKNOWN, "unknown" },
125 { RAID_STATE_ACTIVE, "active" },
126 { RAID_STATE_DEGRADED, "degraded" },
127 { RAID_STATE_RESYNCING, "resyncing" },
128 { RAID_STATE_OFFLINE, "offline" },
James Bottomley61a7afa2005-08-16 18:27:34 -0500129};
130
131static const char *raid_state_name(enum raid_state state)
132{
133 int i;
134 char *name = NULL;
135
Tobias Klauser6391a112006-06-08 22:23:48 -0700136 for (i = 0; i < ARRAY_SIZE(raid_states); i++) {
James Bottomley61a7afa2005-08-16 18:27:34 -0500137 if (raid_states[i].value == state) {
138 name = raid_states[i].name;
139 break;
140 }
141 }
142 return name;
143}
144
James Bottomleyb1081ea2005-11-06 11:59:08 -0600145static struct {
146 enum raid_level value;
147 char *name;
148} raid_levels[] = {
149 { RAID_LEVEL_UNKNOWN, "unknown" },
150 { RAID_LEVEL_LINEAR, "linear" },
151 { RAID_LEVEL_0, "raid0" },
152 { RAID_LEVEL_1, "raid1" },
Moore, Eric8e32ca42006-01-04 14:58:43 -0700153 { RAID_LEVEL_10, "raid10" },
Kashyap, Desai8e4a0cf2010-02-17 16:13:04 +0530154 { RAID_LEVEL_1E, "raid1e" },
James Bottomleyb1081ea2005-11-06 11:59:08 -0600155 { RAID_LEVEL_3, "raid3" },
156 { RAID_LEVEL_4, "raid4" },
157 { RAID_LEVEL_5, "raid5" },
Moore, Eric8e32ca42006-01-04 14:58:43 -0700158 { RAID_LEVEL_50, "raid50" },
James Bottomleyb1081ea2005-11-06 11:59:08 -0600159 { RAID_LEVEL_6, "raid6" },
160};
161
162static const char *raid_level_name(enum raid_level level)
163{
164 int i;
165 char *name = NULL;
166
Tobias Klauser6391a112006-06-08 22:23:48 -0700167 for (i = 0; i < ARRAY_SIZE(raid_levels); i++) {
James Bottomleyb1081ea2005-11-06 11:59:08 -0600168 if (raid_levels[i].value == level) {
169 name = raid_levels[i].name;
170 break;
171 }
172 }
173 return name;
174}
James Bottomley61a7afa2005-08-16 18:27:34 -0500175
176#define raid_attr_show_internal(attr, fmt, var, code) \
Tony Jonesee959b02008-02-22 00:13:36 +0100177static ssize_t raid_show_##attr(struct device *dev, \
178 struct device_attribute *attr, \
179 char *buf) \
James Bottomley61a7afa2005-08-16 18:27:34 -0500180{ \
Tony Jonesee959b02008-02-22 00:13:36 +0100181 struct raid_data *rd = dev_get_drvdata(dev); \
James Bottomley61a7afa2005-08-16 18:27:34 -0500182 code \
183 return snprintf(buf, 20, #fmt "\n", var); \
184}
185
186#define raid_attr_ro_states(attr, states, code) \
187raid_attr_show_internal(attr, %s, name, \
188 const char *name; \
189 code \
190 name = raid_##states##_name(rd->attr); \
191) \
Tony Jonesee959b02008-02-22 00:13:36 +0100192static DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL)
James Bottomley61a7afa2005-08-16 18:27:34 -0500193
194
195#define raid_attr_ro_internal(attr, code) \
196raid_attr_show_internal(attr, %d, rd->attr, code) \
Tony Jonesee959b02008-02-22 00:13:36 +0100197static DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL)
James Bottomley61a7afa2005-08-16 18:27:34 -0500198
199#define ATTR_CODE(attr) \
Tony Jonesee959b02008-02-22 00:13:36 +0100200 struct raid_internal *i = device_to_raid_internal(dev); \
James Bottomley61a7afa2005-08-16 18:27:34 -0500201 if (i->f->get_##attr) \
Tony Jonesee959b02008-02-22 00:13:36 +0100202 i->f->get_##attr(dev->parent);
James Bottomley61a7afa2005-08-16 18:27:34 -0500203
204#define raid_attr_ro(attr) raid_attr_ro_internal(attr, )
205#define raid_attr_ro_fn(attr) raid_attr_ro_internal(attr, ATTR_CODE(attr))
James Bottomleyb1081ea2005-11-06 11:59:08 -0600206#define raid_attr_ro_state(attr) raid_attr_ro_states(attr, attr, )
207#define raid_attr_ro_state_fn(attr) raid_attr_ro_states(attr, attr, ATTR_CODE(attr))
James Bottomley61a7afa2005-08-16 18:27:34 -0500208
James Bottomleyb1081ea2005-11-06 11:59:08 -0600209
210raid_attr_ro_state(level);
James Bottomley61a7afa2005-08-16 18:27:34 -0500211raid_attr_ro_fn(resync);
James Bottomleyb1081ea2005-11-06 11:59:08 -0600212raid_attr_ro_state_fn(state);
213
Tony Jonesee959b02008-02-22 00:13:36 +0100214static void raid_component_release(struct device *dev)
James Bottomleyb1081ea2005-11-06 11:59:08 -0600215{
Tony Jonesee959b02008-02-22 00:13:36 +0100216 struct raid_component *rc =
217 container_of(dev, struct raid_component, dev);
218 dev_printk(KERN_ERR, rc->dev.parent, "COMPONENT RELEASE\n");
219 put_device(rc->dev.parent);
James Bottomleyb1081ea2005-11-06 11:59:08 -0600220 kfree(rc);
221}
James Bottomley61a7afa2005-08-16 18:27:34 -0500222
Jeff Garziked542be2006-10-04 07:05:11 -0400223int raid_component_add(struct raid_template *r,struct device *raid_dev,
224 struct device *component_dev)
James Bottomley61a7afa2005-08-16 18:27:34 -0500225{
Tony Jonesee959b02008-02-22 00:13:36 +0100226 struct device *cdev =
James Bottomley61a7afa2005-08-16 18:27:34 -0500227 attribute_container_find_class_device(&r->raid_attrs.ac,
228 raid_dev);
229 struct raid_component *rc;
Tony Jonesee959b02008-02-22 00:13:36 +0100230 struct raid_data *rd = dev_get_drvdata(cdev);
Jeff Garziked542be2006-10-04 07:05:11 -0400231 int err;
James Bottomley61a7afa2005-08-16 18:27:34 -0500232
James Bottomleyb1081ea2005-11-06 11:59:08 -0600233 rc = kzalloc(sizeof(*rc), GFP_KERNEL);
James Bottomley61a7afa2005-08-16 18:27:34 -0500234 if (!rc)
Jeff Garziked542be2006-10-04 07:05:11 -0400235 return -ENOMEM;
James Bottomley61a7afa2005-08-16 18:27:34 -0500236
237 INIT_LIST_HEAD(&rc->node);
Tony Jonesee959b02008-02-22 00:13:36 +0100238 device_initialize(&rc->dev);
239 rc->dev.release = raid_component_release;
240 rc->dev.parent = get_device(component_dev);
James Bottomley61a7afa2005-08-16 18:27:34 -0500241 rc->num = rd->component_count++;
242
Kay Sievers71610f52008-12-03 22:41:36 +0100243 dev_set_name(&rc->dev, "component-%d", rc->num);
James Bottomley61a7afa2005-08-16 18:27:34 -0500244 list_add_tail(&rc->node, &rd->component_list);
Tony Jonesee959b02008-02-22 00:13:36 +0100245 rc->dev.class = &raid_class.class;
246 err = device_add(&rc->dev);
Jeff Garziked542be2006-10-04 07:05:11 -0400247 if (err)
248 goto err_out;
249
250 return 0;
251
252err_out:
253 list_del(&rc->node);
254 rd->component_count--;
255 put_device(component_dev);
256 kfree(rc);
257 return err;
James Bottomley61a7afa2005-08-16 18:27:34 -0500258}
259EXPORT_SYMBOL(raid_component_add);
260
261struct raid_template *
262raid_class_attach(struct raid_function_template *ft)
263{
James Bottomleyb1081ea2005-11-06 11:59:08 -0600264 struct raid_internal *i = kzalloc(sizeof(struct raid_internal),
James Bottomley61a7afa2005-08-16 18:27:34 -0500265 GFP_KERNEL);
266 int count = 0;
267
268 if (unlikely(!i))
269 return NULL;
270
James Bottomley61a7afa2005-08-16 18:27:34 -0500271 i->f = ft;
272
273 i->r.raid_attrs.ac.class = &raid_class.class;
274 i->r.raid_attrs.ac.match = raid_match;
275 i->r.raid_attrs.ac.attrs = &i->attrs[0];
276
277 attribute_container_register(&i->r.raid_attrs.ac);
278
Tony Jonesee959b02008-02-22 00:13:36 +0100279 i->attrs[count++] = &dev_attr_level;
280 i->attrs[count++] = &dev_attr_resync;
281 i->attrs[count++] = &dev_attr_state;
James Bottomley61a7afa2005-08-16 18:27:34 -0500282
283 i->attrs[count] = NULL;
284 BUG_ON(count > RAID_NUM_ATTRS);
285
286 return &i->r;
287}
288EXPORT_SYMBOL(raid_class_attach);
289
290void
291raid_class_release(struct raid_template *r)
292{
293 struct raid_internal *i = to_raid_internal(r);
294
James Bottomley2f3edc62008-04-02 10:05:48 -0500295 BUG_ON(attribute_container_unregister(&i->r.raid_attrs.ac));
James Bottomley61a7afa2005-08-16 18:27:34 -0500296
297 kfree(i);
298}
299EXPORT_SYMBOL(raid_class_release);
300
301static __init int raid_init(void)
302{
303 return transport_class_register(&raid_class);
304}
305
306static __exit void raid_exit(void)
307{
308 transport_class_unregister(&raid_class);
309}
310
311MODULE_AUTHOR("James Bottomley");
312MODULE_DESCRIPTION("RAID device class");
313MODULE_LICENSE("GPL");
314
315module_init(raid_init);
316module_exit(raid_exit);
317