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 struct nfsd4_slot {
 103         bool                            sl_inuse;
 104         u32                             sl_seqid;
 105 };
 106
 107 struct nfsd4_session {
 108         struct kref             se_ref;
 109         struct list_head        se_hash;        /* hash by sessionid */
 110         struct list_head        se_perclnt;
 111         u32                     se_flags;
 112         struct nfs4_client      *se_client;     /* for expire_client */
 113         struct nfs4_sessionid   se_sessionid;
 114         u32                     se_fmaxreq_sz;
 115         u32                     se_fmaxresp_sz;
 116         u32                     se_fmaxresp_cached;
 117         u32                     se_fmaxops;
 118         u32                     se_fnumslots;
 119         struct nfsd4_slot       *se_slots;      /* forward channel slots */
 120 };
 121
 122 static inline void
 123 nfsd4_put_session(struct nfsd4_session *ses)
 124 {
 125         extern void free_session(struct kref *kref);
 126         kref_put(&ses->se_ref, free_session);
 127 }
 128
 129 static inline void
 130 nfsd4_get_session(struct nfsd4_session *ses)
 131 {
 132         kref_get(&ses->se_ref);
 133 }
 134
 135 /* formatted contents of nfs4_sessionid */
 136 struct nfsd4_sessionid {
 137         clientid_t      clientid;
 138         u32             sequence;
 139         u32             reserved;
 140 };
 141
 142 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 143
 144 /*
 145  * struct nfs4_client - one per client.  Clientids live here.
 146  *      o Each nfs4_client is hashed by clientid.
 147  *
 148  *      o Each nfs4_clients is also hashed by name
 149  *        (the opaque quantity initially sent by the client to identify itself).
 150  *
 151  *      o cl_perclient list is used to ensure no dangling stateowner references
 152  *        when we expire the nfs4_client
 153  */
 154 struct nfs4_client {
 155         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 156         struct list_head        cl_strhash;     /* hash by cl_name */
 157         struct list_head        cl_openowners;
 158         struct list_head        cl_delegations;
 159         struct list_head        cl_lru;         /* tail queue */
 160         struct xdr_netobj       cl_name;        /* id generated by client */
 161         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 162         nfs4_verifier           cl_verifier;    /* generated by client */
 163         time_t                  cl_time;        /* time of last lease renewal */
 164         __be32                  cl_addr;        /* client ipaddress */
 165         u32                     cl_flavor;      /* setclientid pseudoflavor */
 166         char                    *cl_principal;  /* setclientid principal name */
 167         struct svc_cred         cl_cred;        /* setclientid principal */
 168         clientid_t              cl_clientid;    /* generated by server */
 169         nfs4_verifier           cl_confirm;     /* generated by server */
 170         struct nfs4_callback    cl_callback;    /* callback info */
 171         atomic_t                cl_count;       /* ref count */
 172         u32                     cl_firststate;  /* recovery dir creation */
 173
 174         /* for nfs41 */
 175         struct list_head        cl_sessions;
 176 };
 177
 178 /* struct nfs4_client_reset
 179  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 180  * upon lease reset, or from upcall to state_daemon (to read in state
 181  * from non-volitile storage) upon reboot.
 182  */
 183 struct nfs4_client_reclaim {
 184         struct list_head        cr_strhash;     /* hash by cr_name */
 185         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 186 };
 187
 188 static inline void
 189 update_stateid(stateid_t *stateid)
 190 {
 191         stateid->si_generation++;
 192 }
 193
 194 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 195  * The OPEN response, typically the largest, requires
 196  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 197  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 198  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 199  */
 200
 201 #define NFSD4_REPLAY_ISIZE       112
 202
 203 /*
 204  * Replay buffer, where the result of the last seqid-mutating operation
 205  * is cached.
 206  */
 207 struct nfs4_replay {
 208         __be32                  rp_status;
 209         unsigned int            rp_buflen;
 210         char                    *rp_buf;
 211         unsigned                intrp_allocated;
 212         struct knfsd_fh         rp_openfh;
 213         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 214 };
 215
 216 /*
 217 * nfs4_stateowner can either be an open_owner, or a lock_owner
 218 *
 219 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 220 *         for lock_owner
 221 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 222 *         for lock_owner
 223 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 224 *         struct is reaped.
 225 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 226 *         and is used to ensure no dangling nfs4_stateid references when we
 227 *         release a stateowner.
 228 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 229 *         close is called to reap associated byte-range locks
 230 *    so_close_lru: (open) stateowner is placed on this list instead of being
 231 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 232 *         reaped by laundramat thread after lease period.
 233 */
 234 struct nfs4_stateowner {
 235         struct kref             so_ref;
 236         struct list_head        so_idhash;   /* hash by so_id */
 237         struct list_head        so_strhash;   /* hash by op_name */
 238         struct list_head        so_perclient;
 239         struct list_head        so_stateids;
 240         struct list_head        so_perstateid; /* for lockowners only */
 241         struct list_head        so_close_lru; /* tail queue */
 242         time_t                  so_time; /* time of placement on so_close_lru */
 243         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 244         u32                     so_id;
 245         struct nfs4_client *    so_client;
 246         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 247          * sequence id expected from the client: */
 248         u32                     so_seqid;
 249         struct xdr_netobj       so_owner;     /* open owner name */
 250         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 251         struct nfs4_replay      so_replay;
 252 };
 253
 254 /*
 255 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 256 *    o fi_perfile list is used to search for conflicting
 257 *      share_acces, share_deny on the file.
 258 */
 259 struct nfs4_file {
 260         atomic_t                fi_ref;
 261         struct list_head        fi_hash;    /* hash by "struct inode *" */
 262         struct list_head        fi_stateids;
 263         struct list_head        fi_delegations;
 264         struct inode            *fi_inode;
 265         u32                     fi_id;      /* used with stateowner->so_id
 266                                              * for stateid_hashtbl hash */
 267         bool                    fi_had_conflict;
 268 };
 269
 270 /*
 271 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 272 *
 273 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 274 *
 275 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 276 *       st_perfile: file_hashtbl[] entry.
 277 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 278 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 279 *       st_access_bmap: used only for open stateid
 280 *       st_deny_bmap: used only for open stateid
 281 *       st_openstp: open stateid lock stateid was derived from
 282 *
 283 * XXX: open stateids and lock stateids have diverged sufficiently that
 284 * we should consider defining separate structs for the two cases.
 285 */
 286
 287 struct nfs4_stateid {
 288         struct list_head              st_hash;
 289         struct list_head              st_perfile;
 290         struct list_head              st_perstateowner;
 291         struct list_head              st_lockowners;
 292         struct nfs4_stateowner      * st_stateowner;
 293         struct nfs4_file            * st_file;
 294         stateid_t                     st_stateid;
 295         struct file                 * st_vfs_file;
 296         unsigned long                 st_access_bmap;
 297         unsigned long                 st_deny_bmap;
 298         struct nfs4_stateid         * st_openstp;
 299 };
 300
 301 /* flags for preprocess_seqid_op() */
 302 #define CONFIRM                 0x00000002
 303 #define OPEN_STATE              0x00000004
 304 #define LOCK_STATE              0x00000008
 305 #define RD_STATE                0x00000010
 306 #define WR_STATE                0x00000020
 307 #define CLOSE_STATE             0x00000040
 308
 309 #define seqid_mutating_err(err)                       \
 310         (((err) != nfserr_stale_clientid) &&    \
 311         ((err) != nfserr_bad_seqid) &&          \
 312         ((err) != nfserr_stale_stateid) &&      \
 313         ((err) != nfserr_bad_stateid))
 314
 315 extern __be32 nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
 316                 stateid_t *stateid, int flags, struct file **filp);
 317 extern void nfs4_lock_state(void);
 318 extern void nfs4_unlock_state(void);
 319 extern int nfs4_in_grace(void);
 320 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 321 extern void put_nfs4_client(struct nfs4_client *clp);
 322 extern void nfs4_free_stateowner(struct kref *kref);
 323 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 324 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 325 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 326 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 327 extern void nfsd4_init_recdir(char *recdir_name);
 328 extern int nfsd4_recdir_load(void);
 329 extern void nfsd4_shutdown_recdir(void);
 330 extern int nfs4_client_to_reclaim(const char *name);
 331 extern int nfs4_has_reclaimed_state(const char *name);
 332 extern void nfsd4_recdir_purge_old(void);
 333 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 334 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 335
 336 static inline void
 337 nfs4_put_stateowner(struct nfs4_stateowner *so)
 338 {
 339         kref_put(&so->so_ref, nfs4_free_stateowner);
 340 }
 341
 342 static inline void
 343 nfs4_get_stateowner(struct nfs4_stateowner *so)
 344 {
 345         kref_get(&so->so_ref);
 346 }
 347
 348 #endif   /* NFSD4_STATE_H */