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 extern stateid_t zerostateid;
  65 extern stateid_t onestateid;
  66
  67 #define ZERO_STATEID(stateid)       (!memcmp((stateid), &zerostateid, sizeof(stateid_t)))
  68 #define ONE_STATEID(stateid)        (!memcmp((stateid), &onestateid, sizeof(stateid_t)))
  69
  70 struct nfs4_cb_recall {
  71         u32                     cbr_ident;
  72         int                     cbr_trunc;
  73         stateid_t               cbr_stateid;
  74         u32                     cbr_fhlen;
  75         u32                     cbr_fhval[NFS4_FHSIZE];
  76         struct nfs4_delegation  *cbr_dp;
  77 };
  78
  79 struct nfs4_delegation {
  80         struct list_head        dl_del_perfile; /* nfs4_file->fi_del_perfile */
  81         struct list_head        dl_del_perclnt; /* nfs4_client->cl_del_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         struct file_lock        *dl_flock;
  87         struct file             *dl_vfs_file;
  88         u32                     dl_type;
  89         time_t                  dl_time;
  90         struct nfs4_cb_recall   dl_recall;
  91 };
  92
  93 #define dl_stateid      dl_recall.cbr_stateid
  94 #define dl_fhlen        dl_recall.cbr_fhlen
  95 #define dl_fhval        dl_recall.cbr_fhval
  96
  97 /* client delegation callback info */
  98 struct nfs4_callback {
  99         /* SETCLIENTID info */
 100         u32                     cb_parsed;  /* addr parsed */
 101         u32                     cb_addr;
 102         unsigned short          cb_port;
 103         u32                     cb_prog;
 104         u32                     cb_ident;
 105         /* RPC client info */
 106         atomic_t                cb_set;     /* successful CB_NULL call */
 107         struct rpc_program      cb_program;
 108         struct rpc_stat         cb_stat;
 109         struct rpc_clnt *       cb_client;
 110 };
 111
 112 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 113
 114 /*
 115  * struct nfs4_client - one per client.  Clientids live here.
 116  *      o Each nfs4_client is hashed by clientid.
 117  *
 118  *      o Each nfs4_clients is also hashed by name
 119  *        (the opaque quantity initially sent by the client to identify itself).
 120  *
 121  *      o cl_perclient list is used to ensure no dangling stateowner references
 122  *        when we expire the nfs4_client
 123  */
 124 struct nfs4_client {
 125         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 126         struct list_head        cl_strhash;     /* hash by cl_name */
 127         struct list_head        cl_perclient;   /* list: stateowners */
 128         struct list_head        cl_del_perclnt; /* list: delegations */
 129         struct list_head        cl_lru;         /* tail queue */
 130         struct xdr_netobj       cl_name;        /* id generated by client */
 131         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 132         nfs4_verifier           cl_verifier;    /* generated by client */
 133         time_t                  cl_time;        /* time of last lease renewal */
 134         u32                     cl_addr;        /* client ipaddress */
 135         struct svc_cred         cl_cred;        /* setclientid principal */
 136         clientid_t              cl_clientid;    /* generated by server */
 137         nfs4_verifier           cl_confirm;     /* generated by server */
 138         struct nfs4_callback    cl_callback;    /* callback info */
 139         atomic_t                cl_count;       /* ref count */
 140 };
 141
 142 /* struct nfs4_client_reset
 143  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 144  * upon lease reset, or from upcall to state_daemon (to read in state
 145  * from non-volitile storage) upon reboot.
 146  */
 147 struct nfs4_client_reclaim {
 148         struct list_head        cr_strhash;     /* hash by cr_name */
 149         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 150 };
 151
 152 static inline void
 153 update_stateid(stateid_t *stateid)
 154 {
 155         stateid->si_generation++;
 156 }
 157
 158 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 159  * The OPEN response, typically the largest, requires
 160  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 161  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 162  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 163  */
 164
 165 #define NFSD4_REPLAY_ISIZE       112
 166
 167 /*
 168  * Replay buffer, where the result of the last seqid-mutating operation
 169  * is cached.
 170  */
 171 struct nfs4_replay {
 172         u32                     rp_status;
 173         unsigned int            rp_buflen;
 174         char                    *rp_buf;
 175         unsigned                intrp_allocated;
 176         int                     rp_openfh_len;
 177         char                    rp_openfh[NFS4_FHSIZE];
 178         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 179 };
 180
 181 /*
 182 * nfs4_stateowner can either be an open_owner, or a lock_owner
 183 *
 184 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 185 *         for lock_owner
 186 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 187 *         for lock_owner
 188 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 189 *         struct is reaped.
 190 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 191 *         and is used to ensure no dangling nfs4_stateid references when we
 192 *         release a stateowner.
 193 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 194 *         close is called to reap associated byte-range locks
 195 *    so_close_lru: (open) stateowner is placed on this list instead of being
 196 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 197 *         reaped by laundramat thread after lease period.
 198 */
 199 struct nfs4_stateowner {
 200         struct kref             so_ref;
 201         struct list_head        so_idhash;   /* hash by so_id */
 202         struct list_head        so_strhash;   /* hash by op_name */
 203         struct list_head        so_perclient; /* nfs4_client->cl_perclient */
 204         struct list_head        so_perfilestate; /* list: nfs4_stateid */
 205         struct list_head        so_perlockowner; /* nfs4_stateid->st_perlockowner */
 206         struct list_head        so_close_lru; /* tail queue */
 207         time_t                  so_time; /* time of placement on so_close_lru */
 208         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 209         u32                     so_id;
 210         struct nfs4_client *    so_client;
 211         u32                     so_seqid;
 212         struct xdr_netobj       so_owner;     /* open owner name */
 213         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 214         struct nfs4_replay      so_replay;
 215 };
 216
 217 /*
 218 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 219 *    o fi_perfile list is used to search for conflicting
 220 *      share_acces, share_deny on the file.
 221 */
 222 struct nfs4_file {
 223         struct kref             fi_ref;
 224         struct list_head        fi_hash;    /* hash by "struct inode *" */
 225         struct list_head        fi_stateids;
 226         struct list_head        fi_delegations;
 227         struct inode            *fi_inode;
 228         u32                     fi_id;      /* used with stateowner->so_id
 229                                              * for stateid_hashtbl hash */
 230 };
 231
 232 /*
 233 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 234 *
 235 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 236 *
 237 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 238 *       st_perfile: file_hashtbl[] entry.
 239 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 240 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 241 *       st_access_bmap: used only for open stateid
 242 *       st_deny_bmap: used only for open stateid
 243 */
 244
 245 struct nfs4_stateid {
 246         struct list_head              st_hash;
 247         struct list_head              st_perfile;
 248         struct list_head              st_perfilestate;
 249         struct list_head              st_perlockowner;
 250         struct nfs4_stateowner      * st_stateowner;
 251         struct nfs4_file            * st_file;
 252         stateid_t                     st_stateid;
 253         struct file                 * st_vfs_file;
 254         unsigned long                 st_access_bmap;
 255         unsigned long                 st_deny_bmap;
 256 };
 257
 258 /* flags for preprocess_seqid_op() */
 259 #define CHECK_FH                0x00000001
 260 #define CONFIRM                 0x00000002
 261 #define OPEN_STATE              0x00000004
 262 #define LOCK_STATE              0x00000008
 263 #define RD_STATE                0x00000010
 264 #define WR_STATE                0x00000020
 265 #define CLOSE_STATE             0x00000040
 266 #define DELEG_RET               0x00000080
 267
 268 #define seqid_mutating_err(err)                       \
 269         (((err) != nfserr_stale_clientid) &&    \
 270         ((err) != nfserr_bad_seqid) &&          \
 271         ((err) != nfserr_stale_stateid) &&      \
 272         ((err) != nfserr_bad_stateid))
 273
 274 extern time_t nfs4_laundromat(void);
 275 extern int nfsd4_renew(clientid_t *clid);
 276 extern int nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
 277                 stateid_t *stateid, int flags, struct file **filp);
 278 extern int nfs4_share_conflict(struct svc_fh *current_fh,
 279                 unsigned int deny_type);
 280 extern void nfs4_lock_state(void);
 281 extern void nfs4_unlock_state(void);
 282 extern int nfs4_in_grace(void);
 283 extern int nfs4_check_open_reclaim(clientid_t *clid);
 284 extern void put_nfs4_client(struct nfs4_client *clp);
 285 extern void nfs4_free_stateowner(struct kref *kref);
 286 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 287 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 288 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 289 extern int nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 290
 291 static inline void
 292 nfs4_put_stateowner(struct nfs4_stateowner *so)
 293 {
 294         kref_put(&so->so_ref, nfs4_free_stateowner);
 295 }
 296
 297 static inline void
 298 nfs4_get_stateowner(struct nfs4_stateowner *so)
 299 {
 300         kref_get(&so->so_ref);
 301 }
 302
 303 #endif   /* NFSD4_STATE_H */