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