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 typedef struct {
  45         u32             cl_boot;
  46         u32             cl_id;
  47 } clientid_t;
  48
  49 typedef struct {
  50         u32             so_boot;
  51         u32             so_stateownerid;
  52         u32             so_fileid;
  53 } stateid_opaque_t;
  54
  55 typedef struct {
  56         u32                     si_generation;
  57         stateid_opaque_t        si_opaque;
  58 } stateid_t;
  59 #define si_boot           si_opaque.so_boot
  60 #define si_stateownerid   si_opaque.so_stateownerid
  61 #define si_fileid         si_opaque.so_fileid
  62
  63 struct nfs4_delegation {
  64         struct list_head        dl_perfile;
  65         struct list_head        dl_perclnt;
  66         struct list_head        dl_recall_lru;  /* delegation recalled */
  67         atomic_t                dl_count;       /* ref count */
  68         struct nfs4_client      *dl_client;
  69         struct nfs4_file        *dl_file;
  70         struct file_lock        *dl_flock;
  71         struct file             *dl_vfs_file;
  72         u32                     dl_type;
  73         time_t                  dl_time;
  74 /* For recall: */
  75         u32                     dl_ident;
  76         stateid_t               dl_stateid;
  77         struct knfsd_fh         dl_fh;
  78         int                     dl_retries;
  79 };
  80
  81 /* client delegation callback info */
  82 struct nfs4_cb_conn {
  83         /* SETCLIENTID info */
  84         struct sockaddr_storage cb_addr;
  85         size_t                  cb_addrlen;
  86         u32                     cb_prog;
  87         u32                     cb_minorversion;
  88         u32                     cb_ident;       /* minorversion 0 only */
  89         /* RPC client info */
  90         atomic_t                cb_set;     /* successful CB_NULL call */
  91         struct rpc_clnt *       cb_client;
  92         struct rpc_cred *       cb_cred;
  93 };
  94
  95 /* Maximum number of slots per session. 160 is useful for long haul TCP */
  96 #define NFSD_MAX_SLOTS_PER_SESSION     160
  97 /* Maximum number of pages per slot cache entry */
  98 #define NFSD_PAGES_PER_SLOT     1
  99 #define NFSD_SLOT_CACHE_SIZE            PAGE_SIZE
 100 /* Maximum number of operations per session compound */
 101 #define NFSD_MAX_OPS_PER_COMPOUND       16
 102 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 103 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 104 #define NFSD_MAX_MEM_PER_SESSION  \
 105                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 106
 107 struct nfsd4_cache_entry {
 108         __be32          ce_status;
 109         struct kvec     ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
 110         struct page     *ce_respages[NFSD_PAGES_PER_SLOT + 1];
 111         int             ce_cachethis;
 112         short           ce_resused;
 113         int             ce_opcnt;
 114         int             ce_rpchdrlen;
 115 };
 116
 117 struct nfsd4_slot {
 118         bool                            sl_inuse;
 119         u32                             sl_seqid;
 120         struct nfsd4_cache_entry        sl_cache_entry;
 121 };
 122
 123 struct nfsd4_channel_attrs {
 124         u32             headerpadsz;
 125         u32             maxreq_sz;
 126         u32             maxresp_sz;
 127         u32             maxresp_cached;
 128         u32             maxops;
 129         u32             maxreqs;
 130         u32             nr_rdma_attrs;
 131         u32             rdma_attrs;
 132 };
 133
 134 struct nfsd4_create_session {
 135         clientid_t                      clientid;
 136         struct nfs4_sessionid           sessionid;
 137         u32                             seqid;
 138         u32                             flags;
 139         struct nfsd4_channel_attrs      fore_channel;
 140         struct nfsd4_channel_attrs      back_channel;
 141         u32                             callback_prog;
 142         u32                             uid;
 143         u32                             gid;
 144 };
 145
 146 /* The single slot clientid cache structure */
 147 struct nfsd4_clid_slot {
 148         u32                             sl_seqid;
 149         __be32                          sl_status;
 150         struct nfsd4_create_session     sl_cr_ses;
 151 };
 152
 153 struct nfsd4_session {
 154         struct kref             se_ref;
 155         struct list_head        se_hash;        /* hash by sessionid */
 156         struct list_head        se_perclnt;
 157         u32                     se_flags;
 158         struct nfs4_client      *se_client;     /* for expire_client */
 159         struct nfs4_sessionid   se_sessionid;
 160         struct nfsd4_channel_attrs se_fchannel;
 161         struct nfsd4_channel_attrs se_bchannel;
 162         struct nfsd4_slot       se_slots[];     /* forward channel slots */
 163 };
 164
 165 static inline void
 166 nfsd4_put_session(struct nfsd4_session *ses)
 167 {
 168         extern void free_session(struct kref *kref);
 169         kref_put(&ses->se_ref, free_session);
 170 }
 171
 172 static inline void
 173 nfsd4_get_session(struct nfsd4_session *ses)
 174 {
 175         kref_get(&ses->se_ref);
 176 }
 177
 178 /* formatted contents of nfs4_sessionid */
 179 struct nfsd4_sessionid {
 180         clientid_t      clientid;
 181         u32             sequence;
 182         u32             reserved;
 183 };
 184
 185 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 186
 187 /*
 188  * struct nfs4_client - one per client.  Clientids live here.
 189  *      o Each nfs4_client is hashed by clientid.
 190  *
 191  *      o Each nfs4_clients is also hashed by name
 192  *        (the opaque quantity initially sent by the client to identify itself).
 193  *
 194  *      o cl_perclient list is used to ensure no dangling stateowner references
 195  *        when we expire the nfs4_client
 196  */
 197 struct nfs4_client {
 198         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 199         struct list_head        cl_strhash;     /* hash by cl_name */
 200         struct list_head        cl_openowners;
 201         struct list_head        cl_delegations;
 202         struct list_head        cl_lru;         /* tail queue */
 203         struct xdr_netobj       cl_name;        /* id generated by client */
 204         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 205         nfs4_verifier           cl_verifier;    /* generated by client */
 206         time_t                  cl_time;        /* time of last lease renewal */
 207         struct sockaddr_storage cl_addr;        /* client ipaddress */
 208         u32                     cl_flavor;      /* setclientid pseudoflavor */
 209         char                    *cl_principal;  /* setclientid principal name */
 210         struct svc_cred         cl_cred;        /* setclientid principal */
 211         clientid_t              cl_clientid;    /* generated by server */
 212         nfs4_verifier           cl_confirm;     /* generated by server */
 213         struct nfs4_cb_conn     cl_cb_conn;     /* callback info */
 214         atomic_t                cl_count;       /* ref count */
 215         u32                     cl_firststate;  /* recovery dir creation */
 216
 217         /* for nfs41 */
 218         struct list_head        cl_sessions;
 219         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 220         u32                     cl_exchange_flags;
 221         struct nfs4_sessionid   cl_sessionid;
 222 };
 223
 224 /* struct nfs4_client_reset
 225  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 226  * upon lease reset, or from upcall to state_daemon (to read in state
 227  * from non-volitile storage) upon reboot.
 228  */
 229 struct nfs4_client_reclaim {
 230         struct list_head        cr_strhash;     /* hash by cr_name */
 231         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 232 };
 233
 234 static inline void
 235 update_stateid(stateid_t *stateid)
 236 {
 237         stateid->si_generation++;
 238 }
 239
 240 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 241  * The OPEN response, typically the largest, requires
 242  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 243  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 244  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 245  */
 246
 247 #define NFSD4_REPLAY_ISIZE       112
 248
 249 /*
 250  * Replay buffer, where the result of the last seqid-mutating operation
 251  * is cached.
 252  */
 253 struct nfs4_replay {
 254         __be32                  rp_status;
 255         unsigned int            rp_buflen;
 256         char                    *rp_buf;
 257         unsigned                intrp_allocated;
 258         struct knfsd_fh         rp_openfh;
 259         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 260 };
 261
 262 /*
 263 * nfs4_stateowner can either be an open_owner, or a lock_owner
 264 *
 265 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 266 *         for lock_owner
 267 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 268 *         for lock_owner
 269 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 270 *         struct is reaped.
 271 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 272 *         and is used to ensure no dangling nfs4_stateid references when we
 273 *         release a stateowner.
 274 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 275 *         close is called to reap associated byte-range locks
 276 *    so_close_lru: (open) stateowner is placed on this list instead of being
 277 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 278 *         reaped by laundramat thread after lease period.
 279 */
 280 struct nfs4_stateowner {
 281         struct kref             so_ref;
 282         struct list_head        so_idhash;   /* hash by so_id */
 283         struct list_head        so_strhash;   /* hash by op_name */
 284         struct list_head        so_perclient;
 285         struct list_head        so_stateids;
 286         struct list_head        so_perstateid; /* for lockowners only */
 287         struct list_head        so_close_lru; /* tail queue */
 288         time_t                  so_time; /* time of placement on so_close_lru */
 289         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 290         u32                     so_id;
 291         struct nfs4_client *    so_client;
 292         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 293          * sequence id expected from the client: */
 294         u32                     so_seqid;
 295         struct xdr_netobj       so_owner;     /* open owner name */
 296         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 297         struct nfs4_replay      so_replay;
 298 };
 299
 300 /*
 301 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 302 *    o fi_perfile list is used to search for conflicting
 303 *      share_acces, share_deny on the file.
 304 */
 305 struct nfs4_file {
 306         atomic_t                fi_ref;
 307         struct list_head        fi_hash;    /* hash by "struct inode *" */
 308         struct list_head        fi_stateids;
 309         struct list_head        fi_delegations;
 310         struct inode            *fi_inode;
 311         u32                     fi_id;      /* used with stateowner->so_id
 312                                              * for stateid_hashtbl hash */
 313         bool                    fi_had_conflict;
 314 };
 315
 316 /*
 317 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 318 *
 319 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 320 *
 321 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 322 *       st_perfile: file_hashtbl[] entry.
 323 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 324 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 325 *       st_access_bmap: used only for open stateid
 326 *       st_deny_bmap: used only for open stateid
 327 *       st_openstp: open stateid lock stateid was derived from
 328 *
 329 * XXX: open stateids and lock stateids have diverged sufficiently that
 330 * we should consider defining separate structs for the two cases.
 331 */
 332
 333 struct nfs4_stateid {
 334         struct list_head              st_hash;
 335         struct list_head              st_perfile;
 336         struct list_head              st_perstateowner;
 337         struct list_head              st_lockowners;
 338         struct nfs4_stateowner      * st_stateowner;
 339         struct nfs4_file            * st_file;
 340         stateid_t                     st_stateid;
 341         struct file                 * st_vfs_file;
 342         unsigned long                 st_access_bmap;
 343         unsigned long                 st_deny_bmap;
 344         struct nfs4_stateid         * st_openstp;
 345 };
 346
 347 /* flags for preprocess_seqid_op() */
 348 #define HAS_SESSION             0x00000001
 349 #define CONFIRM                 0x00000002
 350 #define OPEN_STATE              0x00000004
 351 #define LOCK_STATE              0x00000008
 352 #define RD_STATE                0x00000010
 353 #define WR_STATE                0x00000020
 354 #define CLOSE_STATE             0x00000040
 355
 356 #define seqid_mutating_err(err)                       \
 357         (((err) != nfserr_stale_clientid) &&    \
 358         ((err) != nfserr_bad_seqid) &&          \
 359         ((err) != nfserr_stale_stateid) &&      \
 360         ((err) != nfserr_bad_stateid))
 361
 362 struct nfsd4_compound_state;
 363
 364 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 365                 stateid_t *stateid, int flags, struct file **filp);
 366 extern void nfs4_lock_state(void);
 367 extern void nfs4_unlock_state(void);
 368 extern int nfs4_in_grace(void);
 369 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 370 extern void put_nfs4_client(struct nfs4_client *clp);
 371 extern void nfs4_free_stateowner(struct kref *kref);
 372 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 373 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 374 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 375 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 376 extern void nfsd4_init_recdir(char *recdir_name);
 377 extern int nfsd4_recdir_load(void);
 378 extern void nfsd4_shutdown_recdir(void);
 379 extern int nfs4_client_to_reclaim(const char *name);
 380 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 381 extern void nfsd4_recdir_purge_old(void);
 382 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 383 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 384
 385 static inline void
 386 nfs4_put_stateowner(struct nfs4_stateowner *so)
 387 {
 388         kref_put(&so->so_ref, nfs4_free_stateowner);
 389 }
 390
 391 static inline void
 392 nfs4_get_stateowner(struct nfs4_stateowner *so)
 393 {
 394         kref_get(&so->so_ref);
 395 }
 396
 397 #endif   /* NFSD4_STATE_H */