Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / netproto / smb / smb_tran.h
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  * $FreeBSD: src/sys/netsmb/smb_tran.h,v 1.1.2.1 2001/05/22 08:32:34 bp Exp $
33  */
34
35 #ifndef _NETSMB_SMB_TRAN_H_
36 #define _NETSMB_SMB_TRAN_H_
37
38 #include <sys/socket.h>
39
40 /*
41  * Known transports
42  */
43 #define SMBT_NBTCP      1
44
45 /*
46  * Transport parameters
47  */
48 #define SMBTP_SNDSZ     1               /* R  - int */
49 #define SMBTP_RCVSZ     2               /* R  - int */
50 #define SMBTP_TIMEOUT   3               /* RW - struct timespec */
51 #define SMBTP_SELECTID  4               /* RW - (void *) */
52
53 struct smb_tran_ops;
54
55 struct smb_tran_desc {
56         sa_family_t     tr_type;
57         int     (*tr_create)(struct smb_vc *vcp, struct proc *p);
58         int     (*tr_done)(struct smb_vc *vcp, struct proc *p);
59         int     (*tr_bind)(struct smb_vc *vcp, struct sockaddr *sap, struct proc *p);
60         int     (*tr_connect)(struct smb_vc *vcp, struct sockaddr *sap, struct proc *p);
61         int     (*tr_disconnect)(struct smb_vc *vcp, struct proc *p);
62         int     (*tr_send)(struct smb_vc *vcp, struct mbuf *m0, struct proc *p);
63         int     (*tr_recv)(struct smb_vc *vcp, struct mbuf **mpp, struct proc *p);
64         void    (*tr_timo)(struct smb_vc *vcp);
65         void    (*tr_intr)(struct smb_vc *vcp);
66         int     (*tr_getparam)(struct smb_vc *vcp, int param, void *data);
67         int     (*tr_setparam)(struct smb_vc *vcp, int param, void *data);
68         int     (*tr_fatal)(struct smb_vc *vcp, int error);
69 #ifdef notyet
70         int     (*tr_poll)(struct smb_vc *vcp, struct proc *p);
71         int     (*tr_cmpaddr)(void *addr1, void *addr2);
72 #endif
73         LIST_ENTRY(smb_tran_desc)       tr_link;
74 };
75
76 #define SMB_TRAN_CREATE(vcp,p)          (vcp)->vc_tdesc->tr_create(vcp,p)
77 #define SMB_TRAN_DONE(vcp,p)            (vcp)->vc_tdesc->tr_done(vcp,p)
78 #define SMB_TRAN_BIND(vcp,sap,p)        (vcp)->vc_tdesc->tr_bind(vcp,sap,p)
79 #define SMB_TRAN_CONNECT(vcp,sap,p)     (vcp)->vc_tdesc->tr_connect(vcp,sap,p)
80 #define SMB_TRAN_DISCONNECT(vcp,p)      (vcp)->vc_tdesc->tr_disconnect(vcp,p)
81 #define SMB_TRAN_SEND(vcp,m0,p)         (vcp)->vc_tdesc->tr_send(vcp,m0,p)
82 #define SMB_TRAN_RECV(vcp,m,p)          (vcp)->vc_tdesc->tr_recv(vcp,m,p)
83 #define SMB_TRAN_TIMO(vcp)              (vcp)->vc_tdesc->tr_timo(vcp)
84 #define SMB_TRAN_INTR(vcp)              (vcp)->vc_tdesc->tr_intr(vcp)
85 #define SMB_TRAN_GETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_getparam(vcp, par, data)
86 #define SMB_TRAN_SETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_setparam(vcp, par, data)
87 #define SMB_TRAN_FATAL(vcp, error)      (vcp)->vc_tdesc->tr_fatal(vcp, error)
88
89 #endif /* _NETSMB_SMB_TRAN_H_ */