ctl_backend_block.c revision 241896
1229997Sken/*-
2229997Sken * Copyright (c) 2003 Silicon Graphics International Corp.
3229997Sken * Copyright (c) 2009-2011 Spectra Logic Corporation
4232604Strasz * Copyright (c) 2012 The FreeBSD Foundation
5229997Sken * All rights reserved.
6229997Sken *
7232604Strasz * Portions of this software were developed by Edward Tomasz Napierala
8232604Strasz * under sponsorship from the FreeBSD Foundation.
9232604Strasz *
10229997Sken * Redistribution and use in source and binary forms, with or without
11229997Sken * modification, are permitted provided that the following conditions
12229997Sken * are met:
13229997Sken * 1. Redistributions of source code must retain the above copyright
14229997Sken *    notice, this list of conditions, and the following disclaimer,
15229997Sken *    without modification.
16229997Sken * 2. Redistributions in binary form must reproduce at minimum a disclaimer
17229997Sken *    substantially similar to the "NO WARRANTY" disclaimer below
18229997Sken *    ("Disclaimer") and any redistribution must be conditioned upon
19229997Sken *    including a substantially similar Disclaimer requirement for further
20229997Sken *    binary redistribution.
21229997Sken *
22229997Sken * NO WARRANTY
23229997Sken * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24229997Sken * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25229997Sken * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
26229997Sken * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27229997Sken * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28229997Sken * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29229997Sken * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30229997Sken * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31229997Sken * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32229997Sken * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33229997Sken * POSSIBILITY OF SUCH DAMAGES.
34229997Sken *
35229997Sken * $Id: //depot/users/kenm/FreeBSD-test2/sys/cam/ctl/ctl_backend_block.c#5 $
36229997Sken */
37229997Sken/*
38229997Sken * CAM Target Layer driver backend for block devices.
39229997Sken *
40229997Sken * Author: Ken Merry <ken@FreeBSD.org>
41229997Sken */
42229997Sken#include <sys/cdefs.h>
43229997Sken__FBSDID("$FreeBSD: head/sys/cam/ctl/ctl_backend_block.c 241896 2012-10-22 17:50:54Z kib $");
44229997Sken
45229997Sken#include <opt_kdtrace.h>
46229997Sken
47229997Sken#include <sys/param.h>
48229997Sken#include <sys/systm.h>
49229997Sken#include <sys/kernel.h>
50229997Sken#include <sys/types.h>
51229997Sken#include <sys/kthread.h>
52229997Sken#include <sys/bio.h>
53229997Sken#include <sys/fcntl.h>
54229997Sken#include <sys/lock.h>
55229997Sken#include <sys/mutex.h>
56229997Sken#include <sys/condvar.h>
57229997Sken#include <sys/malloc.h>
58229997Sken#include <sys/conf.h>
59229997Sken#include <sys/ioccom.h>
60229997Sken#include <sys/queue.h>
61229997Sken#include <sys/sbuf.h>
62229997Sken#include <sys/endian.h>
63229997Sken#include <sys/uio.h>
64229997Sken#include <sys/buf.h>
65229997Sken#include <sys/taskqueue.h>
66229997Sken#include <sys/vnode.h>
67229997Sken#include <sys/namei.h>
68229997Sken#include <sys/mount.h>
69229997Sken#include <sys/disk.h>
70229997Sken#include <sys/fcntl.h>
71229997Sken#include <sys/filedesc.h>
72229997Sken#include <sys/proc.h>
73229997Sken#include <sys/pcpu.h>
74229997Sken#include <sys/module.h>
75229997Sken#include <sys/sdt.h>
76229997Sken#include <sys/devicestat.h>
77229997Sken#include <sys/sysctl.h>
78229997Sken
79229997Sken#include <geom/geom.h>
80229997Sken
81229997Sken#include <cam/cam.h>
82229997Sken#include <cam/scsi/scsi_all.h>
83229997Sken#include <cam/scsi/scsi_da.h>
84229997Sken#include <cam/ctl/ctl_io.h>
85229997Sken#include <cam/ctl/ctl.h>
86229997Sken#include <cam/ctl/ctl_backend.h>
87229997Sken#include <cam/ctl/ctl_frontend_internal.h>
88229997Sken#include <cam/ctl/ctl_ioctl.h>
89229997Sken#include <cam/ctl/ctl_scsi_all.h>
90229997Sken#include <cam/ctl/ctl_error.h>
91229997Sken
92229997Sken/*
93229997Sken * The idea here is that we'll allocate enough S/G space to hold a 16MB
94229997Sken * I/O.  If we get an I/O larger than that, we'll reject it.
95229997Sken */
96229997Sken#define	CTLBLK_MAX_IO_SIZE	(16 * 1024 * 1024)
97229997Sken#define	CTLBLK_MAX_SEGS		(CTLBLK_MAX_IO_SIZE / MAXPHYS) + 1
98229997Sken
99229997Sken#ifdef CTLBLK_DEBUG
100229997Sken#define DPRINTF(fmt, args...) \
101229997Sken    printf("cbb(%s:%d): " fmt, __FUNCTION__, __LINE__, ##args)
102229997Sken#else
103229997Sken#define DPRINTF(fmt, args...) do {} while(0)
104229997Sken#endif
105229997Sken
106229997SkenSDT_PROVIDER_DEFINE(cbb);
107229997Sken
108229997Skentypedef enum {
109229997Sken	CTL_BE_BLOCK_LUN_UNCONFIGURED	= 0x01,
110229997Sken	CTL_BE_BLOCK_LUN_CONFIG_ERR	= 0x02,
111229997Sken	CTL_BE_BLOCK_LUN_WAITING	= 0x04,
112229997Sken	CTL_BE_BLOCK_LUN_MULTI_THREAD	= 0x08
113229997Sken} ctl_be_block_lun_flags;
114229997Sken
115229997Skentypedef enum {
116229997Sken	CTL_BE_BLOCK_NONE,
117229997Sken	CTL_BE_BLOCK_DEV,
118229997Sken	CTL_BE_BLOCK_FILE
119229997Sken} ctl_be_block_type;
120229997Sken
121229997Skenstruct ctl_be_block_devdata {
122229997Sken	struct cdev *cdev;
123229997Sken	struct cdevsw *csw;
124229997Sken	int dev_ref;
125229997Sken};
126229997Sken
127229997Skenstruct ctl_be_block_filedata {
128229997Sken	struct ucred *cred;
129229997Sken};
130229997Sken
131229997Skenunion ctl_be_block_bedata {
132229997Sken	struct ctl_be_block_devdata dev;
133229997Sken	struct ctl_be_block_filedata file;
134229997Sken};
135229997Sken
136229997Skenstruct ctl_be_block_io;
137229997Skenstruct ctl_be_block_lun;
138229997Sken
139229997Skentypedef void (*cbb_dispatch_t)(struct ctl_be_block_lun *be_lun,
140229997Sken			       struct ctl_be_block_io *beio);
141229997Sken
142229997Sken/*
143229997Sken * Backend LUN structure.  There is a 1:1 mapping between a block device
144229997Sken * and a backend block LUN, and between a backend block LUN and a CTL LUN.
145229997Sken */
146229997Skenstruct ctl_be_block_lun {
147229997Sken	struct ctl_block_disk *disk;
148229997Sken	char lunname[32];
149229997Sken	char *dev_path;
150229997Sken	ctl_be_block_type dev_type;
151229997Sken	struct vnode *vn;
152229997Sken	union ctl_be_block_bedata backend;
153229997Sken	cbb_dispatch_t dispatch;
154229997Sken	cbb_dispatch_t lun_flush;
155229997Sken	struct mtx lock;
156229997Sken	uma_zone_t lun_zone;
157229997Sken	uint64_t size_blocks;
158229997Sken	uint64_t size_bytes;
159229997Sken	uint32_t blocksize;
160229997Sken	int blocksize_shift;
161229997Sken	struct ctl_be_block_softc *softc;
162229997Sken	struct devstat *disk_stats;
163229997Sken	ctl_be_block_lun_flags flags;
164229997Sken	STAILQ_ENTRY(ctl_be_block_lun) links;
165229997Sken	struct ctl_be_lun ctl_be_lun;
166229997Sken	struct taskqueue *io_taskqueue;
167229997Sken	struct task io_task;
168229997Sken	int num_threads;
169229997Sken	STAILQ_HEAD(, ctl_io_hdr) input_queue;
170229997Sken	STAILQ_HEAD(, ctl_io_hdr) config_write_queue;
171229997Sken	STAILQ_HEAD(, ctl_io_hdr) datamove_queue;
172229997Sken};
173229997Sken
174229997Sken/*
175229997Sken * Overall softc structure for the block backend module.
176229997Sken */
177229997Skenstruct ctl_be_block_softc {
178229997Sken	STAILQ_HEAD(, ctl_be_block_io)   beio_free_queue;
179229997Sken	struct mtx			 lock;
180229997Sken	int				 prealloc_beio;
181229997Sken	int				 num_disks;
182229997Sken	STAILQ_HEAD(, ctl_block_disk)	 disk_list;
183229997Sken	int				 num_luns;
184229997Sken	STAILQ_HEAD(, ctl_be_block_lun)	 lun_list;
185229997Sken};
186229997Sken
187229997Skenstatic struct ctl_be_block_softc backend_block_softc;
188229997Sken
189229997Sken/*
190229997Sken * Per-I/O information.
191229997Sken */
192229997Skenstruct ctl_be_block_io {
193229997Sken	union ctl_io			*io;
194229997Sken	struct ctl_sg_entry		sg_segs[CTLBLK_MAX_SEGS];
195229997Sken	struct iovec			xiovecs[CTLBLK_MAX_SEGS];
196229997Sken	int				bio_cmd;
197229997Sken	int				bio_flags;
198229997Sken	int				num_segs;
199229997Sken	int				num_bios_sent;
200229997Sken	int				num_bios_done;
201229997Sken	int				send_complete;
202229997Sken	int				num_errors;
203229997Sken	struct bintime			ds_t0;
204229997Sken	devstat_tag_type		ds_tag_type;
205229997Sken	devstat_trans_flags		ds_trans_type;
206229997Sken	uint64_t			io_len;
207229997Sken	uint64_t			io_offset;
208229997Sken	struct ctl_be_block_softc	*softc;
209229997Sken	struct ctl_be_block_lun		*lun;
210229997Sken	STAILQ_ENTRY(ctl_be_block_io)	links;
211229997Sken};
212229997Sken
213229997Skenstatic int cbb_num_threads = 14;
214229997SkenTUNABLE_INT("kern.cam.ctl.block.num_threads", &cbb_num_threads);
215229997SkenSYSCTL_NODE(_kern_cam_ctl, OID_AUTO, block, CTLFLAG_RD, 0,
216229997Sken	    "CAM Target Layer Block Backend");
217229997SkenSYSCTL_INT(_kern_cam_ctl_block, OID_AUTO, num_threads, CTLFLAG_RW,
218229997Sken           &cbb_num_threads, 0, "Number of threads per backing file");
219229997Sken
220229997Skenstatic struct ctl_be_block_io *ctl_alloc_beio(struct ctl_be_block_softc *softc);
221229997Skenstatic void ctl_free_beio(struct ctl_be_block_io *beio);
222229997Skenstatic int ctl_grow_beio(struct ctl_be_block_softc *softc, int count);
223229997Sken#if 0
224229997Skenstatic void ctl_shrink_beio(struct ctl_be_block_softc *softc);
225229997Sken#endif
226229997Skenstatic void ctl_complete_beio(struct ctl_be_block_io *beio);
227229997Skenstatic int ctl_be_block_move_done(union ctl_io *io);
228229997Skenstatic void ctl_be_block_biodone(struct bio *bio);
229229997Skenstatic void ctl_be_block_flush_file(struct ctl_be_block_lun *be_lun,
230229997Sken				    struct ctl_be_block_io *beio);
231229997Skenstatic void ctl_be_block_dispatch_file(struct ctl_be_block_lun *be_lun,
232229997Sken				       struct ctl_be_block_io *beio);
233229997Skenstatic void ctl_be_block_flush_dev(struct ctl_be_block_lun *be_lun,
234229997Sken				   struct ctl_be_block_io *beio);
235229997Skenstatic void ctl_be_block_dispatch_dev(struct ctl_be_block_lun *be_lun,
236229997Sken				      struct ctl_be_block_io *beio);
237229997Skenstatic void ctl_be_block_cw_dispatch(struct ctl_be_block_lun *be_lun,
238229997Sken				    union ctl_io *io);
239229997Skenstatic void ctl_be_block_dispatch(struct ctl_be_block_lun *be_lun,
240229997Sken				  union ctl_io *io);
241229997Skenstatic void ctl_be_block_worker(void *context, int pending);
242229997Skenstatic int ctl_be_block_submit(union ctl_io *io);
243229997Skenstatic int ctl_be_block_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
244229997Sken				   int flag, struct thread *td);
245229997Skenstatic int ctl_be_block_open_file(struct ctl_be_block_lun *be_lun,
246229997Sken				  struct ctl_lun_req *req);
247229997Skenstatic int ctl_be_block_open_dev(struct ctl_be_block_lun *be_lun,
248229997Sken				 struct ctl_lun_req *req);
249229997Skenstatic int ctl_be_block_close(struct ctl_be_block_lun *be_lun);
250229997Skenstatic int ctl_be_block_open(struct ctl_be_block_softc *softc,
251229997Sken			     struct ctl_be_block_lun *be_lun,
252229997Sken			     struct ctl_lun_req *req);
253229997Skenstatic int ctl_be_block_create(struct ctl_be_block_softc *softc,
254229997Sken			       struct ctl_lun_req *req);
255229997Skenstatic int ctl_be_block_rm(struct ctl_be_block_softc *softc,
256229997Sken			   struct ctl_lun_req *req);
257232604Straszstatic int ctl_be_block_modify_file(struct ctl_be_block_lun *be_lun,
258232604Strasz				  struct ctl_lun_req *req);
259232604Straszstatic int ctl_be_block_modify_dev(struct ctl_be_block_lun *be_lun,
260232604Strasz				 struct ctl_lun_req *req);
261232604Straszstatic int ctl_be_block_modify(struct ctl_be_block_softc *softc,
262232604Strasz			   struct ctl_lun_req *req);
263229997Skenstatic void ctl_be_block_lun_shutdown(void *be_lun);
264229997Skenstatic void ctl_be_block_lun_config_status(void *be_lun,
265229997Sken					   ctl_lun_config_status status);
266229997Skenstatic int ctl_be_block_config_write(union ctl_io *io);
267229997Skenstatic int ctl_be_block_config_read(union ctl_io *io);
268229997Skenstatic int ctl_be_block_lun_info(void *be_lun, struct sbuf *sb);
269229997Skenint ctl_be_block_init(void);
270229997Sken
271229997Skenstatic struct ctl_backend_driver ctl_be_block_driver =
272229997Sken{
273230334Sken	.name = "block",
274230334Sken	.flags = CTL_BE_FLAG_HAS_CONFIG,
275230334Sken	.init = ctl_be_block_init,
276230334Sken	.data_submit = ctl_be_block_submit,
277230334Sken	.data_move_done = ctl_be_block_move_done,
278230334Sken	.config_read = ctl_be_block_config_read,
279230334Sken	.config_write = ctl_be_block_config_write,
280230334Sken	.ioctl = ctl_be_block_ioctl,
281230334Sken	.lun_info = ctl_be_block_lun_info
282229997Sken};
283229997Sken
284229997SkenMALLOC_DEFINE(M_CTLBLK, "ctlblk", "Memory used for CTL block backend");
285229997SkenCTL_BACKEND_DECLARE(cbb, ctl_be_block_driver);
286229997Sken
287229997Skenstatic struct ctl_be_block_io *
288229997Skenctl_alloc_beio(struct ctl_be_block_softc *softc)
289229997Sken{
290229997Sken	struct ctl_be_block_io *beio;
291229997Sken	int count;
292229997Sken
293229997Sken	mtx_lock(&softc->lock);
294229997Sken
295229997Sken	beio = STAILQ_FIRST(&softc->beio_free_queue);
296229997Sken	if (beio != NULL) {
297229997Sken		STAILQ_REMOVE(&softc->beio_free_queue, beio,
298229997Sken			      ctl_be_block_io, links);
299229997Sken	}
300229997Sken	mtx_unlock(&softc->lock);
301229997Sken
302229997Sken	if (beio != NULL) {
303229997Sken		bzero(beio, sizeof(*beio));
304229997Sken		beio->softc = softc;
305229997Sken		return (beio);
306229997Sken	}
307229997Sken
308229997Sken	for (;;) {
309229997Sken
310229997Sken		count = ctl_grow_beio(softc, /*count*/ 10);
311229997Sken
312229997Sken		/*
313229997Sken		 * This shouldn't be possible, since ctl_grow_beio() uses a
314229997Sken		 * blocking malloc.
315229997Sken		 */
316229997Sken		if (count == 0)
317229997Sken			return (NULL);
318229997Sken
319229997Sken		/*
320229997Sken		 * Since we have to drop the lock when we're allocating beio
321229997Sken		 * structures, it's possible someone else can come along and
322229997Sken		 * allocate the beio's we've just allocated.
323229997Sken		 */
324229997Sken		mtx_lock(&softc->lock);
325229997Sken		beio = STAILQ_FIRST(&softc->beio_free_queue);
326229997Sken		if (beio != NULL) {
327229997Sken			STAILQ_REMOVE(&softc->beio_free_queue, beio,
328229997Sken				      ctl_be_block_io, links);
329229997Sken		}
330229997Sken		mtx_unlock(&softc->lock);
331229997Sken
332229997Sken		if (beio != NULL) {
333229997Sken			bzero(beio, sizeof(*beio));
334229997Sken			beio->softc = softc;
335229997Sken			break;
336229997Sken		}
337229997Sken	}
338229997Sken	return (beio);
339229997Sken}
340229997Sken
341229997Skenstatic void
342229997Skenctl_free_beio(struct ctl_be_block_io *beio)
343229997Sken{
344229997Sken	struct ctl_be_block_softc *softc;
345229997Sken	int duplicate_free;
346229997Sken	int i;
347229997Sken
348229997Sken	softc = beio->softc;
349229997Sken	duplicate_free = 0;
350229997Sken
351229997Sken	for (i = 0; i < beio->num_segs; i++) {
352229997Sken		if (beio->sg_segs[i].addr == NULL)
353229997Sken			duplicate_free++;
354229997Sken
355229997Sken		uma_zfree(beio->lun->lun_zone, beio->sg_segs[i].addr);
356229997Sken		beio->sg_segs[i].addr = NULL;
357229997Sken	}
358229997Sken
359229997Sken	if (duplicate_free > 0) {
360229997Sken		printf("%s: %d duplicate frees out of %d segments\n", __func__,
361229997Sken		       duplicate_free, beio->num_segs);
362229997Sken	}
363229997Sken	mtx_lock(&softc->lock);
364229997Sken	STAILQ_INSERT_TAIL(&softc->beio_free_queue, beio, links);
365229997Sken	mtx_unlock(&softc->lock);
366229997Sken}
367229997Sken
368229997Skenstatic int
369229997Skenctl_grow_beio(struct ctl_be_block_softc *softc, int count)
370229997Sken{
371229997Sken	int i;
372229997Sken
373229997Sken	for (i = 0; i < count; i++) {
374229997Sken		struct ctl_be_block_io *beio;
375229997Sken
376229997Sken		beio = (struct ctl_be_block_io *)malloc(sizeof(*beio),
377229997Sken							   M_CTLBLK,
378229997Sken							   M_WAITOK | M_ZERO);
379229997Sken		bzero(beio, sizeof(*beio));
380229997Sken		beio->softc = softc;
381229997Sken		mtx_lock(&softc->lock);
382229997Sken		STAILQ_INSERT_TAIL(&softc->beio_free_queue, beio, links);
383229997Sken		mtx_unlock(&softc->lock);
384229997Sken	}
385229997Sken
386229997Sken	return (i);
387229997Sken}
388229997Sken
389229997Sken#if 0
390229997Skenstatic void
391229997Skenctl_shrink_beio(struct ctl_be_block_softc *softc)
392229997Sken{
393229997Sken	struct ctl_be_block_io *beio, *beio_tmp;
394229997Sken
395229997Sken	mtx_lock(&softc->lock);
396229997Sken	STAILQ_FOREACH_SAFE(beio, &softc->beio_free_queue, links, beio_tmp) {
397229997Sken		STAILQ_REMOVE(&softc->beio_free_queue, beio,
398229997Sken			      ctl_be_block_io, links);
399229997Sken		free(beio, M_CTLBLK);
400229997Sken	}
401229997Sken	mtx_unlock(&softc->lock);
402229997Sken}
403229997Sken#endif
404229997Sken
405229997Skenstatic void
406229997Skenctl_complete_beio(struct ctl_be_block_io *beio)
407229997Sken{
408229997Sken	union ctl_io *io;
409229997Sken	int io_len;
410229997Sken
411229997Sken	io = beio->io;
412229997Sken
413229997Sken	if ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_SUCCESS)
414229997Sken		io_len = beio->io_len;
415229997Sken	else
416229997Sken		io_len = 0;
417229997Sken
418229997Sken	devstat_end_transaction(beio->lun->disk_stats,
419229997Sken				/*bytes*/ io_len,
420229997Sken				beio->ds_tag_type,
421229997Sken				beio->ds_trans_type,
422229997Sken				/*now*/ NULL,
423229997Sken				/*then*/&beio->ds_t0);
424229997Sken
425229997Sken	ctl_free_beio(beio);
426229997Sken	ctl_done(io);
427229997Sken}
428229997Sken
429229997Skenstatic int
430229997Skenctl_be_block_move_done(union ctl_io *io)
431229997Sken{
432229997Sken	struct ctl_be_block_io *beio;
433229997Sken	struct ctl_be_block_lun *be_lun;
434229997Sken#ifdef CTL_TIME_IO
435229997Sken	struct bintime cur_bt;
436229997Sken#endif
437229997Sken
438229997Sken	beio = (struct ctl_be_block_io *)
439229997Sken		io->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptr;
440229997Sken
441229997Sken	be_lun = beio->lun;
442229997Sken
443229997Sken	DPRINTF("entered\n");
444229997Sken
445229997Sken#ifdef CTL_TIME_IO
446229997Sken	getbintime(&cur_bt);
447229997Sken	bintime_sub(&cur_bt, &io->io_hdr.dma_start_bt);
448229997Sken	bintime_add(&io->io_hdr.dma_bt, &cur_bt);
449229997Sken	io->io_hdr.num_dmas++;
450229997Sken#endif
451229997Sken
452229997Sken	/*
453229997Sken	 * We set status at this point for read commands, and write
454229997Sken	 * commands with errors.
455229997Sken	 */
456229997Sken	if ((beio->bio_cmd == BIO_READ)
457229997Sken	 && (io->io_hdr.port_status == 0)
458229997Sken	 && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
459229997Sken	 && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE))
460229997Sken		ctl_set_success(&io->scsiio);
461229997Sken	else if ((io->io_hdr.port_status != 0)
462229997Sken	      && ((io->io_hdr.flags & CTL_FLAG_ABORT) == 0)
463229997Sken	      && ((io->io_hdr.status & CTL_STATUS_MASK) == CTL_STATUS_NONE)) {
464229997Sken		/*
465229997Sken		 * For hardware error sense keys, the sense key
466229997Sken		 * specific value is defined to be a retry count,
467229997Sken		 * but we use it to pass back an internal FETD
468229997Sken		 * error code.  XXX KDM  Hopefully the FETD is only
469229997Sken		 * using 16 bits for an error code, since that's
470229997Sken		 * all the space we have in the sks field.
471229997Sken		 */
472229997Sken		ctl_set_internal_failure(&io->scsiio,
473229997Sken					 /*sks_valid*/ 1,
474229997Sken					 /*retry_count*/
475229997Sken					 io->io_hdr.port_status);
476229997Sken	}
477229997Sken
478229997Sken	/*
479229997Sken	 * If this is a read, or a write with errors, it is done.
480229997Sken	 */
481229997Sken	if ((beio->bio_cmd == BIO_READ)
482229997Sken	 || ((io->io_hdr.flags & CTL_FLAG_ABORT) != 0)
483229997Sken	 || ((io->io_hdr.status & CTL_STATUS_MASK) != CTL_STATUS_NONE)) {
484229997Sken		ctl_complete_beio(beio);
485229997Sken		return (0);
486229997Sken	}
487229997Sken
488229997Sken	/*
489229997Sken	 * At this point, we have a write and the DMA completed
490229997Sken	 * successfully.  We now have to queue it to the task queue to
491229997Sken	 * execute the backend I/O.  That is because we do blocking
492229997Sken	 * memory allocations, and in the file backing case, blocking I/O.
493229997Sken	 * This move done routine is generally called in the SIM's
494229997Sken	 * interrupt context, and therefore we cannot block.
495229997Sken	 */
496229997Sken	mtx_lock(&be_lun->lock);
497229997Sken	/*
498229997Sken	 * XXX KDM make sure that links is okay to use at this point.
499229997Sken	 * Otherwise, we either need to add another field to ctl_io_hdr,
500229997Sken	 * or deal with resource allocation here.
501229997Sken	 */
502229997Sken	STAILQ_INSERT_TAIL(&be_lun->datamove_queue, &io->io_hdr, links);
503229997Sken	mtx_unlock(&be_lun->lock);
504229997Sken
505229997Sken	taskqueue_enqueue(be_lun->io_taskqueue, &be_lun->io_task);
506229997Sken
507229997Sken	return (0);
508229997Sken}
509229997Sken
510229997Skenstatic void
511229997Skenctl_be_block_biodone(struct bio *bio)
512229997Sken{
513229997Sken	struct ctl_be_block_io *beio;
514229997Sken	struct ctl_be_block_lun *be_lun;
515229997Sken	union ctl_io *io;
516229997Sken
517229997Sken	beio = bio->bio_caller1;
518229997Sken	be_lun = beio->lun;
519229997Sken	io = beio->io;
520229997Sken
521229997Sken	DPRINTF("entered\n");
522229997Sken
523229997Sken	mtx_lock(&be_lun->lock);
524229997Sken	if (bio->bio_error != 0)
525229997Sken		beio->num_errors++;
526229997Sken
527229997Sken	beio->num_bios_done++;
528229997Sken
529229997Sken	/*
530229997Sken	 * XXX KDM will this cause WITNESS to complain?  Holding a lock
531229997Sken	 * during the free might cause it to complain.
532229997Sken	 */
533229997Sken	g_destroy_bio(bio);
534229997Sken
535229997Sken	/*
536229997Sken	 * If the send complete bit isn't set, or we aren't the last I/O to
537229997Sken	 * complete, then we're done.
538229997Sken	 */
539229997Sken	if ((beio->send_complete == 0)
540229997Sken	 || (beio->num_bios_done < beio->num_bios_sent)) {
541229997Sken		mtx_unlock(&be_lun->lock);
542229997Sken		return;
543229997Sken	}
544229997Sken
545229997Sken	/*
546229997Sken	 * At this point, we've verified that we are the last I/O to
547229997Sken	 * complete, so it's safe to drop the lock.
548229997Sken	 */
549229997Sken	mtx_unlock(&be_lun->lock);
550229997Sken
551229997Sken	/*
552229997Sken	 * If there are any errors from the backing device, we fail the
553229997Sken	 * entire I/O with a medium error.
554229997Sken	 */
555229997Sken	if (beio->num_errors > 0) {
556229997Sken		if (beio->bio_cmd == BIO_FLUSH) {
557229997Sken			/* XXX KDM is there is a better error here? */
558229997Sken			ctl_set_internal_failure(&io->scsiio,
559229997Sken						 /*sks_valid*/ 1,
560229997Sken						 /*retry_count*/ 0xbad2);
561229997Sken		} else
562229997Sken			ctl_set_medium_error(&io->scsiio);
563229997Sken		ctl_complete_beio(beio);
564229997Sken		return;
565229997Sken	}
566229997Sken
567229997Sken	/*
568229997Sken	 * If this is a write or a flush, we're all done.
569229997Sken	 * If this is a read, we can now send the data to the user.
570229997Sken	 */
571229997Sken	if ((beio->bio_cmd == BIO_WRITE)
572229997Sken	 || (beio->bio_cmd == BIO_FLUSH)) {
573229997Sken		ctl_set_success(&io->scsiio);
574229997Sken		ctl_complete_beio(beio);
575229997Sken	} else {
576229997Sken		io->scsiio.be_move_done = ctl_be_block_move_done;
577229997Sken		io->scsiio.kern_data_ptr = (uint8_t *)beio->sg_segs;
578229997Sken		io->scsiio.kern_data_len = beio->io_len;
579229997Sken		io->scsiio.kern_total_len = beio->io_len;
580229997Sken		io->scsiio.kern_rel_offset = 0;
581229997Sken		io->scsiio.kern_data_resid = 0;
582229997Sken		io->scsiio.kern_sg_entries = beio->num_segs;
583229997Sken		io->io_hdr.flags |= CTL_FLAG_ALLOCATED | CTL_FLAG_KDPTR_SGLIST;
584229997Sken#ifdef CTL_TIME_IO
585229997Sken        	getbintime(&io->io_hdr.dma_start_bt);
586229997Sken#endif
587229997Sken		ctl_datamove(io);
588229997Sken	}
589229997Sken}
590229997Sken
591229997Skenstatic void
592229997Skenctl_be_block_flush_file(struct ctl_be_block_lun *be_lun,
593229997Sken			struct ctl_be_block_io *beio)
594229997Sken{
595229997Sken	union ctl_io *io;
596229997Sken	struct mount *mountpoint;
597241896Skib	int error, lock_flags;
598229997Sken
599229997Sken	DPRINTF("entered\n");
600229997Sken
601229997Sken	io = beio->io;
602229997Sken
603229997Sken       	(void) vn_start_write(be_lun->vn, &mountpoint, V_WAIT);
604229997Sken
605229997Sken	if (MNT_SHARED_WRITES(mountpoint)
606229997Sken	 || ((mountpoint == NULL)
607229997Sken	  && MNT_SHARED_WRITES(be_lun->vn->v_mount)))
608229997Sken		lock_flags = LK_SHARED;
609229997Sken	else
610229997Sken		lock_flags = LK_EXCLUSIVE;
611229997Sken
612229997Sken	vn_lock(be_lun->vn, lock_flags | LK_RETRY);
613229997Sken
614229997Sken	binuptime(&beio->ds_t0);
615229997Sken	devstat_start_transaction(beio->lun->disk_stats, &beio->ds_t0);
616229997Sken
617229997Sken	error = VOP_FSYNC(be_lun->vn, MNT_WAIT, curthread);
618229997Sken	VOP_UNLOCK(be_lun->vn, 0);
619229997Sken
620229997Sken	vn_finished_write(mountpoint);
621229997Sken
622229997Sken	if (error == 0)
623229997Sken		ctl_set_success(&io->scsiio);
624229997Sken	else {
625229997Sken		/* XXX KDM is there is a better error here? */
626229997Sken		ctl_set_internal_failure(&io->scsiio,
627229997Sken					 /*sks_valid*/ 1,
628229997Sken					 /*retry_count*/ 0xbad1);
629229997Sken	}
630229997Sken
631229997Sken	ctl_complete_beio(beio);
632229997Sken}
633229997Sken
634229997SkenSDT_PROBE_DEFINE1(cbb, kernel, read, file_start, file_start, "uint64_t");
635229997SkenSDT_PROBE_DEFINE1(cbb, kernel, write, file_start, file_start, "uint64_t");
636229997SkenSDT_PROBE_DEFINE1(cbb, kernel, read, file_done, file_done,"uint64_t");
637229997SkenSDT_PROBE_DEFINE1(cbb, kernel, write, file_done, file_done, "uint64_t");
638229997Sken
639229997Skenstatic void
640229997Skenctl_be_block_dispatch_file(struct ctl_be_block_lun *be_lun,
641229997Sken			   struct ctl_be_block_io *beio)
642229997Sken{
643229997Sken	struct ctl_be_block_filedata *file_data;
644229997Sken	union ctl_io *io;
645229997Sken	struct uio xuio;
646229997Sken	struct iovec *xiovec;
647241896Skib	int flags;
648229997Sken	int error, i;
649229997Sken
650229997Sken	DPRINTF("entered\n");
651229997Sken
652229997Sken	file_data = &be_lun->backend.file;
653229997Sken	io = beio->io;
654229997Sken	flags = beio->bio_flags;
655229997Sken
656229997Sken	if (beio->bio_cmd == BIO_READ) {
657229997Sken		SDT_PROBE(cbb, kernel, read, file_start, 0, 0, 0, 0, 0);
658229997Sken	} else {
659229997Sken		SDT_PROBE(cbb, kernel, write, file_start, 0, 0, 0, 0, 0);
660229997Sken	}
661229997Sken
662229997Sken	bzero(&xuio, sizeof(xuio));
663229997Sken	if (beio->bio_cmd == BIO_READ)
664229997Sken		xuio.uio_rw = UIO_READ;
665229997Sken	else
666229997Sken		xuio.uio_rw = UIO_WRITE;
667229997Sken
668229997Sken	xuio.uio_offset = beio->io_offset;
669229997Sken	xuio.uio_resid = beio->io_len;
670229997Sken	xuio.uio_segflg = UIO_SYSSPACE;
671229997Sken	xuio.uio_iov = beio->xiovecs;
672229997Sken	xuio.uio_iovcnt = beio->num_segs;
673229997Sken	xuio.uio_td = curthread;
674229997Sken
675229997Sken	for (i = 0, xiovec = xuio.uio_iov; i < xuio.uio_iovcnt; i++, xiovec++) {
676229997Sken		xiovec->iov_base = beio->sg_segs[i].addr;
677229997Sken		xiovec->iov_len = beio->sg_segs[i].len;
678229997Sken	}
679229997Sken
680229997Sken	if (beio->bio_cmd == BIO_READ) {
681229997Sken		vn_lock(be_lun->vn, LK_SHARED | LK_RETRY);
682229997Sken
683229997Sken		binuptime(&beio->ds_t0);
684229997Sken		devstat_start_transaction(beio->lun->disk_stats, &beio->ds_t0);
685229997Sken
686229997Sken		/*
687229997Sken		 * UFS pays attention to IO_DIRECT for reads.  If the
688229997Sken		 * DIRECTIO option is configured into the kernel, it calls
689229997Sken		 * ffs_rawread().  But that only works for single-segment
690229997Sken		 * uios with user space addresses.  In our case, with a
691229997Sken		 * kernel uio, it still reads into the buffer cache, but it
692229997Sken		 * will just try to release the buffer from the cache later
693229997Sken		 * on in ffs_read().
694229997Sken		 *
695229997Sken		 * ZFS does not pay attention to IO_DIRECT for reads.
696229997Sken		 *
697229997Sken		 * UFS does not pay attention to IO_SYNC for reads.
698229997Sken		 *
699229997Sken		 * ZFS pays attention to IO_SYNC (which translates into the
700229997Sken		 * Solaris define FRSYNC for zfs_read()) for reads.  It
701229997Sken		 * attempts to sync the file before reading.
702229997Sken		 *
703229997Sken		 * So, to attempt to provide some barrier semantics in the
704229997Sken		 * BIO_ORDERED case, set both IO_DIRECT and IO_SYNC.
705229997Sken		 */
706229997Sken		error = VOP_READ(be_lun->vn, &xuio, (flags & BIO_ORDERED) ?
707229997Sken				 (IO_DIRECT|IO_SYNC) : 0, file_data->cred);
708229997Sken
709229997Sken		VOP_UNLOCK(be_lun->vn, 0);
710229997Sken	} else {
711229997Sken		struct mount *mountpoint;
712229997Sken		int lock_flags;
713229997Sken
714229997Sken		(void)vn_start_write(be_lun->vn, &mountpoint, V_WAIT);
715229997Sken
716229997Sken		if (MNT_SHARED_WRITES(mountpoint)
717229997Sken		 || ((mountpoint == NULL)
718229997Sken		  && MNT_SHARED_WRITES(be_lun->vn->v_mount)))
719229997Sken			lock_flags = LK_SHARED;
720229997Sken		else
721229997Sken			lock_flags = LK_EXCLUSIVE;
722229997Sken
723229997Sken		vn_lock(be_lun->vn, lock_flags | LK_RETRY);
724229997Sken
725229997Sken		binuptime(&beio->ds_t0);
726229997Sken		devstat_start_transaction(beio->lun->disk_stats, &beio->ds_t0);
727229997Sken
728229997Sken		/*
729229997Sken		 * UFS pays attention to IO_DIRECT for writes.  The write
730229997Sken		 * is done asynchronously.  (Normally the write would just
731229997Sken		 * get put into cache.
732229997Sken		 *
733229997Sken		 * UFS pays attention to IO_SYNC for writes.  It will
734229997Sken		 * attempt to write the buffer out synchronously if that
735229997Sken		 * flag is set.
736229997Sken		 *
737229997Sken		 * ZFS does not pay attention to IO_DIRECT for writes.
738229997Sken		 *
739229997Sken		 * ZFS pays attention to IO_SYNC (a.k.a. FSYNC or FRSYNC)
740229997Sken		 * for writes.  It will flush the transaction from the
741229997Sken		 * cache before returning.
742229997Sken		 *
743229997Sken		 * So if we've got the BIO_ORDERED flag set, we want
744229997Sken		 * IO_SYNC in either the UFS or ZFS case.
745229997Sken		 */
746229997Sken		error = VOP_WRITE(be_lun->vn, &xuio, (flags & BIO_ORDERED) ?
747229997Sken				  IO_SYNC : 0, file_data->cred);
748229997Sken		VOP_UNLOCK(be_lun->vn, 0);
749229997Sken
750229997Sken		vn_finished_write(mountpoint);
751229997Sken        }
752229997Sken
753229997Sken	/*
754229997Sken	 * If we got an error, set the sense data to "MEDIUM ERROR" and
755229997Sken	 * return the I/O to the user.
756229997Sken	 */
757229997Sken	if (error != 0) {
758229997Sken		char path_str[32];
759229997Sken
760229997Sken		ctl_scsi_path_string(io, path_str, sizeof(path_str));
761229997Sken		/*
762229997Sken		 * XXX KDM ZFS returns ENOSPC when the underlying
763229997Sken		 * filesystem fills up.  What kind of SCSI error should we
764229997Sken		 * return for that?
765229997Sken		 */
766229997Sken		printf("%s%s command returned errno %d\n", path_str,
767229997Sken		       (beio->bio_cmd == BIO_READ) ? "READ" : "WRITE", error);
768229997Sken		ctl_set_medium_error(&io->scsiio);
769229997Sken		ctl_complete_beio(beio);
770229997Sken		return;
771229997Sken	}
772229997Sken
773229997Sken	/*
774229997Sken	 * If this is a write, we're all done.
775229997Sken	 * If this is a read, we can now send the data to the user.
776229997Sken	 */
777229997Sken	if (beio->bio_cmd == BIO_WRITE) {
778229997Sken		ctl_set_success(&io->scsiio);
779229997Sken		SDT_PROBE(cbb, kernel, write, file_done, 0, 0, 0, 0, 0);
780229997Sken		ctl_complete_beio(beio);
781229997Sken	} else {
782229997Sken		SDT_PROBE(cbb, kernel, read, file_done, 0, 0, 0, 0, 0);
783229997Sken		io->scsiio.be_move_done = ctl_be_block_move_done;
784229997Sken		io->scsiio.kern_data_ptr = (uint8_t *)beio->sg_segs;
785229997Sken		io->scsiio.kern_data_len = beio->io_len;
786229997Sken		io->scsiio.kern_total_len = beio->io_len;
787229997Sken		io->scsiio.kern_rel_offset = 0;
788229997Sken		io->scsiio.kern_data_resid = 0;
789229997Sken		io->scsiio.kern_sg_entries = beio->num_segs;
790229997Sken		io->io_hdr.flags |= CTL_FLAG_ALLOCATED | CTL_FLAG_KDPTR_SGLIST;
791229997Sken#ifdef CTL_TIME_IO
792229997Sken        	getbintime(&io->io_hdr.dma_start_bt);
793229997Sken#endif
794229997Sken		ctl_datamove(io);
795229997Sken	}
796229997Sken}
797229997Sken
798229997Skenstatic void
799229997Skenctl_be_block_flush_dev(struct ctl_be_block_lun *be_lun,
800229997Sken		       struct ctl_be_block_io *beio)
801229997Sken{
802229997Sken	struct bio *bio;
803229997Sken	union ctl_io *io;
804229997Sken	struct ctl_be_block_devdata *dev_data;
805229997Sken
806229997Sken	dev_data = &be_lun->backend.dev;
807229997Sken	io = beio->io;
808229997Sken
809229997Sken	DPRINTF("entered\n");
810229997Sken
811229997Sken	/* This can't fail, it's a blocking allocation. */
812229997Sken	bio = g_alloc_bio();
813229997Sken
814229997Sken	bio->bio_cmd	    = BIO_FLUSH;
815229997Sken	bio->bio_flags	   |= BIO_ORDERED;
816229997Sken	bio->bio_dev	    = dev_data->cdev;
817229997Sken	bio->bio_offset	    = 0;
818229997Sken	bio->bio_data	    = 0;
819229997Sken	bio->bio_done	    = ctl_be_block_biodone;
820229997Sken	bio->bio_caller1    = beio;
821229997Sken	bio->bio_pblkno	    = 0;
822229997Sken
823229997Sken	/*
824229997Sken	 * We don't need to acquire the LUN lock here, because we are only
825229997Sken	 * sending one bio, and so there is no other context to synchronize
826229997Sken	 * with.
827229997Sken	 */
828229997Sken	beio->num_bios_sent = 1;
829229997Sken	beio->send_complete = 1;
830229997Sken
831229997Sken	binuptime(&beio->ds_t0);
832229997Sken	devstat_start_transaction(be_lun->disk_stats, &beio->ds_t0);
833229997Sken
834229997Sken	(*dev_data->csw->d_strategy)(bio);
835229997Sken}
836229997Sken
837229997Skenstatic void
838229997Skenctl_be_block_dispatch_dev(struct ctl_be_block_lun *be_lun,
839229997Sken			  struct ctl_be_block_io *beio)
840229997Sken{
841229997Sken	int i;
842229997Sken	struct bio *bio;
843229997Sken	struct ctl_be_block_devdata *dev_data;
844229997Sken	off_t cur_offset;
845229997Sken	int max_iosize;
846229997Sken
847229997Sken	DPRINTF("entered\n");
848229997Sken
849229997Sken	dev_data = &be_lun->backend.dev;
850229997Sken
851229997Sken	/*
852229997Sken	 * We have to limit our I/O size to the maximum supported by the
853229997Sken	 * backend device.  Hopefully it is MAXPHYS.  If the driver doesn't
854229997Sken	 * set it properly, use DFLTPHYS.
855229997Sken	 */
856229997Sken	max_iosize = dev_data->cdev->si_iosize_max;
857229997Sken	if (max_iosize < PAGE_SIZE)
858229997Sken		max_iosize = DFLTPHYS;
859229997Sken
860229997Sken	cur_offset = beio->io_offset;
861229997Sken
862229997Sken	/*
863229997Sken	 * XXX KDM need to accurately reflect the number of I/Os outstanding
864229997Sken	 * to a device.
865229997Sken	 */
866229997Sken	binuptime(&beio->ds_t0);
867229997Sken	devstat_start_transaction(be_lun->disk_stats, &beio->ds_t0);
868229997Sken
869229997Sken	for (i = 0; i < beio->num_segs; i++) {
870229997Sken		size_t cur_size;
871229997Sken		uint8_t *cur_ptr;
872229997Sken
873229997Sken		cur_size = beio->sg_segs[i].len;
874229997Sken		cur_ptr = beio->sg_segs[i].addr;
875229997Sken
876229997Sken		while (cur_size > 0) {
877229997Sken			/* This can't fail, it's a blocking allocation. */
878229997Sken			bio = g_alloc_bio();
879229997Sken
880229997Sken			KASSERT(bio != NULL, ("g_alloc_bio() failed!\n"));
881229997Sken
882229997Sken			bio->bio_cmd = beio->bio_cmd;
883229997Sken			bio->bio_flags |= beio->bio_flags;
884229997Sken			bio->bio_dev = dev_data->cdev;
885229997Sken			bio->bio_caller1 = beio;
886229997Sken			bio->bio_length = min(cur_size, max_iosize);
887229997Sken			bio->bio_offset = cur_offset;
888229997Sken			bio->bio_data = cur_ptr;
889229997Sken			bio->bio_done = ctl_be_block_biodone;
890229997Sken			bio->bio_pblkno = cur_offset / be_lun->blocksize;
891229997Sken
892229997Sken			cur_offset += bio->bio_length;
893229997Sken			cur_ptr += bio->bio_length;
894229997Sken			cur_size -= bio->bio_length;
895229997Sken
896229997Sken			/*
897229997Sken			 * Make sure we set the complete bit just before we
898229997Sken			 * issue the last bio so we don't wind up with a
899229997Sken			 * race.
900229997Sken			 *
901229997Sken			 * Use the LUN mutex here instead of a combination
902229997Sken			 * of atomic variables for simplicity.
903229997Sken			 *
904229997Sken			 * XXX KDM we could have a per-IO lock, but that
905229997Sken			 * would cause additional per-IO setup and teardown
906229997Sken			 * overhead.  Hopefully there won't be too much
907229997Sken			 * contention on the LUN lock.
908229997Sken			 */
909229997Sken			mtx_lock(&be_lun->lock);
910229997Sken
911229997Sken			beio->num_bios_sent++;
912229997Sken
913229997Sken			if ((i == beio->num_segs - 1)
914229997Sken			 && (cur_size == 0))
915229997Sken				beio->send_complete = 1;
916229997Sken
917229997Sken			mtx_unlock(&be_lun->lock);
918229997Sken
919229997Sken			(*dev_data->csw->d_strategy)(bio);
920229997Sken		}
921229997Sken	}
922229997Sken}
923229997Sken
924229997Skenstatic void
925229997Skenctl_be_block_cw_dispatch(struct ctl_be_block_lun *be_lun,
926229997Sken			 union ctl_io *io)
927229997Sken{
928229997Sken	struct ctl_be_block_io *beio;
929229997Sken	struct ctl_be_block_softc *softc;
930229997Sken
931229997Sken	DPRINTF("entered\n");
932229997Sken
933229997Sken	softc = be_lun->softc;
934229997Sken	beio = ctl_alloc_beio(softc);
935229997Sken	if (beio == NULL) {
936229997Sken		/*
937229997Sken		 * This should not happen.  ctl_alloc_beio() will call
938229997Sken		 * ctl_grow_beio() with a blocking malloc as needed.
939229997Sken		 * A malloc with M_WAITOK should not fail.
940229997Sken		 */
941229997Sken		ctl_set_busy(&io->scsiio);
942229997Sken		ctl_done(io);
943229997Sken		return;
944229997Sken	}
945229997Sken
946229997Sken	beio->io = io;
947229997Sken	beio->softc = softc;
948229997Sken	beio->lun = be_lun;
949229997Sken	io->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptr = beio;
950229997Sken
951229997Sken	switch (io->scsiio.cdb[0]) {
952229997Sken	case SYNCHRONIZE_CACHE:
953229997Sken	case SYNCHRONIZE_CACHE_16:
954229997Sken		beio->ds_trans_type = DEVSTAT_NO_DATA;
955229997Sken		beio->ds_tag_type = DEVSTAT_TAG_ORDERED;
956229997Sken		beio->io_len = 0;
957229997Sken		be_lun->lun_flush(be_lun, beio);
958229997Sken		break;
959229997Sken	default:
960229997Sken		panic("Unhandled CDB type %#x", io->scsiio.cdb[0]);
961229997Sken		break;
962229997Sken	}
963229997Sken}
964229997Sken
965229997SkenSDT_PROBE_DEFINE1(cbb, kernel, read, start, start, "uint64_t");
966229997SkenSDT_PROBE_DEFINE1(cbb, kernel, write, start, start, "uint64_t");
967229997SkenSDT_PROBE_DEFINE1(cbb, kernel, read, alloc_done, alloc_done, "uint64_t");
968229997SkenSDT_PROBE_DEFINE1(cbb, kernel, write, alloc_done, alloc_done, "uint64_t");
969229997Sken
970229997Skenstatic void
971229997Skenctl_be_block_dispatch(struct ctl_be_block_lun *be_lun,
972229997Sken			   union ctl_io *io)
973229997Sken{
974229997Sken	struct ctl_be_block_io *beio;
975229997Sken	struct ctl_be_block_softc *softc;
976229997Sken	struct ctl_lba_len lbalen;
977229997Sken	uint64_t len_left, io_size_bytes;
978229997Sken	int i;
979229997Sken
980229997Sken	softc = be_lun->softc;
981229997Sken
982229997Sken	DPRINTF("entered\n");
983229997Sken
984229997Sken	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) {
985229997Sken		SDT_PROBE(cbb, kernel, read, start, 0, 0, 0, 0, 0);
986229997Sken	} else {
987229997Sken		SDT_PROBE(cbb, kernel, write, start, 0, 0, 0, 0, 0);
988229997Sken	}
989229997Sken
990229997Sken	memcpy(&lbalen, io->io_hdr.ctl_private[CTL_PRIV_LBA_LEN].bytes,
991229997Sken	       sizeof(lbalen));
992229997Sken
993229997Sken	io_size_bytes = lbalen.len * be_lun->blocksize;
994229997Sken
995229997Sken	/*
996229997Sken	 * XXX KDM this is temporary, until we implement chaining of beio
997229997Sken	 * structures and multiple datamove calls to move all the data in
998229997Sken	 * or out.
999229997Sken	 */
1000229997Sken	if (io_size_bytes > CTLBLK_MAX_IO_SIZE) {
1001229997Sken		printf("%s: IO length %ju > max io size %u\n", __func__,
1002229997Sken		       io_size_bytes, CTLBLK_MAX_IO_SIZE);
1003229997Sken		ctl_set_invalid_field(&io->scsiio,
1004229997Sken				      /*sks_valid*/ 0,
1005229997Sken				      /*command*/ 1,
1006229997Sken				      /*field*/ 0,
1007229997Sken				      /*bit_valid*/ 0,
1008229997Sken				      /*bit*/ 0);
1009229997Sken		ctl_done(io);
1010229997Sken		return;
1011229997Sken	}
1012229997Sken
1013229997Sken	beio = ctl_alloc_beio(softc);
1014229997Sken	if (beio == NULL) {
1015229997Sken		/*
1016229997Sken		 * This should not happen.  ctl_alloc_beio() will call
1017229997Sken		 * ctl_grow_beio() with a blocking malloc as needed.
1018229997Sken		 * A malloc with M_WAITOK should not fail.
1019229997Sken		 */
1020229997Sken		ctl_set_busy(&io->scsiio);
1021229997Sken		ctl_done(io);
1022229997Sken		return;
1023229997Sken	}
1024229997Sken
1025229997Sken	beio->io = io;
1026229997Sken	beio->softc = softc;
1027229997Sken	beio->lun = be_lun;
1028229997Sken	io->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptr = beio;
1029229997Sken
1030229997Sken	/*
1031229997Sken	 * If the I/O came down with an ordered or head of queue tag, set
1032229997Sken	 * the BIO_ORDERED attribute.  For head of queue tags, that's
1033229997Sken	 * pretty much the best we can do.
1034229997Sken	 *
1035229997Sken	 * XXX KDM we don't have a great way to easily know about the FUA
1036229997Sken	 * bit right now (it is decoded in ctl_read_write(), but we don't
1037229997Sken	 * pass that knowledge to the backend), and in any case we would
1038229997Sken	 * need to determine how to handle it.
1039229997Sken	 */
1040229997Sken	if ((io->scsiio.tag_type == CTL_TAG_ORDERED)
1041229997Sken	 || (io->scsiio.tag_type == CTL_TAG_HEAD_OF_QUEUE))
1042229997Sken		beio->bio_flags = BIO_ORDERED;
1043229997Sken
1044229997Sken	switch (io->scsiio.tag_type) {
1045229997Sken	case CTL_TAG_ORDERED:
1046229997Sken		beio->ds_tag_type = DEVSTAT_TAG_ORDERED;
1047229997Sken		break;
1048229997Sken	case CTL_TAG_HEAD_OF_QUEUE:
1049229997Sken		beio->ds_tag_type = DEVSTAT_TAG_HEAD;
1050229997Sken		break;
1051229997Sken	case CTL_TAG_UNTAGGED:
1052229997Sken	case CTL_TAG_SIMPLE:
1053229997Sken	case CTL_TAG_ACA:
1054229997Sken	default:
1055229997Sken		beio->ds_tag_type = DEVSTAT_TAG_SIMPLE;
1056229997Sken		break;
1057229997Sken	}
1058229997Sken
1059229997Sken	/*
1060229997Sken	 * This path handles read and write only.  The config write path
1061229997Sken	 * handles flush operations.
1062229997Sken	 */
1063229997Sken	if ((io->io_hdr.flags & CTL_FLAG_DATA_MASK) == CTL_FLAG_DATA_IN) {
1064229997Sken		beio->bio_cmd = BIO_READ;
1065229997Sken		beio->ds_trans_type = DEVSTAT_READ;
1066229997Sken	} else {
1067229997Sken		beio->bio_cmd = BIO_WRITE;
1068229997Sken		beio->ds_trans_type = DEVSTAT_WRITE;
1069229997Sken	}
1070229997Sken
1071229997Sken	beio->io_len = lbalen.len * be_lun->blocksize;
1072229997Sken	beio->io_offset = lbalen.lba * be_lun->blocksize;
1073229997Sken
1074229997Sken	DPRINTF("%s at LBA %jx len %u\n",
1075229997Sken	       (beio->bio_cmd == BIO_READ) ? "READ" : "WRITE",
1076229997Sken	       (uintmax_t)lbalen.lba, lbalen.len);
1077229997Sken
1078229997Sken	for (i = 0, len_left = io_size_bytes; i < CTLBLK_MAX_SEGS &&
1079229997Sken	     len_left > 0; i++) {
1080229997Sken
1081229997Sken		/*
1082229997Sken		 * Setup the S/G entry for this chunk.
1083229997Sken		 */
1084229997Sken		beio->sg_segs[i].len = min(MAXPHYS, len_left);
1085229997Sken		beio->sg_segs[i].addr = uma_zalloc(be_lun->lun_zone, M_WAITOK);
1086229997Sken
1087229997Sken		DPRINTF("segment %d addr %p len %zd\n", i,
1088229997Sken			beio->sg_segs[i].addr, beio->sg_segs[i].len);
1089229997Sken
1090229997Sken		beio->num_segs++;
1091229997Sken		len_left -= beio->sg_segs[i].len;
1092229997Sken	}
1093229997Sken
1094229997Sken	/*
1095229997Sken	 * For the read case, we need to read the data into our buffers and
1096229997Sken	 * then we can send it back to the user.  For the write case, we
1097229997Sken	 * need to get the data from the user first.
1098229997Sken	 */
1099229997Sken	if (beio->bio_cmd == BIO_READ) {
1100229997Sken		SDT_PROBE(cbb, kernel, read, alloc_done, 0, 0, 0, 0, 0);
1101229997Sken		be_lun->dispatch(be_lun, beio);
1102229997Sken	} else {
1103229997Sken		SDT_PROBE(cbb, kernel, write, alloc_done, 0, 0, 0, 0, 0);
1104229997Sken		io->scsiio.be_move_done = ctl_be_block_move_done;
1105229997Sken		io->scsiio.kern_data_ptr = (uint8_t *)beio->sg_segs;
1106229997Sken		io->scsiio.kern_data_len = beio->io_len;
1107229997Sken		io->scsiio.kern_total_len = beio->io_len;
1108229997Sken		io->scsiio.kern_rel_offset = 0;
1109229997Sken		io->scsiio.kern_data_resid = 0;
1110229997Sken		io->scsiio.kern_sg_entries = beio->num_segs;
1111229997Sken		io->io_hdr.flags |= CTL_FLAG_ALLOCATED | CTL_FLAG_KDPTR_SGLIST;
1112229997Sken#ifdef CTL_TIME_IO
1113229997Sken        	getbintime(&io->io_hdr.dma_start_bt);
1114229997Sken#endif
1115229997Sken		ctl_datamove(io);
1116229997Sken	}
1117229997Sken}
1118229997Sken
1119229997Skenstatic void
1120229997Skenctl_be_block_worker(void *context, int pending)
1121229997Sken{
1122229997Sken	struct ctl_be_block_lun *be_lun;
1123229997Sken	struct ctl_be_block_softc *softc;
1124229997Sken	union ctl_io *io;
1125229997Sken
1126229997Sken	be_lun = (struct ctl_be_block_lun *)context;
1127229997Sken	softc = be_lun->softc;
1128229997Sken
1129229997Sken	DPRINTF("entered\n");
1130229997Sken
1131229997Sken	mtx_lock(&be_lun->lock);
1132229997Sken	for (;;) {
1133229997Sken		io = (union ctl_io *)STAILQ_FIRST(&be_lun->datamove_queue);
1134229997Sken		if (io != NULL) {
1135229997Sken			struct ctl_be_block_io *beio;
1136229997Sken
1137229997Sken			DPRINTF("datamove queue\n");
1138229997Sken
1139229997Sken			STAILQ_REMOVE(&be_lun->datamove_queue, &io->io_hdr,
1140229997Sken				      ctl_io_hdr, links);
1141229997Sken
1142229997Sken			mtx_unlock(&be_lun->lock);
1143229997Sken
1144229997Sken			beio = (struct ctl_be_block_io *)
1145229997Sken			    io->io_hdr.ctl_private[CTL_PRIV_BACKEND].ptr;
1146229997Sken
1147229997Sken			be_lun->dispatch(be_lun, beio);
1148229997Sken
1149229997Sken			mtx_lock(&be_lun->lock);
1150229997Sken			continue;
1151229997Sken		}
1152229997Sken		io = (union ctl_io *)STAILQ_FIRST(&be_lun->config_write_queue);
1153229997Sken		if (io != NULL) {
1154229997Sken
1155229997Sken			DPRINTF("config write queue\n");
1156229997Sken
1157229997Sken			STAILQ_REMOVE(&be_lun->config_write_queue, &io->io_hdr,
1158229997Sken				      ctl_io_hdr, links);
1159229997Sken
1160229997Sken			mtx_unlock(&be_lun->lock);
1161229997Sken
1162229997Sken			ctl_be_block_cw_dispatch(be_lun, io);
1163229997Sken
1164229997Sken			mtx_lock(&be_lun->lock);
1165229997Sken			continue;
1166229997Sken		}
1167229997Sken		io = (union ctl_io *)STAILQ_FIRST(&be_lun->input_queue);
1168229997Sken		if (io != NULL) {
1169229997Sken			DPRINTF("input queue\n");
1170229997Sken
1171229997Sken			STAILQ_REMOVE(&be_lun->input_queue, &io->io_hdr,
1172229997Sken				      ctl_io_hdr, links);
1173229997Sken			mtx_unlock(&be_lun->lock);
1174229997Sken
1175229997Sken			/*
1176229997Sken			 * We must drop the lock, since this routine and
1177229997Sken			 * its children may sleep.
1178229997Sken			 */
1179229997Sken			ctl_be_block_dispatch(be_lun, io);
1180229997Sken
1181229997Sken			mtx_lock(&be_lun->lock);
1182229997Sken			continue;
1183229997Sken		}
1184229997Sken
1185229997Sken		/*
1186229997Sken		 * If we get here, there is no work left in the queues, so
1187229997Sken		 * just break out and let the task queue go to sleep.
1188229997Sken		 */
1189229997Sken		break;
1190229997Sken	}
1191229997Sken	mtx_unlock(&be_lun->lock);
1192229997Sken}
1193229997Sken
1194229997Sken/*
1195229997Sken * Entry point from CTL to the backend for I/O.  We queue everything to a
1196229997Sken * work thread, so this just puts the I/O on a queue and wakes up the
1197229997Sken * thread.
1198229997Sken */
1199229997Skenstatic int
1200229997Skenctl_be_block_submit(union ctl_io *io)
1201229997Sken{
1202229997Sken	struct ctl_be_block_lun *be_lun;
1203229997Sken	struct ctl_be_lun *ctl_be_lun;
1204229997Sken	int retval;
1205229997Sken
1206229997Sken	DPRINTF("entered\n");
1207229997Sken
1208229997Sken	retval = CTL_RETVAL_COMPLETE;
1209229997Sken
1210229997Sken	ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
1211229997Sken		CTL_PRIV_BACKEND_LUN].ptr;
1212229997Sken	be_lun = (struct ctl_be_block_lun *)ctl_be_lun->be_lun;
1213229997Sken
1214229997Sken	/*
1215229997Sken	 * Make sure we only get SCSI I/O.
1216229997Sken	 */
1217229997Sken	KASSERT(io->io_hdr.io_type == CTL_IO_SCSI, ("Non-SCSI I/O (type "
1218229997Sken		"%#x) encountered", io->io_hdr.io_type));
1219229997Sken
1220229997Sken	mtx_lock(&be_lun->lock);
1221229997Sken	/*
1222229997Sken	 * XXX KDM make sure that links is okay to use at this point.
1223229997Sken	 * Otherwise, we either need to add another field to ctl_io_hdr,
1224229997Sken	 * or deal with resource allocation here.
1225229997Sken	 */
1226229997Sken	STAILQ_INSERT_TAIL(&be_lun->input_queue, &io->io_hdr, links);
1227229997Sken	mtx_unlock(&be_lun->lock);
1228229997Sken
1229229997Sken	taskqueue_enqueue(be_lun->io_taskqueue, &be_lun->io_task);
1230229997Sken
1231229997Sken	return (retval);
1232229997Sken}
1233229997Sken
1234229997Skenstatic int
1235229997Skenctl_be_block_ioctl(struct cdev *dev, u_long cmd, caddr_t addr,
1236229997Sken			int flag, struct thread *td)
1237229997Sken{
1238229997Sken	struct ctl_be_block_softc *softc;
1239229997Sken	int error;
1240229997Sken
1241229997Sken	softc = &backend_block_softc;
1242229997Sken
1243229997Sken	error = 0;
1244229997Sken
1245229997Sken	switch (cmd) {
1246229997Sken	case CTL_LUN_REQ: {
1247229997Sken		struct ctl_lun_req *lun_req;
1248229997Sken
1249229997Sken		lun_req = (struct ctl_lun_req *)addr;
1250229997Sken
1251229997Sken		switch (lun_req->reqtype) {
1252229997Sken		case CTL_LUNREQ_CREATE:
1253229997Sken			error = ctl_be_block_create(softc, lun_req);
1254229997Sken			break;
1255229997Sken		case CTL_LUNREQ_RM:
1256229997Sken			error = ctl_be_block_rm(softc, lun_req);
1257229997Sken			break;
1258232604Strasz		case CTL_LUNREQ_MODIFY:
1259232604Strasz			error = ctl_be_block_modify(softc, lun_req);
1260232604Strasz			break;
1261229997Sken		default:
1262229997Sken			lun_req->status = CTL_LUN_ERROR;
1263229997Sken			snprintf(lun_req->error_str, sizeof(lun_req->error_str),
1264229997Sken				 "%s: invalid LUN request type %d", __func__,
1265229997Sken				 lun_req->reqtype);
1266229997Sken			break;
1267229997Sken		}
1268229997Sken		break;
1269229997Sken	}
1270229997Sken	default:
1271229997Sken		error = ENOTTY;
1272229997Sken		break;
1273229997Sken	}
1274229997Sken
1275229997Sken	return (error);
1276229997Sken}
1277229997Sken
1278229997Skenstatic int
1279229997Skenctl_be_block_open_file(struct ctl_be_block_lun *be_lun, struct ctl_lun_req *req)
1280229997Sken{
1281229997Sken	struct ctl_be_block_filedata *file_data;
1282229997Sken	struct ctl_lun_create_params *params;
1283229997Sken	struct vattr		      vattr;
1284229997Sken	int			      error;
1285229997Sken
1286229997Sken	error = 0;
1287229997Sken	file_data = &be_lun->backend.file;
1288229997Sken	params = &req->reqdata.create;
1289229997Sken
1290229997Sken	be_lun->dev_type = CTL_BE_BLOCK_FILE;
1291229997Sken	be_lun->dispatch = ctl_be_block_dispatch_file;
1292229997Sken	be_lun->lun_flush = ctl_be_block_flush_file;
1293229997Sken
1294229997Sken	error = VOP_GETATTR(be_lun->vn, &vattr, curthread->td_ucred);
1295229997Sken	if (error != 0) {
1296229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1297229997Sken			 "error calling VOP_GETATTR() for file %s",
1298229997Sken			 be_lun->dev_path);
1299229997Sken		return (error);
1300229997Sken	}
1301229997Sken
1302229997Sken	/*
1303229997Sken	 * Verify that we have the ability to upgrade to exclusive
1304229997Sken	 * access on this file so we can trap errors at open instead
1305229997Sken	 * of reporting them during first access.
1306229997Sken	 */
1307229997Sken	if (VOP_ISLOCKED(be_lun->vn) != LK_EXCLUSIVE) {
1308229997Sken		vn_lock(be_lun->vn, LK_UPGRADE | LK_RETRY);
1309229997Sken		if (be_lun->vn->v_iflag & VI_DOOMED) {
1310229997Sken			error = EBADF;
1311229997Sken			snprintf(req->error_str, sizeof(req->error_str),
1312229997Sken				 "error locking file %s", be_lun->dev_path);
1313229997Sken			return (error);
1314229997Sken		}
1315229997Sken	}
1316229997Sken
1317229997Sken
1318229997Sken	file_data->cred = crhold(curthread->td_ucred);
1319232604Strasz	if (params->lun_size_bytes != 0)
1320232604Strasz		be_lun->size_bytes = params->lun_size_bytes;
1321232604Strasz	else
1322232604Strasz		be_lun->size_bytes = vattr.va_size;
1323229997Sken	/*
1324229997Sken	 * We set the multi thread flag for file operations because all
1325229997Sken	 * filesystems (in theory) are capable of allowing multiple readers
1326229997Sken	 * of a file at once.  So we want to get the maximum possible
1327229997Sken	 * concurrency.
1328229997Sken	 */
1329229997Sken	be_lun->flags |= CTL_BE_BLOCK_LUN_MULTI_THREAD;
1330229997Sken
1331229997Sken	/*
1332229997Sken	 * XXX KDM vattr.va_blocksize may be larger than 512 bytes here.
1333229997Sken	 * With ZFS, it is 131072 bytes.  Block sizes that large don't work
1334229997Sken	 * with disklabel and UFS on FreeBSD at least.  Large block sizes
1335229997Sken	 * may not work with other OSes as well.  So just export a sector
1336229997Sken	 * size of 512 bytes, which should work with any OS or
1337229997Sken	 * application.  Since our backing is a file, any block size will
1338229997Sken	 * work fine for the backing store.
1339229997Sken	 */
1340229997Sken#if 0
1341229997Sken	be_lun->blocksize= vattr.va_blocksize;
1342229997Sken#endif
1343229997Sken	if (params->blocksize_bytes != 0)
1344229997Sken		be_lun->blocksize = params->blocksize_bytes;
1345229997Sken	else
1346229997Sken		be_lun->blocksize = 512;
1347229997Sken
1348229997Sken	/*
1349229997Sken	 * Sanity check.  The media size has to be at least one
1350229997Sken	 * sector long.
1351229997Sken	 */
1352229997Sken	if (be_lun->size_bytes < be_lun->blocksize) {
1353229997Sken		error = EINVAL;
1354229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1355229997Sken			 "file %s size %ju < block size %u", be_lun->dev_path,
1356229997Sken			 (uintmax_t)be_lun->size_bytes, be_lun->blocksize);
1357229997Sken	}
1358229997Sken	return (error);
1359229997Sken}
1360229997Sken
1361229997Skenstatic int
1362229997Skenctl_be_block_open_dev(struct ctl_be_block_lun *be_lun, struct ctl_lun_req *req)
1363229997Sken{
1364229997Sken	struct ctl_lun_create_params *params;
1365229997Sken	struct vattr		      vattr;
1366229997Sken	struct cdev		     *dev;
1367229997Sken	struct cdevsw		     *devsw;
1368229997Sken	int			      error;
1369229997Sken
1370229997Sken	params = &req->reqdata.create;
1371229997Sken
1372229997Sken	be_lun->dev_type = CTL_BE_BLOCK_DEV;
1373229997Sken	be_lun->dispatch = ctl_be_block_dispatch_dev;
1374229997Sken	be_lun->lun_flush = ctl_be_block_flush_dev;
1375229997Sken	be_lun->backend.dev.cdev = be_lun->vn->v_rdev;
1376229997Sken	be_lun->backend.dev.csw = dev_refthread(be_lun->backend.dev.cdev,
1377229997Sken					     &be_lun->backend.dev.dev_ref);
1378229997Sken	if (be_lun->backend.dev.csw == NULL)
1379229997Sken		panic("Unable to retrieve device switch");
1380229997Sken
1381229997Sken	error = VOP_GETATTR(be_lun->vn, &vattr, NOCRED);
1382229997Sken	if (error) {
1383229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1384229997Sken			 "%s: error getting vnode attributes for device %s",
1385229997Sken			 __func__, be_lun->dev_path);
1386229997Sken		return (error);
1387229997Sken	}
1388229997Sken
1389229997Sken	dev = be_lun->vn->v_rdev;
1390229997Sken	devsw = dev->si_devsw;
1391229997Sken	if (!devsw->d_ioctl) {
1392229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1393229997Sken			 "%s: no d_ioctl for device %s!", __func__,
1394229997Sken			 be_lun->dev_path);
1395229997Sken		return (ENODEV);
1396229997Sken	}
1397229997Sken
1398229997Sken	error = devsw->d_ioctl(dev, DIOCGSECTORSIZE,
1399229997Sken			       (caddr_t)&be_lun->blocksize, FREAD,
1400229997Sken			       curthread);
1401229997Sken	if (error) {
1402229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1403229997Sken			 "%s: error %d returned for DIOCGSECTORSIZE ioctl "
1404229997Sken			 "on %s!", __func__, error, be_lun->dev_path);
1405229997Sken		return (error);
1406229997Sken	}
1407229997Sken
1408229997Sken	/*
1409229997Sken	 * If the user has asked for a blocksize that is greater than the
1410229997Sken	 * backing device's blocksize, we can do it only if the blocksize
1411229997Sken	 * the user is asking for is an even multiple of the underlying
1412229997Sken	 * device's blocksize.
1413229997Sken	 */
1414229997Sken	if ((params->blocksize_bytes != 0)
1415229997Sken	 && (params->blocksize_bytes > be_lun->blocksize)) {
1416229997Sken		uint32_t bs_multiple, tmp_blocksize;
1417229997Sken
1418229997Sken		bs_multiple = params->blocksize_bytes / be_lun->blocksize;
1419229997Sken
1420229997Sken		tmp_blocksize = bs_multiple * be_lun->blocksize;
1421229997Sken
1422229997Sken		if (tmp_blocksize == params->blocksize_bytes) {
1423229997Sken			be_lun->blocksize = params->blocksize_bytes;
1424229997Sken		} else {
1425229997Sken			snprintf(req->error_str, sizeof(req->error_str),
1426229997Sken				 "%s: requested blocksize %u is not an even "
1427229997Sken				 "multiple of backing device blocksize %u",
1428229997Sken				 __func__, params->blocksize_bytes,
1429229997Sken				 be_lun->blocksize);
1430229997Sken			return (EINVAL);
1431229997Sken
1432229997Sken		}
1433229997Sken	} else if ((params->blocksize_bytes != 0)
1434229997Sken		&& (params->blocksize_bytes != be_lun->blocksize)) {
1435229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1436229997Sken			 "%s: requested blocksize %u < backing device "
1437229997Sken			 "blocksize %u", __func__, params->blocksize_bytes,
1438229997Sken			 be_lun->blocksize);
1439229997Sken		return (EINVAL);
1440229997Sken	}
1441229997Sken
1442229997Sken	error = devsw->d_ioctl(dev, DIOCGMEDIASIZE,
1443229997Sken			       (caddr_t)&be_lun->size_bytes, FREAD,
1444229997Sken			       curthread);
1445229997Sken	if (error) {
1446229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1447232604Strasz			 "%s: error %d returned for DIOCGMEDIASIZE "
1448232604Strasz			 " ioctl on %s!", __func__, error,
1449232604Strasz			 be_lun->dev_path);
1450229997Sken		return (error);
1451229997Sken	}
1452229997Sken
1453232604Strasz	if (params->lun_size_bytes != 0) {
1454232604Strasz		if (params->lun_size_bytes > be_lun->size_bytes) {
1455232604Strasz			snprintf(req->error_str, sizeof(req->error_str),
1456232604Strasz				 "%s: requested LUN size %ju > backing device "
1457232604Strasz				 "size %ju", __func__,
1458232604Strasz				 (uintmax_t)params->lun_size_bytes,
1459232604Strasz				 (uintmax_t)be_lun->size_bytes);
1460232604Strasz			return (EINVAL);
1461232604Strasz		}
1462232604Strasz
1463232604Strasz		be_lun->size_bytes = params->lun_size_bytes;
1464232604Strasz	}
1465232604Strasz
1466229997Sken	return (0);
1467229997Sken}
1468229997Sken
1469229997Skenstatic int
1470229997Skenctl_be_block_close(struct ctl_be_block_lun *be_lun)
1471229997Sken{
1472229997Sken	DROP_GIANT();
1473229997Sken	if (be_lun->vn) {
1474229997Sken		int flags = FREAD | FWRITE;
1475229997Sken
1476229997Sken		switch (be_lun->dev_type) {
1477229997Sken		case CTL_BE_BLOCK_DEV:
1478229997Sken			if (be_lun->backend.dev.csw) {
1479229997Sken				dev_relthread(be_lun->backend.dev.cdev,
1480229997Sken					      be_lun->backend.dev.dev_ref);
1481229997Sken				be_lun->backend.dev.csw  = NULL;
1482229997Sken				be_lun->backend.dev.cdev = NULL;
1483229997Sken			}
1484229997Sken			break;
1485229997Sken		case CTL_BE_BLOCK_FILE:
1486229997Sken			break;
1487229997Sken		case CTL_BE_BLOCK_NONE:
1488229997Sken		default:
1489229997Sken			panic("Unexpected backend type.");
1490229997Sken			break;
1491229997Sken		}
1492229997Sken
1493229997Sken		(void)vn_close(be_lun->vn, flags, NOCRED, curthread);
1494229997Sken		be_lun->vn = NULL;
1495229997Sken
1496229997Sken		switch (be_lun->dev_type) {
1497229997Sken		case CTL_BE_BLOCK_DEV:
1498229997Sken			break;
1499229997Sken		case CTL_BE_BLOCK_FILE:
1500229997Sken			if (be_lun->backend.file.cred != NULL) {
1501229997Sken				crfree(be_lun->backend.file.cred);
1502229997Sken				be_lun->backend.file.cred = NULL;
1503229997Sken			}
1504229997Sken			break;
1505229997Sken		case CTL_BE_BLOCK_NONE:
1506229997Sken		default:
1507229997Sken			panic("Unexpected backend type.");
1508229997Sken			break;
1509229997Sken		}
1510229997Sken	}
1511229997Sken	PICKUP_GIANT();
1512229997Sken
1513229997Sken	return (0);
1514229997Sken}
1515229997Sken
1516229997Skenstatic int
1517229997Skenctl_be_block_open(struct ctl_be_block_softc *softc,
1518229997Sken		       struct ctl_be_block_lun *be_lun, struct ctl_lun_req *req)
1519229997Sken{
1520229997Sken	struct nameidata nd;
1521229997Sken	int		 flags;
1522229997Sken	int		 error;
1523229997Sken
1524229997Sken	/*
1525229997Sken	 * XXX KDM allow a read-only option?
1526229997Sken	 */
1527229997Sken	flags = FREAD | FWRITE;
1528229997Sken	error = 0;
1529229997Sken
1530229997Sken	if (rootvnode == NULL) {
1531229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1532229997Sken			 "%s: Root filesystem is not mounted", __func__);
1533229997Sken		return (1);
1534229997Sken	}
1535229997Sken
1536229997Sken	if (!curthread->td_proc->p_fd->fd_cdir) {
1537229997Sken		curthread->td_proc->p_fd->fd_cdir = rootvnode;
1538229997Sken		VREF(rootvnode);
1539229997Sken	}
1540229997Sken	if (!curthread->td_proc->p_fd->fd_rdir) {
1541229997Sken		curthread->td_proc->p_fd->fd_rdir = rootvnode;
1542229997Sken		VREF(rootvnode);
1543229997Sken	}
1544229997Sken	if (!curthread->td_proc->p_fd->fd_jdir) {
1545229997Sken		curthread->td_proc->p_fd->fd_jdir = rootvnode;
1546229997Sken		VREF(rootvnode);
1547229997Sken	}
1548229997Sken
1549229997Sken again:
1550229997Sken	NDINIT(&nd, LOOKUP, FOLLOW, UIO_SYSSPACE, be_lun->dev_path, curthread);
1551229997Sken	error = vn_open(&nd, &flags, 0, NULL);
1552229997Sken	if (error) {
1553229997Sken		/*
1554229997Sken		 * This is the only reasonable guess we can make as far as
1555229997Sken		 * path if the user doesn't give us a fully qualified path.
1556229997Sken		 * If they want to specify a file, they need to specify the
1557229997Sken		 * full path.
1558229997Sken		 */
1559229997Sken		if (be_lun->dev_path[0] != '/') {
1560229997Sken			char *dev_path = "/dev/";
1561229997Sken			char *dev_name;
1562229997Sken
1563229997Sken			/* Try adding device path at beginning of name */
1564229997Sken			dev_name = malloc(strlen(be_lun->dev_path)
1565229997Sken					+ strlen(dev_path) + 1,
1566229997Sken					  M_CTLBLK, M_WAITOK);
1567229997Sken			if (dev_name) {
1568229997Sken				sprintf(dev_name, "%s%s", dev_path,
1569229997Sken					be_lun->dev_path);
1570229997Sken				free(be_lun->dev_path, M_CTLBLK);
1571229997Sken				be_lun->dev_path = dev_name;
1572229997Sken				goto again;
1573229997Sken			}
1574229997Sken		}
1575229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1576229997Sken			 "%s: error opening %s", __func__, be_lun->dev_path);
1577229997Sken		return (error);
1578229997Sken	}
1579229997Sken
1580229997Sken	NDFREE(&nd, NDF_ONLY_PNBUF);
1581229997Sken
1582229997Sken	be_lun->vn = nd.ni_vp;
1583229997Sken
1584229997Sken	/* We only support disks and files. */
1585229997Sken	if (vn_isdisk(be_lun->vn, &error)) {
1586229997Sken		error = ctl_be_block_open_dev(be_lun, req);
1587229997Sken	} else if (be_lun->vn->v_type == VREG) {
1588229997Sken		error = ctl_be_block_open_file(be_lun, req);
1589229997Sken	} else {
1590229997Sken		error = EINVAL;
1591229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1592229997Sken			 "%s is not a disk or file", be_lun->dev_path);
1593229997Sken	}
1594229997Sken	VOP_UNLOCK(be_lun->vn, 0);
1595229997Sken
1596229997Sken	if (error != 0) {
1597229997Sken		ctl_be_block_close(be_lun);
1598229997Sken		return (error);
1599229997Sken	}
1600229997Sken
1601229997Sken	be_lun->blocksize_shift = fls(be_lun->blocksize) - 1;
1602229997Sken	be_lun->size_blocks = be_lun->size_bytes >> be_lun->blocksize_shift;
1603229997Sken
1604229997Sken	return (0);
1605229997Sken}
1606229997Sken
1607229997Skenstatic int
1608229997Skenctl_be_block_mem_ctor(void *mem, int size, void *arg, int flags)
1609229997Sken{
1610229997Sken	return (0);
1611229997Sken}
1612229997Sken
1613229997Skenstatic void
1614229997Skenctl_be_block_mem_dtor(void *mem, int size, void *arg)
1615229997Sken{
1616229997Sken	bzero(mem, size);
1617229997Sken}
1618229997Sken
1619229997Skenstatic int
1620229997Skenctl_be_block_create(struct ctl_be_block_softc *softc, struct ctl_lun_req *req)
1621229997Sken{
1622229997Sken	struct ctl_be_block_lun *be_lun;
1623229997Sken	struct ctl_lun_create_params *params;
1624229997Sken	struct ctl_be_arg *file_arg;
1625229997Sken	char tmpstr[32];
1626229997Sken	int retval, num_threads;
1627229997Sken	int i;
1628229997Sken
1629229997Sken	params = &req->reqdata.create;
1630229997Sken	retval = 0;
1631229997Sken
1632229997Sken	num_threads = cbb_num_threads;
1633229997Sken
1634229997Sken	file_arg = NULL;
1635229997Sken
1636229997Sken	be_lun = malloc(sizeof(*be_lun), M_CTLBLK, M_ZERO | M_WAITOK);
1637229997Sken
1638229997Sken	be_lun->softc = softc;
1639229997Sken	STAILQ_INIT(&be_lun->input_queue);
1640229997Sken	STAILQ_INIT(&be_lun->config_write_queue);
1641229997Sken	STAILQ_INIT(&be_lun->datamove_queue);
1642229997Sken	sprintf(be_lun->lunname, "cblk%d", softc->num_luns);
1643229997Sken	mtx_init(&be_lun->lock, be_lun->lunname, NULL, MTX_DEF);
1644229997Sken
1645229997Sken	be_lun->lun_zone = uma_zcreate(be_lun->lunname, MAXPHYS,
1646229997Sken	    ctl_be_block_mem_ctor, ctl_be_block_mem_dtor, NULL, NULL,
1647229997Sken	    /*align*/ 0, /*flags*/0);
1648229997Sken
1649229997Sken	if (be_lun->lun_zone == NULL) {
1650229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1651229997Sken			 "%s: error allocating UMA zone", __func__);
1652229997Sken		goto bailout_error;
1653229997Sken	}
1654229997Sken
1655229997Sken	if (params->flags & CTL_LUN_FLAG_DEV_TYPE)
1656229997Sken		be_lun->ctl_be_lun.lun_type = params->device_type;
1657229997Sken	else
1658229997Sken		be_lun->ctl_be_lun.lun_type = T_DIRECT;
1659229997Sken
1660229997Sken	if (be_lun->ctl_be_lun.lun_type == T_DIRECT) {
1661229997Sken		for (i = 0; i < req->num_be_args; i++) {
1662229997Sken			if (strcmp(req->kern_be_args[i].name, "file") == 0) {
1663229997Sken				file_arg = &req->kern_be_args[i];
1664229997Sken				break;
1665229997Sken			}
1666229997Sken		}
1667229997Sken
1668229997Sken		if (file_arg == NULL) {
1669229997Sken			snprintf(req->error_str, sizeof(req->error_str),
1670229997Sken				 "%s: no file argument specified", __func__);
1671229997Sken			goto bailout_error;
1672229997Sken		}
1673229997Sken
1674229997Sken		be_lun->dev_path = malloc(file_arg->vallen, M_CTLBLK,
1675229997Sken					  M_WAITOK | M_ZERO);
1676229997Sken
1677229997Sken		strlcpy(be_lun->dev_path, (char *)file_arg->value,
1678229997Sken			file_arg->vallen);
1679229997Sken
1680229997Sken		retval = ctl_be_block_open(softc, be_lun, req);
1681229997Sken		if (retval != 0) {
1682229997Sken			retval = 0;
1683229997Sken			goto bailout_error;
1684229997Sken		}
1685229997Sken
1686229997Sken		/*
1687229997Sken		 * Tell the user the size of the file/device.
1688229997Sken		 */
1689229997Sken		params->lun_size_bytes = be_lun->size_bytes;
1690229997Sken
1691229997Sken		/*
1692229997Sken		 * The maximum LBA is the size - 1.
1693229997Sken		 */
1694229997Sken		be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
1695229997Sken	} else {
1696229997Sken		/*
1697229997Sken		 * For processor devices, we don't have any size.
1698229997Sken		 */
1699229997Sken		be_lun->blocksize = 0;
1700229997Sken		be_lun->size_blocks = 0;
1701229997Sken		be_lun->size_bytes = 0;
1702229997Sken		be_lun->ctl_be_lun.maxlba = 0;
1703229997Sken		params->lun_size_bytes = 0;
1704229997Sken
1705229997Sken		/*
1706229997Sken		 * Default to just 1 thread for processor devices.
1707229997Sken		 */
1708229997Sken		num_threads = 1;
1709229997Sken	}
1710229997Sken
1711229997Sken	/*
1712229997Sken	 * XXX This searching loop might be refactored to be combined with
1713229997Sken	 * the loop above,
1714229997Sken	 */
1715229997Sken	for (i = 0; i < req->num_be_args; i++) {
1716229997Sken		if (strcmp(req->kern_be_args[i].name, "num_threads") == 0) {
1717229997Sken			struct ctl_be_arg *thread_arg;
1718229997Sken			char num_thread_str[16];
1719229997Sken			int tmp_num_threads;
1720229997Sken
1721229997Sken
1722229997Sken			thread_arg = &req->kern_be_args[i];
1723229997Sken
1724229997Sken			strlcpy(num_thread_str, (char *)thread_arg->value,
1725229997Sken				min(thread_arg->vallen,
1726229997Sken				sizeof(num_thread_str)));
1727229997Sken
1728229997Sken			tmp_num_threads = strtol(num_thread_str, NULL, 0);
1729229997Sken
1730229997Sken			/*
1731229997Sken			 * We don't let the user specify less than one
1732229997Sken			 * thread, but hope he's clueful enough not to
1733229997Sken			 * specify 1000 threads.
1734229997Sken			 */
1735229997Sken			if (tmp_num_threads < 1) {
1736229997Sken				snprintf(req->error_str, sizeof(req->error_str),
1737229997Sken					 "%s: invalid number of threads %s",
1738229997Sken				         __func__, num_thread_str);
1739229997Sken				goto bailout_error;
1740229997Sken			}
1741229997Sken
1742229997Sken			num_threads = tmp_num_threads;
1743229997Sken		}
1744229997Sken	}
1745229997Sken
1746229997Sken	be_lun->flags = CTL_BE_BLOCK_LUN_UNCONFIGURED;
1747229997Sken	be_lun->ctl_be_lun.flags = CTL_LUN_FLAG_PRIMARY;
1748229997Sken	be_lun->ctl_be_lun.be_lun = be_lun;
1749229997Sken	be_lun->ctl_be_lun.blocksize = be_lun->blocksize;
1750229997Sken	/* Tell the user the blocksize we ended up using */
1751229997Sken	params->blocksize_bytes = be_lun->blocksize;
1752229997Sken	if (params->flags & CTL_LUN_FLAG_ID_REQ) {
1753229997Sken		be_lun->ctl_be_lun.req_lun_id = params->req_lun_id;
1754229997Sken		be_lun->ctl_be_lun.flags |= CTL_LUN_FLAG_ID_REQ;
1755229997Sken	} else
1756229997Sken		be_lun->ctl_be_lun.req_lun_id = 0;
1757229997Sken
1758229997Sken	be_lun->ctl_be_lun.lun_shutdown = ctl_be_block_lun_shutdown;
1759229997Sken	be_lun->ctl_be_lun.lun_config_status =
1760229997Sken		ctl_be_block_lun_config_status;
1761229997Sken	be_lun->ctl_be_lun.be = &ctl_be_block_driver;
1762229997Sken
1763229997Sken	if ((params->flags & CTL_LUN_FLAG_SERIAL_NUM) == 0) {
1764229997Sken		snprintf(tmpstr, sizeof(tmpstr), "MYSERIAL%4d",
1765229997Sken			 softc->num_luns);
1766229997Sken		strncpy((char *)be_lun->ctl_be_lun.serial_num, tmpstr,
1767229997Sken			ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
1768229997Sken			sizeof(tmpstr)));
1769229997Sken
1770229997Sken		/* Tell the user what we used for a serial number */
1771229997Sken		strncpy((char *)params->serial_num, tmpstr,
1772229997Sken			ctl_min(sizeof(params->serial_num), sizeof(tmpstr)));
1773229997Sken	} else {
1774229997Sken		strncpy((char *)be_lun->ctl_be_lun.serial_num,
1775229997Sken			params->serial_num,
1776229997Sken			ctl_min(sizeof(be_lun->ctl_be_lun.serial_num),
1777229997Sken			sizeof(params->serial_num)));
1778229997Sken	}
1779229997Sken	if ((params->flags & CTL_LUN_FLAG_DEVID) == 0) {
1780229997Sken		snprintf(tmpstr, sizeof(tmpstr), "MYDEVID%4d", softc->num_luns);
1781229997Sken		strncpy((char *)be_lun->ctl_be_lun.device_id, tmpstr,
1782229997Sken			ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
1783229997Sken			sizeof(tmpstr)));
1784229997Sken
1785229997Sken		/* Tell the user what we used for a device ID */
1786229997Sken		strncpy((char *)params->device_id, tmpstr,
1787229997Sken			ctl_min(sizeof(params->device_id), sizeof(tmpstr)));
1788229997Sken	} else {
1789229997Sken		strncpy((char *)be_lun->ctl_be_lun.device_id,
1790229997Sken			params->device_id,
1791229997Sken			ctl_min(sizeof(be_lun->ctl_be_lun.device_id),
1792229997Sken				sizeof(params->device_id)));
1793229997Sken	}
1794229997Sken
1795229997Sken	TASK_INIT(&be_lun->io_task, /*priority*/0, ctl_be_block_worker, be_lun);
1796229997Sken
1797229997Sken	be_lun->io_taskqueue = taskqueue_create(be_lun->lunname, M_WAITOK,
1798229997Sken	    taskqueue_thread_enqueue, /*context*/&be_lun->io_taskqueue);
1799229997Sken
1800229997Sken	if (be_lun->io_taskqueue == NULL) {
1801229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1802229997Sken			 "%s: Unable to create taskqueue", __func__);
1803229997Sken		goto bailout_error;
1804229997Sken	}
1805229997Sken
1806229997Sken	/*
1807229997Sken	 * Note that we start the same number of threads by default for
1808229997Sken	 * both the file case and the block device case.  For the file
1809229997Sken	 * case, we need multiple threads to allow concurrency, because the
1810229997Sken	 * vnode interface is designed to be a blocking interface.  For the
1811229997Sken	 * block device case, ZFS zvols at least will block the caller's
1812229997Sken	 * context in many instances, and so we need multiple threads to
1813229997Sken	 * overcome that problem.  Other block devices don't need as many
1814229997Sken	 * threads, but they shouldn't cause too many problems.
1815229997Sken	 *
1816229997Sken	 * If the user wants to just have a single thread for a block
1817229997Sken	 * device, he can specify that when the LUN is created, or change
1818229997Sken	 * the tunable/sysctl to alter the default number of threads.
1819229997Sken	 */
1820229997Sken	retval = taskqueue_start_threads(&be_lun->io_taskqueue,
1821229997Sken					 /*num threads*/num_threads,
1822229997Sken					 /*priority*/PWAIT,
1823229997Sken					 /*thread name*/
1824229997Sken					 "%s taskq", be_lun->lunname);
1825229997Sken
1826229997Sken	if (retval != 0)
1827229997Sken		goto bailout_error;
1828229997Sken
1829229997Sken	be_lun->num_threads = num_threads;
1830229997Sken
1831229997Sken	mtx_lock(&softc->lock);
1832229997Sken	softc->num_luns++;
1833229997Sken	STAILQ_INSERT_TAIL(&softc->lun_list, be_lun, links);
1834229997Sken
1835229997Sken	mtx_unlock(&softc->lock);
1836229997Sken
1837229997Sken	retval = ctl_add_lun(&be_lun->ctl_be_lun);
1838229997Sken	if (retval != 0) {
1839229997Sken		mtx_lock(&softc->lock);
1840229997Sken		STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_block_lun,
1841229997Sken			      links);
1842229997Sken		softc->num_luns--;
1843229997Sken		mtx_unlock(&softc->lock);
1844229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1845229997Sken			 "%s: ctl_add_lun() returned error %d, see dmesg for "
1846229997Sken			"details", __func__, retval);
1847229997Sken		retval = 0;
1848229997Sken		goto bailout_error;
1849229997Sken	}
1850229997Sken
1851229997Sken	mtx_lock(&softc->lock);
1852229997Sken
1853229997Sken	/*
1854229997Sken	 * Tell the config_status routine that we're waiting so it won't
1855229997Sken	 * clean up the LUN in the event of an error.
1856229997Sken	 */
1857229997Sken	be_lun->flags |= CTL_BE_BLOCK_LUN_WAITING;
1858229997Sken
1859229997Sken	while (be_lun->flags & CTL_BE_BLOCK_LUN_UNCONFIGURED) {
1860229997Sken		retval = msleep(be_lun, &softc->lock, PCATCH, "ctlblk", 0);
1861229997Sken		if (retval == EINTR)
1862229997Sken			break;
1863229997Sken	}
1864229997Sken	be_lun->flags &= ~CTL_BE_BLOCK_LUN_WAITING;
1865229997Sken
1866229997Sken	if (be_lun->flags & CTL_BE_BLOCK_LUN_CONFIG_ERR) {
1867229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1868229997Sken			 "%s: LUN configuration error, see dmesg for details",
1869229997Sken			 __func__);
1870229997Sken		STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_block_lun,
1871229997Sken			      links);
1872229997Sken		softc->num_luns--;
1873229997Sken		mtx_unlock(&softc->lock);
1874229997Sken		goto bailout_error;
1875229997Sken	} else {
1876229997Sken		params->req_lun_id = be_lun->ctl_be_lun.lun_id;
1877229997Sken	}
1878229997Sken
1879229997Sken	mtx_unlock(&softc->lock);
1880229997Sken
1881229997Sken	be_lun->disk_stats = devstat_new_entry("cbb", params->req_lun_id,
1882229997Sken					       be_lun->blocksize,
1883229997Sken					       DEVSTAT_ALL_SUPPORTED,
1884229997Sken					       be_lun->ctl_be_lun.lun_type
1885229997Sken					       | DEVSTAT_TYPE_IF_OTHER,
1886229997Sken					       DEVSTAT_PRIORITY_OTHER);
1887229997Sken
1888229997Sken
1889229997Sken	req->status = CTL_LUN_OK;
1890229997Sken
1891229997Sken	return (retval);
1892229997Sken
1893229997Skenbailout_error:
1894229997Sken	req->status = CTL_LUN_ERROR;
1895229997Sken
1896229997Sken	ctl_be_block_close(be_lun);
1897229997Sken
1898229997Sken	free(be_lun->dev_path, M_CTLBLK);
1899229997Sken	free(be_lun, M_CTLBLK);
1900229997Sken
1901229997Sken	return (retval);
1902229997Sken}
1903229997Sken
1904229997Skenstatic int
1905229997Skenctl_be_block_rm(struct ctl_be_block_softc *softc, struct ctl_lun_req *req)
1906229997Sken{
1907229997Sken	struct ctl_lun_rm_params *params;
1908229997Sken	struct ctl_be_block_lun *be_lun;
1909229997Sken	int retval;
1910229997Sken
1911229997Sken	params = &req->reqdata.rm;
1912229997Sken
1913229997Sken	mtx_lock(&softc->lock);
1914229997Sken
1915229997Sken	be_lun = NULL;
1916229997Sken
1917229997Sken	STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
1918229997Sken		if (be_lun->ctl_be_lun.lun_id == params->lun_id)
1919229997Sken			break;
1920229997Sken	}
1921229997Sken	mtx_unlock(&softc->lock);
1922229997Sken
1923229997Sken	if (be_lun == NULL) {
1924229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1925229997Sken			 "%s: LUN %u is not managed by the block backend",
1926229997Sken			 __func__, params->lun_id);
1927229997Sken		goto bailout_error;
1928229997Sken	}
1929229997Sken
1930229997Sken	retval = ctl_disable_lun(&be_lun->ctl_be_lun);
1931229997Sken
1932229997Sken	if (retval != 0) {
1933229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1934229997Sken			 "%s: error %d returned from ctl_disable_lun() for "
1935229997Sken			 "LUN %d", __func__, retval, params->lun_id);
1936229997Sken		goto bailout_error;
1937229997Sken
1938229997Sken	}
1939229997Sken
1940229997Sken	retval = ctl_invalidate_lun(&be_lun->ctl_be_lun);
1941229997Sken	if (retval != 0) {
1942229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1943229997Sken			 "%s: error %d returned from ctl_invalidate_lun() for "
1944229997Sken			 "LUN %d", __func__, retval, params->lun_id);
1945229997Sken		goto bailout_error;
1946229997Sken	}
1947229997Sken
1948229997Sken	mtx_lock(&softc->lock);
1949229997Sken
1950229997Sken	be_lun->flags |= CTL_BE_BLOCK_LUN_WAITING;
1951229997Sken
1952229997Sken	while ((be_lun->flags & CTL_BE_BLOCK_LUN_UNCONFIGURED) == 0) {
1953229997Sken                retval = msleep(be_lun, &softc->lock, PCATCH, "ctlblk", 0);
1954229997Sken                if (retval == EINTR)
1955229997Sken                        break;
1956229997Sken        }
1957229997Sken
1958229997Sken	be_lun->flags &= ~CTL_BE_BLOCK_LUN_WAITING;
1959229997Sken
1960229997Sken	if ((be_lun->flags & CTL_BE_BLOCK_LUN_UNCONFIGURED) == 0) {
1961229997Sken		snprintf(req->error_str, sizeof(req->error_str),
1962229997Sken			 "%s: interrupted waiting for LUN to be freed",
1963229997Sken			 __func__);
1964229997Sken		mtx_unlock(&softc->lock);
1965229997Sken		goto bailout_error;
1966229997Sken	}
1967229997Sken
1968229997Sken	STAILQ_REMOVE(&softc->lun_list, be_lun, ctl_be_block_lun, links);
1969229997Sken
1970229997Sken	softc->num_luns--;
1971229997Sken	mtx_unlock(&softc->lock);
1972229997Sken
1973229997Sken	taskqueue_drain(be_lun->io_taskqueue, &be_lun->io_task);
1974229997Sken
1975229997Sken	taskqueue_free(be_lun->io_taskqueue);
1976229997Sken
1977229997Sken	ctl_be_block_close(be_lun);
1978229997Sken
1979229997Sken	if (be_lun->disk_stats != NULL)
1980229997Sken		devstat_remove_entry(be_lun->disk_stats);
1981229997Sken
1982229997Sken	uma_zdestroy(be_lun->lun_zone);
1983229997Sken
1984229997Sken	free(be_lun->dev_path, M_CTLBLK);
1985229997Sken
1986229997Sken	free(be_lun, M_CTLBLK);
1987229997Sken
1988229997Sken	req->status = CTL_LUN_OK;
1989229997Sken
1990229997Sken	return (0);
1991229997Sken
1992229997Skenbailout_error:
1993229997Sken
1994229997Sken	req->status = CTL_LUN_ERROR;
1995229997Sken
1996229997Sken	return (0);
1997229997Sken}
1998229997Sken
1999232604Straszstatic int
2000232604Straszctl_be_block_modify_file(struct ctl_be_block_lun *be_lun,
2001232604Strasz			 struct ctl_lun_req *req)
2002232604Strasz{
2003232604Strasz	struct vattr vattr;
2004232604Strasz	int error;
2005232604Strasz	struct ctl_lun_modify_params *params;
2006232604Strasz
2007232604Strasz	params = &req->reqdata.modify;
2008232604Strasz
2009232604Strasz	if (params->lun_size_bytes != 0) {
2010232604Strasz		be_lun->size_bytes = params->lun_size_bytes;
2011232604Strasz	} else  {
2012232604Strasz		error = VOP_GETATTR(be_lun->vn, &vattr, curthread->td_ucred);
2013232604Strasz		if (error != 0) {
2014232604Strasz			snprintf(req->error_str, sizeof(req->error_str),
2015232604Strasz				 "error calling VOP_GETATTR() for file %s",
2016232604Strasz				 be_lun->dev_path);
2017232604Strasz			return (error);
2018232604Strasz		}
2019232604Strasz
2020232604Strasz		be_lun->size_bytes = vattr.va_size;
2021232604Strasz	}
2022232604Strasz
2023232604Strasz	return (0);
2024232604Strasz}
2025232604Strasz
2026232604Straszstatic int
2027232604Straszctl_be_block_modify_dev(struct ctl_be_block_lun *be_lun,
2028232604Strasz			struct ctl_lun_req *req)
2029232604Strasz{
2030232604Strasz	struct cdev *dev;
2031232604Strasz	struct cdevsw *devsw;
2032232604Strasz	int error;
2033232604Strasz	struct ctl_lun_modify_params *params;
2034232604Strasz	uint64_t size_bytes;
2035232604Strasz
2036232604Strasz	params = &req->reqdata.modify;
2037232604Strasz
2038232604Strasz	dev = be_lun->vn->v_rdev;
2039232604Strasz	devsw = dev->si_devsw;
2040232604Strasz	if (!devsw->d_ioctl) {
2041232604Strasz		snprintf(req->error_str, sizeof(req->error_str),
2042232604Strasz			 "%s: no d_ioctl for device %s!", __func__,
2043232604Strasz			 be_lun->dev_path);
2044232604Strasz		return (ENODEV);
2045232604Strasz	}
2046232604Strasz
2047232604Strasz	error = devsw->d_ioctl(dev, DIOCGMEDIASIZE,
2048232604Strasz			       (caddr_t)&size_bytes, FREAD,
2049232604Strasz			       curthread);
2050232604Strasz	if (error) {
2051232604Strasz		snprintf(req->error_str, sizeof(req->error_str),
2052232604Strasz			 "%s: error %d returned for DIOCGMEDIASIZE ioctl "
2053232604Strasz			 "on %s!", __func__, error, be_lun->dev_path);
2054232604Strasz		return (error);
2055232604Strasz	}
2056232604Strasz
2057232604Strasz	if (params->lun_size_bytes != 0) {
2058232604Strasz		if (params->lun_size_bytes > size_bytes) {
2059232604Strasz			snprintf(req->error_str, sizeof(req->error_str),
2060232604Strasz				 "%s: requested LUN size %ju > backing device "
2061232604Strasz				 "size %ju", __func__,
2062232604Strasz				 (uintmax_t)params->lun_size_bytes,
2063232604Strasz				 (uintmax_t)size_bytes);
2064232604Strasz			return (EINVAL);
2065232604Strasz		}
2066232604Strasz
2067232604Strasz		be_lun->size_bytes = params->lun_size_bytes;
2068232604Strasz	} else {
2069232604Strasz		be_lun->size_bytes = size_bytes;
2070232604Strasz	}
2071232604Strasz
2072232604Strasz	return (0);
2073232604Strasz}
2074232604Strasz
2075232604Straszstatic int
2076232604Straszctl_be_block_modify(struct ctl_be_block_softc *softc, struct ctl_lun_req *req)
2077232604Strasz{
2078232604Strasz	struct ctl_lun_modify_params *params;
2079232604Strasz	struct ctl_be_block_lun *be_lun;
2080241896Skib	int error;
2081232604Strasz
2082232604Strasz	params = &req->reqdata.modify;
2083232604Strasz
2084232604Strasz	mtx_lock(&softc->lock);
2085232604Strasz
2086232604Strasz	be_lun = NULL;
2087232604Strasz
2088232604Strasz	STAILQ_FOREACH(be_lun, &softc->lun_list, links) {
2089232604Strasz		if (be_lun->ctl_be_lun.lun_id == params->lun_id)
2090232604Strasz			break;
2091232604Strasz	}
2092232604Strasz	mtx_unlock(&softc->lock);
2093232604Strasz
2094232604Strasz	if (be_lun == NULL) {
2095232604Strasz		snprintf(req->error_str, sizeof(req->error_str),
2096232604Strasz			 "%s: LUN %u is not managed by the block backend",
2097232604Strasz			 __func__, params->lun_id);
2098232604Strasz		goto bailout_error;
2099232604Strasz	}
2100232604Strasz
2101232604Strasz	if (params->lun_size_bytes != 0) {
2102232604Strasz		if (params->lun_size_bytes < be_lun->blocksize) {
2103232604Strasz			snprintf(req->error_str, sizeof(req->error_str),
2104232604Strasz				"%s: LUN size %ju < blocksize %u", __func__,
2105232604Strasz				params->lun_size_bytes, be_lun->blocksize);
2106232604Strasz			goto bailout_error;
2107232604Strasz		}
2108232604Strasz	}
2109232604Strasz
2110232604Strasz	vn_lock(be_lun->vn, LK_SHARED | LK_RETRY);
2111232604Strasz
2112232604Strasz	if (be_lun->vn->v_type == VREG)
2113232604Strasz		error = ctl_be_block_modify_file(be_lun, req);
2114232604Strasz	else
2115232604Strasz		error = ctl_be_block_modify_dev(be_lun, req);
2116232604Strasz
2117232604Strasz	VOP_UNLOCK(be_lun->vn, 0);
2118232604Strasz
2119232604Strasz	if (error != 0)
2120232604Strasz		goto bailout_error;
2121232604Strasz
2122232604Strasz	be_lun->size_blocks = be_lun->size_bytes >> be_lun->blocksize_shift;
2123232604Strasz
2124232604Strasz	/*
2125232604Strasz	 * The maximum LBA is the size - 1.
2126232604Strasz	 *
2127232604Strasz	 * XXX: Note that this field is being updated without locking,
2128232604Strasz	 * 	which might cause problems on 32-bit architectures.
2129232604Strasz	 */
2130232604Strasz	be_lun->ctl_be_lun.maxlba = be_lun->size_blocks - 1;
2131232604Strasz	ctl_lun_capacity_changed(&be_lun->ctl_be_lun);
2132232604Strasz
2133232604Strasz	/* Tell the user the exact size we ended up using */
2134232604Strasz	params->lun_size_bytes = be_lun->size_bytes;
2135232604Strasz
2136232604Strasz	req->status = CTL_LUN_OK;
2137232604Strasz
2138232604Strasz	return (0);
2139232604Strasz
2140232604Straszbailout_error:
2141232604Strasz	req->status = CTL_LUN_ERROR;
2142232604Strasz
2143232604Strasz	return (0);
2144232604Strasz}
2145232604Strasz
2146229997Skenstatic void
2147229997Skenctl_be_block_lun_shutdown(void *be_lun)
2148229997Sken{
2149229997Sken	struct ctl_be_block_lun *lun;
2150229997Sken	struct ctl_be_block_softc *softc;
2151229997Sken
2152229997Sken	lun = (struct ctl_be_block_lun *)be_lun;
2153229997Sken
2154229997Sken	softc = lun->softc;
2155229997Sken
2156229997Sken	mtx_lock(&softc->lock);
2157229997Sken	lun->flags |= CTL_BE_BLOCK_LUN_UNCONFIGURED;
2158229997Sken	if (lun->flags & CTL_BE_BLOCK_LUN_WAITING)
2159229997Sken		wakeup(lun);
2160229997Sken	mtx_unlock(&softc->lock);
2161229997Sken
2162229997Sken}
2163229997Sken
2164229997Skenstatic void
2165229997Skenctl_be_block_lun_config_status(void *be_lun, ctl_lun_config_status status)
2166229997Sken{
2167229997Sken	struct ctl_be_block_lun *lun;
2168229997Sken	struct ctl_be_block_softc *softc;
2169229997Sken
2170229997Sken	lun = (struct ctl_be_block_lun *)be_lun;
2171229997Sken	softc = lun->softc;
2172229997Sken
2173229997Sken	if (status == CTL_LUN_CONFIG_OK) {
2174229997Sken		mtx_lock(&softc->lock);
2175229997Sken		lun->flags &= ~CTL_BE_BLOCK_LUN_UNCONFIGURED;
2176229997Sken		if (lun->flags & CTL_BE_BLOCK_LUN_WAITING)
2177229997Sken			wakeup(lun);
2178229997Sken		mtx_unlock(&softc->lock);
2179229997Sken
2180229997Sken		/*
2181229997Sken		 * We successfully added the LUN, attempt to enable it.
2182229997Sken		 */
2183229997Sken		if (ctl_enable_lun(&lun->ctl_be_lun) != 0) {
2184229997Sken			printf("%s: ctl_enable_lun() failed!\n", __func__);
2185229997Sken			if (ctl_invalidate_lun(&lun->ctl_be_lun) != 0) {
2186229997Sken				printf("%s: ctl_invalidate_lun() failed!\n",
2187229997Sken				       __func__);
2188229997Sken			}
2189229997Sken		}
2190229997Sken
2191229997Sken		return;
2192229997Sken	}
2193229997Sken
2194229997Sken
2195229997Sken	mtx_lock(&softc->lock);
2196229997Sken	lun->flags &= ~CTL_BE_BLOCK_LUN_UNCONFIGURED;
2197229997Sken	lun->flags |= CTL_BE_BLOCK_LUN_CONFIG_ERR;
2198229997Sken	wakeup(lun);
2199229997Sken	mtx_unlock(&softc->lock);
2200229997Sken}
2201229997Sken
2202229997Sken
2203229997Skenstatic int
2204229997Skenctl_be_block_config_write(union ctl_io *io)
2205229997Sken{
2206229997Sken	struct ctl_be_block_lun *be_lun;
2207229997Sken	struct ctl_be_lun *ctl_be_lun;
2208229997Sken	int retval;
2209229997Sken
2210229997Sken	retval = 0;
2211229997Sken
2212229997Sken	DPRINTF("entered\n");
2213229997Sken
2214229997Sken	ctl_be_lun = (struct ctl_be_lun *)io->io_hdr.ctl_private[
2215229997Sken		CTL_PRIV_BACKEND_LUN].ptr;
2216229997Sken	be_lun = (struct ctl_be_block_lun *)ctl_be_lun->be_lun;
2217229997Sken
2218229997Sken	switch (io->scsiio.cdb[0]) {
2219229997Sken	case SYNCHRONIZE_CACHE:
2220229997Sken	case SYNCHRONIZE_CACHE_16:
2221229997Sken		/*
2222229997Sken		 * The upper level CTL code will filter out any CDBs with
2223229997Sken		 * the immediate bit set and return the proper error.
2224229997Sken		 *
2225229997Sken		 * We don't really need to worry about what LBA range the
2226229997Sken		 * user asked to be synced out.  When they issue a sync
2227229997Sken		 * cache command, we'll sync out the whole thing.
2228229997Sken		 */
2229229997Sken		mtx_lock(&be_lun->lock);
2230229997Sken		STAILQ_INSERT_TAIL(&be_lun->config_write_queue, &io->io_hdr,
2231229997Sken				   links);
2232229997Sken		mtx_unlock(&be_lun->lock);
2233229997Sken		taskqueue_enqueue(be_lun->io_taskqueue, &be_lun->io_task);
2234229997Sken		break;
2235229997Sken	case START_STOP_UNIT: {
2236229997Sken		struct scsi_start_stop_unit *cdb;
2237229997Sken
2238229997Sken		cdb = (struct scsi_start_stop_unit *)io->scsiio.cdb;
2239229997Sken
2240229997Sken		if (cdb->how & SSS_START)
2241229997Sken			retval = ctl_start_lun(ctl_be_lun);
2242229997Sken		else {
2243229997Sken			retval = ctl_stop_lun(ctl_be_lun);
2244229997Sken			/*
2245229997Sken			 * XXX KDM Copan-specific offline behavior.
2246229997Sken			 * Figure out a reasonable way to port this?
2247229997Sken			 */
2248229997Sken#ifdef NEEDTOPORT
2249229997Sken			if ((retval == 0)
2250229997Sken			 && (cdb->byte2 & SSS_ONOFFLINE))
2251229997Sken				retval = ctl_lun_offline(ctl_be_lun);
2252229997Sken#endif
2253229997Sken		}
2254229997Sken
2255229997Sken		/*
2256229997Sken		 * In general, the above routines should not fail.  They
2257229997Sken		 * just set state for the LUN.  So we've got something
2258229997Sken		 * pretty wrong here if we can't start or stop the LUN.
2259229997Sken		 */
2260229997Sken		if (retval != 0) {
2261229997Sken			ctl_set_internal_failure(&io->scsiio,
2262229997Sken						 /*sks_valid*/ 1,
2263229997Sken						 /*retry_count*/ 0xf051);
2264229997Sken			retval = CTL_RETVAL_COMPLETE;
2265229997Sken		} else {
2266229997Sken			ctl_set_success(&io->scsiio);
2267229997Sken		}
2268229997Sken		ctl_config_write_done(io);
2269229997Sken		break;
2270229997Sken	}
2271229997Sken	default:
2272229997Sken		ctl_set_invalid_opcode(&io->scsiio);
2273229997Sken		ctl_config_write_done(io);
2274229997Sken		retval = CTL_RETVAL_COMPLETE;
2275229997Sken		break;
2276229997Sken	}
2277229997Sken
2278229997Sken	return (retval);
2279229997Sken
2280229997Sken}
2281229997Sken
2282229997Skenstatic int
2283229997Skenctl_be_block_config_read(union ctl_io *io)
2284229997Sken{
2285229997Sken	return (0);
2286229997Sken}
2287229997Sken
2288229997Skenstatic int
2289229997Skenctl_be_block_lun_info(void *be_lun, struct sbuf *sb)
2290229997Sken{
2291229997Sken	struct ctl_be_block_lun *lun;
2292229997Sken	int retval;
2293229997Sken
2294229997Sken	lun = (struct ctl_be_block_lun *)be_lun;
2295229997Sken	retval = 0;
2296229997Sken
2297229997Sken	retval = sbuf_printf(sb, "<num_threads>");
2298229997Sken
2299229997Sken	if (retval != 0)
2300229997Sken		goto bailout;
2301229997Sken
2302229997Sken	retval = sbuf_printf(sb, "%d", lun->num_threads);
2303229997Sken
2304229997Sken	if (retval != 0)
2305229997Sken		goto bailout;
2306229997Sken
2307229997Sken	retval = sbuf_printf(sb, "</num_threads>");
2308229997Sken
2309229997Sken	/*
2310229997Sken	 * For processor devices, we don't have a path variable.
2311229997Sken	 */
2312229997Sken	if ((retval != 0)
2313229997Sken	 || (lun->dev_path == NULL))
2314229997Sken		goto bailout;
2315229997Sken
2316229997Sken	retval = sbuf_printf(sb, "<file>");
2317229997Sken
2318229997Sken	if (retval != 0)
2319229997Sken		goto bailout;
2320229997Sken
2321229997Sken	retval = ctl_sbuf_printf_esc(sb, lun->dev_path);
2322229997Sken
2323229997Sken	if (retval != 0)
2324229997Sken		goto bailout;
2325229997Sken
2326229997Sken	retval = sbuf_printf(sb, "</file>\n");
2327229997Sken
2328229997Skenbailout:
2329229997Sken
2330229997Sken	return (retval);
2331229997Sken}
2332229997Sken
2333229997Skenint
2334229997Skenctl_be_block_init(void)
2335229997Sken{
2336229997Sken	struct ctl_be_block_softc *softc;
2337229997Sken	int retval;
2338229997Sken
2339229997Sken	softc = &backend_block_softc;
2340229997Sken	retval = 0;
2341229997Sken
2342229997Sken	mtx_init(&softc->lock, "ctlblk", NULL, MTX_DEF);
2343229997Sken	STAILQ_INIT(&softc->beio_free_queue);
2344229997Sken	STAILQ_INIT(&softc->disk_list);
2345229997Sken	STAILQ_INIT(&softc->lun_list);
2346229997Sken	ctl_grow_beio(softc, 200);
2347229997Sken
2348229997Sken	return (retval);
2349229997Sken}
2350