raw.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "ublk/detail/raw.hpp"
 
#ifndef IORING_URING_CMD_MULTISHOT
#define IORING_URING_CMD_MULTISHOT (1U << 1)
#endif
 
namespace ublk {
namespace raw {

template <typename Fd>
inline auto get_queue_affinity(Fd fd, uint32_t dev_id, uint16_t q_id,
                               void *data, uint16_t size,
                               uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(
        fd, static_cast<int>(UBLK_U_CMD_GET_QUEUE_AFFINITY), dev_id, q_id, q_id,
        reinterpret_cast<uint64_t>(data), size, dev_path_len);
}

template <typename Fd>
inline auto get_queue_affinity(Fd fd, uint32_t dev_id, uint16_t q_id,
                               cpu_set_t *cpuset) noexcept {
    return get_queue_affinity(fd, dev_id, q_id, cpuset, sizeof(*cpuset), 0);
}

template <typename Fd>
inline auto get_dev_info(Fd fd, uint32_t dev_id, void *data, uint16_t size,
                         uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_GET_DEV_INFO),
                            dev_id, -1, 0, reinterpret_cast<uint64_t>(data),
                            size, dev_path_len);
}

template <typename Fd>
inline auto get_dev_info(Fd fd, uint32_t dev_id,
                         ublksrv_ctrl_dev_info *info) noexcept {
    return get_dev_info(fd, dev_id, info, sizeof(*info), 0);
}

template <typename Fd>
inline auto add_dev(Fd fd, ublksrv_ctrl_dev_info *info) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_ADD_DEV),
                            info->dev_id, -1, 0,
                            reinterpret_cast<uint64_t>(info), sizeof(*info), 0);
}

template <typename Fd>
inline auto del_dev(Fd fd, uint32_t dev_id, const char *dev_path,
                    uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_DEL_DEV), dev_id,
                            -1, 0, reinterpret_cast<uint64_t>(dev_path),
                            dev_path_len, dev_path_len);
}

template <typename Fd> inline auto del_dev(Fd fd, uint32_t dev_id) noexcept {
    return del_dev(fd, dev_id, nullptr, 0);
}

template <typename Fd>
inline auto start_dev(Fd fd, uint32_t dev_id, int32_t daemon_pid,
                      const char *dev_path, uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_START_DEV), dev_id,
                            -1, static_cast<uint64_t>(daemon_pid),
                            reinterpret_cast<uint64_t>(dev_path), dev_path_len,
                            dev_path_len);
}

template <typename Fd>
inline auto start_dev(Fd fd, uint32_t dev_id, int32_t daemon_pid) noexcept {
    return start_dev(fd, dev_id, daemon_pid, nullptr, 0);
}

template <typename Fd>
inline auto stop_dev(Fd fd, uint32_t dev_id, const char *dev_path,
                     uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_STOP_DEV), dev_id,
                            -1, 0, reinterpret_cast<uint64_t>(dev_path),
                            dev_path_len, dev_path_len);
}

template <typename Fd> inline auto stop_dev(Fd fd, uint32_t dev_id) noexcept {
    return stop_dev(fd, dev_id, nullptr, 0);
}

template <typename Fd>
inline auto set_params(Fd fd, uint32_t dev_id, const void *data, uint16_t size,
                       uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_SET_PARAMS), dev_id,
                            -1, 0, reinterpret_cast<uint64_t>(data), size,
                            dev_path_len);
}

template <typename Fd>
inline auto set_params(Fd fd, uint32_t dev_id,
                       const ublk_params *params) noexcept {
    return set_params(fd, dev_id, params, sizeof(*params), 0);
}

template <typename Fd>
inline auto get_params(Fd fd, uint32_t dev_id, void *data, uint16_t size,
                       uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_GET_PARAMS), dev_id,
                            -1, 0, reinterpret_cast<uint64_t>(data), size,
                            dev_path_len);
}

template <typename Fd>
inline auto get_params(Fd fd, uint32_t dev_id, ublk_params *params) noexcept {
    return get_params(fd, dev_id, params, sizeof(*params), 0);
}

