v9fs.h 7.3 KB

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