drivers/nvme/host/fabrics.h

   1 /*
   2  * NVMe over Fabrics common host code.
   3  * Copyright (c) 2015-2016 HGST, a Western Digital Company.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  */
  14 #ifndef _NVME_FABRICS_H
  15 #define _NVME_FABRICS_H 1
  16
  17 #include <linux/in.h>
  18 #include <linux/inet.h>
  19
  20 #define NVMF_MIN_QUEUE_SIZE     16
  21 #define NVMF_MAX_QUEUE_SIZE     1024
  22 #define NVMF_DEF_QUEUE_SIZE     128
  23 #define NVMF_DEF_RECONNECT_DELAY        10
  24 /* default to 600 seconds of reconnect attempts before giving up */
  25 #define NVMF_DEF_CTRL_LOSS_TMO          600
  26
  27 /*
  28  * Define a host as seen by the target.  We allocate one at boot, but also
  29  * allow the override it when creating controllers.  This is both to provide
  30  * persistence of the Host NQN over multiple boots, and to allow using
  31  * multiple ones, for example in a container scenario.  Because we must not
  32  * use different Host NQNs with the same Host ID we generate a Host ID and
  33  * use this structure to keep track of the relation between the two.
  34  */
  35 struct nvmf_host {
  36         struct kref             ref;
  37         struct list_head        list;
  38         char                    nqn[NVMF_NQN_SIZE];
  39         uuid_t                  id;
  40 };
  41
  42 /**
  43  * enum nvmf_parsing_opts - used to define the sysfs parsing options used.
  44  */
  45 enum {
  46         NVMF_OPT_ERR            = 0,
  47         NVMF_OPT_TRANSPORT      = 1 << 0,
  48         NVMF_OPT_NQN            = 1 << 1,
  49         NVMF_OPT_TRADDR         = 1 << 2,
  50         NVMF_OPT_TRSVCID        = 1 << 3,
  51         NVMF_OPT_QUEUE_SIZE     = 1 << 4,
  52         NVMF_OPT_NR_IO_QUEUES   = 1 << 5,
  53         NVMF_OPT_TL_RETRY_COUNT = 1 << 6,
  54         NVMF_OPT_KATO           = 1 << 7,
  55         NVMF_OPT_HOSTNQN        = 1 << 8,
  56         NVMF_OPT_RECONNECT_DELAY = 1 << 9,
  57         NVMF_OPT_HOST_TRADDR    = 1 << 10,
  58         NVMF_OPT_CTRL_LOSS_TMO  = 1 << 11,
  59         NVMF_OPT_HOST_ID        = 1 << 12,
  60         NVMF_OPT_DUP_CONNECT    = 1 << 13,
  61         NVMF_OPT_DISABLE_SQFLOW = 1 << 14,
  62         NVMF_OPT_HDR_DIGEST     = 1 << 15,
  63         NVMF_OPT_DATA_DIGEST    = 1 << 16,
  64 };
  65
  66 /**
  67  * struct nvmf_ctrl_options - Used to hold the options specified
  68  *                            with the parsing opts enum.
  69  * @mask:       Used by the fabrics library to parse through sysfs options
  70  *              on adding a NVMe controller.
  71  * @transport:  Holds the fabric transport "technology name" (for a lack of
  72  *              better description) that will be used by an NVMe controller
  73  *              being added.
  74  * @subsysnqn:  Hold the fully qualified NQN subystem name (format defined
  75  *              in the NVMe specification, "NVMe Qualified Names").
  76  * @traddr:     The transport-specific TRADDR field for a port on the
  77  *              subsystem which is adding a controller.
  78  * @trsvcid:    The transport-specific TRSVCID field for a port on the
  79  *              subsystem which is adding a controller.
  80  * @host_traddr: A transport-specific field identifying the NVME host port
  81  *              to use for the connection to the controller.
  82  * @queue_size: Number of IO queue elements.
  83  * @nr_io_queues: Number of controller IO queues that will be established.
  84  * @reconnect_delay: Time between two consecutive reconnect attempts.
  85  * @discovery_nqn: indicates if the subsysnqn is the well-known discovery NQN.
  86  * @kato:       Keep-alive timeout.
  87  * @host:       Virtual NVMe host, contains the NQN and Host ID.
  88  * @max_reconnects: maximum number of allowed reconnect attempts before removing
  89  *              the controller, (-1) means reconnect forever, zero means remove
  90  *              immediately;
  91  * @disable_sqflow: disable controller sq flow control
  92  * @hdr_digest: generate/verify header digest (TCP)
  93  * @data_digest: generate/verify data digest (TCP)
  94  */
  95 struct nvmf_ctrl_options {
  96         unsigned                mask;
  97         char                    *transport;
  98         char                    *subsysnqn;
  99         char                    *traddr;
 100         char                    *trsvcid;
 101         char                    *host_traddr;
 102         size_t                  queue_size;
 103         unsigned int            nr_io_queues;
 104         unsigned int            reconnect_delay;
 105         bool                    discovery_nqn;
 106         bool                    duplicate_connect;
 107         unsigned int            kato;
 108         struct nvmf_host        *host;
 109         int                     max_reconnects;
 110         bool                    disable_sqflow;
 111         bool                    hdr_digest;
 112         bool                    data_digest;
 113 };
 114
 115 /*
 116  * struct nvmf_transport_ops - used to register a specific
 117  *                             fabric implementation of NVMe fabrics.
 118  * @entry:              Used by the fabrics library to add the new
 119  *                      registration entry to its linked-list internal tree.
 120  * @module:             Transport module reference
 121  * @name:               Name of the NVMe fabric driver implementation.
 122  * @required_opts:      sysfs command-line options that must be specified
 123  *                      when adding a new NVMe controller.
 124  * @allowed_opts:       sysfs command-line options that can be specified
 125  *                      when adding a new NVMe controller.
 126  * @create_ctrl():      function pointer that points to a non-NVMe
 127  *                      implementation-specific fabric technology
 128  *                      that would go into starting up that fabric
 129  *                      for the purpose of conneciton to an NVMe controller
 130  *                      using that fabric technology.
 131  *
 132  * Notes:
 133  *      1. At minimum, 'required_opts' and 'allowed_opts' should
 134  *         be set to the same enum parsing options defined earlier.
 135  *      2. create_ctrl() must be defined (even if it does nothing)
 136  *      3. struct nvmf_transport_ops must be statically allocated in the
 137  *         modules .bss section so that a pure module_get on @module
 138  *         prevents the memory from beeing freed.
 139  */
 140 struct nvmf_transport_ops {
 141         struct list_head        entry;
 142         struct module           *module;
 143         const char              *name;
 144         int                     required_opts;
 145         int                     allowed_opts;
 146         struct nvme_ctrl        *(*create_ctrl)(struct device *dev,
 147                                         struct nvmf_ctrl_options *opts);
 148 };
 149
 150 static inline bool
 151 nvmf_ctlr_matches_baseopts(struct nvme_ctrl *ctrl,
 152                         struct nvmf_ctrl_options *opts)
 153 {
 154         if (ctrl->state == NVME_CTRL_DELETING ||
 155             ctrl->state == NVME_CTRL_DEAD ||
 156             strcmp(opts->subsysnqn, ctrl->opts->subsysnqn) ||
 157             strcmp(opts->host->nqn, ctrl->opts->host->nqn) ||
 158             memcmp(&opts->host->id, &ctrl->opts->host->id, sizeof(uuid_t)))
 159                 return false;
 160
 161         return true;
 162 }
 163
 164 int nvmf_reg_read32(struct nvme_ctrl *ctrl, u32 off, u32 *val);
 165 int nvmf_reg_read64(struct nvme_ctrl *ctrl, u32 off, u64 *val);
 166 int nvmf_reg_write32(struct nvme_ctrl *ctrl, u32 off, u32 val);
 167 int nvmf_connect_admin_queue(struct nvme_ctrl *ctrl);
 168 int nvmf_connect_io_queue(struct nvme_ctrl *ctrl, u16 qid);
 169 int nvmf_register_transport(struct nvmf_transport_ops *ops);
 170 void nvmf_unregister_transport(struct nvmf_transport_ops *ops);
 171 void nvmf_free_options(struct nvmf_ctrl_options *opts);
 172 int nvmf_get_address(struct nvme_ctrl *ctrl, char *buf, int size);
 173 bool nvmf_should_reconnect(struct nvme_ctrl *ctrl);
 174 blk_status_t nvmf_fail_nonready_command(struct nvme_ctrl *ctrl,
 175                 struct request *rq);
 176 bool __nvmf_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
 177                 bool queue_live);
 178 bool nvmf_ip_options_match(struct nvme_ctrl *ctrl,
 179                 struct nvmf_ctrl_options *opts);
 180
 181 static inline bool nvmf_check_ready(struct nvme_ctrl *ctrl, struct request *rq,
 182                 bool queue_live)
 183 {
 184         if (likely(ctrl->state == NVME_CTRL_LIVE ||
 185                    ctrl->state == NVME_CTRL_ADMIN_ONLY))
 186                 return true;
 187         return __nvmf_check_ready(ctrl, rq, queue_live);
 188 }
 189
 190 #endif /* _NVME_FABRICS_H */