xref: /freebsd/sys/netsmb/smb_tran.h (revision 389e4940069316fe667ffa263fa7d6390d0a960f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2000-2001 Boris Popov
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _NETSMB_SMB_TRAN_H_
32 #define	_NETSMB_SMB_TRAN_H_
33 
34 #include <sys/socket.h>
35 
36 /*
37  * Known transports
38  */
39 #define	SMBT_NBTCP	1
40 
41 /*
42  * Transport parameters
43  */
44 #define	SMBTP_SNDSZ	1		/* R  - int */
45 #define	SMBTP_RCVSZ	2		/* R  - int */
46 #define	SMBTP_TIMEOUT	3		/* RW - struct timespec */
47 #define	SMBTP_SELECTID	4		/* RW - (void *) */
48 #define SMBTP_UPCALL	5		/* RW - (* void)(void *) */
49 
50 struct smb_tran_ops;
51 
52 struct smb_tran_desc {
53 	sa_family_t	tr_type;
54 	int	(*tr_create)(struct smb_vc *vcp, struct thread *td);
55 	int	(*tr_done)(struct smb_vc *vcp, struct thread *td);
56 	int	(*tr_bind)(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td);
57 	int	(*tr_connect)(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td);
58 	int	(*tr_disconnect)(struct smb_vc *vcp, struct thread *td);
59 	int	(*tr_send)(struct smb_vc *vcp, struct mbuf *m0, struct thread *td);
60 	int	(*tr_recv)(struct smb_vc *vcp, struct mbuf **mpp, struct thread *td);
61 	void	(*tr_timo)(struct smb_vc *vcp);
62 	void	(*tr_intr)(struct smb_vc *vcp);
63 	int	(*tr_getparam)(struct smb_vc *vcp, int param, void *data);
64 	int	(*tr_setparam)(struct smb_vc *vcp, int param, void *data);
65 	int	(*tr_fatal)(struct smb_vc *vcp, int error);
66 #ifdef notyet
67 	int	(*tr_poll)(struct smb_vc *vcp, struct thread *td);
68 	int	(*tr_cmpaddr)(void *addr1, void *addr2);
69 #endif
70 	LIST_ENTRY(smb_tran_desc)	tr_link;
71 };
72 
73 #define SMB_TRAN_CREATE(vcp,p)		(vcp)->vc_tdesc->tr_create(vcp,p)
74 #define SMB_TRAN_DONE(vcp,p)		(vcp)->vc_tdesc->tr_done(vcp,p)
75 #define	SMB_TRAN_BIND(vcp,sap,p)	(vcp)->vc_tdesc->tr_bind(vcp,sap,p)
76 #define	SMB_TRAN_CONNECT(vcp,sap,p)	(vcp)->vc_tdesc->tr_connect(vcp,sap,p)
77 #define	SMB_TRAN_DISCONNECT(vcp,p)	(vcp)->vc_tdesc->tr_disconnect(vcp,p)
78 #define	SMB_TRAN_SEND(vcp,m0,p)		(vcp)->vc_tdesc->tr_send(vcp,m0,p)
79 #define	SMB_TRAN_RECV(vcp,m,p)		(vcp)->vc_tdesc->tr_recv(vcp,m,p)
80 #define	SMB_TRAN_TIMO(vcp)		(vcp)->vc_tdesc->tr_timo(vcp)
81 #define	SMB_TRAN_INTR(vcp)		(vcp)->vc_tdesc->tr_intr(vcp)
82 #define	SMB_TRAN_GETPARAM(vcp,par,data)	(vcp)->vc_tdesc->tr_getparam(vcp, par, data)
83 #define	SMB_TRAN_SETPARAM(vcp,par,data)	(vcp)->vc_tdesc->tr_setparam(vcp, par, data)
84 #define	SMB_TRAN_FATAL(vcp, error)	(vcp)->vc_tdesc->tr_fatal(vcp, error)
85 
86 #endif /* _NETSMB_SMB_TRAN_H_ */
87