Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * fs/cifs/cifsglob.h | |
3 | * | |
366781c1 | 4 | * Copyright (C) International Business Machines Corp., 2002,2008 |
1da177e4 | 5 | * Author(s): Steve French (sfrench@us.ibm.com) |
7ee1af76 | 6 | * Jeremy Allison (jra@samba.org) |
1da177e4 LT |
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. | |
d38d8c74 | 17 | * |
1da177e4 | 18 | */ |
abd2e44d SJ |
19 | #ifndef _CIFS_GLOB_H |
20 | #define _CIFS_GLOB_H | |
21 | ||
1da177e4 LT |
22 | #include <linux/in.h> |
23 | #include <linux/in6.h> | |
5a0e3ad6 | 24 | #include <linux/slab.h> |
2dc7e1c0 | 25 | #include <linux/mempool.h> |
9b646972 | 26 | #include <linux/workqueue.h> |
1da177e4 | 27 | #include "cifs_fs_sb.h" |
442aa310 | 28 | #include "cifsacl.h" |
d2b91521 SP |
29 | #include <crypto/internal/hash.h> |
30 | #include <linux/scatterlist.h> | |
d60622eb PS |
31 | #ifdef CONFIG_CIFS_SMB2 |
32 | #include "smb2pdu.h" | |
33 | #endif | |
d2b91521 | 34 | |
1da177e4 LT |
35 | /* |
36 | * The sizes of various internal tables and strings | |
37 | */ | |
38 | #define MAX_UID_INFO 16 | |
39 | #define MAX_SES_INFO 2 | |
40 | #define MAX_TCON_INFO 4 | |
41 | ||
ef571cad | 42 | #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1) |
1da177e4 | 43 | #define MAX_SERVER_SIZE 15 |
2e325d59 | 44 | #define MAX_SHARE_SIZE 80 |
8727c8a8 SF |
45 | #define MAX_USERNAME_SIZE 256 /* reasonable maximum for current servers */ |
46 | #define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */ | |
1da177e4 LT |
47 | |
48 | #define CIFS_MIN_RCV_POOL 4 | |
49 | ||
2c0c2a08 | 50 | #define MAX_REOPEN_ATT 5 /* these many maximum attempts to reopen a file */ |
6d20e840 SJ |
51 | /* |
52 | * default attribute cache timeout (jiffies) | |
53 | */ | |
54 | #define CIFS_DEF_ACTIMEO (1 * HZ) | |
55 | ||
56 | /* | |
57 | * max attribute cache timeout (jiffies) - 2^30 | |
58 | */ | |
59 | #define CIFS_MAX_ACTIMEO (1 << 30) | |
60 | ||
1da177e4 LT |
61 | /* |
62 | * MAX_REQ is the maximum number of requests that WE will send | |
10b9b98e | 63 | * on one socket concurrently. |
1da177e4 | 64 | */ |
10b9b98e | 65 | #define CIFS_MAX_REQ 32767 |
1da177e4 | 66 | |
8ecaf67a JL |
67 | #define RFC1001_NAME_LEN 15 |
68 | #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1) | |
69 | ||
70 | /* currently length of NIP6_FMT */ | |
71 | #define SERVER_NAME_LENGTH 40 | |
1da177e4 LT |
72 | #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1) |
73 | ||
74 | /* used to define string lengths for reversing unicode strings */ | |
75 | /* (256+1)*2 = 514 */ | |
76 | /* (max path length + 1 for null) * 2 for unicode */ | |
77 | #define MAX_NAME 514 | |
78 | ||
9094fad1 PS |
79 | /* SMB echo "timeout" -- FIXME: tunable? */ |
80 | #define SMB_ECHO_INTERVAL (60 * HZ) | |
81 | ||
1da177e4 LT |
82 | #include "cifspdu.h" |
83 | ||
1da177e4 LT |
84 | #ifndef XATTR_DOS_ATTRIB |
85 | #define XATTR_DOS_ATTRIB "user.DOSATTRIB" | |
86 | #endif | |
87 | ||
1da177e4 LT |
88 | /* |
89 | * CIFS vfs client Status information (based on what we know.) | |
90 | */ | |
91 | ||
6c0f6218 | 92 | /* associated with each tcp and smb session */ |
1da177e4 LT |
93 | enum statusEnum { |
94 | CifsNew = 0, | |
95 | CifsGood, | |
96 | CifsExiting, | |
fd88ce93 SF |
97 | CifsNeedReconnect, |
98 | CifsNeedNegotiate | |
1da177e4 LT |
99 | }; |
100 | ||
101 | enum securityEnum { | |
daf5b0b6 | 102 | LANMAN = 0, /* Legacy LANMAN auth */ |
3979877e | 103 | NTLM, /* Legacy NTLM012 auth with NTLM hash */ |
1da177e4 | 104 | NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */ |
ac683924 | 105 | RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */ |
f46c7234 | 106 | /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */ |
c16fefa5 | 107 | Kerberos, /* Kerberos via SPNEGO */ |
1da177e4 LT |
108 | }; |
109 | ||
110 | enum protocolEnum { | |
3ec332ef | 111 | TCP = 0, |
1da177e4 LT |
112 | SCTP |
113 | /* Netbios frames protocol not supported at this time */ | |
114 | }; | |
115 | ||
5f98ca9a | 116 | struct session_key { |
b609f06a | 117 | unsigned int len; |
21e73393 | 118 | char *response; |
b609f06a SF |
119 | }; |
120 | ||
d2b91521 SP |
121 | /* crypto security descriptor definition */ |
122 | struct sdesc { | |
123 | struct shash_desc shash; | |
124 | char ctx[]; | |
125 | }; | |
126 | ||
f7c5445a | 127 | /* crypto hashing related structure/fields, not specific to a sec mech */ |
d2b91521 SP |
128 | struct cifs_secmech { |
129 | struct crypto_shash *hmacmd5; /* hmac-md5 hash function */ | |
130 | struct crypto_shash *md5; /* md5 hash function */ | |
131 | struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */ | |
132 | struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */ | |
133 | }; | |
134 | ||
d3686d54 | 135 | /* per smb session structure/fields */ |
d2b91521 SP |
136 | struct ntlmssp_auth { |
137 | __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */ | |
138 | __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */ | |
139 | unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */ | |
d3686d54 | 140 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */ |
d2b91521 SP |
141 | }; |
142 | ||
442aa310 SF |
143 | struct cifs_cred { |
144 | int uid; | |
145 | int gid; | |
146 | int mode; | |
147 | int cecount; | |
148 | struct cifs_sid osid; | |
149 | struct cifs_sid gsid; | |
150 | struct cifs_ntace *ntaces; | |
151 | struct cifs_ace *aces; | |
152 | }; | |
153 | ||
1da177e4 LT |
154 | /* |
155 | ***************************************************************** | |
156 | * Except the CIFS PDUs themselves all the | |
157 | * globally interesting structs should go here | |
158 | ***************************************************************** | |
159 | */ | |
160 | ||
23db65f5 JL |
161 | enum smb_version { |
162 | Smb_1 = 1, | |
1080ef75 | 163 | Smb_21, |
23db65f5 JL |
164 | }; |
165 | ||
121b046a JL |
166 | struct mid_q_entry; |
167 | struct TCP_Server_Info; | |
55157dfb | 168 | struct cifsFileInfo; |
082d0642 | 169 | struct cifs_ses; |
2e6e02ab | 170 | struct cifs_tcon; |
b669f33c | 171 | struct dfs_info3_param; |
1208ef1f | 172 | struct cifs_fattr; |
9224dfc2 | 173 | struct smb_vol; |
121b046a | 174 | |
23db65f5 | 175 | struct smb_version_operations { |
121b046a JL |
176 | int (*send_cancel)(struct TCP_Server_Info *, void *, |
177 | struct mid_q_entry *); | |
55157dfb | 178 | bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *); |
082d0642 PS |
179 | /* setup request: allocate mid, sign message */ |
180 | int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int, | |
181 | struct mid_q_entry **); | |
45740847 PS |
182 | /* setup async request: allocate mid, sign message */ |
183 | int (*setup_async_request)(struct TCP_Server_Info *, struct kvec *, | |
184 | unsigned int, struct mid_q_entry **); | |
082d0642 PS |
185 | /* check response: verify signature, map error */ |
186 | int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *, | |
187 | bool); | |
a891f0f8 PS |
188 | void (*add_credits)(struct TCP_Server_Info *, const unsigned int, |
189 | const int); | |
45275789 | 190 | void (*set_credits)(struct TCP_Server_Info *, const int); |
a891f0f8 PS |
191 | int * (*get_credits_field)(struct TCP_Server_Info *, const int); |
192 | unsigned int (*get_credits)(struct mid_q_entry *); | |
88257360 | 193 | __u64 (*get_next_mid)(struct TCP_Server_Info *); |
eb378711 PS |
194 | /* data offset from read response message */ |
195 | unsigned int (*read_data_offset)(char *); | |
196 | /* data length from read response message */ | |
197 | unsigned int (*read_data_length)(char *); | |
198 | /* map smb to linux error */ | |
199 | int (*map_error)(char *, bool); | |
8aa26f3e PS |
200 | /* find mid corresponding to the response message */ |
201 | struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *); | |
202 | void (*dump_detail)(void *); | |
44c58186 PS |
203 | void (*clear_stats)(struct cifs_tcon *); |
204 | void (*print_stats)(struct seq_file *m, struct cifs_tcon *); | |
8aa26f3e PS |
205 | /* verify the message */ |
206 | int (*check_message)(char *, unsigned int); | |
207 | bool (*is_oplock_break)(char *, struct TCP_Server_Info *); | |
316cf94a PS |
208 | /* process transaction2 response */ |
209 | bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *, | |
210 | char *, int); | |
286170aa PS |
211 | /* check if we need to negotiate */ |
212 | bool (*need_neg)(struct TCP_Server_Info *); | |
213 | /* negotiate to the server */ | |
214 | int (*negotiate)(const unsigned int, struct cifs_ses *); | |
58c45c58 PS |
215 | /* setup smb sessionn */ |
216 | int (*sess_setup)(const unsigned int, struct cifs_ses *, | |
217 | const struct nls_table *); | |
218 | /* close smb session */ | |
219 | int (*logoff)(const unsigned int, struct cifs_ses *); | |
2e6e02ab PS |
220 | /* connect to a server share */ |
221 | int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *, | |
222 | struct cifs_tcon *, const struct nls_table *); | |
223 | /* close tree connecion */ | |
224 | int (*tree_disconnect)(const unsigned int, struct cifs_tcon *); | |
b669f33c PS |
225 | /* get DFS referrals */ |
226 | int (*get_dfs_refer)(const unsigned int, struct cifs_ses *, | |
227 | const char *, struct dfs_info3_param **, | |
228 | unsigned int *, const struct nls_table *, int); | |
af4281dc PS |
229 | /* informational QFS call */ |
230 | void (*qfs_tcon)(const unsigned int, struct cifs_tcon *); | |
68889f26 PS |
231 | /* check if a path is accessible or not */ |
232 | int (*is_path_accessible)(const unsigned int, struct cifs_tcon *, | |
233 | struct cifs_sb_info *, const char *); | |
1208ef1f PS |
234 | /* query path data from the server */ |
235 | int (*query_path_info)(const unsigned int, struct cifs_tcon *, | |
236 | struct cifs_sb_info *, const char *, | |
237 | FILE_ALL_INFO *, bool *); | |
238 | /* get server index number */ | |
239 | int (*get_srv_inum)(const unsigned int, struct cifs_tcon *, | |
240 | struct cifs_sb_info *, const char *, | |
241 | u64 *uniqueid, FILE_ALL_INFO *); | |
9224dfc2 PS |
242 | /* build a full path to the root of the mount */ |
243 | char * (*build_path_to_root)(struct smb_vol *, struct cifs_sb_info *, | |
244 | struct cifs_tcon *); | |
f6d76178 PS |
245 | /* check if we can send an echo or nor */ |
246 | bool (*can_echo)(struct TCP_Server_Info *); | |
247 | /* send echo request */ | |
248 | int (*echo)(struct TCP_Server_Info *); | |
f436720e PS |
249 | /* create directory */ |
250 | int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *, | |
251 | struct cifs_sb_info *); | |
252 | /* set info on created directory */ | |
253 | void (*mkdir_setinfo)(struct inode *, const char *, | |
254 | struct cifs_sb_info *, struct cifs_tcon *, | |
255 | const unsigned int); | |
f958ca5d PS |
256 | /* remove directory */ |
257 | int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *, | |
258 | struct cifs_sb_info *); | |
23db65f5 JL |
259 | }; |
260 | ||
261 | struct smb_version_values { | |
262 | char *version_string; | |
106dc538 PS |
263 | __u32 large_lock_type; |
264 | __u32 exclusive_lock_type; | |
265 | __u32 shared_lock_type; | |
266 | __u32 unlock_lock_type; | |
1887f601 PS |
267 | size_t header_size; |
268 | size_t max_header_size; | |
eb378711 | 269 | size_t read_rsp_size; |
2dc7e1c0 | 270 | __le16 lock_cmd; |
29e20f9c PS |
271 | unsigned int cap_unix; |
272 | unsigned int cap_nt_find; | |
273 | unsigned int cap_large_files; | |
23db65f5 JL |
274 | }; |
275 | ||
1887f601 PS |
276 | #define HEADER_SIZE(server) (server->vals->header_size) |
277 | #define MAX_HEADER_SIZE(server) (server->vals->max_header_size) | |
278 | ||
f87d39d9 SF |
279 | struct smb_vol { |
280 | char *username; | |
281 | char *password; | |
282 | char *domainname; | |
283 | char *UNC; | |
284 | char *UNCip; | |
285 | char *iocharset; /* local code page for mapping to and from Unicode */ | |
286 | char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */ | |
287 | char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */ | |
288 | uid_t cred_uid; | |
289 | uid_t linux_uid; | |
290 | gid_t linux_gid; | |
3d3ea8e6 SP |
291 | uid_t backupuid; |
292 | gid_t backupgid; | |
5206efd6 AV |
293 | umode_t file_mode; |
294 | umode_t dir_mode; | |
f87d39d9 SF |
295 | unsigned secFlg; |
296 | bool retry:1; | |
297 | bool intr:1; | |
298 | bool setuids:1; | |
299 | bool override_uid:1; | |
300 | bool override_gid:1; | |
301 | bool dynperm:1; | |
302 | bool noperm:1; | |
303 | bool no_psx_acl:1; /* set if posix acl support should be disabled */ | |
304 | bool cifs_acl:1; | |
3d3ea8e6 SP |
305 | bool backupuid_specified; /* mount option backupuid is specified */ |
306 | bool backupgid_specified; /* mount option backupgid is specified */ | |
f87d39d9 SF |
307 | bool no_xattr:1; /* set if xattr (EA) support should be disabled*/ |
308 | bool server_ino:1; /* use inode numbers from server ie UniqueId */ | |
309 | bool direct_io:1; | |
310 | bool strict_io:1; /* strict cache behavior */ | |
311 | bool remap:1; /* set to remap seven reserved chars in filenames */ | |
312 | bool posix_paths:1; /* unset to not ask for posix pathnames. */ | |
313 | bool no_linux_ext:1; | |
314 | bool sfu_emul:1; | |
315 | bool nullauth:1; /* attempt to authenticate with null user */ | |
316 | bool nocase:1; /* request case insensitive filenames */ | |
317 | bool nobrl:1; /* disable sending byte range locks to srv */ | |
318 | bool mand_lock:1; /* send mandatory not posix byte range lock reqs */ | |
319 | bool seal:1; /* request transport encryption on share */ | |
320 | bool nodfs:1; /* Do not request DFS, even if available */ | |
321 | bool local_lease:1; /* check leases only on local system, not remote */ | |
322 | bool noblocksnd:1; | |
323 | bool noautotune:1; | |
324 | bool nostrictsync:1; /* do not force expensive SMBflush on every sync */ | |
325 | bool fsc:1; /* enable fscache */ | |
326 | bool mfsymlinks:1; /* use Minshall+French Symlinks */ | |
327 | bool multiuser:1; | |
d4ffff1f | 328 | bool rwpidforward:1; /* pid forward for read/write operations */ |
f87d39d9 SF |
329 | unsigned int rsize; |
330 | unsigned int wsize; | |
331 | bool sockopt_tcp_nodelay:1; | |
332 | unsigned short int port; | |
333 | unsigned long actimeo; /* attribute cache timeout (jiffies) */ | |
23db65f5 JL |
334 | struct smb_version_operations *ops; |
335 | struct smb_version_values *vals; | |
f87d39d9 SF |
336 | char *prepath; |
337 | struct sockaddr_storage srcaddr; /* allow binding to a local IP */ | |
338 | struct nls_table *local_nls; | |
339 | }; | |
340 | ||
25c7f41e PS |
341 | #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \ |
342 | CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \ | |
343 | CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \ | |
344 | CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \ | |
345 | CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \ | |
346 | CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \ | |
347 | CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \ | |
348 | CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \ | |
3d3ea8e6 SP |
349 | CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \ |
350 | CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID) | |
25c7f41e PS |
351 | |
352 | #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \ | |
353 | MS_NODEV | MS_SYNCHRONOUS) | |
354 | ||
355 | struct cifs_mnt_data { | |
356 | struct cifs_sb_info *cifs_sb; | |
357 | struct smb_vol *vol; | |
358 | int flags; | |
359 | }; | |
360 | ||
792af7b0 PS |
361 | static inline unsigned int |
362 | get_rfc1002_length(void *buf) | |
363 | { | |
364 | return be32_to_cpu(*((__be32 *)buf)); | |
365 | } | |
366 | ||
ec2e4523 PS |
367 | static inline void |
368 | inc_rfc1001_len(void *buf, int count) | |
369 | { | |
370 | be32_add_cpu((__be32 *)buf, count); | |
371 | } | |
372 | ||
1da177e4 | 373 | struct TCP_Server_Info { |
3b795210 SF |
374 | struct list_head tcp_ses_list; |
375 | struct list_head smb_ses_list; | |
e7ddee90 | 376 | int srv_count; /* reference counter */ |
a10faeb2 | 377 | /* 15 character server name + 0x20 16th byte indicating type = srv */ |
8ecaf67a | 378 | char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
23db65f5 JL |
379 | struct smb_version_operations *ops; |
380 | struct smb_version_values *vals; | |
c3dccf48 | 381 | enum statusEnum tcpStatus; /* what we think the status is */ |
c359cf3c | 382 | char *hostname; /* hostname portion of UNC string */ |
1da177e4 | 383 | struct socket *ssocket; |
a9f1b85e | 384 | struct sockaddr_storage dstaddr; |
3eb9a889 | 385 | struct sockaddr_storage srcaddr; /* locally bind to this IP */ |
f1d0c998 RL |
386 | #ifdef CONFIG_NET_NS |
387 | struct net *net; | |
388 | #endif | |
d38d8c74 | 389 | wait_queue_head_t response_q; |
1da177e4 LT |
390 | wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/ |
391 | struct list_head pending_mid_q; | |
edf1ae40 SF |
392 | bool noblocksnd; /* use blocking sendmsg */ |
393 | bool noautotune; /* do not autotune send buf sizes */ | |
6a5fa236 | 394 | bool tcp_nodelay; |
2d86dbc9 | 395 | int credits; /* send no more requests at once */ |
fc40f9cf | 396 | unsigned int in_flight; /* number of requests on the wire to server */ |
2d86dbc9 | 397 | spinlock_t req_lock; /* protect the two values above */ |
72ca545b | 398 | struct mutex srv_mutex; |
1da177e4 LT |
399 | struct task_struct *tsk; |
400 | char server_GUID[16]; | |
286170aa | 401 | __u16 sec_mode; |
c3dccf48 | 402 | bool session_estab; /* mark when very first sess is established */ |
28ea5290 PS |
403 | #ifdef CONFIG_CIFS_SMB2 |
404 | int echo_credits; /* echo reserved slots */ | |
405 | int oplock_credits; /* oplock break reserved slots */ | |
406 | bool echoes:1; /* enable echoes */ | |
407 | #endif | |
c3dccf48 | 408 | u16 dialect; /* dialect index that server chose */ |
1da177e4 | 409 | enum securityEnum secType; |
10b9b98e | 410 | bool oplocks:1; /* enable oplocks */ |
1da177e4 LT |
411 | unsigned int maxReq; /* Clients should submit no more */ |
412 | /* than maxReq distinct unanswered SMBs to the server when using */ | |
413 | /* multiplexed reads or writes */ | |
414 | unsigned int maxBuf; /* maxBuf specifies the maximum */ | |
415 | /* message size the server can send or receive for non-raw SMBs */ | |
7e90d705 SF |
416 | /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */ |
417 | /* when socket is setup (and during reconnect) before NegProt sent */ | |
eca6acf9 | 418 | unsigned int max_rw; /* maxRw specifies the maximum */ |
1da177e4 LT |
419 | /* message size the server can send or receive for */ |
420 | /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */ | |
eca6acf9 SF |
421 | unsigned int max_vcs; /* maximum number of smb sessions, at least |
422 | those that can be specified uniquely with | |
423 | vcnumbers */ | |
29e20f9c | 424 | unsigned int capabilities; /* selective disabling of caps by smb sess */ |
de7ed55d | 425 | int timeAdj; /* Adjust for difference in server time zone in sec */ |
243d04b6 | 426 | __u64 CurrentMid; /* multiplex id - rotating counter */ |
d3ba50b1 | 427 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */ |
a10faeb2 | 428 | /* 16th byte of RFC1001 workstation name is always null */ |
8ecaf67a | 429 | char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
a0f8b4fb | 430 | __u32 sequence_number; /* for signing, protected by srv_mutex */ |
5f98ca9a | 431 | struct session_key session_key; |
3a5ff61c | 432 | unsigned long lstrp; /* when we got last response from this server */ |
d2b91521 | 433 | struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */ |
26efa0ba | 434 | /* extended security flavors that server supports */ |
c3dccf48 JL |
435 | bool sec_ntlmssp; /* supports NTLMSSP */ |
436 | bool sec_kerberosu2u; /* supports U2U Kerberos */ | |
26efa0ba JL |
437 | bool sec_kerberos; /* supports plain Kerberos */ |
438 | bool sec_mskerberos; /* supports legacy MS Kerberos */ | |
2a37ef94 | 439 | bool large_buf; /* is current buffer large? */ |
c74093b6 | 440 | struct delayed_work echo; /* echo ping workqueue job */ |
1041e3f9 JL |
441 | struct kvec *iov; /* reusable kvec array for receives */ |
442 | unsigned int nr_iov; /* number of kvecs in array */ | |
2a37ef94 JL |
443 | char *smallbuf; /* pointer to current "small" buffer */ |
444 | char *bigbuf; /* pointer to current "big" buffer */ | |
445 | unsigned int total_read; /* total amount of data read in this pass */ | |
488f1d2d SJ |
446 | #ifdef CONFIG_CIFS_FSCACHE |
447 | struct fscache_cookie *fscache; /* client index cache cookie */ | |
448 | #endif | |
c3dccf48 | 449 | #ifdef CONFIG_CIFS_STATS2 |
789e6661 | 450 | atomic_t in_send; /* requests trying to send */ |
c3dccf48 JL |
451 | atomic_t num_waiters; /* blocked waiting to get in sendrecv */ |
452 | #endif | |
ec2e4523 PS |
453 | #ifdef CONFIG_CIFS_SMB2 |
454 | unsigned int max_read; | |
455 | unsigned int max_write; | |
456 | #endif /* CONFIG_CIFS_SMB2 */ | |
1da177e4 LT |
457 | }; |
458 | ||
fc40f9cf PS |
459 | static inline unsigned int |
460 | in_flight(struct TCP_Server_Info *server) | |
461 | { | |
462 | unsigned int num; | |
463 | spin_lock(&server->req_lock); | |
464 | num = server->in_flight; | |
465 | spin_unlock(&server->req_lock); | |
466 | return num; | |
467 | } | |
468 | ||
2d86dbc9 | 469 | static inline bool |
bc205ed1 | 470 | has_credits(struct TCP_Server_Info *server, int *credits) |
fc40f9cf | 471 | { |
2d86dbc9 | 472 | int num; |
fc40f9cf | 473 | spin_lock(&server->req_lock); |
bc205ed1 | 474 | num = *credits; |
fc40f9cf | 475 | spin_unlock(&server->req_lock); |
2d86dbc9 | 476 | return num > 0; |
fc40f9cf PS |
477 | } |
478 | ||
45275789 | 479 | static inline void |
a891f0f8 PS |
480 | add_credits(struct TCP_Server_Info *server, const unsigned int add, |
481 | const int optype) | |
45275789 | 482 | { |
a891f0f8 | 483 | server->ops->add_credits(server, add, optype); |
45275789 PS |
484 | } |
485 | ||
486 | static inline void | |
487 | set_credits(struct TCP_Server_Info *server, const int val) | |
488 | { | |
489 | server->ops->set_credits(server, val); | |
490 | } | |
491 | ||
88257360 PS |
492 | static inline __u64 |
493 | get_next_mid(struct TCP_Server_Info *server) | |
494 | { | |
495 | return server->ops->get_next_mid(server); | |
496 | } | |
497 | ||
f1d0c998 RL |
498 | /* |
499 | * Macros to allow the TCP_Server_Info->net field and related code to drop out | |
500 | * when CONFIG_NET_NS isn't set. | |
501 | */ | |
502 | ||
503 | #ifdef CONFIG_NET_NS | |
504 | ||
505 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
506 | { | |
507 | return srv->net; | |
508 | } | |
509 | ||
510 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
511 | { | |
512 | srv->net = net; | |
513 | } | |
514 | ||
515 | #else | |
516 | ||
517 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
518 | { | |
519 | return &init_net; | |
520 | } | |
521 | ||
522 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
523 | { | |
524 | } | |
525 | ||
526 | #endif | |
527 | ||
1da177e4 LT |
528 | /* |
529 | * Session structure. One of these for each uid session with a particular host | |
530 | */ | |
96daf2b0 | 531 | struct cifs_ses { |
14fbf50d | 532 | struct list_head smb_ses_list; |
3b795210 | 533 | struct list_head tcon_list; |
d7b619cf | 534 | struct mutex session_mutex; |
1da177e4 | 535 | struct TCP_Server_Info *server; /* pointer to server info */ |
14fbf50d | 536 | int ses_count; /* reference counter */ |
1da177e4 | 537 | enum statusEnum status; |
750d1151 | 538 | unsigned overrideSecFlg; /* if non-zero override global sec flags */ |
1da177e4 LT |
539 | __u16 ipc_tid; /* special tid for connection to IPC share */ |
540 | __u16 flags; | |
eca6acf9 | 541 | __u16 vcnum; |
ad009ac9 SF |
542 | char *serverOS; /* name of operating system underlying server */ |
543 | char *serverNOS; /* name of network operating system of server */ | |
1da177e4 | 544 | char *serverDomain; /* security realm of server */ |
286170aa | 545 | __u64 Suid; /* remote smb uid */ |
3e4b3e1f JL |
546 | uid_t linux_uid; /* overriding owner of files on the mount */ |
547 | uid_t cred_uid; /* owner of credentials */ | |
29e20f9c | 548 | unsigned int capabilities; |
d38d8c74 | 549 | char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for |
ad009ac9 | 550 | TCP names - will ipv6 and sctp addresses fit? */ |
34c87901 SF |
551 | char *user_name; /* must not be null except during init of sess |
552 | and after mount option parsing we fill it */ | |
d38d8c74 SF |
553 | char *domainName; |
554 | char *password; | |
5d0d2882 | 555 | struct session_key auth_key; |
d3686d54 | 556 | struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */ |
3b795210 | 557 | bool need_reconnect:1; /* connection reset, uid now invalid */ |
5478f9ba PS |
558 | #ifdef CONFIG_CIFS_SMB2 |
559 | __u16 session_flags; | |
560 | #endif /* CONFIG_CIFS_SMB2 */ | |
1da177e4 | 561 | }; |
9ac00b7d | 562 | /* no more than one of the following three session flags may be set */ |
1da177e4 | 563 | #define CIFS_SES_NT4 1 |
9ac00b7d SF |
564 | #define CIFS_SES_OS2 2 |
565 | #define CIFS_SES_W9X 4 | |
566 | /* following flag is set for old servers such as OS2 (and Win95?) | |
567 | which do not negotiate NTLM or POSIX dialects, but instead | |
568 | negotiate one of the older LANMAN dialects */ | |
569 | #define CIFS_SES_LANMAN 8 | |
29e20f9c PS |
570 | |
571 | static inline bool | |
572 | cap_unix(struct cifs_ses *ses) | |
573 | { | |
574 | return ses->server->vals->cap_unix & ses->capabilities; | |
575 | } | |
576 | ||
1da177e4 LT |
577 | /* |
578 | * there is one of these for each connection to a resource on a particular | |
d38d8c74 | 579 | * session |
1da177e4 | 580 | */ |
96daf2b0 | 581 | struct cifs_tcon { |
f1987b44 JL |
582 | struct list_head tcon_list; |
583 | int tc_count; | |
1da177e4 | 584 | struct list_head openFileList; |
96daf2b0 | 585 | struct cifs_ses *ses; /* pointer to session associated with */ |
254e55ed | 586 | char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */ |
1da177e4 | 587 | char *nativeFileSystem; |
00e485b0 | 588 | char *password; /* for share-level security */ |
faaf946a | 589 | __u32 tid; /* The 4 byte tree id */ |
1da177e4 LT |
590 | __u16 Flags; /* optional support bits */ |
591 | enum statusEnum tidStatus; | |
1da177e4 LT |
592 | #ifdef CONFIG_CIFS_STATS |
593 | atomic_t num_smbs_sent; | |
44c58186 PS |
594 | union { |
595 | struct { | |
596 | atomic_t num_writes; | |
597 | atomic_t num_reads; | |
598 | atomic_t num_flushes; | |
599 | atomic_t num_oplock_brks; | |
600 | atomic_t num_opens; | |
601 | atomic_t num_closes; | |
602 | atomic_t num_deletes; | |
603 | atomic_t num_mkdirs; | |
604 | atomic_t num_posixopens; | |
605 | atomic_t num_posixmkdirs; | |
606 | atomic_t num_rmdirs; | |
607 | atomic_t num_renames; | |
608 | atomic_t num_t2renames; | |
609 | atomic_t num_ffirst; | |
610 | atomic_t num_fnext; | |
611 | atomic_t num_fclose; | |
612 | atomic_t num_hardlinks; | |
613 | atomic_t num_symlinks; | |
614 | atomic_t num_locks; | |
615 | atomic_t num_acl_get; | |
616 | atomic_t num_acl_set; | |
617 | } cifs_stats; | |
d60622eb PS |
618 | #ifdef CONFIG_CIFS_SMB2 |
619 | struct { | |
620 | atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS]; | |
621 | atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS]; | |
622 | } smb2_stats; | |
623 | #endif /* CONFIG_CIFS_SMB2 */ | |
44c58186 | 624 | } stats; |
a5a2b489 SF |
625 | #ifdef CONFIG_CIFS_STATS2 |
626 | unsigned long long time_writes; | |
627 | unsigned long long time_reads; | |
628 | unsigned long long time_opens; | |
629 | unsigned long long time_deletes; | |
630 | unsigned long long time_closes; | |
631 | unsigned long long time_mkdirs; | |
632 | unsigned long long time_rmdirs; | |
633 | unsigned long long time_renames; | |
634 | unsigned long long time_t2renames; | |
635 | unsigned long long time_ffirst; | |
636 | unsigned long long time_fnext; | |
637 | unsigned long long time_fclose; | |
638 | #endif /* CONFIG_CIFS_STATS2 */ | |
1da177e4 LT |
639 | __u64 bytes_read; |
640 | __u64 bytes_written; | |
641 | spinlock_t stat_lock; | |
a5a2b489 | 642 | #endif /* CONFIG_CIFS_STATS */ |
1da177e4 | 643 | FILE_SYSTEM_DEVICE_INFO fsDevInfo; |
254e55ed | 644 | FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */ |
1da177e4 | 645 | FILE_SYSTEM_UNIX_INFO fsUnixInfo; |
4b18f2a9 SF |
646 | bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */ |
647 | bool retry:1; | |
648 | bool nocase:1; | |
95b1cb90 | 649 | bool seal:1; /* transport encryption for this mounted share */ |
4b18f2a9 | 650 | bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol |
c18c842b | 651 | for this mount even if server would support */ |
84210e91 | 652 | bool local_lease:1; /* check leases (only) on local system not remote */ |
64cc2c63 | 653 | bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */ |
3b795210 | 654 | bool need_reconnect:1; /* connection reset, tid now invalid */ |
faaf946a PS |
655 | #ifdef CONFIG_CIFS_SMB2 |
656 | bool print:1; /* set if connection to printer share */ | |
657 | bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */ | |
658 | __u32 capabilities; | |
659 | __u32 share_flags; | |
660 | __u32 maximal_access; | |
661 | __u32 vol_serial_number; | |
662 | __le64 vol_create_time; | |
663 | #endif /* CONFIG_CIFS_SMB2 */ | |
d03382ce SJ |
664 | #ifdef CONFIG_CIFS_FSCACHE |
665 | u64 resource_id; /* server resource id */ | |
666 | struct fscache_cookie *fscache; /* cookie for share */ | |
667 | #endif | |
c18c842b | 668 | /* BB add field for back pointer to sb struct(s)? */ |
1da177e4 LT |
669 | }; |
670 | ||
7ffec372 JL |
671 | /* |
672 | * This is a refcounted and timestamped container for a tcon pointer. The | |
673 | * container holds a tcon reference. It is considered safe to free one of | |
674 | * these when the tl_count goes to 0. The tl_time is the time of the last | |
675 | * "get" on the container. | |
676 | */ | |
677 | struct tcon_link { | |
b647c35f JL |
678 | struct rb_node tl_rbnode; |
679 | uid_t tl_uid; | |
9d002df4 JL |
680 | unsigned long tl_flags; |
681 | #define TCON_LINK_MASTER 0 | |
682 | #define TCON_LINK_PENDING 1 | |
683 | #define TCON_LINK_IN_TREE 2 | |
684 | unsigned long tl_time; | |
685 | atomic_t tl_count; | |
96daf2b0 | 686 | struct cifs_tcon *tl_tcon; |
7ffec372 JL |
687 | }; |
688 | ||
9d002df4 | 689 | extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb); |
7ffec372 | 690 | |
96daf2b0 | 691 | static inline struct cifs_tcon * |
7ffec372 JL |
692 | tlink_tcon(struct tcon_link *tlink) |
693 | { | |
9d002df4 | 694 | return tlink->tl_tcon; |
7ffec372 JL |
695 | } |
696 | ||
9d002df4 | 697 | extern void cifs_put_tlink(struct tcon_link *tlink); |
7ffec372 | 698 | |
13cfb733 JL |
699 | static inline struct tcon_link * |
700 | cifs_get_tlink(struct tcon_link *tlink) | |
701 | { | |
9d002df4 JL |
702 | if (tlink && !IS_ERR(tlink)) |
703 | atomic_inc(&tlink->tl_count); | |
13cfb733 JL |
704 | return tlink; |
705 | } | |
706 | ||
7ffec372 | 707 | /* This function is always expected to succeed */ |
96daf2b0 | 708 | extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb); |
7ffec372 | 709 | |
1da177e4 | 710 | /* |
7ee1af76 JA |
711 | * This info hangs off the cifsFileInfo structure, pointed to by llist. |
712 | * This is used to track byte stream locks on the file | |
1da177e4 LT |
713 | */ |
714 | struct cifsLockInfo { | |
7ee1af76 | 715 | struct list_head llist; /* pointer to next cifsLockInfo */ |
85160e03 PS |
716 | struct list_head blist; /* pointer to locks blocked on this */ |
717 | wait_queue_head_t block_q; | |
7ee1af76 JA |
718 | __u64 offset; |
719 | __u64 length; | |
03776f45 | 720 | __u32 pid; |
04a6aa8a | 721 | __u32 type; |
1da177e4 LT |
722 | }; |
723 | ||
724 | /* | |
725 | * One of these for each open instance of a file | |
726 | */ | |
727 | struct cifs_search_info { | |
728 | loff_t index_of_last_entry; | |
729 | __u16 entries_in_buffer; | |
730 | __u16 info_level; | |
731 | __u32 resume_key; | |
d38d8c74 SF |
732 | char *ntwrk_buf_start; |
733 | char *srch_entries_start; | |
0752f152 | 734 | char *last_entry; |
eaf35b1e | 735 | const char *presume_name; |
1da177e4 | 736 | unsigned int resume_name_len; |
4b18f2a9 SF |
737 | bool endOfSearch:1; |
738 | bool emptyDir:1; | |
739 | bool unicode:1; | |
740 | bool smallBuf:1; /* so we know which buf_release function to call */ | |
1da177e4 LT |
741 | }; |
742 | ||
743 | struct cifsFileInfo { | |
744 | struct list_head tlist; /* pointer to next fid owned by tcon */ | |
745 | struct list_head flist; /* next fid (file instance) for this inode */ | |
fbd35aca PS |
746 | struct list_head llist; /* |
747 | * brlocks held by this fid, protected by | |
748 | * lock_mutex from cifsInodeInfo structure | |
749 | */ | |
1da177e4 LT |
750 | unsigned int uid; /* allows finding which FileInfo structure */ |
751 | __u32 pid; /* process id who opened file */ | |
752 | __u16 netfid; /* file id from remote */ | |
753 | /* BB add lock scope info here if needed */ ; | |
754 | /* lock scope id (0 if none) */ | |
a5e18bc3 | 755 | struct dentry *dentry; |
15886177 | 756 | unsigned int f_flags; |
13cfb733 | 757 | struct tcon_link *tlink; |
4b18f2a9 | 758 | bool invalidHandle:1; /* file closed via session abend */ |
3bc303c2 | 759 | bool oplock_break_cancelled:1; |
6c0f6218 | 760 | int count; /* refcount protected by cifs_file_list_lock */ |
a6ce4932 | 761 | struct mutex fh_mutex; /* prevents reopen race after dead ses*/ |
1da177e4 | 762 | struct cifs_search_info srch_inf; |
9b646972 | 763 | struct work_struct oplock_break; /* work for oplock breaks */ |
1da177e4 LT |
764 | }; |
765 | ||
fa2989f4 PS |
766 | struct cifs_io_parms { |
767 | __u16 netfid; | |
768 | __u32 pid; | |
769 | __u64 offset; | |
770 | unsigned int length; | |
96daf2b0 | 771 | struct cifs_tcon *tcon; |
fa2989f4 PS |
772 | }; |
773 | ||
5f6dbc9e JL |
774 | /* |
775 | * Take a reference on the file private data. Must be called with | |
776 | * cifs_file_list_lock held. | |
777 | */ | |
764a1b1a JL |
778 | static inline void |
779 | cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file) | |
6ab409b5 | 780 | { |
5f6dbc9e | 781 | ++cifs_file->count; |
6ab409b5 DK |
782 | } |
783 | ||
764a1b1a | 784 | struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file); |
b33879aa | 785 | void cifsFileInfo_put(struct cifsFileInfo *cifs_file); |
6ab409b5 | 786 | |
1da177e4 LT |
787 | /* |
788 | * One of these for each file inode | |
789 | */ | |
790 | ||
791 | struct cifsInodeInfo { | |
d59dad2b | 792 | bool can_cache_brlcks; |
fbd35aca PS |
793 | struct mutex lock_mutex; /* |
794 | * protect the field above and llist | |
795 | * from every cifsFileInfo structure | |
796 | * from openFileList | |
797 | */ | |
d38d8c74 | 798 | /* BB add in lists for dirty pages i.e. write caching info for oplock */ |
1da177e4 | 799 | struct list_head openFileList; |
1da177e4 | 800 | __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */ |
aae62fdb JL |
801 | bool clientCanCacheRead; /* read oplock */ |
802 | bool clientCanCacheAll; /* read and writebehind oplock */ | |
803 | bool delete_pending; /* DELETE_ON_CLOSE is set */ | |
804 | bool invalid_mapping; /* pagecache is invalid */ | |
805 | unsigned long time; /* jiffies of last update of inode */ | |
597b027f | 806 | u64 server_eof; /* current file size on server -- protected by i_lock */ |
cc0bad75 | 807 | u64 uniqueid; /* server inode number */ |
20054bd6 | 808 | u64 createtime; /* creation time on server */ |
9451a9a5 SJ |
809 | #ifdef CONFIG_CIFS_FSCACHE |
810 | struct fscache_cookie *fscache; | |
811 | #endif | |
1da177e4 LT |
812 | struct inode vfs_inode; |
813 | }; | |
814 | ||
815 | static inline struct cifsInodeInfo * | |
816 | CIFS_I(struct inode *inode) | |
817 | { | |
818 | return container_of(inode, struct cifsInodeInfo, vfs_inode); | |
819 | } | |
820 | ||
821 | static inline struct cifs_sb_info * | |
822 | CIFS_SB(struct super_block *sb) | |
823 | { | |
824 | return sb->s_fs_info; | |
825 | } | |
826 | ||
ab2f218f | 827 | static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb) |
ac67055e JA |
828 | { |
829 | if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS) | |
830 | return '/'; | |
831 | else | |
832 | return '\\'; | |
833 | } | |
1da177e4 | 834 | |
f87d39d9 SF |
835 | static inline void |
836 | convert_delimiter(char *path, char delim) | |
837 | { | |
838 | int i; | |
839 | char old_delim; | |
840 | ||
841 | if (path == NULL) | |
842 | return; | |
843 | ||
844 | if (delim == '/') | |
845 | old_delim = '\\'; | |
846 | else | |
847 | old_delim = '/'; | |
848 | ||
849 | for (i = 0; path[i] != '\0'; i++) { | |
850 | if (path[i] == old_delim) | |
851 | path[i] = delim; | |
852 | } | |
853 | } | |
854 | ||
9224dfc2 PS |
855 | static inline char * |
856 | build_path_to_root(struct smb_vol *vol, struct cifs_sb_info *cifs_sb, | |
857 | struct cifs_tcon *tcon) | |
858 | { | |
859 | if (!vol->ops->build_path_to_root) | |
860 | return NULL; | |
861 | return vol->ops->build_path_to_root(vol, cifs_sb, tcon); | |
862 | } | |
863 | ||
a4544347 SF |
864 | #ifdef CONFIG_CIFS_STATS |
865 | #define cifs_stats_inc atomic_inc | |
866 | ||
96daf2b0 | 867 | static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon, |
a4544347 SF |
868 | unsigned int bytes) |
869 | { | |
870 | if (bytes) { | |
871 | spin_lock(&tcon->stat_lock); | |
872 | tcon->bytes_written += bytes; | |
873 | spin_unlock(&tcon->stat_lock); | |
874 | } | |
875 | } | |
876 | ||
96daf2b0 | 877 | static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon, |
a4544347 SF |
878 | unsigned int bytes) |
879 | { | |
880 | spin_lock(&tcon->stat_lock); | |
881 | tcon->bytes_read += bytes; | |
882 | spin_unlock(&tcon->stat_lock); | |
883 | } | |
884 | #else | |
885 | ||
d38d8c74 SF |
886 | #define cifs_stats_inc(field) do {} while (0) |
887 | #define cifs_stats_bytes_written(tcon, bytes) do {} while (0) | |
888 | #define cifs_stats_bytes_read(tcon, bytes) do {} while (0) | |
a4544347 SF |
889 | |
890 | #endif | |
891 | ||
2b84a36c JL |
892 | |
893 | /* | |
44d22d84 JL |
894 | * This is the prototype for the mid receive function. This function is for |
895 | * receiving the rest of the SMB frame, starting with the WordCount (which is | |
896 | * just after the MID in struct smb_hdr). Note: | |
897 | * | |
898 | * - This will be called by cifsd, with no locks held. | |
899 | * - The mid will still be on the pending_mid_q. | |
900 | * - mid->resp_buf will point to the current buffer. | |
901 | * | |
902 | * Returns zero on a successful receive, or an error. The receive state in | |
903 | * the TCP_Server_Info will also be updated. | |
904 | */ | |
905 | typedef int (mid_receive_t)(struct TCP_Server_Info *server, | |
906 | struct mid_q_entry *mid); | |
907 | ||
908 | /* | |
909 | * This is the prototype for the mid callback function. This is called once the | |
910 | * mid has been received off of the socket. When creating one, take special | |
911 | * care to avoid deadlocks. Things to bear in mind: | |
2b84a36c | 912 | * |
3c1105df JL |
913 | * - it will be called by cifsd, with no locks held |
914 | * - the mid will be removed from any lists | |
2b84a36c JL |
915 | */ |
916 | typedef void (mid_callback_t)(struct mid_q_entry *mid); | |
917 | ||
1da177e4 LT |
918 | /* one of these for every pending CIFS request to the server */ |
919 | struct mid_q_entry { | |
920 | struct list_head qhead; /* mids waiting on reply from this server */ | |
2dc7e1c0 | 921 | struct TCP_Server_Info *server; /* server corresponding to this mid */ |
7c9421e1 PS |
922 | __u64 mid; /* multiplex id */ |
923 | __u32 pid; /* process id */ | |
1da177e4 | 924 | __u32 sequence_number; /* for CIFS signing */ |
1047abc1 SF |
925 | unsigned long when_alloc; /* when mid was created */ |
926 | #ifdef CONFIG_CIFS_STATS2 | |
927 | unsigned long when_sent; /* time when smb send finished */ | |
928 | unsigned long when_received; /* when demux complete (taken off wire) */ | |
929 | #endif | |
44d22d84 | 930 | mid_receive_t *receive; /* call receive callback */ |
2b84a36c JL |
931 | mid_callback_t *callback; /* call completion callback */ |
932 | void *callback_data; /* general purpose pointer for callback */ | |
d4e4854f | 933 | void *resp_buf; /* pointer to received SMB header */ |
7c9421e1 PS |
934 | int mid_state; /* wish this were enum but can not pass to wait_event */ |
935 | __le16 command; /* smb command code */ | |
936 | bool large_buf:1; /* if valid response, is pointer to large buf */ | |
4b18f2a9 SF |
937 | bool multiRsp:1; /* multiple trans2 responses for one request */ |
938 | bool multiEnd:1; /* both received */ | |
1da177e4 LT |
939 | }; |
940 | ||
789e6661 SF |
941 | /* Make code in transport.c a little cleaner by moving |
942 | update of optional stats into function below */ | |
943 | #ifdef CONFIG_CIFS_STATS2 | |
944 | ||
945 | static inline void cifs_in_send_inc(struct TCP_Server_Info *server) | |
946 | { | |
947 | atomic_inc(&server->in_send); | |
948 | } | |
949 | ||
950 | static inline void cifs_in_send_dec(struct TCP_Server_Info *server) | |
951 | { | |
952 | atomic_dec(&server->in_send); | |
953 | } | |
954 | ||
955 | static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server) | |
956 | { | |
957 | atomic_inc(&server->num_waiters); | |
958 | } | |
959 | ||
960 | static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server) | |
961 | { | |
962 | atomic_dec(&server->num_waiters); | |
963 | } | |
964 | ||
965 | static inline void cifs_save_when_sent(struct mid_q_entry *mid) | |
966 | { | |
967 | mid->when_sent = jiffies; | |
968 | } | |
969 | #else | |
970 | static inline void cifs_in_send_inc(struct TCP_Server_Info *server) | |
971 | { | |
972 | } | |
973 | static inline void cifs_in_send_dec(struct TCP_Server_Info *server) | |
974 | { | |
975 | } | |
976 | ||
977 | static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server) | |
978 | { | |
979 | } | |
980 | ||
981 | static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server) | |
982 | { | |
983 | } | |
984 | ||
985 | static inline void cifs_save_when_sent(struct mid_q_entry *mid) | |
986 | { | |
987 | } | |
988 | #endif | |
1da177e4 | 989 | |
ff5dbd9e SF |
990 | /* for pending dnotify requests */ |
991 | struct dir_notify_req { | |
13cd4b7f SF |
992 | struct list_head lhead; |
993 | __le16 Pid; | |
994 | __le16 PidHigh; | |
995 | __u16 Mid; | |
996 | __u16 Tid; | |
997 | __u16 Uid; | |
998 | __u16 netfid; | |
999 | __u32 filter; /* CompletionFilter (for multishot) */ | |
1000 | int multishot; | |
1001 | struct file *pfile; | |
ff5dbd9e SF |
1002 | }; |
1003 | ||
366781c1 SF |
1004 | struct dfs_info3_param { |
1005 | int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/ | |
8aad018b | 1006 | int path_consumed; |
366781c1 SF |
1007 | int server_type; |
1008 | int ref_flag; | |
1009 | char *path_name; | |
1010 | char *node_name; | |
1011 | }; | |
1012 | ||
cc0bad75 JL |
1013 | /* |
1014 | * common struct for holding inode info when searching for or updating an | |
1015 | * inode with new info | |
1016 | */ | |
1017 | ||
1018 | #define CIFS_FATTR_DFS_REFERRAL 0x1 | |
0b8f18e3 JL |
1019 | #define CIFS_FATTR_DELETE_PENDING 0x2 |
1020 | #define CIFS_FATTR_NEED_REVAL 0x4 | |
3d694380 | 1021 | #define CIFS_FATTR_INO_COLLISION 0x8 |
cc0bad75 JL |
1022 | |
1023 | struct cifs_fattr { | |
1024 | u32 cf_flags; | |
1025 | u32 cf_cifsattrs; | |
1026 | u64 cf_uniqueid; | |
1027 | u64 cf_eof; | |
1028 | u64 cf_bytes; | |
20054bd6 | 1029 | u64 cf_createtime; |
cc0bad75 JL |
1030 | uid_t cf_uid; |
1031 | gid_t cf_gid; | |
1032 | umode_t cf_mode; | |
1033 | dev_t cf_rdev; | |
1034 | unsigned int cf_nlink; | |
1035 | unsigned int cf_dtype; | |
1036 | struct timespec cf_atime; | |
1037 | struct timespec cf_mtime; | |
1038 | struct timespec cf_ctime; | |
1039 | }; | |
1040 | ||
366781c1 SF |
1041 | static inline void free_dfs_info_param(struct dfs_info3_param *param) |
1042 | { | |
1043 | if (param) { | |
1044 | kfree(param->path_name); | |
1045 | kfree(param->node_name); | |
1046 | kfree(param); | |
1047 | } | |
1048 | } | |
1049 | ||
1050 | static inline void free_dfs_info_array(struct dfs_info3_param *param, | |
1051 | int number_of_items) | |
1052 | { | |
1053 | int i; | |
1054 | if ((number_of_items == 0) || (param == NULL)) | |
1055 | return; | |
1056 | for (i = 0; i < number_of_items; i++) { | |
1057 | kfree(param[i].path_name); | |
1058 | kfree(param[i].node_name); | |
1059 | } | |
1060 | kfree(param); | |
1061 | } | |
1062 | ||
1da177e4 LT |
1063 | #define MID_FREE 0 |
1064 | #define MID_REQUEST_ALLOCATED 1 | |
1065 | #define MID_REQUEST_SUBMITTED 2 | |
1066 | #define MID_RESPONSE_RECEIVED 4 | |
1067 | #define MID_RETRY_NEEDED 8 /* session closed while this request out */ | |
71823baf | 1068 | #define MID_RESPONSE_MALFORMED 0x10 |
3c1105df | 1069 | #define MID_SHUTDOWN 0x20 |
ec637e3f SF |
1070 | |
1071 | /* Types of response buffer returned from SendReceive2 */ | |
1072 | #define CIFS_NO_BUFFER 0 /* Response buffer not returned */ | |
1073 | #define CIFS_SMALL_BUFFER 1 | |
1074 | #define CIFS_LARGE_BUFFER 2 | |
1075 | #define CIFS_IOVEC 4 /* array of response buffers */ | |
1da177e4 | 1076 | |
133672ef | 1077 | /* Type of Request to SendReceive2 */ |
7749981e JL |
1078 | #define CIFS_BLOCKING_OP 1 /* operation can block */ |
1079 | #define CIFS_ASYNC_OP 2 /* do not wait for response */ | |
1080 | #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */ | |
133672ef SF |
1081 | #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */ |
1082 | #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */ | |
1083 | #define CIFS_NO_RESP 0x040 /* no response buffer required */ | |
1084 | ||
a891f0f8 PS |
1085 | /* Type of request operation */ |
1086 | #define CIFS_ECHO_OP 0x080 /* echo request */ | |
1087 | #define CIFS_OBREAK_OP 0x0100 /* oplock break request */ | |
ec2e4523 PS |
1088 | #define CIFS_NEG_OP 0x0200 /* negotiate request */ |
1089 | #define CIFS_OP_MASK 0x0380 /* mask request type */ | |
a891f0f8 | 1090 | |
3979877e SF |
1091 | /* Security Flags: indicate type of session setup needed */ |
1092 | #define CIFSSEC_MAY_SIGN 0x00001 | |
1093 | #define CIFSSEC_MAY_NTLM 0x00002 | |
1094 | #define CIFSSEC_MAY_NTLMV2 0x00004 | |
1095 | #define CIFSSEC_MAY_KRB5 0x00008 | |
1096 | #ifdef CONFIG_CIFS_WEAK_PW_HASH | |
1097 | #define CIFSSEC_MAY_LANMAN 0x00010 | |
1098 | #define CIFSSEC_MAY_PLNTXT 0x00020 | |
516897a2 SF |
1099 | #else |
1100 | #define CIFSSEC_MAY_LANMAN 0 | |
1101 | #define CIFSSEC_MAY_PLNTXT 0 | |
3979877e SF |
1102 | #endif /* weak passwords */ |
1103 | #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */ | |
ac683924 | 1104 | #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */ |
3979877e SF |
1105 | |
1106 | #define CIFSSEC_MUST_SIGN 0x01001 | |
1107 | /* note that only one of the following can be set so the | |
1108 | result of setting MUST flags more than once will be to | |
1109 | require use of the stronger protocol */ | |
1110 | #define CIFSSEC_MUST_NTLM 0x02002 | |
1111 | #define CIFSSEC_MUST_NTLMV2 0x04004 | |
1112 | #define CIFSSEC_MUST_KRB5 0x08008 | |
1113 | #ifdef CONFIG_CIFS_WEAK_PW_HASH | |
1114 | #define CIFSSEC_MUST_LANMAN 0x10010 | |
1115 | #define CIFSSEC_MUST_PLNTXT 0x20020 | |
0d3a01fa | 1116 | #ifdef CONFIG_CIFS_UPCALL |
20d1752f | 1117 | #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */ |
0d3a01fa | 1118 | #else |
20d1752f | 1119 | #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */ |
016ec75f | 1120 | #endif /* UPCALL */ |
0d3a01fa | 1121 | #else /* do not allow weak pw hash */ |
88a4412b SF |
1122 | #define CIFSSEC_MUST_LANMAN 0 |
1123 | #define CIFSSEC_MUST_PLNTXT 0 | |
0d3a01fa | 1124 | #ifdef CONFIG_CIFS_UPCALL |
ac683924 | 1125 | #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */ |
d38d8c74 | 1126 | #else |
ac683924 | 1127 | #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */ |
016ec75f | 1128 | #endif /* UPCALL */ |
3979877e SF |
1129 | #endif /* WEAK_PW_HASH */ |
1130 | #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */ | |
ac683924 | 1131 | #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */ |
3979877e | 1132 | |
ef571cad SP |
1133 | #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2) |
1134 | #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2) | |
ac683924 | 1135 | #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP) |
1da177e4 LT |
1136 | /* |
1137 | ***************************************************************** | |
1138 | * All constants go here | |
1139 | ***************************************************************** | |
1140 | */ | |
1141 | ||
1142 | #define UID_HASH (16) | |
1143 | ||
1144 | /* | |
1145 | * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the | |
1146 | * following to be declared. | |
1147 | */ | |
1148 | ||
1149 | /**************************************************************************** | |
1150 | * Locking notes. All updates to global variables and lists should be | |
1151 | * protected by spinlocks or semaphores. | |
1152 | * | |
1153 | * Spinlocks | |
1154 | * --------- | |
1155 | * GlobalMid_Lock protects: | |
1156 | * list operations on pending_mid_q and oplockQ | |
1157 | * updates to XID counters, multiplex id and SMB sequence numbers | |
6573e9b7 | 1158 | * cifs_file_list_lock protects: |
1da177e4 LT |
1159 | * list operations on tcp and SMB session lists and tCon lists |
1160 | * f_owner.lock protects certain per file struct operations | |
1161 | * mapping->page_lock protects certain per page operations | |
1162 | * | |
1163 | * Semaphores | |
1164 | * ---------- | |
1165 | * sesSem operations on smb session | |
1166 | * tconSem operations on tree connection | |
d38d8c74 | 1167 | * fh_sem file handle reconnection operations |
1da177e4 LT |
1168 | * |
1169 | ****************************************************************************/ | |
1170 | ||
1171 | #ifdef DECLARE_GLOBALS_HERE | |
1172 | #define GLOBAL_EXTERN | |
1173 | #else | |
1174 | #define GLOBAL_EXTERN extern | |
1175 | #endif | |
1176 | ||
e7ddee90 JL |
1177 | /* |
1178 | * the list of TCP_Server_Info structures, ie each of the sockets | |
fb396016 | 1179 | * connecting our client to a distinct server (ip address), is |
e7ddee90 | 1180 | * chained together by cifs_tcp_ses_list. The list of all our SMB |
fb396016 | 1181 | * sessions (and from that the tree connections) can be found |
e7ddee90 JL |
1182 | * by iterating over cifs_tcp_ses_list |
1183 | */ | |
1184 | GLOBAL_EXTERN struct list_head cifs_tcp_ses_list; | |
1185 | ||
f1987b44 JL |
1186 | /* |
1187 | * This lock protects the cifs_tcp_ses_list, the list of smb sessions per | |
1188 | * tcp session, and the list of tcon's per smb session. It also protects | |
1189 | * the reference counters for the server, smb session, and tcon. Finally, | |
1190 | * changes to the tcon->tidStatus should be done while holding this lock. | |
1191 | */ | |
3f9bcca7 | 1192 | GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock; |
ddb4cbfc SF |
1193 | |
1194 | /* | |
1195 | * This lock protects the cifs_file->llist and cifs_file->flist | |
1196 | * list operations, and updates to some flags (cifs_file->invalidHandle) | |
1197 | * It will be moved to either use the tcon->stat_lock or equivalent later. | |
1198 | * If cifs_tcp_ses_lock and the lock below are both needed to be held, then | |
1199 | * the cifs_tcp_ses_lock must be grabbed first and released last. | |
1200 | */ | |
4477288a | 1201 | GLOBAL_EXTERN spinlock_t cifs_file_list_lock; |
1da177e4 | 1202 | |
0eff0e26 | 1203 | #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */ |
99ee4dbd SF |
1204 | /* Outstanding dir notify requests */ |
1205 | GLOBAL_EXTERN struct list_head GlobalDnotifyReqList; | |
1206 | /* DirNotify response queue */ | |
1207 | GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q; | |
0eff0e26 | 1208 | #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */ |
ff5dbd9e | 1209 | |
1da177e4 LT |
1210 | /* |
1211 | * Global transaction id (XID) information | |
1212 | */ | |
1213 | GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */ | |
254e55ed | 1214 | GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */ |
1da177e4 | 1215 | GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */ |
254e55ed SF |
1216 | GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */ |
1217 | /* on midQ entries */ | |
1da177e4 LT |
1218 | /* |
1219 | * Global counters, updated atomically | |
1220 | */ | |
1221 | GLOBAL_EXTERN atomic_t sesInfoAllocCount; | |
1222 | GLOBAL_EXTERN atomic_t tconInfoAllocCount; | |
1223 | GLOBAL_EXTERN atomic_t tcpSesAllocCount; | |
1224 | GLOBAL_EXTERN atomic_t tcpSesReconnectCount; | |
1225 | GLOBAL_EXTERN atomic_t tconInfoReconnectCount; | |
1226 | ||
aaa9bbe0 | 1227 | /* Various Debug counters */ |
4498eed5 SF |
1228 | GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */ |
1229 | #ifdef CONFIG_CIFS_STATS2 | |
1230 | GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */ | |
1231 | GLOBAL_EXTERN atomic_t totSmBufAllocCount; | |
1232 | #endif | |
1233 | GLOBAL_EXTERN atomic_t smBufAllocCount; | |
1da177e4 LT |
1234 | GLOBAL_EXTERN atomic_t midCount; |
1235 | ||
1236 | /* Misc globals */ | |
5e500ed1 | 1237 | GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */ |
1da177e4 | 1238 | GLOBAL_EXTERN unsigned int lookupCacheEnabled; |
04912d6a | 1239 | GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent |
1da177e4 | 1240 | with more secure ntlmssp2 challenge/resp */ |
1da177e4 LT |
1241 | GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */ |
1242 | GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/ | |
1243 | GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */ | |
1244 | GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */ | |
1245 | GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */ | |
1246 | GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/ | |
1247 | ||
21fed0d5 | 1248 | #ifdef CONFIG_CIFS_ACL |
4d79dba0 SP |
1249 | GLOBAL_EXTERN struct rb_root uidtree; |
1250 | GLOBAL_EXTERN struct rb_root gidtree; | |
1251 | GLOBAL_EXTERN spinlock_t siduidlock; | |
1252 | GLOBAL_EXTERN spinlock_t sidgidlock; | |
21fed0d5 SP |
1253 | GLOBAL_EXTERN struct rb_root siduidtree; |
1254 | GLOBAL_EXTERN struct rb_root sidgidtree; | |
1255 | GLOBAL_EXTERN spinlock_t uidsidlock; | |
1256 | GLOBAL_EXTERN spinlock_t gidsidlock; | |
1257 | #endif /* CONFIG_CIFS_ACL */ | |
4d79dba0 | 1258 | |
9b646972 | 1259 | void cifs_oplock_break(struct work_struct *work); |
3b7433b8 | 1260 | |
3bc303c2 | 1261 | extern const struct slow_work_ops cifs_oplock_break_ops; |
da472fc8 | 1262 | extern struct workqueue_struct *cifsiod_wq; |
abd2e44d | 1263 | |
2dc7e1c0 PS |
1264 | extern mempool_t *cifs_mid_poolp; |
1265 | ||
23db65f5 JL |
1266 | /* Operations for different SMB versions */ |
1267 | #define SMB1_VERSION_STRING "1.0" | |
1268 | extern struct smb_version_operations smb1_operations; | |
1269 | extern struct smb_version_values smb1_values; | |
1080ef75 SF |
1270 | #define SMB21_VERSION_STRING "2.1" |
1271 | extern struct smb_version_operations smb21_operations; | |
1272 | extern struct smb_version_values smb21_values; | |
abd2e44d | 1273 | #endif /* _CIFS_GLOB_H */ |