1 /*- 2 * Copyright (c) 2014 Alexander Motin <mav@FreeBSD.org> 3 * Copyright (c) 2004, 2005 Silicon Graphics International Corp. 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer, 11 * without modification, immediately at the beginning of the file. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #include <sys/cdefs.h> 29 __FBSDID("$FreeBSD$"); 30 31 #include <sys/param.h> 32 #include <sys/systm.h> 33 #include <sys/kernel.h> 34 #include <sys/types.h> 35 #include <sys/lock.h> 36 #include <sys/module.h> 37 #include <sys/mutex.h> 38 #include <sys/condvar.h> 39 #include <sys/malloc.h> 40 #include <sys/conf.h> 41 #include <sys/queue.h> 42 #include <sys/sysctl.h> 43 44 #include <cam/cam.h> 45 #include <cam/scsi/scsi_all.h> 46 #include <cam/scsi/scsi_da.h> 47 #include <cam/ctl/ctl_io.h> 48 #include <cam/ctl/ctl.h> 49 #include <cam/ctl/ctl_frontend.h> 50 #include <cam/ctl/ctl_util.h> 51 #include <cam/ctl/ctl_backend.h> 52 #include <cam/ctl/ctl_ioctl.h> 53 #include <cam/ctl/ctl_ha.h> 54 #include <cam/ctl/ctl_private.h> 55 #include <cam/ctl/ctl_debug.h> 56 #include <cam/ctl/ctl_scsi_all.h> 57 #include <cam/ctl/ctl_tpc.h> 58 #include <cam/ctl/ctl_error.h> 59 60 struct tpcl_softc { 61 struct ctl_port port; 62 int cur_tag_num; 63 }; 64 65 static struct tpcl_softc tpcl_softc; 66 67 static int tpcl_init(void); 68 static void tpcl_shutdown(void); 69 static void tpcl_datamove(union ctl_io *io); 70 static void tpcl_done(union ctl_io *io); 71 72 73 static struct ctl_frontend tpcl_frontend = 74 { 75 .name = "tpc", 76 .init = tpcl_init, 77 .shutdown = tpcl_shutdown, 78 }; 79 CTL_FRONTEND_DECLARE(ctltpc, tpcl_frontend); 80 81 static int 82 tpcl_init(void) 83 { 84 struct tpcl_softc *tsoftc = &tpcl_softc; 85 struct ctl_port *port; 86 struct scsi_transportid_spi *tid; 87 int len; 88 89 memset(tsoftc, 0, sizeof(*tsoftc)); 90 91 port = &tsoftc->port; 92 port->frontend = &tpcl_frontend; 93 port->port_type = CTL_PORT_INTERNAL; 94 port->num_requested_ctl_io = 100; 95 port->port_name = "tpc"; 96 port->fe_datamove = tpcl_datamove; 97 port->fe_done = tpcl_done; 98 port->max_targets = 1; 99 port->max_target_id = 0; 100 port->targ_port = -1; 101 port->max_initiators = 1; 102 103 if (ctl_port_register(port) != 0) { 104 printf("%s: ctl_port_register() failed with error\n", __func__); 105 return (0); 106 } 107 108 len = sizeof(struct scsi_transportid_spi); 109 port->init_devid = malloc(sizeof(struct ctl_devid) + len, 110 M_CTL, M_WAITOK | M_ZERO); 111 port->init_devid->len = len; 112 tid = (struct scsi_transportid_spi *)port->init_devid->data; 113 tid->format_protocol = SCSI_TRN_SPI_FORMAT_DEFAULT | SCSI_PROTO_SPI; 114 scsi_ulto2b(0, tid->scsi_addr); 115 scsi_ulto2b(port->targ_port, tid->rel_trgt_port_id); 116 117 ctl_port_online(port); 118 return (0); 119 } 120 121 void 122 tpcl_shutdown(void) 123 { 124 struct tpcl_softc *tsoftc = &tpcl_softc; 125 struct ctl_port *port; 126 127 port = &tsoftc->port; 128 ctl_port_offline(port); 129 if (ctl_port_deregister(&tsoftc->port) != 0) 130 printf("%s: ctl_frontend_deregister() failed\n", __func__); 131 } 132 133 static void 134 tpcl_datamove(union ctl_io *io) 135 { 136 struct ctl_sg_entry *ext_sglist, *kern_sglist; 137 struct ctl_sg_entry ext_entry, kern_entry; 138 int ext_sg_entries, kern_sg_entries; 139 int ext_sg_start, ext_offset; 140 int len_to_copy, len_copied; 141 int kern_watermark, ext_watermark; 142 struct ctl_scsiio *ctsio; 143 int i, j; 144 145 CTL_DEBUG_PRINT(("%s\n", __func__)); 146 147 ctsio = &io->scsiio; 148 149 /* 150 * If this is the case, we're probably doing a BBR read and don't 151 * actually need to transfer the data. This will effectively 152 * bit-bucket the data. 153 */ 154 if (ctsio->ext_data_ptr == NULL) 155 goto bailout; 156 157 /* 158 * To simplify things here, if we have a single buffer, stick it in 159 * a S/G entry and just make it a single entry S/G list. 160 */ 161 if (ctsio->ext_sg_entries > 0) { 162 int len_seen; 163 164 ext_sglist = (struct ctl_sg_entry *)ctsio->ext_data_ptr; 165 ext_sg_entries = ctsio->ext_sg_entries; 166 ext_sg_start = 0; 167 ext_offset = 0; 168 len_seen = 0; 169 for (i = 0; i < ext_sg_entries; i++) { 170 if ((len_seen + ext_sglist[i].len) >= 171 ctsio->ext_data_filled) { 172 ext_sg_start = i; 173 ext_offset = ctsio->ext_data_filled - len_seen; 174 break; 175 } 176 len_seen += ext_sglist[i].len; 177 } 178 } else { 179 ext_sglist = &ext_entry; 180 ext_sglist->addr = ctsio->ext_data_ptr; 181 ext_sglist->len = ctsio->ext_data_len; 182 ext_sg_entries = 1; 183 ext_sg_start = 0; 184 ext_offset = ctsio->ext_data_filled; 185 } 186 187 if (ctsio->kern_sg_entries > 0) { 188 kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr; 189 kern_sg_entries = ctsio->kern_sg_entries; 190 } else { 191 kern_sglist = &kern_entry; 192 kern_sglist->addr = ctsio->kern_data_ptr; 193 kern_sglist->len = ctsio->kern_data_len; 194 kern_sg_entries = 1; 195 } 196 197 kern_watermark = 0; 198 ext_watermark = ext_offset; 199 len_copied = 0; 200 for (i = ext_sg_start, j = 0; 201 i < ext_sg_entries && j < kern_sg_entries;) { 202 uint8_t *ext_ptr, *kern_ptr; 203 204 len_to_copy = min(ext_sglist[i].len - ext_watermark, 205 kern_sglist[j].len - kern_watermark); 206 207 ext_ptr = (uint8_t *)ext_sglist[i].addr; 208 ext_ptr = ext_ptr + ext_watermark; 209 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) { 210 /* 211 * XXX KDM fix this! 212 */ 213 panic("need to implement bus address support"); 214 #if 0 215 kern_ptr = bus_to_virt(kern_sglist[j].addr); 216 #endif 217 } else 218 kern_ptr = (uint8_t *)kern_sglist[j].addr; 219 kern_ptr = kern_ptr + kern_watermark; 220 221 kern_watermark += len_to_copy; 222 ext_watermark += len_to_copy; 223 224 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) == 225 CTL_FLAG_DATA_IN) { 226 CTL_DEBUG_PRINT(("%s: copying %d bytes to user\n", 227 __func__, len_to_copy)); 228 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__, 229 kern_ptr, ext_ptr)); 230 memcpy(ext_ptr, kern_ptr, len_to_copy); 231 } else { 232 CTL_DEBUG_PRINT(("%s: copying %d bytes from user\n", 233 __func__, len_to_copy)); 234 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__, 235 ext_ptr, kern_ptr)); 236 memcpy(kern_ptr, ext_ptr, len_to_copy); 237 } 238 239 len_copied += len_to_copy; 240 241 if (ext_sglist[i].len == ext_watermark) { 242 i++; 243 ext_watermark = 0; 244 } 245 246 if (kern_sglist[j].len == kern_watermark) { 247 j++; 248 kern_watermark = 0; 249 } 250 } 251 252 ctsio->ext_data_filled += len_copied; 253 254 CTL_DEBUG_PRINT(("%s: ext_sg_entries: %d, kern_sg_entries: %d\n", 255 __func__, ext_sg_entries, kern_sg_entries)); 256 CTL_DEBUG_PRINT(("%s: ext_data_len = %d, kern_data_len = %d\n", 257 __func__, ctsio->ext_data_len, ctsio->kern_data_len)); 258 259 /* XXX KDM set residual?? */ 260 bailout: 261 io->scsiio.be_move_done(io); 262 } 263 264 static void 265 tpcl_done(union ctl_io *io) 266 { 267 268 tpc_done(io); 269 } 270 271 uint64_t 272 tpcl_resolve(struct ctl_softc *softc, int init_port, 273 struct scsi_ec_cscd *cscd, uint32_t *ss, uint32_t *ps, uint32_t *pso) 274 { 275 struct scsi_ec_cscd_id *cscdid; 276 struct ctl_port *port; 277 struct ctl_lun *lun; 278 uint64_t lunid = UINT64_MAX; 279 280 if (cscd->type_code != EC_CSCD_ID || 281 (cscd->luidt_pdt & EC_LUIDT_MASK) != EC_LUIDT_LUN || 282 (cscd->luidt_pdt & EC_NUL) != 0) 283 return (lunid); 284 285 cscdid = (struct scsi_ec_cscd_id *)cscd; 286 mtx_lock(&softc->ctl_lock); 287 if (init_port >= 0) 288 port = softc->ctl_ports[init_port]; 289 else 290 port = NULL; 291 STAILQ_FOREACH(lun, &softc->lun_list, links) { 292 if (port != NULL && 293 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS) 294 continue; 295 if (lun->lun_devid == NULL) 296 continue; 297 if (scsi_devid_match(lun->lun_devid->data, 298 lun->lun_devid->len, &cscdid->codeset, 299 cscdid->length + 4) == 0) { 300 lunid = lun->lun; 301 if (ss && lun->be_lun) 302 *ss = lun->be_lun->blocksize; 303 if (ps && lun->be_lun) 304 *ps = lun->be_lun->blocksize << 305 lun->be_lun->pblockexp; 306 if (pso && lun->be_lun) 307 *pso = lun->be_lun->blocksize * 308 lun->be_lun->pblockoff; 309 break; 310 } 311 } 312 mtx_unlock(&softc->ctl_lock); 313 return (lunid); 314 }; 315 316 union ctl_io * 317 tpcl_alloc_io(void) 318 { 319 struct tpcl_softc *tsoftc = &tpcl_softc; 320 321 return (ctl_alloc_io(tsoftc->port.ctl_pool_ref)); 322 }; 323 324 int 325 tpcl_queue(union ctl_io *io, uint64_t lun) 326 { 327 struct tpcl_softc *tsoftc = &tpcl_softc; 328 329 io->io_hdr.nexus.initid = 0; 330 io->io_hdr.nexus.targ_port = tsoftc->port.targ_port; 331 io->io_hdr.nexus.targ_lun = lun; 332 io->scsiio.tag_num = atomic_fetchadd_int(&tsoftc->cur_tag_num, 1); 333 io->scsiio.ext_data_filled = 0; 334 return (ctl_queue(io)); 335 } 336