sys/netsmb/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  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _NETSMB_SMB_TRAN_H_
  30 #define _NETSMB_SMB_TRAN_H_
  31
  32 #include <sys/socket.h>
  33
  34 /*
  35  * Known transports
  36  */
  37 #define SMBT_NBTCP      1
  38
  39 /*
  40  * Transport parameters
  41  */
  42 #define SMBTP_SNDSZ     1               /* R  - int */
  43 #define SMBTP_RCVSZ     2               /* R  - int */
  44 #define SMBTP_TIMEOUT   3               /* RW - struct timespec */
  45 #define SMBTP_SELECTID  4               /* RW - (void *) */
  46 #define SMBTP_UPCALL    5               /* RW - (* void)(void *) */
  47
  48 struct smb_tran_ops;
  49
  50 struct smb_tran_desc {
  51         sa_family_t     tr_type;
  52         int     (*tr_create)(struct smb_vc *vcp, struct thread *td);
  53         int     (*tr_done)(struct smb_vc *vcp, struct thread *td);
  54         int     (*tr_bind)(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td);
  55         int     (*tr_connect)(struct smb_vc *vcp, struct sockaddr *sap, struct thread *td);
  56         int     (*tr_disconnect)(struct smb_vc *vcp, struct thread *td);
  57         int     (*tr_send)(struct smb_vc *vcp, struct mbuf *m0, struct thread *td);
  58         int     (*tr_recv)(struct smb_vc *vcp, struct mbuf **mpp, struct thread *td);
  59         void    (*tr_timo)(struct smb_vc *vcp);
  60         void    (*tr_intr)(struct smb_vc *vcp);
  61         int     (*tr_getparam)(struct smb_vc *vcp, int param, void *data);
  62         int     (*tr_setparam)(struct smb_vc *vcp, int param, void *data);
  63         int     (*tr_fatal)(struct smb_vc *vcp, int error);
  64 #ifdef notyet
  65         int     (*tr_poll)(struct smb_vc *vcp, struct thread *td);
  66         int     (*tr_cmpaddr)(void *addr1, void *addr2);
  67 #endif
  68         LIST_ENTRY(smb_tran_desc)       tr_link;
  69 };
  70
  71 #define SMB_TRAN_CREATE(vcp,p)          (vcp)->vc_tdesc->tr_create(vcp,p)
  72 #define SMB_TRAN_DONE(vcp,p)            (vcp)->vc_tdesc->tr_done(vcp,p)
  73 #define SMB_TRAN_BIND(vcp,sap,p)        (vcp)->vc_tdesc->tr_bind(vcp,sap,p)
  74 #define SMB_TRAN_CONNECT(vcp,sap,p)     (vcp)->vc_tdesc->tr_connect(vcp,sap,p)
  75 #define SMB_TRAN_DISCONNECT(vcp,p)      (vcp)->vc_tdesc->tr_disconnect(vcp,p)
  76 #define SMB_TRAN_SEND(vcp,m0,p)         (vcp)->vc_tdesc->tr_send(vcp,m0,p)
  77 #define SMB_TRAN_RECV(vcp,m,p)          (vcp)->vc_tdesc->tr_recv(vcp,m,p)
  78 #define SMB_TRAN_TIMO(vcp)              (vcp)->vc_tdesc->tr_timo(vcp)
  79 #define SMB_TRAN_INTR(vcp)              (vcp)->vc_tdesc->tr_intr(vcp)
  80 #define SMB_TRAN_GETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_getparam(vcp, par, data)
  81 #define SMB_TRAN_SETPARAM(vcp,par,data) (vcp)->vc_tdesc->tr_setparam(vcp, par, data)
  82 #define SMB_TRAN_FATAL(vcp, error)      (vcp)->vc_tdesc->tr_fatal(vcp, error)
  83
  84 #endif /* _NETSMB_SMB_TRAN_H_ */