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