fs/cifs/cifsglob.h

   1 /*
   2  *   fs/cifs/cifsglob.h
   3  *
   4  *   Copyright (C) International Business Machines  Corp., 2002,2008
   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 #ifndef _CIFS_GLOB_H
  20 #define _CIFS_GLOB_H
  21
  22 #include <linux/in.h>
  23 #include <linux/in6.h>
  24 #include <linux/slab.h>
  25 #include <linux/workqueue.h>
  26 #include "cifs_fs_sb.h"
  27 #include "cifsacl.h"
  28 #include <crypto/internal/hash.h>
  29 #include <linux/scatterlist.h>
  30
  31 /*
  32  * The sizes of various internal tables and strings
  33  */
  34 #define MAX_UID_INFO 16
  35 #define MAX_SES_INFO 2
  36 #define MAX_TCON_INFO 4
  37
  38 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
  39 #define MAX_SERVER_SIZE 15
  40 #define MAX_SHARE_SIZE 80
  41 #define MAX_USERNAME_SIZE 256   /* reasonable maximum for current servers */
  42 #define MAX_PASSWORD_SIZE 512   /* max for windows seems to be 256 wide chars */
  43
  44 #define CIFS_MIN_RCV_POOL 4
  45
  46 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
  47 /*
  48  * default attribute cache timeout (jiffies)
  49  */
  50 #define CIFS_DEF_ACTIMEO (1 * HZ)
  51
  52 /*
  53  * max attribute cache timeout (jiffies) - 2^30
  54  */
  55 #define CIFS_MAX_ACTIMEO (1 << 30)
  56
  57 /*
  58  * MAX_REQ is the maximum number of requests that WE will send
  59  * on one socket concurrently. It also matches the most common
  60  * value of max multiplex returned by servers.  We may
  61  * eventually want to use the negotiated value (in case
  62  * future servers can handle more) when we are more confident that
  63  * we will not have problems oveloading the socket with pending
  64  * write data.
  65  */
  66 #define CIFS_MAX_REQ 50
  67
  68 #define RFC1001_NAME_LEN 15
  69 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
  70
  71 /* currently length of NIP6_FMT */
  72 #define SERVER_NAME_LENGTH 40
  73 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
  74
  75 /* used to define string lengths for reversing unicode strings */
  76 /*         (256+1)*2 = 514                                     */
  77 /*           (max path length + 1 for null) * 2 for unicode    */
  78 #define MAX_NAME 514
  79
  80 #include "cifspdu.h"
  81
  82 #ifndef XATTR_DOS_ATTRIB
  83 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
  84 #endif
  85
  86 /*
  87  * CIFS vfs client Status information (based on what we know.)
  88  */
  89
  90 /* associated with each tcp and smb session */
  91 enum statusEnum {
  92         CifsNew = 0,
  93         CifsGood,
  94         CifsExiting,
  95         CifsNeedReconnect,
  96         CifsNeedNegotiate
  97 };
  98
  99 enum securityEnum {
 100         LANMAN = 0,                     /* Legacy LANMAN auth */
 101         NTLM,                   /* Legacy NTLM012 auth with NTLM hash */
 102         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
 103         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
 104 /*      NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
 105         Kerberos,               /* Kerberos via SPNEGO */
 106 };
 107
 108 enum protocolEnum {
 109         TCP = 0,
 110         SCTP
 111         /* Netbios frames protocol not supported at this time */
 112 };
 113
 114 struct session_key {
 115         unsigned int len;
 116         char *response;
 117 };
 118
 119 /* crypto security descriptor definition */
 120 struct sdesc {
 121         struct shash_desc shash;
 122         char ctx[];
 123 };
 124
 125 /* crypto hashing related structure/fields, not specific to a sec mech */
 126 struct cifs_secmech {
 127         struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
 128         struct crypto_shash *md5; /* md5 hash function */
 129         struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
 130         struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
 131 };
 132
 133 /* per smb session structure/fields */
 134 struct ntlmssp_auth {
 135         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
 136         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
 137         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
 138         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
 139 };
 140
 141 struct cifs_cred {
 142         int uid;
 143         int gid;
 144         int mode;
 145         int cecount;
 146         struct cifs_sid osid;
 147         struct cifs_sid gsid;
 148         struct cifs_ntace *ntaces;
 149         struct cifs_ace *aces;
 150 };
 151
 152 /*
 153  *****************************************************************
 154  * Except the CIFS PDUs themselves all the
 155  * globally interesting structs should go here
 156  *****************************************************************
 157  */
 158
 159 struct smb_vol {
 160         char *username;
 161         char *password;
 162         char *domainname;
 163         char *UNC;
 164         char *UNCip;
 165         char *iocharset;  /* local code page for mapping to and from Unicode */
 166         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 167         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 168         uid_t cred_uid;
 169         uid_t linux_uid;
 170         gid_t linux_gid;
 171         mode_t file_mode;
 172         mode_t dir_mode;
 173         unsigned secFlg;
 174         bool retry:1;
 175         bool intr:1;
 176         bool setuids:1;
 177         bool override_uid:1;
 178         bool override_gid:1;
 179         bool dynperm:1;
 180         bool noperm:1;
 181         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 182         bool cifs_acl:1;
 183         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 184         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 185         bool direct_io:1;
 186         bool strict_io:1; /* strict cache behavior */
 187         bool remap:1;      /* set to remap seven reserved chars in filenames */
 188         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 189         bool no_linux_ext:1;
 190         bool sfu_emul:1;
 191         bool nullauth:1;   /* attempt to authenticate with null user */
 192         bool nocase:1;     /* request case insensitive filenames */
 193         bool nobrl:1;      /* disable sending byte range locks to srv */
 194         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 195         bool seal:1;       /* request transport encryption on share */
 196         bool nodfs:1;      /* Do not request DFS, even if available */
 197         bool local_lease:1; /* check leases only on local system, not remote */
 198         bool noblocksnd:1;
 199         bool noautotune:1;
 200         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 201         bool fsc:1;     /* enable fscache */
 202         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 203         bool multiuser:1;
 204         bool rwpidforward:1; /* pid forward for read/write operations */
 205         unsigned int rsize;
 206         unsigned int wsize;
 207         bool sockopt_tcp_nodelay:1;
 208         unsigned short int port;
 209         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 210         char *prepath;
 211         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 212         struct nls_table *local_nls;
 213 };
 214
 215 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 216                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 217                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 218                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 219                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 220                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 221                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 222                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 223                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO)
 224
 225 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
 226                       MS_NODEV | MS_SYNCHRONOUS)
 227
 228 struct cifs_mnt_data {
 229         struct cifs_sb_info *cifs_sb;
 230         struct smb_vol *vol;
 231         int flags;
 232 };
 233
 234 struct TCP_Server_Info {
 235         struct list_head tcp_ses_list;
 236         struct list_head smb_ses_list;
 237         int srv_count; /* reference counter */
 238         /* 15 character server name + 0x20 16th byte indicating type = srv */
 239         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 240         enum statusEnum tcpStatus; /* what we think the status is */
 241         char *hostname; /* hostname portion of UNC string */
 242         struct socket *ssocket;
 243         struct sockaddr_storage dstaddr;
 244         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 245 #ifdef CONFIG_NET_NS
 246         struct net *net;
 247 #endif
 248         wait_queue_head_t response_q;
 249         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 250         struct list_head pending_mid_q;
 251         bool noblocksnd;                /* use blocking sendmsg */
 252         bool noautotune;                /* do not autotune send buf sizes */
 253         bool tcp_nodelay;
 254         atomic_t inFlight;  /* number of requests on the wire to server */
 255         struct mutex srv_mutex;
 256         struct task_struct *tsk;
 257         char server_GUID[16];
 258         char sec_mode;
 259         bool session_estab; /* mark when very first sess is established */
 260         u16 dialect; /* dialect index that server chose */
 261         enum securityEnum secType;
 262         unsigned int maxReq;    /* Clients should submit no more */
 263         /* than maxReq distinct unanswered SMBs to the server when using  */
 264         /* multiplexed reads or writes */
 265         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 266         /* message size the server can send or receive for non-raw SMBs */
 267         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 268         /* when socket is setup (and during reconnect) before NegProt sent */
 269         unsigned int max_rw;    /* maxRw specifies the maximum */
 270         /* message size the server can send or receive for */
 271         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 272         unsigned int max_vcs;   /* maximum number of smb sessions, at least
 273                                    those that can be specified uniquely with
 274                                    vcnumbers */
 275         int capabilities; /* allow selective disabling of caps by smb sess */
 276         int timeAdj;  /* Adjust for difference in server time zone in sec */
 277         __u16 CurrentMid;         /* multiplex id - rotating counter */
 278         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 279         /* 16th byte of RFC1001 workstation name is always null */
 280         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 281         __u32 sequence_number; /* for signing, protected by srv_mutex */
 282         struct session_key session_key;
 283         unsigned long lstrp; /* when we got last response from this server */
 284         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 285         /* extended security flavors that server supports */
 286         bool    sec_ntlmssp;            /* supports NTLMSSP */
 287         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 288         bool    sec_kerberos;           /* supports plain Kerberos */
 289         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 290         struct delayed_work     echo; /* echo ping workqueue job */
 291 #ifdef CONFIG_CIFS_FSCACHE
 292         struct fscache_cookie   *fscache; /* client index cache cookie */
 293 #endif
 294 #ifdef CONFIG_CIFS_STATS2
 295         atomic_t inSend; /* requests trying to send */
 296         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 297 #endif
 298 };
 299
 300 /*
 301  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 302  * when CONFIG_NET_NS isn't set.
 303  */
 304
 305 #ifdef CONFIG_NET_NS
 306
 307 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 308 {
 309         return srv->net;
 310 }
 311
 312 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 313 {
 314         srv->net = net;
 315 }
 316
 317 #else
 318
 319 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 320 {
 321         return &init_net;
 322 }
 323
 324 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 325 {
 326 }
 327
 328 #endif
 329
 330 /*
 331  * Session structure.  One of these for each uid session with a particular host
 332  */
 333 struct cifs_ses {
 334         struct list_head smb_ses_list;
 335         struct list_head tcon_list;
 336         struct mutex session_mutex;
 337         struct TCP_Server_Info *server; /* pointer to server info */
 338         int ses_count;          /* reference counter */
 339         enum statusEnum status;
 340         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 341         __u16 ipc_tid;          /* special tid for connection to IPC share */
 342         __u16 flags;
 343         __u16 vcnum;
 344         char *serverOS;         /* name of operating system underlying server */
 345         char *serverNOS;        /* name of network operating system of server */
 346         char *serverDomain;     /* security realm of server */
 347         int Suid;               /* remote smb uid  */
 348         uid_t linux_uid;        /* overriding owner of files on the mount */
 349         uid_t cred_uid;         /* owner of credentials */
 350         int capabilities;
 351         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
 352                                 TCP names - will ipv6 and sctp addresses fit? */
 353         char *user_name;        /* must not be null except during init of sess
 354                                    and after mount option parsing we fill it */
 355         char *domainName;
 356         char *password;
 357         struct session_key auth_key;
 358         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 359         bool need_reconnect:1; /* connection reset, uid now invalid */
 360 };
 361 /* no more than one of the following three session flags may be set */
 362 #define CIFS_SES_NT4 1
 363 #define CIFS_SES_OS2 2
 364 #define CIFS_SES_W9X 4
 365 /* following flag is set for old servers such as OS2 (and Win95?)
 366    which do not negotiate NTLM or POSIX dialects, but instead
 367    negotiate one of the older LANMAN dialects */
 368 #define CIFS_SES_LANMAN 8
 369 /*
 370  * there is one of these for each connection to a resource on a particular
 371  * session
 372  */
 373 struct cifs_tcon {
 374         struct list_head tcon_list;
 375         int tc_count;
 376         struct list_head openFileList;
 377         struct cifs_ses *ses;   /* pointer to session associated with */
 378         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
 379         char *nativeFileSystem;
 380         char *password;         /* for share-level security */
 381         __u16 tid;              /* The 2 byte tree id */
 382         __u16 Flags;            /* optional support bits */
 383         enum statusEnum tidStatus;
 384 #ifdef CONFIG_CIFS_STATS
 385         atomic_t num_smbs_sent;
 386         atomic_t num_writes;
 387         atomic_t num_reads;
 388         atomic_t num_flushes;
 389         atomic_t num_oplock_brks;
 390         atomic_t num_opens;
 391         atomic_t num_closes;
 392         atomic_t num_deletes;
 393         atomic_t num_mkdirs;
 394         atomic_t num_posixopens;
 395         atomic_t num_posixmkdirs;
 396         atomic_t num_rmdirs;
 397         atomic_t num_renames;
 398         atomic_t num_t2renames;
 399         atomic_t num_ffirst;
 400         atomic_t num_fnext;
 401         atomic_t num_fclose;
 402         atomic_t num_hardlinks;
 403         atomic_t num_symlinks;
 404         atomic_t num_locks;
 405         atomic_t num_acl_get;
 406         atomic_t num_acl_set;
 407 #ifdef CONFIG_CIFS_STATS2
 408         unsigned long long time_writes;
 409         unsigned long long time_reads;
 410         unsigned long long time_opens;
 411         unsigned long long time_deletes;
 412         unsigned long long time_closes;
 413         unsigned long long time_mkdirs;
 414         unsigned long long time_rmdirs;
 415         unsigned long long time_renames;
 416         unsigned long long time_t2renames;
 417         unsigned long long time_ffirst;
 418         unsigned long long time_fnext;
 419         unsigned long long time_fclose;
 420 #endif /* CONFIG_CIFS_STATS2 */
 421         __u64    bytes_read;
 422         __u64    bytes_written;
 423         spinlock_t stat_lock;
 424 #endif /* CONFIG_CIFS_STATS */
 425         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
 426         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
 427         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
 428         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
 429         bool retry:1;
 430         bool nocase:1;
 431         bool seal:1;      /* transport encryption for this mounted share */
 432         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
 433                                 for this mount even if server would support */
 434         bool local_lease:1; /* check leases (only) on local system not remote */
 435         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
 436         bool need_reconnect:1; /* connection reset, tid now invalid */
 437 #ifdef CONFIG_CIFS_FSCACHE
 438         u64 resource_id;                /* server resource id */
 439         struct fscache_cookie *fscache; /* cookie for share */
 440 #endif
 441         /* BB add field for back pointer to sb struct(s)? */
 442 };
 443
 444 /*
 445  * This is a refcounted and timestamped container for a tcon pointer. The
 446  * container holds a tcon reference. It is considered safe to free one of
 447  * these when the tl_count goes to 0. The tl_time is the time of the last
 448  * "get" on the container.
 449  */
 450 struct tcon_link {
 451         struct rb_node          tl_rbnode;
 452         uid_t                   tl_uid;
 453         unsigned long           tl_flags;
 454 #define TCON_LINK_MASTER        0
 455 #define TCON_LINK_PENDING       1
 456 #define TCON_LINK_IN_TREE       2
 457         unsigned long           tl_time;
 458         atomic_t                tl_count;
 459         struct cifs_tcon        *tl_tcon;
 460 };
 461
 462 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
 463
 464 static inline struct cifs_tcon *
 465 tlink_tcon(struct tcon_link *tlink)
 466 {
 467         return tlink->tl_tcon;
 468 }
 469
 470 extern void cifs_put_tlink(struct tcon_link *tlink);
 471
 472 static inline struct tcon_link *
 473 cifs_get_tlink(struct tcon_link *tlink)
 474 {
 475         if (tlink && !IS_ERR(tlink))
 476                 atomic_inc(&tlink->tl_count);
 477         return tlink;
 478 }
 479
 480 /* This function is always expected to succeed */
 481 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
 482
 483 /*
 484  * This info hangs off the cifsFileInfo structure, pointed to by llist.
 485  * This is used to track byte stream locks on the file
 486  */
 487 struct cifsLockInfo {
 488         struct list_head llist; /* pointer to next cifsLockInfo */
 489         __u64 offset;
 490         __u64 length;
 491         __u8 type;
 492 };
 493
 494 /*
 495  * One of these for each open instance of a file
 496  */
 497 struct cifs_search_info {
 498         loff_t index_of_last_entry;
 499         __u16 entries_in_buffer;
 500         __u16 info_level;
 501         __u32 resume_key;
 502         char *ntwrk_buf_start;
 503         char *srch_entries_start;
 504         char *last_entry;
 505         char *presume_name;
 506         unsigned int resume_name_len;
 507         bool endOfSearch:1;
 508         bool emptyDir:1;
 509         bool unicode:1;
 510         bool smallBuf:1; /* so we know which buf_release function to call */
 511 };
 512
 513 struct cifsFileInfo {
 514         struct list_head tlist; /* pointer to next fid owned by tcon */
 515         struct list_head flist; /* next fid (file instance) for this inode */
 516         unsigned int uid;       /* allows finding which FileInfo structure */
 517         __u32 pid;              /* process id who opened file */
 518         __u16 netfid;           /* file id from remote */
 519         /* BB add lock scope info here if needed */ ;
 520         /* lock scope id (0 if none) */
 521         struct dentry *dentry;
 522         unsigned int f_flags;
 523         struct tcon_link *tlink;
 524         struct mutex lock_mutex;
 525         struct list_head llist; /* list of byte range locks we have. */
 526         bool invalidHandle:1;   /* file closed via session abend */
 527         bool oplock_break_cancelled:1;
 528         int count;              /* refcount protected by cifs_file_list_lock */
 529         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
 530         struct cifs_search_info srch_inf;
 531         struct work_struct oplock_break; /* work for oplock breaks */
 532 };
 533
 534 struct cifs_io_parms {
 535         __u16 netfid;
 536         __u32 pid;
 537         __u64 offset;
 538         unsigned int length;
 539         struct cifs_tcon *tcon;
 540 };
 541
 542 /*
 543  * Take a reference on the file private data. Must be called with
 544  * cifs_file_list_lock held.
 545  */
 546 static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
 547 {
 548         ++cifs_file->count;
 549 }
 550
 551 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
 552
 553 /*
 554  * One of these for each file inode
 555  */
 556
 557 struct cifsInodeInfo {
 558         struct list_head lockList;
 559         /* BB add in lists for dirty pages i.e. write caching info for oplock */
 560         struct list_head openFileList;
 561         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
 562         bool clientCanCacheRead;        /* read oplock */
 563         bool clientCanCacheAll;         /* read and writebehind oplock */
 564         bool delete_pending;            /* DELETE_ON_CLOSE is set */
 565         bool invalid_mapping;           /* pagecache is invalid */
 566         unsigned long time;             /* jiffies of last update of inode */
 567         u64  server_eof;                /* current file size on server */
 568         u64  uniqueid;                  /* server inode number */
 569         u64  createtime;                /* creation time on server */
 570 #ifdef CONFIG_CIFS_FSCACHE
 571         struct fscache_cookie *fscache;
 572 #endif
 573         struct inode vfs_inode;
 574 };
 575
 576 static inline struct cifsInodeInfo *
 577 CIFS_I(struct inode *inode)
 578 {
 579         return container_of(inode, struct cifsInodeInfo, vfs_inode);
 580 }
 581
 582 static inline struct cifs_sb_info *
 583 CIFS_SB(struct super_block *sb)
 584 {
 585         return sb->s_fs_info;
 586 }
 587
 588 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
 589 {
 590         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
 591                 return '/';
 592         else
 593                 return '\\';
 594 }
 595
 596 static inline void
 597 convert_delimiter(char *path, char delim)
 598 {
 599         int i;
 600         char old_delim;
 601
 602         if (path == NULL)
 603                 return;
 604
 605         if (delim == '/')
 606                 old_delim = '\\';
 607         else
 608                 old_delim = '/';
 609
 610         for (i = 0; path[i] != '\0'; i++) {
 611                 if (path[i] == old_delim)
 612                         path[i] = delim;
 613         }
 614 }
 615
 616 #ifdef CONFIG_CIFS_STATS
 617 #define cifs_stats_inc atomic_inc
 618
 619 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
 620                                             unsigned int bytes)
 621 {
 622         if (bytes) {
 623                 spin_lock(&tcon->stat_lock);
 624                 tcon->bytes_written += bytes;
 625                 spin_unlock(&tcon->stat_lock);
 626         }
 627 }
 628
 629 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
 630                                          unsigned int bytes)
 631 {
 632         spin_lock(&tcon->stat_lock);
 633         tcon->bytes_read += bytes;
 634         spin_unlock(&tcon->stat_lock);
 635 }
 636 #else
 637
 638 #define  cifs_stats_inc(field) do {} while (0)
 639 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
 640 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
 641
 642 #endif
 643
 644 struct mid_q_entry;
 645
 646 /*
 647  * This is the prototype for the mid callback function. When creating one,
 648  * take special care to avoid deadlocks. Things to bear in mind:
 649  *
 650  * - it will be called by cifsd, with no locks held
 651  * - the mid will be removed from any lists
 652  */
 653 typedef void (mid_callback_t)(struct mid_q_entry *mid);
 654
 655 /* one of these for every pending CIFS request to the server */
 656 struct mid_q_entry {
 657         struct list_head qhead; /* mids waiting on reply from this server */
 658         __u16 mid;              /* multiplex id */
 659         __u16 pid;              /* process id */
 660         __u32 sequence_number;  /* for CIFS signing */
 661         unsigned long when_alloc;  /* when mid was created */
 662 #ifdef CONFIG_CIFS_STATS2
 663         unsigned long when_sent; /* time when smb send finished */
 664         unsigned long when_received; /* when demux complete (taken off wire) */
 665 #endif
 666         mid_callback_t *callback; /* call completion callback */
 667         void *callback_data;      /* general purpose pointer for callback */
 668         struct smb_hdr *resp_buf;       /* response buffer */
 669         int midState;   /* wish this were enum but can not pass to wait_event */
 670         __u8 command;   /* smb command code */
 671         bool largeBuf:1;        /* if valid response, is pointer to large buf */
 672         bool multiRsp:1;        /* multiple trans2 responses for one request  */
 673         bool multiEnd:1;        /* both received */
 674 };
 675
 676 struct oplock_q_entry {
 677         struct list_head qhead;
 678         struct inode *pinode;
 679         struct cifs_tcon *tcon;
 680         __u16 netfid;
 681 };
 682
 683 /* for pending dnotify requests */
 684 struct dir_notify_req {
 685         struct list_head lhead;
 686         __le16 Pid;
 687         __le16 PidHigh;
 688         __u16 Mid;
 689         __u16 Tid;
 690         __u16 Uid;
 691         __u16 netfid;
 692         __u32 filter; /* CompletionFilter (for multishot) */
 693         int multishot;
 694         struct file *pfile;
 695 };
 696
 697 struct dfs_info3_param {
 698         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
 699         int path_consumed;
 700         int server_type;
 701         int ref_flag;
 702         char *path_name;
 703         char *node_name;
 704 };
 705
 706 /*
 707  * common struct for holding inode info when searching for or updating an
 708  * inode with new info
 709  */
 710
 711 #define CIFS_FATTR_DFS_REFERRAL         0x1
 712 #define CIFS_FATTR_DELETE_PENDING       0x2
 713 #define CIFS_FATTR_NEED_REVAL           0x4
 714 #define CIFS_FATTR_INO_COLLISION        0x8
 715
 716 struct cifs_fattr {
 717         u32             cf_flags;
 718         u32             cf_cifsattrs;
 719         u64             cf_uniqueid;
 720         u64             cf_eof;
 721         u64             cf_bytes;
 722         u64             cf_createtime;
 723         uid_t           cf_uid;
 724         gid_t           cf_gid;
 725         umode_t         cf_mode;
 726         dev_t           cf_rdev;
 727         unsigned int    cf_nlink;
 728         unsigned int    cf_dtype;
 729         struct timespec cf_atime;
 730         struct timespec cf_mtime;
 731         struct timespec cf_ctime;
 732 };
 733
 734 static inline void free_dfs_info_param(struct dfs_info3_param *param)
 735 {
 736         if (param) {
 737                 kfree(param->path_name);
 738                 kfree(param->node_name);
 739                 kfree(param);
 740         }
 741 }
 742
 743 static inline void free_dfs_info_array(struct dfs_info3_param *param,
 744                                        int number_of_items)
 745 {
 746         int i;
 747         if ((number_of_items == 0) || (param == NULL))
 748                 return;
 749         for (i = 0; i < number_of_items; i++) {
 750                 kfree(param[i].path_name);
 751                 kfree(param[i].node_name);
 752         }
 753         kfree(param);
 754 }
 755
 756 #define   MID_FREE 0
 757 #define   MID_REQUEST_ALLOCATED 1
 758 #define   MID_REQUEST_SUBMITTED 2
 759 #define   MID_RESPONSE_RECEIVED 4
 760 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
 761 #define   MID_RESPONSE_MALFORMED 0x10
 762 #define   MID_SHUTDOWN           0x20
 763
 764 /* Types of response buffer returned from SendReceive2 */
 765 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
 766 #define   CIFS_SMALL_BUFFER     1
 767 #define   CIFS_LARGE_BUFFER     2
 768 #define   CIFS_IOVEC            4    /* array of response buffers */
 769
 770 /* Type of Request to SendReceive2 */
 771 #define   CIFS_BLOCKING_OP      1    /* operation can block */
 772 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
 773 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
 774 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
 775 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
 776 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
 777
 778 /* Security Flags: indicate type of session setup needed */
 779 #define   CIFSSEC_MAY_SIGN      0x00001
 780 #define   CIFSSEC_MAY_NTLM      0x00002
 781 #define   CIFSSEC_MAY_NTLMV2    0x00004
 782 #define   CIFSSEC_MAY_KRB5      0x00008
 783 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 784 #define   CIFSSEC_MAY_LANMAN    0x00010
 785 #define   CIFSSEC_MAY_PLNTXT    0x00020
 786 #else
 787 #define   CIFSSEC_MAY_LANMAN    0
 788 #define   CIFSSEC_MAY_PLNTXT    0
 789 #endif /* weak passwords */
 790 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
 791 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
 792
 793 #define   CIFSSEC_MUST_SIGN     0x01001
 794 /* note that only one of the following can be set so the
 795 result of setting MUST flags more than once will be to
 796 require use of the stronger protocol */
 797 #define   CIFSSEC_MUST_NTLM     0x02002
 798 #define   CIFSSEC_MUST_NTLMV2   0x04004
 799 #define   CIFSSEC_MUST_KRB5     0x08008
 800 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 801 #define   CIFSSEC_MUST_LANMAN   0x10010
 802 #define   CIFSSEC_MUST_PLNTXT   0x20020
 803 #ifdef CONFIG_CIFS_UPCALL
 804 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
 805 #else
 806 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
 807 #endif /* UPCALL */
 808 #else /* do not allow weak pw hash */
 809 #ifdef CONFIG_CIFS_UPCALL
 810 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
 811 #else
 812 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
 813 #endif /* UPCALL */
 814 #endif /* WEAK_PW_HASH */
 815 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
 816 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
 817
 818 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
 819 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
 820 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
 821 /*
 822  *****************************************************************
 823  * All constants go here
 824  *****************************************************************
 825  */
 826
 827 #define UID_HASH (16)
 828
 829 /*
 830  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
 831  * following to be declared.
 832  */
 833
 834 /****************************************************************************
 835  *  Locking notes.  All updates to global variables and lists should be
 836  *                  protected by spinlocks or semaphores.
 837  *
 838  *  Spinlocks
 839  *  ---------
 840  *  GlobalMid_Lock protects:
 841  *      list operations on pending_mid_q and oplockQ
 842  *      updates to XID counters, multiplex id  and SMB sequence numbers
 843  *  cifs_file_list_lock protects:
 844  *      list operations on tcp and SMB session lists and tCon lists
 845  *  f_owner.lock protects certain per file struct operations
 846  *  mapping->page_lock protects certain per page operations
 847  *
 848  *  Semaphores
 849  *  ----------
 850  *  sesSem     operations on smb session
 851  *  tconSem    operations on tree connection
 852  *  fh_sem      file handle reconnection operations
 853  *
 854  ****************************************************************************/
 855
 856 #ifdef DECLARE_GLOBALS_HERE
 857 #define GLOBAL_EXTERN
 858 #else
 859 #define GLOBAL_EXTERN extern
 860 #endif
 861
 862 /*
 863  * the list of TCP_Server_Info structures, ie each of the sockets
 864  * connecting our client to a distinct server (ip address), is
 865  * chained together by cifs_tcp_ses_list. The list of all our SMB
 866  * sessions (and from that the tree connections) can be found
 867  * by iterating over cifs_tcp_ses_list
 868  */
 869 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
 870
 871 /*
 872  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
 873  * tcp session, and the list of tcon's per smb session. It also protects
 874  * the reference counters for the server, smb session, and tcon. Finally,
 875  * changes to the tcon->tidStatus should be done while holding this lock.
 876  */
 877 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
 878
 879 /*
 880  * This lock protects the cifs_file->llist and cifs_file->flist
 881  * list operations, and updates to some flags (cifs_file->invalidHandle)
 882  * It will be moved to either use the tcon->stat_lock or equivalent later.
 883  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
 884  * the cifs_tcp_ses_lock must be grabbed first and released last.
 885  */
 886 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
 887
 888 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
 889 /* Outstanding dir notify requests */
 890 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
 891 /* DirNotify response queue */
 892 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
 893 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
 894
 895 /*
 896  * Global transaction id (XID) information
 897  */
 898 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
 899 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
 900 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
 901 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
 902                                           /* on midQ entries */
 903 /*
 904  *  Global counters, updated atomically
 905  */
 906 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
 907 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
 908 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
 909 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
 910 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
 911
 912 /* Various Debug counters */
 913 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
 914 #ifdef CONFIG_CIFS_STATS2
 915 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
 916 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
 917 #endif
 918 GLOBAL_EXTERN atomic_t smBufAllocCount;
 919 GLOBAL_EXTERN atomic_t midCount;
 920
 921 /* Misc globals */
 922 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
 923                                 to be established on existing mount if we
 924                                 have the uid/password or Kerberos credential
 925                                 or equivalent for current user */
 926 GLOBAL_EXTERN unsigned int oplockEnabled;
 927 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
 928 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
 929                                 with more secure ntlmssp2 challenge/resp */
 930 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
 931 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
 932 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
 933 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
 934 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
 935 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
 936
 937 /* reconnect after this many failed echo attempts */
 938 GLOBAL_EXTERN unsigned short echo_retries;
 939
 940 GLOBAL_EXTERN struct rb_root uidtree;
 941 GLOBAL_EXTERN struct rb_root gidtree;
 942 GLOBAL_EXTERN spinlock_t siduidlock;
 943 GLOBAL_EXTERN spinlock_t sidgidlock;
 944
 945 void cifs_oplock_break(struct work_struct *work);
 946 void cifs_oplock_break_get(struct cifsFileInfo *cfile);
 947 void cifs_oplock_break_put(struct cifsFileInfo *cfile);
 948
 949 extern const struct slow_work_ops cifs_oplock_break_ops;
 950
 951 #endif  /* _CIFS_GLOB_H */