xref: /illumos-gate/usr/src/uts/common/fs/smbclnt/netsmb/smb_tran.h (revision 9c2acf00e275b6b2125a306f33cdddcc58393220)
1 /*
2  * Copyright (c) 2000-2001, Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $Id: smb_tran.h,v 1.2 2001/12/21 02:41:30 conrad Exp $
33  */
34 
35 /*
36  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
37  * Use is subject to license terms.
38  *
39  * Copyright 2018 Nexenta Systems, Inc.  All rights reserved.
40  */
41 
42 #ifndef _NETSMB_SMB_TRAN_H_
43 #define	_NETSMB_SMB_TRAN_H_
44 
45 #include <sys/socket.h>
46 #include <sys/stream.h>
47 #ifndef _KERNEL
48 struct file;
49 #endif
50 
51 /*
52  * Known transports
53  */
54 #define	SMBT_NBTCP	1
55 
56 /*
57  * Transport parameters, for tr_getparam/tr_setparam
58  */
59 #define	SMBTP_TCP_NODELAY	0x01		/* RW - int */
60 #define	SMBTP_TCP_CON_TMO	0x13		/* RW - int */
61 #define	SMBTP_KEEPALIVE		SO_KEEPALIVE	/* RW - int */
62 #define	SMBTP_SNDBUF		SO_SNDBUF	/* RW - int */
63 #define	SMBTP_RCVBUF		SO_RCVBUF	/* RW - int */
64 #define	SMBTP_RCVTIMEO		SO_RCVTIMEO	/* RW - int? */
65 
66 struct smb_tran_ops;
67 
68 struct smb_tran_desc {
69 	sa_family_t	tr_type;
70 	int	(*tr_create)(struct smb_vc *vcp, cred_t *cr);
71 	int	(*tr_done)(struct smb_vc *vcp);
72 	int	(*tr_bind)(struct smb_vc *vcp, struct sockaddr *sap);
73 	int	(*tr_unbind)(struct smb_vc *vcp);
74 	int	(*tr_connect)(struct smb_vc *vcp, struct sockaddr *sap);
75 	int	(*tr_disconnect)(struct smb_vc *vcp);
76 	int	(*tr_send)(struct smb_vc *vcp, mblk_t *m);
77 	int	(*tr_recv)(struct smb_vc *vcp, mblk_t **mpp);
78 	int	(*tr_poll)(struct smb_vc *vcp, int ticks);
79 	int	(*tr_getparam)(struct smb_vc *vcp, int param, void *data);
80 	int	(*tr_setparam)(struct smb_vc *vcp, int param, void *data);
81 	int	(*tr_fatal)(struct smb_vc *vcp, int error);
82 	LIST_ENTRY(smb_tran_desc)	tr_link;
83 };
84 typedef struct smb_tran_desc smb_tran_desc_t;
85 
86 #define	SMB_TRAN_CREATE(vcp, cr)	(vcp)->vc_tdesc->tr_create(vcp, cr)
87 #define	SMB_TRAN_DONE(vcp)		(vcp)->vc_tdesc->tr_done(vcp)
88 #define	SMB_TRAN_BIND(vcp, sap)		(vcp)->vc_tdesc->tr_bind(vcp, sap)
89 #define	SMB_TRAN_UNBIND(vcp)		(vcp)->vc_tdesc->tr_unbind(vcp)
90 #define	SMB_TRAN_CONNECT(vcp, sap)	(vcp)->vc_tdesc->tr_connect(vcp, sap)
91 #define	SMB_TRAN_DISCONNECT(vcp)	(vcp)->vc_tdesc->tr_disconnect(vcp)
92 #define	SMB_TRAN_SEND(vcp, m)		(vcp)->vc_tdesc->tr_send(vcp, m)
93 #define	SMB_TRAN_RECV(vcp, m)		(vcp)->vc_tdesc->tr_recv(vcp, m)
94 #define	SMB_TRAN_POLL(vcp, t)		(vcp)->vc_tdesc->tr_poll(vcp, t)
95 #define	SMB_TRAN_GETPARAM(vcp, par, data)	\
96 	(vcp)->vc_tdesc->tr_getparam(vcp, par, data)
97 #define	SMB_TRAN_SETPARAM(vcp, par, data)	\
98 	(vcp)->vc_tdesc->tr_setparam(vcp, par, data)
99 #define	SMB_TRAN_FATAL(vcp, error)	(vcp)->vc_tdesc->tr_fatal(vcp, error)
100 
101 /* Ops vectors for each transport. */
102 extern struct smb_tran_desc smb_tran_nbtcp_desc;
103 
104 #endif /* _NETSMB_SMB_TRAN_H_ */
105