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