4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org) 2006.
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/list.h>
25 #include <linux/gfp.h>
26 #include <linux/wait.h>
27 #include <linux/net.h>
28 #include <linux/delay.h>
29 #include <linux/freezer.h>
30 #include <linux/tcp.h>
31 #include <linux/bvec.h>
32 #include <linux/highmem.h>
33 #include <linux/uaccess.h>
34 #include <asm/processor.h>
35 #include <linux/mempool.h>
36 #include <linux/signal.h>
39 #include "cifsproto.h"
40 #include "cifs_debug.h"
41 #include "smb2proto.h"
42 #include "smbdirect.h"
44 /* Max number of iovectors we can use off the stack when sending requests. */
45 #define CIFS_MAX_IOV_SIZE 8
48 cifs_wake_up_task(struct mid_q_entry *mid)
50 wake_up_process(mid->callback_data);
54 AllocMidQEntry(const struct smb_hdr *smb_buffer, struct TCP_Server_Info *server)
56 struct mid_q_entry *temp;
59 cifs_dbg(VFS, "Null TCP session in AllocMidQEntry\n");
63 temp = mempool_alloc(cifs_mid_poolp, GFP_NOFS);
64 memset(temp, 0, sizeof(struct mid_q_entry));
65 kref_init(&temp->refcount);
66 temp->mid = get_mid(smb_buffer);
67 temp->pid = current->pid;
68 temp->command = cpu_to_le16(smb_buffer->Command);
69 cifs_dbg(FYI, "For smb_command %d\n", smb_buffer->Command);
70 /* do_gettimeofday(&temp->when_sent);*/ /* easier to use jiffies */
71 /* when mid allocated can be before when sent */
72 temp->when_alloc = jiffies;
73 temp->server = server;
76 * The default is for the mid to be synchronous, so the
77 * default callback just wakes up the current task.
79 temp->callback = cifs_wake_up_task;
80 temp->callback_data = current;
82 atomic_inc(&midCount);
83 temp->mid_state = MID_REQUEST_ALLOCATED;
87 static void _cifs_mid_q_entry_release(struct kref *refcount)
89 struct mid_q_entry *mid = container_of(refcount, struct mid_q_entry,
92 mempool_free(mid, cifs_mid_poolp);
95 void cifs_mid_q_entry_release(struct mid_q_entry *midEntry)
97 spin_lock(&GlobalMid_Lock);
98 kref_put(&midEntry->refcount, _cifs_mid_q_entry_release);
99 spin_unlock(&GlobalMid_Lock);
103 DeleteMidQEntry(struct mid_q_entry *midEntry)
105 #ifdef CONFIG_CIFS_STATS2
106 __le16 command = midEntry->server->vals->lock_cmd;
109 midEntry->mid_state = MID_FREE;
110 atomic_dec(&midCount);
111 if (midEntry->large_buf)
112 cifs_buf_release(midEntry->resp_buf);
114 cifs_small_buf_release(midEntry->resp_buf);
115 #ifdef CONFIG_CIFS_STATS2
118 * commands taking longer than one second (default) can be indications
119 * that something is wrong, unless it is quite a slow link or a very
120 * busy server. Note that this calc is unlikely or impossible to wrap
121 * as long as slow_rsp_threshold is not set way above recommended max
122 * value (32767 ie 9 hours) and is generally harmless even if wrong
123 * since only affects debug counters - so leaving the calc as simple
124 * comparison rather than doing multiple conversions and overflow
127 if ((slow_rsp_threshold != 0) &&
128 time_after(now, midEntry->when_alloc + (slow_rsp_threshold * HZ)) &&
129 (midEntry->command != command)) {
131 * smb2slowcmd[NUMBER_OF_SMB2_COMMANDS] counts by command
132 * NB: le16_to_cpu returns unsigned so can not be negative below
134 if (le16_to_cpu(midEntry->command) < NUMBER_OF_SMB2_COMMANDS)
135 cifs_stats_inc(&midEntry->server->smb2slowcmd[le16_to_cpu(midEntry->command)]);
137 trace_smb3_slow_rsp(le16_to_cpu(midEntry->command),
138 midEntry->mid, midEntry->pid,
139 midEntry->when_sent, midEntry->when_received);
140 if (cifsFYI & CIFS_TIMER) {
141 pr_debug(" CIFS slow rsp: cmd %d mid %llu",
142 midEntry->command, midEntry->mid);
143 cifs_info(" A: 0x%lx S: 0x%lx R: 0x%lx\n",
144 now - midEntry->when_alloc,
145 now - midEntry->when_sent,
146 now - midEntry->when_received);
150 cifs_mid_q_entry_release(midEntry);
154 cifs_delete_mid(struct mid_q_entry *mid)
156 spin_lock(&GlobalMid_Lock);
157 list_del_init(&mid->qhead);
158 mid->mid_flags |= MID_DELETED;
159 spin_unlock(&GlobalMid_Lock);
161 DeleteMidQEntry(mid);
165 * smb_send_kvec - send an array of kvecs to the server
166 * @server: Server to send the data to
167 * @smb_msg: Message to send
168 * @sent: amount of data sent on socket is stored here
170 * Our basic "send data to server" function. Should be called with srv_mutex
171 * held. The caller is responsible for handling the results.
174 smb_send_kvec(struct TCP_Server_Info *server, struct msghdr *smb_msg,
179 struct socket *ssocket = server->ssocket;
183 smb_msg->msg_name = (struct sockaddr *) &server->dstaddr;
184 smb_msg->msg_namelen = sizeof(struct sockaddr);
185 smb_msg->msg_control = NULL;
186 smb_msg->msg_controllen = 0;
187 if (server->noblocksnd)
188 smb_msg->msg_flags = MSG_DONTWAIT + MSG_NOSIGNAL;
190 smb_msg->msg_flags = MSG_NOSIGNAL;
192 while (msg_data_left(smb_msg)) {
194 * If blocking send, we try 3 times, since each can block
195 * for 5 seconds. For nonblocking we have to try more
196 * but wait increasing amounts of time allowing time for
197 * socket to clear. The overall time we wait in either
198 * case to send on the socket is about 15 seconds.
199 * Similarly we wait for 15 seconds for a response from
200 * the server in SendReceive[2] for the server to send
201 * a response back for most types of requests (except
202 * SMB Write past end of file which can be slow, and
203 * blocking lock operations). NFS waits slightly longer
204 * than CIFS, but this can make it take longer for
205 * nonresponsive servers to be detected and 15 seconds
206 * is more than enough time for modern networks to
207 * send a packet. In most cases if we fail to send
208 * after the retries we will kill the socket and
209 * reconnect which may clear the network problem.
211 rc = sock_sendmsg(ssocket, smb_msg);
215 (!server->noblocksnd && (retries > 2))) {
216 cifs_dbg(VFS, "sends on sock %p stuck for 15 seconds\n",
220 msleep(1 << retries);
228 /* should never happen, letting socket clear before
229 retrying is our only obvious option here */
230 cifs_dbg(VFS, "tcp sent no data\n");
235 /* send was at least partially successful */
237 retries = 0; /* in case we get ENOSPC on the next send */
243 smb_rqst_len(struct TCP_Server_Info *server, struct smb_rqst *rqst)
248 unsigned long buflen = 0;
250 if (server->vals->header_preamble_size == 0 &&
251 rqst->rq_nvec >= 2 && rqst->rq_iov[0].iov_len == 4) {
252 iov = &rqst->rq_iov[1];
253 nvec = rqst->rq_nvec - 1;
256 nvec = rqst->rq_nvec;
259 /* total up iov array first */
260 for (i = 0; i < nvec; i++)
261 buflen += iov[i].iov_len;
264 * Add in the page array if there is one. The caller needs to make
265 * sure rq_offset and rq_tailsz are set correctly. If a buffer of
266 * multiple pages ends at page boundary, rq_tailsz needs to be set to
269 if (rqst->rq_npages) {
270 if (rqst->rq_npages == 1)
271 buflen += rqst->rq_tailsz;
274 * If there is more than one page, calculate the
275 * buffer length based on rq_offset and rq_tailsz
277 buflen += rqst->rq_pagesz * (rqst->rq_npages - 1) -
279 buflen += rqst->rq_tailsz;
287 __smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
288 struct smb_rqst *rqst)
293 unsigned int send_length = 0;
295 sigset_t mask, oldmask;
296 size_t total_len = 0, sent, size;
297 struct socket *ssocket = server->ssocket;
298 struct msghdr smb_msg;
300 __be32 rfc1002_marker;
302 if (cifs_rdma_enabled(server) && server->smbd_conn) {
303 rc = smbd_send(server, rqst);
310 if (signal_pending(current)) {
311 cifs_dbg(FYI, "signal is pending before sending any data\n");
315 /* cork the socket */
316 kernel_setsockopt(ssocket, SOL_TCP, TCP_CORK,
317 (char *)&val, sizeof(val));
319 for (j = 0; j < num_rqst; j++)
320 send_length += smb_rqst_len(server, &rqst[j]);
321 rfc1002_marker = cpu_to_be32(send_length);
324 * We should not allow signals to interrupt the network send because
325 * any partial send will cause session reconnects thus increasing
326 * latency of system calls and overload a server with unnecessary
331 sigprocmask(SIG_BLOCK, &mask, &oldmask);
333 /* Generate a rfc1002 marker for SMB2+ */
334 if (server->vals->header_preamble_size == 0) {
336 .iov_base = &rfc1002_marker,
339 iov_iter_kvec(&smb_msg.msg_iter, WRITE, &hiov, 1, 4);
340 rc = smb_send_kvec(server, &smb_msg, &sent);
348 cifs_dbg(FYI, "Sending smb: smb_len=%u\n", send_length);
350 for (j = 0; j < num_rqst; j++) {
351 iov = rqst[j].rq_iov;
352 n_vec = rqst[j].rq_nvec;
355 for (i = 0; i < n_vec; i++) {
356 dump_smb(iov[i].iov_base, iov[i].iov_len);
357 size += iov[i].iov_len;
360 iov_iter_kvec(&smb_msg.msg_iter, WRITE, iov, n_vec, size);
362 rc = smb_send_kvec(server, &smb_msg, &sent);
368 /* now walk the page array and send each page in it */
369 for (i = 0; i < rqst[j].rq_npages; i++) {
372 bvec.bv_page = rqst[j].rq_pages[i];
373 rqst_page_get_length(&rqst[j], i, &bvec.bv_len,
376 iov_iter_bvec(&smb_msg.msg_iter, WRITE,
377 &bvec, 1, bvec.bv_len);
378 rc = smb_send_kvec(server, &smb_msg, &sent);
387 sigprocmask(SIG_SETMASK, &oldmask, NULL);
390 * If signal is pending but we have already sent the whole packet to
391 * the server we need to return success status to allow a corresponding
392 * mid entry to be kept in the pending requests queue thus allowing
393 * to handle responses from the server by the client.
395 * If only part of the packet has been sent there is no need to hide
396 * interrupt because the session will be reconnected anyway, so there
397 * won't be any response from the server to handle.
400 if (signal_pending(current) && (total_len != send_length)) {
401 cifs_dbg(FYI, "signal is pending after attempt to send\n");
407 kernel_setsockopt(ssocket, SOL_TCP, TCP_CORK,
408 (char *)&val, sizeof(val));
410 if ((total_len > 0) && (total_len != send_length)) {
411 cifs_dbg(FYI, "partial send (wanted=%u sent=%zu): terminating session\n",
412 send_length, total_len);
414 * If we have only sent part of an SMB then the next SMB could
415 * be taken as the remainder of this one. We need to kill the
416 * socket so the server throws away the partial SMB
418 server->tcpStatus = CifsNeedReconnect;
419 trace_smb3_partial_send_reconnect(server->CurrentMid,
423 if (rc < 0 && rc != -EINTR)
424 cifs_dbg(VFS, "Error %d sending data on socket to server\n",
433 smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
434 struct smb_rqst *rqst, int flags)
437 struct smb2_transform_hdr tr_hdr;
438 struct smb_rqst cur_rqst[MAX_COMPOUND];
441 if (!(flags & CIFS_TRANSFORM_REQ))
442 return __smb_send_rqst(server, num_rqst, rqst);
444 if (num_rqst > MAX_COMPOUND - 1)
447 memset(&cur_rqst[0], 0, sizeof(cur_rqst));
448 memset(&iov, 0, sizeof(iov));
449 memset(&tr_hdr, 0, sizeof(tr_hdr));
451 iov.iov_base = &tr_hdr;
452 iov.iov_len = sizeof(tr_hdr);
453 cur_rqst[0].rq_iov = &iov;
454 cur_rqst[0].rq_nvec = 1;
456 if (!server->ops->init_transform_rq) {
457 cifs_dbg(VFS, "Encryption requested but transform callback "
462 rc = server->ops->init_transform_rq(server, num_rqst + 1,
467 rc = __smb_send_rqst(server, num_rqst + 1, &cur_rqst[0]);
468 smb3_free_compound_rqst(num_rqst, &cur_rqst[1]);
473 smb_send(struct TCP_Server_Info *server, struct smb_hdr *smb_buffer,
474 unsigned int smb_buf_length)
477 struct smb_rqst rqst = { .rq_iov = iov,
480 iov[0].iov_base = smb_buffer;
482 iov[1].iov_base = (char *)smb_buffer + 4;
483 iov[1].iov_len = smb_buf_length;
485 return __smb_send_rqst(server, 1, &rqst);
489 wait_for_free_credits(struct TCP_Server_Info *server, const int num_credits,
490 const int timeout, const int flags,
491 unsigned int *instance)
499 t = MAX_JIFFY_OFFSET;
501 t = msecs_to_jiffies(timeout);
503 optype = flags & CIFS_OP_MASK;
507 credits = server->ops->get_credits_field(server, optype);
508 /* Since an echo is already inflight, no need to wait to send another */
509 if (*credits <= 0 && optype == CIFS_ECHO_OP)
512 spin_lock(&server->req_lock);
513 if ((flags & CIFS_TIMEOUT_MASK) == CIFS_ASYNC_OP) {
514 /* oplock breaks must not be held up */
517 *instance = server->reconnect_instance;
518 spin_unlock(&server->req_lock);
523 if (*credits < num_credits) {
524 spin_unlock(&server->req_lock);
525 cifs_num_waiters_inc(server);
526 rc = wait_event_killable_timeout(server->request_q,
527 has_credits(server, credits, num_credits), t);
528 cifs_num_waiters_dec(server);
530 trace_smb3_credit_timeout(server->CurrentMid,
531 server->hostname, num_credits);
532 cifs_dbg(VFS, "wait timed out after %d ms\n",
536 if (rc == -ERESTARTSYS)
538 spin_lock(&server->req_lock);
540 if (server->tcpStatus == CifsExiting) {
541 spin_unlock(&server->req_lock);
546 * For normal commands, reserve the last MAX_COMPOUND
547 * credits to compound requests.
548 * Otherwise these compounds could be permanently
549 * starved for credits by single-credit requests.
551 * To prevent spinning CPU, block this thread until
552 * there are >MAX_COMPOUND credits available.
553 * But only do this is we already have a lot of
554 * credits in flight to avoid triggering this check
555 * for servers that are slow to hand out credits on
558 if (!optype && num_credits == 1 &&
559 server->in_flight > 2 * MAX_COMPOUND &&
560 *credits <= MAX_COMPOUND) {
561 spin_unlock(&server->req_lock);
562 cifs_num_waiters_inc(server);
563 rc = wait_event_killable_timeout(
565 has_credits(server, credits,
568 cifs_num_waiters_dec(server);
570 trace_smb3_credit_timeout(
572 server->hostname, num_credits);
573 cifs_dbg(VFS, "wait timed out after %d ms\n",
577 if (rc == -ERESTARTSYS)
579 spin_lock(&server->req_lock);
584 * Can not count locking commands against total
585 * as they are allowed to block on server.
588 /* update # of requests on the wire to server */
589 if ((flags & CIFS_TIMEOUT_MASK) != CIFS_BLOCKING_OP) {
590 *credits -= num_credits;
591 server->in_flight += num_credits;
592 *instance = server->reconnect_instance;
594 spin_unlock(&server->req_lock);
602 wait_for_free_request(struct TCP_Server_Info *server, const int flags,
603 unsigned int *instance)
605 return wait_for_free_credits(server, 1, -1, flags,
610 wait_for_compound_request(struct TCP_Server_Info *server, int num,
611 const int flags, unsigned int *instance)
615 credits = server->ops->get_credits_field(server, flags & CIFS_OP_MASK);
617 spin_lock(&server->req_lock);
618 if (*credits < num) {
620 * Return immediately if not too many requests in flight since
621 * we will likely be stuck on waiting for credits.
623 if (server->in_flight < num - *credits) {
624 spin_unlock(&server->req_lock);
628 spin_unlock(&server->req_lock);
630 return wait_for_free_credits(server, num, 60000, flags,
635 cifs_wait_mtu_credits(struct TCP_Server_Info *server, unsigned int size,
636 unsigned int *num, struct cifs_credits *credits)
640 credits->instance = server->reconnect_instance;
644 static int allocate_mid(struct cifs_ses *ses, struct smb_hdr *in_buf,
645 struct mid_q_entry **ppmidQ)
647 if (ses->server->tcpStatus == CifsExiting) {
651 if (ses->server->tcpStatus == CifsNeedReconnect) {
652 cifs_dbg(FYI, "tcp session dead - return to caller to retry\n");
656 if (ses->status == CifsNew) {
657 if ((in_buf->Command != SMB_COM_SESSION_SETUP_ANDX) &&
658 (in_buf->Command != SMB_COM_NEGOTIATE))
660 /* else ok - we are setting up session */
663 if (ses->status == CifsExiting) {
664 /* check if SMB session is bad because we are setting it up */
665 if (in_buf->Command != SMB_COM_LOGOFF_ANDX)
667 /* else ok - we are shutting down session */
670 *ppmidQ = AllocMidQEntry(in_buf, ses->server);
673 spin_lock(&GlobalMid_Lock);
674 list_add_tail(&(*ppmidQ)->qhead, &ses->server->pending_mid_q);
675 spin_unlock(&GlobalMid_Lock);
680 wait_for_response(struct TCP_Server_Info *server, struct mid_q_entry *midQ)
684 error = wait_event_freezekillable_unsafe(server->response_q,
685 midQ->mid_state != MID_REQUEST_SUBMITTED);
693 cifs_setup_async_request(struct TCP_Server_Info *server, struct smb_rqst *rqst)
696 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
697 struct mid_q_entry *mid;
699 if (rqst->rq_iov[0].iov_len != 4 ||
700 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
701 return ERR_PTR(-EIO);
703 /* enable signing if server requires it */
705 hdr->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
707 mid = AllocMidQEntry(hdr, server);
709 return ERR_PTR(-ENOMEM);
711 rc = cifs_sign_rqst(rqst, server, &mid->sequence_number);
713 DeleteMidQEntry(mid);
721 * Send a SMB request and set the callback function in the mid to handle
722 * the result. Caller is responsible for dealing with timeouts.
725 cifs_call_async(struct TCP_Server_Info *server, struct smb_rqst *rqst,
726 mid_receive_t *receive, mid_callback_t *callback,
727 mid_handle_t *handle, void *cbdata, const int flags,
728 const struct cifs_credits *exist_credits)
731 struct mid_q_entry *mid;
732 struct cifs_credits credits = { .value = 0, .instance = 0 };
733 unsigned int instance;
736 optype = flags & CIFS_OP_MASK;
738 if ((flags & CIFS_HAS_CREDITS) == 0) {
739 rc = wait_for_free_request(server, flags, &instance);
743 credits.instance = instance;
745 instance = exist_credits->instance;
747 mutex_lock(&server->srv_mutex);
750 * We can't use credits obtained from the previous session to send this
751 * request. Check if there were reconnects after we obtained credits and
752 * return -EAGAIN in such cases to let callers handle it.
754 if (instance != server->reconnect_instance) {
755 mutex_unlock(&server->srv_mutex);
756 add_credits_and_wake_if(server, &credits, optype);
760 mid = server->ops->setup_async_request(server, rqst);
762 mutex_unlock(&server->srv_mutex);
763 add_credits_and_wake_if(server, &credits, optype);
767 mid->receive = receive;
768 mid->callback = callback;
769 mid->callback_data = cbdata;
770 mid->handle = handle;
771 mid->mid_state = MID_REQUEST_SUBMITTED;
773 /* put it on the pending_mid_q */
774 spin_lock(&GlobalMid_Lock);
775 list_add_tail(&mid->qhead, &server->pending_mid_q);
776 spin_unlock(&GlobalMid_Lock);
779 * Need to store the time in mid before calling I/O. For call_async,
780 * I/O response may come back and free the mid entry on another thread.
782 cifs_save_when_sent(mid);
783 cifs_in_send_inc(server);
784 rc = smb_send_rqst(server, 1, rqst, flags);
785 cifs_in_send_dec(server);
788 revert_current_mid(server, mid->credits);
789 server->sequence_number -= 2;
790 cifs_delete_mid(mid);
793 mutex_unlock(&server->srv_mutex);
798 add_credits_and_wake_if(server, &credits, optype);
804 * Send an SMB Request. No response info (other than return code)
805 * needs to be parsed.
807 * flags indicate the type of request buffer and how long to wait
808 * and whether to log NT STATUS code (error) before mapping it to POSIX error
812 SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
813 char *in_buf, int flags)
820 iov[0].iov_base = in_buf;
821 iov[0].iov_len = get_rfc1002_length(in_buf) + 4;
822 flags |= CIFS_NO_RESP;
823 rc = SendReceive2(xid, ses, iov, 1, &resp_buf_type, flags, &rsp_iov);
824 cifs_dbg(NOISY, "SendRcvNoRsp flags %d rc %d\n", flags, rc);
830 cifs_sync_mid_result(struct mid_q_entry *mid, struct TCP_Server_Info *server)
834 cifs_dbg(FYI, "%s: cmd=%d mid=%llu state=%d\n",
835 __func__, le16_to_cpu(mid->command), mid->mid, mid->mid_state);
837 spin_lock(&GlobalMid_Lock);
838 switch (mid->mid_state) {
839 case MID_RESPONSE_RECEIVED:
840 spin_unlock(&GlobalMid_Lock);
842 case MID_RETRY_NEEDED:
845 case MID_RESPONSE_MALFORMED:
852 list_del_init(&mid->qhead);
853 cifs_dbg(VFS, "%s: invalid mid state mid=%llu state=%d\n",
854 __func__, mid->mid, mid->mid_state);
857 spin_unlock(&GlobalMid_Lock);
859 DeleteMidQEntry(mid);
864 send_cancel(struct TCP_Server_Info *server, struct smb_rqst *rqst,
865 struct mid_q_entry *mid)
867 return server->ops->send_cancel ?
868 server->ops->send_cancel(server, rqst, mid) : 0;
872 cifs_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
875 unsigned int len = get_rfc1002_length(mid->resp_buf) + 4;
877 dump_smb(mid->resp_buf, min_t(u32, 92, len));
879 /* convert the length into a more usable form */
883 struct smb_rqst rqst = { .rq_iov = iov,
886 iov[0].iov_base = mid->resp_buf;
888 iov[1].iov_base = (char *)mid->resp_buf + 4;
889 iov[1].iov_len = len - 4;
890 /* FIXME: add code to kill session */
891 rc = cifs_verify_signature(&rqst, server,
892 mid->sequence_number);
894 cifs_dbg(VFS, "SMB signature verification returned error = %d\n",
898 /* BB special case reconnect tid and uid here? */
899 return map_smb_to_linux_error(mid->resp_buf, log_error);
903 cifs_setup_request(struct cifs_ses *ses, struct smb_rqst *rqst)
906 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
907 struct mid_q_entry *mid;
909 if (rqst->rq_iov[0].iov_len != 4 ||
910 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
911 return ERR_PTR(-EIO);
913 rc = allocate_mid(ses, hdr, &mid);
916 rc = cifs_sign_rqst(rqst, ses->server, &mid->sequence_number);
918 cifs_delete_mid(mid);
925 cifs_compound_callback(struct mid_q_entry *mid)
927 struct TCP_Server_Info *server = mid->server;
928 struct cifs_credits credits;
930 credits.value = server->ops->get_credits(mid);
931 credits.instance = server->reconnect_instance;
933 add_credits(server, &credits, mid->optype);
937 cifs_compound_last_callback(struct mid_q_entry *mid)
939 cifs_compound_callback(mid);
940 cifs_wake_up_task(mid);
944 cifs_cancelled_callback(struct mid_q_entry *mid)
946 cifs_compound_callback(mid);
947 DeleteMidQEntry(mid);
951 compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
952 const int flags, const int num_rqst, struct smb_rqst *rqst,
953 int *resp_buf_type, struct kvec *resp_iov)
955 int i, j, optype, rc = 0;
956 struct mid_q_entry *midQ[MAX_COMPOUND];
957 bool cancelled_mid[MAX_COMPOUND] = {false};
958 struct cifs_credits credits[MAX_COMPOUND] = {
959 { .value = 0, .instance = 0 }
961 unsigned int instance;
964 optype = flags & CIFS_OP_MASK;
966 for (i = 0; i < num_rqst; i++)
967 resp_buf_type[i] = CIFS_NO_BUFFER; /* no response buf yet */
969 if ((ses == NULL) || (ses->server == NULL)) {
970 cifs_dbg(VFS, "Null session\n");
974 if (ses->server->tcpStatus == CifsExiting)
978 * Wait for all the requests to become available.
979 * This approach still leaves the possibility to be stuck waiting for
980 * credits if the server doesn't grant credits to the outstanding
981 * requests and if the client is completely idle, not generating any
983 * This can be handled by the eventual session reconnect.
985 rc = wait_for_compound_request(ses->server, num_rqst, flags,
990 for (i = 0; i < num_rqst; i++) {
991 credits[i].value = 1;
992 credits[i].instance = instance;
996 * Make sure that we sign in the same order that we send on this socket
997 * and avoid races inside tcp sendmsg code that could cause corruption
1001 mutex_lock(&ses->server->srv_mutex);
1004 * All the parts of the compound chain belong obtained credits from the
1005 * same session. We can not use credits obtained from the previous
1006 * session to send this request. Check if there were reconnects after
1007 * we obtained credits and return -EAGAIN in such cases to let callers
1010 if (instance != ses->server->reconnect_instance) {
1011 mutex_unlock(&ses->server->srv_mutex);
1012 for (j = 0; j < num_rqst; j++)
1013 add_credits(ses->server, &credits[j], optype);
1017 for (i = 0; i < num_rqst; i++) {
1018 midQ[i] = ses->server->ops->setup_request(ses, &rqst[i]);
1019 if (IS_ERR(midQ[i])) {
1020 revert_current_mid(ses->server, i);
1021 for (j = 0; j < i; j++)
1022 cifs_delete_mid(midQ[j]);
1023 mutex_unlock(&ses->server->srv_mutex);
1025 /* Update # of requests on wire to server */
1026 for (j = 0; j < num_rqst; j++)
1027 add_credits(ses->server, &credits[j], optype);
1028 return PTR_ERR(midQ[i]);
1031 midQ[i]->mid_state = MID_REQUEST_SUBMITTED;
1032 midQ[i]->optype = optype;
1034 * Invoke callback for every part of the compound chain
1035 * to calculate credits properly. Wake up this thread only when
1036 * the last element is received.
1038 if (i < num_rqst - 1)
1039 midQ[i]->callback = cifs_compound_callback;
1041 midQ[i]->callback = cifs_compound_last_callback;
1043 cifs_in_send_inc(ses->server);
1044 rc = smb_send_rqst(ses->server, num_rqst, rqst, flags);
1045 cifs_in_send_dec(ses->server);
1047 for (i = 0; i < num_rqst; i++)
1048 cifs_save_when_sent(midQ[i]);
1051 revert_current_mid(ses->server, num_rqst);
1052 ses->server->sequence_number -= 2;
1055 mutex_unlock(&ses->server->srv_mutex);
1058 /* Sending failed for some reason - return credits back */
1059 for (i = 0; i < num_rqst; i++)
1060 add_credits(ses->server, &credits[i], optype);
1065 * At this point the request is passed to the network stack - we assume
1066 * that any credits taken from the server structure on the client have
1067 * been spent and we can't return them back. Once we receive responses
1068 * we will collect credits granted by the server in the mid callbacks
1069 * and add those credits to the server structure.
1073 * Compounding is never used during session establish.
1075 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP))
1076 smb311_update_preauth_hash(ses, rqst[0].rq_iov,
1079 if ((flags & CIFS_TIMEOUT_MASK) == CIFS_ASYNC_OP)
1082 for (i = 0; i < num_rqst; i++) {
1083 rc = wait_for_response(ses->server, midQ[i]);
1088 for (; i < num_rqst; i++) {
1089 cifs_dbg(VFS, "Cancelling wait for mid %llu cmd: %d\n",
1090 midQ[i]->mid, le16_to_cpu(midQ[i]->command));
1091 send_cancel(ses->server, &rqst[i], midQ[i]);
1092 spin_lock(&GlobalMid_Lock);
1093 if (midQ[i]->mid_state == MID_REQUEST_SUBMITTED) {
1094 midQ[i]->mid_flags |= MID_WAIT_CANCELLED;
1095 midQ[i]->callback = cifs_cancelled_callback;
1096 cancelled_mid[i] = true;
1097 credits[i].value = 0;
1099 spin_unlock(&GlobalMid_Lock);
1103 for (i = 0; i < num_rqst; i++) {
1107 rc = cifs_sync_mid_result(midQ[i], ses->server);
1109 /* mark this mid as cancelled to not free it below */
1110 cancelled_mid[i] = true;
1114 if (!midQ[i]->resp_buf ||
1115 midQ[i]->mid_state != MID_RESPONSE_RECEIVED) {
1117 cifs_dbg(FYI, "Bad MID state?\n");
1121 buf = (char *)midQ[i]->resp_buf;
1122 resp_iov[i].iov_base = buf;
1123 resp_iov[i].iov_len = midQ[i]->resp_buf_size +
1124 ses->server->vals->header_preamble_size;
1126 if (midQ[i]->large_buf)
1127 resp_buf_type[i] = CIFS_LARGE_BUFFER;
1129 resp_buf_type[i] = CIFS_SMALL_BUFFER;
1131 rc = ses->server->ops->check_receive(midQ[i], ses->server,
1132 flags & CIFS_LOG_ERROR);
1134 /* mark it so buf will not be freed by cifs_delete_mid */
1135 if ((flags & CIFS_NO_RESP) == 0)
1136 midQ[i]->resp_buf = NULL;
1141 * Compounding is never used during session establish.
1143 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP)) {
1145 .iov_base = resp_iov[0].iov_base,
1146 .iov_len = resp_iov[0].iov_len
1148 smb311_update_preauth_hash(ses, &iov, 1);
1153 * This will dequeue all mids. After this it is important that the
1154 * demultiplex_thread will not process any of these mids any futher.
1155 * This is prevented above by using a noop callback that will not
1156 * wake this thread except for the very last PDU.
1158 for (i = 0; i < num_rqst; i++) {
1159 if (!cancelled_mid[i])
1160 cifs_delete_mid(midQ[i]);
1167 cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
1168 struct smb_rqst *rqst, int *resp_buf_type, const int flags,
1169 struct kvec *resp_iov)
1171 return compound_send_recv(xid, ses, flags, 1, rqst, resp_buf_type,
1176 SendReceive2(const unsigned int xid, struct cifs_ses *ses,
1177 struct kvec *iov, int n_vec, int *resp_buf_type /* ret */,
1178 const int flags, struct kvec *resp_iov)
1180 struct smb_rqst rqst;
1181 struct kvec s_iov[CIFS_MAX_IOV_SIZE], *new_iov;
1184 if (n_vec + 1 > CIFS_MAX_IOV_SIZE) {
1185 new_iov = kmalloc_array(n_vec + 1, sizeof(struct kvec),
1188 /* otherwise cifs_send_recv below sets resp_buf_type */
1189 *resp_buf_type = CIFS_NO_BUFFER;
1195 /* 1st iov is a RFC1001 length followed by the rest of the packet */
1196 memcpy(new_iov + 1, iov, (sizeof(struct kvec) * n_vec));
1198 new_iov[0].iov_base = new_iov[1].iov_base;
1199 new_iov[0].iov_len = 4;
1200 new_iov[1].iov_base += 4;
1201 new_iov[1].iov_len -= 4;
1203 memset(&rqst, 0, sizeof(struct smb_rqst));
1204 rqst.rq_iov = new_iov;
1205 rqst.rq_nvec = n_vec + 1;
1207 rc = cifs_send_recv(xid, ses, &rqst, resp_buf_type, flags, resp_iov);
1208 if (n_vec + 1 > CIFS_MAX_IOV_SIZE)
1214 SendReceive(const unsigned int xid, struct cifs_ses *ses,
1215 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1216 int *pbytes_returned, const int flags)
1219 struct mid_q_entry *midQ;
1220 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1221 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1222 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1223 struct cifs_credits credits = { .value = 1, .instance = 0 };
1226 cifs_dbg(VFS, "Null smb session\n");
1229 if (ses->server == NULL) {
1230 cifs_dbg(VFS, "Null tcp session\n");
1234 if (ses->server->tcpStatus == CifsExiting)
1237 /* Ensure that we do not send more than 50 overlapping requests
1238 to the same server. We may make this configurable later or
1241 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1242 cifs_dbg(VFS, "Illegal length, greater than maximum frame, %d\n",
1247 rc = wait_for_free_request(ses->server, flags, &credits.instance);
1251 /* make sure that we sign in the same order that we send on this socket
1252 and avoid races inside tcp sendmsg code that could cause corruption
1255 mutex_lock(&ses->server->srv_mutex);
1257 rc = allocate_mid(ses, in_buf, &midQ);
1259 mutex_unlock(&ses->server->srv_mutex);
1260 /* Update # of requests on wire to server */
1261 add_credits(ses->server, &credits, 0);
1265 rc = cifs_sign_smb(in_buf, ses->server, &midQ->sequence_number);
1267 mutex_unlock(&ses->server->srv_mutex);
1271 midQ->mid_state = MID_REQUEST_SUBMITTED;
1273 cifs_in_send_inc(ses->server);
1274 rc = smb_send(ses->server, in_buf, len);
1275 cifs_in_send_dec(ses->server);
1276 cifs_save_when_sent(midQ);
1279 ses->server->sequence_number -= 2;
1281 mutex_unlock(&ses->server->srv_mutex);
1286 if ((flags & CIFS_TIMEOUT_MASK) == CIFS_ASYNC_OP)
1289 rc = wait_for_response(ses->server, midQ);
1291 send_cancel(ses->server, &rqst, midQ);
1292 spin_lock(&GlobalMid_Lock);
1293 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1294 /* no longer considered to be "in-flight" */
1295 midQ->callback = DeleteMidQEntry;
1296 spin_unlock(&GlobalMid_Lock);
1297 add_credits(ses->server, &credits, 0);
1300 spin_unlock(&GlobalMid_Lock);
1303 rc = cifs_sync_mid_result(midQ, ses->server);
1305 add_credits(ses->server, &credits, 0);
1309 if (!midQ->resp_buf || !out_buf ||
1310 midQ->mid_state != MID_RESPONSE_RECEIVED) {
1312 cifs_dbg(VFS, "Bad MID state?\n");
1316 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1317 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1318 rc = cifs_check_receive(midQ, ses->server, 0);
1320 cifs_delete_mid(midQ);
1321 add_credits(ses->server, &credits, 0);
1326 /* We send a LOCKINGX_CANCEL_LOCK to cause the Windows
1327 blocking lock to return. */
1330 send_lock_cancel(const unsigned int xid, struct cifs_tcon *tcon,
1331 struct smb_hdr *in_buf,
1332 struct smb_hdr *out_buf)
1335 struct cifs_ses *ses = tcon->ses;
1336 LOCK_REQ *pSMB = (LOCK_REQ *)in_buf;
1338 /* We just modify the current in_buf to change
1339 the type of lock from LOCKING_ANDX_SHARED_LOCK
1340 or LOCKING_ANDX_EXCLUSIVE_LOCK to
1341 LOCKING_ANDX_CANCEL_LOCK. */
1343 pSMB->LockType = LOCKING_ANDX_CANCEL_LOCK|LOCKING_ANDX_LARGE_FILES;
1345 pSMB->hdr.Mid = get_next_mid(ses->server);
1347 return SendReceive(xid, ses, in_buf, out_buf,
1348 &bytes_returned, 0);
1352 SendReceiveBlockingLock(const unsigned int xid, struct cifs_tcon *tcon,
1353 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1354 int *pbytes_returned)
1358 struct mid_q_entry *midQ;
1359 struct cifs_ses *ses;
1360 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1361 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1362 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1363 unsigned int instance;
1365 if (tcon == NULL || tcon->ses == NULL) {
1366 cifs_dbg(VFS, "Null smb session\n");
1371 if (ses->server == NULL) {
1372 cifs_dbg(VFS, "Null tcp session\n");
1376 if (ses->server->tcpStatus == CifsExiting)
1379 /* Ensure that we do not send more than 50 overlapping requests
1380 to the same server. We may make this configurable later or
1383 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1384 cifs_dbg(VFS, "Illegal length, greater than maximum frame, %d\n",
1389 rc = wait_for_free_request(ses->server, CIFS_BLOCKING_OP, &instance);
1393 /* make sure that we sign in the same order that we send on this socket
1394 and avoid races inside tcp sendmsg code that could cause corruption
1397 mutex_lock(&ses->server->srv_mutex);
1399 rc = allocate_mid(ses, in_buf, &midQ);
1401 mutex_unlock(&ses->server->srv_mutex);
1405 rc = cifs_sign_smb(in_buf, ses->server, &midQ->sequence_number);
1407 cifs_delete_mid(midQ);
1408 mutex_unlock(&ses->server->srv_mutex);
1412 midQ->mid_state = MID_REQUEST_SUBMITTED;
1413 cifs_in_send_inc(ses->server);
1414 rc = smb_send(ses->server, in_buf, len);
1415 cifs_in_send_dec(ses->server);
1416 cifs_save_when_sent(midQ);
1419 ses->server->sequence_number -= 2;
1421 mutex_unlock(&ses->server->srv_mutex);
1424 cifs_delete_mid(midQ);
1428 /* Wait for a reply - allow signals to interrupt. */
1429 rc = wait_event_interruptible(ses->server->response_q,
1430 (!(midQ->mid_state == MID_REQUEST_SUBMITTED)) ||
1431 ((ses->server->tcpStatus != CifsGood) &&
1432 (ses->server->tcpStatus != CifsNew)));
1434 /* Were we interrupted by a signal ? */
1435 if ((rc == -ERESTARTSYS) &&
1436 (midQ->mid_state == MID_REQUEST_SUBMITTED) &&
1437 ((ses->server->tcpStatus == CifsGood) ||
1438 (ses->server->tcpStatus == CifsNew))) {
1440 if (in_buf->Command == SMB_COM_TRANSACTION2) {
1441 /* POSIX lock. We send a NT_CANCEL SMB to cause the
1442 blocking lock to return. */
1443 rc = send_cancel(ses->server, &rqst, midQ);
1445 cifs_delete_mid(midQ);
1449 /* Windows lock. We send a LOCKINGX_CANCEL_LOCK
1450 to cause the blocking lock to return. */
1452 rc = send_lock_cancel(xid, tcon, in_buf, out_buf);
1454 /* If we get -ENOLCK back the lock may have
1455 already been removed. Don't exit in this case. */
1456 if (rc && rc != -ENOLCK) {
1457 cifs_delete_mid(midQ);
1462 rc = wait_for_response(ses->server, midQ);
1464 send_cancel(ses->server, &rqst, midQ);
1465 spin_lock(&GlobalMid_Lock);
1466 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1467 /* no longer considered to be "in-flight" */
1468 midQ->callback = DeleteMidQEntry;
1469 spin_unlock(&GlobalMid_Lock);
1472 spin_unlock(&GlobalMid_Lock);
1475 /* We got the response - restart system call. */
1479 rc = cifs_sync_mid_result(midQ, ses->server);
1483 /* rcvd frame is ok */
1484 if (out_buf == NULL || midQ->mid_state != MID_RESPONSE_RECEIVED) {
1486 cifs_dbg(VFS, "Bad MID state?\n");
1490 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1491 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1492 rc = cifs_check_receive(midQ, ses->server, 0);
1494 cifs_delete_mid(midQ);
1495 if (rstart && rc == -EACCES)
1496 return -ERESTARTSYS;