1009ea47eSEdward Tomasz Napierala /*- 2718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3718cf2ccSPedro F. Giffuni * 4009ea47eSEdward Tomasz Napierala * Copyright (c) 2012 The FreeBSD Foundation 5009ea47eSEdward Tomasz Napierala * All rights reserved. 6009ea47eSEdward Tomasz Napierala * 7009ea47eSEdward Tomasz Napierala * This software was developed by Edward Tomasz Napierala under sponsorship 8009ea47eSEdward Tomasz Napierala * from the FreeBSD Foundation. 9009ea47eSEdward Tomasz Napierala * 10009ea47eSEdward Tomasz Napierala * Redistribution and use in source and binary forms, with or without 11009ea47eSEdward Tomasz Napierala * modification, are permitted provided that the following conditions 12009ea47eSEdward Tomasz Napierala * are met: 13009ea47eSEdward Tomasz Napierala * 1. Redistributions of source code must retain the above copyright 14009ea47eSEdward Tomasz Napierala * notice, this list of conditions and the following disclaimer. 15009ea47eSEdward Tomasz Napierala * 2. Redistributions in binary form must reproduce the above copyright 16009ea47eSEdward Tomasz Napierala * notice, this list of conditions and the following disclaimer in the 17009ea47eSEdward Tomasz Napierala * documentation and/or other materials provided with the distribution. 18009ea47eSEdward Tomasz Napierala * 19009ea47eSEdward Tomasz Napierala * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20009ea47eSEdward Tomasz Napierala * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21009ea47eSEdward Tomasz Napierala * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22009ea47eSEdward Tomasz Napierala * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23009ea47eSEdward Tomasz Napierala * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24009ea47eSEdward Tomasz Napierala * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25009ea47eSEdward Tomasz Napierala * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26009ea47eSEdward Tomasz Napierala * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27009ea47eSEdward Tomasz Napierala * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28009ea47eSEdward Tomasz Napierala * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29009ea47eSEdward Tomasz Napierala * SUCH DAMAGE. 30009ea47eSEdward Tomasz Napierala * 31009ea47eSEdward Tomasz Napierala * $FreeBSD$ 32009ea47eSEdward Tomasz Napierala */ 33009ea47eSEdward Tomasz Napierala 34009ea47eSEdward Tomasz Napierala #ifndef ICL_H 35009ea47eSEdward Tomasz Napierala #define ICL_H 36009ea47eSEdward Tomasz Napierala 37009ea47eSEdward Tomasz Napierala /* 38009ea47eSEdward Tomasz Napierala * iSCSI Common Layer. It's used by both the initiator and target to send 39009ea47eSEdward Tomasz Napierala * and receive iSCSI PDUs. 40009ea47eSEdward Tomasz Napierala */ 41009ea47eSEdward Tomasz Napierala 42321b17ecSEdward Tomasz Napierala #include <sys/types.h> 43321b17ecSEdward Tomasz Napierala #include <sys/kobj.h> 44321b17ecSEdward Tomasz Napierala #include <sys/condvar.h> 45321b17ecSEdward Tomasz Napierala #include <sys/sysctl.h> 46321b17ecSEdward Tomasz Napierala 47321b17ecSEdward Tomasz Napierala SYSCTL_DECL(_kern_icl); 48321b17ecSEdward Tomasz Napierala 49321b17ecSEdward Tomasz Napierala extern int icl_debug; 50321b17ecSEdward Tomasz Napierala 51321b17ecSEdward Tomasz Napierala #define ICL_DEBUG(X, ...) \ 52321b17ecSEdward Tomasz Napierala do { \ 53321b17ecSEdward Tomasz Napierala if (icl_debug > 1) \ 54321b17ecSEdward Tomasz Napierala printf("%s: " X "\n", __func__, ## __VA_ARGS__);\ 55321b17ecSEdward Tomasz Napierala } while (0) 56321b17ecSEdward Tomasz Napierala 57321b17ecSEdward Tomasz Napierala #define ICL_WARN(X, ...) \ 58321b17ecSEdward Tomasz Napierala do { \ 59321b17ecSEdward Tomasz Napierala if (icl_debug > 0) { \ 60321b17ecSEdward Tomasz Napierala printf("WARNING: %s: " X "\n", \ 61321b17ecSEdward Tomasz Napierala __func__, ## __VA_ARGS__); \ 62321b17ecSEdward Tomasz Napierala } \ 63321b17ecSEdward Tomasz Napierala } while (0) 64321b17ecSEdward Tomasz Napierala 65009ea47eSEdward Tomasz Napierala struct icl_conn; 66321b17ecSEdward Tomasz Napierala struct ccb_scsiio; 67321b17ecSEdward Tomasz Napierala union ctl_io; 68009ea47eSEdward Tomasz Napierala 69009ea47eSEdward Tomasz Napierala struct icl_pdu { 7016c158a5SEdward Tomasz Napierala STAILQ_ENTRY(icl_pdu) ip_next; 71009ea47eSEdward Tomasz Napierala struct icl_conn *ip_conn; 72009ea47eSEdward Tomasz Napierala struct iscsi_bhs *ip_bhs; 73009ea47eSEdward Tomasz Napierala struct mbuf *ip_bhs_mbuf; 74009ea47eSEdward Tomasz Napierala size_t ip_ahs_len; 75009ea47eSEdward Tomasz Napierala struct mbuf *ip_ahs_mbuf; 76009ea47eSEdward Tomasz Napierala size_t ip_data_len; 77009ea47eSEdward Tomasz Napierala struct mbuf *ip_data_mbuf; 78009ea47eSEdward Tomasz Napierala 79009ea47eSEdward Tomasz Napierala /* 80009ea47eSEdward Tomasz Napierala * User (initiator or provider) private fields. 81009ea47eSEdward Tomasz Napierala */ 829a4510acSAlexander Motin void *ip_prv0; 839a4510acSAlexander Motin void *ip_prv1; 84009ea47eSEdward Tomasz Napierala }; 85009ea47eSEdward Tomasz Napierala 86009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_INVALID 0 87009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_BHS 1 88009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_AHS 2 89009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_HEADER_DIGEST 3 90009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_DATA 4 91009ea47eSEdward Tomasz Napierala #define ICL_CONN_STATE_DATA_DIGEST 5 92009ea47eSEdward Tomasz Napierala 93009ea47eSEdward Tomasz Napierala #define ICL_MAX_DATA_SEGMENT_LENGTH (128 * 1024) 94009ea47eSEdward Tomasz Napierala 959a4510acSAlexander Motin #define ICL_NOCOPY (1 << 30) 969a4510acSAlexander Motin 97009ea47eSEdward Tomasz Napierala struct icl_conn { 98321b17ecSEdward Tomasz Napierala KOBJ_FIELDS; 996ed8f5d2SEdward Tomasz Napierala struct mtx *ic_lock; 100009ea47eSEdward Tomasz Napierala struct socket *ic_socket; 101717f4815SEdward Tomasz Napierala #ifdef DIAGNOSTIC 102009ea47eSEdward Tomasz Napierala volatile u_int ic_outstanding_pdus; 103717f4815SEdward Tomasz Napierala #endif 10416c158a5SEdward Tomasz Napierala STAILQ_HEAD(, icl_pdu) ic_to_send; 105c485ab14SEdward Tomasz Napierala bool ic_check_send_space; 106009ea47eSEdward Tomasz Napierala size_t ic_receive_len; 107009ea47eSEdward Tomasz Napierala int ic_receive_state; 108009ea47eSEdward Tomasz Napierala struct icl_pdu *ic_receive_pdu; 109009ea47eSEdward Tomasz Napierala struct cv ic_send_cv; 110009ea47eSEdward Tomasz Napierala struct cv ic_receive_cv; 111009ea47eSEdward Tomasz Napierala bool ic_header_crc32c; 112009ea47eSEdward Tomasz Napierala bool ic_data_crc32c; 113009ea47eSEdward Tomasz Napierala bool ic_send_running; 114009ea47eSEdward Tomasz Napierala bool ic_receive_running; 115009ea47eSEdward Tomasz Napierala size_t ic_max_data_segment_length; 116b218ca6fSEdward Tomasz Napierala size_t ic_maxtags; 117009ea47eSEdward Tomasz Napierala bool ic_disconnecting; 118009ea47eSEdward Tomasz Napierala bool ic_iser; 1197deb68abSEdward Tomasz Napierala bool ic_unmapped; 120ecba49ddSEdward Tomasz Napierala const char *ic_name; 12182babffbSEdward Tomasz Napierala const char *ic_offload; 122009ea47eSEdward Tomasz Napierala 123009ea47eSEdward Tomasz Napierala void (*ic_receive)(struct icl_pdu *); 124009ea47eSEdward Tomasz Napierala void (*ic_error)(struct icl_conn *); 125009ea47eSEdward Tomasz Napierala 126009ea47eSEdward Tomasz Napierala /* 127009ea47eSEdward Tomasz Napierala * User (initiator or provider) private fields. 128009ea47eSEdward Tomasz Napierala */ 129009ea47eSEdward Tomasz Napierala void *ic_prv0; 130009ea47eSEdward Tomasz Napierala }; 131009ea47eSEdward Tomasz Napierala 13297b84d34SNavdeep Parhar struct icl_drv_limits { 13397b84d34SNavdeep Parhar int idl_max_recv_data_segment_length; 13497b84d34SNavdeep Parhar int idl_max_send_data_segment_length; 13597b84d34SNavdeep Parhar int idl_max_burst_length; 13697b84d34SNavdeep Parhar int idl_first_burst_length; 13797b84d34SNavdeep Parhar int spare[4]; 13897b84d34SNavdeep Parhar }; 13997b84d34SNavdeep Parhar 1409a4510acSAlexander Motin typedef void (*icl_pdu_cb)(struct icl_pdu *, int error); 1419a4510acSAlexander Motin 142b8911594SEdward Tomasz Napierala struct icl_conn *icl_new_conn(const char *offload, bool iser, const char *name, 143321b17ecSEdward Tomasz Napierala struct mtx *lock); 14497b84d34SNavdeep Parhar int icl_limits(const char *offload, bool iser, 14597b84d34SNavdeep Parhar struct icl_drv_limits *idl); 146b8911594SEdward Tomasz Napierala int icl_register(const char *offload, bool iser, int priority, 14797b84d34SNavdeep Parhar int (*limits)(struct icl_drv_limits *), 148321b17ecSEdward Tomasz Napierala struct icl_conn *(*new_conn)(const char *, struct mtx *)); 149b8911594SEdward Tomasz Napierala int icl_unregister(const char *offload, bool rdma); 150009ea47eSEdward Tomasz Napierala 151009ea47eSEdward Tomasz Napierala #ifdef ICL_KERNEL_PROXY 152009ea47eSEdward Tomasz Napierala 153009ea47eSEdward Tomasz Napierala struct sockaddr; 154009ea47eSEdward Tomasz Napierala struct icl_listen; 155009ea47eSEdward Tomasz Napierala 156009ea47eSEdward Tomasz Napierala /* 157009ea47eSEdward Tomasz Napierala * Target part. 158009ea47eSEdward Tomasz Napierala */ 1598eab95d6SEdward Tomasz Napierala struct icl_listen *icl_listen_new(void (*accept_cb)(struct socket *, 1608eab95d6SEdward Tomasz Napierala struct sockaddr *, int)); 161009ea47eSEdward Tomasz Napierala void icl_listen_free(struct icl_listen *il); 1628cab2ed4SEdward Tomasz Napierala int icl_listen_add(struct icl_listen *il, bool rdma, 1638cab2ed4SEdward Tomasz Napierala int domain, int socktype, int protocol, 1648cab2ed4SEdward Tomasz Napierala struct sockaddr *sa, int portal_id); 165009ea47eSEdward Tomasz Napierala int icl_listen_remove(struct icl_listen *il, struct sockaddr *sa); 166009ea47eSEdward Tomasz Napierala 167009ea47eSEdward Tomasz Napierala /* 168257cbe34SEdward Tomasz Napierala * Those two are not a public API; only to be used between icl_soft.c 169257cbe34SEdward Tomasz Napierala * and icl_soft_proxy.c. 170009ea47eSEdward Tomasz Napierala */ 171f41492b0SEdward Tomasz Napierala int icl_soft_handoff_sock(struct icl_conn *ic, struct socket *so); 172f41492b0SEdward Tomasz Napierala int icl_soft_proxy_connect(struct icl_conn *ic, int domain, 173f41492b0SEdward Tomasz Napierala int socktype, int protocol, struct sockaddr *from_sa, 174f41492b0SEdward Tomasz Napierala struct sockaddr *to_sa); 175009ea47eSEdward Tomasz Napierala #endif /* ICL_KERNEL_PROXY */ 176009ea47eSEdward Tomasz Napierala #endif /* !ICL_H */ 177