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