sys/cam/ctl/ctl_frontend.c

   1 /*-
   2  * Copyright (c) 2003 Silicon Graphics International Corp.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    substantially similar to the "NO WARRANTY" disclaimer below
  13  *    ("Disclaimer") and any redistribution must be conditioned upon
  14  *    including a substantially similar Disclaimer requirement for further
  15  *    binary redistribution.
  16  *
  17  * NO WARRANTY
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGES.
  29  *
  30  * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_frontend.c#4 $
  31  */
  32 /*
  33  * CAM Target Layer front end interface code
  34  *
  35  * Author: Ken Merry <ken@FreeBSD.org>
  36  */
  37
  38 #include <sys/cdefs.h>
  39 __FBSDID("$FreeBSD$");
  40
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/kernel.h>
  44 #include <sys/types.h>
  45 #include <sys/malloc.h>
  46 #include <sys/lock.h>
  47 #include <sys/mutex.h>
  48 #include <sys/condvar.h>
  49 #include <sys/endian.h>
  50 #include <sys/queue.h>
  51 #include <sys/sysctl.h>
  52
  53 #include <cam/scsi/scsi_all.h>
  54 #include <cam/scsi/scsi_da.h>
  55 #include <cam/ctl/ctl_io.h>
  56 #include <cam/ctl/ctl.h>
  57 #include <cam/ctl/ctl_frontend.h>
  58 #include <cam/ctl/ctl_backend.h>
  59 /* XXX KDM move defines from ctl_ioctl.h to somewhere else */
  60 #include <cam/ctl/ctl_ioctl.h>
  61 #include <cam/ctl/ctl_ha.h>
  62 #include <cam/ctl/ctl_private.h>
  63 #include <cam/ctl/ctl_debug.h>
  64
  65 extern struct ctl_softc *control_softc;
  66
  67 int
  68 ctl_frontend_register(struct ctl_frontend *fe)
  69 {
  70         struct ctl_softc *softc = control_softc;
  71         struct ctl_frontend *fe_tmp;
  72
  73         KASSERT(softc != NULL, ("CTL is not initialized"));
  74
  75         /*
  76          * Sanity check, make sure this isn't a duplicate registration.
  77          */
  78         mtx_lock(&softc->ctl_lock);
  79         STAILQ_FOREACH(fe_tmp, &softc->fe_list, links) {
  80                 if (strcmp(fe_tmp->name, fe->name) == 0) {
  81                         mtx_unlock(&softc->ctl_lock);
  82                         return (-1);
  83                 }
  84         }
  85         mtx_unlock(&softc->ctl_lock);
  86         STAILQ_INIT(&fe->port_list);
  87
  88         /*
  89          * Call the frontend's initialization routine.
  90          */
  91         if (fe->init != NULL)
  92                 fe->init();
  93
  94         mtx_lock(&softc->ctl_lock);
  95         softc->num_frontends++;
  96         STAILQ_INSERT_TAIL(&softc->fe_list, fe, links);
  97         mtx_unlock(&softc->ctl_lock);
  98         return (0);
  99 }
 100
 101 int
 102 ctl_frontend_deregister(struct ctl_frontend *fe)
 103 {
 104         struct ctl_softc *softc = control_softc;
 105
 106         if (!STAILQ_EMPTY(&fe->port_list))
 107                 return (-1);
 108
 109         mtx_lock(&softc->ctl_lock);
 110         STAILQ_REMOVE(&softc->fe_list, fe, ctl_frontend, links);
 111         softc->num_frontends--;
 112         mtx_unlock(&softc->ctl_lock);
 113
 114         /*
 115          * Call the frontend's shutdown routine.
 116          */
 117         if (fe->shutdown != NULL)
 118                 fe->shutdown();
 119         return (0);
 120 }
 121
 122 struct ctl_frontend *
 123 ctl_frontend_find(char *frontend_name)
 124 {
 125         struct ctl_softc *softc = control_softc;
 126         struct ctl_frontend *fe;
 127
 128         mtx_lock(&softc->ctl_lock);
 129         STAILQ_FOREACH(fe, &softc->fe_list, links) {
 130                 if (strcmp(fe->name, frontend_name) == 0) {
 131                         mtx_unlock(&softc->ctl_lock);
 132                         return (fe);
 133                 }
 134         }
 135         mtx_unlock(&softc->ctl_lock);
 136         return (NULL);
 137 }
 138
 139 int
 140 ctl_port_register(struct ctl_port *port)
 141 {
 142         struct ctl_softc *softc = control_softc;
 143         struct ctl_port *tport, *nport;
 144         void *pool;
 145         int port_num;
 146         int retval;
 147
 148         KASSERT(softc != NULL, ("CTL is not initialized"));
 149         port->ctl_softc = softc;
 150
 151         mtx_lock(&softc->ctl_lock);
 152         if (port->targ_port >= 0)
 153                 port_num = port->targ_port;
 154         else
 155                 port_num = ctl_ffz(softc->ctl_port_mask,
 156                     softc->port_min, softc->port_max);
 157         if ((port_num < 0) ||
 158             (ctl_set_mask(softc->ctl_port_mask, port_num) < 0)) {
 159                 mtx_unlock(&softc->ctl_lock);
 160                 return (1);
 161         }
 162         softc->num_ports++;
 163         mtx_unlock(&softc->ctl_lock);
 164
 165         /*
 166          * Initialize the initiator and portname mappings
 167          */
 168         port->max_initiators = CTL_MAX_INIT_PER_PORT;
 169         port->wwpn_iid = malloc(sizeof(*port->wwpn_iid) * port->max_initiators,
 170             M_CTL, M_NOWAIT | M_ZERO);
 171         if (port->wwpn_iid == NULL) {
 172                 retval = ENOMEM;
 173                 goto error;
 174         }
 175
 176         /*
 177          * We add 20 to whatever the caller requests, so he doesn't get
 178          * burned by queueing things back to the pending sense queue.  In
 179          * theory, there should probably only be one outstanding item, at
 180          * most, on the pending sense queue for a LUN.  We'll clear the
 181          * pending sense queue on the next command, whether or not it is
 182          * a REQUEST SENSE.
 183          */
 184         retval = ctl_pool_create(softc, port->port_name,
 185                                  port->num_requested_ctl_io + 20, &pool);
 186         if (retval != 0) {
 187                 free(port->wwpn_iid, M_CTL);
 188 error:
 189                 port->targ_port = -1;
 190                 mtx_lock(&softc->ctl_lock);
 191                 ctl_clear_mask(softc->ctl_port_mask, port_num);
 192                 mtx_unlock(&softc->ctl_lock);
 193                 return (retval);
 194         }
 195         port->ctl_pool_ref = pool;
 196
 197         if (port->options.stqh_first == NULL)
 198                 STAILQ_INIT(&port->options);
 199
 200         mtx_lock(&softc->ctl_lock);
 201         port->targ_port = port_num;
 202         STAILQ_INSERT_TAIL(&port->frontend->port_list, port, fe_links);
 203         for (tport = NULL, nport = STAILQ_FIRST(&softc->port_list);
 204             nport != NULL && nport->targ_port < port_num;
 205             tport = nport, nport = STAILQ_NEXT(tport, links)) {
 206         }
 207         if (tport)
 208                 STAILQ_INSERT_AFTER(&softc->port_list, tport, port, links);
 209         else
 210                 STAILQ_INSERT_HEAD(&softc->port_list, port, links);
 211         softc->ctl_ports[port->targ_port] = port;
 212         mtx_unlock(&softc->ctl_lock);
 213
 214         return (retval);
 215 }
 216
 217 int
 218 ctl_port_deregister(struct ctl_port *port)
 219 {
 220         struct ctl_softc *softc = port->ctl_softc;
 221         struct ctl_io_pool *pool;
 222         int retval, i;
 223
 224         retval = 0;
 225
 226         pool = (struct ctl_io_pool *)port->ctl_pool_ref;
 227
 228         if (port->targ_port == -1) {
 229                 retval = 1;
 230                 goto bailout;
 231         }
 232
 233         mtx_lock(&softc->ctl_lock);
 234         STAILQ_REMOVE(&softc->port_list, port, ctl_port, links);
 235         STAILQ_REMOVE(&port->frontend->port_list, port, ctl_port, fe_links);
 236         softc->num_ports--;
 237         ctl_clear_mask(softc->ctl_port_mask, port->targ_port);
 238         softc->ctl_ports[port->targ_port] = NULL;
 239         mtx_unlock(&softc->ctl_lock);
 240
 241         ctl_pool_free(pool);
 242         ctl_free_opts(&port->options);
 243
 244         ctl_lun_map_deinit(port);
 245         free(port->port_devid, M_CTL);
 246         port->port_devid = NULL;
 247         free(port->target_devid, M_CTL);
 248         port->target_devid = NULL;
 249         free(port->init_devid, M_CTL);
 250         port->init_devid = NULL;
 251         for (i = 0; i < port->max_initiators; i++)
 252                 free(port->wwpn_iid[i].name, M_CTL);
 253         free(port->wwpn_iid, M_CTL);
 254
 255 bailout:
 256         return (retval);
 257 }
 258
 259 void
 260 ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid, uint64_t wwnn,
 261                       int wwpn_valid, uint64_t wwpn)
 262 {
 263         struct scsi_vpd_id_descriptor *desc;
 264         int len, proto;
 265
 266         if (port->port_type == CTL_PORT_FC)
 267                 proto = SCSI_PROTO_FC << 4;
 268         else if (port->port_type == CTL_PORT_ISCSI)
 269                 proto = SCSI_PROTO_ISCSI << 4;
 270         else
 271                 proto = SCSI_PROTO_SPI << 4;
 272
 273         if (wwnn_valid) {
 274                 port->wwnn = wwnn;
 275
 276                 free(port->target_devid, M_CTL);
 277
 278                 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
 279                 port->target_devid = malloc(sizeof(struct ctl_devid) + len,
 280                     M_CTL, M_WAITOK | M_ZERO);
 281                 port->target_devid->len = len;
 282                 desc = (struct scsi_vpd_id_descriptor *)port->target_devid->data;
 283                 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
 284                 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_TARGET |
 285                     SVPD_ID_TYPE_NAA;
 286                 desc->length = CTL_WWPN_LEN;
 287                 scsi_u64to8b(port->wwnn, desc->identifier);
 288         }
 289
 290         if (wwpn_valid) {
 291                 port->wwpn = wwpn;
 292
 293                 free(port->port_devid, M_CTL);
 294
 295                 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
 296                 port->port_devid = malloc(sizeof(struct ctl_devid) + len,
 297                     M_CTL, M_WAITOK | M_ZERO);
 298                 port->port_devid->len = len;
 299                 desc = (struct scsi_vpd_id_descriptor *)port->port_devid->data;
 300                 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
 301                 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
 302                     SVPD_ID_TYPE_NAA;
 303                 desc->length = CTL_WWPN_LEN;
 304                 scsi_u64to8b(port->wwpn, desc->identifier);
 305         }
 306 }
 307
 308 void
 309 ctl_port_online(struct ctl_port *port)
 310 {
 311         struct ctl_softc *softc = port->ctl_softc;
 312         struct ctl_lun *lun;
 313         const char *value;
 314         uint32_t l;
 315
 316         if (port->lun_enable != NULL) {
 317                 if (port->lun_map) {
 318                         for (l = 0; l < CTL_MAX_LUNS; l++) {
 319                                 if (ctl_lun_map_from_port(port, l) >=
 320                                     CTL_MAX_LUNS)
 321                                         continue;
 322                                 port->lun_enable(port->targ_lun_arg, l);
 323                         }
 324                 } else {
 325                         STAILQ_FOREACH(lun, &softc->lun_list, links)
 326                                 port->lun_enable(port->targ_lun_arg, lun->lun);
 327                 }
 328         }
 329         if (port->port_online != NULL)
 330                 port->port_online(port->onoff_arg);
 331         mtx_lock(&softc->ctl_lock);
 332         if (softc->is_single == 0) {
 333                 value = ctl_get_opt(&port->options, "ha_shared");
 334                 if (value != NULL && strcmp(value, "on") == 0)
 335                         port->status |= CTL_PORT_STATUS_HA_SHARED;
 336                 else
 337                         port->status &= ~CTL_PORT_STATUS_HA_SHARED;
 338         }
 339         port->status |= CTL_PORT_STATUS_ONLINE;
 340         STAILQ_FOREACH(lun, &softc->lun_list, links) {
 341                 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
 342                         continue;
 343                 mtx_lock(&lun->lun_lock);
 344                 ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
 345                 mtx_unlock(&lun->lun_lock);
 346         }
 347         mtx_unlock(&softc->ctl_lock);
 348         ctl_isc_announce_port(port);
 349 }
 350
 351 void
 352 ctl_port_offline(struct ctl_port *port)
 353 {
 354         struct ctl_softc *softc = port->ctl_softc;
 355         struct ctl_lun *lun;
 356         uint32_t l;
 357
 358         if (port->port_offline != NULL)
 359                 port->port_offline(port->onoff_arg);
 360         if (port->lun_disable != NULL) {
 361                 if (port->lun_map) {
 362                         for (l = 0; l < CTL_MAX_LUNS; l++) {
 363                                 if (ctl_lun_map_from_port(port, l) >=
 364                                     CTL_MAX_LUNS)
 365                                         continue;
 366                                 port->lun_disable(port->targ_lun_arg, l);
 367                         }
 368                 } else {
 369                         STAILQ_FOREACH(lun, &softc->lun_list, links)
 370                                 port->lun_disable(port->targ_lun_arg, lun->lun);
 371                 }
 372         }
 373         mtx_lock(&softc->ctl_lock);
 374         port->status &= ~CTL_PORT_STATUS_ONLINE;
 375         STAILQ_FOREACH(lun, &softc->lun_list, links) {
 376                 if (ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
 377                         continue;
 378                 mtx_lock(&lun->lun_lock);
 379                 ctl_est_ua_all(lun, -1, CTL_UA_INQ_CHANGE);
 380                 mtx_unlock(&lun->lun_lock);
 381         }
 382         mtx_unlock(&softc->ctl_lock);
 383         ctl_isc_announce_port(port);
 384 }
 385
 386 /*
 387  * vim: ts=8
 388  */