4 * IO engine that uses the Linux SG v3 interface to talk to SCSI devices
19 unsigned char cdb[10];
24 struct sgio_cmd *cmds;
33 static void sgio_hdr_init(struct sgio_data *sd, struct sg_io_hdr *hdr,
34 struct io_u *io_u, int fs)
36 struct sgio_cmd *sc = &sd->cmds[io_u->index];
38 memset(hdr, 0, sizeof(*hdr));
39 memset(sc->cdb, 0, sizeof(sc->cdb));
41 hdr->interface_id = 'S';
43 hdr->cmd_len = sizeof(sc->cdb);
44 hdr->pack_id = io_u->index;
48 hdr->dxferp = io_u->xfer_buf;
49 hdr->dxfer_len = io_u->xfer_buflen;
53 static int pollin_events(struct pollfd *pfds, int fds)
57 for (i = 0; i < fds; i++)
58 if (pfds[i].revents & POLLIN)
64 static int fio_sgio_getevents(struct thread_data *td, unsigned int min,
65 unsigned int max, struct timespec fio_unused *t)
67 struct sgio_data *sd = td->io_ops->data;
68 int left = max, ret, r = 0;
69 void *buf = sd->sgbuf;
70 unsigned int i, events;
74 * Fill in the file descriptors
76 for_each_file(td, f, i) {
78 * don't block for min events == 0
81 fio_set_fd_nonblocking(f->fd, "sg");
83 sd->pfds[i].fd = f->fd;
84 sd->pfds[i].events = POLLIN;
94 ret = poll(sd->pfds, td->o.nr_files, -1);
98 td_verror(td, errno, "poll");
103 if (pollin_events(sd->pfds, td->o.nr_files))
113 for_each_file(td, f, i) {
114 ret = read(f->fd, p, left * sizeof(struct sg_io_hdr));
119 td_verror(td, errno, "read");
123 events += ret / sizeof(struct sg_io_hdr);
137 for (i = 0; i < events; i++) {
138 struct sg_io_hdr *hdr = (struct sg_io_hdr *) buf + i;
140 sd->events[i] = hdr->usr_ptr;
145 for_each_file(td, f, i)
146 fcntl(f->fd, F_SETFL, sd->fd_flags[i]);
152 static int fio_sgio_ioctl_doio(struct thread_data *td,
153 struct fio_file *f, struct io_u *io_u)
155 struct sgio_data *sd = td->io_ops->data;
156 struct sg_io_hdr *hdr = &io_u->hdr;
159 sd->events[0] = io_u;
161 ret = ioctl(f->fd, SG_IO, hdr);
165 return FIO_Q_COMPLETED;
168 static int fio_sgio_rw_doio(struct fio_file *f, struct io_u *io_u, int do_sync)
170 struct sg_io_hdr *hdr = &io_u->hdr;
173 ret = write(f->fd, hdr, sizeof(*hdr));
178 ret = read(f->fd, hdr, sizeof(*hdr));
181 return FIO_Q_COMPLETED;
187 static int fio_sgio_doio(struct thread_data *td, struct io_u *io_u, int do_sync)
189 struct fio_file *f = io_u->file;
191 if (f->filetype == FIO_TYPE_BD)
192 return fio_sgio_ioctl_doio(td, f, io_u);
194 return fio_sgio_rw_doio(f, io_u, do_sync);
197 static int fio_sgio_prep(struct thread_data *td, struct io_u *io_u)
199 struct sg_io_hdr *hdr = &io_u->hdr;
200 struct sgio_data *sd = td->io_ops->data;
203 if (io_u->xfer_buflen & (sd->bs - 1)) {
204 log_err("read/write not sector aligned\n");
208 if (io_u->ddir == DDIR_READ) {
209 sgio_hdr_init(sd, hdr, io_u, 1);
211 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
213 } else if (io_u->ddir == DDIR_WRITE) {
214 sgio_hdr_init(sd, hdr, io_u, 1);
216 hdr->dxfer_direction = SG_DXFER_TO_DEV;
219 sgio_hdr_init(sd, hdr, io_u, 0);
221 hdr->dxfer_direction = SG_DXFER_NONE;
225 if (hdr->dxfer_direction != SG_DXFER_NONE) {
226 nr_blocks = io_u->xfer_buflen / sd->bs;
227 lba = io_u->offset / sd->bs;
228 hdr->cmdp[2] = (unsigned char) ((lba >> 24) & 0xff);
229 hdr->cmdp[3] = (unsigned char) ((lba >> 16) & 0xff);
230 hdr->cmdp[4] = (unsigned char) ((lba >> 8) & 0xff);
231 hdr->cmdp[5] = (unsigned char) (lba & 0xff);
232 hdr->cmdp[7] = (unsigned char) ((nr_blocks >> 8) & 0xff);
233 hdr->cmdp[8] = (unsigned char) (nr_blocks & 0xff);
239 static int fio_sgio_queue(struct thread_data *td, struct io_u *io_u)
241 struct sg_io_hdr *hdr = &io_u->hdr;
242 int ret, do_sync = 0;
244 fio_ro_check(td, io_u);
246 if (td->o.sync_io || td->o.odirect || ddir_sync(io_u->ddir))
249 ret = fio_sgio_doio(td, io_u, do_sync);
253 else if (hdr->status) {
254 io_u->resid = hdr->resid;
259 td_verror(td, io_u->error, "xfer");
260 return FIO_Q_COMPLETED;
266 static struct io_u *fio_sgio_event(struct thread_data *td, int event)
268 struct sgio_data *sd = td->io_ops->data;
270 return sd->events[event];
273 static int fio_sgio_get_bs(struct thread_data *td, unsigned int *bs)
275 struct sgio_data *sd = td->io_ops->data;
277 struct sg_io_hdr *hdr;
278 unsigned char buf[8];
281 memset(&io_u, 0, sizeof(io_u));
282 io_u.file = td->files[0];
285 sgio_hdr_init(sd, hdr, &io_u, 0);
286 memset(buf, 0, sizeof(buf));
289 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
291 hdr->dxfer_len = sizeof(buf);
293 ret = fio_sgio_doio(td, &io_u, 1);
297 *bs = (buf[4] << 24) | (buf[5] << 16) | (buf[6] << 8) | buf[7];
301 static void fio_sgio_cleanup(struct thread_data *td)
303 struct sgio_data *sd = td->io_ops->data;
315 static int fio_sgio_init(struct thread_data *td)
317 struct sgio_data *sd;
319 sd = malloc(sizeof(*sd));
320 memset(sd, 0, sizeof(*sd));
321 sd->cmds = malloc(td->o.iodepth * sizeof(struct sgio_cmd));
322 memset(sd->cmds, 0, td->o.iodepth * sizeof(struct sgio_cmd));
323 sd->events = malloc(td->o.iodepth * sizeof(struct io_u *));
324 memset(sd->events, 0, td->o.iodepth * sizeof(struct io_u *));
325 sd->pfds = malloc(sizeof(struct pollfd) * td->o.nr_files);
326 memset(sd->pfds, 0, sizeof(struct pollfd) * td->o.nr_files);
327 sd->fd_flags = malloc(sizeof(int) * td->o.nr_files);
328 memset(sd->fd_flags, 0, sizeof(int) * td->o.nr_files);
329 sd->sgbuf = malloc(sizeof(struct sg_io_hdr) * td->o.iodepth);
330 memset(sd->sgbuf, 0, sizeof(struct sg_io_hdr) * td->o.iodepth);
332 td->io_ops->data = sd;
335 * we want to do it, regardless of whether odirect is set or not
337 td->o.override_sync = 1;
341 static int fio_sgio_type_check(struct thread_data *td, struct fio_file *f)
343 struct sgio_data *sd = td->io_ops->data;
346 if (f->filetype == FIO_TYPE_BD) {
347 if (ioctl(f->fd, BLKSSZGET, &bs) < 0) {
348 td_verror(td, errno, "ioctl");
351 } else if (f->filetype == FIO_TYPE_CHAR) {
354 if (ioctl(f->fd, SG_GET_VERSION_NUM, &version) < 0) {
355 td_verror(td, errno, "ioctl");
359 ret = fio_sgio_get_bs(td, &bs);
363 log_err("ioengine sg only works on block devices\n");
369 if (f->filetype == FIO_TYPE_BD) {
370 td->io_ops->getevents = NULL;
371 td->io_ops->event = NULL;
377 static int fio_sgio_open(struct thread_data *td, struct fio_file *f)
379 struct sgio_data *sd = td->io_ops->data;
382 ret = generic_open_file(td, f);
386 if (sd && !sd->type_checked && fio_sgio_type_check(td, f)) {
387 ret = generic_close_file(td, f);
394 static struct ioengine_ops ioengine = {
396 .version = FIO_IOOPS_VERSION,
397 .init = fio_sgio_init,
398 .prep = fio_sgio_prep,
399 .queue = fio_sgio_queue,
400 .getevents = fio_sgio_getevents,
401 .event = fio_sgio_event,
402 .cleanup = fio_sgio_cleanup,
403 .open_file = fio_sgio_open,
404 .close_file = generic_close_file,
405 .get_file_size = generic_get_file_size,
406 .flags = FIO_SYNCIO | FIO_RAWIO,
409 #else /* FIO_HAVE_SGIO */
412 * When we have a proper configure system in place, we simply wont build
413 * and install this io engine. For now install a crippled version that
414 * just complains and fails to load.
416 static int fio_sgio_init(struct thread_data fio_unused *td)
418 log_err("fio: ioengine sg not available\n");
422 static struct ioengine_ops ioengine = {
424 .version = FIO_IOOPS_VERSION,
425 .init = fio_sgio_init,
430 static void fio_init fio_sgio_register(void)
432 register_ioengine(&ioengine);
435 static void fio_exit fio_sgio_unregister(void)
437 unregister_ioengine(&ioengine);