sys/netsmb/smb_tran.h

   1 /*      $NetBSD: smb_tran.h,v 1.5 2005/12/11 00:06:21 elad Exp $        */
   2
   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  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *    This product includes software developed by Boris Popov.
  18  * 4. Neither the name of the author nor the names of any co-contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * FreeBSD: src/sys/netsmb/smb_tran.h,v 1.2 2001/12/02 08:47:29 bp Exp
  35  */
  36
  37 #ifndef _NETSMB_SMB_TRAN_H_
  38 #define _NETSMB_SMB_TRAN_H_
  39
  40 #ifndef _KERNEL
  41 #error not supposed to be exposed to userland.
  42 #endif /* !_KERNEL */
  43
  44 #include <sys/socket.h>
  45
  46 /*
  47  * Known transports
  48  */
  49 #define SMBT_NBTCP      1
  50
  51 /*
  52  * Transport parameters
  53  */
  54 #define SMBTP_SNDSZ     1               /* R  - int */
  55 #define SMBTP_RCVSZ     2               /* R  - int */
  56 #define SMBTP_TIMEOUT   3               /* RW - struct timespec */
  57 #define SMBTP_SELECTID  4               /* RW - (void *) */
  58
  59 struct smb_tran_ops;
  60
  61 struct smb_tran_desc {
  62         sa_family_t     tr_type;
  63         int     (*tr_create)(struct smb_vc *vcp, struct lwp *l);
  64         int     (*tr_done)(struct smb_vc *vcp, struct lwp *l);
  65         int     (*tr_bind)(struct smb_vc *vcp, struct sockaddr *sap, struct lwp *l);
  66         int     (*tr_connect)(struct smb_vc *vcp, struct sockaddr *sap, struct lwp *l);
  67         int     (*tr_disconnect)(struct smb_vc *vcp, struct lwp *l);
  68         int     (*tr_send)(struct smb_vc *vcp, struct mbuf *m0, struct lwp *l);
  69         int     (*tr_recv)(struct smb_vc *vcp, struct mbuf **mpp, struct lwp *l);
  70         void    (*tr_timo)(struct smb_vc *vcp);
  71         void    (*tr_intr)(struct smb_vc *vcp);
  72         int     (*tr_getparam)(struct smb_vc *vcp, int param, void *data);
  73         int     (*tr_setparam)(struct smb_vc *vcp, int param, void *data);
  74         int     (*tr_fatal)(struct smb_vc *vcp, int error);
  75 #ifdef notyet
  76         int     (*tr_poll)(struct smb_vc *vcp, struct lwp *l);
  77         int     (*tr_cmpaddr)(void *addr1, void *addr2);
  78 #endif
  79         LIST_ENTRY(smb_tran_desc)       tr_link;
  80 };
  81
  82 #define SMB_TRAN_CREATE(vcp,p)          (vcp)->vc_tdesc->tr_create(vcp,p)
  83 #define SMB_TRAN_DONE(vcp,p)            (vcp)->vc_tdesc->tr_done(vcp,p)
  84 #define SMB_TRAN_BIND(vcp,sap,p)        (vcp)->vc_tdesc->tr_bind(vcp,sap,p)
  85 #define SMB_TRAN_CONNECT(vcp,sap,p)     (vcp)->vc_tdesc->tr_connect(vcp,sap,p)
  86 #define SMB_TRAN_DISCONNECT(vcp,p)      (vcp)->vc_tdesc->tr_disconnect(vcp,p)
  87 #define SMB_TRAN_SEND(vcp,m0,p)         (vcp)->vc_tdesc->tr_send(vcp,m0,p)
  88 #define SMB_TRAN_RECV(vcp,m,p)          (vcp)->vc_tdesc->tr_recv(vcp,m,p)
  89 #define SMB_TRAN_TIMO(vcp)              (vcp)->vc_tdesc->tr_timo(vcp)
  90 #define SMB_TRAN_INTR(vcp)              (vcp)->vc_tdesc->tr_intr(vcp)
  91 #define SMB_TRAN_GETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_getparam(vcp, par, data)
  92 #define SMB_TRAN_SETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_setparam(vcp, par, data)
  93 #define SMB_TRAN_FATAL(vcp, error)      (vcp)->vc_tdesc->tr_fatal(vcp, error)
  94
  95 #endif /* !_NETSMB_SMB_TRAN_H_ */