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_frontend_internal.h>
51 #include <cam/ctl/ctl_util.h>
52 #include <cam/ctl/ctl_backend.h>
53 #include <cam/ctl/ctl_ioctl.h>
54 #include <cam/ctl/ctl_ha.h>
55 #include <cam/ctl/ctl_private.h>
56 #include <cam/ctl/ctl_debug.h>
57 #include <cam/ctl/ctl_scsi_all.h>
58 #include <cam/ctl/ctl_tpc.h>
59 #include <cam/ctl/ctl_error.h>
60
61 struct tpcl_softc {
62 struct ctl_port port;
63 int cur_tag_num;
64 };
65
66 static struct tpcl_softc tpcl_softc;
67
68 static int tpcl_init(void);
69 static void tpcl_shutdown(void);
70 static void tpcl_online(void *arg);
71 static void tpcl_offline(void *arg);
72 static int tpcl_lun_enable(void *arg, struct ctl_id target_id, int lun_id);
73 static int tpcl_lun_disable(void *arg, struct ctl_id target_id, int lun_id);
74 static void tpcl_datamove(union ctl_io *io);
75 static void tpcl_done(union ctl_io *io);
76
77
78 static struct ctl_frontend tpcl_frontend =
79 {
80 .name = "tpc",
81 .init = tpcl_init,
82 .shutdown = tpcl_shutdown,
83 };
84 CTL_FRONTEND_DECLARE(ctltpc, tpcl_frontend);
85
86 static int
tpcl_init(void)87 tpcl_init(void)
88 {
89 struct tpcl_softc *tsoftc = &tpcl_softc;
90 struct ctl_port *port;
91 struct scsi_transportid_spi *tid;
92 int len;
93
94 memset(tsoftc, 0, sizeof(*tsoftc));
95
96 port = &tsoftc->port;
97 port->frontend = &tpcl_frontend;
98 port->port_type = CTL_PORT_INTERNAL;
99 port->num_requested_ctl_io = 100;
100 port->port_name = "tpc";
101 port->port_online = tpcl_online;
102 port->port_offline = tpcl_offline;
103 port->onoff_arg = tsoftc;
104 port->lun_enable = tpcl_lun_enable;
105 port->lun_disable = tpcl_lun_disable;
106 port->targ_lun_arg = tsoftc;
107 port->fe_datamove = tpcl_datamove;
108 port->fe_done = tpcl_done;
109 port->max_targets = 1;
110 port->max_target_id = 0;
111 port->max_initiators = 1;
112
113 if (ctl_port_register(port) != 0)
114 {
115 printf("%s: tpc frontend registration failed\n", __func__);
116 return (0);
117 }
118
119 len = sizeof(struct scsi_transportid_spi);
120 port->init_devid = malloc(sizeof(struct ctl_devid) + len,
121 M_CTL, M_WAITOK | M_ZERO);
122 port->init_devid->len = len;
123 tid = (struct scsi_transportid_spi *)port->init_devid->data;
124 tid->format_protocol = SCSI_TRN_SPI_FORMAT_DEFAULT | SCSI_PROTO_SPI;
125 scsi_ulto2b(0, tid->scsi_addr);
126 scsi_ulto2b(port->targ_port, tid->rel_trgt_port_id);
127
128 ctl_port_online(port);
129 return (0);
130 }
131
132 void
tpcl_shutdown(void)133 tpcl_shutdown(void)
134 {
135 struct tpcl_softc *tsoftc = &tpcl_softc;
136 struct ctl_port *port;
137
138 port = &tsoftc->port;
139 ctl_port_offline(port);
140 if (ctl_port_deregister(&tsoftc->port) != 0)
141 printf("%s: ctl_frontend_deregister() failed\n", __func__);
142 }
143
144 static void
tpcl_online(void * arg)145 tpcl_online(void *arg)
146 {
147 }
148
149 static void
tpcl_offline(void * arg)150 tpcl_offline(void *arg)
151 {
152 }
153
154 static int
tpcl_lun_enable(void * arg,struct ctl_id target_id,int lun_id)155 tpcl_lun_enable(void *arg, struct ctl_id target_id, int lun_id)
156 {
157
158 return (0);
159 }
160
161 static int
tpcl_lun_disable(void * arg,struct ctl_id target_id,int lun_id)162 tpcl_lun_disable(void *arg, struct ctl_id target_id, int lun_id)
163 {
164
165 return (0);
166 }
167
168 static void
tpcl_datamove(union ctl_io * io)169 tpcl_datamove(union ctl_io *io)
170 {
171 struct ctl_sg_entry *ext_sglist, *kern_sglist;
172 struct ctl_sg_entry ext_entry, kern_entry;
173 int ext_sg_entries, kern_sg_entries;
174 int ext_sg_start, ext_offset;
175 int len_to_copy, len_copied;
176 int kern_watermark, ext_watermark;
177 struct ctl_scsiio *ctsio;
178 int i, j;
179
180 ext_sg_start = 0;
181 ext_offset = 0;
182 ext_sglist = NULL;
183
184 CTL_DEBUG_PRINT(("%s\n", __func__));
185
186 ctsio = &io->scsiio;
187
188 /*
189 * If this is the case, we're probably doing a BBR read and don't
190 * actually need to transfer the data. This will effectively
191 * bit-bucket the data.
192 */
193 if (ctsio->ext_data_ptr == NULL)
194 goto bailout;
195
196 /*
197 * To simplify things here, if we have a single buffer, stick it in
198 * a S/G entry and just make it a single entry S/G list.
199 */
200 if (ctsio->io_hdr.flags & CTL_FLAG_EDPTR_SGLIST) {
201 int len_seen;
202
203 ext_sglist = (struct ctl_sg_entry *)ctsio->ext_data_ptr;
204 ext_sg_entries = ctsio->ext_sg_entries;
205 ext_sg_start = 0;
206 ext_offset = 0;
207 len_seen = 0;
208 for (i = 0; i < ext_sg_entries; i++) {
209 if ((len_seen + ext_sglist[i].len) >=
210 ctsio->ext_data_filled) {
211 ext_sg_start = i;
212 ext_offset = ctsio->ext_data_filled - len_seen;
213 break;
214 }
215 len_seen += ext_sglist[i].len;
216 }
217 } else {
218 ext_sglist = &ext_entry;
219 ext_sglist->addr = ctsio->ext_data_ptr;
220 ext_sglist->len = ctsio->ext_data_len;
221 ext_sg_entries = 1;
222 ext_sg_start = 0;
223 ext_offset = ctsio->ext_data_filled;
224 }
225
226 if (ctsio->kern_sg_entries > 0) {
227 kern_sglist = (struct ctl_sg_entry *)ctsio->kern_data_ptr;
228 kern_sg_entries = ctsio->kern_sg_entries;
229 } else {
230 kern_sglist = &kern_entry;
231 kern_sglist->addr = ctsio->kern_data_ptr;
232 kern_sglist->len = ctsio->kern_data_len;
233 kern_sg_entries = 1;
234 }
235
236 kern_watermark = 0;
237 ext_watermark = ext_offset;
238 len_copied = 0;
239 for (i = ext_sg_start, j = 0;
240 i < ext_sg_entries && j < kern_sg_entries;) {
241 uint8_t *ext_ptr, *kern_ptr;
242
243 len_to_copy = min(ext_sglist[i].len - ext_watermark,
244 kern_sglist[j].len - kern_watermark);
245
246 ext_ptr = (uint8_t *)ext_sglist[i].addr;
247 ext_ptr = ext_ptr + ext_watermark;
248 if (io->io_hdr.flags & CTL_FLAG_BUS_ADDR) {
249 /*
250 * XXX KDM fix this!
251 */
252 panic("need to implement bus address support");
253 #if 0
254 kern_ptr = bus_to_virt(kern_sglist[j].addr);
255 #endif
256 } else
257 kern_ptr = (uint8_t *)kern_sglist[j].addr;
258 kern_ptr = kern_ptr + kern_watermark;
259
260 kern_watermark += len_to_copy;
261 ext_watermark += len_to_copy;
262
263 if ((ctsio->io_hdr.flags & CTL_FLAG_DATA_MASK) ==
264 CTL_FLAG_DATA_IN) {
265 CTL_DEBUG_PRINT(("%s: copying %d bytes to user\n",
266 __func__, len_to_copy));
267 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__,
268 kern_ptr, ext_ptr));
269 memcpy(ext_ptr, kern_ptr, len_to_copy);
270 } else {
271 CTL_DEBUG_PRINT(("%s: copying %d bytes from user\n",
272 __func__, len_to_copy));
273 CTL_DEBUG_PRINT(("%s: from %p to %p\n", __func__,
274 ext_ptr, kern_ptr));
275 memcpy(kern_ptr, ext_ptr, len_to_copy);
276 }
277
278 len_copied += len_to_copy;
279
280 if (ext_sglist[i].len == ext_watermark) {
281 i++;
282 ext_watermark = 0;
283 }
284
285 if (kern_sglist[j].len == kern_watermark) {
286 j++;
287 kern_watermark = 0;
288 }
289 }
290
291 ctsio->ext_data_filled += len_copied;
292
293 CTL_DEBUG_PRINT(("%s: ext_sg_entries: %d, kern_sg_entries: %d\n",
294 __func__, ext_sg_entries, kern_sg_entries));
295 CTL_DEBUG_PRINT(("%s: ext_data_len = %d, kern_data_len = %d\n",
296 __func__, ctsio->ext_data_len, ctsio->kern_data_len));
297
298 /* XXX KDM set residual?? */
299 bailout:
300 io->scsiio.be_move_done(io);
301 }
302
303 static void
tpcl_done(union ctl_io * io)304 tpcl_done(union ctl_io *io)
305 {
306
307 tpc_done(io);
308 }
309
310 uint64_t
tpcl_resolve(struct ctl_softc * softc,int init_port,struct scsi_ec_cscd * cscd,uint32_t * ss,uint32_t * ps,uint32_t * pso)311 tpcl_resolve(struct ctl_softc *softc, int init_port,
312 struct scsi_ec_cscd *cscd, uint32_t *ss, uint32_t *ps, uint32_t *pso)
313 {
314 struct scsi_ec_cscd_id *cscdid;
315 struct ctl_port *port;
316 struct ctl_lun *lun;
317 uint64_t lunid = UINT64_MAX;
318
319 if (cscd->type_code != EC_CSCD_ID)
320 return (lunid);
321
322 cscdid = (struct scsi_ec_cscd_id *)cscd;
323 mtx_lock(&softc->ctl_lock);
324 if (init_port >= 0)
325 port = softc->ctl_ports[ctl_port_idx(init_port)];
326 else
327 port = NULL;
328 STAILQ_FOREACH(lun, &softc->lun_list, links) {
329 if (port != NULL &&
330 ctl_lun_map_to_port(port, lun->lun) >= CTL_MAX_LUNS)
331 continue;
332 if (lun->lun_devid == NULL)
333 continue;
334 if (scsi_devid_match(lun->lun_devid->data,
335 lun->lun_devid->len, &cscdid->codeset,
336 cscdid->length + 4) == 0) {
337 lunid = lun->lun;
338 if (ss && lun->be_lun)
339 *ss = lun->be_lun->blocksize;
340 if (ps && lun->be_lun)
341 *ps = lun->be_lun->blocksize <<
342 lun->be_lun->pblockexp;
343 if (pso && lun->be_lun)
344 *pso = lun->be_lun->blocksize *
345 lun->be_lun->pblockoff;
346 break;
347 }
348 }
349 mtx_unlock(&softc->ctl_lock);
350 return (lunid);
351 };
352
353 union ctl_io *
tpcl_alloc_io(void)354 tpcl_alloc_io(void)
355 {
356 struct tpcl_softc *tsoftc = &tpcl_softc;
357
358 return (ctl_alloc_io(tsoftc->port.ctl_pool_ref));
359 };
360
361 int
tpcl_queue(union ctl_io * io,uint64_t lun)362 tpcl_queue(union ctl_io *io, uint64_t lun)
363 {
364 struct tpcl_softc *tsoftc = &tpcl_softc;
365
366 io->io_hdr.nexus.initid.id = 0;
367 io->io_hdr.nexus.targ_port = tsoftc->port.targ_port;
368 io->io_hdr.nexus.targ_target.id = 0;
369 io->io_hdr.nexus.targ_lun = lun;
370 io->scsiio.tag_num = atomic_fetchadd_int(&tsoftc->cur_tag_num, 1);
371 io->scsiio.ext_data_filled = 0;
372 return (ctl_queue(io));
373 }
374