1 // SPDX-License-Identifier: LGPL-2.1
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.
11 #include <linux/list.h>
12 #include <linux/gfp.h>
13 #include <linux/wait.h>
14 #include <linux/net.h>
15 #include <linux/delay.h>
16 #include <linux/freezer.h>
17 #include <linux/tcp.h>
18 #include <linux/bvec.h>
19 #include <linux/highmem.h>
20 #include <linux/uaccess.h>
21 #include <asm/processor.h>
22 #include <linux/mempool.h>
23 #include <linux/sched/signal.h>
26 #include "cifsproto.h"
27 #include "cifs_debug.h"
28 #include "smb2proto.h"
29 #include "smbdirect.h"
31 /* Max number of iovectors we can use off the stack when sending requests. */
32 #define CIFS_MAX_IOV_SIZE 8
35 cifs_wake_up_task(struct mid_q_entry *mid)
37 wake_up_process(mid->callback_data);
41 AllocMidQEntry(const struct smb_hdr *smb_buffer, struct TCP_Server_Info *server)
43 struct mid_q_entry *temp;
46 cifs_dbg(VFS, "Null TCP session in AllocMidQEntry\n");
50 temp = mempool_alloc(cifs_mid_poolp, GFP_NOFS);
51 memset(temp, 0, sizeof(struct mid_q_entry));
52 kref_init(&temp->refcount);
53 temp->mid = get_mid(smb_buffer);
54 temp->pid = current->pid;
55 temp->command = cpu_to_le16(smb_buffer->Command);
56 cifs_dbg(FYI, "For smb_command %d\n", smb_buffer->Command);
57 /* do_gettimeofday(&temp->when_sent);*/ /* easier to use jiffies */
58 /* when mid allocated can be before when sent */
59 temp->when_alloc = jiffies;
60 temp->server = server;
63 * The default is for the mid to be synchronous, so the
64 * default callback just wakes up the current task.
66 get_task_struct(current);
67 temp->creator = current;
68 temp->callback = cifs_wake_up_task;
69 temp->callback_data = current;
71 atomic_inc(&midCount);
72 temp->mid_state = MID_REQUEST_ALLOCATED;
76 static void _cifs_mid_q_entry_release(struct kref *refcount)
78 struct mid_q_entry *midEntry =
79 container_of(refcount, struct mid_q_entry, refcount);
80 #ifdef CONFIG_CIFS_STATS2
81 __le16 command = midEntry->server->vals->lock_cmd;
82 __u16 smb_cmd = le16_to_cpu(midEntry->command);
84 unsigned long roundtrip_time;
86 struct TCP_Server_Info *server = midEntry->server;
88 if (midEntry->resp_buf && (midEntry->mid_flags & MID_WAIT_CANCELLED) &&
89 midEntry->mid_state == MID_RESPONSE_RECEIVED &&
90 server->ops->handle_cancelled_mid)
91 server->ops->handle_cancelled_mid(midEntry, server);
93 midEntry->mid_state = MID_FREE;
94 atomic_dec(&midCount);
95 if (midEntry->large_buf)
96 cifs_buf_release(midEntry->resp_buf);
98 cifs_small_buf_release(midEntry->resp_buf);
99 #ifdef CONFIG_CIFS_STATS2
101 if (now < midEntry->when_alloc)
102 cifs_server_dbg(VFS, "Invalid mid allocation time\n");
103 roundtrip_time = now - midEntry->when_alloc;
105 if (smb_cmd < NUMBER_OF_SMB2_COMMANDS) {
106 if (atomic_read(&server->num_cmds[smb_cmd]) == 0) {
107 server->slowest_cmd[smb_cmd] = roundtrip_time;
108 server->fastest_cmd[smb_cmd] = roundtrip_time;
110 if (server->slowest_cmd[smb_cmd] < roundtrip_time)
111 server->slowest_cmd[smb_cmd] = roundtrip_time;
112 else if (server->fastest_cmd[smb_cmd] > roundtrip_time)
113 server->fastest_cmd[smb_cmd] = roundtrip_time;
115 cifs_stats_inc(&server->num_cmds[smb_cmd]);
116 server->time_per_cmd[smb_cmd] += roundtrip_time;
119 * commands taking longer than one second (default) can be indications
120 * that something is wrong, unless it is quite a slow link or a very
121 * busy server. Note that this calc is unlikely or impossible to wrap
122 * as long as slow_rsp_threshold is not set way above recommended max
123 * value (32767 ie 9 hours) and is generally harmless even if wrong
124 * since only affects debug counters - so leaving the calc as simple
125 * comparison rather than doing multiple conversions and overflow
128 if ((slow_rsp_threshold != 0) &&
129 time_after(now, midEntry->when_alloc + (slow_rsp_threshold * HZ)) &&
130 (midEntry->command != command)) {
132 * smb2slowcmd[NUMBER_OF_SMB2_COMMANDS] counts by command
133 * NB: le16_to_cpu returns unsigned so can not be negative below
135 if (smb_cmd < NUMBER_OF_SMB2_COMMANDS)
136 cifs_stats_inc(&server->smb2slowcmd[smb_cmd]);
138 trace_smb3_slow_rsp(smb_cmd, midEntry->mid, midEntry->pid,
139 midEntry->when_sent, midEntry->when_received);
140 if (cifsFYI & CIFS_TIMER) {
141 pr_debug("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 put_task_struct(midEntry->creator);
152 mempool_free(midEntry, cifs_mid_poolp);
155 void cifs_mid_q_entry_release(struct mid_q_entry *midEntry)
157 spin_lock(&GlobalMid_Lock);
158 kref_put(&midEntry->refcount, _cifs_mid_q_entry_release);
159 spin_unlock(&GlobalMid_Lock);
162 void DeleteMidQEntry(struct mid_q_entry *midEntry)
164 cifs_mid_q_entry_release(midEntry);
168 cifs_delete_mid(struct mid_q_entry *mid)
170 spin_lock(&GlobalMid_Lock);
171 if (!(mid->mid_flags & MID_DELETED)) {
172 list_del_init(&mid->qhead);
173 mid->mid_flags |= MID_DELETED;
175 spin_unlock(&GlobalMid_Lock);
177 DeleteMidQEntry(mid);
181 * smb_send_kvec - send an array of kvecs to the server
182 * @server: Server to send the data to
183 * @smb_msg: Message to send
184 * @sent: amount of data sent on socket is stored here
186 * Our basic "send data to server" function. Should be called with srv_mutex
187 * held. The caller is responsible for handling the results.
190 smb_send_kvec(struct TCP_Server_Info *server, struct msghdr *smb_msg,
195 struct socket *ssocket = server->ssocket;
199 smb_msg->msg_name = (struct sockaddr *) &server->dstaddr;
200 smb_msg->msg_namelen = sizeof(struct sockaddr);
201 smb_msg->msg_control = NULL;
202 smb_msg->msg_controllen = 0;
203 if (server->noblocksnd)
204 smb_msg->msg_flags = MSG_DONTWAIT + MSG_NOSIGNAL;
206 smb_msg->msg_flags = MSG_NOSIGNAL;
208 while (msg_data_left(smb_msg)) {
210 * If blocking send, we try 3 times, since each can block
211 * for 5 seconds. For nonblocking we have to try more
212 * but wait increasing amounts of time allowing time for
213 * socket to clear. The overall time we wait in either
214 * case to send on the socket is about 15 seconds.
215 * Similarly we wait for 15 seconds for a response from
216 * the server in SendReceive[2] for the server to send
217 * a response back for most types of requests (except
218 * SMB Write past end of file which can be slow, and
219 * blocking lock operations). NFS waits slightly longer
220 * than CIFS, but this can make it take longer for
221 * nonresponsive servers to be detected and 15 seconds
222 * is more than enough time for modern networks to
223 * send a packet. In most cases if we fail to send
224 * after the retries we will kill the socket and
225 * reconnect which may clear the network problem.
227 rc = sock_sendmsg(ssocket, smb_msg);
231 (!server->noblocksnd && (retries > 2))) {
232 cifs_server_dbg(VFS, "sends on sock %p stuck for 15 seconds\n",
236 msleep(1 << retries);
244 /* should never happen, letting socket clear before
245 retrying is our only obvious option here */
246 cifs_server_dbg(VFS, "tcp sent no data\n");
251 /* send was at least partially successful */
253 retries = 0; /* in case we get ENOSPC on the next send */
259 smb_rqst_len(struct TCP_Server_Info *server, struct smb_rqst *rqst)
264 unsigned long buflen = 0;
266 if (server->vals->header_preamble_size == 0 &&
267 rqst->rq_nvec >= 2 && rqst->rq_iov[0].iov_len == 4) {
268 iov = &rqst->rq_iov[1];
269 nvec = rqst->rq_nvec - 1;
272 nvec = rqst->rq_nvec;
275 /* total up iov array first */
276 for (i = 0; i < nvec; i++)
277 buflen += iov[i].iov_len;
280 * Add in the page array if there is one. The caller needs to make
281 * sure rq_offset and rq_tailsz are set correctly. If a buffer of
282 * multiple pages ends at page boundary, rq_tailsz needs to be set to
285 if (rqst->rq_npages) {
286 if (rqst->rq_npages == 1)
287 buflen += rqst->rq_tailsz;
290 * If there is more than one page, calculate the
291 * buffer length based on rq_offset and rq_tailsz
293 buflen += rqst->rq_pagesz * (rqst->rq_npages - 1) -
295 buflen += rqst->rq_tailsz;
303 __smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
304 struct smb_rqst *rqst)
309 unsigned int send_length = 0;
311 sigset_t mask, oldmask;
312 size_t total_len = 0, sent, size;
313 struct socket *ssocket = server->ssocket;
314 struct msghdr smb_msg;
315 __be32 rfc1002_marker;
317 if (cifs_rdma_enabled(server)) {
318 /* return -EAGAIN when connecting or reconnecting */
320 if (server->smbd_conn)
321 rc = smbd_send(server, num_rqst, rqst);
328 if (fatal_signal_pending(current)) {
329 cifs_dbg(FYI, "signal pending before send request\n");
333 /* cork the socket */
334 tcp_sock_set_cork(ssocket->sk, true);
336 for (j = 0; j < num_rqst; j++)
337 send_length += smb_rqst_len(server, &rqst[j]);
338 rfc1002_marker = cpu_to_be32(send_length);
341 * We should not allow signals to interrupt the network send because
342 * any partial send will cause session reconnects thus increasing
343 * latency of system calls and overload a server with unnecessary
348 sigprocmask(SIG_BLOCK, &mask, &oldmask);
350 /* Generate a rfc1002 marker for SMB2+ */
351 if (server->vals->header_preamble_size == 0) {
353 .iov_base = &rfc1002_marker,
356 iov_iter_kvec(&smb_msg.msg_iter, WRITE, &hiov, 1, 4);
357 rc = smb_send_kvec(server, &smb_msg, &sent);
365 cifs_dbg(FYI, "Sending smb: smb_len=%u\n", send_length);
367 for (j = 0; j < num_rqst; j++) {
368 iov = rqst[j].rq_iov;
369 n_vec = rqst[j].rq_nvec;
372 for (i = 0; i < n_vec; i++) {
373 dump_smb(iov[i].iov_base, iov[i].iov_len);
374 size += iov[i].iov_len;
377 iov_iter_kvec(&smb_msg.msg_iter, WRITE, iov, n_vec, size);
379 rc = smb_send_kvec(server, &smb_msg, &sent);
385 /* now walk the page array and send each page in it */
386 for (i = 0; i < rqst[j].rq_npages; i++) {
389 bvec.bv_page = rqst[j].rq_pages[i];
390 rqst_page_get_length(&rqst[j], i, &bvec.bv_len,
393 iov_iter_bvec(&smb_msg.msg_iter, WRITE,
394 &bvec, 1, bvec.bv_len);
395 rc = smb_send_kvec(server, &smb_msg, &sent);
404 sigprocmask(SIG_SETMASK, &oldmask, NULL);
407 * If signal is pending but we have already sent the whole packet to
408 * the server we need to return success status to allow a corresponding
409 * mid entry to be kept in the pending requests queue thus allowing
410 * to handle responses from the server by the client.
412 * If only part of the packet has been sent there is no need to hide
413 * interrupt because the session will be reconnected anyway, so there
414 * won't be any response from the server to handle.
417 if (signal_pending(current) && (total_len != send_length)) {
418 cifs_dbg(FYI, "signal is pending after attempt to send\n");
423 tcp_sock_set_cork(ssocket->sk, false);
425 if ((total_len > 0) && (total_len != send_length)) {
426 cifs_dbg(FYI, "partial send (wanted=%u sent=%zu): terminating session\n",
427 send_length, total_len);
429 * If we have only sent part of an SMB then the next SMB could
430 * be taken as the remainder of this one. We need to kill the
431 * socket so the server throws away the partial SMB
433 cifs_signal_cifsd_for_reconnect(server, false);
434 trace_smb3_partial_send_reconnect(server->CurrentMid,
435 server->conn_id, server->hostname);
438 if (rc < 0 && rc != -EINTR)
439 cifs_server_dbg(VFS, "Error %d sending data on socket to server\n",
448 smb_send_rqst(struct TCP_Server_Info *server, int num_rqst,
449 struct smb_rqst *rqst, int flags)
452 struct smb2_transform_hdr *tr_hdr;
453 struct smb_rqst cur_rqst[MAX_COMPOUND];
456 if (!(flags & CIFS_TRANSFORM_REQ))
457 return __smb_send_rqst(server, num_rqst, rqst);
459 if (num_rqst > MAX_COMPOUND - 1)
462 if (!server->ops->init_transform_rq) {
463 cifs_server_dbg(VFS, "Encryption requested but transform callback is missing\n");
467 tr_hdr = kmalloc(sizeof(*tr_hdr), GFP_NOFS);
471 memset(&cur_rqst[0], 0, sizeof(cur_rqst));
472 memset(&iov, 0, sizeof(iov));
473 memset(tr_hdr, 0, sizeof(*tr_hdr));
475 iov.iov_base = tr_hdr;
476 iov.iov_len = sizeof(*tr_hdr);
477 cur_rqst[0].rq_iov = &iov;
478 cur_rqst[0].rq_nvec = 1;
480 rc = server->ops->init_transform_rq(server, num_rqst + 1,
485 rc = __smb_send_rqst(server, num_rqst + 1, &cur_rqst[0]);
486 smb3_free_compound_rqst(num_rqst, &cur_rqst[1]);
493 smb_send(struct TCP_Server_Info *server, struct smb_hdr *smb_buffer,
494 unsigned int smb_buf_length)
497 struct smb_rqst rqst = { .rq_iov = iov,
500 iov[0].iov_base = smb_buffer;
502 iov[1].iov_base = (char *)smb_buffer + 4;
503 iov[1].iov_len = smb_buf_length;
505 return __smb_send_rqst(server, 1, &rqst);
509 wait_for_free_credits(struct TCP_Server_Info *server, const int num_credits,
510 const int timeout, const int flags,
511 unsigned int *instance)
517 int scredits, in_flight;
520 t = MAX_JIFFY_OFFSET;
522 t = msecs_to_jiffies(timeout);
524 optype = flags & CIFS_OP_MASK;
528 credits = server->ops->get_credits_field(server, optype);
529 /* Since an echo is already inflight, no need to wait to send another */
530 if (*credits <= 0 && optype == CIFS_ECHO_OP)
533 spin_lock(&server->req_lock);
534 if ((flags & CIFS_TIMEOUT_MASK) == CIFS_NON_BLOCKING) {
535 /* oplock breaks must not be held up */
537 if (server->in_flight > server->max_in_flight)
538 server->max_in_flight = server->in_flight;
540 *instance = server->reconnect_instance;
542 in_flight = server->in_flight;
543 spin_unlock(&server->req_lock);
545 trace_smb3_nblk_credits(server->CurrentMid,
546 server->conn_id, server->hostname, scredits, -1, in_flight);
547 cifs_dbg(FYI, "%s: remove %u credits total=%d\n",
548 __func__, 1, scredits);
554 if (*credits < num_credits) {
556 spin_unlock(&server->req_lock);
558 cifs_num_waiters_inc(server);
559 rc = wait_event_killable_timeout(server->request_q,
560 has_credits(server, credits, num_credits), t);
561 cifs_num_waiters_dec(server);
563 spin_lock(&server->req_lock);
565 in_flight = server->in_flight;
566 spin_unlock(&server->req_lock);
568 trace_smb3_credit_timeout(server->CurrentMid,
569 server->conn_id, server->hostname, scredits,
570 num_credits, in_flight);
571 cifs_server_dbg(VFS, "wait timed out after %d ms\n",
575 if (rc == -ERESTARTSYS)
577 spin_lock(&server->req_lock);
579 spin_unlock(&server->req_lock);
581 spin_lock(&cifs_tcp_ses_lock);
582 if (server->tcpStatus == CifsExiting) {
583 spin_unlock(&cifs_tcp_ses_lock);
586 spin_unlock(&cifs_tcp_ses_lock);
589 * For normal commands, reserve the last MAX_COMPOUND
590 * credits to compound requests.
591 * Otherwise these compounds could be permanently
592 * starved for credits by single-credit requests.
594 * To prevent spinning CPU, block this thread until
595 * there are >MAX_COMPOUND credits available.
596 * But only do this is we already have a lot of
597 * credits in flight to avoid triggering this check
598 * for servers that are slow to hand out credits on
601 spin_lock(&server->req_lock);
602 if (!optype && num_credits == 1 &&
603 server->in_flight > 2 * MAX_COMPOUND &&
604 *credits <= MAX_COMPOUND) {
605 spin_unlock(&server->req_lock);
607 cifs_num_waiters_inc(server);
608 rc = wait_event_killable_timeout(
610 has_credits(server, credits,
613 cifs_num_waiters_dec(server);
615 spin_lock(&server->req_lock);
617 in_flight = server->in_flight;
618 spin_unlock(&server->req_lock);
620 trace_smb3_credit_timeout(
622 server->conn_id, server->hostname,
623 scredits, num_credits, in_flight);
624 cifs_server_dbg(VFS, "wait timed out after %d ms\n",
628 if (rc == -ERESTARTSYS)
630 spin_lock(&server->req_lock);
635 * Can not count locking commands against total
636 * as they are allowed to block on server.
639 /* update # of requests on the wire to server */
640 if ((flags & CIFS_TIMEOUT_MASK) != CIFS_BLOCKING_OP) {
641 *credits -= num_credits;
642 server->in_flight += num_credits;
643 if (server->in_flight > server->max_in_flight)
644 server->max_in_flight = server->in_flight;
645 *instance = server->reconnect_instance;
648 in_flight = server->in_flight;
649 spin_unlock(&server->req_lock);
651 trace_smb3_waitff_credits(server->CurrentMid,
652 server->conn_id, server->hostname, scredits,
653 -(num_credits), in_flight);
654 cifs_dbg(FYI, "%s: remove %u credits total=%d\n",
655 __func__, num_credits, scredits);
663 wait_for_free_request(struct TCP_Server_Info *server, const int flags,
664 unsigned int *instance)
666 return wait_for_free_credits(server, 1, -1, flags,
671 wait_for_compound_request(struct TCP_Server_Info *server, int num,
672 const int flags, unsigned int *instance)
675 int scredits, in_flight;
677 credits = server->ops->get_credits_field(server, flags & CIFS_OP_MASK);
679 spin_lock(&server->req_lock);
681 in_flight = server->in_flight;
683 if (*credits < num) {
685 * If the server is tight on resources or just gives us less
686 * credits for other reasons (e.g. requests are coming out of
687 * order and the server delays granting more credits until it
688 * processes a missing mid) and we exhausted most available
689 * credits there may be situations when we try to send
690 * a compound request but we don't have enough credits. At this
691 * point the client needs to decide if it should wait for
692 * additional credits or fail the request. If at least one
693 * request is in flight there is a high probability that the
694 * server will return enough credits to satisfy this compound
697 * Return immediately if no requests in flight since we will be
698 * stuck on waiting for credits.
700 if (server->in_flight == 0) {
701 spin_unlock(&server->req_lock);
702 trace_smb3_insufficient_credits(server->CurrentMid,
703 server->conn_id, server->hostname, scredits,
705 cifs_dbg(FYI, "%s: %d requests in flight, needed %d total=%d\n",
706 __func__, in_flight, num, scredits);
710 spin_unlock(&server->req_lock);
712 return wait_for_free_credits(server, num, 60000, flags,
717 cifs_wait_mtu_credits(struct TCP_Server_Info *server, unsigned int size,
718 unsigned int *num, struct cifs_credits *credits)
722 credits->instance = server->reconnect_instance;
726 static int allocate_mid(struct cifs_ses *ses, struct smb_hdr *in_buf,
727 struct mid_q_entry **ppmidQ)
729 spin_lock(&cifs_tcp_ses_lock);
730 if (ses->status == CifsNew) {
731 if ((in_buf->Command != SMB_COM_SESSION_SETUP_ANDX) &&
732 (in_buf->Command != SMB_COM_NEGOTIATE)) {
733 spin_unlock(&cifs_tcp_ses_lock);
736 /* else ok - we are setting up session */
739 if (ses->status == CifsExiting) {
740 /* check if SMB session is bad because we are setting it up */
741 if (in_buf->Command != SMB_COM_LOGOFF_ANDX) {
742 spin_unlock(&cifs_tcp_ses_lock);
745 /* else ok - we are shutting down session */
747 spin_unlock(&cifs_tcp_ses_lock);
749 *ppmidQ = AllocMidQEntry(in_buf, ses->server);
752 spin_lock(&GlobalMid_Lock);
753 list_add_tail(&(*ppmidQ)->qhead, &ses->server->pending_mid_q);
754 spin_unlock(&GlobalMid_Lock);
759 wait_for_response(struct TCP_Server_Info *server, struct mid_q_entry *midQ)
763 error = wait_event_freezekillable_unsafe(server->response_q,
764 midQ->mid_state != MID_REQUEST_SUBMITTED);
772 cifs_setup_async_request(struct TCP_Server_Info *server, struct smb_rqst *rqst)
775 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
776 struct mid_q_entry *mid;
778 if (rqst->rq_iov[0].iov_len != 4 ||
779 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
780 return ERR_PTR(-EIO);
782 /* enable signing if server requires it */
784 hdr->Flags2 |= SMBFLG2_SECURITY_SIGNATURE;
786 mid = AllocMidQEntry(hdr, server);
788 return ERR_PTR(-ENOMEM);
790 rc = cifs_sign_rqst(rqst, server, &mid->sequence_number);
792 DeleteMidQEntry(mid);
800 * Send a SMB request and set the callback function in the mid to handle
801 * the result. Caller is responsible for dealing with timeouts.
804 cifs_call_async(struct TCP_Server_Info *server, struct smb_rqst *rqst,
805 mid_receive_t *receive, mid_callback_t *callback,
806 mid_handle_t *handle, void *cbdata, const int flags,
807 const struct cifs_credits *exist_credits)
810 struct mid_q_entry *mid;
811 struct cifs_credits credits = { .value = 0, .instance = 0 };
812 unsigned int instance;
815 optype = flags & CIFS_OP_MASK;
817 if ((flags & CIFS_HAS_CREDITS) == 0) {
818 rc = wait_for_free_request(server, flags, &instance);
822 credits.instance = instance;
824 instance = exist_credits->instance;
826 mutex_lock(&server->srv_mutex);
829 * We can't use credits obtained from the previous session to send this
830 * request. Check if there were reconnects after we obtained credits and
831 * return -EAGAIN in such cases to let callers handle it.
833 if (instance != server->reconnect_instance) {
834 mutex_unlock(&server->srv_mutex);
835 add_credits_and_wake_if(server, &credits, optype);
839 mid = server->ops->setup_async_request(server, rqst);
841 mutex_unlock(&server->srv_mutex);
842 add_credits_and_wake_if(server, &credits, optype);
846 mid->receive = receive;
847 mid->callback = callback;
848 mid->callback_data = cbdata;
849 mid->handle = handle;
850 mid->mid_state = MID_REQUEST_SUBMITTED;
852 /* put it on the pending_mid_q */
853 spin_lock(&GlobalMid_Lock);
854 list_add_tail(&mid->qhead, &server->pending_mid_q);
855 spin_unlock(&GlobalMid_Lock);
858 * Need to store the time in mid before calling I/O. For call_async,
859 * I/O response may come back and free the mid entry on another thread.
861 cifs_save_when_sent(mid);
862 cifs_in_send_inc(server);
863 rc = smb_send_rqst(server, 1, rqst, flags);
864 cifs_in_send_dec(server);
867 revert_current_mid(server, mid->credits);
868 server->sequence_number -= 2;
869 cifs_delete_mid(mid);
872 mutex_unlock(&server->srv_mutex);
877 add_credits_and_wake_if(server, &credits, optype);
883 * Send an SMB Request. No response info (other than return code)
884 * needs to be parsed.
886 * flags indicate the type of request buffer and how long to wait
887 * and whether to log NT STATUS code (error) before mapping it to POSIX error
891 SendReceiveNoRsp(const unsigned int xid, struct cifs_ses *ses,
892 char *in_buf, int flags)
899 iov[0].iov_base = in_buf;
900 iov[0].iov_len = get_rfc1002_length(in_buf) + 4;
901 flags |= CIFS_NO_RSP_BUF;
902 rc = SendReceive2(xid, ses, iov, 1, &resp_buf_type, flags, &rsp_iov);
903 cifs_dbg(NOISY, "SendRcvNoRsp flags %d rc %d\n", flags, rc);
909 cifs_sync_mid_result(struct mid_q_entry *mid, struct TCP_Server_Info *server)
913 cifs_dbg(FYI, "%s: cmd=%d mid=%llu state=%d\n",
914 __func__, le16_to_cpu(mid->command), mid->mid, mid->mid_state);
916 spin_lock(&GlobalMid_Lock);
917 switch (mid->mid_state) {
918 case MID_RESPONSE_RECEIVED:
919 spin_unlock(&GlobalMid_Lock);
921 case MID_RETRY_NEEDED:
924 case MID_RESPONSE_MALFORMED:
931 if (!(mid->mid_flags & MID_DELETED)) {
932 list_del_init(&mid->qhead);
933 mid->mid_flags |= MID_DELETED;
935 cifs_server_dbg(VFS, "%s: invalid mid state mid=%llu state=%d\n",
936 __func__, mid->mid, mid->mid_state);
939 spin_unlock(&GlobalMid_Lock);
941 DeleteMidQEntry(mid);
946 send_cancel(struct TCP_Server_Info *server, struct smb_rqst *rqst,
947 struct mid_q_entry *mid)
949 return server->ops->send_cancel ?
950 server->ops->send_cancel(server, rqst, mid) : 0;
954 cifs_check_receive(struct mid_q_entry *mid, struct TCP_Server_Info *server,
957 unsigned int len = get_rfc1002_length(mid->resp_buf) + 4;
959 dump_smb(mid->resp_buf, min_t(u32, 92, len));
961 /* convert the length into a more usable form */
965 struct smb_rqst rqst = { .rq_iov = iov,
968 iov[0].iov_base = mid->resp_buf;
970 iov[1].iov_base = (char *)mid->resp_buf + 4;
971 iov[1].iov_len = len - 4;
972 /* FIXME: add code to kill session */
973 rc = cifs_verify_signature(&rqst, server,
974 mid->sequence_number);
976 cifs_server_dbg(VFS, "SMB signature verification returned error = %d\n",
980 /* BB special case reconnect tid and uid here? */
981 return map_and_check_smb_error(mid, log_error);
985 cifs_setup_request(struct cifs_ses *ses, struct TCP_Server_Info *ignored,
986 struct smb_rqst *rqst)
989 struct smb_hdr *hdr = (struct smb_hdr *)rqst->rq_iov[0].iov_base;
990 struct mid_q_entry *mid;
992 if (rqst->rq_iov[0].iov_len != 4 ||
993 rqst->rq_iov[0].iov_base + 4 != rqst->rq_iov[1].iov_base)
994 return ERR_PTR(-EIO);
996 rc = allocate_mid(ses, hdr, &mid);
999 rc = cifs_sign_rqst(rqst, ses->server, &mid->sequence_number);
1001 cifs_delete_mid(mid);
1008 cifs_compound_callback(struct mid_q_entry *mid)
1010 struct TCP_Server_Info *server = mid->server;
1011 struct cifs_credits credits;
1013 credits.value = server->ops->get_credits(mid);
1014 credits.instance = server->reconnect_instance;
1016 add_credits(server, &credits, mid->optype);
1020 cifs_compound_last_callback(struct mid_q_entry *mid)
1022 cifs_compound_callback(mid);
1023 cifs_wake_up_task(mid);
1027 cifs_cancelled_callback(struct mid_q_entry *mid)
1029 cifs_compound_callback(mid);
1030 DeleteMidQEntry(mid);
1034 * Return a channel (master if none) of @ses that can be used to send
1037 * If we are currently binding a new channel (negprot/sess.setup),
1038 * return the new incomplete channel.
1040 struct TCP_Server_Info *cifs_pick_channel(struct cifs_ses *ses)
1048 index = (uint)atomic_inc_return(&ses->chan_seq);
1050 spin_lock(&ses->chan_lock);
1051 index %= ses->chan_count;
1052 spin_unlock(&ses->chan_lock);
1054 return ses->chans[index].server;
1058 compound_send_recv(const unsigned int xid, struct cifs_ses *ses,
1059 struct TCP_Server_Info *server,
1060 const int flags, const int num_rqst, struct smb_rqst *rqst,
1061 int *resp_buf_type, struct kvec *resp_iov)
1063 int i, j, optype, rc = 0;
1064 struct mid_q_entry *midQ[MAX_COMPOUND];
1065 bool cancelled_mid[MAX_COMPOUND] = {false};
1066 struct cifs_credits credits[MAX_COMPOUND] = {
1067 { .value = 0, .instance = 0 }
1069 unsigned int instance;
1072 optype = flags & CIFS_OP_MASK;
1074 for (i = 0; i < num_rqst; i++)
1075 resp_buf_type[i] = CIFS_NO_BUFFER; /* no response buf yet */
1077 if (!ses || !ses->server || !server) {
1078 cifs_dbg(VFS, "Null session\n");
1082 spin_lock(&cifs_tcp_ses_lock);
1083 if (server->tcpStatus == CifsExiting) {
1084 spin_unlock(&cifs_tcp_ses_lock);
1087 spin_unlock(&cifs_tcp_ses_lock);
1090 * Wait for all the requests to become available.
1091 * This approach still leaves the possibility to be stuck waiting for
1092 * credits if the server doesn't grant credits to the outstanding
1093 * requests and if the client is completely idle, not generating any
1095 * This can be handled by the eventual session reconnect.
1097 rc = wait_for_compound_request(server, num_rqst, flags,
1102 for (i = 0; i < num_rqst; i++) {
1103 credits[i].value = 1;
1104 credits[i].instance = instance;
1108 * Make sure that we sign in the same order that we send on this socket
1109 * and avoid races inside tcp sendmsg code that could cause corruption
1113 mutex_lock(&server->srv_mutex);
1116 * All the parts of the compound chain belong obtained credits from the
1117 * same session. We can not use credits obtained from the previous
1118 * session to send this request. Check if there were reconnects after
1119 * we obtained credits and return -EAGAIN in such cases to let callers
1122 if (instance != server->reconnect_instance) {
1123 mutex_unlock(&server->srv_mutex);
1124 for (j = 0; j < num_rqst; j++)
1125 add_credits(server, &credits[j], optype);
1129 for (i = 0; i < num_rqst; i++) {
1130 midQ[i] = server->ops->setup_request(ses, server, &rqst[i]);
1131 if (IS_ERR(midQ[i])) {
1132 revert_current_mid(server, i);
1133 for (j = 0; j < i; j++)
1134 cifs_delete_mid(midQ[j]);
1135 mutex_unlock(&server->srv_mutex);
1137 /* Update # of requests on wire to server */
1138 for (j = 0; j < num_rqst; j++)
1139 add_credits(server, &credits[j], optype);
1140 return PTR_ERR(midQ[i]);
1143 midQ[i]->mid_state = MID_REQUEST_SUBMITTED;
1144 midQ[i]->optype = optype;
1146 * Invoke callback for every part of the compound chain
1147 * to calculate credits properly. Wake up this thread only when
1148 * the last element is received.
1150 if (i < num_rqst - 1)
1151 midQ[i]->callback = cifs_compound_callback;
1153 midQ[i]->callback = cifs_compound_last_callback;
1155 cifs_in_send_inc(server);
1156 rc = smb_send_rqst(server, num_rqst, rqst, flags);
1157 cifs_in_send_dec(server);
1159 for (i = 0; i < num_rqst; i++)
1160 cifs_save_when_sent(midQ[i]);
1163 revert_current_mid(server, num_rqst);
1164 server->sequence_number -= 2;
1167 mutex_unlock(&server->srv_mutex);
1170 * If sending failed for some reason or it is an oplock break that we
1171 * will not receive a response to - return credits back
1173 if (rc < 0 || (flags & CIFS_NO_SRV_RSP)) {
1174 for (i = 0; i < num_rqst; i++)
1175 add_credits(server, &credits[i], optype);
1180 * At this point the request is passed to the network stack - we assume
1181 * that any credits taken from the server structure on the client have
1182 * been spent and we can't return them back. Once we receive responses
1183 * we will collect credits granted by the server in the mid callbacks
1184 * and add those credits to the server structure.
1188 * Compounding is never used during session establish.
1190 spin_lock(&cifs_tcp_ses_lock);
1191 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP) || (optype & CIFS_SESS_OP)) {
1192 spin_unlock(&cifs_tcp_ses_lock);
1194 mutex_lock(&server->srv_mutex);
1195 smb311_update_preauth_hash(ses, server, rqst[0].rq_iov, rqst[0].rq_nvec);
1196 mutex_unlock(&server->srv_mutex);
1198 spin_lock(&cifs_tcp_ses_lock);
1200 spin_unlock(&cifs_tcp_ses_lock);
1202 for (i = 0; i < num_rqst; i++) {
1203 rc = wait_for_response(server, midQ[i]);
1208 for (; i < num_rqst; i++) {
1209 cifs_server_dbg(FYI, "Cancelling wait for mid %llu cmd: %d\n",
1210 midQ[i]->mid, le16_to_cpu(midQ[i]->command));
1211 send_cancel(server, &rqst[i], midQ[i]);
1212 spin_lock(&GlobalMid_Lock);
1213 midQ[i]->mid_flags |= MID_WAIT_CANCELLED;
1214 if (midQ[i]->mid_state == MID_REQUEST_SUBMITTED) {
1215 midQ[i]->callback = cifs_cancelled_callback;
1216 cancelled_mid[i] = true;
1217 credits[i].value = 0;
1219 spin_unlock(&GlobalMid_Lock);
1223 for (i = 0; i < num_rqst; i++) {
1227 rc = cifs_sync_mid_result(midQ[i], server);
1229 /* mark this mid as cancelled to not free it below */
1230 cancelled_mid[i] = true;
1234 if (!midQ[i]->resp_buf ||
1235 midQ[i]->mid_state != MID_RESPONSE_RECEIVED) {
1237 cifs_dbg(FYI, "Bad MID state?\n");
1241 buf = (char *)midQ[i]->resp_buf;
1242 resp_iov[i].iov_base = buf;
1243 resp_iov[i].iov_len = midQ[i]->resp_buf_size +
1244 server->vals->header_preamble_size;
1246 if (midQ[i]->large_buf)
1247 resp_buf_type[i] = CIFS_LARGE_BUFFER;
1249 resp_buf_type[i] = CIFS_SMALL_BUFFER;
1251 rc = server->ops->check_receive(midQ[i], server,
1252 flags & CIFS_LOG_ERROR);
1254 /* mark it so buf will not be freed by cifs_delete_mid */
1255 if ((flags & CIFS_NO_RSP_BUF) == 0)
1256 midQ[i]->resp_buf = NULL;
1261 * Compounding is never used during session establish.
1263 spin_lock(&cifs_tcp_ses_lock);
1264 if ((ses->status == CifsNew) || (optype & CIFS_NEG_OP) || (optype & CIFS_SESS_OP)) {
1266 .iov_base = resp_iov[0].iov_base,
1267 .iov_len = resp_iov[0].iov_len
1269 spin_unlock(&cifs_tcp_ses_lock);
1270 mutex_lock(&server->srv_mutex);
1271 smb311_update_preauth_hash(ses, server, &iov, 1);
1272 mutex_unlock(&server->srv_mutex);
1273 spin_lock(&cifs_tcp_ses_lock);
1275 spin_unlock(&cifs_tcp_ses_lock);
1279 * This will dequeue all mids. After this it is important that the
1280 * demultiplex_thread will not process any of these mids any futher.
1281 * This is prevented above by using a noop callback that will not
1282 * wake this thread except for the very last PDU.
1284 for (i = 0; i < num_rqst; i++) {
1285 if (!cancelled_mid[i])
1286 cifs_delete_mid(midQ[i]);
1293 cifs_send_recv(const unsigned int xid, struct cifs_ses *ses,
1294 struct TCP_Server_Info *server,
1295 struct smb_rqst *rqst, int *resp_buf_type, const int flags,
1296 struct kvec *resp_iov)
1298 return compound_send_recv(xid, ses, server, flags, 1,
1299 rqst, resp_buf_type, resp_iov);
1303 SendReceive2(const unsigned int xid, struct cifs_ses *ses,
1304 struct kvec *iov, int n_vec, int *resp_buf_type /* ret */,
1305 const int flags, struct kvec *resp_iov)
1307 struct smb_rqst rqst;
1308 struct kvec s_iov[CIFS_MAX_IOV_SIZE], *new_iov;
1311 if (n_vec + 1 > CIFS_MAX_IOV_SIZE) {
1312 new_iov = kmalloc_array(n_vec + 1, sizeof(struct kvec),
1315 /* otherwise cifs_send_recv below sets resp_buf_type */
1316 *resp_buf_type = CIFS_NO_BUFFER;
1322 /* 1st iov is a RFC1001 length followed by the rest of the packet */
1323 memcpy(new_iov + 1, iov, (sizeof(struct kvec) * n_vec));
1325 new_iov[0].iov_base = new_iov[1].iov_base;
1326 new_iov[0].iov_len = 4;
1327 new_iov[1].iov_base += 4;
1328 new_iov[1].iov_len -= 4;
1330 memset(&rqst, 0, sizeof(struct smb_rqst));
1331 rqst.rq_iov = new_iov;
1332 rqst.rq_nvec = n_vec + 1;
1334 rc = cifs_send_recv(xid, ses, ses->server,
1335 &rqst, resp_buf_type, flags, resp_iov);
1336 if (n_vec + 1 > CIFS_MAX_IOV_SIZE)
1342 SendReceive(const unsigned int xid, struct cifs_ses *ses,
1343 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1344 int *pbytes_returned, const int flags)
1347 struct mid_q_entry *midQ;
1348 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1349 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1350 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1351 struct cifs_credits credits = { .value = 1, .instance = 0 };
1352 struct TCP_Server_Info *server;
1355 cifs_dbg(VFS, "Null smb session\n");
1358 server = ses->server;
1359 if (server == NULL) {
1360 cifs_dbg(VFS, "Null tcp session\n");
1364 spin_lock(&cifs_tcp_ses_lock);
1365 if (server->tcpStatus == CifsExiting) {
1366 spin_unlock(&cifs_tcp_ses_lock);
1369 spin_unlock(&cifs_tcp_ses_lock);
1371 /* Ensure that we do not send more than 50 overlapping requests
1372 to the same server. We may make this configurable later or
1375 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1376 cifs_server_dbg(VFS, "Invalid length, greater than maximum frame, %d\n",
1381 rc = wait_for_free_request(server, flags, &credits.instance);
1385 /* make sure that we sign in the same order that we send on this socket
1386 and avoid races inside tcp sendmsg code that could cause corruption
1389 mutex_lock(&server->srv_mutex);
1391 rc = allocate_mid(ses, in_buf, &midQ);
1393 mutex_unlock(&server->srv_mutex);
1394 /* Update # of requests on wire to server */
1395 add_credits(server, &credits, 0);
1399 rc = cifs_sign_smb(in_buf, server, &midQ->sequence_number);
1401 mutex_unlock(&server->srv_mutex);
1405 midQ->mid_state = MID_REQUEST_SUBMITTED;
1407 cifs_in_send_inc(server);
1408 rc = smb_send(server, in_buf, len);
1409 cifs_in_send_dec(server);
1410 cifs_save_when_sent(midQ);
1413 server->sequence_number -= 2;
1415 mutex_unlock(&server->srv_mutex);
1420 rc = wait_for_response(server, midQ);
1422 send_cancel(server, &rqst, midQ);
1423 spin_lock(&GlobalMid_Lock);
1424 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1425 /* no longer considered to be "in-flight" */
1426 midQ->callback = DeleteMidQEntry;
1427 spin_unlock(&GlobalMid_Lock);
1428 add_credits(server, &credits, 0);
1431 spin_unlock(&GlobalMid_Lock);
1434 rc = cifs_sync_mid_result(midQ, server);
1436 add_credits(server, &credits, 0);
1440 if (!midQ->resp_buf || !out_buf ||
1441 midQ->mid_state != MID_RESPONSE_RECEIVED) {
1443 cifs_server_dbg(VFS, "Bad MID state?\n");
1447 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1448 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1449 rc = cifs_check_receive(midQ, server, 0);
1451 cifs_delete_mid(midQ);
1452 add_credits(server, &credits, 0);
1457 /* We send a LOCKINGX_CANCEL_LOCK to cause the Windows
1458 blocking lock to return. */
1461 send_lock_cancel(const unsigned int xid, struct cifs_tcon *tcon,
1462 struct smb_hdr *in_buf,
1463 struct smb_hdr *out_buf)
1466 struct cifs_ses *ses = tcon->ses;
1467 LOCK_REQ *pSMB = (LOCK_REQ *)in_buf;
1469 /* We just modify the current in_buf to change
1470 the type of lock from LOCKING_ANDX_SHARED_LOCK
1471 or LOCKING_ANDX_EXCLUSIVE_LOCK to
1472 LOCKING_ANDX_CANCEL_LOCK. */
1474 pSMB->LockType = LOCKING_ANDX_CANCEL_LOCK|LOCKING_ANDX_LARGE_FILES;
1476 pSMB->hdr.Mid = get_next_mid(ses->server);
1478 return SendReceive(xid, ses, in_buf, out_buf,
1479 &bytes_returned, 0);
1483 SendReceiveBlockingLock(const unsigned int xid, struct cifs_tcon *tcon,
1484 struct smb_hdr *in_buf, struct smb_hdr *out_buf,
1485 int *pbytes_returned)
1489 struct mid_q_entry *midQ;
1490 struct cifs_ses *ses;
1491 unsigned int len = be32_to_cpu(in_buf->smb_buf_length);
1492 struct kvec iov = { .iov_base = in_buf, .iov_len = len };
1493 struct smb_rqst rqst = { .rq_iov = &iov, .rq_nvec = 1 };
1494 unsigned int instance;
1495 struct TCP_Server_Info *server;
1497 if (tcon == NULL || tcon->ses == NULL) {
1498 cifs_dbg(VFS, "Null smb session\n");
1502 server = ses->server;
1504 if (server == NULL) {
1505 cifs_dbg(VFS, "Null tcp session\n");
1509 spin_lock(&cifs_tcp_ses_lock);
1510 if (server->tcpStatus == CifsExiting) {
1511 spin_unlock(&cifs_tcp_ses_lock);
1514 spin_unlock(&cifs_tcp_ses_lock);
1516 /* Ensure that we do not send more than 50 overlapping requests
1517 to the same server. We may make this configurable later or
1520 if (len > CIFSMaxBufSize + MAX_CIFS_HDR_SIZE - 4) {
1521 cifs_tcon_dbg(VFS, "Invalid length, greater than maximum frame, %d\n",
1526 rc = wait_for_free_request(server, CIFS_BLOCKING_OP, &instance);
1530 /* make sure that we sign in the same order that we send on this socket
1531 and avoid races inside tcp sendmsg code that could cause corruption
1534 mutex_lock(&server->srv_mutex);
1536 rc = allocate_mid(ses, in_buf, &midQ);
1538 mutex_unlock(&server->srv_mutex);
1542 rc = cifs_sign_smb(in_buf, server, &midQ->sequence_number);
1544 cifs_delete_mid(midQ);
1545 mutex_unlock(&server->srv_mutex);
1549 midQ->mid_state = MID_REQUEST_SUBMITTED;
1550 cifs_in_send_inc(server);
1551 rc = smb_send(server, in_buf, len);
1552 cifs_in_send_dec(server);
1553 cifs_save_when_sent(midQ);
1556 server->sequence_number -= 2;
1558 mutex_unlock(&server->srv_mutex);
1561 cifs_delete_mid(midQ);
1565 /* Wait for a reply - allow signals to interrupt. */
1566 rc = wait_event_interruptible(server->response_q,
1567 (!(midQ->mid_state == MID_REQUEST_SUBMITTED)) ||
1568 ((server->tcpStatus != CifsGood) &&
1569 (server->tcpStatus != CifsNew)));
1571 /* Were we interrupted by a signal ? */
1572 spin_lock(&cifs_tcp_ses_lock);
1573 if ((rc == -ERESTARTSYS) &&
1574 (midQ->mid_state == MID_REQUEST_SUBMITTED) &&
1575 ((server->tcpStatus == CifsGood) ||
1576 (server->tcpStatus == CifsNew))) {
1577 spin_unlock(&cifs_tcp_ses_lock);
1579 if (in_buf->Command == SMB_COM_TRANSACTION2) {
1580 /* POSIX lock. We send a NT_CANCEL SMB to cause the
1581 blocking lock to return. */
1582 rc = send_cancel(server, &rqst, midQ);
1584 cifs_delete_mid(midQ);
1588 /* Windows lock. We send a LOCKINGX_CANCEL_LOCK
1589 to cause the blocking lock to return. */
1591 rc = send_lock_cancel(xid, tcon, in_buf, out_buf);
1593 /* If we get -ENOLCK back the lock may have
1594 already been removed. Don't exit in this case. */
1595 if (rc && rc != -ENOLCK) {
1596 cifs_delete_mid(midQ);
1601 rc = wait_for_response(server, midQ);
1603 send_cancel(server, &rqst, midQ);
1604 spin_lock(&GlobalMid_Lock);
1605 if (midQ->mid_state == MID_REQUEST_SUBMITTED) {
1606 /* no longer considered to be "in-flight" */
1607 midQ->callback = DeleteMidQEntry;
1608 spin_unlock(&GlobalMid_Lock);
1611 spin_unlock(&GlobalMid_Lock);
1614 /* We got the response - restart system call. */
1616 spin_lock(&cifs_tcp_ses_lock);
1618 spin_unlock(&cifs_tcp_ses_lock);
1620 rc = cifs_sync_mid_result(midQ, server);
1624 /* rcvd frame is ok */
1625 if (out_buf == NULL || midQ->mid_state != MID_RESPONSE_RECEIVED) {
1627 cifs_tcon_dbg(VFS, "Bad MID state?\n");
1631 *pbytes_returned = get_rfc1002_length(midQ->resp_buf);
1632 memcpy(out_buf, midQ->resp_buf, *pbytes_returned + 4);
1633 rc = cifs_check_receive(midQ, server, 0);
1635 cifs_delete_mid(midQ);
1636 if (rstart && rc == -EACCES)
1637 return -ERESTARTSYS;