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