Issue time fixup for guasi/libaio
[fio.git] / engines / sg.c
... / ...
CommitLineData
1/*
2 * sg engine
3 *
4 * IO engine that uses the Linux SG v3 interface to talk to SCSI devices
5 *
6 */
7#include <stdio.h>
8#include <stdlib.h>
9#include <unistd.h>
10#include <errno.h>
11#include <assert.h>
12#include <sys/poll.h>
13
14#include "../fio.h"
15
16#ifdef FIO_HAVE_SGIO
17
18struct sgio_cmd {
19 unsigned char cdb[10];
20 int nr;
21};
22
23struct sgio_data {
24 struct sgio_cmd *cmds;
25 struct io_u **events;
26 struct pollfd *pfds;
27 int *fd_flags;
28 void *sgbuf;
29 unsigned int bs;
30 int type_checked;
31};
32
33static void sgio_hdr_init(struct sgio_data *sd, struct sg_io_hdr *hdr,
34 struct io_u *io_u, int fs)
35{
36 struct sgio_cmd *sc = &sd->cmds[io_u->index];
37
38 memset(hdr, 0, sizeof(*hdr));
39 memset(sc->cdb, 0, sizeof(sc->cdb));
40
41 hdr->interface_id = 'S';
42 hdr->cmdp = sc->cdb;
43 hdr->cmd_len = sizeof(sc->cdb);
44 hdr->pack_id = io_u->index;
45 hdr->usr_ptr = io_u;
46
47 if (fs) {
48 hdr->dxferp = io_u->xfer_buf;
49 hdr->dxfer_len = io_u->xfer_buflen;
50 }
51}
52
53static int pollin_events(struct pollfd *pfds, int fds)
54{
55 int i;
56
57 for (i = 0; i < fds; i++)
58 if (pfds[i].revents & POLLIN)
59 return 1;
60
61 return 0;
62}
63
64static int fio_sgio_getevents(struct thread_data *td, unsigned int min,
65 unsigned int max, struct timespec fio_unused *t)
66{
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;
71 struct fio_file *f;
72
73 /*
74 * Fill in the file descriptors
75 */
76 for_each_file(td, f, i) {
77 /*
78 * don't block for min events == 0
79 */
80 if (!min) {
81 sd->fd_flags[i] = fcntl(f->fd, F_GETFL);
82 fcntl(f->fd, F_SETFL, sd->fd_flags[i] | O_NONBLOCK);
83 }
84 sd->pfds[i].fd = f->fd;
85 sd->pfds[i].events = POLLIN;
86 }
87
88 while (left) {
89 void *p;
90
91 do {
92 if (!min)
93 break;
94
95 ret = poll(sd->pfds, td->o.nr_files, -1);
96 if (ret < 0) {
97 if (!r)
98 r = -errno;
99 td_verror(td, errno, "poll");
100 break;
101 } else if (!ret)
102 continue;
103
104 if (pollin_events(sd->pfds, td->o.nr_files))
105 break;
106 } while (1);
107
108 if (r < 0)
109 break;
110
111re_read:
112 p = buf;
113 events = 0;
114 for_each_file(td, f, i) {
115 ret = read(f->fd, p, left * sizeof(struct sg_io_hdr));
116 if (ret < 0) {
117 if (errno == EAGAIN)
118 continue;
119 r = -errno;
120 td_verror(td, errno, "read");
121 break;
122 } else if (ret) {
123 p += ret;
124 events += ret / sizeof(struct sg_io_hdr);
125 }
126 }
127
128 if (r < 0)
129 break;
130 if (!events) {
131 usleep(1000);
132 goto re_read;
133 }
134
135 left -= events;
136 r += events;
137
138 for (i = 0; i < events; i++) {
139 struct sg_io_hdr *hdr = (struct sg_io_hdr *) buf + i;
140
141 sd->events[i] = hdr->usr_ptr;
142 }
143 }
144
145 if (!min) {
146 for_each_file(td, f, i)
147 fcntl(f->fd, F_SETFL, sd->fd_flags[i]);
148 }
149
150 return r;
151}
152
153static int fio_sgio_ioctl_doio(struct thread_data *td,
154 struct fio_file *f, struct io_u *io_u)
155{
156 struct sgio_data *sd = td->io_ops->data;
157 struct sg_io_hdr *hdr = &io_u->hdr;
158 int ret;
159
160 sd->events[0] = io_u;
161
162 ret = ioctl(f->fd, SG_IO, hdr);
163 if (ret < 0)
164 return ret;
165
166 return FIO_Q_COMPLETED;
167}
168
169static int fio_sgio_rw_doio(struct fio_file *f, struct io_u *io_u, int sync)
170{
171 struct sg_io_hdr *hdr = &io_u->hdr;
172 int ret;
173
174 ret = write(f->fd, hdr, sizeof(*hdr));
175 if (ret < 0)
176 return ret;
177
178 if (sync) {
179 ret = read(f->fd, hdr, sizeof(*hdr));
180 if (ret < 0)
181 return ret;
182 return FIO_Q_COMPLETED;
183 }
184
185 return FIO_Q_QUEUED;
186}
187
188static int fio_sgio_doio(struct thread_data *td, struct io_u *io_u, int sync)
189{
190 struct fio_file *f = io_u->file;
191
192 if (f->filetype == FIO_TYPE_BD)
193 return fio_sgio_ioctl_doio(td, f, io_u);
194
195 return fio_sgio_rw_doio(f, io_u, sync);
196}
197
198static int fio_sgio_prep(struct thread_data *td, struct io_u *io_u)
199{
200 struct sg_io_hdr *hdr = &io_u->hdr;
201 struct sgio_data *sd = td->io_ops->data;
202 int nr_blocks, lba;
203
204 if (io_u->xfer_buflen & (sd->bs - 1)) {
205 log_err("read/write not sector aligned\n");
206 return EINVAL;
207 }
208
209 if (io_u->ddir == DDIR_READ) {
210 sgio_hdr_init(sd, hdr, io_u, 1);
211
212 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
213 hdr->cmdp[0] = 0x28;
214 } else if (io_u->ddir == DDIR_WRITE) {
215 sgio_hdr_init(sd, hdr, io_u, 1);
216
217 hdr->dxfer_direction = SG_DXFER_TO_DEV;
218 hdr->cmdp[0] = 0x2a;
219 } else {
220 sgio_hdr_init(sd, hdr, io_u, 0);
221
222 hdr->dxfer_direction = SG_DXFER_NONE;
223 hdr->cmdp[0] = 0x35;
224 }
225
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);
235 }
236
237 return 0;
238}
239
240static int fio_sgio_queue(struct thread_data *td, struct io_u *io_u)
241{
242 struct sg_io_hdr *hdr = &io_u->hdr;
243 int ret;
244
245 fio_ro_check(td, io_u);
246
247 ret = fio_sgio_doio(td, io_u, io_u->ddir == DDIR_SYNC);
248
249 if (ret < 0)
250 io_u->error = errno;
251 else if (hdr->status) {
252 io_u->resid = hdr->resid;
253 io_u->error = EIO;
254 }
255
256 if (io_u->error) {
257 td_verror(td, io_u->error, "xfer");
258 return FIO_Q_COMPLETED;
259 }
260
261 return ret;
262}
263
264static struct io_u *fio_sgio_event(struct thread_data *td, int event)
265{
266 struct sgio_data *sd = td->io_ops->data;
267
268 return sd->events[event];
269}
270
271static int fio_sgio_get_bs(struct thread_data *td, unsigned int *bs)
272{
273 struct sgio_data *sd = td->io_ops->data;
274 struct io_u *io_u;
275 struct sg_io_hdr *hdr;
276 unsigned char buf[8];
277 int ret;
278
279 io_u = __get_io_u(td);
280 io_u->file = td->files[0];
281 assert(io_u);
282
283 hdr = &io_u->hdr;
284 sgio_hdr_init(sd, hdr, io_u, 0);
285 memset(buf, 0, sizeof(buf));
286
287 hdr->cmdp[0] = 0x25;
288 hdr->dxfer_direction = SG_DXFER_FROM_DEV;
289 hdr->dxferp = buf;
290 hdr->dxfer_len = sizeof(buf);
291
292 ret = fio_sgio_doio(td, io_u, 1);
293 if (ret) {
294 put_io_u(td, io_u);
295 return ret;
296 }
297
298 *bs = (buf[4] << 24) | (buf[5] << 16) | (buf[6] << 8) | buf[7];
299 put_io_u(td, io_u);
300 return 0;
301}
302
303static void fio_sgio_cleanup(struct thread_data *td)
304{
305 struct sgio_data *sd = td->io_ops->data;
306
307 if (sd) {
308 free(sd->events);
309 free(sd->cmds);
310 free(sd->fd_flags);
311 free(sd->pfds);
312 free(sd->sgbuf);
313 free(sd);
314 }
315}
316
317static int fio_sgio_init(struct thread_data *td)
318{
319 struct sgio_data *sd;
320
321 sd = malloc(sizeof(*sd));
322 memset(sd, 0, sizeof(*sd));
323 sd->cmds = malloc(td->o.iodepth * sizeof(struct sgio_cmd));
324 memset(sd->cmds, 0, td->o.iodepth * sizeof(struct sgio_cmd));
325 sd->events = malloc(td->o.iodepth * sizeof(struct io_u *));
326 memset(sd->events, 0, td->o.iodepth * sizeof(struct io_u *));
327 sd->pfds = malloc(sizeof(struct pollfd) * td->o.nr_files);
328 memset(sd->pfds, 0, sizeof(struct pollfd) * td->o.nr_files);
329 sd->fd_flags = malloc(sizeof(int) * td->o.nr_files);
330 memset(sd->fd_flags, 0, sizeof(int) * td->o.nr_files);
331 sd->sgbuf = malloc(sizeof(struct sg_io_hdr) * td->o.iodepth);
332 memset(sd->sgbuf, 0, sizeof(struct sg_io_hdr) * td->o.iodepth);
333
334 td->io_ops->data = sd;
335
336 /*
337 * we want to do it, regardless of whether odirect is set or not
338 */
339 td->o.override_sync = 1;
340 return 0;
341}
342
343static int fio_sgio_type_check(struct thread_data *td, struct fio_file *f)
344{
345 struct sgio_data *sd = td->io_ops->data;
346 unsigned int bs;
347
348 if (f->filetype == FIO_TYPE_BD) {
349 if (ioctl(f->fd, BLKSSZGET, &bs) < 0) {
350 td_verror(td, errno, "ioctl");
351 return 1;
352 }
353 } else if (f->filetype == FIO_TYPE_CHAR) {
354 int version, ret;
355
356 if (ioctl(f->fd, SG_GET_VERSION_NUM, &version) < 0) {
357 td_verror(td, errno, "ioctl");
358 return 1;
359 }
360
361 ret = fio_sgio_get_bs(td, &bs);
362 if (ret)
363 return 1;
364 } else {
365 log_err("ioengine sg only works on block devices\n");
366 return 1;
367 }
368
369 sd->bs = bs;
370
371 if (f->filetype == FIO_TYPE_BD) {
372 td->io_ops->getevents = NULL;
373 td->io_ops->event = NULL;
374 }
375
376 return 0;
377}
378
379static int fio_sgio_open(struct thread_data *td, struct fio_file *f)
380{
381 struct sgio_data *sd = td->io_ops->data;
382 int ret;
383
384 ret = generic_open_file(td, f);
385 if (ret)
386 return ret;
387
388 if (sd && !sd->type_checked && fio_sgio_type_check(td, f)) {
389 ret = generic_close_file(td, f);
390 return 1;
391 }
392
393 return 0;
394}
395
396static struct ioengine_ops ioengine = {
397 .name = "sg",
398 .version = FIO_IOOPS_VERSION,
399 .init = fio_sgio_init,
400 .prep = fio_sgio_prep,
401 .queue = fio_sgio_queue,
402 .getevents = fio_sgio_getevents,
403 .event = fio_sgio_event,
404 .cleanup = fio_sgio_cleanup,
405 .open_file = fio_sgio_open,
406 .close_file = generic_close_file,
407 .flags = FIO_SYNCIO | FIO_RAWIO,
408};
409
410#else /* FIO_HAVE_SGIO */
411
412/*
413 * When we have a proper configure system in place, we simply wont build
414 * and install this io engine. For now install a crippled version that
415 * just complains and fails to load.
416 */
417static int fio_sgio_init(struct thread_data fio_unused *td)
418{
419 fprintf(stderr, "fio: ioengine sg not available\n");
420 return 1;
421}
422
423static struct ioengine_ops ioengine = {
424 .name = "sg",
425 .version = FIO_IOOPS_VERSION,
426 .init = fio_sgio_init,
427};
428
429#endif
430
431static void fio_init fio_sgio_register(void)
432{
433 register_ioengine(&ioengine);
434}
435
436static void fio_exit fio_sgio_unregister(void)
437{
438 unregister_ioengine(&ioengine);
439}