blob: 49563e0c172534f5be58036e75150d068635e826 [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"
Steve French9fbc5902010-08-20 20:42:26 +000028#include <crypto/internal/hash.h>
29#include <linux/scatterlist.h>
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/*
32 * The sizes of various internal tables and strings
33 */
34#define MAX_UID_INFO 16
35#define MAX_SES_INFO 2
36#define MAX_TCON_INFO 4
37
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +000038#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#define MAX_SERVER_SIZE 15
Steve Frenchd38d8c72007-06-28 19:44:13 +000040#define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
Linus Torvalds1da177e2005-04-16 15:20:36 -070041#define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
42 termination then *2 for unicode versions */
Jeff Layton4ff67b72010-07-06 20:43:02 -040043#define MAX_PASSWORD_SIZE 512 /* max for windows seems to be 256 wide chars */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
45#define CIFS_MIN_RCV_POOL 4
46
47/*
48 * MAX_REQ is the maximum number of requests that WE will send
André Goddard Rosaaf901ca2009-11-14 13:09:05 -020049 * on one socket concurrently. It also matches the most common
Steve Frenchd38d8c72007-06-28 19:44:13 +000050 * value of max multiplex returned by servers. We may
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * eventually want to use the negotiated value (in case
52 * future servers can handle more) when we are more confident that
53 * we will not have problems oveloading the socket with pending
54 * write data.
55 */
Steve Frenchd38d8c72007-06-28 19:44:13 +000056#define CIFS_MAX_REQ 50
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Jeff Layton8ecaf672008-12-01 15:23:50 -050058#define RFC1001_NAME_LEN 15
59#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
60
61/* currently length of NIP6_FMT */
62#define SERVER_NAME_LENGTH 40
Linus Torvalds1da177e2005-04-16 15:20:36 -070063#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
64
65/* used to define string lengths for reversing unicode strings */
66/* (256+1)*2 = 514 */
67/* (max path length + 1 for null) * 2 for unicode */
68#define MAX_NAME 514
69
70#include "cifspdu.h"
71
Linus Torvalds1da177e2005-04-16 15:20:36 -070072#ifndef XATTR_DOS_ATTRIB
73#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
74#endif
75
76/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 * CIFS vfs client Status information (based on what we know.)
78 */
79
80 /* associated with each tcp and smb session */
81enum statusEnum {
82 CifsNew = 0,
83 CifsGood,
84 CifsExiting,
85 CifsNeedReconnect
86};
87
88enum securityEnum {
Jeff Laytondaf5b0b2010-07-06 20:43:02 -040089 LANMAN = 0, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +000090 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
Steve Frenchac683922009-05-06 04:16:04 +000092 RawNTLMSSP, /* NTLMSSP without SPNEGO, NTLMv2 hash */
Steve Frenchf46c7232009-06-25 03:04:20 +000093/* NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
Steve Frenchc16fefa2008-08-19 19:35:33 +000094 Kerberos, /* Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070095};
96
97enum protocolEnum {
Steve French3ec332e2008-11-14 03:35:10 +000098 TCP = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 SCTP
100 /* Netbios frames protocol not supported at this time */
101};
102
Steve French9fbc5902010-08-20 20:42:26 +0000103struct session_key {
Steve Frenchb609f062007-07-09 07:55:14 +0000104 unsigned int len;
105 union {
106 char ntlm[CIFS_SESS_KEY_SIZE + 16];
Steve French24424212007-11-16 23:37:35 +0000107 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
Steve Frenchb609f062007-07-09 07:55:14 +0000108 struct {
109 char key[16];
110 struct ntlmv2_resp resp;
111 } ntlmv2;
112 } data;
113};
114
Steve French442aa312007-09-24 20:25:46 +0000115struct cifs_cred {
116 int uid;
117 int gid;
118 int mode;
119 int cecount;
120 struct cifs_sid osid;
121 struct cifs_sid gsid;
122 struct cifs_ntace *ntaces;
123 struct cifs_ace *aces;
124};
125
Steve French9fbc5902010-08-20 20:42:26 +0000126struct ntlmssp_auth {
127 __u32 client_flags;
128 __u32 server_flags;
129 unsigned char ciphertext[CIFS_CPHTXT_SIZE];
130 struct crypto_shash *hmacmd5;
131 struct crypto_shash *md5;
132};
133
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134/*
135 *****************************************************************
136 * Except the CIFS PDUs themselves all the
137 * globally interesting structs should go here
138 *****************************************************************
139 */
140
141struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000142 struct list_head tcp_ses_list;
143 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500144 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700145 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500146 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytonc359cf32007-11-16 22:22:06 +0000147 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 struct socket *ssocket;
149 union {
150 struct sockaddr_in sockAddr;
151 struct sockaddr_in6 sockAddr6;
152 } addr;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000153 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
155 struct list_head pending_mid_q;
156 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
157 unsigned short server_codepage; /* codepage for the server */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000158 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 char versionMajor;
160 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000161 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000162 bool noblocksnd; /* use blocking sendmsg */
163 bool noautotune; /* do not autotune send buf sizes */
Steve French6a5fa2362010-01-01 01:28:43 +0000164 bool tcp_nodelay;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd0b2005-10-07 09:51:05 -0700166#ifdef CONFIG_CIFS_STATS2
167 atomic_t inSend; /* requests trying to send */
168 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
169#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500171 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 struct task_struct *tsk;
173 char server_GUID[16];
174 char secMode;
175 enum securityEnum secType;
176 unsigned int maxReq; /* Clients should submit no more */
177 /* than maxReq distinct unanswered SMBs to the server when using */
178 /* multiplexed reads or writes */
179 unsigned int maxBuf; /* maxBuf specifies the maximum */
180 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000181 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 /* message size the server can send or receive for */
183 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000184 unsigned int max_vcs; /* maximum number of smb sessions, at least
185 those that can be specified uniquely with
186 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 char sessid[4]; /* unique token id for this session */
188 /* (returned on Negotiate */
189 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000190 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700191 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700193 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500194 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700195 __u32 sequence_number; /* needed for CIFS PDU signature */
Steve French9fbc5902010-08-20 20:42:26 +0000196 struct session_key session_key;
Steve Frenchb609f062007-07-09 07:55:14 +0000197 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000198 unsigned long lstrp; /* when we got last response from this server */
Jeff Layton9bf67e52010-04-24 07:57:46 -0400199 u16 dialect; /* dialect index that server chose */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400200 /* extended security flavors that server supports */
Steve French9fbc5902010-08-20 20:42:26 +0000201 unsigned int tilen; /* length of the target info blob */
202 unsigned char *tiblob; /* target info blob in challenge response */
203 struct ntlmssp_auth ntlmssp; /* various keys, ciphers, flags */
Jeff Layton26efa0b2010-04-24 07:57:49 -0400204 bool sec_kerberos; /* supports plain Kerberos */
205 bool sec_mskerberos; /* supports legacy MS Kerberos */
206 bool sec_kerberosu2u; /* supports U2U Kerberos */
207 bool sec_ntlmssp; /* supports NTLMSSP */
Suresh Jayaraman488f1d2d2010-07-05 18:12:15 +0530208#ifdef CONFIG_CIFS_FSCACHE
209 struct fscache_cookie *fscache; /* client index cache cookie */
210#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211};
212
213/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 * Session structure. One of these for each uid session with a particular host
215 */
216struct cifsSesInfo {
Jeff Layton14fbf502008-11-14 13:53:46 -0500217 struct list_head smb_ses_list;
Steve French3b795212008-11-13 19:45:32 +0000218 struct list_head tcon_list;
Steve Frenchd7b619c2010-02-25 05:36:46 +0000219 struct mutex session_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500221 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000223 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 __u16 ipc_tid; /* special tid for connection to IPC share */
225 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000226 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700227 char *serverOS; /* name of operating system underlying server */
228 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 char *serverDomain; /* security realm of server */
230 int Suid; /* remote smb uid */
Jeff Layton3e4b3e12010-07-19 18:00:17 -0400231 uid_t linux_uid; /* overriding owner of files on the mount */
232 uid_t cred_uid; /* owner of credentials */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 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 */
Suresh Jayaramand03382c2010-07-05 18:12:27 +0530317#ifdef CONFIG_CIFS_FSCACHE
318 u64 resource_id; /* server resource id */
319 struct fscache_cookie *fscache; /* cookie for share */
320#endif
Steve Frenchc18c8422007-07-18 23:21:09 +0000321 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322};
323
324/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000325 * This info hangs off the cifsFileInfo structure, pointed to by llist.
326 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 */
328struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000329 struct list_head llist; /* pointer to next cifsLockInfo */
330 __u64 offset;
331 __u64 length;
332 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333};
334
335/*
336 * One of these for each open instance of a file
337 */
338struct cifs_search_info {
339 loff_t index_of_last_entry;
340 __u16 entries_in_buffer;
341 __u16 info_level;
342 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000343 char *ntwrk_buf_start;
344 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000345 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000346 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000348 bool endOfSearch:1;
349 bool emptyDir:1;
350 bool unicode:1;
351 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352};
353
354struct cifsFileInfo {
355 struct list_head tlist; /* pointer to next fid owned by tcon */
356 struct list_head flist; /* next fid (file instance) for this inode */
357 unsigned int uid; /* allows finding which FileInfo structure */
358 __u32 pid; /* process id who opened file */
359 __u16 netfid; /* file id from remote */
360 /* BB add lock scope info here if needed */ ;
361 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000362 struct file *pfile; /* needed for writepage */
363 struct inode *pInode; /* needed for oplock break */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400364 struct vfsmount *mnt;
Roland Dreier796e5662007-05-03 04:33:45 +0000365 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000366 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000367 bool closePend:1; /* file is marked to close */
368 bool invalidHandle:1; /* file closed via session abend */
Jeff Layton3bc303c2009-09-21 06:47:50 -0400369 bool oplock_break_cancelled:1;
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400370 atomic_t count; /* reference count */
Steve Frencha6ce4932009-04-09 01:14:32 +0000371 struct mutex fh_mutex; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 struct cifs_search_info srch_inf;
Tejun Heo9b646972010-07-20 22:09:02 +0200373 struct work_struct oplock_break; /* work for oplock breaks */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374};
375
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400376/* Take a reference on the file private data */
377static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
378{
379 atomic_inc(&cifs_file->count);
380}
381
382/* Release a reference on the file private data */
383static inline void cifsFileInfo_put(struct cifsFileInfo *cifs_file)
384{
Jeff Layton48541bd2009-09-12 11:54:29 -0400385 if (atomic_dec_and_test(&cifs_file->count)) {
386 iput(cifs_file->pInode);
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400387 kfree(cifs_file);
Jeff Layton48541bd2009-09-12 11:54:29 -0400388 }
Dave Kleikamp6ab409b2009-08-31 11:07:12 -0400389}
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391/*
392 * One of these for each file inode
393 */
394
395struct cifsInodeInfo {
396 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000397 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 struct list_head openFileList;
399 int write_behind_rc;
400 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000402 bool clientCanCacheRead:1; /* read oplock */
403 bool clientCanCacheAll:1; /* read and writebehind oplock */
Jeff Layton9a8165f2008-10-17 21:03:20 -0400404 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Jeff Laytondf2cf172010-02-12 07:44:16 -0500405 bool invalid_mapping:1; /* pagecache is invalid */
Jeff Laytonfbec9ab2009-04-03 13:44:00 -0400406 u64 server_eof; /* current file size on server */
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400407 u64 uniqueid; /* server inode number */
Suresh Jayaraman9451a9a2010-07-05 18:12:45 +0530408#ifdef CONFIG_CIFS_FSCACHE
409 struct fscache_cookie *fscache;
410#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 struct inode vfs_inode;
412};
413
414static inline struct cifsInodeInfo *
415CIFS_I(struct inode *inode)
416{
417 return container_of(inode, struct cifsInodeInfo, vfs_inode);
418}
419
420static inline struct cifs_sb_info *
421CIFS_SB(struct super_block *sb)
422{
423 return sb->s_fs_info;
424}
425
Steve Frenchab2f2182005-09-15 20:44:50 -0700426static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700427{
428 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
429 return '/';
430 else
431 return '\\';
432}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Steve Frencha4544342005-08-24 13:59:35 -0700434#ifdef CONFIG_CIFS_STATS
435#define cifs_stats_inc atomic_inc
436
437static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
438 unsigned int bytes)
439{
440 if (bytes) {
441 spin_lock(&tcon->stat_lock);
442 tcon->bytes_written += bytes;
443 spin_unlock(&tcon->stat_lock);
444 }
445}
446
447static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
448 unsigned int bytes)
449{
450 spin_lock(&tcon->stat_lock);
451 tcon->bytes_read += bytes;
452 spin_unlock(&tcon->stat_lock);
453}
454#else
455
Steve Frenchd38d8c72007-06-28 19:44:13 +0000456#define cifs_stats_inc(field) do {} while (0)
457#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
458#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700459
460#endif
461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462/* one of these for every pending CIFS request to the server */
463struct mid_q_entry {
464 struct list_head qhead; /* mids waiting on reply from this server */
465 __u16 mid; /* multiplex id */
466 __u16 pid; /* process id */
467 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700468 unsigned long when_alloc; /* when mid was created */
469#ifdef CONFIG_CIFS_STATS2
470 unsigned long when_sent; /* time when smb send finished */
471 unsigned long when_received; /* when demux complete (taken off wire) */
472#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 struct task_struct *tsk; /* task waiting for response */
474 struct smb_hdr *resp_buf; /* response buffer */
475 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700476 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000477 bool largeBuf:1; /* if valid response, is pointer to large buf */
478 bool multiRsp:1; /* multiple trans2 responses for one request */
479 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480};
481
482struct oplock_q_entry {
483 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000484 struct inode *pinode;
485 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 __u16 netfid;
487};
488
Steve Frenchff5dbd92005-08-24 17:10:36 -0700489/* for pending dnotify requests */
490struct dir_notify_req {
491 struct list_head lhead;
492 __le16 Pid;
493 __le16 PidHigh;
494 __u16 Mid;
495 __u16 Tid;
496 __u16 Uid;
497 __u16 netfid;
498 __u32 filter; /* CompletionFilter (for multishot) */
499 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000500 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700501};
502
Steve French366781c2008-01-25 10:12:41 +0000503struct dfs_info3_param {
504 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000505 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000506 int server_type;
507 int ref_flag;
508 char *path_name;
509 char *node_name;
510};
511
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400512/*
513 * common struct for holding inode info when searching for or updating an
514 * inode with new info
515 */
516
517#define CIFS_FATTR_DFS_REFERRAL 0x1
Jeff Layton0b8f18e2009-07-09 01:46:37 -0400518#define CIFS_FATTR_DELETE_PENDING 0x2
519#define CIFS_FATTR_NEED_REVAL 0x4
Jeff Layton3d694382010-05-11 14:59:55 -0400520#define CIFS_FATTR_INO_COLLISION 0x8
Jeff Laytoncc0bad72009-06-25 00:56:52 -0400521
522struct cifs_fattr {
523 u32 cf_flags;
524 u32 cf_cifsattrs;
525 u64 cf_uniqueid;
526 u64 cf_eof;
527 u64 cf_bytes;
528 uid_t cf_uid;
529 gid_t cf_gid;
530 umode_t cf_mode;
531 dev_t cf_rdev;
532 unsigned int cf_nlink;
533 unsigned int cf_dtype;
534 struct timespec cf_atime;
535 struct timespec cf_mtime;
536 struct timespec cf_ctime;
537};
538
Steve French366781c2008-01-25 10:12:41 +0000539static inline void free_dfs_info_param(struct dfs_info3_param *param)
540{
541 if (param) {
542 kfree(param->path_name);
543 kfree(param->node_name);
544 kfree(param);
545 }
546}
547
548static inline void free_dfs_info_array(struct dfs_info3_param *param,
549 int number_of_items)
550{
551 int i;
552 if ((number_of_items == 0) || (param == NULL))
553 return;
554 for (i = 0; i < number_of_items; i++) {
555 kfree(param[i].path_name);
556 kfree(param[i].node_name);
557 }
558 kfree(param);
559}
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561#define MID_FREE 0
562#define MID_REQUEST_ALLOCATED 1
563#define MID_REQUEST_SUBMITTED 2
564#define MID_RESPONSE_RECEIVED 4
565#define MID_RETRY_NEEDED 8 /* session closed while this request out */
566#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800567
568/* Types of response buffer returned from SendReceive2 */
569#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
570#define CIFS_SMALL_BUFFER 1
571#define CIFS_LARGE_BUFFER 2
572#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Steve French133672e2007-11-13 22:41:37 +0000574/* Type of Request to SendReceive2 */
575#define CIFS_STD_OP 0 /* normal request timeout */
576#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
577#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
578#define CIFS_BLOCKING_OP 4 /* operation can block */
579#define CIFS_ASYNC_OP 8 /* do not wait for response */
580#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
581#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
582#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
583#define CIFS_NO_RESP 0x040 /* no response buffer required */
584
Steve French39798772006-05-31 22:40:51 +0000585/* Security Flags: indicate type of session setup needed */
586#define CIFSSEC_MAY_SIGN 0x00001
587#define CIFSSEC_MAY_NTLM 0x00002
588#define CIFSSEC_MAY_NTLMV2 0x00004
589#define CIFSSEC_MAY_KRB5 0x00008
590#ifdef CONFIG_CIFS_WEAK_PW_HASH
591#define CIFSSEC_MAY_LANMAN 0x00010
592#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000593#else
594#define CIFSSEC_MAY_LANMAN 0
595#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000596#endif /* weak passwords */
597#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000598#define CIFSSEC_MAY_NTLMSSP 0x00080 /* raw ntlmssp with ntlmv2 */
Steve French5815449d2006-02-14 01:36:20 +0000599
Steve French39798772006-05-31 22:40:51 +0000600#define CIFSSEC_MUST_SIGN 0x01001
601/* note that only one of the following can be set so the
602result of setting MUST flags more than once will be to
603require use of the stronger protocol */
604#define CIFSSEC_MUST_NTLM 0x02002
605#define CIFSSEC_MUST_NTLMV2 0x04004
606#define CIFSSEC_MUST_KRB5 0x08008
607#ifdef CONFIG_CIFS_WEAK_PW_HASH
608#define CIFSSEC_MUST_LANMAN 0x10010
609#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000610#ifdef CONFIG_CIFS_UPCALL
Chuck Ebbert20d17522009-09-15 01:53:21 -0400611#define CIFSSEC_MASK 0xBF0BF /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000612#else
Chuck Ebbert20d17522009-09-15 01:53:21 -0400613#define CIFSSEC_MASK 0xB70B7 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000614#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000615#else /* do not allow weak pw hash */
616#ifdef CONFIG_CIFS_UPCALL
Steve Frenchac683922009-05-06 04:16:04 +0000617#define CIFSSEC_MASK 0x8F08F /* flags supported if no weak allowed */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000618#else
Steve Frenchac683922009-05-06 04:16:04 +0000619#define CIFSSEC_MASK 0x87087 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000620#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000621#endif /* WEAK_PW_HASH */
622#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
Steve Frenchac683922009-05-06 04:16:04 +0000623#define CIFSSEC_MUST_NTLMSSP 0x80080 /* raw ntlmssp with ntlmv2 */
Steve French39798772006-05-31 22:40:51 +0000624
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000625#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
626#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frenchac683922009-05-06 04:16:04 +0000627#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 -0700628/*
629 *****************************************************************
630 * All constants go here
631 *****************************************************************
632 */
633
634#define UID_HASH (16)
635
636/*
637 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
638 * following to be declared.
639 */
640
641/****************************************************************************
642 * Locking notes. All updates to global variables and lists should be
643 * protected by spinlocks or semaphores.
644 *
645 * Spinlocks
646 * ---------
647 * GlobalMid_Lock protects:
648 * list operations on pending_mid_q and oplockQ
649 * updates to XID counters, multiplex id and SMB sequence numbers
650 * GlobalSMBSesLock protects:
651 * list operations on tcp and SMB session lists and tCon lists
652 * f_owner.lock protects certain per file struct operations
653 * mapping->page_lock protects certain per page operations
654 *
655 * Semaphores
656 * ----------
657 * sesSem operations on smb session
658 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000659 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 *
661 ****************************************************************************/
662
663#ifdef DECLARE_GLOBALS_HERE
664#define GLOBAL_EXTERN
665#else
666#define GLOBAL_EXTERN extern
667#endif
668
Jeff Laytone7ddee92008-11-14 13:44:38 -0500669/*
670 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000671 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500672 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000673 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500674 * by iterating over cifs_tcp_ses_list
675 */
676GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
677
Jeff Laytonf1987b42008-11-15 11:12:47 -0500678/*
679 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
680 * tcp session, and the list of tcon's per smb session. It also protects
681 * the reference counters for the server, smb session, and tcon. Finally,
682 * changes to the tcon->tidStatus should be done while holding this lock.
683 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500684GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000685
686/*
687 * This lock protects the cifs_file->llist and cifs_file->flist
688 * list operations, and updates to some flags (cifs_file->invalidHandle)
689 * It will be moved to either use the tcon->stat_lock or equivalent later.
690 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
691 * the cifs_tcp_ses_lock must be grabbed first and released last.
692 */
693GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Steve French99ee4db2007-02-27 05:35:17 +0000695/* Outstanding dir notify requests */
696GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
697/* DirNotify response queue */
698GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700/*
701 * Global transaction id (XID) information
702 */
703GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000704GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000706GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
707 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708GLOBAL_EXTERN char Local_System_Name[15];
709
710/*
711 * Global counters, updated atomically
712 */
713GLOBAL_EXTERN atomic_t sesInfoAllocCount;
714GLOBAL_EXTERN atomic_t tconInfoAllocCount;
715GLOBAL_EXTERN atomic_t tcpSesAllocCount;
716GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
717GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
718
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000719/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -0800720GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
721#ifdef CONFIG_CIFS_STATS2
722GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
723GLOBAL_EXTERN atomic_t totSmBufAllocCount;
724#endif
725GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726GLOBAL_EXTERN atomic_t midCount;
727
728/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000729GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000731 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 or equivalent for current user */
733GLOBAL_EXTERN unsigned int oplockEnabled;
734GLOBAL_EXTERN unsigned int experimEnabled;
735GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Jeff Layton04912d62010-04-24 07:57:45 -0400736GLOBAL_EXTERN unsigned int global_secflags; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
740GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
741GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
742GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
743GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
744
Tejun Heo9b646972010-07-20 22:09:02 +0200745void cifs_oplock_break(struct work_struct *work);
746void cifs_oplock_break_get(struct cifsFileInfo *cfile);
747void cifs_oplock_break_put(struct cifsFileInfo *cfile);
Linus Torvalds3b7433b2010-08-07 12:42:58 -0700748
Jeff Layton3bc303c2009-09-21 06:47:50 -0400749extern const struct slow_work_ops cifs_oplock_break_ops;
Suresh Jayaramanabd2e442010-06-22 20:52:50 +0530750
751#endif /* _CIFS_GLOB_H */