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 PLAINTXT = 0, /* Legacy with Plaintext passwords */
94 LANMAN, /* Legacy LANMAN auth */
95 NTLM, /* Legacy NTLM012 auth with NTLM hash */
96 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
97 RawNTLMSSP, /* NTLMSSP without SPNEGO */
98 NTLMSSP, /* NTLMSSP via SPNEGO */
99 Kerberos /* Kerberos via SPNEGO */
106 /* Netbios frames protocol not supported at this time */
112 char ntlm[CIFS_SESS_KEY_SIZE + 16];
115 struct ntlmv2_resp resp;
125 struct cifs_sid osid;
126 struct cifs_sid gsid;
127 struct cifs_ntace *ntaces;
128 struct cifs_ace *aces;
132 *****************************************************************
133 * Except the CIFS PDUs themselves all the
134 * globally interesting structs should go here
135 *****************************************************************
138 struct TCP_Server_Info {
139 /* 15 character server name + 0x20 16th byte indicating type = srv */
140 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
141 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
142 struct socket *ssocket;
144 struct sockaddr_in sockAddr;
145 struct sockaddr_in6 sockAddr6;
147 wait_queue_head_t response_q;
148 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
149 struct list_head pending_mid_q;
150 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
151 unsigned short server_codepage; /* codepage for the server */
152 unsigned long ip_address; /* IP addr for the server if known */
153 enum protocolEnum protocolType;
156 unsigned svlocal:1; /* local server or remote */
157 atomic_t socketUseCount; /* number of open cifs sessions on socket */
158 atomic_t inFlight; /* number of requests on the wire to server */
159 #ifdef CONFIG_CIFS_STATS2
160 atomic_t inSend; /* requests trying to send */
161 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
163 enum statusEnum tcpStatus; /* what we think the status is */
164 struct semaphore tcpSem;
165 struct task_struct *tsk;
166 char server_GUID[16];
168 enum securityEnum secType;
169 unsigned int maxReq; /* Clients should submit no more */
170 /* than maxReq distinct unanswered SMBs to the server when using */
171 /* multiplexed reads or writes */
172 unsigned int maxBuf; /* maxBuf specifies the maximum */
173 /* message size the server can send or receive for non-raw SMBs */
174 unsigned int maxRw; /* maxRw specifies the maximum */
175 /* message size the server can send or receive for */
176 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
177 char sessid[4]; /* unique token id for this session */
178 /* (returned on Negotiate */
179 int capabilities; /* allow selective disabling of caps by smb sess */
180 int timeAdj; /* Adjust for difference in server time zone in sec */
181 __u16 CurrentMid; /* multiplex id - rotating counter */
182 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
183 /* 16th byte of RFC1001 workstation name is always null */
184 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
185 __u32 sequence_number; /* needed for CIFS PDU signature */
186 struct mac_key mac_signing_key;
187 char ntlmv2_hash[16];
188 unsigned long lstrp; /* when we got last response from this server */
192 * The following is our shortcut to user information. We surface the uid,
193 * and name. We always get the password on the fly in case it
194 * has changed. We also hang a list of sessions owned by this user off here.
197 struct list_head userList;
198 struct list_head sessionList; /* SMB sessions for this user */
200 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
201 /* BB may need ptr or callback for PAM or WinBind info */
205 * Session structure. One of these for each uid session with a particular host
208 struct list_head cifsSessionList;
209 struct semaphore sesSem;
211 struct cifsUidInfo *uidInfo; /* pointer to user info */
213 struct TCP_Server_Info *server; /* pointer to server info */
214 atomic_t inUse; /* # of mounts (tree connections) on this ses */
215 enum statusEnum status;
216 unsigned overrideSecFlg; /* if non-zero override global sec flags */
217 __u16 ipc_tid; /* special tid for connection to IPC share */
219 char *serverOS; /* name of operating system underlying server */
220 char *serverNOS; /* name of network operating system of server */
221 char *serverDomain; /* security realm of server */
222 int Suid; /* remote smb uid */
223 uid_t linux_uid; /* local Linux uid */
225 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
226 TCP names - will ipv6 and sctp addresses fit? */
227 char userName[MAX_USERNAME_SIZE + 1];
231 /* no more than one of the following three session flags may be set */
232 #define CIFS_SES_NT4 1
233 #define CIFS_SES_OS2 2
234 #define CIFS_SES_W9X 4
235 /* following flag is set for old servers such as OS2 (and Win95?)
236 which do not negotiate NTLM or POSIX dialects, but instead
237 negotiate one of the older LANMAN dialects */
238 #define CIFS_SES_LANMAN 8
240 * there is one of these for each connection to a resource on a particular
243 struct cifsTconInfo {
244 struct list_head cifsConnectionList;
245 struct list_head openFileList;
246 struct semaphore tconSem;
247 struct cifsSesInfo *ses; /* pointer to session associated with */
248 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
249 char *nativeFileSystem;
250 __u16 tid; /* The 2 byte tree id */
251 __u16 Flags; /* optional support bits */
252 enum statusEnum tidStatus;
253 atomic_t useCount; /* how many explicit/implicit mounts to share */
254 #ifdef CONFIG_CIFS_STATS
255 atomic_t num_smbs_sent;
258 atomic_t num_oplock_brks;
261 atomic_t num_deletes;
264 atomic_t num_renames;
265 atomic_t num_t2renames;
269 atomic_t num_hardlinks;
270 atomic_t num_symlinks;
272 atomic_t num_acl_get;
273 atomic_t num_acl_set;
274 #ifdef CONFIG_CIFS_STATS2
275 unsigned long long time_writes;
276 unsigned long long time_reads;
277 unsigned long long time_opens;
278 unsigned long long time_deletes;
279 unsigned long long time_closes;
280 unsigned long long time_mkdirs;
281 unsigned long long time_rmdirs;
282 unsigned long long time_renames;
283 unsigned long long time_t2renames;
284 unsigned long long time_ffirst;
285 unsigned long long time_fnext;
286 unsigned long long time_fclose;
287 #endif /* CONFIG_CIFS_STATS2 */
290 spinlock_t stat_lock;
291 #endif /* CONFIG_CIFS_STATS */
292 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
293 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
294 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
295 unsigned ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
298 unsigned unix_ext:1; /* if off disable Linux extensions to CIFS protocol
299 for this mount even if server would support */
300 /* BB add field for back pointer to sb struct(s)? */
304 * This info hangs off the cifsFileInfo structure, pointed to by llist.
305 * This is used to track byte stream locks on the file
307 struct cifsLockInfo {
308 struct list_head llist; /* pointer to next cifsLockInfo */
315 * One of these for each open instance of a file
317 struct cifs_search_info {
318 loff_t index_of_last_entry;
319 __u16 entries_in_buffer;
322 char *ntwrk_buf_start;
323 char *srch_entries_start;
325 unsigned int resume_name_len;
326 unsigned endOfSearch:1;
329 unsigned smallBuf:1; /* so we know which buf_release function to call */
332 struct cifsFileInfo {
333 struct list_head tlist; /* pointer to next fid owned by tcon */
334 struct list_head flist; /* next fid (file instance) for this inode */
335 unsigned int uid; /* allows finding which FileInfo structure */
336 __u32 pid; /* process id who opened file */
337 __u16 netfid; /* file id from remote */
338 /* BB add lock scope info here if needed */ ;
339 /* lock scope id (0 if none) */
340 struct file *pfile; /* needed for writepage */
341 struct inode *pInode; /* needed for oplock break */
342 struct mutex lock_mutex;
343 struct list_head llist; /* list of byte range locks we have. */
344 unsigned closePend:1; /* file is marked to close */
345 unsigned invalidHandle:1; /* file closed via session abend */
346 unsigned messageMode:1; /* for pipes: message vs byte mode */
347 atomic_t wrtPending; /* handle in use - defer close */
348 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
349 char *search_resume_name; /* BB removeme BB */
350 struct cifs_search_info srch_inf;
354 * One of these for each file inode
357 struct cifsInodeInfo {
358 struct list_head lockList;
359 /* BB add in lists for dirty pages i.e. write caching info for oplock */
360 struct list_head openFileList;
362 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
363 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
364 unsigned long time; /* jiffies of last update/check of inode */
365 unsigned clientCanCacheRead:1; /* read oplock */
366 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
367 unsigned oplockPending:1;
368 struct inode vfs_inode;
371 static inline struct cifsInodeInfo *
372 CIFS_I(struct inode *inode)
374 return container_of(inode, struct cifsInodeInfo, vfs_inode);
377 static inline struct cifs_sb_info *
378 CIFS_SB(struct super_block *sb)
380 return sb->s_fs_info;
383 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
385 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
391 #ifdef CONFIG_CIFS_STATS
392 #define cifs_stats_inc atomic_inc
394 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
398 spin_lock(&tcon->stat_lock);
399 tcon->bytes_written += bytes;
400 spin_unlock(&tcon->stat_lock);
404 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
407 spin_lock(&tcon->stat_lock);
408 tcon->bytes_read += bytes;
409 spin_unlock(&tcon->stat_lock);
413 #define cifs_stats_inc(field) do {} while (0)
414 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
415 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
419 /* one of these for every pending CIFS request to the server */
421 struct list_head qhead; /* mids waiting on reply from this server */
422 __u16 mid; /* multiplex id */
423 __u16 pid; /* process id */
424 __u32 sequence_number; /* for CIFS signing */
425 unsigned long when_alloc; /* when mid was created */
426 #ifdef CONFIG_CIFS_STATS2
427 unsigned long when_sent; /* time when smb send finished */
428 unsigned long when_received; /* when demux complete (taken off wire) */
430 struct cifsSesInfo *ses; /* smb was sent to this server */
431 struct task_struct *tsk; /* task waiting for response */
432 struct smb_hdr *resp_buf; /* response buffer */
433 int midState; /* wish this were enum but can not pass to wait_event */
434 __u8 command; /* smb command code */
435 unsigned largeBuf:1; /* if valid response, is pointer to large buf */
436 unsigned multiRsp:1; /* multiple trans2 responses for one request */
437 unsigned multiEnd:1; /* both received */
440 struct oplock_q_entry {
441 struct list_head qhead;
442 struct inode *pinode;
443 struct cifsTconInfo *tcon;
447 /* for pending dnotify requests */
448 struct dir_notify_req {
449 struct list_head lhead;
456 __u32 filter; /* CompletionFilter (for multishot) */
462 #define MID_REQUEST_ALLOCATED 1
463 #define MID_REQUEST_SUBMITTED 2
464 #define MID_RESPONSE_RECEIVED 4
465 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
466 #define MID_NO_RESP_NEEDED 0x10
468 /* Types of response buffer returned from SendReceive2 */
469 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
470 #define CIFS_SMALL_BUFFER 1
471 #define CIFS_LARGE_BUFFER 2
472 #define CIFS_IOVEC 4 /* array of response buffers */
474 /* Security Flags: indicate type of session setup needed */
475 #define CIFSSEC_MAY_SIGN 0x00001
476 #define CIFSSEC_MAY_NTLM 0x00002
477 #define CIFSSEC_MAY_NTLMV2 0x00004
478 #define CIFSSEC_MAY_KRB5 0x00008
479 #ifdef CONFIG_CIFS_WEAK_PW_HASH
480 #define CIFSSEC_MAY_LANMAN 0x00010
481 #define CIFSSEC_MAY_PLNTXT 0x00020
483 #define CIFSSEC_MAY_LANMAN 0
484 #define CIFSSEC_MAY_PLNTXT 0
485 #endif /* weak passwords */
486 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
488 #define CIFSSEC_MUST_SIGN 0x01001
489 /* note that only one of the following can be set so the
490 result of setting MUST flags more than once will be to
491 require use of the stronger protocol */
492 #define CIFSSEC_MUST_NTLM 0x02002
493 #define CIFSSEC_MUST_NTLMV2 0x04004
494 #define CIFSSEC_MUST_KRB5 0x08008
495 #ifdef CONFIG_CIFS_WEAK_PW_HASH
496 #define CIFSSEC_MUST_LANMAN 0x10010
497 #define CIFSSEC_MUST_PLNTXT 0x20020
498 #ifdef CONFIG_CIFS_UPCALL
499 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
501 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
503 #else /* do not allow weak pw hash */
504 #ifdef CONFIG_CIFS_UPCALL
505 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
507 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
509 #endif /* WEAK_PW_HASH */
510 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
512 #define CIFSSEC_DEF CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2
513 #define CIFSSEC_MAX CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2
514 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
516 *****************************************************************
517 * All constants go here
518 *****************************************************************
521 #define UID_HASH (16)
524 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
525 * following to be declared.
528 /****************************************************************************
529 * Locking notes. All updates to global variables and lists should be
530 * protected by spinlocks or semaphores.
534 * GlobalMid_Lock protects:
535 * list operations on pending_mid_q and oplockQ
536 * updates to XID counters, multiplex id and SMB sequence numbers
537 * GlobalSMBSesLock protects:
538 * list operations on tcp and SMB session lists and tCon lists
539 * f_owner.lock protects certain per file struct operations
540 * mapping->page_lock protects certain per page operations
544 * sesSem operations on smb session
545 * tconSem operations on tree connection
546 * fh_sem file handle reconnection operations
548 ****************************************************************************/
550 #ifdef DECLARE_GLOBALS_HERE
551 #define GLOBAL_EXTERN
553 #define GLOBAL_EXTERN extern
557 * The list of servers that did not respond with NT LM 0.12.
558 * This list helps improve performance and eliminate the messages indicating
559 * that we had a communications error talking to the server in this list.
561 /* Feature not supported */
562 /* GLOBAL_EXTERN struct servers_not_supported *NotSuppList; */
565 * The following is a hash table of all the users we know about.
567 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
569 /* GLOBAL_EXTERN struct list_head GlobalServerList; BB not implemented yet */
570 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
571 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
572 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
574 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
576 /* Outstanding dir notify requests */
577 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
578 /* DirNotify response queue */
579 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
582 * Global transaction id (XID) information
584 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
585 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
586 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
587 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
588 /* on midQ entries */
589 GLOBAL_EXTERN char Local_System_Name[15];
592 * Global counters, updated atomically
594 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
595 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
596 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
597 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
598 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
600 /* Various Debug counters to remove someday (BB) */
601 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
602 #ifdef CONFIG_CIFS_STATS2
603 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
604 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
606 GLOBAL_EXTERN atomic_t smBufAllocCount;
607 GLOBAL_EXTERN atomic_t midCount;
610 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
611 to be established on existing mount if we
612 have the uid/password or Kerberos credential
613 or equivalent for current user */
614 GLOBAL_EXTERN unsigned int oplockEnabled;
615 GLOBAL_EXTERN unsigned int experimEnabled;
616 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
617 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
618 with more secure ntlmssp2 challenge/resp */
619 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
620 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
621 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
622 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
623 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
624 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/