SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/cifs/cifsglob.h

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