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