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         bool                    sqhd_disabled;
 110         struct completion       free_done;
 111         struct completion       confirm_done;
 112 };
 113
 114 struct nvmet_ana_group {
 115         struct config_group     group;
 116         struct nvmet_port       *port;
 117         u32                     grpid;
 118 };
 119
 120 static inline struct nvmet_ana_group *to_ana_group(struct config_item *item)
 121 {
 122         return container_of(to_config_group(item), struct nvmet_ana_group,
 123                         group);
 124 }
 125
 126 /**
 127  * struct nvmet_port -  Common structure to keep port
 128  *                              information for the target.
 129  * @entry:              Entry into referrals or transport list.
 130  * @disc_addr:          Address information is stored in a format defined
 131  *                              for a discovery log page entry.
 132  * @group:              ConfigFS group for this element's folder.
 133  * @priv:               Private data for the transport.
 134  */
 135 struct nvmet_port {
 136         struct list_head                entry;
 137         struct nvmf_disc_rsp_page_entry disc_addr;
 138         struct config_group             group;
 139         struct config_group             subsys_group;
 140         struct list_head                subsystems;
 141         struct config_group             referrals_group;
 142         struct list_head                referrals;
 143         struct list_head                global_entry;
 144         struct config_group             ana_groups_group;
 145         struct nvmet_ana_group          ana_default_group;
 146         enum nvme_ana_state             *ana_state;
 147         void                            *priv;
 148         bool                            enabled;
 149         int                             inline_data_size;
 150 };
 151
 152 static inline struct nvmet_port *to_nvmet_port(struct config_item *item)
 153 {
 154         return container_of(to_config_group(item), struct nvmet_port,
 155                         group);
 156 }
 157
 158 static inline struct nvmet_port *ana_groups_to_port(
 159                 struct config_item *item)
 160 {
 161         return container_of(to_config_group(item), struct nvmet_port,
 162                         ana_groups_group);
 163 }
 164
 165 struct nvmet_ctrl {
 166         struct nvmet_subsys     *subsys;
 167         struct nvmet_cq         **cqs;
 168         struct nvmet_sq         **sqs;
 169
 170         bool                    cmd_seen;
 171
 172         struct mutex            lock;
 173         u64                     cap;
 174         u32                     cc;
 175         u32                     csts;
 176
 177         uuid_t                  hostid;
 178         u16                     cntlid;
 179         u32                     kato;
 180
 181         struct nvmet_port       *port;
 182
 183         u32                     aen_enabled;
 184         unsigned long           aen_masked;
 185         struct nvmet_req        *async_event_cmds[NVMET_ASYNC_EVENTS];
 186         unsigned int            nr_async_event_cmds;
 187         struct list_head        async_events;
 188         struct work_struct      async_event_work;
 189
 190         struct list_head        subsys_entry;
 191         struct kref             ref;
 192         struct delayed_work     ka_work;
 193         struct work_struct      fatal_err_work;
 194
 195         const struct nvmet_fabrics_ops *ops;
 196
 197         __le32                  *changed_ns_list;
 198         u32                     nr_changed_ns;
 199
 200         char                    subsysnqn[NVMF_NQN_FIELD_LEN];
 201         char                    hostnqn[NVMF_NQN_FIELD_LEN];
 202
 203         struct device           *p2p_client;
 204         struct radix_tree_root  p2p_ns_map;
 205 };
 206
 207 struct nvmet_subsys {
 208         enum nvme_subsys_type   type;
 209
 210         struct mutex            lock;
 211         struct kref             ref;
 212
 213         struct list_head        namespaces;
 214         unsigned int            nr_namespaces;
 215         unsigned int            max_nsid;
 216
 217         struct list_head        ctrls;
 218
 219         struct list_head        hosts;
 220         bool                    allow_any_host;
 221
 222         u16                     max_qid;
 223
 224         u64                     ver;
 225         u64                     serial;
 226         char                    *subsysnqn;
 227
 228         struct config_group     group;
 229
 230         struct config_group     namespaces_group;
 231         struct config_group     allowed_hosts_group;
 232 };
 233
 234 static inline struct nvmet_subsys *to_subsys(struct config_item *item)
 235 {
 236         return container_of(to_config_group(item), struct nvmet_subsys, group);
 237 }
 238
 239 static inline struct nvmet_subsys *namespaces_to_subsys(
 240                 struct config_item *item)
 241 {
 242         return container_of(to_config_group(item), struct nvmet_subsys,
 243                         namespaces_group);
 244 }
 245
 246 struct nvmet_host {
 247         struct config_group     group;
 248 };
 249
 250 static inline struct nvmet_host *to_host(struct config_item *item)
 251 {
 252         return container_of(to_config_group(item), struct nvmet_host, group);
 253 }
 254
 255 static inline char *nvmet_host_name(struct nvmet_host *host)
 256 {
 257         return config_item_name(&host->group.cg_item);
 258 }
 259
 260 struct nvmet_host_link {
 261         struct list_head        entry;
 262         struct nvmet_host       *host;
 263 };
 264
 265 struct nvmet_subsys_link {
 266         struct list_head        entry;
 267         struct nvmet_subsys     *subsys;
 268 };
 269
 270 struct nvmet_req;
 271 struct nvmet_fabrics_ops {
 272         struct module *owner;
 273         unsigned int type;
 274         unsigned int msdbd;
 275         bool has_keyed_sgls : 1;
 276         void (*queue_response)(struct nvmet_req *req);
 277         int (*add_port)(struct nvmet_port *port);
 278         void (*remove_port)(struct nvmet_port *port);
 279         void (*delete_ctrl)(struct nvmet_ctrl *ctrl);
 280         void (*disc_traddr)(struct nvmet_req *req,
 281                         struct nvmet_port *port, char *traddr);
 282         u16 (*install_queue)(struct nvmet_sq *nvme_sq);
 283 };
 284
 285 #define NVMET_MAX_INLINE_BIOVEC 8
 286 #define NVMET_MAX_INLINE_DATA_LEN NVMET_MAX_INLINE_BIOVEC * PAGE_SIZE
 287
 288 struct nvmet_req {
 289         struct nvme_command     *cmd;
 290         struct nvme_completion  *rsp;
 291         struct nvmet_sq         *sq;
 292         struct nvmet_cq         *cq;
 293         struct nvmet_ns         *ns;
 294         struct scatterlist      *sg;
 295         struct bio_vec          inline_bvec[NVMET_MAX_INLINE_BIOVEC];
 296         union {
 297                 struct {
 298                         struct bio      inline_bio;
 299                 } b;
 300                 struct {
 301                         bool                    mpool_alloc;
 302                         struct kiocb            iocb;
 303                         struct bio_vec          *bvec;
 304                         struct work_struct      work;
 305                 } f;
 306         };
 307         int                     sg_cnt;
 308         /* data length as parsed from the command: */
 309         size_t                  data_len;
 310         /* data length as parsed from the SGL descriptor: */
 311         size_t                  transfer_len;
 312
 313         struct nvmet_port       *port;
 314
 315         void (*execute)(struct nvmet_req *req);
 316         const struct nvmet_fabrics_ops *ops;
 317
 318         struct pci_dev          *p2p_dev;
 319         struct device           *p2p_client;
 320 };
 321
 322 extern struct workqueue_struct *buffered_io_wq;
 323
 324 static inline void nvmet_set_status(struct nvmet_req *req, u16 status)
 325 {
 326         req->rsp->status = cpu_to_le16(status << 1);
 327 }
 328
 329 static inline void nvmet_set_result(struct nvmet_req *req, u32 result)
 330 {
 331         req->rsp->result.u32 = cpu_to_le32(result);
 332 }
 333
 334 /*
 335  * NVMe command writes actually are DMA reads for us on the target side.
 336  */
 337 static inline enum dma_data_direction
 338 nvmet_data_dir(struct nvmet_req *req)
 339 {
 340         return nvme_is_write(req->cmd) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 341 }
 342
 343 struct nvmet_async_event {
 344         struct list_head        entry;
 345         u8                      event_type;
 346         u8                      event_info;
 347         u8                      log_page;
 348 };
 349
 350 static inline void nvmet_clear_aen_bit(struct nvmet_req *req, u32 bn)
 351 {
 352         int rae = le32_to_cpu(req->cmd->common.cdw10[0]) & 1 << 15;
 353
 354         if (!rae)
 355                 clear_bit(bn, &req->sq->ctrl->aen_masked);
 356 }
 357
 358 static inline bool nvmet_aen_bit_disabled(struct nvmet_ctrl *ctrl, u32 bn)
 359 {
 360         if (!(READ_ONCE(ctrl->aen_enabled) & (1 << bn)))
 361                 return true;
 362         return test_and_set_bit(bn, &ctrl->aen_masked);
 363 }
 364
 365 void nvmet_get_feat_kato(struct nvmet_req *req);
 366 void nvmet_get_feat_async_event(struct nvmet_req *req);
 367 u16 nvmet_set_feat_kato(struct nvmet_req *req);
 368 u16 nvmet_set_feat_async_event(struct nvmet_req *req, u32 mask);
 369 void nvmet_execute_async_event(struct nvmet_req *req);
 370
 371 u16 nvmet_parse_connect_cmd(struct nvmet_req *req);
 372 u16 nvmet_bdev_parse_io_cmd(struct nvmet_req *req);
 373 u16 nvmet_file_parse_io_cmd(struct nvmet_req *req);
 374 u16 nvmet_parse_admin_cmd(struct nvmet_req *req);
 375 u16 nvmet_parse_discovery_cmd(struct nvmet_req *req);
 376 u16 nvmet_parse_fabrics_cmd(struct nvmet_req *req);
 377
 378 bool nvmet_req_init(struct nvmet_req *req, struct nvmet_cq *cq,
 379                 struct nvmet_sq *sq, const struct nvmet_fabrics_ops *ops);
 380 void nvmet_req_uninit(struct nvmet_req *req);
 381 void nvmet_req_execute(struct nvmet_req *req);
 382 void nvmet_req_complete(struct nvmet_req *req, u16 status);
 383 int nvmet_req_alloc_sgl(struct nvmet_req *req);
 384 void nvmet_req_free_sgl(struct nvmet_req *req);
 385
 386 void nvmet_execute_keep_alive(struct nvmet_req *req);
 387
 388 void nvmet_cq_setup(struct nvmet_ctrl *ctrl, struct nvmet_cq *cq, u16 qid,
 389                 u16 size);
 390 void nvmet_sq_setup(struct nvmet_ctrl *ctrl, struct nvmet_sq *sq, u16 qid,
 391                 u16 size);
 392 void nvmet_sq_destroy(struct nvmet_sq *sq);
 393 int nvmet_sq_init(struct nvmet_sq *sq);
 394
 395 void nvmet_ctrl_fatal_error(struct nvmet_ctrl *ctrl);
 396
 397 void nvmet_update_cc(struct nvmet_ctrl *ctrl, u32 new);
 398 u16 nvmet_alloc_ctrl(const char *subsysnqn, const char *hostnqn,
 399                 struct nvmet_req *req, u32 kato, struct nvmet_ctrl **ctrlp);
 400 u16 nvmet_ctrl_find_get(const char *subsysnqn, const char *hostnqn, u16 cntlid,
 401                 struct nvmet_req *req, struct nvmet_ctrl **ret);
 402 void nvmet_ctrl_put(struct nvmet_ctrl *ctrl);
 403 u16 nvmet_check_ctrl_status(struct nvmet_req *req, struct nvme_command *cmd);
 404
 405 struct nvmet_subsys *nvmet_subsys_alloc(const char *subsysnqn,
 406                 enum nvme_subsys_type type);
 407 void nvmet_subsys_put(struct nvmet_subsys *subsys);
 408 void nvmet_subsys_del_ctrls(struct nvmet_subsys *subsys);
 409
 410 struct nvmet_ns *nvmet_find_namespace(struct nvmet_ctrl *ctrl, __le32 nsid);
 411 void nvmet_put_namespace(struct nvmet_ns *ns);
 412 int nvmet_ns_enable(struct nvmet_ns *ns);
 413 void nvmet_ns_disable(struct nvmet_ns *ns);
 414 struct nvmet_ns *nvmet_ns_alloc(struct nvmet_subsys *subsys, u32 nsid);
 415 void nvmet_ns_free(struct nvmet_ns *ns);
 416
 417 void nvmet_send_ana_event(struct nvmet_subsys *subsys,
 418                 struct nvmet_port *port);
 419 void nvmet_port_send_ana_event(struct nvmet_port *port);
 420
 421 int nvmet_register_transport(const struct nvmet_fabrics_ops *ops);
 422 void nvmet_unregister_transport(const struct nvmet_fabrics_ops *ops);
 423
 424 int nvmet_enable_port(struct nvmet_port *port);
 425 void nvmet_disable_port(struct nvmet_port *port);
 426
 427 void nvmet_referral_enable(struct nvmet_port *parent, struct nvmet_port *port);
 428 void nvmet_referral_disable(struct nvmet_port *parent, struct nvmet_port *port);
 429
 430 u16 nvmet_copy_to_sgl(struct nvmet_req *req, off_t off, const void *buf,
 431                 size_t len);
 432 u16 nvmet_copy_from_sgl(struct nvmet_req *req, off_t off, void *buf,
 433                 size_t len);
 434 u16 nvmet_zero_sgl(struct nvmet_req *req, off_t off, size_t len);
 435
 436 u32 nvmet_get_log_page_len(struct nvme_command *cmd);
 437
 438 extern struct list_head *nvmet_ports;
 439 void nvmet_port_disc_changed(struct nvmet_port *port,
 440                 struct nvmet_subsys *subsys);
 441 void nvmet_subsys_disc_changed(struct nvmet_subsys *subsys,
 442                 struct nvmet_host *host);
 443 void nvmet_add_async_event(struct nvmet_ctrl *ctrl, u8 event_type,
 444                 u8 event_info, u8 log_page);
 445
 446 #define NVMET_QUEUE_SIZE        1024
 447 #define NVMET_NR_QUEUES         128
 448 #define NVMET_MAX_CMD           NVMET_QUEUE_SIZE
 449
 450 /*
 451  * Nice round number that makes a list of nsids fit into a page.
 452  * Should become tunable at some point in the future.
 453  */
 454 #define NVMET_MAX_NAMESPACES    1024
 455
 456 /*
 457  * 0 is not a valid ANA group ID, so we start numbering at 1.
 458  *
 459  * ANA Group 1 exists without manual intervention, has namespaces assigned to it
 460  * by default, and is available in an optimized state through all ports.
 461  */
 462 #define NVMET_MAX_ANAGRPS       128
 463 #define NVMET_DEFAULT_ANA_GRPID 1
 464
 465 #define NVMET_KAS               10
 466 #define NVMET_DISC_KATO_MS              120000
 467
 468 int __init nvmet_init_configfs(void);
 469 void __exit nvmet_exit_configfs(void);
 470
 471 int __init nvmet_init_discovery(void);
 472 void nvmet_exit_discovery(void);
 473
 474 extern struct nvmet_subsys *nvmet_disc_subsys;
 475 extern struct rw_semaphore nvmet_config_sem;
 476
 477 extern u32 nvmet_ana_group_enabled[NVMET_MAX_ANAGRPS + 1];
 478 extern u64 nvmet_ana_chgcnt;
 479 extern struct rw_semaphore nvmet_ana_sem;
 480
 481 bool nvmet_host_allowed(struct nvmet_subsys *subsys, const char *hostnqn);
 482
 483 int nvmet_bdev_ns_enable(struct nvmet_ns *ns);
 484 int nvmet_file_ns_enable(struct nvmet_ns *ns);
 485 void nvmet_bdev_ns_disable(struct nvmet_ns *ns);
 486 void nvmet_file_ns_disable(struct nvmet_ns *ns);
 487 u16 nvmet_bdev_flush(struct nvmet_req *req);
 488 u16 nvmet_file_flush(struct nvmet_req *req);
 489 void nvmet_ns_changed(struct nvmet_subsys *subsys, u32 nsid);
 490
 491 static inline u32 nvmet_rw_len(struct nvmet_req *req)
 492 {
 493         return ((u32)le16_to_cpu(req->cmd->rw.length) + 1) <<
 494                         req->ns->blksize_shift;
 495 }
 496 #endif /* _NVMET_H */