4 * Copyright (C) 2001 by Urban Widmark
6 * Please add a note about your changes to smbfs in the ChangeLog file.
9 #include <linux/kernel.h>
10 #include <linux/types.h>
12 #include <linux/slab.h>
13 #include <linux/net.h>
15 #include <linux/smb_fs.h>
16 #include <linux/smbno.h>
17 #include <linux/smb_mount.h>
19 #include "smb_debug.h"
23 /* #define SMB_SLAB_DEBUG (SLAB_RED_ZONE | SLAB_POISON) */
24 #define SMB_SLAB_DEBUG 0
26 /* cache for request structures */
27 static struct kmem_cache
*req_cachep
;
29 static int smb_request_send_req(struct smb_request
*req
);
33 name, active, num, objsize, active_slabs, num_slaps, #pages
37 int smb_init_request_cache(void)
39 req_cachep
= kmem_cache_create("smb_request",
40 sizeof(struct smb_request
), 0,
41 SMB_SLAB_DEBUG
| SLAB_HWCACHE_ALIGN
,
43 if (req_cachep
== NULL
)
49 void smb_destroy_request_cache(void)
51 kmem_cache_destroy(req_cachep
);
55 * Allocate and initialise a request structure
57 static struct smb_request
*smb_do_alloc_request(struct smb_sb_info
*server
,
60 struct smb_request
*req
;
61 unsigned char *buf
= NULL
;
63 req
= kmem_cache_zalloc(req_cachep
, GFP_KERNEL
);
64 VERBOSE("allocating request: %p\n", req
);
69 buf
= kmalloc(bufsize
, GFP_NOFS
);
71 kmem_cache_free(req_cachep
, req
);
77 req
->rq_bufsize
= bufsize
;
78 req
->rq_server
= server
;
79 init_waitqueue_head(&req
->rq_wait
);
80 INIT_LIST_HEAD(&req
->rq_queue
);
81 atomic_set(&req
->rq_count
, 1);
87 struct smb_request
*smb_alloc_request(struct smb_sb_info
*server
, int bufsize
)
89 struct smb_request
*req
= NULL
;
92 atomic_inc(&server
->nr_requests
);
93 if (atomic_read(&server
->nr_requests
) <= MAX_REQUEST_HARD
) {
94 req
= smb_do_alloc_request(server
, bufsize
);
101 * Try to free up at least one request in order to stay
102 * below the hard limit
104 if (nfs_try_to_free_pages(server
))
107 if (signalled() && (server
->flags
& NFS_MOUNT_INTR
))
108 return ERR_PTR(-ERESTARTSYS
);
109 current
->policy
= SCHED_YIELD
;
112 /* FIXME: we want something like nfs does above, but that
113 requires changes to all callers and can wait. */
120 static void smb_free_request(struct smb_request
*req
)
122 atomic_dec(&req
->rq_server
->nr_requests
);
123 if (req
->rq_buffer
&& !(req
->rq_flags
& SMB_REQ_STATIC
))
124 kfree(req
->rq_buffer
);
125 kfree(req
->rq_trans2buffer
);
126 kmem_cache_free(req_cachep
, req
);
130 * What prevents a rget to race with a rput? The count must never drop to zero
131 * while it is in use. Only rput if it is ok that it is free'd.
133 static void smb_rget(struct smb_request
*req
)
135 atomic_inc(&req
->rq_count
);
137 void smb_rput(struct smb_request
*req
)
139 if (atomic_dec_and_test(&req
->rq_count
)) {
140 list_del_init(&req
->rq_queue
);
141 smb_free_request(req
);
145 /* setup to receive the data part of the SMB */
146 static int smb_setup_bcc(struct smb_request
*req
)
149 req
->rq_rlen
= smb_len(req
->rq_header
) + 4 - req
->rq_bytes_recvd
;
151 if (req
->rq_rlen
> req
->rq_bufsize
) {
152 PARANOIA("Packet too large %d > %d\n",
153 req
->rq_rlen
, req
->rq_bufsize
);
157 req
->rq_iov
[0].iov_base
= req
->rq_buffer
;
158 req
->rq_iov
[0].iov_len
= req
->rq_rlen
;
165 * Prepare a "normal" request structure.
167 static int smb_setup_request(struct smb_request
*req
)
169 int len
= smb_len(req
->rq_header
) + 4;
172 /* if we expect a data part in the reply we set the iov's to read it */
173 if (req
->rq_resp_bcc
)
174 req
->rq_setup_read
= smb_setup_bcc
;
176 /* This tries to support re-using the same request */
177 req
->rq_bytes_sent
= 0;
181 req
->rq_fragment
= 0;
182 kfree(req
->rq_trans2buffer
);
183 req
->rq_trans2buffer
= NULL
;
189 * Prepare a transaction2 request structure
191 static int smb_setup_trans2request(struct smb_request
*req
)
193 struct smb_sb_info
*server
= req
->rq_server
;
195 static unsigned char padding
[4];
197 /* I know the following is very ugly, but I want to build the
198 smb packet as efficiently as possible. */
200 const int smb_parameters
= 15;
201 const int header
= SMB_HEADER_LEN
+ 2 * smb_parameters
+ 2;
202 const int oparam
= ALIGN(header
+ 3, sizeof(u32
));
203 const int odata
= ALIGN(oparam
+ req
->rq_lparm
, sizeof(u32
));
204 const int bcc
= (req
->rq_data
? odata
+ req
->rq_ldata
:
205 oparam
+ req
->rq_lparm
) - header
;
207 if ((bcc
+ oparam
) > server
->opt
.max_xmit
)
209 smb_setup_header(req
, SMBtrans2
, smb_parameters
, bcc
);
212 * max parameters + max data + max setup == bufsize to make NT4 happy
213 * and not abort the transfer or split into multiple responses. It also
214 * makes smbfs happy as handling packets larger than the buffer size
217 * OS/2 is probably going to hate me for this ...
219 mparam
= SMB_TRANS2_MAX_PARAM
;
220 mdata
= req
->rq_bufsize
- mparam
;
222 mdata
= server
->opt
.max_xmit
- mparam
- 100;
229 /* NT/win2k has ~4k max_xmit, so with this we request more than it wants
230 to return as one SMB. Useful for testing the fragmented trans2
235 WSET(req
->rq_header
, smb_tpscnt
, req
->rq_lparm
);
236 WSET(req
->rq_header
, smb_tdscnt
, req
->rq_ldata
);
237 WSET(req
->rq_header
, smb_mprcnt
, mparam
);
238 WSET(req
->rq_header
, smb_mdrcnt
, mdata
);
239 WSET(req
->rq_header
, smb_msrcnt
, 0); /* max setup always 0 ? */
240 WSET(req
->rq_header
, smb_flags
, 0);
241 DSET(req
->rq_header
, smb_timeout
, 0);
242 WSET(req
->rq_header
, smb_pscnt
, req
->rq_lparm
);
243 WSET(req
->rq_header
, smb_psoff
, oparam
- 4);
244 WSET(req
->rq_header
, smb_dscnt
, req
->rq_ldata
);
245 WSET(req
->rq_header
, smb_dsoff
, req
->rq_data
? odata
- 4 : 0);
246 *(req
->rq_header
+ smb_suwcnt
) = 0x01; /* setup count */
247 *(req
->rq_header
+ smb_suwcnt
+ 1) = 0x00; /* reserved */
248 WSET(req
->rq_header
, smb_setup0
, req
->rq_trans2_command
);
251 req
->rq_iov
[0].iov_base
= (void *) req
->rq_header
;
252 req
->rq_iov
[0].iov_len
= oparam
;
253 req
->rq_iov
[1].iov_base
= (req
->rq_parm
==NULL
) ? padding
: req
->rq_parm
;
254 req
->rq_iov
[1].iov_len
= req
->rq_lparm
;
255 req
->rq_slen
= oparam
+ req
->rq_lparm
;
259 req
->rq_iov
[2].iov_base
= padding
;
260 req
->rq_iov
[2].iov_len
= odata
- oparam
- req
->rq_lparm
;
261 req
->rq_iov
[3].iov_base
= req
->rq_data
;
262 req
->rq_iov
[3].iov_len
= req
->rq_ldata
;
263 req
->rq_slen
= odata
+ req
->rq_ldata
;
266 /* always a data part for trans2 replies */
267 req
->rq_setup_read
= smb_setup_bcc
;
273 * Add a request and tell smbiod to process it
275 int smb_add_request(struct smb_request
*req
)
278 struct smb_sb_info
*server
= req
->rq_server
;
281 smb_setup_request(req
);
282 if (req
->rq_trans2_command
) {
283 if (req
->rq_buffer
== NULL
) {
284 PARANOIA("trans2 attempted without response buffer!\n");
287 result
= smb_setup_trans2request(req
);
292 #ifdef SMB_DEBUG_PACKET_SIZE
296 /* add 'req' to the queue of requests */
297 if (smb_lock_server_interruptible(server
))
301 * Try to send the request as the process. If that fails we queue the
302 * request and let smbiod send it later.
305 /* FIXME: each server has a number on the maximum number of parallel
306 requests. 10, 50 or so. We should not allow more requests to be
308 if (server
->mid
> 0xf000)
310 req
->rq_mid
= server
->mid
++;
311 WSET(req
->rq_header
, smb_mid
, req
->rq_mid
);
314 if (server
->state
== CONN_VALID
) {
315 if (list_empty(&server
->xmitq
))
316 result
= smb_request_send_req(req
);
318 /* Connection lost? */
319 server
->conn_error
= result
;
320 server
->state
= CONN_INVALID
;
324 list_add_tail(&req
->rq_queue
, &server
->xmitq
);
327 if (server
->state
!= CONN_VALID
)
328 smbiod_retry(server
);
330 smb_unlock_server(server
);
334 timeleft
= wait_event_interruptible_timeout(req
->rq_wait
,
335 req
->rq_flags
& SMB_REQ_RECEIVED
, 30*HZ
);
336 if (!timeleft
|| signal_pending(current
)) {
338 * On timeout or on interrupt we want to try and remove the
339 * request from the recvq/xmitq.
340 * First check if the request is still part of a queue. (May
341 * have been removed by some error condition)
343 smb_lock_server(server
);
344 if (!list_empty(&req
->rq_queue
)) {
345 list_del_init(&req
->rq_queue
);
348 smb_unlock_server(server
);
352 PARANOIA("request [%p, mid=%d] timed out!\n",
354 VERBOSE("smb_com: %02x\n", *(req
->rq_header
+ smb_com
));
355 VERBOSE("smb_rcls: %02x\n", *(req
->rq_header
+ smb_rcls
));
356 VERBOSE("smb_flg: %02x\n", *(req
->rq_header
+ smb_flg
));
357 VERBOSE("smb_tid: %04x\n", WVAL(req
->rq_header
, smb_tid
));
358 VERBOSE("smb_pid: %04x\n", WVAL(req
->rq_header
, smb_pid
));
359 VERBOSE("smb_uid: %04x\n", WVAL(req
->rq_header
, smb_uid
));
360 VERBOSE("smb_mid: %04x\n", WVAL(req
->rq_header
, smb_mid
));
361 VERBOSE("smb_wct: %02x\n", *(req
->rq_header
+ smb_wct
));
363 req
->rq_rcls
= ERRSRV
;
364 req
->rq_err
= ERRtimeout
;
366 /* Just in case it was "stuck" */
369 VERBOSE("woke up, rcls=%d\n", req
->rq_rcls
);
371 if (req
->rq_rcls
!= 0)
372 req
->rq_errno
= smb_errno(req
);
373 if (signal_pending(current
))
374 req
->rq_errno
= -ERESTARTSYS
;
375 return req
->rq_errno
;
379 * Send a request and place it on the recvq if successfully sent.
380 * Must be called with the server lock held.
382 static int smb_request_send_req(struct smb_request
*req
)
384 struct smb_sb_info
*server
= req
->rq_server
;
387 if (req
->rq_bytes_sent
== 0) {
388 WSET(req
->rq_header
, smb_tid
, server
->opt
.tid
);
389 WSET(req
->rq_header
, smb_pid
, 1);
390 WSET(req
->rq_header
, smb_uid
, server
->opt
.server_uid
);
393 result
= smb_send_request(req
);
394 if (result
< 0 && result
!= -EAGAIN
)
398 if (!(req
->rq_flags
& SMB_REQ_TRANSMITTED
))
401 list_move_tail(&req
->rq_queue
, &server
->recvq
);
408 * Sends one request for this server. (smbiod)
409 * Must be called with the server lock held.
410 * Returns: <0 on error
411 * 0 if no request could be completely sent
412 * 1 if all data for one request was sent
414 int smb_request_send_server(struct smb_sb_info
*server
)
416 struct list_head
*head
;
417 struct smb_request
*req
;
420 if (server
->state
!= CONN_VALID
)
423 /* dequeue first request, if any */
425 head
= server
->xmitq
.next
;
426 if (head
!= &server
->xmitq
) {
427 req
= list_entry(head
, struct smb_request
, rq_queue
);
432 result
= smb_request_send_req(req
);
434 server
->conn_error
= result
;
435 list_move(&req
->rq_queue
, &server
->xmitq
);
445 * Try to find a request matching this "mid". Typically the first entry will
446 * be the matching one.
448 static struct smb_request
*find_request(struct smb_sb_info
*server
, int mid
)
450 struct list_head
*tmp
;
451 struct smb_request
*req
= NULL
;
453 list_for_each(tmp
, &server
->recvq
) {
454 req
= list_entry(tmp
, struct smb_request
, rq_queue
);
455 if (req
->rq_mid
== mid
) {
462 VERBOSE("received reply with mid %d but no request!\n",
463 WVAL(server
->header
, smb_mid
));
464 server
->rstate
= SMB_RECV_DROP
;
471 * Called when we have read the smb header and believe this is a response.
473 static int smb_init_request(struct smb_sb_info
*server
, struct smb_request
*req
)
477 memcpy(req
->rq_header
, server
->header
, SMB_HEADER_LEN
);
479 wct
= *(req
->rq_header
+ smb_wct
);
481 PARANOIA("wct too large, %d > 20\n", wct
);
482 server
->rstate
= SMB_RECV_DROP
;
486 req
->rq_resp_wct
= wct
;
487 hdrlen
= SMB_HEADER_LEN
+ wct
*2 + 2;
488 VERBOSE("header length: %d smb_wct: %2d\n", hdrlen
, wct
);
490 req
->rq_bytes_recvd
= SMB_HEADER_LEN
;
491 req
->rq_rlen
= hdrlen
;
492 req
->rq_iov
[0].iov_base
= req
->rq_header
;
493 req
->rq_iov
[0].iov_len
= hdrlen
;
495 server
->rstate
= SMB_RECV_PARAM
;
497 #ifdef SMB_DEBUG_PACKET_SIZE
498 add_recv_stats(smb_len(server
->header
));
504 * Reads the SMB parameters
506 static int smb_recv_param(struct smb_sb_info
*server
, struct smb_request
*req
)
510 result
= smb_receive(server
, req
);
513 if (req
->rq_bytes_recvd
< req
->rq_rlen
)
516 VERBOSE("result: %d smb_bcc: %04x\n", result
,
517 WVAL(req
->rq_header
, SMB_HEADER_LEN
+
518 (*(req
->rq_header
+ smb_wct
) * 2)));
521 req
->rq_iov
[0].iov_base
= NULL
;
523 if (req
->rq_callback
)
524 req
->rq_callback(req
);
525 else if (req
->rq_setup_read
)
526 result
= req
->rq_setup_read(req
);
528 server
->rstate
= SMB_RECV_DROP
;
532 server
->rstate
= req
->rq_rlen
> 0 ? SMB_RECV_DATA
: SMB_RECV_END
;
534 req
->rq_bytes_recvd
= 0; // recvd out of the iov
536 VERBOSE("rlen: %d\n", req
->rq_rlen
);
537 if (req
->rq_rlen
< 0) {
538 PARANOIA("Parameters read beyond end of packet!\n");
539 server
->rstate
= SMB_RECV_END
;
548 static int smb_recv_data(struct smb_sb_info
*server
, struct smb_request
*req
)
552 result
= smb_receive(server
, req
);
555 if (req
->rq_bytes_recvd
< req
->rq_rlen
)
557 server
->rstate
= SMB_RECV_END
;
559 VERBOSE("result: %d\n", result
);
564 * Receive a transaction2 response
565 * Return: 0 if the response has been fully read
566 * 1 if there are further "fragments" to read
567 * <0 if there is an error
569 static int smb_recv_trans2(struct smb_sb_info
*server
, struct smb_request
*req
)
571 unsigned char *inbuf
;
572 unsigned int parm_disp
, parm_offset
, parm_count
, parm_tot
;
573 unsigned int data_disp
, data_offset
, data_count
, data_tot
;
574 int hdrlen
= SMB_HEADER_LEN
+ req
->rq_resp_wct
*2 - 2;
576 VERBOSE("handling trans2\n");
578 inbuf
= req
->rq_header
;
579 data_tot
= WVAL(inbuf
, smb_tdrcnt
);
580 parm_tot
= WVAL(inbuf
, smb_tprcnt
);
581 parm_disp
= WVAL(inbuf
, smb_prdisp
);
582 parm_offset
= WVAL(inbuf
, smb_proff
);
583 parm_count
= WVAL(inbuf
, smb_prcnt
);
584 data_disp
= WVAL(inbuf
, smb_drdisp
);
585 data_offset
= WVAL(inbuf
, smb_droff
);
586 data_count
= WVAL(inbuf
, smb_drcnt
);
588 /* Modify offset for the split header/buffer we use */
589 if (data_count
|| data_offset
) {
590 if (unlikely(data_offset
< hdrlen
))
593 data_offset
-= hdrlen
;
595 if (parm_count
|| parm_offset
) {
596 if (unlikely(parm_offset
< hdrlen
))
599 parm_offset
-= hdrlen
;
602 if (parm_count
== parm_tot
&& data_count
== data_tot
) {
604 * This packet has all the trans2 data.
606 * We setup the request so that this will be the common
607 * case. It may be a server error to not return a
608 * response that fits.
610 VERBOSE("single trans2 response "
611 "dcnt=%u, pcnt=%u, doff=%u, poff=%u\n",
612 data_count
, parm_count
,
613 data_offset
, parm_offset
);
614 req
->rq_ldata
= data_count
;
615 req
->rq_lparm
= parm_count
;
616 req
->rq_data
= req
->rq_buffer
+ data_offset
;
617 req
->rq_parm
= req
->rq_buffer
+ parm_offset
;
618 if (unlikely(parm_offset
+ parm_count
> req
->rq_rlen
))
620 if (unlikely(data_offset
+ data_count
> req
->rq_rlen
))
625 VERBOSE("multi trans2 response "
626 "frag=%d, dcnt=%u, pcnt=%u, doff=%u, poff=%u\n",
628 data_count
, parm_count
,
629 data_offset
, parm_offset
);
631 if (!req
->rq_fragment
) {
634 /* We got the first trans2 fragment */
635 req
->rq_fragment
= 1;
636 req
->rq_total_data
= data_tot
;
637 req
->rq_total_parm
= parm_tot
;
641 buf_len
= data_tot
+ parm_tot
;
642 if (buf_len
> SMB_MAX_PACKET_SIZE
)
645 req
->rq_trans2bufsize
= buf_len
;
646 req
->rq_trans2buffer
= kzalloc(buf_len
, GFP_NOFS
);
647 if (!req
->rq_trans2buffer
)
650 req
->rq_parm
= req
->rq_trans2buffer
;
651 req
->rq_data
= req
->rq_trans2buffer
+ parm_tot
;
652 } else if (unlikely(req
->rq_total_data
< data_tot
||
653 req
->rq_total_parm
< parm_tot
))
656 if (unlikely(parm_disp
+ parm_count
> req
->rq_total_parm
||
657 parm_offset
+ parm_count
> req
->rq_rlen
))
659 if (unlikely(data_disp
+ data_count
> req
->rq_total_data
||
660 data_offset
+ data_count
> req
->rq_rlen
))
663 inbuf
= req
->rq_buffer
;
664 memcpy(req
->rq_parm
+ parm_disp
, inbuf
+ parm_offset
, parm_count
);
665 memcpy(req
->rq_data
+ data_disp
, inbuf
+ data_offset
, data_count
);
667 req
->rq_ldata
+= data_count
;
668 req
->rq_lparm
+= parm_count
;
671 * Check whether we've received all of the data. Note that
672 * we use the packet totals -- total lengths might shrink!
674 if (req
->rq_ldata
>= data_tot
&& req
->rq_lparm
>= parm_tot
) {
675 req
->rq_ldata
= data_tot
;
676 req
->rq_lparm
= parm_tot
;
682 printk(KERN_ERR
"smb_trans2: data/param too long, data=%u, parm=%u\n",
686 printk(KERN_ERR
"smb_trans2: couldn't allocate data area of %d bytes\n",
687 req
->rq_trans2bufsize
);
688 req
->rq_errno
= -ENOMEM
;
691 printk(KERN_ERR
"smb_trans2: data/params grew!\n");
694 printk(KERN_ERR
"smb_trans2: invalid parms, disp=%u, cnt=%u, tot=%u, ofs=%u\n",
695 parm_disp
, parm_count
, parm_tot
, parm_offset
);
698 printk(KERN_ERR
"smb_trans2: invalid data, disp=%u, cnt=%u, tot=%u, ofs=%u\n",
699 data_disp
, data_count
, data_tot
, data_offset
);
701 req
->rq_errno
= -EIO
;
703 return req
->rq_errno
;
707 * State machine for receiving responses. We handle the fact that we can't
708 * read the full response in one try by having states telling us how much we
711 * Must be called with the server lock held (only called from smbiod).
713 * Return: <0 on error
715 int smb_request_recv(struct smb_sb_info
*server
)
717 struct smb_request
*req
= NULL
;
720 if (smb_recv_available(server
) <= 0)
723 VERBOSE("state: %d\n", server
->rstate
);
724 switch (server
->rstate
) {
726 result
= smb_receive_drop(server
);
729 if (server
->rstate
== SMB_RECV_DROP
)
731 server
->rstate
= SMB_RECV_START
;
734 server
->smb_read
= 0;
735 server
->rstate
= SMB_RECV_HEADER
;
737 case SMB_RECV_HEADER
:
738 result
= smb_receive_header(server
);
741 if (server
->rstate
== SMB_RECV_HEADER
)
743 if (! (*(server
->header
+ smb_flg
) & SMB_FLAGS_REPLY
) ) {
744 server
->rstate
= SMB_RECV_REQUEST
;
747 if (server
->rstate
!= SMB_RECV_HCOMPLETE
)
750 case SMB_RECV_HCOMPLETE
:
751 req
= find_request(server
, WVAL(server
->header
, smb_mid
));
754 smb_init_request(server
, req
);
755 req
->rq_rcls
= *(req
->rq_header
+ smb_rcls
);
756 req
->rq_err
= WVAL(req
->rq_header
, smb_err
);
757 if (server
->rstate
!= SMB_RECV_PARAM
)
762 req
= find_request(server
,WVAL(server
->header
,smb_mid
));
765 result
= smb_recv_param(server
, req
);
768 if (server
->rstate
!= SMB_RECV_DATA
)
773 req
= find_request(server
,WVAL(server
->header
,smb_mid
));
776 result
= smb_recv_data(server
, req
);
781 /* We should never be called with any of these states */
783 case SMB_RECV_REQUEST
:
788 /* We saw an error */
792 if (server
->rstate
!= SMB_RECV_END
)
796 if (req
->rq_trans2_command
&& req
->rq_rcls
== SUCCESS
)
797 result
= smb_recv_trans2(server
, req
);
800 * Response completely read. Drop any extra bytes sent by the server.
801 * (Yes, servers sometimes add extra bytes to responses)
803 VERBOSE("smb_len: %d smb_read: %d\n",
804 server
->smb_len
, server
->smb_read
);
805 if (server
->smb_read
< server
->smb_len
)
806 smb_receive_drop(server
);
808 server
->rstate
= SMB_RECV_START
;
811 list_del_init(&req
->rq_queue
);
812 req
->rq_flags
|= SMB_REQ_RECEIVED
;
814 wake_up_interruptible(&req
->rq_wait
);