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/sunrpc/svc_xprt.h>
  39 #include <linux/nfsd/nfsfh.h>
  40 #include "nfsfh.h"
  41
  42 typedef struct {
  43         u32             cl_boot;
  44         u32             cl_id;
  45 } clientid_t;
  46
  47 typedef struct {
  48         clientid_t      so_clid;
  49         u32             so_id;
  50 } stateid_opaque_t;
  51
  52 typedef struct {
  53         u32                     si_generation;
  54         stateid_opaque_t        si_opaque;
  55 } stateid_t;
  56
  57 #define STATEID_FMT     "(%08x/%08x/%08x/%08x)"
  58 #define STATEID_VAL(s) \
  59         (s)->si_opaque.so_clid.cl_boot, \
  60         (s)->si_opaque.so_clid.cl_id, \
  61         (s)->si_opaque.so_id, \
  62         (s)->si_generation
  63
  64 struct nfsd4_callback {
  65         void *cb_op;
  66         struct nfs4_client *cb_clp;
  67         struct list_head cb_per_client;
  68         u32 cb_minorversion;
  69         struct rpc_message cb_msg;
  70         const struct rpc_call_ops *cb_ops;
  71         struct work_struct cb_work;
  72         bool cb_done;
  73 };
  74
  75 struct nfs4_stid {
  76 #define NFS4_OPEN_STID 1
  77 #define NFS4_LOCK_STID 2
  78 #define NFS4_DELEG_STID 4
  79 /* For an open stateid kept around *only* to process close replays: */
  80 #define NFS4_CLOSED_STID 8
  81         unsigned char sc_type;
  82         struct list_head sc_hash;
  83         stateid_t sc_stateid;
  84         struct nfs4_client *sc_client;
  85 };
  86
  87 struct nfs4_delegation {
  88         struct list_head        dl_perfile;
  89         struct list_head        dl_perclnt;
  90         struct list_head        dl_recall_lru;  /* delegation recalled */
  91         atomic_t                dl_count;       /* ref count */
  92         struct nfs4_file        *dl_file;
  93         u32                     dl_type;
  94         time_t                  dl_time;
  95 /* For recall: */
  96         struct nfs4_stid        dl_stid;
  97         struct knfsd_fh         dl_fh;
  98         int                     dl_retries;
  99         struct nfsd4_callback   dl_recall;
 100 };
 101
 102 /* client delegation callback info */
 103 struct nfs4_cb_conn {
 104         /* SETCLIENTID info */
 105         struct sockaddr_storage cb_addr;
 106         struct sockaddr_storage cb_saddr;
 107         size_t                  cb_addrlen;
 108         u32                     cb_prog; /* used only in 4.0 case;
 109                                             per-session otherwise */
 110         u32                     cb_ident;       /* minorversion 0 only */
 111         struct svc_xprt         *cb_xprt;       /* minorversion 1 only */
 112 };
 113
 114 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
 115 {
 116         return container_of(s, struct nfs4_delegation, dl_stid);
 117 }
 118
 119 /* Maximum number of slots per session. 160 is useful for long haul TCP */
 120 #define NFSD_MAX_SLOTS_PER_SESSION     160
 121 /* Maximum number of operations per session compound */
 122 #define NFSD_MAX_OPS_PER_COMPOUND       16
 123 /* Maximum  session per slot cache size */
 124 #define NFSD_SLOT_CACHE_SIZE            1024
 125 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 126 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 127 #define NFSD_MAX_MEM_PER_SESSION  \
 128                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 129
 130 struct nfsd4_slot {
 131         bool    sl_inuse;
 132         bool    sl_cachethis;
 133         u16     sl_opcnt;
 134         u32     sl_seqid;
 135         __be32  sl_status;
 136         u32     sl_datalen;
 137         char    sl_data[];
 138 };
 139
 140 struct nfsd4_channel_attrs {
 141         u32             headerpadsz;
 142         u32             maxreq_sz;
 143         u32             maxresp_sz;
 144         u32             maxresp_cached;
 145         u32             maxops;
 146         u32             maxreqs;
 147         u32             nr_rdma_attrs;
 148         u32             rdma_attrs;
 149 };
 150
 151 struct nfsd4_create_session {
 152         clientid_t                      clientid;
 153         struct nfs4_sessionid           sessionid;
 154         u32                             seqid;
 155         u32                             flags;
 156         struct nfsd4_channel_attrs      fore_channel;
 157         struct nfsd4_channel_attrs      back_channel;
 158         u32                             callback_prog;
 159         u32                             uid;
 160         u32                             gid;
 161 };
 162
 163 struct nfsd4_bind_conn_to_session {
 164         struct nfs4_sessionid           sessionid;
 165         u32                             dir;
 166 };
 167
 168 /* The single slot clientid cache structure */
 169 struct nfsd4_clid_slot {
 170         u32                             sl_seqid;
 171         __be32                          sl_status;
 172         struct nfsd4_create_session     sl_cr_ses;
 173 };
 174
 175 struct nfsd4_conn {
 176         struct list_head cn_persession;
 177         struct svc_xprt *cn_xprt;
 178         struct svc_xpt_user cn_xpt_user;
 179         struct nfsd4_session *cn_session;
 180 /* CDFC4_FORE, CDFC4_BACK: */
 181         unsigned char cn_flags;
 182 };
 183
 184 struct nfsd4_session {
 185         struct kref             se_ref;
 186         struct list_head        se_hash;        /* hash by sessionid */
 187         struct list_head        se_perclnt;
 188         u32                     se_flags;
 189         struct nfs4_client      *se_client;
 190         struct nfs4_sessionid   se_sessionid;
 191         struct nfsd4_channel_attrs se_fchannel;
 192         struct nfsd4_channel_attrs se_bchannel;
 193         struct list_head        se_conns;
 194         u32                     se_cb_prog;
 195         u32                     se_cb_seq_nr;
 196         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 197 };
 198
 199 static inline void
 200 nfsd4_put_session(struct nfsd4_session *ses)
 201 {
 202         extern void free_session(struct kref *kref);
 203         kref_put(&ses->se_ref, free_session);
 204 }
 205
 206 static inline void
 207 nfsd4_get_session(struct nfsd4_session *ses)
 208 {
 209         kref_get(&ses->se_ref);
 210 }
 211
 212 /* formatted contents of nfs4_sessionid */
 213 struct nfsd4_sessionid {
 214         clientid_t      clientid;
 215         u32             sequence;
 216         u32             reserved;
 217 };
 218
 219 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 220
 221 /*
 222  * struct nfs4_client - one per client.  Clientids live here.
 223  *      o Each nfs4_client is hashed by clientid.
 224  *
 225  *      o Each nfs4_clients is also hashed by name
 226  *        (the opaque quantity initially sent by the client to identify itself).
 227  *
 228  *      o cl_perclient list is used to ensure no dangling stateowner references
 229  *        when we expire the nfs4_client
 230  */
 231 struct nfs4_client {
 232         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 233         struct list_head        cl_strhash;     /* hash by cl_name */
 234         struct list_head        cl_openowners;
 235         struct list_head        cl_delegations;
 236         struct list_head        cl_lru;         /* tail queue */
 237         struct xdr_netobj       cl_name;        /* id generated by client */
 238         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 239         nfs4_verifier           cl_verifier;    /* generated by client */
 240         time_t                  cl_time;        /* time of last lease renewal */
 241         struct sockaddr_storage cl_addr;        /* client ipaddress */
 242         u32                     cl_flavor;      /* setclientid pseudoflavor */
 243         char                    *cl_principal;  /* setclientid principal name */
 244         struct svc_cred         cl_cred;        /* setclientid principal */
 245         clientid_t              cl_clientid;    /* generated by server */
 246         nfs4_verifier           cl_confirm;     /* generated by server */
 247         u32                     cl_firststate;  /* recovery dir creation */
 248         u32                     cl_minorversion;
 249
 250         /* for v4.0 and v4.1 callbacks: */
 251         struct nfs4_cb_conn     cl_cb_conn;
 252 #define NFSD4_CLIENT_CB_UPDATE  1
 253 #define NFSD4_CLIENT_KILL       2
 254         unsigned long           cl_cb_flags;
 255         struct rpc_clnt         *cl_cb_client;
 256         u32                     cl_cb_ident;
 257 #define NFSD4_CB_UP             0
 258 #define NFSD4_CB_UNKNOWN        1
 259 #define NFSD4_CB_DOWN           2
 260         int                     cl_cb_state;
 261         struct nfsd4_callback   cl_cb_null;
 262         struct nfsd4_session    *cl_cb_session;
 263         struct list_head        cl_callbacks; /* list of in-progress callbacks */
 264
 265         /* for all client information that callback code might need: */
 266         spinlock_t              cl_lock;
 267
 268         /* for nfs41 */
 269         struct list_head        cl_sessions;
 270         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 271         u32                     cl_exchange_flags;
 272         /* number of rpc's in progress over an associated session: */
 273         atomic_t                cl_refcount;
 274
 275         /* for nfs41 callbacks */
 276         /* We currently support a single back channel with a single slot */
 277         unsigned long           cl_cb_slot_busy;
 278         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 279                                                 /* wait here for slots */
 280 };
 281
 282 static inline void
 283 mark_client_expired(struct nfs4_client *clp)
 284 {
 285         clp->cl_time = 0;
 286 }
 287
 288 static inline bool
 289 is_client_expired(struct nfs4_client *clp)
 290 {
 291         return clp->cl_time == 0;
 292 }
 293
 294 /* struct nfs4_client_reset
 295  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 296  * upon lease reset, or from upcall to state_daemon (to read in state
 297  * from non-volitile storage) upon reboot.
 298  */
 299 struct nfs4_client_reclaim {
 300         struct list_head        cr_strhash;     /* hash by cr_name */
 301         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 302 };
 303
 304 static inline void
 305 update_stateid(stateid_t *stateid)
 306 {
 307         stateid->si_generation++;
 308         /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
 309         if (stateid->si_generation == 0)
 310                 stateid->si_generation = 1;
 311 }
 312
 313 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 314  * The OPEN response, typically the largest, requires
 315  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 316  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 317  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 318  */
 319
 320 #define NFSD4_REPLAY_ISIZE       112
 321
 322 /*
 323  * Replay buffer, where the result of the last seqid-mutating operation
 324  * is cached.
 325  */
 326 struct nfs4_replay {
 327         __be32                  rp_status;
 328         unsigned int            rp_buflen;
 329         char                    *rp_buf;
 330         struct knfsd_fh         rp_openfh;
 331         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 332 };
 333
 334 /*
 335 * nfs4_stateowner can either be an open_owner, or a lock_owner
 336 *
 337 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 338 *         for lock_owner
 339 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 340 *         for lock_owner
 341 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 342 *         struct is reaped.
 343 *    so_perfilestate: heads the list of nfs4_ol_stateid (either open or lock)
 344 *         and is used to ensure no dangling nfs4_ol_stateid references when we
 345 *         release a stateowner.
 346 *    so_perlockowner: (open) nfs4_ol_stateid->st_perlockowner entry - used when
 347 *         close is called to reap associated byte-range locks
 348 *    so_close_lru: (open) stateowner is placed on this list instead of being
 349 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 350 *         reaped by laundramat thread after lease period.
 351 */
 352
 353 struct nfs4_stateowner {
 354         struct list_head        so_strhash;   /* hash by op_name */
 355         struct list_head        so_stateids;
 356         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 357         struct nfs4_client *    so_client;
 358         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 359          * sequence id expected from the client: */
 360         u32                     so_seqid;
 361         struct xdr_netobj       so_owner;     /* open owner name */
 362         struct nfs4_replay      so_replay;
 363 };
 364
 365 struct nfs4_openowner {
 366         struct nfs4_stateowner  oo_owner; /* must be first field */
 367         struct list_head        oo_perclient;
 368         struct list_head        oo_close_lru; /* tail queue */
 369         struct nfs4_ol_stateid *oo_last_closed_stid;
 370         time_t                  oo_time; /* time of placement on so_close_lru */
 371 #define NFS4_OO_CONFIRMED   1
 372 #define NFS4_OO_PURGE_CLOSE 2
 373         unsigned char           oo_flags;
 374 };
 375
 376 struct nfs4_lockowner {
 377         struct nfs4_stateowner  lo_owner; /* must be first element */
 378         struct list_head        lo_perstateid; /* for lockowners only */
 379         struct list_head        lo_list; /* for temporary uses */
 380 };
 381
 382 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
 383 {
 384         return container_of(so, struct nfs4_openowner, oo_owner);
 385 }
 386
 387 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
 388 {
 389         return container_of(so, struct nfs4_lockowner, lo_owner);
 390 }
 391
 392 /*
 393 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 394 *    o fi_perfile list is used to search for conflicting
 395 *      share_acces, share_deny on the file.
 396 */
 397 struct nfs4_file {
 398         atomic_t                fi_ref;
 399         struct list_head        fi_hash;    /* hash by "struct inode *" */
 400         struct list_head        fi_stateids;
 401         struct list_head        fi_delegations;
 402         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 403         struct file *           fi_fds[3];
 404         /*
 405          * Each open or lock stateid contributes 1 to either
 406          * fi_access[O_RDONLY], fi_access[O_WRONLY], or both, depending
 407          * on open or lock mode:
 408          */
 409         atomic_t                fi_access[2];
 410         struct file             *fi_deleg_file;
 411         struct file_lock        *fi_lease;
 412         atomic_t                fi_delegees;
 413         struct inode            *fi_inode;
 414         bool                    fi_had_conflict;
 415 };
 416
 417 /* XXX: for first cut may fall back on returning file that doesn't work
 418  * at all? */
 419 static inline struct file *find_writeable_file(struct nfs4_file *f)
 420 {
 421         if (f->fi_fds[O_WRONLY])
 422                 return f->fi_fds[O_WRONLY];
 423         return f->fi_fds[O_RDWR];
 424 }
 425
 426 static inline struct file *find_readable_file(struct nfs4_file *f)
 427 {
 428         if (f->fi_fds[O_RDONLY])
 429                 return f->fi_fds[O_RDONLY];
 430         return f->fi_fds[O_RDWR];
 431 }
 432
 433 static inline struct file *find_any_file(struct nfs4_file *f)
 434 {
 435         if (f->fi_fds[O_RDWR])
 436                 return f->fi_fds[O_RDWR];
 437         else if (f->fi_fds[O_WRONLY])
 438                 return f->fi_fds[O_WRONLY];
 439         else
 440                 return f->fi_fds[O_RDONLY];
 441 }
 442
 443 /*
 444 * nfs4_ol_stateid can either be an open stateid or (eventually) a lock stateid
 445 *
 446 * (open)nfs4_ol_stateid: one per (open)nfs4_stateowner, nfs4_file
 447 *
 448 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 449 *       st_perfile: file_hashtbl[] entry.
 450 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 451 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 452 *       st_access_bmap: used only for open stateid
 453 *       st_deny_bmap: used only for open stateid
 454 *       st_openstp: open stateid lock stateid was derived from
 455 *
 456 * XXX: open stateids and lock stateids have diverged sufficiently that
 457 * we should consider defining separate structs for the two cases.
 458 */
 459
 460 /* "ol" stands for "Open or Lock".  Better suggestions welcome. */
 461 struct nfs4_ol_stateid {
 462         struct nfs4_stid    st_stid;
 463         struct list_head              st_perfile;
 464         struct list_head              st_perstateowner;
 465         struct list_head              st_lockowners;
 466         struct nfs4_stateowner      * st_stateowner;
 467         struct nfs4_file            * st_file;
 468         unsigned long                 st_access_bmap;
 469         unsigned long                 st_deny_bmap;
 470         struct nfs4_ol_stateid         * st_openstp;
 471 };
 472
 473 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
 474 {
 475         return container_of(s, struct nfs4_ol_stateid, st_stid);
 476 }
 477
 478 /* flags for preprocess_seqid_op() */
 479 #define RD_STATE                0x00000010
 480 #define WR_STATE                0x00000020
 481
 482 struct nfsd4_compound_state;
 483
 484 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 485                 stateid_t *stateid, int flags, struct file **filp);
 486 extern void nfs4_lock_state(void);
 487 extern void nfs4_unlock_state(void);
 488 extern int nfs4_in_grace(void);
 489 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 490 extern void nfs4_free_openowner(struct nfs4_openowner *);
 491 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
 492 extern int set_callback_cred(void);
 493 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 494 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
 495 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 496 extern void nfsd4_do_callback_rpc(struct work_struct *);
 497 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 498 extern int nfsd4_create_callback_queue(void);
 499 extern void nfsd4_destroy_callback_queue(void);
 500 extern void nfsd4_shutdown_callback(struct nfs4_client *);
 501 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 502 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 503 extern void nfsd4_init_recdir(void);
 504 extern int nfsd4_recdir_load(void);
 505 extern void nfsd4_shutdown_recdir(void);
 506 extern int nfs4_client_to_reclaim(const char *name);
 507 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 508 extern void nfsd4_recdir_purge_old(void);
 509 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 510 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 511 extern void release_session_client(struct nfsd4_session *);
 512 extern __be32 nfs4_validate_stateid(stateid_t *, bool);
 513 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
 514
 515 #endif   /* NFSD4_STATE_H */