include/linux/nfsd/state.h

   1 /*
   2  *  linux/include/nfsd/state.h
   3  *
   4  *  Copyright (c) 2001 The Regents of the University of Michigan.
   5  *  All rights reserved.
   6  *
   7  *  Kendrick Smith <kmsmith@umich.edu>
   8  *  Andy Adamson <andros@umich.edu>
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *  1. Redistributions of source code must retain the above copyright
  15  *     notice, this list of conditions and the following disclaimer.
  16  *  2. Redistributions in binary form must reproduce the above copyright
  17  *     notice, this list of conditions and the following disclaimer in the
  18  *     documentation and/or other materials provided with the distribution.
  19  *  3. Neither the name of the University nor the names of its
  20  *     contributors may be used to endorse or promote products derived
  21  *     from this software without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  24  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #ifndef _NFSD4_STATE_H
  38 #define _NFSD4_STATE_H
  39
  40 #include <linux/list.h>
  41 #include <linux/kref.h>
  42 #include <linux/sunrpc/clnt.h>
  43
  44 #define NFS4_OPAQUE_LIMIT 1024
  45 typedef struct {
  46         u32             cl_boot;
  47         u32             cl_id;
  48 } clientid_t;
  49
  50 typedef struct {
  51         u32             so_boot;
  52         u32             so_stateownerid;
  53         u32             so_fileid;
  54 } stateid_opaque_t;
  55
  56 typedef struct {
  57         u32                     si_generation;
  58         stateid_opaque_t        si_opaque;
  59 } stateid_t;
  60 #define si_boot           si_opaque.so_boot
  61 #define si_stateownerid   si_opaque.so_stateownerid
  62 #define si_fileid         si_opaque.so_fileid
  63
  64
  65 struct nfs4_cb_recall {
  66         u32                     cbr_ident;
  67         int                     cbr_trunc;
  68         stateid_t               cbr_stateid;
  69         struct knfsd_fh         cbr_fh;
  70         struct nfs4_delegation  *cbr_dp;
  71 };
  72
  73 struct nfs4_delegation {
  74         struct list_head        dl_perfile;
  75         struct list_head        dl_perclnt;
  76         struct list_head        dl_recall_lru;  /* delegation recalled */
  77         atomic_t                dl_count;       /* ref count */
  78         struct nfs4_client      *dl_client;
  79         struct nfs4_file        *dl_file;
  80         struct file_lock        *dl_flock;
  81         struct file             *dl_vfs_file;
  82         u32                     dl_type;
  83         time_t                  dl_time;
  84         struct nfs4_cb_recall   dl_recall;
  85 };
  86
  87 #define dl_stateid      dl_recall.cbr_stateid
  88 #define dl_fh           dl_recall.cbr_fh
  89
  90 /* client delegation callback info */
  91 struct nfs4_callback {
  92         /* SETCLIENTID info */
  93         u32                     cb_addr;
  94         unsigned short          cb_port;
  95         u32                     cb_prog;
  96         u32                     cb_ident;
  97         /* RPC client info */
  98         atomic_t                cb_set;     /* successful CB_NULL call */
  99         struct rpc_clnt *       cb_client;
 100 };
 101
 102 /* Maximum number of slots per session. 128 is useful for long haul TCP */
 103 #define NFSD_MAX_SLOTS_PER_SESSION      128
 104 /* Maximum number of pages per slot cache entry */
 105 #define NFSD_PAGES_PER_SLOT     1
 106 /* Maximum number of operations per session compound */
 107 #define NFSD_MAX_OPS_PER_COMPOUND       16
 108
 109 struct nfsd4_cache_entry {
 110         __be32          ce_status;
 111         struct kvec     ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
 112         struct page     *ce_respages[NFSD_PAGES_PER_SLOT + 1];
 113         int             ce_cachethis;
 114         short           ce_resused;
 115         int             ce_opcnt;
 116         int             ce_rpchdrlen;
 117 };
 118
 119 struct nfsd4_slot {
 120         bool                            sl_inuse;
 121         u32                             sl_seqid;
 122         struct nfsd4_cache_entry        sl_cache_entry;
 123 };
 124
 125 struct nfsd4_session {
 126         struct kref             se_ref;
 127         struct list_head        se_hash;        /* hash by sessionid */
 128         struct list_head        se_perclnt;
 129         u32                     se_flags;
 130         struct nfs4_client      *se_client;     /* for expire_client */
 131         struct nfs4_sessionid   se_sessionid;
 132         u32                     se_fmaxreq_sz;
 133         u32                     se_fmaxresp_sz;
 134         u32                     se_fmaxresp_cached;
 135         u32                     se_fmaxops;
 136         u32                     se_fnumslots;
 137         struct nfsd4_slot       se_slots[];     /* forward channel slots */
 138 };
 139
 140 static inline void
 141 nfsd4_put_session(struct nfsd4_session *ses)
 142 {
 143         extern void free_session(struct kref *kref);
 144         kref_put(&ses->se_ref, free_session);
 145 }
 146
 147 static inline void
 148 nfsd4_get_session(struct nfsd4_session *ses)
 149 {
 150         kref_get(&ses->se_ref);
 151 }
 152
 153 /* formatted contents of nfs4_sessionid */
 154 struct nfsd4_sessionid {
 155         clientid_t      clientid;
 156         u32             sequence;
 157         u32             reserved;
 158 };
 159
 160 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 161
 162 /*
 163  * struct nfs4_client - one per client.  Clientids live here.
 164  *      o Each nfs4_client is hashed by clientid.
 165  *
 166  *      o Each nfs4_clients is also hashed by name
 167  *        (the opaque quantity initially sent by the client to identify itself).
 168  *
 169  *      o cl_perclient list is used to ensure no dangling stateowner references
 170  *        when we expire the nfs4_client
 171  */
 172 struct nfs4_client {
 173         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 174         struct list_head        cl_strhash;     /* hash by cl_name */
 175         struct list_head        cl_openowners;
 176         struct list_head        cl_delegations;
 177         struct list_head        cl_lru;         /* tail queue */
 178         struct xdr_netobj       cl_name;        /* id generated by client */
 179         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 180         nfs4_verifier           cl_verifier;    /* generated by client */
 181         time_t                  cl_time;        /* time of last lease renewal */
 182         __be32                  cl_addr;        /* client ipaddress */
 183         u32                     cl_flavor;      /* setclientid pseudoflavor */
 184         char                    *cl_principal;  /* setclientid principal name */
 185         struct svc_cred         cl_cred;        /* setclientid principal */
 186         clientid_t              cl_clientid;    /* generated by server */
 187         nfs4_verifier           cl_confirm;     /* generated by server */
 188         struct nfs4_callback    cl_callback;    /* callback info */
 189         atomic_t                cl_count;       /* ref count */
 190         u32                     cl_firststate;  /* recovery dir creation */
 191
 192         /* for nfs41 */
 193         struct list_head        cl_sessions;
 194         struct nfsd4_slot       cl_slot;        /* create_session slot */
 195         u32                     cl_exchange_flags;
 196         struct nfs4_sessionid   cl_sessionid;
 197 };
 198
 199 /* struct nfs4_client_reset
 200  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 201  * upon lease reset, or from upcall to state_daemon (to read in state
 202  * from non-volitile storage) upon reboot.
 203  */
 204 struct nfs4_client_reclaim {
 205         struct list_head        cr_strhash;     /* hash by cr_name */
 206         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 207 };
 208
 209 static inline void
 210 update_stateid(stateid_t *stateid)
 211 {
 212         stateid->si_generation++;
 213 }
 214
 215 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 216  * The OPEN response, typically the largest, requires
 217  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 218  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 219  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 220  */
 221
 222 #define NFSD4_REPLAY_ISIZE       112
 223
 224 /*
 225  * Replay buffer, where the result of the last seqid-mutating operation
 226  * is cached.
 227  */
 228 struct nfs4_replay {
 229         __be32                  rp_status;
 230         unsigned int            rp_buflen;
 231         char                    *rp_buf;
 232         unsigned                intrp_allocated;
 233         struct knfsd_fh         rp_openfh;
 234         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 235 };
 236
 237 /*
 238 * nfs4_stateowner can either be an open_owner, or a lock_owner
 239 *
 240 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 241 *         for lock_owner
 242 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 243 *         for lock_owner
 244 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 245 *         struct is reaped.
 246 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 247 *         and is used to ensure no dangling nfs4_stateid references when we
 248 *         release a stateowner.
 249 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 250 *         close is called to reap associated byte-range locks
 251 *    so_close_lru: (open) stateowner is placed on this list instead of being
 252 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 253 *         reaped by laundramat thread after lease period.
 254 */
 255 struct nfs4_stateowner {
 256         struct kref             so_ref;
 257         struct list_head        so_idhash;   /* hash by so_id */
 258         struct list_head        so_strhash;   /* hash by op_name */
 259         struct list_head        so_perclient;
 260         struct list_head        so_stateids;
 261         struct list_head        so_perstateid; /* for lockowners only */
 262         struct list_head        so_close_lru; /* tail queue */
 263         time_t                  so_time; /* time of placement on so_close_lru */
 264         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 265         u32                     so_id;
 266         struct nfs4_client *    so_client;
 267         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 268          * sequence id expected from the client: */
 269         u32                     so_seqid;
 270         struct xdr_netobj       so_owner;     /* open owner name */
 271         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 272         struct nfs4_replay      so_replay;
 273 };
 274
 275 /*
 276 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 277 *    o fi_perfile list is used to search for conflicting
 278 *      share_acces, share_deny on the file.
 279 */
 280 struct nfs4_file {
 281         atomic_t                fi_ref;
 282         struct list_head        fi_hash;    /* hash by "struct inode *" */
 283         struct list_head        fi_stateids;
 284         struct list_head        fi_delegations;
 285         struct inode            *fi_inode;
 286         u32                     fi_id;      /* used with stateowner->so_id
 287                                              * for stateid_hashtbl hash */
 288         bool                    fi_had_conflict;
 289 };
 290
 291 /*
 292 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 293 *
 294 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 295 *
 296 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 297 *       st_perfile: file_hashtbl[] entry.
 298 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 299 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 300 *       st_access_bmap: used only for open stateid
 301 *       st_deny_bmap: used only for open stateid
 302 *       st_openstp: open stateid lock stateid was derived from
 303 *
 304 * XXX: open stateids and lock stateids have diverged sufficiently that
 305 * we should consider defining separate structs for the two cases.
 306 */
 307
 308 struct nfs4_stateid {
 309         struct list_head              st_hash;
 310         struct list_head              st_perfile;
 311         struct list_head              st_perstateowner;
 312         struct list_head              st_lockowners;
 313         struct nfs4_stateowner      * st_stateowner;
 314         struct nfs4_file            * st_file;
 315         stateid_t                     st_stateid;
 316         struct file                 * st_vfs_file;
 317         unsigned long                 st_access_bmap;
 318         unsigned long                 st_deny_bmap;
 319         struct nfs4_stateid         * st_openstp;
 320 };
 321
 322 /* flags for preprocess_seqid_op() */
 323 #define CONFIRM                 0x00000002
 324 #define OPEN_STATE              0x00000004
 325 #define LOCK_STATE              0x00000008
 326 #define RD_STATE                0x00000010
 327 #define WR_STATE                0x00000020
 328 #define CLOSE_STATE             0x00000040
 329
 330 #define seqid_mutating_err(err)                       \
 331         (((err) != nfserr_stale_clientid) &&    \
 332         ((err) != nfserr_bad_seqid) &&          \
 333         ((err) != nfserr_stale_stateid) &&      \
 334         ((err) != nfserr_bad_stateid))
 335
 336 extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
 337                 stateid_t *stateid, int flags, struct file **filp);
 338 extern void nfs4_lock_state(void);
 339 extern void nfs4_unlock_state(void);
 340 extern int nfs4_in_grace(void);
 341 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 342 extern void put_nfs4_client(struct nfs4_client *clp);
 343 extern void nfs4_free_stateowner(struct kref *kref);
 344 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 345 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 346 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 347 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 348 extern void nfsd4_init_recdir(char *recdir_name);
 349 extern int nfsd4_recdir_load(void);
 350 extern void nfsd4_shutdown_recdir(void);
 351 extern int nfs4_client_to_reclaim(const char *name);
 352 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 353 extern void nfsd4_recdir_purge_old(void);
 354 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 355 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 356
 357 static inline void
 358 nfs4_put_stateowner(struct nfs4_stateowner *so)
 359 {
 360         kref_put(&so->so_ref, nfs4_free_stateowner);
 361 }
 362
 363 static inline void
 364 nfs4_get_stateowner(struct nfs4_stateowner *so)
 365 {
 366         kref_get(&so->so_ref);
 367 }
 368
 369 #endif   /* NFSD4_STATE_H */