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