James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 1 | /* |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 2 | * 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 Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 11 | */ |
| 12 | #include <linux/init.h> |
| 13 | #include <linux/module.h> |
| 14 | #include <linux/list.h> |
Tim Schmielau | 8c65b4a | 2005-11-07 00:59:43 -0800 | [diff] [blame] | 15 | #include <linux/slab.h> |
| 16 | #include <linux/string.h> |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 17 | #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 | |
| 23 | struct raid_internal { |
| 24 | struct raid_template r; |
| 25 | struct raid_function_template *f; |
| 26 | /* The actual attributes */ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 27 | struct device_attribute private_attrs[RAID_NUM_ATTRS]; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 28 | /* The array of null terminated pointers to attributes |
| 29 | * needed by scsi_sysfs.c */ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 30 | struct device_attribute *attrs[RAID_NUM_ATTRS + 1]; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 31 | }; |
| 32 | |
| 33 | struct raid_component { |
| 34 | struct list_head node; |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 35 | struct device dev; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 36 | 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 Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 53 | #define device_to_raid_internal(dev) ({ \ |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 54 | struct attribute_container *ac = \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 55 | attribute_container_classdev_to_container(dev); \ |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 56 | ac_to_raid_internal(ac); \ |
| 57 | }) |
| 58 | |
| 59 | |
| 60 | static 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 | |
| 66 | if (scsi_is_sdev_device(dev)) { |
| 67 | struct scsi_device *sdev = to_scsi_device(dev); |
| 68 | |
| 69 | if (i->f->cookie != sdev->host->hostt) |
| 70 | return 0; |
| 71 | |
| 72 | return i->f->is_raid(dev); |
| 73 | } |
| 74 | /* FIXME: look at other subsystems too */ |
| 75 | return 0; |
| 76 | } |
| 77 | |
| 78 | static int raid_setup(struct transport_container *tc, struct device *dev, |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 79 | struct device *cdev) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 80 | { |
| 81 | struct raid_data *rd; |
| 82 | |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 83 | BUG_ON(dev_get_drvdata(cdev)); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 84 | |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 85 | rd = kzalloc(sizeof(*rd), GFP_KERNEL); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 86 | if (!rd) |
| 87 | return -ENOMEM; |
| 88 | |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 89 | INIT_LIST_HEAD(&rd->component_list); |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 90 | dev_set_drvdata(cdev, rd); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 91 | |
| 92 | return 0; |
| 93 | } |
| 94 | |
| 95 | static int raid_remove(struct transport_container *tc, struct device *dev, |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 96 | struct device *cdev) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 97 | { |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 98 | struct raid_data *rd = dev_get_drvdata(cdev); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 99 | struct raid_component *rc, *next; |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 100 | dev_printk(KERN_ERR, dev, "RAID REMOVE\n"); |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 101 | dev_set_drvdata(cdev, NULL); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 102 | list_for_each_entry_safe(rc, next, &rd->component_list, node) { |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 103 | list_del(&rc->node); |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 104 | dev_printk(KERN_ERR, rc->dev.parent, "RAID COMPONENT REMOVE\n"); |
| 105 | device_unregister(&rc->dev); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 106 | } |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 107 | dev_printk(KERN_ERR, dev, "RAID REMOVE DONE\n"); |
| 108 | kfree(rd); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 109 | return 0; |
| 110 | } |
| 111 | |
| 112 | static DECLARE_TRANSPORT_CLASS(raid_class, |
| 113 | "raid_devices", |
| 114 | raid_setup, |
| 115 | raid_remove, |
| 116 | NULL); |
| 117 | |
Arjan van de Ven | 0ad7820 | 2005-11-28 16:22:25 +0100 | [diff] [blame] | 118 | static const struct { |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 119 | enum raid_state value; |
| 120 | char *name; |
| 121 | } raid_states[] = { |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 122 | { RAID_STATE_UNKNOWN, "unknown" }, |
| 123 | { RAID_STATE_ACTIVE, "active" }, |
| 124 | { RAID_STATE_DEGRADED, "degraded" }, |
| 125 | { RAID_STATE_RESYNCING, "resyncing" }, |
| 126 | { RAID_STATE_OFFLINE, "offline" }, |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 127 | }; |
| 128 | |
| 129 | static const char *raid_state_name(enum raid_state state) |
| 130 | { |
| 131 | int i; |
| 132 | char *name = NULL; |
| 133 | |
Tobias Klauser | 6391a11 | 2006-06-08 22:23:48 -0700 | [diff] [blame] | 134 | for (i = 0; i < ARRAY_SIZE(raid_states); i++) { |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 135 | if (raid_states[i].value == state) { |
| 136 | name = raid_states[i].name; |
| 137 | break; |
| 138 | } |
| 139 | } |
| 140 | return name; |
| 141 | } |
| 142 | |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 143 | static struct { |
| 144 | enum raid_level value; |
| 145 | char *name; |
| 146 | } raid_levels[] = { |
| 147 | { RAID_LEVEL_UNKNOWN, "unknown" }, |
| 148 | { RAID_LEVEL_LINEAR, "linear" }, |
| 149 | { RAID_LEVEL_0, "raid0" }, |
| 150 | { RAID_LEVEL_1, "raid1" }, |
Moore, Eric | 8e32ca4 | 2006-01-04 14:58:43 -0700 | [diff] [blame] | 151 | { RAID_LEVEL_10, "raid10" }, |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 152 | { RAID_LEVEL_3, "raid3" }, |
| 153 | { RAID_LEVEL_4, "raid4" }, |
| 154 | { RAID_LEVEL_5, "raid5" }, |
Moore, Eric | 8e32ca4 | 2006-01-04 14:58:43 -0700 | [diff] [blame] | 155 | { RAID_LEVEL_50, "raid50" }, |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 156 | { RAID_LEVEL_6, "raid6" }, |
| 157 | }; |
| 158 | |
| 159 | static const char *raid_level_name(enum raid_level level) |
| 160 | { |
| 161 | int i; |
| 162 | char *name = NULL; |
| 163 | |
Tobias Klauser | 6391a11 | 2006-06-08 22:23:48 -0700 | [diff] [blame] | 164 | for (i = 0; i < ARRAY_SIZE(raid_levels); i++) { |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 165 | if (raid_levels[i].value == level) { |
| 166 | name = raid_levels[i].name; |
| 167 | break; |
| 168 | } |
| 169 | } |
| 170 | return name; |
| 171 | } |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 172 | |
| 173 | #define raid_attr_show_internal(attr, fmt, var, code) \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 174 | static ssize_t raid_show_##attr(struct device *dev, \ |
| 175 | struct device_attribute *attr, \ |
| 176 | char *buf) \ |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 177 | { \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 178 | struct raid_data *rd = dev_get_drvdata(dev); \ |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 179 | code \ |
| 180 | return snprintf(buf, 20, #fmt "\n", var); \ |
| 181 | } |
| 182 | |
| 183 | #define raid_attr_ro_states(attr, states, code) \ |
| 184 | raid_attr_show_internal(attr, %s, name, \ |
| 185 | const char *name; \ |
| 186 | code \ |
| 187 | name = raid_##states##_name(rd->attr); \ |
| 188 | ) \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 189 | static DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 190 | |
| 191 | |
| 192 | #define raid_attr_ro_internal(attr, code) \ |
| 193 | raid_attr_show_internal(attr, %d, rd->attr, code) \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 194 | static DEVICE_ATTR(attr, S_IRUGO, raid_show_##attr, NULL) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 195 | |
| 196 | #define ATTR_CODE(attr) \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 197 | struct raid_internal *i = device_to_raid_internal(dev); \ |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 198 | if (i->f->get_##attr) \ |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 199 | i->f->get_##attr(dev->parent); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 200 | |
| 201 | #define raid_attr_ro(attr) raid_attr_ro_internal(attr, ) |
| 202 | #define raid_attr_ro_fn(attr) raid_attr_ro_internal(attr, ATTR_CODE(attr)) |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 203 | #define raid_attr_ro_state(attr) raid_attr_ro_states(attr, attr, ) |
| 204 | #define raid_attr_ro_state_fn(attr) raid_attr_ro_states(attr, attr, ATTR_CODE(attr)) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 205 | |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 206 | |
| 207 | raid_attr_ro_state(level); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 208 | raid_attr_ro_fn(resync); |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 209 | raid_attr_ro_state_fn(state); |
| 210 | |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 211 | static void raid_component_release(struct device *dev) |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 212 | { |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 213 | struct raid_component *rc = |
| 214 | container_of(dev, struct raid_component, dev); |
| 215 | dev_printk(KERN_ERR, rc->dev.parent, "COMPONENT RELEASE\n"); |
| 216 | put_device(rc->dev.parent); |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 217 | kfree(rc); |
| 218 | } |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 219 | |
Jeff Garzik | ed542be | 2006-10-04 07:05:11 -0400 | [diff] [blame] | 220 | int raid_component_add(struct raid_template *r,struct device *raid_dev, |
| 221 | struct device *component_dev) |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 222 | { |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 223 | struct device *cdev = |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 224 | attribute_container_find_class_device(&r->raid_attrs.ac, |
| 225 | raid_dev); |
| 226 | struct raid_component *rc; |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 227 | struct raid_data *rd = dev_get_drvdata(cdev); |
Jeff Garzik | ed542be | 2006-10-04 07:05:11 -0400 | [diff] [blame] | 228 | int err; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 229 | |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 230 | rc = kzalloc(sizeof(*rc), GFP_KERNEL); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 231 | if (!rc) |
Jeff Garzik | ed542be | 2006-10-04 07:05:11 -0400 | [diff] [blame] | 232 | return -ENOMEM; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 233 | |
| 234 | INIT_LIST_HEAD(&rc->node); |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 235 | device_initialize(&rc->dev); |
| 236 | rc->dev.release = raid_component_release; |
| 237 | rc->dev.parent = get_device(component_dev); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 238 | rc->num = rd->component_count++; |
| 239 | |
Kay Sievers | 71610f5 | 2008-12-03 22:41:36 +0100 | [diff] [blame^] | 240 | dev_set_name(&rc->dev, "component-%d", rc->num); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 241 | list_add_tail(&rc->node, &rd->component_list); |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 242 | rc->dev.class = &raid_class.class; |
| 243 | err = device_add(&rc->dev); |
Jeff Garzik | ed542be | 2006-10-04 07:05:11 -0400 | [diff] [blame] | 244 | if (err) |
| 245 | goto err_out; |
| 246 | |
| 247 | return 0; |
| 248 | |
| 249 | err_out: |
| 250 | list_del(&rc->node); |
| 251 | rd->component_count--; |
| 252 | put_device(component_dev); |
| 253 | kfree(rc); |
| 254 | return err; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 255 | } |
| 256 | EXPORT_SYMBOL(raid_component_add); |
| 257 | |
| 258 | struct raid_template * |
| 259 | raid_class_attach(struct raid_function_template *ft) |
| 260 | { |
James Bottomley | b1081ea | 2005-11-06 11:59:08 -0600 | [diff] [blame] | 261 | struct raid_internal *i = kzalloc(sizeof(struct raid_internal), |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 262 | GFP_KERNEL); |
| 263 | int count = 0; |
| 264 | |
| 265 | if (unlikely(!i)) |
| 266 | return NULL; |
| 267 | |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 268 | i->f = ft; |
| 269 | |
| 270 | i->r.raid_attrs.ac.class = &raid_class.class; |
| 271 | i->r.raid_attrs.ac.match = raid_match; |
| 272 | i->r.raid_attrs.ac.attrs = &i->attrs[0]; |
| 273 | |
| 274 | attribute_container_register(&i->r.raid_attrs.ac); |
| 275 | |
Tony Jones | ee959b0 | 2008-02-22 00:13:36 +0100 | [diff] [blame] | 276 | i->attrs[count++] = &dev_attr_level; |
| 277 | i->attrs[count++] = &dev_attr_resync; |
| 278 | i->attrs[count++] = &dev_attr_state; |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 279 | |
| 280 | i->attrs[count] = NULL; |
| 281 | BUG_ON(count > RAID_NUM_ATTRS); |
| 282 | |
| 283 | return &i->r; |
| 284 | } |
| 285 | EXPORT_SYMBOL(raid_class_attach); |
| 286 | |
| 287 | void |
| 288 | raid_class_release(struct raid_template *r) |
| 289 | { |
| 290 | struct raid_internal *i = to_raid_internal(r); |
| 291 | |
James Bottomley | 2f3edc6 | 2008-04-02 10:05:48 -0500 | [diff] [blame] | 292 | BUG_ON(attribute_container_unregister(&i->r.raid_attrs.ac)); |
James Bottomley | 61a7afa | 2005-08-16 18:27:34 -0500 | [diff] [blame] | 293 | |
| 294 | kfree(i); |
| 295 | } |
| 296 | EXPORT_SYMBOL(raid_class_release); |
| 297 | |
| 298 | static __init int raid_init(void) |
| 299 | { |
| 300 | return transport_class_register(&raid_class); |
| 301 | } |
| 302 | |
| 303 | static __exit void raid_exit(void) |
| 304 | { |
| 305 | transport_class_unregister(&raid_class); |
| 306 | } |
| 307 | |
| 308 | MODULE_AUTHOR("James Bottomley"); |
| 309 | MODULE_DESCRIPTION("RAID device class"); |
| 310 | MODULE_LICENSE("GPL"); |
| 311 | |
| 312 | module_init(raid_init); |
| 313 | module_exit(raid_exit); |
| 314 | |