sys/netsmb/smb_rq.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_SMB_RQ_H_
  31 #define _NETSMB_SMB_RQ_H_
  32
  33 #ifndef MB_MSYSTEM
  34 #include <sys/mchain.h>
  35 #endif
  36
  37 #define SMBR_ALLOCED            0x0001  /* structure was malloced */
  38 #define SMBR_SENT               0x0002  /* request successfully transmitted */
  39 #define SMBR_REXMIT             0x0004  /* request should be retransmitted */
  40 #define SMBR_INTR               0x0008  /* request interrupted */
  41 #define SMBR_RESTART            0x0010  /* request should be repeated if possible */
  42 #define SMBR_NORESTART          0x0020  /* request is not restartable */
  43 #define SMBR_MULTIPACKET        0x0040  /* multiple packets can be sent and received */
  44 #define SMBR_INTERNAL           0x0080  /* request is internal to smbrqd */
  45 #define SMBR_XLOCK              0x0100  /* request locked and can't be moved */
  46 #define SMBR_XLOCKWANT          0x0200  /* waiter on XLOCK */
  47
  48 #define SMBT2_ALLSENT           0x0001  /* all data and params are sent */
  49 #define SMBT2_ALLRECV           0x0002  /* all data and params are received */
  50 #define SMBT2_ALLOCED           0x0004
  51 #define SMBT2_RESTART           0x0008
  52 #define SMBT2_NORESTART         0x0010
  53 #define SMBT2_SECONDARY         0x0020  /* secondary request */
  54
  55 #define SMBRQ_SLOCK(rqp)        smb_sl_lock(&(rqp)->sr_slock)
  56 #define SMBRQ_SUNLOCK(rqp)      smb_sl_unlock(&(rqp)->sr_slock)
  57 #define SMBRQ_SLOCKPTR(rqp)     (&(rqp)->sr_slock)
  58
  59 enum smbrq_state {
  60         SMBRQ_NOTSENT,          /* rq have data to send */
  61         SMBRQ_SENT,             /* send procedure completed */
  62         SMBRQ_REPLYRECEIVED,
  63         SMBRQ_NOTIFIED          /* owner notified about completion */
  64 };
  65
  66 struct smb_vc;
  67 struct smb_t2rq;
  68
  69 struct smb_rq {
  70         enum smbrq_state        sr_state;
  71         struct smb_vc *         sr_vc;
  72         struct smb_share*       sr_share;
  73         u_short                 sr_mid;
  74         u_int32_t               sr_seqno;
  75         u_int32_t               sr_rseqno;
  76         struct mbchain          sr_rq;
  77         u_int8_t                sr_rqflags;
  78         u_int16_t               sr_rqflags2;
  79         u_char *                sr_wcount;
  80         void *                  sr_bcount;      /* Points to 2-byte buffer. */
  81         struct mdchain          sr_rp;
  82         int                     sr_rpgen;
  83         int                     sr_rplast;
  84         int                     sr_flags;       /* SMBR_* */
  85         int                     sr_rpsize;
  86         struct smb_cred *       sr_cred;
  87         int                     sr_timo;
  88         int                     sr_rexmit;
  89         int                     sr_sendcnt;
  90         struct timespec         sr_timesent;
  91         int                     sr_lerror;
  92         u_int8_t *              sr_rqsig;
  93         void *                  sr_rqtid;       /* Points to 2-byte buffer. */
  94         void *                  sr_rquid;       /* Points to 2-byte buffer. */
  95         u_int8_t                sr_errclass;
  96         u_int16_t               sr_serror;
  97         u_int32_t               sr_error;
  98         u_int8_t                sr_rpflags;
  99         u_int16_t               sr_rpflags2;
 100         u_int16_t               sr_rptid;
 101         u_int16_t               sr_rppid;
 102         u_int16_t               sr_rpuid;
 103         u_int16_t               sr_rpmid;
 104         struct smb_slock        sr_slock;       /* short term locks */
 105         struct smb_t2rq *       sr_t2;
 106         TAILQ_ENTRY(smb_rq)     sr_link;
 107 };
 108
 109 struct smb_t2rq {
 110         u_int16_t       t2_setupcount;
 111         u_int16_t *     t2_setupdata;
 112         u_int16_t       t2_setup[2];    /* most of rqs has setupcount of 1 */
 113         u_int8_t        t2_maxscount;   /* max setup words to return */
 114         u_int16_t       t2_maxpcount;   /* max param bytes to return */
 115         u_int16_t       t2_maxdcount;   /* max data bytes to return */
 116         u_int16_t       t2_fid;         /* for T2 request */
 117         char *          t_name;         /* for T request, should be zero for T2 */
 118         int             t2_flags;       /* SMBT2_ */
 119         struct mbchain  t2_tparam;      /* parameters to transmit */
 120         struct mbchain  t2_tdata;       /* data to transmit */
 121         struct mdchain  t2_rparam;      /* received parameters */
 122         struct mdchain  t2_rdata;       /* received data */
 123         struct smb_cred*t2_cred;
 124         struct smb_connobj *t2_source;
 125         struct smb_rq * t2_rq;
 126         struct smb_vc * t2_vc;
 127 };
 128
 129 int  smb_rq_alloc(struct smb_connobj *layer, u_char cmd,
 130         struct smb_cred *scred, struct smb_rq **rqpp);
 131 int  smb_rq_init(struct smb_rq *rqp, struct smb_connobj *layer, u_char cmd,
 132         struct smb_cred *scred);
 133 void smb_rq_done(struct smb_rq *rqp);
 134 int  smb_rq_getrequest(struct smb_rq *rqp, struct mbchain **mbpp);
 135 int  smb_rq_getreply(struct smb_rq *rqp, struct mdchain **mbpp);
 136 void smb_rq_wstart(struct smb_rq *rqp);
 137 void smb_rq_wend(struct smb_rq *rqp);
 138 void smb_rq_bstart(struct smb_rq *rqp);
 139 void smb_rq_bend(struct smb_rq *rqp);
 140 int  smb_rq_intr(struct smb_rq *rqp);
 141 int  smb_rq_simple(struct smb_rq *rqp);
 142
 143 int  smb_t2_alloc(struct smb_connobj *layer, u_short setup, struct smb_cred *scred,
 144         struct smb_t2rq **rqpp);
 145 int  smb_t2_init(struct smb_t2rq *rqp, struct smb_connobj *layer, u_short setup,
 146         struct smb_cred *scred);
 147 void smb_t2_done(struct smb_t2rq *t2p);
 148 int  smb_t2_request(struct smb_t2rq *t2p);
 149
 150 #endif /* !_NETSMB_SMB_RQ_H_ */