ceph/src/spdk/lib/nvmf/request.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef NVMF_REQUEST_H
  35 #define NVMF_REQUEST_H
  36
  37 #include "spdk/nvmf_spec.h"
  38 #include "spdk/queue.h"
  39
  40 typedef enum _spdk_nvmf_request_exec_status {
  41         SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE,
  42         SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS,
  43 } spdk_nvmf_request_exec_status;
  44
  45 union nvmf_h2c_msg {
  46         struct spdk_nvmf_capsule_cmd                    nvmf_cmd;
  47         struct spdk_nvme_cmd                            nvme_cmd;
  48         struct spdk_nvmf_fabric_prop_set_cmd            prop_set_cmd;
  49         struct spdk_nvmf_fabric_prop_get_cmd            prop_get_cmd;
  50         struct spdk_nvmf_fabric_connect_cmd             connect_cmd;
  51 };
  52 SPDK_STATIC_ASSERT(sizeof(union nvmf_h2c_msg) == 64, "Incorrect size");
  53
  54 union nvmf_c2h_msg {
  55         struct spdk_nvme_cpl                            nvme_cpl;
  56         struct spdk_nvmf_fabric_prop_get_rsp            prop_get_rsp;
  57         struct spdk_nvmf_fabric_connect_rsp             connect_rsp;
  58 };
  59 SPDK_STATIC_ASSERT(sizeof(union nvmf_c2h_msg) == 16, "Incorrect size");
  60
  61 struct spdk_nvmf_request {
  62         struct spdk_nvmf_conn           *conn;
  63         uint32_t                        length;
  64         enum spdk_nvme_data_transfer    xfer;
  65         void                            *data;
  66         union nvmf_h2c_msg              *cmd;
  67         union nvmf_c2h_msg              *rsp;
  68         struct spdk_scsi_unmap_bdesc    *unmap_bdesc;
  69 };
  70
  71 int
  72 spdk_nvmf_request_exec(struct spdk_nvmf_request *req);
  73
  74 int spdk_nvmf_request_complete(struct spdk_nvmf_request *req);
  75
  76 #endif