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