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/sched/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 get_task_struct(current);
80 temp->creator = current;
81 temp->callback = cifs_wake_up_task;
82 temp->callback_data = current;
84 atomic_inc(&midCount);
85 temp->mid_state = MID_REQUEST_ALLOCATED;
89 static void _cifs_mid_q_entry_release(struct kref *refcount)
91 struct mid_q_entry *midEntry =
92 container_of(refcount, struct mid_q_entry, refcount);
93 #ifdef CONFIG_CIFS_STATS2
94 __le16 command = midEntry->server->vals->lock_cmd;
95 __u16 smb_cmd = le16_to_cpu(midEntry->command);
97 unsigned long roundtrip_time;
99 struct TCP_Server_Info *server = midEntry->server;
101 if (midEntry->resp_buf && (midEntry->mid_flags & MID_WAIT_CANCELLED) &&
102 midEntry->mid_state == MID_RESPONSE_RECEIVED &&
103 server->ops->handle_cancelled_mid)
104 server->ops->handle_cancelled_mid(midEntry->resp_buf, server);
106 midEntry->mid_state = MID_FREE;
107 atomic_dec(&midCount);
108 if (midEntry->large_buf)
109 cifs_buf_release(midEntry->resp_buf);
111 cifs_small_buf_release(midEntry->resp_buf);
112 #ifdef CONFIG_CIFS_STATS2
114 if (now < midEntry->when_alloc)
115 cifs_server_dbg(VFS, "invalid mid allocation time\n");
116 roundtrip_time = now - midEntry->when_alloc;
118 if (smb_cmd < NUMBER_OF_SMB2_COMMANDS) {
119 if (atomic_read(&server->num_cmds[smb_cmd]) == 0) {
120 server->slowest_cmd[smb_cmd] = roundtrip_time;
121 server->fastest_cmd[smb_cmd] = roundtrip_time;
123 if (server->slowest_cmd[smb_cmd] < roundtrip_time)
124 server->slowest_cmd[smb_cmd] = roundtrip_time;
125 else if (server->fastest_cmd[smb_cmd] > roundtrip_time)
126 server->fastest_cmd[smb_cmd] = roundtrip_time;
128 cifs_stats_inc(&server->num_cmds[smb_cmd]);
129 server->time_per_cmd[smb_cmd] += roundtrip_time;
132 * commands taking longer than one second (default) can be indications
133 * that something is wrong, unless it is quite a slow link or a very
134 * busy server. Note that this calc is unlikely or impossible to wrap
135 * as long as slow_rsp_threshold is not set way above recommended max
136 * value (32767 ie 9 hours) and is generally harmless even if wrong
137 * since only affects debug counters - so leaving the calc as simple
138 * comparison rather than doing multiple conversions and overflow
141 if ((slow_rsp_threshold != 0) &&
142 time_after(now, midEntry->when_alloc + (slow_rsp_threshold * HZ)) &&
143 (midEntry->command != command)) {
145 * smb2slowcmd[NUMBER_OF_SMB2_COMMANDS] counts by command
146 * NB: le16_to_cpu returns unsigned so can not be negative below
148 if (smb_cmd < NUMBER_OF_SMB2_COMMANDS)
149 cifs_stats_inc(&server->smb2slowcmd[smb_cmd]);
151 trace_smb3_slow_rsp(smb_cmd, midEntry->mid, midEntry->pid,
152 midEntry->when_sent, midEntry->when_received);
153 if (cifsFYI & CIFS_TIMER) {
154 pr_debug(" CIFS slow rsp: cmd %d mid %llu",
155 midEntry->command, midEntry->mid);
156 cifs_info(" A: 0x%lx S: 0x%lx R: 0x%lx\n",
157 now - midEntry->when_alloc,
158 now - midEntry->when_sent,
159 now - midEntry->when_received);
163 put_task_struct(midEntry->creator);
165 mempool_free(midEntry, cifs_mid_poolp);
168 void cifs_mid_q_entry_release(struct mid_q_entry *midEntry)
170 spin_lock(&GlobalMid_Lock);
171 kref_put(&midEntry->refcount, _cifs_mid_q_entry_release);
172 spin_unlock(&GlobalMid_Lock);
175 void DeleteMidQEntry(struct mid_q_entry *midEntry)
177 cifs_mid_q_entry_release(midEntry);
181 cifs_delete_mid(struct mid_q_entry *mid)
183 spin_lock(&GlobalMid_Lock);
184 if (!(mid->mid_flags & MID_DELETED)) {
185 list_del_init(&mid->qhead);
186 mid->mid_flags |= MID_DELETED;
188 spin_unlock(&GlobalMid_Lock);
190 DeleteMidQEntry(mid);
194 * smb_send_kvec - send an array of kvecs to the server
195 * @server: Server to send the data to
196 * @smb_msg: Message to send
197 * @sent: amount of data sent on socket is stored here
199 * Our basic "send data to server" function. Should be called with srv_mutex
200 * held. The caller is responsible for handling the results.
203 smb_send_kvec(struct TCP_Server_Info *server, struct msghdr *smb_msg,
208 struct socket *ssocket = server->ssocket;
212 smb_msg->msg_name = (struct sockaddr *) &server->dstaddr;
213 smb_msg->msg_namelen = sizeof(struct sockaddr);
214 smb_msg->msg_control = NULL;
215 smb_msg->msg_controllen = 0;
216 if (server->noblocksnd)
217 smb_msg->msg_flags = MSG_DONTWAIT + MSG_NOSIGNAL;
219 smb_msg->msg_flags = MSG_NOSIGNAL;
221 while (msg_data_left(smb_msg)) {
223 * If blocking send, we try 3 times, since each can block
224 * for 5 seconds. For nonblocking we have to try more
225 * but wait increasing amounts of time allowing time for
226 * socket to clear. The overall time we wait in either
227 * case to send on the socket is about 15 seconds.
228 * Similarly we wait for 15 seconds for a response from
229 * the server in SendReceive[2] for the server to send
230 * a response back for most types of requests (except
231 * SMB Write past end of file which can be slow, and
232 * blocking lock operations). NFS waits slightly longer
233 * than CIFS, but this can make it take longer for
234 * nonresponsive servers to be detected and 15 seconds
235 * is more than enough time for modern networks to
236 * send a packet. In most cases if we fail to send
237 * after the retries we will kill the socket and
238 * reconnect which may clear the network problem.
240 rc = sock_sendmsg(ssocket, smb_msg);
244 (!server->noblocksnd && (retries > 2))) {
245 cifs_server_dbg(VFS, "sends on sock %p stuck for 15 seconds\n",
249 msleep(1 << retries);
257 /* should never happen, letting socket clear before
258 retrying is our only obvious option here */
259 cifs_server_dbg(VFS, "tcp sent no data\n");
264 /* send was at least partially successful */
266 retries = 0; /* in case we get ENOSPC on the next send */
272 smb_rqst_len(struct TCP_Server_Info *server, struct smb_rqst *rqst)
277 unsigned long buflen = 0;
279 if (server->vals->header_preamble_size == 0 &&
280 rqst->rq_nvec >= 2 && rqst->rq_iov[0].iov_len == 4) {
281 iov = &rqst->rq_iov[1];
282 nvec = rqst->rq_nvec - 1;
285 nvec = rqst->rq_nvec;
288 /* total up iov array first */
289 for (i = 0; i < nvec; i++)
290 buflen += iov[i].iov_len;
293 * Add in the page array if there is one. The caller needs to make
294 * sure rq_offset and rq_tailsz are set correctly. If a buffer of
295 * multiple pages ends at page boundary, rq_tailsz needs to be set to
298 if (rqst->rq_npages) {
299 if (rqst->rq_npages == 1)
300 buflen += rqst->rq_tailsz;
303 * If there is more than one page, calculate the
304 * buffer length based on rq_offset and rq_tailsz
306 buflen += rqst->rq_pagesz * (rqst->rq_npages - 1) -
308 buflen += rqst->rq_tailsz;
316 __smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
317 struct smb_rqst *rqst)
322 unsigned int send_length = 0;
324 sigset_t mask, oldmask;
325 size_t total_len = 0, sent, size;
326 struct socket *ssocket = server->ssocket;
327 struct msghdr smb_msg;
329 __be32 rfc1002_marker;
331 if (cifs_rdma_enabled(server)) {
332 /* return -EAGAIN when connecting or reconnecting */
334 if (server->smbd_conn)
335 rc = smbd_send(server, num_rqst, rqst);
342 if (signal_pending(current)) {
343 cifs_dbg(FYI, "signal is pending before sending any data\n");
347 /* cork the socket */
348 kernel_setsockopt(ssocket, SOL_TCP, TCP_CORK,
349 (char *)&val, sizeof(val));
351 for (j = 0; j < num_rqst; j++)
352 send_length += smb_rqst_len(server, &rqst[j]);
353 rfc1002_marker = cpu_to_be32(send_length);
356 * We should not allow signals to interrupt the network send because
357 * any partial send will cause session reconnects thus increasing
358 * latency of system calls and overload a server with unnecessary
363 sigprocmask(SIG_BLOCK, &mask, &oldmask);
365 /* Generate a rfc1002 marker for SMB2+ */
366 if (server->vals->header_preamble_size == 0) {
368 .iov_base = &rfc1002_marker,
371 iov_iter_kvec(&smb_msg.msg_iter, WRITE, &hiov, 1, 4);
372 rc = smb_send_kvec(server, &smb_msg, &sent);
380 cifs_dbg(FYI, "Sending smb: smb_len=%u\n", send_length);
382 for (j = 0; j < num_rqst; j++) {
383 iov = rqst[j].rq_iov;
384 n_vec = rqst[j].rq_nvec;
387 for (i = 0; i < n_vec; i++) {
388 dump_smb(iov[i].iov_base, iov[i].iov_len);
389 size += iov[i].iov_len;
392 iov_iter_kvec(&smb_msg.msg_iter, WRITE, iov, n_vec, size);
394 rc = smb_send_kvec(server, &smb_msg, &sent);
400 /* now walk the page array and send each page in it */
401 for (i = 0; i < rqst[j].rq_npages; i++) {
404 bvec.bv_page = rqst[j].rq_pages[i];
405 rqst_page_get_length(&rqst[j], i, &bvec.bv_len,
408 iov_iter_bvec(&smb_msg.msg_iter, WRITE,
409 &bvec, 1, bvec.bv_len);
410 rc = smb_send_kvec(server, &smb_msg, &sent);
419 sigprocmask(SIG_SETMASK, &oldmask, NULL);
422 * If signal is pending but we have already sent the whole packet to
423 * the server we need to return success status to allow a corresponding
424 * mid entry to be kept in the pending requests queue thus allowing
425 * to handle responses from the server by the client.
427 * If only part of the packet has been sent there is no need to hide
428 * interrupt because the session will be reconnected anyway, so there
429 * won't be any response from the server to handle.
432 if (signal_pending(current) && (total_len != send_length)) {
433 cifs_dbg(FYI, "signal is pending after attempt to send\n");
439 kernel_setsockopt(ssocket, SOL_TCP, TCP_CORK,
440 (char *)&val, sizeof(val));
442 if ((total_len > 0) && (total_len != send_length)) {
443 cifs_dbg(FYI, "partial send (wanted=%u sent=%zu): terminating session\n",
444 send_length, total_len);
446 * If we have only sent part of an SMB then the next SMB could
447 * be taken as the remainder of this one. We need to kill the
448 * socket so the server throws away the partial SMB
450 server->tcpStatus = CifsNeedReconnect;
451 trace_smb3_partial_send_reconnect(server->CurrentMid,
455 if (rc < 0 && rc != -EINTR)
456 cifs_server_dbg(VFS, "Error %d sending data on socket to server\n",
465 smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
466 struct smb_rqst *rqst, int flags)
469 struct smb2_transform_hdr *tr_hdr;
470 struct smb_rqst cur_rqst[MAX_COMPOUND];
473 if (!(flags & CIFS_TRANSFORM_REQ))
474 return __smb_send_rqst(server, num_rqst, rqst);
476 if (num_rqst > MAX_COMPOUND - 1)
479 if (!server->ops->init_transform_rq) {
480 cifs_server_dbg(VFS, "Encryption requested but transform "
481 "callback is missing\n");
485 tr_hdr = kmalloc(sizeof(*tr_hdr), GFP_NOFS);
489 memset(&cur_rqst[0], 0, sizeof(cur_rqst));
490 memset(&iov, 0, sizeof(iov));
491 memset(tr_hdr, 0, sizeof(*tr_hdr));
493 iov.iov_base = tr_hdr;
494 iov.iov_len = sizeof(*tr_hdr);
495 cur_rqst[0].rq_iov = &iov;
496 cur_rqst[0].rq_nvec = 1;
498 rc = server->ops->init_transform_rq(server, num_rqst + 1,
503 rc = __smb_send_rqst(server, num_rqst + 1, &cur_rqst[0]);
504 smb3_free_compound_rqst(num_rqst, &cur_rqst[1]);
511 smb_send(struct TCP_Server_Info *server, struct smb_hdr *smb_buffer,
512 unsigned int smb_buf_length)
515 struct smb_rqst rqst = { .rq_iov = iov,
518 iov[0].iov_base = smb_buffer;
520 iov[1].iov_base = (char *)smb_buffer + 4;
521 iov[1].iov_len = smb_buf_length;
523 return __smb_send_rqst(server, 1, &rqst);
527 wait_for_free_credits(struct TCP_Server_Info *server, const int num_credits,
528 const int timeout, const int flags,
529 unsigned int *instance)
537 t = MAX_JIFFY_OFFSET;
539 t = msecs_to_jiffies(timeout);
541 optype = flags & CIFS_OP_MASK;
545 credits = server->ops->get_credits_field(server, optype);
546 /* Since an echo is already inflight, no need to wait to send another */
547 if (*credits <= 0 && optype == CIFS_ECHO_OP)
550 spin_lock(&server->req_lock);
551 if ((flags & CIFS_TIMEOUT_MASK) == CIFS_NON_BLOCKING) {
552 /* oplock breaks must not be held up */
554 if (server->in_flight > server->max_in_flight)
555 server->max_in_flight = server->in_flight;
557 *instance = server->reconnect_instance;
558 spin_unlock(&server->req_lock);
563 if (*credits < num_credits) {
564 spin_unlock(&server->req_lock);
565 cifs_num_waiters_inc(server);
566 rc = wait_event_killable_timeout(server->request_q,
567 has_credits(server, credits, num_credits), t);
568 cifs_num_waiters_dec(server);
570 trace_smb3_credit_timeout(server->CurrentMid,
571 server->hostname, num_credits);
572 cifs_server_dbg(VFS, "wait timed out after %d ms\n",
576 if (rc == -ERESTARTSYS)
578 spin_lock(&server->req_lock);
580 if (server->tcpStatus == CifsExiting) {
581 spin_unlock(&server->req_lock);
586 * For normal commands, reserve the last MAX_COMPOUND
587 * credits to compound requests.
588 * Otherwise these compounds could be permanently
589 * starved for credits by single-credit requests.
591 * To prevent spinning CPU, block this thread until
592 * there are >MAX_COMPOUND credits available.
593 * But only do this is we already have a lot of
594 * credits in flight to avoid triggering this check
595 * for servers that are slow to hand out credits on
598 if (!optype && num_credits == 1 &&
599 server->in_flight > 2 * MAX_COMPOUND &&
600 *credits <= MAX_COMPOUND) {
601 spin_unlock(&server->req_lock);
602 cifs_num_waiters_inc(server);
603 rc = wait_event_killable_timeout(
605 has_credits(server, credits,
608 cifs_num_waiters_dec(server);
610 trace_smb3_credit_timeout(
612 server->hostname, num_credits);
613 cifs_server_dbg(VFS, "wait timed out after %d ms\n",
617 if (rc == -ERESTARTSYS)
619 spin_lock(&server->req_lock);
624 * Can not count locking commands against total
625 * as they are allowed to block on server.
628 /* update # of requests on the wire to server */
629 if ((flags & CIFS_TIMEOUT_MASK) != CIFS_BLOCKING_OP) {
630 *credits -= num_credits;
631 server->in_flight += num_credits;
632 if (server->in_flight > server->max_in_flight)
633 server->max_in_flight = server->in_flight;
634 *instance = server->reconnect_instance;
636 spin_unlock(&server->req_lock);
644 wait_for_free_request(struct TCP_Server_Info *server, const int flags,
645 unsigned int *instance)
647 return wait_for_free_credits(server, 1, -1, flags,
652 wait_for_compound_request(struct TCP_Server_Info *server, int num,
653 const int flags, unsigned int *instance)
657 credits = server->ops->get_credits_field(server, flags & CIFS_OP_MASK);
659 spin_lock(&server->req_lock);
660 if (*credits < num) {
662 * Return immediately if not too many requests in flight since
663 * we will likely be stuck on waiting for credits.
665 if (server->in_flight < num - *credits) {
666 spin_unlock(&server->req_lock);
670 spin_unlock(&server->req_lock);
672 return wait_for_free_credits(server, num, 60000, flags,
677 cifs_wait_mtu_credits(struct TCP_Server_Info *server, unsigned int size,
678 unsigned int *num, struct cifs_credits *credits)
682 credits->instance = server->reconnect_instance;
686 static int allocate_mid(struct cifs_ses *ses, struct smb_hdr *in_buf,
687 struct mid_q_entry **ppmidQ)
689 if (ses->server->tcpStatus == CifsExiting) {
693 if (ses->server->tcpStatus == CifsNeedReconnect) {
694 cifs_dbg(FYI, "tcp session dead - return to caller to retry\n");
698 if (ses->status == CifsNew) {
699 if ((in_buf->Command != SMB_COM_SESSION_SETUP_ANDX) &&
700 (in_buf->Command != SMB_COM_NEGOTIATE))
702 /* else ok - we are setting up session */
705 if (ses->status == CifsExiting) {
706 /* check if SMB session is bad because we are setting it up */
707 if (in_buf->Command != SMB_COM_LOGOFF_ANDX)
709 /* else ok - we are shutting down session */
712 *ppmidQ = AllocMidQEntry(in_buf, ses->server);
715 spin_lock(&GlobalMid_Lock);
716 list_add_tail(&(*ppmidQ)->qhead, &ses->server->pending_mid_q);
717 spin_unlock(&GlobalMid_Lock);
722 wait_for_response(struct TCP_Server_Info *server, struct mid_q_entry *midQ)
726 error = wait_event_freezekillable_unsafe(server->response_q,
727 midQ->mid_state != MID_REQUEST_SUBMITTED);
735 cifs_setup_async_request(struct TCP_Server_Info *server, struct smb_rqst *rqst)
738 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
739 struct mid_q_entry *mid;
741 if (rqst->rq_iov[0].iov_len != 4 ||
742 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
743 return ERR_PTR(-EIO);
745 /* enable signing if server requires it */
747 hdr->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
749 mid = AllocMidQEntry(hdr, server);
751 return ERR_PTR(-ENOMEM);
753 rc = cifs_sign_rqst(rqst, server, &mid->sequence_number);
755 DeleteMidQEntry(mid);
763 * Send a SMB request and set the callback function in the mid to handle
764 * the result. Caller is responsible for dealing with timeouts.
767 cifs_call_async(struct TCP_Server_Info *server, struct smb_rqst *rqst,
768 mid_receive_t *receive, mid_callback_t *callback,
769 mid_handle_t *handle, void *cbdata, const int flags,
770 const struct cifs_credits *exist_credits)
773 struct mid_q_entry *mid;
774 struct cifs_credits credits = { .value = 0, .instance = 0 };
775 unsigned int instance;
778 optype = flags & CIFS_OP_MASK;
780 if ((flags & CIFS_HAS_CREDITS) == 0) {
781 rc = wait_for_free_request(server, flags, &instance);
785 credits.instance = instance;
787 instance = exist_credits->instance;
789 mutex_lock(&server->srv_mutex);
792 * We can't use credits obtained from the previous session to send this
793 * request. Check if there were reconnects after we obtained credits and
794 * return -EAGAIN in such cases to let callers handle it.
796 if (instance != server->reconnect_instance) {
797 mutex_unlock(&server->srv_mutex);
798 add_credits_and_wake_if(server, &credits, optype);
802 mid = server->ops->setup_async_request(server, rqst);
804 mutex_unlock(&server->srv_mutex);
805 add_credits_and_wake_if(server, &credits, optype);
809 mid->receive = receive;
810 mid->callback = callback;
811 mid->callback_data = cbdata;
812 mid->handle = handle;
813 mid->mid_state = MID_REQUEST_SUBMITTED;
815 /* put it on the pending_mid_q */
816 spin_lock(&GlobalMid_Lock);
817 list_add_tail(&mid->qhead, &server->pending_mid_q);
818 spin_unlock(&GlobalMid_Lock);
821 * Need to store the time in mid before calling I/O. For call_async,
822 * I/O response may come back and free the mid entry on another thread.
824 cifs_save_when_sent(mid);
825 cifs_in_send_inc(server);
826 rc = smb_send_rqst(server, 1, rqst, flags);
827 cifs_in_send_dec(server);
830 revert_current_mid(server, mid->credits);
831 server->sequence_number -= 2;
832 cifs_delete_mid(mid);
835 mutex_unlock(&server->srv_mutex);
840 add_credits_and_wake_if(server, &credits, optype);
846 * Send an SMB Request. No response info (other than return code)
847 * needs to be parsed.
849 * flags indicate the type of request buffer and how long to wait
850 * and whether to log NT STATUS code (error) before mapping it to POSIX error
854 SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
855 char *in_buf, int flags)
862 iov[0].iov_base = in_buf;
863 iov[0].iov_len = get_rfc1002_length(in_buf) + 4;
864 flags |= CIFS_NO_RSP_BUF;
865 rc = SendReceive2(xid, ses, iov, 1, &resp_buf_type, flags, &rsp_iov);
866 cifs_dbg(NOISY, "SendRcvNoRsp flags %d rc %d\n", flags, rc);
872 cifs_sync_mid_result(struct mid_q_entry *mid, struct TCP_Server_Info *server)
876 cifs_dbg(FYI, "%s: cmd=%d mid=%llu state=%d\n",
877 __func__, le16_to_cpu(mid->command), mid->mid, mid->mid_state);
879 spin_lock(&GlobalMid_Lock);
880 switch (mid->mid_state) {
881 case MID_RESPONSE_RECEIVED:
882 spin_unlock(&GlobalMid_Lock);
884 case MID_RETRY_NEEDED:
887 case MID_RESPONSE_MALFORMED:
894 if (!(mid->mid_flags & MID_DELETED)) {
895 list_del_init(&mid->qhead);
896 mid->mid_flags |= MID_DELETED;
898 cifs_server_dbg(VFS, "%s: invalid mid state mid=%llu state=%d\n",
899 __func__, mid->mid, mid->mid_state);
902 spin_unlock(&GlobalMid_Lock);
904 DeleteMidQEntry(mid);
909 send_cancel(struct TCP_Server_Info *server, struct smb_rqst *rqst,
910 struct mid_q_entry *mid)
912 return server->ops->send_cancel ?
913 server->ops->send_cancel(server, rqst, mid) : 0;
917 cifs_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
920 unsigned int len = get_rfc1002_length(mid->resp_buf) + 4;
922 dump_smb(mid->resp_buf, min_t(u32, 92, len));
924 /* convert the length into a more usable form */
928 struct smb_rqst rqst = { .rq_iov = iov,
931 iov[0].iov_base = mid->resp_buf;
933 iov[1].iov_base = (char *)mid->resp_buf + 4;
934 iov[1].iov_len = len - 4;
935 /* FIXME: add code to kill session */
936 rc = cifs_verify_signature(&rqst, server,
937 mid->sequence_number);
939 cifs_server_dbg(VFS, "SMB signature verification returned error = %d\n",
943 /* BB special case reconnect tid and uid here? */
944 return map_smb_to_linux_error(mid->resp_buf, log_error);
948 cifs_setup_request(struct cifs_ses *ses, struct TCP_Server_Info *ignored,
949 struct smb_rqst *rqst)
952 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
953 struct mid_q_entry *mid;
955 if (rqst->rq_iov[0].iov_len != 4 ||
956 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
957 return ERR_PTR(-EIO);
959 rc = allocate_mid(ses, hdr, &mid);
962 rc = cifs_sign_rqst(rqst, ses->server, &mid->sequence_number);
964 cifs_delete_mid(mid);
971 cifs_compound_callback(struct mid_q_entry *mid)
973 struct TCP_Server_Info *server = mid->server;
974 struct cifs_credits credits;
976 credits.value = server->ops->get_credits(mid);
977 credits.instance = server->reconnect_instance;
979 add_credits(server, &credits, mid->optype);
983 cifs_compound_last_callback(struct mid_q_entry *mid)
985 cifs_compound_callback(mid);
986 cifs_wake_up_task(mid);
990 cifs_cancelled_callback(struct mid_q_entry *mid)
992 cifs_compound_callback(mid);
993 DeleteMidQEntry(mid);
997 compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
998 const int flags, const int num_rqst, struct smb_rqst *rqst,
999 int *resp_buf_type, struct kvec *resp_iov)
1001 int i, j, optype, rc = 0;
1002 struct mid_q_entry *midQ[MAX_COMPOUND];
1003 bool cancelled_mid[MAX_COMPOUND] = {false};
1004 struct cifs_credits credits[MAX_COMPOUND] = {
1005 { .value = 0, .instance = 0 }
1007 unsigned int instance;
1009 struct TCP_Server_Info *server;
1011 optype = flags & CIFS_OP_MASK;
1013 for (i = 0; i < num_rqst; i++)
1014 resp_buf_type[i] = CIFS_NO_BUFFER; /* no response buf yet */
1016 if ((ses == NULL) || (ses->server == NULL)) {
1017 cifs_dbg(VFS, "Null session\n");
1021 if (!ses->binding) {
1024 if (ses->chan_count > 1) {
1025 index = (uint)atomic_inc_return(&ses->chan_seq);
1026 index %= ses->chan_count;
1028 server = ses->chans[index].server;
1030 server = cifs_ses_server(ses);
1033 if (server->tcpStatus == CifsExiting)
1037 * Wait for all the requests to become available.
1038 * This approach still leaves the possibility to be stuck waiting for
1039 * credits if the server doesn't grant credits to the outstanding
1040 * requests and if the client is completely idle, not generating any
1042 * This can be handled by the eventual session reconnect.
1044 rc = wait_for_compound_request(server, num_rqst, flags,
1049 for (i = 0; i < num_rqst; i++) {
1050 credits[i].value = 1;
1051 credits[i].instance = instance;
1055 * Make sure that we sign in the same order that we send on this socket
1056 * and avoid races inside tcp sendmsg code that could cause corruption
1060 mutex_lock(&server->srv_mutex);
1063 * All the parts of the compound chain belong obtained credits from the
1064 * same session. We can not use credits obtained from the previous
1065 * session to send this request. Check if there were reconnects after
1066 * we obtained credits and return -EAGAIN in such cases to let callers
1069 if (instance != server->reconnect_instance) {
1070 mutex_unlock(&server->srv_mutex);
1071 for (j = 0; j < num_rqst; j++)
1072 add_credits(server, &credits[j], optype);
1076 for (i = 0; i < num_rqst; i++) {
1077 midQ[i] = server->ops->setup_request(ses, server, &rqst[i]);
1078 if (IS_ERR(midQ[i])) {
1079 revert_current_mid(server, i);
1080 for (j = 0; j < i; j++)
1081 cifs_delete_mid(midQ[j]);
1082 mutex_unlock(&server->srv_mutex);
1084 /* Update # of requests on wire to server */
1085 for (j = 0; j < num_rqst; j++)
1086 add_credits(server, &credits[j], optype);
1087 return PTR_ERR(midQ[i]);
1090 midQ[i]->mid_state = MID_REQUEST_SUBMITTED;
1091 midQ[i]->optype = optype;
1093 * Invoke callback for every part of the compound chain
1094 * to calculate credits properly. Wake up this thread only when
1095 * the last element is received.
1097 if (i < num_rqst - 1)
1098 midQ[i]->callback = cifs_compound_callback;
1100 midQ[i]->callback = cifs_compound_last_callback;
1102 cifs_in_send_inc(server);
1103 rc = smb_send_rqst(server, num_rqst, rqst, flags);
1104 cifs_in_send_dec(server);
1106 for (i = 0; i < num_rqst; i++)
1107 cifs_save_when_sent(midQ[i]);
1110 revert_current_mid(server, num_rqst);
1111 server->sequence_number -= 2;
1114 mutex_unlock(&server->srv_mutex);
1117 * If sending failed for some reason or it is an oplock break that we
1118 * will not receive a response to - return credits back
1120 if (rc < 0 || (flags & CIFS_NO_SRV_RSP)) {
1121 for (i = 0; i < num_rqst; i++)
1122 add_credits(server, &credits[i], optype);
1127 * At this point the request is passed to the network stack - we assume
1128 * that any credits taken from the server structure on the client have
1129 * been spent and we can't return them back. Once we receive responses
1130 * we will collect credits granted by the server in the mid callbacks
1131 * and add those credits to the server structure.
1135 * Compounding is never used during session establish.
1137 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP))
1138 smb311_update_preauth_hash(ses, rqst[0].rq_iov,
1141 for (i = 0; i < num_rqst; i++) {
1142 rc = wait_for_response(server, midQ[i]);
1147 for (; i < num_rqst; i++) {
1148 cifs_server_dbg(VFS, "Cancelling wait for mid %llu cmd: %d\n",
1149 midQ[i]->mid, le16_to_cpu(midQ[i]->command));
1150 send_cancel(server, &rqst[i], midQ[i]);
1151 spin_lock(&GlobalMid_Lock);
1152 midQ[i]->mid_flags |= MID_WAIT_CANCELLED;
1153 if (midQ[i]->mid_state == MID_REQUEST_SUBMITTED) {
1154 midQ[i]->callback = cifs_cancelled_callback;
1155 cancelled_mid[i] = true;
1156 credits[i].value = 0;
1158 spin_unlock(&GlobalMid_Lock);
1162 for (i = 0; i < num_rqst; i++) {
1166 rc = cifs_sync_mid_result(midQ[i], server);
1168 /* mark this mid as cancelled to not free it below */
1169 cancelled_mid[i] = true;
1173 if (!midQ[i]->resp_buf ||
1174 midQ[i]->mid_state != MID_RESPONSE_RECEIVED) {
1176 cifs_dbg(FYI, "Bad MID state?\n");
1180 buf = (char *)midQ[i]->resp_buf;
1181 resp_iov[i].iov_base = buf;
1182 resp_iov[i].iov_len = midQ[i]->resp_buf_size +
1183 server->vals->header_preamble_size;
1185 if (midQ[i]->large_buf)
1186 resp_buf_type[i] = CIFS_LARGE_BUFFER;
1188 resp_buf_type[i] = CIFS_SMALL_BUFFER;
1190 rc = server->ops->check_receive(midQ[i], server,
1191 flags & CIFS_LOG_ERROR);
1193 /* mark it so buf will not be freed by cifs_delete_mid */
1194 if ((flags & CIFS_NO_RSP_BUF) == 0)
1195 midQ[i]->resp_buf = NULL;
1200 * Compounding is never used during session establish.
1202 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP)) {
1204 .iov_base = resp_iov[0].iov_base,
1205 .iov_len = resp_iov[0].iov_len
1207 smb311_update_preauth_hash(ses, &iov, 1);
1212 * This will dequeue all mids. After this it is important that the
1213 * demultiplex_thread will not process any of these mids any futher.
1214 * This is prevented above by using a noop callback that will not
1215 * wake this thread except for the very last PDU.
1217 for (i = 0; i < num_rqst; i++) {
1218 if (!cancelled_mid[i])
1219 cifs_delete_mid(midQ[i]);
1226 cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
1227 struct smb_rqst *rqst, int *resp_buf_type, const int flags,
1228 struct kvec *resp_iov)
1230 return compound_send_recv(xid, ses, flags, 1, rqst, resp_buf_type,
1235 SendReceive2(const unsigned int xid, struct cifs_ses *ses,
1236 struct kvec *iov, int n_vec, int *resp_buf_type /* ret */,
1237 const int flags, struct kvec *resp_iov)
1239 struct smb_rqst rqst;
1240 struct kvec s_iov[CIFS_MAX_IOV_SIZE], *new_iov;
1243 if (n_vec + 1 > CIFS_MAX_IOV_SIZE) {
1244 new_iov = kmalloc_array(n_vec + 1, sizeof(struct kvec),
1247 /* otherwise cifs_send_recv below sets resp_buf_type */
1248 *resp_buf_type = CIFS_NO_BUFFER;
1254 /* 1st iov is a RFC1001 length followed by the rest of the packet */
1255 memcpy(new_iov + 1, iov, (sizeof(struct kvec) * n_vec));
1257 new_iov[0].iov_base = new_iov[1].iov_base;
1258 new_iov[0].iov_len = 4;
1259 new_iov[1].iov_base += 4;
1260 new_iov[1].iov_len -= 4;
1262 memset(&rqst, 0, sizeof(struct smb_rqst));
1263 rqst.rq_iov = new_iov;
1264 rqst.rq_nvec = n_vec + 1;
1266 rc = cifs_send_recv(xid, ses, &rqst, resp_buf_type, flags, resp_iov);
1267 if (n_vec + 1 > CIFS_MAX_IOV_SIZE)
1273 SendReceive(const unsigned int xid, struct cifs_ses *ses,
1274 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1275 int *pbytes_returned, const int flags)
1278 struct mid_q_entry *midQ;
1279 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1280 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1281 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1282 struct cifs_credits credits = { .value = 1, .instance = 0 };
1283 struct TCP_Server_Info *server;
1286 cifs_dbg(VFS, "Null smb session\n");
1289 server = ses->server;
1290 if (server == NULL) {
1291 cifs_dbg(VFS, "Null tcp session\n");
1295 if (server->tcpStatus == CifsExiting)
1298 /* Ensure that we do not send more than 50 overlapping requests
1299 to the same server. We may make this configurable later or
1302 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1303 cifs_server_dbg(VFS, "Illegal length, greater than maximum frame, %d\n",
1308 rc = wait_for_free_request(server, flags, &credits.instance);
1312 /* make sure that we sign in the same order that we send on this socket
1313 and avoid races inside tcp sendmsg code that could cause corruption
1316 mutex_lock(&server->srv_mutex);
1318 rc = allocate_mid(ses, in_buf, &midQ);
1320 mutex_unlock(&server->srv_mutex);
1321 /* Update # of requests on wire to server */
1322 add_credits(server, &credits, 0);
1326 rc = cifs_sign_smb(in_buf, server, &midQ->sequence_number);
1328 mutex_unlock(&server->srv_mutex);
1332 midQ->mid_state = MID_REQUEST_SUBMITTED;
1334 cifs_in_send_inc(server);
1335 rc = smb_send(server, in_buf, len);
1336 cifs_in_send_dec(server);
1337 cifs_save_when_sent(midQ);
1340 server->sequence_number -= 2;
1342 mutex_unlock(&server->srv_mutex);
1347 rc = wait_for_response(server, midQ);
1349 send_cancel(server, &rqst, midQ);
1350 spin_lock(&GlobalMid_Lock);
1351 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1352 /* no longer considered to be "in-flight" */
1353 midQ->callback = DeleteMidQEntry;
1354 spin_unlock(&GlobalMid_Lock);
1355 add_credits(server, &credits, 0);
1358 spin_unlock(&GlobalMid_Lock);
1361 rc = cifs_sync_mid_result(midQ, server);
1363 add_credits(server, &credits, 0);
1367 if (!midQ->resp_buf || !out_buf ||
1368 midQ->mid_state != MID_RESPONSE_RECEIVED) {
1370 cifs_server_dbg(VFS, "Bad MID state?\n");
1374 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1375 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1376 rc = cifs_check_receive(midQ, server, 0);
1378 cifs_delete_mid(midQ);
1379 add_credits(server, &credits, 0);
1384 /* We send a LOCKINGX_CANCEL_LOCK to cause the Windows
1385 blocking lock to return. */
1388 send_lock_cancel(const unsigned int xid, struct cifs_tcon *tcon,
1389 struct smb_hdr *in_buf,
1390 struct smb_hdr *out_buf)
1393 struct cifs_ses *ses = tcon->ses;
1394 LOCK_REQ *pSMB = (LOCK_REQ *)in_buf;
1396 /* We just modify the current in_buf to change
1397 the type of lock from LOCKING_ANDX_SHARED_LOCK
1398 or LOCKING_ANDX_EXCLUSIVE_LOCK to
1399 LOCKING_ANDX_CANCEL_LOCK. */
1401 pSMB->LockType = LOCKING_ANDX_CANCEL_LOCK|LOCKING_ANDX_LARGE_FILES;
1403 pSMB->hdr.Mid = get_next_mid(ses->server);
1405 return SendReceive(xid, ses, in_buf, out_buf,
1406 &bytes_returned, 0);
1410 SendReceiveBlockingLock(const unsigned int xid, struct cifs_tcon *tcon,
1411 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1412 int *pbytes_returned)
1416 struct mid_q_entry *midQ;
1417 struct cifs_ses *ses;
1418 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1419 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1420 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1421 unsigned int instance;
1422 struct TCP_Server_Info *server;
1424 if (tcon == NULL || tcon->ses == NULL) {
1425 cifs_dbg(VFS, "Null smb session\n");
1429 server = ses->server;
1431 if (server == NULL) {
1432 cifs_dbg(VFS, "Null tcp session\n");
1436 if (server->tcpStatus == CifsExiting)
1439 /* Ensure that we do not send more than 50 overlapping requests
1440 to the same server. We may make this configurable later or
1443 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1444 cifs_tcon_dbg(VFS, "Illegal length, greater than maximum frame, %d\n",
1449 rc = wait_for_free_request(server, CIFS_BLOCKING_OP, &instance);
1453 /* make sure that we sign in the same order that we send on this socket
1454 and avoid races inside tcp sendmsg code that could cause corruption
1457 mutex_lock(&server->srv_mutex);
1459 rc = allocate_mid(ses, in_buf, &midQ);
1461 mutex_unlock(&server->srv_mutex);
1465 rc = cifs_sign_smb(in_buf, server, &midQ->sequence_number);
1467 cifs_delete_mid(midQ);
1468 mutex_unlock(&server->srv_mutex);
1472 midQ->mid_state = MID_REQUEST_SUBMITTED;
1473 cifs_in_send_inc(server);
1474 rc = smb_send(server, in_buf, len);
1475 cifs_in_send_dec(server);
1476 cifs_save_when_sent(midQ);
1479 server->sequence_number -= 2;
1481 mutex_unlock(&server->srv_mutex);
1484 cifs_delete_mid(midQ);
1488 /* Wait for a reply - allow signals to interrupt. */
1489 rc = wait_event_interruptible(server->response_q,
1490 (!(midQ->mid_state == MID_REQUEST_SUBMITTED)) ||
1491 ((server->tcpStatus != CifsGood) &&
1492 (server->tcpStatus != CifsNew)));
1494 /* Were we interrupted by a signal ? */
1495 if ((rc == -ERESTARTSYS) &&
1496 (midQ->mid_state == MID_REQUEST_SUBMITTED) &&
1497 ((server->tcpStatus == CifsGood) ||
1498 (server->tcpStatus == CifsNew))) {
1500 if (in_buf->Command == SMB_COM_TRANSACTION2) {
1501 /* POSIX lock. We send a NT_CANCEL SMB to cause the
1502 blocking lock to return. */
1503 rc = send_cancel(server, &rqst, midQ);
1505 cifs_delete_mid(midQ);
1509 /* Windows lock. We send a LOCKINGX_CANCEL_LOCK
1510 to cause the blocking lock to return. */
1512 rc = send_lock_cancel(xid, tcon, in_buf, out_buf);
1514 /* If we get -ENOLCK back the lock may have
1515 already been removed. Don't exit in this case. */
1516 if (rc && rc != -ENOLCK) {
1517 cifs_delete_mid(midQ);
1522 rc = wait_for_response(server, midQ);
1524 send_cancel(server, &rqst, midQ);
1525 spin_lock(&GlobalMid_Lock);
1526 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1527 /* no longer considered to be "in-flight" */
1528 midQ->callback = DeleteMidQEntry;
1529 spin_unlock(&GlobalMid_Lock);
1532 spin_unlock(&GlobalMid_Lock);
1535 /* We got the response - restart system call. */
1539 rc = cifs_sync_mid_result(midQ, server);
1543 /* rcvd frame is ok */
1544 if (out_buf == NULL || midQ->mid_state != MID_RESPONSE_RECEIVED) {
1546 cifs_tcon_dbg(VFS, "Bad MID state?\n");
1550 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1551 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1552 rc = cifs_check_receive(midQ, server, 0);
1554 cifs_delete_mid(midQ);
1555 if (rstart && rc == -EACCES)
1556 return -ERESTARTSYS;