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