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> |
9b646972 | 25 | #include <linux/workqueue.h> |
1da177e4 | 26 | #include "cifs_fs_sb.h" |
442aa310 | 27 | #include "cifsacl.h" |
d2b91521 SP |
28 | #include <crypto/internal/hash.h> |
29 | #include <linux/scatterlist.h> | |
30 | ||
1da177e4 LT |
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 | ||
ef571cad | 38 | #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1) |
1da177e4 | 39 | #define MAX_SERVER_SIZE 15 |
2e325d59 | 40 | #define MAX_SHARE_SIZE 80 |
8727c8a8 SF |
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 */ | |
1da177e4 LT |
43 | |
44 | #define CIFS_MIN_RCV_POOL 4 | |
45 | ||
6d20e840 SJ |
46 | /* |
47 | * default attribute cache timeout (jiffies) | |
48 | */ | |
49 | #define CIFS_DEF_ACTIMEO (1 * HZ) | |
50 | ||
51 | /* | |
52 | * max attribute cache timeout (jiffies) - 2^30 | |
53 | */ | |
54 | #define CIFS_MAX_ACTIMEO (1 << 30) | |
55 | ||
1da177e4 LT |
56 | /* |
57 | * MAX_REQ is the maximum number of requests that WE will send | |
af901ca1 | 58 | * on one socket concurrently. It also matches the most common |
d38d8c74 | 59 | * value of max multiplex returned by servers. We may |
1da177e4 LT |
60 | * eventually want to use the negotiated value (in case |
61 | * future servers can handle more) when we are more confident that | |
62 | * we will not have problems oveloading the socket with pending | |
63 | * write data. | |
64 | */ | |
d38d8c74 | 65 | #define CIFS_MAX_REQ 50 |
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 | ||
79 | #include "cifspdu.h" | |
80 | ||
1da177e4 LT |
81 | #ifndef XATTR_DOS_ATTRIB |
82 | #define XATTR_DOS_ATTRIB "user.DOSATTRIB" | |
83 | #endif | |
84 | ||
1da177e4 LT |
85 | /* |
86 | * CIFS vfs client Status information (based on what we know.) | |
87 | */ | |
88 | ||
6c0f6218 | 89 | /* associated with each tcp and smb session */ |
1da177e4 LT |
90 | enum statusEnum { |
91 | CifsNew = 0, | |
92 | CifsGood, | |
93 | CifsExiting, | |
fd88ce93 SF |
94 | CifsNeedReconnect, |
95 | CifsNeedNegotiate | |
1da177e4 LT |
96 | }; |
97 | ||
98 | enum securityEnum { | |
daf5b0b6 | 99 | LANMAN = 0, /* Legacy LANMAN auth */ |
3979877e | 100 | NTLM, /* Legacy NTLM012 auth with NTLM hash */ |
1da177e4 | 101 | NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */ |
ac683924 | 102 | RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */ |
f46c7234 | 103 | /* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */ |
c16fefa5 | 104 | Kerberos, /* Kerberos via SPNEGO */ |
1da177e4 LT |
105 | }; |
106 | ||
107 | enum protocolEnum { | |
3ec332ef | 108 | TCP = 0, |
1da177e4 LT |
109 | SCTP |
110 | /* Netbios frames protocol not supported at this time */ | |
111 | }; | |
112 | ||
5f98ca9a | 113 | struct session_key { |
b609f06a | 114 | unsigned int len; |
21e73393 | 115 | char *response; |
b609f06a SF |
116 | }; |
117 | ||
d2b91521 SP |
118 | /* crypto security descriptor definition */ |
119 | struct sdesc { | |
120 | struct shash_desc shash; | |
121 | char ctx[]; | |
122 | }; | |
123 | ||
f7c5445a | 124 | /* crypto hashing related structure/fields, not specific to a sec mech */ |
d2b91521 SP |
125 | struct cifs_secmech { |
126 | struct crypto_shash *hmacmd5; /* hmac-md5 hash function */ | |
127 | struct crypto_shash *md5; /* md5 hash function */ | |
128 | struct sdesc *sdeschmacmd5; /* ctxt to generate ntlmv2 hash, CR1 */ | |
129 | struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */ | |
130 | }; | |
131 | ||
d3686d54 | 132 | /* per smb session structure/fields */ |
d2b91521 SP |
133 | struct ntlmssp_auth { |
134 | __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */ | |
135 | __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */ | |
136 | unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */ | |
d3686d54 | 137 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */ |
d2b91521 SP |
138 | }; |
139 | ||
442aa310 SF |
140 | struct cifs_cred { |
141 | int uid; | |
142 | int gid; | |
143 | int mode; | |
144 | int cecount; | |
145 | struct cifs_sid osid; | |
146 | struct cifs_sid gsid; | |
147 | struct cifs_ntace *ntaces; | |
148 | struct cifs_ace *aces; | |
149 | }; | |
150 | ||
1da177e4 LT |
151 | /* |
152 | ***************************************************************** | |
153 | * Except the CIFS PDUs themselves all the | |
154 | * globally interesting structs should go here | |
155 | ***************************************************************** | |
156 | */ | |
157 | ||
158 | struct TCP_Server_Info { | |
3b795210 SF |
159 | struct list_head tcp_ses_list; |
160 | struct list_head smb_ses_list; | |
e7ddee90 | 161 | int srv_count; /* reference counter */ |
a10faeb2 | 162 | /* 15 character server name + 0x20 16th byte indicating type = srv */ |
8ecaf67a | 163 | char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
c3dccf48 | 164 | enum statusEnum tcpStatus; /* what we think the status is */ |
c359cf3c | 165 | char *hostname; /* hostname portion of UNC string */ |
1da177e4 | 166 | struct socket *ssocket; |
a9f1b85e | 167 | struct sockaddr_storage dstaddr; |
3eb9a889 | 168 | struct sockaddr_storage srcaddr; /* locally bind to this IP */ |
f1d0c998 RL |
169 | #ifdef CONFIG_NET_NS |
170 | struct net *net; | |
171 | #endif | |
d38d8c74 | 172 | wait_queue_head_t response_q; |
1da177e4 LT |
173 | wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/ |
174 | struct list_head pending_mid_q; | |
edf1ae40 SF |
175 | bool noblocksnd; /* use blocking sendmsg */ |
176 | bool noautotune; /* do not autotune send buf sizes */ | |
6a5fa236 | 177 | bool tcp_nodelay; |
1da177e4 | 178 | atomic_t inFlight; /* number of requests on the wire to server */ |
72ca545b | 179 | struct mutex srv_mutex; |
1da177e4 LT |
180 | struct task_struct *tsk; |
181 | char server_GUID[16]; | |
182 | char secMode; | |
c3dccf48 JL |
183 | bool session_estab; /* mark when very first sess is established */ |
184 | u16 dialect; /* dialect index that server chose */ | |
1da177e4 LT |
185 | enum securityEnum secType; |
186 | unsigned int maxReq; /* Clients should submit no more */ | |
187 | /* than maxReq distinct unanswered SMBs to the server when using */ | |
188 | /* multiplexed reads or writes */ | |
189 | unsigned int maxBuf; /* maxBuf specifies the maximum */ | |
190 | /* message size the server can send or receive for non-raw SMBs */ | |
7e90d705 SF |
191 | /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */ |
192 | /* when socket is setup (and during reconnect) before NegProt sent */ | |
eca6acf9 | 193 | unsigned int max_rw; /* maxRw specifies the maximum */ |
1da177e4 LT |
194 | /* message size the server can send or receive for */ |
195 | /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */ | |
eca6acf9 SF |
196 | unsigned int max_vcs; /* maximum number of smb sessions, at least |
197 | those that can be specified uniquely with | |
198 | vcnumbers */ | |
1da177e4 | 199 | int capabilities; /* allow selective disabling of caps by smb sess */ |
de7ed55d | 200 | int timeAdj; /* Adjust for difference in server time zone in sec */ |
1982c344 | 201 | __u16 CurrentMid; /* multiplex id - rotating counter */ |
d3ba50b1 | 202 | char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */ |
a10faeb2 | 203 | /* 16th byte of RFC1001 workstation name is always null */ |
8ecaf67a | 204 | char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL]; |
a0f8b4fb | 205 | __u32 sequence_number; /* for signing, protected by srv_mutex */ |
5f98ca9a | 206 | struct session_key session_key; |
3a5ff61c | 207 | unsigned long lstrp; /* when we got last response from this server */ |
d2b91521 | 208 | struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */ |
26efa0ba | 209 | /* extended security flavors that server supports */ |
c3dccf48 JL |
210 | bool sec_ntlmssp; /* supports NTLMSSP */ |
211 | bool sec_kerberosu2u; /* supports U2U Kerberos */ | |
26efa0ba JL |
212 | bool sec_kerberos; /* supports plain Kerberos */ |
213 | bool sec_mskerberos; /* supports legacy MS Kerberos */ | |
c74093b6 | 214 | struct delayed_work echo; /* echo ping workqueue job */ |
488f1d2d SJ |
215 | #ifdef CONFIG_CIFS_FSCACHE |
216 | struct fscache_cookie *fscache; /* client index cache cookie */ | |
217 | #endif | |
c3dccf48 JL |
218 | #ifdef CONFIG_CIFS_STATS2 |
219 | atomic_t inSend; /* requests trying to send */ | |
220 | atomic_t num_waiters; /* blocked waiting to get in sendrecv */ | |
221 | #endif | |
1da177e4 LT |
222 | }; |
223 | ||
f1d0c998 RL |
224 | /* |
225 | * Macros to allow the TCP_Server_Info->net field and related code to drop out | |
226 | * when CONFIG_NET_NS isn't set. | |
227 | */ | |
228 | ||
229 | #ifdef CONFIG_NET_NS | |
230 | ||
231 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
232 | { | |
233 | return srv->net; | |
234 | } | |
235 | ||
236 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
237 | { | |
238 | srv->net = net; | |
239 | } | |
240 | ||
241 | #else | |
242 | ||
243 | static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv) | |
244 | { | |
245 | return &init_net; | |
246 | } | |
247 | ||
248 | static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net) | |
249 | { | |
250 | } | |
251 | ||
252 | #endif | |
253 | ||
1da177e4 LT |
254 | /* |
255 | * Session structure. One of these for each uid session with a particular host | |
256 | */ | |
257 | struct cifsSesInfo { | |
14fbf50d | 258 | struct list_head smb_ses_list; |
3b795210 | 259 | struct list_head tcon_list; |
d7b619cf | 260 | struct mutex session_mutex; |
1da177e4 | 261 | struct TCP_Server_Info *server; /* pointer to server info */ |
14fbf50d | 262 | int ses_count; /* reference counter */ |
1da177e4 | 263 | enum statusEnum status; |
750d1151 | 264 | unsigned overrideSecFlg; /* if non-zero override global sec flags */ |
1da177e4 LT |
265 | __u16 ipc_tid; /* special tid for connection to IPC share */ |
266 | __u16 flags; | |
eca6acf9 | 267 | __u16 vcnum; |
ad009ac9 SF |
268 | char *serverOS; /* name of operating system underlying server */ |
269 | char *serverNOS; /* name of network operating system of server */ | |
1da177e4 LT |
270 | char *serverDomain; /* security realm of server */ |
271 | int Suid; /* remote smb uid */ | |
3e4b3e1f JL |
272 | uid_t linux_uid; /* overriding owner of files on the mount */ |
273 | uid_t cred_uid; /* owner of credentials */ | |
1da177e4 | 274 | int capabilities; |
d38d8c74 | 275 | char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for |
ad009ac9 | 276 | TCP names - will ipv6 and sctp addresses fit? */ |
34c87901 SF |
277 | char *user_name; /* must not be null except during init of sess |
278 | and after mount option parsing we fill it */ | |
d38d8c74 SF |
279 | char *domainName; |
280 | char *password; | |
5d0d2882 | 281 | struct session_key auth_key; |
d3686d54 | 282 | struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */ |
3b795210 | 283 | bool need_reconnect:1; /* connection reset, uid now invalid */ |
1da177e4 | 284 | }; |
9ac00b7d | 285 | /* no more than one of the following three session flags may be set */ |
1da177e4 | 286 | #define CIFS_SES_NT4 1 |
9ac00b7d SF |
287 | #define CIFS_SES_OS2 2 |
288 | #define CIFS_SES_W9X 4 | |
289 | /* following flag is set for old servers such as OS2 (and Win95?) | |
290 | which do not negotiate NTLM or POSIX dialects, but instead | |
291 | negotiate one of the older LANMAN dialects */ | |
292 | #define CIFS_SES_LANMAN 8 | |
1da177e4 LT |
293 | /* |
294 | * there is one of these for each connection to a resource on a particular | |
d38d8c74 | 295 | * session |
1da177e4 LT |
296 | */ |
297 | struct cifsTconInfo { | |
f1987b44 JL |
298 | struct list_head tcon_list; |
299 | int tc_count; | |
1da177e4 | 300 | struct list_head openFileList; |
1da177e4 | 301 | struct cifsSesInfo *ses; /* pointer to session associated with */ |
254e55ed | 302 | char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */ |
1da177e4 | 303 | char *nativeFileSystem; |
00e485b0 | 304 | char *password; /* for share-level security */ |
1da177e4 LT |
305 | __u16 tid; /* The 2 byte tree id */ |
306 | __u16 Flags; /* optional support bits */ | |
307 | enum statusEnum tidStatus; | |
1da177e4 LT |
308 | #ifdef CONFIG_CIFS_STATS |
309 | atomic_t num_smbs_sent; | |
310 | atomic_t num_writes; | |
311 | atomic_t num_reads; | |
b298f223 | 312 | atomic_t num_flushes; |
1da177e4 LT |
313 | atomic_t num_oplock_brks; |
314 | atomic_t num_opens; | |
a5a2b489 | 315 | atomic_t num_closes; |
1da177e4 LT |
316 | atomic_t num_deletes; |
317 | atomic_t num_mkdirs; | |
65bc98b0 SF |
318 | atomic_t num_posixopens; |
319 | atomic_t num_posixmkdirs; | |
1da177e4 LT |
320 | atomic_t num_rmdirs; |
321 | atomic_t num_renames; | |
322 | atomic_t num_t2renames; | |
dfb7533b SF |
323 | atomic_t num_ffirst; |
324 | atomic_t num_fnext; | |
325 | atomic_t num_fclose; | |
a5a2b489 SF |
326 | atomic_t num_hardlinks; |
327 | atomic_t num_symlinks; | |
328 | atomic_t num_locks; | |
0a4b92c0 SF |
329 | atomic_t num_acl_get; |
330 | atomic_t num_acl_set; | |
a5a2b489 SF |
331 | #ifdef CONFIG_CIFS_STATS2 |
332 | unsigned long long time_writes; | |
333 | unsigned long long time_reads; | |
334 | unsigned long long time_opens; | |
335 | unsigned long long time_deletes; | |
336 | unsigned long long time_closes; | |
337 | unsigned long long time_mkdirs; | |
338 | unsigned long long time_rmdirs; | |
339 | unsigned long long time_renames; | |
340 | unsigned long long time_t2renames; | |
341 | unsigned long long time_ffirst; | |
342 | unsigned long long time_fnext; | |
343 | unsigned long long time_fclose; | |
344 | #endif /* CONFIG_CIFS_STATS2 */ | |
1da177e4 LT |
345 | __u64 bytes_read; |
346 | __u64 bytes_written; | |
347 | spinlock_t stat_lock; | |
a5a2b489 | 348 | #endif /* CONFIG_CIFS_STATS */ |
1da177e4 | 349 | FILE_SYSTEM_DEVICE_INFO fsDevInfo; |
254e55ed | 350 | FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */ |
1da177e4 | 351 | FILE_SYSTEM_UNIX_INFO fsUnixInfo; |
4b18f2a9 SF |
352 | bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */ |
353 | bool retry:1; | |
354 | bool nocase:1; | |
95b1cb90 | 355 | bool seal:1; /* transport encryption for this mounted share */ |
4b18f2a9 | 356 | bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol |
c18c842b | 357 | for this mount even if server would support */ |
84210e91 | 358 | bool local_lease:1; /* check leases (only) on local system not remote */ |
64cc2c63 | 359 | bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */ |
3b795210 | 360 | bool need_reconnect:1; /* connection reset, tid now invalid */ |
d03382ce SJ |
361 | #ifdef CONFIG_CIFS_FSCACHE |
362 | u64 resource_id; /* server resource id */ | |
363 | struct fscache_cookie *fscache; /* cookie for share */ | |
364 | #endif | |
c18c842b | 365 | /* BB add field for back pointer to sb struct(s)? */ |
1da177e4 LT |
366 | }; |
367 | ||
7ffec372 JL |
368 | /* |
369 | * This is a refcounted and timestamped container for a tcon pointer. The | |
370 | * container holds a tcon reference. It is considered safe to free one of | |
371 | * these when the tl_count goes to 0. The tl_time is the time of the last | |
372 | * "get" on the container. | |
373 | */ | |
374 | struct tcon_link { | |
b647c35f JL |
375 | struct rb_node tl_rbnode; |
376 | uid_t tl_uid; | |
9d002df4 JL |
377 | unsigned long tl_flags; |
378 | #define TCON_LINK_MASTER 0 | |
379 | #define TCON_LINK_PENDING 1 | |
380 | #define TCON_LINK_IN_TREE 2 | |
381 | unsigned long tl_time; | |
382 | atomic_t tl_count; | |
7ffec372 JL |
383 | struct cifsTconInfo *tl_tcon; |
384 | }; | |
385 | ||
9d002df4 | 386 | extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb); |
7ffec372 JL |
387 | |
388 | static inline struct cifsTconInfo * | |
389 | tlink_tcon(struct tcon_link *tlink) | |
390 | { | |
9d002df4 | 391 | return tlink->tl_tcon; |
7ffec372 JL |
392 | } |
393 | ||
9d002df4 | 394 | extern void cifs_put_tlink(struct tcon_link *tlink); |
7ffec372 | 395 | |
13cfb733 JL |
396 | static inline struct tcon_link * |
397 | cifs_get_tlink(struct tcon_link *tlink) | |
398 | { | |
9d002df4 JL |
399 | if (tlink && !IS_ERR(tlink)) |
400 | atomic_inc(&tlink->tl_count); | |
13cfb733 JL |
401 | return tlink; |
402 | } | |
403 | ||
7ffec372 | 404 | /* This function is always expected to succeed */ |
9d002df4 | 405 | extern struct cifsTconInfo *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb); |
7ffec372 | 406 | |
1da177e4 | 407 | /* |
7ee1af76 JA |
408 | * This info hangs off the cifsFileInfo structure, pointed to by llist. |
409 | * This is used to track byte stream locks on the file | |
1da177e4 LT |
410 | */ |
411 | struct cifsLockInfo { | |
7ee1af76 JA |
412 | struct list_head llist; /* pointer to next cifsLockInfo */ |
413 | __u64 offset; | |
414 | __u64 length; | |
415 | __u8 type; | |
1da177e4 LT |
416 | }; |
417 | ||
418 | /* | |
419 | * One of these for each open instance of a file | |
420 | */ | |
421 | struct cifs_search_info { | |
422 | loff_t index_of_last_entry; | |
423 | __u16 entries_in_buffer; | |
424 | __u16 info_level; | |
425 | __u32 resume_key; | |
d38d8c74 SF |
426 | char *ntwrk_buf_start; |
427 | char *srch_entries_start; | |
0752f152 | 428 | char *last_entry; |
d38d8c74 | 429 | char *presume_name; |
1da177e4 | 430 | unsigned int resume_name_len; |
4b18f2a9 SF |
431 | bool endOfSearch:1; |
432 | bool emptyDir:1; | |
433 | bool unicode:1; | |
434 | bool smallBuf:1; /* so we know which buf_release function to call */ | |
1da177e4 LT |
435 | }; |
436 | ||
437 | struct cifsFileInfo { | |
438 | struct list_head tlist; /* pointer to next fid owned by tcon */ | |
439 | struct list_head flist; /* next fid (file instance) for this inode */ | |
440 | unsigned int uid; /* allows finding which FileInfo structure */ | |
441 | __u32 pid; /* process id who opened file */ | |
442 | __u16 netfid; /* file id from remote */ | |
443 | /* BB add lock scope info here if needed */ ; | |
444 | /* lock scope id (0 if none) */ | |
a5e18bc3 | 445 | struct dentry *dentry; |
15886177 | 446 | unsigned int f_flags; |
13cfb733 | 447 | struct tcon_link *tlink; |
796e5661 | 448 | struct mutex lock_mutex; |
7ee1af76 | 449 | struct list_head llist; /* list of byte range locks we have. */ |
4b18f2a9 | 450 | bool invalidHandle:1; /* file closed via session abend */ |
3bc303c2 | 451 | bool oplock_break_cancelled:1; |
6c0f6218 | 452 | int count; /* refcount protected by cifs_file_list_lock */ |
a6ce4932 | 453 | struct mutex fh_mutex; /* prevents reopen race after dead ses*/ |
1da177e4 | 454 | struct cifs_search_info srch_inf; |
9b646972 | 455 | struct work_struct oplock_break; /* work for oplock breaks */ |
1da177e4 LT |
456 | }; |
457 | ||
5f6dbc9e JL |
458 | /* |
459 | * Take a reference on the file private data. Must be called with | |
460 | * cifs_file_list_lock held. | |
461 | */ | |
6ab409b5 DK |
462 | static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file) |
463 | { | |
5f6dbc9e | 464 | ++cifs_file->count; |
6ab409b5 DK |
465 | } |
466 | ||
b33879aa | 467 | void cifsFileInfo_put(struct cifsFileInfo *cifs_file); |
6ab409b5 | 468 | |
1da177e4 LT |
469 | /* |
470 | * One of these for each file inode | |
471 | */ | |
472 | ||
473 | struct cifsInodeInfo { | |
474 | struct list_head lockList; | |
d38d8c74 | 475 | /* BB add in lists for dirty pages i.e. write caching info for oplock */ |
1da177e4 | 476 | struct list_head openFileList; |
1da177e4 | 477 | __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */ |
aae62fdb JL |
478 | bool clientCanCacheRead; /* read oplock */ |
479 | bool clientCanCacheAll; /* read and writebehind oplock */ | |
480 | bool delete_pending; /* DELETE_ON_CLOSE is set */ | |
481 | bool invalid_mapping; /* pagecache is invalid */ | |
482 | unsigned long time; /* jiffies of last update of inode */ | |
fbec9ab9 | 483 | u64 server_eof; /* current file size on server */ |
cc0bad75 | 484 | u64 uniqueid; /* server inode number */ |
20054bd6 | 485 | u64 createtime; /* creation time on server */ |
9451a9a5 SJ |
486 | #ifdef CONFIG_CIFS_FSCACHE |
487 | struct fscache_cookie *fscache; | |
488 | #endif | |
1da177e4 LT |
489 | struct inode vfs_inode; |
490 | }; | |
491 | ||
492 | static inline struct cifsInodeInfo * | |
493 | CIFS_I(struct inode *inode) | |
494 | { | |
495 | return container_of(inode, struct cifsInodeInfo, vfs_inode); | |
496 | } | |
497 | ||
498 | static inline struct cifs_sb_info * | |
499 | CIFS_SB(struct super_block *sb) | |
500 | { | |
501 | return sb->s_fs_info; | |
502 | } | |
503 | ||
ab2f218f | 504 | static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb) |
ac67055e JA |
505 | { |
506 | if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS) | |
507 | return '/'; | |
508 | else | |
509 | return '\\'; | |
510 | } | |
1da177e4 | 511 | |
a4544347 SF |
512 | #ifdef CONFIG_CIFS_STATS |
513 | #define cifs_stats_inc atomic_inc | |
514 | ||
515 | static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon, | |
516 | unsigned int bytes) | |
517 | { | |
518 | if (bytes) { | |
519 | spin_lock(&tcon->stat_lock); | |
520 | tcon->bytes_written += bytes; | |
521 | spin_unlock(&tcon->stat_lock); | |
522 | } | |
523 | } | |
524 | ||
525 | static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon, | |
526 | unsigned int bytes) | |
527 | { | |
528 | spin_lock(&tcon->stat_lock); | |
529 | tcon->bytes_read += bytes; | |
530 | spin_unlock(&tcon->stat_lock); | |
531 | } | |
532 | #else | |
533 | ||
d38d8c74 SF |
534 | #define cifs_stats_inc(field) do {} while (0) |
535 | #define cifs_stats_bytes_written(tcon, bytes) do {} while (0) | |
536 | #define cifs_stats_bytes_read(tcon, bytes) do {} while (0) | |
a4544347 SF |
537 | |
538 | #endif | |
539 | ||
2b84a36c JL |
540 | struct mid_q_entry; |
541 | ||
542 | /* | |
543 | * This is the prototype for the mid callback function. When creating one, | |
544 | * take special care to avoid deadlocks. Things to bear in mind: | |
545 | * | |
546 | * - it will be called by cifsd | |
547 | * - the GlobalMid_Lock will be held | |
548 | * - the mid will be removed from the pending_mid_q list | |
549 | */ | |
550 | typedef void (mid_callback_t)(struct mid_q_entry *mid); | |
551 | ||
1da177e4 LT |
552 | /* one of these for every pending CIFS request to the server */ |
553 | struct mid_q_entry { | |
554 | struct list_head qhead; /* mids waiting on reply from this server */ | |
555 | __u16 mid; /* multiplex id */ | |
556 | __u16 pid; /* process id */ | |
557 | __u32 sequence_number; /* for CIFS signing */ | |
1047abc1 SF |
558 | unsigned long when_alloc; /* when mid was created */ |
559 | #ifdef CONFIG_CIFS_STATS2 | |
560 | unsigned long when_sent; /* time when smb send finished */ | |
561 | unsigned long when_received; /* when demux complete (taken off wire) */ | |
562 | #endif | |
2b84a36c JL |
563 | mid_callback_t *callback; /* call completion callback */ |
564 | void *callback_data; /* general purpose pointer for callback */ | |
1da177e4 LT |
565 | struct smb_hdr *resp_buf; /* response buffer */ |
566 | int midState; /* wish this were enum but can not pass to wait_event */ | |
c81156dd | 567 | __u8 command; /* smb command code */ |
4b18f2a9 SF |
568 | bool largeBuf:1; /* if valid response, is pointer to large buf */ |
569 | bool multiRsp:1; /* multiple trans2 responses for one request */ | |
570 | bool multiEnd:1; /* both received */ | |
1da177e4 LT |
571 | }; |
572 | ||
573 | struct oplock_q_entry { | |
574 | struct list_head qhead; | |
d38d8c74 SF |
575 | struct inode *pinode; |
576 | struct cifsTconInfo *tcon; | |
1da177e4 LT |
577 | __u16 netfid; |
578 | }; | |
579 | ||
ff5dbd9e SF |
580 | /* for pending dnotify requests */ |
581 | struct dir_notify_req { | |
13cd4b7f SF |
582 | struct list_head lhead; |
583 | __le16 Pid; | |
584 | __le16 PidHigh; | |
585 | __u16 Mid; | |
586 | __u16 Tid; | |
587 | __u16 Uid; | |
588 | __u16 netfid; | |
589 | __u32 filter; /* CompletionFilter (for multishot) */ | |
590 | int multishot; | |
591 | struct file *pfile; | |
ff5dbd9e SF |
592 | }; |
593 | ||
366781c1 SF |
594 | struct dfs_info3_param { |
595 | int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/ | |
8aad018b | 596 | int path_consumed; |
366781c1 SF |
597 | int server_type; |
598 | int ref_flag; | |
599 | char *path_name; | |
600 | char *node_name; | |
601 | }; | |
602 | ||
cc0bad75 JL |
603 | /* |
604 | * common struct for holding inode info when searching for or updating an | |
605 | * inode with new info | |
606 | */ | |
607 | ||
608 | #define CIFS_FATTR_DFS_REFERRAL 0x1 | |
0b8f18e3 JL |
609 | #define CIFS_FATTR_DELETE_PENDING 0x2 |
610 | #define CIFS_FATTR_NEED_REVAL 0x4 | |
3d694380 | 611 | #define CIFS_FATTR_INO_COLLISION 0x8 |
cc0bad75 JL |
612 | |
613 | struct cifs_fattr { | |
614 | u32 cf_flags; | |
615 | u32 cf_cifsattrs; | |
616 | u64 cf_uniqueid; | |
617 | u64 cf_eof; | |
618 | u64 cf_bytes; | |
20054bd6 | 619 | u64 cf_createtime; |
cc0bad75 JL |
620 | uid_t cf_uid; |
621 | gid_t cf_gid; | |
622 | umode_t cf_mode; | |
623 | dev_t cf_rdev; | |
624 | unsigned int cf_nlink; | |
625 | unsigned int cf_dtype; | |
626 | struct timespec cf_atime; | |
627 | struct timespec cf_mtime; | |
628 | struct timespec cf_ctime; | |
629 | }; | |
630 | ||
366781c1 SF |
631 | static inline void free_dfs_info_param(struct dfs_info3_param *param) |
632 | { | |
633 | if (param) { | |
634 | kfree(param->path_name); | |
635 | kfree(param->node_name); | |
636 | kfree(param); | |
637 | } | |
638 | } | |
639 | ||
640 | static inline void free_dfs_info_array(struct dfs_info3_param *param, | |
641 | int number_of_items) | |
642 | { | |
643 | int i; | |
644 | if ((number_of_items == 0) || (param == NULL)) | |
645 | return; | |
646 | for (i = 0; i < number_of_items; i++) { | |
647 | kfree(param[i].path_name); | |
648 | kfree(param[i].node_name); | |
649 | } | |
650 | kfree(param); | |
651 | } | |
652 | ||
1da177e4 LT |
653 | #define MID_FREE 0 |
654 | #define MID_REQUEST_ALLOCATED 1 | |
655 | #define MID_REQUEST_SUBMITTED 2 | |
656 | #define MID_RESPONSE_RECEIVED 4 | |
657 | #define MID_RETRY_NEEDED 8 /* session closed while this request out */ | |
71823baf | 658 | #define MID_RESPONSE_MALFORMED 0x10 |
ec637e3f SF |
659 | |
660 | /* Types of response buffer returned from SendReceive2 */ | |
661 | #define CIFS_NO_BUFFER 0 /* Response buffer not returned */ | |
662 | #define CIFS_SMALL_BUFFER 1 | |
663 | #define CIFS_LARGE_BUFFER 2 | |
664 | #define CIFS_IOVEC 4 /* array of response buffers */ | |
1da177e4 | 665 | |
133672ef | 666 | /* Type of Request to SendReceive2 */ |
7749981e JL |
667 | #define CIFS_BLOCKING_OP 1 /* operation can block */ |
668 | #define CIFS_ASYNC_OP 2 /* do not wait for response */ | |
669 | #define CIFS_TIMEOUT_MASK 0x003 /* only one of above set in req */ | |
133672ef SF |
670 | #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */ |
671 | #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */ | |
672 | #define CIFS_NO_RESP 0x040 /* no response buffer required */ | |
673 | ||
3979877e SF |
674 | /* Security Flags: indicate type of session setup needed */ |
675 | #define CIFSSEC_MAY_SIGN 0x00001 | |
676 | #define CIFSSEC_MAY_NTLM 0x00002 | |
677 | #define CIFSSEC_MAY_NTLMV2 0x00004 | |
678 | #define CIFSSEC_MAY_KRB5 0x00008 | |
679 | #ifdef CONFIG_CIFS_WEAK_PW_HASH | |
680 | #define CIFSSEC_MAY_LANMAN 0x00010 | |
681 | #define CIFSSEC_MAY_PLNTXT 0x00020 | |
516897a2 SF |
682 | #else |
683 | #define CIFSSEC_MAY_LANMAN 0 | |
684 | #define CIFSSEC_MAY_PLNTXT 0 | |
3979877e SF |
685 | #endif /* weak passwords */ |
686 | #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */ | |
ac683924 | 687 | #define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */ |
3979877e SF |
688 | |
689 | #define CIFSSEC_MUST_SIGN 0x01001 | |
690 | /* note that only one of the following can be set so the | |
691 | result of setting MUST flags more than once will be to | |
692 | require use of the stronger protocol */ | |
693 | #define CIFSSEC_MUST_NTLM 0x02002 | |
694 | #define CIFSSEC_MUST_NTLMV2 0x04004 | |
695 | #define CIFSSEC_MUST_KRB5 0x08008 | |
696 | #ifdef CONFIG_CIFS_WEAK_PW_HASH | |
697 | #define CIFSSEC_MUST_LANMAN 0x10010 | |
698 | #define CIFSSEC_MUST_PLNTXT 0x20020 | |
0d3a01fa | 699 | #ifdef CONFIG_CIFS_UPCALL |
20d1752f | 700 | #define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */ |
0d3a01fa | 701 | #else |
20d1752f | 702 | #define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */ |
016ec75f | 703 | #endif /* UPCALL */ |
0d3a01fa JL |
704 | #else /* do not allow weak pw hash */ |
705 | #ifdef CONFIG_CIFS_UPCALL | |
ac683924 | 706 | #define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */ |
d38d8c74 | 707 | #else |
ac683924 | 708 | #define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */ |
016ec75f | 709 | #endif /* UPCALL */ |
3979877e SF |
710 | #endif /* WEAK_PW_HASH */ |
711 | #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */ | |
ac683924 | 712 | #define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */ |
3979877e | 713 | |
ef571cad SP |
714 | #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2) |
715 | #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2) | |
ac683924 | 716 | #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP) |
1da177e4 LT |
717 | /* |
718 | ***************************************************************** | |
719 | * All constants go here | |
720 | ***************************************************************** | |
721 | */ | |
722 | ||
723 | #define UID_HASH (16) | |
724 | ||
725 | /* | |
726 | * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the | |
727 | * following to be declared. | |
728 | */ | |
729 | ||
730 | /**************************************************************************** | |
731 | * Locking notes. All updates to global variables and lists should be | |
732 | * protected by spinlocks or semaphores. | |
733 | * | |
734 | * Spinlocks | |
735 | * --------- | |
736 | * GlobalMid_Lock protects: | |
737 | * list operations on pending_mid_q and oplockQ | |
738 | * updates to XID counters, multiplex id and SMB sequence numbers | |
6573e9b7 | 739 | * cifs_file_list_lock protects: |
1da177e4 LT |
740 | * list operations on tcp and SMB session lists and tCon lists |
741 | * f_owner.lock protects certain per file struct operations | |
742 | * mapping->page_lock protects certain per page operations | |
743 | * | |
744 | * Semaphores | |
745 | * ---------- | |
746 | * sesSem operations on smb session | |
747 | * tconSem operations on tree connection | |
d38d8c74 | 748 | * fh_sem file handle reconnection operations |
1da177e4 LT |
749 | * |
750 | ****************************************************************************/ | |
751 | ||
752 | #ifdef DECLARE_GLOBALS_HERE | |
753 | #define GLOBAL_EXTERN | |
754 | #else | |
755 | #define GLOBAL_EXTERN extern | |
756 | #endif | |
757 | ||
e7ddee90 JL |
758 | /* |
759 | * the list of TCP_Server_Info structures, ie each of the sockets | |
fb396016 | 760 | * connecting our client to a distinct server (ip address), is |
e7ddee90 | 761 | * chained together by cifs_tcp_ses_list. The list of all our SMB |
fb396016 | 762 | * sessions (and from that the tree connections) can be found |
e7ddee90 JL |
763 | * by iterating over cifs_tcp_ses_list |
764 | */ | |
765 | GLOBAL_EXTERN struct list_head cifs_tcp_ses_list; | |
766 | ||
f1987b44 JL |
767 | /* |
768 | * This lock protects the cifs_tcp_ses_list, the list of smb sessions per | |
769 | * tcp session, and the list of tcon's per smb session. It also protects | |
770 | * the reference counters for the server, smb session, and tcon. Finally, | |
771 | * changes to the tcon->tidStatus should be done while holding this lock. | |
772 | */ | |
3f9bcca7 | 773 | GLOBAL_EXTERN spinlock_t cifs_tcp_ses_lock; |
ddb4cbfc SF |
774 | |
775 | /* | |
776 | * This lock protects the cifs_file->llist and cifs_file->flist | |
777 | * list operations, and updates to some flags (cifs_file->invalidHandle) | |
778 | * It will be moved to either use the tcon->stat_lock or equivalent later. | |
779 | * If cifs_tcp_ses_lock and the lock below are both needed to be held, then | |
780 | * the cifs_tcp_ses_lock must be grabbed first and released last. | |
781 | */ | |
4477288a | 782 | GLOBAL_EXTERN spinlock_t cifs_file_list_lock; |
1da177e4 | 783 | |
0eff0e26 | 784 | #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */ |
99ee4dbd SF |
785 | /* Outstanding dir notify requests */ |
786 | GLOBAL_EXTERN struct list_head GlobalDnotifyReqList; | |
787 | /* DirNotify response queue */ | |
788 | GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q; | |
0eff0e26 | 789 | #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */ |
ff5dbd9e | 790 | |
1da177e4 LT |
791 | /* |
792 | * Global transaction id (XID) information | |
793 | */ | |
794 | GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */ | |
254e55ed | 795 | GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */ |
1da177e4 | 796 | GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */ |
254e55ed SF |
797 | GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */ |
798 | /* on midQ entries */ | |
1da177e4 LT |
799 | /* |
800 | * Global counters, updated atomically | |
801 | */ | |
802 | GLOBAL_EXTERN atomic_t sesInfoAllocCount; | |
803 | GLOBAL_EXTERN atomic_t tconInfoAllocCount; | |
804 | GLOBAL_EXTERN atomic_t tcpSesAllocCount; | |
805 | GLOBAL_EXTERN atomic_t tcpSesReconnectCount; | |
806 | GLOBAL_EXTERN atomic_t tconInfoReconnectCount; | |
807 | ||
aaa9bbe0 | 808 | /* Various Debug counters */ |
4498eed5 SF |
809 | GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */ |
810 | #ifdef CONFIG_CIFS_STATS2 | |
811 | GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */ | |
812 | GLOBAL_EXTERN atomic_t totSmBufAllocCount; | |
813 | #endif | |
814 | GLOBAL_EXTERN atomic_t smBufAllocCount; | |
1da177e4 LT |
815 | GLOBAL_EXTERN atomic_t midCount; |
816 | ||
817 | /* Misc globals */ | |
254e55ed | 818 | GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions |
1da177e4 | 819 | to be established on existing mount if we |
d38d8c74 | 820 | have the uid/password or Kerberos credential |
1da177e4 LT |
821 | or equivalent for current user */ |
822 | GLOBAL_EXTERN unsigned int oplockEnabled; | |
1da177e4 | 823 | GLOBAL_EXTERN unsigned int lookupCacheEnabled; |
04912d6a | 824 | GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent |
1da177e4 | 825 | with more secure ntlmssp2 challenge/resp */ |
1da177e4 LT |
826 | GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */ |
827 | GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/ | |
828 | GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */ | |
829 | GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */ | |
830 | GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */ | |
831 | GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/ | |
832 | ||
fda35943 SF |
833 | /* reconnect after this many failed echo attempts */ |
834 | GLOBAL_EXTERN unsigned short echo_retries; | |
835 | ||
4d79dba0 SP |
836 | GLOBAL_EXTERN struct rb_root uidtree; |
837 | GLOBAL_EXTERN struct rb_root gidtree; | |
838 | GLOBAL_EXTERN spinlock_t siduidlock; | |
839 | GLOBAL_EXTERN spinlock_t sidgidlock; | |
840 | ||
9b646972 TH |
841 | void cifs_oplock_break(struct work_struct *work); |
842 | void cifs_oplock_break_get(struct cifsFileInfo *cfile); | |
843 | void cifs_oplock_break_put(struct cifsFileInfo *cfile); | |
3b7433b8 | 844 | |
3bc303c2 | 845 | extern const struct slow_work_ops cifs_oplock_break_ops; |
abd2e44d SJ |
846 | |
847 | #endif /* _CIFS_GLOB_H */ |