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 sd->fd_flags[i] = fcntl(f->fd, F_GETFL);
82 fcntl(f->fd, F_SETFL, sd->fd_flags[i] | O_NONBLOCK);
84 sd->pfds[i].fd = f->fd;
85 sd->pfds[i].events = POLLIN;
95 ret = poll(sd->pfds, td->o.nr_files, -1);
99 td_verror(td, errno, "poll");
104 if (pollin_events(sd->pfds, td->o.nr_files))
114 for_each_file(td, f, i) {
115 ret = read(f->fd, p, left * sizeof(struct sg_io_hdr));
120 td_verror(td, errno, "read");
124 events += ret / sizeof(struct sg_io_hdr);
138 for (i = 0; i < events; i++) {
139 struct sg_io_hdr *hdr = (struct sg_io_hdr *) buf + i;
141 sd->events[i] = hdr->usr_ptr;
146 for_each_file(td, f, i)
147 fcntl(f->fd, F_SETFL, sd->fd_flags[i]);
153 static int fio_sgio_ioctl_doio(struct thread_data *td,
154 struct fio_file *f, struct io_u *io_u)
156 struct sgio_data *sd = td->io_ops->data;
157 struct sg_io_hdr *hdr = &io_u->hdr;
160 sd->events[0] = io_u;
162 ret = ioctl(f->fd, SG_IO, hdr);
166 return FIO_Q_COMPLETED;
169 static int fio_sgio_rw_doio(struct fio_file *f, struct io_u *io_u, int sync)
171 struct sg_io_hdr *hdr = &io_u->hdr;
174 ret = write(f->fd, hdr, sizeof(*hdr));
179 ret = read(f->fd, hdr, sizeof(*hdr));
182 return FIO_Q_COMPLETED;
188 static int fio_sgio_doio(struct thread_data *td, struct io_u *io_u, int sync)
190 struct fio_file *f = io_u->file;
192 if (f->filetype == FIO_TYPE_BD)
193 return fio_sgio_ioctl_doio(td, f, io_u);
195 return fio_sgio_rw_doio(f, io_u, sync);
198 static int fio_sgio_prep(struct thread_data *td, struct io_u *io_u)
200 struct sg_io_hdr *hdr = &io_u->hdr;
201 struct sgio_data *sd = td->io_ops->data;
204 if (io_u->xfer_buflen & (sd->bs - 1)) {
205 log_err("read/write not sector aligned\n");
209 if (io_u->ddir == DDIR_READ) {
210 sgio_hdr_init(sd, hdr, io_u, 1);
212 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
214 } else if (io_u->ddir == DDIR_WRITE) {
215 sgio_hdr_init(sd, hdr, io_u, 1);
217 hdr->dxfer_direction = SG_DXFER_TO_DEV;
220 sgio_hdr_init(sd, hdr, io_u, 0);
222 hdr->dxfer_direction = SG_DXFER_NONE;
226 if (hdr->dxfer_direction != SG_DXFER_NONE) {
227 nr_blocks = io_u->xfer_buflen / sd->bs;
228 lba = io_u->offset / sd->bs;
229 hdr->cmdp[2] = (unsigned char) ((lba >> 24) & 0xff);
230 hdr->cmdp[3] = (unsigned char) ((lba >> 16) & 0xff);
231 hdr->cmdp[4] = (unsigned char) ((lba >> 8) & 0xff);
232 hdr->cmdp[5] = (unsigned char) (lba & 0xff);
233 hdr->cmdp[7] = (unsigned char) ((nr_blocks >> 8) & 0xff);
234 hdr->cmdp[8] = (unsigned char) (nr_blocks & 0xff);
240 static int fio_sgio_queue(struct thread_data *td, struct io_u *io_u)
242 struct sg_io_hdr *hdr = &io_u->hdr;
243 int ret, do_sync = 0;
245 fio_ro_check(td, io_u);
247 if (td->o.sync_io || td->o.odirect || ddir_sync(io_u->ddir))
250 ret = fio_sgio_doio(td, io_u, do_sync);
254 else if (hdr->status) {
255 io_u->resid = hdr->resid;
260 td_verror(td, io_u->error, "xfer");
261 return FIO_Q_COMPLETED;
267 static struct io_u *fio_sgio_event(struct thread_data *td, int event)
269 struct sgio_data *sd = td->io_ops->data;
271 return sd->events[event];
274 static int fio_sgio_get_bs(struct thread_data *td, unsigned int *bs)
276 struct sgio_data *sd = td->io_ops->data;
278 struct sg_io_hdr *hdr;
279 unsigned char buf[8];
282 io_u = __get_io_u(td);
283 io_u->file = td->files[0];
287 sgio_hdr_init(sd, hdr, io_u, 0);
288 memset(buf, 0, sizeof(buf));
291 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
293 hdr->dxfer_len = sizeof(buf);
295 ret = fio_sgio_doio(td, io_u, 1);
301 *bs = (buf[4] << 24) | (buf[5] << 16) | (buf[6] << 8) | buf[7];
306 static void fio_sgio_cleanup(struct thread_data *td)
308 struct sgio_data *sd = td->io_ops->data;
320 static int fio_sgio_init(struct thread_data *td)
322 struct sgio_data *sd;
324 sd = malloc(sizeof(*sd));
325 memset(sd, 0, sizeof(*sd));
326 sd->cmds = malloc(td->o.iodepth * sizeof(struct sgio_cmd));
327 memset(sd->cmds, 0, td->o.iodepth * sizeof(struct sgio_cmd));
328 sd->events = malloc(td->o.iodepth * sizeof(struct io_u *));
329 memset(sd->events, 0, td->o.iodepth * sizeof(struct io_u *));
330 sd->pfds = malloc(sizeof(struct pollfd) * td->o.nr_files);
331 memset(sd->pfds, 0, sizeof(struct pollfd) * td->o.nr_files);
332 sd->fd_flags = malloc(sizeof(int) * td->o.nr_files);
333 memset(sd->fd_flags, 0, sizeof(int) * td->o.nr_files);
334 sd->sgbuf = malloc(sizeof(struct sg_io_hdr) * td->o.iodepth);
335 memset(sd->sgbuf, 0, sizeof(struct sg_io_hdr) * td->o.iodepth);
337 td->io_ops->data = sd;
340 * we want to do it, regardless of whether odirect is set or not
342 td->o.override_sync = 1;
346 static int fio_sgio_type_check(struct thread_data *td, struct fio_file *f)
348 struct sgio_data *sd = td->io_ops->data;
351 if (f->filetype == FIO_TYPE_BD) {
352 if (ioctl(f->fd, BLKSSZGET, &bs) < 0) {
353 td_verror(td, errno, "ioctl");
356 } else if (f->filetype == FIO_TYPE_CHAR) {
359 if (ioctl(f->fd, SG_GET_VERSION_NUM, &version) < 0) {
360 td_verror(td, errno, "ioctl");
364 ret = fio_sgio_get_bs(td, &bs);
368 log_err("ioengine sg only works on block devices\n");
374 if (f->filetype == FIO_TYPE_BD) {
375 td->io_ops->getevents = NULL;
376 td->io_ops->event = NULL;
382 static int fio_sgio_open(struct thread_data *td, struct fio_file *f)
384 struct sgio_data *sd = td->io_ops->data;
387 ret = generic_open_file(td, f);
391 if (sd && !sd->type_checked && fio_sgio_type_check(td, f)) {
392 ret = generic_close_file(td, f);
399 static struct ioengine_ops ioengine = {
401 .version = FIO_IOOPS_VERSION,
402 .init = fio_sgio_init,
403 .prep = fio_sgio_prep,
404 .queue = fio_sgio_queue,
405 .getevents = fio_sgio_getevents,
406 .event = fio_sgio_event,
407 .cleanup = fio_sgio_cleanup,
408 .open_file = fio_sgio_open,
409 .close_file = generic_close_file,
410 .get_file_size = generic_get_file_size,
411 .flags = FIO_SYNCIO | FIO_RAWIO,
414 #else /* FIO_HAVE_SGIO */
417 * When we have a proper configure system in place, we simply wont build
418 * and install this io engine. For now install a crippled version that
419 * just complains and fails to load.
421 static int fio_sgio_init(struct thread_data fio_unused *td)
423 fprintf(stderr, "fio: ioengine sg not available\n");
427 static struct ioengine_ops ioengine = {
429 .version = FIO_IOOPS_VERSION,
430 .init = fio_sgio_init,
435 static void fio_init fio_sgio_register(void)
437 register_ioengine(&ioengine);
440 static void fio_exit fio_sgio_unregister(void)
442 unregister_ioengine(&ioengine);