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 * When a "large" received PDU represents multiple on-the-wire 80 * PDUs, this is the count of additional on-the-wire PDUs. 81 * For PDUs that match on-the-wire PDUs, this should be set to 82 * zero. 83 */ 84 u_int ip_additional_pdus; 85 86 /* 87 * User (initiator or provider) private fields. 88 */ 89 void *ip_prv0; 90 void *ip_prv1; 91 }; 92 93 #define ICL_NOCOPY (1 << 30) 94 95 struct icl_conn { 96 KOBJ_FIELDS; 97 struct mtx *ic_lock; 98 struct socket *ic_socket; 99 #ifdef DIAGNOSTIC 100 volatile u_int ic_outstanding_pdus; 101 #endif 102 uint32_t ic_max_recv_data_segment_length; 103 uint32_t ic_max_send_data_segment_length; 104 size_t ic_hw_isomax; 105 size_t ic_maxtags; 106 bool ic_header_crc32c; 107 bool ic_data_crc32c; 108 bool ic_disconnecting; 109 bool ic_iser; 110 bool ic_unmapped; 111 const char *ic_name; 112 const char *ic_offload; 113 114 void (*ic_receive)(struct icl_pdu *); 115 void (*ic_error)(struct icl_conn *); 116 117 /* 118 * User (initiator or provider) private fields. 119 */ 120 void *ic_prv0; 121 }; 122 123 #define ICL_CONN_LOCK(X) mtx_lock(X->ic_lock) 124 #define ICL_CONN_UNLOCK(X) mtx_unlock(X->ic_lock) 125 #define ICL_CONN_LOCK_ASSERT(X) mtx_assert(X->ic_lock, MA_OWNED) 126 #define ICL_CONN_LOCK_ASSERT_NOT(X) mtx_assert(X->ic_lock, MA_NOTOWNED) 127 128 struct icl_drv_limits { 129 int idl_max_recv_data_segment_length; 130 int idl_max_send_data_segment_length; 131 int idl_max_burst_length; 132 int idl_first_burst_length; 133 int spare[4]; 134 }; 135 136 typedef void (*icl_pdu_cb)(struct icl_pdu *, int error); 137 138 struct icl_conn *icl_new_conn(const char *offload, bool iser, const char *name, 139 struct mtx *lock); 140 int icl_limits(const char *offload, bool iser, int socket, 141 struct icl_drv_limits *idl); 142 int icl_register(const char *offload, bool iser, int priority, 143 int (*limits)(struct icl_drv_limits *, int), 144 struct icl_conn *(*new_conn)(const char *, struct mtx *)); 145 int icl_unregister(const char *offload, bool rdma); 146 147 #ifdef ICL_KERNEL_PROXY 148 149 struct sockaddr; 150 struct icl_listen; 151 152 /* 153 * Target part. 154 */ 155 struct icl_listen *icl_listen_new(void (*accept_cb)(struct socket *, 156 struct sockaddr *, int)); 157 void icl_listen_free(struct icl_listen *il); 158 int icl_listen_add(struct icl_listen *il, bool rdma, 159 int domain, int socktype, int protocol, 160 struct sockaddr *sa, int portal_id); 161 int icl_listen_remove(struct icl_listen *il, struct sockaddr *sa); 162 163 /* 164 * Those two are not a public API; only to be used between icl_soft.c 165 * and icl_soft_proxy.c. 166 */ 167 int icl_soft_handoff_sock(struct icl_conn *ic, struct socket *so); 168 int icl_soft_proxy_connect(struct icl_conn *ic, int domain, 169 int socktype, int protocol, struct sockaddr *from_sa, 170 struct sockaddr *to_sa); 171 #endif /* ICL_KERNEL_PROXY */ 172 #endif /* !ICL_H */ 173