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/sunrpc/clnt.h>
  42
  43 #define NFS4_OPAQUE_LIMIT 1024
  44 typedef struct {
  45         u32             cl_boot;
  46         u32             cl_id;
  47 } clientid_t;
  48
  49 typedef struct {
  50         u32             so_boot;
  51         u32             so_stateownerid;
  52         u32             so_fileid;
  53 } stateid_opaque_t;
  54
  55 typedef struct {
  56         u32                     si_generation;
  57         stateid_opaque_t        si_opaque;
  58 } stateid_t;
  59 #define si_boot           si_opaque.so_boot
  60 #define si_stateownerid   si_opaque.so_stateownerid
  61 #define si_fileid         si_opaque.so_fileid
  62
  63 extern stateid_t zerostateid;
  64 extern stateid_t onestateid;
  65
  66 #define ZERO_STATEID(stateid)       (!memcmp((stateid), &zerostateid, sizeof(stateid_t)))
  67 #define ONE_STATEID(stateid)        (!memcmp((stateid), &onestateid, sizeof(stateid_t)))
  68
  69 /* client delegation callback info */
  70 struct nfs4_callback {
  71         /* SETCLIENTID info */
  72         u32                     cb_parsed;  /* addr parsed */
  73         u32                     cb_addr;
  74         unsigned short          cb_port;
  75         u32                     cb_prog;
  76         u32                     cb_ident;
  77         struct xdr_netobj       cb_netid;
  78         /* RPC client info */
  79         u32                     cb_set;     /* successful CB_NULL call */
  80         struct rpc_program      cb_program;
  81         struct rpc_stat         cb_stat;
  82         struct rpc_clnt *       cb_client;
  83 };
  84
  85 /*
  86  * struct nfs4_client - one per client.  Clientids live here.
  87  *      o Each nfs4_client is hashed by clientid.
  88  *
  89  *      o Each nfs4_clients is also hashed by name
  90  *        (the opaque quantity initially sent by the client to identify itself).
  91  *
  92  *      o cl_perclient list is used to ensure no dangling stateowner references
  93  *        when we expire the nfs4_client
  94  */
  95 struct nfs4_client {
  96         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
  97         struct list_head        cl_strhash;     /* hash by cl_name */
  98         struct list_head        cl_perclient;   /* list: stateowners */
  99         struct list_head        cl_lru;         /* tail queue */
 100         struct xdr_netobj       cl_name;        /* id generated by client */
 101         nfs4_verifier           cl_verifier;    /* generated by client */
 102         time_t                  cl_time;        /* time of last lease renewal */
 103         u32                     cl_addr;        /* client ipaddress */
 104         struct svc_cred         cl_cred;        /* setclientid principal */
 105         clientid_t              cl_clientid;    /* generated by server */
 106         nfs4_verifier           cl_confirm;     /* generated by server */
 107         struct nfs4_callback    cl_callback;    /* callback info */
 108         time_t                  cl_first_state; /* first state aquisition*/
 109 };
 110
 111 /* struct nfs4_client_reset
 112  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 113  * upon lease reset, or from upcall to state_daemon (to read in state
 114  * from non-volitile storage) upon reboot.
 115  */
 116 struct nfs4_client_reclaim {
 117         struct list_head        cr_strhash;     /* hash by cr_name */
 118         struct xdr_netobj       cr_name;        /* id generated by client */
 119         time_t                  cr_first_state; /* first state aquisition */
 120         u32                     cr_expired;     /* boolean: lease expired? */
 121 };
 122
 123 static inline void
 124 update_stateid(stateid_t *stateid)
 125 {
 126         stateid->si_generation++;
 127 }
 128
 129 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 130  * The OPEN response, typically the largest, requires
 131  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 132  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 133  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 134  */
 135
 136 #define NFSD4_REPLAY_ISIZE       112
 137
 138 /*
 139  * Replay buffer, where the result of the last seqid-mutating operation
 140  * is cached.
 141  */
 142 struct nfs4_replay {
 143         u32                     rp_status;
 144         unsigned int            rp_buflen;
 145         char                    *rp_buf;
 146         unsigned                intrp_allocated;
 147         int                     rp_openfh_len;
 148         char                    rp_openfh[NFS4_FHSIZE];
 149         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 150 };
 151
 152 /*
 153 * nfs4_stateowner can either be an open_owner, or a lock_owner
 154 *
 155 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 156 *         for lock_owner
 157 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 158 *         for lock_owner
 159 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 160 *         struct is reaped.
 161 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 162 *         and is used to ensure no dangling nfs4_stateid references when we
 163 *         release a stateowner.
 164 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 165 *         close is called to reap associated byte-range locks
 166 *    so_close_lru: (open) stateowner is placed on this list instead of being
 167 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 168 *         reaped by laundramat thread after lease period.
 169 */
 170 struct nfs4_stateowner {
 171         struct list_head        so_idhash;   /* hash by so_id */
 172         struct list_head        so_strhash;   /* hash by op_name */
 173         struct list_head        so_perclient; /* nfs4_client->cl_perclient */
 174         struct list_head        so_perfilestate; /* list: nfs4_stateid */
 175         struct list_head        so_perlockowner; /* nfs4_stateid->st_perlockowner */
 176         struct list_head        so_close_lru; /* tail queue */
 177         time_t                  so_time; /* time of placement on so_close_lru */
 178         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 179         u32                     so_id;
 180         struct nfs4_client *    so_client;
 181         u32                     so_seqid;
 182         struct xdr_netobj       so_owner;     /* open owner name */
 183         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 184         struct nfs4_replay      so_replay;
 185 };
 186
 187 /*
 188 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 189 *    o fi_perfile list is used to search for conflicting
 190 *      share_acces, share_deny on the file.
 191 */
 192 struct nfs4_file {
 193         struct list_head        fi_hash;    /* hash by "struct inode *" */
 194         struct list_head        fi_perfile; /* list: nfs4_stateid */
 195         struct inode            *fi_inode;
 196         u32                     fi_id;      /* used with stateowner->so_id
 197                                              * for stateid_hashtbl hash */
 198 };
 199
 200 /*
 201 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 202 *
 203 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 204 *
 205 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 206 *       st_perfile: file_hashtbl[] entry.
 207 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 208 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 209 *       st_access_bmap: used only for open stateid
 210 *       st_deny_bmap: used only for open stateid
 211 */
 212
 213 struct nfs4_stateid {
 214         struct list_head              st_hash;
 215         struct list_head              st_perfile;
 216         struct list_head              st_perfilestate;
 217         struct list_head              st_perlockowner;
 218         struct nfs4_stateowner      * st_stateowner;
 219         struct nfs4_file            * st_file;
 220         stateid_t                     st_stateid;
 221         struct file                   st_vfs_file;
 222         int                           st_vfs_set;
 223         unsigned long                 st_access_bmap;
 224         unsigned long                 st_deny_bmap;
 225 };
 226
 227 /* flags for preprocess_seqid_op() */
 228 #define CHECK_FH                0x00000001
 229 #define CONFIRM                 0x00000002
 230 #define OPEN_STATE              0x00000004
 231 #define LOCK_STATE              0x00000008
 232 #define RDWR_STATE              0x00000010
 233 #define CLOSE_STATE             0x00000020
 234
 235 #define seqid_mutating_err(err)                       \
 236         (((err) != nfserr_stale_clientid) &&    \
 237         ((err) != nfserr_bad_seqid) &&          \
 238         ((err) != nfserr_stale_stateid) &&      \
 239         ((err) != nfserr_bad_stateid))
 240
 241 extern time_t nfs4_laundromat(void);
 242 extern int nfsd4_renew(clientid_t *clid);
 243 extern int nfs4_preprocess_stateid_op(struct svc_fh *current_fh,
 244                 stateid_t *stateid, int flags, struct nfs4_stateid **stpp);
 245 extern int nfs4_share_conflict(struct svc_fh *current_fh,
 246                 unsigned int deny_type);
 247 extern void nfs4_lock_state(void);
 248 extern void nfs4_unlock_state(void);
 249 extern int nfs4_in_grace(void);
 250 extern int nfs4_check_open_reclaim(clientid_t *clid);
 251 #endif   /* NFSD4_STATE_H */