1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2023-2024 Chelsio Communications, Inc. 5 * Written by: John Baldwin <jhb@FreeBSD.org> 6 */ 7 8 #ifndef __NVMF_VAR_H__ 9 #define __NVMF_VAR_H__ 10 11 #include <sys/_callout.h> 12 #include <sys/_eventhandler.h> 13 #include <sys/_lock.h> 14 #include <sys/_mutex.h> 15 //#include <sys/_nv.h> 16 #include <sys/_sx.h> 17 #include <sys/_task.h> 18 #include <sys/smp.h> 19 #include <sys/queue.h> 20 #include <dev/nvme/nvme.h> 21 #include <dev/nvmf/nvmf_transport.h> 22 23 struct nvmf_aer; 24 struct nvmf_capsule; 25 struct nvmf_host_qpair; 26 struct nvmf_namespace; 27 struct sysctl_oid_list; 28 29 typedef void nvmf_request_complete_t(void *, const struct nvme_completion *); 30 31 struct nvmf_softc { 32 device_t dev; 33 34 struct nvmf_host_qpair *admin; 35 struct nvmf_host_qpair **io; 36 u_int num_io_queues; 37 enum nvmf_trtype trtype; 38 39 struct cam_sim *sim; 40 struct cam_path *path; 41 struct mtx sim_mtx; 42 bool sim_disconnected; 43 bool sim_shutdown; 44 45 struct nvmf_namespace **ns; 46 47 struct nvme_controller_data *cdata; 48 uint64_t cap; 49 uint32_t vs; 50 u_int max_pending_io; 51 u_long max_xfer_size; 52 53 struct cdev *cdev; 54 55 /* 56 * Keep Alive support depends on two timers. The 'tx' timer 57 * is responsible for sending KeepAlive commands and runs at 58 * half the timeout interval. The 'rx' timer is responsible 59 * for detecting an actual timeout. 60 * 61 * For efficient support of TKAS, the host does not reschedule 62 * these timers every time new commands are scheduled. 63 * Instead, the host sets the *_traffic flags when commands 64 * are sent and received. The timeout handlers check and 65 * clear these flags. This does mean it can take up to twice 66 * the timeout time to detect an AWOL controller. 67 */ 68 bool ka_traffic; /* Using TKAS? */ 69 70 volatile int ka_active_tx_traffic; 71 struct callout ka_tx_timer; 72 sbintime_t ka_tx_sbt; 73 74 volatile int ka_active_rx_traffic; 75 struct callout ka_rx_timer; 76 sbintime_t ka_rx_sbt; 77 78 struct sx connection_lock; 79 struct task disconnect_task; 80 bool detaching; 81 82 u_int num_aer; 83 struct nvmf_aer *aer; 84 85 struct sysctl_oid_list *ioq_oid_list; 86 87 nvlist_t *rparams; 88 89 eventhandler_tag shutdown_pre_sync_eh; 90 eventhandler_tag shutdown_post_sync_eh; 91 }; 92 93 struct nvmf_request { 94 struct nvmf_host_qpair *qp; 95 struct nvmf_capsule *nc; 96 nvmf_request_complete_t *cb; 97 void *cb_arg; 98 bool aer; 99 100 STAILQ_ENTRY(nvmf_request) link; 101 }; 102 103 struct nvmf_completion_status { 104 struct nvme_completion cqe; 105 bool done; 106 bool io_done; 107 int io_error; 108 }; 109 110 static __inline struct nvmf_host_qpair * 111 nvmf_select_io_queue(struct nvmf_softc *sc) 112 { 113 u_int idx = curcpu * sc->num_io_queues / (mp_maxid + 1); 114 return (sc->io[idx]); 115 } 116 117 static __inline bool 118 nvmf_cqe_aborted(const struct nvme_completion *cqe) 119 { 120 uint16_t status; 121 122 status = le16toh(cqe->status); 123 return (NVME_STATUS_GET_SCT(status) == NVME_SCT_PATH_RELATED && 124 NVME_STATUS_GET_SC(status) == NVME_SC_COMMAND_ABORTED_BY_HOST); 125 } 126 127 static __inline void 128 nvmf_status_init(struct nvmf_completion_status *status) 129 { 130 status->done = false; 131 status->io_done = true; 132 status->io_error = 0; 133 } 134 135 static __inline void 136 nvmf_status_wait_io(struct nvmf_completion_status *status) 137 { 138 status->io_done = false; 139 } 140 141 #ifdef DRIVER_MODULE 142 extern driver_t nvme_nvmf_driver; 143 #endif 144 145 #ifdef MALLOC_DECLARE 146 MALLOC_DECLARE(M_NVMF); 147 #endif 148 149 /* If true, I/O requests will fail while the host is disconnected. */ 150 extern bool nvmf_fail_disconnect; 151 152 /* nvmf.c */ 153 void nvmf_complete(void *arg, const struct nvme_completion *cqe); 154 void nvmf_io_complete(void *arg, size_t xfered, int error); 155 void nvmf_wait_for_reply(struct nvmf_completion_status *status); 156 int nvmf_copyin_handoff(const struct nvmf_ioc_nv *nv, nvlist_t **nvlp); 157 void nvmf_disconnect(struct nvmf_softc *sc); 158 void nvmf_rescan_ns(struct nvmf_softc *sc, uint32_t nsid); 159 void nvmf_rescan_all_ns(struct nvmf_softc *sc); 160 int nvmf_passthrough_cmd(struct nvmf_softc *sc, struct nvme_pt_command *pt, 161 bool admin); 162 163 /* nvmf_aer.c */ 164 void nvmf_init_aer(struct nvmf_softc *sc); 165 int nvmf_start_aer(struct nvmf_softc *sc); 166 void nvmf_destroy_aer(struct nvmf_softc *sc); 167 168 /* nvmf_cmd.c */ 169 bool nvmf_cmd_get_property(struct nvmf_softc *sc, uint32_t offset, 170 uint8_t size, nvmf_request_complete_t *cb, void *cb_arg, int how); 171 bool nvmf_cmd_set_property(struct nvmf_softc *sc, uint32_t offset, 172 uint8_t size, uint64_t value, nvmf_request_complete_t *cb, void *cb_arg, 173 int how); 174 bool nvmf_cmd_keep_alive(struct nvmf_softc *sc, nvmf_request_complete_t *cb, 175 void *cb_arg, int how); 176 bool nvmf_cmd_identify_active_namespaces(struct nvmf_softc *sc, uint32_t id, 177 struct nvme_ns_list *nslist, nvmf_request_complete_t *req_cb, 178 void *req_cb_arg, nvmf_io_complete_t *io_cb, void *io_cb_arg, int how); 179 bool nvmf_cmd_identify_namespace(struct nvmf_softc *sc, uint32_t id, 180 struct nvme_namespace_data *nsdata, nvmf_request_complete_t *req_cb, 181 void *req_cb_arg, nvmf_io_complete_t *io_cb, void *io_cb_arg, int how); 182 bool nvmf_cmd_get_log_page(struct nvmf_softc *sc, uint32_t nsid, uint8_t lid, 183 uint64_t offset, void *buf, size_t len, nvmf_request_complete_t *req_cb, 184 void *req_cb_arg, nvmf_io_complete_t *io_cb, void *io_cb_arg, int how); 185 186 /* nvmf_ctldev.c */ 187 int nvmf_ctl_load(void); 188 void nvmf_ctl_unload(void); 189 190 /* nvmf_ns.c */ 191 struct nvmf_namespace *nvmf_init_ns(struct nvmf_softc *sc, uint32_t id, 192 const struct nvme_namespace_data *data); 193 void nvmf_disconnect_ns(struct nvmf_namespace *ns); 194 void nvmf_reconnect_ns(struct nvmf_namespace *ns); 195 void nvmf_shutdown_ns(struct nvmf_namespace *ns); 196 void nvmf_destroy_ns(struct nvmf_namespace *ns); 197 bool nvmf_update_ns(struct nvmf_namespace *ns, 198 const struct nvme_namespace_data *data); 199 200 /* nvmf_qpair.c */ 201 struct nvmf_host_qpair *nvmf_init_qp(struct nvmf_softc *sc, 202 enum nvmf_trtype trtype, const nvlist_t *nvl, const char *name, u_int qid); 203 void nvmf_shutdown_qp(struct nvmf_host_qpair *qp); 204 void nvmf_destroy_qp(struct nvmf_host_qpair *qp); 205 struct nvmf_request *nvmf_allocate_request(struct nvmf_host_qpair *qp, 206 void *sqe, nvmf_request_complete_t *cb, void *cb_arg, int how); 207 void nvmf_submit_request(struct nvmf_request *req); 208 void nvmf_free_request(struct nvmf_request *req); 209 210 /* nvmf_sim.c */ 211 int nvmf_init_sim(struct nvmf_softc *sc); 212 void nvmf_disconnect_sim(struct nvmf_softc *sc); 213 void nvmf_reconnect_sim(struct nvmf_softc *sc); 214 void nvmf_shutdown_sim(struct nvmf_softc *sc); 215 void nvmf_destroy_sim(struct nvmf_softc *sc); 216 void nvmf_sim_rescan_ns(struct nvmf_softc *sc, uint32_t id); 217 218 #endif /* !__NVMF_VAR_H__ */ 219