blob: cdfd2db4e70d59cf4d01a589c3c099e990e7bec6 [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;
Ben Greear3eb9a882010-09-01 17:06:02 -0700142 struct sockaddr_storage srcaddr; /* locally bind to this IP */
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 Frenchd38d8c72007-06-28 19:44:13 +0000148 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 char versionMajor;
150 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000151 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000152 bool noblocksnd; /* use blocking sendmsg */
153 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000154 bool tcp_nodelay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd0b2005-10-07 09:51:05 -0700156#ifdef CONFIG_CIFS_STATS2
157 atomic_t inSend; /* requests trying to send */
158 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
159#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500161 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 struct task_struct *tsk;
163 char server_GUID[16];
164 char secMode;
165 enum securityEnum secType;
166 unsigned int maxReq; /* Clients should submit no more */
167 /* than maxReq distinct unanswered SMBs to the server when using */
168 /* multiplexed reads or writes */
169 unsigned int maxBuf; /* maxBuf specifies the maximum */
170 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000171 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 /* message size the server can send or receive for */
173 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000174 unsigned int max_vcs; /* maximum number of smb sessions, at least
175 those that can be specified uniquely with
176 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 char sessid[4]; /* unique token id for this session */
178 /* (returned on Negotiate */
179 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000180 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700181 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700183 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500184 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700185 __u32 sequence_number; /* needed for CIFS PDU signature */
Shirish Pargaonkar5f98ca92010-09-18 22:01:58 -0500186 struct session_key session_key;
Steve Frenchb609f062007-07-09 07:55:14 +0000187 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000188 unsigned long lstrp; /* when we got last response from this server */
Jeff Layton9bf67e52010-04-24 07:57:46 -0400189 u16 dialect; /* dialect index that server chose */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400190 /* extended security flavors that server supports */
191 bool sec_kerberos; /* supports plain Kerberos */
192 bool sec_mskerberos; /* supports legacy MS Kerberos */
193 bool sec_kerberosu2u; /* supports U2U Kerberos */
194 bool sec_ntlmssp; /* supports NTLMSSP */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530195#ifdef CONFIG_CIFS_FSCACHE
196 struct fscache_cookie *fscache; /* client index cache cookie */
197#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198};
199
200/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 * Session structure. One of these for each uid session with a particular host
202 */
203struct cifsSesInfo {
Jeff Layton14fbf502008-11-14 13:53:46 -0500204 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000205 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000206 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500208 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000210 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 __u16 ipc_tid; /* special tid for connection to IPC share */
212 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000213 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700214 char *serverOS; /* name of operating system underlying server */
215 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 char *serverDomain; /* security realm of server */
217 int Suid; /* remote smb uid */
Jeff Layton3e4b3e12010-07-19 18:00:17 -0400218 uid_t linux_uid; /* overriding owner of files on the mount */
219 uid_t cred_uid; /* owner of credentials */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000221 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700222 TCP names - will ipv6 and sctp addresses fit? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 char userName[MAX_USERNAME_SIZE + 1];
Steve Frenchd38d8c72007-06-28 19:44:13 +0000224 char *domainName;
225 char *password;
Shirish Pargaonkar2b149f12010-09-18 22:02:18 -0500226 unsigned int tilen; /* length of the target info blob */
227 unsigned char *tiblob; /* target info blob in challenge response */
Steve French3b795212008-11-13 19:45:32 +0000228 bool need_reconnect:1; /* connection reset, uid now invalid */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229};
Steve French9ac00b72006-09-30 04:13:17 +0000230/* no more than one of the following three session flags may be set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231#define CIFS_SES_NT4 1
Steve French9ac00b72006-09-30 04:13:17 +0000232#define CIFS_SES_OS2 2
233#define CIFS_SES_W9X 4
234/* following flag is set for old servers such as OS2 (and Win95?)
235 which do not negotiate NTLM or POSIX dialects, but instead
236 negotiate one of the older LANMAN dialects */
237#define CIFS_SES_LANMAN 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238/*
239 * there is one of these for each connection to a resource on a particular
Steve Frenchd38d8c72007-06-28 19:44:13 +0000240 * session
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 */
242struct cifsTconInfo {
Jeff Laytonf1987b42008-11-15 11:12:47 -0500243 struct list_head tcon_list;
244 int tc_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 struct list_head openFileList;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 struct cifsSesInfo *ses; /* pointer to session associated with */
Steve French254e55e2006-06-04 05:53:15 +0000247 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 char *nativeFileSystem;
Jeff Layton00e485b2008-12-05 20:41:21 -0500249 char *password; /* for share-level security */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 __u16 tid; /* The 2 byte tree id */
251 __u16 Flags; /* optional support bits */
252 enum statusEnum tidStatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253#ifdef CONFIG_CIFS_STATS
254 atomic_t num_smbs_sent;
255 atomic_t num_writes;
256 atomic_t num_reads;
Steve Frenchb298f222009-02-21 21:17:43 +0000257 atomic_t num_flushes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 atomic_t num_oplock_brks;
259 atomic_t num_opens;
Steve Frencha5a2b482005-08-20 21:42:53 -0700260 atomic_t num_closes;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 atomic_t num_deletes;
262 atomic_t num_mkdirs;
Steve French65bc98b2009-07-10 15:27:25 +0000263 atomic_t num_posixopens;
264 atomic_t num_posixmkdirs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 atomic_t num_rmdirs;
266 atomic_t num_renames;
267 atomic_t num_t2renames;
Steve Frenchdfb75332005-06-22 17:13:47 -0700268 atomic_t num_ffirst;
269 atomic_t num_fnext;
270 atomic_t num_fclose;
Steve Frencha5a2b482005-08-20 21:42:53 -0700271 atomic_t num_hardlinks;
272 atomic_t num_symlinks;
273 atomic_t num_locks;
Steve French0a4b92c2006-01-12 15:44:21 -0800274 atomic_t num_acl_get;
275 atomic_t num_acl_set;
Steve Frencha5a2b482005-08-20 21:42:53 -0700276#ifdef CONFIG_CIFS_STATS2
277 unsigned long long time_writes;
278 unsigned long long time_reads;
279 unsigned long long time_opens;
280 unsigned long long time_deletes;
281 unsigned long long time_closes;
282 unsigned long long time_mkdirs;
283 unsigned long long time_rmdirs;
284 unsigned long long time_renames;
285 unsigned long long time_t2renames;
286 unsigned long long time_ffirst;
287 unsigned long long time_fnext;
288 unsigned long long time_fclose;
289#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 __u64 bytes_read;
291 __u64 bytes_written;
292 spinlock_t stat_lock;
Steve Frencha5a2b482005-08-20 21:42:53 -0700293#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000295 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000297 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
298 bool retry:1;
299 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000300 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000301 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000302 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000303 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French64cc2c62009-03-04 19:54:08 +0000304 bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
Steve French3b795212008-11-13 19:45:32 +0000305 bool need_reconnect:1; /* connection reset, tid now invalid */
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530306#ifdef CONFIG_CIFS_FSCACHE
307 u64 resource_id; /* server resource id */
308 struct fscache_cookie *fscache; /* cookie for share */
309#endif
Steve Frenchc18c8422007-07-18 23:21:09 +0000310 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311};
312
313/*
Jeff Layton7ffec372010-09-29 19:51:11 -0400314 * This is a refcounted and timestamped container for a tcon pointer. The
315 * container holds a tcon reference. It is considered safe to free one of
316 * these when the tl_count goes to 0. The tl_time is the time of the last
317 * "get" on the container.
318 */
319struct tcon_link {
320 spinlock_t tl_lock;
321 u32 tl_count;
322 u64 tl_time;
323 struct cifsTconInfo *tl_tcon;
324};
325
326static inline struct tcon_link *
327cifs_sb_tlink(struct cifs_sb_info *cifs_sb)
328{
329 return (struct tcon_link *)cifs_sb->ptcon;
330}
331
332static inline struct cifsTconInfo *
333tlink_tcon(struct tcon_link *tlink)
334{
335 return (struct cifsTconInfo *)tlink;
336}
337
338static inline void
339cifs_put_tlink(struct tcon_link *tlink)
340{
341 return;
342}
343
344/* This function is always expected to succeed */
345static inline struct cifsTconInfo *
346cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb)
347{
348 return cifs_sb->ptcon;
349}
350
351/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000352 * This info hangs off the cifsFileInfo structure, pointed to by llist.
353 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 */
355struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000356 struct list_head llist; /* pointer to next cifsLockInfo */
357 __u64 offset;
358 __u64 length;
359 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360};
361
362/*
363 * One of these for each open instance of a file
364 */
365struct cifs_search_info {
366 loff_t index_of_last_entry;
367 __u16 entries_in_buffer;
368 __u16 info_level;
369 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000370 char *ntwrk_buf_start;
371 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000372 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000373 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000375 bool endOfSearch:1;
376 bool emptyDir:1;
377 bool unicode:1;
378 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379};
380
381struct cifsFileInfo {
382 struct list_head tlist; /* pointer to next fid owned by tcon */
383 struct list_head flist; /* next fid (file instance) for this inode */
384 unsigned int uid; /* allows finding which FileInfo structure */
385 __u32 pid; /* process id who opened file */
386 __u16 netfid; /* file id from remote */
387 /* BB add lock scope info here if needed */ ;
388 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000389 struct file *pfile; /* needed for writepage */
390 struct inode *pInode; /* needed for oplock break */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400391 struct vfsmount *mnt;
Jeff Layton5fe97cf2010-09-20 16:01:30 -0700392 struct cifsTconInfo *tcon;
Roland Dreier796e5662007-05-03 04:33:45 +0000393 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000394 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000395 bool closePend:1; /* file is marked to close */
396 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400397 bool oplock_break_cancelled:1;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400398 atomic_t count; /* reference count */
Steve Frencha6ce4932009-04-09 01:14:32 +0000399 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +0200401 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402};
403
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400404/* Take a reference on the file private data */
405static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
406{
407 atomic_inc(&cifs_file->count);
408}
409
410/* Release a reference on the file private data */
411static inline void cifsFileInfo_put(struct cifsFileInfo *cifs_file)
412{
Jeff Layton48541bd2009-09-12 11:54:29 -0400413 if (atomic_dec_and_test(&cifs_file->count)) {
414 iput(cifs_file->pInode);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400415 kfree(cifs_file);
Jeff Layton48541bd2009-09-12 11:54:29 -0400416 }
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400417}
418
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419/*
420 * One of these for each file inode
421 */
422
423struct cifsInodeInfo {
424 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000425 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 struct list_head openFileList;
427 int write_behind_rc;
428 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000430 bool clientCanCacheRead:1; /* read oplock */
431 bool clientCanCacheAll:1; /* read and writebehind oplock */
Jeff Layton9a8165f2008-10-17 21:03:20 -0400432 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Jeff Laytondf2cf172010-02-12 07:44:16 -0500433 bool invalid_mapping:1; /* pagecache is invalid */
Jeff Laytonfbec9ab2009-04-03 13:44:00 -0400434 u64 server_eof; /* current file size on server */
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400435 u64 uniqueid; /* server inode number */
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530436#ifdef CONFIG_CIFS_FSCACHE
437 struct fscache_cookie *fscache;
438#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 struct inode vfs_inode;
440};
441
442static inline struct cifsInodeInfo *
443CIFS_I(struct inode *inode)
444{
445 return container_of(inode, struct cifsInodeInfo, vfs_inode);
446}
447
448static inline struct cifs_sb_info *
449CIFS_SB(struct super_block *sb)
450{
451 return sb->s_fs_info;
452}
453
Steve Frenchab2f2182005-09-15 20:44:50 -0700454static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700455{
456 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
457 return '/';
458 else
459 return '\\';
460}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Steve Frencha4544342005-08-24 13:59:35 -0700462#ifdef CONFIG_CIFS_STATS
463#define cifs_stats_inc atomic_inc
464
465static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
466 unsigned int bytes)
467{
468 if (bytes) {
469 spin_lock(&tcon->stat_lock);
470 tcon->bytes_written += bytes;
471 spin_unlock(&tcon->stat_lock);
472 }
473}
474
475static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
476 unsigned int bytes)
477{
478 spin_lock(&tcon->stat_lock);
479 tcon->bytes_read += bytes;
480 spin_unlock(&tcon->stat_lock);
481}
482#else
483
Steve Frenchd38d8c72007-06-28 19:44:13 +0000484#define cifs_stats_inc(field) do {} while (0)
485#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
486#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700487
488#endif
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490/* one of these for every pending CIFS request to the server */
491struct mid_q_entry {
492 struct list_head qhead; /* mids waiting on reply from this server */
493 __u16 mid; /* multiplex id */
494 __u16 pid; /* process id */
495 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700496 unsigned long when_alloc; /* when mid was created */
497#ifdef CONFIG_CIFS_STATS2
498 unsigned long when_sent; /* time when smb send finished */
499 unsigned long when_received; /* when demux complete (taken off wire) */
500#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 struct task_struct *tsk; /* task waiting for response */
502 struct smb_hdr *resp_buf; /* response buffer */
503 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700504 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000505 bool largeBuf:1; /* if valid response, is pointer to large buf */
506 bool multiRsp:1; /* multiple trans2 responses for one request */
507 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508};
509
510struct oplock_q_entry {
511 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000512 struct inode *pinode;
513 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 __u16 netfid;
515};
516
Steve Frenchff5dbd92005-08-24 17:10:36 -0700517/* for pending dnotify requests */
518struct dir_notify_req {
519 struct list_head lhead;
520 __le16 Pid;
521 __le16 PidHigh;
522 __u16 Mid;
523 __u16 Tid;
524 __u16 Uid;
525 __u16 netfid;
526 __u32 filter; /* CompletionFilter (for multishot) */
527 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000528 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700529};
530
Steve French366781c2008-01-25 10:12:41 +0000531struct dfs_info3_param {
532 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000533 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000534 int server_type;
535 int ref_flag;
536 char *path_name;
537 char *node_name;
538};
539
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400540/*
541 * common struct for holding inode info when searching for or updating an
542 * inode with new info
543 */
544
545#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -0400546#define CIFS_FATTR_DELETE_PENDING 0x2
547#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -0400548#define CIFS_FATTR_INO_COLLISION 0x8
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400549
550struct cifs_fattr {
551 u32 cf_flags;
552 u32 cf_cifsattrs;
553 u64 cf_uniqueid;
554 u64 cf_eof;
555 u64 cf_bytes;
556 uid_t cf_uid;
557 gid_t cf_gid;
558 umode_t cf_mode;
559 dev_t cf_rdev;
560 unsigned int cf_nlink;
561 unsigned int cf_dtype;
562 struct timespec cf_atime;
563 struct timespec cf_mtime;
564 struct timespec cf_ctime;
565};
566
Steve French366781c2008-01-25 10:12:41 +0000567static inline void free_dfs_info_param(struct dfs_info3_param *param)
568{
569 if (param) {
570 kfree(param->path_name);
571 kfree(param->node_name);
572 kfree(param);
573 }
574}
575
576static inline void free_dfs_info_array(struct dfs_info3_param *param,
577 int number_of_items)
578{
579 int i;
580 if ((number_of_items == 0) || (param == NULL))
581 return;
582 for (i = 0; i < number_of_items; i++) {
583 kfree(param[i].path_name);
584 kfree(param[i].node_name);
585 }
586 kfree(param);
587}
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589#define MID_FREE 0
590#define MID_REQUEST_ALLOCATED 1
591#define MID_REQUEST_SUBMITTED 2
592#define MID_RESPONSE_RECEIVED 4
593#define MID_RETRY_NEEDED 8 /* session closed while this request out */
594#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800595
596/* Types of response buffer returned from SendReceive2 */
597#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
598#define CIFS_SMALL_BUFFER 1
599#define CIFS_LARGE_BUFFER 2
600#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Steve French133672e2007-11-13 22:41:37 +0000602/* Type of Request to SendReceive2 */
603#define CIFS_STD_OP 0 /* normal request timeout */
604#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
605#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
606#define CIFS_BLOCKING_OP 4 /* operation can block */
607#define CIFS_ASYNC_OP 8 /* do not wait for response */
608#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
609#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
610#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
611#define CIFS_NO_RESP 0x040 /* no response buffer required */
612
Steve French39798772006-05-31 22:40:51 +0000613/* Security Flags: indicate type of session setup needed */
614#define CIFSSEC_MAY_SIGN 0x00001
615#define CIFSSEC_MAY_NTLM 0x00002
616#define CIFSSEC_MAY_NTLMV2 0x00004
617#define CIFSSEC_MAY_KRB5 0x00008
618#ifdef CONFIG_CIFS_WEAK_PW_HASH
619#define CIFSSEC_MAY_LANMAN 0x00010
620#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000621#else
622#define CIFSSEC_MAY_LANMAN 0
623#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000624#endif /* weak passwords */
625#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000626#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +0000627
Steve French39798772006-05-31 22:40:51 +0000628#define CIFSSEC_MUST_SIGN 0x01001
629/* note that only one of the following can be set so the
630result of setting MUST flags more than once will be to
631require use of the stronger protocol */
632#define CIFSSEC_MUST_NTLM 0x02002
633#define CIFSSEC_MUST_NTLMV2 0x04004
634#define CIFSSEC_MUST_KRB5 0x08008
635#ifdef CONFIG_CIFS_WEAK_PW_HASH
636#define CIFSSEC_MUST_LANMAN 0x10010
637#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000638#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -0400639#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000640#else
Chuck Ebbert20d17522009-09-15 01:53:21 -0400641#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000642#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000643#else /* do not allow weak pw hash */
644#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +0000645#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000646#else
Steve Frenchac683922009-05-06 04:16:04 +0000647#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000648#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000649#endif /* WEAK_PW_HASH */
650#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000651#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +0000652
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000653#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
654#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +0000655#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 -0700656/*
657 *****************************************************************
658 * All constants go here
659 *****************************************************************
660 */
661
662#define UID_HASH (16)
663
664/*
665 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
666 * following to be declared.
667 */
668
669/****************************************************************************
670 * Locking notes. All updates to global variables and lists should be
671 * protected by spinlocks or semaphores.
672 *
673 * Spinlocks
674 * ---------
675 * GlobalMid_Lock protects:
676 * list operations on pending_mid_q and oplockQ
677 * updates to XID counters, multiplex id and SMB sequence numbers
678 * GlobalSMBSesLock protects:
679 * list operations on tcp and SMB session lists and tCon lists
680 * f_owner.lock protects certain per file struct operations
681 * mapping->page_lock protects certain per page operations
682 *
683 * Semaphores
684 * ----------
685 * sesSem operations on smb session
686 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000687 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 *
689 ****************************************************************************/
690
691#ifdef DECLARE_GLOBALS_HERE
692#define GLOBAL_EXTERN
693#else
694#define GLOBAL_EXTERN extern
695#endif
696
Jeff Laytone7ddee92008-11-14 13:44:38 -0500697/*
698 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000699 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500700 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000701 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500702 * by iterating over cifs_tcp_ses_list
703 */
704GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
705
Jeff Laytonf1987b42008-11-15 11:12:47 -0500706/*
707 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
708 * tcp session, and the list of tcon's per smb session. It also protects
709 * the reference counters for the server, smb session, and tcon. Finally,
710 * changes to the tcon->tidStatus should be done while holding this lock.
711 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500712GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000713
714/*
715 * This lock protects the cifs_file->llist and cifs_file->flist
716 * list operations, and updates to some flags (cifs_file->invalidHandle)
717 * It will be moved to either use the tcon->stat_lock or equivalent later.
718 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
719 * the cifs_tcp_ses_lock must be grabbed first and released last.
720 */
721GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Steve French99ee4db2007-02-27 05:35:17 +0000723/* Outstanding dir notify requests */
724GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
725/* DirNotify response queue */
726GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/*
729 * Global transaction id (XID) information
730 */
731GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000732GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000734GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
735 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736GLOBAL_EXTERN char Local_System_Name[15];
737
738/*
739 * Global counters, updated atomically
740 */
741GLOBAL_EXTERN atomic_t sesInfoAllocCount;
742GLOBAL_EXTERN atomic_t tconInfoAllocCount;
743GLOBAL_EXTERN atomic_t tcpSesAllocCount;
744GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
745GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
746
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000747/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -0800748GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
749#ifdef CONFIG_CIFS_STATS2
750GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
751GLOBAL_EXTERN atomic_t totSmBufAllocCount;
752#endif
753GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754GLOBAL_EXTERN atomic_t midCount;
755
756/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000757GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000759 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 or equivalent for current user */
761GLOBAL_EXTERN unsigned int oplockEnabled;
762GLOBAL_EXTERN unsigned int experimEnabled;
763GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -0400764GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
768GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
769GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
770GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
771GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
772
Tejun Heo9b646972010-07-20 22:09:02 +0200773void cifs_oplock_break(struct work_struct *work);
774void cifs_oplock_break_get(struct cifsFileInfo *cfile);
775void cifs_oplock_break_put(struct cifsFileInfo *cfile);
Linus Torvalds3b7433b2010-08-07 12:42:58 -0700776
Jeff Layton3bc303c2009-09-21 06:47:50 -0400777extern const struct slow_work_ops cifs_oplock_break_ops;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +0530778
779#endif /* _CIFS_GLOB_H */