nfs_fs.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
  1. /*
  2. * linux/include/linux/nfs_fs.h
  3. *
  4. * Copyright (C) 1992 Rick Sladkey
  5. *
  6. * OS-specific nfs filesystem definitions and declarations
  7. */
  8. #ifndef _LINUX_NFS_FS_H
  9. #define _LINUX_NFS_FS_H
  10. #include <linux/magic.h>
  11. /*
  12. * Enable debugging support for nfs client.
  13. * Requires RPC_DEBUG.
  14. */
  15. #ifdef RPC_DEBUG
  16. # define NFS_DEBUG
  17. #endif
  18. /* Default timeout values */
  19. #define NFS_MAX_UDP_TIMEOUT (60*HZ)
  20. #define NFS_MAX_TCP_TIMEOUT (600*HZ)
  21. /*
  22. * When flushing a cluster of dirty pages, there can be different
  23. * strategies:
  24. */
  25. #define FLUSH_SYNC 1 /* file being synced, or contention */
  26. #define FLUSH_STABLE 4 /* commit to stable storage */
  27. #define FLUSH_LOWPRI 8 /* low priority background flush */
  28. #define FLUSH_HIGHPRI 16 /* high priority memory reclaim flush */
  29. #define FLUSH_NOCOMMIT 32 /* Don't send the NFSv3/v4 COMMIT */
  30. #define FLUSH_INVALIDATE 64 /* Invalidate the page cache */
  31. #define FLUSH_NOWRITEPAGE 128 /* Don't call writepage() */
  32. #ifdef __KERNEL__
  33. #include <linux/in.h>
  34. #include <linux/mm.h>
  35. #include <linux/pagemap.h>
  36. #include <linux/rbtree.h>
  37. #include <linux/rwsem.h>
  38. #include <linux/wait.h>
  39. #include <linux/sunrpc/debug.h>
  40. #include <linux/sunrpc/auth.h>
  41. #include <linux/sunrpc/clnt.h>
  42. #include <linux/nfs.h>
  43. #include <linux/nfs2.h>
  44. #include <linux/nfs3.h>
  45. #include <linux/nfs4.h>
  46. #include <linux/nfs_xdr.h>
  47. #include <linux/nfs_fs_sb.h>
  48. #include <linux/rwsem.h>
  49. #include <linux/mempool.h>
  50. /*
  51. * These are the default flags for swap requests
  52. */
  53. #define NFS_RPC_SWAPFLAGS (RPC_TASK_SWAPPER|RPC_TASK_ROOTCREDS)
  54. /*
  55. * NFSv3/v4 Access mode cache entry
  56. */
  57. struct nfs_access_entry {
  58. struct rb_node rb_node;
  59. struct list_head lru;
  60. unsigned long jiffies;
  61. struct rpc_cred * cred;
  62. int mask;
  63. };
  64. struct nfs4_state;
  65. struct nfs_open_context {
  66. atomic_t count;
  67. struct vfsmount *vfsmnt;
  68. struct dentry *dentry;
  69. struct rpc_cred *cred;
  70. struct nfs4_state *state;
  71. fl_owner_t lockowner;
  72. int mode;
  73. int error;
  74. struct list_head list;
  75. __u64 dir_cookie;
  76. };
  77. /*
  78. * NFSv4 delegation
  79. */
  80. struct nfs_delegation;
  81. struct posix_acl;
  82. /*
  83. * nfs fs inode data in memory
  84. */
  85. struct nfs_inode {
  86. /*
  87. * The 64bit 'inode number'
  88. */
  89. __u64 fileid;
  90. /*
  91. * NFS file handle
  92. */
  93. struct nfs_fh fh;
  94. /*
  95. * Various flags
  96. */
  97. unsigned long flags; /* atomic bit ops */
  98. unsigned long cache_validity; /* bit mask */
  99. /*
  100. * read_cache_jiffies is when we started read-caching this inode.
  101. * attrtimeo is for how long the cached information is assumed
  102. * to be valid. A successful attribute revalidation doubles
  103. * attrtimeo (up to acregmax/acdirmax), a failure resets it to
  104. * acregmin/acdirmin.
  105. *
  106. * We need to revalidate the cached attrs for this inode if
  107. *
  108. * jiffies - read_cache_jiffies > attrtimeo
  109. */
  110. unsigned long read_cache_jiffies;
  111. unsigned long attrtimeo;
  112. unsigned long attrtimeo_timestamp;
  113. __u64 change_attr; /* v4 only */
  114. unsigned long last_updated;
  115. /* "Generation counter" for the attribute cache. This is
  116. * bumped whenever we update the metadata on the
  117. * server.
  118. */
  119. unsigned long cache_change_attribute;
  120. /*
  121. * Counter indicating the number of outstanding requests that
  122. * will cause a file data update.
  123. */
  124. atomic_t data_updates;
  125. struct rb_root access_cache;
  126. struct list_head access_cache_entry_lru;
  127. struct list_head access_cache_inode_lru;
  128. #ifdef CONFIG_NFS_V3_ACL
  129. struct posix_acl *acl_access;
  130. struct posix_acl *acl_default;
  131. #endif
  132. /*
  133. * This is the cookie verifier used for NFSv3 readdir
  134. * operations
  135. */
  136. __be32 cookieverf[2];
  137. /*
  138. * This is the list of dirty unwritten pages.
  139. */
  140. spinlock_t req_lock;
  141. struct list_head dirty;
  142. struct list_head commit;
  143. struct radix_tree_root nfs_page_tree;
  144. unsigned int ndirty,
  145. ncommit,
  146. npages;
  147. /* Open contexts for shared mmap writes */
  148. struct list_head open_files;
  149. #ifdef CONFIG_NFS_V4
  150. struct nfs4_cached_acl *nfs4_acl;
  151. /* NFSv4 state */
  152. struct list_head open_states;
  153. struct nfs_delegation *delegation;
  154. int delegation_state;
  155. struct rw_semaphore rwsem;
  156. #endif /* CONFIG_NFS_V4*/
  157. struct inode vfs_inode;
  158. };
  159. /*
  160. * Cache validity bit flags
  161. */
  162. #define NFS_INO_INVALID_ATTR 0x0001 /* cached attrs are invalid */
  163. #define NFS_INO_INVALID_DATA 0x0002 /* cached data is invalid */
  164. #define NFS_INO_INVALID_ATIME 0x0004 /* cached atime is invalid */
  165. #define NFS_INO_INVALID_ACCESS 0x0008 /* cached access cred invalid */
  166. #define NFS_INO_INVALID_ACL 0x0010 /* cached acls are invalid */
  167. #define NFS_INO_REVAL_PAGECACHE 0x0020 /* must revalidate pagecache */
  168. /*
  169. * Bit offsets in flags field
  170. */
  171. #define NFS_INO_REVALIDATING (0) /* revalidating attrs */
  172. #define NFS_INO_ADVISE_RDPLUS (1) /* advise readdirplus */
  173. #define NFS_INO_STALE (2) /* possible stale inode */
  174. #define NFS_INO_ACL_LRU_SET (3) /* Inode is on the LRU list */
  175. static inline struct nfs_inode *NFS_I(struct inode *inode)
  176. {
  177. return container_of(inode, struct nfs_inode, vfs_inode);
  178. }
  179. #define NFS_SB(s) ((struct nfs_server *)(s->s_fs_info))
  180. #define NFS_FH(inode) (&NFS_I(inode)->fh)
  181. #define NFS_SERVER(inode) (NFS_SB(inode->i_sb))
  182. #define NFS_CLIENT(inode) (NFS_SERVER(inode)->client)
  183. #define NFS_PROTO(inode) (NFS_SERVER(inode)->nfs_client->rpc_ops)
  184. #define NFS_COOKIEVERF(inode) (NFS_I(inode)->cookieverf)
  185. #define NFS_READTIME(inode) (NFS_I(inode)->read_cache_jiffies)
  186. #define NFS_CHANGE_ATTR(inode) (NFS_I(inode)->change_attr)
  187. #define NFS_ATTRTIMEO(inode) (NFS_I(inode)->attrtimeo)
  188. #define NFS_MINATTRTIMEO(inode) \
  189. (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmin \
  190. : NFS_SERVER(inode)->acregmin)
  191. #define NFS_MAXATTRTIMEO(inode) \
  192. (S_ISDIR(inode->i_mode)? NFS_SERVER(inode)->acdirmax \
  193. : NFS_SERVER(inode)->acregmax)
  194. #define NFS_ATTRTIMEO_UPDATE(inode) (NFS_I(inode)->attrtimeo_timestamp)
  195. #define NFS_FLAGS(inode) (NFS_I(inode)->flags)
  196. #define NFS_STALE(inode) (test_bit(NFS_INO_STALE, &NFS_FLAGS(inode)))
  197. #define NFS_FILEID(inode) (NFS_I(inode)->fileid)
  198. static inline int nfs_caches_unstable(struct inode *inode)
  199. {
  200. return atomic_read(&NFS_I(inode)->data_updates) != 0;
  201. }
  202. static inline void nfs_mark_for_revalidate(struct inode *inode)
  203. {
  204. struct nfs_inode *nfsi = NFS_I(inode);
  205. spin_lock(&inode->i_lock);
  206. nfsi->cache_validity |= NFS_INO_INVALID_ATTR|NFS_INO_INVALID_ACCESS;
  207. if (S_ISDIR(inode->i_mode))
  208. nfsi->cache_validity |= NFS_INO_REVAL_PAGECACHE|NFS_INO_INVALID_DATA;
  209. spin_unlock(&inode->i_lock);
  210. }
  211. static inline void NFS_CACHEINV(struct inode *inode)
  212. {
  213. if (!nfs_caches_unstable(inode))
  214. nfs_mark_for_revalidate(inode);
  215. }
  216. static inline int nfs_server_capable(struct inode *inode, int cap)
  217. {
  218. return NFS_SERVER(inode)->caps & cap;
  219. }
  220. static inline int NFS_USE_READDIRPLUS(struct inode *inode)
  221. {
  222. return test_bit(NFS_INO_ADVISE_RDPLUS, &NFS_FLAGS(inode));
  223. }
  224. /**
  225. * nfs_save_change_attribute - Returns the inode attribute change cookie
  226. * @inode - pointer to inode
  227. * The "change attribute" is updated every time we finish an operation
  228. * that will result in a metadata change on the server.
  229. */
  230. static inline long nfs_save_change_attribute(struct inode *inode)
  231. {
  232. return NFS_I(inode)->cache_change_attribute;
  233. }
  234. /**
  235. * nfs_verify_change_attribute - Detects NFS inode cache updates
  236. * @inode - pointer to inode
  237. * @chattr - previously saved change attribute
  238. * Return "false" if metadata has been updated (or is in the process of
  239. * being updated) since the change attribute was saved.
  240. */
  241. static inline int nfs_verify_change_attribute(struct inode *inode, unsigned long chattr)
  242. {
  243. return !nfs_caches_unstable(inode)
  244. && time_after_eq(chattr, NFS_I(inode)->cache_change_attribute);
  245. }
  246. /*
  247. * linux/fs/nfs/inode.c
  248. */
  249. extern int nfs_sync_mapping(struct address_space *mapping);
  250. extern void nfs_zap_mapping(struct inode *inode, struct address_space *mapping);
  251. extern void nfs_zap_caches(struct inode *);
  252. extern struct inode *nfs_fhget(struct super_block *, struct nfs_fh *,
  253. struct nfs_fattr *);
  254. extern int nfs_refresh_inode(struct inode *, struct nfs_fattr *);
  255. extern int nfs_post_op_update_inode(struct inode *inode, struct nfs_fattr *fattr);
  256. extern int nfs_getattr(struct vfsmount *, struct dentry *, struct kstat *);
  257. extern int nfs_permission(struct inode *, int, struct nameidata *);
  258. extern int nfs_access_get_cached(struct inode *, struct rpc_cred *, struct nfs_access_entry *);
  259. extern void nfs_access_add_cache(struct inode *, struct nfs_access_entry *);
  260. extern void nfs_access_zap_cache(struct inode *inode);
  261. extern int nfs_open(struct inode *, struct file *);
  262. extern int nfs_release(struct inode *, struct file *);
  263. extern int nfs_attribute_timeout(struct inode *inode);
  264. extern int nfs_revalidate_inode(struct nfs_server *server, struct inode *inode);
  265. extern int __nfs_revalidate_inode(struct nfs_server *, struct inode *);
  266. extern int nfs_revalidate_mapping(struct inode *inode, struct address_space *mapping);
  267. extern int nfs_revalidate_mapping_nolock(struct inode *inode, struct address_space *mapping);
  268. extern int nfs_setattr(struct dentry *, struct iattr *);
  269. extern void nfs_setattr_update_inode(struct inode *inode, struct iattr *attr);
  270. extern void nfs_begin_attr_update(struct inode *);
  271. extern void nfs_end_attr_update(struct inode *);
  272. extern void nfs_begin_data_update(struct inode *);
  273. extern void nfs_end_data_update(struct inode *);
  274. extern struct nfs_open_context *get_nfs_open_context(struct nfs_open_context *ctx);
  275. extern void put_nfs_open_context(struct nfs_open_context *ctx);
  276. extern struct nfs_open_context *nfs_find_open_context(struct inode *inode, struct rpc_cred *cred, int mode);
  277. /* linux/net/ipv4/ipconfig.c: trims ip addr off front of name, too. */
  278. extern __be32 root_nfs_parse_addr(char *name); /*__init*/
  279. static inline void nfs_fattr_init(struct nfs_fattr *fattr)
  280. {
  281. fattr->valid = 0;
  282. fattr->time_start = jiffies;
  283. }
  284. /*
  285. * linux/fs/nfs/file.c
  286. */
  287. extern struct inode_operations nfs_file_inode_operations;
  288. #ifdef CONFIG_NFS_V3
  289. extern struct inode_operations nfs3_file_inode_operations;
  290. #endif /* CONFIG_NFS_V3 */
  291. extern const struct file_operations nfs_file_operations;
  292. extern const struct address_space_operations nfs_file_aops;
  293. static inline struct rpc_cred *nfs_file_cred(struct file *file)
  294. {
  295. if (file != NULL) {
  296. struct nfs_open_context *ctx;
  297. ctx = (struct nfs_open_context*)file->private_data;
  298. return ctx->cred;
  299. }
  300. return NULL;
  301. }
  302. /*
  303. * linux/fs/nfs/xattr.c
  304. */
  305. #ifdef CONFIG_NFS_V3_ACL
  306. extern ssize_t nfs3_listxattr(struct dentry *, char *, size_t);
  307. extern ssize_t nfs3_getxattr(struct dentry *, const char *, void *, size_t);
  308. extern int nfs3_setxattr(struct dentry *, const char *,
  309. const void *, size_t, int);
  310. extern int nfs3_removexattr (struct dentry *, const char *name);
  311. #else
  312. # define nfs3_listxattr NULL
  313. # define nfs3_getxattr NULL
  314. # define nfs3_setxattr NULL
  315. # define nfs3_removexattr NULL
  316. #endif
  317. /*
  318. * linux/fs/nfs/direct.c
  319. */
  320. extern ssize_t nfs_direct_IO(int, struct kiocb *, const struct iovec *, loff_t,
  321. unsigned long);
  322. extern ssize_t nfs_file_direct_read(struct kiocb *iocb,
  323. const struct iovec *iov, unsigned long nr_segs,
  324. loff_t pos);
  325. extern ssize_t nfs_file_direct_write(struct kiocb *iocb,
  326. const struct iovec *iov, unsigned long nr_segs,
  327. loff_t pos);
  328. /*
  329. * linux/fs/nfs/dir.c
  330. */
  331. extern struct inode_operations nfs_dir_inode_operations;
  332. #ifdef CONFIG_NFS_V3
  333. extern struct inode_operations nfs3_dir_inode_operations;
  334. #endif /* CONFIG_NFS_V3 */
  335. extern const struct file_operations nfs_dir_operations;
  336. extern struct dentry_operations nfs_dentry_operations;
  337. extern int nfs_instantiate(struct dentry *dentry, struct nfs_fh *fh, struct nfs_fattr *fattr);
  338. /*
  339. * linux/fs/nfs/symlink.c
  340. */
  341. extern struct inode_operations nfs_symlink_inode_operations;
  342. /*
  343. * linux/fs/nfs/sysctl.c
  344. */
  345. #ifdef CONFIG_SYSCTL
  346. extern int nfs_register_sysctl(void);
  347. extern void nfs_unregister_sysctl(void);
  348. #else
  349. #define nfs_register_sysctl() 0
  350. #define nfs_unregister_sysctl() do { } while(0)
  351. #endif
  352. /*
  353. * linux/fs/nfs/namespace.c
  354. */
  355. extern struct list_head nfs_automount_list;
  356. extern struct inode_operations nfs_mountpoint_inode_operations;
  357. extern struct inode_operations nfs_referral_inode_operations;
  358. extern int nfs_mountpoint_expiry_timeout;
  359. extern void nfs_release_automount_timer(void);
  360. /*
  361. * linux/fs/nfs/unlink.c
  362. */
  363. extern int nfs_async_unlink(struct dentry *);
  364. extern void nfs_complete_unlink(struct dentry *);
  365. /*
  366. * linux/fs/nfs/write.c
  367. */
  368. extern int nfs_writepage(struct page *page, struct writeback_control *wbc);
  369. extern int nfs_writepages(struct address_space *, struct writeback_control *);
  370. extern int nfs_flush_incompatible(struct file *file, struct page *page);
  371. extern int nfs_updatepage(struct file *, struct page *, unsigned int, unsigned int);
  372. extern int nfs_writeback_done(struct rpc_task *, struct nfs_write_data *);
  373. extern void nfs_writedata_release(void *);
  374. extern int nfs_set_page_dirty(struct page *);
  375. /*
  376. * Try to write back everything synchronously (but check the
  377. * return value!)
  378. */
  379. extern long nfs_sync_mapping_wait(struct address_space *, struct writeback_control *, int);
  380. extern int nfs_sync_mapping_range(struct address_space *, loff_t, loff_t, int);
  381. extern int nfs_wb_all(struct inode *inode);
  382. extern int nfs_wb_page(struct inode *inode, struct page* page);
  383. extern int nfs_wb_page_priority(struct inode *inode, struct page* page, int how);
  384. #if defined(CONFIG_NFS_V3) || defined(CONFIG_NFS_V4)
  385. extern int nfs_commit_inode(struct inode *, int);
  386. extern struct nfs_write_data *nfs_commit_alloc(void);
  387. extern void nfs_commit_free(struct nfs_write_data *wdata);
  388. extern void nfs_commit_release(void *wdata);
  389. #else
  390. static inline int
  391. nfs_commit_inode(struct inode *inode, int how)
  392. {
  393. return 0;
  394. }
  395. #endif
  396. static inline int
  397. nfs_have_writebacks(struct inode *inode)
  398. {
  399. return NFS_I(inode)->npages != 0;
  400. }
  401. /*
  402. * Allocate nfs_write_data structures
  403. */
  404. extern struct nfs_write_data *nfs_writedata_alloc(size_t len);
  405. /*
  406. * linux/fs/nfs/read.c
  407. */
  408. extern int nfs_readpage(struct file *, struct page *);
  409. extern int nfs_readpages(struct file *, struct address_space *,
  410. struct list_head *, unsigned);
  411. extern int nfs_readpage_result(struct rpc_task *, struct nfs_read_data *);
  412. extern void nfs_readdata_release(void *data);
  413. /*
  414. * Allocate nfs_read_data structures
  415. */
  416. extern struct nfs_read_data *nfs_readdata_alloc(size_t len);
  417. /*
  418. * linux/fs/nfs3proc.c
  419. */
  420. #ifdef CONFIG_NFS_V3_ACL
  421. extern struct posix_acl *nfs3_proc_getacl(struct inode *inode, int type);
  422. extern int nfs3_proc_setacl(struct inode *inode, int type,
  423. struct posix_acl *acl);
  424. extern int nfs3_proc_set_default_acl(struct inode *dir, struct inode *inode,
  425. mode_t mode);
  426. extern void nfs3_forget_cached_acls(struct inode *inode);
  427. #else
  428. static inline int nfs3_proc_set_default_acl(struct inode *dir,
  429. struct inode *inode,
  430. mode_t mode)
  431. {
  432. return 0;
  433. }
  434. static inline void nfs3_forget_cached_acls(struct inode *inode)
  435. {
  436. }
  437. #endif /* CONFIG_NFS_V3_ACL */
  438. /*
  439. * linux/fs/mount_clnt.c
  440. * (Used only by nfsroot module)
  441. */
  442. extern int nfsroot_mount(struct sockaddr_in *, char *, struct nfs_fh *,
  443. int, int);
  444. /*
  445. * inline functions
  446. */
  447. static inline loff_t
  448. nfs_size_to_loff_t(__u64 size)
  449. {
  450. loff_t maxsz = (((loff_t) ULONG_MAX) << PAGE_CACHE_SHIFT) + PAGE_CACHE_SIZE - 1;
  451. if (size > maxsz)
  452. return maxsz;
  453. return (loff_t) size;
  454. }
  455. static inline ino_t
  456. nfs_fileid_to_ino_t(u64 fileid)
  457. {
  458. ino_t ino = (ino_t) fileid;
  459. if (sizeof(ino_t) < sizeof(u64))
  460. ino ^= fileid >> (sizeof(u64)-sizeof(ino_t)) * 8;
  461. return ino;
  462. }
  463. /* NFS root */
  464. extern void * nfs_root_data(void);
  465. #define nfs_wait_event(clnt, wq, condition) \
  466. ({ \
  467. int __retval = 0; \
  468. if (clnt->cl_intr) { \
  469. sigset_t oldmask; \
  470. rpc_clnt_sigmask(clnt, &oldmask); \
  471. __retval = wait_event_interruptible(wq, condition); \
  472. rpc_clnt_sigunmask(clnt, &oldmask); \
  473. } else \
  474. wait_event(wq, condition); \
  475. __retval; \
  476. })
  477. #define NFS_JUKEBOX_RETRY_TIME (5 * HZ)
  478. #endif /* __KERNEL__ */
  479. /*
  480. * NFS debug flags
  481. */
  482. #define NFSDBG_VFS 0x0001
  483. #define NFSDBG_DIRCACHE 0x0002
  484. #define NFSDBG_LOOKUPCACHE 0x0004
  485. #define NFSDBG_PAGECACHE 0x0008
  486. #define NFSDBG_PROC 0x0010
  487. #define NFSDBG_XDR 0x0020
  488. #define NFSDBG_FILE 0x0040
  489. #define NFSDBG_ROOT 0x0080
  490. #define NFSDBG_CALLBACK 0x0100
  491. #define NFSDBG_CLIENT 0x0200
  492. #define NFSDBG_ALL 0xFFFF
  493. #ifdef __KERNEL__
  494. # undef ifdebug
  495. # ifdef NFS_DEBUG
  496. # define ifdebug(fac) if (unlikely(nfs_debug & NFSDBG_##fac))
  497. # else
  498. # define ifdebug(fac) if (0)
  499. # endif
  500. #endif /* __KERNEL */
  501. #endif