fs/nfsd/state.h

   1 /*
   2  *  Copyright (c) 2001 The Regents of the University of Michigan.
   3  *  All rights reserved.
   4  *
   5  *  Kendrick Smith <kmsmith@umich.edu>
   6  *  Andy Adamson <andros@umich.edu>
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *  1. Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *  2. Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in the
  16  *     documentation and/or other materials provided with the distribution.
  17  *  3. Neither the name of the University nor the names of its
  18  *     contributors may be used to endorse or promote products derived
  19  *     from this software without specific prior written permission.
  20  *
  21  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  22  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  23  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  24  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  28  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  29  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  30  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  31  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _NFSD4_STATE_H
  36 #define _NFSD4_STATE_H
  37
  38 #include <linux/nfsd/nfsfh.h>
  39 #include "nfsfh.h"
  40
  41 typedef struct {
  42         u32             cl_boot;
  43         u32             cl_id;
  44 } clientid_t;
  45
  46 typedef struct {
  47         u32             so_boot;
  48         u32             so_stateownerid;
  49         u32             so_fileid;
  50 } stateid_opaque_t;
  51
  52 typedef struct {
  53         u32                     si_generation;
  54         stateid_opaque_t        si_opaque;
  55 } stateid_t;
  56 #define si_boot           si_opaque.so_boot
  57 #define si_stateownerid   si_opaque.so_stateownerid
  58 #define si_fileid         si_opaque.so_fileid
  59
  60 #define STATEID_FMT     "(%08x/%08x/%08x/%08x)"
  61 #define STATEID_VAL(s) \
  62         (s)->si_boot, \
  63         (s)->si_stateownerid, \
  64         (s)->si_fileid, \
  65         (s)->si_generation
  66
  67 struct nfsd4_callback {
  68         void *cb_op;
  69         struct nfs4_client *cb_clp;
  70         u32 cb_minorversion;
  71         struct rpc_message cb_msg;
  72         const struct rpc_call_ops *cb_ops;
  73         struct work_struct cb_work;
  74 };
  75
  76 struct nfs4_delegation {
  77         struct list_head        dl_perfile;
  78         struct list_head        dl_perclnt;
  79         struct list_head        dl_recall_lru;  /* delegation recalled */
  80         atomic_t                dl_count;       /* ref count */
  81         struct nfs4_client      *dl_client;
  82         struct nfs4_file        *dl_file;
  83         struct file_lock        *dl_flock;
  84         u32                     dl_type;
  85         time_t                  dl_time;
  86 /* For recall: */
  87         stateid_t               dl_stateid;
  88         struct knfsd_fh         dl_fh;
  89         int                     dl_retries;
  90         struct nfsd4_callback   dl_recall;
  91 };
  92
  93 /* client delegation callback info */
  94 struct nfs4_cb_conn {
  95         /* SETCLIENTID info */
  96         struct sockaddr_storage cb_addr;
  97         size_t                  cb_addrlen;
  98         u32                     cb_prog;
  99         u32                     cb_minorversion;
 100         u32                     cb_ident;       /* minorversion 0 only */
 101         struct svc_xprt         *cb_xprt;       /* minorversion 1 only */
 102 };
 103
 104 /* Maximum number of slots per session. 160 is useful for long haul TCP */
 105 #define NFSD_MAX_SLOTS_PER_SESSION     160
 106 /* Maximum number of operations per session compound */
 107 #define NFSD_MAX_OPS_PER_COMPOUND       16
 108 /* Maximum  session per slot cache size */
 109 #define NFSD_SLOT_CACHE_SIZE            1024
 110 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 111 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 112 #define NFSD_MAX_MEM_PER_SESSION  \
 113                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 114
 115 struct nfsd4_slot {
 116         bool    sl_inuse;
 117         bool    sl_cachethis;
 118         u16     sl_opcnt;
 119         u32     sl_seqid;
 120         __be32  sl_status;
 121         u32     sl_datalen;
 122         char    sl_data[];
 123 };
 124
 125 struct nfsd4_channel_attrs {
 126         u32             headerpadsz;
 127         u32             maxreq_sz;
 128         u32             maxresp_sz;
 129         u32             maxresp_cached;
 130         u32             maxops;
 131         u32             maxreqs;
 132         u32             nr_rdma_attrs;
 133         u32             rdma_attrs;
 134 };
 135
 136 struct nfsd4_create_session {
 137         clientid_t                      clientid;
 138         struct nfs4_sessionid           sessionid;
 139         u32                             seqid;
 140         u32                             flags;
 141         struct nfsd4_channel_attrs      fore_channel;
 142         struct nfsd4_channel_attrs      back_channel;
 143         u32                             callback_prog;
 144         u32                             uid;
 145         u32                             gid;
 146 };
 147
 148 /* The single slot clientid cache structure */
 149 struct nfsd4_clid_slot {
 150         u32                             sl_seqid;
 151         __be32                          sl_status;
 152         struct nfsd4_create_session     sl_cr_ses;
 153 };
 154
 155 struct nfsd4_conn {
 156         struct list_head cn_persession;
 157         struct svc_xprt *cn_xprt;
 158 /* CDFC4_FORE, CDFC4_BACK: */
 159         unsigned char cn_flags;
 160 };
 161
 162 struct nfsd4_session {
 163         struct kref             se_ref;
 164         struct list_head        se_hash;        /* hash by sessionid */
 165         struct list_head        se_perclnt;
 166         u32                     se_flags;
 167         struct nfs4_client      *se_client;
 168         struct nfs4_sessionid   se_sessionid;
 169         struct nfsd4_channel_attrs se_fchannel;
 170         struct nfsd4_channel_attrs se_bchannel;
 171         struct list_head        se_conns;
 172         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 173 };
 174
 175 static inline void
 176 nfsd4_put_session(struct nfsd4_session *ses)
 177 {
 178         extern void free_session(struct kref *kref);
 179         kref_put(&ses->se_ref, free_session);
 180 }
 181
 182 static inline void
 183 nfsd4_get_session(struct nfsd4_session *ses)
 184 {
 185         kref_get(&ses->se_ref);
 186 }
 187
 188 /* formatted contents of nfs4_sessionid */
 189 struct nfsd4_sessionid {
 190         clientid_t      clientid;
 191         u32             sequence;
 192         u32             reserved;
 193 };
 194
 195 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 196
 197 /*
 198  * struct nfs4_client - one per client.  Clientids live here.
 199  *      o Each nfs4_client is hashed by clientid.
 200  *
 201  *      o Each nfs4_clients is also hashed by name
 202  *        (the opaque quantity initially sent by the client to identify itself).
 203  *
 204  *      o cl_perclient list is used to ensure no dangling stateowner references
 205  *        when we expire the nfs4_client
 206  */
 207 struct nfs4_client {
 208         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 209         struct list_head        cl_strhash;     /* hash by cl_name */
 210         struct list_head        cl_openowners;
 211         struct list_head        cl_delegations;
 212         struct list_head        cl_lru;         /* tail queue */
 213         struct xdr_netobj       cl_name;        /* id generated by client */
 214         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 215         nfs4_verifier           cl_verifier;    /* generated by client */
 216         time_t                  cl_time;        /* time of last lease renewal */
 217         struct sockaddr_storage cl_addr;        /* client ipaddress */
 218         u32                     cl_flavor;      /* setclientid pseudoflavor */
 219         char                    *cl_principal;  /* setclientid principal name */
 220         struct svc_cred         cl_cred;        /* setclientid principal */
 221         clientid_t              cl_clientid;    /* generated by server */
 222         nfs4_verifier           cl_confirm;     /* generated by server */
 223         u32                     cl_firststate;  /* recovery dir creation */
 224
 225         /* for v4.0 and v4.1 callbacks: */
 226         struct nfs4_cb_conn     cl_cb_conn;
 227 #define NFSD4_CLIENT_CB_UPDATE  1
 228 #define NFSD4_CLIENT_KILL       2
 229         unsigned long           cl_cb_flags;
 230         struct rpc_clnt         *cl_cb_client;
 231         u32                     cl_cb_ident;
 232         atomic_t                cl_cb_set;
 233         struct nfsd4_callback   cl_cb_null;
 234
 235         /* for all client information that callback code might need: */
 236         spinlock_t              cl_lock;
 237
 238         /* for nfs41 */
 239         struct list_head        cl_sessions;
 240         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 241         u32                     cl_exchange_flags;
 242         struct nfs4_sessionid   cl_sessionid;
 243         /* number of rpc's in progress over an associated session: */
 244         atomic_t                cl_refcount;
 245
 246         /* for nfs41 callbacks */
 247         /* We currently support a single back channel with a single slot */
 248         unsigned long           cl_cb_slot_busy;
 249         u32                     cl_cb_seq_nr;
 250         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 251                                                 /* wait here for slots */
 252 };
 253
 254 static inline void
 255 mark_client_expired(struct nfs4_client *clp)
 256 {
 257         clp->cl_time = 0;
 258 }
 259
 260 static inline bool
 261 is_client_expired(struct nfs4_client *clp)
 262 {
 263         return clp->cl_time == 0;
 264 }
 265
 266 /* struct nfs4_client_reset
 267  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 268  * upon lease reset, or from upcall to state_daemon (to read in state
 269  * from non-volitile storage) upon reboot.
 270  */
 271 struct nfs4_client_reclaim {
 272         struct list_head        cr_strhash;     /* hash by cr_name */
 273         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 274 };
 275
 276 static inline void
 277 update_stateid(stateid_t *stateid)
 278 {
 279         stateid->si_generation++;
 280 }
 281
 282 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 283  * The OPEN response, typically the largest, requires
 284  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 285  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 286  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 287  */
 288
 289 #define NFSD4_REPLAY_ISIZE       112
 290
 291 /*
 292  * Replay buffer, where the result of the last seqid-mutating operation
 293  * is cached.
 294  */
 295 struct nfs4_replay {
 296         __be32                  rp_status;
 297         unsigned int            rp_buflen;
 298         char                    *rp_buf;
 299         unsigned                intrp_allocated;
 300         struct knfsd_fh         rp_openfh;
 301         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 302 };
 303
 304 /*
 305 * nfs4_stateowner can either be an open_owner, or a lock_owner
 306 *
 307 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 308 *         for lock_owner
 309 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 310 *         for lock_owner
 311 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 312 *         struct is reaped.
 313 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 314 *         and is used to ensure no dangling nfs4_stateid references when we
 315 *         release a stateowner.
 316 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 317 *         close is called to reap associated byte-range locks
 318 *    so_close_lru: (open) stateowner is placed on this list instead of being
 319 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 320 *         reaped by laundramat thread after lease period.
 321 */
 322 struct nfs4_stateowner {
 323         struct kref             so_ref;
 324         struct list_head        so_idhash;   /* hash by so_id */
 325         struct list_head        so_strhash;   /* hash by op_name */
 326         struct list_head        so_perclient;
 327         struct list_head        so_stateids;
 328         struct list_head        so_perstateid; /* for lockowners only */
 329         struct list_head        so_close_lru; /* tail queue */
 330         time_t                  so_time; /* time of placement on so_close_lru */
 331         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 332         u32                     so_id;
 333         struct nfs4_client *    so_client;
 334         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 335          * sequence id expected from the client: */
 336         u32                     so_seqid;
 337         struct xdr_netobj       so_owner;     /* open owner name */
 338         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 339         struct nfs4_replay      so_replay;
 340 };
 341
 342 /*
 343 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 344 *    o fi_perfile list is used to search for conflicting
 345 *      share_acces, share_deny on the file.
 346 */
 347 struct nfs4_file {
 348         atomic_t                fi_ref;
 349         struct list_head        fi_hash;    /* hash by "struct inode *" */
 350         struct list_head        fi_stateids;
 351         struct list_head        fi_delegations;
 352         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 353         struct file *           fi_fds[3];
 354         /* One each for O_RDONLY, O_WRONLY: */
 355         atomic_t                fi_access[2];
 356         /*
 357          * Each open stateid contributes 1 to either fi_readers or
 358          * fi_writers, or both, depending on the open mode.  A
 359          * delegation also takes an fi_readers reference.  Lock
 360          * stateid's take none.
 361          */
 362         atomic_t                fi_readers;
 363         atomic_t                fi_writers;
 364         struct inode            *fi_inode;
 365         u32                     fi_id;      /* used with stateowner->so_id
 366                                              * for stateid_hashtbl hash */
 367         bool                    fi_had_conflict;
 368 };
 369
 370 /* XXX: for first cut may fall back on returning file that doesn't work
 371  * at all? */
 372 static inline struct file *find_writeable_file(struct nfs4_file *f)
 373 {
 374         if (f->fi_fds[O_WRONLY])
 375                 return f->fi_fds[O_WRONLY];
 376         return f->fi_fds[O_RDWR];
 377 }
 378
 379 static inline struct file *find_readable_file(struct nfs4_file *f)
 380 {
 381         if (f->fi_fds[O_RDONLY])
 382                 return f->fi_fds[O_RDONLY];
 383         return f->fi_fds[O_RDWR];
 384 }
 385
 386 static inline struct file *find_any_file(struct nfs4_file *f)
 387 {
 388         if (f->fi_fds[O_RDWR])
 389                 return f->fi_fds[O_RDWR];
 390         else if (f->fi_fds[O_WRONLY])
 391                 return f->fi_fds[O_WRONLY];
 392         else
 393                 return f->fi_fds[O_RDONLY];
 394 }
 395
 396 /*
 397 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 398 *
 399 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 400 *
 401 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 402 *       st_perfile: file_hashtbl[] entry.
 403 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 404 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 405 *       st_access_bmap: used only for open stateid
 406 *       st_deny_bmap: used only for open stateid
 407 *       st_openstp: open stateid lock stateid was derived from
 408 *
 409 * XXX: open stateids and lock stateids have diverged sufficiently that
 410 * we should consider defining separate structs for the two cases.
 411 */
 412
 413 struct nfs4_stateid {
 414         struct list_head              st_hash;
 415         struct list_head              st_perfile;
 416         struct list_head              st_perstateowner;
 417         struct list_head              st_lockowners;
 418         struct nfs4_stateowner      * st_stateowner;
 419         struct nfs4_file            * st_file;
 420         stateid_t                     st_stateid;
 421         unsigned long                 st_access_bmap;
 422         unsigned long                 st_deny_bmap;
 423         struct nfs4_stateid         * st_openstp;
 424 };
 425
 426 /* flags for preprocess_seqid_op() */
 427 #define HAS_SESSION             0x00000001
 428 #define CONFIRM                 0x00000002
 429 #define OPEN_STATE              0x00000004
 430 #define LOCK_STATE              0x00000008
 431 #define RD_STATE                0x00000010
 432 #define WR_STATE                0x00000020
 433 #define CLOSE_STATE             0x00000040
 434
 435 #define seqid_mutating_err(err)                       \
 436         (((err) != nfserr_stale_clientid) &&    \
 437         ((err) != nfserr_bad_seqid) &&          \
 438         ((err) != nfserr_stale_stateid) &&      \
 439         ((err) != nfserr_bad_stateid))
 440
 441 struct nfsd4_compound_state;
 442
 443 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 444                 stateid_t *stateid, int flags, struct file **filp);
 445 extern void nfs4_lock_state(void);
 446 extern void nfs4_unlock_state(void);
 447 extern int nfs4_in_grace(void);
 448 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 449 extern void nfs4_free_stateowner(struct kref *kref);
 450 extern int set_callback_cred(void);
 451 extern void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 452 extern void nfsd4_do_callback_rpc(struct work_struct *);
 453 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 454 extern int nfsd4_create_callback_queue(void);
 455 extern void nfsd4_destroy_callback_queue(void);
 456 extern void nfsd4_shutdown_callback(struct nfs4_client *);
 457 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 458 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 459 extern void nfsd4_init_recdir(char *recdir_name);
 460 extern int nfsd4_recdir_load(void);
 461 extern void nfsd4_shutdown_recdir(void);
 462 extern int nfs4_client_to_reclaim(const char *name);
 463 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 464 extern void nfsd4_recdir_purge_old(void);
 465 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 466 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 467 extern void release_session_client(struct nfsd4_session *);
 468
 469 static inline void
 470 nfs4_put_stateowner(struct nfs4_stateowner *so)
 471 {
 472         kref_put(&so->so_ref, nfs4_free_stateowner);
 473 }
 474
 475 static inline void
 476 nfs4_get_stateowner(struct nfs4_stateowner *so)
 477 {
 478         kref_get(&so->so_ref);
 479 }
 480
 481 #endif   /* NFSD4_STATE_H */