drivers/scsi/device_handler/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 static int scsi_dh_list_idx = 1;
  32
  33 static struct scsi_device_handler *get_device_handler(const char *name)
  34 {
  35         struct scsi_device_handler *tmp, *found = NULL;
  36
  37         spin_lock(&list_lock);
  38         list_for_each_entry(tmp, &scsi_dh_list, list) {
  39                 if (!strncmp(tmp->name, name, strlen(tmp->name))) {
  40                         found = tmp;
  41                         break;
  42                 }
  43         }
  44         spin_unlock(&list_lock);
  45         return found;
  46 }
  47
  48 static struct scsi_device_handler *get_device_handler_by_idx(int idx)
  49 {
  50         struct scsi_device_handler *tmp, *found = NULL;
  51
  52         spin_lock(&list_lock);
  53         list_for_each_entry(tmp, &scsi_dh_list, list) {
  54                 if (tmp->idx == idx) {
  55                         found = tmp;
  56                         break;
  57                 }
  58         }
  59         spin_unlock(&list_lock);
  60         return found;
  61 }
  62
  63 /*
  64  * device_handler_match_function - Match a device handler to a device
  65  * @sdev - SCSI device to be tested
  66  *
  67  * Tests @sdev against the match function of all registered device_handler.
  68  * Returns the found device handler or NULL if not found.
  69  */
  70 static struct scsi_device_handler *
  71 device_handler_match_function(struct scsi_device *sdev)
  72 {
  73         struct scsi_device_handler *tmp_dh, *found_dh = NULL;
  74
  75         spin_lock(&list_lock);
  76         list_for_each_entry(tmp_dh, &scsi_dh_list, list) {
  77                 if (tmp_dh->match && tmp_dh->match(sdev)) {
  78                         found_dh = tmp_dh;
  79                         break;
  80                 }
  81         }
  82         spin_unlock(&list_lock);
  83         return found_dh;
  84 }
  85
  86 /*
  87  * device_handler_match_devlist - Match a device handler to a device
  88  * @sdev - SCSI device to be tested
  89  *
  90  * Tests @sdev against all device_handler registered in the devlist.
  91  * Returns the found device handler or NULL if not found.
  92  */
  93 static struct scsi_device_handler *
  94 device_handler_match_devlist(struct scsi_device *sdev)
  95 {
  96         int idx;
  97
  98         idx = scsi_get_device_flags_keyed(sdev, sdev->vendor, sdev->model,
  99                                           SCSI_DEVINFO_DH);
 100         return get_device_handler_by_idx(idx);
 101 }
 102
 103 /*
 104  * device_handler_match - Attach a device handler to a device
 105  * @scsi_dh - The device handler to match against or NULL
 106  * @sdev - SCSI device to be tested against @scsi_dh
 107  *
 108  * Tests @sdev against the device handler @scsi_dh or against
 109  * all registered device_handler if @scsi_dh == NULL.
 110  * Returns the found device handler or NULL if not found.
 111  */
 112 static struct scsi_device_handler *
 113 device_handler_match(struct scsi_device_handler *scsi_dh,
 114                      struct scsi_device *sdev)
 115 {
 116         struct scsi_device_handler *found_dh;
 117
 118         found_dh = device_handler_match_function(sdev);
 119         if (!found_dh)
 120                 found_dh = device_handler_match_devlist(sdev);
 121
 122         if (scsi_dh && found_dh != scsi_dh)
 123                 found_dh = NULL;
 124
 125         return found_dh;
 126 }
 127
 128 /*
 129  * scsi_dh_handler_attach - Attach a device handler to a device
 130  * @sdev - SCSI device the device handler should attach to
 131  * @scsi_dh - The device handler to attach
 132  */
 133 static int scsi_dh_handler_attach(struct scsi_device *sdev,
 134                                   struct scsi_device_handler *scsi_dh)
 135 {
 136         int err = 0;
 137
 138         if (sdev->scsi_dh_data) {
 139                 if (sdev->scsi_dh_data->scsi_dh != scsi_dh)
 140                         err = -EBUSY;
 141                 else
 142                         kref_get(&sdev->scsi_dh_data->kref);
 143         } else if (scsi_dh->attach) {
 144                 err = scsi_dh->attach(sdev);
 145                 if (!err) {
 146                         kref_init(&sdev->scsi_dh_data->kref);
 147                         sdev->scsi_dh_data->sdev = sdev;
 148                 }
 149         }
 150         return err;
 151 }
 152
 153 static void __detach_handler (struct kref *kref)
 154 {
 155         struct scsi_dh_data *scsi_dh_data = container_of(kref, struct scsi_dh_data, kref);
 156         scsi_dh_data->scsi_dh->detach(scsi_dh_data->sdev);
 157 }
 158
 159 /*
 160  * scsi_dh_handler_detach - Detach a device handler from a device
 161  * @sdev - SCSI device the device handler should be detached from
 162  * @scsi_dh - Device handler to be detached
 163  *
 164  * Detach from a device handler. If a device handler is specified,
 165  * only detach if the currently attached handler matches @scsi_dh.
 166  */
 167 static void scsi_dh_handler_detach(struct scsi_device *sdev,
 168                                    struct scsi_device_handler *scsi_dh)
 169 {
 170         if (!sdev->scsi_dh_data)
 171                 return;
 172
 173         if (scsi_dh && scsi_dh != sdev->scsi_dh_data->scsi_dh)
 174                 return;
 175
 176         if (!scsi_dh)
 177                 scsi_dh = sdev->scsi_dh_data->scsi_dh;
 178
 179         if (scsi_dh && scsi_dh->detach)
 180                 kref_put(&sdev->scsi_dh_data->kref, __detach_handler);
 181 }
 182
 183 /*
 184  * Functions for sysfs attribute 'dh_state'
 185  */
 186 static ssize_t
 187 store_dh_state(struct device *dev, struct device_attribute *attr,
 188                const char *buf, size_t count)
 189 {
 190         struct scsi_device *sdev = to_scsi_device(dev);
 191         struct scsi_device_handler *scsi_dh;
 192         int err = -EINVAL;
 193
 194         if (sdev->sdev_state == SDEV_CANCEL ||
 195             sdev->sdev_state == SDEV_DEL)
 196                 return -ENODEV;
 197
 198         if (!sdev->scsi_dh_data) {
 199                 /*
 200                  * Attach to a device handler
 201                  */
 202                 if (!(scsi_dh = get_device_handler(buf)))
 203                         return err;
 204                 err = scsi_dh_handler_attach(sdev, scsi_dh);
 205         } else {
 206                 scsi_dh = sdev->scsi_dh_data->scsi_dh;
 207                 if (!strncmp(buf, "detach", 6)) {
 208                         /*
 209                          * Detach from a device handler
 210                          */
 211                         scsi_dh_handler_detach(sdev, scsi_dh);
 212                         err = 0;
 213                 } else if (!strncmp(buf, "activate", 8)) {
 214                         /*
 215                          * Activate a device handler
 216                          */
 217                         if (scsi_dh->activate)
 218                                 err = scsi_dh->activate(sdev, NULL, NULL);
 219                         else
 220                                 err = 0;
 221                 }
 222         }
 223
 224         return err<0?err:count;
 225 }
 226
 227 static ssize_t
 228 show_dh_state(struct device *dev, struct device_attribute *attr, char *buf)
 229 {
 230         struct scsi_device *sdev = to_scsi_device(dev);
 231
 232         if (!sdev->scsi_dh_data)
 233                 return snprintf(buf, 20, "detached\n");
 234
 235         return snprintf(buf, 20, "%s\n", sdev->scsi_dh_data->scsi_dh->name);
 236 }
 237
 238 static struct device_attribute scsi_dh_state_attr =
 239         __ATTR(dh_state, S_IRUGO | S_IWUSR, show_dh_state,
 240                store_dh_state);
 241
 242 /*
 243  * scsi_dh_sysfs_attr_add - Callback for scsi_init_dh
 244  */
 245 static int scsi_dh_sysfs_attr_add(struct device *dev, void *data)
 246 {
 247         struct scsi_device *sdev;
 248         int err;
 249
 250         if (!scsi_is_sdev_device(dev))
 251                 return 0;
 252
 253         sdev = to_scsi_device(dev);
 254
 255         err = device_create_file(&sdev->sdev_gendev,
 256                                  &scsi_dh_state_attr);
 257
 258         return 0;
 259 }
 260
 261 /*
 262  * scsi_dh_sysfs_attr_remove - Callback for scsi_exit_dh
 263  */
 264 static int scsi_dh_sysfs_attr_remove(struct device *dev, void *data)
 265 {
 266         struct scsi_device *sdev;
 267
 268         if (!scsi_is_sdev_device(dev))
 269                 return 0;
 270
 271         sdev = to_scsi_device(dev);
 272
 273         device_remove_file(&sdev->sdev_gendev,
 274                            &scsi_dh_state_attr);
 275
 276         return 0;
 277 }
 278
 279 /*
 280  * scsi_dh_notifier - notifier chain callback
 281  */
 282 static int scsi_dh_notifier(struct notifier_block *nb,
 283                             unsigned long action, void *data)
 284 {
 285         struct device *dev = data;
 286         struct scsi_device *sdev;
 287         int err = 0;
 288         struct scsi_device_handler *devinfo = NULL;
 289
 290         if (!scsi_is_sdev_device(dev))
 291                 return 0;
 292
 293         sdev = to_scsi_device(dev);
 294
 295         if (action == BUS_NOTIFY_ADD_DEVICE) {
 296                 err = device_create_file(dev, &scsi_dh_state_attr);
 297                 /* don't care about err */
 298                 devinfo = device_handler_match(NULL, sdev);
 299                 if (devinfo)
 300                         err = scsi_dh_handler_attach(sdev, devinfo);
 301         } else if (action == BUS_NOTIFY_DEL_DEVICE) {
 302                 device_remove_file(dev, &scsi_dh_state_attr);
 303                 scsi_dh_handler_detach(sdev, NULL);
 304         }
 305         return err;
 306 }
 307
 308 /*
 309  * scsi_dh_notifier_add - Callback for scsi_register_device_handler
 310  */
 311 static int scsi_dh_notifier_add(struct device *dev, void *data)
 312 {
 313         struct scsi_device_handler *scsi_dh = data;
 314         struct scsi_device *sdev;
 315
 316         if (!scsi_is_sdev_device(dev))
 317                 return 0;
 318
 319         if (!get_device(dev))
 320                 return 0;
 321
 322         sdev = to_scsi_device(dev);
 323
 324         if (device_handler_match(scsi_dh, sdev))
 325                 scsi_dh_handler_attach(sdev, scsi_dh);
 326
 327         put_device(dev);
 328
 329         return 0;
 330 }
 331
 332 /*
 333  * scsi_dh_notifier_remove - Callback for scsi_unregister_device_handler
 334  */
 335 static int scsi_dh_notifier_remove(struct device *dev, void *data)
 336 {
 337         struct scsi_device_handler *scsi_dh = data;
 338         struct scsi_device *sdev;
 339
 340         if (!scsi_is_sdev_device(dev))
 341                 return 0;
 342
 343         if (!get_device(dev))
 344                 return 0;
 345
 346         sdev = to_scsi_device(dev);
 347
 348         scsi_dh_handler_detach(sdev, scsi_dh);
 349
 350         put_device(dev);
 351
 352         return 0;
 353 }
 354
 355 /*
 356  * scsi_register_device_handler - register a device handler personality
 357  *      module.
 358  * @scsi_dh - device handler to be registered.
 359  *
 360  * Returns 0 on success, -EBUSY if handler already registered.
 361  */
 362 int scsi_register_device_handler(struct scsi_device_handler *scsi_dh)
 363 {
 364         int i;
 365
 366         if (get_device_handler(scsi_dh->name))
 367                 return -EBUSY;
 368
 369         spin_lock(&list_lock);
 370         scsi_dh->idx = scsi_dh_list_idx++;
 371         list_add(&scsi_dh->list, &scsi_dh_list);
 372         spin_unlock(&list_lock);
 373
 374         for (i = 0; scsi_dh->devlist && scsi_dh->devlist[i].vendor; i++) {
 375                 scsi_dev_info_list_add_keyed(0,
 376                                         scsi_dh->devlist[i].vendor,
 377                                         scsi_dh->devlist[i].model,
 378                                         NULL,
 379                                         scsi_dh->idx,
 380                                         SCSI_DEVINFO_DH);
 381         }
 382
 383         bus_for_each_dev(&scsi_bus_type, NULL, scsi_dh, scsi_dh_notifier_add);
 384         printk(KERN_INFO "%s: device handler registered\n", scsi_dh->name);
 385
 386         return SCSI_DH_OK;
 387 }
 388 EXPORT_SYMBOL_GPL(scsi_register_device_handler);
 389
 390 /*
 391  * scsi_unregister_device_handler - register a device handler personality
 392  *      module.
 393  * @scsi_dh - device handler to be unregistered.
 394  *
 395  * Returns 0 on success, -ENODEV if handler not registered.
 396  */
 397 int scsi_unregister_device_handler(struct scsi_device_handler *scsi_dh)
 398 {
 399         int i;
 400
 401         if (!get_device_handler(scsi_dh->name))
 402                 return -ENODEV;
 403
 404         bus_for_each_dev(&scsi_bus_type, NULL, scsi_dh,
 405                          scsi_dh_notifier_remove);
 406
 407         for (i = 0; scsi_dh->devlist && scsi_dh->devlist[i].vendor; i++) {
 408                 scsi_dev_info_list_del_keyed(scsi_dh->devlist[i].vendor,
 409                                              scsi_dh->devlist[i].model,
 410                                              SCSI_DEVINFO_DH);
 411         }
 412
 413         spin_lock(&list_lock);
 414         list_del(&scsi_dh->list);
 415         spin_unlock(&list_lock);
 416         printk(KERN_INFO "%s: device handler unregistered\n", scsi_dh->name);
 417
 418         return SCSI_DH_OK;
 419 }
 420 EXPORT_SYMBOL_GPL(scsi_unregister_device_handler);
 421
 422 /*
 423  * scsi_dh_activate - activate the path associated with the scsi_device
 424  *      corresponding to the given request queue.
 425  *     Returns immediately without waiting for activation to be completed.
 426  * @q    - Request queue that is associated with the scsi_device to be
 427  *         activated.
 428  * @fn   - Function to be called upon completion of the activation.
 429  *         Function fn is called with data (below) and the error code.
 430  *         Function fn may be called from the same calling context. So,
 431  *         do not hold the lock in the caller which may be needed in fn.
 432  * @data - data passed to the function fn upon completion.
 433  *
 434  */
 435 int scsi_dh_activate(struct request_queue *q, activate_complete fn, void *data)
 436 {
 437         int err = 0;
 438         unsigned long flags;
 439         struct scsi_device *sdev;
 440         struct scsi_device_handler *scsi_dh = NULL;
 441         struct device *dev = NULL;
 442
 443         spin_lock_irqsave(q->queue_lock, flags);
 444         sdev = q->queuedata;
 445         if (!sdev) {
 446                 spin_unlock_irqrestore(q->queue_lock, flags);
 447                 err = SCSI_DH_NOSYS;
 448                 if (fn)
 449                         fn(data, err);
 450                 return err;
 451         }
 452
 453         if (sdev->scsi_dh_data)
 454                 scsi_dh = sdev->scsi_dh_data->scsi_dh;
 455         dev = get_device(&sdev->sdev_gendev);
 456         if (!scsi_dh || !dev ||
 457             sdev->sdev_state == SDEV_CANCEL ||
 458             sdev->sdev_state == SDEV_DEL)
 459                 err = SCSI_DH_NOSYS;
 460         if (sdev->sdev_state == SDEV_OFFLINE)
 461                 err = SCSI_DH_DEV_OFFLINED;
 462         spin_unlock_irqrestore(q->queue_lock, flags);
 463
 464         if (err) {
 465                 if (fn)
 466                         fn(data, err);
 467                 goto out;
 468         }
 469
 470         if (scsi_dh->activate)
 471                 err = scsi_dh->activate(sdev, fn, data);
 472 out:
 473         put_device(dev);
 474         return err;
 475 }
 476 EXPORT_SYMBOL_GPL(scsi_dh_activate);
 477
 478 /*
 479  * scsi_dh_set_params - set the parameters for the device as per the
 480  *      string specified in params.
 481  * @q - Request queue that is associated with the scsi_device for
 482  *      which the parameters to be set.
 483  * @params - parameters in the following format
 484  *      "no_of_params\0param1\0param2\0param3\0...\0"
 485  *      for example, string for 2 parameters with value 10 and 21
 486  *      is specified as "2\010\021\0".
 487  */
 488 int scsi_dh_set_params(struct request_queue *q, const char *params)
 489 {
 490         int err = -SCSI_DH_NOSYS;
 491         unsigned long flags;
 492         struct scsi_device *sdev;
 493         struct scsi_device_handler *scsi_dh = NULL;
 494
 495         spin_lock_irqsave(q->queue_lock, flags);
 496         sdev = q->queuedata;
 497         if (sdev && sdev->scsi_dh_data)
 498                 scsi_dh = sdev->scsi_dh_data->scsi_dh;
 499         if (scsi_dh && scsi_dh->set_params && get_device(&sdev->sdev_gendev))
 500                 err = 0;
 501         spin_unlock_irqrestore(q->queue_lock, flags);
 502
 503         if (err)
 504                 return err;
 505         err = scsi_dh->set_params(sdev, params);
 506         put_device(&sdev->sdev_gendev);
 507         return err;
 508 }
 509 EXPORT_SYMBOL_GPL(scsi_dh_set_params);
 510
 511 /*
 512  * scsi_dh_handler_exist - Return TRUE(1) if a device handler exists for
 513  *      the given name. FALSE(0) otherwise.
 514  * @name - name of the device handler.
 515  */
 516 int scsi_dh_handler_exist(const char *name)
 517 {
 518         return (get_device_handler(name) != NULL);
 519 }
 520 EXPORT_SYMBOL_GPL(scsi_dh_handler_exist);
 521
 522 /*
 523  * scsi_dh_attach - Attach device handler
 524  * @sdev - sdev the handler should be attached to
 525  * @name - name of the handler to attach
 526  */
 527 int scsi_dh_attach(struct request_queue *q, const char *name)
 528 {
 529         unsigned long flags;
 530         struct scsi_device *sdev;
 531         struct scsi_device_handler *scsi_dh;
 532         int err = 0;
 533
 534         scsi_dh = get_device_handler(name);
 535         if (!scsi_dh)
 536                 return -EINVAL;
 537
 538         spin_lock_irqsave(q->queue_lock, flags);
 539         sdev = q->queuedata;
 540         if (!sdev || !get_device(&sdev->sdev_gendev))
 541                 err = -ENODEV;
 542         spin_unlock_irqrestore(q->queue_lock, flags);
 543
 544         if (!err) {
 545                 err = scsi_dh_handler_attach(sdev, scsi_dh);
 546                 put_device(&sdev->sdev_gendev);
 547         }
 548         return err;
 549 }
 550 EXPORT_SYMBOL_GPL(scsi_dh_attach);
 551
 552 /*
 553  * scsi_dh_detach - Detach device handler
 554  * @sdev - sdev the handler should be detached from
 555  *
 556  * This function will detach the device handler only
 557  * if the sdev is not part of the internal list, ie
 558  * if it has been attached manually.
 559  */
 560 void scsi_dh_detach(struct request_queue *q)
 561 {
 562         unsigned long flags;
 563         struct scsi_device *sdev;
 564         struct scsi_device_handler *scsi_dh = NULL;
 565
 566         spin_lock_irqsave(q->queue_lock, flags);
 567         sdev = q->queuedata;
 568         if (!sdev || !get_device(&sdev->sdev_gendev))
 569                 sdev = NULL;
 570         spin_unlock_irqrestore(q->queue_lock, flags);
 571
 572         if (!sdev)
 573                 return;
 574
 575         if (sdev->scsi_dh_data) {
 576                 scsi_dh = sdev->scsi_dh_data->scsi_dh;
 577                 scsi_dh_handler_detach(sdev, scsi_dh);
 578         }
 579         put_device(&sdev->sdev_gendev);
 580 }
 581 EXPORT_SYMBOL_GPL(scsi_dh_detach);
 582
 583 static struct notifier_block scsi_dh_nb = {
 584         .notifier_call = scsi_dh_notifier
 585 };
 586
 587 static int __init scsi_dh_init(void)
 588 {
 589         int r;
 590
 591         r = scsi_dev_info_add_list(SCSI_DEVINFO_DH, "SCSI Device Handler");
 592         if (r)
 593                 return r;
 594
 595         r = bus_register_notifier(&scsi_bus_type, &scsi_dh_nb);
 596
 597         if (!r)
 598                 bus_for_each_dev(&scsi_bus_type, NULL, NULL,
 599                                  scsi_dh_sysfs_attr_add);
 600
 601         return r;
 602 }
 603
 604 static void __exit scsi_dh_exit(void)
 605 {
 606         bus_for_each_dev(&scsi_bus_type, NULL, NULL,
 607                          scsi_dh_sysfs_attr_remove);
 608         bus_unregister_notifier(&scsi_bus_type, &scsi_dh_nb);
 609         scsi_dev_info_remove_list(SCSI_DEVINFO_DH);
 610 }
 611
 612 module_init(scsi_dh_init);
 613 module_exit(scsi_dh_exit);
 614
 615 MODULE_DESCRIPTION("SCSI device handler");
 616 MODULE_AUTHOR("Chandra Seetharaman <sekharan@us.ibm.com>");
 617 MODULE_LICENSE("GPL");