19bad2a6bSPaolo Bonzini /* 29bad2a6bSPaolo Bonzini * Persistent reservation manager that talks to qemu-pr-helper 39bad2a6bSPaolo Bonzini * 49bad2a6bSPaolo Bonzini * Copyright (c) 2017 Red Hat, Inc. 59bad2a6bSPaolo Bonzini * 69bad2a6bSPaolo Bonzini * Author: Paolo Bonzini <pbonzini@redhat.com> 79bad2a6bSPaolo Bonzini * 89bad2a6bSPaolo Bonzini * This code is licensed under the LGPL v2.1 or later. 99bad2a6bSPaolo Bonzini * 109bad2a6bSPaolo Bonzini */ 119bad2a6bSPaolo Bonzini 129bad2a6bSPaolo Bonzini #include "qemu/osdep.h" 139bad2a6bSPaolo Bonzini #include "qapi/error.h" 149bad2a6bSPaolo Bonzini #include "scsi/constants.h" 159bad2a6bSPaolo Bonzini #include "scsi/pr-manager.h" 169bad2a6bSPaolo Bonzini #include "scsi/utils.h" 179bad2a6bSPaolo Bonzini #include "io/channel.h" 189bad2a6bSPaolo Bonzini #include "io/channel-socket.h" 199bad2a6bSPaolo Bonzini #include "pr-helper.h" 20e2c81a45SPaolo Bonzini #include "qapi/qapi-events-block.h" 21*0b8fa32fSMarkus Armbruster #include "qemu/module.h" 229bad2a6bSPaolo Bonzini 239bad2a6bSPaolo Bonzini #include <scsi/sg.h> 249bad2a6bSPaolo Bonzini 259bad2a6bSPaolo Bonzini #define PR_MAX_RECONNECT_ATTEMPTS 5 269bad2a6bSPaolo Bonzini 279bad2a6bSPaolo Bonzini #define TYPE_PR_MANAGER_HELPER "pr-manager-helper" 289bad2a6bSPaolo Bonzini 299bad2a6bSPaolo Bonzini #define PR_MANAGER_HELPER(obj) \ 309bad2a6bSPaolo Bonzini OBJECT_CHECK(PRManagerHelper, (obj), \ 319bad2a6bSPaolo Bonzini TYPE_PR_MANAGER_HELPER) 329bad2a6bSPaolo Bonzini 339bad2a6bSPaolo Bonzini typedef struct PRManagerHelper { 349bad2a6bSPaolo Bonzini /* <private> */ 359bad2a6bSPaolo Bonzini PRManager parent; 369bad2a6bSPaolo Bonzini 379bad2a6bSPaolo Bonzini char *path; 389bad2a6bSPaolo Bonzini 399bad2a6bSPaolo Bonzini QemuMutex lock; 409bad2a6bSPaolo Bonzini QIOChannel *ioc; 419bad2a6bSPaolo Bonzini } PRManagerHelper; 429bad2a6bSPaolo Bonzini 43e2c81a45SPaolo Bonzini static void pr_manager_send_status_changed_event(PRManagerHelper *pr_mgr) 44e2c81a45SPaolo Bonzini { 45e2c81a45SPaolo Bonzini char *id = object_get_canonical_path_component(OBJECT(pr_mgr)); 46e2c81a45SPaolo Bonzini 47e2c81a45SPaolo Bonzini if (id) { 483ab72385SPeter Xu qapi_event_send_pr_manager_status_changed(id, !!pr_mgr->ioc); 49ea3d77c8SPaolo Bonzini g_free(id); 50e2c81a45SPaolo Bonzini } 51e2c81a45SPaolo Bonzini } 52e2c81a45SPaolo Bonzini 539bad2a6bSPaolo Bonzini /* Called with lock held. */ 549bad2a6bSPaolo Bonzini static int pr_manager_helper_read(PRManagerHelper *pr_mgr, 559bad2a6bSPaolo Bonzini void *buf, int sz, Error **errp) 569bad2a6bSPaolo Bonzini { 579bad2a6bSPaolo Bonzini ssize_t r = qio_channel_read_all(pr_mgr->ioc, buf, sz, errp); 589bad2a6bSPaolo Bonzini 599bad2a6bSPaolo Bonzini if (r < 0) { 609bad2a6bSPaolo Bonzini object_unref(OBJECT(pr_mgr->ioc)); 619bad2a6bSPaolo Bonzini pr_mgr->ioc = NULL; 62e2c81a45SPaolo Bonzini pr_manager_send_status_changed_event(pr_mgr); 639bad2a6bSPaolo Bonzini return -EINVAL; 649bad2a6bSPaolo Bonzini } 659bad2a6bSPaolo Bonzini 669bad2a6bSPaolo Bonzini return 0; 679bad2a6bSPaolo Bonzini } 689bad2a6bSPaolo Bonzini 699bad2a6bSPaolo Bonzini /* Called with lock held. */ 709bad2a6bSPaolo Bonzini static int pr_manager_helper_write(PRManagerHelper *pr_mgr, 719bad2a6bSPaolo Bonzini int fd, 729bad2a6bSPaolo Bonzini const void *buf, int sz, Error **errp) 739bad2a6bSPaolo Bonzini { 749bad2a6bSPaolo Bonzini size_t nfds = (fd != -1); 759bad2a6bSPaolo Bonzini while (sz > 0) { 769bad2a6bSPaolo Bonzini struct iovec iov; 779bad2a6bSPaolo Bonzini ssize_t n_written; 789bad2a6bSPaolo Bonzini 799bad2a6bSPaolo Bonzini iov.iov_base = (void *)buf; 809bad2a6bSPaolo Bonzini iov.iov_len = sz; 819bad2a6bSPaolo Bonzini n_written = qio_channel_writev_full(QIO_CHANNEL(pr_mgr->ioc), &iov, 1, 829bad2a6bSPaolo Bonzini nfds ? &fd : NULL, nfds, errp); 839bad2a6bSPaolo Bonzini 849bad2a6bSPaolo Bonzini if (n_written <= 0) { 859bad2a6bSPaolo Bonzini assert(n_written != QIO_CHANNEL_ERR_BLOCK); 869bad2a6bSPaolo Bonzini object_unref(OBJECT(pr_mgr->ioc)); 87aad10040SPaolo Bonzini pr_mgr->ioc = NULL; 88e2c81a45SPaolo Bonzini pr_manager_send_status_changed_event(pr_mgr); 899bad2a6bSPaolo Bonzini return n_written < 0 ? -EINVAL : 0; 909bad2a6bSPaolo Bonzini } 919bad2a6bSPaolo Bonzini 929bad2a6bSPaolo Bonzini nfds = 0; 939bad2a6bSPaolo Bonzini buf += n_written; 949bad2a6bSPaolo Bonzini sz -= n_written; 959bad2a6bSPaolo Bonzini } 969bad2a6bSPaolo Bonzini 979bad2a6bSPaolo Bonzini return 0; 989bad2a6bSPaolo Bonzini } 999bad2a6bSPaolo Bonzini 1009bad2a6bSPaolo Bonzini /* Called with lock held. */ 1019bad2a6bSPaolo Bonzini static int pr_manager_helper_initialize(PRManagerHelper *pr_mgr, 1029bad2a6bSPaolo Bonzini Error **errp) 1039bad2a6bSPaolo Bonzini { 1049bad2a6bSPaolo Bonzini char *path = g_strdup(pr_mgr->path); 1059bad2a6bSPaolo Bonzini SocketAddress saddr = { 1069bad2a6bSPaolo Bonzini .type = SOCKET_ADDRESS_TYPE_UNIX, 1079bad2a6bSPaolo Bonzini .u.q_unix.path = path 1089bad2a6bSPaolo Bonzini }; 1099bad2a6bSPaolo Bonzini QIOChannelSocket *sioc = qio_channel_socket_new(); 1109bad2a6bSPaolo Bonzini Error *local_err = NULL; 1119bad2a6bSPaolo Bonzini 1129bad2a6bSPaolo Bonzini uint32_t flags; 1139bad2a6bSPaolo Bonzini int r; 1149bad2a6bSPaolo Bonzini 1159bad2a6bSPaolo Bonzini assert(!pr_mgr->ioc); 1169bad2a6bSPaolo Bonzini qio_channel_set_name(QIO_CHANNEL(sioc), "pr-manager-helper"); 1179bad2a6bSPaolo Bonzini qio_channel_socket_connect_sync(sioc, 1189bad2a6bSPaolo Bonzini &saddr, 1199bad2a6bSPaolo Bonzini &local_err); 1209bad2a6bSPaolo Bonzini g_free(path); 1219bad2a6bSPaolo Bonzini if (local_err) { 1229bad2a6bSPaolo Bonzini object_unref(OBJECT(sioc)); 1239bad2a6bSPaolo Bonzini error_propagate(errp, local_err); 1249bad2a6bSPaolo Bonzini return -ENOTCONN; 1259bad2a6bSPaolo Bonzini } 1269bad2a6bSPaolo Bonzini 1279bad2a6bSPaolo Bonzini qio_channel_set_delay(QIO_CHANNEL(sioc), false); 1289bad2a6bSPaolo Bonzini pr_mgr->ioc = QIO_CHANNEL(sioc); 1299bad2a6bSPaolo Bonzini 1309bad2a6bSPaolo Bonzini /* A simple feature negotation protocol, even though there is 1319bad2a6bSPaolo Bonzini * no optional feature right now. 1329bad2a6bSPaolo Bonzini */ 1339bad2a6bSPaolo Bonzini r = pr_manager_helper_read(pr_mgr, &flags, sizeof(flags), errp); 1349bad2a6bSPaolo Bonzini if (r < 0) { 1359bad2a6bSPaolo Bonzini goto out_close; 1369bad2a6bSPaolo Bonzini } 1379bad2a6bSPaolo Bonzini 1389bad2a6bSPaolo Bonzini flags = 0; 1399bad2a6bSPaolo Bonzini r = pr_manager_helper_write(pr_mgr, -1, &flags, sizeof(flags), errp); 1409bad2a6bSPaolo Bonzini if (r < 0) { 1419bad2a6bSPaolo Bonzini goto out_close; 1429bad2a6bSPaolo Bonzini } 1439bad2a6bSPaolo Bonzini 144e2c81a45SPaolo Bonzini pr_manager_send_status_changed_event(pr_mgr); 1459bad2a6bSPaolo Bonzini return 0; 1469bad2a6bSPaolo Bonzini 1479bad2a6bSPaolo Bonzini out_close: 1489bad2a6bSPaolo Bonzini object_unref(OBJECT(pr_mgr->ioc)); 1499bad2a6bSPaolo Bonzini pr_mgr->ioc = NULL; 1509bad2a6bSPaolo Bonzini return r; 1519bad2a6bSPaolo Bonzini } 1529bad2a6bSPaolo Bonzini 1539bad2a6bSPaolo Bonzini static int pr_manager_helper_run(PRManager *p, 1549bad2a6bSPaolo Bonzini int fd, struct sg_io_hdr *io_hdr) 1559bad2a6bSPaolo Bonzini { 1569bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(p); 1579bad2a6bSPaolo Bonzini 1589bad2a6bSPaolo Bonzini uint32_t len; 1599bad2a6bSPaolo Bonzini PRHelperResponse resp; 1609bad2a6bSPaolo Bonzini int ret; 1619bad2a6bSPaolo Bonzini int expected_dir; 1629bad2a6bSPaolo Bonzini int attempts; 1639bad2a6bSPaolo Bonzini uint8_t cdb[PR_HELPER_CDB_SIZE] = { 0 }; 1649bad2a6bSPaolo Bonzini 1659bad2a6bSPaolo Bonzini if (!io_hdr->cmd_len || io_hdr->cmd_len > PR_HELPER_CDB_SIZE) { 1669bad2a6bSPaolo Bonzini return -EINVAL; 1679bad2a6bSPaolo Bonzini } 1689bad2a6bSPaolo Bonzini 1699bad2a6bSPaolo Bonzini memcpy(cdb, io_hdr->cmdp, io_hdr->cmd_len); 1709bad2a6bSPaolo Bonzini assert(cdb[0] == PERSISTENT_RESERVE_OUT || cdb[0] == PERSISTENT_RESERVE_IN); 1719bad2a6bSPaolo Bonzini expected_dir = 1729bad2a6bSPaolo Bonzini (cdb[0] == PERSISTENT_RESERVE_OUT ? SG_DXFER_TO_DEV : SG_DXFER_FROM_DEV); 1739bad2a6bSPaolo Bonzini if (io_hdr->dxfer_direction != expected_dir) { 1749bad2a6bSPaolo Bonzini return -EINVAL; 1759bad2a6bSPaolo Bonzini } 1769bad2a6bSPaolo Bonzini 1779bad2a6bSPaolo Bonzini len = scsi_cdb_xfer(cdb); 1789bad2a6bSPaolo Bonzini if (io_hdr->dxfer_len < len || len > PR_HELPER_DATA_SIZE) { 1799bad2a6bSPaolo Bonzini return -EINVAL; 1809bad2a6bSPaolo Bonzini } 1819bad2a6bSPaolo Bonzini 1829bad2a6bSPaolo Bonzini qemu_mutex_lock(&pr_mgr->lock); 1839bad2a6bSPaolo Bonzini 1849bad2a6bSPaolo Bonzini /* Try to reconnect while sending the CDB. */ 1859bad2a6bSPaolo Bonzini for (attempts = 0; attempts < PR_MAX_RECONNECT_ATTEMPTS; attempts++) { 1869bad2a6bSPaolo Bonzini if (!pr_mgr->ioc) { 1879bad2a6bSPaolo Bonzini ret = pr_manager_helper_initialize(pr_mgr, NULL); 1889bad2a6bSPaolo Bonzini if (ret < 0) { 1899bad2a6bSPaolo Bonzini qemu_mutex_unlock(&pr_mgr->lock); 1909bad2a6bSPaolo Bonzini g_usleep(G_USEC_PER_SEC); 1919bad2a6bSPaolo Bonzini qemu_mutex_lock(&pr_mgr->lock); 1929bad2a6bSPaolo Bonzini continue; 1939bad2a6bSPaolo Bonzini } 1949bad2a6bSPaolo Bonzini } 1959bad2a6bSPaolo Bonzini 1969bad2a6bSPaolo Bonzini ret = pr_manager_helper_write(pr_mgr, fd, cdb, ARRAY_SIZE(cdb), NULL); 1979bad2a6bSPaolo Bonzini if (ret >= 0) { 1989bad2a6bSPaolo Bonzini break; 1999bad2a6bSPaolo Bonzini } 2009bad2a6bSPaolo Bonzini } 2019bad2a6bSPaolo Bonzini if (ret < 0) { 2029bad2a6bSPaolo Bonzini goto out; 2039bad2a6bSPaolo Bonzini } 2049bad2a6bSPaolo Bonzini 2059bad2a6bSPaolo Bonzini /* After sending the CDB, any communications failure causes the 2069bad2a6bSPaolo Bonzini * command to fail. The failure is transient, retrying the command 2079bad2a6bSPaolo Bonzini * will invoke pr_manager_helper_initialize again. 2089bad2a6bSPaolo Bonzini */ 2099bad2a6bSPaolo Bonzini if (expected_dir == SG_DXFER_TO_DEV) { 2109bad2a6bSPaolo Bonzini io_hdr->resid = io_hdr->dxfer_len - len; 2119bad2a6bSPaolo Bonzini ret = pr_manager_helper_write(pr_mgr, -1, io_hdr->dxferp, len, NULL); 2129bad2a6bSPaolo Bonzini if (ret < 0) { 2139bad2a6bSPaolo Bonzini goto out; 2149bad2a6bSPaolo Bonzini } 2159bad2a6bSPaolo Bonzini } 2169bad2a6bSPaolo Bonzini ret = pr_manager_helper_read(pr_mgr, &resp, sizeof(resp), NULL); 2179bad2a6bSPaolo Bonzini if (ret < 0) { 2189bad2a6bSPaolo Bonzini goto out; 2199bad2a6bSPaolo Bonzini } 2209bad2a6bSPaolo Bonzini 2219bad2a6bSPaolo Bonzini resp.result = be32_to_cpu(resp.result); 2229bad2a6bSPaolo Bonzini resp.sz = be32_to_cpu(resp.sz); 2239bad2a6bSPaolo Bonzini if (io_hdr->dxfer_direction == SG_DXFER_FROM_DEV) { 2249bad2a6bSPaolo Bonzini assert(resp.sz <= io_hdr->dxfer_len); 2259bad2a6bSPaolo Bonzini ret = pr_manager_helper_read(pr_mgr, io_hdr->dxferp, resp.sz, NULL); 2269bad2a6bSPaolo Bonzini if (ret < 0) { 2279bad2a6bSPaolo Bonzini goto out; 2289bad2a6bSPaolo Bonzini } 2299bad2a6bSPaolo Bonzini io_hdr->resid = io_hdr->dxfer_len - resp.sz; 2309bad2a6bSPaolo Bonzini } else { 2319bad2a6bSPaolo Bonzini assert(resp.sz == 0); 2329bad2a6bSPaolo Bonzini } 2339bad2a6bSPaolo Bonzini 2349bad2a6bSPaolo Bonzini io_hdr->status = resp.result; 2359bad2a6bSPaolo Bonzini if (resp.result == CHECK_CONDITION) { 2369bad2a6bSPaolo Bonzini io_hdr->driver_status = SG_ERR_DRIVER_SENSE; 2379bad2a6bSPaolo Bonzini io_hdr->sb_len_wr = MIN(io_hdr->mx_sb_len, PR_HELPER_SENSE_SIZE); 2389bad2a6bSPaolo Bonzini memcpy(io_hdr->sbp, resp.sense, io_hdr->sb_len_wr); 2399bad2a6bSPaolo Bonzini } 2409bad2a6bSPaolo Bonzini 2419bad2a6bSPaolo Bonzini out: 2429bad2a6bSPaolo Bonzini if (ret < 0) { 2439bad2a6bSPaolo Bonzini int sense_len = scsi_build_sense(io_hdr->sbp, 2449bad2a6bSPaolo Bonzini SENSE_CODE(LUN_COMM_FAILURE)); 2459bad2a6bSPaolo Bonzini io_hdr->driver_status = SG_ERR_DRIVER_SENSE; 2469bad2a6bSPaolo Bonzini io_hdr->sb_len_wr = MIN(io_hdr->mx_sb_len, sense_len); 2479bad2a6bSPaolo Bonzini io_hdr->status = CHECK_CONDITION; 2489bad2a6bSPaolo Bonzini } 2499bad2a6bSPaolo Bonzini qemu_mutex_unlock(&pr_mgr->lock); 2509bad2a6bSPaolo Bonzini return ret; 2519bad2a6bSPaolo Bonzini } 2529bad2a6bSPaolo Bonzini 2535f640894SPaolo Bonzini static bool pr_manager_helper_is_connected(PRManager *p) 2545f640894SPaolo Bonzini { 2555f640894SPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(p); 2565f640894SPaolo Bonzini bool result; 2575f640894SPaolo Bonzini 2585f640894SPaolo Bonzini qemu_mutex_lock(&pr_mgr->lock); 2595f640894SPaolo Bonzini result = (pr_mgr->ioc != NULL); 2605f640894SPaolo Bonzini qemu_mutex_unlock(&pr_mgr->lock); 2615f640894SPaolo Bonzini 2625f640894SPaolo Bonzini return result; 2635f640894SPaolo Bonzini } 2645f640894SPaolo Bonzini 2659bad2a6bSPaolo Bonzini static void pr_manager_helper_complete(UserCreatable *uc, Error **errp) 2669bad2a6bSPaolo Bonzini { 2679bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(uc); 2689bad2a6bSPaolo Bonzini 2699bad2a6bSPaolo Bonzini qemu_mutex_lock(&pr_mgr->lock); 2709bad2a6bSPaolo Bonzini pr_manager_helper_initialize(pr_mgr, errp); 2719bad2a6bSPaolo Bonzini qemu_mutex_unlock(&pr_mgr->lock); 2729bad2a6bSPaolo Bonzini } 2739bad2a6bSPaolo Bonzini 2749bad2a6bSPaolo Bonzini static char *get_path(Object *obj, Error **errp) 2759bad2a6bSPaolo Bonzini { 2769bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj); 2779bad2a6bSPaolo Bonzini 2789bad2a6bSPaolo Bonzini return g_strdup(pr_mgr->path); 2799bad2a6bSPaolo Bonzini } 2809bad2a6bSPaolo Bonzini 2819bad2a6bSPaolo Bonzini static void set_path(Object *obj, const char *str, Error **errp) 2829bad2a6bSPaolo Bonzini { 2839bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj); 2849bad2a6bSPaolo Bonzini 2859bad2a6bSPaolo Bonzini g_free(pr_mgr->path); 2869bad2a6bSPaolo Bonzini pr_mgr->path = g_strdup(str); 2879bad2a6bSPaolo Bonzini } 2889bad2a6bSPaolo Bonzini 2899bad2a6bSPaolo Bonzini static void pr_manager_helper_instance_finalize(Object *obj) 2909bad2a6bSPaolo Bonzini { 2919bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj); 2929bad2a6bSPaolo Bonzini 2939bad2a6bSPaolo Bonzini object_unref(OBJECT(pr_mgr->ioc)); 2949bad2a6bSPaolo Bonzini qemu_mutex_destroy(&pr_mgr->lock); 2959bad2a6bSPaolo Bonzini } 2969bad2a6bSPaolo Bonzini 2979bad2a6bSPaolo Bonzini static void pr_manager_helper_instance_init(Object *obj) 2989bad2a6bSPaolo Bonzini { 2999bad2a6bSPaolo Bonzini PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj); 3009bad2a6bSPaolo Bonzini 3019bad2a6bSPaolo Bonzini qemu_mutex_init(&pr_mgr->lock); 3029bad2a6bSPaolo Bonzini } 3039bad2a6bSPaolo Bonzini 3049bad2a6bSPaolo Bonzini static void pr_manager_helper_class_init(ObjectClass *klass, 3059bad2a6bSPaolo Bonzini void *class_data G_GNUC_UNUSED) 3069bad2a6bSPaolo Bonzini { 3079bad2a6bSPaolo Bonzini PRManagerClass *prmgr_klass = PR_MANAGER_CLASS(klass); 3089bad2a6bSPaolo Bonzini UserCreatableClass *uc_klass = USER_CREATABLE_CLASS(klass); 3099bad2a6bSPaolo Bonzini 3109bad2a6bSPaolo Bonzini object_class_property_add_str(klass, "path", get_path, set_path, 3119bad2a6bSPaolo Bonzini &error_abort); 3129bad2a6bSPaolo Bonzini uc_klass->complete = pr_manager_helper_complete; 3139bad2a6bSPaolo Bonzini prmgr_klass->run = pr_manager_helper_run; 3145f640894SPaolo Bonzini prmgr_klass->is_connected = pr_manager_helper_is_connected; 3159bad2a6bSPaolo Bonzini } 3169bad2a6bSPaolo Bonzini 3179bad2a6bSPaolo Bonzini static const TypeInfo pr_manager_helper_info = { 3189bad2a6bSPaolo Bonzini .parent = TYPE_PR_MANAGER, 3199bad2a6bSPaolo Bonzini .name = TYPE_PR_MANAGER_HELPER, 3209bad2a6bSPaolo Bonzini .instance_size = sizeof(PRManagerHelper), 3219bad2a6bSPaolo Bonzini .instance_init = pr_manager_helper_instance_init, 3229bad2a6bSPaolo Bonzini .instance_finalize = pr_manager_helper_instance_finalize, 3239bad2a6bSPaolo Bonzini .class_init = pr_manager_helper_class_init, 3249bad2a6bSPaolo Bonzini }; 3259bad2a6bSPaolo Bonzini 3269bad2a6bSPaolo Bonzini static void pr_manager_helper_register_types(void) 3279bad2a6bSPaolo Bonzini { 3289bad2a6bSPaolo Bonzini type_register_static(&pr_manager_helper_info); 3299bad2a6bSPaolo Bonzini } 3309bad2a6bSPaolo Bonzini 3319bad2a6bSPaolo Bonzini type_init(pr_manager_helper_register_types); 332