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