2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1997, 1998, 2000 Justin T. Gibbs.
5 * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification, immediately at the beginning of the file.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/types.h>
40 #include <sys/devicestat.h>
41 #include <sys/errno.h>
42 #include <sys/fcntl.h>
43 #include <sys/malloc.h>
46 #include <sys/selinfo.h>
48 #include <sys/sysent.h>
49 #include <sys/taskqueue.h>
52 #include <vm/vm_extern.h>
54 #include <machine/bus.h>
57 #include <cam/cam_ccb.h>
58 #include <cam/cam_periph.h>
59 #include <cam/cam_queue.h>
60 #include <cam/cam_xpt.h>
61 #include <cam/cam_xpt_periph.h>
62 #include <cam/cam_debug.h>
63 #include <cam/cam_compat.h>
64 #include <cam/cam_xpt_periph.h>
66 #include <cam/scsi/scsi_all.h>
67 #include <cam/scsi/scsi_pass.h>
70 PASS_FLAG_OPEN = 0x01,
71 PASS_FLAG_LOCKED = 0x02,
72 PASS_FLAG_INVALID = 0x04,
73 PASS_FLAG_INITIAL_PHYSPATH = 0x08,
74 PASS_FLAG_ZONE_INPROG = 0x10,
75 PASS_FLAG_ZONE_VALID = 0x20,
76 PASS_FLAG_UNMAPPED_CAPABLE = 0x40,
77 PASS_FLAG_ABANDONED_REF_SET = 0x80
89 #define ccb_type ppriv_field0
90 #define ccb_ioreq ppriv_ptr1
93 * The maximum number of memory segments we preallocate.
95 #define PASS_MAX_SEGS 16
99 PASS_IO_USER_SEG_MALLOC = 0x01,
100 PASS_IO_KERN_SEG_MALLOC = 0x02,
101 PASS_IO_ABANDONED = 0x04
106 union ccb *alloced_ccb;
107 union ccb *user_ccb_ptr;
108 camq_entry user_periph_links;
109 ccb_ppriv_area user_periph_priv;
110 struct cam_periph_map_info mapinfo;
112 ccb_flags data_flags;
114 bus_dma_segment_t user_segs[PASS_MAX_SEGS];
116 bus_dma_segment_t kern_segs[PASS_MAX_SEGS];
117 bus_dma_segment_t *user_segptr;
118 bus_dma_segment_t *kern_segptr;
120 uint32_t dirs[CAM_PERIPH_MAXMAPS];
121 uint32_t lengths[CAM_PERIPH_MAXMAPS];
122 uint8_t *user_bufs[CAM_PERIPH_MAXMAPS];
123 uint8_t *kern_bufs[CAM_PERIPH_MAXMAPS];
124 struct bintime start_time;
125 TAILQ_ENTRY(pass_io_req) links;
135 struct devstat *device_stats;
137 struct cdev *alias_dev;
138 struct task add_physpath_task;
139 struct task shutdown_kqueue_task;
140 struct selinfo read_select;
141 TAILQ_HEAD(, pass_io_req) incoming_queue;
142 TAILQ_HEAD(, pass_io_req) active_queue;
143 TAILQ_HEAD(, pass_io_req) abandoned_queue;
144 TAILQ_HEAD(, pass_io_req) done_queue;
145 struct cam_periph *periph;
147 char io_zone_name[12];
148 uma_zone_t pass_zone;
149 uma_zone_t pass_io_zone;
153 static d_open_t passopen;
154 static d_close_t passclose;
155 static d_ioctl_t passioctl;
156 static d_ioctl_t passdoioctl;
157 static d_poll_t passpoll;
158 static d_kqfilter_t passkqfilter;
159 static void passreadfiltdetach(struct knote *kn);
160 static int passreadfilt(struct knote *kn, long hint);
162 static periph_init_t passinit;
163 static periph_ctor_t passregister;
164 static periph_oninv_t passoninvalidate;
165 static periph_dtor_t passcleanup;
166 static periph_start_t passstart;
167 static void pass_shutdown_kqueue(void *context, int pending);
168 static void pass_add_physpath(void *context, int pending);
169 static void passasync(void *callback_arg, u_int32_t code,
170 struct cam_path *path, void *arg);
171 static void passdone(struct cam_periph *periph,
172 union ccb *done_ccb);
173 static int passcreatezone(struct cam_periph *periph);
174 static void passiocleanup(struct pass_softc *softc,
175 struct pass_io_req *io_req);
176 static int passcopysglist(struct cam_periph *periph,
177 struct pass_io_req *io_req,
178 ccb_flags direction);
179 static int passmemsetup(struct cam_periph *periph,
180 struct pass_io_req *io_req);
181 static int passmemdone(struct cam_periph *periph,
182 struct pass_io_req *io_req);
183 static int passerror(union ccb *ccb, u_int32_t cam_flags,
184 u_int32_t sense_flags);
185 static int passsendccb(struct cam_periph *periph, union ccb *ccb,
188 static struct periph_driver passdriver =
191 TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
194 PERIPHDRIVER_DECLARE(pass, passdriver);
196 static struct cdevsw pass_cdevsw = {
197 .d_version = D_VERSION,
198 .d_flags = D_TRACKCLOSE,
200 .d_close = passclose,
201 .d_ioctl = passioctl,
203 .d_kqfilter = passkqfilter,
207 static struct filterops passread_filtops = {
209 .f_detach = passreadfiltdetach,
210 .f_event = passreadfilt
213 static MALLOC_DEFINE(M_SCSIPASS, "scsi_pass", "scsi passthrough buffers");
221 * Install a global async callback. This callback will
222 * receive async callbacks like "new device found".
224 status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
226 if (status != CAM_REQ_CMP) {
227 printf("pass: Failed to attach master async callback "
228 "due to status 0x%x!\n", status);
234 passrejectios(struct cam_periph *periph)
236 struct pass_io_req *io_req, *io_req2;
237 struct pass_softc *softc;
239 softc = (struct pass_softc *)periph->softc;
242 * The user can no longer get status for I/O on the done queue, so
243 * clean up all outstanding I/O on the done queue.
245 TAILQ_FOREACH_SAFE(io_req, &softc->done_queue, links, io_req2) {
246 TAILQ_REMOVE(&softc->done_queue, io_req, links);
247 passiocleanup(softc, io_req);
248 uma_zfree(softc->pass_zone, io_req);
252 * The underlying device is gone, so we can't issue these I/Os.
253 * The devfs node has been shut down, so we can't return status to
254 * the user. Free any I/O left on the incoming queue.
256 TAILQ_FOREACH_SAFE(io_req, &softc->incoming_queue, links, io_req2) {
257 TAILQ_REMOVE(&softc->incoming_queue, io_req, links);
258 passiocleanup(softc, io_req);
259 uma_zfree(softc->pass_zone, io_req);
263 * Normally we would put I/Os on the abandoned queue and acquire a
264 * reference when we saw the final close. But, the device went
265 * away and devfs may have moved everything off to deadfs by the
266 * time the I/O done callback is called; as a result, we won't see
267 * any more closes. So, if we have any active I/Os, we need to put
268 * them on the abandoned queue. When the abandoned queue is empty,
269 * we'll release the remaining reference (see below) to the peripheral.
271 TAILQ_FOREACH_SAFE(io_req, &softc->active_queue, links, io_req2) {
272 TAILQ_REMOVE(&softc->active_queue, io_req, links);
273 io_req->flags |= PASS_IO_ABANDONED;
274 TAILQ_INSERT_TAIL(&softc->abandoned_queue, io_req, links);
278 * If we put any I/O on the abandoned queue, acquire a reference.
280 if ((!TAILQ_EMPTY(&softc->abandoned_queue))
281 && ((softc->flags & PASS_FLAG_ABANDONED_REF_SET) == 0)) {
282 cam_periph_doacquire(periph);
283 softc->flags |= PASS_FLAG_ABANDONED_REF_SET;
288 passdevgonecb(void *arg)
290 struct cam_periph *periph;
292 struct pass_softc *softc;
295 periph = (struct cam_periph *)arg;
296 mtx = cam_periph_mtx(periph);
299 softc = (struct pass_softc *)periph->softc;
300 KASSERT(softc->open_count >= 0, ("Negative open count %d",
304 * When we get this callback, we will get no more close calls from
305 * devfs. So if we have any dangling opens, we need to release the
306 * reference held for that particular context.
308 for (i = 0; i < softc->open_count; i++)
309 cam_periph_release_locked(periph);
311 softc->open_count = 0;
314 * Release the reference held for the device node, it is gone now.
315 * Accordingly, inform all queued I/Os of their fate.
317 cam_periph_release_locked(periph);
318 passrejectios(periph);
321 * We reference the SIM lock directly here, instead of using
322 * cam_periph_unlock(). The reason is that the final call to
323 * cam_periph_release_locked() above could result in the periph
324 * getting freed. If that is the case, dereferencing the periph
325 * with a cam_periph_unlock() call would cause a page fault.
330 * We have to remove our kqueue context from a thread because it
331 * may sleep. It would be nice if we could get a callback from
332 * kqueue when it is done cleaning up resources.
334 taskqueue_enqueue(taskqueue_thread, &softc->shutdown_kqueue_task);
338 passoninvalidate(struct cam_periph *periph)
340 struct pass_softc *softc;
342 softc = (struct pass_softc *)periph->softc;
345 * De-register any async callbacks.
347 xpt_register_async(0, passasync, periph, periph->path);
349 softc->flags |= PASS_FLAG_INVALID;
352 * Tell devfs this device has gone away, and ask for a callback
353 * when it has cleaned up its state.
355 destroy_dev_sched_cb(softc->dev, passdevgonecb, periph);
359 passcleanup(struct cam_periph *periph)
361 struct pass_softc *softc;
363 softc = (struct pass_softc *)periph->softc;
365 cam_periph_assert(periph, MA_OWNED);
366 KASSERT(TAILQ_EMPTY(&softc->active_queue),
367 ("%s called when there are commands on the active queue!\n",
369 KASSERT(TAILQ_EMPTY(&softc->abandoned_queue),
370 ("%s called when there are commands on the abandoned queue!\n",
372 KASSERT(TAILQ_EMPTY(&softc->incoming_queue),
373 ("%s called when there are commands on the incoming queue!\n",
375 KASSERT(TAILQ_EMPTY(&softc->done_queue),
376 ("%s called when there are commands on the done queue!\n",
379 devstat_remove_entry(softc->device_stats);
381 cam_periph_unlock(periph);
384 * We call taskqueue_drain() for the physpath task to make sure it
385 * is complete. We drop the lock because this can potentially
386 * sleep. XXX KDM that is bad. Need a way to get a callback when
387 * a taskqueue is drained.
389 * Note that we don't drain the kqueue shutdown task queue. This
390 * is because we hold a reference on the periph for kqueue, and
391 * release that reference from the kqueue shutdown task queue. So
392 * we cannot come into this routine unless we've released that
393 * reference. Also, because that could be the last reference, we
394 * could be called from the cam_periph_release() call in
395 * pass_shutdown_kqueue(). In that case, the taskqueue_drain()
396 * would deadlock. It would be preferable if we had a way to
397 * get a callback when a taskqueue is done.
399 taskqueue_drain(taskqueue_thread, &softc->add_physpath_task);
401 cam_periph_lock(periph);
403 free(softc, M_DEVBUF);
407 pass_shutdown_kqueue(void *context, int pending)
409 struct cam_periph *periph;
410 struct pass_softc *softc;
413 softc = periph->softc;
415 knlist_clear(&softc->read_select.si_note, /*is_locked*/ 0);
416 knlist_destroy(&softc->read_select.si_note);
419 * Release the reference we held for kqueue.
421 cam_periph_release(periph);
425 pass_add_physpath(void *context, int pending)
427 struct cam_periph *periph;
428 struct pass_softc *softc;
433 * If we have one, create a devfs alias for our
437 softc = periph->softc;
438 physpath = malloc(MAXPATHLEN, M_DEVBUF, M_WAITOK);
439 mtx = cam_periph_mtx(periph);
442 if (periph->flags & CAM_PERIPH_INVALID)
445 if (xpt_getattr(physpath, MAXPATHLEN,
446 "GEOM::physpath", periph->path) == 0
447 && strlen(physpath) != 0) {
449 make_dev_physpath_alias(MAKEDEV_WAITOK, &softc->alias_dev,
450 softc->dev, softc->alias_dev, physpath);
456 * Now that we've made our alias, we no longer have to have a
457 * reference to the device.
459 if ((softc->flags & PASS_FLAG_INITIAL_PHYSPATH) == 0)
460 softc->flags |= PASS_FLAG_INITIAL_PHYSPATH;
463 * We always acquire a reference to the periph before queueing this
464 * task queue function, so it won't go away before we run.
466 while (pending-- > 0)
467 cam_periph_release_locked(periph);
470 free(physpath, M_DEVBUF);
474 passasync(void *callback_arg, u_int32_t code,
475 struct cam_path *path, void *arg)
477 struct cam_periph *periph;
479 periph = (struct cam_periph *)callback_arg;
482 case AC_FOUND_DEVICE:
484 struct ccb_getdev *cgd;
487 cgd = (struct ccb_getdev *)arg;
492 * Allocate a peripheral instance for
493 * this device and start the probe
496 status = cam_periph_alloc(passregister, passoninvalidate,
497 passcleanup, passstart, "pass",
498 CAM_PERIPH_BIO, path,
499 passasync, AC_FOUND_DEVICE, cgd);
501 if (status != CAM_REQ_CMP
502 && status != CAM_REQ_INPROG) {
503 const struct cam_status_entry *entry;
505 entry = cam_fetch_status_entry(status);
507 printf("passasync: Unable to attach new device "
508 "due to status %#x: %s\n", status, entry ?
509 entry->status_text : "Unknown");
514 case AC_ADVINFO_CHANGED:
518 buftype = (uintptr_t)arg;
519 if (buftype == CDAI_TYPE_PHYS_PATH) {
520 struct pass_softc *softc;
522 softc = (struct pass_softc *)periph->softc;
524 * Acquire a reference to the periph before we
525 * start the taskqueue, so that we don't run into
526 * a situation where the periph goes away before
527 * the task queue has a chance to run.
529 if (cam_periph_acquire(periph) != 0)
532 taskqueue_enqueue(taskqueue_thread,
533 &softc->add_physpath_task);
538 cam_periph_async(periph, code, path, arg);
544 passregister(struct cam_periph *periph, void *arg)
546 struct pass_softc *softc;
547 struct ccb_getdev *cgd;
548 struct ccb_pathinq cpi;
549 struct make_dev_args args;
552 cgd = (struct ccb_getdev *)arg;
554 printf("%s: no getdev CCB, can't register device\n", __func__);
555 return(CAM_REQ_CMP_ERR);
558 softc = (struct pass_softc *)malloc(sizeof(*softc),
562 printf("%s: Unable to probe new device. "
563 "Unable to allocate softc\n", __func__);
564 return(CAM_REQ_CMP_ERR);
567 bzero(softc, sizeof(*softc));
568 softc->state = PASS_STATE_NORMAL;
569 if (cgd->protocol == PROTO_SCSI || cgd->protocol == PROTO_ATAPI)
570 softc->pd_type = SID_TYPE(&cgd->inq_data);
571 else if (cgd->protocol == PROTO_SATAPM)
572 softc->pd_type = T_ENCLOSURE;
574 softc->pd_type = T_DIRECT;
576 periph->softc = softc;
577 softc->periph = periph;
578 TAILQ_INIT(&softc->incoming_queue);
579 TAILQ_INIT(&softc->active_queue);
580 TAILQ_INIT(&softc->abandoned_queue);
581 TAILQ_INIT(&softc->done_queue);
582 snprintf(softc->zone_name, sizeof(softc->zone_name), "%s%d",
583 periph->periph_name, periph->unit_number);
584 snprintf(softc->io_zone_name, sizeof(softc->io_zone_name), "%s%dIO",
585 periph->periph_name, periph->unit_number);
586 softc->io_zone_size = maxphys;
587 knlist_init_mtx(&softc->read_select.si_note, cam_periph_mtx(periph));
589 xpt_path_inq(&cpi, periph->path);
592 softc->maxio = DFLTPHYS; /* traditional default */
593 else if (cpi.maxio > maxphys)
594 softc->maxio = maxphys; /* for safety */
596 softc->maxio = cpi.maxio; /* real value */
598 if (cpi.hba_misc & PIM_UNMAPPED)
599 softc->flags |= PASS_FLAG_UNMAPPED_CAPABLE;
602 * We pass in 0 for a blocksize, since we don't
603 * know what the blocksize of this device is, if
604 * it even has a blocksize.
606 cam_periph_unlock(periph);
607 no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
608 softc->device_stats = devstat_new_entry("pass",
609 periph->unit_number, 0,
611 | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
613 XPORT_DEVSTAT_TYPE(cpi.transport) |
615 DEVSTAT_PRIORITY_PASS);
618 * Initialize the taskqueue handler for shutting down kqueue.
620 TASK_INIT(&softc->shutdown_kqueue_task, /*priority*/ 0,
621 pass_shutdown_kqueue, periph);
624 * Acquire a reference to the periph that we can release once we've
625 * cleaned up the kqueue.
627 if (cam_periph_acquire(periph) != 0) {
628 xpt_print(periph->path, "%s: lost periph during "
629 "registration!\n", __func__);
630 cam_periph_lock(periph);
631 return (CAM_REQ_CMP_ERR);
635 * Acquire a reference to the periph before we create the devfs
636 * instance for it. We'll release this reference once the devfs
637 * instance has been freed.
639 if (cam_periph_acquire(periph) != 0) {
640 xpt_print(periph->path, "%s: lost periph during "
641 "registration!\n", __func__);
642 cam_periph_lock(periph);
643 return (CAM_REQ_CMP_ERR);
646 /* Register the device */
647 make_dev_args_init(&args);
648 args.mda_devsw = &pass_cdevsw;
649 args.mda_unit = periph->unit_number;
650 args.mda_uid = UID_ROOT;
651 args.mda_gid = GID_OPERATOR;
652 args.mda_mode = 0600;
653 args.mda_si_drv1 = periph;
654 args.mda_flags = MAKEDEV_NOWAIT;
655 error = make_dev_s(&args, &softc->dev, "%s%d", periph->periph_name,
656 periph->unit_number);
658 cam_periph_lock(periph);
659 cam_periph_release_locked(periph);
660 return (CAM_REQ_CMP_ERR);
664 * Hold a reference to the periph before we create the physical
665 * path alias so it can't go away.
667 if (cam_periph_acquire(periph) != 0) {
668 xpt_print(periph->path, "%s: lost periph during "
669 "registration!\n", __func__);
670 cam_periph_lock(periph);
671 return (CAM_REQ_CMP_ERR);
674 cam_periph_lock(periph);
676 TASK_INIT(&softc->add_physpath_task, /*priority*/0,
677 pass_add_physpath, periph);
680 * See if physical path information is already available.
682 taskqueue_enqueue(taskqueue_thread, &softc->add_physpath_task);
685 * Add an async callback so that we get notified if
686 * this device goes away or its physical path
687 * (stored in the advanced info data of the EDT) has
690 xpt_register_async(AC_LOST_DEVICE | AC_ADVINFO_CHANGED,
691 passasync, periph, periph->path);
694 xpt_announce_periph(periph, NULL);
700 passopen(struct cdev *dev, int flags, int fmt, struct thread *td)
702 struct cam_periph *periph;
703 struct pass_softc *softc;
706 periph = (struct cam_periph *)dev->si_drv1;
707 if (cam_periph_acquire(periph) != 0)
710 cam_periph_lock(periph);
712 softc = (struct pass_softc *)periph->softc;
714 if (softc->flags & PASS_FLAG_INVALID) {
715 cam_periph_release_locked(periph);
716 cam_periph_unlock(periph);
721 * Don't allow access when we're running at a high securelevel.
723 error = securelevel_gt(td->td_ucred, 1);
725 cam_periph_release_locked(periph);
726 cam_periph_unlock(periph);
731 * Only allow read-write access.
733 if (((flags & FWRITE) == 0) || ((flags & FREAD) == 0)) {
734 cam_periph_release_locked(periph);
735 cam_periph_unlock(periph);
740 * We don't allow nonblocking access.
742 if ((flags & O_NONBLOCK) != 0) {
743 xpt_print(periph->path, "can't do nonblocking access\n");
744 cam_periph_release_locked(periph);
745 cam_periph_unlock(periph);
751 cam_periph_unlock(periph);
757 passclose(struct cdev *dev, int flag, int fmt, struct thread *td)
759 struct cam_periph *periph;
760 struct pass_softc *softc;
763 periph = (struct cam_periph *)dev->si_drv1;
764 mtx = cam_periph_mtx(periph);
767 softc = periph->softc;
770 if (softc->open_count == 0) {
771 struct pass_io_req *io_req, *io_req2;
773 TAILQ_FOREACH_SAFE(io_req, &softc->done_queue, links, io_req2) {
774 TAILQ_REMOVE(&softc->done_queue, io_req, links);
775 passiocleanup(softc, io_req);
776 uma_zfree(softc->pass_zone, io_req);
779 TAILQ_FOREACH_SAFE(io_req, &softc->incoming_queue, links,
781 TAILQ_REMOVE(&softc->incoming_queue, io_req, links);
782 passiocleanup(softc, io_req);
783 uma_zfree(softc->pass_zone, io_req);
787 * If there are any active I/Os, we need to forcibly acquire a
788 * reference to the peripheral so that we don't go away
789 * before they complete. We'll release the reference when
790 * the abandoned queue is empty.
792 io_req = TAILQ_FIRST(&softc->active_queue);
794 && (softc->flags & PASS_FLAG_ABANDONED_REF_SET) == 0) {
795 cam_periph_doacquire(periph);
796 softc->flags |= PASS_FLAG_ABANDONED_REF_SET;
800 * Since the I/O in the active queue is not under our
801 * control, just set a flag so that we can clean it up when
802 * it completes and put it on the abandoned queue. This
803 * will prevent our sending spurious completions in the
804 * event that the device is opened again before these I/Os
807 TAILQ_FOREACH_SAFE(io_req, &softc->active_queue, links,
809 TAILQ_REMOVE(&softc->active_queue, io_req, links);
810 io_req->flags |= PASS_IO_ABANDONED;
811 TAILQ_INSERT_TAIL(&softc->abandoned_queue, io_req,
816 cam_periph_release_locked(periph);
819 * We reference the lock directly here, instead of using
820 * cam_periph_unlock(). The reason is that the call to
821 * cam_periph_release_locked() above could result in the periph
822 * getting freed. If that is the case, dereferencing the periph
823 * with a cam_periph_unlock() call would cause a page fault.
825 * cam_periph_release() avoids this problem using the same method,
826 * but we're manually acquiring and dropping the lock here to
827 * protect the open count and avoid another lock acquisition and
836 passstart(struct cam_periph *periph, union ccb *start_ccb)
838 struct pass_softc *softc;
840 softc = (struct pass_softc *)periph->softc;
842 switch (softc->state) {
843 case PASS_STATE_NORMAL: {
844 struct pass_io_req *io_req;
847 * Check for any queued I/O requests that require an
850 io_req = TAILQ_FIRST(&softc->incoming_queue);
851 if (io_req == NULL) {
852 xpt_release_ccb(start_ccb);
855 TAILQ_REMOVE(&softc->incoming_queue, io_req, links);
856 TAILQ_INSERT_TAIL(&softc->active_queue, io_req, links);
858 * Merge the user's CCB into the allocated CCB.
860 xpt_merge_ccb(start_ccb, &io_req->ccb);
861 start_ccb->ccb_h.ccb_type = PASS_CCB_QUEUED_IO;
862 start_ccb->ccb_h.ccb_ioreq = io_req;
863 start_ccb->ccb_h.cbfcnp = passdone;
864 io_req->alloced_ccb = start_ccb;
865 binuptime(&io_req->start_time);
866 devstat_start_transaction(softc->device_stats,
867 &io_req->start_time);
869 xpt_action(start_ccb);
872 * If we have any more I/O waiting, schedule ourselves again.
874 if (!TAILQ_EMPTY(&softc->incoming_queue))
875 xpt_schedule(periph, CAM_PRIORITY_NORMAL);
884 passdone(struct cam_periph *periph, union ccb *done_ccb)
886 struct pass_softc *softc;
887 struct ccb_scsiio *csio;
889 softc = (struct pass_softc *)periph->softc;
891 cam_periph_assert(periph, MA_OWNED);
893 csio = &done_ccb->csio;
894 switch (csio->ccb_h.ccb_type) {
895 case PASS_CCB_QUEUED_IO: {
896 struct pass_io_req *io_req;
898 io_req = done_ccb->ccb_h.ccb_ioreq;
900 xpt_print(periph->path, "%s: called for user CCB %p\n",
901 __func__, io_req->user_ccb_ptr);
903 if (((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP)
904 && (done_ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER)
905 && ((io_req->flags & PASS_IO_ABANDONED) == 0)) {
908 error = passerror(done_ccb, CAM_RETRY_SELTO,
909 SF_RETRY_UA | SF_NO_PRINT);
911 if (error == ERESTART) {
913 * A retry was scheduled, so
921 * Copy the allocated CCB contents back to the malloced CCB
922 * so we can give status back to the user when he requests it.
924 bcopy(done_ccb, &io_req->ccb, sizeof(*done_ccb));
927 * Log data/transaction completion with devstat(9).
929 switch (done_ccb->ccb_h.func_code) {
931 devstat_end_transaction(softc->device_stats,
932 done_ccb->csio.dxfer_len - done_ccb->csio.resid,
933 done_ccb->csio.tag_action & 0x3,
934 ((done_ccb->ccb_h.flags & CAM_DIR_MASK) ==
935 CAM_DIR_NONE) ? DEVSTAT_NO_DATA :
936 (done_ccb->ccb_h.flags & CAM_DIR_OUT) ?
937 DEVSTAT_WRITE : DEVSTAT_READ, NULL,
938 &io_req->start_time);
941 devstat_end_transaction(softc->device_stats,
942 done_ccb->ataio.dxfer_len - done_ccb->ataio.resid,
943 0, /* Not used in ATA */
944 ((done_ccb->ccb_h.flags & CAM_DIR_MASK) ==
945 CAM_DIR_NONE) ? DEVSTAT_NO_DATA :
946 (done_ccb->ccb_h.flags & CAM_DIR_OUT) ?
947 DEVSTAT_WRITE : DEVSTAT_READ, NULL,
948 &io_req->start_time);
952 * XXX KDM this isn't quite right, but there isn't
953 * currently an easy way to represent a bidirectional
954 * transfer in devstat. The only way to do it
955 * and have the byte counts come out right would
956 * mean that we would have to record two
957 * transactions, one for the request and one for the
958 * response. For now, so that we report something,
959 * just treat the entire thing as a read.
961 devstat_end_transaction(softc->device_stats,
962 done_ccb->smpio.smp_request_len +
963 done_ccb->smpio.smp_response_len,
964 DEVSTAT_TAG_SIMPLE, DEVSTAT_READ, NULL,
965 &io_req->start_time);
968 devstat_end_transaction(softc->device_stats, 0,
969 DEVSTAT_TAG_NONE, DEVSTAT_NO_DATA, NULL,
970 &io_req->start_time);
975 * In the normal case, take the completed I/O off of the
976 * active queue and put it on the done queue. Notitfy the
977 * user that we have a completed I/O.
979 if ((io_req->flags & PASS_IO_ABANDONED) == 0) {
980 TAILQ_REMOVE(&softc->active_queue, io_req, links);
981 TAILQ_INSERT_TAIL(&softc->done_queue, io_req, links);
982 selwakeuppri(&softc->read_select, PRIBIO);
983 KNOTE_LOCKED(&softc->read_select.si_note, 0);
986 * In the case of an abandoned I/O (final close
987 * without fetching the I/O), take it off of the
988 * abandoned queue and free it.
990 TAILQ_REMOVE(&softc->abandoned_queue, io_req, links);
991 passiocleanup(softc, io_req);
992 uma_zfree(softc->pass_zone, io_req);
995 * Release the done_ccb here, since we may wind up
996 * freeing the peripheral when we decrement the
997 * reference count below.
999 xpt_release_ccb(done_ccb);
1002 * If the abandoned queue is empty, we can release
1003 * our reference to the periph since we won't have
1004 * any more completions coming.
1006 if ((TAILQ_EMPTY(&softc->abandoned_queue))
1007 && (softc->flags & PASS_FLAG_ABANDONED_REF_SET)) {
1008 softc->flags &= ~PASS_FLAG_ABANDONED_REF_SET;
1009 cam_periph_release_locked(periph);
1013 * We have already released the CCB, so we can
1021 xpt_release_ccb(done_ccb);
1025 passcreatezone(struct cam_periph *periph)
1027 struct pass_softc *softc;
1031 softc = (struct pass_softc *)periph->softc;
1033 cam_periph_assert(periph, MA_OWNED);
1034 KASSERT(((softc->flags & PASS_FLAG_ZONE_VALID) == 0),
1035 ("%s called when the pass(4) zone is valid!\n", __func__));
1036 KASSERT((softc->pass_zone == NULL),
1037 ("%s called when the pass(4) zone is allocated!\n", __func__));
1039 if ((softc->flags & PASS_FLAG_ZONE_INPROG) == 0) {
1041 * We're the first context through, so we need to create
1042 * the pass(4) UMA zone for I/O requests.
1044 softc->flags |= PASS_FLAG_ZONE_INPROG;
1047 * uma_zcreate() does a blocking (M_WAITOK) allocation,
1048 * so we cannot hold a mutex while we call it.
1050 cam_periph_unlock(periph);
1052 softc->pass_zone = uma_zcreate(softc->zone_name,
1053 sizeof(struct pass_io_req), NULL, NULL, NULL, NULL,
1054 /*align*/ 0, /*flags*/ 0);
1056 softc->pass_io_zone = uma_zcreate(softc->io_zone_name,
1057 softc->io_zone_size, NULL, NULL, NULL, NULL,
1058 /*align*/ 0, /*flags*/ 0);
1060 cam_periph_lock(periph);
1062 if ((softc->pass_zone == NULL)
1063 || (softc->pass_io_zone == NULL)) {
1064 if (softc->pass_zone == NULL)
1065 xpt_print(periph->path, "unable to allocate "
1066 "IO Req UMA zone\n");
1068 xpt_print(periph->path, "unable to allocate "
1070 softc->flags &= ~PASS_FLAG_ZONE_INPROG;
1075 * Set the flags appropriately and notify any other waiters.
1077 softc->flags &= PASS_FLAG_ZONE_INPROG;
1078 softc->flags |= PASS_FLAG_ZONE_VALID;
1079 wakeup(&softc->pass_zone);
1082 * In this case, the UMA zone has not yet been created, but
1083 * another context is in the process of creating it. We
1084 * need to sleep until the creation is either done or has
1087 while ((softc->flags & PASS_FLAG_ZONE_INPROG)
1088 && ((softc->flags & PASS_FLAG_ZONE_VALID) == 0)) {
1089 error = msleep(&softc->pass_zone,
1090 cam_periph_mtx(periph), PRIBIO,
1096 * If the zone creation failed, no luck for the user.
1098 if ((softc->flags & PASS_FLAG_ZONE_VALID) == 0){
1108 passiocleanup(struct pass_softc *softc, struct pass_io_req *io_req)
1111 u_int8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
1116 switch (ccb->ccb_h.func_code) {
1118 numbufs = min(io_req->num_bufs, 2);
1121 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1123 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1124 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1128 case XPT_CONT_TARGET_IO:
1129 data_ptrs[0] = &ccb->csio.data_ptr;
1130 numbufs = min(io_req->num_bufs, 1);
1133 data_ptrs[0] = &ccb->ataio.data_ptr;
1134 numbufs = min(io_req->num_bufs, 1);
1137 numbufs = min(io_req->num_bufs, 2);
1138 data_ptrs[0] = &ccb->smpio.smp_request;
1139 data_ptrs[1] = &ccb->smpio.smp_response;
1141 case XPT_DEV_ADVINFO:
1142 numbufs = min(io_req->num_bufs, 1);
1143 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1146 case XPT_NVME_ADMIN:
1147 data_ptrs[0] = &ccb->nvmeio.data_ptr;
1148 numbufs = min(io_req->num_bufs, 1);
1151 /* allow ourselves to be swapped once again */
1153 break; /* NOTREACHED */
1156 if (io_req->flags & PASS_IO_USER_SEG_MALLOC) {
1157 free(io_req->user_segptr, M_SCSIPASS);
1158 io_req->user_segptr = NULL;
1162 * We only want to free memory we malloced.
1164 if (io_req->data_flags == CAM_DATA_VADDR) {
1165 for (i = 0; i < io_req->num_bufs; i++) {
1166 if (io_req->kern_bufs[i] == NULL)
1169 free(io_req->kern_bufs[i], M_SCSIPASS);
1170 io_req->kern_bufs[i] = NULL;
1172 } else if (io_req->data_flags == CAM_DATA_SG) {
1173 for (i = 0; i < io_req->num_kern_segs; i++) {
1174 if ((uint8_t *)(uintptr_t)
1175 io_req->kern_segptr[i].ds_addr == NULL)
1178 uma_zfree(softc->pass_io_zone, (uint8_t *)(uintptr_t)
1179 io_req->kern_segptr[i].ds_addr);
1180 io_req->kern_segptr[i].ds_addr = 0;
1184 if (io_req->flags & PASS_IO_KERN_SEG_MALLOC) {
1185 free(io_req->kern_segptr, M_SCSIPASS);
1186 io_req->kern_segptr = NULL;
1189 if (io_req->data_flags != CAM_DATA_PADDR) {
1190 for (i = 0; i < numbufs; i++) {
1192 * Restore the user's buffer pointers to their
1195 if (io_req->user_bufs[i] != NULL)
1196 *data_ptrs[i] = io_req->user_bufs[i];
1203 passcopysglist(struct cam_periph *periph, struct pass_io_req *io_req,
1204 ccb_flags direction)
1206 bus_size_t kern_watermark, user_watermark, len_copied, len_to_copy;
1207 bus_dma_segment_t *user_sglist, *kern_sglist;
1215 user_sglist = io_req->user_segptr;
1216 kern_sglist = io_req->kern_segptr;
1218 for (i = 0, j = 0; i < io_req->num_user_segs &&
1219 j < io_req->num_kern_segs;) {
1220 uint8_t *user_ptr, *kern_ptr;
1222 len_to_copy = min(user_sglist[i].ds_len -user_watermark,
1223 kern_sglist[j].ds_len - kern_watermark);
1225 user_ptr = (uint8_t *)(uintptr_t)user_sglist[i].ds_addr;
1226 user_ptr = user_ptr + user_watermark;
1227 kern_ptr = (uint8_t *)(uintptr_t)kern_sglist[j].ds_addr;
1228 kern_ptr = kern_ptr + kern_watermark;
1230 user_watermark += len_to_copy;
1231 kern_watermark += len_to_copy;
1233 if (direction == CAM_DIR_IN) {
1234 error = copyout(kern_ptr, user_ptr, len_to_copy);
1236 xpt_print(periph->path, "%s: copyout of %u "
1237 "bytes from %p to %p failed with "
1238 "error %d\n", __func__, len_to_copy,
1239 kern_ptr, user_ptr, error);
1243 error = copyin(user_ptr, kern_ptr, len_to_copy);
1245 xpt_print(periph->path, "%s: copyin of %u "
1246 "bytes from %p to %p failed with "
1247 "error %d\n", __func__, len_to_copy,
1248 user_ptr, kern_ptr, error);
1253 len_copied += len_to_copy;
1255 if (user_sglist[i].ds_len == user_watermark) {
1260 if (kern_sglist[j].ds_len == kern_watermark) {
1272 passmemsetup(struct cam_periph *periph, struct pass_io_req *io_req)
1275 struct pass_softc *softc;
1277 uint8_t **data_ptrs[CAM_PERIPH_MAXMAPS];
1278 uint32_t lengths[CAM_PERIPH_MAXMAPS];
1279 uint32_t dirs[CAM_PERIPH_MAXMAPS];
1281 uint16_t *seg_cnt_ptr;
1285 cam_periph_assert(periph, MA_NOTOWNED);
1287 softc = periph->softc;
1295 switch(ccb->ccb_h.func_code) {
1297 if (ccb->cdm.match_buf_len == 0) {
1298 printf("%s: invalid match buffer length 0\n", __func__);
1301 if (ccb->cdm.pattern_buf_len > 0) {
1302 data_ptrs[0] = (u_int8_t **)&ccb->cdm.patterns;
1303 lengths[0] = ccb->cdm.pattern_buf_len;
1304 dirs[0] = CAM_DIR_OUT;
1305 data_ptrs[1] = (u_int8_t **)&ccb->cdm.matches;
1306 lengths[1] = ccb->cdm.match_buf_len;
1307 dirs[1] = CAM_DIR_IN;
1310 data_ptrs[0] = (u_int8_t **)&ccb->cdm.matches;
1311 lengths[0] = ccb->cdm.match_buf_len;
1312 dirs[0] = CAM_DIR_IN;
1315 io_req->data_flags = CAM_DATA_VADDR;
1318 case XPT_CONT_TARGET_IO:
1319 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
1323 * The user shouldn't be able to supply a bio.
1325 if ((ccb->ccb_h.flags & CAM_DATA_MASK) == CAM_DATA_BIO)
1328 io_req->data_flags = ccb->ccb_h.flags & CAM_DATA_MASK;
1330 data_ptrs[0] = &ccb->csio.data_ptr;
1331 lengths[0] = ccb->csio.dxfer_len;
1332 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1333 num_segs = ccb->csio.sglist_cnt;
1334 seg_cnt_ptr = &ccb->csio.sglist_cnt;
1336 maxmap = softc->maxio;
1339 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
1343 * We only support a single virtual address for ATA I/O.
1345 if ((ccb->ccb_h.flags & CAM_DATA_MASK) != CAM_DATA_VADDR)
1348 io_req->data_flags = CAM_DATA_VADDR;
1350 data_ptrs[0] = &ccb->ataio.data_ptr;
1351 lengths[0] = ccb->ataio.dxfer_len;
1352 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1354 maxmap = softc->maxio;
1357 io_req->data_flags = CAM_DATA_VADDR;
1359 data_ptrs[0] = &ccb->smpio.smp_request;
1360 lengths[0] = ccb->smpio.smp_request_len;
1361 dirs[0] = CAM_DIR_OUT;
1362 data_ptrs[1] = &ccb->smpio.smp_response;
1363 lengths[1] = ccb->smpio.smp_response_len;
1364 dirs[1] = CAM_DIR_IN;
1366 maxmap = softc->maxio;
1368 case XPT_DEV_ADVINFO:
1369 if (ccb->cdai.bufsiz == 0)
1372 io_req->data_flags = CAM_DATA_VADDR;
1374 data_ptrs[0] = (uint8_t **)&ccb->cdai.buf;
1375 lengths[0] = ccb->cdai.bufsiz;
1376 dirs[0] = CAM_DIR_IN;
1379 case XPT_NVME_ADMIN:
1381 if ((ccb->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_NONE)
1384 io_req->data_flags = ccb->ccb_h.flags & CAM_DATA_MASK;
1386 data_ptrs[0] = &ccb->nvmeio.data_ptr;
1387 lengths[0] = ccb->nvmeio.dxfer_len;
1388 dirs[0] = ccb->ccb_h.flags & CAM_DIR_MASK;
1389 num_segs = ccb->nvmeio.sglist_cnt;
1390 seg_cnt_ptr = &ccb->nvmeio.sglist_cnt;
1392 maxmap = softc->maxio;
1396 break; /* NOTREACHED */
1399 io_req->num_bufs = numbufs;
1402 * If there is a maximum, check to make sure that the user's
1403 * request fits within the limit. In general, we should only have
1404 * a maximum length for requests that go to hardware. Otherwise it
1405 * is whatever we're able to malloc.
1407 for (i = 0; i < numbufs; i++) {
1408 io_req->user_bufs[i] = *data_ptrs[i];
1409 io_req->dirs[i] = dirs[i];
1410 io_req->lengths[i] = lengths[i];
1415 if (lengths[i] <= maxmap)
1418 xpt_print(periph->path, "%s: data length %u > max allowed %u "
1419 "bytes\n", __func__, lengths[i], maxmap);
1424 switch (io_req->data_flags) {
1425 case CAM_DATA_VADDR:
1426 /* Map or copy the buffer into kernel address space */
1427 for (i = 0; i < numbufs; i++) {
1431 * If for some reason no length is specified, we
1432 * don't need to allocate anything.
1434 if (io_req->lengths[i] == 0)
1437 tmp_buf = malloc(lengths[i], M_SCSIPASS,
1439 io_req->kern_bufs[i] = tmp_buf;
1440 *data_ptrs[i] = tmp_buf;
1443 xpt_print(periph->path, "%s: malloced %p len %u, user "
1444 "buffer %p, operation: %s\n", __func__,
1445 tmp_buf, lengths[i], io_req->user_bufs[i],
1446 (dirs[i] == CAM_DIR_IN) ? "read" : "write");
1449 * We only need to copy in if the user is writing.
1451 if (dirs[i] != CAM_DIR_OUT)
1454 error = copyin(io_req->user_bufs[i],
1455 io_req->kern_bufs[i], lengths[i]);
1457 xpt_print(periph->path, "%s: copy of user "
1458 "buffer from %p to %p failed with "
1459 "error %d\n", __func__,
1460 io_req->user_bufs[i],
1461 io_req->kern_bufs[i], error);
1466 case CAM_DATA_PADDR:
1467 /* Pass down the pointer as-is */
1470 size_t sg_length, size_to_go, alloc_size;
1471 uint32_t num_segs_needed;
1474 * Copy the user S/G list in, and then copy in the
1475 * individual segments.
1478 * We shouldn't see this, but check just in case.
1481 xpt_print(periph->path, "%s: cannot currently handle "
1482 "more than one S/G list per CCB\n", __func__);
1488 * We have to have at least one segment.
1490 if (num_segs == 0) {
1491 xpt_print(periph->path, "%s: CAM_DATA_SG flag set, "
1492 "but sglist_cnt=0!\n", __func__);
1498 * Make sure the user specified the total length and didn't
1499 * just leave it to us to decode the S/G list.
1501 if (lengths[0] == 0) {
1502 xpt_print(periph->path, "%s: no dxfer_len specified, "
1503 "but CAM_DATA_SG flag is set!\n", __func__);
1509 * We allocate buffers in io_zone_size increments for an
1510 * S/G list. This will generally be maxphys.
1512 if (lengths[0] <= softc->io_zone_size)
1513 num_segs_needed = 1;
1515 num_segs_needed = lengths[0] / softc->io_zone_size;
1516 if ((lengths[0] % softc->io_zone_size) != 0)
1520 /* Figure out the size of the S/G list */
1521 sg_length = num_segs * sizeof(bus_dma_segment_t);
1522 io_req->num_user_segs = num_segs;
1523 io_req->num_kern_segs = num_segs_needed;
1525 /* Save the user's S/G list pointer for later restoration */
1526 io_req->user_bufs[0] = *data_ptrs[0];
1529 * If we have enough segments allocated by default to handle
1530 * the length of the user's S/G list,
1532 if (num_segs > PASS_MAX_SEGS) {
1533 io_req->user_segptr = malloc(sizeof(bus_dma_segment_t) *
1534 num_segs, M_SCSIPASS, M_WAITOK | M_ZERO);
1535 io_req->flags |= PASS_IO_USER_SEG_MALLOC;
1537 io_req->user_segptr = io_req->user_segs;
1539 error = copyin(*data_ptrs[0], io_req->user_segptr, sg_length);
1541 xpt_print(periph->path, "%s: copy of user S/G list "
1542 "from %p to %p failed with error %d\n",
1543 __func__, *data_ptrs[0], io_req->user_segptr,
1548 if (num_segs_needed > PASS_MAX_SEGS) {
1549 io_req->kern_segptr = malloc(sizeof(bus_dma_segment_t) *
1550 num_segs_needed, M_SCSIPASS, M_WAITOK | M_ZERO);
1551 io_req->flags |= PASS_IO_KERN_SEG_MALLOC;
1553 io_req->kern_segptr = io_req->kern_segs;
1557 * Allocate the kernel S/G list.
1559 for (size_to_go = lengths[0], i = 0;
1560 size_to_go > 0 && i < num_segs_needed;
1561 i++, size_to_go -= alloc_size) {
1564 alloc_size = min(size_to_go, softc->io_zone_size);
1565 kern_ptr = uma_zalloc(softc->pass_io_zone, M_WAITOK);
1566 io_req->kern_segptr[i].ds_addr =
1567 (bus_addr_t)(uintptr_t)kern_ptr;
1568 io_req->kern_segptr[i].ds_len = alloc_size;
1570 if (size_to_go > 0) {
1571 printf("%s: size_to_go = %zu, software error!\n",
1572 __func__, size_to_go);
1577 *data_ptrs[0] = (uint8_t *)io_req->kern_segptr;
1578 *seg_cnt_ptr = io_req->num_kern_segs;
1581 * We only need to copy data here if the user is writing.
1583 if (dirs[0] == CAM_DIR_OUT)
1584 error = passcopysglist(periph, io_req, dirs[0]);
1587 case CAM_DATA_SG_PADDR: {
1591 * We shouldn't see this, but check just in case.
1594 printf("%s: cannot currently handle more than one "
1595 "S/G list per CCB\n", __func__);
1601 * We have to have at least one segment.
1603 if (num_segs == 0) {
1604 xpt_print(periph->path, "%s: CAM_DATA_SG_PADDR flag "
1605 "set, but sglist_cnt=0!\n", __func__);
1611 * Make sure the user specified the total length and didn't
1612 * just leave it to us to decode the S/G list.
1614 if (lengths[0] == 0) {
1615 xpt_print(periph->path, "%s: no dxfer_len specified, "
1616 "but CAM_DATA_SG flag is set!\n", __func__);
1621 /* Figure out the size of the S/G list */
1622 sg_length = num_segs * sizeof(bus_dma_segment_t);
1623 io_req->num_user_segs = num_segs;
1624 io_req->num_kern_segs = io_req->num_user_segs;
1626 /* Save the user's S/G list pointer for later restoration */
1627 io_req->user_bufs[0] = *data_ptrs[0];
1629 if (num_segs > PASS_MAX_SEGS) {
1630 io_req->user_segptr = malloc(sizeof(bus_dma_segment_t) *
1631 num_segs, M_SCSIPASS, M_WAITOK | M_ZERO);
1632 io_req->flags |= PASS_IO_USER_SEG_MALLOC;
1634 io_req->user_segptr = io_req->user_segs;
1636 io_req->kern_segptr = io_req->user_segptr;
1638 error = copyin(*data_ptrs[0], io_req->user_segptr, sg_length);
1640 xpt_print(periph->path, "%s: copy of user S/G list "
1641 "from %p to %p failed with error %d\n",
1642 __func__, *data_ptrs[0], io_req->user_segptr,
1651 * A user shouldn't be attaching a bio to the CCB. It
1652 * isn't a user-accessible structure.
1660 passiocleanup(softc, io_req);
1666 passmemdone(struct cam_periph *periph, struct pass_io_req *io_req)
1668 struct pass_softc *softc;
1673 softc = (struct pass_softc *)periph->softc;
1675 switch (io_req->data_flags) {
1676 case CAM_DATA_VADDR:
1678 * Copy back to the user buffer if this was a read.
1680 for (i = 0; i < io_req->num_bufs; i++) {
1681 if (io_req->dirs[i] != CAM_DIR_IN)
1684 error = copyout(io_req->kern_bufs[i],
1685 io_req->user_bufs[i], io_req->lengths[i]);
1687 xpt_print(periph->path, "Unable to copy %u "
1688 "bytes from %p to user address %p\n",
1690 io_req->kern_bufs[i],
1691 io_req->user_bufs[i]);
1696 case CAM_DATA_PADDR:
1697 /* Do nothing. The pointer is a physical address already */
1701 * Copy back to the user buffer if this was a read.
1702 * Restore the user's S/G list buffer pointer.
1704 if (io_req->dirs[0] == CAM_DIR_IN)
1705 error = passcopysglist(periph, io_req, io_req->dirs[0]);
1707 case CAM_DATA_SG_PADDR:
1709 * Restore the user's S/G list buffer pointer. No need to
1721 * Reset the user's pointers to their original values and free
1724 passiocleanup(softc, io_req);
1730 passioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
1734 if ((error = passdoioctl(dev, cmd, addr, flag, td)) == ENOTTY) {
1735 error = cam_compat_ioctl(dev, cmd, addr, flag, td, passdoioctl);
1741 passdoioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
1743 struct cam_periph *periph;
1744 struct pass_softc *softc;
1748 periph = (struct cam_periph *)dev->si_drv1;
1749 cam_periph_lock(periph);
1750 softc = (struct pass_softc *)periph->softc;
1761 inccb = (union ccb *)addr;
1762 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
1763 if (inccb->ccb_h.func_code == XPT_SCSI_IO)
1764 inccb->csio.bio = NULL;
1767 if (inccb->ccb_h.flags & CAM_UNLOCKED) {
1773 * Some CCB types, like scan bus and scan lun can only go
1774 * through the transport layer device.
1776 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
1777 xpt_print(periph->path, "CCB function code %#x is "
1778 "restricted to the XPT device\n",
1779 inccb->ccb_h.func_code);
1784 /* Compatibility for RL/priority-unaware code. */
1785 priority = inccb->ccb_h.pinfo.priority;
1786 if (priority <= CAM_PRIORITY_OOB)
1787 priority += CAM_PRIORITY_OOB + 1;
1790 * Non-immediate CCBs need a CCB from the per-device pool
1791 * of CCBs, which is scheduled by the transport layer.
1792 * Immediate CCBs and user-supplied CCBs should just be
1795 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
1796 && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
1797 ccb = cam_periph_getccb(periph, priority);
1800 ccb = xpt_alloc_ccb_nowait();
1803 xpt_setup_ccb(&ccb->ccb_h, periph->path,
1809 xpt_print(periph->path, "unable to allocate CCB\n");
1814 error = passsendccb(periph, ccb, inccb);
1819 xpt_release_ccb(ccb);
1825 struct pass_io_req *io_req;
1826 union ccb **user_ccb, *ccb;
1829 #ifdef COMPAT_FREEBSD32
1830 if (SV_PROC_FLAG(td->td_proc, SV_ILP32)) {
1835 if ((softc->flags & PASS_FLAG_ZONE_VALID) == 0) {
1836 error = passcreatezone(periph);
1842 * We're going to do a blocking allocation for this I/O
1843 * request, so we have to drop the lock.
1845 cam_periph_unlock(periph);
1847 io_req = uma_zalloc(softc->pass_zone, M_WAITOK | M_ZERO);
1849 user_ccb = (union ccb **)addr;
1852 * Unlike the CAMIOCOMMAND ioctl above, we only have a
1853 * pointer to the user's CCB, so we have to copy the whole
1854 * thing in to a buffer we have allocated (above) instead
1855 * of allowing the ioctl code to malloc a buffer and copy
1858 * This is an advantage for this asynchronous interface,
1859 * since we don't want the memory to get freed while the
1860 * CCB is outstanding.
1863 xpt_print(periph->path, "Copying user CCB %p to "
1864 "kernel address %p\n", *user_ccb, ccb);
1866 error = copyin(*user_ccb, ccb, sizeof(*ccb));
1868 xpt_print(periph->path, "Copy of user CCB %p to "
1869 "kernel address %p failed with error %d\n",
1870 *user_ccb, ccb, error);
1871 goto camioqueue_error;
1873 #if defined(BUF_TRACKING) || defined(FULL_BUF_TRACKING)
1874 if (ccb->ccb_h.func_code == XPT_SCSI_IO)
1875 ccb->csio.bio = NULL;
1878 if (ccb->ccb_h.flags & CAM_UNLOCKED) {
1880 goto camioqueue_error;
1883 if (ccb->ccb_h.flags & CAM_CDB_POINTER) {
1884 if (ccb->csio.cdb_len > IOCDBLEN) {
1886 goto camioqueue_error;
1888 error = copyin(ccb->csio.cdb_io.cdb_ptr,
1889 ccb->csio.cdb_io.cdb_bytes, ccb->csio.cdb_len);
1891 goto camioqueue_error;
1892 ccb->ccb_h.flags &= ~CAM_CDB_POINTER;
1896 * Some CCB types, like scan bus and scan lun can only go
1897 * through the transport layer device.
1899 if (ccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
1900 xpt_print(periph->path, "CCB function code %#x is "
1901 "restricted to the XPT device\n",
1902 ccb->ccb_h.func_code);
1904 goto camioqueue_error;
1908 * Save the user's CCB pointer as well as his linked list
1909 * pointers and peripheral private area so that we can
1910 * restore these later.
1912 io_req->user_ccb_ptr = *user_ccb;
1913 io_req->user_periph_links = ccb->ccb_h.periph_links;
1914 io_req->user_periph_priv = ccb->ccb_h.periph_priv;
1917 * Now that we've saved the user's values, we can set our
1918 * own peripheral private entry.
1920 ccb->ccb_h.ccb_ioreq = io_req;
1922 /* Compatibility for RL/priority-unaware code. */
1923 priority = ccb->ccb_h.pinfo.priority;
1924 if (priority <= CAM_PRIORITY_OOB)
1925 priority += CAM_PRIORITY_OOB + 1;
1928 * Setup fields in the CCB like the path and the priority.
1929 * The path in particular cannot be done in userland, since
1930 * it is a pointer to a kernel data structure.
1932 xpt_setup_ccb_flags(&ccb->ccb_h, periph->path, priority,
1936 * Setup our done routine. There is no way for the user to
1937 * have a valid pointer here.
1939 ccb->ccb_h.cbfcnp = passdone;
1941 fc = ccb->ccb_h.func_code;
1943 * If this function code has memory that can be mapped in
1944 * or out, we need to call passmemsetup().
1946 if ((fc == XPT_SCSI_IO) || (fc == XPT_ATA_IO)
1947 || (fc == XPT_SMP_IO) || (fc == XPT_DEV_MATCH)
1948 || (fc == XPT_DEV_ADVINFO)
1949 || (fc == XPT_NVME_ADMIN) || (fc == XPT_NVME_IO)) {
1950 error = passmemsetup(periph, io_req);
1952 goto camioqueue_error;
1954 io_req->mapinfo.num_bufs_used = 0;
1956 cam_periph_lock(periph);
1959 * Everything goes on the incoming queue initially.
1961 TAILQ_INSERT_TAIL(&softc->incoming_queue, io_req, links);
1964 * If the CCB is queued, and is not a user CCB, then
1965 * we need to allocate a slot for it. Call xpt_schedule()
1966 * so that our start routine will get called when a CCB is
1969 if ((fc & XPT_FC_QUEUED)
1970 && ((fc & XPT_FC_USER_CCB) == 0)) {
1971 xpt_schedule(periph, priority);
1976 * At this point, the CCB in question is either an
1977 * immediate CCB (like XPT_DEV_ADVINFO) or it is a user CCB
1978 * and therefore should be malloced, not allocated via a slot.
1979 * Remove the CCB from the incoming queue and add it to the
1982 TAILQ_REMOVE(&softc->incoming_queue, io_req, links);
1983 TAILQ_INSERT_TAIL(&softc->active_queue, io_req, links);
1988 * If this is not a queued CCB (i.e. it is an immediate CCB),
1989 * then it is already done. We need to put it on the done
1990 * queue for the user to fetch.
1992 if ((fc & XPT_FC_QUEUED) == 0) {
1993 TAILQ_REMOVE(&softc->active_queue, io_req, links);
1994 TAILQ_INSERT_TAIL(&softc->done_queue, io_req, links);
1999 uma_zfree(softc->pass_zone, io_req);
2000 cam_periph_lock(periph);
2005 union ccb **user_ccb;
2006 struct pass_io_req *io_req;
2009 #ifdef COMPAT_FREEBSD32
2010 if (SV_PROC_FLAG(td->td_proc, SV_ILP32)) {
2015 user_ccb = (union ccb **)addr;
2018 io_req = TAILQ_FIRST(&softc->done_queue);
2019 if (io_req == NULL) {
2025 * Remove the I/O from the done queue.
2027 TAILQ_REMOVE(&softc->done_queue, io_req, links);
2030 * We have to drop the lock during the copyout because the
2031 * copyout can result in VM faults that require sleeping.
2033 cam_periph_unlock(periph);
2036 * Do any needed copies (e.g. for reads) and revert the
2037 * pointers in the CCB back to the user's pointers.
2039 error = passmemdone(periph, io_req);
2043 io_req->ccb.ccb_h.periph_links = io_req->user_periph_links;
2044 io_req->ccb.ccb_h.periph_priv = io_req->user_periph_priv;
2047 xpt_print(periph->path, "Copying to user CCB %p from "
2048 "kernel address %p\n", *user_ccb, &io_req->ccb);
2051 error = copyout(&io_req->ccb, *user_ccb, sizeof(union ccb));
2053 xpt_print(periph->path, "Copy to user CCB %p from "
2054 "kernel address %p failed with error %d\n",
2055 *user_ccb, &io_req->ccb, error);
2059 * Prefer the first error we got back, and make sure we
2060 * don't overwrite bad status with good.
2065 cam_periph_lock(periph);
2068 * At this point, if there was an error, we could potentially
2069 * re-queue the I/O and try again. But why? The error
2070 * would almost certainly happen again. We might as well
2073 uma_zfree(softc->pass_zone, io_req);
2077 error = cam_periph_ioctl(periph, cmd, addr, passerror);
2082 cam_periph_unlock(periph);
2088 passpoll(struct cdev *dev, int poll_events, struct thread *td)
2090 struct cam_periph *periph;
2091 struct pass_softc *softc;
2094 periph = (struct cam_periph *)dev->si_drv1;
2095 softc = (struct pass_softc *)periph->softc;
2097 revents = poll_events & (POLLOUT | POLLWRNORM);
2098 if ((poll_events & (POLLIN | POLLRDNORM)) != 0) {
2099 cam_periph_lock(periph);
2101 if (!TAILQ_EMPTY(&softc->done_queue)) {
2102 revents |= poll_events & (POLLIN | POLLRDNORM);
2104 cam_periph_unlock(periph);
2106 selrecord(td, &softc->read_select);
2113 passkqfilter(struct cdev *dev, struct knote *kn)
2115 struct cam_periph *periph;
2116 struct pass_softc *softc;
2118 periph = (struct cam_periph *)dev->si_drv1;
2119 softc = (struct pass_softc *)periph->softc;
2121 kn->kn_hook = (caddr_t)periph;
2122 kn->kn_fop = &passread_filtops;
2123 knlist_add(&softc->read_select.si_note, kn, 0);
2129 passreadfiltdetach(struct knote *kn)
2131 struct cam_periph *periph;
2132 struct pass_softc *softc;
2134 periph = (struct cam_periph *)kn->kn_hook;
2135 softc = (struct pass_softc *)periph->softc;
2137 knlist_remove(&softc->read_select.si_note, kn, 0);
2141 passreadfilt(struct knote *kn, long hint)
2143 struct cam_periph *periph;
2144 struct pass_softc *softc;
2147 periph = (struct cam_periph *)kn->kn_hook;
2148 softc = (struct pass_softc *)periph->softc;
2150 cam_periph_assert(periph, MA_OWNED);
2152 if (TAILQ_EMPTY(&softc->done_queue))
2161 * Generally, "ccb" should be the CCB supplied by the kernel. "inccb"
2162 * should be the CCB that is copied in from the user.
2165 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
2167 struct pass_softc *softc;
2168 struct cam_periph_map_info mapinfo;
2173 softc = (struct pass_softc *)periph->softc;
2176 * There are some fields in the CCB header that need to be
2177 * preserved, the rest we get from the user.
2179 xpt_merge_ccb(ccb, inccb);
2181 if (ccb->ccb_h.flags & CAM_CDB_POINTER) {
2182 cmd = __builtin_alloca(ccb->csio.cdb_len);
2183 error = copyin(ccb->csio.cdb_io.cdb_ptr, cmd, ccb->csio.cdb_len);
2186 ccb->csio.cdb_io.cdb_ptr = cmd;
2190 * Let cam_periph_mapmem do a sanity check on the data pointer format.
2191 * Even if no data transfer is needed, it's a cheap check and it
2192 * simplifies the code.
2194 fc = ccb->ccb_h.func_code;
2195 if ((fc == XPT_SCSI_IO) || (fc == XPT_ATA_IO) || (fc == XPT_SMP_IO)
2196 || (fc == XPT_DEV_MATCH) || (fc == XPT_DEV_ADVINFO) || (fc == XPT_MMC_IO)
2197 || (fc == XPT_NVME_ADMIN) || (fc == XPT_NVME_IO)) {
2198 bzero(&mapinfo, sizeof(mapinfo));
2201 * cam_periph_mapmem calls into proc and vm functions that can
2202 * sleep as well as trigger I/O, so we can't hold the lock.
2203 * Dropping it here is reasonably safe.
2205 cam_periph_unlock(periph);
2206 error = cam_periph_mapmem(ccb, &mapinfo, softc->maxio);
2207 cam_periph_lock(periph);
2210 * cam_periph_mapmem returned an error, we can't continue.
2211 * Return the error to the user.
2216 /* Ensure that the unmap call later on is a no-op. */
2217 mapinfo.num_bufs_used = 0;
2220 * If the user wants us to perform any error recovery, then honor
2221 * that request. Otherwise, it's up to the user to perform any
2224 cam_periph_runccb(ccb, (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ?
2225 passerror : NULL, /* cam_flags */ CAM_RETRY_SELTO,
2226 /* sense_flags */ SF_RETRY_UA | SF_NO_PRINT,
2227 softc->device_stats);
2229 cam_periph_unlock(periph);
2230 cam_periph_unmapmem(ccb, &mapinfo);
2231 cam_periph_lock(periph);
2233 ccb->ccb_h.cbfcnp = NULL;
2234 ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
2235 bcopy(ccb, inccb, sizeof(union ccb));
2241 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
2243 struct cam_periph *periph;
2244 struct pass_softc *softc;
2246 periph = xpt_path_periph(ccb->ccb_h.path);
2247 softc = (struct pass_softc *)periph->softc;
2249 return(cam_periph_error(ccb, cam_flags, sense_flags));