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