blob: e004f6db5fc87904e21d6ebc4eb0cb56ccc15d29 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * fs/cifs/cifsglob.h
3 *
Steve French366781c2008-01-25 10:12:41 +00004 * Copyright (C) International Business Machines Corp., 2002,2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Author(s): Steve French (sfrench@us.ibm.com)
Jeremy Allison7ee1af72006-08-02 21:56:33 +00006 * Jeremy Allison (jra@samba.org)
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License as published
10 * by the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
16 * the GNU Lesser General Public License for more details.
Steve Frenchd38d8c72007-06-28 19:44:13 +000017 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 */
19#include <linux/in.h>
20#include <linux/in6.h>
21#include "cifs_fs_sb.h"
Steve French442aa312007-09-24 20:25:46 +000022#include "cifsacl.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/*
24 * The sizes of various internal tables and strings
25 */
26#define MAX_UID_INFO 16
27#define MAX_SES_INFO 2
28#define MAX_TCON_INFO 4
29
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +000030#define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#define MAX_SERVER_SIZE 15
Steve Frenchd38d8c72007-06-28 19:44:13 +000032#define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
34 termination then *2 for unicode versions */
35#define MAX_PASSWORD_SIZE 16
36
37#define CIFS_MIN_RCV_POOL 4
38
39/*
40 * MAX_REQ is the maximum number of requests that WE will send
41 * on one socket concurently. It also matches the most common
Steve Frenchd38d8c72007-06-28 19:44:13 +000042 * value of max multiplex returned by servers. We may
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 * eventually want to use the negotiated value (in case
44 * future servers can handle more) when we are more confident that
45 * we will not have problems oveloading the socket with pending
46 * write data.
47 */
Steve Frenchd38d8c72007-06-28 19:44:13 +000048#define CIFS_MAX_REQ 50
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Jeff Layton8ecaf672008-12-01 15:23:50 -050050#define RFC1001_NAME_LEN 15
51#define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
52
53/* currently length of NIP6_FMT */
54#define SERVER_NAME_LENGTH 40
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
56
57/* used to define string lengths for reversing unicode strings */
58/* (256+1)*2 = 514 */
59/* (max path length + 1 for null) * 2 for unicode */
60#define MAX_NAME 514
61
62#include "cifspdu.h"
63
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#ifndef XATTR_DOS_ATTRIB
65#define XATTR_DOS_ATTRIB "user.DOSATTRIB"
66#endif
67
68/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 * CIFS vfs client Status information (based on what we know.)
70 */
71
72 /* associated with each tcp and smb session */
73enum statusEnum {
74 CifsNew = 0,
75 CifsGood,
76 CifsExiting,
77 CifsNeedReconnect
78};
79
80enum securityEnum {
Steve Frencha0136892007-10-04 20:05:09 +000081 PLAINTXT = 0, /* Legacy with Plaintext passwords */
82 LANMAN, /* Legacy LANMAN auth */
Steve French39798772006-05-31 22:40:51 +000083 NTLM, /* Legacy NTLM012 auth with NTLM hash */
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
85 RawNTLMSSP, /* NTLMSSP without SPNEGO */
86 NTLMSSP, /* NTLMSSP via SPNEGO */
Steve Frenchc16fefa2008-08-19 19:35:33 +000087 Kerberos, /* Kerberos via SPNEGO */
88 MSKerberos, /* MS Kerberos via SPNEGO */
Linus Torvalds1da177e2005-04-16 15:20:36 -070089};
90
91enum protocolEnum {
Steve French3ec332e2008-11-14 03:35:10 +000092 TCP = 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 SCTP
94 /* Netbios frames protocol not supported at this time */
95};
96
Steve Frenchb609f062007-07-09 07:55:14 +000097struct mac_key {
98 unsigned int len;
99 union {
100 char ntlm[CIFS_SESS_KEY_SIZE + 16];
Steve French24424212007-11-16 23:37:35 +0000101 char krb5[CIFS_SESS_KEY_SIZE + 16]; /* BB: length correct? */
Steve Frenchb609f062007-07-09 07:55:14 +0000102 struct {
103 char key[16];
104 struct ntlmv2_resp resp;
105 } ntlmv2;
106 } data;
107};
108
Steve French442aa312007-09-24 20:25:46 +0000109struct cifs_cred {
110 int uid;
111 int gid;
112 int mode;
113 int cecount;
114 struct cifs_sid osid;
115 struct cifs_sid gsid;
116 struct cifs_ntace *ntaces;
117 struct cifs_ace *aces;
118};
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/*
121 *****************************************************************
122 * Except the CIFS PDUs themselves all the
123 * globally interesting structs should go here
124 *****************************************************************
125 */
126
127struct TCP_Server_Info {
Steve French3b795212008-11-13 19:45:32 +0000128 struct list_head tcp_ses_list;
129 struct list_head smb_ses_list;
Jeff Laytone7ddee92008-11-14 13:44:38 -0500130 int srv_count; /* reference counter */
Steve Frencha10faeb22005-08-22 21:38:31 -0700131 /* 15 character server name + 0x20 16th byte indicating type = srv */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500132 char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Jeff Laytonc359cf32007-11-16 22:22:06 +0000133 char *hostname; /* hostname portion of UNC string */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 struct socket *ssocket;
135 union {
136 struct sockaddr_in sockAddr;
137 struct sockaddr_in6 sockAddr6;
138 } addr;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000139 wait_queue_head_t response_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
141 struct list_head pending_mid_q;
142 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
143 unsigned short server_codepage; /* codepage for the server */
Steve French131afd0b2005-10-07 09:51:05 -0700144 unsigned long ip_address; /* IP addr for the server if known */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000145 enum protocolEnum protocolType;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 char versionMajor;
147 char versionMinor;
Steve French4b18f2a2008-04-29 00:06:05 +0000148 bool svlocal:1; /* local server or remote */
Steve Frenchedf1ae42008-10-29 00:47:57 +0000149 bool noblocksnd; /* use blocking sendmsg */
150 bool noautotune; /* do not autotune send buf sizes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 atomic_t inFlight; /* number of requests on the wire to server */
Steve French131afd0b2005-10-07 09:51:05 -0700152#ifdef CONFIG_CIFS_STATS2
153 atomic_t inSend; /* requests trying to send */
154 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
155#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 enum statusEnum tcpStatus; /* what we think the status is */
Jeff Layton72ca5452008-12-01 07:09:36 -0500157 struct mutex srv_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158 struct task_struct *tsk;
159 char server_GUID[16];
160 char secMode;
161 enum securityEnum secType;
162 unsigned int maxReq; /* Clients should submit no more */
163 /* than maxReq distinct unanswered SMBs to the server when using */
164 /* multiplexed reads or writes */
165 unsigned int maxBuf; /* maxBuf specifies the maximum */
166 /* message size the server can send or receive for non-raw SMBs */
Steve Frencheca6acf2009-02-20 05:43:09 +0000167 unsigned int max_rw; /* maxRw specifies the maximum */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 /* message size the server can send or receive for */
169 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
Steve Frencheca6acf2009-02-20 05:43:09 +0000170 unsigned int max_vcs; /* maximum number of smb sessions, at least
171 those that can be specified uniquely with
172 vcnumbers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 char sessid[4]; /* unique token id for this session */
174 /* (returned on Negotiate */
175 int capabilities; /* allow selective disabling of caps by smb sess */
Steve Frenchde7ed552006-09-30 13:25:52 +0000176 int timeAdj; /* Adjust for difference in server time zone in sec */
Steve French1982c342005-08-17 12:38:22 -0700177 __u16 CurrentMid; /* multiplex id - rotating counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
Steve Frencha10faeb22005-08-22 21:38:31 -0700179 /* 16th byte of RFC1001 workstation name is always null */
Jeff Layton8ecaf672008-12-01 15:23:50 -0500180 char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
Steve Frenchad009ac2005-04-28 22:41:05 -0700181 __u32 sequence_number; /* needed for CIFS PDU signature */
Steve Frenchb609f062007-07-09 07:55:14 +0000182 struct mac_key mac_signing_key;
183 char ntlmv2_hash[16];
Steve French3a5ff612006-07-14 22:37:11 +0000184 unsigned long lstrp; /* when we got last response from this server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185};
186
187/*
188 * The following is our shortcut to user information. We surface the uid,
189 * and name. We always get the password on the fly in case it
Steve Frenchd38d8c72007-06-28 19:44:13 +0000190 * has changed. We also hang a list of sessions owned by this user off here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 */
192struct cifsUidInfo {
193 struct list_head userList;
194 struct list_head sessionList; /* SMB sessions for this user */
195 uid_t linux_uid;
196 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
197 /* BB may need ptr or callback for PAM or WinBind info */
198};
199
200/*
201 * 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 struct semaphore sesSem;
Steve French39798772006-05-31 22:40:51 +0000207#if 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 struct cifsUidInfo *uidInfo; /* pointer to user info */
Steve French39798772006-05-31 22:40:51 +0000209#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct TCP_Server_Info *server; /* pointer to server info */
Jeff Layton14fbf502008-11-14 13:53:46 -0500211 int ses_count; /* reference counter */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 enum statusEnum status;
Steve French750d1152006-06-27 06:28:30 +0000213 unsigned overrideSecFlg; /* if non-zero override global sec flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 __u16 ipc_tid; /* special tid for connection to IPC share */
215 __u16 flags;
Steve Frencheca6acf2009-02-20 05:43:09 +0000216 __u16 vcnum;
Steve Frenchad009ac2005-04-28 22:41:05 -0700217 char *serverOS; /* name of operating system underlying server */
218 char *serverNOS; /* name of network operating system of server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 char *serverDomain; /* security realm of server */
220 int Suid; /* remote smb uid */
221 uid_t linux_uid; /* local Linux uid */
222 int capabilities;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000223 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
Steve Frenchad009ac2005-04-28 22:41:05 -0700224 TCP names - will ipv6 and sctp addresses fit? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 char userName[MAX_USERNAME_SIZE + 1];
Steve Frenchd38d8c72007-06-28 19:44:13 +0000226 char *domainName;
227 char *password;
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;
257 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;
262 atomic_t num_rmdirs;
263 atomic_t num_renames;
264 atomic_t num_t2renames;
Steve Frenchdfb75332005-06-22 17:13:47 -0700265 atomic_t num_ffirst;
266 atomic_t num_fnext;
267 atomic_t num_fclose;
Steve Frencha5a2b482005-08-20 21:42:53 -0700268 atomic_t num_hardlinks;
269 atomic_t num_symlinks;
270 atomic_t num_locks;
Steve French0a4b92c2006-01-12 15:44:21 -0800271 atomic_t num_acl_get;
272 atomic_t num_acl_set;
Steve Frencha5a2b482005-08-20 21:42:53 -0700273#ifdef CONFIG_CIFS_STATS2
274 unsigned long long time_writes;
275 unsigned long long time_reads;
276 unsigned long long time_opens;
277 unsigned long long time_deletes;
278 unsigned long long time_closes;
279 unsigned long long time_mkdirs;
280 unsigned long long time_rmdirs;
281 unsigned long long time_renames;
282 unsigned long long time_t2renames;
283 unsigned long long time_ffirst;
284 unsigned long long time_fnext;
285 unsigned long long time_fclose;
286#endif /* CONFIG_CIFS_STATS2 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 __u64 bytes_read;
288 __u64 bytes_written;
289 spinlock_t stat_lock;
Steve Frencha5a2b482005-08-20 21:42:53 -0700290#endif /* CONFIG_CIFS_STATS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
Steve French254e55e2006-06-04 05:53:15 +0000292 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
Steve French4b18f2a2008-04-29 00:06:05 +0000294 bool ipc:1; /* set if connection to IPC$ eg for RPC/PIPES */
295 bool retry:1;
296 bool nocase:1;
Steve French95b1cb92008-05-15 16:44:38 +0000297 bool seal:1; /* transport encryption for this mounted share */
Steve French4b18f2a2008-04-29 00:06:05 +0000298 bool unix_ext:1; /* if false disable Linux extensions to CIFS protocol
Steve Frenchc18c8422007-07-18 23:21:09 +0000299 for this mount even if server would support */
Steve French84210e92008-10-23 04:42:37 +0000300 bool local_lease:1; /* check leases (only) on local system not remote */
Steve French3b795212008-11-13 19:45:32 +0000301 bool need_reconnect:1; /* connection reset, tid now invalid */
Steve Frenchc18c8422007-07-18 23:21:09 +0000302 /* BB add field for back pointer to sb struct(s)? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303};
304
305/*
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000306 * This info hangs off the cifsFileInfo structure, pointed to by llist.
307 * This is used to track byte stream locks on the file
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 */
309struct cifsLockInfo {
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000310 struct list_head llist; /* pointer to next cifsLockInfo */
311 __u64 offset;
312 __u64 length;
313 __u8 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314};
315
316/*
317 * One of these for each open instance of a file
318 */
319struct cifs_search_info {
320 loff_t index_of_last_entry;
321 __u16 entries_in_buffer;
322 __u16 info_level;
323 __u32 resume_key;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000324 char *ntwrk_buf_start;
325 char *srch_entries_start;
Steve French0752f152008-10-07 20:03:33 +0000326 char *last_entry;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000327 char *presume_name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 unsigned int resume_name_len;
Steve French4b18f2a2008-04-29 00:06:05 +0000329 bool endOfSearch:1;
330 bool emptyDir:1;
331 bool unicode:1;
332 bool smallBuf:1; /* so we know which buf_release function to call */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333};
334
335struct cifsFileInfo {
336 struct list_head tlist; /* pointer to next fid owned by tcon */
337 struct list_head flist; /* next fid (file instance) for this inode */
338 unsigned int uid; /* allows finding which FileInfo structure */
339 __u32 pid; /* process id who opened file */
340 __u16 netfid; /* file id from remote */
341 /* BB add lock scope info here if needed */ ;
342 /* lock scope id (0 if none) */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000343 struct file *pfile; /* needed for writepage */
344 struct inode *pInode; /* needed for oplock break */
Roland Dreier796e5662007-05-03 04:33:45 +0000345 struct mutex lock_mutex;
Jeremy Allison7ee1af72006-08-02 21:56:33 +0000346 struct list_head llist; /* list of byte range locks we have. */
Steve French4b18f2a2008-04-29 00:06:05 +0000347 bool closePend:1; /* file is marked to close */
348 bool invalidHandle:1; /* file closed via session abend */
349 bool messageMode:1; /* for pipes: message vs byte mode */
Steve French23e7dd72005-10-20 13:44:56 -0700350 atomic_t wrtPending; /* handle in use - defer close */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 struct cifs_search_info srch_inf;
353};
354
355/*
356 * One of these for each file inode
357 */
358
359struct cifsInodeInfo {
360 struct list_head lockList;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000361 /* BB add in lists for dirty pages i.e. write caching info for oplock */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 struct list_head openFileList;
363 int write_behind_rc;
364 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
365 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
366 unsigned long time; /* jiffies of last update/check of inode */
Steve French4b18f2a2008-04-29 00:06:05 +0000367 bool clientCanCacheRead:1; /* read oplock */
368 bool clientCanCacheAll:1; /* read and writebehind oplock */
369 bool oplockPending:1;
Jeff Layton9a8165f2008-10-17 21:03:20 -0400370 bool delete_pending:1; /* DELETE_ON_CLOSE is set */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 struct inode vfs_inode;
372};
373
374static inline struct cifsInodeInfo *
375CIFS_I(struct inode *inode)
376{
377 return container_of(inode, struct cifsInodeInfo, vfs_inode);
378}
379
380static inline struct cifs_sb_info *
381CIFS_SB(struct super_block *sb)
382{
383 return sb->s_fs_info;
384}
385
Steve Frenchab2f2182005-09-15 20:44:50 -0700386static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
Jeremy Allisonac670552005-06-22 17:26:35 -0700387{
388 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
389 return '/';
390 else
391 return '\\';
392}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Steve Frencha4544342005-08-24 13:59:35 -0700394#ifdef CONFIG_CIFS_STATS
395#define cifs_stats_inc atomic_inc
396
397static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
398 unsigned int bytes)
399{
400 if (bytes) {
401 spin_lock(&tcon->stat_lock);
402 tcon->bytes_written += bytes;
403 spin_unlock(&tcon->stat_lock);
404 }
405}
406
407static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
408 unsigned int bytes)
409{
410 spin_lock(&tcon->stat_lock);
411 tcon->bytes_read += bytes;
412 spin_unlock(&tcon->stat_lock);
413}
414#else
415
Steve Frenchd38d8c72007-06-28 19:44:13 +0000416#define cifs_stats_inc(field) do {} while (0)
417#define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
418#define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
Steve Frencha4544342005-08-24 13:59:35 -0700419
420#endif
421
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422/* one of these for every pending CIFS request to the server */
423struct mid_q_entry {
424 struct list_head qhead; /* mids waiting on reply from this server */
425 __u16 mid; /* multiplex id */
426 __u16 pid; /* process id */
427 __u32 sequence_number; /* for CIFS signing */
Steve French1047abc2005-10-11 19:58:06 -0700428 unsigned long when_alloc; /* when mid was created */
429#ifdef CONFIG_CIFS_STATS2
430 unsigned long when_sent; /* time when smb send finished */
431 unsigned long when_received; /* when demux complete (taken off wire) */
432#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 struct task_struct *tsk; /* task waiting for response */
434 struct smb_hdr *resp_buf; /* response buffer */
435 int midState; /* wish this were enum but can not pass to wait_event */
Steve Frenchc81156d2005-04-28 22:41:07 -0700436 __u8 command; /* smb command code */
Steve French4b18f2a2008-04-29 00:06:05 +0000437 bool largeBuf:1; /* if valid response, is pointer to large buf */
438 bool multiRsp:1; /* multiple trans2 responses for one request */
439 bool multiEnd:1; /* both received */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440};
441
442struct oplock_q_entry {
443 struct list_head qhead;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000444 struct inode *pinode;
445 struct cifsTconInfo *tcon;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 __u16 netfid;
447};
448
Steve Frenchff5dbd92005-08-24 17:10:36 -0700449/* for pending dnotify requests */
450struct dir_notify_req {
451 struct list_head lhead;
452 __le16 Pid;
453 __le16 PidHigh;
454 __u16 Mid;
455 __u16 Tid;
456 __u16 Uid;
457 __u16 netfid;
458 __u32 filter; /* CompletionFilter (for multishot) */
459 int multishot;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000460 struct file *pfile;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700461};
462
Steve French366781c2008-01-25 10:12:41 +0000463struct dfs_info3_param {
464 int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
Igor Mammedov8aad0182008-02-15 18:21:49 +0000465 int path_consumed;
Steve French366781c2008-01-25 10:12:41 +0000466 int server_type;
467 int ref_flag;
468 char *path_name;
469 char *node_name;
470};
471
472static inline void free_dfs_info_param(struct dfs_info3_param *param)
473{
474 if (param) {
475 kfree(param->path_name);
476 kfree(param->node_name);
477 kfree(param);
478 }
479}
480
481static inline void free_dfs_info_array(struct dfs_info3_param *param,
482 int number_of_items)
483{
484 int i;
485 if ((number_of_items == 0) || (param == NULL))
486 return;
487 for (i = 0; i < number_of_items; i++) {
488 kfree(param[i].path_name);
489 kfree(param[i].node_name);
490 }
491 kfree(param);
492}
493
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494#define MID_FREE 0
495#define MID_REQUEST_ALLOCATED 1
496#define MID_REQUEST_SUBMITTED 2
497#define MID_RESPONSE_RECEIVED 4
498#define MID_RETRY_NEEDED 8 /* session closed while this request out */
499#define MID_NO_RESP_NEEDED 0x10
Steve Frenchec637e32005-12-12 20:53:18 -0800500
501/* Types of response buffer returned from SendReceive2 */
502#define CIFS_NO_BUFFER 0 /* Response buffer not returned */
503#define CIFS_SMALL_BUFFER 1
504#define CIFS_LARGE_BUFFER 2
505#define CIFS_IOVEC 4 /* array of response buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Steve French133672e2007-11-13 22:41:37 +0000507/* Type of Request to SendReceive2 */
508#define CIFS_STD_OP 0 /* normal request timeout */
509#define CIFS_LONG_OP 1 /* long op (up to 45 sec, oplock time) */
510#define CIFS_VLONG_OP 2 /* sloow op - can take up to 180 seconds */
511#define CIFS_BLOCKING_OP 4 /* operation can block */
512#define CIFS_ASYNC_OP 8 /* do not wait for response */
513#define CIFS_TIMEOUT_MASK 0x00F /* only one of 5 above set in req */
514#define CIFS_LOG_ERROR 0x010 /* log NT STATUS if non-zero */
515#define CIFS_LARGE_BUF_OP 0x020 /* large request buffer */
516#define CIFS_NO_RESP 0x040 /* no response buffer required */
517
Steve French39798772006-05-31 22:40:51 +0000518/* Security Flags: indicate type of session setup needed */
519#define CIFSSEC_MAY_SIGN 0x00001
520#define CIFSSEC_MAY_NTLM 0x00002
521#define CIFSSEC_MAY_NTLMV2 0x00004
522#define CIFSSEC_MAY_KRB5 0x00008
523#ifdef CONFIG_CIFS_WEAK_PW_HASH
524#define CIFSSEC_MAY_LANMAN 0x00010
525#define CIFSSEC_MAY_PLNTXT 0x00020
Steve French516897a2007-10-12 19:24:06 +0000526#else
527#define CIFSSEC_MAY_LANMAN 0
528#define CIFSSEC_MAY_PLNTXT 0
Steve French39798772006-05-31 22:40:51 +0000529#endif /* weak passwords */
530#define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
Steve French5815449d2006-02-14 01:36:20 +0000531
Steve French39798772006-05-31 22:40:51 +0000532#define CIFSSEC_MUST_SIGN 0x01001
533/* note that only one of the following can be set so the
534result of setting MUST flags more than once will be to
535require use of the stronger protocol */
536#define CIFSSEC_MUST_NTLM 0x02002
537#define CIFSSEC_MUST_NTLMV2 0x04004
538#define CIFSSEC_MUST_KRB5 0x08008
539#ifdef CONFIG_CIFS_WEAK_PW_HASH
540#define CIFSSEC_MUST_LANMAN 0x10010
541#define CIFSSEC_MUST_PLNTXT 0x20020
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000542#ifdef CONFIG_CIFS_UPCALL
543#define CIFSSEC_MASK 0x3F03F /* allows weak security but also krb5 */
Steve Frenchd38d8c72007-06-28 19:44:13 +0000544#else
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000545#define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
Steve French016ec752007-10-16 18:10:10 +0000546#endif /* UPCALL */
Jeff Layton0d3a01f2007-10-16 17:32:19 +0000547#else /* do not allow weak pw hash */
548#ifdef CONFIG_CIFS_UPCALL
549#define CIFSSEC_MASK 0x0F00F /* flags supported if no weak allowed */
550#else
551#define CIFSSEC_MASK 0x07007 /* flags supported if no weak allowed */
Steve French016ec752007-10-16 18:10:10 +0000552#endif /* UPCALL */
Steve French39798772006-05-31 22:40:51 +0000553#endif /* WEAK_PW_HASH */
554#define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
555
Shirish Pargaonkaref571ca2008-07-24 15:56:05 +0000556#define CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
557#define CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
Steve Frencha0136892007-10-04 20:05:09 +0000558#define CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559/*
560 *****************************************************************
561 * All constants go here
562 *****************************************************************
563 */
564
565#define UID_HASH (16)
566
567/*
568 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
569 * following to be declared.
570 */
571
572/****************************************************************************
573 * Locking notes. All updates to global variables and lists should be
574 * protected by spinlocks or semaphores.
575 *
576 * Spinlocks
577 * ---------
578 * GlobalMid_Lock protects:
579 * list operations on pending_mid_q and oplockQ
580 * updates to XID counters, multiplex id and SMB sequence numbers
581 * GlobalSMBSesLock protects:
582 * list operations on tcp and SMB session lists and tCon lists
583 * f_owner.lock protects certain per file struct operations
584 * mapping->page_lock protects certain per page operations
585 *
586 * Semaphores
587 * ----------
588 * sesSem operations on smb session
589 * tconSem operations on tree connection
Steve Frenchd38d8c72007-06-28 19:44:13 +0000590 * fh_sem file handle reconnection operations
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 *
592 ****************************************************************************/
593
594#ifdef DECLARE_GLOBALS_HERE
595#define GLOBAL_EXTERN
596#else
597#define GLOBAL_EXTERN extern
598#endif
599
Jeff Laytone7ddee92008-11-14 13:44:38 -0500600/*
601 * the list of TCP_Server_Info structures, ie each of the sockets
Steve Frenchfb396012008-11-13 20:04:07 +0000602 * connecting our client to a distinct server (ip address), is
Jeff Laytone7ddee92008-11-14 13:44:38 -0500603 * chained together by cifs_tcp_ses_list. The list of all our SMB
Steve Frenchfb396012008-11-13 20:04:07 +0000604 * sessions (and from that the tree connections) can be found
Jeff Laytone7ddee92008-11-14 13:44:38 -0500605 * by iterating over cifs_tcp_ses_list
606 */
607GLOBAL_EXTERN struct list_head cifs_tcp_ses_list;
608
Jeff Laytonf1987b42008-11-15 11:12:47 -0500609/*
610 * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
611 * tcp session, and the list of tcon's per smb session. It also protects
612 * the reference counters for the server, smb session, and tcon. Finally,
613 * changes to the tcon->tidStatus should be done while holding this lock.
614 */
Jeff Laytone7ddee92008-11-14 13:44:38 -0500615GLOBAL_EXTERN rwlock_t cifs_tcp_ses_lock;
Steve Frenchddb4cbf2008-11-20 20:00:44 +0000616
617/*
618 * This lock protects the cifs_file->llist and cifs_file->flist
619 * list operations, and updates to some flags (cifs_file->invalidHandle)
620 * It will be moved to either use the tcon->stat_lock or equivalent later.
621 * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
622 * the cifs_tcp_ses_lock must be grabbed first and released last.
623 */
624GLOBAL_EXTERN rwlock_t GlobalSMBSeslock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
626GLOBAL_EXTERN struct list_head GlobalOplock_Q;
627
Steve French99ee4db2007-02-27 05:35:17 +0000628/* Outstanding dir notify requests */
629GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
630/* DirNotify response queue */
631GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
Steve Frenchff5dbd92005-08-24 17:10:36 -0700632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/*
634 * Global transaction id (XID) information
635 */
636GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000637GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
Steve French254e55e2006-06-04 05:53:15 +0000639GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
640 /* on midQ entries */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641GLOBAL_EXTERN char Local_System_Name[15];
642
643/*
644 * Global counters, updated atomically
645 */
646GLOBAL_EXTERN atomic_t sesInfoAllocCount;
647GLOBAL_EXTERN atomic_t tconInfoAllocCount;
648GLOBAL_EXTERN atomic_t tcpSesAllocCount;
649GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
650GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
651
Steve Frenchaaa9bbe2008-05-23 17:38:32 +0000652/* Various Debug counters */
Steve French4498eed52005-12-03 13:58:57 -0800653GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
654#ifdef CONFIG_CIFS_STATS2
655GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
656GLOBAL_EXTERN atomic_t totSmBufAllocCount;
657#endif
658GLOBAL_EXTERN atomic_t smBufAllocCount;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659GLOBAL_EXTERN atomic_t midCount;
660
661/* Misc globals */
Steve French254e55e2006-06-04 05:53:15 +0000662GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 to be established on existing mount if we
Steve Frenchd38d8c72007-06-28 19:44:13 +0000664 have the uid/password or Kerberos credential
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 or equivalent for current user */
666GLOBAL_EXTERN unsigned int oplockEnabled;
667GLOBAL_EXTERN unsigned int experimEnabled;
668GLOBAL_EXTERN unsigned int lookupCacheEnabled;
Steve Frenchd38d8c72007-06-28 19:44:13 +0000669GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 with more secure ntlmssp2 challenge/resp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
673GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
674GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
675GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
676GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
677