projects / deliverable / linux.git / blob
? search:


fba4d1341f88977416cd0bbf982591e7df3c2bdc
[deliverable/linux.git] / fs / cifs / cifsglob.h
1 /*
2 * fs/cifs/cifsglob.h
3 *
4 * Copyright (C) International Business Machines Corp., 2002,2008
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
7 *
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.
12 *
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.
17 *
18 */
19 #ifndef _CIFS_GLOB_H
20 #define _CIFS_GLOB_H
21
22 #include <linux/in.h>
23 #include <linux/in6.h>
24 #include <linux/slab.h>
25 #include <linux/mempool.h>
26 #include <linux/workqueue.h>
27 #include "cifs_fs_sb.h"
28 #include "cifsacl.h"
29 #include <crypto/internal/hash.h>
30 #include <linux/scatterlist.h>
31 #include <uapi/linux/cifs/cifs_mount.h>
32 #ifdef CONFIG_CIFS_SMB2
33 #include "smb2pdu.h"
34 #endif
35
36 #define CIFS_MAGIC_NUMBER 0xFF534D42 /* the first four bytes of SMB PDUs */
37
38 /*
39 * The sizes of various internal tables and strings
40 */
41 #define MAX_UID_INFO 16
42 #define MAX_SES_INFO 2
43 #define MAX_TCON_INFO 4
44
45 #define MAX_TREE_SIZE (2 + CIFS_NI_MAXHOST + 1 + CIFS_MAX_SHARE_LEN + 1)
46
47 #define CIFS_MIN_RCV_POOL 4
48
49 #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */
50 /*
51 * default attribute cache timeout (jiffies)
52 */
53 #define CIFS_DEF_ACTIMEO (1 * HZ)
54
55 /*
56 * max attribute cache timeout (jiffies) - 2^30
57 */
58 #define CIFS_MAX_ACTIMEO (1 << 30)
59
60 /*
61 * MAX_REQ is the maximum number of requests that WE will send
62 * on one socket concurrently.
63 */
64 #define CIFS_MAX_REQ 32767
65
66 #define RFC1001_NAME_LEN 15
67 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
68
69 /* currently length of NIP6_FMT */
70 #define SERVER_NAME_LENGTH 40
71 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
72
73 /* used to define string lengths for reversing unicode strings */
74 /* (256+1)*2 = 514 */
75 /* (max path length + 1 for null) * 2 for unicode */
76 #define MAX_NAME 514
77
78 /* SMB echo "timeout" -- FIXME: tunable? */
79 #define SMB_ECHO_INTERVAL (60 * HZ)
80
81 #include "cifspdu.h"
82
83 #ifndef XATTR_DOS_ATTRIB
84 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
85 #endif
86
87 /*
88 * CIFS vfs client Status information (based on what we know.)
89 */
90
91 /* associated with each tcp and smb session */
92 enum statusEnum {
93 CifsNew = 0,
94 CifsGood,
95 CifsExiting,
96 CifsNeedReconnect,
97 CifsNeedNegotiate
98 };
99
100 enum securityEnum {
101 Unspecified = 0, /* not specified */
102 LANMAN, /* Legacy LANMAN auth */
103 NTLM, /* Legacy NTLM012 auth with NTLM hash */
104 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
105 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
106 Kerberos, /* Kerberos via SPNEGO */
107 };
108
109 struct session_key {
110 unsigned int len;
111 char *response;
112 };
113
114 /* crypto security descriptor definition */
115 struct sdesc {
116 struct shash_desc shash;
117 char ctx[];
118 };
119
120 /* crypto hashing related structure/fields, not specific to a sec mech */
121 struct cifs_secmech {
122 struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
123 struct crypto_shash *md5; /* md5 hash function */
124 struct crypto_shash *hmacsha256; /* hmac-sha256 hash function */
125 struct crypto_shash *cmacaes; /* block-cipher based MAC function */
126 struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */
127 struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
128 struct sdesc *sdeschmacsha256; /* ctxt to generate smb2 signature */
129 struct sdesc *sdesccmacaes; /* ctxt to generate smb3 signature */
130 };
131
132 /* per smb session structure/fields */
133 struct ntlmssp_auth {
134 bool sesskey_per_smbsess; /* whether session key is per smb session */
135 __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
136 __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
137 unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
138 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
139 };
140
141 struct cifs_cred {
142 int uid;
143 int gid;
144 int mode;
145 int cecount;
146 struct cifs_sid osid;
147 struct cifs_sid gsid;
148 struct cifs_ntace *ntaces;
149 struct cifs_ace *aces;
150 };
151
152 /*
153 *****************************************************************
154 * Except the CIFS PDUs themselves all the
155 * globally interesting structs should go here
156 *****************************************************************
157 */
158
159 /*
160 * A smb_rqst represents a complete request to be issued to a server. It's
161 * formed by a kvec array, followed by an array of pages. Page data is assumed
162 * to start at the beginning of the first page.
163 */
164 struct smb_rqst {
165 struct kvec *rq_iov; /* array of kvecs */
166 unsigned int rq_nvec; /* number of kvecs in array */
167 struct page **rq_pages; /* pointer to array of page ptrs */
168 unsigned int rq_npages; /* number pages in array */
169 unsigned int rq_pagesz; /* page size to use */
170 unsigned int rq_tailsz; /* length of last page */
171 };
172
173 enum smb_version {
174 Smb_1 = 1,
175 Smb_20,
176 Smb_21,
177 Smb_30,
178 Smb_302,
179 };
180
181 struct mid_q_entry;
182 struct TCP_Server_Info;
183 struct cifsFileInfo;
184 struct cifs_ses;
185 struct cifs_tcon;
186 struct dfs_info3_param;
187 struct cifs_fattr;
188 struct smb_vol;
189 struct cifs_fid;
190 struct cifs_readdata;
191 struct cifs_writedata;
192 struct cifs_io_parms;
193 struct cifs_search_info;
194 struct cifsInodeInfo;
195 struct cifs_open_parms;
196
197 struct smb_version_operations {
198 int (*send_cancel)(struct TCP_Server_Info *, void *,
199 struct mid_q_entry *);
200 bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
201 /* setup request: allocate mid, sign message */
202 struct mid_q_entry *(*setup_request)(struct cifs_ses *,
203 struct smb_rqst *);
204 /* setup async request: allocate mid, sign message */
205 struct mid_q_entry *(*setup_async_request)(struct TCP_Server_Info *,
206 struct smb_rqst *);
207 /* check response: verify signature, map error */
208 int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
209 bool);
210 void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
211 const int);
212 void (*set_credits)(struct TCP_Server_Info *, const int);
213 int * (*get_credits_field)(struct TCP_Server_Info *, const int);
214 unsigned int (*get_credits)(struct mid_q_entry *);
215 __u64 (*get_next_mid)(struct TCP_Server_Info *);
216 /* data offset from read response message */
217 unsigned int (*read_data_offset)(char *);
218 /* data length from read response message */
219 unsigned int (*read_data_length)(char *);
220 /* map smb to linux error */
221 int (*map_error)(char *, bool);
222 /* find mid corresponding to the response message */
223 struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
224 void (*dump_detail)(void *);
225 void (*clear_stats)(struct cifs_tcon *);
226 void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
227 void (*dump_share_caps)(struct seq_file *, struct cifs_tcon *);
228 /* verify the message */
229 int (*check_message)(char *, unsigned int);
230 bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
231 /* process transaction2 response */
232 bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
233 char *, int);
234 /* check if we need to negotiate */
235 bool (*need_neg)(struct TCP_Server_Info *);
236 /* negotiate to the server */
237 int (*negotiate)(const unsigned int, struct cifs_ses *);
238 /* set negotiated write size */
239 unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
240 /* set negotiated read size */
241 unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
242 /* setup smb sessionn */
243 int (*sess_setup)(const unsigned int, struct cifs_ses *,
244 const struct nls_table *);
245 /* close smb session */
246 int (*logoff)(const unsigned int, struct cifs_ses *);
247 /* connect to a server share */
248 int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
249 struct cifs_tcon *, const struct nls_table *);
250 /* close tree connecion */
251 int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
252 /* get DFS referrals */
253 int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
254 const char *, struct dfs_info3_param **,
255 unsigned int *, const struct nls_table *, int);
256 /* informational QFS call */
257 void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
258 /* check if a path is accessible or not */
259 int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
260 struct cifs_sb_info *, const char *);
261 /* query path data from the server */
262 int (*query_path_info)(const unsigned int, struct cifs_tcon *,
263 struct cifs_sb_info *, const char *,
264 FILE_ALL_INFO *, bool *, bool *);
265 /* query file data from the server */
266 int (*query_file_info)(const unsigned int, struct cifs_tcon *,
267 struct cifs_fid *, FILE_ALL_INFO *);
268 /* get server index number */
269 int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
270 struct cifs_sb_info *, const char *,
271 u64 *uniqueid, FILE_ALL_INFO *);
272 /* set size by path */
273 int (*set_path_size)(const unsigned int, struct cifs_tcon *,
274 const char *, __u64, struct cifs_sb_info *, bool);
275 /* set size by file handle */
276 int (*set_file_size)(const unsigned int, struct cifs_tcon *,
277 struct cifsFileInfo *, __u64, bool);
278 /* set attributes */
279 int (*set_file_info)(struct inode *, const char *, FILE_BASIC_INFO *,
280 const unsigned int);
281 int (*set_compression)(const unsigned int, struct cifs_tcon *,
282 struct cifsFileInfo *);
283 /* check if we can send an echo or nor */
284 bool (*can_echo)(struct TCP_Server_Info *);
285 /* send echo request */
286 int (*echo)(struct TCP_Server_Info *);
287 /* create directory */
288 int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
289 struct cifs_sb_info *);
290 /* set info on created directory */
291 void (*mkdir_setinfo)(struct inode *, const char *,
292 struct cifs_sb_info *, struct cifs_tcon *,
293 const unsigned int);
294 /* remove directory */
295 int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
296 struct cifs_sb_info *);
297 /* unlink file */
298 int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
299 struct cifs_sb_info *);
300 /* open, rename and delete file */
301 int (*rename_pending_delete)(const char *, struct dentry *,
302 const unsigned int);
303 /* send rename request */
304 int (*rename)(const unsigned int, struct cifs_tcon *, const char *,
305 const char *, struct cifs_sb_info *);
306 /* send create hardlink request */
307 int (*create_hardlink)(const unsigned int, struct cifs_tcon *,
308 const char *, const char *,
309 struct cifs_sb_info *);
310 /* query symlink target */
311 int (*query_symlink)(const unsigned int, struct cifs_tcon *,
312 const char *, char **, struct cifs_sb_info *);
313 /* open a file for non-posix mounts */
314 int (*open)(const unsigned int, struct cifs_open_parms *,
315 __u32 *, FILE_ALL_INFO *);
316 /* set fid protocol-specific info */
317 void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
318 /* close a file */
319 void (*close)(const unsigned int, struct cifs_tcon *,
320 struct cifs_fid *);
321 /* send a flush request to the server */
322 int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
323 /* async read from the server */
324 int (*async_readv)(struct cifs_readdata *);
325 /* async write to the server */
326 int (*async_writev)(struct cifs_writedata *);
327 /* sync read from the server */
328 int (*sync_read)(const unsigned int, struct cifsFileInfo *,
329 struct cifs_io_parms *, unsigned int *, char **,
330 int *);
331 /* sync write to the server */
332 int (*sync_write)(const unsigned int, struct cifsFileInfo *,
333 struct cifs_io_parms *, unsigned int *, struct kvec *,
334 unsigned long);
335 /* open dir, start readdir */
336 int (*query_dir_first)(const unsigned int, struct cifs_tcon *,
337 const char *, struct cifs_sb_info *,
338 struct cifs_fid *, __u16,
339 struct cifs_search_info *);
340 /* continue readdir */
341 int (*query_dir_next)(const unsigned int, struct cifs_tcon *,
342 struct cifs_fid *,
343 __u16, struct cifs_search_info *srch_inf);
344 /* close dir */
345 int (*close_dir)(const unsigned int, struct cifs_tcon *,
346 struct cifs_fid *);
347 /* calculate a size of SMB message */
348 unsigned int (*calc_smb_size)(void *);
349 /* check for STATUS_PENDING and process it in a positive case */
350 bool (*is_status_pending)(char *, struct TCP_Server_Info *, int);
351 /* send oplock break response */
352 int (*oplock_response)(struct cifs_tcon *, struct cifs_fid *,
353 struct cifsInodeInfo *);
354 /* query remote filesystem */
355 int (*queryfs)(const unsigned int, struct cifs_tcon *,
356 struct kstatfs *);
357 /* send mandatory brlock to the server */
358 int (*mand_lock)(const unsigned int, struct cifsFileInfo *, __u64,
359 __u64, __u32, int, int, bool);
360 /* unlock range of mandatory locks */
361 int (*mand_unlock_range)(struct cifsFileInfo *, struct file_lock *,
362 const unsigned int);
363 /* push brlocks from the cache to the server */
364 int (*push_mand_locks)(struct cifsFileInfo *);
365 /* get lease key of the inode */
366 void (*get_lease_key)(struct inode *, struct cifs_fid *);
367 /* set lease key of the inode */
368 void (*set_lease_key)(struct inode *, struct cifs_fid *);
369 /* generate new lease key */
370 void (*new_lease_key)(struct cifs_fid *);
371 int (*generate_signingkey)(struct cifs_ses *);
372 int (*calc_signature)(struct smb_rqst *, struct TCP_Server_Info *);
373 int (*query_mf_symlink)(unsigned int, struct cifs_tcon *,
374 struct cifs_sb_info *, const unsigned char *,
375 char *, unsigned int *);
376 /* if we can do cache read operations */
377 bool (*is_read_op)(__u32);
378 /* set oplock level for the inode */
379 void (*set_oplock_level)(struct cifsInodeInfo *, __u32, unsigned int,
380 bool *);
381 /* create lease context buffer for CREATE request */
382 char * (*create_lease_buf)(u8 *, u8);
383 /* parse lease context buffer and return oplock/epoch info */
384 __u8 (*parse_lease_buf)(void *, unsigned int *);
385 int (*clone_range)(const unsigned int, struct cifsFileInfo *src_file,
386 struct cifsFileInfo *target_file, u64 src_off, u64 len,
387 u64 dest_off);
388 int (*validate_negotiate)(const unsigned int, struct cifs_tcon *);
389 };
390
391 struct smb_version_values {
392 char *version_string;
393 __u16 protocol_id;
394 __u32 req_capabilities;
395 __u32 large_lock_type;
396 __u32 exclusive_lock_type;
397 __u32 shared_lock_type;
398 __u32 unlock_lock_type;
399 size_t header_size;
400 size_t max_header_size;
401 size_t read_rsp_size;
402 __le16 lock_cmd;
403 unsigned int cap_unix;
404 unsigned int cap_nt_find;
405 unsigned int cap_large_files;
406 __u16 signing_enabled;
407 __u16 signing_required;
408 size_t create_lease_size;
409 };
410
411 #define HEADER_SIZE(server) (server->vals->header_size)
412 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
413
414 struct smb_vol {
415 char *username;
416 char *password;
417 char *domainname;
418 char *UNC;
419 char *iocharset; /* local code page for mapping to and from Unicode */
420 char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
421 char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
422 kuid_t cred_uid;
423 kuid_t linux_uid;
424 kgid_t linux_gid;
425 kuid_t backupuid;
426 kgid_t backupgid;
427 umode_t file_mode;
428 umode_t dir_mode;
429 enum securityEnum sectype; /* sectype requested via mnt opts */
430 bool sign; /* was signing requested via mnt opts? */
431 bool retry:1;
432 bool intr:1;
433 bool setuids:1;
434 bool override_uid:1;
435 bool override_gid:1;
436 bool dynperm:1;
437 bool noperm:1;
438 bool no_psx_acl:1; /* set if posix acl support should be disabled */
439 bool cifs_acl:1;
440 bool backupuid_specified; /* mount option backupuid is specified */
441 bool backupgid_specified; /* mount option backupgid is specified */
442 bool no_xattr:1; /* set if xattr (EA) support should be disabled*/
443 bool server_ino:1; /* use inode numbers from server ie UniqueId */
444 bool direct_io:1;
445 bool strict_io:1; /* strict cache behavior */
446 bool remap:1; /* set to remap seven reserved chars in filenames */
447 bool posix_paths:1; /* unset to not ask for posix pathnames. */
448 bool no_linux_ext:1;
449 bool sfu_emul:1;
450 bool nullauth:1; /* attempt to authenticate with null user */
451 bool nocase:1; /* request case insensitive filenames */
452 bool nobrl:1; /* disable sending byte range locks to srv */
453 bool mand_lock:1; /* send mandatory not posix byte range lock reqs */
454 bool seal:1; /* request transport encryption on share */
455 bool nodfs:1; /* Do not request DFS, even if available */
456 bool local_lease:1; /* check leases only on local system, not remote */
457 bool noblocksnd:1;
458 bool noautotune:1;
459 bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
460 bool fsc:1; /* enable fscache */
461 bool mfsymlinks:1; /* use Minshall+French Symlinks */
462 bool multiuser:1;
463 bool rwpidforward:1; /* pid forward for read/write operations */
464 bool nosharesock;
465 unsigned int rsize;
466 unsigned int wsize;
467 bool sockopt_tcp_nodelay:1;
468 unsigned long actimeo; /* attribute cache timeout (jiffies) */
469 struct smb_version_operations *ops;
470 struct smb_version_values *vals;
471 char *prepath;
472 struct sockaddr_storage dstaddr; /* destination address */
473 struct sockaddr_storage srcaddr; /* allow binding to a local IP */
474 struct nls_table *local_nls;
475 };
476
477 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
478 CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
479 CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
480 CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
481 CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
482 CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
483 CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
484 CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
485 CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
486 CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
487
488 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
489 MS_NODEV | MS_SYNCHRONOUS)
490
491 struct cifs_mnt_data {
492 struct cifs_sb_info *cifs_sb;
493 struct smb_vol *vol;
494 int flags;
495 };
496
497 static inline unsigned int
498 get_rfc1002_length(void *buf)
499 {
500 return be32_to_cpu(*((__be32 *)buf));
501 }
502
503 static inline void
504 inc_rfc1001_len(void *buf, int count)
505 {
506 be32_add_cpu((__be32 *)buf, count);
507 }
508
509 struct TCP_Server_Info {
510 struct list_head tcp_ses_list;
511 struct list_head smb_ses_list;
512 int srv_count; /* reference counter */
513 /* 15 character server name + 0x20 16th byte indicating type = srv */
514 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
515 struct smb_version_operations *ops;
516 struct smb_version_values *vals;
517 enum statusEnum tcpStatus; /* what we think the status is */
518 char *hostname; /* hostname portion of UNC string */
519 struct socket *ssocket;
520 struct sockaddr_storage dstaddr;
521 struct sockaddr_storage srcaddr; /* locally bind to this IP */
522 #ifdef CONFIG_NET_NS
523 struct net *net;
524 #endif
525 wait_queue_head_t response_q;
526 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
527 struct list_head pending_mid_q;
528 bool noblocksnd; /* use blocking sendmsg */
529 bool noautotune; /* do not autotune send buf sizes */
530 bool tcp_nodelay;
531 int credits; /* send no more requests at once */
532 unsigned int in_flight; /* number of requests on the wire to server */
533 spinlock_t req_lock; /* protect the two values above */
534 struct mutex srv_mutex;
535 struct task_struct *tsk;
536 char server_GUID[16];
537 __u16 sec_mode;
538 bool sign; /* is signing enabled on this connection? */
539 bool session_estab; /* mark when very first sess is established */
540 #ifdef CONFIG_CIFS_SMB2
541 int echo_credits; /* echo reserved slots */
542 int oplock_credits; /* oplock break reserved slots */
543 bool echoes:1; /* enable echoes */
544 #endif
545 u16 dialect; /* dialect index that server chose */
546 bool oplocks:1; /* enable oplocks */
547 unsigned int maxReq; /* Clients should submit no more */
548 /* than maxReq distinct unanswered SMBs to the server when using */
549 /* multiplexed reads or writes */
550 unsigned int maxBuf; /* maxBuf specifies the maximum */
551 /* message size the server can send or receive for non-raw SMBs */
552 /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
553 /* when socket is setup (and during reconnect) before NegProt sent */
554 unsigned int max_rw; /* maxRw specifies the maximum */
555 /* message size the server can send or receive for */
556 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
557 unsigned int capabilities; /* selective disabling of caps by smb sess */
558 int timeAdj; /* Adjust for difference in server time zone in sec */
559 __u64 CurrentMid; /* multiplex id - rotating counter */
560 char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
561 /* 16th byte of RFC1001 workstation name is always null */
562 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
563 __u32 sequence_number; /* for signing, protected by srv_mutex */
564 struct session_key session_key;
565 unsigned long lstrp; /* when we got last response from this server */
566 struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
567 #define CIFS_NEGFLAVOR_LANMAN 0 /* wct == 13, LANMAN */
568 #define CIFS_NEGFLAVOR_UNENCAP 1 /* wct == 17, but no ext_sec */
569 #define CIFS_NEGFLAVOR_EXTENDED 2 /* wct == 17, ext_sec bit set */
570 char negflavor; /* NEGOTIATE response flavor */
571 /* extended security flavors that server supports */
572 bool sec_ntlmssp; /* supports NTLMSSP */
573 bool sec_kerberosu2u; /* supports U2U Kerberos */
574 bool sec_kerberos; /* supports plain Kerberos */
575 bool sec_mskerberos; /* supports legacy MS Kerberos */
576 bool large_buf; /* is current buffer large? */
577 struct delayed_work echo; /* echo ping workqueue job */
578 struct kvec *iov; /* reusable kvec array for receives */
579 unsigned int nr_iov; /* number of kvecs in array */
580 char *smallbuf; /* pointer to current "small" buffer */
581 char *bigbuf; /* pointer to current "big" buffer */
582 unsigned int total_read; /* total amount of data read in this pass */
583 #ifdef CONFIG_CIFS_FSCACHE
584 struct fscache_cookie *fscache; /* client index cache cookie */
585 #endif
586 #ifdef CONFIG_CIFS_STATS2
587 atomic_t in_send; /* requests trying to send */
588 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
589 #endif
590 #ifdef CONFIG_CIFS_SMB2
591 unsigned int max_read;
592 unsigned int max_write;
593 #endif /* CONFIG_CIFS_SMB2 */
594 };
595
596 static inline unsigned int
597 in_flight(struct TCP_Server_Info *server)
598 {
599 unsigned int num;
600 spin_lock(&server->req_lock);
601 num = server->in_flight;
602 spin_unlock(&server->req_lock);
603 return num;
604 }
605
606 static inline bool
607 has_credits(struct TCP_Server_Info *server, int *credits)
608 {
609 int num;
610 spin_lock(&server->req_lock);
611 num = *credits;
612 spin_unlock(&server->req_lock);
613 return num > 0;
614 }
615
616 static inline void
617 add_credits(struct TCP_Server_Info *server, const unsigned int add,
618 const int optype)
619 {
620 server->ops->add_credits(server, add, optype);
621 }
622
623 static inline void
624 set_credits(struct TCP_Server_Info *server, const int val)
625 {
626 server->ops->set_credits(server, val);
627 }
628
629 static inline __u64
630 get_next_mid64(struct TCP_Server_Info *server)
631 {
632 return server->ops->get_next_mid(server);
633 }
634
635 static inline __le16
636 get_next_mid(struct TCP_Server_Info *server)
637 {
638 __u16 mid = get_next_mid64(server);
639 /*
640 * The value in the SMB header should be little endian for easy
641 * on-the-wire decoding.
642 */
643 return cpu_to_le16(mid);
644 }
645
646 static inline __u16
647 get_mid(const struct smb_hdr *smb)
648 {
649 return le16_to_cpu(smb->Mid);
650 }
651
652 static inline bool
653 compare_mid(__u16 mid, const struct smb_hdr *smb)
654 {
655 return mid == le16_to_cpu(smb->Mid);
656 }
657
658 /*
659 * When the server supports very large reads and writes via POSIX extensions,
660 * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
661 * including the RFC1001 length.
662 *
663 * Note that this might make for "interesting" allocation problems during
664 * writeback however as we have to allocate an array of pointers for the
665 * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
666 *
667 * For reads, there is a similar problem as we need to allocate an array
668 * of kvecs to handle the receive, though that should only need to be done
669 * once.
670 */
671 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
672 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
673
674 /*
675 * When the server doesn't allow large posix writes, only allow a rsize/wsize
676 * of 2^17-1 minus the size of the call header. That allows for a read or
677 * write up to the maximum size described by RFC1002.
678 */
679 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
680 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
681
682 /*
683 * The default wsize is 1M. find_get_pages seems to return a maximum of 256
684 * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
685 * a single wsize request with a single call.
686 */
687 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
688
689 /*
690 * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
691 * those values when posix extensions aren't in force. In actuality here, we
692 * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
693 * to be ok with the extra byte even though Windows doesn't send writes that
694 * are that large.
695 *
696 * Citation:
697 *
698 * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
699 */
700 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
701 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
702
703 /*
704 * Macros to allow the TCP_Server_Info->net field and related code to drop out
705 * when CONFIG_NET_NS isn't set.
706 */
707
708 #ifdef CONFIG_NET_NS
709
710 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
711 {
712 return srv->net;
713 }
714
715 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
716 {
717 srv->net = net;
718 }
719
720 #else
721
722 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
723 {
724 return &init_net;
725 }
726
727 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
728 {
729 }
730
731 #endif
732
733 /*
734 * Session structure. One of these for each uid session with a particular host
735 */
736 struct cifs_ses {
737 struct list_head smb_ses_list;
738 struct list_head tcon_list;
739 struct mutex session_mutex;
740 struct TCP_Server_Info *server; /* pointer to server info */
741 int ses_count; /* reference counter */
742 enum statusEnum status;
743 unsigned overrideSecFlg; /* if non-zero override global sec flags */
744 __u16 ipc_tid; /* special tid for connection to IPC share */
745 char *serverOS; /* name of operating system underlying server */
746 char *serverNOS; /* name of network operating system of server */
747 char *serverDomain; /* security realm of server */
748 __u64 Suid; /* remote smb uid */
749 kuid_t linux_uid; /* overriding owner of files on the mount */
750 kuid_t cred_uid; /* owner of credentials */
751 unsigned int capabilities;
752 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
753 TCP names - will ipv6 and sctp addresses fit? */
754 char *user_name; /* must not be null except during init of sess
755 and after mount option parsing we fill it */
756 char *domainName;
757 char *password;
758 struct session_key auth_key;
759 struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
760 enum securityEnum sectype; /* what security flavor was specified? */
761 bool sign; /* is signing required? */
762 bool need_reconnect:1; /* connection reset, uid now invalid */
763 #ifdef CONFIG_CIFS_SMB2
764 __u16 session_flags;
765 char smb3signingkey[SMB3_SIGN_KEY_SIZE]; /* for signing smb3 packets */
766 #endif /* CONFIG_CIFS_SMB2 */
767 };
768
769 static inline bool
770 cap_unix(struct cifs_ses *ses)
771 {
772 return ses->server->vals->cap_unix & ses->capabilities;
773 }
774
775 /*
776 * there is one of these for each connection to a resource on a particular
777 * session
778 */
779 struct cifs_tcon {
780 struct list_head tcon_list;
781 int tc_count;
782 struct list_head openFileList;
783 struct cifs_ses *ses; /* pointer to session associated with */
784 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
785 char *nativeFileSystem;
786 char *password; /* for share-level security */
787 __u32 tid; /* The 4 byte tree id */
788 __u16 Flags; /* optional support bits */
789 enum statusEnum tidStatus;
790 #ifdef CONFIG_CIFS_STATS
791 atomic_t num_smbs_sent;
792 union {
793 struct {
794 atomic_t num_writes;
795 atomic_t num_reads;
796 atomic_t num_flushes;
797 atomic_t num_oplock_brks;
798 atomic_t num_opens;
799 atomic_t num_closes;
800 atomic_t num_deletes;
801 atomic_t num_mkdirs;
802 atomic_t num_posixopens;
803 atomic_t num_posixmkdirs;
804 atomic_t num_rmdirs;
805 atomic_t num_renames;
806 atomic_t num_t2renames;
807 atomic_t num_ffirst;
808 atomic_t num_fnext;
809 atomic_t num_fclose;
810 atomic_t num_hardlinks;
811 atomic_t num_symlinks;
812 atomic_t num_locks;
813 atomic_t num_acl_get;
814 atomic_t num_acl_set;
815 } cifs_stats;
816 #ifdef CONFIG_CIFS_SMB2
817 struct {
818 atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
819 atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
820 } smb2_stats;
821 #endif /* CONFIG_CIFS_SMB2 */
822 } stats;
823 #ifdef CONFIG_CIFS_STATS2
824 unsigned long long time_writes;
825 unsigned long long time_reads;
826 unsigned long long time_opens;
827 unsigned long long time_deletes;
828 unsigned long long time_closes;
829 unsigned long long time_mkdirs;
830 unsigned long long time_rmdirs;
831 unsigned long long time_renames;
832 unsigned long long time_t2renames;
833 unsigned long long time_ffirst;
834 unsigned long long time_fnext;
835 unsigned long long time_fclose;
836 #endif /* CONFIG_CIFS_STATS2 */
837 __u64 bytes_read;
838 __u64 bytes_written;
839 spinlock_t stat_lock;
840 #endif /* CONFIG_CIFS_STATS */
841 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
842 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
843 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
844 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
845 bool retry:1;
846 bool nocase:1;
847 bool seal:1; /* transport encryption for this mounted share */
848 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
849 for this mount even if server would support */
850 bool local_lease:1; /* check leases (only) on local system not remote */
851 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
852 bool need_reconnect:1; /* connection reset, tid now invalid */
853 #ifdef CONFIG_CIFS_SMB2
854 bool print:1; /* set if connection to printer share */
855 bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
856 __le32 capabilities;
857 __u32 share_flags;
858 __u32 maximal_access;
859 __u32 vol_serial_number;
860 __le64 vol_create_time;
861 __u32 ss_flags; /* sector size flags */
862 __u32 perf_sector_size; /* best sector size for perf */
863 __u32 max_chunks;
864 __u32 max_bytes_chunk;
865 __u32 max_bytes_copy;
866 #endif /* CONFIG_CIFS_SMB2 */
867 #ifdef CONFIG_CIFS_FSCACHE
868 u64 resource_id; /* server resource id */
869 struct fscache_cookie *fscache; /* cookie for share */
870 #endif
871 struct list_head pending_opens; /* list of incomplete opens */
872 /* BB add field for back pointer to sb struct(s)? */
873 };
874
875 /*
876 * This is a refcounted and timestamped container for a tcon pointer. The
877 * container holds a tcon reference. It is considered safe to free one of
878 * these when the tl_count goes to 0. The tl_time is the time of the last
879 * "get" on the container.
880 */
881 struct tcon_link {
882 struct rb_node tl_rbnode;
883 kuid_t tl_uid;
884 unsigned long tl_flags;
885 #define TCON_LINK_MASTER 0
886 #define TCON_LINK_PENDING 1
887 #define TCON_LINK_IN_TREE 2
888 unsigned long tl_time;
889 atomic_t tl_count;
890 struct cifs_tcon *tl_tcon;
891 };
892
893 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
894
895 static inline struct cifs_tcon *
896 tlink_tcon(struct tcon_link *tlink)
897 {
898 return tlink->tl_tcon;
899 }
900
901 extern void cifs_put_tlink(struct tcon_link *tlink);
902
903 static inline struct tcon_link *
904 cifs_get_tlink(struct tcon_link *tlink)
905 {
906 if (tlink && !IS_ERR(tlink))
907 atomic_inc(&tlink->tl_count);
908 return tlink;
909 }
910
911 /* This function is always expected to succeed */
912 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
913
914 #define CIFS_OPLOCK_NO_CHANGE 0xfe
915
916 struct cifs_pending_open {
917 struct list_head olist;
918 struct tcon_link *tlink;
919 __u8 lease_key[16];
920 __u32 oplock;
921 };
922
923 /*
924 * This info hangs off the cifsFileInfo structure, pointed to by llist.
925 * This is used to track byte stream locks on the file
926 */
927 struct cifsLockInfo {
928 struct list_head llist; /* pointer to next cifsLockInfo */
929 struct list_head blist; /* pointer to locks blocked on this */
930 wait_queue_head_t block_q;
931 __u64 offset;
932 __u64 length;
933 __u32 pid;
934 __u32 type;
935 };
936
937 /*
938 * One of these for each open instance of a file
939 */
940 struct cifs_search_info {
941 loff_t index_of_last_entry;
942 __u16 entries_in_buffer;
943 __u16 info_level;
944 __u32 resume_key;
945 char *ntwrk_buf_start;
946 char *srch_entries_start;
947 char *last_entry;
948 const char *presume_name;
949 unsigned int resume_name_len;
950 bool endOfSearch:1;
951 bool emptyDir:1;
952 bool unicode:1;
953 bool smallBuf:1; /* so we know which buf_release function to call */
954 };
955
956 struct cifs_open_parms {
957 struct cifs_tcon *tcon;
958 struct cifs_sb_info *cifs_sb;
959 int disposition;
960 int desired_access;
961 int create_options;
962 const char *path;
963 struct cifs_fid *fid;
964 bool reconnect:1;
965 };
966
967 struct cifs_fid {
968 __u16 netfid;
969 #ifdef CONFIG_CIFS_SMB2
970 __u64 persistent_fid; /* persist file id for smb2 */
971 __u64 volatile_fid; /* volatile file id for smb2 */
972 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for smb2 */
973 #endif
974 struct cifs_pending_open *pending_open;
975 unsigned int epoch;
976 bool purge_cache;
977 };
978
979 struct cifs_fid_locks {
980 struct list_head llist;
981 struct cifsFileInfo *cfile; /* fid that owns locks */
982 struct list_head locks; /* locks held by fid above */
983 };
984
985 struct cifsFileInfo {
986 struct list_head tlist; /* pointer to next fid owned by tcon */
987 struct list_head flist; /* next fid (file instance) for this inode */
988 struct cifs_fid_locks *llist; /* brlocks held by this fid */
989 kuid_t uid; /* allows finding which FileInfo structure */
990 __u32 pid; /* process id who opened file */
991 struct cifs_fid fid; /* file id from remote */
992 /* BB add lock scope info here if needed */ ;
993 /* lock scope id (0 if none) */
994 struct dentry *dentry;
995 unsigned int f_flags;
996 struct tcon_link *tlink;
997 bool invalidHandle:1; /* file closed via session abend */
998 bool oplock_break_cancelled:1;
999 int count; /* refcount protected by cifs_file_list_lock */
1000 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
1001 struct cifs_search_info srch_inf;
1002 struct work_struct oplock_break; /* work for oplock breaks */
1003 };
1004
1005 struct cifs_io_parms {
1006 __u16 netfid;
1007 #ifdef CONFIG_CIFS_SMB2
1008 __u64 persistent_fid; /* persist file id for smb2 */
1009 __u64 volatile_fid; /* volatile file id for smb2 */
1010 #endif
1011 __u32 pid;
1012 __u64 offset;
1013 unsigned int length;
1014 struct cifs_tcon *tcon;
1015 };
1016
1017 struct cifs_readdata;
1018
1019 /* asynchronous read support */
1020 struct cifs_readdata {
1021 struct kref refcount;
1022 struct list_head list;
1023 struct completion done;
1024 struct cifsFileInfo *cfile;
1025 struct address_space *mapping;
1026 __u64 offset;
1027 unsigned int bytes;
1028 pid_t pid;
1029 int result;
1030 struct work_struct work;
1031 int (*read_into_pages)(struct TCP_Server_Info *server,
1032 struct cifs_readdata *rdata,
1033 unsigned int len);
1034 struct kvec iov;
1035 unsigned int pagesz;
1036 unsigned int tailsz;
1037 unsigned int nr_pages;
1038 struct page *pages[];
1039 };
1040
1041 struct cifs_writedata;
1042
1043 /* asynchronous write support */
1044 struct cifs_writedata {
1045 struct kref refcount;
1046 struct list_head list;
1047 struct completion done;
1048 enum writeback_sync_modes sync_mode;
1049 struct work_struct work;
1050 struct cifsFileInfo *cfile;
1051 __u64 offset;
1052 pid_t pid;
1053 unsigned int bytes;
1054 int result;
1055 unsigned int pagesz;
1056 unsigned int tailsz;
1057 unsigned int nr_pages;
1058 struct page *pages[1];
1059 };
1060
1061 /*
1062 * Take a reference on the file private data. Must be called with
1063 * cifs_file_list_lock held.
1064 */
1065 static inline void
1066 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
1067 {
1068 ++cifs_file->count;
1069 }
1070
1071 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
1072 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
1073
1074 #define CIFS_CACHE_READ_FLG 1
1075 #define CIFS_CACHE_HANDLE_FLG 2
1076 #define CIFS_CACHE_RH_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_HANDLE_FLG)
1077 #define CIFS_CACHE_WRITE_FLG 4
1078 #define CIFS_CACHE_RW_FLG (CIFS_CACHE_READ_FLG | CIFS_CACHE_WRITE_FLG)
1079 #define CIFS_CACHE_RHW_FLG (CIFS_CACHE_RW_FLG | CIFS_CACHE_HANDLE_FLG)
1080
1081 #define CIFS_CACHE_READ(cinode) (cinode->oplock & CIFS_CACHE_READ_FLG)
1082 #define CIFS_CACHE_HANDLE(cinode) (cinode->oplock & CIFS_CACHE_HANDLE_FLG)
1083 #define CIFS_CACHE_WRITE(cinode) (cinode->oplock & CIFS_CACHE_WRITE_FLG)
1084
1085 /*
1086 * One of these for each file inode
1087 */
1088
1089 struct cifsInodeInfo {
1090 bool can_cache_brlcks;
1091 struct list_head llist; /* locks helb by this inode */
1092 struct rw_semaphore lock_sem; /* protect the fields above */
1093 /* BB add in lists for dirty pages i.e. write caching info for oplock */
1094 struct list_head openFileList;
1095 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
1096 unsigned int oplock; /* oplock/lease level we have */
1097 unsigned int epoch; /* used to track lease state changes */
1098 bool delete_pending; /* DELETE_ON_CLOSE is set */
1099 bool invalid_mapping; /* pagecache is invalid */
1100 unsigned long time; /* jiffies of last update of inode */
1101 u64 server_eof; /* current file size on server -- protected by i_lock */
1102 u64 uniqueid; /* server inode number */
1103 u64 createtime; /* creation time on server */
1104 #ifdef CONFIG_CIFS_SMB2
1105 __u8 lease_key[SMB2_LEASE_KEY_SIZE]; /* lease key for this inode */
1106 #endif
1107 #ifdef CONFIG_CIFS_FSCACHE
1108 struct fscache_cookie *fscache;
1109 #endif
1110 struct inode vfs_inode;
1111 };
1112
1113 static inline struct cifsInodeInfo *
1114 CIFS_I(struct inode *inode)
1115 {
1116 return container_of(inode, struct cifsInodeInfo, vfs_inode);
1117 }
1118
1119 static inline struct cifs_sb_info *
1120 CIFS_SB(struct super_block *sb)
1121 {
1122 return sb->s_fs_info;
1123 }
1124
1125 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
1126 {
1127 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
1128 return '/';
1129 else
1130 return '\\';
1131 }
1132
1133 static inline void
1134 convert_delimiter(char *path, char delim)
1135 {
1136 char old_delim, *pos;
1137
1138 if (delim == '/')
1139 old_delim = '\\';
1140 else
1141 old_delim = '/';
1142
1143 pos = path;
1144 while ((pos = strchr(pos, old_delim)))
1145 *pos = delim;
1146 }
1147
1148 #ifdef CONFIG_CIFS_STATS
1149 #define cifs_stats_inc atomic_inc
1150
1151 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
1152 unsigned int bytes)
1153 {
1154 if (bytes) {
1155 spin_lock(&tcon->stat_lock);
1156 tcon->bytes_written += bytes;
1157 spin_unlock(&tcon->stat_lock);
1158 }
1159 }
1160
1161 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
1162 unsigned int bytes)
1163 {
1164 spin_lock(&tcon->stat_lock);
1165 tcon->bytes_read += bytes;
1166 spin_unlock(&tcon->stat_lock);
1167 }
1168 #else
1169
1170 #define cifs_stats_inc(field) do {} while (0)
1171 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
1172 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
1173
1174 #endif
1175
1176
1177 /*
1178 * This is the prototype for the mid receive function. This function is for
1179 * receiving the rest of the SMB frame, starting with the WordCount (which is
1180 * just after the MID in struct smb_hdr). Note:
1181 *
1182 * - This will be called by cifsd, with no locks held.
1183 * - The mid will still be on the pending_mid_q.
1184 * - mid->resp_buf will point to the current buffer.
1185 *
1186 * Returns zero on a successful receive, or an error. The receive state in
1187 * the TCP_Server_Info will also be updated.
1188 */
1189 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
1190 struct mid_q_entry *mid);
1191
1192 /*
1193 * This is the prototype for the mid callback function. This is called once the
1194 * mid has been received off of the socket. When creating one, take special
1195 * care to avoid deadlocks. Things to bear in mind:
1196 *
1197 * - it will be called by cifsd, with no locks held
1198 * - the mid will be removed from any lists
1199 */
1200 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1201
1202 /* one of these for every pending CIFS request to the server */
1203 struct mid_q_entry {
1204 struct list_head qhead; /* mids waiting on reply from this server */
1205 struct TCP_Server_Info *server; /* server corresponding to this mid */
1206 __u64 mid; /* multiplex id */
1207 __u32 pid; /* process id */
1208 __u32 sequence_number; /* for CIFS signing */
1209 unsigned long when_alloc; /* when mid was created */
1210 #ifdef CONFIG_CIFS_STATS2
1211 unsigned long when_sent; /* time when smb send finished */
1212 unsigned long when_received; /* when demux complete (taken off wire) */
1213 #endif
1214 mid_receive_t *receive; /* call receive callback */
1215 mid_callback_t *callback; /* call completion callback */
1216 void *callback_data; /* general purpose pointer for callback */
1217 void *resp_buf; /* pointer to received SMB header */
1218 int mid_state; /* wish this were enum but can not pass to wait_event */
1219 __le16 command; /* smb command code */
1220 bool large_buf:1; /* if valid response, is pointer to large buf */
1221 bool multiRsp:1; /* multiple trans2 responses for one request */
1222 bool multiEnd:1; /* both received */
1223 };
1224
1225 /* Make code in transport.c a little cleaner by moving
1226 update of optional stats into function below */
1227 #ifdef CONFIG_CIFS_STATS2
1228
1229 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1230 {
1231 atomic_inc(&server->in_send);
1232 }
1233
1234 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1235 {
1236 atomic_dec(&server->in_send);
1237 }
1238
1239 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1240 {
1241 atomic_inc(&server->num_waiters);
1242 }
1243
1244 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1245 {
1246 atomic_dec(&server->num_waiters);
1247 }
1248
1249 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1250 {
1251 mid->when_sent = jiffies;
1252 }
1253 #else
1254 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1255 {
1256 }
1257 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1258 {
1259 }
1260
1261 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1262 {
1263 }
1264
1265 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1266 {
1267 }
1268
1269 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1270 {
1271 }
1272 #endif
1273
1274 /* for pending dnotify requests */
1275 struct dir_notify_req {
1276 struct list_head lhead;
1277 __le16 Pid;
1278 __le16 PidHigh;
1279 __u16 Mid;
1280 __u16 Tid;
1281 __u16 Uid;
1282 __u16 netfid;
1283 __u32 filter; /* CompletionFilter (for multishot) */
1284 int multishot;
1285 struct file *pfile;
1286 };
1287
1288 struct dfs_info3_param {
1289 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1290 int path_consumed;
1291 int server_type;
1292 int ref_flag;
1293 char *path_name;
1294 char *node_name;
1295 };
1296
1297 /*
1298 * common struct for holding inode info when searching for or updating an
1299 * inode with new info
1300 */
1301
1302 #define CIFS_FATTR_DFS_REFERRAL 0x1
1303 #define CIFS_FATTR_DELETE_PENDING 0x2
1304 #define CIFS_FATTR_NEED_REVAL 0x4
1305 #define CIFS_FATTR_INO_COLLISION 0x8
1306 #define CIFS_FATTR_UNKNOWN_NLINK 0x10
1307
1308 struct cifs_fattr {
1309 u32 cf_flags;
1310 u32 cf_cifsattrs;
1311 u64 cf_uniqueid;
1312 u64 cf_eof;
1313 u64 cf_bytes;
1314 u64 cf_createtime;
1315 kuid_t cf_uid;
1316 kgid_t cf_gid;
1317 umode_t cf_mode;
1318 dev_t cf_rdev;
1319 unsigned int cf_nlink;
1320 unsigned int cf_dtype;
1321 struct timespec cf_atime;
1322 struct timespec cf_mtime;
1323 struct timespec cf_ctime;
1324 };
1325
1326 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1327 {
1328 if (param) {
1329 kfree(param->path_name);
1330 kfree(param->node_name);
1331 kfree(param);
1332 }
1333 }
1334
1335 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1336 int number_of_items)
1337 {
1338 int i;
1339 if ((number_of_items == 0) || (param == NULL))
1340 return;
1341 for (i = 0; i < number_of_items; i++) {
1342 kfree(param[i].path_name);
1343 kfree(param[i].node_name);
1344 }
1345 kfree(param);
1346 }
1347
1348 #define MID_FREE 0
1349 #define MID_REQUEST_ALLOCATED 1
1350 #define MID_REQUEST_SUBMITTED 2
1351 #define MID_RESPONSE_RECEIVED 4
1352 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
1353 #define MID_RESPONSE_MALFORMED 0x10
1354 #define MID_SHUTDOWN 0x20
1355
1356 /* Types of response buffer returned from SendReceive2 */
1357 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
1358 #define CIFS_SMALL_BUFFER 1
1359 #define CIFS_LARGE_BUFFER 2
1360 #define CIFS_IOVEC 4 /* array of response buffers */
1361
1362 /* Type of Request to SendReceive2 */
1363 #define CIFS_BLOCKING_OP 1 /* operation can block */
1364 #define CIFS_ASYNC_OP 2 /* do not wait for response */
1365 #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */
1366 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
1367 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
1368 #define CIFS_NO_RESP 0x040 /* no response buffer required */
1369
1370 /* Type of request operation */
1371 #define CIFS_ECHO_OP 0x080 /* echo request */
1372 #define CIFS_OBREAK_OP 0x0100 /* oplock break request */
1373 #define CIFS_NEG_OP 0x0200 /* negotiate request */
1374 #define CIFS_OP_MASK 0x0380 /* mask request type */
1375
1376 /* Security Flags: indicate type of session setup needed */
1377 #define CIFSSEC_MAY_SIGN 0x00001
1378 #define CIFSSEC_MAY_NTLM 0x00002
1379 #define CIFSSEC_MAY_NTLMV2 0x00004
1380 #define CIFSSEC_MAY_KRB5 0x00008
1381 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1382 #define CIFSSEC_MAY_LANMAN 0x00010
1383 #define CIFSSEC_MAY_PLNTXT 0x00020
1384 #else
1385 #define CIFSSEC_MAY_LANMAN 0
1386 #define CIFSSEC_MAY_PLNTXT 0
1387 #endif /* weak passwords */
1388 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
1389 #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
1390
1391 #define CIFSSEC_MUST_SIGN 0x01001
1392 /* note that only one of the following can be set so the
1393 result of setting MUST flags more than once will be to
1394 require use of the stronger protocol */
1395 #define CIFSSEC_MUST_NTLM 0x02002
1396 #define CIFSSEC_MUST_NTLMV2 0x04004
1397 #define CIFSSEC_MUST_KRB5 0x08008
1398 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1399 #define CIFSSEC_MUST_LANMAN 0x10010
1400 #define CIFSSEC_MUST_PLNTXT 0x20020
1401 #ifdef CONFIG_CIFS_UPCALL
1402 #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
1403 #else
1404 #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
1405 #endif /* UPCALL */
1406 #else /* do not allow weak pw hash */
1407 #define CIFSSEC_MUST_LANMAN 0
1408 #define CIFSSEC_MUST_PLNTXT 0
1409 #ifdef CONFIG_CIFS_UPCALL
1410 #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
1411 #else
1412 #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
1413 #endif /* UPCALL */
1414 #endif /* WEAK_PW_HASH */
1415 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
1416 #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
1417
1418 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_NTLMSSP)
1419 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1420 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1421 /*
1422 *****************************************************************
1423 * All constants go here
1424 *****************************************************************
1425 */
1426
1427 #define UID_HASH (16)
1428
1429 /*
1430 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1431 * following to be declared.
1432 */
1433
1434 /****************************************************************************
1435 * Locking notes. All updates to global variables and lists should be
1436 * protected by spinlocks or semaphores.
1437 *
1438 * Spinlocks
1439 * ---------
1440 * GlobalMid_Lock protects:
1441 * list operations on pending_mid_q and oplockQ
1442 * updates to XID counters, multiplex id and SMB sequence numbers
1443 * cifs_file_list_lock protects:
1444 * list operations on tcp and SMB session lists and tCon lists
1445 * f_owner.lock protects certain per file struct operations
1446 * mapping->page_lock protects certain per page operations
1447 *
1448 * Semaphores
1449 * ----------
1450 * sesSem operations on smb session
1451 * tconSem operations on tree connection
1452 * fh_sem file handle reconnection operations
1453 *
1454 ****************************************************************************/
1455
1456 #ifdef DECLARE_GLOBALS_HERE
1457 #define GLOBAL_EXTERN
1458 #else
1459 #define GLOBAL_EXTERN extern
1460 #endif
1461
1462 /*
1463 * the list of TCP_Server_Info structures, ie each of the sockets
1464 * connecting our client to a distinct server (ip address), is
1465 * chained together by cifs_tcp_ses_list. The list of all our SMB
1466 * sessions (and from that the tree connections) can be found
1467 * by iterating over cifs_tcp_ses_list
1468 */
1469 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
1470
1471 /*
1472 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1473 * tcp session, and the list of tcon's per smb session. It also protects
1474 * the reference counters for the server, smb session, and tcon. Finally,
1475 * changes to the tcon->tidStatus should be done while holding this lock.
1476 */
1477 GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock;
1478
1479 /*
1480 * This lock protects the cifs_file->llist and cifs_file->flist
1481 * list operations, and updates to some flags (cifs_file->invalidHandle)
1482 * It will be moved to either use the tcon->stat_lock or equivalent later.
1483 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1484 * the cifs_tcp_ses_lock must be grabbed first and released last.
1485 */
1486 GLOBAL_EXTERN spinlock_t cifs_file_list_lock;
1487
1488 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1489 /* Outstanding dir notify requests */
1490 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1491 /* DirNotify response queue */
1492 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1493 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1494
1495 /*
1496 * Global transaction id (XID) information
1497 */
1498 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
1499 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1500 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
1501 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
1502 /* on midQ entries */
1503 /*
1504 * Global counters, updated atomically
1505 */
1506 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1507 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1508 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1509 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1510 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1511
1512 /* Various Debug counters */
1513 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
1514 #ifdef CONFIG_CIFS_STATS2
1515 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1516 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1517 #endif
1518 GLOBAL_EXTERN atomic_t smBufAllocCount;
1519 GLOBAL_EXTERN atomic_t midCount;
1520
1521 /* Misc globals */
1522 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1523 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1524 GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
1525 with more secure ntlmssp2 challenge/resp */
1526 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
1527 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1528 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
1529 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
1530 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
1531 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1532
1533 #ifdef CONFIG_CIFS_ACL
1534 GLOBAL_EXTERN struct rb_root uidtree;
1535 GLOBAL_EXTERN struct rb_root gidtree;
1536 GLOBAL_EXTERN spinlock_t siduidlock;
1537 GLOBAL_EXTERN spinlock_t sidgidlock;
1538 GLOBAL_EXTERN struct rb_root siduidtree;
1539 GLOBAL_EXTERN struct rb_root sidgidtree;
1540 GLOBAL_EXTERN spinlock_t uidsidlock;
1541 GLOBAL_EXTERN spinlock_t gidsidlock;
1542 #endif /* CONFIG_CIFS_ACL */
1543
1544 void cifs_oplock_break(struct work_struct *work);
1545
1546 extern const struct slow_work_ops cifs_oplock_break_ops;
1547 extern struct workqueue_struct *cifsiod_wq;
1548
1549 extern mempool_t *cifs_mid_poolp;
1550
1551 /* Operations for different SMB versions */
1552 #define SMB1_VERSION_STRING "1.0"
1553 extern struct smb_version_operations smb1_operations;
1554 extern struct smb_version_values smb1_values;
1555 #define SMB20_VERSION_STRING "2.0"
1556 extern struct smb_version_operations smb20_operations;
1557 extern struct smb_version_values smb20_values;
1558 #define SMB21_VERSION_STRING "2.1"
1559 extern struct smb_version_operations smb21_operations;
1560 extern struct smb_version_values smb21_values;
1561 #define SMB30_VERSION_STRING "3.0"
1562 extern struct smb_version_operations smb30_operations;
1563 extern struct smb_version_values smb30_values;
1564 #define SMB302_VERSION_STRING "3.02"
1565 /*extern struct smb_version_operations smb302_operations;*/ /* not needed yet */
1566 extern struct smb_version_values smb302_values;
1567 #endif /* _CIFS_GLOB_H */
Linux kernel - Deliverables
This page took 0.091609 seconds and 4 git commands to generate.