aboutsummaryrefslogtreecommitdiffstats
path: root/scsi
diff options
context:
space:
mode:
authorTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2023-10-10 11:40:56 +0000
committerTimos Ampelikiotis <t.ampelikiotis@virtualopensystems.com>2023-10-10 11:40:56 +0000
commite02cda008591317b1625707ff8e115a4841aa889 (patch)
treeaee302e3cf8b59ec2d32ec481be3d1afddfc8968 /scsi
parentcc668e6b7e0ffd8c9d130513d12053cf5eda1d3b (diff)
Introduce Virtio-loopback epsilon release:
Epsilon release introduces a new compatibility layer which make virtio-loopback design to work with QEMU and rust-vmm vhost-user backend without require any changes. Signed-off-by: Timos Ampelikiotis <t.ampelikiotis@virtualopensystems.com> Change-Id: I52e57563e08a7d0bdc002f8e928ee61ba0c53dd9
Diffstat (limited to 'scsi')
-rw-r--r--scsi/meson.build4
-rw-r--r--scsi/pr-helper.h40
-rw-r--r--scsi/pr-manager-helper.c328
-rw-r--r--scsi/pr-manager-stub.c30
-rw-r--r--scsi/pr-manager.c145
-rw-r--r--scsi/qemu-pr-helper.c1082
-rw-r--r--scsi/trace-events5
-rw-r--r--scsi/trace.h1
-rw-r--r--scsi/utils.c660
9 files changed, 2295 insertions, 0 deletions
diff --git a/scsi/meson.build b/scsi/meson.build
new file mode 100644
index 000000000..53f3a1f71
--- /dev/null
+++ b/scsi/meson.build
@@ -0,0 +1,4 @@
+block_ss.add(files('utils.c'))
+block_ss.add(when: 'CONFIG_LINUX',
+ if_true: files('pr-manager.c', 'pr-manager-helper.c'),
+ if_false: files('pr-manager-stub.c'))
diff --git a/scsi/pr-helper.h b/scsi/pr-helper.h
new file mode 100644
index 000000000..e26e104ec
--- /dev/null
+++ b/scsi/pr-helper.h
@@ -0,0 +1,40 @@
+/* Definitions for QEMU's persistent reservation helper daemon
+ *
+ * Copyright (C) 2017 Red Hat, Inc.
+ *
+ * Author:
+ * Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+#ifndef QEMU_PR_HELPER_H
+#define QEMU_PR_HELPER_H
+
+#define PR_HELPER_CDB_SIZE 16
+#define PR_HELPER_SENSE_SIZE 96
+#define PR_HELPER_DATA_SIZE 8192
+
+typedef struct PRHelperResponse {
+ int32_t result;
+ int32_t sz;
+ uint8_t sense[PR_HELPER_SENSE_SIZE];
+} PRHelperResponse;
+
+#endif
diff --git a/scsi/pr-manager-helper.c b/scsi/pr-manager-helper.c
new file mode 100644
index 000000000..451c7631b
--- /dev/null
+++ b/scsi/pr-manager-helper.c
@@ -0,0 +1,328 @@
+/*
+ * Persistent reservation manager that talks to qemu-pr-helper
+ *
+ * Copyright (c) 2017 Red Hat, Inc.
+ *
+ * Author: Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * This code is licensed under the LGPL v2.1 or later.
+ *
+ */
+
+#include "qemu/osdep.h"
+#include "qapi/error.h"
+#include "scsi/constants.h"
+#include "scsi/pr-manager.h"
+#include "scsi/utils.h"
+#include "io/channel.h"
+#include "io/channel-socket.h"
+#include "pr-helper.h"
+#include "qapi/qapi-events-block.h"
+#include "qemu/module.h"
+
+#include <scsi/sg.h>
+#include "qom/object.h"
+
+#define PR_MAX_RECONNECT_ATTEMPTS 5
+
+#define TYPE_PR_MANAGER_HELPER "pr-manager-helper"
+
+OBJECT_DECLARE_SIMPLE_TYPE(PRManagerHelper, PR_MANAGER_HELPER)
+
+struct PRManagerHelper {
+ /* <private> */
+ PRManager parent;
+
+ char *path;
+
+ QemuMutex lock;
+ QIOChannel *ioc;
+};
+
+static void pr_manager_send_status_changed_event(PRManagerHelper *pr_mgr)
+{
+ const char *id = object_get_canonical_path_component(OBJECT(pr_mgr));
+
+ if (id) {
+ qapi_event_send_pr_manager_status_changed(id, !!pr_mgr->ioc);
+ }
+}
+
+/* Called with lock held. */
+static int pr_manager_helper_read(PRManagerHelper *pr_mgr,
+ void *buf, int sz, Error **errp)
+{
+ ssize_t r = qio_channel_read_all(pr_mgr->ioc, buf, sz, errp);
+
+ if (r < 0) {
+ object_unref(OBJECT(pr_mgr->ioc));
+ pr_mgr->ioc = NULL;
+ pr_manager_send_status_changed_event(pr_mgr);
+ return -EINVAL;
+ }
+
+ return 0;
+}
+
+/* Called with lock held. */
+static int pr_manager_helper_write(PRManagerHelper *pr_mgr,
+ int fd,
+ const void *buf, int sz, Error **errp)
+{
+ size_t nfds = (fd != -1);
+ while (sz > 0) {
+ struct iovec iov;
+ ssize_t n_written;
+
+ iov.iov_base = (void *)buf;
+ iov.iov_len = sz;
+ n_written = qio_channel_writev_full(QIO_CHANNEL(pr_mgr->ioc), &iov, 1,
+ nfds ? &fd : NULL, nfds, errp);
+
+ if (n_written <= 0) {
+ assert(n_written != QIO_CHANNEL_ERR_BLOCK);
+ object_unref(OBJECT(pr_mgr->ioc));
+ pr_mgr->ioc = NULL;
+ pr_manager_send_status_changed_event(pr_mgr);
+ return n_written < 0 ? -EINVAL : 0;
+ }
+
+ nfds = 0;
+ buf += n_written;
+ sz -= n_written;
+ }
+
+ return 0;
+}
+
+/* Called with lock held. */
+static int pr_manager_helper_initialize(PRManagerHelper *pr_mgr,
+ Error **errp)
+{
+ char *path = g_strdup(pr_mgr->path);
+ SocketAddress saddr = {
+ .type = SOCKET_ADDRESS_TYPE_UNIX,
+ .u.q_unix.path = path
+ };
+ QIOChannelSocket *sioc = qio_channel_socket_new();
+ Error *local_err = NULL;
+
+ uint32_t flags;
+ int r;
+
+ assert(!pr_mgr->ioc);
+ qio_channel_set_name(QIO_CHANNEL(sioc), "pr-manager-helper");
+ qio_channel_socket_connect_sync(sioc,
+ &saddr,
+ &local_err);
+ g_free(path);
+ if (local_err) {
+ object_unref(OBJECT(sioc));
+ error_propagate(errp, local_err);
+ return -ENOTCONN;
+ }
+
+ qio_channel_set_delay(QIO_CHANNEL(sioc), false);
+ pr_mgr->ioc = QIO_CHANNEL(sioc);
+
+ /* A simple feature negotiation protocol, even though there is
+ * no optional feature right now.
+ */
+ r = pr_manager_helper_read(pr_mgr, &flags, sizeof(flags), errp);
+ if (r < 0) {
+ goto out_close;
+ }
+
+ flags = 0;
+ r = pr_manager_helper_write(pr_mgr, -1, &flags, sizeof(flags), errp);
+ if (r < 0) {
+ goto out_close;
+ }
+
+ pr_manager_send_status_changed_event(pr_mgr);
+ return 0;
+
+out_close:
+ object_unref(OBJECT(pr_mgr->ioc));
+ pr_mgr->ioc = NULL;
+ return r;
+}
+
+static int pr_manager_helper_run(PRManager *p,
+ int fd, struct sg_io_hdr *io_hdr)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(p);
+
+ uint32_t len;
+ PRHelperResponse resp;
+ int ret;
+ int expected_dir;
+ int attempts;
+ uint8_t cdb[PR_HELPER_CDB_SIZE] = { 0 };
+
+ if (!io_hdr->cmd_len || io_hdr->cmd_len > PR_HELPER_CDB_SIZE) {
+ return -EINVAL;
+ }
+
+ memcpy(cdb, io_hdr->cmdp, io_hdr->cmd_len);
+ assert(cdb[0] == PERSISTENT_RESERVE_OUT || cdb[0] == PERSISTENT_RESERVE_IN);
+ expected_dir =
+ (cdb[0] == PERSISTENT_RESERVE_OUT ? SG_DXFER_TO_DEV : SG_DXFER_FROM_DEV);
+ if (io_hdr->dxfer_direction != expected_dir) {
+ return -EINVAL;
+ }
+
+ len = scsi_cdb_xfer(cdb);
+ if (io_hdr->dxfer_len < len || len > PR_HELPER_DATA_SIZE) {
+ return -EINVAL;
+ }
+
+ qemu_mutex_lock(&pr_mgr->lock);
+
+ /* Try to reconnect while sending the CDB. */
+ for (attempts = 0; attempts < PR_MAX_RECONNECT_ATTEMPTS; attempts++) {
+ if (!pr_mgr->ioc) {
+ ret = pr_manager_helper_initialize(pr_mgr, NULL);
+ if (ret < 0) {
+ qemu_mutex_unlock(&pr_mgr->lock);
+ g_usleep(G_USEC_PER_SEC);
+ qemu_mutex_lock(&pr_mgr->lock);
+ continue;
+ }
+ }
+
+ ret = pr_manager_helper_write(pr_mgr, fd, cdb, ARRAY_SIZE(cdb), NULL);
+ if (ret >= 0) {
+ break;
+ }
+ }
+ if (ret < 0) {
+ goto out;
+ }
+
+ /* After sending the CDB, any communications failure causes the
+ * command to fail. The failure is transient, retrying the command
+ * will invoke pr_manager_helper_initialize again.
+ */
+ if (expected_dir == SG_DXFER_TO_DEV) {
+ io_hdr->resid = io_hdr->dxfer_len - len;
+ ret = pr_manager_helper_write(pr_mgr, -1, io_hdr->dxferp, len, NULL);
+ if (ret < 0) {
+ goto out;
+ }
+ }
+ ret = pr_manager_helper_read(pr_mgr, &resp, sizeof(resp), NULL);
+ if (ret < 0) {
+ goto out;
+ }
+
+ resp.result = be32_to_cpu(resp.result);
+ resp.sz = be32_to_cpu(resp.sz);
+ if (io_hdr->dxfer_direction == SG_DXFER_FROM_DEV) {
+ assert(resp.sz <= io_hdr->dxfer_len);
+ ret = pr_manager_helper_read(pr_mgr, io_hdr->dxferp, resp.sz, NULL);
+ if (ret < 0) {
+ goto out;
+ }
+ io_hdr->resid = io_hdr->dxfer_len - resp.sz;
+ } else {
+ assert(resp.sz == 0);
+ }
+
+ io_hdr->status = resp.result;
+ if (resp.result == CHECK_CONDITION) {
+ io_hdr->driver_status = SG_ERR_DRIVER_SENSE;
+ io_hdr->sb_len_wr = MIN(io_hdr->mx_sb_len, PR_HELPER_SENSE_SIZE);
+ memcpy(io_hdr->sbp, resp.sense, io_hdr->sb_len_wr);
+ }
+
+out:
+ if (ret < 0) {
+ int sense_len = scsi_build_sense(io_hdr->sbp,
+ SENSE_CODE(LUN_COMM_FAILURE));
+ io_hdr->driver_status = SG_ERR_DRIVER_SENSE;
+ io_hdr->sb_len_wr = MIN(io_hdr->mx_sb_len, sense_len);
+ io_hdr->status = CHECK_CONDITION;
+ }
+ qemu_mutex_unlock(&pr_mgr->lock);
+ return ret;
+}
+
+static bool pr_manager_helper_is_connected(PRManager *p)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(p);
+ bool result;
+
+ qemu_mutex_lock(&pr_mgr->lock);
+ result = (pr_mgr->ioc != NULL);
+ qemu_mutex_unlock(&pr_mgr->lock);
+
+ return result;
+}
+
+static void pr_manager_helper_complete(UserCreatable *uc, Error **errp)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(uc);
+
+ qemu_mutex_lock(&pr_mgr->lock);
+ pr_manager_helper_initialize(pr_mgr, errp);
+ qemu_mutex_unlock(&pr_mgr->lock);
+}
+
+static char *get_path(Object *obj, Error **errp)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj);
+
+ return g_strdup(pr_mgr->path);
+}
+
+static void set_path(Object *obj, const char *str, Error **errp)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj);
+
+ g_free(pr_mgr->path);
+ pr_mgr->path = g_strdup(str);
+}
+
+static void pr_manager_helper_instance_finalize(Object *obj)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj);
+
+ object_unref(OBJECT(pr_mgr->ioc));
+ qemu_mutex_destroy(&pr_mgr->lock);
+}
+
+static void pr_manager_helper_instance_init(Object *obj)
+{
+ PRManagerHelper *pr_mgr = PR_MANAGER_HELPER(obj);
+
+ qemu_mutex_init(&pr_mgr->lock);
+}
+
+static void pr_manager_helper_class_init(ObjectClass *klass,
+ void *class_data G_GNUC_UNUSED)
+{
+ PRManagerClass *prmgr_klass = PR_MANAGER_CLASS(klass);
+ UserCreatableClass *uc_klass = USER_CREATABLE_CLASS(klass);
+
+ object_class_property_add_str(klass, "path", get_path, set_path);
+ uc_klass->complete = pr_manager_helper_complete;
+ prmgr_klass->run = pr_manager_helper_run;
+ prmgr_klass->is_connected = pr_manager_helper_is_connected;
+}
+
+static const TypeInfo pr_manager_helper_info = {
+ .parent = TYPE_PR_MANAGER,
+ .name = TYPE_PR_MANAGER_HELPER,
+ .instance_size = sizeof(PRManagerHelper),
+ .instance_init = pr_manager_helper_instance_init,
+ .instance_finalize = pr_manager_helper_instance_finalize,
+ .class_init = pr_manager_helper_class_init,
+};
+
+static void pr_manager_helper_register_types(void)
+{
+ type_register_static(&pr_manager_helper_info);
+}
+
+type_init(pr_manager_helper_register_types);
diff --git a/scsi/pr-manager-stub.c b/scsi/pr-manager-stub.c
new file mode 100644
index 000000000..738b6d742
--- /dev/null
+++ b/scsi/pr-manager-stub.c
@@ -0,0 +1,30 @@
+/*
+ * Persistent reservation manager - stub for non-Linux platforms
+ *
+ * Copyright (c) 2018 Red Hat, Inc.
+ *
+ * Author: Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * This code is licensed under the LGPL.
+ *
+ */
+
+#include "qemu/osdep.h"
+#include "qapi/error.h"
+#include "scsi/pr-manager.h"
+#include "trace.h"
+#include "qapi/qapi-types-block.h"
+#include "qapi/qapi-commands-block.h"
+
+PRManager *pr_manager_lookup(const char *id, Error **errp)
+{
+ /* The classes do not exist at all! */
+ error_setg(errp, "No persistent reservation manager with id '%s'", id);
+ return NULL;
+}
+
+
+PRManagerInfoList *qmp_query_pr_managers(Error **errp)
+{
+ return NULL;
+}
diff --git a/scsi/pr-manager.c b/scsi/pr-manager.c
new file mode 100644
index 000000000..2098d7e75
--- /dev/null
+++ b/scsi/pr-manager.c
@@ -0,0 +1,145 @@
+/*
+ * Persistent reservation manager abstract class
+ *
+ * Copyright (c) 2017 Red Hat, Inc.
+ *
+ * Author: Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * This code is licensed under the LGPL.
+ *
+ */
+
+#include "qemu/osdep.h"
+#include <scsi/sg.h>
+
+#include "qapi/error.h"
+#include "block/aio.h"
+#include "block/thread-pool.h"
+#include "scsi/pr-manager.h"
+#include "trace.h"
+#include "qapi/qapi-types-block.h"
+#include "qemu/module.h"
+#include "qapi/qapi-commands-block.h"
+
+#define PR_MANAGER_PATH "/objects"
+
+typedef struct PRManagerData {
+ PRManager *pr_mgr;
+ struct sg_io_hdr *hdr;
+ int fd;
+} PRManagerData;
+
+static int pr_manager_worker(void *opaque)
+{
+ PRManagerData *data = opaque;
+ PRManager *pr_mgr = data->pr_mgr;
+ PRManagerClass *pr_mgr_class =
+ PR_MANAGER_GET_CLASS(pr_mgr);
+ struct sg_io_hdr *hdr = data->hdr;
+ int fd = data->fd;
+ int r;
+
+ trace_pr_manager_run(fd, hdr->cmdp[0], hdr->cmdp[1]);
+
+ /* The reference was taken in pr_manager_execute. */
+ r = pr_mgr_class->run(pr_mgr, fd, hdr);
+ object_unref(OBJECT(pr_mgr));
+ return r;
+}
+
+
+int coroutine_fn pr_manager_execute(PRManager *pr_mgr, AioContext *ctx, int fd,
+ struct sg_io_hdr *hdr)
+{
+ ThreadPool *pool = aio_get_thread_pool(ctx);
+ PRManagerData data = {
+ .pr_mgr = pr_mgr,
+ .fd = fd,
+ .hdr = hdr,
+ };
+
+ trace_pr_manager_execute(fd, hdr->cmdp[0], hdr->cmdp[1]);
+
+ /* The matching object_unref is in pr_manager_worker. */
+ object_ref(OBJECT(pr_mgr));
+ return thread_pool_submit_co(pool, pr_manager_worker, &data);
+}
+
+bool pr_manager_is_connected(PRManager *pr_mgr)
+{
+ PRManagerClass *pr_mgr_class =
+ PR_MANAGER_GET_CLASS(pr_mgr);
+
+ return !pr_mgr_class->is_connected || pr_mgr_class->is_connected(pr_mgr);
+}
+
+static const TypeInfo pr_manager_info = {
+ .parent = TYPE_OBJECT,
+ .name = TYPE_PR_MANAGER,
+ .class_size = sizeof(PRManagerClass),
+ .abstract = true,
+ .interfaces = (InterfaceInfo[]) {
+ { TYPE_USER_CREATABLE },
+ { }
+ }
+};
+
+PRManager *pr_manager_lookup(const char *id, Error **errp)
+{
+ Object *obj;
+ PRManager *pr_mgr;
+
+ obj = object_resolve_path_component(object_get_objects_root(), id);
+ if (!obj) {
+ error_setg(errp, "No persistent reservation manager with id '%s'", id);
+ return NULL;
+ }
+
+ pr_mgr = (PRManager *)
+ object_dynamic_cast(obj,
+ TYPE_PR_MANAGER);
+ if (!pr_mgr) {
+ error_setg(errp,
+ "Object with id '%s' is not a persistent reservation manager",
+ id);
+ return NULL;
+ }
+
+ return pr_mgr;
+}
+
+static void
+pr_manager_register_types(void)
+{
+ type_register_static(&pr_manager_info);
+}
+
+static int query_one_pr_manager(Object *object, void *opaque)
+{
+ PRManagerInfoList ***tail = opaque;
+ PRManagerInfo *info;
+ PRManager *pr_mgr;
+
+ pr_mgr = (PRManager *)object_dynamic_cast(object, TYPE_PR_MANAGER);
+ if (!pr_mgr) {
+ return 0;
+ }
+
+ info = g_new0(PRManagerInfo, 1);
+ info->id = g_strdup(object_get_canonical_path_component(object));
+ info->connected = pr_manager_is_connected(pr_mgr);
+ QAPI_LIST_APPEND(*tail, info);
+ return 0;
+}
+
+PRManagerInfoList *qmp_query_pr_managers(Error **errp)
+{
+ PRManagerInfoList *head = NULL;
+ PRManagerInfoList **prev = &head;
+ Object *container = container_get(object_get_root(), PR_MANAGER_PATH);
+
+ object_child_foreach(container, query_one_pr_manager, &prev);
+ return head;
+}
+
+type_init(pr_manager_register_types);
diff --git a/scsi/qemu-pr-helper.c b/scsi/qemu-pr-helper.c
new file mode 100644
index 000000000..f281daece
--- /dev/null
+++ b/scsi/qemu-pr-helper.c
@@ -0,0 +1,1082 @@
+/*
+ * Privileged helper to handle persistent reservation commands for QEMU
+ *
+ * Copyright (C) 2017 Red Hat, Inc. <pbonzini@redhat.com>
+ *
+ * Author: Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; under version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "qemu/osdep.h"
+#include <getopt.h>
+#include <sys/ioctl.h>
+#include <linux/dm-ioctl.h>
+#include <scsi/sg.h>
+
+#ifdef CONFIG_LIBCAP_NG
+#include <cap-ng.h>
+#endif
+#include <pwd.h>
+#include <grp.h>
+
+#ifdef CONFIG_MPATH
+#include <libudev.h>
+#include <mpath_cmd.h>
+#include <mpath_persist.h>
+#endif
+
+#include "qemu-common.h"
+#include "qapi/error.h"
+#include "qemu/cutils.h"
+#include "qemu/main-loop.h"
+#include "qemu/module.h"
+#include "qemu/error-report.h"
+#include "qemu/config-file.h"
+#include "qemu/bswap.h"
+#include "qemu/log.h"
+#include "qemu/systemd.h"
+#include "qapi/util.h"
+#include "qapi/qmp/qstring.h"
+#include "io/channel-socket.h"
+#include "trace/control.h"
+#include "qemu-version.h"
+
+#include "block/aio.h"
+#include "block/thread-pool.h"
+
+#include "scsi/constants.h"
+#include "scsi/utils.h"
+#include "pr-helper.h"
+
+#define PR_OUT_FIXED_PARAM_SIZE 24
+
+static char *socket_path;
+static char *pidfile;
+static enum { RUNNING, TERMINATE, TERMINATING } state;
+static QIOChannelSocket *server_ioc;
+static int server_watch;
+static int num_active_sockets = 1;
+static int noisy;
+static int verbose;
+
+#ifdef CONFIG_LIBCAP_NG
+static int uid = -1;
+static int gid = -1;
+#endif
+
+static void compute_default_paths(void)
+{
+ socket_path = qemu_get_local_state_pathname("run/qemu-pr-helper.sock");
+ pidfile = qemu_get_local_state_pathname("run/qemu-pr-helper.pid");
+}
+
+static void usage(const char *name)
+{
+ (printf) (
+"Usage: %s [OPTIONS] FILE\n"
+"Persistent Reservation helper program for QEMU\n"
+"\n"
+" -h, --help display this help and exit\n"
+" -V, --version output version information and exit\n"
+"\n"
+" -d, --daemon run in the background\n"
+" -f, --pidfile=PATH PID file when running as a daemon\n"
+" (default '%s')\n"
+" -k, --socket=PATH path to the unix socket\n"
+" (default '%s')\n"
+" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
+" specify tracing options\n"
+#ifdef CONFIG_LIBCAP_NG
+" -u, --user=USER user to drop privileges to\n"
+" -g, --group=GROUP group to drop privileges to\n"
+#endif
+"\n"
+QEMU_HELP_BOTTOM "\n"
+ , name, pidfile, socket_path);
+}
+
+static void version(const char *name)
+{
+ printf(
+"%s " QEMU_FULL_VERSION "\n"
+"Written by Paolo Bonzini.\n"
+"\n"
+QEMU_COPYRIGHT "\n"
+"This is free software; see the source for copying conditions. There is NO\n"
+"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
+ , name);
+}
+
+/* SG_IO support */
+
+typedef struct PRHelperSGIOData {
+ int fd;
+ const uint8_t *cdb;
+ uint8_t *sense;
+ uint8_t *buf;
+ int sz; /* input/output */
+ int dir;
+} PRHelperSGIOData;
+
+static int do_sgio_worker(void *opaque)
+{
+ PRHelperSGIOData *data = opaque;
+ struct sg_io_hdr io_hdr;
+ int ret;
+ int status;
+ SCSISense sense_code;
+
+ memset(data->sense, 0, PR_HELPER_SENSE_SIZE);
+ memset(&io_hdr, 0, sizeof(io_hdr));
+ io_hdr.interface_id = 'S';
+ io_hdr.cmd_len = PR_HELPER_CDB_SIZE;
+ io_hdr.cmdp = (uint8_t *)data->cdb;
+ io_hdr.sbp = data->sense;
+ io_hdr.mx_sb_len = PR_HELPER_SENSE_SIZE;
+ io_hdr.timeout = 1;
+ io_hdr.dxfer_direction = data->dir;
+ io_hdr.dxferp = (char *)data->buf;
+ io_hdr.dxfer_len = data->sz;
+ ret = ioctl(data->fd, SG_IO, &io_hdr);
+
+ if (ret < 0) {
+ status = scsi_sense_from_errno(errno, &sense_code);
+ if (status == CHECK_CONDITION) {
+ scsi_build_sense(data->sense, sense_code);
+ }
+ } else if (io_hdr.host_status != SCSI_HOST_OK) {
+ status = scsi_sense_from_host_status(io_hdr.host_status, &sense_code);
+ if (status == CHECK_CONDITION) {
+ scsi_build_sense(data->sense, sense_code);
+ }
+ } else if (io_hdr.driver_status & SG_ERR_DRIVER_TIMEOUT) {
+ status = BUSY;
+ } else {
+ status = io_hdr.status;
+ }
+
+ if (status == GOOD) {
+ data->sz -= io_hdr.resid;
+ } else {
+ data->sz = 0;
+ }
+
+ return status;
+}
+
+static int do_sgio(int fd, const uint8_t *cdb, uint8_t *sense,
+ uint8_t *buf, int *sz, int dir)
+{
+ ThreadPool *pool = aio_get_thread_pool(qemu_get_aio_context());
+ int r;
+
+ PRHelperSGIOData data = {
+ .fd = fd,
+ .cdb = cdb,
+ .sense = sense,
+ .buf = buf,
+ .sz = *sz,
+ .dir = dir,
+ };
+
+ r = thread_pool_submit_co(pool, do_sgio_worker, &data);
+ *sz = data.sz;
+ return r;
+}
+
+/* Device mapper interface */
+
+#ifdef CONFIG_MPATH
+#define CONTROL_PATH "/dev/mapper/control"
+
+typedef struct DMData {
+ struct dm_ioctl dm;
+ uint8_t data[1024];
+} DMData;
+
+static int control_fd;
+
+static void *dm_ioctl(int ioc, struct dm_ioctl *dm)
+{
+ static DMData d;
+ memcpy(&d.dm, dm, sizeof(d.dm));
+ QEMU_BUILD_BUG_ON(sizeof(d.data) < sizeof(struct dm_target_spec));
+
+ d.dm.version[0] = DM_VERSION_MAJOR;
+ d.dm.version[1] = 0;
+ d.dm.version[2] = 0;
+ d.dm.data_size = 1024;
+ d.dm.data_start = offsetof(DMData, data);
+ if (ioctl(control_fd, ioc, &d) < 0) {
+ return NULL;
+ }
+ memcpy(dm, &d.dm, sizeof(d.dm));
+ return &d.data;
+}
+
+static void *dm_dev_ioctl(int fd, int ioc, struct dm_ioctl *dm)
+{
+ struct stat st;
+ int r;
+
+ r = fstat(fd, &st);
+ if (r < 0) {
+ perror("fstat");
+ exit(1);
+ }
+
+ dm->dev = st.st_rdev;
+ return dm_ioctl(ioc, dm);
+}
+
+static void dm_init(void)
+{
+ control_fd = open(CONTROL_PATH, O_RDWR);
+ if (control_fd < 0) {
+ perror("Cannot open " CONTROL_PATH);
+ exit(1);
+ }
+ struct dm_ioctl dm = { };
+ if (!dm_ioctl(DM_VERSION, &dm)) {
+ perror("ioctl");
+ exit(1);
+ }
+ if (dm.version[0] != DM_VERSION_MAJOR) {
+ fprintf(stderr, "Unsupported device mapper interface");
+ exit(1);
+ }
+}
+
+/* Variables required by libmultipath and libmpathpersist. */
+QEMU_BUILD_BUG_ON(PR_HELPER_DATA_SIZE > MPATH_MAX_PARAM_LEN);
+static struct config *multipath_conf;
+unsigned mpath_mx_alloc_len = PR_HELPER_DATA_SIZE;
+int logsink;
+struct udev *udev;
+
+extern struct config *get_multipath_config(void);
+struct config *get_multipath_config(void)
+{
+ return multipath_conf;
+}
+
+extern void put_multipath_config(struct config *conf);
+void put_multipath_config(struct config *conf)
+{
+}
+
+static void multipath_pr_init(void)
+{
+ udev = udev_new();
+#ifdef CONFIG_MPATH_NEW_API
+ multipath_conf = mpath_lib_init();
+#else
+ mpath_lib_init(udev);
+#endif
+}
+
+static int is_mpath(int fd)
+{
+ struct dm_ioctl dm = { .flags = DM_NOFLUSH_FLAG };
+ struct dm_target_spec *tgt;
+
+ tgt = dm_dev_ioctl(fd, DM_TABLE_STATUS, &dm);
+ if (!tgt) {
+ if (errno == ENXIO) {
+ return 0;
+ }
+ perror("ioctl");
+ exit(EXIT_FAILURE);
+ }
+ return !strncmp(tgt->target_type, "multipath", DM_MAX_TYPE_NAME);
+}
+
+static SCSISense mpath_generic_sense(int r)
+{
+ switch (r) {
+ case MPATH_PR_SENSE_NOT_READY:
+ return SENSE_CODE(NOT_READY);
+ case MPATH_PR_SENSE_MEDIUM_ERROR:
+ return SENSE_CODE(READ_ERROR);
+ case MPATH_PR_SENSE_HARDWARE_ERROR:
+ return SENSE_CODE(TARGET_FAILURE);
+ case MPATH_PR_SENSE_ABORTED_COMMAND:
+ return SENSE_CODE(IO_ERROR);
+ default:
+ abort();
+ }
+}
+
+static int mpath_reconstruct_sense(int fd, int r, uint8_t *sense)
+{
+ switch (r) {
+ case MPATH_PR_SUCCESS:
+ return GOOD;
+ case MPATH_PR_SENSE_NOT_READY:
+ case MPATH_PR_SENSE_MEDIUM_ERROR:
+ case MPATH_PR_SENSE_HARDWARE_ERROR:
+ case MPATH_PR_SENSE_ABORTED_COMMAND:
+ {
+ /* libmpathpersist ate the exact sense. Try to find it by
+ * issuing TEST UNIT READY.
+ */
+ uint8_t cdb[6] = { TEST_UNIT_READY };
+ int sz = 0;
+ int ret = do_sgio(fd, cdb, sense, NULL, &sz, SG_DXFER_NONE);
+
+ if (ret != GOOD) {
+ return ret;
+ }
+ scsi_build_sense(sense, mpath_generic_sense(r));
+ return CHECK_CONDITION;
+ }
+
+ case MPATH_PR_SENSE_UNIT_ATTENTION:
+ /* Congratulations libmpathpersist, you ruined the Unit Attention...
+ * Return a heavyweight one.
+ */
+ scsi_build_sense(sense, SENSE_CODE(SCSI_BUS_RESET));
+ return CHECK_CONDITION;
+ case MPATH_PR_SENSE_INVALID_OP:
+ /* Only one valid sense. */
+ scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
+ return CHECK_CONDITION;
+ case MPATH_PR_ILLEGAL_REQ:
+ /* Guess. */
+ scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
+ return CHECK_CONDITION;
+ case MPATH_PR_NO_SENSE:
+ scsi_build_sense(sense, SENSE_CODE(NO_SENSE));
+ return CHECK_CONDITION;
+
+ case MPATH_PR_RESERV_CONFLICT:
+ return RESERVATION_CONFLICT;
+
+ case MPATH_PR_OTHER:
+ default:
+ scsi_build_sense(sense, SENSE_CODE(LUN_COMM_FAILURE));
+ return CHECK_CONDITION;
+ }
+}
+
+static int multipath_pr_in(int fd, const uint8_t *cdb, uint8_t *sense,
+ uint8_t *data, int sz)
+{
+ int rq_servact = cdb[1];
+ struct prin_resp resp;
+ size_t written;
+ int r;
+
+ switch (rq_servact) {
+ case MPATH_PRIN_RKEY_SA:
+ case MPATH_PRIN_RRES_SA:
+ case MPATH_PRIN_RCAP_SA:
+ break;
+ case MPATH_PRIN_RFSTAT_SA:
+ /* Nobody implements it anyway, so bail out. */
+ default:
+ /* Cannot parse any other output. */
+ scsi_build_sense(sense, SENSE_CODE(INVALID_FIELD));
+ return CHECK_CONDITION;
+ }
+
+ r = mpath_persistent_reserve_in(fd, rq_servact, &resp, noisy, verbose);
+ if (r == MPATH_PR_SUCCESS) {
+ switch (rq_servact) {
+ case MPATH_PRIN_RKEY_SA:
+ case MPATH_PRIN_RRES_SA: {
+ struct prin_readdescr *out = &resp.prin_descriptor.prin_readkeys;
+ assert(sz >= 8);
+ written = MIN(out->additional_length + 8, sz);
+ stl_be_p(&data[0], out->prgeneration);
+ stl_be_p(&data[4], out->additional_length);
+ memcpy(&data[8], out->key_list, written - 8);
+ break;
+ }
+ case MPATH_PRIN_RCAP_SA: {
+ struct prin_capdescr *out = &resp.prin_descriptor.prin_readcap;
+ assert(sz >= 6);
+ written = 6;
+ stw_be_p(&data[0], out->length);
+ data[2] = out->flags[0];
+ data[3] = out->flags[1];
+ stw_be_p(&data[4], out->pr_type_mask);
+ break;
+ }
+ default:
+ scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
+ return CHECK_CONDITION;
+ }
+ assert(written <= sz);
+ memset(data + written, 0, sz - written);
+ }
+
+ return mpath_reconstruct_sense(fd, r, sense);
+}
+
+static int multipath_pr_out(int fd, const uint8_t *cdb, uint8_t *sense,
+ const uint8_t *param, int sz)
+{
+ int rq_servact = cdb[1];
+ int rq_scope = cdb[2] >> 4;
+ int rq_type = cdb[2] & 0xf;
+ g_autofree struct prout_param_descriptor *paramp = NULL;
+ char transportids[PR_HELPER_DATA_SIZE];
+ int r;
+
+ paramp = g_malloc0(sizeof(struct prout_param_descriptor)
+ + sizeof(struct transportid *) * MPATH_MX_TIDS);
+
+ if (sz < PR_OUT_FIXED_PARAM_SIZE) {
+ /* Illegal request, Parameter list length error. This isn't fatal;
+ * we have read the data, send an error without closing the socket.
+ */
+ scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM_LEN));
+ return CHECK_CONDITION;
+ }
+
+ switch (rq_servact) {
+ case MPATH_PROUT_REG_SA:
+ case MPATH_PROUT_RES_SA:
+ case MPATH_PROUT_REL_SA:
+ case MPATH_PROUT_CLEAR_SA:
+ case MPATH_PROUT_PREE_SA:
+ case MPATH_PROUT_PREE_AB_SA:
+ case MPATH_PROUT_REG_IGN_SA:
+ break;
+ case MPATH_PROUT_REG_MOV_SA:
+ /* Not supported by struct prout_param_descriptor. */
+ default:
+ /* Cannot parse any other input. */
+ scsi_build_sense(sense, SENSE_CODE(INVALID_FIELD));
+ return CHECK_CONDITION;
+ }
+
+ /* Convert input data, especially transport IDs, to the structs
+ * used by libmpathpersist (which, of course, will immediately
+ * do the opposite).
+ */
+ memcpy(&paramp->key, &param[0], 8);
+ memcpy(&paramp->sa_key, &param[8], 8);
+ paramp->sa_flags = param[20];
+ if (sz > PR_OUT_FIXED_PARAM_SIZE) {
+ size_t transportid_len;
+ int i, j;
+ if (sz < PR_OUT_FIXED_PARAM_SIZE + 4) {
+ scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM_LEN));
+ return CHECK_CONDITION;
+ }
+ transportid_len = ldl_be_p(&param[24]) + PR_OUT_FIXED_PARAM_SIZE + 4;
+ if (transportid_len > sz) {
+ scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
+ return CHECK_CONDITION;
+ }
+ for (i = PR_OUT_FIXED_PARAM_SIZE + 4, j = 0; i < transportid_len; ) {
+ struct transportid *id = (struct transportid *) &transportids[j];
+ int len;
+
+ id->format_code = param[i] & 0xc0;
+ id->protocol_id = param[i] & 0x0f;
+ switch (param[i] & 0xcf) {
+ case 0:
+ /* FC transport. */
+ if (i + 24 > transportid_len) {
+ goto illegal_req;
+ }
+ memcpy(id->n_port_name, &param[i + 8], 8);
+ j += offsetof(struct transportid, n_port_name[8]);
+ i += 24;
+ break;
+ case 5:
+ case 0x45:
+ /* iSCSI transport. */
+ len = lduw_be_p(&param[i + 2]);
+ if (len > 252 || (len & 3) || i + len + 4 > transportid_len) {
+ /* For format code 00, the standard says the maximum is 223
+ * plus the NUL terminator. For format code 01 there is no
+ * maximum length, but libmpathpersist ignores the first
+ * byte of id->iscsi_name so our maximum is 252.
+ */
+ goto illegal_req;
+ }
+ if (memchr(&param[i + 4], 0, len) == NULL) {
+ goto illegal_req;
+ }
+ memcpy(id->iscsi_name, &param[i + 2], len + 2);
+ j += offsetof(struct transportid, iscsi_name[len + 2]);
+ i += len + 4;
+ break;
+ case 6:
+ /* SAS transport. */
+ if (i + 24 > transportid_len) {
+ goto illegal_req;
+ }
+ memcpy(id->sas_address, &param[i + 4], 8);
+ j += offsetof(struct transportid, sas_address[8]);
+ i += 24;
+ break;
+ default:
+ illegal_req:
+ scsi_build_sense(sense, SENSE_CODE(INVALID_PARAM));
+ return CHECK_CONDITION;
+ }
+
+ assert(paramp->num_transportid < MPATH_MX_TIDS);
+ paramp->trnptid_list[paramp->num_transportid++] = id;
+ }
+ }
+
+ r = mpath_persistent_reserve_out(fd, rq_servact, rq_scope, rq_type,
+ paramp, noisy, verbose);
+ return mpath_reconstruct_sense(fd, r, sense);
+}
+#endif
+
+static int do_pr_in(int fd, const uint8_t *cdb, uint8_t *sense,
+ uint8_t *data, int *resp_sz)
+{
+#ifdef CONFIG_MPATH
+ if (is_mpath(fd)) {
+ /* multipath_pr_in fills the whole input buffer. */
+ int r = multipath_pr_in(fd, cdb, sense, data, *resp_sz);
+ if (r != GOOD) {
+ *resp_sz = 0;
+ }
+ return r;
+ }
+#endif
+
+ return do_sgio(fd, cdb, sense, data, resp_sz,
+ SG_DXFER_FROM_DEV);
+}
+
+static int do_pr_out(int fd, const uint8_t *cdb, uint8_t *sense,
+ const uint8_t *param, int sz)
+{
+ int resp_sz;
+
+ if ((fcntl(fd, F_GETFL) & O_ACCMODE) == O_RDONLY) {
+ scsi_build_sense(sense, SENSE_CODE(INVALID_OPCODE));
+ return CHECK_CONDITION;
+ }
+
+#ifdef CONFIG_MPATH
+ if (is_mpath(fd)) {
+ return multipath_pr_out(fd, cdb, sense, param, sz);
+ }
+#endif
+
+ resp_sz = sz;
+ return do_sgio(fd, cdb, sense, (uint8_t *)param, &resp_sz,
+ SG_DXFER_TO_DEV);
+}
+
+/* Client */
+
+typedef struct PRHelperClient {
+ QIOChannelSocket *ioc;
+ Coroutine *co;
+ int fd;
+ uint8_t data[PR_HELPER_DATA_SIZE];
+} PRHelperClient;
+
+typedef struct PRHelperRequest {
+ int fd;
+ size_t sz;
+ uint8_t cdb[PR_HELPER_CDB_SIZE];
+} PRHelperRequest;
+
+static int coroutine_fn prh_read(PRHelperClient *client, void *buf, int sz,
+ Error **errp)
+{
+ int ret = 0;
+
+ while (sz > 0) {
+ int *fds = NULL;
+ size_t nfds = 0;
+ int i;
+ struct iovec iov;
+ ssize_t n_read;
+
+ iov.iov_base = buf;
+ iov.iov_len = sz;
+ n_read = qio_channel_readv_full(QIO_CHANNEL(client->ioc), &iov, 1,
+ &fds, &nfds, errp);
+
+ if (n_read == QIO_CHANNEL_ERR_BLOCK) {
+ qio_channel_yield(QIO_CHANNEL(client->ioc), G_IO_IN);
+ continue;
+ }
+ if (n_read <= 0) {
+ ret = n_read ? n_read : -1;
+ goto err;
+ }
+
+ /* Stash one file descriptor per request. */
+ if (nfds) {
+ bool too_many = false;
+ for (i = 0; i < nfds; i++) {
+ if (client->fd == -1) {
+ client->fd = fds[i];
+ } else {
+ close(fds[i]);
+ too_many = true;
+ }
+ }
+ g_free(fds);
+ if (too_many) {
+ ret = -1;
+ goto err;
+ }
+ }
+
+ buf += n_read;
+ sz -= n_read;
+ }
+
+ return 0;
+
+err:
+ if (client->fd != -1) {
+ close(client->fd);
+ client->fd = -1;
+ }
+ return ret;
+}
+
+static int coroutine_fn prh_read_request(PRHelperClient *client,
+ PRHelperRequest *req,
+ PRHelperResponse *resp, Error **errp)
+{
+ uint32_t sz;
+
+ if (prh_read(client, req->cdb, sizeof(req->cdb), NULL) < 0) {
+ return -1;
+ }
+
+ if (client->fd == -1) {
+ error_setg(errp, "No file descriptor in request.");
+ return -1;
+ }
+
+ if (req->cdb[0] != PERSISTENT_RESERVE_OUT &&
+ req->cdb[0] != PERSISTENT_RESERVE_IN) {
+ error_setg(errp, "Invalid CDB, closing socket.");
+ goto out_close;
+ }
+
+ sz = scsi_cdb_xfer(req->cdb);
+ if (sz > sizeof(client->data)) {
+ goto out_close;
+ }
+
+ if (req->cdb[0] == PERSISTENT_RESERVE_OUT) {
+ if (qio_channel_read_all(QIO_CHANNEL(client->ioc),
+ (char *)client->data, sz,
+ errp) < 0) {
+ goto out_close;
+ }
+ }
+
+ req->fd = client->fd;
+ req->sz = sz;
+ client->fd = -1;
+ return sz;
+
+out_close:
+ close(client->fd);
+ client->fd = -1;
+ return -1;
+}
+
+static int coroutine_fn prh_write_response(PRHelperClient *client,
+ PRHelperRequest *req,
+ PRHelperResponse *resp, Error **errp)
+{
+ ssize_t r;
+ size_t sz;
+
+ if (req->cdb[0] == PERSISTENT_RESERVE_IN && resp->result == GOOD) {
+ assert(resp->sz <= req->sz && resp->sz <= sizeof(client->data));
+ } else {
+ assert(resp->sz == 0);
+ }
+
+ sz = resp->sz;
+
+ resp->result = cpu_to_be32(resp->result);
+ resp->sz = cpu_to_be32(resp->sz);
+ r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
+ (char *) resp, sizeof(*resp), errp);
+ if (r < 0) {
+ return r;
+ }
+
+ r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
+ (char *) client->data,
+ sz, errp);
+ return r < 0 ? r : 0;
+}
+
+static void coroutine_fn prh_co_entry(void *opaque)
+{
+ PRHelperClient *client = opaque;
+ Error *local_err = NULL;
+ uint32_t flags;
+ int r;
+
+ qio_channel_set_blocking(QIO_CHANNEL(client->ioc),
+ false, NULL);
+ qio_channel_attach_aio_context(QIO_CHANNEL(client->ioc),
+ qemu_get_aio_context());
+
+ /* A very simple negotiation for future extensibility. No features
+ * are defined so write 0.
+ */
+ flags = cpu_to_be32(0);
+ r = qio_channel_write_all(QIO_CHANNEL(client->ioc),
+ (char *) &flags, sizeof(flags), NULL);
+ if (r < 0) {
+ goto out;
+ }
+
+ r = qio_channel_read_all(QIO_CHANNEL(client->ioc),
+ (char *) &flags, sizeof(flags), NULL);
+ if (be32_to_cpu(flags) != 0 || r < 0) {
+ goto out;
+ }
+
+ while (qatomic_read(&state) == RUNNING) {
+ PRHelperRequest req;
+ PRHelperResponse resp;
+ int sz;
+
+ sz = prh_read_request(client, &req, &resp, &local_err);
+ if (sz < 0) {
+ break;
+ }
+
+ num_active_sockets++;
+ if (req.cdb[0] == PERSISTENT_RESERVE_OUT) {
+ r = do_pr_out(req.fd, req.cdb, resp.sense,
+ client->data, sz);
+ resp.sz = 0;
+ } else {
+ resp.sz = sizeof(client->data);
+ r = do_pr_in(req.fd, req.cdb, resp.sense,
+ client->data, &resp.sz);
+ resp.sz = MIN(resp.sz, sz);
+ }
+ num_active_sockets--;
+ close(req.fd);
+ if (r == -1) {
+ break;
+ }
+ resp.result = r;
+
+ if (prh_write_response(client, &req, &resp, &local_err) < 0) {
+ break;
+ }
+ }
+
+ if (local_err) {
+ if (verbose == 0) {
+ error_free(local_err);
+ } else {
+ error_report_err(local_err);
+ }
+ }
+
+out:
+ qio_channel_detach_aio_context(QIO_CHANNEL(client->ioc));
+ object_unref(OBJECT(client->ioc));
+ g_free(client);
+}
+
+static gboolean accept_client(QIOChannel *ioc, GIOCondition cond, gpointer opaque)
+{
+ QIOChannelSocket *cioc;
+ PRHelperClient *prh;
+
+ cioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc),
+ NULL);
+ if (!cioc) {
+ return TRUE;
+ }
+
+ prh = g_new(PRHelperClient, 1);
+ prh->ioc = cioc;
+ prh->fd = -1;
+ prh->co = qemu_coroutine_create(prh_co_entry, prh);
+ qemu_coroutine_enter(prh->co);
+
+ return TRUE;
+}
+
+static void termsig_handler(int signum)
+{
+ qatomic_cmpxchg(&state, RUNNING, TERMINATE);
+ qemu_notify_event();
+}
+
+static void close_server_socket(void)
+{
+ assert(server_ioc);
+
+ g_source_remove(server_watch);
+ server_watch = -1;
+ object_unref(OBJECT(server_ioc));
+ num_active_sockets--;
+}
+
+#ifdef CONFIG_LIBCAP_NG
+static int drop_privileges(void)
+{
+ /* clear all capabilities */
+ capng_clear(CAPNG_SELECT_BOTH);
+
+ if (capng_update(CAPNG_ADD, CAPNG_EFFECTIVE | CAPNG_PERMITTED,
+ CAP_SYS_RAWIO) < 0) {
+ return -1;
+ }
+
+#ifdef CONFIG_MPATH
+ /* For /dev/mapper/control ioctls */
+ if (capng_update(CAPNG_ADD, CAPNG_EFFECTIVE | CAPNG_PERMITTED,
+ CAP_SYS_ADMIN) < 0) {
+ return -1;
+ }
+#endif
+
+ /* Change user/group id, retaining the capabilities. Because file descriptors
+ * are passed via SCM_RIGHTS, we don't need supplementary groups (and in
+ * fact the helper can run as "nobody").
+ */
+ if (capng_change_id(uid != -1 ? uid : getuid(),
+ gid != -1 ? gid : getgid(),
+ CAPNG_DROP_SUPP_GRP | CAPNG_CLEAR_BOUNDING)) {
+ return -1;
+ }
+
+ return 0;
+}
+#endif
+
+int main(int argc, char **argv)
+{
+ const char *sopt = "hVk:f:dT:u:g:vq";
+ struct option lopt[] = {
+ { "help", no_argument, NULL, 'h' },
+ { "version", no_argument, NULL, 'V' },
+ { "socket", required_argument, NULL, 'k' },
+ { "pidfile", required_argument, NULL, 'f' },
+ { "daemon", no_argument, NULL, 'd' },
+ { "trace", required_argument, NULL, 'T' },
+ { "user", required_argument, NULL, 'u' },
+ { "group", required_argument, NULL, 'g' },
+ { "verbose", no_argument, NULL, 'v' },
+ { "quiet", no_argument, NULL, 'q' },
+ { NULL, 0, NULL, 0 }
+ };
+ int opt_ind = 0;
+ int loglevel = 1;
+ int quiet = 0;
+ int ch;
+ Error *local_err = NULL;
+ bool daemonize = false;
+ bool pidfile_specified = false;
+ bool socket_path_specified = false;
+ unsigned socket_activation;
+
+ struct sigaction sa_sigterm;
+ memset(&sa_sigterm, 0, sizeof(sa_sigterm));
+ sa_sigterm.sa_handler = termsig_handler;
+ sigaction(SIGTERM, &sa_sigterm, NULL);
+ sigaction(SIGINT, &sa_sigterm, NULL);
+ sigaction(SIGHUP, &sa_sigterm, NULL);
+
+ signal(SIGPIPE, SIG_IGN);
+
+ error_init(argv[0]);
+ module_call_init(MODULE_INIT_TRACE);
+ module_call_init(MODULE_INIT_QOM);
+ qemu_add_opts(&qemu_trace_opts);
+ qemu_init_exec_dir(argv[0]);
+
+ compute_default_paths();
+
+ while ((ch = getopt_long(argc, argv, sopt, lopt, &opt_ind)) != -1) {
+ switch (ch) {
+ case 'k':
+ g_free(socket_path);
+ socket_path = g_strdup(optarg);
+ socket_path_specified = true;
+ if (socket_path[0] != '/') {
+ error_report("socket path must be absolute");
+ exit(EXIT_FAILURE);
+ }
+ break;
+ case 'f':
+ g_free(pidfile);
+ pidfile = g_strdup(optarg);
+ pidfile_specified = true;
+ break;
+#ifdef CONFIG_LIBCAP_NG
+ case 'u': {
+ unsigned long res;
+ struct passwd *userinfo = getpwnam(optarg);
+ if (userinfo) {
+ uid = userinfo->pw_uid;
+ } else if (qemu_strtoul(optarg, NULL, 10, &res) == 0 &&
+ (uid_t)res == res) {
+ uid = res;
+ } else {
+ error_report("invalid user '%s'", optarg);
+ exit(EXIT_FAILURE);
+ }
+ break;
+ }
+ case 'g': {
+ unsigned long res;
+ struct group *groupinfo = getgrnam(optarg);
+ if (groupinfo) {
+ gid = groupinfo->gr_gid;
+ } else if (qemu_strtoul(optarg, NULL, 10, &res) == 0 &&
+ (gid_t)res == res) {
+ gid = res;
+ } else {
+ error_report("invalid group '%s'", optarg);
+ exit(EXIT_FAILURE);
+ }
+ break;
+ }
+#else
+ case 'u':
+ case 'g':
+ error_report("-%c not supported by this %s", ch, argv[0]);
+ exit(1);
+#endif
+ case 'd':
+ daemonize = true;
+ break;
+ case 'q':
+ quiet = 1;
+ break;
+ case 'v':
+ ++loglevel;
+ break;
+ case 'T':
+ trace_opt_parse(optarg);
+ break;
+ case 'V':
+ version(argv[0]);
+ exit(EXIT_SUCCESS);
+ break;
+ case 'h':
+ usage(argv[0]);
+ exit(EXIT_SUCCESS);
+ break;
+ case '?':
+ error_report("Try `%s --help' for more information.", argv[0]);
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ /* set verbosity */
+ noisy = !quiet && (loglevel >= 3);
+ verbose = quiet ? 0 : MIN(loglevel, 3);
+
+ if (!trace_init_backends()) {
+ exit(EXIT_FAILURE);
+ }
+ trace_init_file();
+ qemu_set_log(LOG_TRACE);
+
+#ifdef CONFIG_MPATH
+ dm_init();
+ multipath_pr_init();
+#endif
+
+ socket_activation = check_socket_activation();
+ if (socket_activation == 0) {
+ SocketAddress saddr;
+ saddr = (SocketAddress){
+ .type = SOCKET_ADDRESS_TYPE_UNIX,
+ .u.q_unix.path = socket_path,
+ };
+ server_ioc = qio_channel_socket_new();
+ if (qio_channel_socket_listen_sync(server_ioc, &saddr,
+ 1, &local_err) < 0) {
+ object_unref(OBJECT(server_ioc));
+ error_report_err(local_err);
+ return 1;
+ }
+ } else {
+ /* Using socket activation - check user didn't use -p etc. */
+ if (socket_path_specified) {
+ error_report("Unix socket can't be set when using socket activation");
+ exit(EXIT_FAILURE);
+ }
+
+ /* Can only listen on a single socket. */
+ if (socket_activation > 1) {
+ error_report("%s does not support socket activation with LISTEN_FDS > 1",
+ argv[0]);
+ exit(EXIT_FAILURE);
+ }
+ server_ioc = qio_channel_socket_new_fd(FIRST_SOCKET_ACTIVATION_FD,
+ &local_err);
+ if (server_ioc == NULL) {
+ error_reportf_err(local_err,
+ "Failed to use socket activation: ");
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ qemu_init_main_loop(&error_fatal);
+
+ server_watch = qio_channel_add_watch(QIO_CHANNEL(server_ioc),
+ G_IO_IN,
+ accept_client,
+ NULL, NULL);
+
+ if (daemonize) {
+ if (daemon(0, 0) < 0) {
+ error_report("Failed to daemonize: %s", strerror(errno));
+ exit(EXIT_FAILURE);
+ }
+ }
+
+ if (daemonize || pidfile_specified) {
+ qemu_write_pidfile(pidfile, &error_fatal);
+ }
+
+#ifdef CONFIG_LIBCAP_NG
+ if (drop_privileges() < 0) {
+ error_report("Failed to drop privileges: %s", strerror(errno));
+ exit(EXIT_FAILURE);
+ }
+#endif
+
+ state = RUNNING;
+ do {
+ main_loop_wait(false);
+ if (state == TERMINATE) {
+ state = TERMINATING;
+ close_server_socket();
+ }
+ } while (num_active_sockets > 0);
+
+ exit(EXIT_SUCCESS);
+}
diff --git a/scsi/trace-events b/scsi/trace-events
new file mode 100644
index 000000000..baf924fa8
--- /dev/null
+++ b/scsi/trace-events
@@ -0,0 +1,5 @@
+# See docs/devel/tracing.rst for syntax documentation.
+
+# pr-manager.c
+pr_manager_execute(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x"
+pr_manager_run(int fd, int cmd, int sa) "fd=%d cmd=0x%02x service action=0x%02x"
diff --git a/scsi/trace.h b/scsi/trace.h
new file mode 100644
index 000000000..3e4d89a3a
--- /dev/null
+++ b/scsi/trace.h
@@ -0,0 +1 @@
+#include "trace/trace-scsi.h"
diff --git a/scsi/utils.c b/scsi/utils.c
new file mode 100644
index 000000000..357b03667
--- /dev/null
+++ b/scsi/utils.c
@@ -0,0 +1,660 @@
+/*
+ * SCSI helpers
+ *
+ * Copyright 2017 Red Hat, Inc.
+ *
+ * Authors:
+ * Fam Zheng <famz@redhat.com>
+ * Paolo Bonzini <pbonzini@redhat.com>
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ */
+
+#include "qemu/osdep.h"
+#include "scsi/constants.h"
+#include "scsi/utils.h"
+#include "qemu/bswap.h"
+
+uint32_t scsi_data_cdb_xfer(uint8_t *buf)
+{
+ if ((buf[0] >> 5) == 0 && buf[4] == 0) {
+ return 256;
+ } else {
+ return scsi_cdb_xfer(buf);
+ }
+}
+
+uint32_t scsi_cdb_xfer(uint8_t *buf)
+{
+ switch (buf[0] >> 5) {
+ case 0:
+ return buf[4];
+ case 1:
+ case 2:
+ return lduw_be_p(&buf[7]);
+ case 4:
+ return ldl_be_p(&buf[10]) & 0xffffffffULL;
+ case 5:
+ return ldl_be_p(&buf[6]) & 0xffffffffULL;
+ default:
+ return -1;
+ }
+}
+
+uint64_t scsi_cmd_lba(SCSICommand *cmd)
+{
+ uint8_t *buf = cmd->buf;
+ uint64_t lba;
+
+ switch (buf[0] >> 5) {
+ case 0:
+ lba = ldl_be_p(&buf[0]) & 0x1fffff;
+ break;
+ case 1:
+ case 2:
+ case 5:
+ lba = ldl_be_p(&buf[2]) & 0xffffffffULL;
+ break;
+ case 4:
+ lba = ldq_be_p(&buf[2]);
+ break;
+ default:
+ lba = -1;
+
+ }
+ return lba;
+}
+
+int scsi_cdb_length(uint8_t *buf)
+{
+ int cdb_len;
+
+ switch (buf[0] >> 5) {
+ case 0:
+ cdb_len = 6;
+ break;
+ case 1:
+ case 2:
+ cdb_len = 10;
+ break;
+ case 4:
+ cdb_len = 16;
+ break;
+ case 5:
+ cdb_len = 12;
+ break;
+ default:
+ cdb_len = -1;
+ }
+ return cdb_len;
+}
+
+SCSISense scsi_parse_sense_buf(const uint8_t *in_buf, int in_len)
+{
+ bool fixed_in;
+ SCSISense sense;
+
+ assert(in_len > 0);
+ fixed_in = (in_buf[0] & 2) == 0;
+ if (fixed_in) {
+ if (in_len < 14) {
+ return SENSE_CODE(IO_ERROR);
+ }
+ sense.key = in_buf[2];
+ sense.asc = in_buf[12];
+ sense.ascq = in_buf[13];
+ } else {
+ if (in_len < 4) {
+ return SENSE_CODE(IO_ERROR);
+ }
+ sense.key = in_buf[1];
+ sense.asc = in_buf[2];
+ sense.ascq = in_buf[3];
+ }
+
+ return sense;
+}
+
+int scsi_build_sense_buf(uint8_t *out_buf, size_t size, SCSISense sense,
+ bool fixed_sense)
+{
+ int len;
+ uint8_t buf[SCSI_SENSE_LEN] = { 0 };
+
+ if (fixed_sense) {
+ buf[0] = 0x70;
+ buf[2] = sense.key;
+ buf[7] = 10;
+ buf[12] = sense.asc;
+ buf[13] = sense.ascq;
+ len = 18;
+ } else {
+ buf[0] = 0x72;
+ buf[1] = sense.key;
+ buf[2] = sense.asc;
+ buf[3] = sense.ascq;
+ len = 8;
+ }
+ len = MIN(len, size);
+ memcpy(out_buf, buf, len);
+ return len;
+}
+
+int scsi_build_sense(uint8_t *buf, SCSISense sense)
+{
+ return scsi_build_sense_buf(buf, SCSI_SENSE_LEN, sense, true);
+}
+
+/*
+ * Predefined sense codes
+ */
+
+/* No sense data available */
+const struct SCSISense sense_code_NO_SENSE = {
+ .key = NO_SENSE , .asc = 0x00 , .ascq = 0x00
+};
+
+/* LUN not ready, Manual intervention required */
+const struct SCSISense sense_code_LUN_NOT_READY = {
+ .key = NOT_READY, .asc = 0x04, .ascq = 0x03
+};
+
+/* LUN not ready, Medium not present */
+const struct SCSISense sense_code_NO_MEDIUM = {
+ .key = NOT_READY, .asc = 0x3a, .ascq = 0x00
+};
+
+/* LUN not ready, medium removal prevented */
+const struct SCSISense sense_code_NOT_READY_REMOVAL_PREVENTED = {
+ .key = NOT_READY, .asc = 0x53, .ascq = 0x02
+};
+
+/* Hardware error, internal target failure */
+const struct SCSISense sense_code_TARGET_FAILURE = {
+ .key = HARDWARE_ERROR, .asc = 0x44, .ascq = 0x00
+};
+
+/* Illegal request, invalid command operation code */
+const struct SCSISense sense_code_INVALID_OPCODE = {
+ .key = ILLEGAL_REQUEST, .asc = 0x20, .ascq = 0x00
+};
+
+/* Illegal request, LBA out of range */
+const struct SCSISense sense_code_LBA_OUT_OF_RANGE = {
+ .key = ILLEGAL_REQUEST, .asc = 0x21, .ascq = 0x00
+};
+
+/* Illegal request, Invalid field in CDB */
+const struct SCSISense sense_code_INVALID_FIELD = {
+ .key = ILLEGAL_REQUEST, .asc = 0x24, .ascq = 0x00
+};
+
+/* Illegal request, Invalid field in parameter list */
+const struct SCSISense sense_code_INVALID_PARAM = {
+ .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x00
+};
+
+/* Illegal request, Invalid value in parameter list */
+const struct SCSISense sense_code_INVALID_PARAM_VALUE = {
+ .key = ILLEGAL_REQUEST, .asc = 0x26, .ascq = 0x01
+};
+
+/* Illegal request, Parameter list length error */
+const struct SCSISense sense_code_INVALID_PARAM_LEN = {
+ .key = ILLEGAL_REQUEST, .asc = 0x1a, .ascq = 0x00
+};
+
+/* Illegal request, LUN not supported */
+const struct SCSISense sense_code_LUN_NOT_SUPPORTED = {
+ .key = ILLEGAL_REQUEST, .asc = 0x25, .ascq = 0x00
+};
+
+/* Illegal request, Saving parameters not supported */
+const struct SCSISense sense_code_SAVING_PARAMS_NOT_SUPPORTED = {
+ .key = ILLEGAL_REQUEST, .asc = 0x39, .ascq = 0x00
+};
+
+/* Illegal request, Incompatible medium installed */
+const struct SCSISense sense_code_INCOMPATIBLE_FORMAT = {
+ .key = ILLEGAL_REQUEST, .asc = 0x30, .ascq = 0x00
+};
+
+/* Illegal request, medium removal prevented */
+const struct SCSISense sense_code_ILLEGAL_REQ_REMOVAL_PREVENTED = {
+ .key = ILLEGAL_REQUEST, .asc = 0x53, .ascq = 0x02
+};
+
+/* Illegal request, Invalid Transfer Tag */
+const struct SCSISense sense_code_INVALID_TAG = {
+ .key = ILLEGAL_REQUEST, .asc = 0x4b, .ascq = 0x01
+};
+
+/* Command aborted, I/O process terminated */
+const struct SCSISense sense_code_IO_ERROR = {
+ .key = ABORTED_COMMAND, .asc = 0x00, .ascq = 0x06
+};
+
+/* Command aborted, I_T Nexus loss occurred */
+const struct SCSISense sense_code_I_T_NEXUS_LOSS = {
+ .key = ABORTED_COMMAND, .asc = 0x29, .ascq = 0x07
+};
+
+/* Command aborted, Logical Unit failure */
+const struct SCSISense sense_code_LUN_FAILURE = {
+ .key = ABORTED_COMMAND, .asc = 0x3e, .ascq = 0x01
+};
+
+/* Command aborted, Overlapped Commands Attempted */
+const struct SCSISense sense_code_OVERLAPPED_COMMANDS = {
+ .key = ABORTED_COMMAND, .asc = 0x4e, .ascq = 0x00
+};
+
+/* Command aborted, LUN Communication Failure */
+const struct SCSISense sense_code_LUN_COMM_FAILURE = {
+ .key = ABORTED_COMMAND, .asc = 0x08, .ascq = 0x00
+};
+
+/* Command aborted, LUN does not respond to selection */
+const struct SCSISense sense_code_LUN_NOT_RESPONDING = {
+ .key = ABORTED_COMMAND, .asc = 0x05, .ascq = 0x00
+};
+
+/* Command aborted, Command Timeout during processing */
+const struct SCSISense sense_code_COMMAND_TIMEOUT = {
+ .key = ABORTED_COMMAND, .asc = 0x2e, .ascq = 0x02
+};
+
+/* Command aborted, Commands cleared by device server */
+const struct SCSISense sense_code_COMMAND_ABORTED = {
+ .key = ABORTED_COMMAND, .asc = 0x2f, .ascq = 0x02
+};
+
+/* Medium Error, Unrecovered read error */
+const struct SCSISense sense_code_READ_ERROR = {
+ .key = MEDIUM_ERROR, .asc = 0x11, .ascq = 0x00
+};
+
+/* Not ready, Cause not reportable */
+const struct SCSISense sense_code_NOT_READY = {
+ .key = NOT_READY, .asc = 0x04, .ascq = 0x00
+};
+
+/* Unit attention, Capacity data has changed */
+const struct SCSISense sense_code_CAPACITY_CHANGED = {
+ .key = UNIT_ATTENTION, .asc = 0x2a, .ascq = 0x09
+};
+
+/* Unit attention, Power on, reset or bus device reset occurred */
+const struct SCSISense sense_code_RESET = {
+ .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x00
+};
+
+/* Unit attention, SCSI bus reset */
+const struct SCSISense sense_code_SCSI_BUS_RESET = {
+ .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x02
+};
+
+/* Unit attention, No medium */
+const struct SCSISense sense_code_UNIT_ATTENTION_NO_MEDIUM = {
+ .key = UNIT_ATTENTION, .asc = 0x3a, .ascq = 0x00
+};
+
+/* Unit attention, Medium may have changed */
+const struct SCSISense sense_code_MEDIUM_CHANGED = {
+ .key = UNIT_ATTENTION, .asc = 0x28, .ascq = 0x00
+};
+
+/* Unit attention, Reported LUNs data has changed */
+const struct SCSISense sense_code_REPORTED_LUNS_CHANGED = {
+ .key = UNIT_ATTENTION, .asc = 0x3f, .ascq = 0x0e
+};
+
+/* Unit attention, Device internal reset */
+const struct SCSISense sense_code_DEVICE_INTERNAL_RESET = {
+ .key = UNIT_ATTENTION, .asc = 0x29, .ascq = 0x04
+};
+
+/* Data Protection, Write Protected */
+const struct SCSISense sense_code_WRITE_PROTECTED = {
+ .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x00
+};
+
+/* Data Protection, Space Allocation Failed Write Protect */
+const struct SCSISense sense_code_SPACE_ALLOC_FAILED = {
+ .key = DATA_PROTECT, .asc = 0x27, .ascq = 0x07
+};
+
+/*
+ * scsi_convert_sense
+ *
+ * Convert between fixed and descriptor sense buffers
+ */
+int scsi_convert_sense(uint8_t *in_buf, int in_len,
+ uint8_t *buf, int len, bool fixed)
+{
+ SCSISense sense;
+ bool fixed_in;
+
+ if (in_len == 0) {
+ return scsi_build_sense_buf(buf, len, SENSE_CODE(NO_SENSE), fixed);
+ }
+
+ fixed_in = (in_buf[0] & 2) == 0;
+ if (fixed == fixed_in) {
+ memcpy(buf, in_buf, MIN(len, in_len));
+ return MIN(len, in_len);
+ } else {
+ sense = scsi_parse_sense_buf(in_buf, in_len);
+ return scsi_build_sense_buf(buf, len, sense, fixed);
+ }
+}
+
+static bool scsi_sense_is_guest_recoverable(int key, int asc, int ascq)
+{
+ switch (key) {
+ case NO_SENSE:
+ case RECOVERED_ERROR:
+ case UNIT_ATTENTION:
+ case ABORTED_COMMAND:
+ return true;
+ case NOT_READY:
+ case ILLEGAL_REQUEST:
+ case DATA_PROTECT:
+ /* Parse ASCQ */
+ break;
+ default:
+ return false;
+ }
+
+ switch ((asc << 8) | ascq) {
+ case 0x1a00: /* PARAMETER LIST LENGTH ERROR */
+ case 0x2000: /* INVALID OPERATION CODE */
+ case 0x2400: /* INVALID FIELD IN CDB */
+ case 0x2500: /* LOGICAL UNIT NOT SUPPORTED */
+ case 0x2600: /* INVALID FIELD IN PARAMETER LIST */
+
+ case 0x2104: /* UNALIGNED WRITE COMMAND */
+ case 0x2105: /* WRITE BOUNDARY VIOLATION */
+ case 0x2106: /* ATTEMPT TO READ INVALID DATA */
+ case 0x550e: /* INSUFFICIENT ZONE RESOURCES */
+
+ case 0x0401: /* NOT READY, IN PROGRESS OF BECOMING READY */
+ case 0x0402: /* NOT READY, INITIALIZING COMMAND REQUIRED */
+ return true;
+ default:
+ return false;
+ }
+}
+
+int scsi_sense_to_errno(int key, int asc, int ascq)
+{
+ switch (key) {
+ case NO_SENSE:
+ case RECOVERED_ERROR:
+ case UNIT_ATTENTION:
+ return EAGAIN;
+ case ABORTED_COMMAND: /* COMMAND ABORTED */
+ return ECANCELED;
+ case NOT_READY:
+ case ILLEGAL_REQUEST:
+ case DATA_PROTECT:
+ /* Parse ASCQ */
+ break;
+ default:
+ return EIO;
+ }
+ switch ((asc << 8) | ascq) {
+ case 0x1a00: /* PARAMETER LIST LENGTH ERROR */
+ case 0x2000: /* INVALID OPERATION CODE */
+ case 0x2400: /* INVALID FIELD IN CDB */
+ case 0x2600: /* INVALID FIELD IN PARAMETER LIST */
+ return EINVAL;
+ case 0x2100: /* LBA OUT OF RANGE */
+ case 0x2707: /* SPACE ALLOC FAILED */
+ return ENOSPC;
+ case 0x2500: /* LOGICAL UNIT NOT SUPPORTED */
+ return ENOTSUP;
+ case 0x3a00: /* MEDIUM NOT PRESENT */
+ case 0x3a01: /* MEDIUM NOT PRESENT TRAY CLOSED */
+ case 0x3a02: /* MEDIUM NOT PRESENT TRAY OPEN */
+ return ENOMEDIUM;
+ case 0x2700: /* WRITE PROTECTED */
+ return EACCES;
+ case 0x0401: /* NOT READY, IN PROGRESS OF BECOMING READY */
+ return EINPROGRESS;
+ case 0x0402: /* NOT READY, INITIALIZING COMMAND REQUIRED */
+ return ENOTCONN;
+ default:
+ return EIO;
+ }
+}
+
+int scsi_sense_buf_to_errno(const uint8_t *in_buf, size_t in_len)
+{
+ SCSISense sense;
+ if (in_len < 1) {
+ return EIO;
+ }
+
+ sense = scsi_parse_sense_buf(in_buf, in_len);
+ return scsi_sense_to_errno(sense.key, sense.asc, sense.ascq);
+}
+
+bool scsi_sense_buf_is_guest_recoverable(const uint8_t *in_buf, size_t in_len)
+{
+ SCSISense sense;
+ if (in_len < 1) {
+ return false;
+ }
+
+ sense = scsi_parse_sense_buf(in_buf, in_len);
+ return scsi_sense_is_guest_recoverable(sense.key, sense.asc, sense.ascq);
+}
+
+const char *scsi_command_name(uint8_t cmd)
+{
+ static const char *names[] = {
+ [ TEST_UNIT_READY ] = "TEST_UNIT_READY",
+ [ REWIND ] = "REWIND",
+ [ REQUEST_SENSE ] = "REQUEST_SENSE",
+ [ FORMAT_UNIT ] = "FORMAT_UNIT",
+ [ READ_BLOCK_LIMITS ] = "READ_BLOCK_LIMITS",
+ [ REASSIGN_BLOCKS ] = "REASSIGN_BLOCKS/INITIALIZE ELEMENT STATUS",
+ /* LOAD_UNLOAD and INITIALIZE_ELEMENT_STATUS use the same operation code */
+ [ READ_6 ] = "READ_6",
+ [ WRITE_6 ] = "WRITE_6",
+ [ SET_CAPACITY ] = "SET_CAPACITY",
+ [ READ_REVERSE ] = "READ_REVERSE",
+ [ WRITE_FILEMARKS ] = "WRITE_FILEMARKS",
+ [ SPACE ] = "SPACE",
+ [ INQUIRY ] = "INQUIRY",
+ [ RECOVER_BUFFERED_DATA ] = "RECOVER_BUFFERED_DATA",
+ [ MAINTENANCE_IN ] = "MAINTENANCE_IN",
+ [ MAINTENANCE_OUT ] = "MAINTENANCE_OUT",
+ [ MODE_SELECT ] = "MODE_SELECT",
+ [ RESERVE ] = "RESERVE",
+ [ RELEASE ] = "RELEASE",
+ [ COPY ] = "COPY",
+ [ ERASE ] = "ERASE",
+ [ MODE_SENSE ] = "MODE_SENSE",
+ [ START_STOP ] = "START_STOP/LOAD_UNLOAD",
+ /* LOAD_UNLOAD and START_STOP use the same operation code */
+ [ RECEIVE_DIAGNOSTIC ] = "RECEIVE_DIAGNOSTIC",
+ [ SEND_DIAGNOSTIC ] = "SEND_DIAGNOSTIC",
+ [ ALLOW_MEDIUM_REMOVAL ] = "ALLOW_MEDIUM_REMOVAL",
+ [ READ_CAPACITY_10 ] = "READ_CAPACITY_10",
+ [ READ_10 ] = "READ_10",
+ [ WRITE_10 ] = "WRITE_10",
+ [ SEEK_10 ] = "SEEK_10/POSITION_TO_ELEMENT",
+ /* SEEK_10 and POSITION_TO_ELEMENT use the same operation code */
+ [ WRITE_VERIFY_10 ] = "WRITE_VERIFY_10",
+ [ VERIFY_10 ] = "VERIFY_10",
+ [ SEARCH_HIGH ] = "SEARCH_HIGH",
+ [ SEARCH_EQUAL ] = "SEARCH_EQUAL",
+ [ SEARCH_LOW ] = "SEARCH_LOW",
+ [ SET_LIMITS ] = "SET_LIMITS",
+ [ PRE_FETCH ] = "PRE_FETCH/READ_POSITION",
+ /* READ_POSITION and PRE_FETCH use the same operation code */
+ [ SYNCHRONIZE_CACHE ] = "SYNCHRONIZE_CACHE",
+ [ LOCK_UNLOCK_CACHE ] = "LOCK_UNLOCK_CACHE",
+ [ READ_DEFECT_DATA ] = "READ_DEFECT_DATA/INITIALIZE_ELEMENT_STATUS_WITH_RANGE",
+ /* READ_DEFECT_DATA and INITIALIZE_ELEMENT_STATUS_WITH_RANGE use the same operation code */
+ [ MEDIUM_SCAN ] = "MEDIUM_SCAN",
+ [ COMPARE ] = "COMPARE",
+ [ COPY_VERIFY ] = "COPY_VERIFY",
+ [ WRITE_BUFFER ] = "WRITE_BUFFER",
+ [ READ_BUFFER ] = "READ_BUFFER",
+ [ UPDATE_BLOCK ] = "UPDATE_BLOCK",
+ [ READ_LONG_10 ] = "READ_LONG_10",
+ [ WRITE_LONG_10 ] = "WRITE_LONG_10",
+ [ CHANGE_DEFINITION ] = "CHANGE_DEFINITION",
+ [ WRITE_SAME_10 ] = "WRITE_SAME_10",
+ [ UNMAP ] = "UNMAP",
+ [ READ_TOC ] = "READ_TOC",
+ [ REPORT_DENSITY_SUPPORT ] = "REPORT_DENSITY_SUPPORT",
+ [ SANITIZE ] = "SANITIZE",
+ [ GET_CONFIGURATION ] = "GET_CONFIGURATION",
+ [ LOG_SELECT ] = "LOG_SELECT",
+ [ LOG_SENSE ] = "LOG_SENSE",
+ [ MODE_SELECT_10 ] = "MODE_SELECT_10",
+ [ RESERVE_10 ] = "RESERVE_10",
+ [ RELEASE_10 ] = "RELEASE_10",
+ [ MODE_SENSE_10 ] = "MODE_SENSE_10",
+ [ PERSISTENT_RESERVE_IN ] = "PERSISTENT_RESERVE_IN",
+ [ PERSISTENT_RESERVE_OUT ] = "PERSISTENT_RESERVE_OUT",
+ [ WRITE_FILEMARKS_16 ] = "WRITE_FILEMARKS_16",
+ [ EXTENDED_COPY ] = "EXTENDED_COPY",
+ [ ATA_PASSTHROUGH_16 ] = "ATA_PASSTHROUGH_16",
+ [ ACCESS_CONTROL_IN ] = "ACCESS_CONTROL_IN",
+ [ ACCESS_CONTROL_OUT ] = "ACCESS_CONTROL_OUT",
+ [ READ_16 ] = "READ_16",
+ [ COMPARE_AND_WRITE ] = "COMPARE_AND_WRITE",
+ [ WRITE_16 ] = "WRITE_16",
+ [ WRITE_VERIFY_16 ] = "WRITE_VERIFY_16",
+ [ VERIFY_16 ] = "VERIFY_16",
+ [ PRE_FETCH_16 ] = "PRE_FETCH_16",
+ [ SYNCHRONIZE_CACHE_16 ] = "SPACE_16/SYNCHRONIZE_CACHE_16",
+ /* SPACE_16 and SYNCHRONIZE_CACHE_16 use the same operation code */
+ [ LOCATE_16 ] = "LOCATE_16",
+ [ WRITE_SAME_16 ] = "ERASE_16/WRITE_SAME_16",
+ /* ERASE_16 and WRITE_SAME_16 use the same operation code */
+ [ SERVICE_ACTION_IN_16 ] = "SERVICE_ACTION_IN_16",
+ [ WRITE_LONG_16 ] = "WRITE_LONG_16",
+ [ REPORT_LUNS ] = "REPORT_LUNS",
+ [ ATA_PASSTHROUGH_12 ] = "BLANK/ATA_PASSTHROUGH_12",
+ [ MOVE_MEDIUM ] = "MOVE_MEDIUM",
+ [ EXCHANGE_MEDIUM ] = "EXCHANGE MEDIUM",
+ [ READ_12 ] = "READ_12",
+ [ WRITE_12 ] = "WRITE_12",
+ [ ERASE_12 ] = "ERASE_12/GET_PERFORMANCE",
+ /* ERASE_12 and GET_PERFORMANCE use the same operation code */
+ [ SERVICE_ACTION_IN_12 ] = "SERVICE_ACTION_IN_12",
+ [ WRITE_VERIFY_12 ] = "WRITE_VERIFY_12",
+ [ VERIFY_12 ] = "VERIFY_12",
+ [ SEARCH_HIGH_12 ] = "SEARCH_HIGH_12",
+ [ SEARCH_EQUAL_12 ] = "SEARCH_EQUAL_12",
+ [ SEARCH_LOW_12 ] = "SEARCH_LOW_12",
+ [ READ_ELEMENT_STATUS ] = "READ_ELEMENT_STATUS",
+ [ SEND_VOLUME_TAG ] = "SEND_VOLUME_TAG/SET_STREAMING",
+ /* SEND_VOLUME_TAG and SET_STREAMING use the same operation code */
+ [ READ_CD ] = "READ_CD",
+ [ READ_DEFECT_DATA_12 ] = "READ_DEFECT_DATA_12",
+ [ READ_DVD_STRUCTURE ] = "READ_DVD_STRUCTURE",
+ [ RESERVE_TRACK ] = "RESERVE_TRACK",
+ [ SEND_CUE_SHEET ] = "SEND_CUE_SHEET",
+ [ SEND_DVD_STRUCTURE ] = "SEND_DVD_STRUCTURE",
+ [ SET_CD_SPEED ] = "SET_CD_SPEED",
+ [ SET_READ_AHEAD ] = "SET_READ_AHEAD",
+ [ ALLOW_OVERWRITE ] = "ALLOW_OVERWRITE",
+ [ MECHANISM_STATUS ] = "MECHANISM_STATUS",
+ [ GET_EVENT_STATUS_NOTIFICATION ] = "GET_EVENT_STATUS_NOTIFICATION",
+ [ READ_DISC_INFORMATION ] = "READ_DISC_INFORMATION",
+ };
+
+ if (cmd >= ARRAY_SIZE(names) || names[cmd] == NULL) {
+ return "*UNKNOWN*";
+ }
+ return names[cmd];
+}
+
+int scsi_sense_from_errno(int errno_value, SCSISense *sense)
+{
+ switch (errno_value) {
+ case 0:
+ return GOOD;
+ case EDOM:
+ return TASK_SET_FULL;
+#ifdef CONFIG_LINUX
+ /* These errno mapping are specific to Linux. For more information:
+ * - scsi_check_sense and scsi_decide_disposition in drivers/scsi/scsi_error.c
+ * - scsi_result_to_blk_status in drivers/scsi/scsi_lib.c
+ * - blk_errors[] in block/blk-core.c
+ */
+ case EBADE:
+ return RESERVATION_CONFLICT;
+ case ENODATA:
+ *sense = SENSE_CODE(READ_ERROR);
+ return CHECK_CONDITION;
+ case EREMOTEIO:
+ *sense = SENSE_CODE(TARGET_FAILURE);
+ return CHECK_CONDITION;
+#endif
+ case ENOMEDIUM:
+ *sense = SENSE_CODE(NO_MEDIUM);
+ return CHECK_CONDITION;
+ case ENOMEM:
+ *sense = SENSE_CODE(TARGET_FAILURE);
+ return CHECK_CONDITION;
+ case EINVAL:
+ *sense = SENSE_CODE(INVALID_FIELD);
+ return CHECK_CONDITION;
+ case ENOSPC:
+ *sense = SENSE_CODE(SPACE_ALLOC_FAILED);
+ return CHECK_CONDITION;
+ default:
+ *sense = SENSE_CODE(IO_ERROR);
+ return CHECK_CONDITION;
+ }
+}
+
+int scsi_sense_from_host_status(uint8_t host_status,
+ SCSISense *sense)
+{
+ switch (host_status) {
+ case SCSI_HOST_NO_LUN:
+ *sense = SENSE_CODE(LUN_NOT_RESPONDING);
+ return CHECK_CONDITION;
+ case SCSI_HOST_BUSY:
+ return BUSY;
+ case SCSI_HOST_TIME_OUT:
+ *sense = SENSE_CODE(COMMAND_TIMEOUT);
+ return CHECK_CONDITION;
+ case SCSI_HOST_BAD_RESPONSE:
+ *sense = SENSE_CODE(LUN_COMM_FAILURE);
+ return CHECK_CONDITION;
+ case SCSI_HOST_ABORTED:
+ *sense = SENSE_CODE(COMMAND_ABORTED);
+ return CHECK_CONDITION;
+ case SCSI_HOST_RESET:
+ *sense = SENSE_CODE(RESET);
+ return CHECK_CONDITION;
+ case SCSI_HOST_TRANSPORT_DISRUPTED:
+ *sense = SENSE_CODE(I_T_NEXUS_LOSS);
+ return CHECK_CONDITION;
+ case SCSI_HOST_TARGET_FAILURE:
+ *sense = SENSE_CODE(TARGET_FAILURE);
+ return CHECK_CONDITION;
+ case SCSI_HOST_RESERVATION_ERROR:
+ return RESERVATION_CONFLICT;
+ case SCSI_HOST_ALLOCATION_FAILURE:
+ *sense = SENSE_CODE(SPACE_ALLOC_FAILED);
+ return CHECK_CONDITION;
+ case SCSI_HOST_MEDIUM_ERROR:
+ *sense = SENSE_CODE(READ_ERROR);
+ return CHECK_CONDITION;
+ }
+ return GOOD;
+}