ceph/src/spdk/lib/nvme/nvme_io_msg.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 /** \file
  35  * SPDK cuse
  36  */
  37
  38
  39 #ifndef SPDK_NVME_IO_MSG_H_
  40 #define SPDK_NVME_IO_MSG_H_
  41
  42 typedef void (*spdk_nvme_io_msg_fn)(struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid,
  43                                     void *arg);
  44
  45 struct spdk_nvme_io_msg {
  46         struct spdk_nvme_ctrlr  *ctrlr;
  47         uint32_t                nsid;
  48
  49         spdk_nvme_io_msg_fn     fn;
  50         void                    *arg;
  51 };
  52
  53 struct nvme_io_msg_producer {
  54         const char *name;
  55         void (*update)(struct spdk_nvme_ctrlr *ctrlr);
  56         void (*stop)(struct spdk_nvme_ctrlr *ctrlr);
  57         STAILQ_ENTRY(nvme_io_msg_producer) link;
  58 };
  59
  60 int nvme_io_msg_send(struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, spdk_nvme_io_msg_fn fn,
  61                      void *arg);
  62
  63 /**
  64  * Process IO message sent to controller from external module.
  65  *
  66  * This call process requests from the ring, send IO to an allocated qpair or
  67  * admin commands in its context. This call is non-blocking and intended to be
  68  * polled by SPDK thread to provide safe environment for NVMe request
  69  * completition sent by external module to controller.
  70  *
  71  * The caller must ensure that each controller is polled by only one thread at
  72  * a time.
  73  *
  74  * This function may be called at any point while the controller is attached to
  75  * the SPDK NVMe driver.
  76  *
  77  * \param ctrlr Opaque handle to NVMe controller.
  78  *
  79  * \return number of processed external IO messages.
  80  */
  81 int nvme_io_msg_process(struct spdk_nvme_ctrlr *ctrlr);
  82
  83 int nvme_io_msg_ctrlr_register(struct spdk_nvme_ctrlr *ctrlr,
  84                                struct nvme_io_msg_producer *io_msg_producer);
  85 void nvme_io_msg_ctrlr_unregister(struct spdk_nvme_ctrlr *ctrlr,
  86                                   struct nvme_io_msg_producer *io_msg_producer);
  87 void nvme_io_msg_ctrlr_detach(struct spdk_nvme_ctrlr *ctrlr);
  88 void nvme_io_msg_ctrlr_update(struct spdk_nvme_ctrlr *ctrlr);
  89
  90 #endif /* SPDK_NVME_IO_MSG_H_ */