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