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

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation. All rights reserved.
   5  *   Copyright (c) 2019 Mellanox Technologies LTD. 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 SPDK_NVMF_TRANSPORT_H
  35 #define SPDK_NVMF_TRANSPORT_H
  36
  37 #include "spdk/stdinc.h"
  38
  39 #include "spdk/nvme.h"
  40 #include "spdk/nvmf.h"
  41 #include "spdk/nvmf_transport.h"
  42
  43 uint32_t nvmf_transport_accept(struct spdk_nvmf_transport *transport);
  44
  45 void nvmf_transport_listener_discover(struct spdk_nvmf_transport *transport,
  46                                       struct spdk_nvme_transport_id *trid,
  47                                       struct spdk_nvmf_discovery_log_page_entry *entry);
  48
  49 struct spdk_nvmf_transport_poll_group *nvmf_transport_poll_group_create(
  50         struct spdk_nvmf_transport *transport);
  51 struct spdk_nvmf_transport_poll_group *nvmf_transport_get_optimal_poll_group(
  52         struct spdk_nvmf_transport *transport, struct spdk_nvmf_qpair *qpair);
  53
  54 void nvmf_transport_poll_group_destroy(struct spdk_nvmf_transport_poll_group *group);
  55
  56 int nvmf_transport_poll_group_add(struct spdk_nvmf_transport_poll_group *group,
  57                                   struct spdk_nvmf_qpair *qpair);
  58
  59 int nvmf_transport_poll_group_remove(struct spdk_nvmf_transport_poll_group *group,
  60                                      struct spdk_nvmf_qpair *qpair);
  61
  62 int nvmf_transport_poll_group_poll(struct spdk_nvmf_transport_poll_group *group);
  63
  64 int nvmf_transport_req_free(struct spdk_nvmf_request *req);
  65
  66 int nvmf_transport_req_complete(struct spdk_nvmf_request *req);
  67
  68 void nvmf_transport_qpair_fini(struct spdk_nvmf_qpair *qpair);
  69
  70 int nvmf_transport_qpair_get_peer_trid(struct spdk_nvmf_qpair *qpair,
  71                                        struct spdk_nvme_transport_id *trid);
  72
  73 int nvmf_transport_qpair_get_local_trid(struct spdk_nvmf_qpair *qpair,
  74                                         struct spdk_nvme_transport_id *trid);
  75
  76 int nvmf_transport_qpair_get_listen_trid(struct spdk_nvmf_qpair *qpair,
  77                 struct spdk_nvme_transport_id *trid);
  78
  79 void nvmf_transport_qpair_abort_request(struct spdk_nvmf_qpair *qpair,
  80                                         struct spdk_nvmf_request *req);
  81
  82 #endif /* SPDK_NVMF_TRANSPORT_H */