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