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