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         void *pool;
 144         int port_num;
 145         int retval;
 146
 147         retval = 0;
 148
 149         KASSERT(softc != NULL, ("CTL is not initialized"));
 150
 151         mtx_lock(&softc->ctl_lock);
 152         port_num = ctl_ffz(softc->ctl_port_mask, CTL_MAX_PORTS);
 153         if ((port_num == -1)
 154          || (ctl_set_mask(softc->ctl_port_mask, port_num) == -1)) {
 155                 port->targ_port = -1;
 156                 mtx_unlock(&softc->ctl_lock);
 157                 return (1);
 158         }
 159         softc->num_ports++;
 160         mtx_unlock(&softc->ctl_lock);
 161
 162         /*
 163          * Initialize the initiator and portname mappings
 164          */
 165         port->max_initiators = CTL_MAX_INIT_PER_PORT;
 166         port->wwpn_iid = malloc(sizeof(*port->wwpn_iid) * port->max_initiators,
 167             M_CTL, M_NOWAIT | M_ZERO);
 168         if (port->wwpn_iid == NULL) {
 169                 retval = ENOMEM;
 170                 goto error;
 171         }
 172
 173         /*
 174          * We add 20 to whatever the caller requests, so he doesn't get
 175          * burned by queueing things back to the pending sense queue.  In
 176          * theory, there should probably only be one outstanding item, at
 177          * most, on the pending sense queue for a LUN.  We'll clear the
 178          * pending sense queue on the next command, whether or not it is
 179          * a REQUEST SENSE.
 180          */
 181         retval = ctl_pool_create(softc, port->port_name,
 182                                  port->num_requested_ctl_io + 20, &pool);
 183         if (retval != 0) {
 184                 free(port->wwpn_iid, M_CTL);
 185 error:
 186                 port->targ_port = -1;
 187                 mtx_lock(&softc->ctl_lock);
 188                 ctl_clear_mask(softc->ctl_port_mask, port_num);
 189                 mtx_unlock(&softc->ctl_lock);
 190                 return (retval);
 191         }
 192         port->ctl_pool_ref = pool;
 193
 194         if (port->options.stqh_first == NULL)
 195                 STAILQ_INIT(&port->options);
 196
 197         mtx_lock(&softc->ctl_lock);
 198         port->targ_port = port_num + softc->port_offset;
 199         STAILQ_INSERT_TAIL(&port->frontend->port_list, port, fe_links);
 200         STAILQ_INSERT_TAIL(&softc->port_list, port, links);
 201         softc->ctl_ports[port_num] = port;
 202         mtx_unlock(&softc->ctl_lock);
 203
 204         return (retval);
 205 }
 206
 207 int
 208 ctl_port_deregister(struct ctl_port *port)
 209 {
 210         struct ctl_softc *softc = control_softc;
 211         struct ctl_io_pool *pool;
 212         int port_num, retval, i;
 213
 214         retval = 0;
 215
 216         pool = (struct ctl_io_pool *)port->ctl_pool_ref;
 217
 218         if (port->targ_port == -1) {
 219                 retval = 1;
 220                 goto bailout;
 221         }
 222
 223         mtx_lock(&softc->ctl_lock);
 224         STAILQ_REMOVE(&softc->port_list, port, ctl_port, links);
 225         STAILQ_REMOVE(&port->frontend->port_list, port, ctl_port, fe_links);
 226         softc->num_ports--;
 227         port_num = (port->targ_port < CTL_MAX_PORTS) ? port->targ_port :
 228             port->targ_port - CTL_MAX_PORTS;
 229         ctl_clear_mask(softc->ctl_port_mask, port_num);
 230         softc->ctl_ports[port_num] = NULL;
 231         mtx_unlock(&softc->ctl_lock);
 232
 233         ctl_pool_free(pool);
 234         ctl_free_opts(&port->options);
 235
 236         ctl_lun_map_deinit(port);
 237         free(port->port_devid, M_CTL);
 238         port->port_devid = NULL;
 239         free(port->target_devid, M_CTL);
 240         port->target_devid = NULL;
 241         free(port->init_devid, M_CTL);
 242         port->init_devid = NULL;
 243         for (i = 0; i < port->max_initiators; i++)
 244                 free(port->wwpn_iid[i].name, M_CTL);
 245         free(port->wwpn_iid, M_CTL);
 246
 247 bailout:
 248         return (retval);
 249 }
 250
 251 void
 252 ctl_port_set_wwns(struct ctl_port *port, int wwnn_valid, uint64_t wwnn,
 253                       int wwpn_valid, uint64_t wwpn)
 254 {
 255         struct scsi_vpd_id_descriptor *desc;
 256         int len, proto;
 257
 258         if (port->port_type == CTL_PORT_FC)
 259                 proto = SCSI_PROTO_FC << 4;
 260         else if (port->port_type == CTL_PORT_ISCSI)
 261                 proto = SCSI_PROTO_ISCSI << 4;
 262         else
 263                 proto = SCSI_PROTO_SPI << 4;
 264
 265         if (wwnn_valid) {
 266                 port->wwnn = wwnn;
 267
 268                 free(port->target_devid, M_CTL);
 269
 270                 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
 271                 port->target_devid = malloc(sizeof(struct ctl_devid) + len,
 272                     M_CTL, M_WAITOK | M_ZERO);
 273                 port->target_devid->len = len;
 274                 desc = (struct scsi_vpd_id_descriptor *)port->target_devid->data;
 275                 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
 276                 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_TARGET |
 277                     SVPD_ID_TYPE_NAA;
 278                 desc->length = CTL_WWPN_LEN;
 279                 scsi_u64to8b(port->wwnn, desc->identifier);
 280         }
 281
 282         if (wwpn_valid) {
 283                 port->wwpn = wwpn;
 284
 285                 free(port->port_devid, M_CTL);
 286
 287                 len = sizeof(struct scsi_vpd_device_id) + CTL_WWPN_LEN;
 288                 port->port_devid = malloc(sizeof(struct ctl_devid) + len,
 289                     M_CTL, M_WAITOK | M_ZERO);
 290                 port->port_devid->len = len;
 291                 desc = (struct scsi_vpd_id_descriptor *)port->port_devid->data;
 292                 desc->proto_codeset = proto | SVPD_ID_CODESET_BINARY;
 293                 desc->id_type = SVPD_ID_PIV | SVPD_ID_ASSOC_PORT |
 294                     SVPD_ID_TYPE_NAA;
 295                 desc->length = CTL_WWPN_LEN;
 296                 scsi_u64to8b(port->wwpn, desc->identifier);
 297         }
 298 }
 299
 300 void
 301 ctl_port_online(struct ctl_port *port)
 302 {
 303         struct ctl_softc *softc = control_softc;
 304         struct ctl_lun *lun;
 305         uint32_t l;
 306
 307         if (port->lun_map) {
 308                 for (l = 0; l < CTL_MAX_LUNS; l++) {
 309                         if (ctl_lun_map_from_port(port, l) >= CTL_MAX_LUNS)
 310                                 continue;
 311                         port->lun_enable(port->targ_lun_arg, l);
 312                 }
 313         } else {
 314                 STAILQ_FOREACH(lun, &softc->lun_list, links)
 315                         port->lun_enable(port->targ_lun_arg, lun->lun);
 316         }
 317         port->port_online(port->onoff_arg);
 318         /* XXX KDM need a lock here? */
 319         port->status |= CTL_PORT_STATUS_ONLINE;
 320 }
 321
 322 void
 323 ctl_port_offline(struct ctl_port *port)
 324 {
 325         struct ctl_softc *softc = control_softc;
 326         struct ctl_lun *lun;
 327         uint32_t l;
 328
 329         port->port_offline(port->onoff_arg);
 330         if (port->lun_map) {
 331                 for (l = 0; l < CTL_MAX_LUNS; l++) {
 332                         if (ctl_lun_map_from_port(port, l) >= CTL_MAX_LUNS)
 333                                 continue;
 334                         port->lun_disable(port->targ_lun_arg, l);
 335                 }
 336         } else {
 337                 STAILQ_FOREACH(lun, &softc->lun_list, links)
 338                         port->lun_disable(port->targ_lun_arg, lun->lun);
 339         }
 340         /* XXX KDM need a lock here? */
 341         port->status &= ~CTL_PORT_STATUS_ONLINE;
 342 }
 343
 344 /*
 345  * vim: ts=8
 346  */