4 * IO engine that uses the Linux SG v3 interface to talk to SCSI devices
6 * This ioengine can operate in two modes:
7 * sync with block devices (/dev/sdX) or
8 * with character devices (/dev/sgY) with direct=1 or sync=1
9 * async with character devices with direct=0 and sync=0
11 * What value does queue() return for the different cases?
12 * queue() return value
14 * /dev/sdX RWT FIO_Q_COMPLETED
15 * /dev/sgY RWT FIO_Q_COMPLETED
16 * with direct=1 or sync=1
19 * /dev/sgY RWT FIO_Q_QUEUED
22 * Because FIO_SYNCIO is set for this ioengine td_io_queue() will fill in
23 * issue_time *before* each IO is sent to queue()
25 * Where are the IO counting functions called for the different cases?
28 * /dev/sdX (commit==NULL)
30 * io_u_mark_depth() called in td_io_queue()
31 * io_u_mark_submit/complete() called in td_io_queue()
32 * issue_time set in td_io_queue()
34 * /dev/sgY with direct=1 or sync=1 (commit does nothing)
36 * io_u_mark_depth() called in td_io_queue()
37 * io_u_mark_submit/complete() called in queue()
38 * issue_time set in td_io_queue()
41 * /dev/sgY with direct=0 and sync=0
42 * RW: read and write operations are submitted in queue()
43 * io_u_mark_depth() called in td_io_commit()
44 * io_u_mark_submit() called in queue()
45 * issue_time set in td_io_queue()
46 * T: trim operations are queued in queue() and submitted in commit()
47 * io_u_mark_depth() called in td_io_commit()
48 * io_u_mark_submit() called in commit()
49 * issue_time set in commit()
59 #include "../optgroup.h"
65 FIO_SG_WRITE_VERIFY = 2,
72 unsigned int writefua;
73 unsigned int write_mode;
76 static struct fio_option options[] = {
79 .lname = "sg engine read fua flag support",
81 .off1 = offsetof(struct sg_options, readfua),
82 .help = "Set FUA flag (force unit access) for all Read operations",
84 .category = FIO_OPT_C_ENGINE,
85 .group = FIO_OPT_G_SG,
89 .lname = "sg engine write fua flag support",
91 .off1 = offsetof(struct sg_options, writefua),
92 .help = "Set FUA flag (force unit access) for all Write operations",
94 .category = FIO_OPT_C_ENGINE,
95 .group = FIO_OPT_G_SG,
98 .name = "sg_write_mode",
99 .lname = "specify sg write mode",
101 .off1 = offsetof(struct sg_options, write_mode),
102 .help = "Specify SCSI WRITE mode",
106 .oval = FIO_SG_WRITE,
107 .help = "Issue standard SCSI WRITE commands",
110 .oval = FIO_SG_WRITE_VERIFY,
111 .help = "Issue SCSI WRITE AND VERIFY commands",
114 .oval = FIO_SG_WRITE_SAME,
115 .help = "Issue SCSI WRITE SAME commands",
118 .category = FIO_OPT_C_ENGINE,
119 .group = FIO_OPT_G_SG,
126 #define MAX_10B_LBA 0xFFFFFFFFULL
127 #define SCSI_TIMEOUT_MS 30000 // 30 second timeout; currently no method to override
128 #define MAX_SB 64 // sense block maximum return size
130 #define FIO_SGIO_DEBUG
134 unsigned char cdb[16]; // enhanced from 10 to support 16 byte commands
135 unsigned char sb[MAX_SB]; // add sense block to commands
141 unsigned int unmap_range_count;
142 struct io_u **trim_io_us;
146 struct sgio_cmd *cmds;
147 struct io_u **events;
153 struct sgio_trim **trim_queues;
155 #ifdef FIO_SGIO_DEBUG
156 unsigned int *trim_queue_map;
160 static inline bool sgio_unbuffered(struct thread_data *td)
162 return (td->o.odirect || td->o.sync_io);
165 static void sgio_hdr_init(struct sgio_data *sd, struct sg_io_hdr *hdr,
166 struct io_u *io_u, int fs)
168 struct sgio_cmd *sc = &sd->cmds[io_u->index];
170 memset(hdr, 0, sizeof(*hdr));
171 memset(sc->cdb, 0, sizeof(sc->cdb));
173 hdr->interface_id = 'S';
175 hdr->cmd_len = sizeof(sc->cdb);
177 hdr->mx_sb_len = sizeof(sc->sb);
178 hdr->pack_id = io_u->index;
180 hdr->timeout = SCSI_TIMEOUT_MS;
183 hdr->dxferp = io_u->xfer_buf;
184 hdr->dxfer_len = io_u->xfer_buflen;
188 static int pollin_events(struct pollfd *pfds, int fds)
192 for (i = 0; i < fds; i++)
193 if (pfds[i].revents & POLLIN)
199 static int sg_fd_read(int fd, void *data, size_t size)
206 ret = read(fd, data, size);
208 if (errno == EAGAIN || errno == EINTR)
228 static int fio_sgio_getevents(struct thread_data *td, unsigned int min,
230 const struct timespec fio_unused *t)
232 struct sgio_data *sd = td->io_ops_data;
233 int left = max, eventNum, ret, r = 0, trims = 0;
234 void *buf = sd->sgbuf;
235 unsigned int i, j, events;
240 * Fill in the file descriptors
242 for_each_file(td, f, i) {
244 * don't block for min events == 0
247 sd->fd_flags[i] = fio_set_fd_nonblocking(f->fd, "sg");
249 sd->fd_flags[i] = -1;
251 sd->pfds[i].fd = f->fd;
252 sd->pfds[i].events = POLLIN;
256 ** There are two counters here:
257 ** - number of SCSI commands completed
258 ** - number of io_us completed
260 ** These are the same with reads and writes, but
261 ** could differ with trim/unmap commands because
262 ** a single unmap can include multiple io_us
268 dprint(FD_IO, "sgio_getevents: sd %p: min=%d, max=%d, left=%d\n", sd, min, max, left);
274 ret = poll(sd->pfds, td->o.nr_files, -1);
278 td_verror(td, errno, "poll");
283 if (pollin_events(sd->pfds, td->o.nr_files))
293 for_each_file(td, f, i) {
294 for (eventNum = 0; eventNum < left; eventNum++) {
295 ret = sg_fd_read(f->fd, p, sizeof(struct sg_io_hdr));
296 dprint(FD_IO, "sgio_getevents: sg_fd_read ret: %d\n", ret);
299 td_verror(td, r, "sg_read");
302 io_u = ((struct sg_io_hdr *)p)->usr_ptr;
303 if (io_u->ddir == DDIR_TRIM) {
304 events += sd->trim_queues[io_u->index]->unmap_range_count;
305 eventNum += sd->trim_queues[io_u->index]->unmap_range_count - 1;
309 p += sizeof(struct sg_io_hdr);
310 dprint(FD_IO, "sgio_getevents: events: %d, eventNum: %d, left: %d\n", events, eventNum, left);
314 if (r < 0 && !events)
324 for (i = 0; i < events; i++) {
325 struct sg_io_hdr *hdr = (struct sg_io_hdr *) buf + i;
326 sd->events[i + trims] = hdr->usr_ptr;
327 io_u = (struct io_u *)(hdr->usr_ptr);
329 if (hdr->info & SG_INFO_CHECK) {
330 /* record if an io error occurred, ignore resid */
331 memcpy(&io_u->hdr, hdr, sizeof(struct sg_io_hdr));
332 sd->events[i + trims]->error = EIO;
335 if (io_u->ddir == DDIR_TRIM) {
336 struct sgio_trim *st = sd->trim_queues[io_u->index];
337 #ifdef FIO_SGIO_DEBUG
338 assert(st->trim_io_us[0] == io_u);
339 assert(sd->trim_queue_map[io_u->index] == io_u->index);
340 dprint(FD_IO, "sgio_getevents: reaping %d io_us from trim queue %d\n", st->unmap_range_count, io_u->index);
341 dprint(FD_IO, "sgio_getevents: reaped io_u %d and stored in events[%d]\n", io_u->index, i+trims);
343 for (j = 1; j < st->unmap_range_count; j++) {
345 sd->events[i + trims] = st->trim_io_us[j];
346 #ifdef FIO_SGIO_DEBUG
347 dprint(FD_IO, "sgio_getevents: reaped io_u %d and stored in events[%d]\n", st->trim_io_us[j]->index, i+trims);
348 assert(sd->trim_queue_map[st->trim_io_us[j]->index] == io_u->index);
350 if (hdr->info & SG_INFO_CHECK) {
351 /* record if an io error occurred, ignore resid */
352 memcpy(&st->trim_io_us[j]->hdr, hdr, sizeof(struct sg_io_hdr));
353 sd->events[i + trims]->error = EIO;
356 events -= st->unmap_range_count - 1;
357 st->unmap_range_count = 0;
363 for_each_file(td, f, i) {
364 if (sd->fd_flags[i] == -1)
367 if (fcntl(f->fd, F_SETFL, sd->fd_flags[i]) < 0)
368 log_err("fio: sg failed to restore fcntl flags: %s\n", strerror(errno));
375 static enum fio_q_status fio_sgio_ioctl_doio(struct thread_data *td,
379 struct sgio_data *sd = td->io_ops_data;
380 struct sg_io_hdr *hdr = &io_u->hdr;
383 sd->events[0] = io_u;
385 ret = ioctl(f->fd, SG_IO, hdr);
389 /* record if an io error occurred */
390 if (hdr->info & SG_INFO_CHECK)
393 return FIO_Q_COMPLETED;
396 static enum fio_q_status fio_sgio_rw_doio(struct fio_file *f,
397 struct io_u *io_u, int do_sync)
399 struct sg_io_hdr *hdr = &io_u->hdr;
402 ret = write(f->fd, hdr, sizeof(*hdr));
407 ret = read(f->fd, hdr, sizeof(*hdr));
411 /* record if an io error occurred */
412 if (hdr->info & SG_INFO_CHECK)
415 return FIO_Q_COMPLETED;
421 static enum fio_q_status fio_sgio_doio(struct thread_data *td,
422 struct io_u *io_u, int do_sync)
424 struct fio_file *f = io_u->file;
425 enum fio_q_status ret;
427 if (f->filetype == FIO_TYPE_BLOCK) {
428 ret = fio_sgio_ioctl_doio(td, f, io_u);
429 td_verror(td, io_u->error, __func__);
431 ret = fio_sgio_rw_doio(f, io_u, do_sync);
433 td_verror(td, io_u->error, __func__);
439 static void fio_sgio_rw_lba(struct sg_io_hdr *hdr, unsigned long long lba,
440 unsigned long long nr_blocks)
442 if (lba < MAX_10B_LBA) {
443 hdr->cmdp[2] = (unsigned char) ((lba >> 24) & 0xff);
444 hdr->cmdp[3] = (unsigned char) ((lba >> 16) & 0xff);
445 hdr->cmdp[4] = (unsigned char) ((lba >> 8) & 0xff);
446 hdr->cmdp[5] = (unsigned char) (lba & 0xff);
447 hdr->cmdp[7] = (unsigned char) ((nr_blocks >> 8) & 0xff);
448 hdr->cmdp[8] = (unsigned char) (nr_blocks & 0xff);
450 hdr->cmdp[2] = (unsigned char) ((lba >> 56) & 0xff);
451 hdr->cmdp[3] = (unsigned char) ((lba >> 48) & 0xff);
452 hdr->cmdp[4] = (unsigned char) ((lba >> 40) & 0xff);
453 hdr->cmdp[5] = (unsigned char) ((lba >> 32) & 0xff);
454 hdr->cmdp[6] = (unsigned char) ((lba >> 24) & 0xff);
455 hdr->cmdp[7] = (unsigned char) ((lba >> 16) & 0xff);
456 hdr->cmdp[8] = (unsigned char) ((lba >> 8) & 0xff);
457 hdr->cmdp[9] = (unsigned char) (lba & 0xff);
458 hdr->cmdp[10] = (unsigned char) ((nr_blocks >> 32) & 0xff);
459 hdr->cmdp[11] = (unsigned char) ((nr_blocks >> 16) & 0xff);
460 hdr->cmdp[12] = (unsigned char) ((nr_blocks >> 8) & 0xff);
461 hdr->cmdp[13] = (unsigned char) (nr_blocks & 0xff);
467 static int fio_sgio_prep(struct thread_data *td, struct io_u *io_u)
469 struct sg_io_hdr *hdr = &io_u->hdr;
470 struct sg_options *o = td->eo;
471 struct sgio_data *sd = td->io_ops_data;
472 unsigned long long nr_blocks, lba;
475 if (io_u->xfer_buflen & (sd->bs - 1)) {
476 log_err("read/write not sector aligned\n");
480 nr_blocks = io_u->xfer_buflen / sd->bs;
481 lba = io_u->offset / sd->bs;
483 if (io_u->ddir == DDIR_READ) {
484 sgio_hdr_init(sd, hdr, io_u, 1);
486 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
487 if (lba < MAX_10B_LBA)
488 hdr->cmdp[0] = 0x28; // read(10)
490 hdr->cmdp[0] = 0x88; // read(16)
493 hdr->cmdp[1] |= 0x08;
495 fio_sgio_rw_lba(hdr, lba, nr_blocks);
497 } else if (io_u->ddir == DDIR_WRITE) {
498 sgio_hdr_init(sd, hdr, io_u, 1);
500 hdr->dxfer_direction = SG_DXFER_TO_DEV;
501 switch(o->write_mode) {
503 if (lba < MAX_10B_LBA)
504 hdr->cmdp[0] = 0x2a; // write(10)
506 hdr->cmdp[0] = 0x8a; // write(16)
508 hdr->cmdp[1] |= 0x08;
510 case FIO_SG_WRITE_VERIFY:
511 if (lba < MAX_10B_LBA)
512 hdr->cmdp[0] = 0x2e; // write and verify(10)
514 hdr->cmdp[0] = 0x8e; // write and verify(16)
516 // BYTCHK is disabled by virtue of the memset in sgio_hdr_init
517 case FIO_SG_WRITE_SAME:
518 hdr->dxfer_len = sd->bs;
519 if (lba < MAX_10B_LBA)
520 hdr->cmdp[0] = 0x41; // write same(10)
522 hdr->cmdp[0] = 0x93; // write same(16)
526 fio_sgio_rw_lba(hdr, lba, nr_blocks);
528 } else if (io_u->ddir == DDIR_TRIM) {
529 struct sgio_trim *st;
531 if (sd->current_queue == -1) {
532 sgio_hdr_init(sd, hdr, io_u, 0);
535 hdr->dxfer_direction = SG_DXFER_TO_DEV;
536 hdr->cmdp[0] = 0x42; // unmap
537 sd->current_queue = io_u->index;
538 st = sd->trim_queues[sd->current_queue];
539 hdr->dxferp = st->unmap_param;
540 #ifdef FIO_SGIO_DEBUG
541 assert(sd->trim_queues[io_u->index]->unmap_range_count == 0);
542 dprint(FD_IO, "sg: creating new queue based on io_u %d\n", io_u->index);
546 st = sd->trim_queues[sd->current_queue];
548 dprint(FD_IO, "sg: adding io_u %d to trim queue %d\n", io_u->index, sd->current_queue);
549 st->trim_io_us[st->unmap_range_count] = io_u;
550 #ifdef FIO_SGIO_DEBUG
551 sd->trim_queue_map[io_u->index] = sd->current_queue;
554 offset = 8 + 16 * st->unmap_range_count;
555 st->unmap_param[offset] = (unsigned char) ((lba >> 56) & 0xff);
556 st->unmap_param[offset+1] = (unsigned char) ((lba >> 48) & 0xff);
557 st->unmap_param[offset+2] = (unsigned char) ((lba >> 40) & 0xff);
558 st->unmap_param[offset+3] = (unsigned char) ((lba >> 32) & 0xff);
559 st->unmap_param[offset+4] = (unsigned char) ((lba >> 24) & 0xff);
560 st->unmap_param[offset+5] = (unsigned char) ((lba >> 16) & 0xff);
561 st->unmap_param[offset+6] = (unsigned char) ((lba >> 8) & 0xff);
562 st->unmap_param[offset+7] = (unsigned char) (lba & 0xff);
563 st->unmap_param[offset+8] = (unsigned char) ((nr_blocks >> 32) & 0xff);
564 st->unmap_param[offset+9] = (unsigned char) ((nr_blocks >> 16) & 0xff);
565 st->unmap_param[offset+10] = (unsigned char) ((nr_blocks >> 8) & 0xff);
566 st->unmap_param[offset+11] = (unsigned char) (nr_blocks & 0xff);
568 st->unmap_range_count++;
570 } else if (ddir_sync(io_u->ddir)) {
571 sgio_hdr_init(sd, hdr, io_u, 0);
572 hdr->dxfer_direction = SG_DXFER_NONE;
573 if (lba < MAX_10B_LBA)
574 hdr->cmdp[0] = 0x35; // synccache(10)
576 hdr->cmdp[0] = 0x91; // synccache(16)
583 static void fio_sgio_unmap_setup(struct sg_io_hdr *hdr, struct sgio_trim *st)
585 hdr->dxfer_len = st->unmap_range_count * 16 + 8;
586 hdr->cmdp[7] = (unsigned char) (((st->unmap_range_count * 16 + 8) >> 8) & 0xff);
587 hdr->cmdp[8] = (unsigned char) ((st->unmap_range_count * 16 + 8) & 0xff);
589 st->unmap_param[0] = (unsigned char) (((16 * st->unmap_range_count + 6) >> 8) & 0xff);
590 st->unmap_param[1] = (unsigned char) ((16 * st->unmap_range_count + 6) & 0xff);
591 st->unmap_param[2] = (unsigned char) (((16 * st->unmap_range_count) >> 8) & 0xff);
592 st->unmap_param[3] = (unsigned char) ((16 * st->unmap_range_count) & 0xff);
597 static enum fio_q_status fio_sgio_queue(struct thread_data *td,
600 struct sg_io_hdr *hdr = &io_u->hdr;
601 struct sgio_data *sd = td->io_ops_data;
602 int ret, do_sync = 0;
604 fio_ro_check(td, io_u);
606 if (sgio_unbuffered(td) || ddir_sync(io_u->ddir))
609 if (io_u->ddir == DDIR_TRIM) {
610 if (do_sync || io_u->file->filetype == FIO_TYPE_BLOCK) {
611 struct sgio_trim *st = sd->trim_queues[sd->current_queue];
613 /* finish cdb setup for unmap because we are
614 ** doing unmap commands synchronously */
615 #ifdef FIO_SGIO_DEBUG
616 assert(st->unmap_range_count == 1);
617 assert(io_u == st->trim_io_us[0]);
621 fio_sgio_unmap_setup(hdr, st);
623 st->unmap_range_count = 0;
624 sd->current_queue = -1;
626 /* queue up trim ranges and submit in commit() */
630 ret = fio_sgio_doio(td, io_u, do_sync);
634 else if (hdr->status) {
635 io_u->resid = hdr->resid;
637 } else if (td->io_ops->commit != NULL) {
638 if (do_sync && !ddir_sync(io_u->ddir)) {
639 io_u_mark_submit(td, 1);
640 io_u_mark_complete(td, 1);
641 } else if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
642 io_u_mark_submit(td, 1);
643 io_u_queued(td, io_u);
648 td_verror(td, io_u->error, "xfer");
649 return FIO_Q_COMPLETED;
655 static int fio_sgio_commit(struct thread_data *td)
657 struct sgio_data *sd = td->io_ops_data;
658 struct sgio_trim *st;
660 struct sg_io_hdr *hdr;
665 if (sd->current_queue == -1)
668 st = sd->trim_queues[sd->current_queue];
669 io_u = st->trim_io_us[0];
672 fio_sgio_unmap_setup(hdr, st);
674 sd->current_queue = -1;
676 ret = fio_sgio_rw_doio(io_u->file, io_u, 0);
678 if (ret < 0 || hdr->status) {
688 for (i = 0; i < st->unmap_range_count; i++) {
689 st->trim_io_us[i]->error = error;
690 clear_io_u(td, st->trim_io_us[i]);
692 st->trim_io_us[i]->resid = hdr->resid;
695 td_verror(td, error, "xfer");
699 if (fio_fill_issue_time(td)) {
700 fio_gettime(&now, NULL);
701 for (i = 0; i < st->unmap_range_count; i++) {
702 memcpy(&st->trim_io_us[i]->issue_time, &now, sizeof(now));
703 io_u_queued(td, io_u);
706 io_u_mark_submit(td, st->unmap_range_count);
711 static struct io_u *fio_sgio_event(struct thread_data *td, int event)
713 struct sgio_data *sd = td->io_ops_data;
715 return sd->events[event];
718 static int fio_sgio_read_capacity(struct thread_data *td, unsigned int *bs,
719 unsigned long long *max_lba)
722 * need to do read capacity operation w/o benefit of sd or
723 * io_u structures, which are not initialized until later.
725 struct sg_io_hdr hdr;
726 unsigned char cmd[16];
727 unsigned char sb[64];
728 unsigned char buf[32]; // read capacity return
732 struct fio_file *f = td->files[0];
734 /* open file independent of rest of application */
735 fd = open(f->file_name, O_RDONLY);
739 memset(&hdr, 0, sizeof(hdr));
740 memset(cmd, 0, sizeof(cmd));
741 memset(sb, 0, sizeof(sb));
742 memset(buf, 0, sizeof(buf));
744 /* First let's try a 10 byte read capacity. */
745 hdr.interface_id = 'S';
749 hdr.mx_sb_len = sizeof(sb);
750 hdr.timeout = SCSI_TIMEOUT_MS;
751 hdr.cmdp[0] = 0x25; // Read Capacity(10)
752 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
754 hdr.dxfer_len = sizeof(buf);
756 ret = ioctl(fd, SG_IO, &hdr);
762 *bs = ((unsigned long) buf[4] << 24) | ((unsigned long) buf[5] << 16) |
763 ((unsigned long) buf[6] << 8) | (unsigned long) buf[7];
764 *max_lba = ((unsigned long) buf[0] << 24) | ((unsigned long) buf[1] << 16) |
765 ((unsigned long) buf[2] << 8) | (unsigned long) buf[3];
768 * If max lba masked by MAX_10B_LBA equals MAX_10B_LBA,
769 * then need to retry with 16 byte Read Capacity command.
771 if (*max_lba == MAX_10B_LBA) {
773 hdr.cmdp[0] = 0x9e; // service action
774 hdr.cmdp[1] = 0x10; // Read Capacity(16)
775 hdr.cmdp[10] = (unsigned char) ((sizeof(buf) >> 24) & 0xff);
776 hdr.cmdp[11] = (unsigned char) ((sizeof(buf) >> 16) & 0xff);
777 hdr.cmdp[12] = (unsigned char) ((sizeof(buf) >> 8) & 0xff);
778 hdr.cmdp[13] = (unsigned char) (sizeof(buf) & 0xff);
780 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
782 hdr.dxfer_len = sizeof(buf);
784 ret = ioctl(fd, SG_IO, &hdr);
790 /* record if an io error occurred */
791 if (hdr.info & SG_INFO_CHECK)
792 td_verror(td, EIO, "fio_sgio_read_capacity");
794 *bs = (buf[8] << 24) | (buf[9] << 16) | (buf[10] << 8) | buf[11];
795 *max_lba = ((unsigned long long)buf[0] << 56) |
796 ((unsigned long long)buf[1] << 48) |
797 ((unsigned long long)buf[2] << 40) |
798 ((unsigned long long)buf[3] << 32) |
799 ((unsigned long long)buf[4] << 24) |
800 ((unsigned long long)buf[5] << 16) |
801 ((unsigned long long)buf[6] << 8) |
802 (unsigned long long)buf[7];
809 static void fio_sgio_cleanup(struct thread_data *td)
811 struct sgio_data *sd = td->io_ops_data;
820 #ifdef FIO_SGIO_DEBUG
821 free(sd->trim_queue_map);
824 for (i = 0; i < td->o.iodepth; i++) {
825 free(sd->trim_queues[i]->unmap_param);
826 free(sd->trim_queues[i]->trim_io_us);
827 free(sd->trim_queues[i]);
830 free(sd->trim_queues);
835 static int fio_sgio_init(struct thread_data *td)
837 struct sgio_data *sd;
838 struct sgio_trim *st;
841 sd = calloc(1, sizeof(*sd));
842 sd->cmds = calloc(td->o.iodepth, sizeof(struct sgio_cmd));
843 sd->sgbuf = calloc(td->o.iodepth, sizeof(struct sg_io_hdr));
844 sd->events = calloc(td->o.iodepth, sizeof(struct io_u *));
845 sd->pfds = calloc(td->o.nr_files, sizeof(struct pollfd));
846 sd->fd_flags = calloc(td->o.nr_files, sizeof(int));
847 sd->type_checked = 0;
849 sd->trim_queues = calloc(td->o.iodepth, sizeof(struct sgio_trim *));
850 sd->current_queue = -1;
851 #ifdef FIO_SGIO_DEBUG
852 sd->trim_queue_map = calloc(td->o.iodepth, sizeof(int));
854 for (i = 0; i < td->o.iodepth; i++) {
855 sd->trim_queues[i] = calloc(1, sizeof(struct sgio_trim));
856 st = sd->trim_queues[i];
857 st->unmap_param = calloc(td->o.iodepth + 1, sizeof(char[16]));
858 st->unmap_range_count = 0;
859 st->trim_io_us = calloc(td->o.iodepth, sizeof(struct io_u *));
862 td->io_ops_data = sd;
865 * we want to do it, regardless of whether odirect is set or not
867 td->o.override_sync = 1;
871 static int fio_sgio_type_check(struct thread_data *td, struct fio_file *f)
873 struct sgio_data *sd = td->io_ops_data;
875 unsigned long long max_lba = 0;
877 if (f->filetype == FIO_TYPE_BLOCK) {
878 if (ioctl(f->fd, BLKSSZGET, &bs) < 0) {
879 td_verror(td, errno, "ioctl");
882 } else if (f->filetype == FIO_TYPE_CHAR) {
885 if (ioctl(f->fd, SG_GET_VERSION_NUM, &version) < 0) {
886 td_verror(td, errno, "ioctl");
890 ret = fio_sgio_read_capacity(td, &bs, &max_lba);
892 td_verror(td, td->error, "fio_sgio_read_capacity");
893 log_err("ioengine sg unable to read capacity successfully\n");
897 td_verror(td, EINVAL, "wrong file type");
898 log_err("ioengine sg only works on block or character devices\n");
903 // Determine size of commands needed based on max_lba
904 if (max_lba >= MAX_10B_LBA) {
905 dprint(FD_IO, "sgio_type_check: using 16 byte read/write "
906 "commands for lba above 0x%016llx/0x%016llx\n",
907 MAX_10B_LBA, max_lba);
910 if (f->filetype == FIO_TYPE_BLOCK) {
911 td->io_ops->getevents = NULL;
912 td->io_ops->event = NULL;
913 td->io_ops->commit = NULL;
915 ** Setting these functions to null may cause problems
916 ** with filename=/dev/sda:/dev/sg0 since we are only
917 ** considering a single file
920 sd->type_checked = 1;
925 static int fio_sgio_open(struct thread_data *td, struct fio_file *f)
927 struct sgio_data *sd = td->io_ops_data;
930 ret = generic_open_file(td, f);
934 if (sd && !sd->type_checked && fio_sgio_type_check(td, f)) {
935 ret = generic_close_file(td, f);
943 * Build an error string with details about the driver, host or scsi
944 * error contained in the sg header Caller will use as necessary.
946 static char *fio_sgio_errdetails(struct io_u *io_u)
948 struct sg_io_hdr *hdr = &io_u->hdr;
949 #define MAXERRDETAIL 1024
950 #define MAXMSGCHUNK 128
951 char *msg, msgchunk[MAXMSGCHUNK];
954 msg = calloc(1, MAXERRDETAIL);
958 * can't seem to find sg_err.h, so I'll just echo the define values
959 * so others can search on internet to find clearer clues of meaning.
961 if (hdr->info & SG_INFO_CHECK) {
962 if (hdr->host_status) {
963 snprintf(msgchunk, MAXMSGCHUNK, "SG Host Status: 0x%02x; ", hdr->host_status);
964 strlcat(msg, msgchunk, MAXERRDETAIL);
965 switch (hdr->host_status) {
967 strlcat(msg, "SG_ERR_DID_NO_CONNECT", MAXERRDETAIL);
970 strlcat(msg, "SG_ERR_DID_BUS_BUSY", MAXERRDETAIL);
973 strlcat(msg, "SG_ERR_DID_TIME_OUT", MAXERRDETAIL);
976 strlcat(msg, "SG_ERR_DID_BAD_TARGET", MAXERRDETAIL);
979 strlcat(msg, "SG_ERR_DID_ABORT", MAXERRDETAIL);
982 strlcat(msg, "SG_ERR_DID_PARITY", MAXERRDETAIL);
985 strlcat(msg, "SG_ERR_DID_ERROR (internal error)", MAXERRDETAIL);
988 strlcat(msg, "SG_ERR_DID_RESET", MAXERRDETAIL);
991 strlcat(msg, "SG_ERR_DID_BAD_INTR (unexpected)", MAXERRDETAIL);
994 strlcat(msg, "SG_ERR_DID_PASSTHROUGH", MAXERRDETAIL);
997 strlcat(msg, "SG_ERR_DID_SOFT_ERROR (driver retry?)", MAXERRDETAIL);
1000 strlcat(msg, "SG_ERR_DID_IMM_RETRY", MAXERRDETAIL);
1003 strlcat(msg, "SG_ERR_DID_REQUEUE", MAXERRDETAIL);
1006 strlcat(msg, "SG_ERR_DID_TRANSPORT_DISRUPTED", MAXERRDETAIL);
1009 strlcat(msg, "SG_ERR_DID_TRANSPORT_FAILFAST", MAXERRDETAIL);
1012 strlcat(msg, "SG_ERR_DID_TARGET_FAILURE", MAXERRDETAIL);
1015 strlcat(msg, "SG_ERR_DID_NEXUS_FAILURE", MAXERRDETAIL);
1018 strlcat(msg, "SG_ERR_DID_ALLOC_FAILURE", MAXERRDETAIL);
1021 strlcat(msg, "SG_ERR_DID_MEDIUM_ERROR", MAXERRDETAIL);
1024 strlcat(msg, "Unknown", MAXERRDETAIL);
1027 strlcat(msg, ". ", MAXERRDETAIL);
1029 if (hdr->driver_status) {
1030 snprintf(msgchunk, MAXMSGCHUNK, "SG Driver Status: 0x%02x; ", hdr->driver_status);
1031 strlcat(msg, msgchunk, MAXERRDETAIL);
1032 switch (hdr->driver_status & 0x0F) {
1034 strlcat(msg, "SG_ERR_DRIVER_BUSY", MAXERRDETAIL);
1037 strlcat(msg, "SG_ERR_DRIVER_SOFT", MAXERRDETAIL);
1040 strlcat(msg, "SG_ERR_DRIVER_MEDIA", MAXERRDETAIL);
1043 strlcat(msg, "SG_ERR_DRIVER_ERROR", MAXERRDETAIL);
1046 strlcat(msg, "SG_ERR_DRIVER_INVALID", MAXERRDETAIL);
1049 strlcat(msg, "SG_ERR_DRIVER_TIMEOUT", MAXERRDETAIL);
1052 strlcat(msg, "SG_ERR_DRIVER_HARD", MAXERRDETAIL);
1055 strlcat(msg, "SG_ERR_DRIVER_SENSE", MAXERRDETAIL);
1058 strlcat(msg, "Unknown", MAXERRDETAIL);
1061 strlcat(msg, "; ", MAXERRDETAIL);
1062 switch (hdr->driver_status & 0xF0) {
1064 strlcat(msg, "SG_ERR_SUGGEST_RETRY", MAXERRDETAIL);
1067 strlcat(msg, "SG_ERR_SUGGEST_ABORT", MAXERRDETAIL);
1070 strlcat(msg, "SG_ERR_SUGGEST_REMAP", MAXERRDETAIL);
1073 strlcat(msg, "SG_ERR_SUGGEST_DIE", MAXERRDETAIL);
1076 strlcat(msg, "SG_ERR_SUGGEST_SENSE", MAXERRDETAIL);
1079 strlcat(msg, ". ", MAXERRDETAIL);
1082 snprintf(msgchunk, MAXMSGCHUNK, "SG SCSI Status: 0x%02x; ", hdr->status);
1083 strlcat(msg, msgchunk, MAXERRDETAIL);
1084 // SCSI 3 status codes
1085 switch (hdr->status) {
1087 strlcat(msg, "CHECK_CONDITION", MAXERRDETAIL);
1090 strlcat(msg, "CONDITION_MET", MAXERRDETAIL);
1093 strlcat(msg, "BUSY", MAXERRDETAIL);
1096 strlcat(msg, "INTERMEDIATE", MAXERRDETAIL);
1099 strlcat(msg, "INTERMEDIATE_CONDITION_MET", MAXERRDETAIL);
1102 strlcat(msg, "RESERVATION_CONFLICT", MAXERRDETAIL);
1105 strlcat(msg, "COMMAND_TERMINATED", MAXERRDETAIL);
1108 strlcat(msg, "TASK_SET_FULL", MAXERRDETAIL);
1111 strlcat(msg, "ACA_ACTIVE", MAXERRDETAIL);
1114 strlcat(msg, "TASK_ABORTED", MAXERRDETAIL);
1117 strlcat(msg, "Unknown", MAXERRDETAIL);
1120 strlcat(msg, ". ", MAXERRDETAIL);
1122 if (hdr->sb_len_wr) {
1123 snprintf(msgchunk, MAXMSGCHUNK, "Sense Data (%d bytes):", hdr->sb_len_wr);
1124 strlcat(msg, msgchunk, MAXERRDETAIL);
1125 for (i = 0; i < hdr->sb_len_wr; i++) {
1126 snprintf(msgchunk, MAXMSGCHUNK, " %02x", hdr->sbp[i]);
1127 strlcat(msg, msgchunk, MAXERRDETAIL);
1129 strlcat(msg, ". ", MAXERRDETAIL);
1131 if (hdr->resid != 0) {
1132 snprintf(msgchunk, MAXMSGCHUNK, "SG Driver: %d bytes out of %d not transferred. ", hdr->resid, hdr->dxfer_len);
1133 strlcat(msg, msgchunk, MAXERRDETAIL);
1136 strlcat(msg, "cdb:", MAXERRDETAIL);
1137 for (i = 0; i < hdr->cmd_len; i++) {
1138 snprintf(msgchunk, MAXMSGCHUNK, " %02x", hdr->cmdp[i]);
1139 strlcat(msg, msgchunk, MAXERRDETAIL);
1141 strlcat(msg, ". ", MAXERRDETAIL);
1142 if (io_u->ddir == DDIR_TRIM) {
1143 unsigned char *param_list = hdr->dxferp;
1144 strlcat(msg, "dxferp:", MAXERRDETAIL);
1145 for (i = 0; i < hdr->dxfer_len; i++) {
1146 snprintf(msgchunk, MAXMSGCHUNK, " %02x", param_list[i]);
1147 strlcat(msg, msgchunk, MAXERRDETAIL);
1149 strlcat(msg, ". ", MAXERRDETAIL);
1154 if (!(hdr->info & SG_INFO_CHECK) && !strlen(msg))
1155 strncpy(msg, "SG Driver did not report a Host, Driver or Device check",
1162 * get max file size from read capacity.
1164 static int fio_sgio_get_file_size(struct thread_data *td, struct fio_file *f)
1167 * get_file_size is being called even before sgio_init is
1168 * called, so none of the sg_io structures are
1169 * initialized in the thread_data yet. So we need to do the
1170 * ReadCapacity without any of those helpers. One of the effects
1171 * is that ReadCapacity may get called 4 times on each open:
1172 * readcap(10) followed by readcap(16) if needed - just to get
1173 * the file size after the init occurs - it will be called
1174 * again when "type_check" is called during structure
1175 * initialization I'm not sure how to prevent this little
1178 unsigned int bs = 0;
1179 unsigned long long max_lba = 0;
1182 if (fio_file_size_known(f))
1185 if (f->filetype != FIO_TYPE_BLOCK && f->filetype != FIO_TYPE_CHAR) {
1186 td_verror(td, EINVAL, "wrong file type");
1187 log_err("ioengine sg only works on block or character devices\n");
1191 ret = fio_sgio_read_capacity(td, &bs, &max_lba);
1193 td_verror(td, td->error, "fio_sgio_read_capacity");
1194 log_err("ioengine sg unable to successfully execute read capacity to get block size and maximum lba\n");
1198 f->real_file_size = (max_lba + 1) * bs;
1199 fio_file_set_size_known(f);
1204 static struct ioengine_ops ioengine = {
1206 .version = FIO_IOOPS_VERSION,
1207 .init = fio_sgio_init,
1208 .prep = fio_sgio_prep,
1209 .queue = fio_sgio_queue,
1210 .commit = fio_sgio_commit,
1211 .getevents = fio_sgio_getevents,
1212 .errdetails = fio_sgio_errdetails,
1213 .event = fio_sgio_event,
1214 .cleanup = fio_sgio_cleanup,
1215 .open_file = fio_sgio_open,
1216 .close_file = generic_close_file,
1217 .get_file_size = fio_sgio_get_file_size,
1218 .flags = FIO_SYNCIO | FIO_RAWIO,
1220 .option_struct_size = sizeof(struct sg_options)
1223 #else /* FIO_HAVE_SGIO */
1226 * When we have a proper configure system in place, we simply wont build
1227 * and install this io engine. For now install a crippled version that
1228 * just complains and fails to load.
1230 static int fio_sgio_init(struct thread_data fio_unused *td)
1232 log_err("fio: ioengine sg not available\n");
1236 static struct ioengine_ops ioengine = {
1238 .version = FIO_IOOPS_VERSION,
1239 .init = fio_sgio_init,
1244 static void fio_init fio_sgio_register(void)
1246 register_ioengine(&ioengine);
1249 static void fio_exit fio_sgio_unregister(void)
1251 unregister_ioengine(&ioengine);