drivers/scsi/scsi_dh.c

   1 /*
   2  * SCSI device handler infrastruture.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License as published by the
   6  * Free Software Foundation; either version 2 of the License, or (at your
   7  * option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  *
  18  * Copyright IBM Corporation, 2007
  19  *      Authors:
  20  *               Chandra Seetharaman <sekharan@us.ibm.com>
  21  *               Mike Anderson <andmike@linux.vnet.ibm.com>
  22  */
  23
  24 #include <linux/slab.h>
  25 #include <linux/module.h>
  26 #include <scsi/scsi_dh.h>
  27 #include "scsi_priv.h"
  28
  29 static DEFINE_SPINLOCK(list_lock);
  30 static LIST_HEAD(scsi_dh_list);
  31
  32 struct scsi_dh_blist {
  33         const char *vendor;
  34         const char *model;
  35         const char *driver;
  36 };
  37
  38 static const struct scsi_dh_blist scsi_dh_blist[] = {
  39         {"DGC", "RAID",                 "clariion" },
  40         {"DGC", "DISK",                 "clariion" },
  41         {"DGC", "VRAID",                "clariion" },
  42
  43         {"COMPAQ", "MSA1000 VOLUME",    "hp_sw" },
  44         {"COMPAQ", "HSV110",            "hp_sw" },
  45         {"HP", "HSV100",                "hp_sw"},
  46         {"DEC", "HSG80",                "hp_sw"},
  47
  48         {"IBM", "1722",                 "rdac", },
  49         {"IBM", "1724",                 "rdac", },
  50         {"IBM", "1726",                 "rdac", },
  51         {"IBM", "1742",                 "rdac", },
  52         {"IBM", "1745",                 "rdac", },
  53         {"IBM", "1746",                 "rdac", },
  54         {"IBM", "1813",                 "rdac", },
  55         {"IBM", "1814",                 "rdac", },
  56         {"IBM", "1815",                 "rdac", },
  57         {"IBM", "1818",                 "rdac", },
  58         {"IBM", "3526",                 "rdac", },
  59         {"SGI", "TP9",                  "rdac", },
  60         {"SGI", "IS",                   "rdac", },
  61         {"STK", "OPENstorage D280",     "rdac", },
  62         {"STK", "FLEXLINE 380",         "rdac", },
  63         {"SUN", "CSM",                  "rdac", },
  64         {"SUN", "LCSM100",              "rdac", },
  65         {"SUN", "STK6580_6780",         "rdac", },
  66         {"SUN", "SUN_6180",             "rdac", },
  67         {"SUN", "ArrayStorage",         "rdac", },
  68         {"DELL", "MD3",                 "rdac", },
  69         {"NETAPP", "INF-01-00",         "rdac", },
  70         {"LSI", "INF-01-00",            "rdac", },
  71         {"ENGENIO", "INF-01-00",        "rdac", },
  72         {NULL, NULL,                    NULL },
  73 };
  74
  75 static const char *
  76 scsi_dh_find_driver(struct scsi_device *sdev)
  77 {
  78         const struct scsi_dh_blist *b;
  79
  80         if (scsi_device_tpgs(sdev))
  81                 return "alua";
  82
  83         for (b = scsi_dh_blist; b->vendor; b++) {
  84                 if (!strncmp(sdev->vendor, b->vendor, strlen(b->vendor)) &&
  85                     !strncmp(sdev->model, b->model, strlen(b->model))) {
  86                         return b->driver;
  87                 }
  88         }
  89         return NULL;
  90 }
  91
  92
  93 static struct scsi_device_handler *__scsi_dh_lookup(const char *name)
  94 {
  95         struct scsi_device_handler *tmp, *found = NULL;
  96
  97         spin_lock(&list_lock);
  98         list_for_each_entry(tmp, &scsi_dh_list, list) {
  99                 if (!strncmp(tmp->name, name, strlen(tmp->name))) {
 100                         found = tmp;
 101                         break;
 102                 }
 103         }
 104         spin_unlock(&list_lock);
 105         return found;
 106 }
 107
 108 static struct scsi_device_handler *scsi_dh_lookup(const char *name)
 109 {
 110         struct scsi_device_handler *dh;
 111
 112         dh = __scsi_dh_lookup(name);
 113         if (!dh) {
 114                 request_module(name);
 115                 dh = __scsi_dh_lookup(name);
 116         }
 117
 118         return dh;
 119 }
 120
 121 /*
 122  * scsi_dh_handler_attach - Attach a device handler to a device
 123  * @sdev - SCSI device the device handler should attach to
 124  * @scsi_dh - The device handler to attach
 125  */
 126 static int scsi_dh_handler_attach(struct scsi_device *sdev,
 127                                   struct scsi_device_handler *scsi_dh)
 128 {
 129         int error;
 130
 131         if (!try_module_get(scsi_dh->module))
 132                 return -EINVAL;
 133
 134         error = scsi_dh->attach(sdev);
 135         if (error) {
 136                 sdev_printk(KERN_ERR, sdev, "%s: Attach failed (%d)\n",
 137                             scsi_dh->name, error);
 138                 module_put(scsi_dh->module);
 139         } else
 140                 sdev->handler = scsi_dh;
 141
 142         return error;
 143 }
 144
 145 /*
 146  * scsi_dh_handler_detach - Detach a device handler from a device
 147  * @sdev - SCSI device the device handler should be detached from
 148  */
 149 static void scsi_dh_handler_detach(struct scsi_device *sdev)
 150 {
 151         sdev->handler->detach(sdev);
 152         sdev_printk(KERN_NOTICE, sdev, "%s: Detached\n", sdev->handler->name);
 153         module_put(sdev->handler->module);
 154 }
 155
 156 /*
 157  * Functions for sysfs attribute 'dh_state'
 158  */
 159 static ssize_t
 160 store_dh_state(struct device *dev, struct device_attribute *attr,
 161                const char *buf, size_t count)
 162 {
 163         struct scsi_device *sdev = to_scsi_device(dev);
 164         struct scsi_device_handler *scsi_dh;
 165         int err = -EINVAL;
 166
 167         if (sdev->sdev_state == SDEV_CANCEL ||
 168             sdev->sdev_state == SDEV_DEL)
 169                 return -ENODEV;
 170
 171         if (!sdev->handler) {
 172                 /*
 173                  * Attach to a device handler
 174                  */
 175                 scsi_dh = scsi_dh_lookup(buf);
 176                 if (!scsi_dh)
 177                         return err;
 178                 err = scsi_dh_handler_attach(sdev, scsi_dh);
 179         } else {
 180                 if (!strncmp(buf, "detach", 6)) {
 181                         /*
 182                          * Detach from a device handler
 183                          */
 184                         scsi_dh_handler_detach(sdev);
 185                         err = 0;
 186                 } else if (!strncmp(buf, "activate", 8)) {
 187                         /*
 188                          * Activate a device handler
 189                          */
 190                         if (sdev->handler->activate)
 191                                 err = sdev->handler->activate(sdev, NULL, NULL);
 192                         else
 193                                 err = 0;
 194                 }
 195         }
 196
 197         return err<0?err:count;
 198 }
 199
 200 static ssize_t
 201 show_dh_state(struct device *dev, struct device_attribute *attr, char *buf)
 202 {
 203         struct scsi_device *sdev = to_scsi_device(dev);
 204
 205         if (!sdev->handler)
 206                 return snprintf(buf, 20, "detached\n");
 207
 208         return snprintf(buf, 20, "%s\n", sdev->handler->name);
 209 }
 210
 211 static struct device_attribute scsi_dh_state_attr =
 212         __ATTR(dh_state, S_IRUGO | S_IWUSR, show_dh_state,
 213                store_dh_state);
 214
 215 int scsi_dh_add_device(struct scsi_device *sdev)
 216 {
 217         struct scsi_device_handler *devinfo = NULL;
 218         const char *drv;
 219         int err;
 220
 221         err = device_create_file(&sdev->sdev_gendev, &scsi_dh_state_attr);
 222         if (err)
 223                 return err;
 224
 225         drv = scsi_dh_find_driver(sdev);
 226         if (drv)
 227                 devinfo = scsi_dh_lookup(drv);
 228         if (devinfo)
 229                 err = scsi_dh_handler_attach(sdev, devinfo);
 230         return err;
 231 }
 232
 233 void scsi_dh_remove_device(struct scsi_device *sdev)
 234 {
 235         if (sdev->handler)
 236                 scsi_dh_handler_detach(sdev);
 237         device_remove_file(&sdev->sdev_gendev, &scsi_dh_state_attr);
 238 }
 239
 240 /*
 241  * scsi_register_device_handler - register a device handler personality
 242  *      module.
 243  * @scsi_dh - device handler to be registered.
 244  *
 245  * Returns 0 on success, -EBUSY if handler already registered.
 246  */
 247 int scsi_register_device_handler(struct scsi_device_handler *scsi_dh)
 248 {
 249         if (__scsi_dh_lookup(scsi_dh->name))
 250                 return -EBUSY;
 251
 252         if (!scsi_dh->attach || !scsi_dh->detach)
 253                 return -EINVAL;
 254
 255         spin_lock(&list_lock);
 256         list_add(&scsi_dh->list, &scsi_dh_list);
 257         spin_unlock(&list_lock);
 258
 259         printk(KERN_INFO "%s: device handler registered\n", scsi_dh->name);
 260
 261         return SCSI_DH_OK;
 262 }
 263 EXPORT_SYMBOL_GPL(scsi_register_device_handler);
 264
 265 /*
 266  * scsi_unregister_device_handler - register a device handler personality
 267  *      module.
 268  * @scsi_dh - device handler to be unregistered.
 269  *
 270  * Returns 0 on success, -ENODEV if handler not registered.
 271  */
 272 int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh)
 273 {
 274         if (!__scsi_dh_lookup(scsi_dh->name))
 275                 return -ENODEV;
 276
 277         spin_lock(&list_lock);
 278         list_del(&scsi_dh->list);
 279         spin_unlock(&list_lock);
 280         printk(KERN_INFO "%s: device handler unregistered\n", scsi_dh->name);
 281
 282         return SCSI_DH_OK;
 283 }
 284 EXPORT_SYMBOL_GPL(scsi_unregister_device_handler);
 285
 286 static struct scsi_device *get_sdev_from_queue(struct request_queue *q)
 287 {
 288         struct scsi_device *sdev;
 289         unsigned long flags;
 290
 291         spin_lock_irqsave(q->queue_lock, flags);
 292         sdev = q->queuedata;
 293         if (!sdev || !get_device(&sdev->sdev_gendev))
 294                 sdev = NULL;
 295         spin_unlock_irqrestore(q->queue_lock, flags);
 296
 297         return sdev;
 298 }
 299
 300 /*
 301  * scsi_dh_activate - activate the path associated with the scsi_device
 302  *      corresponding to the given request queue.
 303  *     Returns immediately without waiting for activation to be completed.
 304  * @q    - Request queue that is associated with the scsi_device to be
 305  *         activated.
 306  * @fn   - Function to be called upon completion of the activation.
 307  *         Function fn is called with data (below) and the error code.
 308  *         Function fn may be called from the same calling context. So,
 309  *         do not hold the lock in the caller which may be needed in fn.
 310  * @data - data passed to the function fn upon completion.
 311  *
 312  */
 313 int scsi_dh_activate(struct request_queue *q, activate_complete fn, void *data)
 314 {
 315         struct scsi_device *sdev;
 316         int err = SCSI_DH_NOSYS;
 317
 318         sdev = get_sdev_from_queue(q);
 319         if (!sdev) {
 320                 if (fn)
 321                         fn(data, err);
 322                 return err;
 323         }
 324
 325         if (!sdev->handler)
 326                 goto out_fn;
 327         if (sdev->sdev_state == SDEV_CANCEL ||
 328             sdev->sdev_state == SDEV_DEL)
 329                 goto out_fn;
 330
 331         err = SCSI_DH_DEV_OFFLINED;
 332         if (sdev->sdev_state == SDEV_OFFLINE)
 333                 goto out_fn;
 334
 335         if (sdev->handler->activate)
 336                 err = sdev->handler->activate(sdev, fn, data);
 337
 338 out_put_device:
 339         put_device(&sdev->sdev_gendev);
 340         return err;
 341
 342 out_fn:
 343         if (fn)
 344                 fn(data, err);
 345         goto out_put_device;
 346 }
 347 EXPORT_SYMBOL_GPL(scsi_dh_activate);
 348
 349 /*
 350  * scsi_dh_set_params - set the parameters for the device as per the
 351  *      string specified in params.
 352  * @q - Request queue that is associated with the scsi_device for
 353  *      which the parameters to be set.
 354  * @params - parameters in the following format
 355  *      "no_of_params\0param1\0param2\0param3\0...\0"
 356  *      for example, string for 2 parameters with value 10 and 21
 357  *      is specified as "2\010\021\0".
 358  */
 359 int scsi_dh_set_params(struct request_queue *q, const char *params)
 360 {
 361         struct scsi_device *sdev;
 362         int err = -SCSI_DH_NOSYS;
 363
 364         sdev = get_sdev_from_queue(q);
 365         if (!sdev)
 366                 return err;
 367
 368         if (sdev->handler && sdev->handler->set_params)
 369                 err = sdev->handler->set_params(sdev, params);
 370         put_device(&sdev->sdev_gendev);
 371         return err;
 372 }
 373 EXPORT_SYMBOL_GPL(scsi_dh_set_params);
 374
 375 /*
 376  * scsi_dh_attach - Attach device handler
 377  * @q - Request queue that is associated with the scsi_device
 378  *      the handler should be attached to
 379  * @name - name of the handler to attach
 380  */
 381 int scsi_dh_attach(struct request_queue *q, const char *name)
 382 {
 383         struct scsi_device *sdev;
 384         struct scsi_device_handler *scsi_dh;
 385         int err = 0;
 386
 387         sdev = get_sdev_from_queue(q);
 388         if (!sdev)
 389                 return -ENODEV;
 390
 391         scsi_dh = scsi_dh_lookup(name);
 392         if (!scsi_dh) {
 393                 err = -EINVAL;
 394                 goto out_put_device;
 395         }
 396
 397         if (sdev->handler) {
 398                 if (sdev->handler != scsi_dh)
 399                         err = -EBUSY;
 400                 goto out_put_device;
 401         }
 402
 403         err = scsi_dh_handler_attach(sdev, scsi_dh);
 404
 405 out_put_device:
 406         put_device(&sdev->sdev_gendev);
 407         return err;
 408 }
 409 EXPORT_SYMBOL_GPL(scsi_dh_attach);
 410
 411 /*
 412  * scsi_dh_attached_handler_name - Get attached device handler's name
 413  * @q - Request queue that is associated with the scsi_device
 414  *      that may have a device handler attached
 415  * @gfp - the GFP mask used in the kmalloc() call when allocating memory
 416  *
 417  * Returns name of attached handler, NULL if no handler is attached.
 418  * Caller must take care to free the returned string.
 419  */
 420 const char *scsi_dh_attached_handler_name(struct request_queue *q, gfp_t gfp)
 421 {
 422         struct scsi_device *sdev;
 423         const char *handler_name = NULL;
 424
 425         sdev = get_sdev_from_queue(q);
 426         if (!sdev)
 427                 return NULL;
 428
 429         if (sdev->handler)
 430                 handler_name = kstrdup(sdev->handler->name, gfp);
 431         put_device(&sdev->sdev_gendev);
 432         return handler_name;
 433 }
 434 EXPORT_SYMBOL_GPL(scsi_dh_attached_handler_name);