fs/cifs/cifsglob.h

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