state.h 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659
  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. #ifndef _NFSD4_STATE_H
  35. #define _NFSD4_STATE_H
  36. #include <linux/idr.h>
  37. #include <linux/sunrpc/svc_xprt.h>
  38. #include "nfsfh.h"
  39. typedef struct {
  40. u32 cl_boot;
  41. u32 cl_id;
  42. } clientid_t;
  43. typedef struct {
  44. clientid_t so_clid;
  45. u32 so_id;
  46. } stateid_opaque_t;
  47. typedef struct {
  48. u32 si_generation;
  49. stateid_opaque_t si_opaque;
  50. } stateid_t;
  51. #define STATEID_FMT "(%08x/%08x/%08x/%08x)"
  52. #define STATEID_VAL(s) \
  53. (s)->si_opaque.so_clid.cl_boot, \
  54. (s)->si_opaque.so_clid.cl_id, \
  55. (s)->si_opaque.so_id, \
  56. (s)->si_generation
  57. struct nfsd4_callback {
  58. struct nfs4_client *cb_clp;
  59. u32 cb_minorversion;
  60. struct rpc_message cb_msg;
  61. struct nfsd4_callback_ops *cb_ops;
  62. struct work_struct cb_work;
  63. int cb_seq_status;
  64. int cb_status;
  65. bool cb_need_restart;
  66. };
  67. struct nfsd4_callback_ops {
  68. void (*prepare)(struct nfsd4_callback *);
  69. int (*done)(struct nfsd4_callback *, struct rpc_task *);
  70. void (*release)(struct nfsd4_callback *);
  71. };
  72. /*
  73. * A core object that represents a "common" stateid. These are generally
  74. * embedded within the different (more specific) stateid objects and contain
  75. * fields that are of general use to any stateid.
  76. */
  77. struct nfs4_stid {
  78. atomic_t sc_count;
  79. #define NFS4_OPEN_STID 1
  80. #define NFS4_LOCK_STID 2
  81. #define NFS4_DELEG_STID 4
  82. /* For an open stateid kept around *only* to process close replays: */
  83. #define NFS4_CLOSED_STID 8
  84. /* For a deleg stateid kept around only to process free_stateid's: */
  85. #define NFS4_REVOKED_DELEG_STID 16
  86. #define NFS4_CLOSED_DELEG_STID 32
  87. #define NFS4_LAYOUT_STID 64
  88. unsigned char sc_type;
  89. stateid_t sc_stateid;
  90. spinlock_t sc_lock;
  91. struct nfs4_client *sc_client;
  92. struct nfs4_file *sc_file;
  93. void (*sc_free)(struct nfs4_stid *);
  94. };
  95. /*
  96. * Represents a delegation stateid. The nfs4_client holds references to these
  97. * and they are put when it is being destroyed or when the delegation is
  98. * returned by the client:
  99. *
  100. * o 1 reference as long as a delegation is still in force (taken when it's
  101. * alloc'd, put when it's returned or revoked)
  102. *
  103. * o 1 reference as long as a recall rpc is in progress (taken when the lease
  104. * is broken, put when the rpc exits)
  105. *
  106. * o 1 more ephemeral reference for each nfsd thread currently doing something
  107. * with that delegation without holding the cl_lock
  108. *
  109. * If the server attempts to recall a delegation and the client doesn't do so
  110. * before a timeout, the server may also revoke the delegation. In that case,
  111. * the object will either be destroyed (v4.0) or moved to a per-client list of
  112. * revoked delegations (v4.1+).
  113. *
  114. * This object is a superset of the nfs4_stid.
  115. */
  116. struct nfs4_delegation {
  117. struct nfs4_stid dl_stid; /* must be first field */
  118. struct list_head dl_perfile;
  119. struct list_head dl_perclnt;
  120. struct list_head dl_recall_lru; /* delegation recalled */
  121. struct nfs4_clnt_odstate *dl_clnt_odstate;
  122. u32 dl_type;
  123. time_t dl_time;
  124. /* For recall: */
  125. int dl_retries;
  126. struct nfsd4_callback dl_recall;
  127. };
  128. #define cb_to_delegation(cb) \
  129. container_of(cb, struct nfs4_delegation, dl_recall)
  130. /* client delegation callback info */
  131. struct nfs4_cb_conn {
  132. /* SETCLIENTID info */
  133. struct sockaddr_storage cb_addr;
  134. struct sockaddr_storage cb_saddr;
  135. size_t cb_addrlen;
  136. u32 cb_prog; /* used only in 4.0 case;
  137. per-session otherwise */
  138. u32 cb_ident; /* minorversion 0 only */
  139. struct svc_xprt *cb_xprt; /* minorversion 1 only */
  140. };
  141. static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
  142. {
  143. return container_of(s, struct nfs4_delegation, dl_stid);
  144. }
  145. /* Maximum number of slots per session. 160 is useful for long haul TCP */
  146. #define NFSD_MAX_SLOTS_PER_SESSION 160
  147. /* Maximum number of operations per session compound */
  148. #define NFSD_MAX_OPS_PER_COMPOUND 16
  149. /* Maximum session per slot cache size */
  150. #define NFSD_SLOT_CACHE_SIZE 2048
  151. /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
  152. #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
  153. #define NFSD_MAX_MEM_PER_SESSION \
  154. (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
  155. struct nfsd4_slot {
  156. u32 sl_seqid;
  157. __be32 sl_status;
  158. u32 sl_datalen;
  159. u16 sl_opcnt;
  160. #define NFSD4_SLOT_INUSE (1 << 0)
  161. #define NFSD4_SLOT_CACHETHIS (1 << 1)
  162. #define NFSD4_SLOT_INITIALIZED (1 << 2)
  163. u8 sl_flags;
  164. char sl_data[];
  165. };
  166. struct nfsd4_channel_attrs {
  167. u32 headerpadsz;
  168. u32 maxreq_sz;
  169. u32 maxresp_sz;
  170. u32 maxresp_cached;
  171. u32 maxops;
  172. u32 maxreqs;
  173. u32 nr_rdma_attrs;
  174. u32 rdma_attrs;
  175. };
  176. struct nfsd4_cb_sec {
  177. u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
  178. kuid_t uid;
  179. kgid_t gid;
  180. };
  181. struct nfsd4_create_session {
  182. clientid_t clientid;
  183. struct nfs4_sessionid sessionid;
  184. u32 seqid;
  185. u32 flags;
  186. struct nfsd4_channel_attrs fore_channel;
  187. struct nfsd4_channel_attrs back_channel;
  188. u32 callback_prog;
  189. struct nfsd4_cb_sec cb_sec;
  190. };
  191. struct nfsd4_backchannel_ctl {
  192. u32 bc_cb_program;
  193. struct nfsd4_cb_sec bc_cb_sec;
  194. };
  195. struct nfsd4_bind_conn_to_session {
  196. struct nfs4_sessionid sessionid;
  197. u32 dir;
  198. };
  199. /* The single slot clientid cache structure */
  200. struct nfsd4_clid_slot {
  201. u32 sl_seqid;
  202. __be32 sl_status;
  203. struct nfsd4_create_session sl_cr_ses;
  204. };
  205. struct nfsd4_conn {
  206. struct list_head cn_persession;
  207. struct svc_xprt *cn_xprt;
  208. struct svc_xpt_user cn_xpt_user;
  209. struct nfsd4_session *cn_session;
  210. /* CDFC4_FORE, CDFC4_BACK: */
  211. unsigned char cn_flags;
  212. };
  213. /*
  214. * Representation of a v4.1+ session. These are refcounted in a similar fashion
  215. * to the nfs4_client. References are only taken when the server is actively
  216. * working on the object (primarily during the processing of compounds).
  217. */
  218. struct nfsd4_session {
  219. atomic_t se_ref;
  220. struct list_head se_hash; /* hash by sessionid */
  221. struct list_head se_perclnt;
  222. /* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
  223. #define NFS4_SESSION_DEAD 0x010
  224. u32 se_flags;
  225. struct nfs4_client *se_client;
  226. struct nfs4_sessionid se_sessionid;
  227. struct nfsd4_channel_attrs se_fchannel;
  228. struct nfsd4_channel_attrs se_bchannel;
  229. struct nfsd4_cb_sec se_cb_sec;
  230. struct list_head se_conns;
  231. u32 se_cb_prog;
  232. u32 se_cb_seq_nr;
  233. struct nfsd4_slot *se_slots[]; /* forward channel slots */
  234. };
  235. /* formatted contents of nfs4_sessionid */
  236. struct nfsd4_sessionid {
  237. clientid_t clientid;
  238. u32 sequence;
  239. u32 reserved;
  240. };
  241. #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
  242. /*
  243. * struct nfs4_client - one per client. Clientids live here.
  244. *
  245. * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
  246. * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
  247. * Each nfsd_net_ns object contains a set of these and they are tracked via
  248. * short and long form clientid. They are hashed and searched for under the
  249. * per-nfsd_net client_lock spinlock.
  250. *
  251. * References to it are only held during the processing of compounds, and in
  252. * certain other operations. In their "resting state" they have a refcount of
  253. * 0. If they are not renewed within a lease period, they become eligible for
  254. * destruction by the laundromat.
  255. *
  256. * These objects can also be destroyed prematurely by the fault injection code,
  257. * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
  258. * Care is taken *not* to do this however when the objects have an elevated
  259. * refcount.
  260. *
  261. * o Each nfs4_client is hashed by clientid
  262. *
  263. * o Each nfs4_clients is also hashed by name (the opaque quantity initially
  264. * sent by the client to identify itself).
  265. *
  266. * o cl_perclient list is used to ensure no dangling stateowner references
  267. * when we expire the nfs4_client
  268. */
  269. struct nfs4_client {
  270. struct list_head cl_idhash; /* hash by cl_clientid.id */
  271. struct rb_node cl_namenode; /* link into by-name trees */
  272. struct list_head *cl_ownerstr_hashtbl;
  273. struct list_head cl_openowners;
  274. struct idr cl_stateids; /* stateid lookup */
  275. struct list_head cl_delegations;
  276. struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
  277. struct list_head cl_lru; /* tail queue */
  278. #ifdef CONFIG_NFSD_PNFS
  279. struct list_head cl_lo_states; /* outstanding layout states */
  280. #endif
  281. struct xdr_netobj cl_name; /* id generated by client */
  282. nfs4_verifier cl_verifier; /* generated by client */
  283. time_t cl_time; /* time of last lease renewal */
  284. struct sockaddr_storage cl_addr; /* client ipaddress */
  285. bool cl_mach_cred; /* SP4_MACH_CRED in force */
  286. struct svc_cred cl_cred; /* setclientid principal */
  287. clientid_t cl_clientid; /* generated by server */
  288. nfs4_verifier cl_confirm; /* generated by server */
  289. u32 cl_minorversion;
  290. /* for v4.0 and v4.1 callbacks: */
  291. struct nfs4_cb_conn cl_cb_conn;
  292. #define NFSD4_CLIENT_CB_UPDATE (0)
  293. #define NFSD4_CLIENT_CB_KILL (1)
  294. #define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
  295. #define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
  296. #define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
  297. #define NFSD4_CLIENT_UPCALL_LOCK (5) /* upcall serialization */
  298. #define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
  299. 1 << NFSD4_CLIENT_CB_KILL)
  300. unsigned long cl_flags;
  301. struct rpc_cred *cl_cb_cred;
  302. struct rpc_clnt *cl_cb_client;
  303. u32 cl_cb_ident;
  304. #define NFSD4_CB_UP 0
  305. #define NFSD4_CB_UNKNOWN 1
  306. #define NFSD4_CB_DOWN 2
  307. #define NFSD4_CB_FAULT 3
  308. int cl_cb_state;
  309. struct nfsd4_callback cl_cb_null;
  310. struct nfsd4_session *cl_cb_session;
  311. /* for all client information that callback code might need: */
  312. spinlock_t cl_lock;
  313. /* for nfs41 */
  314. struct list_head cl_sessions;
  315. struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
  316. u32 cl_exchange_flags;
  317. /* number of rpc's in progress over an associated session: */
  318. atomic_t cl_refcount;
  319. /* for nfs41 callbacks */
  320. /* We currently support a single back channel with a single slot */
  321. unsigned long cl_cb_slot_busy;
  322. struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
  323. /* wait here for slots */
  324. struct net *net;
  325. };
  326. /* struct nfs4_client_reset
  327. * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
  328. * upon lease reset, or from upcall to state_daemon (to read in state
  329. * from non-volitile storage) upon reboot.
  330. */
  331. struct nfs4_client_reclaim {
  332. struct list_head cr_strhash; /* hash by cr_name */
  333. struct nfs4_client *cr_clp; /* pointer to associated clp */
  334. char cr_recdir[HEXDIR_LEN]; /* recover dir */
  335. };
  336. /* A reasonable value for REPLAY_ISIZE was estimated as follows:
  337. * The OPEN response, typically the largest, requires
  338. * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
  339. * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
  340. * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
  341. */
  342. #define NFSD4_REPLAY_ISIZE 112
  343. /*
  344. * Replay buffer, where the result of the last seqid-mutating operation
  345. * is cached.
  346. */
  347. struct nfs4_replay {
  348. __be32 rp_status;
  349. unsigned int rp_buflen;
  350. char *rp_buf;
  351. struct knfsd_fh rp_openfh;
  352. struct mutex rp_mutex;
  353. char rp_ibuf[NFSD4_REPLAY_ISIZE];
  354. };
  355. struct nfs4_stateowner;
  356. struct nfs4_stateowner_operations {
  357. void (*so_unhash)(struct nfs4_stateowner *);
  358. void (*so_free)(struct nfs4_stateowner *);
  359. };
  360. /*
  361. * A core object that represents either an open or lock owner. The object and
  362. * lock owner objects have one of these embedded within them. Refcounts and
  363. * other fields common to both owner types are contained within these
  364. * structures.
  365. */
  366. struct nfs4_stateowner {
  367. struct list_head so_strhash;
  368. struct list_head so_stateids;
  369. struct nfs4_client *so_client;
  370. const struct nfs4_stateowner_operations *so_ops;
  371. /* after increment in nfsd4_bump_seqid, represents the next
  372. * sequence id expected from the client: */
  373. atomic_t so_count;
  374. u32 so_seqid;
  375. struct xdr_netobj so_owner; /* open owner name */
  376. struct nfs4_replay so_replay;
  377. bool so_is_open_owner;
  378. };
  379. /*
  380. * When a file is opened, the client provides an open state owner opaque string
  381. * that indicates the "owner" of that open. These objects are refcounted.
  382. * References to it are held by each open state associated with it. This object
  383. * is a superset of the nfs4_stateowner struct.
  384. */
  385. struct nfs4_openowner {
  386. struct nfs4_stateowner oo_owner; /* must be first field */
  387. struct list_head oo_perclient;
  388. /*
  389. * We keep around openowners a little while after last close,
  390. * which saves clients from having to confirm, and allows us to
  391. * handle close replays if they come soon enough. The close_lru
  392. * is a list of such openowners, to be reaped by the laundromat
  393. * thread eventually if they remain unused:
  394. */
  395. struct list_head oo_close_lru;
  396. struct nfs4_ol_stateid *oo_last_closed_stid;
  397. time_t oo_time; /* time of placement on so_close_lru */
  398. #define NFS4_OO_CONFIRMED 1
  399. unsigned char oo_flags;
  400. };
  401. /*
  402. * Represents a generic "lockowner". Similar to an openowner. References to it
  403. * are held by the lock stateids that are created on its behalf. This object is
  404. * a superset of the nfs4_stateowner struct (or would be if it needed any extra
  405. * fields).
  406. */
  407. struct nfs4_lockowner {
  408. struct nfs4_stateowner lo_owner; /* must be first element */
  409. };
  410. static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
  411. {
  412. return container_of(so, struct nfs4_openowner, oo_owner);
  413. }
  414. static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
  415. {
  416. return container_of(so, struct nfs4_lockowner, lo_owner);
  417. }
  418. /*
  419. * Per-client state indicating no. of opens and outstanding delegations
  420. * on a file from a particular client.'od' stands for 'open & delegation'
  421. */
  422. struct nfs4_clnt_odstate {
  423. struct nfs4_client *co_client;
  424. struct nfs4_file *co_file;
  425. struct list_head co_perfile;
  426. atomic_t co_odcount;
  427. };
  428. /*
  429. * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
  430. *
  431. * These objects are global. nfsd keeps one instance of a nfs4_file per
  432. * filehandle (though it may keep multiple file descriptors for each). Each
  433. * inode can have multiple filehandles associated with it, so there is
  434. * (potentially) a many to one relationship between this struct and struct
  435. * inode.
  436. *
  437. * These are hashed by filehandle in the file_hashtbl, which is protected by
  438. * the global state_lock spinlock.
  439. */
  440. struct nfs4_file {
  441. atomic_t fi_ref;
  442. spinlock_t fi_lock;
  443. struct hlist_node fi_hash; /* hash on fi_fhandle */
  444. struct list_head fi_stateids;
  445. union {
  446. struct list_head fi_delegations;
  447. struct rcu_head fi_rcu;
  448. };
  449. struct list_head fi_clnt_odstate;
  450. /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
  451. struct file * fi_fds[3];
  452. /*
  453. * Each open or lock stateid contributes 0-4 to the counts
  454. * below depending on which bits are set in st_access_bitmap:
  455. * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
  456. * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
  457. * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
  458. */
  459. atomic_t fi_access[2];
  460. u32 fi_share_deny;
  461. struct file *fi_deleg_file;
  462. int fi_delegees;
  463. struct knfsd_fh fi_fhandle;
  464. bool fi_had_conflict;
  465. #ifdef CONFIG_NFSD_PNFS
  466. struct list_head fi_lo_states;
  467. atomic_t fi_lo_recalls;
  468. #endif
  469. };
  470. /*
  471. * A generic struct representing either a open or lock stateid. The nfs4_client
  472. * holds a reference to each of these objects, and they in turn hold a
  473. * reference to their respective stateowners. The client's reference is
  474. * released in response to a close or unlock (depending on whether it's an open
  475. * or lock stateid) or when the client is being destroyed.
  476. *
  477. * In the case of v4.0 open stateids, these objects are preserved for a little
  478. * while after close in order to handle CLOSE replays. Those are eventually
  479. * reclaimed via a LRU scheme by the laundromat.
  480. *
  481. * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
  482. * Better suggestions welcome.
  483. */
  484. struct nfs4_ol_stateid {
  485. struct nfs4_stid st_stid;
  486. struct list_head st_perfile;
  487. struct list_head st_perstateowner;
  488. struct list_head st_locks;
  489. struct nfs4_stateowner *st_stateowner;
  490. struct nfs4_clnt_odstate *st_clnt_odstate;
  491. unsigned char st_access_bmap;
  492. unsigned char st_deny_bmap;
  493. struct nfs4_ol_stateid *st_openstp;
  494. struct mutex st_mutex;
  495. };
  496. static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
  497. {
  498. return container_of(s, struct nfs4_ol_stateid, st_stid);
  499. }
  500. struct nfs4_layout_stateid {
  501. struct nfs4_stid ls_stid;
  502. struct list_head ls_perclnt;
  503. struct list_head ls_perfile;
  504. spinlock_t ls_lock;
  505. struct list_head ls_layouts;
  506. u32 ls_layout_type;
  507. struct file *ls_file;
  508. struct nfsd4_callback ls_recall;
  509. stateid_t ls_recall_sid;
  510. bool ls_recalled;
  511. struct mutex ls_mutex;
  512. };
  513. static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
  514. {
  515. return container_of(s, struct nfs4_layout_stateid, ls_stid);
  516. }
  517. /* flags for preprocess_seqid_op() */
  518. #define RD_STATE 0x00000010
  519. #define WR_STATE 0x00000020
  520. enum nfsd4_cb_op {
  521. NFSPROC4_CLNT_CB_NULL = 0,
  522. NFSPROC4_CLNT_CB_RECALL,
  523. NFSPROC4_CLNT_CB_LAYOUT,
  524. NFSPROC4_CLNT_CB_SEQUENCE,
  525. };
  526. struct nfsd4_compound_state;
  527. struct nfsd_net;
  528. extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
  529. struct nfsd4_compound_state *cstate, stateid_t *stateid,
  530. int flags, struct file **filp, bool *tmp_file);
  531. __be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
  532. stateid_t *stateid, unsigned char typemask,
  533. struct nfs4_stid **s, struct nfsd_net *nn);
  534. struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab,
  535. void (*sc_free)(struct nfs4_stid *));
  536. void nfs4_unhash_stid(struct nfs4_stid *s);
  537. void nfs4_put_stid(struct nfs4_stid *s);
  538. void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
  539. void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
  540. extern void nfs4_release_reclaim(struct nfsd_net *);
  541. extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
  542. struct nfsd_net *nn);
  543. extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
  544. struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
  545. extern int set_callback_cred(void);
  546. extern void cleanup_callback_cred(void);
  547. extern void nfsd4_probe_callback(struct nfs4_client *clp);
  548. extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
  549. extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
  550. extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
  551. struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
  552. extern void nfsd4_run_cb(struct nfsd4_callback *cb);
  553. extern int nfsd4_create_callback_queue(void);
  554. extern void nfsd4_destroy_callback_queue(void);
  555. extern void nfsd4_shutdown_callback(struct nfs4_client *);
  556. extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
  557. extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
  558. struct nfsd_net *nn);
  559. extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
  560. struct nfs4_file *find_file(struct knfsd_fh *fh);
  561. void put_nfs4_file(struct nfs4_file *fi);
  562. static inline void get_nfs4_file(struct nfs4_file *fi)
  563. {
  564. atomic_inc(&fi->fi_ref);
  565. }
  566. struct file *find_any_file(struct nfs4_file *f);
  567. /* grace period management */
  568. void nfsd4_end_grace(struct nfsd_net *nn);
  569. /* nfs4recover operations */
  570. extern int nfsd4_client_tracking_init(struct net *net);
  571. extern void nfsd4_client_tracking_exit(struct net *net);
  572. extern void nfsd4_client_record_create(struct nfs4_client *clp);
  573. extern void nfsd4_client_record_remove(struct nfs4_client *clp);
  574. extern int nfsd4_client_record_check(struct nfs4_client *clp);
  575. extern void nfsd4_record_grace_done(struct nfsd_net *nn);
  576. /* nfs fault injection functions */
  577. #ifdef CONFIG_NFSD_FAULT_INJECTION
  578. int nfsd_fault_inject_init(void);
  579. void nfsd_fault_inject_cleanup(void);
  580. u64 nfsd_inject_print_clients(void);
  581. u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
  582. u64 nfsd_inject_forget_clients(u64);
  583. u64 nfsd_inject_print_locks(void);
  584. u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
  585. u64 nfsd_inject_forget_locks(u64);
  586. u64 nfsd_inject_print_openowners(void);
  587. u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
  588. u64 nfsd_inject_forget_openowners(u64);
  589. u64 nfsd_inject_print_delegations(void);
  590. u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
  591. u64 nfsd_inject_forget_delegations(u64);
  592. u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
  593. u64 nfsd_inject_recall_delegations(u64);
  594. #else /* CONFIG_NFSD_FAULT_INJECTION */
  595. static inline int nfsd_fault_inject_init(void) { return 0; }
  596. static inline void nfsd_fault_inject_cleanup(void) {}
  597. #endif /* CONFIG_NFSD_FAULT_INJECTION */
  598. #endif /* NFSD4_STATE_H */