state.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:11k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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