/* * iSER transport for the Open iSCSI Initiator & iSER transport internals * * Copyright (C) 2004 Dmitry Yusupov * Copyright (C) 2004 Alex Aizman * Copyright (C) 2005 Mike Christie * based on code maintained by [email protected] * * Copyright (c) 2004, 2005, 2006 Voltaire, Inc. All rights reserved. * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved. * Copyright (c) 2013-2014 Mellanox Technologies. All rights reserved. * * This software is available to you under a choice of one of two * licenses. You may choose to be licensed under the terms of the GNU * General Public License (GPL) Version 2, available from the file * COPYING in the main directory of this source tree, or the * OpenIB.org BSD license below: * * Redistribution and use in source and binary forms, with or * without modification, are permitted provided that the following * conditions are met: * * - Redistributions of source code must retain the above * copyright notice, this list of conditions and the following * disclaimer. * * - Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials * provided with the distribution. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef __ISCSI_ISER_H__ #define __ISCSI_ISER_H__ #include <linux/types.h> #include <linux/net.h> #include <linux/printk.h> #include <scsi/libiscsi.h> #include <scsi/scsi_transport_iscsi.h> #include <scsi/scsi_cmnd.h> #include <scsi/scsi_device.h> #include <scsi/iser.h> #include <linux/interrupt.h> #include <linux/wait.h> #include <linux/sched.h> #include <linux/list.h> #include <linux/slab.h> #include <linux/dma-mapping.h> #include <linux/mutex.h> #include <linux/mempool.h> #include <linux/uio.h> #include <linux/socket.h> #include <linux/in.h> #include <linux/in6.h> #include <rdma/ib_verbs.h> #include <rdma/rdma_cm.h> #define DRV_NAME … #define PFX … #define DRV_VER … #define iser_dbg(fmt, arg...) … #define iser_warn(fmt, arg...) … #define iser_info(fmt, arg...) … #define iser_err(fmt, arg...) … /* Default support is 512KB I/O size */ #define ISER_DEF_MAX_SECTORS … #define ISCSI_ISER_DEF_SG_TABLESIZE … /* Maximum support is 16MB I/O size */ #define ISCSI_ISER_MAX_SG_TABLESIZE … #define ISER_DEF_XMIT_CMDS_DEFAULT … #if ISCSI_DEF_XMIT_CMDS_MAX > ISER_DEF_XMIT_CMDS_DEFAULT #define ISER_DEF_XMIT_CMDS_MAX … #else #define ISER_DEF_XMIT_CMDS_MAX … #endif #define ISER_DEF_CMD_PER_LUN … /* QP settings */ /* Maximal bounds on received asynchronous PDUs */ #define ISER_MAX_RX_MISC_PDUS … #define ISER_MAX_TX_MISC_PDUS … #define ISER_QP_MAX_RECV_DTOS … /* the max TX (send) WR supported by the iSER QP is defined by * * max_send_wr = T * (1 + D) + C ; D is how many inflight dataouts we expect * * to have at max for SCSI command. The tx posting & completion handling code * * supports -EAGAIN scheme where tx is suspended till the QP has room for more * * send WR. D=8 comes from 64K/8K */ #define ISER_INFLIGHT_DATAOUTS … #define ISER_QP_MAX_REQ_DTOS … /* Max registration work requests per command */ #define ISER_MAX_REG_WR_PER_CMD … /* For Signature we don't support DATAOUTs so no need to make room for them */ #define ISER_QP_SIG_MAX_REQ_DTOS … #define ISER_GET_MAX_XMIT_CMDS(send_wr) … /* Constant PDU lengths calculations */ #define ISER_HEADERS_LEN … #define ISER_RECV_DATA_SEG_LEN … #define ISER_RX_PAYLOAD_SIZE … #define ISER_RX_LOGIN_SIZE … /* Length of an object name string */ #define ISER_OBJECT_NAME_SIZE … enum iser_conn_state { … }; enum iser_task_status { … }; enum iser_data_dir { … }; /** * struct iser_data_buf - iSER data buffer * * @sg: pointer to the sg list * @size: num entries of this sg * @data_len: total buffer byte len * @dma_nents: returned by dma_map_sg */ struct iser_data_buf { … }; /* fwd declarations */ struct iser_device; struct iscsi_iser_task; struct iscsi_endpoint; struct iser_reg_resources; /** * struct iser_mem_reg - iSER memory registration info * * @sge: memory region sg element * @rkey: memory region remote key * @desc: pointer to fast registration context */ struct iser_mem_reg { … }; enum iser_desc_type { … }; /** * struct iser_tx_desc - iSER TX descriptor * * @iser_header: iser header * @iscsi_header: iscsi header * @type: command/control/dataout * @dma_addr: header buffer dma_address * @tx_sg: sg[0] points to iser/iscsi headers * sg[1] optionally points to either of immediate data * unsolicited data-out or control * @num_sge: number sges used on this TX task * @cqe: completion handler * @mapped: Is the task header mapped * @reg_wr: registration WR * @send_wr: send WR * @inv_wr: invalidate WR */ struct iser_tx_desc { … }; #define ISER_RX_PAD_SIZE … /** * struct iser_rx_desc - iSER RX descriptor * * @iser_header: iser header * @iscsi_header: iscsi header * @data: received data segment * @dma_addr: receive buffer dma address * @rx_sg: ib_sge of receive buffer * @cqe: completion handler * @pad: for sense data TODO: Modify to maximum sense length supported */ struct iser_rx_desc { … } __packed; /** * struct iser_login_desc - iSER login descriptor * * @req: pointer to login request buffer * @rsp: pointer to login response buffer * @req_dma: DMA address of login request buffer * @rsp_dma: DMA address of login response buffer * @sge: IB sge for login post recv * @cqe: completion handler */ struct iser_login_desc { … } __packed; struct iser_conn; struct ib_conn; /** * struct iser_device - iSER device handle * * @ib_device: RDMA device * @pd: Protection Domain for this device * @event_handler: IB events handle routine * @ig_list: entry in devices list * @refcount: Reference counter, dominated by open iser connections */ struct iser_device { … }; /** * struct iser_reg_resources - Fast registration resources * * @mr: memory region * @sig_mr: signature memory region */ struct iser_reg_resources { … }; /** * struct iser_fr_desc - Fast registration descriptor * * @list: entry in connection fastreg pool * @rsc: data buffer registration resources * @sig_protected: is region protected indicator * @all_list: first and last list members */ struct iser_fr_desc { … }; /** * struct iser_fr_pool - connection fast registration pool * * @list: list of fastreg descriptors * @lock: protects fastreg pool * @size: size of the pool * @all_list: first and last list members */ struct iser_fr_pool { … }; /** * struct ib_conn - Infiniband related objects * * @cma_id: rdma_cm connection maneger handle * @qp: Connection Queue-pair * @cq: Connection completion queue * @cq_size: The number of max outstanding completions * @device: reference to iser device * @fr_pool: connection fast registration pool * @pi_support: Indicate device T10-PI support * @reg_cqe: completion handler */ struct ib_conn { … }; /** * struct iser_conn - iSER connection context * * @ib_conn: connection RDMA resources * @iscsi_conn: link to matching iscsi connection * @ep: transport handle * @state: connection logical state * @qp_max_recv_dtos: maximum number of data outs, corresponds * to max number of post recvs * @max_cmds: maximum cmds allowed for this connection * @name: connection peer portal * @release_work: deferred work for release job * @state_mutex: protects iser onnection state * @stop_completion: conn_stop completion * @ib_completion: RDMA cleanup completion * @up_completion: connection establishment completed * (state is ISER_CONN_UP) * @conn_list: entry in ig conn list * @login_desc: login descriptor * @rx_descs: rx buffers array (cyclic buffer) * @num_rx_descs: number of rx descriptors * @scsi_sg_tablesize: scsi host sg_tablesize * @pages_per_mr: maximum pages available for registration * @snd_w_inv: connection uses remote invalidation */ struct iser_conn { … }; /** * struct iscsi_iser_task - iser task context * * @desc: TX descriptor * @iser_conn: link to iser connection * @status: current task status * @sc: link to scsi command * @command_sent: indicate if command was sent * @dir: iser data direction * @rdma_reg: task rdma registration desc * @data: iser data buffer desc * @prot: iser protection buffer desc */ struct iscsi_iser_task { … }; /** * struct iser_global - iSER global context * * @device_list_mutex: protects device_list * @device_list: iser devices global list * @connlist_mutex: protects connlist * @connlist: iser connections global list * @desc_cache: kmem cache for tx dataout */ struct iser_global { … }; extern struct iser_global ig; extern int iser_debug_level; extern bool iser_pi_enable; extern unsigned int iser_max_sectors; extern bool iser_always_reg; int iser_send_control(struct iscsi_conn *conn, struct iscsi_task *task); int iser_send_command(struct iscsi_conn *conn, struct iscsi_task *task); int iser_send_data_out(struct iscsi_conn *conn, struct iscsi_task *task, struct iscsi_data *hdr); void iscsi_iser_recv(struct iscsi_conn *conn, struct iscsi_hdr *hdr, char *rx_data, int rx_data_len); void iser_conn_init(struct iser_conn *iser_conn); void iser_conn_release(struct iser_conn *iser_conn); int iser_conn_terminate(struct iser_conn *iser_conn); void iser_release_work(struct work_struct *work); void iser_err_comp(struct ib_wc *wc, const char *type); void iser_login_rsp(struct ib_cq *cq, struct ib_wc *wc); void iser_task_rsp(struct ib_cq *cq, struct ib_wc *wc); void iser_cmd_comp(struct ib_cq *cq, struct ib_wc *wc); void iser_ctrl_comp(struct ib_cq *cq, struct ib_wc *wc); void iser_dataout_comp(struct ib_cq *cq, struct ib_wc *wc); void iser_reg_comp(struct ib_cq *cq, struct ib_wc *wc); void iser_task_rdma_init(struct iscsi_iser_task *task); void iser_task_rdma_finalize(struct iscsi_iser_task *task); void iser_free_rx_descriptors(struct iser_conn *iser_conn); void iser_finalize_rdma_unaligned_sg(struct iscsi_iser_task *iser_task, struct iser_data_buf *mem, enum iser_data_dir cmd_dir); int iser_reg_mem_fastreg(struct iscsi_iser_task *task, enum iser_data_dir dir, bool all_imm); void iser_unreg_mem_fastreg(struct iscsi_iser_task *task, enum iser_data_dir dir); int iser_connect(struct iser_conn *iser_conn, struct sockaddr *src_addr, struct sockaddr *dst_addr, int non_blocking); int iser_post_recvl(struct iser_conn *iser_conn); int iser_post_recvm(struct iser_conn *iser_conn, struct iser_rx_desc *rx_desc); int iser_post_send(struct ib_conn *ib_conn, struct iser_tx_desc *tx_desc); int iser_dma_map_task_data(struct iscsi_iser_task *iser_task, enum iser_data_dir iser_dir, enum dma_data_direction dma_dir); void iser_dma_unmap_task_data(struct iscsi_iser_task *iser_task, enum iser_data_dir iser_dir, enum dma_data_direction dma_dir); int iser_initialize_task_headers(struct iscsi_task *task, struct iser_tx_desc *tx_desc); int iser_alloc_rx_descriptors(struct iser_conn *iser_conn, struct iscsi_session *session); int iser_alloc_fastreg_pool(struct ib_conn *ib_conn, unsigned cmds_max, unsigned int size); void iser_free_fastreg_pool(struct ib_conn *ib_conn); u8 iser_check_task_pi_status(struct iscsi_iser_task *iser_task, enum iser_data_dir cmd_dir, sector_t *sector); static inline struct iser_conn * to_iser_conn(struct ib_conn *ib_conn) { … } static inline struct iser_rx_desc * iser_rx(struct ib_cqe *cqe) { … } static inline struct iser_tx_desc * iser_tx(struct ib_cqe *cqe) { … } static inline struct iser_login_desc * iser_login(struct ib_cqe *cqe) { … } #endif
Codebase Browser
linux