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/mempool.h>
  26 #include <linux/workqueue.h>
  27 #include "cifs_fs_sb.h"
  28 #include "cifsacl.h"
  29 #include <crypto/internal/hash.h>
  30 #include <linux/scatterlist.h>
  31 #ifdef CONFIG_CIFS_SMB2
  32 #include "smb2pdu.h"
  33 #endif
  34
  35 /*
  36  * The sizes of various internal tables and strings
  37  */
  38 #define MAX_UID_INFO 16
  39 #define MAX_SES_INFO 2
  40 #define MAX_TCON_INFO 4
  41
  42 #define MAX_TREE_SIZE (2 + MAX_SERVER_SIZE + 1 + MAX_SHARE_SIZE + 1)
  43 #define MAX_SERVER_SIZE 15
  44 #define MAX_SHARE_SIZE 80
  45 #define MAX_USERNAME_SIZE 256   /* reasonable maximum for current servers */
  46 #define MAX_PASSWORD_SIZE 512   /* max for windows seems to be 256 wide chars */
  47
  48 #define CIFS_MIN_RCV_POOL 4
  49
  50 #define MAX_REOPEN_ATT  5 /* these many maximum attempts to reopen a file */
  51 /*
  52  * default attribute cache timeout (jiffies)
  53  */
  54 #define CIFS_DEF_ACTIMEO (1 * HZ)
  55
  56 /*
  57  * max attribute cache timeout (jiffies) - 2^30
  58  */
  59 #define CIFS_MAX_ACTIMEO (1 << 30)
  60
  61 /*
  62  * MAX_REQ is the maximum number of requests that WE will send
  63  * on one socket concurrently.
  64  */
  65 #define CIFS_MAX_REQ 32767
  66
  67 #define RFC1001_NAME_LEN 15
  68 #define RFC1001_NAME_LEN_WITH_NULL (RFC1001_NAME_LEN + 1)
  69
  70 /* currently length of NIP6_FMT */
  71 #define SERVER_NAME_LENGTH 40
  72 #define SERVER_NAME_LEN_WITH_NULL     (SERVER_NAME_LENGTH + 1)
  73
  74 /* used to define string lengths for reversing unicode strings */
  75 /*         (256+1)*2 = 514                                     */
  76 /*           (max path length + 1 for null) * 2 for unicode    */
  77 #define MAX_NAME 514
  78
  79 /* SMB echo "timeout" -- FIXME: tunable? */
  80 #define SMB_ECHO_INTERVAL (60 * HZ)
  81
  82 #include "cifspdu.h"
  83
  84 #ifndef XATTR_DOS_ATTRIB
  85 #define XATTR_DOS_ATTRIB "user.DOSATTRIB"
  86 #endif
  87
  88 /*
  89  * CIFS vfs client Status information (based on what we know.)
  90  */
  91
  92 /* associated with each tcp and smb session */
  93 enum statusEnum {
  94         CifsNew = 0,
  95         CifsGood,
  96         CifsExiting,
  97         CifsNeedReconnect,
  98         CifsNeedNegotiate
  99 };
 100
 101 enum securityEnum {
 102         LANMAN = 0,                     /* Legacy LANMAN auth */
 103         NTLM,                   /* Legacy NTLM012 auth with NTLM hash */
 104         NTLMv2,                 /* Legacy NTLM auth with NTLMv2 hash */
 105         RawNTLMSSP,             /* NTLMSSP without SPNEGO, NTLMv2 hash */
 106 /*      NTLMSSP, */ /* can use rawNTLMSSP instead of NTLMSSP via SPNEGO */
 107         Kerberos,               /* Kerberos via SPNEGO */
 108 };
 109
 110 enum protocolEnum {
 111         TCP = 0,
 112         SCTP
 113         /* Netbios frames protocol not supported at this time */
 114 };
 115
 116 struct session_key {
 117         unsigned int len;
 118         char *response;
 119 };
 120
 121 /* crypto security descriptor definition */
 122 struct sdesc {
 123         struct shash_desc shash;
 124         char ctx[];
 125 };
 126
 127 /* crypto hashing related structure/fields, not specific to a sec mech */
 128 struct cifs_secmech {
 129         struct crypto_shash *hmacmd5; /* hmac-md5 hash function */
 130         struct crypto_shash *md5; /* md5 hash function */
 131         struct sdesc *sdeschmacmd5;  /* ctxt to generate ntlmv2 hash, CR1 */
 132         struct sdesc *sdescmd5; /* ctxt to generate cifs/smb signature */
 133 };
 134
 135 /* per smb session structure/fields */
 136 struct ntlmssp_auth {
 137         __u32 client_flags; /* sent by client in type 1 ntlmsssp exchange */
 138         __u32 server_flags; /* sent by server in type 2 ntlmssp exchange */
 139         unsigned char ciphertext[CIFS_CPHTXT_SIZE]; /* sent to server */
 140         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlmssp */
 141 };
 142
 143 struct cifs_cred {
 144         int uid;
 145         int gid;
 146         int mode;
 147         int cecount;
 148         struct cifs_sid osid;
 149         struct cifs_sid gsid;
 150         struct cifs_ntace *ntaces;
 151         struct cifs_ace *aces;
 152 };
 153
 154 /*
 155  *****************************************************************
 156  * Except the CIFS PDUs themselves all the
 157  * globally interesting structs should go here
 158  *****************************************************************
 159  */
 160
 161 enum smb_version {
 162         Smb_1 = 1,
 163         Smb_21,
 164 };
 165
 166 struct mid_q_entry;
 167 struct TCP_Server_Info;
 168 struct cifsFileInfo;
 169 struct cifs_ses;
 170 struct cifs_tcon;
 171 struct dfs_info3_param;
 172 struct cifs_fattr;
 173 struct smb_vol;
 174 struct cifs_fid;
 175 struct cifs_readdata;
 176
 177 struct smb_version_operations {
 178         int (*send_cancel)(struct TCP_Server_Info *, void *,
 179                            struct mid_q_entry *);
 180         bool (*compare_fids)(struct cifsFileInfo *, struct cifsFileInfo *);
 181         /* setup request: allocate mid, sign message */
 182         int (*setup_request)(struct cifs_ses *, struct kvec *, unsigned int,
 183                              struct mid_q_entry **);
 184         /* setup async request: allocate mid, sign message */
 185         int (*setup_async_request)(struct TCP_Server_Info *, struct kvec *,
 186                                    unsigned int, struct mid_q_entry **);
 187         /* check response: verify signature, map error */
 188         int (*check_receive)(struct mid_q_entry *, struct TCP_Server_Info *,
 189                              bool);
 190         void (*add_credits)(struct TCP_Server_Info *, const unsigned int,
 191                             const int);
 192         void (*set_credits)(struct TCP_Server_Info *, const int);
 193         int * (*get_credits_field)(struct TCP_Server_Info *, const int);
 194         unsigned int (*get_credits)(struct mid_q_entry *);
 195         __u64 (*get_next_mid)(struct TCP_Server_Info *);
 196         /* data offset from read response message */
 197         unsigned int (*read_data_offset)(char *);
 198         /* data length from read response message */
 199         unsigned int (*read_data_length)(char *);
 200         /* map smb to linux error */
 201         int (*map_error)(char *, bool);
 202         /* find mid corresponding to the response message */
 203         struct mid_q_entry * (*find_mid)(struct TCP_Server_Info *, char *);
 204         void (*dump_detail)(void *);
 205         void (*clear_stats)(struct cifs_tcon *);
 206         void (*print_stats)(struct seq_file *m, struct cifs_tcon *);
 207         /* verify the message */
 208         int (*check_message)(char *, unsigned int);
 209         bool (*is_oplock_break)(char *, struct TCP_Server_Info *);
 210         /* process transaction2 response */
 211         bool (*check_trans2)(struct mid_q_entry *, struct TCP_Server_Info *,
 212                              char *, int);
 213         /* check if we need to negotiate */
 214         bool (*need_neg)(struct TCP_Server_Info *);
 215         /* negotiate to the server */
 216         int (*negotiate)(const unsigned int, struct cifs_ses *);
 217         /* set negotiated write size */
 218         unsigned int (*negotiate_wsize)(struct cifs_tcon *, struct smb_vol *);
 219         /* set negotiated read size */
 220         unsigned int (*negotiate_rsize)(struct cifs_tcon *, struct smb_vol *);
 221         /* setup smb sessionn */
 222         int (*sess_setup)(const unsigned int, struct cifs_ses *,
 223                           const struct nls_table *);
 224         /* close smb session */
 225         int (*logoff)(const unsigned int, struct cifs_ses *);
 226         /* connect to a server share */
 227         int (*tree_connect)(const unsigned int, struct cifs_ses *, const char *,
 228                             struct cifs_tcon *, const struct nls_table *);
 229         /* close tree connecion */
 230         int (*tree_disconnect)(const unsigned int, struct cifs_tcon *);
 231         /* get DFS referrals */
 232         int (*get_dfs_refer)(const unsigned int, struct cifs_ses *,
 233                              const char *, struct dfs_info3_param **,
 234                              unsigned int *, const struct nls_table *, int);
 235         /* informational QFS call */
 236         void (*qfs_tcon)(const unsigned int, struct cifs_tcon *);
 237         /* check if a path is accessible or not */
 238         int (*is_path_accessible)(const unsigned int, struct cifs_tcon *,
 239                                   struct cifs_sb_info *, const char *);
 240         /* query path data from the server */
 241         int (*query_path_info)(const unsigned int, struct cifs_tcon *,
 242                                struct cifs_sb_info *, const char *,
 243                                FILE_ALL_INFO *, bool *);
 244         /* query file data from the server */
 245         int (*query_file_info)(const unsigned int, struct cifs_tcon *,
 246                                struct cifs_fid *, FILE_ALL_INFO *);
 247         /* get server index number */
 248         int (*get_srv_inum)(const unsigned int, struct cifs_tcon *,
 249                             struct cifs_sb_info *, const char *,
 250                             u64 *uniqueid, FILE_ALL_INFO *);
 251         /* build a full path to the root of the mount */
 252         char * (*build_path_to_root)(struct smb_vol *, struct cifs_sb_info *,
 253                                      struct cifs_tcon *);
 254         /* check if we can send an echo or nor */
 255         bool (*can_echo)(struct TCP_Server_Info *);
 256         /* send echo request */
 257         int (*echo)(struct TCP_Server_Info *);
 258         /* create directory */
 259         int (*mkdir)(const unsigned int, struct cifs_tcon *, const char *,
 260                      struct cifs_sb_info *);
 261         /* set info on created directory */
 262         void (*mkdir_setinfo)(struct inode *, const char *,
 263                               struct cifs_sb_info *, struct cifs_tcon *,
 264                               const unsigned int);
 265         /* remove directory */
 266         int (*rmdir)(const unsigned int, struct cifs_tcon *, const char *,
 267                      struct cifs_sb_info *);
 268         /* unlink file */
 269         int (*unlink)(const unsigned int, struct cifs_tcon *, const char *,
 270                       struct cifs_sb_info *);
 271         /* open, rename and delete file */
 272         int (*rename_pending_delete)(const char *, struct dentry *,
 273                                      const unsigned int);
 274         /* open a file for non-posix mounts */
 275         int (*open)(const unsigned int, struct cifs_tcon *, const char *, int,
 276                     int, int, struct cifs_fid *, __u32 *, FILE_ALL_INFO *,
 277                     struct cifs_sb_info *);
 278         /* set fid protocol-specific info */
 279         void (*set_fid)(struct cifsFileInfo *, struct cifs_fid *, __u32);
 280         /* close a file */
 281         int (*close)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
 282         /* send a flush request to the server */
 283         int (*flush)(const unsigned int, struct cifs_tcon *, struct cifs_fid *);
 284         /* async read from the server */
 285         int (*async_readv)(struct cifs_readdata *);
 286 };
 287
 288 struct smb_version_values {
 289         char            *version_string;
 290         __u32           large_lock_type;
 291         __u32           exclusive_lock_type;
 292         __u32           shared_lock_type;
 293         __u32           unlock_lock_type;
 294         size_t          header_size;
 295         size_t          max_header_size;
 296         size_t          read_rsp_size;
 297         __le16          lock_cmd;
 298         unsigned int    cap_unix;
 299         unsigned int    cap_nt_find;
 300         unsigned int    cap_large_files;
 301 };
 302
 303 #define HEADER_SIZE(server) (server->vals->header_size)
 304 #define MAX_HEADER_SIZE(server) (server->vals->max_header_size)
 305
 306 struct smb_vol {
 307         char *username;
 308         char *password;
 309         char *domainname;
 310         char *UNC;
 311         char *UNCip;
 312         char *iocharset;  /* local code page for mapping to and from Unicode */
 313         char source_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* clnt nb name */
 314         char target_rfc1001_name[RFC1001_NAME_LEN_WITH_NULL]; /* srvr nb name */
 315         uid_t cred_uid;
 316         uid_t linux_uid;
 317         gid_t linux_gid;
 318         uid_t backupuid;
 319         gid_t backupgid;
 320         umode_t file_mode;
 321         umode_t dir_mode;
 322         unsigned secFlg;
 323         bool retry:1;
 324         bool intr:1;
 325         bool setuids:1;
 326         bool override_uid:1;
 327         bool override_gid:1;
 328         bool dynperm:1;
 329         bool noperm:1;
 330         bool no_psx_acl:1; /* set if posix acl support should be disabled */
 331         bool cifs_acl:1;
 332         bool backupuid_specified; /* mount option  backupuid  is specified */
 333         bool backupgid_specified; /* mount option  backupgid  is specified */
 334         bool no_xattr:1;   /* set if xattr (EA) support should be disabled*/
 335         bool server_ino:1; /* use inode numbers from server ie UniqueId */
 336         bool direct_io:1;
 337         bool strict_io:1; /* strict cache behavior */
 338         bool remap:1;      /* set to remap seven reserved chars in filenames */
 339         bool posix_paths:1; /* unset to not ask for posix pathnames. */
 340         bool no_linux_ext:1;
 341         bool sfu_emul:1;
 342         bool nullauth:1;   /* attempt to authenticate with null user */
 343         bool nocase:1;     /* request case insensitive filenames */
 344         bool nobrl:1;      /* disable sending byte range locks to srv */
 345         bool mand_lock:1;  /* send mandatory not posix byte range lock reqs */
 346         bool seal:1;       /* request transport encryption on share */
 347         bool nodfs:1;      /* Do not request DFS, even if available */
 348         bool local_lease:1; /* check leases only on local system, not remote */
 349         bool noblocksnd:1;
 350         bool noautotune:1;
 351         bool nostrictsync:1; /* do not force expensive SMBflush on every sync */
 352         bool fsc:1;     /* enable fscache */
 353         bool mfsymlinks:1; /* use Minshall+French Symlinks */
 354         bool multiuser:1;
 355         bool rwpidforward:1; /* pid forward for read/write operations */
 356         unsigned int rsize;
 357         unsigned int wsize;
 358         bool sockopt_tcp_nodelay:1;
 359         unsigned short int port;
 360         unsigned long actimeo; /* attribute cache timeout (jiffies) */
 361         struct smb_version_operations *ops;
 362         struct smb_version_values *vals;
 363         char *prepath;
 364         struct sockaddr_storage srcaddr; /* allow binding to a local IP */
 365         struct nls_table *local_nls;
 366 };
 367
 368 #define CIFS_MOUNT_MASK (CIFS_MOUNT_NO_PERM | CIFS_MOUNT_SET_UID | \
 369                          CIFS_MOUNT_SERVER_INUM | CIFS_MOUNT_DIRECT_IO | \
 370                          CIFS_MOUNT_NO_XATTR | CIFS_MOUNT_MAP_SPECIAL_CHR | \
 371                          CIFS_MOUNT_UNX_EMUL | CIFS_MOUNT_NO_BRL | \
 372                          CIFS_MOUNT_CIFS_ACL | CIFS_MOUNT_OVERR_UID | \
 373                          CIFS_MOUNT_OVERR_GID | CIFS_MOUNT_DYNPERM | \
 374                          CIFS_MOUNT_NOPOSIXBRL | CIFS_MOUNT_NOSSYNC | \
 375                          CIFS_MOUNT_FSCACHE | CIFS_MOUNT_MF_SYMLINKS | \
 376                          CIFS_MOUNT_MULTIUSER | CIFS_MOUNT_STRICT_IO | \
 377                          CIFS_MOUNT_CIFS_BACKUPUID | CIFS_MOUNT_CIFS_BACKUPGID)
 378
 379 #define CIFS_MS_MASK (MS_RDONLY | MS_MANDLOCK | MS_NOEXEC | MS_NOSUID | \
 380                       MS_NODEV | MS_SYNCHRONOUS)
 381
 382 struct cifs_mnt_data {
 383         struct cifs_sb_info *cifs_sb;
 384         struct smb_vol *vol;
 385         int flags;
 386 };
 387
 388 static inline unsigned int
 389 get_rfc1002_length(void *buf)
 390 {
 391         return be32_to_cpu(*((__be32 *)buf));
 392 }
 393
 394 static inline void
 395 inc_rfc1001_len(void *buf, int count)
 396 {
 397         be32_add_cpu((__be32 *)buf, count);
 398 }
 399
 400 struct TCP_Server_Info {
 401         struct list_head tcp_ses_list;
 402         struct list_head smb_ses_list;
 403         int srv_count; /* reference counter */
 404         /* 15 character server name + 0x20 16th byte indicating type = srv */
 405         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 406         struct smb_version_operations   *ops;
 407         struct smb_version_values       *vals;
 408         enum statusEnum tcpStatus; /* what we think the status is */
 409         char *hostname; /* hostname portion of UNC string */
 410         struct socket *ssocket;
 411         struct sockaddr_storage dstaddr;
 412         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 413 #ifdef CONFIG_NET_NS
 414         struct net *net;
 415 #endif
 416         wait_queue_head_t response_q;
 417         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 418         struct list_head pending_mid_q;
 419         bool noblocksnd;                /* use blocking sendmsg */
 420         bool noautotune;                /* do not autotune send buf sizes */
 421         bool tcp_nodelay;
 422         int credits;  /* send no more requests at once */
 423         unsigned int in_flight;  /* number of requests on the wire to server */
 424         spinlock_t req_lock;  /* protect the two values above */
 425         struct mutex srv_mutex;
 426         struct task_struct *tsk;
 427         char server_GUID[16];
 428         __u16 sec_mode;
 429         bool session_estab; /* mark when very first sess is established */
 430 #ifdef CONFIG_CIFS_SMB2
 431         int echo_credits;  /* echo reserved slots */
 432         int oplock_credits;  /* oplock break reserved slots */
 433         bool echoes:1; /* enable echoes */
 434 #endif
 435         u16 dialect; /* dialect index that server chose */
 436         enum securityEnum secType;
 437         bool oplocks:1; /* enable oplocks */
 438         unsigned int maxReq;    /* Clients should submit no more */
 439         /* than maxReq distinct unanswered SMBs to the server when using  */
 440         /* multiplexed reads or writes */
 441         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 442         /* message size the server can send or receive for non-raw SMBs */
 443         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 444         /* when socket is setup (and during reconnect) before NegProt sent */
 445         unsigned int max_rw;    /* maxRw specifies the maximum */
 446         /* message size the server can send or receive for */
 447         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 448         unsigned int max_vcs;   /* maximum number of smb sessions, at least
 449                                    those that can be specified uniquely with
 450                                    vcnumbers */
 451         unsigned int capabilities; /* selective disabling of caps by smb sess */
 452         int timeAdj;  /* Adjust for difference in server time zone in sec */
 453         __u64 CurrentMid;         /* multiplex id - rotating counter */
 454         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 455         /* 16th byte of RFC1001 workstation name is always null */
 456         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 457         __u32 sequence_number; /* for signing, protected by srv_mutex */
 458         struct session_key session_key;
 459         unsigned long lstrp; /* when we got last response from this server */
 460         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 461         /* extended security flavors that server supports */
 462         bool    sec_ntlmssp;            /* supports NTLMSSP */
 463         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 464         bool    sec_kerberos;           /* supports plain Kerberos */
 465         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 466         bool    large_buf;              /* is current buffer large? */
 467         struct delayed_work     echo; /* echo ping workqueue job */
 468         struct kvec *iov;       /* reusable kvec array for receives */
 469         unsigned int nr_iov;    /* number of kvecs in array */
 470         char    *smallbuf;      /* pointer to current "small" buffer */
 471         char    *bigbuf;        /* pointer to current "big" buffer */
 472         unsigned int total_read; /* total amount of data read in this pass */
 473 #ifdef CONFIG_CIFS_FSCACHE
 474         struct fscache_cookie   *fscache; /* client index cache cookie */
 475 #endif
 476 #ifdef CONFIG_CIFS_STATS2
 477         atomic_t in_send; /* requests trying to send */
 478         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 479 #endif
 480 #ifdef CONFIG_CIFS_SMB2
 481         unsigned int    max_read;
 482         unsigned int    max_write;
 483 #endif /* CONFIG_CIFS_SMB2 */
 484 };
 485
 486 static inline unsigned int
 487 in_flight(struct TCP_Server_Info *server)
 488 {
 489         unsigned int num;
 490         spin_lock(&server->req_lock);
 491         num = server->in_flight;
 492         spin_unlock(&server->req_lock);
 493         return num;
 494 }
 495
 496 static inline bool
 497 has_credits(struct TCP_Server_Info *server, int *credits)
 498 {
 499         int num;
 500         spin_lock(&server->req_lock);
 501         num = *credits;
 502         spin_unlock(&server->req_lock);
 503         return num > 0;
 504 }
 505
 506 static inline void
 507 add_credits(struct TCP_Server_Info *server, const unsigned int add,
 508             const int optype)
 509 {
 510         server->ops->add_credits(server, add, optype);
 511 }
 512
 513 static inline void
 514 set_credits(struct TCP_Server_Info *server, const int val)
 515 {
 516         server->ops->set_credits(server, val);
 517 }
 518
 519 static inline __u64
 520 get_next_mid(struct TCP_Server_Info *server)
 521 {
 522         return server->ops->get_next_mid(server);
 523 }
 524
 525 /*
 526  * When the server supports very large reads and writes via POSIX extensions,
 527  * we can allow up to 2^24-1, minus the size of a READ/WRITE_AND_X header, not
 528  * including the RFC1001 length.
 529  *
 530  * Note that this might make for "interesting" allocation problems during
 531  * writeback however as we have to allocate an array of pointers for the
 532  * pages. A 16M write means ~32kb page array with PAGE_CACHE_SIZE == 4096.
 533  *
 534  * For reads, there is a similar problem as we need to allocate an array
 535  * of kvecs to handle the receive, though that should only need to be done
 536  * once.
 537  */
 538 #define CIFS_MAX_WSIZE ((1<<24) - 1 - sizeof(WRITE_REQ) + 4)
 539 #define CIFS_MAX_RSIZE ((1<<24) - sizeof(READ_RSP) + 4)
 540
 541 /*
 542  * When the server doesn't allow large posix writes, only allow a rsize/wsize
 543  * of 2^17-1 minus the size of the call header. That allows for a read or
 544  * write up to the maximum size described by RFC1002.
 545  */
 546 #define CIFS_MAX_RFC1002_WSIZE ((1<<17) - 1 - sizeof(WRITE_REQ) + 4)
 547 #define CIFS_MAX_RFC1002_RSIZE ((1<<17) - 1 - sizeof(READ_RSP) + 4)
 548
 549 /*
 550  * The default wsize is 1M. find_get_pages seems to return a maximum of 256
 551  * pages in a single call. With PAGE_CACHE_SIZE == 4k, this means we can fill
 552  * a single wsize request with a single call.
 553  */
 554 #define CIFS_DEFAULT_IOSIZE (1024 * 1024)
 555
 556 /*
 557  * Windows only supports a max of 60kb reads and 65535 byte writes. Default to
 558  * those values when posix extensions aren't in force. In actuality here, we
 559  * use 65536 to allow for a write that is a multiple of 4k. Most servers seem
 560  * to be ok with the extra byte even though Windows doesn't send writes that
 561  * are that large.
 562  *
 563  * Citation:
 564  *
 565  * http://blogs.msdn.com/b/openspecification/archive/2009/04/10/smb-maximum-transmit-buffer-size-and-performance-tuning.aspx
 566  */
 567 #define CIFS_DEFAULT_NON_POSIX_RSIZE (60 * 1024)
 568 #define CIFS_DEFAULT_NON_POSIX_WSIZE (65536)
 569
 570 /*
 571  * On hosts with high memory, we can't currently support wsize/rsize that are
 572  * larger than we can kmap at once. Cap the rsize/wsize at
 573  * LAST_PKMAP * PAGE_SIZE. We'll never be able to fill a read or write request
 574  * larger than that anyway.
 575  */
 576 #ifdef CONFIG_HIGHMEM
 577 #define CIFS_KMAP_SIZE_LIMIT   (LAST_PKMAP * PAGE_CACHE_SIZE)
 578 #else /* CONFIG_HIGHMEM */
 579 #define CIFS_KMAP_SIZE_LIMIT   (1<<24)
 580 #endif /* CONFIG_HIGHMEM */
 581
 582 /*
 583  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 584  * when CONFIG_NET_NS isn't set.
 585  */
 586
 587 #ifdef CONFIG_NET_NS
 588
 589 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 590 {
 591         return srv->net;
 592 }
 593
 594 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 595 {
 596         srv->net = net;
 597 }
 598
 599 #else
 600
 601 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 602 {
 603         return &init_net;
 604 }
 605
 606 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 607 {
 608 }
 609
 610 #endif
 611
 612 /*
 613  * Session structure.  One of these for each uid session with a particular host
 614  */
 615 struct cifs_ses {
 616         struct list_head smb_ses_list;
 617         struct list_head tcon_list;
 618         struct mutex session_mutex;
 619         struct TCP_Server_Info *server; /* pointer to server info */
 620         int ses_count;          /* reference counter */
 621         enum statusEnum status;
 622         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 623         __u16 ipc_tid;          /* special tid for connection to IPC share */
 624         __u16 flags;
 625         __u16 vcnum;
 626         char *serverOS;         /* name of operating system underlying server */
 627         char *serverNOS;        /* name of network operating system of server */
 628         char *serverDomain;     /* security realm of server */
 629         __u64 Suid;             /* remote smb uid  */
 630         uid_t linux_uid;        /* overriding owner of files on the mount */
 631         uid_t cred_uid;         /* owner of credentials */
 632         unsigned int capabilities;
 633         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
 634                                 TCP names - will ipv6 and sctp addresses fit? */
 635         char *user_name;        /* must not be null except during init of sess
 636                                    and after mount option parsing we fill it */
 637         char *domainName;
 638         char *password;
 639         struct session_key auth_key;
 640         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 641         bool need_reconnect:1; /* connection reset, uid now invalid */
 642 #ifdef CONFIG_CIFS_SMB2
 643         __u16 session_flags;
 644 #endif /* CONFIG_CIFS_SMB2 */
 645 };
 646 /* no more than one of the following three session flags may be set */
 647 #define CIFS_SES_NT4 1
 648 #define CIFS_SES_OS2 2
 649 #define CIFS_SES_W9X 4
 650 /* following flag is set for old servers such as OS2 (and Win95?)
 651    which do not negotiate NTLM or POSIX dialects, but instead
 652    negotiate one of the older LANMAN dialects */
 653 #define CIFS_SES_LANMAN 8
 654
 655 static inline bool
 656 cap_unix(struct cifs_ses *ses)
 657 {
 658         return ses->server->vals->cap_unix & ses->capabilities;
 659 }
 660
 661 /*
 662  * there is one of these for each connection to a resource on a particular
 663  * session
 664  */
 665 struct cifs_tcon {
 666         struct list_head tcon_list;
 667         int tc_count;
 668         struct list_head openFileList;
 669         struct cifs_ses *ses;   /* pointer to session associated with */
 670         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
 671         char *nativeFileSystem;
 672         char *password;         /* for share-level security */
 673         __u32 tid;              /* The 4 byte tree id */
 674         __u16 Flags;            /* optional support bits */
 675         enum statusEnum tidStatus;
 676 #ifdef CONFIG_CIFS_STATS
 677         atomic_t num_smbs_sent;
 678         union {
 679                 struct {
 680                         atomic_t num_writes;
 681                         atomic_t num_reads;
 682                         atomic_t num_flushes;
 683                         atomic_t num_oplock_brks;
 684                         atomic_t num_opens;
 685                         atomic_t num_closes;
 686                         atomic_t num_deletes;
 687                         atomic_t num_mkdirs;
 688                         atomic_t num_posixopens;
 689                         atomic_t num_posixmkdirs;
 690                         atomic_t num_rmdirs;
 691                         atomic_t num_renames;
 692                         atomic_t num_t2renames;
 693                         atomic_t num_ffirst;
 694                         atomic_t num_fnext;
 695                         atomic_t num_fclose;
 696                         atomic_t num_hardlinks;
 697                         atomic_t num_symlinks;
 698                         atomic_t num_locks;
 699                         atomic_t num_acl_get;
 700                         atomic_t num_acl_set;
 701                 } cifs_stats;
 702 #ifdef CONFIG_CIFS_SMB2
 703                 struct {
 704                         atomic_t smb2_com_sent[NUMBER_OF_SMB2_COMMANDS];
 705                         atomic_t smb2_com_failed[NUMBER_OF_SMB2_COMMANDS];
 706                 } smb2_stats;
 707 #endif /* CONFIG_CIFS_SMB2 */
 708         } stats;
 709 #ifdef CONFIG_CIFS_STATS2
 710         unsigned long long time_writes;
 711         unsigned long long time_reads;
 712         unsigned long long time_opens;
 713         unsigned long long time_deletes;
 714         unsigned long long time_closes;
 715         unsigned long long time_mkdirs;
 716         unsigned long long time_rmdirs;
 717         unsigned long long time_renames;
 718         unsigned long long time_t2renames;
 719         unsigned long long time_ffirst;
 720         unsigned long long time_fnext;
 721         unsigned long long time_fclose;
 722 #endif /* CONFIG_CIFS_STATS2 */
 723         __u64    bytes_read;
 724         __u64    bytes_written;
 725         spinlock_t stat_lock;
 726 #endif /* CONFIG_CIFS_STATS */
 727         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
 728         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
 729         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
 730         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
 731         bool retry:1;
 732         bool nocase:1;
 733         bool seal:1;      /* transport encryption for this mounted share */
 734         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
 735                                 for this mount even if server would support */
 736         bool local_lease:1; /* check leases (only) on local system not remote */
 737         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
 738         bool need_reconnect:1; /* connection reset, tid now invalid */
 739 #ifdef CONFIG_CIFS_SMB2
 740         bool print:1;           /* set if connection to printer share */
 741         bool bad_network_name:1; /* set if ret status STATUS_BAD_NETWORK_NAME */
 742         __u32 capabilities;
 743         __u32 share_flags;
 744         __u32 maximal_access;
 745         __u32 vol_serial_number;
 746         __le64 vol_create_time;
 747 #endif /* CONFIG_CIFS_SMB2 */
 748 #ifdef CONFIG_CIFS_FSCACHE
 749         u64 resource_id;                /* server resource id */
 750         struct fscache_cookie *fscache; /* cookie for share */
 751 #endif
 752         /* BB add field for back pointer to sb struct(s)? */
 753 };
 754
 755 /*
 756  * This is a refcounted and timestamped container for a tcon pointer. The
 757  * container holds a tcon reference. It is considered safe to free one of
 758  * these when the tl_count goes to 0. The tl_time is the time of the last
 759  * "get" on the container.
 760  */
 761 struct tcon_link {
 762         struct rb_node          tl_rbnode;
 763         uid_t                   tl_uid;
 764         unsigned long           tl_flags;
 765 #define TCON_LINK_MASTER        0
 766 #define TCON_LINK_PENDING       1
 767 #define TCON_LINK_IN_TREE       2
 768         unsigned long           tl_time;
 769         atomic_t                tl_count;
 770         struct cifs_tcon        *tl_tcon;
 771 };
 772
 773 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
 774
 775 static inline struct cifs_tcon *
 776 tlink_tcon(struct tcon_link *tlink)
 777 {
 778         return tlink->tl_tcon;
 779 }
 780
 781 extern void cifs_put_tlink(struct tcon_link *tlink);
 782
 783 static inline struct tcon_link *
 784 cifs_get_tlink(struct tcon_link *tlink)
 785 {
 786         if (tlink && !IS_ERR(tlink))
 787                 atomic_inc(&tlink->tl_count);
 788         return tlink;
 789 }
 790
 791 /* This function is always expected to succeed */
 792 extern struct cifs_tcon *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
 793
 794 /*
 795  * This info hangs off the cifsFileInfo structure, pointed to by llist.
 796  * This is used to track byte stream locks on the file
 797  */
 798 struct cifsLockInfo {
 799         struct list_head llist; /* pointer to next cifsLockInfo */
 800         struct list_head blist; /* pointer to locks blocked on this */
 801         wait_queue_head_t block_q;
 802         __u64 offset;
 803         __u64 length;
 804         __u32 pid;
 805         __u32 type;
 806 };
 807
 808 /*
 809  * One of these for each open instance of a file
 810  */
 811 struct cifs_search_info {
 812         loff_t index_of_last_entry;
 813         __u16 entries_in_buffer;
 814         __u16 info_level;
 815         __u32 resume_key;
 816         char *ntwrk_buf_start;
 817         char *srch_entries_start;
 818         char *last_entry;
 819         const char *presume_name;
 820         unsigned int resume_name_len;
 821         bool endOfSearch:1;
 822         bool emptyDir:1;
 823         bool unicode:1;
 824         bool smallBuf:1; /* so we know which buf_release function to call */
 825 };
 826
 827 struct cifs_fid {
 828         __u16 netfid;
 829 #ifdef CONFIG_CIFS_SMB2
 830         __u64 persistent_fid;   /* persist file id for smb2 */
 831         __u64 volatile_fid;     /* volatile file id for smb2 */
 832 #endif
 833 };
 834
 835 struct cifsFileInfo {
 836         struct list_head tlist; /* pointer to next fid owned by tcon */
 837         struct list_head flist; /* next fid (file instance) for this inode */
 838         struct list_head llist; /*
 839                                  * brlocks held by this fid, protected by
 840                                  * lock_mutex from cifsInodeInfo structure
 841                                  */
 842         unsigned int uid;       /* allows finding which FileInfo structure */
 843         __u32 pid;              /* process id who opened file */
 844         struct cifs_fid fid;    /* file id from remote */
 845         /* BB add lock scope info here if needed */ ;
 846         /* lock scope id (0 if none) */
 847         struct dentry *dentry;
 848         unsigned int f_flags;
 849         struct tcon_link *tlink;
 850         bool invalidHandle:1;   /* file closed via session abend */
 851         bool oplock_break_cancelled:1;
 852         int count;              /* refcount protected by cifs_file_list_lock */
 853         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
 854         struct cifs_search_info srch_inf;
 855         struct work_struct oplock_break; /* work for oplock breaks */
 856 };
 857
 858 struct cifs_io_parms {
 859         __u16 netfid;
 860         __u32 pid;
 861         __u64 offset;
 862         unsigned int length;
 863         struct cifs_tcon *tcon;
 864 };
 865
 866 /*
 867  * Take a reference on the file private data. Must be called with
 868  * cifs_file_list_lock held.
 869  */
 870 static inline void
 871 cifsFileInfo_get_locked(struct cifsFileInfo *cifs_file)
 872 {
 873         ++cifs_file->count;
 874 }
 875
 876 struct cifsFileInfo *cifsFileInfo_get(struct cifsFileInfo *cifs_file);
 877 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
 878
 879 /*
 880  * One of these for each file inode
 881  */
 882
 883 struct cifsInodeInfo {
 884         bool can_cache_brlcks;
 885         struct mutex lock_mutex;        /*
 886                                          * protect the field above and llist
 887                                          * from every cifsFileInfo structure
 888                                          * from openFileList
 889                                          */
 890         /* BB add in lists for dirty pages i.e. write caching info for oplock */
 891         struct list_head openFileList;
 892         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
 893         bool clientCanCacheRead;        /* read oplock */
 894         bool clientCanCacheAll;         /* read and writebehind oplock */
 895         bool delete_pending;            /* DELETE_ON_CLOSE is set */
 896         bool invalid_mapping;           /* pagecache is invalid */
 897         unsigned long time;             /* jiffies of last update of inode */
 898         u64  server_eof;                /* current file size on server -- protected by i_lock */
 899         u64  uniqueid;                  /* server inode number */
 900         u64  createtime;                /* creation time on server */
 901 #ifdef CONFIG_CIFS_FSCACHE
 902         struct fscache_cookie *fscache;
 903 #endif
 904         struct inode vfs_inode;
 905 };
 906
 907 static inline struct cifsInodeInfo *
 908 CIFS_I(struct inode *inode)
 909 {
 910         return container_of(inode, struct cifsInodeInfo, vfs_inode);
 911 }
 912
 913 static inline struct cifs_sb_info *
 914 CIFS_SB(struct super_block *sb)
 915 {
 916         return sb->s_fs_info;
 917 }
 918
 919 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
 920 {
 921         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
 922                 return '/';
 923         else
 924                 return '\\';
 925 }
 926
 927 static inline void
 928 convert_delimiter(char *path, char delim)
 929 {
 930         int i;
 931         char old_delim;
 932
 933         if (path == NULL)
 934                 return;
 935
 936         if (delim == '/')
 937                 old_delim = '\\';
 938         else
 939                 old_delim = '/';
 940
 941         for (i = 0; path[i] != '\0'; i++) {
 942                 if (path[i] == old_delim)
 943                         path[i] = delim;
 944         }
 945 }
 946
 947 static inline char *
 948 build_path_to_root(struct smb_vol *vol, struct cifs_sb_info *cifs_sb,
 949                    struct cifs_tcon *tcon)
 950 {
 951         if (!vol->ops->build_path_to_root)
 952                 return NULL;
 953         return vol->ops->build_path_to_root(vol, cifs_sb, tcon);
 954 }
 955
 956 #ifdef CONFIG_CIFS_STATS
 957 #define cifs_stats_inc atomic_inc
 958
 959 static inline void cifs_stats_bytes_written(struct cifs_tcon *tcon,
 960                                             unsigned int bytes)
 961 {
 962         if (bytes) {
 963                 spin_lock(&tcon->stat_lock);
 964                 tcon->bytes_written += bytes;
 965                 spin_unlock(&tcon->stat_lock);
 966         }
 967 }
 968
 969 static inline void cifs_stats_bytes_read(struct cifs_tcon *tcon,
 970                                          unsigned int bytes)
 971 {
 972         spin_lock(&tcon->stat_lock);
 973         tcon->bytes_read += bytes;
 974         spin_unlock(&tcon->stat_lock);
 975 }
 976 #else
 977
 978 #define  cifs_stats_inc(field) do {} while (0)
 979 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
 980 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
 981
 982 #endif
 983
 984
 985 /*
 986  * This is the prototype for the mid receive function. This function is for
 987  * receiving the rest of the SMB frame, starting with the WordCount (which is
 988  * just after the MID in struct smb_hdr). Note:
 989  *
 990  * - This will be called by cifsd, with no locks held.
 991  * - The mid will still be on the pending_mid_q.
 992  * - mid->resp_buf will point to the current buffer.
 993  *
 994  * Returns zero on a successful receive, or an error. The receive state in
 995  * the TCP_Server_Info will also be updated.
 996  */
 997 typedef int (mid_receive_t)(struct TCP_Server_Info *server,
 998                             struct mid_q_entry *mid);
 999
