4 * Copyright (C) International Business Machines Corp., 2002,2008
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 RFC1001_NAME_LEN 15
51 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
53 /* currently length of NIP6_FMT */
54 #define SERVER_NAME_LENGTH 40
55 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
57 /* used to define string lengths for reversing unicode strings */
59 /* (max path length + 1 for null) * 2 for unicode */
64 #ifndef XATTR_DOS_ATTRIB
65 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
69 * CIFS vfs client Status information (based on what we know.)
72 /* associated with each tcp and smb session */
81 PLAINTXT = 0, /* Legacy with Plaintext passwords */
82 LANMAN, /* Legacy LANMAN auth */
83 NTLM, /* Legacy NTLM012 auth with NTLM hash */
84 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
85 RawNTLMSSP, /* NTLMSSP without SPNEGO */
86 NTLMSSP, /* NTLMSSP via SPNEGO */
87 Kerberos, /* Kerberos via SPNEGO */
88 MSKerberos, /* MS Kerberos via SPNEGO */
94 /* Netbios frames protocol not supported at this time */
100 char ntlm[CIFS_SESS_KEY_SIZE + 16];
101 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
104 struct ntlmv2_resp resp;
114 struct cifs_sid osid;
115 struct cifs_sid gsid;
116 struct cifs_ntace *ntaces;
117 struct cifs_ace *aces;
121 *****************************************************************
122 * Except the CIFS PDUs themselves all the
123 * globally interesting structs should go here
124 *****************************************************************
127 struct TCP_Server_Info {
128 struct list_head tcp_ses_list;
129 struct list_head smb_ses_list;
130 int srv_count; /* reference counter */
131 /* 15 character server name + 0x20 16th byte indicating type = srv */
132 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
133 char *hostname; /* hostname portion of UNC string */
134 struct socket *ssocket;
136 struct sockaddr_in sockAddr;
137 struct sockaddr_in6 sockAddr6;
139 wait_queue_head_t response_q;
140 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
141 struct list_head pending_mid_q;
142 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
143 unsigned short server_codepage; /* codepage for the server */
144 unsigned long ip_address; /* IP addr for the server if known */
145 enum protocolEnum protocolType;
148 bool svlocal:1; /* local server or remote */
149 bool noblocksnd; /* use blocking sendmsg */
150 bool noautotune; /* do not autotune send buf sizes */
151 atomic_t inFlight; /* number of requests on the wire to server */
152 #ifdef CONFIG_CIFS_STATS2
153 atomic_t inSend; /* requests trying to send */
154 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
156 enum statusEnum tcpStatus; /* what we think the status is */
157 struct mutex srv_mutex;
158 struct task_struct *tsk;
159 char server_GUID[16];
161 enum securityEnum secType;
162 unsigned int maxReq; /* Clients should submit no more */
163 /* than maxReq distinct unanswered SMBs to the server when using */
164 /* multiplexed reads or writes */
165 unsigned int maxBuf; /* maxBuf specifies the maximum */
166 /* message size the server can send or receive for non-raw SMBs */
167 unsigned int max_rw; /* maxRw specifies the maximum */
168 /* message size the server can send or receive for */
169 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
170 unsigned int max_vcs; /* maximum number of smb sessions, at least
171 those that can be specified uniquely with
173 char sessid[4]; /* unique token id for this session */
174 /* (returned on Negotiate */
175 int capabilities; /* allow selective disabling of caps by smb sess */
176 int timeAdj; /* Adjust for difference in server time zone in sec */
177 __u16 CurrentMid; /* multiplex id - rotating counter */
178 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
179 /* 16th byte of RFC1001 workstation name is always null */
180 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
181 __u32 sequence_number; /* needed for CIFS PDU signature */
182 struct mac_key mac_signing_key;
183 char ntlmv2_hash[16];
184 unsigned long lstrp; /* when we got last response from this server */
188 * The following is our shortcut to user information. We surface the uid,
189 * and name. We always get the password on the fly in case it
190 * has changed. We also hang a list of sessions owned by this user off here.
193 struct list_head userList;
194 struct list_head sessionList; /* SMB sessions for this user */
196 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
197 /* BB may need ptr or callback for PAM or WinBind info */
201 * Session structure. One of these for each uid session with a particular host
204 struct list_head smb_ses_list;
205 struct list_head tcon_list;
206 struct semaphore sesSem;
208 struct cifsUidInfo *uidInfo; /* pointer to user info */
210 struct TCP_Server_Info *server; /* pointer to server info */
211 int ses_count; /* reference counter */
212 enum statusEnum status;
213 unsigned overrideSecFlg; /* if non-zero override global sec flags */
214 __u16 ipc_tid; /* special tid for connection to IPC share */
217 char *serverOS; /* name of operating system underlying server */
218 char *serverNOS; /* name of network operating system of server */
219 char *serverDomain; /* security realm of server */
220 int Suid; /* remote smb uid */
221 uid_t linux_uid; /* local Linux uid */
223 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
224 TCP names - will ipv6 and sctp addresses fit? */
225 char userName[MAX_USERNAME_SIZE + 1];
228 bool need_reconnect:1; /* connection reset, uid now invalid */
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 tcon_list;
245 struct list_head openFileList;
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 char *password; /* for share-level security */
250 __u16 tid; /* The 2 byte tree id */
251 __u16 Flags; /* optional support bits */
252 enum statusEnum tidStatus;
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 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
297 bool seal:1; /* transport encryption for this mounted share */
298 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
299 for this mount even if server would support */
300 bool local_lease:1; /* check leases (only) on local system not remote */
301 bool need_reconnect:1; /* connection reset, tid now invalid */
302 /* BB add field for back pointer to sb struct(s)? */
306 * This info hangs off the cifsFileInfo structure, pointed to by llist.
307 * This is used to track byte stream locks on the file
309 struct cifsLockInfo {
310 struct list_head llist; /* pointer to next cifsLockInfo */
317 * One of these for each open instance of a file
319 struct cifs_search_info {
320 loff_t index_of_last_entry;
321 __u16 entries_in_buffer;
324 char *ntwrk_buf_start;
325 char *srch_entries_start;
328 unsigned int resume_name_len;
332 bool smallBuf:1; /* so we know which buf_release function to call */
335 struct cifsFileInfo {
336 struct list_head tlist; /* pointer to next fid owned by tcon */
337 struct list_head flist; /* next fid (file instance) for this inode */
338 unsigned int uid; /* allows finding which FileInfo structure */
339 __u32 pid; /* process id who opened file */
340 __u16 netfid; /* file id from remote */
341 /* BB add lock scope info here if needed */ ;
342 /* lock scope id (0 if none) */
343 struct file *pfile; /* needed for writepage */
344 struct inode *pInode; /* needed for oplock break */
345 struct mutex lock_mutex;
346 struct list_head llist; /* list of byte range locks we have. */
347 bool closePend:1; /* file is marked to close */
348 bool invalidHandle:1; /* file closed via session abend */
349 bool messageMode:1; /* for pipes: message vs byte mode */
350 atomic_t wrtPending; /* handle in use - defer close */
351 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
352 struct cifs_search_info srch_inf;
356 * One of these for each file inode
359 struct cifsInodeInfo {
360 struct list_head lockList;
361 /* BB add in lists for dirty pages i.e. write caching info for oplock */
362 struct list_head openFileList;
364 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
365 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
366 unsigned long time; /* jiffies of last update/check of inode */
367 bool clientCanCacheRead:1; /* read oplock */
368 bool clientCanCacheAll:1; /* read and writebehind oplock */
369 bool oplockPending:1;
370 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
371 struct inode vfs_inode;
374 static inline struct cifsInodeInfo *
375 CIFS_I(struct inode *inode)
377 return container_of(inode, struct cifsInodeInfo, vfs_inode);
380 static inline struct cifs_sb_info *
381 CIFS_SB(struct super_block *sb)
383 return sb->s_fs_info;
386 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
388 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
394 #ifdef CONFIG_CIFS_STATS
395 #define cifs_stats_inc atomic_inc
397 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
401 spin_lock(&tcon->stat_lock);
402 tcon->bytes_written += bytes;
403 spin_unlock(&tcon->stat_lock);
407 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
410 spin_lock(&tcon->stat_lock);
411 tcon->bytes_read += bytes;
412 spin_unlock(&tcon->stat_lock);
416 #define cifs_stats_inc(field) do {} while (0)
417 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
418 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
422 /* one of these for every pending CIFS request to the server */
424 struct list_head qhead; /* mids waiting on reply from this server */
425 __u16 mid; /* multiplex id */
426 __u16 pid; /* process id */
427 __u32 sequence_number; /* for CIFS signing */
428 unsigned long when_alloc; /* when mid was created */
429 #ifdef CONFIG_CIFS_STATS2
430 unsigned long when_sent; /* time when smb send finished */
431 unsigned long when_received; /* when demux complete (taken off wire) */
433 struct task_struct *tsk; /* task waiting for response */
434 struct smb_hdr *resp_buf; /* response buffer */
435 int midState; /* wish this were enum but can not pass to wait_event */
436 __u8 command; /* smb command code */
437 bool largeBuf:1; /* if valid response, is pointer to large buf */
438 bool multiRsp:1; /* multiple trans2 responses for one request */
439 bool multiEnd:1; /* both received */
442 struct oplock_q_entry {
443 struct list_head qhead;
444 struct inode *pinode;
445 struct cifsTconInfo *tcon;
449 /* for pending dnotify requests */
450 struct dir_notify_req {
451 struct list_head lhead;
458 __u32 filter; /* CompletionFilter (for multishot) */
463 struct dfs_info3_param {
464 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
472 static inline void free_dfs_info_param(struct dfs_info3_param *param)
475 kfree(param->path_name);
476 kfree(param->node_name);
481 static inline void free_dfs_info_array(struct dfs_info3_param *param,
485 if ((number_of_items == 0) || (param == NULL))
487 for (i = 0; i < number_of_items; i++) {
488 kfree(param[i].path_name);
489 kfree(param[i].node_name);
495 #define MID_REQUEST_ALLOCATED 1
496 #define MID_REQUEST_SUBMITTED 2
497 #define MID_RESPONSE_RECEIVED 4
498 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
499 #define MID_NO_RESP_NEEDED 0x10
501 /* Types of response buffer returned from SendReceive2 */
502 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
503 #define CIFS_SMALL_BUFFER 1
504 #define CIFS_LARGE_BUFFER 2
505 #define CIFS_IOVEC 4 /* array of response buffers */
507 /* Type of Request to SendReceive2 */
508 #define CIFS_STD_OP 0 /* normal request timeout */
509 #define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
510 #define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
511 #define CIFS_BLOCKING_OP 4 /* operation can block */
512 #define CIFS_ASYNC_OP 8 /* do not wait for response */
513 #define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
514 #define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
515 #define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
516 #define CIFS_NO_RESP 0x040 /* no response buffer required */
518 /* Security Flags: indicate type of session setup needed */
519 #define CIFSSEC_MAY_SIGN 0x00001
520 #define CIFSSEC_MAY_NTLM 0x00002
521 #define CIFSSEC_MAY_NTLMV2 0x00004
522 #define CIFSSEC_MAY_KRB5 0x00008
523 #ifdef CONFIG_CIFS_WEAK_PW_HASH
524 #define CIFSSEC_MAY_LANMAN 0x00010
525 #define CIFSSEC_MAY_PLNTXT 0x00020
527 #define CIFSSEC_MAY_LANMAN 0
528 #define CIFSSEC_MAY_PLNTXT 0
529 #endif /* weak passwords */
530 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
532 #define CIFSSEC_MUST_SIGN 0x01001
533 /* note that only one of the following can be set so the
534 result of setting MUST flags more than once will be to
535 require use of the stronger protocol */
536 #define CIFSSEC_MUST_NTLM 0x02002
537 #define CIFSSEC_MUST_NTLMV2 0x04004
538 #define CIFSSEC_MUST_KRB5 0x08008
539 #ifdef CONFIG_CIFS_WEAK_PW_HASH
540 #define CIFSSEC_MUST_LANMAN 0x10010
541 #define CIFSSEC_MUST_PLNTXT 0x20020
542 #ifdef CONFIG_CIFS_UPCALL
543 #define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
545 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
547 #else /* do not allow weak pw hash */
548 #ifdef CONFIG_CIFS_UPCALL
549 #define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
551 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
553 #endif /* WEAK_PW_HASH */
554 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
556 #define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
557 #define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
558 #define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
560 *****************************************************************
561 * All constants go here
562 *****************************************************************
565 #define UID_HASH (16)
568 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
569 * following to be declared.
572 /****************************************************************************
573 * Locking notes. All updates to global variables and lists should be
574 * protected by spinlocks or semaphores.
578 * GlobalMid_Lock protects:
579 * list operations on pending_mid_q and oplockQ
580 * updates to XID counters, multiplex id and SMB sequence numbers
581 * GlobalSMBSesLock protects:
582 * list operations on tcp and SMB session lists and tCon lists
583 * f_owner.lock protects certain per file struct operations
584 * mapping->page_lock protects certain per page operations
588 * sesSem operations on smb session
589 * tconSem operations on tree connection
590 * fh_sem file handle reconnection operations
592 ****************************************************************************/
594 #ifdef DECLARE_GLOBALS_HERE
595 #define GLOBAL_EXTERN
597 #define GLOBAL_EXTERN extern
601 * the list of TCP_Server_Info structures, ie each of the sockets
602 * connecting our client to a distinct server (ip address), is
603 * chained together by cifs_tcp_ses_list. The list of all our SMB
604 * sessions (and from that the tree connections) can be found
605 * by iterating over cifs_tcp_ses_list
607 GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
610 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
611 * tcp session, and the list of tcon's per smb session. It also protects
612 * the reference counters for the server, smb session, and tcon. Finally,
613 * changes to the tcon->tidStatus should be done while holding this lock.
615 GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
618 * This lock protects the cifs_file->llist and cifs_file->flist
619 * list operations, and updates to some flags (cifs_file->invalidHandle)
620 * It will be moved to either use the tcon->stat_lock or equivalent later.
621 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
622 * the cifs_tcp_ses_lock must be grabbed first and released last.
624 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
626 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
628 /* Outstanding dir notify requests */
629 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
630 /* DirNotify response queue */
631 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
634 * Global transaction id (XID) information
636 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
637 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
638 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
639 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
640 /* on midQ entries */
641 GLOBAL_EXTERN char Local_System_Name[15];
644 * Global counters, updated atomically
646 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
647 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
648 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
649 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
650 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
652 /* Various Debug counters */
653 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
654 #ifdef CONFIG_CIFS_STATS2
655 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
656 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
658 GLOBAL_EXTERN atomic_t smBufAllocCount;
659 GLOBAL_EXTERN atomic_t midCount;
662 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
663 to be established on existing mount if we
664 have the uid/password or Kerberos credential
665 or equivalent for current user */
666 GLOBAL_EXTERN unsigned int oplockEnabled;
667 GLOBAL_EXTERN unsigned int experimEnabled;
668 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
669 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
670 with more secure ntlmssp2 challenge/resp */
671 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
672 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
673 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
674 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
675 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
676 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/