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