ACPI: suspend: consolidate handling of Sx states addendum
[linux-2.6/mini2440.git] / fs / cifs / cifsglob.h
blobb98742fc3b5aea0d325a395edd750eff093e115c
1 /*
2 * fs/cifs/cifsglob.h
4 * Copyright (C) International Business Machines Corp., 2002,2007
5 * Author(s): Steve French (sfrench@us.ibm.com)
6 * Jeremy Allison (jra@samba.org)
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.
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.
19 #include <linux/in.h>
20 #include <linux/in6.h>
21 #include "cifs_fs_sb.h"
23 * The sizes of various internal tables and strings
25 #define MAX_UID_INFO 16
26 #define MAX_SES_INFO 2
27 #define MAX_TCON_INFO 4
29 #define MAX_TREE_SIZE 2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1
30 #define MAX_SERVER_SIZE 15
31 #define MAX_SHARE_SIZE 64 /* used to be 20, this should still be enough */
32 #define MAX_USERNAME_SIZE 32 /* 32 is to allow for 15 char names + null
33 termination then *2 for unicode versions */
34 #define MAX_PASSWORD_SIZE 16
36 #define CIFS_MIN_RCV_POOL 4
39 * MAX_REQ is the maximum number of requests that WE will send
40 * on one socket concurently. It also matches the most common
41 * value of max multiplex returned by servers. We may
42 * eventually want to use the negotiated value (in case
43 * future servers can handle more) when we are more confident that
44 * we will not have problems oveloading the socket with pending
45 * write data.
47 #define CIFS_MAX_REQ 50
49 #define SERVER_NAME_LENGTH 15
50 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
52 /* used to define string lengths for reversing unicode strings */
53 /* (256+1)*2 = 514 */
54 /* (max path length + 1 for null) * 2 for unicode */
55 #define MAX_NAME 514
57 #include "cifspdu.h"
59 #ifndef FALSE
60 #define FALSE 0
61 #endif
63 #ifndef TRUE
64 #define TRUE 1
65 #endif
67 #ifndef XATTR_DOS_ATTRIB
68 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
69 #endif
72 * This information is kept on every Server we know about.
74 * Some things to note:
77 #define SERVER_NAME_LEN_WITH_NULL (SERVER_NAME_LENGTH + 1)
80 * CIFS vfs client Status information (based on what we know.)
83 /* associated with each tcp and smb session */
84 enum statusEnum {
85 CifsNew = 0,
86 CifsGood,
87 CifsExiting,
88 CifsNeedReconnect
91 enum securityEnum {
92 LANMAN = 0, /* Legacy LANMAN auth */
93 NTLM, /* Legacy NTLM012 auth with NTLM hash */
94 NTLMv2, /* Legacy NTLM auth with NTLMv2 hash */
95 RawNTLMSSP, /* NTLMSSP without SPNEGO */
96 NTLMSSP, /* NTLMSSP via SPNEGO */
97 Kerberos /* Kerberos via SPNEGO */
100 enum protocolEnum {
101 IPV4 = 0,
102 IPV6,
103 SCTP
104 /* Netbios frames protocol not supported at this time */
107 struct mac_key {
108 unsigned int len;
109 union {
110 char ntlm[CIFS_SESS_KEY_SIZE + 16];
111 struct {
112 char key[16];
113 struct ntlmv2_resp resp;
114 } ntlmv2;
115 } data;
119 *****************************************************************
120 * Except the CIFS PDUs themselves all the
121 * globally interesting structs should go here
122 *****************************************************************
125 struct TCP_Server_Info {
126 /* 15 character server name + 0x20 16th byte indicating type = srv */
127 char server_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
128 char unicode_server_Name[SERVER_NAME_LEN_WITH_NULL * 2];
129 struct socket *ssocket;
130 union {
131 struct sockaddr_in sockAddr;
132 struct sockaddr_in6 sockAddr6;
133 } addr;
134 wait_queue_head_t response_q;
135 wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
136 struct list_head pending_mid_q;
137 void *Server_NlsInfo; /* BB - placeholder for future NLS info */
138 unsigned short server_codepage; /* codepage for the server */
139 unsigned long ip_address; /* IP addr for the server if known */
140 enum protocolEnum protocolType;
141 char versionMajor;
142 char versionMinor;
143 unsigned svlocal:1; /* local server or remote */
144 atomic_t socketUseCount; /* number of open cifs sessions on socket */
145 atomic_t inFlight; /* number of requests on the wire to server */
146 #ifdef CONFIG_CIFS_STATS2
147 atomic_t inSend; /* requests trying to send */
148 atomic_t num_waiters; /* blocked waiting to get in sendrecv */
149 #endif
150 enum statusEnum tcpStatus; /* what we think the status is */
151 struct semaphore tcpSem;
152 struct task_struct *tsk;
153 char server_GUID[16];
154 char secMode;
155 enum securityEnum secType;
156 unsigned int maxReq; /* Clients should submit no more */
157 /* than maxReq distinct unanswered SMBs to the server when using */
158 /* multiplexed reads or writes */
159 unsigned int maxBuf; /* maxBuf specifies the maximum */
160 /* message size the server can send or receive for non-raw SMBs */
161 unsigned int maxRw; /* maxRw specifies the maximum */
162 /* message size the server can send or receive for */
163 /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
164 char sessid[4]; /* unique token id for this session */
165 /* (returned on Negotiate */
166 int capabilities; /* allow selective disabling of caps by smb sess */
167 int timeAdj; /* Adjust for difference in server time zone in sec */
168 __u16 CurrentMid; /* multiplex id - rotating counter */
169 char cryptKey[CIFS_CRYPTO_KEY_SIZE];
170 /* 16th byte of RFC1001 workstation name is always null */
171 char workstation_RFC1001_name[SERVER_NAME_LEN_WITH_NULL];
172 __u32 sequence_number; /* needed for CIFS PDU signature */
173 struct mac_key mac_signing_key;
174 char ntlmv2_hash[16];
175 unsigned long lstrp; /* when we got last response from this server */
179 * The following is our shortcut to user information. We surface the uid,
180 * and name. We always get the password on the fly in case it
181 * has changed. We also hang a list of sessions owned by this user off here.
183 struct cifsUidInfo {
184 struct list_head userList;
185 struct list_head sessionList; /* SMB sessions for this user */
186 uid_t linux_uid;
187 char user[MAX_USERNAME_SIZE + 1]; /* ascii name of user */
188 /* BB may need ptr or callback for PAM or WinBind info */
192 * Session structure. One of these for each uid session with a particular host
194 struct cifsSesInfo {
195 struct list_head cifsSessionList;
196 struct semaphore sesSem;
197 #if 0
198 struct cifsUidInfo *uidInfo; /* pointer to user info */
199 #endif
200 struct TCP_Server_Info *server; /* pointer to server info */
201 atomic_t inUse; /* # of mounts (tree connections) on this ses */
202 enum statusEnum status;
203 unsigned overrideSecFlg; /* if non-zero override global sec flags */
204 __u16 ipc_tid; /* special tid for connection to IPC share */
205 __u16 flags;
206 char *serverOS; /* name of operating system underlying server */
207 char *serverNOS; /* name of network operating system of server */
208 char *serverDomain; /* security realm of server */
209 int Suid; /* remote smb uid */
210 uid_t linux_uid; /* local Linux uid */
211 int capabilities;
212 char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
213 TCP names - will ipv6 and sctp addresses fit? */
214 char userName[MAX_USERNAME_SIZE + 1];
215 char *domainName;
216 char *password;
218 /* no more than one of the following three session flags may be set */
219 #define CIFS_SES_NT4 1
220 #define CIFS_SES_OS2 2
221 #define CIFS_SES_W9X 4
222 /* following flag is set for old servers such as OS2 (and Win95?)
223 which do not negotiate NTLM or POSIX dialects, but instead
224 negotiate one of the older LANMAN dialects */
225 #define CIFS_SES_LANMAN 8
227 * there is one of these for each connection to a resource on a particular
228 * session
230 struct cifsTconInfo {
231 struct list_head cifsConnectionList;
232 struct list_head openFileList;
233 struct semaphore tconSem;
234 struct cifsSesInfo *ses; /* pointer to session associated with */
235 char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
236 char *nativeFileSystem;
237 __u16 tid; /* The 2 byte tree id */
238 __u16 Flags; /* optional support bits */
239 enum statusEnum tidStatus;
240 atomic_t useCount; /* how many explicit/implicit mounts to share */
241 #ifdef CONFIG_CIFS_STATS
242 atomic_t num_smbs_sent;
243 atomic_t num_writes;
244 atomic_t num_reads;
245 atomic_t num_oplock_brks;
246 atomic_t num_opens;
247 atomic_t num_closes;
248 atomic_t num_deletes;
249 atomic_t num_mkdirs;
250 atomic_t num_rmdirs;
251 atomic_t num_renames;
252 atomic_t num_t2renames;
253 atomic_t num_ffirst;
254 atomic_t num_fnext;
255 atomic_t num_fclose;
256 atomic_t num_hardlinks;
257 atomic_t num_symlinks;
258 atomic_t num_locks;
259 atomic_t num_acl_get;
260 atomic_t num_acl_set;
261 #ifdef CONFIG_CIFS_STATS2
262 unsigned long long time_writes;
263 unsigned long long time_reads;
264 unsigned long long time_opens;
265 unsigned long long time_deletes;
266 unsigned long long time_closes;
267 unsigned long long time_mkdirs;
268 unsigned long long time_rmdirs;
269 unsigned long long time_renames;
270 unsigned long long time_t2renames;
271 unsigned long long time_ffirst;
272 unsigned long long time_fnext;
273 unsigned long long time_fclose;
274 #endif /* CONFIG_CIFS_STATS2 */
275 __u64 bytes_read;
276 __u64 bytes_written;
277 spinlock_t stat_lock;
278 #endif /* CONFIG_CIFS_STATS */
279 FILE_SYSTEM_DEVICE_INFO fsDevInfo;
280 FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
281 FILE_SYSTEM_UNIX_INFO fsUnixInfo;
282 unsigned retry:1;
283 unsigned nocase:1;
284 unsigned unix_ext:1; /* if off disable Linux extensions to CIFS protocol
285 for this mount even if server would support */
286 /* BB add field for back pointer to sb struct(s)? */
290 * This info hangs off the cifsFileInfo structure, pointed to by llist.
291 * This is used to track byte stream locks on the file
293 struct cifsLockInfo {
294 struct list_head llist; /* pointer to next cifsLockInfo */
295 __u64 offset;
296 __u64 length;
297 __u8 type;
301 * One of these for each open instance of a file
303 struct cifs_search_info {
304 loff_t index_of_last_entry;
305 __u16 entries_in_buffer;
306 __u16 info_level;
307 __u32 resume_key;
308 char *ntwrk_buf_start;
309 char *srch_entries_start;
310 char *presume_name;
311 unsigned int resume_name_len;
312 unsigned endOfSearch:1;
313 unsigned emptyDir:1;
314 unsigned unicode:1;
315 unsigned smallBuf:1; /* so we know which buf_release function to call */
318 struct cifsFileInfo {
319 struct list_head tlist; /* pointer to next fid owned by tcon */
320 struct list_head flist; /* next fid (file instance) for this inode */
321 unsigned int uid; /* allows finding which FileInfo structure */
322 __u32 pid; /* process id who opened file */
323 __u16 netfid; /* file id from remote */
324 /* BB add lock scope info here if needed */ ;
325 /* lock scope id (0 if none) */
326 struct file *pfile; /* needed for writepage */
327 struct inode *pInode; /* needed for oplock break */
328 struct mutex lock_mutex;
329 struct list_head llist; /* list of byte range locks we have. */
330 unsigned closePend:1; /* file is marked to close */
331 unsigned invalidHandle:1; /* file closed via session abend */
332 atomic_t wrtPending; /* handle in use - defer close */
333 struct semaphore fh_sem; /* prevents reopen race after dead ses*/
334 char *search_resume_name; /* BB removeme BB */
335 struct cifs_search_info srch_inf;
339 * One of these for each file inode
342 struct cifsInodeInfo {
343 struct list_head lockList;
344 /* BB add in lists for dirty pages i.e. write caching info for oplock */
345 struct list_head openFileList;
346 int write_behind_rc;
347 __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
348 atomic_t inUse; /* num concurrent users (local openers cifs) of file*/
349 unsigned long time; /* jiffies of last update/check of inode */
350 unsigned clientCanCacheRead:1; /* read oplock */
351 unsigned clientCanCacheAll:1; /* read and writebehind oplock */
352 unsigned oplockPending:1;
353 struct inode vfs_inode;
356 static inline struct cifsInodeInfo *
357 CIFS_I(struct inode *inode)
359 return container_of(inode, struct cifsInodeInfo, vfs_inode);
362 static inline struct cifs_sb_info *
363 CIFS_SB(struct super_block *sb)
365 return sb->s_fs_info;
368 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
370 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
371 return '/';
372 else
373 return '\\';
376 #ifdef CONFIG_CIFS_STATS
377 #define cifs_stats_inc atomic_inc
379 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
380 unsigned int bytes)
382 if (bytes) {
383 spin_lock(&tcon->stat_lock);
384 tcon->bytes_written += bytes;
385 spin_unlock(&tcon->stat_lock);
389 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
390 unsigned int bytes)
392 spin_lock(&tcon->stat_lock);
393 tcon->bytes_read += bytes;
394 spin_unlock(&tcon->stat_lock);
396 #else
398 #define cifs_stats_inc(field) do {} while (0)
399 #define cifs_stats_bytes_written(tcon, bytes) do {} while (0)
400 #define cifs_stats_bytes_read(tcon, bytes) do {} while (0)
402 #endif
404 /* one of these for every pending CIFS request to the server */
405 struct mid_q_entry {
406 struct list_head qhead; /* mids waiting on reply from this server */
407 __u16 mid; /* multiplex id */
408 __u16 pid; /* process id */
409 __u32 sequence_number; /* for CIFS signing */
410 unsigned long when_alloc; /* when mid was created */
411 #ifdef CONFIG_CIFS_STATS2
412 unsigned long when_sent; /* time when smb send finished */
413 unsigned long when_received; /* when demux complete (taken off wire) */
414 #endif
415 struct cifsSesInfo *ses; /* smb was sent to this server */
416 struct task_struct *tsk; /* task waiting for response */
417 struct smb_hdr *resp_buf; /* response buffer */
418 int midState; /* wish this were enum but can not pass to wait_event */
419 __u8 command; /* smb command code */
420 unsigned largeBuf:1; /* if valid response, is pointer to large buf */
421 unsigned multiRsp:1; /* multiple trans2 responses for one request */
422 unsigned multiEnd:1; /* both received */
425 struct oplock_q_entry {
426 struct list_head qhead;
427 struct inode *pinode;
428 struct cifsTconInfo *tcon;
429 __u16 netfid;
432 /* for pending dnotify requests */
433 struct dir_notify_req {
434 struct list_head lhead;
435 __le16 Pid;
436 __le16 PidHigh;
437 __u16 Mid;
438 __u16 Tid;
439 __u16 Uid;
440 __u16 netfid;
441 __u32 filter; /* CompletionFilter (for multishot) */
442 int multishot;
443 struct file *pfile;
446 #define MID_FREE 0
447 #define MID_REQUEST_ALLOCATED 1
448 #define MID_REQUEST_SUBMITTED 2
449 #define MID_RESPONSE_RECEIVED 4
450 #define MID_RETRY_NEEDED 8 /* session closed while this request out */
451 #define MID_NO_RESP_NEEDED 0x10
453 /* Types of response buffer returned from SendReceive2 */
454 #define CIFS_NO_BUFFER 0 /* Response buffer not returned */
455 #define CIFS_SMALL_BUFFER 1
456 #define CIFS_LARGE_BUFFER 2
457 #define CIFS_IOVEC 4 /* array of response buffers */
459 /* Security Flags: indicate type of session setup needed */
460 #define CIFSSEC_MAY_SIGN 0x00001
461 #define CIFSSEC_MAY_NTLM 0x00002
462 #define CIFSSEC_MAY_NTLMV2 0x00004
463 #define CIFSSEC_MAY_KRB5 0x00008
464 #ifdef CONFIG_CIFS_WEAK_PW_HASH
465 #define CIFSSEC_MAY_LANMAN 0x00010
466 #define CIFSSEC_MAY_PLNTXT 0x00020
467 #endif /* weak passwords */
468 #define CIFSSEC_MAY_SEAL 0x00040 /* not supported yet */
470 #define CIFSSEC_MUST_SIGN 0x01001
471 /* note that only one of the following can be set so the
472 result of setting MUST flags more than once will be to
473 require use of the stronger protocol */
474 #define CIFSSEC_MUST_NTLM 0x02002
475 #define CIFSSEC_MUST_NTLMV2 0x04004
476 #define CIFSSEC_MUST_KRB5 0x08008
477 #ifdef CONFIG_CIFS_WEAK_PW_HASH
478 #define CIFSSEC_MUST_LANMAN 0x10010
479 #define CIFSSEC_MUST_PLNTXT 0x20020
480 #define CIFSSEC_MASK 0x37037 /* current flags supported if weak */
481 #else
482 #define CIFSSEC_MASK 0x07007 /* flags supported if no weak config */
483 #endif /* WEAK_PW_HASH */
484 #define CIFSSEC_MUST_SEAL 0x40040 /* not supported yet */
486 #define CIFSSEC_DEF CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2
487 #define CIFSSEC_MAX CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2
489 *****************************************************************
490 * All constants go here
491 *****************************************************************
494 #define UID_HASH (16)
497 * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
498 * following to be declared.
501 /****************************************************************************
502 * Locking notes. All updates to global variables and lists should be
503 * protected by spinlocks or semaphores.
505 * Spinlocks
506 * ---------
507 * GlobalMid_Lock protects:
508 * list operations on pending_mid_q and oplockQ
509 * updates to XID counters, multiplex id and SMB sequence numbers
510 * GlobalSMBSesLock protects:
511 * list operations on tcp and SMB session lists and tCon lists
512 * f_owner.lock protects certain per file struct operations
513 * mapping->page_lock protects certain per page operations
515 * Semaphores
516 * ----------
517 * sesSem operations on smb session
518 * tconSem operations on tree connection
519 * fh_sem file handle reconnection operations
521 ****************************************************************************/
523 #ifdef DECLARE_GLOBALS_HERE
524 #define GLOBAL_EXTERN
525 #else
526 #define GLOBAL_EXTERN extern
527 #endif
530 * The list of servers that did not respond with NT LM 0.12.
531 * This list helps improve performance and eliminate the messages indicating
532 * that we had a communications error talking to the server in this list.
534 /* Feature not supported */
535 /* GLOBAL_EXTERN struct servers_not_supported *NotSuppList; */
538 * The following is a hash table of all the users we know about.
540 GLOBAL_EXTERN struct smbUidInfo *GlobalUidList[UID_HASH];
542 /* GLOBAL_EXTERN struct list_head GlobalServerList; BB not implemented yet */
543 GLOBAL_EXTERN struct list_head GlobalSMBSessionList;
544 GLOBAL_EXTERN struct list_head GlobalTreeConnectionList;
545 GLOBAL_EXTERN rwlock_t GlobalSMBSeslock; /* protects list inserts on 3 above */
547 GLOBAL_EXTERN struct list_head GlobalOplock_Q;
549 /* Outstanding dir notify requests */
550 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
551 /* DirNotify response queue */
552 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
555 * Global transaction id (XID) information
557 GLOBAL_EXTERN unsigned int GlobalCurrentXid; /* protected by GlobalMid_Sem */
558 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
559 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid; /* prot by GlobalMid_Sem */
560 GLOBAL_EXTERN spinlock_t GlobalMid_Lock; /* protects above & list operations */
561 /* on midQ entries */
562 GLOBAL_EXTERN char Local_System_Name[15];
565 * Global counters, updated atomically
567 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
568 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
569 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
570 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
571 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
573 /* Various Debug counters to remove someday (BB) */
574 GLOBAL_EXTERN atomic_t bufAllocCount; /* current number allocated */
575 #ifdef CONFIG_CIFS_STATS2
576 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
577 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
578 #endif
579 GLOBAL_EXTERN atomic_t smBufAllocCount;
580 GLOBAL_EXTERN atomic_t midCount;
582 /* Misc globals */
583 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
584 to be established on existing mount if we
585 have the uid/password or Kerberos credential
586 or equivalent for current user */
587 GLOBAL_EXTERN unsigned int oplockEnabled;
588 GLOBAL_EXTERN unsigned int experimEnabled;
589 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
590 GLOBAL_EXTERN unsigned int extended_security; /* if on, session setup sent
591 with more secure ntlmssp2 challenge/resp */
592 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs; /* enable smb packet signing */
593 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
594 GLOBAL_EXTERN unsigned int CIFSMaxBufSize; /* max size not including hdr */
595 GLOBAL_EXTERN unsigned int cifs_min_rcv; /* min size of big ntwrk buf pool */
596 GLOBAL_EXTERN unsigned int cifs_min_small; /* min size of small buf pool */
597 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/