sys/netsmb/smb_dev.h

   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 #ifndef _NETSMB_DEV_H_
  31 #define _NETSMB_DEV_H_
  32
  33 #ifndef _KERNEL
  34 #include <sys/types.h>
  35 #endif
  36 #include <sys/ioccom.h>
  37
  38 #include <netsmb/smb.h>
  39
  40 #define NSMB_NAME               "nsmb"
  41
  42 #define NSMB_VERMAJ     1
  43 #define NSMB_VERMIN     3006
  44 #define NSMB_VERSION    (NSMB_VERMAJ * 100000 + NSMB_VERMIN)
  45
  46 #define NSMBFL_OPEN             0x0001
  47
  48 #define SMBVOPT_CREATE          0x0001  /* create object if necessary */
  49 #define SMBVOPT_PRIVATE         0x0002  /* connection should be private */
  50 #define SMBVOPT_SINGLESHARE     0x0004  /* keep only one share at this VC */
  51 #define SMBVOPT_PERMANENT       0x0010  /* object will keep last reference */
  52
  53 #define SMBSOPT_CREATE          0x0001  /* create object if necessary */
  54 #define SMBSOPT_PERMANENT       0x0010  /* object will keep last reference */
  55
  56 /*
  57  * SMBIOC_LOOKUP flags
  58  */
  59 #define SMBLK_CREATE            0x0001
  60
  61 struct smbioc_ossn {
  62         int             ioc_opt;
  63         uint32_t        ioc_svlen;      /* size of ioc_server address */
  64         struct sockaddr*ioc_server;
  65         uint32_t        ioc_lolen;      /* size of ioc_local address */
  66         struct sockaddr*ioc_local;
  67         char            ioc_srvname[SMB_MAXSRVNAMELEN + 1];
  68         int             ioc_timeout;
  69         int             ioc_retrycount; /* number of retries before giveup */
  70         char            ioc_localcs[16];/* local charset */
  71         char            ioc_servercs[16];/* server charset */
  72         char            ioc_user[SMB_MAXUSERNAMELEN + 1];
  73         char            ioc_workgroup[SMB_MAXUSERNAMELEN + 1];
  74         char            ioc_password[SMB_MAXPASSWORDLEN + 1];
  75         uid_t           ioc_owner;      /* proposed owner */
  76         gid_t           ioc_group;      /* proposed group */
  77         mode_t          ioc_mode;       /* desired access mode */
  78         mode_t          ioc_rights;     /* SMBM_* */
  79 };
  80
  81 struct smbioc_oshare {
  82         int             ioc_opt;
  83         int             ioc_stype;      /* share type */
  84         char            ioc_share[SMB_MAXSHARENAMELEN + 1];
  85         char            ioc_password[SMB_MAXPASSWORDLEN + 1];
  86         uid_t           ioc_owner;      /* proposed owner of share */
  87         gid_t           ioc_group;      /* proposed group of share */
  88         mode_t          ioc_mode;       /* desired access mode to share */
  89         mode_t          ioc_rights;     /* SMBM_* */
  90 };
  91
  92 struct smbioc_rq {
  93         u_char          ioc_cmd;
  94         u_char          ioc_twc;
  95         void *          ioc_twords;
  96         u_short         ioc_tbc;
  97         void *          ioc_tbytes;
  98         int             ioc_rpbufsz;
  99         char *          ioc_rpbuf;
 100         u_char          ioc_rwc;
 101         u_short         ioc_rbc;
 102         u_int8_t        ioc_errclass;
 103         u_int16_t       ioc_serror;
 104         u_int32_t       ioc_error;
 105 };
 106
 107 struct smbioc_t2rq {
 108         u_int16_t       ioc_setup[3];
 109         int             ioc_setupcnt;
 110         char *          ioc_name;
 111         u_short         ioc_tparamcnt;
 112         void *          ioc_tparam;
 113         u_short         ioc_tdatacnt;
 114         void *          ioc_tdata;
 115         u_short         ioc_rparamcnt;
 116         void *          ioc_rparam;
 117         u_short         ioc_rdatacnt;
 118         void *          ioc_rdata;
 119 };
 120
 121 struct smbioc_flags {
 122         int             ioc_level;      /* 0 - session, 1 - share */
 123         int             ioc_mask;
 124         int             ioc_flags;
 125 };
 126
 127 struct smbioc_lookup {
 128         int             ioc_level;
 129         int             ioc_flags;
 130         struct smbioc_ossn      ioc_ssn;
 131         struct smbioc_oshare    ioc_sh;
 132 };
 133
 134 struct smbioc_rw {
 135         smbfh   ioc_fh;
 136         char *  ioc_base;
 137         off_t   ioc_offset;
 138         int     ioc_cnt;
 139 };
 140
 141 /*
 142  * Device IOCTLs
 143  */
 144 #define SMBIOC_OPENSESSION      _IOW('n',  100, struct smbioc_ossn)
 145 #define SMBIOC_OPENSHARE        _IOW('n',  101, struct smbioc_oshare)
 146 #define SMBIOC_REQUEST          _IOWR('n', 102, struct smbioc_rq)
 147 #define SMBIOC_T2RQ             _IOWR('n', 103, struct smbioc_t2rq)
 148 #define SMBIOC_SETFLAGS         _IOW('n',  104, struct smbioc_flags)
 149 #define SMBIOC_LOOKUP           _IOW('n',  106, struct smbioc_lookup)
 150 #define SMBIOC_READ             _IOWR('n', 107, struct smbioc_rw)
 151 #define SMBIOC_WRITE            _IOWR('n', 108, struct smbioc_rw)
 152
 153 #ifdef _KERNEL
 154
 155 #define SMBST_CONNECTED 1
 156
 157 STAILQ_HEAD(smbrqh, smb_rq);
 158
 159 struct smb_dev {
 160         struct cdev *   dev;
 161         int             sd_opened;
 162         int             sd_level;
 163         struct smb_vc * sd_vc;          /* reference to VC */
 164         struct smb_share *sd_share;     /* reference to share if any */
 165         int             sd_poll;
 166         int             sd_seq;
 167         int             sd_flags;
 168         int             refcount;
 169         int             usecount;
 170 };
 171
 172 extern struct sx smb_lock;
 173 #define SMB_LOCK()              sx_xlock(&smb_lock)
 174 #define SMB_UNLOCK()            sx_unlock(&smb_lock)
 175 #define SMB_LOCKASSERT()        sx_assert(&smb_lock, SA_XLOCKED)
 176
 177 struct smb_cred;
 178
 179 void sdp_dtor(void *arg);
 180 void sdp_trydestroy(struct smb_dev *dev);
 181
 182 /*
 183  * Compound user interface
 184  */
 185 int  smb_usr_lookup(struct smbioc_lookup *dp, struct smb_cred *scred,
 186         struct smb_vc **vcpp, struct smb_share **sspp);
 187 int  smb_usr_opensession(struct smbioc_ossn *data,
 188         struct smb_cred *scred, struct smb_vc **vcpp);
 189 int  smb_usr_openshare(struct smb_vc *vcp, struct smbioc_oshare *data,
 190         struct smb_cred *scred, struct smb_share **sspp);
 191 int  smb_usr_simplerequest(struct smb_share *ssp, struct smbioc_rq *data,
 192         struct smb_cred *scred);
 193 int  smb_usr_t2request(struct smb_share *ssp, struct smbioc_t2rq *data,
 194         struct smb_cred *scred);
 195 int  smb_dev2share(int fd, int mode, struct smb_cred *scred,
 196         struct smb_share **sspp, struct smb_dev **ssdp);
 197
 198
 199 #endif /* _KERNEL */
 200
 201 #endif /* _NETSMB_DEV_H_ */