4 * Copyright (C) International Business Machines Corp., 2002,2006
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 LANMAN = 0, /* Legacy LANMAN auth */
92 NTLM, /* Legacy NTLM012 auth with NTLM hash */
93 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
94 RawNTLMSSP, /* NTLMSSP without SPNEGO */
95 NTLMSSP, /* NTLMSSP via SPNEGO */
96 Kerberos /* Kerberos via SPNEGO */
103 /* Netbios frames protocol not supported at this time */
107 *****************************************************************
108 * Except the CIFS PDUs themselves all the
109 * globally interesting structs should go here
110 *****************************************************************
113 struct TCP_Server_Info {
114 /* 15 character server name + 0x20 16th byte indicating type = srv */
115 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
116 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
117 struct socket *ssocket;
119 struct sockaddr_in sockAddr;
120 struct sockaddr_in6 sockAddr6;
122 wait_queue_head_t response_q;
123 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
124 struct list_head pending_mid_q;
125 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
126 unsigned short server_codepage; /* codepage for the server */
127 unsigned long ip_address; /* IP addr for the server if known */
128 enum protocolEnum protocolType;
131 unsigned svlocal:1; /* local server or remote */
132 atomic_t socketUseCount; /* number of open cifs sessions on socket */
133 atomic_t inFlight; /* number of requests on the wire to server */
134 #ifdef CONFIG_CIFS_STATS2
135 atomic_t inSend; /* requests trying to send */
136 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
138 enum statusEnum tcpStatus; /* what we think the status is */
139 struct semaphore tcpSem;
140 struct task_struct *tsk;
141 char server_GUID[16];
143 enum securityEnum secType;
144 unsigned int maxReq; /* Clients should submit no more */
145 /* than maxReq distinct unanswered SMBs to the server when using */
146 /* multiplexed reads or writes */
147 unsigned int maxBuf; /* maxBuf specifies the maximum */
148 /* message size the server can send or receive for non-raw SMBs */
149 unsigned int maxRw; /* maxRw specifies the maximum */
150 /* message size the server can send or receive for */
151 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
152 char sessid[4]; /* unique token id for this session */
153 /* (returned on Negotiate */
154 int capabilities; /* allow selective disabling of caps by smb sess */
156 __u16 CurrentMid; /* multiplex id - rotating counter */
157 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
158 /* 16th byte of RFC1001 workstation name is always null */
159 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
160 __u32 sequence_number; /* needed for CIFS PDU signature */
161 char mac_signing_key[CIFS_SESS_KEY_SIZE + 16];
165 * The following is our shortcut to user information. We surface the uid,
166 * and name. We always get the password on the fly in case it
167 * has changed. We also hang a list of sessions owned by this user off here.
170 struct list_head userList;
171 struct list_head sessionList; /* SMB sessions for this user */
173 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
174 /* BB may need ptr or callback for PAM or WinBind info */
178 * Session structure. One of these for each uid session with a particular host
181 struct list_head cifsSessionList;
182 struct semaphore sesSem;
184 struct cifsUidInfo *uidInfo; /* pointer to user info */
186 struct TCP_Server_Info *server; /* pointer to server info */
187 atomic_t inUse; /* # of mounts (tree connections) on this ses */
188 enum statusEnum status;
189 __u16 ipc_tid; /* special tid for connection to IPC share */
191 char *serverOS; /* name of operating system underlying server */
192 char *serverNOS; /* name of network operating system of server */
193 char *serverDomain; /* security realm of server */
194 int Suid; /* remote smb uid */
195 uid_t linux_uid; /* local Linux uid */
197 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
198 TCP names - will ipv6 and sctp addresses fit? */
199 char userName[MAX_USERNAME_SIZE + 1];
204 #define CIFS_SES_NT4 1
207 * there is one of these for each connection to a resource on a particular
210 struct cifsTconInfo {
211 struct list_head cifsConnectionList;
212 struct list_head openFileList;
213 struct semaphore tconSem;
214 struct cifsSesInfo *ses; /* pointer to session associated with */
215 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
216 char *nativeFileSystem;
217 __u16 tid; /* The 2 byte tree id */
218 __u16 Flags; /* optional support bits */
219 enum statusEnum tidStatus;
220 atomic_t useCount; /* how many explicit/implicit mounts to share */
221 #ifdef CONFIG_CIFS_STATS
222 atomic_t num_smbs_sent;
225 atomic_t num_oplock_brks;
228 atomic_t num_deletes;
231 atomic_t num_renames;
232 atomic_t num_t2renames;
236 atomic_t num_hardlinks;
237 atomic_t num_symlinks;
239 atomic_t num_acl_get;
240 atomic_t num_acl_set;
241 #ifdef CONFIG_CIFS_STATS2
242 unsigned long long time_writes;
243 unsigned long long time_reads;
244 unsigned long long time_opens;
245 unsigned long long time_deletes;
246 unsigned long long time_closes;
247 unsigned long long time_mkdirs;
248 unsigned long long time_rmdirs;
249 unsigned long long time_renames;
250 unsigned long long time_t2renames;
251 unsigned long long time_ffirst;
252 unsigned long long time_fnext;
253 unsigned long long time_fclose;
254 #endif /* CONFIG_CIFS_STATS2 */
257 spinlock_t stat_lock;
258 #endif /* CONFIG_CIFS_STATS */
259 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
260 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
261 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
264 /* BB add field for back pointer to sb struct? */
268 * This info hangs off the cifsFileInfo structure. This is used to track
269 * byte stream locks on the file
271 struct cifsLockInfo {
272 struct cifsLockInfo *next;
279 * One of these for each open instance of a file
281 struct cifs_search_info {
282 loff_t index_of_last_entry;
283 __u16 entries_in_buffer;
286 char * ntwrk_buf_start;
287 char * srch_entries_start;
289 unsigned int resume_name_len;
290 unsigned endOfSearch:1;
293 unsigned smallBuf:1; /* so we know which buf_release function to call */
296 struct cifsFileInfo {
297 struct list_head tlist; /* pointer to next fid owned by tcon */
298 struct list_head flist; /* next fid (file instance) for this inode */
299 unsigned int uid; /* allows finding which FileInfo structure */
300 __u32 pid; /* process id who opened file */
301 __u16 netfid; /* file id from remote */
302 /* BB add lock scope info here if needed */ ;
303 /* lock scope id (0 if none) */
304 struct file * pfile; /* needed for writepage */
305 struct inode * pInode; /* needed for oplock break */
306 unsigned closePend:1; /* file is marked to close */
307 unsigned invalidHandle:1; /* file closed via session abend */
308 atomic_t wrtPending; /* handle in use - defer close */
309 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
310 char * search_resume_name; /* BB removeme BB */
311 struct cifs_search_info srch_inf;
315 * One of these for each file inode
318 struct cifsInodeInfo {
319 struct list_head lockList;
320 /* BB add in lists for dirty pages - i.e. write caching info for oplock */
321 struct list_head openFileList;
323 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
324 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
325 unsigned long time; /* jiffies of last update/check of inode */
326 unsigned clientCanCacheRead:1; /* read oplock */
327 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
328 unsigned oplockPending:1;
329 struct inode vfs_inode;
332 static inline struct cifsInodeInfo *
333 CIFS_I(struct inode *inode)
335 return container_of(inode, struct cifsInodeInfo, vfs_inode);
338 static inline struct cifs_sb_info *
339 CIFS_SB(struct super_block *sb)
341 return sb->s_fs_info;
344 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
346 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
352 #ifdef CONFIG_CIFS_STATS
353 #define cifs_stats_inc atomic_inc
355 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
359 spin_lock(&tcon->stat_lock);
360 tcon->bytes_written += bytes;
361 spin_unlock(&tcon->stat_lock);
365 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
368 spin_lock(&tcon->stat_lock);
369 tcon->bytes_read += bytes;
370 spin_unlock(&tcon->stat_lock);
374 #define cifs_stats_inc(field) do {} while(0)
375 #define cifs_stats_bytes_written(tcon, bytes) do {} while(0)
376 #define cifs_stats_bytes_read(tcon, bytes) do {} while(0)
380 /* one of these for every pending CIFS request to the server */
382 struct list_head qhead; /* mids waiting on reply from this server */
383 __u16 mid; /* multiplex id */
384 __u16 pid; /* process id */
385 __u32 sequence_number; /* for CIFS signing */
386 unsigned long when_alloc; /* when mid was created */
387 #ifdef CONFIG_CIFS_STATS2
388 unsigned long when_sent; /* time when smb send finished */
389 unsigned long when_received; /* when demux complete (taken off wire) */
391 struct cifsSesInfo *ses; /* smb was sent to this server */
392 struct task_struct *tsk; /* task waiting for response */
393 struct smb_hdr *resp_buf; /* response buffer */
394 int midState; /* wish this were enum but can not pass to wait_event */
395 __u8 command; /* smb command code */
396 unsigned largeBuf:1; /* if valid response, is pointer to large buf */
397 unsigned multiRsp:1; /* multiple trans2 responses for one request */
398 unsigned multiEnd:1; /* both received */
401 struct oplock_q_entry {
402 struct list_head qhead;
403 struct inode * pinode;
404 struct cifsTconInfo * tcon;
408 /* for pending dnotify requests */
409 struct dir_notify_req {
410 struct list_head lhead;
417 __u32 filter; /* CompletionFilter (for multishot) */
423 #define MID_REQUEST_ALLOCATED 1
424 #define MID_REQUEST_SUBMITTED 2
425 #define MID_RESPONSE_RECEIVED 4
426 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
427 #define MID_NO_RESP_NEEDED 0x10
429 /* Types of response buffer returned from SendReceive2 */
430 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
431 #define CIFS_SMALL_BUFFER 1
432 #define CIFS_LARGE_BUFFER 2
433 #define CIFS_IOVEC 4 /* array of response buffers */
435 /* Security Flags: indicate type of session setup needed */
436 #define CIFSSEC_MAY_SIGN 0x00001
437 #define CIFSSEC_MAY_NTLM 0x00002
438 #define CIFSSEC_MAY_NTLMV2 0x00004
439 #define CIFSSEC_MAY_KRB5 0x00008
440 #ifdef CONFIG_CIFS_WEAK_PW_HASH
441 #define CIFSSEC_MAY_LANMAN 0x00010
442 #define CIFSSEC_MAY_PLNTXT 0x00020
443 #endif /* weak passwords */
444 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
446 #define CIFSSEC_MUST_SIGN 0x01001
447 /* note that only one of the following can be set so the
448 result of setting MUST flags more than once will be to
449 require use of the stronger protocol */
450 #define CIFSSEC_MUST_NTLM 0x02002
451 #define CIFSSEC_MUST_NTLMV2 0x04004
452 #define CIFSSEC_MUST_KRB5 0x08008
453 #ifdef CONFIG_CIFS_WEAK_PW_HASH
454 #define CIFSSEC_MUST_LANMAN 0x10010
455 #define CIFSSEC_MUST_PLNTXT 0x20020
456 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
458 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak config */
459 #endif /* WEAK_PW_HASH */
460 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
462 #define CIFSSEC_DEF CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2
463 #define CIFSSEC_MAX CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2
465 *****************************************************************
466 * All constants go here
467 *****************************************************************
470 #define UID_HASH (16)
473 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
474 * following to be declared.
477 /****************************************************************************
478 * Locking notes. All updates to global variables and lists should be
479 * protected by spinlocks or semaphores.
483 * GlobalMid_Lock protects:
484 * list operations on pending_mid_q and oplockQ
485 * updates to XID counters, multiplex id and SMB sequence numbers
486 * GlobalSMBSesLock protects:
487 * list operations on tcp and SMB session lists and tCon lists
488 * f_owner.lock protects certain per file struct operations
489 * mapping->page_lock protects certain per page operations
493 * sesSem operations on smb session
494 * tconSem operations on tree connection
495 * fh_sem file handle reconnection operations
497 ****************************************************************************/
499 #ifdef DECLARE_GLOBALS_HERE
500 #define GLOBAL_EXTERN
502 #define GLOBAL_EXTERN extern
506 * The list of servers that did not respond with NT LM 0.12.
507 * This list helps improve performance and eliminate the messages indicating
508 * that we had a communications error talking to the server in this list.
510 GLOBAL_EXTERN struct servers_not_supported *NotSuppList; /*@z4a */
513 * The following is a hash table of all the users we know about.
515 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
517 GLOBAL_EXTERN struct list_head GlobalServerList; /* BB not implemented yet */
518 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
519 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
520 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
522 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
524 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList; /* Outstanding dir notify requests */
525 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;/* DirNotify response queue */
528 * Global transaction id (XID) information
530 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
531 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
532 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
533 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
534 /* on midQ entries */
535 GLOBAL_EXTERN char Local_System_Name[15];
538 * Global counters, updated atomically
540 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
541 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
542 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
543 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
544 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
546 /* Various Debug counters to remove someday (BB) */
547 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
548 #ifdef CONFIG_CIFS_STATS2
549 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
550 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
552 GLOBAL_EXTERN atomic_t smBufAllocCount;
553 GLOBAL_EXTERN atomic_t midCount;
556 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
557 to be established on existing mount if we
558 have the uid/password or Kerberos credential
559 or equivalent for current user */
560 GLOBAL_EXTERN unsigned int oplockEnabled;
561 GLOBAL_EXTERN unsigned int experimEnabled;
562 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
563 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
564 with more secure ntlmssp2 challenge/resp */
565 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
566 GLOBAL_EXTERN unsigned int secFlags;
567 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
568 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
569 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
570 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
571 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/