fs/cifs/cifsglob.h

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