nfs_fs.h 16 KB

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