template <typename Fd>
inline auto start_user_recovery(Fd fd, uint32_t dev_id, const char *dev_path,
                                uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(
        fd, static_cast<int>(UBLK_U_CMD_START_USER_RECOVERY), dev_id, -1, 0,
        reinterpret_cast<uint64_t>(dev_path), dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto start_user_recovery(Fd fd, uint32_t dev_id) noexcept {
    return start_user_recovery(fd, dev_id, nullptr, 0);
}

template <typename Fd>
inline auto end_user_recovery(Fd fd, uint32_t dev_id, int32_t daemon_pid,
                              const char *dev_path,
                              uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_END_USER_RECOVERY),
                            dev_id, -1, static_cast<uint64_t>(daemon_pid),
                            reinterpret_cast<uint64_t>(dev_path), dev_path_len,
                            dev_path_len);
}

template <typename Fd>
inline auto end_user_recovery(Fd fd, uint32_t dev_id,
                              int32_t daemon_pid) noexcept {
    return end_user_recovery(fd, dev_id, daemon_pid, nullptr, 0);
}

template <typename Fd>
inline auto get_dev_info2(Fd fd, uint32_t dev_id, void *data, uint16_t size,
                          uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_GET_DEV_INFO2),
                            dev_id, -1, 0, reinterpret_cast<uint64_t>(data),
                            size, dev_path_len);
}

template <typename Fd>
inline auto get_features(Fd fd, uint64_t *features) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_GET_FEATURES), -1,
                            -1, 0, reinterpret_cast<uint64_t>(features),
                            UBLK_FEATURES_LEN, 0);
}

template <typename Fd>
inline auto del_dev_async(Fd fd, uint32_t dev_id, const char *dev_path,
                          uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_DEL_DEV_ASYNC),
                            dev_id, -1, 0, reinterpret_cast<uint64_t>(dev_path),
                            dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto del_dev_async(Fd fd, uint32_t dev_id) noexcept {
    return del_dev_async(fd, dev_id, nullptr, 0);
}

