1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2012 The FreeBSD Foundation 5 * 6 * This software was developed by Edward Tomasz Napierala under sponsorship 7 * from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD$ 31 */ 32 33 #ifndef ICL_H 34 #define ICL_H 35 36 /* 37 * iSCSI Common Layer. It's used by both the initiator and target to send 38 * and receive iSCSI PDUs. 39 */ 40 41 #include <sys/types.h> 42 #include <sys/kobj.h> 43 #include <sys/condvar.h> 44 #include <sys/sysctl.h> 45 46 SYSCTL_DECL(_kern_icl); 47 48 extern int icl_debug; 49 50 #define ICL_DEBUG(X, ...) \ 51 do { \ 52 if (icl_debug > 1) \ 53 printf("%s: " X "\n", __func__, ## __VA_ARGS__);\ 54 } while (0) 55 56 #define ICL_WARN(X, ...) \ 57 do { \ 58 if (icl_debug > 0) { \ 59 printf("WARNING: %s: " X "\n", \ 60 __func__, ## __VA_ARGS__); \ 61 } \ 62 } while (0) 63 64 struct icl_conn; 65 struct ccb_scsiio; 66 union ctl_io; 67 68 struct icl_pdu { 69 STAILQ_ENTRY(icl_pdu) ip_next; 70 struct icl_conn *ip_conn; 71 struct iscsi_bhs *ip_bhs; 72 struct mbuf *ip_bhs_mbuf; 73 size_t ip_ahs_len; 74 struct mbuf *ip_ahs_mbuf; 75 size_t ip_data_len; 76 struct mbuf *ip_data_mbuf; 77 78 /* 79 * User (initiator or provider) private fields. 80 */ 81 void *ip_prv0; 82 void *ip_prv1; 83 }; 84 85 #define ICL_CONN_STATE_INVALID 0 86 #define ICL_CONN_STATE_BHS 1 87 #define ICL_CONN_STATE_AHS 2 88 #define ICL_CONN_STATE_HEADER_DIGEST 3 89 #define ICL_CONN_STATE_DATA 4 90 #define ICL_CONN_STATE_DATA_DIGEST 5 91 92 #define ICL_MAX_DATA_SEGMENT_LENGTH (128 * 1024) 93 94 #define ICL_NOCOPY (1 << 30) 95 96 struct icl_conn { 97 KOBJ_FIELDS; 98 struct mtx *ic_lock; 99 struct socket *ic_socket; 100 #ifdef DIAGNOSTIC 101 volatile u_int ic_outstanding_pdus; 102 #endif 103 STAILQ_HEAD(, icl_pdu) ic_to_send; 104 bool ic_check_send_space; 105 size_t ic_receive_len; 106 int ic_receive_state; 107 struct icl_pdu *ic_receive_pdu; 108 struct cv ic_send_cv; 109 struct cv ic_receive_cv; 110 bool ic_header_crc32c; 111 bool ic_data_crc32c; 112 bool ic_send_running; 113 bool ic_receive_running; 114 size_t ic_max_data_segment_length; 115 size_t ic_maxtags; 116 bool ic_disconnecting; 117 bool ic_iser; 118 bool ic_unmapped; 119 const char *ic_name; 120 const char *ic_offload; 121 122 void (*ic_receive)(struct icl_pdu *); 123 void (*ic_error)(struct icl_conn *); 124 125 /* 126 * User (initiator or provider) private fields. 127 */ 128 void *ic_prv0; 129 }; 130 131 struct icl_drv_limits { 132 int idl_max_recv_data_segment_length; 133 int idl_max_send_data_segment_length; 134 int idl_max_burst_length; 135 int idl_first_burst_length; 136 int spare[4]; 137 }; 138 139 typedef void (*icl_pdu_cb)(struct icl_pdu *, int error); 140 141 struct icl_conn *icl_new_conn(const char *offload, bool iser, const char *name, 142 struct mtx *lock); 143 int icl_limits(const char *offload, bool iser, 144 struct icl_drv_limits *idl); 145 int icl_register(const char *offload, bool iser, int priority, 146 int (*limits)(struct icl_drv_limits *), 147 struct icl_conn *(*new_conn)(const char *, struct mtx *)); 148 int icl_unregister(const char *offload, bool rdma); 149 150 #ifdef ICL_KERNEL_PROXY 151 152 struct sockaddr; 153 struct icl_listen; 154 155 /* 156 * Target part. 157 */ 158 struct icl_listen *icl_listen_new(void (*accept_cb)(struct socket *, 159 struct sockaddr *, int)); 160 void icl_listen_free(struct icl_listen *il); 161 int icl_listen_add(struct icl_listen *il, bool rdma, 162 int domain, int socktype, int protocol, 163 struct sockaddr *sa, int portal_id); 164 int icl_listen_remove(struct icl_listen *il, struct sockaddr *sa); 165 166 /* 167 * Those two are not a public API; only to be used between icl_soft.c 168 * and icl_soft_proxy.c. 169 */ 170 int icl_soft_handoff_sock(struct icl_conn *ic, struct socket *so); 171 int icl_soft_proxy_connect(struct icl_conn *ic, int domain, 172 int socktype, int protocol, struct sockaddr *from_sa, 173 struct sockaddr *to_sa); 174 #endif /* ICL_KERNEL_PROXY */ 175 #endif /* !ICL_H */ 176