blob: c68f31cf455061b91c605e92085ad0d556f62210 [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>
Tejun Heo9b646972010-07-20 22:09:02 +020025#include <linux/workqueue.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 */
Jeff Layton4ff67b72010-07-06 20:43:02 -040040#define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
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 {
Jeff Laytondaf5b0b2010-07-06 20:43:02 -040086 LANMAN = 0, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +000087 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +000089 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchf46c7232009-06-25 03:04:20 +000090/* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
Steve Frenchc16fefa2008-08-19 19:35:33 +000091 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070092};
93
94enum protocolEnum {
Steve French3ec332e2008-11-14 03:35:10 +000095 TCP = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 SCTP
97 /* Netbios frames protocol not supported at this time */
98};
99
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500100struct session_key {
Steve Frenchb609f062007-07-09 07:55:14 +0000101 unsigned int len;
102 union {
103 char ntlm[CIFS_SESS_KEY_SIZE + 16];
Steve French24424212007-11-16 23:37:35 +0000104 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
Steve Frenchb609f062007-07-09 07:55:14 +0000105 struct {
106 char key[16];
107 struct ntlmv2_resp resp;
108 } ntlmv2;
109 } data;
110};
111
Steve French442aa312007-09-24 20:25:46 +0000112struct cifs_cred {
113 int uid;
114 int gid;
115 int mode;
116 int cecount;
117 struct cifs_sid osid;
118 struct cifs_sid gsid;
119 struct cifs_ntace *ntaces;
120 struct cifs_ace *aces;
121};
122
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123/*
124 *****************************************************************
125 * Except the CIFS PDUs themselves all the
126 * globally interesting structs should go here
127 *****************************************************************
128 */
129
130struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000131 struct list_head tcp_ses_list;
132 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500133 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700134 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500135 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytonc359cf32007-11-16 22:22:06 +0000136 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 struct socket *ssocket;
138 union {
139 struct sockaddr_in sockAddr;
140 struct sockaddr_in6 sockAddr6;
141 } addr;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000142 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
144 struct list_head pending_mid_q;
145 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
146 unsigned short server_codepage; /* codepage for the server */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000147 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 char versionMajor;
149 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000150 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000151 bool noblocksnd; /* use blocking sendmsg */
152 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000153 bool tcp_nodelay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd02005-10-07 09:51:05 -0700155#ifdef CONFIG_CIFS_STATS2
156 atomic_t inSend; /* requests trying to send */
157 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
158#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500160 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 struct task_struct *tsk;
162 char server_GUID[16];
163 char secMode;
164 enum securityEnum secType;
165 unsigned int maxReq; /* Clients should submit no more */
166 /* than maxReq distinct unanswered SMBs to the server when using */
167 /* multiplexed reads or writes */
168 unsigned int maxBuf; /* maxBuf specifies the maximum */
169 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000170 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 /* message size the server can send or receive for */
172 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000173 unsigned int max_vcs; /* maximum number of smb sessions, at least
174 those that can be specified uniquely with
175 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 char sessid[4]; /* unique token id for this session */
177 /* (returned on Negotiate */
178 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000179 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700180 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700182 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500183 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700184 __u32 sequence_number; /* needed for CIFS PDU signature */
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500185 struct session_key session_key;
Steve Frenchb609f062007-07-09 07:55:14 +0000186 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000187 unsigned long lstrp; /* when we got last response from this server */
Jeff Layton9bf67e52010-04-24 07:57:46 -0400188 u16 dialect; /* dialect index that server chose */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400189 /* extended security flavors that server supports */
190 bool sec_kerberos; /* supports plain Kerberos */
191 bool sec_mskerberos; /* supports legacy MS Kerberos */
192 bool sec_kerberosu2u; /* supports U2U Kerberos */
193 bool sec_ntlmssp; /* supports NTLMSSP */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530194#ifdef CONFIG_CIFS_FSCACHE
195 struct fscache_cookie *fscache; /* client index cache cookie */
196#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197};
198
199/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 * Session structure. One of these for each uid session with a particular host
201 */
202struct cifsSesInfo {
Jeff Layton14fbf502008-11-14 13:53:46 -0500203 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000204 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000205 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500207 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000209 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 __u16 ipc_tid; /* special tid for connection to IPC share */
211 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000212 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700213 char *serverOS; /* name of operating system underlying server */
214 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 char *serverDomain; /* security realm of server */
216 int Suid; /* remote smb uid */
Jeff Layton3e4b3e12010-07-19 18:00:17 -0400217 uid_t linux_uid; /* overriding owner of files on the mount */
218 uid_t cred_uid; /* owner of credentials */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000220 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700221 TCP names - will ipv6 and sctp addresses fit? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 char userName[MAX_USERNAME_SIZE + 1];
Steve Frenchd38d8c72007-06-28 19:44:13 +0000223 char *domainName;
224 char *password;
Shirish Pargaonkar2b149f12010-09-18 22:02:18 -0500225 unsigned int tilen; /* length of the target info blob */
226 unsigned char *tiblob; /* target info blob in challenge response */
Steve French3b795212008-11-13 19:45:32 +0000227 bool need_reconnect:1; /* connection reset, uid now invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228};
Steve French9ac00b72006-09-30 04:13:17 +0000229/* no more than one of the following three session flags may be set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230#define CIFS_SES_NT4 1
Steve French9ac00b72006-09-30 04:13:17 +0000231#define CIFS_SES_OS2 2
232#define CIFS_SES_W9X 4
233/* following flag is set for old servers such as OS2 (and Win95?)
234 which do not negotiate NTLM or POSIX dialects, but instead
235 negotiate one of the older LANMAN dialects */
236#define CIFS_SES_LANMAN 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237/*
238 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +0000239 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 */
241struct cifsTconInfo {
Jeff Laytonf1987b42008-11-15 11:12:47 -0500242 struct list_head tcon_list;
243 int tc_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 struct list_head openFileList;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 struct cifsSesInfo *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +0000246 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -0500248 char *password; /* for share-level security */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 __u16 tid; /* The 2 byte tree id */
250 __u16 Flags; /* optional support bits */
251 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252#ifdef CONFIG_CIFS_STATS
253 atomic_t num_smbs_sent;
254 atomic_t num_writes;
255 atomic_t num_reads;
Steve Frenchb298f222009-02-21 21:17:43 +0000256 atomic_t num_flushes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 atomic_t num_oplock_brks;
258 atomic_t num_opens;
Steve Frencha5a2b482005-08-20 21:42:53 -0700259 atomic_t num_closes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 atomic_t num_deletes;
261 atomic_t num_mkdirs;
Steve French65bc98b2009-07-10 15:27:25 +0000262 atomic_t num_posixopens;
263 atomic_t num_posixmkdirs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 atomic_t num_rmdirs;
265 atomic_t num_renames;
266 atomic_t num_t2renames;
Steve Frenchdfb75332005-06-22 17:13:47 -0700267 atomic_t num_ffirst;
268 atomic_t num_fnext;
269 atomic_t num_fclose;
Steve Frencha5a2b482005-08-20 21:42:53 -0700270 atomic_t num_hardlinks;
271 atomic_t num_symlinks;
272 atomic_t num_locks;
Steve French0a4b92c2006-01-12 15:44:21 -0800273 atomic_t num_acl_get;
274 atomic_t num_acl_set;
Steve Frencha5a2b482005-08-20 21:42:53 -0700275#ifdef CONFIG_CIFS_STATS2
276 unsigned long long time_writes;
277 unsigned long long time_reads;
278 unsigned long long time_opens;
279 unsigned long long time_deletes;
280 unsigned long long time_closes;
281 unsigned long long time_mkdirs;
282 unsigned long long time_rmdirs;
283 unsigned long long time_renames;
284 unsigned long long time_t2renames;
285 unsigned long long time_ffirst;
286 unsigned long long time_fnext;
287 unsigned long long time_fclose;
288#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 __u64 bytes_read;
290 __u64 bytes_written;
291 spinlock_t stat_lock;
Steve Frencha5a2b482005-08-20 21:42:53 -0700292#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000294 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000296 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
297 bool retry:1;
298 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000299 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000300 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000301 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000302 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +0000303 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3b795212008-11-13 19:45:32 +0000304 bool need_reconnect:1; /* connection reset, tid now invalid */
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530305#ifdef CONFIG_CIFS_FSCACHE
306 u64 resource_id; /* server resource id */
307 struct fscache_cookie *fscache; /* cookie for share */
308#endif
Steve Frenchc18c8422007-07-18 23:21:09 +0000309 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310};
311
312/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000313 * This info hangs off the cifsFileInfo structure, pointed to by llist.
314 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 */
316struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000317 struct list_head llist; /* pointer to next cifsLockInfo */
318 __u64 offset;
319 __u64 length;
320 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321};
322
323/*
324 * One of these for each open instance of a file
325 */
326struct cifs_search_info {
327 loff_t index_of_last_entry;
328 __u16 entries_in_buffer;
329 __u16 info_level;
330 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000331 char *ntwrk_buf_start;
332 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000333 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000334 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000336 bool endOfSearch:1;
337 bool emptyDir:1;
338 bool unicode:1;
339 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340};
341
342struct cifsFileInfo {
343 struct list_head tlist; /* pointer to next fid owned by tcon */
344 struct list_head flist; /* next fid (file instance) for this inode */
345 unsigned int uid; /* allows finding which FileInfo structure */
346 __u32 pid; /* process id who opened file */
347 __u16 netfid; /* file id from remote */
348 /* BB add lock scope info here if needed */ ;
349 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000350 struct file *pfile; /* needed for writepage */
351 struct inode *pInode; /* needed for oplock break */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400352 struct vfsmount *mnt;
Roland Dreier796e5662007-05-03 04:33:45 +0000353 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000354 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000355 bool closePend:1; /* file is marked to close */
356 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400357 bool oplock_break_cancelled:1;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400358 atomic_t count; /* reference count */
Steve Frencha6ce4932009-04-09 01:14:32 +0000359 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +0200361 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362};
363
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400364/* Take a reference on the file private data */
365static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
366{
367 atomic_inc(&cifs_file->count);
368}
369
370/* Release a reference on the file private data */
371static inline void cifsFileInfo_put(struct cifsFileInfo *cifs_file)
372{
Jeff Layton48541bd2009-09-12 11:54:29 -0400373 if (atomic_dec_and_test(&cifs_file->count)) {
374 iput(cifs_file->pInode);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400375 kfree(cifs_file);
Jeff Layton48541bd2009-09-12 11:54:29 -0400376 }
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400377}
378
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379/*
380 * One of these for each file inode
381 */
382
383struct cifsInodeInfo {
384 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000385 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 struct list_head openFileList;
387 int write_behind_rc;
388 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000390 bool clientCanCacheRead:1; /* read oplock */
391 bool clientCanCacheAll:1; /* read and writebehind oplock */
Jeff Layton9a8165f2008-10-17 21:03:20 -0400392 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Jeff Laytondf2cf172010-02-12 07:44:16 -0500393 bool invalid_mapping:1; /* pagecache is invalid */
Jeff Laytonfbec9ab2009-04-03 13:44:00 -0400394 u64 server_eof; /* current file size on server */
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400395 u64 uniqueid; /* server inode number */
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530396#ifdef CONFIG_CIFS_FSCACHE
397 struct fscache_cookie *fscache;
398#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 struct inode vfs_inode;
400};
401
402static inline struct cifsInodeInfo *
403CIFS_I(struct inode *inode)
404{
405 return container_of(inode, struct cifsInodeInfo, vfs_inode);
406}
407
408static inline struct cifs_sb_info *
409CIFS_SB(struct super_block *sb)
410{
411 return sb->s_fs_info;
412}
413
Steve Frenchab2f2182005-09-15 20:44:50 -0700414static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700415{
416 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
417 return '/';
418 else
419 return '\\';
420}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Steve Frencha4544342005-08-24 13:59:35 -0700422#ifdef CONFIG_CIFS_STATS
423#define cifs_stats_inc atomic_inc
424
425static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
426 unsigned int bytes)
427{
428 if (bytes) {
429 spin_lock(&tcon->stat_lock);
430 tcon->bytes_written += bytes;
431 spin_unlock(&tcon->stat_lock);
432 }
433}
434
435static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
436 unsigned int bytes)
437{
438 spin_lock(&tcon->stat_lock);
439 tcon->bytes_read += bytes;
440 spin_unlock(&tcon->stat_lock);
441}
442#else
443
Steve Frenchd38d8c72007-06-28 19:44:13 +0000444#define cifs_stats_inc(field) do {} while (0)
445#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
446#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700447
448#endif
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450/* one of these for every pending CIFS request to the server */
451struct mid_q_entry {
452 struct list_head qhead; /* mids waiting on reply from this server */
453 __u16 mid; /* multiplex id */
454 __u16 pid; /* process id */
455 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700456 unsigned long when_alloc; /* when mid was created */
457#ifdef CONFIG_CIFS_STATS2
458 unsigned long when_sent; /* time when smb send finished */
459 unsigned long when_received; /* when demux complete (taken off wire) */
460#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 struct task_struct *tsk; /* task waiting for response */
462 struct smb_hdr *resp_buf; /* response buffer */
463 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700464 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000465 bool largeBuf:1; /* if valid response, is pointer to large buf */
466 bool multiRsp:1; /* multiple trans2 responses for one request */
467 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468};
469
470struct oplock_q_entry {
471 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000472 struct inode *pinode;
473 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 __u16 netfid;
475};
476
Steve Frenchff5dbd92005-08-24 17:10:36 -0700477/* for pending dnotify requests */
478struct dir_notify_req {
479 struct list_head lhead;
480 __le16 Pid;
481 __le16 PidHigh;
482 __u16 Mid;
483 __u16 Tid;
484 __u16 Uid;
485 __u16 netfid;
486 __u32 filter; /* CompletionFilter (for multishot) */
487 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000488 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700489};
490
Steve French366781c2008-01-25 10:12:41 +0000491struct dfs_info3_param {
492 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000493 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000494 int server_type;
495 int ref_flag;
496 char *path_name;
497 char *node_name;
498};
499
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400500/*
501 * common struct for holding inode info when searching for or updating an
502 * inode with new info
503 */
504
505#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -0400506#define CIFS_FATTR_DELETE_PENDING 0x2
507#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -0400508#define CIFS_FATTR_INO_COLLISION 0x8
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400509
510struct cifs_fattr {
511 u32 cf_flags;
512 u32 cf_cifsattrs;
513 u64 cf_uniqueid;
514 u64 cf_eof;
515 u64 cf_bytes;
516 uid_t cf_uid;
517 gid_t cf_gid;
518 umode_t cf_mode;
519 dev_t cf_rdev;
520 unsigned int cf_nlink;
521 unsigned int cf_dtype;
522 struct timespec cf_atime;
523 struct timespec cf_mtime;
524 struct timespec cf_ctime;
525};
526
Steve French366781c2008-01-25 10:12:41 +0000527static inline void free_dfs_info_param(struct dfs_info3_param *param)
528{
529 if (param) {
530 kfree(param->path_name);
531 kfree(param->node_name);
532 kfree(param);
533 }
534}
535
536static inline void free_dfs_info_array(struct dfs_info3_param *param,
537 int number_of_items)
538{
539 int i;
540 if ((number_of_items == 0) || (param == NULL))
541 return;
542 for (i = 0; i < number_of_items; i++) {
543 kfree(param[i].path_name);
544 kfree(param[i].node_name);
545 }
546 kfree(param);
547}
548
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549#define MID_FREE 0
550#define MID_REQUEST_ALLOCATED 1
551#define MID_REQUEST_SUBMITTED 2
552#define MID_RESPONSE_RECEIVED 4
553#define MID_RETRY_NEEDED 8 /* session closed while this request out */
554#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800555
556/* Types of response buffer returned from SendReceive2 */
557#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
558#define CIFS_SMALL_BUFFER 1
559#define CIFS_LARGE_BUFFER 2
560#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Steve French133672e2007-11-13 22:41:37 +0000562/* Type of Request to SendReceive2 */
563#define CIFS_STD_OP 0 /* normal request timeout */
564#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
565#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
566#define CIFS_BLOCKING_OP 4 /* operation can block */
567#define CIFS_ASYNC_OP 8 /* do not wait for response */
568#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
569#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
570#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
571#define CIFS_NO_RESP 0x040 /* no response buffer required */
572
Steve French39798772006-05-31 22:40:51 +0000573/* Security Flags: indicate type of session setup needed */
574#define CIFSSEC_MAY_SIGN 0x00001
575#define CIFSSEC_MAY_NTLM 0x00002
576#define CIFSSEC_MAY_NTLMV2 0x00004
577#define CIFSSEC_MAY_KRB5 0x00008
578#ifdef CONFIG_CIFS_WEAK_PW_HASH
579#define CIFSSEC_MAY_LANMAN 0x00010
580#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000581#else
582#define CIFSSEC_MAY_LANMAN 0
583#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000584#endif /* weak passwords */
585#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000586#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +0000587
Steve French39798772006-05-31 22:40:51 +0000588#define CIFSSEC_MUST_SIGN 0x01001
589/* note that only one of the following can be set so the
590result of setting MUST flags more than once will be to
591require use of the stronger protocol */
592#define CIFSSEC_MUST_NTLM 0x02002
593#define CIFSSEC_MUST_NTLMV2 0x04004
594#define CIFSSEC_MUST_KRB5 0x08008
595#ifdef CONFIG_CIFS_WEAK_PW_HASH
596#define CIFSSEC_MUST_LANMAN 0x10010
597#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000598#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -0400599#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000600#else
Chuck Ebbert20d17522009-09-15 01:53:21 -0400601#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000602#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000603#else /* do not allow weak pw hash */
604#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +0000605#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000606#else
Steve Frenchac683922009-05-06 04:16:04 +0000607#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000608#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000609#endif /* WEAK_PW_HASH */
610#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000611#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +0000612
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000613#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
614#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +0000615#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 -0700616/*
617 *****************************************************************
618 * All constants go here
619 *****************************************************************
620 */
621
622#define UID_HASH (16)
623
624/*
625 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
626 * following to be declared.
627 */
628
629/****************************************************************************
630 * Locking notes. All updates to global variables and lists should be
631 * protected by spinlocks or semaphores.
632 *
633 * Spinlocks
634 * ---------
635 * GlobalMid_Lock protects:
636 * list operations on pending_mid_q and oplockQ
637 * updates to XID counters, multiplex id and SMB sequence numbers
638 * GlobalSMBSesLock protects:
639 * list operations on tcp and SMB session lists and tCon lists
640 * f_owner.lock protects certain per file struct operations
641 * mapping->page_lock protects certain per page operations
642 *
643 * Semaphores
644 * ----------
645 * sesSem operations on smb session
646 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000647 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 *
649 ****************************************************************************/
650
651#ifdef DECLARE_GLOBALS_HERE
652#define GLOBAL_EXTERN
653#else
654#define GLOBAL_EXTERN extern
655#endif
656
Jeff Laytone7ddee92008-11-14 13:44:38 -0500657/*
658 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000659 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500660 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000661 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500662 * by iterating over cifs_tcp_ses_list
663 */
664GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
665
Jeff Laytonf1987b42008-11-15 11:12:47 -0500666/*
667 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
668 * tcp session, and the list of tcon's per smb session. It also protects
669 * the reference counters for the server, smb session, and tcon. Finally,
670 * changes to the tcon->tidStatus should be done while holding this lock.
671 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500672GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000673
674/*
675 * This lock protects the cifs_file->llist and cifs_file->flist
676 * list operations, and updates to some flags (cifs_file->invalidHandle)
677 * It will be moved to either use the tcon->stat_lock or equivalent later.
678 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
679 * the cifs_tcp_ses_lock must be grabbed first and released last.
680 */
681GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Steve French99ee4db2007-02-27 05:35:17 +0000683/* Outstanding dir notify requests */
684GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
685/* DirNotify response queue */
686GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/*
689 * Global transaction id (XID) information
690 */
691GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000692GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000694GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
695 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696GLOBAL_EXTERN char Local_System_Name[15];
697
698/*
699 * Global counters, updated atomically
700 */
701GLOBAL_EXTERN atomic_t sesInfoAllocCount;
702GLOBAL_EXTERN atomic_t tconInfoAllocCount;
703GLOBAL_EXTERN atomic_t tcpSesAllocCount;
704GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
705GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
706
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000707/* Various Debug counters */
Steve French4498eed2005-12-03 13:58:57 -0800708GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
709#ifdef CONFIG_CIFS_STATS2
710GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
711GLOBAL_EXTERN atomic_t totSmBufAllocCount;
712#endif
713GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714GLOBAL_EXTERN atomic_t midCount;
715
716/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000717GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000719 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 or equivalent for current user */
721GLOBAL_EXTERN unsigned int oplockEnabled;
722GLOBAL_EXTERN unsigned int experimEnabled;
723GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -0400724GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
728GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
729GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
730GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
731GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
732
Tejun Heo9b646972010-07-20 22:09:02 +0200733void cifs_oplock_break(struct work_struct *work);
734void cifs_oplock_break_get(struct cifsFileInfo *cfile);
735void cifs_oplock_break_put(struct cifsFileInfo *cfile);
Linus Torvalds3b7433b2010-08-07 12:42:58 -0700736
Jeff Layton3bc303c2009-09-21 06:47:50 -0400737extern const struct slow_work_ops cifs_oplock_break_ops;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +0530738
739#endif /* _CIFS_GLOB_H */