template <typename Fd>
inline auto update_size(Fd fd, uint32_t dev_id, uint64_t sectors,
                        const char *dev_path, uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(
        fd, static_cast<int>(UBLK_U_CMD_UPDATE_SIZE), dev_id, -1, sectors,
        reinterpret_cast<uint64_t>(dev_path), dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto update_size(Fd fd, uint32_t dev_id, uint64_t sectors) noexcept {
    return update_size(fd, dev_id, sectors, nullptr, 0);
}

template <typename Fd>
inline auto quiesce_dev(Fd fd, uint32_t dev_id, uint64_t timeout_ms,
                        const char *dev_path, uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(
        fd, static_cast<int>(UBLK_U_CMD_QUIESCE_DEV), dev_id, -1, timeout_ms,
        reinterpret_cast<uint64_t>(dev_path), dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto quiesce_dev(Fd fd, uint32_t dev_id, uint64_t timeout_ms) noexcept {
    return quiesce_dev(fd, dev_id, timeout_ms, nullptr, 0);
}

template <typename Fd>
inline auto try_stop_dev(Fd fd, uint32_t dev_id, const char *dev_path,
                         uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_TRY_STOP_DEV),
                            dev_id, -1, 0, reinterpret_cast<uint64_t>(dev_path),
                            dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto try_stop_dev(Fd fd, uint32_t dev_id) noexcept {
    return try_stop_dev(fd, dev_id, nullptr, 0);
}

template <typename Fd>
inline auto register_shm_buf(Fd fd, uint32_t dev_id, const void *data,
                             uint16_t size, uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_REG_BUF), dev_id,
                            -1, 0, reinterpret_cast<uint64_t>(data), size,
                            dev_path_len);
}

template <typename Fd>
inline auto register_shm_buf(Fd fd, uint32_t dev_id,
                             const ublk_shmem_buf_reg *reg) noexcept {
    return register_shm_buf(fd, dev_id, reg, sizeof(*reg), 0);
}

template <typename Fd>
inline auto unregister_shm_buf(Fd fd, uint32_t dev_id, uint64_t buf_index,
                               const char *dev_path,
                               uint16_t dev_path_len) noexcept {
    return detail::ctrl_cmd(fd, static_cast<int>(UBLK_U_CMD_UNREG_BUF), dev_id,
                            -1, buf_index, reinterpret_cast<uint64_t>(dev_path),
                            dev_path_len, dev_path_len);
}

template <typename Fd>
inline auto unregister_shm_buf(Fd fd, uint32_t dev_id,
                               uint64_t buf_index) noexcept {
    return unregister_shm_buf(fd, dev_id, buf_index, nullptr, 0);
}

template <typename Fd>
inline auto fetch_req(Fd fd, uint16_t q_id, uint16_t tag, uint64_t buf_addr,
                      uint64_t sqe_addr) noexcept {
    return detail::io_cmd(fd, static_cast<int>(UBLK_U_IO_FETCH_REQ), q_id, tag,
                          0, buf_addr, sqe_addr);
}

template <typename Fd>
inline auto fetch_req(Fd fd, uint16_t q_id, uint16_t tag,
                      uint64_t buf_addr) noexcept {
    return fetch_req(fd, q_id, tag, buf_addr, 0);
}

template <typename Fd>
inline auto commit_and_fetch_req(Fd fd, uint16_t q_id, uint16_t tag,
                                 int32_t result, uint64_t buf_addr,
                                 uint64_t sqe_addr) noexcept {
    return detail::io_cmd(fd, static_cast<int>(UBLK_U_IO_COMMIT_AND_FETCH_REQ),
                          q_id, tag, result, buf_addr, sqe_addr);
}

template <typename Fd>
inline auto commit_and_fetch_req(Fd fd, uint16_t q_id, uint16_t tag,
                                 int32_t result, uint64_t buf_addr) noexcept {
    return commit_and_fetch_req(fd, q_id, tag, result, buf_addr, 0);
}

template <typename Fd>
inline auto need_get_data(Fd fd, uint16_t q_id, uint16_t tag,
                          uint64_t buf_addr) noexcept {
    return detail::io_cmd(fd, static_cast<int>(UBLK_U_IO_NEED_GET_DATA), q_id,
                          tag, 0, buf_addr, 0);
}

template <typename Fd>
inline auto register_io_buf(Fd fd, uint16_t q_id, uint16_t tag,
                            uint64_t buf_index) noexcept {
    return detail::io_cmd(fd, static_cast<int>(UBLK_U_IO_REGISTER_IO_BUF), q_id,
                          tag, 0, buf_index, 0);
}

template <typename Fd>
inline auto unregister_io_buf(Fd fd, uint16_t q_id, uint16_t tag,
                              uint64_t buf_index) noexcept {
    return detail::io_cmd(fd, static_cast<int>(UBLK_U_IO_UNREGISTER_IO_BUF),
                          q_id, tag, 0, buf_index, 0);
}

template <typename Fd>
inline auto prep_io_cmds(Fd fd, uint16_t q_id, uint16_t flags, uint16_t nr_elem,
                         uint8_t elem_bytes, const void *elems,
                         uint32_t elems_len) noexcept {
    return detail::batch_io_cmd(fd, static_cast<int>(UBLK_U_IO_PREP_IO_CMDS),
                                q_id, flags, nr_elem, elem_bytes,
                                reinterpret_cast<uint64_t>(elems), elems_len);
}

template <typename Fd>
inline auto commit_io_cmds(Fd fd, uint16_t q_id, uint16_t flags,
                           uint16_t nr_elem, uint8_t elem_bytes,
                           const void *elems, uint32_t elems_len) noexcept {
    return detail::batch_io_cmd(fd, static_cast<int>(UBLK_U_IO_COMMIT_IO_CMDS),
                                q_id, flags, nr_elem, elem_bytes,
                                reinterpret_cast<uint64_t>(elems), elems_len);
}

template <typename Fd, typename MultiShotFunc>
inline auto fetch_io_cmds(Fd fd, condy::ProvidedBufferQueue &buffers,
                          uint16_t q_id, MultiShotFunc &&func) noexcept {
    return condy::async_uring_cmd_multishot(
        static_cast<int>(UBLK_U_IO_FETCH_IO_CMDS), fd,
        [=, bgid = buffers.bgid()](io_uring_sqe *sqe) noexcept {
            auto &b = reinterpret_cast<ublk_batch_io &>(sqe->cmd);
            b = {};
            b.q_id = q_id;
            b.elem_bytes = sizeof(uint16_t);
            sqe->flags |= IOSQE_BUFFER_SELECT;
            sqe->rw_flags |= IORING_URING_CMD_MULTISHOT;
            sqe->buf_group = bgid;
        },
        condy::SelectBufferCQEHandler<condy::ProvidedBufferQueue>{&buffers},
        std::forward<MultiShotFunc>(func));
}
 
} // namespace raw
} // namespace ublk