Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * fs/cifs/cifsglob.h | |
3 | * | |
4 | * Copyright (C) International Business Machines Corp., 2002,2003 | |
5 | * Author(s): Steve French (sfrench@us.ibm.com) | |
6 | * | |
7 | * This library is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU Lesser General Public License as published | |
9 | * by the Free Software Foundation; either version 2.1 of the License, or | |
10 | * (at your option) any later version. | |
11 | * | |
12 | * This library is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See | |
15 | * the GNU Lesser General Public License for more details. | |
16 | * | |
17 | */ | |
18 | #include <linux/in.h> | |
19 | #include <linux/in6.h> | |
20 | #include "cifs_fs_sb.h" | |
21 | /* | |
22 | * The sizes of various internal tables and strings | |
23 | */ | |
24 | #define MAX_UID_INFO 16 | |
25 | #define MAX_SES_INFO 2 | |
26 | #define MAX_TCON_INFO 4 | |
27 | ||
28 | #define MAX_TREE_SIZE 2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1 | |
29 | #define MAX_SERVER_SIZE 15 | |
30 | #define MAX_SHARE_SIZE 64 /* used to be 20 - this should still be enough */ | |
31 | #define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null | |
32 | termination then *2 for unicode versions */ | |
33 | #define MAX_PASSWORD_SIZE 16 | |
34 | ||
35 | #define CIFS_MIN_RCV_POOL 4 | |
36 | ||
37 | /* | |
38 | * MAX_REQ is the maximum number of requests that WE will send | |
39 | * on one socket concurently. It also matches the most common | |
40 | * value of max multiplex returned by servers. We may | |
41 | * eventually want to use the negotiated value (in case | |
42 | * future servers can handle more) when we are more confident that | |
43 | * we will not have problems oveloading the socket with pending | |
44 | * write data. | |
45 | */ | |
46 | #define CIFS_MAX_REQ 50 | |
47 | ||
48 | #define SERVER_NAME_LENGTH 15 | |
49 | #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1) | |
50 | ||
51 | /* used to define string lengths for reversing unicode strings */ | |
52 | /* (256+1)*2 = 514 */ | |
53 | /* (max path length + 1 for null) * 2 for unicode */ | |
54 | #define MAX_NAME 514 | |
55 | ||
56 | #include "cifspdu.h" | |
57 | ||
58 | #ifndef FALSE | |
59 | #define FALSE 0 | |
60 | #endif | |
61 | ||
62 | #ifndef TRUE | |
63 | #define TRUE 1 | |
64 | #endif | |
65 | ||
66 | #ifndef XATTR_DOS_ATTRIB | |
67 | #define XATTR_DOS_ATTRIB "user.DOSATTRIB" | |
68 | #endif | |
69 | ||
70 | /* | |
71 | * This information is kept on every Server we know about. | |
72 | * | |
73 | * Some things to note: | |
74 | * | |
75 | */ | |
76 | #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1) | |
77 | ||
78 | /* | |
79 | * CIFS vfs client Status information (based on what we know.) | |
80 | */ | |
81 | ||
82 | /* associated with each tcp and smb session */ | |
83 | enum statusEnum { | |
84 | CifsNew = 0, | |
85 | CifsGood, | |
86 | CifsExiting, | |
87 | CifsNeedReconnect | |
88 | }; | |
89 | ||
90 | enum securityEnum { | |
91 | NTLM = 0, /* Legacy NTLM012 auth with NTLM hash */ | |
92 | NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */ | |
93 | RawNTLMSSP, /* NTLMSSP without SPNEGO */ | |
94 | NTLMSSP, /* NTLMSSP via SPNEGO */ | |
95 | Kerberos /* Kerberos via SPNEGO */ | |
96 | }; | |
97 | ||
98 | enum protocolEnum { | |
99 | IPV4 = 0, | |
100 | IPV6, | |
101 | SCTP | |
102 | /* Netbios frames protocol not supported at this time */ | |
103 | }; | |
104 | ||
105 | /* | |
106 | ***************************************************************** | |
107 | * Except the CIFS PDUs themselves all the | |
108 | * globally interesting structs should go here | |
109 | ***************************************************************** | |
110 | */ | |
111 | ||
112 | struct TCP_Server_Info { | |
113 | char server_Name[SERVER_NAME_LEN_WITH_NULL]; /* 15 chars + X'20'in 16th */ | |
114 | char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2]; /* Unicode version of server_Name */ | |
115 | struct socket *ssocket; | |
116 | union { | |
117 | struct sockaddr_in sockAddr; | |
118 | struct sockaddr_in6 sockAddr6; | |
119 | } addr; | |
120 | wait_queue_head_t response_q; | |
121 | wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/ | |
122 | struct list_head pending_mid_q; | |
123 | void *Server_NlsInfo; /* BB - placeholder for future NLS info */ | |
124 | unsigned short server_codepage; /* codepage for the server */ | |
125 | unsigned long ip_address; /* IP addr for the server if known */ | |
126 | enum protocolEnum protocolType; | |
127 | char versionMajor; | |
128 | char versionMinor; | |
129 | unsigned svlocal:1; /* local server or remote */ | |
130 | atomic_t socketUseCount; /* number of open cifs sessions on socket */ | |
131 | atomic_t inFlight; /* number of requests on the wire to server */ | |
132 | enum statusEnum tcpStatus; /* what we think the status is */ | |
133 | struct semaphore tcpSem; | |
134 | struct task_struct *tsk; | |
135 | char server_GUID[16]; | |
136 | char secMode; | |
137 | enum securityEnum secType; | |
138 | unsigned int maxReq; /* Clients should submit no more */ | |
139 | /* than maxReq distinct unanswered SMBs to the server when using */ | |
140 | /* multiplexed reads or writes */ | |
141 | unsigned int maxBuf; /* maxBuf specifies the maximum */ | |
142 | /* message size the server can send or receive for non-raw SMBs */ | |
143 | unsigned int maxRw; /* maxRw specifies the maximum */ | |
144 | /* message size the server can send or receive for */ | |
145 | /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */ | |
146 | char sessid[4]; /* unique token id for this session */ | |
147 | /* (returned on Negotiate */ | |
148 | int capabilities; /* allow selective disabling of caps by smb sess */ | |
149 | __u16 timeZone; | |
150 | char cryptKey[CIFS_CRYPTO_KEY_SIZE]; | |
151 | char workstation_RFC1001_name[16]; /* 16th byte is always zero */ | |
ad009ac9 SF |
152 | __u32 sequence_number; /* needed for CIFS PDU signature */ |
153 | char mac_signing_key[CIFS_SESSION_KEY_SIZE + 16]; | |
1da177e4 LT |
154 | }; |
155 | ||
156 | /* | |
157 | * The following is our shortcut to user information. We surface the uid, | |
158 | * and name. We always get the password on the fly in case it | |
159 | * has changed. We also hang a list of sessions owned by this user off here. | |
160 | */ | |
161 | struct cifsUidInfo { | |
162 | struct list_head userList; | |
163 | struct list_head sessionList; /* SMB sessions for this user */ | |
164 | uid_t linux_uid; | |
165 | char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */ | |
166 | /* BB may need ptr or callback for PAM or WinBind info */ | |
167 | }; | |
168 | ||
169 | /* | |
170 | * Session structure. One of these for each uid session with a particular host | |
171 | */ | |
172 | struct cifsSesInfo { | |
173 | struct list_head cifsSessionList; | |
174 | struct semaphore sesSem; | |
175 | struct cifsUidInfo *uidInfo; /* pointer to user info */ | |
176 | struct TCP_Server_Info *server; /* pointer to server info */ | |
177 | atomic_t inUse; /* # of mounts (tree connections) on this ses */ | |
178 | enum statusEnum status; | |
1da177e4 LT |
179 | __u16 ipc_tid; /* special tid for connection to IPC share */ |
180 | __u16 flags; | |
ad009ac9 SF |
181 | char *serverOS; /* name of operating system underlying server */ |
182 | char *serverNOS; /* name of network operating system of server */ | |
1da177e4 LT |
183 | char *serverDomain; /* security realm of server */ |
184 | int Suid; /* remote smb uid */ | |
185 | uid_t linux_uid; /* local Linux uid */ | |
186 | int capabilities; | |
ad009ac9 SF |
187 | char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for |
188 | TCP names - will ipv6 and sctp addresses fit? */ | |
1da177e4 LT |
189 | char userName[MAX_USERNAME_SIZE + 1]; |
190 | char domainName[MAX_USERNAME_SIZE + 1]; | |
191 | char * password; | |
192 | }; | |
193 | /* session flags */ | |
194 | #define CIFS_SES_NT4 1 | |
195 | ||
196 | /* | |
197 | * there is one of these for each connection to a resource on a particular | |
198 | * session | |
199 | */ | |
200 | struct cifsTconInfo { | |
201 | struct list_head cifsConnectionList; | |
202 | struct list_head openFileList; | |
203 | struct semaphore tconSem; | |
204 | struct cifsSesInfo *ses; /* pointer to session associated with */ | |
205 | char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource (in ASCII not UTF) */ | |
206 | char *nativeFileSystem; | |
207 | __u16 tid; /* The 2 byte tree id */ | |
208 | __u16 Flags; /* optional support bits */ | |
209 | enum statusEnum tidStatus; | |
210 | atomic_t useCount; /* how many mounts (explicit or implicit) to this share */ | |
211 | #ifdef CONFIG_CIFS_STATS | |
212 | atomic_t num_smbs_sent; | |
213 | atomic_t num_writes; | |
214 | atomic_t num_reads; | |
215 | atomic_t num_oplock_brks; | |
216 | atomic_t num_opens; | |
217 | atomic_t num_deletes; | |
218 | atomic_t num_mkdirs; | |
219 | atomic_t num_rmdirs; | |
220 | atomic_t num_renames; | |
221 | atomic_t num_t2renames; | |
222 | __u64 bytes_read; | |
223 | __u64 bytes_written; | |
224 | spinlock_t stat_lock; | |
225 | #endif | |
226 | FILE_SYSTEM_DEVICE_INFO fsDevInfo; | |
227 | FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if file system name truncated */ | |
228 | FILE_SYSTEM_UNIX_INFO fsUnixInfo; | |
229 | unsigned retry:1; | |
230 | /* BB add field for back pointer to sb struct? */ | |
231 | }; | |
232 | ||
233 | /* | |
234 | * This info hangs off the cifsFileInfo structure. This is used to track | |
235 | * byte stream locks on the file | |
236 | */ | |
237 | struct cifsLockInfo { | |
238 | struct cifsLockInfo *next; | |
239 | int start; | |
240 | int length; | |
241 | int type; | |
242 | }; | |
243 | ||
244 | /* | |
245 | * One of these for each open instance of a file | |
246 | */ | |
247 | struct cifs_search_info { | |
248 | loff_t index_of_last_entry; | |
249 | __u16 entries_in_buffer; | |
250 | __u16 info_level; | |
251 | __u32 resume_key; | |
252 | char * ntwrk_buf_start; | |
253 | char * srch_entries_start; | |
254 | char * presume_name; | |
255 | unsigned int resume_name_len; | |
256 | unsigned endOfSearch:1; | |
257 | unsigned emptyDir:1; | |
258 | unsigned unicode:1; | |
259 | }; | |
260 | ||
261 | struct cifsFileInfo { | |
262 | struct list_head tlist; /* pointer to next fid owned by tcon */ | |
263 | struct list_head flist; /* next fid (file instance) for this inode */ | |
264 | unsigned int uid; /* allows finding which FileInfo structure */ | |
265 | __u32 pid; /* process id who opened file */ | |
266 | __u16 netfid; /* file id from remote */ | |
267 | /* BB add lock scope info here if needed */ ; | |
268 | /* lock scope id (0 if none) */ | |
269 | struct file * pfile; /* needed for writepage */ | |
270 | struct inode * pInode; /* needed for oplock break */ | |
271 | unsigned closePend:1; /* file is marked to close */ | |
272 | unsigned invalidHandle:1; /* file closed via session abend */ | |
273 | struct semaphore fh_sem; /* prevents reopen race after dead ses*/ | |
274 | char * search_resume_name; /* BB removeme BB */ | |
275 | unsigned int resume_name_length; /* BB removeme - field renamed and moved BB */ | |
276 | struct cifs_search_info srch_inf; | |
277 | }; | |
278 | ||
279 | /* | |
280 | * One of these for each file inode | |
281 | */ | |
282 | ||
283 | struct cifsInodeInfo { | |
284 | struct list_head lockList; | |
285 | /* BB add in lists for dirty pages - i.e. write caching info for oplock */ | |
286 | struct list_head openFileList; | |
287 | int write_behind_rc; | |
288 | __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */ | |
289 | atomic_t inUse; /* num concurrent users (local openers cifs) of file*/ | |
290 | unsigned long time; /* jiffies of last update/check of inode */ | |
291 | unsigned clientCanCacheRead:1; /* read oplock */ | |
292 | unsigned clientCanCacheAll:1; /* read and writebehind oplock */ | |
293 | unsigned oplockPending:1; | |
294 | struct inode vfs_inode; | |
295 | }; | |
296 | ||
297 | static inline struct cifsInodeInfo * | |
298 | CIFS_I(struct inode *inode) | |
299 | { | |
300 | return container_of(inode, struct cifsInodeInfo, vfs_inode); | |
301 | } | |
302 | ||
303 | static inline struct cifs_sb_info * | |
304 | CIFS_SB(struct super_block *sb) | |
305 | { | |
306 | return sb->s_fs_info; | |
307 | } | |
308 | ||
309 | ||
310 | /* one of these for every pending CIFS request to the server */ | |
311 | struct mid_q_entry { | |
312 | struct list_head qhead; /* mids waiting on reply from this server */ | |
313 | __u16 mid; /* multiplex id */ | |
314 | __u16 pid; /* process id */ | |
315 | __u32 sequence_number; /* for CIFS signing */ | |
316 | __u16 command; /* smb command code */ | |
317 | struct timeval when_sent; /* time when smb sent */ | |
318 | struct cifsSesInfo *ses; /* smb was sent to this server */ | |
319 | struct task_struct *tsk; /* task waiting for response */ | |
320 | struct smb_hdr *resp_buf; /* response buffer */ | |
321 | int midState; /* wish this were enum but can not pass to wait_event */ | |
322 | }; | |
323 | ||
324 | struct oplock_q_entry { | |
325 | struct list_head qhead; | |
326 | struct inode * pinode; | |
327 | struct cifsTconInfo * tcon; | |
328 | __u16 netfid; | |
329 | }; | |
330 | ||
331 | #define MID_FREE 0 | |
332 | #define MID_REQUEST_ALLOCATED 1 | |
333 | #define MID_REQUEST_SUBMITTED 2 | |
334 | #define MID_RESPONSE_RECEIVED 4 | |
335 | #define MID_RETRY_NEEDED 8 /* session closed while this request out */ | |
336 | #define MID_NO_RESP_NEEDED 0x10 | |
337 | #define MID_SMALL_BUFFER 0x20 /* 112 byte response buffer instead of 4K */ | |
338 | ||
339 | /* | |
340 | ***************************************************************** | |
341 | * All constants go here | |
342 | ***************************************************************** | |
343 | */ | |
344 | ||
345 | #define UID_HASH (16) | |
346 | ||
347 | /* | |
348 | * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the | |
349 | * following to be declared. | |
350 | */ | |
351 | ||
352 | /**************************************************************************** | |
353 | * Locking notes. All updates to global variables and lists should be | |
354 | * protected by spinlocks or semaphores. | |
355 | * | |
356 | * Spinlocks | |
357 | * --------- | |
358 | * GlobalMid_Lock protects: | |
359 | * list operations on pending_mid_q and oplockQ | |
360 | * updates to XID counters, multiplex id and SMB sequence numbers | |
361 | * GlobalSMBSesLock protects: | |
362 | * list operations on tcp and SMB session lists and tCon lists | |
363 | * f_owner.lock protects certain per file struct operations | |
364 | * mapping->page_lock protects certain per page operations | |
365 | * | |
366 | * Semaphores | |
367 | * ---------- | |
368 | * sesSem operations on smb session | |
369 | * tconSem operations on tree connection | |
370 | * fh_sem file handle reconnection operations | |
371 | * | |
372 | ****************************************************************************/ | |
373 | ||
374 | #ifdef DECLARE_GLOBALS_HERE | |
375 | #define GLOBAL_EXTERN | |
376 | #else | |
377 | #define GLOBAL_EXTERN extern | |
378 | #endif | |
379 | ||
380 | /* | |
381 | * The list of servers that did not respond with NT LM 0.12. | |
382 | * This list helps improve performance and eliminate the messages indicating | |
383 | * that we had a communications error talking to the server in this list. | |
384 | */ | |
385 | GLOBAL_EXTERN struct servers_not_supported *NotSuppList; /*@z4a */ | |
386 | ||
387 | /* | |
388 | * The following is a hash table of all the users we know about. | |
389 | */ | |
390 | GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH]; | |
391 | ||
392 | GLOBAL_EXTERN struct list_head GlobalServerList; /* BB not implemented yet */ | |
393 | GLOBAL_EXTERN struct list_head GlobalSMBSessionList; | |
394 | GLOBAL_EXTERN struct list_head GlobalTreeConnectionList; | |
395 | GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */ | |
396 | ||
397 | GLOBAL_EXTERN struct list_head GlobalOplock_Q; | |
398 | ||
399 | /* | |
400 | * Global transaction id (XID) information | |
401 | */ | |
402 | GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */ | |
403 | GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */ | |
404 | GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */ | |
405 | GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above and list operations */ | |
406 | /* on midQ entries */ | |
407 | GLOBAL_EXTERN char Local_System_Name[15]; | |
408 | ||
409 | /* | |
410 | * Global counters, updated atomically | |
411 | */ | |
412 | GLOBAL_EXTERN atomic_t sesInfoAllocCount; | |
413 | GLOBAL_EXTERN atomic_t tconInfoAllocCount; | |
414 | GLOBAL_EXTERN atomic_t tcpSesAllocCount; | |
415 | GLOBAL_EXTERN atomic_t tcpSesReconnectCount; | |
416 | GLOBAL_EXTERN atomic_t tconInfoReconnectCount; | |
417 | ||
418 | /* Various Debug counters to remove someday (BB) */ | |
419 | GLOBAL_EXTERN atomic_t bufAllocCount; | |
420 | GLOBAL_EXTERN atomic_t smBufAllocCount; | |
421 | GLOBAL_EXTERN atomic_t midCount; | |
422 | ||
423 | /* Misc globals */ | |
424 | GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions | |
425 | to be established on existing mount if we | |
426 | have the uid/password or Kerberos credential | |
427 | or equivalent for current user */ | |
428 | GLOBAL_EXTERN unsigned int oplockEnabled; | |
429 | GLOBAL_EXTERN unsigned int experimEnabled; | |
430 | GLOBAL_EXTERN unsigned int lookupCacheEnabled; | |
431 | GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent | |
432 | with more secure ntlmssp2 challenge/resp */ | |
433 | GLOBAL_EXTERN unsigned int ntlmv2_support; /* better optional password hash */ | |
434 | GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */ | |
435 | GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/ | |
436 | GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */ | |
437 | GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */ | |
438 | GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */ | |
439 | GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/ | |
440 |