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