v9fs.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * V9FS definitions.
  4. *
  5. * Copyright (C) 2004-2008 by Eric Van Hensbergen <ericvh@gmail.com>
  6. * Copyright (C) 2002 by Ron Minnich <rminnich@lanl.gov>
  7. */
  8. #ifndef FS_9P_V9FS_H
  9. #define FS_9P_V9FS_H
  10. #include <linux/backing-dev.h>
  11. /**
  12. * enum p9_session_flags - option flags for each 9P session
  13. * @V9FS_PROTO_2000U: whether or not to use 9P2000.u extensions
  14. * @V9FS_PROTO_2000L: whether or not to use 9P2000.l extensions
  15. * @V9FS_ACCESS_SINGLE: only the mounting user can access the hierarchy
  16. * @V9FS_ACCESS_USER: a new attach will be issued for every user (default)
  17. * @V9FS_ACCESS_CLIENT: Just like user, but access check is performed on client.
  18. * @V9FS_ACCESS_ANY: use a single attach for all users
  19. * @V9FS_ACCESS_MASK: bit mask of different ACCESS options
  20. * @V9FS_POSIX_ACL: POSIX ACLs are enforced
  21. *
  22. * Session flags reflect options selected by users at mount time
  23. */
  24. #define V9FS_ACCESS_ANY (V9FS_ACCESS_SINGLE | \
  25. V9FS_ACCESS_USER | \
  26. V9FS_ACCESS_CLIENT)
  27. #define V9FS_ACCESS_MASK V9FS_ACCESS_ANY
  28. #define V9FS_ACL_MASK V9FS_POSIX_ACL
  29. enum p9_session_flags {
  30. V9FS_PROTO_2000U = 0x01,
  31. V9FS_PROTO_2000L = 0x02,
  32. V9FS_ACCESS_SINGLE = 0x04,
  33. V9FS_ACCESS_USER = 0x08,
  34. V9FS_ACCESS_CLIENT = 0x10,
  35. V9FS_POSIX_ACL = 0x20
  36. };
  37. /* possible values of ->cache */
  38. /**
  39. * enum p9_cache_modes - user specified cache preferences
  40. * @CACHE_NONE: do not cache data, dentries, or directory contents (default)
  41. * @CACHE_LOOSE: cache data, dentries, and directory contents w/no consistency
  42. *
  43. * eventually support loose, tight, time, session, default always none
  44. */
  45. enum p9_cache_modes {
  46. CACHE_NONE,
  47. CACHE_MMAP,
  48. CACHE_LOOSE,
  49. CACHE_FSCACHE,
  50. nr__p9_cache_modes
  51. };
  52. /**
  53. * struct v9fs_session_info - per-instance session information
  54. * @flags: session options of type &p9_session_flags
  55. * @nodev: set to 1 to disable device mapping
  56. * @debug: debug level
  57. * @afid: authentication handle
  58. * @cache: cache mode of type &p9_cache_modes
  59. * @cachetag: the tag of the cache associated with this session
  60. * @fscache: session cookie associated with FS-Cache
  61. * @uname: string user name to mount hierarchy as
  62. * @aname: mount specifier for remote hierarchy
  63. * @maxdata: maximum data to be sent/recvd per protocol message
  64. * @dfltuid: default numeric userid to mount hierarchy as
  65. * @dfltgid: default numeric groupid to mount hierarchy as
  66. * @uid: if %V9FS_ACCESS_SINGLE, the numeric uid which mounted the hierarchy
  67. * @clnt: reference to 9P network client instantiated for this session
  68. * @slist: reference to list of registered 9p sessions
  69. *
  70. * This structure holds state for each session instance established during
  71. * a sys_mount() .
  72. *
  73. * Bugs: there seems to be a lot of state which could be condensed and/or
  74. * removed.
  75. */
  76. struct v9fs_session_info {
  77. /* options */
  78. unsigned char flags;
  79. unsigned char nodev;
  80. unsigned short debug;
  81. unsigned int afid;
  82. unsigned int cache;
  83. #ifdef CONFIG_9P_FSCACHE
  84. char *cachetag;
  85. struct fscache_cookie *fscache;
  86. #endif
  87. char *uname; /* user name to mount as */
  88. char *aname; /* name of remote hierarchy being mounted */
  89. unsigned int maxdata; /* max data for client interface */
  90. kuid_t dfltuid; /* default uid/muid for legacy support */
  91. kgid_t dfltgid; /* default gid for legacy support */
  92. kuid_t uid; /* if ACCESS_SINGLE, the uid that has access */
  93. struct p9_client *clnt; /* 9p client */
  94. struct list_head slist; /* list of sessions registered with v9fs */
  95. struct rw_semaphore rename_sem;
  96. long session_lock_timeout; /* retry interval for blocking locks */
  97. };
  98. /* cache_validity flags */
  99. #define V9FS_INO_INVALID_ATTR 0x01
  100. struct v9fs_inode {
  101. #ifdef CONFIG_9P_FSCACHE
  102. struct mutex fscache_lock;
  103. struct fscache_cookie *fscache;
  104. #endif
  105. struct p9_qid qid;
  106. unsigned int cache_validity;
  107. struct p9_fid *writeback_fid;
  108. struct mutex v_mutex;
  109. struct inode vfs_inode;
  110. };
  111. static inline struct v9fs_inode *V9FS_I(const struct inode *inode)
  112. {
  113. return container_of(inode, struct v9fs_inode, vfs_inode);
  114. }
  115. extern int v9fs_show_options(struct seq_file *m, struct dentry *root);
  116. struct p9_fid *v9fs_session_init(struct v9fs_session_info *, const char *,
  117. char *);
  118. extern void v9fs_session_close(struct v9fs_session_info *v9ses);
  119. extern void v9fs_session_cancel(struct v9fs_session_info *v9ses);
  120. extern void v9fs_session_begin_cancel(struct v9fs_session_info *v9ses);
  121. extern struct dentry *v9fs_vfs_lookup(struct inode *dir, struct dentry *dentry,
  122. unsigned int flags);
  123. extern int v9fs_vfs_unlink(struct inode *i, struct dentry *d);
  124. extern int v9fs_vfs_rmdir(struct inode *i, struct dentry *d);
  125. extern int v9fs_vfs_rename(struct inode *old_dir, struct dentry *old_dentry,
  126. struct inode *new_dir, struct dentry *new_dentry,
  127. unsigned int flags);
  128. extern struct inode *v9fs_inode_from_fid(struct v9fs_session_info *v9ses,
  129. struct p9_fid *fid,
  130. struct super_block *sb, int new);
  131. extern const struct inode_operations v9fs_dir_inode_operations_dotl;
  132. extern const struct inode_operations v9fs_file_inode_operations_dotl;
  133. extern const struct inode_operations v9fs_symlink_inode_operations_dotl;
  134. extern struct inode *v9fs_inode_from_fid_dotl(struct v9fs_session_info *v9ses,
  135. struct p9_fid *fid,
  136. struct super_block *sb, int new);
  137. /* other default globals */
  138. #define V9FS_PORT 564
  139. #define V9FS_DEFUSER "nobody"
  140. #define V9FS_DEFANAME ""
  141. #define V9FS_DEFUID KUIDT_INIT(-2)
  142. #define V9FS_DEFGID KGIDT_INIT(-2)
  143. static inline struct v9fs_session_info *v9fs_inode2v9ses(struct inode *inode)
  144. {
  145. return (inode->i_sb->s_fs_info);
  146. }
  147. static inline struct v9fs_session_info *v9fs_dentry2v9ses(struct dentry *dentry)
  148. {
  149. return dentry->d_sb->s_fs_info;
  150. }
  151. static inline int v9fs_proto_dotu(struct v9fs_session_info *v9ses)
  152. {
  153. return v9ses->flags & V9FS_PROTO_2000U;
  154. }
  155. static inline int v9fs_proto_dotl(struct v9fs_session_info *v9ses)
  156. {
  157. return v9ses->flags & V9FS_PROTO_2000L;
  158. }
  159. /**
  160. * v9fs_get_inode_from_fid - Helper routine to populate an inode by
  161. * issuing a attribute request
  162. * @v9ses: session information
  163. * @fid: fid to issue attribute request for
  164. * @sb: superblock on which to create inode
  165. *
  166. */
  167. static inline struct inode *
  168. v9fs_get_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
  169. struct super_block *sb)
  170. {
  171. if (v9fs_proto_dotl(v9ses))
  172. return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 0);
  173. else
  174. return v9fs_inode_from_fid(v9ses, fid, sb, 0);
  175. }
  176. /**
  177. * v9fs_get_new_inode_from_fid - Helper routine to populate an inode by
  178. * issuing a attribute request
  179. * @v9ses: session information
  180. * @fid: fid to issue attribute request for
  181. * @sb: superblock on which to create inode
  182. *
  183. */
  184. static inline struct inode *
  185. v9fs_get_new_inode_from_fid(struct v9fs_session_info *v9ses, struct p9_fid *fid,
  186. struct super_block *sb)
  187. {
  188. if (v9fs_proto_dotl(v9ses))
  189. return v9fs_inode_from_fid_dotl(v9ses, fid, sb, 1);
  190. else
  191. return v9fs_inode_from_fid(v9ses, fid, sb, 1);
  192. }
  193. #endif