2 * Copyright (C) 2019 Western Digital Corporation or its affiliates.
4 * This file is released under the GPL.
7 * IO engine using libzbc library to talk to SMR disks.
12 #include <libzbc/zbc.h>
16 #include "zbd_types.h"
19 struct zbc_device *zdev;
20 enum zbc_dev_model model;
24 static int libzbc_get_dev_info(struct libzbc_data *ld, struct fio_file *f)
26 struct zbc_device_info *zinfo;
28 zinfo = calloc(1, sizeof(*zinfo));
32 zbc_get_device_info(ld->zdev, zinfo);
33 ld->model = zinfo->zbd_model;
34 ld->nr_sectors = zinfo->zbd_sectors;
36 dprint(FD_ZBD, "%s: vendor_id:%s, type: %s, model: %s\n",
37 f->file_name, zinfo->zbd_vendor_id,
38 zbc_device_type_str(zinfo->zbd_type),
39 zbc_device_model_str(zinfo->zbd_model));
46 static int libzbc_open_dev(struct thread_data *td, struct fio_file *f,
47 struct libzbc_data **p_ld)
49 struct libzbc_data *ld = td->io_ops_data;
50 int ret, flags = OS_O_DIRECT;
58 if (f->filetype != FIO_TYPE_BLOCK && f->filetype != FIO_TYPE_CHAR) {
59 td_verror(td, EINVAL, "wrong file type");
60 log_err("ioengine libzbc only works on block or character devices\n");
67 } else if (td_read(td)) {
68 if (f->filetype == FIO_TYPE_CHAR && !read_only)
72 } else if (td_trim(td)) {
73 td_verror(td, EINVAL, "libzbc does not support trim");
74 log_err("%s: libzbc does not support trim\n", f->file_name);
79 td_verror(td, EINVAL, "libzbc does not support O_ATOMIC");
80 log_err("%s: libzbc does not support O_ATOMIC\n", f->file_name);
84 ld = calloc(1, sizeof(*ld));
88 ret = zbc_open(f->file_name,
89 flags | ZBC_O_DRV_SCSI | ZBC_O_DRV_ATA, &ld->zdev);
91 log_err("%s: zbc_open() failed, err=%d\n",
96 ret = libzbc_get_dev_info(ld, f);
100 td->io_ops_data = ld;
114 static int libzbc_close_dev(struct thread_data *td)
116 struct libzbc_data *ld = td->io_ops_data;
119 td->io_ops_data = NULL;
122 ret = zbc_close(ld->zdev);
128 static int libzbc_open_file(struct thread_data *td, struct fio_file *f)
130 return libzbc_open_dev(td, f, NULL);
133 static int libzbc_close_file(struct thread_data *td, struct fio_file *f)
137 ret = libzbc_close_dev(td);
139 log_err("%s: close device failed err %d\n",
145 static void libzbc_cleanup(struct thread_data *td)
147 libzbc_close_dev(td);
150 static int libzbc_invalidate(struct thread_data *td, struct fio_file *f)
152 /* Passthrough IO do not cache data. Nothing to do */
156 static int libzbc_get_file_size(struct thread_data *td, struct fio_file *f)
158 struct libzbc_data *ld;
161 if (fio_file_size_known(f))
164 ret = libzbc_open_dev(td, f, &ld);
168 f->real_file_size = ld->nr_sectors << 9;
169 fio_file_set_size_known(f);
174 static int libzbc_get_zoned_model(struct thread_data *td, struct fio_file *f,
175 enum zbd_zoned_model *model)
177 struct libzbc_data *ld;
180 if (f->filetype != FIO_TYPE_BLOCK && f->filetype != FIO_TYPE_CHAR) {
185 ret = libzbc_open_dev(td, f, &ld);
190 case ZBC_DM_HOST_AWARE:
191 *model = ZBD_HOST_AWARE;
193 case ZBC_DM_HOST_MANAGED:
194 *model = ZBD_HOST_MANAGED;
204 static int libzbc_report_zones(struct thread_data *td, struct fio_file *f,
205 uint64_t offset, struct zbd_zone *zbdz,
206 unsigned int nr_zones)
208 struct libzbc_data *ld;
209 uint64_t sector = offset >> 9;
210 struct zbc_zone *zones;
214 ret = libzbc_open_dev(td, f, &ld);
218 if (sector >= ld->nr_sectors)
221 zones = calloc(nr_zones, sizeof(struct zbc_zone));
227 ret = zbc_report_zones(ld->zdev, sector, ZBC_RO_ALL, zones, &nr_zones);
229 log_err("%s: zbc_report_zones failed, err=%d\n",
234 for (i = 0; i < nr_zones; i++, zbdz++) {
235 zbdz->start = zones[i].zbz_start << 9;
236 zbdz->len = zones[i].zbz_length << 9;
237 zbdz->wp = zones[i].zbz_write_pointer << 9;
239 * ZBC/ZAC do not define zone capacity, so use the zone size as
242 zbdz->capacity = zbdz->len;
244 switch (zones[i].zbz_type) {
245 case ZBC_ZT_CONVENTIONAL:
246 zbdz->type = ZBD_ZONE_TYPE_CNV;
248 case ZBC_ZT_SEQUENTIAL_REQ:
249 zbdz->type = ZBD_ZONE_TYPE_SWR;
251 case ZBC_ZT_SEQUENTIAL_PREF:
252 zbdz->type = ZBD_ZONE_TYPE_SWP;
255 td_verror(td, errno, "invalid zone type");
256 log_err("%s: invalid type for zone at sector %llu.\n",
257 f->file_name, (unsigned long long)zbdz->start);
262 switch (zones[i].zbz_condition) {
264 zbdz->cond = ZBD_ZONE_COND_NOT_WP;
267 zbdz->cond = ZBD_ZONE_COND_EMPTY;
269 case ZBC_ZC_IMP_OPEN:
270 zbdz->cond = ZBD_ZONE_COND_IMP_OPEN;
272 case ZBC_ZC_EXP_OPEN:
273 zbdz->cond = ZBD_ZONE_COND_EXP_OPEN;
276 zbdz->cond = ZBD_ZONE_COND_CLOSED;
279 zbdz->cond = ZBD_ZONE_COND_FULL;
284 /* Treat all these conditions as offline (don't use!) */
285 zbdz->cond = ZBD_ZONE_COND_OFFLINE;
296 static int libzbc_reset_wp(struct thread_data *td, struct fio_file *f,
297 uint64_t offset, uint64_t length)
299 struct libzbc_data *ld = td->io_ops_data;
300 uint64_t sector = offset >> 9;
301 uint64_t end_sector = (offset + length) >> 9;
302 unsigned int nr_zones;
303 struct zbc_errno err;
309 nr_zones = (length + td->o.zone_size - 1) / td->o.zone_size;
310 if (!sector && end_sector >= ld->nr_sectors) {
311 /* Reset all zones */
312 ret = zbc_reset_zone(ld->zdev, 0, ZBC_OP_ALL_ZONES);
319 for (i = 0; i < nr_zones; i++, sector += td->o.zone_size >> 9) {
320 ret = zbc_reset_zone(ld->zdev, sector, 0);
328 zbc_errno(ld->zdev, &err);
329 td_verror(td, errno, "zbc_reset_zone failed");
331 log_err("%s: reset wp failed %s:%s\n",
333 zbc_sk_str(err.sk), zbc_asc_ascq_str(err.asc_ascq));
337 ssize_t libzbc_rw(struct thread_data *td, struct io_u *io_u)
339 struct libzbc_data *ld = td->io_ops_data;
340 struct fio_file *f = io_u->file;
341 uint64_t sector = io_u->offset >> 9;
342 size_t count = io_u->xfer_buflen >> 9;
343 struct zbc_errno err;
346 if (io_u->ddir == DDIR_WRITE)
347 ret = zbc_pwrite(ld->zdev, io_u->xfer_buf, count, sector);
349 ret = zbc_pread(ld->zdev, io_u->xfer_buf, count, sector);
354 log_err("Short %s, len=%zu, ret=%zd\n",
355 io_u->ddir == DDIR_READ ? "read" : "write",
356 count << 9, ret << 9);
361 zbc_errno(ld->zdev, &err);
362 td_verror(td, errno, "libzbc i/o failed");
364 log_err("%s: op %u offset %llu+%llu failed (%s:%s), err %zd\n",
365 f->file_name, io_u->ddir,
366 io_u->offset, io_u->xfer_buflen,
368 zbc_asc_ascq_str(err.asc_ascq), ret);
370 log_err("%s: op %u offset %llu+%llu failed, err %zd\n",
371 f->file_name, io_u->ddir,
372 io_u->offset, io_u->xfer_buflen, ret);
378 static enum fio_q_status libzbc_queue(struct thread_data *td, struct io_u *io_u)
380 struct libzbc_data *ld = td->io_ops_data;
381 struct fio_file *f = io_u->file;
384 fio_ro_check(td, io_u);
386 dprint(FD_ZBD, "%p:%s: libzbc queue %llu\n",
387 td, f->file_name, io_u->offset);
389 if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
390 ret = libzbc_rw(td, io_u);
391 } else if (ddir_sync(io_u->ddir)) {
392 ret = zbc_flush(ld->zdev);
394 log_err("zbc_flush error %zd\n", ret);
395 } else if (io_u->ddir != DDIR_TRIM) {
396 log_err("Unsupported operation %u\n", io_u->ddir);
402 return FIO_Q_COMPLETED;
405 FIO_STATIC struct ioengine_ops ioengine = {
407 .version = FIO_IOOPS_VERSION,
408 .open_file = libzbc_open_file,
409 .close_file = libzbc_close_file,
410 .cleanup = libzbc_cleanup,
411 .invalidate = libzbc_invalidate,
412 .get_file_size = libzbc_get_file_size,
413 .get_zoned_model = libzbc_get_zoned_model,
414 .report_zones = libzbc_report_zones,
415 .reset_wp = libzbc_reset_wp,
416 .queue = libzbc_queue,
417 .flags = FIO_SYNCIO | FIO_NOEXTEND | FIO_RAWIO,
420 static void fio_init fio_libzbc_register(void)
422 register_ioengine(&ioengine);
425 static void fio_exit fio_libzbc_unregister(void)
427 unregister_ioengine(&ioengine);