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 TCP_Server_Info {
 159         struct list_head tcp_ses_list;
 160         struct list_head smb_ses_list;
 161         int srv_count; /* reference counter */
 162         /* 15 character server name + 0x20 16th byte indicating type = srv */
 163         char server_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 164         enum statusEnum tcpStatus; /* what we think the status is */
 165         char *hostname; /* hostname portion of UNC string */
 166         struct socket *ssocket;
 167         struct sockaddr_storage dstaddr;
 168         struct sockaddr_storage srcaddr; /* locally bind to this IP */
 169 #ifdef CONFIG_NET_NS
 170         struct net *net;
 171 #endif
 172         wait_queue_head_t response_q;
 173         wait_queue_head_t request_q; /* if more than maxmpx to srvr must block*/
 174         struct list_head pending_mid_q;
 175         bool noblocksnd;                /* use blocking sendmsg */
 176         bool noautotune;                /* do not autotune send buf sizes */
 177         bool tcp_nodelay;
 178         atomic_t inFlight;  /* number of requests on the wire to server */
 179         struct mutex srv_mutex;
 180         struct task_struct *tsk;
 181         char server_GUID[16];
 182         char secMode;
 183         bool session_estab; /* mark when very first sess is established */
 184         u16 dialect; /* dialect index that server chose */
 185         enum securityEnum secType;
 186         unsigned int maxReq;    /* Clients should submit no more */
 187         /* than maxReq distinct unanswered SMBs to the server when using  */
 188         /* multiplexed reads or writes */
 189         unsigned int maxBuf;    /* maxBuf specifies the maximum */
 190         /* message size the server can send or receive for non-raw SMBs */
 191         /* maxBuf is returned by SMB NegotiateProtocol so maxBuf is only 0 */
 192         /* when socket is setup (and during reconnect) before NegProt sent */
 193         unsigned int max_rw;    /* maxRw specifies the maximum */
 194         /* message size the server can send or receive for */
 195         /* SMB_COM_WRITE_RAW or SMB_COM_READ_RAW. */
 196         unsigned int max_vcs;   /* maximum number of smb sessions, at least
 197                                    those that can be specified uniquely with
 198                                    vcnumbers */
 199         int capabilities; /* allow selective disabling of caps by smb sess */
 200         int timeAdj;  /* Adjust for difference in server time zone in sec */
 201         __u16 CurrentMid;         /* multiplex id - rotating counter */
 202         char cryptkey[CIFS_CRYPTO_KEY_SIZE]; /* used by ntlm, ntlmv2 etc */
 203         /* 16th byte of RFC1001 workstation name is always null */
 204         char workstation_RFC1001_name[RFC1001_NAME_LEN_WITH_NULL];
 205         __u32 sequence_number; /* for signing, protected by srv_mutex */
 206         struct session_key session_key;
 207         unsigned long lstrp; /* when we got last response from this server */
 208         struct cifs_secmech secmech; /* crypto sec mech functs, descriptors */
 209         /* extended security flavors that server supports */
 210         bool    sec_ntlmssp;            /* supports NTLMSSP */
 211         bool    sec_kerberosu2u;        /* supports U2U Kerberos */
 212         bool    sec_kerberos;           /* supports plain Kerberos */
 213         bool    sec_mskerberos;         /* supports legacy MS Kerberos */
 214         struct delayed_work     echo; /* echo ping workqueue job */
 215 #ifdef CONFIG_CIFS_FSCACHE
 216         struct fscache_cookie   *fscache; /* client index cache cookie */
 217 #endif
 218 #ifdef CONFIG_CIFS_STATS2
 219         atomic_t inSend; /* requests trying to send */
 220         atomic_t num_waiters;   /* blocked waiting to get in sendrecv */
 221 #endif
 222 };
 223
 224 /*
 225  * Macros to allow the TCP_Server_Info->net field and related code to drop out
 226  * when CONFIG_NET_NS isn't set.
 227  */
 228
 229 #ifdef CONFIG_NET_NS
 230
 231 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 232 {
 233         return srv->net;
 234 }
 235
 236 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 237 {
 238         srv->net = net;
 239 }
 240
 241 #else
 242
 243 static inline struct net *cifs_net_ns(struct TCP_Server_Info *srv)
 244 {
 245         return &init_net;
 246 }
 247
 248 static inline void cifs_set_net_ns(struct TCP_Server_Info *srv, struct net *net)
 249 {
 250 }
 251
 252 #endif
 253
 254 /*
 255  * Session structure.  One of these for each uid session with a particular host
 256  */
 257 struct cifsSesInfo {
 258         struct list_head smb_ses_list;
 259         struct list_head tcon_list;
 260         struct mutex session_mutex;
 261         struct TCP_Server_Info *server; /* pointer to server info */
 262         int ses_count;          /* reference counter */
 263         enum statusEnum status;
 264         unsigned overrideSecFlg;  /* if non-zero override global sec flags */
 265         __u16 ipc_tid;          /* special tid for connection to IPC share */
 266         __u16 flags;
 267         __u16 vcnum;
 268         char *serverOS;         /* name of operating system underlying server */
 269         char *serverNOS;        /* name of network operating system of server */
 270         char *serverDomain;     /* security realm of server */
 271         int Suid;               /* remote smb uid  */
 272         uid_t linux_uid;        /* overriding owner of files on the mount */
 273         uid_t cred_uid;         /* owner of credentials */
 274         int capabilities;
 275         char serverName[SERVER_NAME_LEN_WITH_NULL * 2]; /* BB make bigger for
 276                                 TCP names - will ipv6 and sctp addresses fit? */
 277         char *user_name;        /* must not be null except during init of sess
 278                                    and after mount option parsing we fill it */
 279         char *domainName;
 280         char *password;
 281         struct session_key auth_key;
 282         struct ntlmssp_auth *ntlmssp; /* ciphertext, flags, server challenge */
 283         bool need_reconnect:1; /* connection reset, uid now invalid */
 284 };
 285 /* no more than one of the following three session flags may be set */
 286 #define CIFS_SES_NT4 1
 287 #define CIFS_SES_OS2 2
 288 #define CIFS_SES_W9X 4
 289 /* following flag is set for old servers such as OS2 (and Win95?)
 290    which do not negotiate NTLM or POSIX dialects, but instead
 291    negotiate one of the older LANMAN dialects */
 292 #define CIFS_SES_LANMAN 8
 293 /*
 294  * there is one of these for each connection to a resource on a particular
 295  * session
 296  */
 297 struct cifsTconInfo {
 298         struct list_head tcon_list;
 299         int tc_count;
 300         struct list_head openFileList;
 301         struct cifsSesInfo *ses;        /* pointer to session associated with */
 302         char treeName[MAX_TREE_SIZE + 1]; /* UNC name of resource in ASCII */
 303         char *nativeFileSystem;
 304         char *password;         /* for share-level security */
 305         __u16 tid;              /* The 2 byte tree id */
 306         __u16 Flags;            /* optional support bits */
 307         enum statusEnum tidStatus;
 308 #ifdef CONFIG_CIFS_STATS
 309         atomic_t num_smbs_sent;
 310         atomic_t num_writes;
 311         atomic_t num_reads;
 312         atomic_t num_flushes;
 313         atomic_t num_oplock_brks;
 314         atomic_t num_opens;
 315         atomic_t num_closes;
 316         atomic_t num_deletes;
 317         atomic_t num_mkdirs;
 318         atomic_t num_posixopens;
 319         atomic_t num_posixmkdirs;
 320         atomic_t num_rmdirs;
 321         atomic_t num_renames;
 322         atomic_t num_t2renames;
 323         atomic_t num_ffirst;
 324         atomic_t num_fnext;
 325         atomic_t num_fclose;
 326         atomic_t num_hardlinks;
 327         atomic_t num_symlinks;
 328         atomic_t num_locks;
 329         atomic_t num_acl_get;
 330         atomic_t num_acl_set;
 331 #ifdef CONFIG_CIFS_STATS2
 332         unsigned long long time_writes;
 333         unsigned long long time_reads;
 334         unsigned long long time_opens;
 335         unsigned long long time_deletes;
 336         unsigned long long time_closes;
 337         unsigned long long time_mkdirs;
 338         unsigned long long time_rmdirs;
 339         unsigned long long time_renames;
 340         unsigned long long time_t2renames;
 341         unsigned long long time_ffirst;
 342         unsigned long long time_fnext;
 343         unsigned long long time_fclose;
 344 #endif /* CONFIG_CIFS_STATS2 */
 345         __u64    bytes_read;
 346         __u64    bytes_written;
 347         spinlock_t stat_lock;
 348 #endif /* CONFIG_CIFS_STATS */
 349         FILE_SYSTEM_DEVICE_INFO fsDevInfo;
 350         FILE_SYSTEM_ATTRIBUTE_INFO fsAttrInfo; /* ok if fs name truncated */
 351         FILE_SYSTEM_UNIX_INFO fsUnixInfo;
 352         bool ipc:1;             /* set if connection to IPC$ eg for RPC/PIPES */
 353         bool retry:1;
 354         bool nocase:1;
 355         bool seal:1;      /* transport encryption for this mounted share */
 356         bool unix_ext:1;  /* if false disable Linux extensions to CIFS protocol
 357                                 for this mount even if server would support */
 358         bool local_lease:1; /* check leases (only) on local system not remote */
 359         bool broken_posix_open; /* e.g. Samba server versions < 3.3.2, 3.2.9 */
 360         bool need_reconnect:1; /* connection reset, tid now invalid */
 361 #ifdef CONFIG_CIFS_FSCACHE
 362         u64 resource_id;                /* server resource id */
 363         struct fscache_cookie *fscache; /* cookie for share */
 364 #endif
 365         /* BB add field for back pointer to sb struct(s)? */
 366 };
 367
 368 /*
 369  * This is a refcounted and timestamped container for a tcon pointer. The
 370  * container holds a tcon reference. It is considered safe to free one of
 371  * these when the tl_count goes to 0. The tl_time is the time of the last
 372  * "get" on the container.
 373  */
 374 struct tcon_link {
 375         struct rb_node          tl_rbnode;
 376         uid_t                   tl_uid;
 377         unsigned long           tl_flags;
 378 #define TCON_LINK_MASTER        0
 379 #define TCON_LINK_PENDING       1
 380 #define TCON_LINK_IN_TREE       2
 381         unsigned long           tl_time;
 382         atomic_t                tl_count;
 383         struct cifsTconInfo     *tl_tcon;
 384 };
 385
 386 extern struct tcon_link *cifs_sb_tlink(struct cifs_sb_info *cifs_sb);
 387
 388 static inline struct cifsTconInfo *
 389 tlink_tcon(struct tcon_link *tlink)
 390 {
 391         return tlink->tl_tcon;
 392 }
 393
 394 extern void cifs_put_tlink(struct tcon_link *tlink);
 395
 396 static inline struct tcon_link *
 397 cifs_get_tlink(struct tcon_link *tlink)
 398 {
 399         if (tlink && !IS_ERR(tlink))
 400                 atomic_inc(&tlink->tl_count);
 401         return tlink;
 402 }
 403
 404 /* This function is always expected to succeed */
 405 extern struct cifsTconInfo *cifs_sb_master_tcon(struct cifs_sb_info *cifs_sb);
 406
 407 /*
 408  * This info hangs off the cifsFileInfo structure, pointed to by llist.
 409  * This is used to track byte stream locks on the file
 410  */
 411 struct cifsLockInfo {
 412         struct list_head llist; /* pointer to next cifsLockInfo */
 413         __u64 offset;
 414         __u64 length;
 415         __u8 type;
 416 };
 417
 418 /*
 419  * One of these for each open instance of a file
 420  */
 421 struct cifs_search_info {
 422         loff_t index_of_last_entry;
 423         __u16 entries_in_buffer;
 424         __u16 info_level;
 425         __u32 resume_key;
 426         char *ntwrk_buf_start;
 427         char *srch_entries_start;
 428         char *last_entry;
 429         char *presume_name;
 430         unsigned int resume_name_len;
 431         bool endOfSearch:1;
 432         bool emptyDir:1;
 433         bool unicode:1;
 434         bool smallBuf:1; /* so we know which buf_release function to call */
 435 };
 436
 437 struct cifsFileInfo {
 438         struct list_head tlist; /* pointer to next fid owned by tcon */
 439         struct list_head flist; /* next fid (file instance) for this inode */
 440         unsigned int uid;       /* allows finding which FileInfo structure */
 441         __u32 pid;              /* process id who opened file */
 442         __u16 netfid;           /* file id from remote */
 443         /* BB add lock scope info here if needed */ ;
 444         /* lock scope id (0 if none) */
 445         struct dentry *dentry;
 446         unsigned int f_flags;
 447         struct tcon_link *tlink;
 448         struct mutex lock_mutex;
 449         struct list_head llist; /* list of byte range locks we have. */
 450         bool invalidHandle:1;   /* file closed via session abend */
 451         bool oplock_break_cancelled:1;
 452         int count;              /* refcount protected by cifs_file_list_lock */
 453         struct mutex fh_mutex; /* prevents reopen race after dead ses*/
 454         struct cifs_search_info srch_inf;
 455         struct work_struct oplock_break; /* work for oplock breaks */
 456 };
 457
 458 struct cifs_io_parms {
 459         __u16 netfid;
 460         __u32 pid;
 461         __u64 offset;
 462         unsigned int length;
 463         struct cifsTconInfo *tcon;
 464 };
 465
 466 /*
 467  * Take a reference on the file private data. Must be called with
 468  * cifs_file_list_lock held.
 469  */
 470 static inline void cifsFileInfo_get(struct cifsFileInfo *cifs_file)
 471 {
 472         ++cifs_file->count;
 473 }
 474
 475 void cifsFileInfo_put(struct cifsFileInfo *cifs_file);
 476
 477 /*
 478  * One of these for each file inode
 479  */
 480
 481 struct cifsInodeInfo {
 482         struct list_head lockList;
 483         /* BB add in lists for dirty pages i.e. write caching info for oplock */
 484         struct list_head openFileList;
 485         __u32 cifsAttrs; /* e.g. DOS archive bit, sparse, compressed, system */
 486         bool clientCanCacheRead;        /* read oplock */
 487         bool clientCanCacheAll;         /* read and writebehind oplock */
 488         bool delete_pending;            /* DELETE_ON_CLOSE is set */
 489         bool invalid_mapping;           /* pagecache is invalid */
 490         unsigned long time;             /* jiffies of last update of inode */
 491         u64  server_eof;                /* current file size on server */
 492         u64  uniqueid;                  /* server inode number */
 493         u64  createtime;                /* creation time on server */
 494 #ifdef CONFIG_CIFS_FSCACHE
 495         struct fscache_cookie *fscache;
 496 #endif
 497         struct inode vfs_inode;
 498 };
 499
 500 static inline struct cifsInodeInfo *
 501 CIFS_I(struct inode *inode)
 502 {
 503         return container_of(inode, struct cifsInodeInfo, vfs_inode);
 504 }
 505
 506 static inline struct cifs_sb_info *
 507 CIFS_SB(struct super_block *sb)
 508 {
 509         return sb->s_fs_info;
 510 }
 511
 512 static inline char CIFS_DIR_SEP(const struct cifs_sb_info *cifs_sb)
 513 {
 514         if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_POSIX_PATHS)
 515                 return '/';
 516         else
 517                 return '\\';
 518 }
 519
 520 #ifdef CONFIG_CIFS_STATS
 521 #define cifs_stats_inc atomic_inc
 522
 523 static inline void cifs_stats_bytes_written(struct cifsTconInfo *tcon,
 524                                             unsigned int bytes)
 525 {
 526         if (bytes) {
 527                 spin_lock(&tcon->stat_lock);
 528                 tcon->bytes_written += bytes;
 529                 spin_unlock(&tcon->stat_lock);
 530         }
 531 }
 532
 533 static inline void cifs_stats_bytes_read(struct cifsTconInfo *tcon,
 534                                          unsigned int bytes)
 535 {
 536         spin_lock(&tcon->stat_lock);
 537         tcon->bytes_read += bytes;
 538         spin_unlock(&tcon->stat_lock);
 539 }
 540 #else
 541
 542 #define  cifs_stats_inc(field) do {} while (0)
 543 #define  cifs_stats_bytes_written(tcon, bytes) do {} while (0)
 544 #define  cifs_stats_bytes_read(tcon, bytes) do {} while (0)
 545
 546 #endif
 547
 548 struct mid_q_entry;
 549
 550 /*
 551  * This is the prototype for the mid callback function. When creating one,
 552  * take special care to avoid deadlocks. Things to bear in mind:
 553  *
 554  * - it will be called by cifsd, with no locks held
 555  * - the mid will be removed from any lists
 556  */
 557 typedef void (mid_callback_t)(struct mid_q_entry *mid);
 558
 559 /* one of these for every pending CIFS request to the server */
 560 struct mid_q_entry {
 561         struct list_head qhead; /* mids waiting on reply from this server */
 562         __u16 mid;              /* multiplex id */
 563         __u16 pid;              /* process id */
 564         __u32 sequence_number;  /* for CIFS signing */
 565         unsigned long when_alloc;  /* when mid was created */
 566 #ifdef CONFIG_CIFS_STATS2
 567         unsigned long when_sent; /* time when smb send finished */
 568         unsigned long when_received; /* when demux complete (taken off wire) */
 569 #endif
 570         mid_callback_t *callback; /* call completion callback */
 571         void *callback_data;      /* general purpose pointer for callback */
 572         struct smb_hdr *resp_buf;       /* response buffer */
 573         int midState;   /* wish this were enum but can not pass to wait_event */
 574         __u8 command;   /* smb command code */
 575         bool largeBuf:1;        /* if valid response, is pointer to large buf */
 576         bool multiRsp:1;        /* multiple trans2 responses for one request  */
 577         bool multiEnd:1;        /* both received */
 578 };
 579
 580 struct oplock_q_entry {
 581         struct list_head qhead;
 582         struct inode *pinode;
 583         struct cifsTconInfo *tcon;
 584         __u16 netfid;
 585 };
 586
 587 /* for pending dnotify requests */
 588 struct dir_notify_req {
 589         struct list_head lhead;
 590         __le16 Pid;
 591         __le16 PidHigh;
 592         __u16 Mid;
 593         __u16 Tid;
 594         __u16 Uid;
 595         __u16 netfid;
 596         __u32 filter; /* CompletionFilter (for multishot) */
 597         int multishot;
 598         struct file *pfile;
 599 };
 600
 601 struct dfs_info3_param {
 602         int flags; /* DFSREF_REFERRAL_SERVER, DFSREF_STORAGE_SERVER*/
 603         int path_consumed;
 604         int server_type;
 605         int ref_flag;
 606         char *path_name;
 607         char *node_name;
 608 };
 609
 610 /*
 611  * common struct for holding inode info when searching for or updating an
 612  * inode with new info
 613  */
 614
 615 #define CIFS_FATTR_DFS_REFERRAL         0x1
 616 #define CIFS_FATTR_DELETE_PENDING       0x2
 617 #define CIFS_FATTR_NEED_REVAL           0x4
 618 #define CIFS_FATTR_INO_COLLISION        0x8
 619
 620 struct cifs_fattr {
 621         u32             cf_flags;
 622         u32             cf_cifsattrs;
 623         u64             cf_uniqueid;
 624         u64             cf_eof;
 625         u64             cf_bytes;
 626         u64             cf_createtime;
 627         uid_t           cf_uid;
 628         gid_t           cf_gid;
 629         umode_t         cf_mode;
 630         dev_t           cf_rdev;
 631         unsigned int    cf_nlink;
 632         unsigned int    cf_dtype;
 633         struct timespec cf_atime;
 634         struct timespec cf_mtime;
 635         struct timespec cf_ctime;
 636 };
 637
 638 static inline void free_dfs_info_param(struct dfs_info3_param *param)
 639 {
 640         if (param) {
 641                 kfree(param->path_name);
 642                 kfree(param->node_name);
 643                 kfree(param);
 644         }
 645 }
 646
 647 static inline void free_dfs_info_array(struct dfs_info3_param *param,
 648                                        int number_of_items)
 649 {
 650         int i;
 651         if ((number_of_items == 0) || (param == NULL))
 652                 return;
 653         for (i = 0; i < number_of_items; i++) {
 654                 kfree(param[i].path_name);
 655                 kfree(param[i].node_name);
 656         }
 657         kfree(param);
 658 }
 659
 660 #define   MID_FREE 0
 661 #define   MID_REQUEST_ALLOCATED 1
 662 #define   MID_REQUEST_SUBMITTED 2
 663 #define   MID_RESPONSE_RECEIVED 4
 664 #define   MID_RETRY_NEEDED      8 /* session closed while this request out */
 665 #define   MID_RESPONSE_MALFORMED 0x10
 666 #define   MID_SHUTDOWN           0x20
 667
 668 /* Types of response buffer returned from SendReceive2 */
 669 #define   CIFS_NO_BUFFER        0    /* Response buffer not returned */
 670 #define   CIFS_SMALL_BUFFER     1
 671 #define   CIFS_LARGE_BUFFER     2
 672 #define   CIFS_IOVEC            4    /* array of response buffers */
 673
 674 /* Type of Request to SendReceive2 */
 675 #define   CIFS_BLOCKING_OP      1    /* operation can block */
 676 #define   CIFS_ASYNC_OP         2    /* do not wait for response */
 677 #define   CIFS_TIMEOUT_MASK 0x003    /* only one of above set in req */
 678 #define   CIFS_LOG_ERROR    0x010    /* log NT STATUS if non-zero */
 679 #define   CIFS_LARGE_BUF_OP 0x020    /* large request buffer */
 680 #define   CIFS_NO_RESP      0x040    /* no response buffer required */
 681
 682 /* Security Flags: indicate type of session setup needed */
 683 #define   CIFSSEC_MAY_SIGN      0x00001
 684 #define   CIFSSEC_MAY_NTLM      0x00002
 685 #define   CIFSSEC_MAY_NTLMV2    0x00004
 686 #define   CIFSSEC_MAY_KRB5      0x00008
 687 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 688 #define   CIFSSEC_MAY_LANMAN    0x00010
 689 #define   CIFSSEC_MAY_PLNTXT    0x00020
 690 #else
 691 #define   CIFSSEC_MAY_LANMAN    0
 692 #define   CIFSSEC_MAY_PLNTXT    0
 693 #endif /* weak passwords */
 694 #define   CIFSSEC_MAY_SEAL      0x00040 /* not supported yet */
 695 #define   CIFSSEC_MAY_NTLMSSP   0x00080 /* raw ntlmssp with ntlmv2 */
 696
 697 #define   CIFSSEC_MUST_SIGN     0x01001
 698 /* note that only one of the following can be set so the
 699 result of setting MUST flags more than once will be to
 700 require use of the stronger protocol */
 701 #define   CIFSSEC_MUST_NTLM     0x02002
 702 #define   CIFSSEC_MUST_NTLMV2   0x04004
 703 #define   CIFSSEC_MUST_KRB5     0x08008
 704 #ifdef CONFIG_CIFS_WEAK_PW_HASH
 705 #define   CIFSSEC_MUST_LANMAN   0x10010
 706 #define   CIFSSEC_MUST_PLNTXT   0x20020
 707 #ifdef CONFIG_CIFS_UPCALL
 708 #define   CIFSSEC_MASK          0xBF0BF /* allows weak security but also krb5 */
 709 #else
 710 #define   CIFSSEC_MASK          0xB70B7 /* current flags supported if weak */
 711 #endif /* UPCALL */
 712 #else /* do not allow weak pw hash */
 713 #ifdef CONFIG_CIFS_UPCALL
 714 #define   CIFSSEC_MASK          0x8F08F /* flags supported if no weak allowed */
 715 #else
 716 #define   CIFSSEC_MASK          0x87087 /* flags supported if no weak allowed */
 717 #endif /* UPCALL */
 718 #endif /* WEAK_PW_HASH */
 719 #define   CIFSSEC_MUST_SEAL     0x40040 /* not supported yet */
 720 #define   CIFSSEC_MUST_NTLMSSP  0x80080 /* raw ntlmssp with ntlmv2 */
 721
 722 #define   CIFSSEC_DEF (CIFSSEC_MAY_SIGN | CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2)
 723 #define   CIFSSEC_MAX (CIFSSEC_MUST_SIGN | CIFSSEC_MUST_NTLMV2)
 724 #define   CIFSSEC_AUTH_MASK (CIFSSEC_MAY_NTLM | CIFSSEC_MAY_NTLMV2 | CIFSSEC_MAY_LANMAN | CIFSSEC_MAY_PLNTXT | CIFSSEC_MAY_KRB5 | CIFSSEC_MAY_NTLMSSP)
 725 /*
 726  *****************************************************************
 727  * All constants go here
 728  *****************************************************************
 729  */
 730
 731 #define UID_HASH (16)
 732
 733 /*
 734  * Note that ONE module should define _DECLARE_GLOBALS_HERE to cause the
 735  * following to be declared.
 736  */
 737
 738 /****************************************************************************
 739  *  Locking notes.  All updates to global variables and lists should be
 740  *                  protected by spinlocks or semaphores.
 741  *
 742  *  Spinlocks
 743  *  ---------
 744  *  GlobalMid_Lock protects:
 745  *      list operations on pending_mid_q and oplockQ
 746  *      updates to XID counters, multiplex id  and SMB sequence numbers
 747  *  cifs_file_list_lock protects:
 748  *      list operations on tcp and SMB session lists and tCon lists
 749  *  f_owner.lock protects certain per file struct operations
 750  *  mapping->page_lock protects certain per page operations
 751  *
 752  *  Semaphores
 753  *  ----------
 754  *  sesSem     operations on smb session
 755  *  tconSem    operations on tree connection
 756  *  fh_sem      file handle reconnection operations
 757  *
 758  ****************************************************************************/
 759
 760 #ifdef DECLARE_GLOBALS_HERE
 761 #define GLOBAL_EXTERN
 762 #else
 763 #define GLOBAL_EXTERN extern
 764 #endif
 765
 766 /*
 767  * the list of TCP_Server_Info structures, ie each of the sockets
 768  * connecting our client to a distinct server (ip address), is
 769  * chained together by cifs_tcp_ses_list. The list of all our SMB
 770  * sessions (and from that the tree connections) can be found
 771  * by iterating over cifs_tcp_ses_list
 772  */
 773 GLOBAL_EXTERN struct list_head          cifs_tcp_ses_list;
 774
 775 /*
 776  * This lock protects the cifs_tcp_ses_list, the list of smb sessions per
 777  * tcp session, and the list of tcon's per smb session. It also protects
 778  * the reference counters for the server, smb session, and tcon. Finally,
 779  * changes to the tcon->tidStatus should be done while holding this lock.
 780  */
 781 GLOBAL_EXTERN spinlock_t                cifs_tcp_ses_lock;
 782
 783 /*
 784  * This lock protects the cifs_file->llist and cifs_file->flist
 785  * list operations, and updates to some flags (cifs_file->invalidHandle)
 786  * It will be moved to either use the tcon->stat_lock or equivalent later.
 787  * If cifs_tcp_ses_lock and the lock below are both needed to be held, then
 788  * the cifs_tcp_ses_lock must be grabbed first and released last.
 789  */
 790 GLOBAL_EXTERN spinlock_t        cifs_file_list_lock;
 791
 792 #ifdef CONFIG_CIFS_DNOTIFY_EXPERIMENTAL /* unused temporarily */
 793 /* Outstanding dir notify requests */
 794 GLOBAL_EXTERN struct list_head GlobalDnotifyReqList;
 795 /* DirNotify response queue */
 796 GLOBAL_EXTERN struct list_head GlobalDnotifyRsp_Q;
 797 #endif /* was needed for dnotify, and will be needed for inotify when VFS fix */
 798
 799 /*
 800  * Global transaction id (XID) information
 801  */
 802 GLOBAL_EXTERN unsigned int GlobalCurrentXid;    /* protected by GlobalMid_Sem */
 803 GLOBAL_EXTERN unsigned int GlobalTotalActiveXid; /* prot by GlobalMid_Sem */
 804 GLOBAL_EXTERN unsigned int GlobalMaxActiveXid;  /* prot by GlobalMid_Sem */
 805 GLOBAL_EXTERN spinlock_t GlobalMid_Lock;  /* protects above & list operations */
 806                                           /* on midQ entries */
 807 /*
 808  *  Global counters, updated atomically
 809  */
 810 GLOBAL_EXTERN atomic_t sesInfoAllocCount;
 811 GLOBAL_EXTERN atomic_t tconInfoAllocCount;
 812 GLOBAL_EXTERN atomic_t tcpSesAllocCount;
 813 GLOBAL_EXTERN atomic_t tcpSesReconnectCount;
 814 GLOBAL_EXTERN atomic_t tconInfoReconnectCount;
 815
 816 /* Various Debug counters */
 817 GLOBAL_EXTERN atomic_t bufAllocCount;    /* current number allocated  */
 818 #ifdef CONFIG_CIFS_STATS2
 819 GLOBAL_EXTERN atomic_t totBufAllocCount; /* total allocated over all time */
 820 GLOBAL_EXTERN atomic_t totSmBufAllocCount;
 821 #endif
 822 GLOBAL_EXTERN atomic_t smBufAllocCount;
 823 GLOBAL_EXTERN atomic_t midCount;
 824
 825 /* Misc globals */
 826 GLOBAL_EXTERN unsigned int multiuser_mount; /* if enabled allows new sessions
 827                                 to be established on existing mount if we
 828                                 have the uid/password or Kerberos credential
 829                                 or equivalent for current user */
 830 GLOBAL_EXTERN unsigned int oplockEnabled;
 831 GLOBAL_EXTERN unsigned int lookupCacheEnabled;
 832 GLOBAL_EXTERN unsigned int global_secflags;     /* if on, session setup sent
 833                                 with more secure ntlmssp2 challenge/resp */
 834 GLOBAL_EXTERN unsigned int sign_CIFS_PDUs;  /* enable smb packet signing */
 835 GLOBAL_EXTERN unsigned int linuxExtEnabled;/*enable Linux/Unix CIFS extensions*/
 836 GLOBAL_EXTERN unsigned int CIFSMaxBufSize;  /* max size not including hdr */
 837 GLOBAL_EXTERN unsigned int cifs_min_rcv;    /* min size of big ntwrk buf pool */
 838 GLOBAL_EXTERN unsigned int cifs_min_small;  /* min size of small buf pool */
 839 GLOBAL_EXTERN unsigned int cifs_max_pending; /* MAX requests at once to server*/
 840
 841 /* reconnect after this many failed echo attempts */
 842 GLOBAL_EXTERN unsigned short echo_retries;
 843
 844 GLOBAL_EXTERN struct rb_root uidtree;
 845 GLOBAL_EXTERN struct rb_root gidtree;
 846 GLOBAL_EXTERN spinlock_t siduidlock;
 847 GLOBAL_EXTERN spinlock_t sidgidlock;
 848
 849 void cifs_oplock_break(struct work_struct *work);
 850 void cifs_oplock_break_get(struct cifsFileInfo *cfile);
 851 void cifs_oplock_break_put(struct cifsFileInfo *cfile);
 852
 853 extern const struct slow_work_ops cifs_oplock_break_ops;
 854
 855 #endif  /* _CIFS_GLOB_H */