drivers/nvme/target/nvmet.h

   1 /*
   2  * Copyright (c) 2015-2016 HGST, a Western Digital Company.
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms and conditions of the GNU General Public License,
   6  * version 2, as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  */
  13
  14 #ifndef _NVMET_H
  15 #define _NVMET_H
  16
  17 #include <linux/dma-mapping.h>
  18 #include <linux/types.h>
  19 #include <linux/device.h>
  20 #include <linux/kref.h>
  21 #include <linux/percpu-refcount.h>
  22 #include <linux/list.h>
  23 #include <linux/mutex.h>
  24 #include <linux/uuid.h>
  25 #include <linux/nvme.h>
  26 #include <linux/configfs.h>
  27 #include <linux/rcupdate.h>
  28 #include <linux/blkdev.h>
  29 #include <linux/radix-tree.h>
  30
  31 #define NVMET_ASYNC_EVENTS              4
  32 #define NVMET_ERROR_LOG_SLOTS           128
  33
  34 /*
  35  * Supported optional AENs:
  36  */
  37 #define NVMET_AEN_CFG_OPTIONAL \
  38         (NVME_AEN_CFG_NS_ATTR | NVME_AEN_CFG_ANA_CHANGE)
  39 #define NVMET_DISC_AEN_CFG_OPTIONAL \
  40         (NVME_AEN_CFG_DISC_CHANGE)
  41
  42 /*
  43  * Plus mandatory SMART AENs (we'll never send them, but allow enabling them):
  44  */
  45 #define NVMET_AEN_CFG_ALL \
  46         (NVME_SMART_CRIT_SPARE | NVME_SMART_CRIT_TEMPERATURE | \
  47          NVME_SMART_CRIT_RELIABILITY | NVME_SMART_CRIT_MEDIA | \
  48          NVME_SMART_CRIT_VOLATILE_MEMORY | NVMET_AEN_CFG_OPTIONAL)
  49
  50 /* Helper Macros when NVMe error is NVME_SC_CONNECT_INVALID_PARAM
  51  * The 16 bit shift is to set IATTR bit to 1, which means offending
  52  * offset starts in the data section of connect()
  53  */
  54 #define IPO_IATTR_CONNECT_DATA(x)       \
  55         (cpu_to_le32((1 << 16) | (offsetof(struct nvmf_connect_data, x))))
  56 #define IPO_IATTR_CONNECT_SQE(x)        \
  57         (cpu_to_le32(offsetof(struct nvmf_connect_command, x)))
  58
  59 struct nvmet_ns {
  60         struct list_head        dev_link;
  61         struct percpu_ref       ref;
  62         struct block_device     *bdev;
  63         struct file             *file;
  64         bool                    readonly;
  65         u32                     nsid;
  66         u32                     blksize_shift;
  67         loff_t                  size;
  68         u8                      nguid[16];
  69         uuid_t                  uuid;
  70         u32                     anagrpid;
  71
  72         bool                    buffered_io;
  73         bool                    enabled;
  74         struct nvmet_subsys     *subsys;
  75         const char              *device_path;
  76
  77         struct config_group     device_group;
  78         struct config_group     group;
  79
  80         struct completion       disable_done;
  81         mempool_t               *bvec_pool;
  82         struct kmem_cache       *bvec_cache;
  83
  84         int                     use_p2pmem;
  85         struct pci_dev          *p2p_dev;
  86 };
  87
  88 static inline struct nvmet_ns *to_nvmet_ns(struct config_item *item)
  89 {
  90         return container_of(to_config_group(item), struct nvmet_ns, group);
  91 }
  92
  93 static inline struct device *nvmet_ns_dev(struct nvmet_ns *ns)
  94 {
  95         return ns->bdev ? disk_to_dev(ns->bdev->bd_disk) : NULL;
  96 }
  97
  98 struct nvmet_cq {
  99         u16                     qid;
 100         u16                     size;
 101 };
 102
 103 struct nvmet_sq {
 104         struct nvmet_ctrl       *ctrl;
 105         struct percpu_ref       ref;
 106         u16                     qid;
 107         u16                     size;
 108         u32                     sqhd;
 109         struct completion       free_done;
 110         struct completion       confirm_done;
 111 };
 112
 113 struct nvmet_ana_group {
 114         struct config_group     group;
 115         struct nvmet_port       *port;
 116         u32                     grpid;
 117 };
 118
 119 static inline struct nvmet_ana_group *to_ana_group(struct config_item *item)
 120 {
 121         return container_of(to_config_group(item), struct nvmet_ana_group,
 122                         group);
 123 }
 124
 125 /**
 126  * struct nvmet_port -  Common structure to keep port
 127  *                              information for the target.
 128  * @entry:              Entry into referrals or transport list.
 129  * @disc_addr:          Address information is stored in a format defined
 130  *                              for a discovery log page entry.
 131  * @group:              ConfigFS group for this element's folder.
 132  * @priv:               Private data for the transport.
 133  */
 134 struct nvmet_port {
 135         struct list_head                entry;
 136         struct nvmf_disc_rsp_page_entry disc_addr;
 137         struct config_group             group;
 138         struct config_group             subsys_group;
 139         struct list_head                subsystems;
 140         struct config_group             referrals_group;
 141         struct list_head                referrals;
 142         struct config_group             ana_groups_group;
 143         struct nvmet_ana_group          ana_default_group;
 144         enum nvme_ana_state             *ana_state;
 145         void                            *priv;
 146         bool                            enabled;
 147         int                             inline_data_size;
 148 };
 149
 150 static inline struct nvmet_port *to_nvmet_port(struct config_item *item)
 151 {
 152         return container_of(to_config_group(item), struct nvmet_port,
 153                         group);
 154 }
 155
 156 static inline struct nvmet_port *ana_groups_to_port(
 157                 struct config_item *item)
 158 {
 159         return container_of(to_config_group(item), struct nvmet_port,
 160                         ana_groups_group);
 161 }
 162
 163 struct nvmet_ctrl {
 164         struct nvmet_subsys     *subsys;
 165         struct nvmet_cq         **cqs;
 166         struct nvmet_sq         **sqs;
 167
 168         bool                    cmd_seen;
 169
 170         struct mutex            lock;
 171         u64                     cap;
 172         u32                     cc;
 173         u32                     csts;
 174
 175         uuid_t                  hostid;
 176         u16                     cntlid;
 177         u32                     kato;
 178
 179         struct nvmet_port       *port;
 180
 181         u32                     aen_enabled;
 182         unsigned long           aen_masked;
 183         struct nvmet_req        *async_event_cmds[NVMET_ASYNC_EVENTS];
 184         unsigned int            nr_async_event_cmds;
 185         struct list_head        async_events;
 186         struct work_struct      async_event_work;
 187
 188         struct list_head        subsys_entry;
 189         struct kref             ref;
 190         struct delayed_work     ka_work;
 191         struct work_struct      fatal_err_work;
 192
 193         const struct nvmet_fabrics_ops *ops;
 194
 195         __le32                  *changed_ns_list;
 196         u32                     nr_changed_ns;
 197
 198         char                    subsysnqn[NVMF_NQN_FIELD_LEN];
 199         char                    hostnqn[NVMF_NQN_FIELD_LEN];
 200
 201         struct device *p2p_client;
 202         struct radix_tree_root p2p_ns_map;
 203 };
 204
 205 struct nvmet_subsys {
 206         enum nvme_subsys_type   type;
 207
 208         struct mutex            lock;
 209         struct kref             ref;
 210
 211         struct list_head        namespaces;
 212         unsigned int            nr_namespaces;
 213         unsigned int            max_nsid;
 214
 215         struct list_head        ctrls;
 216
 217         struct list_head        hosts;
 218         bool                    allow_any_host;
 219
 220         u16                     max_qid;
 221
 222         u64                     ver;
 223         u64                     serial;
 224         char                    *subsysnqn;
 225
 226         struct config_group     group;
 227
 228         struct config_group     namespaces_group;
 229         struct config_group     allowed_hosts_group;
 230 };
 231
 232 static inline struct nvmet_subsys *to_subsys(struct config_item *item)
 233 {
 234         return container_of(to_config_group(item), struct nvmet_subsys, group);
 235 }
 236
 237 static inline struct nvmet_subsys *namespaces_to_subsys(
 238                 struct config_item *item)
 239 {
 240         return container_of(to_config_group(item), struct nvmet_subsys,
 241                         namespaces_group);
 242 }
 243
 244 struct nvmet_host {
 245         struct config_group     group;
 246 };
 247
 248 static inline struct nvmet_host *to_host(struct config_item *item)
 249 {
 250         return container_of(to_config_group(item), struct nvmet_host, group);
 251 }
 252
 253 static inline char *nvmet_host_name(struct nvmet_host *host)
 254 {
 255         return config_item_name(&host->group.cg_item);
 256 }
 257
 258 struct nvmet_host_link {
 259         struct list_head        entry;
 260         struct nvmet_host       *host;
 261 };
 262
 263 struct nvmet_subsys_link {
 264         struct list_head        entry;
 265         struct nvmet_subsys     *subsys;
 266 };
 267
 268 struct nvmet_req;
 269 struct nvmet_fabrics_ops {
 270         struct module *owner;
 271         unsigned int type;
 272         unsigned int msdbd;
 273         bool has_keyed_sgls : 1;
 274         void (*queue_response)(struct nvmet_req *req);
 275         int (*add_port)(struct nvmet_port *port);
 276         void (*remove_port)(struct nvmet_port *port);
 277         void (*delete_ctrl)(struct nvmet_ctrl *ctrl);
 278         void (*disc_traddr)(struct nvmet_req *req,
 279                         struct nvmet_port *port, char *traddr);
 280 };
 281
 282 #define NVMET_MAX_INLINE_BIOVEC 8
 283 #define NVMET_MAX_INLINE_DATA_LEN NVMET_MAX_INLINE_BIOVEC * PAGE_SIZE
 284
 285 struct nvmet_req {
 286         struct nvme_command     *cmd;
 287         struct nvme_completion  *rsp;
 288         struct nvmet_sq         *sq;
 289         struct nvmet_cq         *cq;
 290         struct nvmet_ns         *ns;
 291         struct scatterlist      *sg;
 292         struct bio_vec          inline_bvec[NVMET_MAX_INLINE_BIOVEC];
 293         union {
 294                 struct {
 295                         struct bio      inline_bio;
 296                 } b;
 297                 struct {
 298                         bool                    mpool_alloc;
 299                         struct kiocb            iocb;
 300                         struct bio_vec          *bvec;
 301                         struct work_struct      work;
 302                 } f;
 303         };
 304         int                     sg_cnt;
 305         /* data length as parsed from the command: */
 306         size_t                  data_len;
 307         /* data length as parsed from the SGL descriptor: */
 308         size_t                  transfer_len;
 309
 310         struct nvmet_port       *port;
 311
 312         void (*execute)(struct nvmet_req *req);
 313         const struct nvmet_fabrics_ops *ops;
 314
 315         struct pci_dev *p2p_dev;
 316         struct device *p2p_client;
 317 };
 318
 319 extern struct workqueue_struct *buffered_io_wq;
 320
 321 static inline void nvmet_set_status(struct nvmet_req *req, u16 status)
 322 {
 323         req->rsp->status = cpu_to_le16(status << 1);
 324 }
 325
 326 static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
 327 {
 328         req->rsp->result.u32 = cpu_to_le32(result);
 329 }
 330
 331 /*
 332  * NVMe command writes actually are DMA reads for us on the target side.
 333  */
 334 static inline enum dma_data_direction
 335 nvmet_data_dir(struct nvmet_req *req)
 336 {
 337         return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 338 }
 339
 340 struct nvmet_async_event {
 341         struct list_head        entry;
 342         u8                      event_type;
 343         u8                      event_info;
 344         u8                      log_page;
 345 };
 346
 347 static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn)
 348 {
 349         int rae = le32_to_cpu(req->cmd->common.cdw10[0]) & 1 << 15;
 350
 351         if (!rae)
 352                 clear_bit(bn, &req->sq->ctrl->aen_masked);
 353 }
 354
 355 static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn)
 356 {
 357         if (!(READ_ONCE(ctrl->aen_enabled) & (1 << bn)))
 358                 return true;
 359         return test_and_set_bit(bn, &ctrl->aen_masked);
 360 }
 361
 362 void nvmet_get_feat_kato(struct nvmet_req *req);
 363 void nvmet_get_feat_async_event(struct nvmet_req *req);
 364 u16 nvmet_set_feat_kato(struct nvmet_req *req);
 365 u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask);
 366 void nvmet_execute_async_event(struct nvmet_req *req);
 367
 368 u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
 369 u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req);
 370 u16 nvmet_file_parse_io_cmd(struct nvmet_req *req);
 371 u16 nvmet_parse_admin_cmd(struct nvmet_req *req);
 372 u16 nvmet_parse_discovery_cmd(struct nvmet_req *req);
 373 u16 nvmet_parse_fabrics_cmd(struct nvmet_req *req);
 374
 375 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,
 376                 struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops);
 377 void nvmet_req_uninit(struct nvmet_req *req);
 378 void nvmet_req_execute(struct nvmet_req *req);
 379 void nvmet_req_complete(struct nvmet_req *req, u16 status);
 380 int nvmet_req_alloc_sgl(struct nvmet_req *req);
 381 void nvmet_req_free_sgl(struct nvmet_req *req);
 382
 383 void nvmet_execute_keep_alive(struct nvmet_req *req);
 384
 385 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid,
 386                 u16 size);
 387 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid,
 388                 u16 size);
 389 void nvmet_sq_destroy(struct nvmet_sq *sq);
 390 int nvmet_sq_init(struct nvmet_sq *sq);
 391
 392 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl);
 393
 394 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new);
 395 u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
 396                 struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp);
 397 u16 nvmet_ctrl_find_get(const char *subsysnqn, const char *hostnqn, u16 cntlid,
 398                 struct nvmet_req *req, struct nvmet_ctrl **ret);
 399 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
 400 u16 nvmet_check_ctrl_status(struct nvmet_req *req, struct nvme_command *cmd);
 401
 402 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn,
 403                 enum nvme_subsys_type type);
 404 void nvmet_subsys_put(struct nvmet_subsys *subsys);
 405 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys);
 406
 407 struct nvmet_ns *nvmet_find_namespace(struct nvmet_ctrl *ctrl, __le32 nsid);
 408 void nvmet_put_namespace(struct nvmet_ns *ns);
 409 int nvmet_ns_enable(struct nvmet_ns *ns);
 410 void nvmet_ns_disable(struct nvmet_ns *ns);
 411 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid);
 412 void nvmet_ns_free(struct nvmet_ns *ns);
 413
 414 void nvmet_send_ana_event(struct nvmet_subsys *subsys,
 415                 struct nvmet_port *port);
 416 void nvmet_port_send_ana_event(struct nvmet_port *port);
 417
 418 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops);
 419 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops);
 420
 421 int nvmet_enable_port(struct nvmet_port *port);
 422 void nvmet_disable_port(struct nvmet_port *port);
 423
 424 void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port);
 425 void nvmet_referral_disable(struct nvmet_port *port);
 426
 427 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf,
 428                 size_t len);
 429 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf,
 430                 size_t len);
 431 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len);
 432
 433 u32 nvmet_get_log_page_len(struct nvme_command *cmd);
 434
 435 #define NVMET_QUEUE_SIZE        1024
 436 #define NVMET_NR_QUEUES         128
 437 #define NVMET_MAX_CMD           NVMET_QUEUE_SIZE
 438
 439 /*
 440  * Nice round number that makes a list of nsids fit into a page.
 441  * Should become tunable at some point in the future.
 442  */
 443 #define NVMET_MAX_NAMESPACES    1024
 444
 445 /*
 446  * 0 is not a valid ANA group ID, so we start numbering at 1.
 447  *
 448  * ANA Group 1 exists without manual intervention, has namespaces assigned to it
 449  * by default, and is available in an optimized state through all ports.
 450  */
 451 #define NVMET_MAX_ANAGRPS       128
 452 #define NVMET_DEFAULT_ANA_GRPID 1
 453
 454 #define NVMET_KAS               10
 455 #define NVMET_DISC_KATO_MS              120000
 456
 457 int __init nvmet_init_configfs(void);
 458 void __exit nvmet_exit_configfs(void);
 459
 460 int __init nvmet_init_discovery(void);
 461 void nvmet_exit_discovery(void);
 462
 463 extern struct nvmet_subsys *nvmet_disc_subsys;
 464 extern u64 nvmet_genctr;
 465 extern struct rw_semaphore nvmet_config_sem;
 466
 467 extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1];
 468 extern u64 nvmet_ana_chgcnt;
 469 extern struct rw_semaphore nvmet_ana_sem;
 470
 471 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn);
 472
 473 int nvmet_bdev_ns_enable(struct nvmet_ns *ns);
 474 int nvmet_file_ns_enable(struct nvmet_ns *ns);
 475 void nvmet_bdev_ns_disable(struct nvmet_ns *ns);
 476 void nvmet_file_ns_disable(struct nvmet_ns *ns);
 477 u16 nvmet_bdev_flush(struct nvmet_req *req);
 478 u16 nvmet_file_flush(struct nvmet_req *req);
 479 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
 480
 481 static inline u32 nvmet_rw_len(struct nvmet_req *req)
 482 {
 483         return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) <<
 484                         req->ns->blksize_shift;
 485 }
 486 #endif /* _NVMET_H */