4 * Copyright (C) International Business Machines Corp., 2002,2005
5 * Author(s): Steve French (sfrench@us.ibm.com)
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.
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.
19 #include <linux/in6.h>
20 #include "cifs_fs_sb.h"
22 * The sizes of various internal tables and strings
24 #define MAX_UID_INFO 16
25 #define MAX_SES_INFO 2
26 #define MAX_TCON_INFO 4
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
35 #define CIFS_MIN_RCV_POOL 4
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
46 #define CIFS_MAX_REQ 50
48 #define SERVER_NAME_LENGTH 15
49 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
51 /* used to define string lengths for reversing unicode strings */
53 /* (max path length + 1 for null) * 2 for unicode */
66 #ifndef XATTR_DOS_ATTRIB
67 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
71 * This information is kept on every Server we know about.
73 * Some things to note:
76 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
79 * CIFS vfs client Status information (based on what we know.)
82 /* associated with each tcp and smb session */
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 */
102 /* Netbios frames protocol not supported at this time */
106 *****************************************************************
107 * Except the CIFS PDUs themselves all the
108 * globally interesting structs should go here
109 *****************************************************************
112 struct TCP_Server_Info {
113 char server_Name[SERVER_NAME_LEN_WITH_NULL]; /* 15 chars + X'20' 16th */
114 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
115 struct socket *ssocket;
117 struct sockaddr_in sockAddr;
118 struct sockaddr_in6 sockAddr6;
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;
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];
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 */
150 __u16 CurrentMid; /* multiplex id - rotating counter */
151 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
152 char workstation_RFC1001_name[16]; /* 16th byte is always zero */
153 __u32 sequence_number; /* needed for CIFS PDU signature */
154 char mac_signing_key[CIFS_SESSION_KEY_SIZE + 16];
158 * The following is our shortcut to user information. We surface the uid,
159 * and name. We always get the password on the fly in case it
160 * has changed. We also hang a list of sessions owned by this user off here.
163 struct list_head userList;
164 struct list_head sessionList; /* SMB sessions for this user */
166 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
167 /* BB may need ptr or callback for PAM or WinBind info */
171 * Session structure. One of these for each uid session with a particular host
174 struct list_head cifsSessionList;
175 struct semaphore sesSem;
176 struct cifsUidInfo *uidInfo; /* pointer to user info */
177 struct TCP_Server_Info *server; /* pointer to server info */
178 atomic_t inUse; /* # of mounts (tree connections) on this ses */
179 enum statusEnum status;
180 __u16 ipc_tid; /* special tid for connection to IPC share */
182 char *serverOS; /* name of operating system underlying server */
183 char *serverNOS; /* name of network operating system of server */
184 char *serverDomain; /* security realm of server */
185 int Suid; /* remote smb uid */
186 uid_t linux_uid; /* local Linux uid */
188 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
189 TCP names - will ipv6 and sctp addresses fit? */
190 char userName[MAX_USERNAME_SIZE + 1];
191 char domainName[MAX_USERNAME_SIZE + 1];
195 #define CIFS_SES_NT4 1
198 * there is one of these for each connection to a resource on a particular
201 struct cifsTconInfo {
202 struct list_head cifsConnectionList;
203 struct list_head openFileList;
204 struct semaphore tconSem;
205 struct cifsSesInfo *ses; /* pointer to session associated with */
206 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource (in ASCII not UTF) */
207 char *nativeFileSystem;
208 __u16 tid; /* The 2 byte tree id */
209 __u16 Flags; /* optional support bits */
210 enum statusEnum tidStatus;
211 atomic_t useCount; /* how many mounts (explicit or implicit) to this share */
212 #ifdef CONFIG_CIFS_STATS
213 atomic_t num_smbs_sent;
216 atomic_t num_oplock_brks;
219 atomic_t num_deletes;
222 atomic_t num_renames;
223 atomic_t num_t2renames;
227 atomic_t num_hardlinks;
228 atomic_t num_symlinks;
230 #ifdef CONFIG_CIFS_STATS2
231 unsigned long long time_writes;
232 unsigned long long time_reads;
233 unsigned long long time_opens;
234 unsigned long long time_deletes;
235 unsigned long long time_closes;
236 unsigned long long time_mkdirs;
237 unsigned long long time_rmdirs;
238 unsigned long long time_renames;
239 unsigned long long time_t2renames;
240 unsigned long long time_ffirst;
241 unsigned long long time_fnext;
242 unsigned long long time_fclose;
243 #endif /* CONFIG_CIFS_STATS2 */
246 spinlock_t stat_lock;
247 #endif /* CONFIG_CIFS_STATS */
248 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
249 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if file system name truncated */
250 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
253 /* BB add field for back pointer to sb struct? */
257 * This info hangs off the cifsFileInfo structure. This is used to track
258 * byte stream locks on the file
260 struct cifsLockInfo {
261 struct cifsLockInfo *next;
268 * One of these for each open instance of a file
270 struct cifs_search_info {
271 loff_t index_of_last_entry;
272 __u16 entries_in_buffer;
275 char * ntwrk_buf_start;
276 char * srch_entries_start;
278 unsigned int resume_name_len;
279 unsigned endOfSearch:1;
284 struct cifsFileInfo {
285 struct list_head tlist; /* pointer to next fid owned by tcon */
286 struct list_head flist; /* next fid (file instance) for this inode */
287 unsigned int uid; /* allows finding which FileInfo structure */
288 __u32 pid; /* process id who opened file */
289 __u16 netfid; /* file id from remote */
290 /* BB add lock scope info here if needed */ ;
291 /* lock scope id (0 if none) */
292 struct file * pfile; /* needed for writepage */
293 struct inode * pInode; /* needed for oplock break */
294 unsigned closePend:1; /* file is marked to close */
295 unsigned invalidHandle:1; /* file closed via session abend */
296 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
297 char * search_resume_name; /* BB removeme BB */
298 unsigned int resume_name_length; /* BB removeme - field renamed and moved BB */
299 struct cifs_search_info srch_inf;
303 * One of these for each file inode
306 struct cifsInodeInfo {
307 struct list_head lockList;
308 /* BB add in lists for dirty pages - i.e. write caching info for oplock */
309 struct list_head openFileList;
311 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
312 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
313 unsigned long time; /* jiffies of last update/check of inode */
314 unsigned clientCanCacheRead:1; /* read oplock */
315 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
316 unsigned oplockPending:1;
317 struct inode vfs_inode;
320 static inline struct cifsInodeInfo *
321 CIFS_I(struct inode *inode)
323 return container_of(inode, struct cifsInodeInfo, vfs_inode);
326 static inline struct cifs_sb_info *
327 CIFS_SB(struct super_block *sb)
329 return sb->s_fs_info;
332 static inline const char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
334 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
340 /* one of these for every pending CIFS request to the server */
342 struct list_head qhead; /* mids waiting on reply from this server */
343 __u16 mid; /* multiplex id */
344 __u16 pid; /* process id */
345 __u32 sequence_number; /* for CIFS signing */
346 struct timeval when_sent; /* time when smb sent */
347 struct cifsSesInfo *ses; /* smb was sent to this server */
348 struct task_struct *tsk; /* task waiting for response */
349 struct smb_hdr *resp_buf; /* response buffer */
350 int midState; /* wish this were enum but can not pass to wait_event */
351 __u8 command; /* smb command code */
352 unsigned multiPart:1; /* multiple responses to one SMB request */
353 unsigned largeBuf:1; /* if valid response, is pointer to large buf */
354 unsigned multiResp:1; /* multiple trans2 responses for one request */
357 struct oplock_q_entry {
358 struct list_head qhead;
359 struct inode * pinode;
360 struct cifsTconInfo * tcon;
365 #define MID_REQUEST_ALLOCATED 1
366 #define MID_REQUEST_SUBMITTED 2
367 #define MID_RESPONSE_RECEIVED 4
368 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
369 #define MID_NO_RESP_NEEDED 0x10
370 #define MID_SMALL_BUFFER 0x20 /* 112 byte response buffer instead of 4K */
373 *****************************************************************
374 * All constants go here
375 *****************************************************************
378 #define UID_HASH (16)
381 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
382 * following to be declared.
385 /****************************************************************************
386 * Locking notes. All updates to global variables and lists should be
387 * protected by spinlocks or semaphores.
391 * GlobalMid_Lock protects:
392 * list operations on pending_mid_q and oplockQ
393 * updates to XID counters, multiplex id and SMB sequence numbers
394 * GlobalSMBSesLock protects:
395 * list operations on tcp and SMB session lists and tCon lists
396 * f_owner.lock protects certain per file struct operations
397 * mapping->page_lock protects certain per page operations
401 * sesSem operations on smb session
402 * tconSem operations on tree connection
403 * fh_sem file handle reconnection operations
405 ****************************************************************************/
407 #ifdef DECLARE_GLOBALS_HERE
408 #define GLOBAL_EXTERN
410 #define GLOBAL_EXTERN extern
414 * The list of servers that did not respond with NT LM 0.12.
415 * This list helps improve performance and eliminate the messages indicating
416 * that we had a communications error talking to the server in this list.
418 GLOBAL_EXTERN struct servers_not_supported *NotSuppList; /*@z4a */
421 * The following is a hash table of all the users we know about.
423 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
425 GLOBAL_EXTERN struct list_head GlobalServerList; /* BB not implemented yet */
426 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
427 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
428 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
430 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
433 * Global transaction id (XID) information
435 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
436 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
437 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
438 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above and list operations */
439 /* on midQ entries */
440 GLOBAL_EXTERN char Local_System_Name[15];
443 * Global counters, updated atomically
445 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
446 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
447 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
448 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
449 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
451 /* Various Debug counters to remove someday (BB) */
452 GLOBAL_EXTERN atomic_t bufAllocCount;
453 GLOBAL_EXTERN atomic_t smBufAllocCount;
454 GLOBAL_EXTERN atomic_t midCount;
457 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
458 to be established on existing mount if we
459 have the uid/password or Kerberos credential
460 or equivalent for current user */
461 GLOBAL_EXTERN unsigned int oplockEnabled;
462 GLOBAL_EXTERN unsigned int experimEnabled;
463 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
464 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
465 with more secure ntlmssp2 challenge/resp */
466 GLOBAL_EXTERN unsigned int ntlmv2_support; /* better optional password hash */
467 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
468 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
469 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
470 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
471 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
472 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/