1000 /*
1001  * This is the prototype for the mid callback function. This is called once the
1002  * mid has been received off of the socket. When creating one, take special
1003  * care to avoid deadlocks. Things to bear in mind:
1004  *
1005  * - it will be called by cifsd, with no locks held
1006  * - the mid will be removed from any lists
1007  */
1008 typedef void (mid_callback_t)(struct mid_q_entry *mid);
1009
1010 /* one of these for every pending CIFS request to the server */
1011 struct mid_q_entry {
1012         struct list_head qhead; /* mids waiting on reply from this server */
1013         struct TCP_Server_Info *server; /* server corresponding to this mid */
1014         __u64 mid;              /* multiplex id */
1015         __u32 pid;              /* process id */
1016         __u32 sequence_number;  /* for CIFS signing */
1017         unsigned long when_alloc;  /* when mid was created */
1018 #ifdef CONFIG_CIFS_STATS2
1019         unsigned long when_sent; /* time when smb send finished */
1020         unsigned long when_received; /* when demux complete (taken off wire) */
1021 #endif
1022         mid_receive_t *receive; /* call receive callback */
1023         mid_callback_t *callback; /* call completion callback */
1024         void *callback_data;      /* general purpose pointer for callback */
1025         void *resp_buf;         /* pointer to received SMB header */
1026         int mid_state;  /* wish this were enum but can not pass to wait_event */
1027         __le16 command;         /* smb command code */
1028         bool large_buf:1;       /* if valid response, is pointer to large buf */
1029         bool multiRsp:1;        /* multiple trans2 responses for one request  */
1030         bool multiEnd:1;        /* both received */
1031 };
1032
1033 /*      Make code in transport.c a little cleaner by moving
1034         update of optional stats into function below */
1035 #ifdef CONFIG_CIFS_STATS2
1036
1037 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1038 {
1039         atomic_inc(&server->in_send);
1040 }
1041
1042 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1043 {
1044         atomic_dec(&server->in_send);
1045 }
1046
1047 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1048 {
1049         atomic_inc(&server->num_waiters);
1050 }
1051
1052 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1053 {
1054         atomic_dec(&server->num_waiters);
1055 }
1056
1057 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1058 {
1059         mid->when_sent = jiffies;
1060 }
1061 #else
1062 static inline void cifs_in_send_inc(struct TCP_Server_Info *server)
1063 {
1064 }
1065 static inline void cifs_in_send_dec(struct TCP_Server_Info *server)
1066 {
1067 }
1068
1069 static inline void cifs_num_waiters_inc(struct TCP_Server_Info *server)
1070 {
1071 }
1072
1073 static inline void cifs_num_waiters_dec(struct TCP_Server_Info *server)
1074 {
1075 }
1076
1077 static inline void cifs_save_when_sent(struct mid_q_entry *mid)
1078 {
1079 }
1080 #endif
1081
1082 /* for pending dnotify requests */
1083 struct dir_notify_req {
1084         struct list_head lhead;
1085         __le16 Pid;
1086         __le16 PidHigh;
1087         __u16 Mid;
1088         __u16 Tid;
1089         __u16 Uid;
1090         __u16 netfid;
1091         __u32 filter; /* CompletionFilter (for multishot) */
1092         int multishot;
1093         struct file *pfile;
1094 };
1095
1096 struct dfs_info3_param {
1097         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
1098         int path_consumed;
1099         int server_type;
1100         int ref_flag;
1101         char *path_name;
1102         char *node_name;
1103 };
1104
1105 /*
1106  * common struct for holding inode info when searching for or updating an
1107  * inode with new info
1108  */
1109
1110 #define CIFS_FATTR_DFS_REFERRAL         0x1
1111 #define CIFS_FATTR_DELETE_PENDING       0x2
1112 #define CIFS_FATTR_NEED_REVAL           0x4
1113 #define CIFS_FATTR_INO_COLLISION        0x8
1114
1115 struct cifs_fattr {
1116         u32             cf_flags;
1117         u32             cf_cifsattrs;
1118         u64             cf_uniqueid;
1119         u64             cf_eof;
1120         u64             cf_bytes;
1121         u64             cf_createtime;
1122         uid_t           cf_uid;
1123         gid_t           cf_gid;
1124         umode_t         cf_mode;
1125         dev_t           cf_rdev;
1126         unsigned int    cf_nlink;
1127         unsigned int    cf_dtype;
1128         struct timespec cf_atime;
1129         struct timespec cf_mtime;
1130         struct timespec cf_ctime;
1131 };
1132
1133 static inline void free_dfs_info_param(struct dfs_info3_param *param)
1134 {
1135         if (param) {
1136                 kfree(param->path_name);
1137                 kfree(param->node_name);
1138                 kfree(param);
1139         }
1140 }
1141
1142 static inline void free_dfs_info_array(struct dfs_info3_param *param,
1143                                        int number_of_items)
1144 {
1145         int i;
1146         if ((number_of_items == 0) || (param == NULL))
1147                 return;
1148         for (i = 0; i < number_of_items; i++) {
1149                 kfree(param[i].path_name);
1150                 kfree(param[i].node_name);
1151         }
1152         kfree(param);
1153 }
1154
1155 #define   MID_FREE 0
1156 #define   MID_REQUEST_ALLOCATED 1
1157 #define   MID_REQUEST_SUBMITTED 2
1158 #define   MID_RESPONSE_RECEIVED 4
1159 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
1160 #define   MID_RESPONSE_MALFORMED 0x10
1161 #define   MID_SHUTDOWN           0x20
1162
1163 /* Types of response buffer returned from SendReceive2 */
1164 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
1165 #define   CIFS_SMALL_BUFFER     1
1166 #define   CIFS_LARGE_BUFFER     2
1167 #define   CIFS_IOVEC            4    /* array of response buffers */
1168
1169 /* Type of Request to SendReceive2 */
1170 #define   CIFS_BLOCKING_OP      1    /* operation can block */
1171 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
1172 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
1173 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
1174 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
1175 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
1176
1177 /* Type of request operation */
1178 #define   CIFS_ECHO_OP      0x080    /* echo request */
1179 #define   CIFS_OBREAK_OP   0x0100    /* oplock break request */
1180 #define   CIFS_NEG_OP      0x0200    /* negotiate request */
1181 #define   CIFS_OP_MASK     0x0380    /* mask request type */
1182
1183 /* Security Flags: indicate type of session setup needed */
1184 #define   CIFSSEC_MAY_SIGN      0x00001
1185 #define   CIFSSEC_MAY_NTLM      0x00002
1186 #define   CIFSSEC_MAY_NTLMV2    0x00004
1187 #define   CIFSSEC_MAY_KRB5      0x00008
1188 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1189 #define   CIFSSEC_MAY_LANMAN    0x00010
1190 #define   CIFSSEC_MAY_PLNTXT    0x00020
1191 #else
1192 #define   CIFSSEC_MAY_LANMAN    0
1193 #define   CIFSSEC_MAY_PLNTXT    0
1194 #endif /* weak passwords */
1195 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
1196 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
1197
1198 #define   CIFSSEC_MUST_SIGN     0x01001
1199 /* note that only one of the following can be set so the
1200 result of setting MUST flags more than once will be to
1201 require use of the stronger protocol */
1202 #define   CIFSSEC_MUST_NTLM     0x02002
1203 #define   CIFSSEC_MUST_NTLMV2   0x04004
1204 #define   CIFSSEC_MUST_KRB5     0x08008
1205 #ifdef CONFIG_CIFS_WEAK_PW_HASH
1206 #define   CIFSSEC_MUST_LANMAN   0x10010
1207 #define   CIFSSEC_MUST_PLNTXT   0x20020
1208 #ifdef CONFIG_CIFS_UPCALL
1209 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
1210 #else
1211 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
1212 #endif /* UPCALL */
1213 #else /* do not allow weak pw hash */
1214 #define   CIFSSEC_MUST_LANMAN   0
1215 #define   CIFSSEC_MUST_PLNTXT   0
1216 #ifdef CONFIG_CIFS_UPCALL
1217 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
1218 #else
1219 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
1220 #endif /* UPCALL */
1221 #endif /* WEAK_PW_HASH */
1222 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
1223 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
1224
1225 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
1226 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
1227 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
1228 /*
1229  *****************************************************************
1230  * All constants go here
1231  *****************************************************************
1232  */
1233
1234 #define UID_HASH (16)
1235
1236 /*
1237  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
1238  * following to be declared.
1239  */
1240
1241 /****************************************************************************
1242  *  Locking notes.  All updates to global variables and lists should be
1243  *                  protected by spinlocks or semaphores.
1244  *
1245  *  Spinlocks
1246  *  ---------
1247  *  GlobalMid_Lock protects:
1248  *      list operations on pending_mid_q and oplockQ
1249  *      updates to XID counters, multiplex id  and SMB sequence numbers
1250  *  cifs_file_list_lock protects:
1251  *      list operations on tcp and SMB session lists and tCon lists
1252  *  f_owner.lock protects certain per file struct operations
1253  *  mapping->page_lock protects certain per page operations
1254  *
1255  *  Semaphores
1256  *  ----------
1257  *  sesSem     operations on smb session
1258  *  tconSem    operations on tree connection
1259  *  fh_sem      file handle reconnection operations
1260  *
1261  ****************************************************************************/
1262
1263 #ifdef DECLARE_GLOBALS_HERE
1264 #define GLOBAL_EXTERN
1265 #else
1266 #define GLOBAL_EXTERN extern
1267 #endif
1268
1269 /*
1270  * the list of TCP_Server_Info structures, ie each of the sockets
1271  * connecting our client to a distinct server (ip address), is
1272  * chained together by cifs_tcp_ses_list. The list of all our SMB
1273  * sessions (and from that the tree connections) can be found
1274  * by iterating over cifs_tcp_ses_list
1275  */
1276 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
1277
1278 /*
1279  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
1280  * tcp session, and the list of tcon's per smb session. It also protects
1281  * the reference counters for the server, smb session, and tcon. Finally,
1282  * changes to the tcon->tidStatus should be done while holding this lock.
1283  */
1284 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
1285
1286 /*
1287  * This lock protects the cifs_file->llist and cifs_file->flist
1288  * list operations, and updates to some flags (cifs_file->invalidHandle)
1289  * It will be moved to either use the tcon->stat_lock or equivalent later.
1290  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
1291  * the cifs_tcp_ses_lock must be grabbed first and released last.
1292  */
1293 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
1294
1295 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
1296 /* Outstanding dir notify requests */
1297 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
1298 /* DirNotify response queue */
1299 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
1300 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
1301
1302 /*
1303  * Global transaction id (XID) information
1304  */
1305 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
1306 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
1307 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
1308 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
1309                                           /* on midQ entries */
1310 /*
1311  *  Global counters, updated atomically
1312  */
1313 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
1314 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
1315 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
1316 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
1317 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
1318
1319 /* Various Debug counters */
1320 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
1321 #ifdef CONFIG_CIFS_STATS2
1322 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
1323 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
1324 #endif
1325 GLOBAL_EXTERN atomic_t smBufAllocCount;
1326 GLOBAL_EXTERN atomic_t midCount;
1327
1328 /* Misc globals */
1329 GLOBAL_EXTERN bool enable_oplocks; /* enable or disable oplocks */
1330 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
1331 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
1332                                 with more secure ntlmssp2 challenge/resp */
1333 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
1334 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
1335 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
1336 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
1337 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
1338 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
1339
1340 #ifdef CONFIG_CIFS_ACL
1341 GLOBAL_EXTERN struct rb_root uidtree;
1342 GLOBAL_EXTERN struct rb_root gidtree;
1343 GLOBAL_EXTERN spinlock_t siduidlock;
1344 GLOBAL_EXTERN spinlock_t sidgidlock;
1345 GLOBAL_EXTERN struct rb_root siduidtree;
1346 GLOBAL_EXTERN struct rb_root sidgidtree;
1347 GLOBAL_EXTERN spinlock_t uidsidlock;
1348 GLOBAL_EXTERN spinlock_t gidsidlock;
1349 #endif /* CONFIG_CIFS_ACL */
1350
1351 void cifs_oplock_break(struct work_struct *work);
1352
1353 extern const struct slow_work_ops cifs_oplock_break_ops;
1354 extern struct workqueue_struct *cifsiod_wq;
1355
1356 extern mempool_t *cifs_mid_poolp;
1357
1358 /* Operations for different SMB versions */
1359 #define SMB1_VERSION_STRING     "1.0"
1360 extern struct smb_version_operations smb1_operations;
1361 extern struct smb_version_values smb1_values;
1362 #define SMB21_VERSION_STRING    "2.1"
1363 extern struct smb_version_operations smb21_operations;
1364 extern struct smb_version_values smb21_values;
1365 #endif  /* _CIFS_GLOB_H */