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