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         u32                     dl_ident;
  88         stateid_t               dl_stateid;
  89         struct knfsd_fh         dl_fh;
  90         int                     dl_retries;
  91         struct nfsd4_callback   dl_recall;
  92 };
  93
  94 /* client delegation callback info */
  95 struct nfs4_cb_conn {
  96         /* SETCLIENTID info */
  97         struct sockaddr_storage cb_addr;
  98         size_t                  cb_addrlen;
  99         u32                     cb_prog;
 100         u32                     cb_minorversion;
 101         u32                     cb_ident;       /* minorversion 0 only */
 102         struct svc_xprt         *cb_xprt;       /* minorversion 1 only */
 103 };
 104
 105 /* Maximum number of slots per session. 160 is useful for long haul TCP */
 106 #define NFSD_MAX_SLOTS_PER_SESSION     160
 107 /* Maximum number of operations per session compound */
 108 #define NFSD_MAX_OPS_PER_COMPOUND       16
 109 /* Maximum  session per slot cache size */
 110 #define NFSD_SLOT_CACHE_SIZE            1024
 111 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 112 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 113 #define NFSD_MAX_MEM_PER_SESSION  \
 114                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 115
 116 struct nfsd4_slot {
 117         bool    sl_inuse;
 118         bool    sl_cachethis;
 119         u16     sl_opcnt;
 120         u32     sl_seqid;
 121         __be32  sl_status;
 122         u32     sl_datalen;
 123         char    sl_data[];
 124 };
 125
 126 struct nfsd4_channel_attrs {
 127         u32             headerpadsz;
 128         u32             maxreq_sz;
 129         u32             maxresp_sz;
 130         u32             maxresp_cached;
 131         u32             maxops;
 132         u32             maxreqs;
 133         u32             nr_rdma_attrs;
 134         u32             rdma_attrs;
 135 };
 136
 137 struct nfsd4_create_session {
 138         clientid_t                      clientid;
 139         struct nfs4_sessionid           sessionid;
 140         u32                             seqid;
 141         u32                             flags;
 142         struct nfsd4_channel_attrs      fore_channel;
 143         struct nfsd4_channel_attrs      back_channel;
 144         u32                             callback_prog;
 145         u32                             uid;
 146         u32                             gid;
 147 };
 148
 149 /* The single slot clientid cache structure */
 150 struct nfsd4_clid_slot {
 151         u32                             sl_seqid;
 152         __be32                          sl_status;
 153         struct nfsd4_create_session     sl_cr_ses;
 154 };
 155
 156 struct nfsd4_session {
 157         struct kref             se_ref;
 158         struct list_head        se_hash;        /* hash by sessionid */
 159         struct list_head        se_perclnt;
 160         u32                     se_flags;
 161         struct nfs4_client      *se_client;
 162         struct nfs4_sessionid   se_sessionid;
 163         struct nfsd4_channel_attrs se_fchannel;
 164         struct nfsd4_channel_attrs se_bchannel;
 165         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 166 };
 167
 168 static inline void
 169 nfsd4_put_session(struct nfsd4_session *ses)
 170 {
 171         extern void free_session(struct kref *kref);
 172         kref_put(&ses->se_ref, free_session);
 173 }
 174
 175 static inline void
 176 nfsd4_get_session(struct nfsd4_session *ses)
 177 {
 178         kref_get(&ses->se_ref);
 179 }
 180
 181 /* formatted contents of nfs4_sessionid */
 182 struct nfsd4_sessionid {
 183         clientid_t      clientid;
 184         u32             sequence;
 185         u32             reserved;
 186 };
 187
 188 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 189
 190 /*
 191  * struct nfs4_client - one per client.  Clientids live here.
 192  *      o Each nfs4_client is hashed by clientid.
 193  *
 194  *      o Each nfs4_clients is also hashed by name
 195  *        (the opaque quantity initially sent by the client to identify itself).
 196  *
 197  *      o cl_perclient list is used to ensure no dangling stateowner references
 198  *        when we expire the nfs4_client
 199  */
 200 struct nfs4_client {
 201         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 202         struct list_head        cl_strhash;     /* hash by cl_name */
 203         struct list_head        cl_openowners;
 204         struct list_head        cl_delegations;
 205         struct list_head        cl_lru;         /* tail queue */
 206         struct xdr_netobj       cl_name;        /* id generated by client */
 207         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 208         nfs4_verifier           cl_verifier;    /* generated by client */
 209         time_t                  cl_time;        /* time of last lease renewal */
 210         struct sockaddr_storage cl_addr;        /* client ipaddress */
 211         u32                     cl_flavor;      /* setclientid pseudoflavor */
 212         char                    *cl_principal;  /* setclientid principal name */
 213         struct svc_cred         cl_cred;        /* setclientid principal */
 214         clientid_t              cl_clientid;    /* generated by server */
 215         nfs4_verifier           cl_confirm;     /* generated by server */
 216         u32                     cl_firststate;  /* recovery dir creation */
 217
 218         /* for v4.0 and v4.1 callbacks: */
 219         struct nfs4_cb_conn     cl_cb_conn;
 220         struct rpc_clnt         *cl_cb_client;
 221         atomic_t                cl_cb_set;
 222         struct nfsd4_callback   cl_cb_null;
 223
 224         /* for nfs41 */
 225         struct list_head        cl_sessions;
 226         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 227         u32                     cl_exchange_flags;
 228         struct nfs4_sessionid   cl_sessionid;
 229         /* number of rpc's in progress over an associated session: */
 230         atomic_t                cl_refcount;
 231
 232         /* for nfs41 callbacks */
 233         /* We currently support a single back channel with a single slot */
 234         unsigned long           cl_cb_slot_busy;
 235         u32                     cl_cb_seq_nr;
 236         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 237                                                 /* wait here for slots */
 238 };
 239
 240 static inline void
 241 mark_client_expired(struct nfs4_client *clp)
 242 {
 243         clp->cl_time = 0;
 244 }
 245
 246 static inline bool
 247 is_client_expired(struct nfs4_client *clp)
 248 {
 249         return clp->cl_time == 0;
 250 }
 251
 252 /* struct nfs4_client_reset
 253  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 254  * upon lease reset, or from upcall to state_daemon (to read in state
 255  * from non-volitile storage) upon reboot.
 256  */
 257 struct nfs4_client_reclaim {
 258         struct list_head        cr_strhash;     /* hash by cr_name */
 259         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 260 };
 261
 262 static inline void
 263 update_stateid(stateid_t *stateid)
 264 {
 265         stateid->si_generation++;
 266 }
 267
 268 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 269  * The OPEN response, typically the largest, requires
 270  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 271  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 272  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 273  */
 274
 275 #define NFSD4_REPLAY_ISIZE       112
 276
 277 /*
 278  * Replay buffer, where the result of the last seqid-mutating operation
 279  * is cached.
 280  */
 281 struct nfs4_replay {
 282         __be32                  rp_status;
 283         unsigned int            rp_buflen;
 284         char                    *rp_buf;
 285         unsigned                intrp_allocated;
 286         struct knfsd_fh         rp_openfh;
 287         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 288 };
 289
 290 /*
 291 * nfs4_stateowner can either be an open_owner, or a lock_owner
 292 *
 293 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 294 *         for lock_owner
 295 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 296 *         for lock_owner
 297 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 298 *         struct is reaped.
 299 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 300 *         and is used to ensure no dangling nfs4_stateid references when we
 301 *         release a stateowner.
 302 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 303 *         close is called to reap associated byte-range locks
 304 *    so_close_lru: (open) stateowner is placed on this list instead of being
 305 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 306 *         reaped by laundramat thread after lease period.
 307 */
 308 struct nfs4_stateowner {
 309         struct kref             so_ref;
 310         struct list_head        so_idhash;   /* hash by so_id */
 311         struct list_head        so_strhash;   /* hash by op_name */
 312         struct list_head        so_perclient;
 313         struct list_head        so_stateids;
 314         struct list_head        so_perstateid; /* for lockowners only */
 315         struct list_head        so_close_lru; /* tail queue */
 316         time_t                  so_time; /* time of placement on so_close_lru */
 317         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 318         u32                     so_id;
 319         struct nfs4_client *    so_client;
 320         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 321          * sequence id expected from the client: */
 322         u32                     so_seqid;
 323         struct xdr_netobj       so_owner;     /* open owner name */
 324         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 325         struct nfs4_replay      so_replay;
 326 };
 327
 328 /*
 329 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 330 *    o fi_perfile list is used to search for conflicting
 331 *      share_acces, share_deny on the file.
 332 */
 333 struct nfs4_file {
 334         atomic_t                fi_ref;
 335         struct list_head        fi_hash;    /* hash by "struct inode *" */
 336         struct list_head        fi_stateids;
 337         struct list_head        fi_delegations;
 338         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 339         struct file *           fi_fds[3];
 340         /* One each for O_RDONLY, O_WRONLY: */
 341         atomic_t                fi_access[2];
 342         /*
 343          * Each open stateid contributes 1 to either fi_readers or
 344          * fi_writers, or both, depending on the open mode.  A
 345          * delegation also takes an fi_readers reference.  Lock
 346          * stateid's take none.
 347          */
 348         atomic_t                fi_readers;
 349         atomic_t                fi_writers;
 350         struct inode            *fi_inode;
 351         u32                     fi_id;      /* used with stateowner->so_id
 352                                              * for stateid_hashtbl hash */
 353         bool                    fi_had_conflict;
 354 };
 355
 356 /* XXX: for first cut may fall back on returning file that doesn't work
 357  * at all? */
 358 static inline struct file *find_writeable_file(struct nfs4_file *f)
 359 {
 360         if (f->fi_fds[O_WRONLY])
 361                 return f->fi_fds[O_WRONLY];
 362         return f->fi_fds[O_RDWR];
 363 }
 364
 365 static inline struct file *find_readable_file(struct nfs4_file *f)
 366 {
 367         if (f->fi_fds[O_RDONLY])
 368                 return f->fi_fds[O_RDONLY];
 369         return f->fi_fds[O_RDWR];
 370 }
 371
 372 static inline struct file *find_any_file(struct nfs4_file *f)
 373 {
 374         if (f->fi_fds[O_RDWR])
 375                 return f->fi_fds[O_RDWR];
 376         else if (f->fi_fds[O_WRONLY])
 377                 return f->fi_fds[O_WRONLY];
 378         else
 379                 return f->fi_fds[O_RDONLY];
 380 }
 381
 382 /*
 383 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 384 *
 385 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 386 *
 387 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 388 *       st_perfile: file_hashtbl[] entry.
 389 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 390 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 391 *       st_access_bmap: used only for open stateid
 392 *       st_deny_bmap: used only for open stateid
 393 *       st_openstp: open stateid lock stateid was derived from
 394 *
 395 * XXX: open stateids and lock stateids have diverged sufficiently that
 396 * we should consider defining separate structs for the two cases.
 397 */
 398
 399 struct nfs4_stateid {
 400         struct list_head              st_hash;
 401         struct list_head              st_perfile;
 402         struct list_head              st_perstateowner;
 403         struct list_head              st_lockowners;
 404         struct nfs4_stateowner      * st_stateowner;
 405         struct nfs4_file            * st_file;
 406         stateid_t                     st_stateid;
 407         unsigned long                 st_access_bmap;
 408         unsigned long                 st_deny_bmap;
 409         struct nfs4_stateid         * st_openstp;
 410 };
 411
 412 /* flags for preprocess_seqid_op() */
 413 #define HAS_SESSION             0x00000001
 414 #define CONFIRM                 0x00000002
 415 #define OPEN_STATE              0x00000004
 416 #define LOCK_STATE              0x00000008
 417 #define RD_STATE                0x00000010
 418 #define WR_STATE                0x00000020
 419 #define CLOSE_STATE             0x00000040
 420
 421 #define seqid_mutating_err(err)                       \
 422         (((err) != nfserr_stale_clientid) &&    \
 423         ((err) != nfserr_bad_seqid) &&          \
 424         ((err) != nfserr_stale_stateid) &&      \
 425         ((err) != nfserr_bad_stateid))
 426
 427 struct nfsd4_compound_state;
 428
 429 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 430                 stateid_t *stateid, int flags, struct file **filp);
 431 extern void nfs4_lock_state(void);
 432 extern void nfs4_unlock_state(void);
 433 extern int nfs4_in_grace(void);
 434 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 435 extern void nfs4_free_stateowner(struct kref *kref);
 436 extern int set_callback_cred(void);
 437 extern void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 438 extern void nfsd4_do_callback_rpc(struct work_struct *);
 439 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 440 extern int nfsd4_create_callback_queue(void);
 441 extern void nfsd4_destroy_callback_queue(void);
 442 extern void nfsd4_set_callback_client(struct nfs4_client *, struct rpc_clnt *);
 443 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 444 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 445 extern void nfsd4_init_recdir(char *recdir_name);
 446 extern int nfsd4_recdir_load(void);
 447 extern void nfsd4_shutdown_recdir(void);
 448 extern int nfs4_client_to_reclaim(const char *name);
 449 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 450 extern void nfsd4_recdir_purge_old(void);
 451 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 452 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 453 extern void release_session_client(struct nfsd4_session *);
 454
 455 static inline void
 456 nfs4_put_stateowner(struct nfs4_stateowner *so)
 457 {
 458         kref_put(&so->so_ref, nfs4_free_stateowner);
 459 }
 460
 461 static inline void
 462 nfs4_get_stateowner(struct nfs4_stateowner *so)
 463 {
 464         kref_get(&so->so_ref);
 465 }
 466
 467 #endif   /* NFSD4_STATE_H */