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