4 * Copyright (C) International Business Machines Corp., 2002,2007
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
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.
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.
20 #include <linux/in6.h>
21 #include "cifs_fs_sb.h"
24 * The sizes of various internal tables and strings
26 #define MAX_UID_INFO 16
27 #define MAX_SES_INFO 2
28 #define MAX_TCON_INFO 4
30 #define MAX_TREE_SIZE 2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1
31 #define MAX_SERVER_SIZE 15
32 #define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
33 #define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
34 termination then *2 for unicode versions */
35 #define MAX_PASSWORD_SIZE 16
37 #define CIFS_MIN_RCV_POOL 4
40 * MAX_REQ is the maximum number of requests that WE will send
41 * on one socket concurently. It also matches the most common
42 * value of max multiplex returned by servers. We may
43 * eventually want to use the negotiated value (in case
44 * future servers can handle more) when we are more confident that
45 * we will not have problems oveloading the socket with pending
48 #define CIFS_MAX_REQ 50
50 #define SERVER_NAME_LENGTH 15
51 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
53 /* used to define string lengths for reversing unicode strings */
55 /* (max path length + 1 for null) * 2 for unicode */
68 #ifndef XATTR_DOS_ATTRIB
69 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
73 * This information is kept on every Server we know about.
75 * Some things to note:
78 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
81 * CIFS vfs client Status information (based on what we know.)
84 /* associated with each tcp and smb session */
93 LANMAN = 0, /* Legacy LANMAN auth */
94 NTLM, /* Legacy NTLM012 auth with NTLM hash */
95 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
96 RawNTLMSSP, /* NTLMSSP without SPNEGO */
97 NTLMSSP, /* NTLMSSP via SPNEGO */
98 Kerberos /* Kerberos via SPNEGO */
105 /* Netbios frames protocol not supported at this time */
111 char ntlm[CIFS_SESS_KEY_SIZE + 16];
114 struct ntlmv2_resp resp;
124 struct cifs_sid osid;
125 struct cifs_sid gsid;
126 struct cifs_ntace *ntaces;
127 struct cifs_ace *aces;
131 *****************************************************************
132 * Except the CIFS PDUs themselves all the
133 * globally interesting structs should go here
134 *****************************************************************
137 struct TCP_Server_Info {
138 /* 15 character server name + 0x20 16th byte indicating type = srv */
139 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
140 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
141 struct socket *ssocket;
143 struct sockaddr_in sockAddr;
144 struct sockaddr_in6 sockAddr6;
146 wait_queue_head_t response_q;
147 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
148 struct list_head pending_mid_q;
149 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
150 unsigned short server_codepage; /* codepage for the server */
151 unsigned long ip_address; /* IP addr for the server if known */
152 enum protocolEnum protocolType;
155 unsigned svlocal:1; /* local server or remote */
156 atomic_t socketUseCount; /* number of open cifs sessions on socket */
157 atomic_t inFlight; /* number of requests on the wire to server */
158 #ifdef CONFIG_CIFS_STATS2
159 atomic_t inSend; /* requests trying to send */
160 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
162 enum statusEnum tcpStatus; /* what we think the status is */
163 struct semaphore tcpSem;
164 struct task_struct *tsk;
165 char server_GUID[16];
167 enum securityEnum secType;
168 unsigned int maxReq; /* Clients should submit no more */
169 /* than maxReq distinct unanswered SMBs to the server when using */
170 /* multiplexed reads or writes */
171 unsigned int maxBuf; /* maxBuf specifies the maximum */
172 /* message size the server can send or receive for non-raw SMBs */
173 unsigned int maxRw; /* maxRw specifies the maximum */
174 /* message size the server can send or receive for */
175 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
176 char sessid[4]; /* unique token id for this session */
177 /* (returned on Negotiate */
178 int capabilities; /* allow selective disabling of caps by smb sess */
179 int timeAdj; /* Adjust for difference in server time zone in sec */
180 __u16 CurrentMid; /* multiplex id - rotating counter */
181 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
182 /* 16th byte of RFC1001 workstation name is always null */
183 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
184 __u32 sequence_number; /* needed for CIFS PDU signature */
185 struct mac_key mac_signing_key;
186 char ntlmv2_hash[16];
187 unsigned long lstrp; /* when we got last response from this server */
191 * The following is our shortcut to user information. We surface the uid,
192 * and name. We always get the password on the fly in case it
193 * has changed. We also hang a list of sessions owned by this user off here.
196 struct list_head userList;
197 struct list_head sessionList; /* SMB sessions for this user */
199 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
200 /* BB may need ptr or callback for PAM or WinBind info */
204 * Session structure. One of these for each uid session with a particular host
207 struct list_head cifsSessionList;
208 struct semaphore sesSem;
210 struct cifsUidInfo *uidInfo; /* pointer to user info */
212 struct TCP_Server_Info *server; /* pointer to server info */
213 atomic_t inUse; /* # of mounts (tree connections) on this ses */
214 enum statusEnum status;
215 unsigned overrideSecFlg; /* if non-zero override global sec flags */
216 __u16 ipc_tid; /* special tid for connection to IPC share */
218 char *serverOS; /* name of operating system underlying server */
219 char *serverNOS; /* name of network operating system of server */
220 char *serverDomain; /* security realm of server */
221 int Suid; /* remote smb uid */
222 uid_t linux_uid; /* local Linux uid */
224 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
225 TCP names - will ipv6 and sctp addresses fit? */
226 char userName[MAX_USERNAME_SIZE + 1];
230 /* no more than one of the following three session flags may be set */
231 #define CIFS_SES_NT4 1
232 #define CIFS_SES_OS2 2
233 #define CIFS_SES_W9X 4
234 /* following flag is set for old servers such as OS2 (and Win95?)
235 which do not negotiate NTLM or POSIX dialects, but instead
236 negotiate one of the older LANMAN dialects */
237 #define CIFS_SES_LANMAN 8
239 * there is one of these for each connection to a resource on a particular
242 struct cifsTconInfo {
243 struct list_head cifsConnectionList;
244 struct list_head openFileList;
245 struct semaphore tconSem;
246 struct cifsSesInfo *ses; /* pointer to session associated with */
247 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
248 char *nativeFileSystem;
249 __u16 tid; /* The 2 byte tree id */
250 __u16 Flags; /* optional support bits */
251 enum statusEnum tidStatus;
252 atomic_t useCount; /* how many explicit/implicit mounts to share */
253 #ifdef CONFIG_CIFS_STATS
254 atomic_t num_smbs_sent;
257 atomic_t num_oplock_brks;
260 atomic_t num_deletes;
263 atomic_t num_renames;
264 atomic_t num_t2renames;
268 atomic_t num_hardlinks;
269 atomic_t num_symlinks;
271 atomic_t num_acl_get;
272 atomic_t num_acl_set;
273 #ifdef CONFIG_CIFS_STATS2
274 unsigned long long time_writes;
275 unsigned long long time_reads;
276 unsigned long long time_opens;
277 unsigned long long time_deletes;
278 unsigned long long time_closes;
279 unsigned long long time_mkdirs;
280 unsigned long long time_rmdirs;
281 unsigned long long time_renames;
282 unsigned long long time_t2renames;
283 unsigned long long time_ffirst;
284 unsigned long long time_fnext;
285 unsigned long long time_fclose;
286 #endif /* CONFIG_CIFS_STATS2 */
289 spinlock_t stat_lock;
290 #endif /* CONFIG_CIFS_STATS */
291 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
292 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
293 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
294 unsigned ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
297 unsigned unix_ext:1; /* if off disable Linux extensions to CIFS protocol
298 for this mount even if server would support */
299 /* BB add field for back pointer to sb struct(s)? */
303 * This info hangs off the cifsFileInfo structure, pointed to by llist.
304 * This is used to track byte stream locks on the file
306 struct cifsLockInfo {
307 struct list_head llist; /* pointer to next cifsLockInfo */
314 * One of these for each open instance of a file
316 struct cifs_search_info {
317 loff_t index_of_last_entry;
318 __u16 entries_in_buffer;
321 char *ntwrk_buf_start;
322 char *srch_entries_start;
324 unsigned int resume_name_len;
325 unsigned endOfSearch:1;
328 unsigned smallBuf:1; /* so we know which buf_release function to call */
331 struct cifsFileInfo {
332 struct list_head tlist; /* pointer to next fid owned by tcon */
333 struct list_head flist; /* next fid (file instance) for this inode */
334 unsigned int uid; /* allows finding which FileInfo structure */
335 __u32 pid; /* process id who opened file */
336 __u16 netfid; /* file id from remote */
337 /* BB add lock scope info here if needed */ ;
338 /* lock scope id (0 if none) */
339 struct file *pfile; /* needed for writepage */
340 struct inode *pInode; /* needed for oplock break */
341 struct mutex lock_mutex;
342 struct list_head llist; /* list of byte range locks we have. */
343 unsigned closePend:1; /* file is marked to close */
344 unsigned invalidHandle:1; /* file closed via session abend */
345 unsigned messageMode:1; /* for pipes: message vs byte mode */
346 atomic_t wrtPending; /* handle in use - defer close */
347 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
348 char *search_resume_name; /* BB removeme BB */
349 struct cifs_search_info srch_inf;
353 * One of these for each file inode
356 struct cifsInodeInfo {
357 struct list_head lockList;
358 /* BB add in lists for dirty pages i.e. write caching info for oplock */
359 struct list_head openFileList;
361 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
362 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
363 unsigned long time; /* jiffies of last update/check of inode */
364 unsigned clientCanCacheRead:1; /* read oplock */
365 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
366 unsigned oplockPending:1;
367 struct inode vfs_inode;
370 static inline struct cifsInodeInfo *
371 CIFS_I(struct inode *inode)
373 return container_of(inode, struct cifsInodeInfo, vfs_inode);
376 static inline struct cifs_sb_info *
377 CIFS_SB(struct super_block *sb)
379 return sb->s_fs_info;
382 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
384 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
390 #ifdef CONFIG_CIFS_STATS
391 #define cifs_stats_inc atomic_inc
393 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
397 spin_lock(&tcon->stat_lock);
398 tcon->bytes_written += bytes;
399 spin_unlock(&tcon->stat_lock);
403 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
406 spin_lock(&tcon->stat_lock);
407 tcon->bytes_read += bytes;
408 spin_unlock(&tcon->stat_lock);
412 #define cifs_stats_inc(field) do {} while (0)
413 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
414 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
418 /* one of these for every pending CIFS request to the server */
420 struct list_head qhead; /* mids waiting on reply from this server */
421 __u16 mid; /* multiplex id */
422 __u16 pid; /* process id */
423 __u32 sequence_number; /* for CIFS signing */
424 unsigned long when_alloc; /* when mid was created */
425 #ifdef CONFIG_CIFS_STATS2
426 unsigned long when_sent; /* time when smb send finished */
427 unsigned long when_received; /* when demux complete (taken off wire) */
429 struct cifsSesInfo *ses; /* smb was sent to this server */
430 struct task_struct *tsk; /* task waiting for response */
431 struct smb_hdr *resp_buf; /* response buffer */
432 int midState; /* wish this were enum but can not pass to wait_event */
433 __u8 command; /* smb command code */
434 unsigned largeBuf:1; /* if valid response, is pointer to large buf */
435 unsigned multiRsp:1; /* multiple trans2 responses for one request */
436 unsigned multiEnd:1; /* both received */
439 struct oplock_q_entry {
440 struct list_head qhead;
441 struct inode *pinode;
442 struct cifsTconInfo *tcon;
446 /* for pending dnotify requests */
447 struct dir_notify_req {
448 struct list_head lhead;
455 __u32 filter; /* CompletionFilter (for multishot) */
461 #define MID_REQUEST_ALLOCATED 1
462 #define MID_REQUEST_SUBMITTED 2
463 #define MID_RESPONSE_RECEIVED 4
464 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
465 #define MID_NO_RESP_NEEDED 0x10
467 /* Types of response buffer returned from SendReceive2 */
468 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
469 #define CIFS_SMALL_BUFFER 1
470 #define CIFS_LARGE_BUFFER 2
471 #define CIFS_IOVEC 4 /* array of response buffers */
473 /* Security Flags: indicate type of session setup needed */
474 #define CIFSSEC_MAY_SIGN 0x00001
475 #define CIFSSEC_MAY_NTLM 0x00002
476 #define CIFSSEC_MAY_NTLMV2 0x00004
477 #define CIFSSEC_MAY_KRB5 0x00008
478 #ifdef CONFIG_CIFS_WEAK_PW_HASH
479 #define CIFSSEC_MAY_LANMAN 0x00010
480 #define CIFSSEC_MAY_PLNTXT 0x00020
481 #endif /* weak passwords */
482 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
484 #define CIFSSEC_MUST_SIGN 0x01001
485 /* note that only one of the following can be set so the
486 result of setting MUST flags more than once will be to
487 require use of the stronger protocol */
488 #define CIFSSEC_MUST_NTLM 0x02002
489 #define CIFSSEC_MUST_NTLMV2 0x04004
490 #define CIFSSEC_MUST_KRB5 0x08008
491 #ifdef CONFIG_CIFS_WEAK_PW_HASH
492 #define CIFSSEC_MUST_LANMAN 0x10010
493 #define CIFSSEC_MUST_PLNTXT 0x20020
494 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
496 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak config */
497 #endif /* WEAK_PW_HASH */
498 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
500 #define CIFSSEC_DEF CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2
501 #define CIFSSEC_MAX CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2
503 *****************************************************************
504 * All constants go here
505 *****************************************************************
508 #define UID_HASH (16)
511 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
512 * following to be declared.
515 /****************************************************************************
516 * Locking notes. All updates to global variables and lists should be
517 * protected by spinlocks or semaphores.
521 * GlobalMid_Lock protects:
522 * list operations on pending_mid_q and oplockQ
523 * updates to XID counters, multiplex id and SMB sequence numbers
524 * GlobalSMBSesLock protects:
525 * list operations on tcp and SMB session lists and tCon lists
526 * f_owner.lock protects certain per file struct operations
527 * mapping->page_lock protects certain per page operations
531 * sesSem operations on smb session
532 * tconSem operations on tree connection
533 * fh_sem file handle reconnection operations
535 ****************************************************************************/
537 #ifdef DECLARE_GLOBALS_HERE
538 #define GLOBAL_EXTERN
540 #define GLOBAL_EXTERN extern
544 * The list of servers that did not respond with NT LM 0.12.
545 * This list helps improve performance and eliminate the messages indicating
546 * that we had a communications error talking to the server in this list.
548 /* Feature not supported */
549 /* GLOBAL_EXTERN struct servers_not_supported *NotSuppList; */
552 * The following is a hash table of all the users we know about.
554 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
556 /* GLOBAL_EXTERN struct list_head GlobalServerList; BB not implemented yet */
557 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
558 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
559 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
561 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
563 /* Outstanding dir notify requests */
564 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
565 /* DirNotify response queue */
566 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
569 * Global transaction id (XID) information
571 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
572 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
573 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
574 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
575 /* on midQ entries */
576 GLOBAL_EXTERN char Local_System_Name[15];
579 * Global counters, updated atomically
581 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
582 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
583 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
584 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
585 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
587 /* Various Debug counters to remove someday (BB) */
588 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
589 #ifdef CONFIG_CIFS_STATS2
590 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
591 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
593 GLOBAL_EXTERN atomic_t smBufAllocCount;
594 GLOBAL_EXTERN atomic_t midCount;
597 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
598 to be established on existing mount if we
599 have the uid/password or Kerberos credential
600 or equivalent for current user */
601 GLOBAL_EXTERN unsigned int oplockEnabled;
602 GLOBAL_EXTERN unsigned int experimEnabled;
603 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
604 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
605 with more secure ntlmssp2 challenge/resp */
606 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
607 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
608 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
609 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
610 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
611 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/