Commit | Line | Data |
---|---|---|
2866c82d | 1 | /* |
da751ca9 JA |
2 | * sg engine |
3 | * | |
4 | * IO engine that uses the Linux SG v3 interface to talk to SCSI devices | |
2866c82d JA |
5 | * |
6 | */ | |
7 | #include <stdio.h> | |
8 | #include <stdlib.h> | |
9 | #include <unistd.h> | |
10 | #include <errno.h> | |
8393ca93 | 11 | #include <poll.h> |
5f350952 JA |
12 | |
13 | #include "../fio.h" | |
52b81b7c | 14 | #include "../optgroup.h" |
2866c82d | 15 | |
34cfcdaf JA |
16 | #ifdef FIO_HAVE_SGIO |
17 | ||
52b81b7c KD |
18 | |
19 | struct sg_options { | |
20 | void *pad; | |
21 | unsigned int readfua; | |
22 | unsigned int writefua; | |
23 | }; | |
24 | ||
25 | static struct fio_option options[] = { | |
26 | { | |
27 | .name = "readfua", | |
28 | .lname = "sg engine read fua flag support", | |
29 | .type = FIO_OPT_BOOL, | |
30 | .off1 = offsetof(struct sg_options, readfua), | |
31 | .help = "Set FUA flag (force unit access) for all Read operations", | |
32 | .def = "0", | |
33 | .category = FIO_OPT_C_ENGINE, | |
34 | .group = FIO_OPT_G_SG, | |
35 | }, | |
36 | { | |
37 | .name = "writefua", | |
38 | .lname = "sg engine write fua flag support", | |
39 | .type = FIO_OPT_BOOL, | |
40 | .off1 = offsetof(struct sg_options, writefua), | |
41 | .help = "Set FUA flag (force unit access) for all Write operations", | |
42 | .def = "0", | |
43 | .category = FIO_OPT_C_ENGINE, | |
44 | .group = FIO_OPT_G_SG, | |
45 | }, | |
46 | { | |
47 | .name = NULL, | |
48 | }, | |
49 | }; | |
50 | ||
5ad7be56 KD |
51 | #define MAX_10B_LBA 0xFFFFFFFFULL |
52 | #define SCSI_TIMEOUT_MS 30000 // 30 second timeout; currently no method to override | |
53 | #define MAX_SB 64 // sense block maximum return size | |
54 | ||
2866c82d | 55 | struct sgio_cmd { |
fde57152 | 56 | unsigned char cdb[16]; // enhanced from 10 to support 16 byte commands |
5ad7be56 | 57 | unsigned char sb[MAX_SB]; // add sense block to commands |
2866c82d JA |
58 | int nr; |
59 | }; | |
60 | ||
61 | struct sgio_data { | |
62 | struct sgio_cmd *cmds; | |
63 | struct io_u **events; | |
dc0deca2 JA |
64 | struct pollfd *pfds; |
65 | int *fd_flags; | |
66 | void *sgbuf; | |
2866c82d | 67 | unsigned int bs; |
b5af8293 | 68 | int type_checked; |
2866c82d JA |
69 | }; |
70 | ||
71 | static void sgio_hdr_init(struct sgio_data *sd, struct sg_io_hdr *hdr, | |
72 | struct io_u *io_u, int fs) | |
73 | { | |
74 | struct sgio_cmd *sc = &sd->cmds[io_u->index]; | |
75 | ||
76 | memset(hdr, 0, sizeof(*hdr)); | |
77 | memset(sc->cdb, 0, sizeof(sc->cdb)); | |
78 | ||
79 | hdr->interface_id = 'S'; | |
80 | hdr->cmdp = sc->cdb; | |
81 | hdr->cmd_len = sizeof(sc->cdb); | |
5ad7be56 KD |
82 | hdr->sbp = sc->sb; |
83 | hdr->mx_sb_len = sizeof(sc->sb); | |
2866c82d JA |
84 | hdr->pack_id = io_u->index; |
85 | hdr->usr_ptr = io_u; | |
86 | ||
87 | if (fs) { | |
cec6b55d JA |
88 | hdr->dxferp = io_u->xfer_buf; |
89 | hdr->dxfer_len = io_u->xfer_buflen; | |
2866c82d JA |
90 | } |
91 | } | |
92 | ||
adee86c5 JA |
93 | static int pollin_events(struct pollfd *pfds, int fds) |
94 | { | |
95 | int i; | |
96 | ||
97 | for (i = 0; i < fds; i++) | |
98 | if (pfds[i].revents & POLLIN) | |
99 | return 1; | |
100 | ||
101 | return 0; | |
102 | } | |
2866c82d | 103 | |
14d0261e JA |
104 | static int sg_fd_read(int fd, void *data, size_t size) |
105 | { | |
106 | int err = 0; | |
107 | ||
108 | while (size) { | |
109 | ssize_t ret; | |
110 | ||
111 | ret = read(fd, data, size); | |
112 | if (ret < 0) { | |
113 | if (errno == EAGAIN || errno == EINTR) | |
114 | continue; | |
115 | err = errno; | |
116 | break; | |
117 | } else if (!ret) | |
118 | break; | |
119 | else { | |
120 | data += ret; | |
121 | size -= ret; | |
122 | } | |
123 | } | |
124 | ||
125 | if (err) | |
126 | return err; | |
127 | if (size) | |
128 | return EAGAIN; | |
129 | ||
130 | return 0; | |
131 | } | |
132 | ||
e7d2e616 | 133 | static int fio_sgio_getevents(struct thread_data *td, unsigned int min, |
1f440ece JA |
134 | unsigned int max, |
135 | const struct timespec fio_unused *t) | |
2866c82d | 136 | { |
565e784d | 137 | struct sgio_data *sd = td->io_ops_data; |
5ad7be56 | 138 | int left = max, eventNum, ret, r = 0; |
dc0deca2 | 139 | void *buf = sd->sgbuf; |
af52b345 | 140 | unsigned int i, events; |
946ff865 | 141 | struct fio_file *f; |
2866c82d JA |
142 | |
143 | /* | |
adee86c5 | 144 | * Fill in the file descriptors |
2866c82d | 145 | */ |
adee86c5 JA |
146 | for_each_file(td, f, i) { |
147 | /* | |
148 | * don't block for min events == 0 | |
149 | */ | |
4a851614 | 150 | if (!min) |
3a35845f JA |
151 | sd->fd_flags[i] = fio_set_fd_nonblocking(f->fd, "sg"); |
152 | else | |
153 | sd->fd_flags[i] = -1; | |
4a851614 | 154 | |
dc0deca2 JA |
155 | sd->pfds[i].fd = f->fd; |
156 | sd->pfds[i].events = POLLIN; | |
2866c82d JA |
157 | } |
158 | ||
159 | while (left) { | |
c97e3cb0 | 160 | char *p; |
adee86c5 | 161 | |
5ad7be56 KD |
162 | dprint(FD_IO, "sgio_getevents: sd %p: left=%d\n", sd, left); |
163 | ||
2866c82d JA |
164 | do { |
165 | if (!min) | |
166 | break; | |
adee86c5 | 167 | |
2dc1bbeb | 168 | ret = poll(sd->pfds, td->o.nr_files, -1); |
adee86c5 | 169 | if (ret < 0) { |
adee86c5 | 170 | if (!r) |
22819ec2 | 171 | r = -errno; |
e1161c32 | 172 | td_verror(td, errno, "poll"); |
adee86c5 JA |
173 | break; |
174 | } else if (!ret) | |
175 | continue; | |
176 | ||
2dc1bbeb | 177 | if (pollin_events(sd->pfds, td->o.nr_files)) |
2866c82d JA |
178 | break; |
179 | } while (1); | |
180 | ||
adee86c5 | 181 | if (r < 0) |
2866c82d | 182 | break; |
adee86c5 JA |
183 | |
184 | re_read: | |
185 | p = buf; | |
186 | events = 0; | |
187 | for_each_file(td, f, i) { | |
5ad7be56 | 188 | for (eventNum = 0; eventNum < left; eventNum++) { |
14d0261e | 189 | ret = sg_fd_read(f->fd, p, sizeof(struct sg_io_hdr)); |
5ad7be56 | 190 | dprint(FD_IO, "sgio_getevents: ret: %d\n", ret); |
14d0261e JA |
191 | if (ret) { |
192 | r = -ret; | |
193 | td_verror(td, r, "sg_read"); | |
5ad7be56 | 194 | break; |
5ad7be56 | 195 | } |
14d0261e JA |
196 | p += sizeof(struct sg_io_hdr); |
197 | events++; | |
198 | dprint(FD_IO, "sgio_getevents: events: %d\n", events); | |
adee86c5 JA |
199 | } |
200 | } | |
201 | ||
14d0261e | 202 | if (r < 0 && !events) |
2866c82d | 203 | break; |
adee86c5 JA |
204 | if (!events) { |
205 | usleep(1000); | |
206 | goto re_read; | |
207 | } | |
2866c82d | 208 | |
2866c82d JA |
209 | left -= events; |
210 | r += events; | |
211 | ||
212 | for (i = 0; i < events; i++) { | |
213 | struct sg_io_hdr *hdr = (struct sg_io_hdr *) buf + i; | |
2866c82d | 214 | sd->events[i] = hdr->usr_ptr; |
5ad7be56 KD |
215 | |
216 | /* record if an io error occurred, ignore resid */ | |
217 | if (hdr->info & SG_INFO_CHECK) { | |
218 | struct io_u *io_u; | |
219 | io_u = (struct io_u *)(hdr->usr_ptr); | |
be660713 | 220 | memcpy(&io_u->hdr, hdr, sizeof(struct sg_io_hdr)); |
5ad7be56 KD |
221 | sd->events[i]->error = EIO; |
222 | } | |
2866c82d JA |
223 | } |
224 | } | |
225 | ||
adee86c5 | 226 | if (!min) { |
affe05a9 | 227 | for_each_file(td, f, i) { |
3a35845f JA |
228 | if (sd->fd_flags[i] == -1) |
229 | continue; | |
230 | ||
affe05a9 JA |
231 | if (fcntl(f->fd, F_SETFL, sd->fd_flags[i]) < 0) |
232 | log_err("fio: sg failed to restore fcntl flags: %s\n", strerror(errno)); | |
233 | } | |
adee86c5 | 234 | } |
2866c82d | 235 | |
2866c82d JA |
236 | return r; |
237 | } | |
238 | ||
7a16dd02 JA |
239 | static int fio_sgio_ioctl_doio(struct thread_data *td, |
240 | struct fio_file *f, struct io_u *io_u) | |
2866c82d | 241 | { |
565e784d | 242 | struct sgio_data *sd = td->io_ops_data; |
2866c82d | 243 | struct sg_io_hdr *hdr = &io_u->hdr; |
36167d82 | 244 | int ret; |
2866c82d JA |
245 | |
246 | sd->events[0] = io_u; | |
247 | ||
36167d82 JA |
248 | ret = ioctl(f->fd, SG_IO, hdr); |
249 | if (ret < 0) | |
a05bd42d | 250 | return ret; |
36167d82 | 251 | |
5ad7be56 KD |
252 | /* record if an io error occurred */ |
253 | if (hdr->info & SG_INFO_CHECK) | |
254 | io_u->error = EIO; | |
255 | ||
36167d82 | 256 | return FIO_Q_COMPLETED; |
2866c82d JA |
257 | } |
258 | ||
2b13e716 | 259 | static int fio_sgio_rw_doio(struct fio_file *f, struct io_u *io_u, int do_sync) |
2866c82d JA |
260 | { |
261 | struct sg_io_hdr *hdr = &io_u->hdr; | |
262 | int ret; | |
263 | ||
53cdc686 | 264 | ret = write(f->fd, hdr, sizeof(*hdr)); |
2866c82d | 265 | if (ret < 0) |
a05bd42d | 266 | return ret; |
2866c82d | 267 | |
2b13e716 | 268 | if (do_sync) { |
53cdc686 | 269 | ret = read(f->fd, hdr, sizeof(*hdr)); |
2866c82d | 270 | if (ret < 0) |
a05bd42d | 271 | return ret; |
5ad7be56 KD |
272 | |
273 | /* record if an io error occurred */ | |
274 | if (hdr->info & SG_INFO_CHECK) | |
275 | io_u->error = EIO; | |
276 | ||
36167d82 | 277 | return FIO_Q_COMPLETED; |
2866c82d JA |
278 | } |
279 | ||
36167d82 | 280 | return FIO_Q_QUEUED; |
2866c82d JA |
281 | } |
282 | ||
2b13e716 | 283 | static int fio_sgio_doio(struct thread_data *td, struct io_u *io_u, int do_sync) |
2866c82d | 284 | { |
53cdc686 | 285 | struct fio_file *f = io_u->file; |
5ad7be56 | 286 | int ret; |
53cdc686 | 287 | |
686fbd31 | 288 | if (f->filetype == FIO_TYPE_BLOCK) { |
5ad7be56 | 289 | ret = fio_sgio_ioctl_doio(td, f, io_u); |
c9aeb797 | 290 | td_verror(td, io_u->error, __func__); |
5ad7be56 KD |
291 | } else { |
292 | ret = fio_sgio_rw_doio(f, io_u, do_sync); | |
293 | if (do_sync) | |
c9aeb797 | 294 | td_verror(td, io_u->error, __func__); |
5ad7be56 | 295 | } |
2866c82d | 296 | |
5ad7be56 | 297 | return ret; |
2866c82d JA |
298 | } |
299 | ||
2866c82d JA |
300 | static int fio_sgio_prep(struct thread_data *td, struct io_u *io_u) |
301 | { | |
302 | struct sg_io_hdr *hdr = &io_u->hdr; | |
52b81b7c | 303 | struct sg_options *o = td->eo; |
565e784d | 304 | struct sgio_data *sd = td->io_ops_data; |
5ad7be56 | 305 | long long nr_blocks, lba; |
2866c82d | 306 | |
cec6b55d | 307 | if (io_u->xfer_buflen & (sd->bs - 1)) { |
2866c82d JA |
308 | log_err("read/write not sector aligned\n"); |
309 | return EINVAL; | |
310 | } | |
311 | ||
5ad7be56 KD |
312 | nr_blocks = io_u->xfer_buflen / sd->bs; |
313 | lba = io_u->offset / sd->bs; | |
314 | ||
2866c82d | 315 | if (io_u->ddir == DDIR_READ) { |
87dc1ab1 JA |
316 | sgio_hdr_init(sd, hdr, io_u, 1); |
317 | ||
2866c82d | 318 | hdr->dxfer_direction = SG_DXFER_FROM_DEV; |
5ad7be56 KD |
319 | if (lba < MAX_10B_LBA) |
320 | hdr->cmdp[0] = 0x28; // read(10) | |
321 | else | |
322 | hdr->cmdp[0] = 0x88; // read(16) | |
52b81b7c KD |
323 | |
324 | if (o->readfua) | |
325 | hdr->cmdp[1] |= 0x08; | |
326 | ||
87dc1ab1 JA |
327 | } else if (io_u->ddir == DDIR_WRITE) { |
328 | sgio_hdr_init(sd, hdr, io_u, 1); | |
329 | ||
2866c82d | 330 | hdr->dxfer_direction = SG_DXFER_TO_DEV; |
5ad7be56 KD |
331 | if (lba < MAX_10B_LBA) |
332 | hdr->cmdp[0] = 0x2a; // write(10) | |
333 | else | |
334 | hdr->cmdp[0] = 0x8a; // write(16) | |
52b81b7c KD |
335 | |
336 | if (o->writefua) | |
337 | hdr->cmdp[1] |= 0x08; | |
338 | ||
87dc1ab1 JA |
339 | } else { |
340 | sgio_hdr_init(sd, hdr, io_u, 0); | |
87dc1ab1 | 341 | hdr->dxfer_direction = SG_DXFER_NONE; |
5ad7be56 KD |
342 | if (lba < MAX_10B_LBA) |
343 | hdr->cmdp[0] = 0x35; // synccache(10) | |
344 | else | |
345 | hdr->cmdp[0] = 0x91; // synccache(16) | |
87dc1ab1 JA |
346 | } |
347 | ||
5ad7be56 KD |
348 | /* |
349 | * for synccache, we leave lba and length to 0 to sync all | |
350 | * blocks on medium. | |
351 | */ | |
87dc1ab1 | 352 | if (hdr->dxfer_direction != SG_DXFER_NONE) { |
5ad7be56 KD |
353 | if (lba < MAX_10B_LBA) { |
354 | hdr->cmdp[2] = (unsigned char) ((lba >> 24) & 0xff); | |
355 | hdr->cmdp[3] = (unsigned char) ((lba >> 16) & 0xff); | |
356 | hdr->cmdp[4] = (unsigned char) ((lba >> 8) & 0xff); | |
357 | hdr->cmdp[5] = (unsigned char) (lba & 0xff); | |
358 | hdr->cmdp[7] = (unsigned char) ((nr_blocks >> 8) & 0xff); | |
359 | hdr->cmdp[8] = (unsigned char) (nr_blocks & 0xff); | |
360 | } else { | |
361 | hdr->cmdp[2] = (unsigned char) ((lba >> 56) & 0xff); | |
362 | hdr->cmdp[3] = (unsigned char) ((lba >> 48) & 0xff); | |
363 | hdr->cmdp[4] = (unsigned char) ((lba >> 40) & 0xff); | |
364 | hdr->cmdp[5] = (unsigned char) ((lba >> 32) & 0xff); | |
365 | hdr->cmdp[6] = (unsigned char) ((lba >> 24) & 0xff); | |
366 | hdr->cmdp[7] = (unsigned char) ((lba >> 16) & 0xff); | |
367 | hdr->cmdp[8] = (unsigned char) ((lba >> 8) & 0xff); | |
368 | hdr->cmdp[9] = (unsigned char) (lba & 0xff); | |
369 | hdr->cmdp[10] = (unsigned char) ((nr_blocks >> 32) & 0xff); | |
370 | hdr->cmdp[11] = (unsigned char) ((nr_blocks >> 16) & 0xff); | |
371 | hdr->cmdp[12] = (unsigned char) ((nr_blocks >> 8) & 0xff); | |
372 | hdr->cmdp[13] = (unsigned char) (nr_blocks & 0xff); | |
373 | } | |
2866c82d JA |
374 | } |
375 | ||
5ad7be56 | 376 | hdr->timeout = SCSI_TIMEOUT_MS; |
2866c82d JA |
377 | return 0; |
378 | } | |
379 | ||
380 | static int fio_sgio_queue(struct thread_data *td, struct io_u *io_u) | |
381 | { | |
382 | struct sg_io_hdr *hdr = &io_u->hdr; | |
f6db4fa5 | 383 | int ret, do_sync = 0; |
2866c82d | 384 | |
7101d9c2 JA |
385 | fio_ro_check(td, io_u); |
386 | ||
f6db4fa5 JA |
387 | if (td->o.sync_io || td->o.odirect || ddir_sync(io_u->ddir)) |
388 | do_sync = 1; | |
389 | ||
390 | ret = fio_sgio_doio(td, io_u, do_sync); | |
2866c82d JA |
391 | |
392 | if (ret < 0) | |
393 | io_u->error = errno; | |
394 | else if (hdr->status) { | |
395 | io_u->resid = hdr->resid; | |
396 | io_u->error = EIO; | |
397 | } | |
398 | ||
95bcd815 | 399 | if (io_u->error) { |
e1161c32 | 400 | td_verror(td, io_u->error, "xfer"); |
36167d82 | 401 | return FIO_Q_COMPLETED; |
95bcd815 JA |
402 | } |
403 | ||
36167d82 | 404 | return ret; |
2866c82d JA |
405 | } |
406 | ||
407 | static struct io_u *fio_sgio_event(struct thread_data *td, int event) | |
408 | { | |
565e784d | 409 | struct sgio_data *sd = td->io_ops_data; |
2866c82d JA |
410 | |
411 | return sd->events[event]; | |
412 | } | |
413 | ||
5ad7be56 KD |
414 | static int fio_sgio_read_capacity(struct thread_data *td, unsigned int *bs, |
415 | unsigned long long *max_lba) | |
2866c82d | 416 | { |
5ad7be56 KD |
417 | /* |
418 | * need to do read capacity operation w/o benefit of sd or | |
419 | * io_u structures, which are not initialized until later. | |
420 | */ | |
421 | struct sg_io_hdr hdr; | |
422 | unsigned char cmd[16]; | |
423 | unsigned char sb[64]; | |
424 | unsigned char buf[32]; // read capacity return | |
2866c82d | 425 | int ret; |
5ad7be56 | 426 | int fd = -1; |
2866c82d | 427 | |
5ad7be56 | 428 | struct fio_file *f = td->files[0]; |
2866c82d | 429 | |
5ad7be56 KD |
430 | /* open file independent of rest of application */ |
431 | fd = open(f->file_name, O_RDONLY); | |
432 | if (fd < 0) | |
433 | return -errno; | |
2866c82d | 434 | |
5ad7be56 KD |
435 | memset(&hdr, 0, sizeof(hdr)); |
436 | memset(cmd, 0, sizeof(cmd)); | |
437 | memset(sb, 0, sizeof(sb)); | |
438 | memset(buf, 0, sizeof(buf)); | |
2866c82d | 439 | |
5ad7be56 KD |
440 | /* First let's try a 10 byte read capacity. */ |
441 | hdr.interface_id = 'S'; | |
442 | hdr.cmdp = cmd; | |
443 | hdr.cmd_len = 10; | |
444 | hdr.sbp = sb; | |
445 | hdr.mx_sb_len = sizeof(sb); | |
446 | hdr.timeout = SCSI_TIMEOUT_MS; | |
447 | hdr.cmdp[0] = 0x25; // Read Capacity(10) | |
448 | hdr.dxfer_direction = SG_DXFER_FROM_DEV; | |
449 | hdr.dxferp = buf; | |
450 | hdr.dxfer_len = sizeof(buf); | |
451 | ||
452 | ret = ioctl(fd, SG_IO, &hdr); | |
453 | if (ret < 0) { | |
454 | close(fd); | |
2866c82d | 455 | return ret; |
5ad7be56 | 456 | } |
2866c82d | 457 | |
7ad2ddff JA |
458 | *bs = ((unsigned long) buf[4] << 24) | ((unsigned long) buf[5] << 16) | |
459 | ((unsigned long) buf[6] << 8) | (unsigned long) buf[7]; | |
460 | *max_lba = ((unsigned long) buf[0] << 24) | ((unsigned long) buf[1] << 16) | | |
461 | ((unsigned long) buf[2] << 8) | (unsigned long) buf[3]; | |
5ad7be56 KD |
462 | |
463 | /* | |
fde57152 TK |
464 | * If max lba masked by MAX_10B_LBA equals MAX_10B_LBA, |
465 | * then need to retry with 16 byte Read Capacity command. | |
5ad7be56 KD |
466 | */ |
467 | if (*max_lba == MAX_10B_LBA) { | |
468 | hdr.cmd_len = 16; | |
28c43a89 TK |
469 | hdr.cmdp[0] = 0x9e; // service action |
470 | hdr.cmdp[1] = 0x10; // Read Capacity(16) | |
5ad7be56 KD |
471 | hdr.cmdp[10] = (unsigned char) ((sizeof(buf) >> 24) & 0xff); |
472 | hdr.cmdp[11] = (unsigned char) ((sizeof(buf) >> 16) & 0xff); | |
473 | hdr.cmdp[12] = (unsigned char) ((sizeof(buf) >> 8) & 0xff); | |
474 | hdr.cmdp[13] = (unsigned char) (sizeof(buf) & 0xff); | |
475 | ||
476 | hdr.dxfer_direction = SG_DXFER_FROM_DEV; | |
477 | hdr.dxferp = buf; | |
478 | hdr.dxfer_len = sizeof(buf); | |
479 | ||
480 | ret = ioctl(fd, SG_IO, &hdr); | |
481 | if (ret < 0) { | |
482 | close(fd); | |
483 | return ret; | |
484 | } | |
485 | ||
486 | /* record if an io error occurred */ | |
487 | if (hdr.info & SG_INFO_CHECK) | |
488 | td_verror(td, EIO, "fio_sgio_read_capacity"); | |
489 | ||
490 | *bs = (buf[8] << 24) | (buf[9] << 16) | (buf[10] << 8) | buf[11]; | |
491 | *max_lba = ((unsigned long long)buf[0] << 56) | | |
492 | ((unsigned long long)buf[1] << 48) | | |
493 | ((unsigned long long)buf[2] << 40) | | |
494 | ((unsigned long long)buf[3] << 32) | | |
495 | ((unsigned long long)buf[4] << 24) | | |
496 | ((unsigned long long)buf[5] << 16) | | |
497 | ((unsigned long long)buf[6] << 8) | | |
498 | (unsigned long long)buf[7]; | |
499 | } | |
500 | ||
501 | close(fd); | |
2866c82d JA |
502 | return 0; |
503 | } | |
504 | ||
505 | static void fio_sgio_cleanup(struct thread_data *td) | |
506 | { | |
565e784d | 507 | struct sgio_data *sd = td->io_ops_data; |
dc0deca2 JA |
508 | |
509 | if (sd) { | |
510 | free(sd->events); | |
511 | free(sd->cmds); | |
512 | free(sd->fd_flags); | |
513 | free(sd->pfds); | |
514 | free(sd->sgbuf); | |
515 | free(sd); | |
2866c82d JA |
516 | } |
517 | } | |
518 | ||
519 | static int fio_sgio_init(struct thread_data *td) | |
520 | { | |
521 | struct sgio_data *sd; | |
2866c82d JA |
522 | |
523 | sd = malloc(sizeof(*sd)); | |
cb781c75 | 524 | memset(sd, 0, sizeof(*sd)); |
2dc1bbeb JA |
525 | sd->cmds = malloc(td->o.iodepth * sizeof(struct sgio_cmd)); |
526 | memset(sd->cmds, 0, td->o.iodepth * sizeof(struct sgio_cmd)); | |
527 | sd->events = malloc(td->o.iodepth * sizeof(struct io_u *)); | |
528 | memset(sd->events, 0, td->o.iodepth * sizeof(struct io_u *)); | |
529 | sd->pfds = malloc(sizeof(struct pollfd) * td->o.nr_files); | |
530 | memset(sd->pfds, 0, sizeof(struct pollfd) * td->o.nr_files); | |
531 | sd->fd_flags = malloc(sizeof(int) * td->o.nr_files); | |
532 | memset(sd->fd_flags, 0, sizeof(int) * td->o.nr_files); | |
533 | sd->sgbuf = malloc(sizeof(struct sg_io_hdr) * td->o.iodepth); | |
534 | memset(sd->sgbuf, 0, sizeof(struct sg_io_hdr) * td->o.iodepth); | |
5ad7be56 | 535 | sd->type_checked = 0; |
565e784d | 536 | td->io_ops_data = sd; |
2866c82d | 537 | |
b5af8293 JA |
538 | /* |
539 | * we want to do it, regardless of whether odirect is set or not | |
540 | */ | |
2dc1bbeb | 541 | td->o.override_sync = 1; |
b5af8293 JA |
542 | return 0; |
543 | } | |
544 | ||
545 | static int fio_sgio_type_check(struct thread_data *td, struct fio_file *f) | |
546 | { | |
565e784d | 547 | struct sgio_data *sd = td->io_ops_data; |
5ad7be56 KD |
548 | unsigned int bs = 0; |
549 | unsigned long long max_lba = 0; | |
550 | ||
686fbd31 | 551 | if (f->filetype == FIO_TYPE_BLOCK) { |
53cdc686 | 552 | if (ioctl(f->fd, BLKSSZGET, &bs) < 0) { |
e1161c32 | 553 | td_verror(td, errno, "ioctl"); |
b5af8293 | 554 | return 1; |
2866c82d | 555 | } |
af52b345 | 556 | } else if (f->filetype == FIO_TYPE_CHAR) { |
b5af8293 | 557 | int version, ret; |
2866c82d | 558 | |
53cdc686 | 559 | if (ioctl(f->fd, SG_GET_VERSION_NUM, &version) < 0) { |
e1161c32 | 560 | td_verror(td, errno, "ioctl"); |
b5af8293 | 561 | return 1; |
2866c82d JA |
562 | } |
563 | ||
5ad7be56 KD |
564 | ret = fio_sgio_read_capacity(td, &bs, &max_lba); |
565 | if (ret) { | |
566 | td_verror(td, td->error, "fio_sgio_read_capacity"); | |
567 | log_err("ioengine sg unable to read capacity successfully\n"); | |
b5af8293 | 568 | return 1; |
5ad7be56 | 569 | } |
2866c82d | 570 | } else { |
16ada754 | 571 | td_verror(td, EINVAL, "wrong file type"); |
30dac136 | 572 | log_err("ioengine sg only works on block or character devices\n"); |
b5af8293 | 573 | return 1; |
2866c82d JA |
574 | } |
575 | ||
576 | sd->bs = bs; | |
5ad7be56 | 577 | // Determine size of commands needed based on max_lba |
166c6b42 TK |
578 | if (max_lba >= MAX_10B_LBA) { |
579 | dprint(FD_IO, "sgio_type_check: using 16 byte read/write " | |
580 | "commands for lba above 0x%016llx/0x%016llx\n", | |
581 | MAX_10B_LBA, max_lba); | |
5ad7be56 KD |
582 | } |
583 | ||
686fbd31 | 584 | if (f->filetype == FIO_TYPE_BLOCK) { |
36167d82 JA |
585 | td->io_ops->getevents = NULL; |
586 | td->io_ops->event = NULL; | |
587 | } | |
5ad7be56 | 588 | sd->type_checked = 1; |
2866c82d | 589 | |
2866c82d | 590 | return 0; |
b5af8293 JA |
591 | } |
592 | ||
593 | static int fio_sgio_open(struct thread_data *td, struct fio_file *f) | |
594 | { | |
565e784d | 595 | struct sgio_data *sd = td->io_ops_data; |
b5af8293 JA |
596 | int ret; |
597 | ||
598 | ret = generic_open_file(td, f); | |
599 | if (ret) | |
600 | return ret; | |
601 | ||
15ba640a | 602 | if (sd && !sd->type_checked && fio_sgio_type_check(td, f)) { |
6977bcd0 | 603 | ret = generic_close_file(td, f); |
b5af8293 JA |
604 | return 1; |
605 | } | |
606 | ||
607 | return 0; | |
2866c82d JA |
608 | } |
609 | ||
5ad7be56 KD |
610 | /* |
611 | * Build an error string with details about the driver, host or scsi | |
612 | * error contained in the sg header Caller will use as necessary. | |
613 | */ | |
614 | static char *fio_sgio_errdetails(struct io_u *io_u) | |
615 | { | |
616 | struct sg_io_hdr *hdr = &io_u->hdr; | |
617 | #define MAXERRDETAIL 1024 | |
618 | #define MAXMSGCHUNK 128 | |
fd04fa03 | 619 | char *msg, msgchunk[MAXMSGCHUNK]; |
5ad7be56 KD |
620 | int i; |
621 | ||
efa72f25 | 622 | msg = calloc(1, MAXERRDETAIL); |
fd04fa03 | 623 | strcpy(msg, ""); |
5ad7be56 KD |
624 | |
625 | /* | |
626 | * can't seem to find sg_err.h, so I'll just echo the define values | |
627 | * so others can search on internet to find clearer clues of meaning. | |
628 | */ | |
629 | if (hdr->info & SG_INFO_CHECK) { | |
5ad7be56 KD |
630 | if (hdr->host_status) { |
631 | snprintf(msgchunk, MAXMSGCHUNK, "SG Host Status: 0x%02x; ", hdr->host_status); | |
632 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
633 | switch (hdr->host_status) { | |
634 | case 0x01: | |
635 | strlcat(msg, "SG_ERR_DID_NO_CONNECT", MAXERRDETAIL); | |
636 | break; | |
637 | case 0x02: | |
638 | strlcat(msg, "SG_ERR_DID_BUS_BUSY", MAXERRDETAIL); | |
639 | break; | |
640 | case 0x03: | |
641 | strlcat(msg, "SG_ERR_DID_TIME_OUT", MAXERRDETAIL); | |
642 | break; | |
643 | case 0x04: | |
644 | strlcat(msg, "SG_ERR_DID_BAD_TARGET", MAXERRDETAIL); | |
645 | break; | |
646 | case 0x05: | |
647 | strlcat(msg, "SG_ERR_DID_ABORT", MAXERRDETAIL); | |
648 | break; | |
649 | case 0x06: | |
650 | strlcat(msg, "SG_ERR_DID_PARITY", MAXERRDETAIL); | |
651 | break; | |
652 | case 0x07: | |
653 | strlcat(msg, "SG_ERR_DID_ERROR (internal error)", MAXERRDETAIL); | |
654 | break; | |
655 | case 0x08: | |
656 | strlcat(msg, "SG_ERR_DID_RESET", MAXERRDETAIL); | |
657 | break; | |
658 | case 0x09: | |
659 | strlcat(msg, "SG_ERR_DID_BAD_INTR (unexpected)", MAXERRDETAIL); | |
660 | break; | |
661 | case 0x0a: | |
662 | strlcat(msg, "SG_ERR_DID_PASSTHROUGH", MAXERRDETAIL); | |
663 | break; | |
664 | case 0x0b: | |
665 | strlcat(msg, "SG_ERR_DID_SOFT_ERROR (driver retry?)", MAXERRDETAIL); | |
666 | break; | |
667 | case 0x0c: | |
668 | strlcat(msg, "SG_ERR_DID_IMM_RETRY", MAXERRDETAIL); | |
669 | break; | |
670 | case 0x0d: | |
671 | strlcat(msg, "SG_ERR_DID_REQUEUE", MAXERRDETAIL); | |
672 | break; | |
2ce6c6e5 TK |
673 | case 0x0e: |
674 | strlcat(msg, "SG_ERR_DID_TRANSPORT_DISRUPTED", MAXERRDETAIL); | |
675 | break; | |
676 | case 0x0f: | |
677 | strlcat(msg, "SG_ERR_DID_TRANSPORT_FAILFAST", MAXERRDETAIL); | |
678 | break; | |
679 | case 0x10: | |
680 | strlcat(msg, "SG_ERR_DID_TARGET_FAILURE", MAXERRDETAIL); | |
681 | break; | |
682 | case 0x11: | |
683 | strlcat(msg, "SG_ERR_DID_NEXUS_FAILURE", MAXERRDETAIL); | |
684 | break; | |
685 | case 0x12: | |
686 | strlcat(msg, "SG_ERR_DID_ALLOC_FAILURE", MAXERRDETAIL); | |
687 | break; | |
688 | case 0x13: | |
689 | strlcat(msg, "SG_ERR_DID_MEDIUM_ERROR", MAXERRDETAIL); | |
690 | break; | |
5ad7be56 KD |
691 | default: |
692 | strlcat(msg, "Unknown", MAXERRDETAIL); | |
693 | break; | |
694 | } | |
695 | strlcat(msg, ". ", MAXERRDETAIL); | |
696 | } | |
697 | if (hdr->driver_status) { | |
698 | snprintf(msgchunk, MAXMSGCHUNK, "SG Driver Status: 0x%02x; ", hdr->driver_status); | |
699 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
700 | switch (hdr->driver_status & 0x0F) { | |
701 | case 0x01: | |
702 | strlcat(msg, "SG_ERR_DRIVER_BUSY", MAXERRDETAIL); | |
703 | break; | |
704 | case 0x02: | |
705 | strlcat(msg, "SG_ERR_DRIVER_SOFT", MAXERRDETAIL); | |
706 | break; | |
707 | case 0x03: | |
708 | strlcat(msg, "SG_ERR_DRIVER_MEDIA", MAXERRDETAIL); | |
709 | break; | |
710 | case 0x04: | |
711 | strlcat(msg, "SG_ERR_DRIVER_ERROR", MAXERRDETAIL); | |
712 | break; | |
713 | case 0x05: | |
714 | strlcat(msg, "SG_ERR_DRIVER_INVALID", MAXERRDETAIL); | |
715 | break; | |
716 | case 0x06: | |
717 | strlcat(msg, "SG_ERR_DRIVER_TIMEOUT", MAXERRDETAIL); | |
718 | break; | |
719 | case 0x07: | |
720 | strlcat(msg, "SG_ERR_DRIVER_HARD", MAXERRDETAIL); | |
721 | break; | |
722 | case 0x08: | |
723 | strlcat(msg, "SG_ERR_DRIVER_SENSE", MAXERRDETAIL); | |
724 | break; | |
725 | default: | |
726 | strlcat(msg, "Unknown", MAXERRDETAIL); | |
727 | break; | |
728 | } | |
729 | strlcat(msg, "; ", MAXERRDETAIL); | |
730 | switch (hdr->driver_status & 0xF0) { | |
731 | case 0x10: | |
732 | strlcat(msg, "SG_ERR_SUGGEST_RETRY", MAXERRDETAIL); | |
733 | break; | |
734 | case 0x20: | |
735 | strlcat(msg, "SG_ERR_SUGGEST_ABORT", MAXERRDETAIL); | |
736 | break; | |
737 | case 0x30: | |
738 | strlcat(msg, "SG_ERR_SUGGEST_REMAP", MAXERRDETAIL); | |
739 | break; | |
740 | case 0x40: | |
741 | strlcat(msg, "SG_ERR_SUGGEST_DIE", MAXERRDETAIL); | |
742 | break; | |
743 | case 0x80: | |
744 | strlcat(msg, "SG_ERR_SUGGEST_SENSE", MAXERRDETAIL); | |
745 | break; | |
746 | } | |
747 | strlcat(msg, ". ", MAXERRDETAIL); | |
748 | } | |
749 | if (hdr->status) { | |
750 | snprintf(msgchunk, MAXMSGCHUNK, "SG SCSI Status: 0x%02x; ", hdr->status); | |
751 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
752 | // SCSI 3 status codes | |
753 | switch (hdr->status) { | |
754 | case 0x02: | |
755 | strlcat(msg, "CHECK_CONDITION", MAXERRDETAIL); | |
756 | break; | |
757 | case 0x04: | |
758 | strlcat(msg, "CONDITION_MET", MAXERRDETAIL); | |
759 | break; | |
760 | case 0x08: | |
761 | strlcat(msg, "BUSY", MAXERRDETAIL); | |
762 | break; | |
763 | case 0x10: | |
764 | strlcat(msg, "INTERMEDIATE", MAXERRDETAIL); | |
765 | break; | |
766 | case 0x14: | |
767 | strlcat(msg, "INTERMEDIATE_CONDITION_MET", MAXERRDETAIL); | |
768 | break; | |
769 | case 0x18: | |
770 | strlcat(msg, "RESERVATION_CONFLICT", MAXERRDETAIL); | |
771 | break; | |
772 | case 0x22: | |
773 | strlcat(msg, "COMMAND_TERMINATED", MAXERRDETAIL); | |
774 | break; | |
775 | case 0x28: | |
776 | strlcat(msg, "TASK_SET_FULL", MAXERRDETAIL); | |
777 | break; | |
778 | case 0x30: | |
779 | strlcat(msg, "ACA_ACTIVE", MAXERRDETAIL); | |
780 | break; | |
781 | case 0x40: | |
782 | strlcat(msg, "TASK_ABORTED", MAXERRDETAIL); | |
783 | break; | |
784 | default: | |
785 | strlcat(msg, "Unknown", MAXERRDETAIL); | |
786 | break; | |
787 | } | |
788 | strlcat(msg, ". ", MAXERRDETAIL); | |
789 | } | |
790 | if (hdr->sb_len_wr) { | |
791 | snprintf(msgchunk, MAXMSGCHUNK, "Sense Data (%d bytes):", hdr->sb_len_wr); | |
792 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
793 | for (i = 0; i < hdr->sb_len_wr; i++) { | |
794 | snprintf(msgchunk, MAXMSGCHUNK, " %02x", hdr->sbp[i]); | |
795 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
796 | } | |
797 | strlcat(msg, ". ", MAXERRDETAIL); | |
798 | } | |
799 | if (hdr->resid != 0) { | |
800 | snprintf(msgchunk, MAXMSGCHUNK, "SG Driver: %d bytes out of %d not transferred. ", hdr->resid, hdr->dxfer_len); | |
801 | strlcat(msg, msgchunk, MAXERRDETAIL); | |
5ad7be56 KD |
802 | } |
803 | } | |
804 | ||
fd04fa03 TK |
805 | if (!(hdr->info & SG_INFO_CHECK) && !strlen(msg)) |
806 | strncpy(msg, "SG Driver did not report a Host, Driver or Device check", | |
807 | MAXERRDETAIL - 1); | |
5ad7be56 | 808 | |
fd04fa03 | 809 | return msg; |
5ad7be56 KD |
810 | } |
811 | ||
812 | /* | |
813 | * get max file size from read capacity. | |
814 | */ | |
815 | static int fio_sgio_get_file_size(struct thread_data *td, struct fio_file *f) | |
816 | { | |
817 | /* | |
818 | * get_file_size is being called even before sgio_init is | |
819 | * called, so none of the sg_io structures are | |
820 | * initialized in the thread_data yet. So we need to do the | |
821 | * ReadCapacity without any of those helpers. One of the effects | |
822 | * is that ReadCapacity may get called 4 times on each open: | |
823 | * readcap(10) followed by readcap(16) if needed - just to get | |
824 | * the file size after the init occurs - it will be called | |
825 | * again when "type_check" is called during structure | |
826 | * initialization I'm not sure how to prevent this little | |
827 | * inefficiency. | |
828 | */ | |
829 | unsigned int bs = 0; | |
830 | unsigned long long max_lba = 0; | |
831 | int ret; | |
832 | ||
833 | if (fio_file_size_known(f)) | |
834 | return 0; | |
835 | ||
686fbd31 | 836 | if (f->filetype != FIO_TYPE_BLOCK && f->filetype != FIO_TYPE_CHAR) { |
30dac136 TK |
837 | td_verror(td, EINVAL, "wrong file type"); |
838 | log_err("ioengine sg only works on block or character devices\n"); | |
839 | return 1; | |
840 | } | |
841 | ||
5ad7be56 KD |
842 | ret = fio_sgio_read_capacity(td, &bs, &max_lba); |
843 | if (ret ) { | |
844 | td_verror(td, td->error, "fio_sgio_read_capacity"); | |
845 | log_err("ioengine sg unable to successfully execute read capacity to get block size and maximum lba\n"); | |
846 | return 1; | |
847 | } | |
848 | ||
849 | f->real_file_size = (max_lba + 1) * bs; | |
850 | fio_file_set_size_known(f); | |
851 | return 0; | |
852 | } | |
853 | ||
854 | ||
5f350952 | 855 | static struct ioengine_ops ioengine = { |
2866c82d JA |
856 | .name = "sg", |
857 | .version = FIO_IOOPS_VERSION, | |
858 | .init = fio_sgio_init, | |
859 | .prep = fio_sgio_prep, | |
860 | .queue = fio_sgio_queue, | |
861 | .getevents = fio_sgio_getevents, | |
5ad7be56 | 862 | .errdetails = fio_sgio_errdetails, |
2866c82d JA |
863 | .event = fio_sgio_event, |
864 | .cleanup = fio_sgio_cleanup, | |
b5af8293 JA |
865 | .open_file = fio_sgio_open, |
866 | .close_file = generic_close_file, | |
fde57152 | 867 | .get_file_size = fio_sgio_get_file_size, |
b2a15192 | 868 | .flags = FIO_SYNCIO | FIO_RAWIO, |
52b81b7c KD |
869 | .options = options, |
870 | .option_struct_size = sizeof(struct sg_options) | |
2866c82d | 871 | }; |
34cfcdaf JA |
872 | |
873 | #else /* FIO_HAVE_SGIO */ | |
874 | ||
875 | /* | |
876 | * When we have a proper configure system in place, we simply wont build | |
877 | * and install this io engine. For now install a crippled version that | |
878 | * just complains and fails to load. | |
879 | */ | |
880 | static int fio_sgio_init(struct thread_data fio_unused *td) | |
881 | { | |
a3edaf76 | 882 | log_err("fio: ioengine sg not available\n"); |
34cfcdaf JA |
883 | return 1; |
884 | } | |
885 | ||
5f350952 | 886 | static struct ioengine_ops ioengine = { |
d0c70934 | 887 | .name = "sg", |
34cfcdaf JA |
888 | .version = FIO_IOOPS_VERSION, |
889 | .init = fio_sgio_init, | |
890 | }; | |
891 | ||
892 | #endif | |
5f350952 JA |
893 | |
894 | static void fio_init fio_sgio_register(void) | |
895 | { | |
896 | register_ioengine(&ioengine); | |
897 | } | |
898 | ||
899 | static void fio_exit fio_sgio_unregister(void) | |
900 | { | |
901 | unregister_ioengine(&ioengine); | |
902 | } |