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