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