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