blob: 6b2c39d809fb611d925c7818bf9e682330248781 [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 */
Suresh Jayaramanabd2e442010-06-22 20:52:50 +053019#ifndef _CIFS_GLOB_H
20#define _CIFS_GLOB_H
21
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/in.h>
23#include <linux/in6.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090024#include <linux/slab.h>
Jeff Layton3bc303c2009-09-21 06:47:50 -040025#include <linux/slow-work.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include "cifs_fs_sb.h"
Steve French442aa312007-09-24 20:25:46 +000027#include "cifsacl.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028/*
29 * The sizes of various internal tables and strings
30 */
31#define MAX_UID_INFO 16
32#define MAX_SES_INFO 2
33#define MAX_TCON_INFO 4
34
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +000035#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#define MAX_SERVER_SIZE 15
Steve Frenchd38d8c72007-06-28 19:44:13 +000037#define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
39 termination then *2 for unicode versions */
40#define MAX_PASSWORD_SIZE 16
41
42#define CIFS_MIN_RCV_POOL 4
43
44/*
45 * MAX_REQ is the maximum number of requests that WE will send
André Goddard Rosaaf901ca2009-11-14 13:09:05 -020046 * on one socket concurrently. It also matches the most common
Steve Frenchd38d8c72007-06-28 19:44:13 +000047 * value of max multiplex returned by servers. We may
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 * eventually want to use the negotiated value (in case
49 * future servers can handle more) when we are more confident that
50 * we will not have problems oveloading the socket with pending
51 * write data.
52 */
Steve Frenchd38d8c72007-06-28 19:44:13 +000053#define CIFS_MAX_REQ 50
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Jeff Layton8ecaf672008-12-01 15:23:50 -050055#define RFC1001_NAME_LEN 15
56#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
57
58/* currently length of NIP6_FMT */
59#define SERVER_NAME_LENGTH 40
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
61
62/* used to define string lengths for reversing unicode strings */
63/* (256+1)*2 = 514 */
64/* (max path length + 1 for null) * 2 for unicode */
65#define MAX_NAME 514
66
67#include "cifspdu.h"
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#ifndef XATTR_DOS_ATTRIB
70#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
71#endif
72
73/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * CIFS vfs client Status information (based on what we know.)
75 */
76
77 /* associated with each tcp and smb session */
78enum statusEnum {
79 CifsNew = 0,
80 CifsGood,
81 CifsExiting,
82 CifsNeedReconnect
83};
84
85enum securityEnum {
Steve Frencha0136892007-10-04 20:05:09 +000086 PLAINTXT = 0, /* Legacy with Plaintext passwords */
87 LANMAN, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +000088 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +000090 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchf46c7232009-06-25 03:04:20 +000091/* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
Steve Frenchc16fefa2008-08-19 19:35:33 +000092 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093};
94
95enum protocolEnum {
Steve French3ec332e2008-11-14 03:35:10 +000096 TCP = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 SCTP
98 /* Netbios frames protocol not supported at this time */
99};
100
Steve Frenchb609f062007-07-09 07:55:14 +0000101struct mac_key {
102 unsigned int len;
103 union {
104 char ntlm[CIFS_SESS_KEY_SIZE + 16];
Steve French24424212007-11-16 23:37:35 +0000105 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
Steve Frenchb609f062007-07-09 07:55:14 +0000106 struct {
107 char key[16];
108 struct ntlmv2_resp resp;
109 } ntlmv2;
110 } data;
111};
112
Steve French442aa312007-09-24 20:25:46 +0000113struct cifs_cred {
114 int uid;
115 int gid;
116 int mode;
117 int cecount;
118 struct cifs_sid osid;
119 struct cifs_sid gsid;
120 struct cifs_ntace *ntaces;
121 struct cifs_ace *aces;
122};
123
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124/*
125 *****************************************************************
126 * Except the CIFS PDUs themselves all the
127 * globally interesting structs should go here
128 *****************************************************************
129 */
130
131struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000132 struct list_head tcp_ses_list;
133 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500134 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700135 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500136 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytonc359cf32007-11-16 22:22:06 +0000137 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 struct socket *ssocket;
139 union {
140 struct sockaddr_in sockAddr;
141 struct sockaddr_in6 sockAddr6;
142 } addr;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000143 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
145 struct list_head pending_mid_q;
146 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
147 unsigned short server_codepage; /* codepage for the server */
Steve French131afd02005-10-07 09:51:05 -0700148 unsigned long ip_address; /* IP addr for the server if known */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000149 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 char versionMajor;
151 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000152 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000153 bool noblocksnd; /* use blocking sendmsg */
154 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000155 bool tcp_nodelay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd02005-10-07 09:51:05 -0700157#ifdef CONFIG_CIFS_STATS2
158 atomic_t inSend; /* requests trying to send */
159 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
160#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500162 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 struct task_struct *tsk;
164 char server_GUID[16];
165 char secMode;
166 enum securityEnum secType;
167 unsigned int maxReq; /* Clients should submit no more */
168 /* than maxReq distinct unanswered SMBs to the server when using */
169 /* multiplexed reads or writes */
170 unsigned int maxBuf; /* maxBuf specifies the maximum */
171 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000172 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 /* message size the server can send or receive for */
174 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000175 unsigned int max_vcs; /* maximum number of smb sessions, at least
176 those that can be specified uniquely with
177 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 char sessid[4]; /* unique token id for this session */
179 /* (returned on Negotiate */
180 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000181 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700182 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700184 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500185 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700186 __u32 sequence_number; /* needed for CIFS PDU signature */
Steve Frenchb609f062007-07-09 07:55:14 +0000187 struct mac_key mac_signing_key;
188 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000189 unsigned long lstrp; /* when we got last response from this server */
Jeff Layton9bf67e52010-04-24 07:57:46 -0400190 u16 dialect; /* dialect index that server chose */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400191 /* extended security flavors that server supports */
192 bool sec_kerberos; /* supports plain Kerberos */
193 bool sec_mskerberos; /* supports legacy MS Kerberos */
194 bool sec_kerberosu2u; /* supports U2U Kerberos */
195 bool sec_ntlmssp; /* supports NTLMSSP */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196};
197
198/*
199 * The following is our shortcut to user information. We surface the uid,
200 * and name. We always get the password on the fly in case it
Steve Frenchd38d8c72007-06-28 19:44:13 +0000201 * has changed. We also hang a list of sessions owned by this user off here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 */
203struct cifsUidInfo {
204 struct list_head userList;
205 struct list_head sessionList; /* SMB sessions for this user */
206 uid_t linux_uid;
207 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
208 /* BB may need ptr or callback for PAM or WinBind info */
209};
210
211/*
212 * Session structure. One of these for each uid session with a particular host
213 */
214struct cifsSesInfo {
Jeff Layton14fbf502008-11-14 13:53:46 -0500215 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000216 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000217 struct mutex session_mutex;
Steve French39798772006-05-31 22:40:51 +0000218#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 struct cifsUidInfo *uidInfo; /* pointer to user info */
Steve French39798772006-05-31 22:40:51 +0000220#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500222 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000224 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 __u16 ipc_tid; /* special tid for connection to IPC share */
226 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000227 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700228 char *serverOS; /* name of operating system underlying server */
229 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 char *serverDomain; /* security realm of server */
231 int Suid; /* remote smb uid */
232 uid_t linux_uid; /* local Linux uid */
233 int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000234 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700235 TCP names - will ipv6 and sctp addresses fit? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 char userName[MAX_USERNAME_SIZE + 1];
Steve Frenchd38d8c72007-06-28 19:44:13 +0000237 char *domainName;
238 char *password;
Steve French3b795212008-11-13 19:45:32 +0000239 bool need_reconnect:1; /* connection reset, uid now invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240};
Steve French9ac00b72006-09-30 04:13:17 +0000241/* no more than one of the following three session flags may be set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242#define CIFS_SES_NT4 1
Steve French9ac00b72006-09-30 04:13:17 +0000243#define CIFS_SES_OS2 2
244#define CIFS_SES_W9X 4
245/* following flag is set for old servers such as OS2 (and Win95?)
246 which do not negotiate NTLM or POSIX dialects, but instead
247 negotiate one of the older LANMAN dialects */
248#define CIFS_SES_LANMAN 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249/*
250 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +0000251 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 */
253struct cifsTconInfo {
Jeff Laytonf1987b42008-11-15 11:12:47 -0500254 struct list_head tcon_list;
255 int tc_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 struct list_head openFileList;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 struct cifsSesInfo *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +0000258 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -0500260 char *password; /* for share-level security */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 __u16 tid; /* The 2 byte tree id */
262 __u16 Flags; /* optional support bits */
263 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264#ifdef CONFIG_CIFS_STATS
265 atomic_t num_smbs_sent;
266 atomic_t num_writes;
267 atomic_t num_reads;
Steve Frenchb298f222009-02-21 21:17:43 +0000268 atomic_t num_flushes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 atomic_t num_oplock_brks;
270 atomic_t num_opens;
Steve Frencha5a2b482005-08-20 21:42:53 -0700271 atomic_t num_closes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 atomic_t num_deletes;
273 atomic_t num_mkdirs;
Steve French65bc98b2009-07-10 15:27:25 +0000274 atomic_t num_posixopens;
275 atomic_t num_posixmkdirs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 atomic_t num_rmdirs;
277 atomic_t num_renames;
278 atomic_t num_t2renames;
Steve Frenchdfb75332005-06-22 17:13:47 -0700279 atomic_t num_ffirst;
280 atomic_t num_fnext;
281 atomic_t num_fclose;
Steve Frencha5a2b482005-08-20 21:42:53 -0700282 atomic_t num_hardlinks;
283 atomic_t num_symlinks;
284 atomic_t num_locks;
Steve French0a4b92c2006-01-12 15:44:21 -0800285 atomic_t num_acl_get;
286 atomic_t num_acl_set;
Steve Frencha5a2b482005-08-20 21:42:53 -0700287#ifdef CONFIG_CIFS_STATS2
288 unsigned long long time_writes;
289 unsigned long long time_reads;
290 unsigned long long time_opens;
291 unsigned long long time_deletes;
292 unsigned long long time_closes;
293 unsigned long long time_mkdirs;
294 unsigned long long time_rmdirs;
295 unsigned long long time_renames;
296 unsigned long long time_t2renames;
297 unsigned long long time_ffirst;
298 unsigned long long time_fnext;
299 unsigned long long time_fclose;
300#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 __u64 bytes_read;
302 __u64 bytes_written;
303 spinlock_t stat_lock;
Steve Frencha5a2b482005-08-20 21:42:53 -0700304#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000306 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000308 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
309 bool retry:1;
310 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000311 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000312 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000313 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000314 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +0000315 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3b795212008-11-13 19:45:32 +0000316 bool need_reconnect:1; /* connection reset, tid now invalid */
Steve Frenchc18c8422007-07-18 23:21:09 +0000317 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318};
319
320/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000321 * This info hangs off the cifsFileInfo structure, pointed to by llist.
322 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 */
324struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000325 struct list_head llist; /* pointer to next cifsLockInfo */
326 __u64 offset;
327 __u64 length;
328 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329};
330
331/*
332 * One of these for each open instance of a file
333 */
334struct cifs_search_info {
335 loff_t index_of_last_entry;
336 __u16 entries_in_buffer;
337 __u16 info_level;
338 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000339 char *ntwrk_buf_start;
340 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000341 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000342 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000344 bool endOfSearch:1;
345 bool emptyDir:1;
346 bool unicode:1;
347 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348};
349
350struct cifsFileInfo {
351 struct list_head tlist; /* pointer to next fid owned by tcon */
352 struct list_head flist; /* next fid (file instance) for this inode */
353 unsigned int uid; /* allows finding which FileInfo structure */
354 __u32 pid; /* process id who opened file */
355 __u16 netfid; /* file id from remote */
356 /* BB add lock scope info here if needed */ ;
357 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000358 struct file *pfile; /* needed for writepage */
359 struct inode *pInode; /* needed for oplock break */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400360 struct vfsmount *mnt;
Roland Dreier796e5662007-05-03 04:33:45 +0000361 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000362 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000363 bool closePend:1; /* file is marked to close */
364 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400365 bool oplock_break_cancelled:1;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400366 atomic_t count; /* reference count */
Steve Frencha6ce4932009-04-09 01:14:32 +0000367 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 struct cifs_search_info srch_inf;
Jeff Layton3bc303c2009-09-21 06:47:50 -0400369 struct slow_work oplock_break; /* slow_work job for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370};
371
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400372/* Take a reference on the file private data */
373static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
374{
375 atomic_inc(&cifs_file->count);
376}
377
378/* Release a reference on the file private data */
379static inline void cifsFileInfo_put(struct cifsFileInfo *cifs_file)
380{
Jeff Layton48541bd2009-09-12 11:54:29 -0400381 if (atomic_dec_and_test(&cifs_file->count)) {
382 iput(cifs_file->pInode);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400383 kfree(cifs_file);
Jeff Layton48541bd2009-09-12 11:54:29 -0400384 }
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400385}
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387/*
388 * One of these for each file inode
389 */
390
391struct cifsInodeInfo {
392 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000393 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 struct list_head openFileList;
395 int write_behind_rc;
396 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000398 bool clientCanCacheRead:1; /* read oplock */
399 bool clientCanCacheAll:1; /* read and writebehind oplock */
Jeff Layton9a8165f2008-10-17 21:03:20 -0400400 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Jeff Laytondf2cf172010-02-12 07:44:16 -0500401 bool invalid_mapping:1; /* pagecache is invalid */
Jeff Laytonfbec9ab2009-04-03 13:44:00 -0400402 u64 server_eof; /* current file size on server */
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400403 u64 uniqueid; /* server inode number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 struct inode vfs_inode;
405};
406
407static inline struct cifsInodeInfo *
408CIFS_I(struct inode *inode)
409{
410 return container_of(inode, struct cifsInodeInfo, vfs_inode);
411}
412
413static inline struct cifs_sb_info *
414CIFS_SB(struct super_block *sb)
415{
416 return sb->s_fs_info;
417}
418
Steve Frenchab2f2182005-09-15 20:44:50 -0700419static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700420{
421 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
422 return '/';
423 else
424 return '\\';
425}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Steve Frencha4544342005-08-24 13:59:35 -0700427#ifdef CONFIG_CIFS_STATS
428#define cifs_stats_inc atomic_inc
429
430static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
431 unsigned int bytes)
432{
433 if (bytes) {
434 spin_lock(&tcon->stat_lock);
435 tcon->bytes_written += bytes;
436 spin_unlock(&tcon->stat_lock);
437 }
438}
439
440static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
441 unsigned int bytes)
442{
443 spin_lock(&tcon->stat_lock);
444 tcon->bytes_read += bytes;
445 spin_unlock(&tcon->stat_lock);
446}
447#else
448
Steve Frenchd38d8c72007-06-28 19:44:13 +0000449#define cifs_stats_inc(field) do {} while (0)
450#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
451#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700452
453#endif
454
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455/* one of these for every pending CIFS request to the server */
456struct mid_q_entry {
457 struct list_head qhead; /* mids waiting on reply from this server */
458 __u16 mid; /* multiplex id */
459 __u16 pid; /* process id */
460 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700461 unsigned long when_alloc; /* when mid was created */
462#ifdef CONFIG_CIFS_STATS2
463 unsigned long when_sent; /* time when smb send finished */
464 unsigned long when_received; /* when demux complete (taken off wire) */
465#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 struct task_struct *tsk; /* task waiting for response */
467 struct smb_hdr *resp_buf; /* response buffer */
468 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700469 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000470 bool largeBuf:1; /* if valid response, is pointer to large buf */
471 bool multiRsp:1; /* multiple trans2 responses for one request */
472 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473};
474
475struct oplock_q_entry {
476 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000477 struct inode *pinode;
478 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 __u16 netfid;
480};
481
Steve Frenchff5dbd92005-08-24 17:10:36 -0700482/* for pending dnotify requests */
483struct dir_notify_req {
484 struct list_head lhead;
485 __le16 Pid;
486 __le16 PidHigh;
487 __u16 Mid;
488 __u16 Tid;
489 __u16 Uid;
490 __u16 netfid;
491 __u32 filter; /* CompletionFilter (for multishot) */
492 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000493 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700494};
495
Steve French366781c2008-01-25 10:12:41 +0000496struct dfs_info3_param {
497 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000498 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000499 int server_type;
500 int ref_flag;
501 char *path_name;
502 char *node_name;
503};
504
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400505/*
506 * common struct for holding inode info when searching for or updating an
507 * inode with new info
508 */
509
510#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -0400511#define CIFS_FATTR_DELETE_PENDING 0x2
512#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -0400513#define CIFS_FATTR_INO_COLLISION 0x8
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400514
515struct cifs_fattr {
516 u32 cf_flags;
517 u32 cf_cifsattrs;
518 u64 cf_uniqueid;
519 u64 cf_eof;
520 u64 cf_bytes;
521 uid_t cf_uid;
522 gid_t cf_gid;
523 umode_t cf_mode;
524 dev_t cf_rdev;
525 unsigned int cf_nlink;
526 unsigned int cf_dtype;
527 struct timespec cf_atime;
528 struct timespec cf_mtime;
529 struct timespec cf_ctime;
530};
531
Steve French366781c2008-01-25 10:12:41 +0000532static inline void free_dfs_info_param(struct dfs_info3_param *param)
533{
534 if (param) {
535 kfree(param->path_name);
536 kfree(param->node_name);
537 kfree(param);
538 }
539}
540
541static inline void free_dfs_info_array(struct dfs_info3_param *param,
542 int number_of_items)
543{
544 int i;
545 if ((number_of_items == 0) || (param == NULL))
546 return;
547 for (i = 0; i < number_of_items; i++) {
548 kfree(param[i].path_name);
549 kfree(param[i].node_name);
550 }
551 kfree(param);
552}
553
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554#define MID_FREE 0
555#define MID_REQUEST_ALLOCATED 1
556#define MID_REQUEST_SUBMITTED 2
557#define MID_RESPONSE_RECEIVED 4
558#define MID_RETRY_NEEDED 8 /* session closed while this request out */
559#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800560
561/* Types of response buffer returned from SendReceive2 */
562#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
563#define CIFS_SMALL_BUFFER 1
564#define CIFS_LARGE_BUFFER 2
565#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Steve French133672e2007-11-13 22:41:37 +0000567/* Type of Request to SendReceive2 */
568#define CIFS_STD_OP 0 /* normal request timeout */
569#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
570#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
571#define CIFS_BLOCKING_OP 4 /* operation can block */
572#define CIFS_ASYNC_OP 8 /* do not wait for response */
573#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
574#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
575#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
576#define CIFS_NO_RESP 0x040 /* no response buffer required */
577
Steve French39798772006-05-31 22:40:51 +0000578/* Security Flags: indicate type of session setup needed */
579#define CIFSSEC_MAY_SIGN 0x00001
580#define CIFSSEC_MAY_NTLM 0x00002
581#define CIFSSEC_MAY_NTLMV2 0x00004
582#define CIFSSEC_MAY_KRB5 0x00008
583#ifdef CONFIG_CIFS_WEAK_PW_HASH
584#define CIFSSEC_MAY_LANMAN 0x00010
585#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000586#else
587#define CIFSSEC_MAY_LANMAN 0
588#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000589#endif /* weak passwords */
590#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000591#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +0000592
Steve French39798772006-05-31 22:40:51 +0000593#define CIFSSEC_MUST_SIGN 0x01001
594/* note that only one of the following can be set so the
595result of setting MUST flags more than once will be to
596require use of the stronger protocol */
597#define CIFSSEC_MUST_NTLM 0x02002
598#define CIFSSEC_MUST_NTLMV2 0x04004
599#define CIFSSEC_MUST_KRB5 0x08008
600#ifdef CONFIG_CIFS_WEAK_PW_HASH
601#define CIFSSEC_MUST_LANMAN 0x10010
602#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000603#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -0400604#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000605#else
Chuck Ebbert20d17522009-09-15 01:53:21 -0400606#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000607#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000608#else /* do not allow weak pw hash */
609#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +0000610#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000611#else
Steve Frenchac683922009-05-06 04:16:04 +0000612#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000613#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000614#endif /* WEAK_PW_HASH */
615#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000616#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +0000617
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000618#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
619#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +0000620#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 -0700621/*
622 *****************************************************************
623 * All constants go here
624 *****************************************************************
625 */
626
627#define UID_HASH (16)
628
629/*
630 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
631 * following to be declared.
632 */
633
634/****************************************************************************
635 * Locking notes. All updates to global variables and lists should be
636 * protected by spinlocks or semaphores.
637 *
638 * Spinlocks
639 * ---------
640 * GlobalMid_Lock protects:
641 * list operations on pending_mid_q and oplockQ
642 * updates to XID counters, multiplex id and SMB sequence numbers
643 * GlobalSMBSesLock protects:
644 * list operations on tcp and SMB session lists and tCon lists
645 * f_owner.lock protects certain per file struct operations
646 * mapping->page_lock protects certain per page operations
647 *
648 * Semaphores
649 * ----------
650 * sesSem operations on smb session
651 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000652 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 *
654 ****************************************************************************/
655
656#ifdef DECLARE_GLOBALS_HERE
657#define GLOBAL_EXTERN
658#else
659#define GLOBAL_EXTERN extern
660#endif
661
Jeff Laytone7ddee92008-11-14 13:44:38 -0500662/*
663 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000664 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500665 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000666 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500667 * by iterating over cifs_tcp_ses_list
668 */
669GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
670
Jeff Laytonf1987b42008-11-15 11:12:47 -0500671/*
672 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
673 * tcp session, and the list of tcon's per smb session. It also protects
674 * the reference counters for the server, smb session, and tcon. Finally,
675 * changes to the tcon->tidStatus should be done while holding this lock.
676 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500677GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000678
679/*
680 * This lock protects the cifs_file->llist and cifs_file->flist
681 * list operations, and updates to some flags (cifs_file->invalidHandle)
682 * It will be moved to either use the tcon->stat_lock or equivalent later.
683 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
684 * the cifs_tcp_ses_lock must be grabbed first and released last.
685 */
686GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Steve French99ee4db2007-02-27 05:35:17 +0000688/* Outstanding dir notify requests */
689GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
690/* DirNotify response queue */
691GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700692
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693/*
694 * Global transaction id (XID) information
695 */
696GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000697GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000699GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
700 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701GLOBAL_EXTERN char Local_System_Name[15];
702
703/*
704 * Global counters, updated atomically
705 */
706GLOBAL_EXTERN atomic_t sesInfoAllocCount;
707GLOBAL_EXTERN atomic_t tconInfoAllocCount;
708GLOBAL_EXTERN atomic_t tcpSesAllocCount;
709GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
710GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
711
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000712/* Various Debug counters */
Steve French4498eed2005-12-03 13:58:57 -0800713GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
714#ifdef CONFIG_CIFS_STATS2
715GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
716GLOBAL_EXTERN atomic_t totSmBufAllocCount;
717#endif
718GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719GLOBAL_EXTERN atomic_t midCount;
720
721/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000722GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000724 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 or equivalent for current user */
726GLOBAL_EXTERN unsigned int oplockEnabled;
727GLOBAL_EXTERN unsigned int experimEnabled;
728GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -0400729GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
733GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
734GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
735GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
736GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
737
Jeff Layton3bc303c2009-09-21 06:47:50 -0400738extern const struct slow_work_ops cifs_oplock_break_ops;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +0530739
740#endif /* _CIFS_GLOB_H */