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