1 /*
2 * fs/cifs/cifsglob.h
3 *
4 * Copyright (C) International Business Machines Corp., 2002,2003
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 *
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 * the GNU Lesser General Public License for more details.
16 *
17 */
18 #include <linux/in.h>
19 #include <linux/in6.h>
20 #include "cifs_fs_sb.h"
21 /*
22 * The sizes of various internal tables and strings
23 */
24 #define MAX_UID_INFO 16
25 #define MAX_SES_INFO 2
26 #define MAX_TCON_INFO 4
27
28 #define MAX_TREE_SIZE 2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1
29 #define MAX_SERVER_SIZE 15
30 #define MAX_SHARE_SIZE 64 /* used to be 20 - this should still be enough */
31 #define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
32 termination then *2 for unicode versions */
33 #define MAX_PASSWORD_SIZE 16
34
35 #define CIFS_MIN_RCV_POOL 4
36
37 /*
38 * MAX_REQ is the maximum number of requests that WE will send
39 * on one socket concurently. It also matches the most common
40 * value of max multiplex returned by servers. We may
41 * eventually want to use the negotiated value (in case
42 * future servers can handle more) when we are more confident that
43 * we will not have problems oveloading the socket with pending
44 * write data.
45 */
46 #define CIFS_MAX_REQ 50
47
48 #define SERVER_NAME_LENGTH 15
49 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
50
51 /* used to define string lengths for reversing unicode strings */
52 /* (256+1)*2 = 514 */
53 /* (max path length + 1 for null) * 2 for unicode */
54 #define MAX_NAME 514
55
56 #include "cifspdu.h"
57
58 #ifndef FALSE
59 #define FALSE 0
60 #endif
61
62 #ifndef TRUE
63 #define TRUE 1
64 #endif
65
66 #ifndef XATTR_DOS_ATTRIB
67 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
68 #endif
69
70 /*
71 * This information is kept on every Server we know about.
72 *
73 * Some things to note:
74 *
75 */
76 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
77
78 /*
79 * CIFS vfs client Status information (based on what we know.)
80 */
81
82 /* associated with each tcp and smb session */
83 enum statusEnum {
84 CifsNew = 0,
85 CifsGood,
86 CifsExiting,
87 CifsNeedReconnect
88 };
89
90 enum securityEnum {
91 NTLM = 0, /* Legacy NTLM012 auth with NTLM hash */
92 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
93 RawNTLMSSP, /* NTLMSSP without SPNEGO */
94 NTLMSSP, /* NTLMSSP via SPNEGO */
95 Kerberos /* Kerberos via SPNEGO */
96 };
97
98 enum protocolEnum {
99 IPV4 = 0,
100 IPV6,
101 SCTP
102 /* Netbios frames protocol not supported at this time */
103 };
104
105 /*
106 *****************************************************************
107 * Except the CIFS PDUs themselves all the
108 * globally interesting structs should go here
109 *****************************************************************
110 */
111
112 struct TCP_Server_Info {
113 char server_Name[SERVER_NAME_LEN_WITH_NULL]; /* 15 chars + X'20'in 16th */
114 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2]; /* Unicode version of server_Name */
115 struct socket *ssocket;
116 union {
117 struct sockaddr_in sockAddr;
118 struct sockaddr_in6 sockAddr6;
119 } addr;
120 wait_queue_head_t response_q;
121 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
122 struct list_head pending_mid_q;
123 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
124 unsigned short server_codepage; /* codepage for the server */
125 unsigned long ip_address; /* IP addr for the server if known */
126 enum protocolEnum protocolType;
127 char versionMajor;
128 char versionMinor;
129 unsigned svlocal:1; /* local server or remote */
130 atomic_t socketUseCount; /* number of open cifs sessions on socket */
131 atomic_t inFlight; /* number of requests on the wire to server */
132 enum statusEnum tcpStatus; /* what we think the status is */
133 struct semaphore tcpSem;
134 struct task_struct *tsk;
135 char server_GUID[16];
136 char secMode;
137 enum securityEnum secType;
138 unsigned int maxReq; /* Clients should submit no more */
139 /* than maxReq distinct unanswered SMBs to the server when using */
140 /* multiplexed reads or writes */
141 unsigned int maxBuf; /* maxBuf specifies the maximum */
142 /* message size the server can send or receive for non-raw SMBs */
143 unsigned int maxRw; /* maxRw specifies the maximum */
144 /* message size the server can send or receive for */
145 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
146 char sessid[4]; /* unique token id for this session */
147 /* (returned on Negotiate */
148 int capabilities; /* allow selective disabling of caps by smb sess */
149 __u16 timeZone;
150 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
151 char workstation_RFC1001_name[16]; /* 16th byte is always zero */
152 };
153
154 /*
155 * The following is our shortcut to user information. We surface the uid,
156 * and name. We always get the password on the fly in case it
157 * has changed. We also hang a list of sessions owned by this user off here.
158 */
159 struct cifsUidInfo {
160 struct list_head userList;
161 struct list_head sessionList; /* SMB sessions for this user */
162 uid_t linux_uid;
163 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
164 /* BB may need ptr or callback for PAM or WinBind info */
165 };
166
167 /*
168 * Session structure. One of these for each uid session with a particular host
169 */
170 struct cifsSesInfo {
171 struct list_head cifsSessionList;
172 struct semaphore sesSem;
173 struct cifsUidInfo *uidInfo; /* pointer to user info */
174 struct TCP_Server_Info *server; /* pointer to server info */
175 atomic_t inUse; /* # of mounts (tree connections) on this ses */
176 enum statusEnum status;
177 __u32 sequence_number; /* needed for CIFS PDU signature */
178 __u16 ipc_tid; /* special tid for connection to IPC share */
179 char mac_signing_key[CIFS_SESSION_KEY_SIZE + 16];
180 char *serverOS; /* name of operating system underlying the server */
181 char *serverNOS; /* name of network operating system that the server is running */
182 char *serverDomain; /* security realm of server */
183 int Suid; /* remote smb uid */
184 uid_t linux_uid; /* local Linux uid */
185 int capabilities;
186 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for tcp names - will ipv6 and sctp addresses fit here?? */
187 char userName[MAX_USERNAME_SIZE + 1];
188 char domainName[MAX_USERNAME_SIZE + 1];
189 char * password;
190 };
191
192 /*
193 * there is one of these for each connection to a resource on a particular
194 * session
195 */
196 struct cifsTconInfo {
197 struct list_head cifsConnectionList;
198 struct list_head openFileList;
199 struct semaphore tconSem;
200 struct cifsSesInfo *ses; /* pointer to session associated with */
201 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource (in ASCII not UTF) */
202 char *nativeFileSystem;
203 __u16 tid; /* The 2 byte tree id */
204 __u16 Flags; /* optional support bits */
205 enum statusEnum tidStatus;
206 atomic_t useCount; /* how many mounts (explicit or implicit) to this share */
207 #ifdef CONFIG_CIFS_STATS
208 atomic_t num_smbs_sent;
209 atomic_t num_writes;
210 atomic_t num_reads;
211 atomic_t num_oplock_brks;
212 atomic_t num_opens;
213 atomic_t num_deletes;
214 atomic_t num_mkdirs;
215 atomic_t num_rmdirs;
216 atomic_t num_renames;
217 atomic_t num_t2renames;
218 __u64 bytes_read;
219 __u64 bytes_written;
220 spinlock_t stat_lock;
221 #endif
222 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
223 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if file system name truncated */
224 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
225 unsigned retry:1;
226 /* BB add field for back pointer to sb struct? */
227 };
228
229 /*
230 * This info hangs off the cifsFileInfo structure. This is used to track
231 * byte stream locks on the file
232 */
233 struct cifsLockInfo {
234 struct cifsLockInfo *next;
235 int start;
236 int length;
237 int type;
238 };
239
240 /*
241 * One of these for each open instance of a file
242 */
243 struct cifs_search_info {
244 loff_t index_of_last_entry;
245 __u16 entries_in_buffer;
246 __u16 info_level;
247 __u32 resume_key;
248 char * ntwrk_buf_start;
249 char * srch_entries_start;
250 char * presume_name;
251 unsigned int resume_name_len;
252 unsigned endOfSearch:1;
253 unsigned emptyDir:1;
254 unsigned unicode:1;
255 };
256
257 struct cifsFileInfo {
258 struct list_head tlist; /* pointer to next fid owned by tcon */
259 struct list_head flist; /* next fid (file instance) for this inode */
260 unsigned int uid; /* allows finding which FileInfo structure */
261 __u32 pid; /* process id who opened file */
262 __u16 netfid; /* file id from remote */
263 /* BB add lock scope info here if needed */ ;
264 /* lock scope id (0 if none) */
265 struct file * pfile; /* needed for writepage */
266 struct inode * pInode; /* needed for oplock break */
267 unsigned closePend:1; /* file is marked to close */
268 unsigned invalidHandle:1; /* file closed via session abend */
269 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
270 char * search_resume_name; /* BB removeme BB */
271 unsigned int resume_name_length; /* BB removeme - field renamed and moved BB */
272 struct cifs_search_info srch_inf;
273 };
274
275 /*
276 * One of these for each file inode
277 */
278
279 struct cifsInodeInfo {
280 struct list_head lockList;
281 /* BB add in lists for dirty pages - i.e. write caching info for oplock */
282 struct list_head openFileList;
283 int write_behind_rc;
284 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
285 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
286 unsigned long time; /* jiffies of last update/check of inode */
287 unsigned clientCanCacheRead:1; /* read oplock */
288 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
289 unsigned oplockPending:1;
290 struct inode vfs_inode;
291 };
292
293 static inline struct cifsInodeInfo *
294 CIFS_I(struct inode *inode)
295 {
296 return container_of(inode, struct cifsInodeInfo, vfs_inode);
297 }
298
299 static inline struct cifs_sb_info *
300 CIFS_SB(struct super_block *sb)
301 {
302 return sb->s_fs_info;
303 }
304
305
306 /* one of these for every pending CIFS request to the server */
307 struct mid_q_entry {
308 struct list_head qhead; /* mids waiting on reply from this server */
309 __u16 mid; /* multiplex id */
310 __u16 pid; /* process id */
311 __u32 sequence_number; /* for CIFS signing */
312 __u16 command; /* smb command code */
313 struct timeval when_sent; /* time when smb sent */
314 struct cifsSesInfo *ses; /* smb was sent to this server */
315 struct task_struct *tsk; /* task waiting for response */
316 struct smb_hdr *resp_buf; /* response buffer */
317 int midState; /* wish this were enum but can not pass to wait_event */
318 };
319
320 struct oplock_q_entry {
321 struct list_head qhead;
322 struct inode * pinode;
323 struct cifsTconInfo * tcon;
324 __u16 netfid;
325 };
326
327 #define MID_FREE 0
328 #define MID_REQUEST_ALLOCATED 1
329 #define MID_REQUEST_SUBMITTED 2
330 #define MID_RESPONSE_RECEIVED 4
331 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
332 #define MID_NO_RESP_NEEDED 0x10
333 #define MID_SMALL_BUFFER 0x20 /* 112 byte response buffer instead of 4K */
334
335 /*
336 *****************************************************************
337 * All constants go here
338 *****************************************************************
339 */
340
341 #define UID_HASH (16)
342
343 /*
344 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
345 * following to be declared.
346 */
347
348 /****************************************************************************
349 * Locking notes. All updates to global variables and lists should be
350 * protected by spinlocks or semaphores.
351 *
352 * Spinlocks
353 * ---------
354 * GlobalMid_Lock protects:
355 * list operations on pending_mid_q and oplockQ
356 * updates to XID counters, multiplex id and SMB sequence numbers
357 * GlobalSMBSesLock protects:
358 * list operations on tcp and SMB session lists and tCon lists
359 * f_owner.lock protects certain per file struct operations
360 * mapping->page_lock protects certain per page operations
361 *
362 * Semaphores
363 * ----------
364 * sesSem operations on smb session
365 * tconSem operations on tree connection
366 * fh_sem file handle reconnection operations
367 *
368 ****************************************************************************/
369
370 #ifdef DECLARE_GLOBALS_HERE
371 #define GLOBAL_EXTERN
372 #else
373 #define GLOBAL_EXTERN extern
374 #endif
375
376 /*
377 * The list of servers that did not respond with NT LM 0.12.
378 * This list helps improve performance and eliminate the messages indicating
379 * that we had a communications error talking to the server in this list.
380 */
381 GLOBAL_EXTERN struct servers_not_supported *NotSuppList; /*@z4a */
382
383 /*
384 * The following is a hash table of all the users we know about.
385 */
386 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
387
388 GLOBAL_EXTERN struct list_head GlobalServerList; /* BB not implemented yet */
389 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
390 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
391 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
392
393 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
394
395 /*
396 * Global transaction id (XID) information
397 */
398 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
399 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
400 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
401 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above and list operations */
402 /* on midQ entries */
403 GLOBAL_EXTERN char Local_System_Name[15];
404
405 /*
406 * Global counters, updated atomically
407 */
408 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
409 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
410 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
411 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
412 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
413
414 /* Various Debug counters to remove someday (BB) */
415 GLOBAL_EXTERN atomic_t bufAllocCount;
416 GLOBAL_EXTERN atomic_t smBufAllocCount;
417 GLOBAL_EXTERN atomic_t midCount;
418
419 /* Misc globals */
420 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
421 to be established on existing mount if we
422 have the uid/password or Kerberos credential
423 or equivalent for current user */
424 GLOBAL_EXTERN unsigned int oplockEnabled;
425 GLOBAL_EXTERN unsigned int experimEnabled;
426 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
427 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
428 with more secure ntlmssp2 challenge/resp */
429 GLOBAL_EXTERN unsigned int ntlmv2_support; /* better optional password hash */
430 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
431 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
432 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
433 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
434 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
435 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
436
437
|
This page was automatically generated by the
LXR engine.
|