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