blob: a88479ceaad59602919d3d6d1a1c7a01855d69ac [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/cifs/cifsglob.h
3 *
Steve French366781c2008-01-25 10:12:41 +00004 * Copyright (C) International Business Machines Corp., 2002,2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Author(s): Steve French (sfrench@us.ibm.com)
Jeremy Allison7ee1af72006-08-02 21:56:33 +00006 * Jeremy Allison (jra@samba.org)
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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.
12 *
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.
Steve Frenchd38d8c72007-06-28 19:44:13 +000017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
19#include <linux/in.h>
20#include <linux/in6.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/slab.h>
Jeff Layton3bc303c2009-09-21 06:47:50 -040022#include <linux/slow-work.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include "cifs_fs_sb.h"
Steve French442aa312007-09-24 20:25:46 +000024#include "cifsacl.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025/*
26 * The sizes of various internal tables and strings
27 */
28#define MAX_UID_INFO 16
29#define MAX_SES_INFO 2
30#define MAX_TCON_INFO 4
31
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +000032#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define MAX_SERVER_SIZE 15
Steve Frenchd38d8c72007-06-28 19:44:13 +000034#define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
36 termination then *2 for unicode versions */
37#define MAX_PASSWORD_SIZE 16
38
39#define CIFS_MIN_RCV_POOL 4
40
41/*
42 * MAX_REQ is the maximum number of requests that WE will send
André Goddard Rosaaf901ca2009-11-14 13:09:05 -020043 * on one socket concurrently. It also matches the most common
Steve Frenchd38d8c72007-06-28 19:44:13 +000044 * value of max multiplex returned by servers. We may
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * eventually want to use the negotiated value (in case
46 * future servers can handle more) when we are more confident that
47 * we will not have problems oveloading the socket with pending
48 * write data.
49 */
Steve Frenchd38d8c72007-06-28 19:44:13 +000050#define CIFS_MAX_REQ 50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Jeff Layton8ecaf672008-12-01 15:23:50 -050052#define RFC1001_NAME_LEN 15
53#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
54
55/* currently length of NIP6_FMT */
56#define SERVER_NAME_LENGTH 40
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
58
59/* used to define string lengths for reversing unicode strings */
60/* (256+1)*2 = 514 */
61/* (max path length + 1 for null) * 2 for unicode */
62#define MAX_NAME 514
63
64#include "cifspdu.h"
65
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#ifndef XATTR_DOS_ATTRIB
67#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
68#endif
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * CIFS vfs client Status information (based on what we know.)
72 */
73
74 /* associated with each tcp and smb session */
75enum statusEnum {
76 CifsNew = 0,
77 CifsGood,
78 CifsExiting,
79 CifsNeedReconnect
80};
81
82enum securityEnum {
Steve Frencha0136892007-10-04 20:05:09 +000083 PLAINTXT = 0, /* Legacy with Plaintext passwords */
84 LANMAN, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +000085 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +000087 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchf46c7232009-06-25 03:04:20 +000088/* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
Steve Frenchc16fefa2008-08-19 19:35:33 +000089 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090};
91
92enum protocolEnum {
Steve French3ec332e2008-11-14 03:35:10 +000093 TCP = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 SCTP
95 /* Netbios frames protocol not supported at this time */
96};
97
Steve Frenchb609f062007-07-09 07:55:14 +000098struct mac_key {
99 unsigned int len;
100 union {
101 char ntlm[CIFS_SESS_KEY_SIZE + 16];
Steve French24424212007-11-16 23:37:35 +0000102 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
Steve Frenchb609f062007-07-09 07:55:14 +0000103 struct {
104 char key[16];
105 struct ntlmv2_resp resp;
106 } ntlmv2;
107 } data;
108};
109
Steve French442aa312007-09-24 20:25:46 +0000110struct cifs_cred {
111 int uid;
112 int gid;
113 int mode;
114 int cecount;
115 struct cifs_sid osid;
116 struct cifs_sid gsid;
117 struct cifs_ntace *ntaces;
118 struct cifs_ace *aces;
119};
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121/*
122 *****************************************************************
123 * Except the CIFS PDUs themselves all the
124 * globally interesting structs should go here
125 *****************************************************************
126 */
127
128struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000129 struct list_head tcp_ses_list;
130 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500131 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700132 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500133 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytonc359cf32007-11-16 22:22:06 +0000134 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 struct socket *ssocket;
136 union {
137 struct sockaddr_in sockAddr;
138 struct sockaddr_in6 sockAddr6;
139 } addr;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000140 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
142 struct list_head pending_mid_q;
143 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
144 unsigned short server_codepage; /* codepage for the server */
Steve French131afd0b2005-10-07 09:51:05 -0700145 unsigned long ip_address; /* IP addr for the server if known */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000146 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 char versionMajor;
148 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000149 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000150 bool noblocksnd; /* use blocking sendmsg */
151 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000152 bool tcp_nodelay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd0b2005-10-07 09:51:05 -0700154#ifdef CONFIG_CIFS_STATS2
155 atomic_t inSend; /* requests trying to send */
156 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
157#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500159 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 struct task_struct *tsk;
161 char server_GUID[16];
162 char secMode;
163 enum securityEnum secType;
164 unsigned int maxReq; /* Clients should submit no more */
165 /* than maxReq distinct unanswered SMBs to the server when using */
166 /* multiplexed reads or writes */
167 unsigned int maxBuf; /* maxBuf specifies the maximum */
168 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000169 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 /* message size the server can send or receive for */
171 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000172 unsigned int max_vcs; /* maximum number of smb sessions, at least
173 those that can be specified uniquely with
174 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 char sessid[4]; /* unique token id for this session */
176 /* (returned on Negotiate */
177 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000178 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700179 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700181 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500182 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700183 __u32 sequence_number; /* needed for CIFS PDU signature */
Steve Frenchb609f062007-07-09 07:55:14 +0000184 struct mac_key mac_signing_key;
185 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000186 unsigned long lstrp; /* when we got last response from this server */
Jeff Layton9bf67e52010-04-24 07:57:46 -0400187 u16 dialect; /* dialect index that server chose */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400188 /* extended security flavors that server supports */
189 bool sec_kerberos; /* supports plain Kerberos */
190 bool sec_mskerberos; /* supports legacy MS Kerberos */
191 bool sec_kerberosu2u; /* supports U2U Kerberos */
192 bool sec_ntlmssp; /* supports NTLMSSP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193};
194
195/*
196 * The following is our shortcut to user information. We surface the uid,
197 * and name. We always get the password on the fly in case it
Steve Frenchd38d8c72007-06-28 19:44:13 +0000198 * has changed. We also hang a list of sessions owned by this user off here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 */
200struct cifsUidInfo {
201 struct list_head userList;
202 struct list_head sessionList; /* SMB sessions for this user */
203 uid_t linux_uid;
204 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
205 /* BB may need ptr or callback for PAM or WinBind info */
206};
207
208/*
209 * Session structure. One of these for each uid session with a particular host
210 */
211struct cifsSesInfo {
Jeff Layton14fbf502008-11-14 13:53:46 -0500212 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000213 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000214 struct mutex session_mutex;
Steve French39798772006-05-31 22:40:51 +0000215#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 struct cifsUidInfo *uidInfo; /* pointer to user info */
Steve French39798772006-05-31 22:40:51 +0000217#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500219 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000221 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 __u16 ipc_tid; /* special tid for connection to IPC share */
223 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000224 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700225 char *serverOS; /* name of operating system underlying server */
226 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 char *serverDomain; /* security realm of server */
228 int Suid; /* remote smb uid */
229 uid_t linux_uid; /* local Linux uid */
230 int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000231 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700232 TCP names - will ipv6 and sctp addresses fit? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 char userName[MAX_USERNAME_SIZE + 1];
Steve Frenchd38d8c72007-06-28 19:44:13 +0000234 char *domainName;
235 char *password;
Steve French3b795212008-11-13 19:45:32 +0000236 bool need_reconnect:1; /* connection reset, uid now invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237};
Steve French9ac00b72006-09-30 04:13:17 +0000238/* no more than one of the following three session flags may be set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239#define CIFS_SES_NT4 1
Steve French9ac00b72006-09-30 04:13:17 +0000240#define CIFS_SES_OS2 2
241#define CIFS_SES_W9X 4
242/* following flag is set for old servers such as OS2 (and Win95?)
243 which do not negotiate NTLM or POSIX dialects, but instead
244 negotiate one of the older LANMAN dialects */
245#define CIFS_SES_LANMAN 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246/*
247 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +0000248 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 */
250struct cifsTconInfo {
Jeff Laytonf1987b42008-11-15 11:12:47 -0500251 struct list_head tcon_list;
252 int tc_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 struct list_head openFileList;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 struct cifsSesInfo *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +0000255 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -0500257 char *password; /* for share-level security */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 __u16 tid; /* The 2 byte tree id */
259 __u16 Flags; /* optional support bits */
260 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261#ifdef CONFIG_CIFS_STATS
262 atomic_t num_smbs_sent;
263 atomic_t num_writes;
264 atomic_t num_reads;
Steve Frenchb298f222009-02-21 21:17:43 +0000265 atomic_t num_flushes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 atomic_t num_oplock_brks;
267 atomic_t num_opens;
Steve Frencha5a2b482005-08-20 21:42:53 -0700268 atomic_t num_closes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 atomic_t num_deletes;
270 atomic_t num_mkdirs;
Steve French65bc98b2009-07-10 15:27:25 +0000271 atomic_t num_posixopens;
272 atomic_t num_posixmkdirs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 atomic_t num_rmdirs;
274 atomic_t num_renames;
275 atomic_t num_t2renames;
Steve Frenchdfb75332005-06-22 17:13:47 -0700276 atomic_t num_ffirst;
277 atomic_t num_fnext;
278 atomic_t num_fclose;
Steve Frencha5a2b482005-08-20 21:42:53 -0700279 atomic_t num_hardlinks;
280 atomic_t num_symlinks;
281 atomic_t num_locks;
Steve French0a4b92c2006-01-12 15:44:21 -0800282 atomic_t num_acl_get;
283 atomic_t num_acl_set;
Steve Frencha5a2b482005-08-20 21:42:53 -0700284#ifdef CONFIG_CIFS_STATS2
285 unsigned long long time_writes;
286 unsigned long long time_reads;
287 unsigned long long time_opens;
288 unsigned long long time_deletes;
289 unsigned long long time_closes;
290 unsigned long long time_mkdirs;
291 unsigned long long time_rmdirs;
292 unsigned long long time_renames;
293 unsigned long long time_t2renames;
294 unsigned long long time_ffirst;
295 unsigned long long time_fnext;
296 unsigned long long time_fclose;
297#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 __u64 bytes_read;
299 __u64 bytes_written;
300 spinlock_t stat_lock;
Steve Frencha5a2b482005-08-20 21:42:53 -0700301#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000303 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000305 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
306 bool retry:1;
307 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000308 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000309 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000310 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000311 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +0000312 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3b795212008-11-13 19:45:32 +0000313 bool need_reconnect:1; /* connection reset, tid now invalid */
Steve Frenchc18c8422007-07-18 23:21:09 +0000314 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315};
316
317/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000318 * This info hangs off the cifsFileInfo structure, pointed to by llist.
319 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 */
321struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000322 struct list_head llist; /* pointer to next cifsLockInfo */
323 __u64 offset;
324 __u64 length;
325 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
328/*
329 * One of these for each open instance of a file
330 */
331struct cifs_search_info {
332 loff_t index_of_last_entry;
333 __u16 entries_in_buffer;
334 __u16 info_level;
335 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000336 char *ntwrk_buf_start;
337 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000338 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000339 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000341 bool endOfSearch:1;
342 bool emptyDir:1;
343 bool unicode:1;
344 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345};
346
347struct cifsFileInfo {
348 struct list_head tlist; /* pointer to next fid owned by tcon */
349 struct list_head flist; /* next fid (file instance) for this inode */
350 unsigned int uid; /* allows finding which FileInfo structure */
351 __u32 pid; /* process id who opened file */
352 __u16 netfid; /* file id from remote */
353 /* BB add lock scope info here if needed */ ;
354 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000355 struct file *pfile; /* needed for writepage */
356 struct inode *pInode; /* needed for oplock break */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400357 struct vfsmount *mnt;
Roland Dreier796e5662007-05-03 04:33:45 +0000358 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000359 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000360 bool closePend:1; /* file is marked to close */
361 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400362 bool oplock_break_cancelled:1;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400363 atomic_t count; /* reference count */
Steve Frencha6ce4932009-04-09 01:14:32 +0000364 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 struct cifs_search_info srch_inf;
Jeff Layton3bc303c2009-09-21 06:47:50 -0400366 struct slow_work oplock_break; /* slow_work job for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367};
368
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400369/* Take a reference on the file private data */
370static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
371{
372 atomic_inc(&cifs_file->count);
373}
374
375/* Release a reference on the file private data */
376static inline void cifsFileInfo_put(struct cifsFileInfo *cifs_file)
377{
Jeff Layton48541bd2009-09-12 11:54:29 -0400378 if (atomic_dec_and_test(&cifs_file->count)) {
379 iput(cifs_file->pInode);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400380 kfree(cifs_file);
Jeff Layton48541bd2009-09-12 11:54:29 -0400381 }
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400382}
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/*
385 * One of these for each file inode
386 */
387
388struct cifsInodeInfo {
389 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000390 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 struct list_head openFileList;
392 int write_behind_rc;
393 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000395 bool clientCanCacheRead:1; /* read oplock */
396 bool clientCanCacheAll:1; /* read and writebehind oplock */
Jeff Layton9a8165f2008-10-17 21:03:20 -0400397 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Jeff Laytondf2cf172010-02-12 07:44:16 -0500398 bool invalid_mapping:1; /* pagecache is invalid */
Jeff Laytonfbec9ab2009-04-03 13:44:00 -0400399 u64 server_eof; /* current file size on server */
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400400 u64 uniqueid; /* server inode number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 struct inode vfs_inode;
402};
403
404static inline struct cifsInodeInfo *
405CIFS_I(struct inode *inode)
406{
407 return container_of(inode, struct cifsInodeInfo, vfs_inode);
408}
409
410static inline struct cifs_sb_info *
411CIFS_SB(struct super_block *sb)
412{
413 return sb->s_fs_info;
414}
415
Steve Frenchab2f2182005-09-15 20:44:50 -0700416static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700417{
418 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
419 return '/';
420 else
421 return '\\';
422}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Steve Frencha4544342005-08-24 13:59:35 -0700424#ifdef CONFIG_CIFS_STATS
425#define cifs_stats_inc atomic_inc
426
427static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
428 unsigned int bytes)
429{
430 if (bytes) {
431 spin_lock(&tcon->stat_lock);
432 tcon->bytes_written += bytes;
433 spin_unlock(&tcon->stat_lock);
434 }
435}
436
437static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
438 unsigned int bytes)
439{
440 spin_lock(&tcon->stat_lock);
441 tcon->bytes_read += bytes;
442 spin_unlock(&tcon->stat_lock);
443}
444#else
445
Steve Frenchd38d8c72007-06-28 19:44:13 +0000446#define cifs_stats_inc(field) do {} while (0)
447#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
448#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700449
450#endif
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452/* one of these for every pending CIFS request to the server */
453struct mid_q_entry {
454 struct list_head qhead; /* mids waiting on reply from this server */
455 __u16 mid; /* multiplex id */
456 __u16 pid; /* process id */
457 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700458 unsigned long when_alloc; /* when mid was created */
459#ifdef CONFIG_CIFS_STATS2
460 unsigned long when_sent; /* time when smb send finished */
461 unsigned long when_received; /* when demux complete (taken off wire) */
462#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 struct task_struct *tsk; /* task waiting for response */
464 struct smb_hdr *resp_buf; /* response buffer */
465 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700466 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000467 bool largeBuf:1; /* if valid response, is pointer to large buf */
468 bool multiRsp:1; /* multiple trans2 responses for one request */
469 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470};
471
472struct oplock_q_entry {
473 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000474 struct inode *pinode;
475 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 __u16 netfid;
477};
478
Steve Frenchff5dbd92005-08-24 17:10:36 -0700479/* for pending dnotify requests */
480struct dir_notify_req {
481 struct list_head lhead;
482 __le16 Pid;
483 __le16 PidHigh;
484 __u16 Mid;
485 __u16 Tid;
486 __u16 Uid;
487 __u16 netfid;
488 __u32 filter; /* CompletionFilter (for multishot) */
489 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000490 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700491};
492
Steve French366781c2008-01-25 10:12:41 +0000493struct dfs_info3_param {
494 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000495 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000496 int server_type;
497 int ref_flag;
498 char *path_name;
499 char *node_name;
500};
501
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400502/*
503 * common struct for holding inode info when searching for or updating an
504 * inode with new info
505 */
506
507#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -0400508#define CIFS_FATTR_DELETE_PENDING 0x2
509#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -0400510#define CIFS_FATTR_INO_COLLISION 0x8
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400511
512struct cifs_fattr {
513 u32 cf_flags;
514 u32 cf_cifsattrs;
515 u64 cf_uniqueid;
516 u64 cf_eof;
517 u64 cf_bytes;
518 uid_t cf_uid;
519 gid_t cf_gid;
520 umode_t cf_mode;
521 dev_t cf_rdev;
522 unsigned int cf_nlink;
523 unsigned int cf_dtype;
524 struct timespec cf_atime;
525 struct timespec cf_mtime;
526 struct timespec cf_ctime;
527};
528
Steve French366781c2008-01-25 10:12:41 +0000529static inline void free_dfs_info_param(struct dfs_info3_param *param)
530{
531 if (param) {
532 kfree(param->path_name);
533 kfree(param->node_name);
534 kfree(param);
535 }
536}
537
538static inline void free_dfs_info_array(struct dfs_info3_param *param,
539 int number_of_items)
540{
541 int i;
542 if ((number_of_items == 0) || (param == NULL))
543 return;
544 for (i = 0; i < number_of_items; i++) {
545 kfree(param[i].path_name);
546 kfree(param[i].node_name);
547 }
548 kfree(param);
549}
550
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551#define MID_FREE 0
552#define MID_REQUEST_ALLOCATED 1
553#define MID_REQUEST_SUBMITTED 2
554#define MID_RESPONSE_RECEIVED 4
555#define MID_RETRY_NEEDED 8 /* session closed while this request out */
556#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800557
558/* Types of response buffer returned from SendReceive2 */
559#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
560#define CIFS_SMALL_BUFFER 1
561#define CIFS_LARGE_BUFFER 2
562#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Steve French133672e2007-11-13 22:41:37 +0000564/* Type of Request to SendReceive2 */
565#define CIFS_STD_OP 0 /* normal request timeout */
566#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
567#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
568#define CIFS_BLOCKING_OP 4 /* operation can block */
569#define CIFS_ASYNC_OP 8 /* do not wait for response */
570#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
571#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
572#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
573#define CIFS_NO_RESP 0x040 /* no response buffer required */
574
Steve French39798772006-05-31 22:40:51 +0000575/* Security Flags: indicate type of session setup needed */
576#define CIFSSEC_MAY_SIGN 0x00001
577#define CIFSSEC_MAY_NTLM 0x00002
578#define CIFSSEC_MAY_NTLMV2 0x00004
579#define CIFSSEC_MAY_KRB5 0x00008
580#ifdef CONFIG_CIFS_WEAK_PW_HASH
581#define CIFSSEC_MAY_LANMAN 0x00010
582#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000583#else
584#define CIFSSEC_MAY_LANMAN 0
585#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000586#endif /* weak passwords */
587#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000588#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +0000589
Steve French39798772006-05-31 22:40:51 +0000590#define CIFSSEC_MUST_SIGN 0x01001
591/* note that only one of the following can be set so the
592result of setting MUST flags more than once will be to
593require use of the stronger protocol */
594#define CIFSSEC_MUST_NTLM 0x02002
595#define CIFSSEC_MUST_NTLMV2 0x04004
596#define CIFSSEC_MUST_KRB5 0x08008
597#ifdef CONFIG_CIFS_WEAK_PW_HASH
598#define CIFSSEC_MUST_LANMAN 0x10010
599#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000600#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -0400601#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000602#else
Chuck Ebbert20d17522009-09-15 01:53:21 -0400603#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000604#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000605#else /* do not allow weak pw hash */
606#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +0000607#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000608#else
Steve Frenchac683922009-05-06 04:16:04 +0000609#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000610#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000611#endif /* WEAK_PW_HASH */
612#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000613#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +0000614
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000615#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
616#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +0000617#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618/*
619 *****************************************************************
620 * All constants go here
621 *****************************************************************
622 */
623
624#define UID_HASH (16)
625
626/*
627 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
628 * following to be declared.
629 */
630
631/****************************************************************************
632 * Locking notes. All updates to global variables and lists should be
633 * protected by spinlocks or semaphores.
634 *
635 * Spinlocks
636 * ---------
637 * GlobalMid_Lock protects:
638 * list operations on pending_mid_q and oplockQ
639 * updates to XID counters, multiplex id and SMB sequence numbers
640 * GlobalSMBSesLock protects:
641 * list operations on tcp and SMB session lists and tCon lists
642 * f_owner.lock protects certain per file struct operations
643 * mapping->page_lock protects certain per page operations
644 *
645 * Semaphores
646 * ----------
647 * sesSem operations on smb session
648 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000649 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 *
651 ****************************************************************************/
652
653#ifdef DECLARE_GLOBALS_HERE
654#define GLOBAL_EXTERN
655#else
656#define GLOBAL_EXTERN extern
657#endif
658
Jeff Laytone7ddee92008-11-14 13:44:38 -0500659/*
660 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000661 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500662 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000663 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500664 * by iterating over cifs_tcp_ses_list
665 */
666GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
667
Jeff Laytonf1987b42008-11-15 11:12:47 -0500668/*
669 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
670 * tcp session, and the list of tcon's per smb session. It also protects
671 * the reference counters for the server, smb session, and tcon. Finally,
672 * changes to the tcon->tidStatus should be done while holding this lock.
673 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500674GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000675
676/*
677 * This lock protects the cifs_file->llist and cifs_file->flist
678 * list operations, and updates to some flags (cifs_file->invalidHandle)
679 * It will be moved to either use the tcon->stat_lock or equivalent later.
680 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
681 * the cifs_tcp_ses_lock must be grabbed first and released last.
682 */
683GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Steve French99ee4db2007-02-27 05:35:17 +0000685/* Outstanding dir notify requests */
686GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
687/* DirNotify response queue */
688GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690/*
691 * Global transaction id (XID) information
692 */
693GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000694GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000696GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
697 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698GLOBAL_EXTERN char Local_System_Name[15];
699
700/*
701 * Global counters, updated atomically
702 */
703GLOBAL_EXTERN atomic_t sesInfoAllocCount;
704GLOBAL_EXTERN atomic_t tconInfoAllocCount;
705GLOBAL_EXTERN atomic_t tcpSesAllocCount;
706GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
707GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
708
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000709/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -0800710GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
711#ifdef CONFIG_CIFS_STATS2
712GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
713GLOBAL_EXTERN atomic_t totSmBufAllocCount;
714#endif
715GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716GLOBAL_EXTERN atomic_t midCount;
717
718/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000719GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000721 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 or equivalent for current user */
723GLOBAL_EXTERN unsigned int oplockEnabled;
724GLOBAL_EXTERN unsigned int experimEnabled;
725GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -0400726GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
730GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
731GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
732GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
733GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
734
Jeff Layton3bc303c2009-09-21 06:47:50 -0400735extern const struct slow_work_ops cifs_oplock_break_ops;