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