9p.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
  1. /* SPDX-License-Identifier: GPL-2.0-only */
  2. /*
  3. * 9P protocol definitions.
  4. *
  5. * Copyright (C) 2005 by Latchesar Ionkov <[email protected]>
  6. * Copyright (C) 2004 by Eric Van Hensbergen <[email protected]>
  7. * Copyright (C) 2002 by Ron Minnich <[email protected]>
  8. */
  9. #ifndef NET_9P_H
  10. #define NET_9P_H
  11. /**
  12. * enum p9_debug_flags - bits for mount time debug parameter
  13. * @P9_DEBUG_ERROR: more verbose error messages including original error string
  14. * @P9_DEBUG_9P: 9P protocol tracing
  15. * @P9_DEBUG_VFS: VFS API tracing
  16. * @P9_DEBUG_CONV: protocol conversion tracing
  17. * @P9_DEBUG_MUX: trace management of concurrent transactions
  18. * @P9_DEBUG_TRANS: transport tracing
  19. * @P9_DEBUG_SLABS: memory management tracing
  20. * @P9_DEBUG_FCALL: verbose dump of protocol messages
  21. * @P9_DEBUG_FID: fid allocation/deallocation tracking
  22. * @P9_DEBUG_PKT: packet marshalling/unmarshalling
  23. * @P9_DEBUG_FSC: FS-cache tracing
  24. * @P9_DEBUG_VPKT: Verbose packet debugging (full packet dump)
  25. *
  26. * These flags are passed at mount time to turn on various levels of
  27. * verbosity and tracing which will be output to the system logs.
  28. */
  29. enum p9_debug_flags {
  30. P9_DEBUG_ERROR = (1<<0),
  31. P9_DEBUG_9P = (1<<2),
  32. P9_DEBUG_VFS = (1<<3),
  33. P9_DEBUG_CONV = (1<<4),
  34. P9_DEBUG_MUX = (1<<5),
  35. P9_DEBUG_TRANS = (1<<6),
  36. P9_DEBUG_SLABS = (1<<7),
  37. P9_DEBUG_FCALL = (1<<8),
  38. P9_DEBUG_FID = (1<<9),
  39. P9_DEBUG_PKT = (1<<10),
  40. P9_DEBUG_FSC = (1<<11),
  41. P9_DEBUG_VPKT = (1<<12),
  42. };
  43. #ifdef CONFIG_NET_9P_DEBUG
  44. extern unsigned int p9_debug_level;
  45. __printf(3, 4)
  46. void _p9_debug(enum p9_debug_flags level, const char *func,
  47. const char *fmt, ...);
  48. #define p9_debug(level, fmt, ...) \
  49. _p9_debug(level, __func__, fmt, ##__VA_ARGS__)
  50. #else
  51. #define p9_debug(level, fmt, ...) \
  52. no_printk(fmt, ##__VA_ARGS__)
  53. #endif
  54. /**
  55. * enum p9_msg_t - 9P message types
  56. * @P9_TLERROR: not used
  57. * @P9_RLERROR: response for any failed request for 9P2000.L
  58. * @P9_TSTATFS: file system status request
  59. * @P9_RSTATFS: file system status response
  60. * @P9_TSYMLINK: make symlink request
  61. * @P9_RSYMLINK: make symlink response
  62. * @P9_TMKNOD: create a special file object request
  63. * @P9_RMKNOD: create a special file object response
  64. * @P9_TLCREATE: prepare a handle for I/O on an new file for 9P2000.L
  65. * @P9_RLCREATE: response with file access information for 9P2000.L
  66. * @P9_TRENAME: rename request
  67. * @P9_RRENAME: rename response
  68. * @P9_TMKDIR: create a directory request
  69. * @P9_RMKDIR: create a directory response
  70. * @P9_TVERSION: version handshake request
  71. * @P9_RVERSION: version handshake response
  72. * @P9_TAUTH: request to establish authentication channel
  73. * @P9_RAUTH: response with authentication information
  74. * @P9_TATTACH: establish user access to file service
  75. * @P9_RATTACH: response with top level handle to file hierarchy
  76. * @P9_TERROR: not used
  77. * @P9_RERROR: response for any failed request
  78. * @P9_TFLUSH: request to abort a previous request
  79. * @P9_RFLUSH: response when previous request has been cancelled
  80. * @P9_TWALK: descend a directory hierarchy
  81. * @P9_RWALK: response with new handle for position within hierarchy
  82. * @P9_TOPEN: prepare a handle for I/O on an existing file
  83. * @P9_ROPEN: response with file access information
  84. * @P9_TCREATE: prepare a handle for I/O on a new file
  85. * @P9_RCREATE: response with file access information
  86. * @P9_TREAD: request to transfer data from a file or directory
  87. * @P9_RREAD: response with data requested
  88. * @P9_TWRITE: reuqest to transfer data to a file
  89. * @P9_RWRITE: response with out much data was transferred to file
  90. * @P9_TCLUNK: forget about a handle to an entity within the file system
  91. * @P9_RCLUNK: response when server has forgotten about the handle
  92. * @P9_TREMOVE: request to remove an entity from the hierarchy
  93. * @P9_RREMOVE: response when server has removed the entity
  94. * @P9_TSTAT: request file entity attributes
  95. * @P9_RSTAT: response with file entity attributes
  96. * @P9_TWSTAT: request to update file entity attributes
  97. * @P9_RWSTAT: response when file entity attributes are updated
  98. *
  99. * There are 14 basic operations in 9P2000, paired as
  100. * requests and responses. The one special case is ERROR
  101. * as there is no @P9_TERROR request for clients to transmit to
  102. * the server, but the server may respond to any other request
  103. * with an @P9_RERROR.
  104. *
  105. * See Also: http://plan9.bell-labs.com/sys/man/5/INDEX.html
  106. */
  107. enum p9_msg_t {
  108. P9_TLERROR = 6,
  109. P9_RLERROR,
  110. P9_TSTATFS = 8,
  111. P9_RSTATFS,
  112. P9_TLOPEN = 12,
  113. P9_RLOPEN,
  114. P9_TLCREATE = 14,
  115. P9_RLCREATE,
  116. P9_TSYMLINK = 16,
  117. P9_RSYMLINK,
  118. P9_TMKNOD = 18,
  119. P9_RMKNOD,
  120. P9_TRENAME = 20,
  121. P9_RRENAME,
  122. P9_TREADLINK = 22,
  123. P9_RREADLINK,
  124. P9_TGETATTR = 24,
  125. P9_RGETATTR,
  126. P9_TSETATTR = 26,
  127. P9_RSETATTR,
  128. P9_TXATTRWALK = 30,
  129. P9_RXATTRWALK,
  130. P9_TXATTRCREATE = 32,
  131. P9_RXATTRCREATE,
  132. P9_TREADDIR = 40,
  133. P9_RREADDIR,
  134. P9_TFSYNC = 50,
  135. P9_RFSYNC,
  136. P9_TLOCK = 52,
  137. P9_RLOCK,
  138. P9_TGETLOCK = 54,
  139. P9_RGETLOCK,
  140. P9_TLINK = 70,
  141. P9_RLINK,
  142. P9_TMKDIR = 72,
  143. P9_RMKDIR,
  144. P9_TRENAMEAT = 74,
  145. P9_RRENAMEAT,
  146. P9_TUNLINKAT = 76,
  147. P9_RUNLINKAT,
  148. P9_TVERSION = 100,
  149. P9_RVERSION,
  150. P9_TAUTH = 102,
  151. P9_RAUTH,
  152. P9_TATTACH = 104,
  153. P9_RATTACH,
  154. P9_TERROR = 106,
  155. P9_RERROR,
  156. P9_TFLUSH = 108,
  157. P9_RFLUSH,
  158. P9_TWALK = 110,
  159. P9_RWALK,
  160. P9_TOPEN = 112,
  161. P9_ROPEN,
  162. P9_TCREATE = 114,
  163. P9_RCREATE,
  164. P9_TREAD = 116,
  165. P9_RREAD,
  166. P9_TWRITE = 118,
  167. P9_RWRITE,
  168. P9_TCLUNK = 120,
  169. P9_RCLUNK,
  170. P9_TREMOVE = 122,
  171. P9_RREMOVE,
  172. P9_TSTAT = 124,
  173. P9_RSTAT,
  174. P9_TWSTAT = 126,
  175. P9_RWSTAT,
  176. };
  177. /**
  178. * enum p9_open_mode_t - 9P open modes
  179. * @P9_OREAD: open file for reading only
  180. * @P9_OWRITE: open file for writing only
  181. * @P9_ORDWR: open file for reading or writing
  182. * @P9_OEXEC: open file for execution
  183. * @P9_OTRUNC: truncate file to zero-length before opening it
  184. * @P9_OREXEC: close the file when an exec(2) system call is made
  185. * @P9_ORCLOSE: remove the file when the file is closed
  186. * @P9_OAPPEND: open the file and seek to the end
  187. * @P9_OEXCL: only create a file, do not open it
  188. *
  189. * 9P open modes differ slightly from Posix standard modes.
  190. * In particular, there are extra modes which specify different
  191. * semantic behaviors than may be available on standard Posix
  192. * systems. For example, @P9_OREXEC and @P9_ORCLOSE are modes that
  193. * most likely will not be issued from the Linux VFS client, but may
  194. * be supported by servers.
  195. *
  196. * See Also: http://plan9.bell-labs.com/magic/man2html/2/open
  197. */
  198. enum p9_open_mode_t {
  199. P9_OREAD = 0x00,
  200. P9_OWRITE = 0x01,
  201. P9_ORDWR = 0x02,
  202. P9_OEXEC = 0x03,
  203. P9_OTRUNC = 0x10,
  204. P9_OREXEC = 0x20,
  205. P9_ORCLOSE = 0x40,
  206. P9_OAPPEND = 0x80,
  207. P9_OEXCL = 0x1000,
  208. };
  209. /**
  210. * enum p9_perm_t - 9P permissions
  211. * @P9_DMDIR: mode bit for directories
  212. * @P9_DMAPPEND: mode bit for is append-only
  213. * @P9_DMEXCL: mode bit for excluse use (only one open handle allowed)
  214. * @P9_DMMOUNT: mode bit for mount points
  215. * @P9_DMAUTH: mode bit for authentication file
  216. * @P9_DMTMP: mode bit for non-backed-up files
  217. * @P9_DMSYMLINK: mode bit for symbolic links (9P2000.u)
  218. * @P9_DMLINK: mode bit for hard-link (9P2000.u)
  219. * @P9_DMDEVICE: mode bit for device files (9P2000.u)
  220. * @P9_DMNAMEDPIPE: mode bit for named pipe (9P2000.u)
  221. * @P9_DMSOCKET: mode bit for socket (9P2000.u)
  222. * @P9_DMSETUID: mode bit for setuid (9P2000.u)
  223. * @P9_DMSETGID: mode bit for setgid (9P2000.u)
  224. * @P9_DMSETVTX: mode bit for sticky bit (9P2000.u)
  225. *
  226. * 9P permissions differ slightly from Posix standard modes.
  227. *
  228. * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
  229. */
  230. enum p9_perm_t {
  231. P9_DMDIR = 0x80000000,
  232. P9_DMAPPEND = 0x40000000,
  233. P9_DMEXCL = 0x20000000,
  234. P9_DMMOUNT = 0x10000000,
  235. P9_DMAUTH = 0x08000000,
  236. P9_DMTMP = 0x04000000,
  237. /* 9P2000.u extensions */
  238. P9_DMSYMLINK = 0x02000000,
  239. P9_DMLINK = 0x01000000,
  240. P9_DMDEVICE = 0x00800000,
  241. P9_DMNAMEDPIPE = 0x00200000,
  242. P9_DMSOCKET = 0x00100000,
  243. P9_DMSETUID = 0x00080000,
  244. P9_DMSETGID = 0x00040000,
  245. P9_DMSETVTX = 0x00010000,
  246. };
  247. /* 9p2000.L open flags */
  248. #define P9_DOTL_RDONLY 00000000
  249. #define P9_DOTL_WRONLY 00000001
  250. #define P9_DOTL_RDWR 00000002
  251. #define P9_DOTL_NOACCESS 00000003
  252. #define P9_DOTL_CREATE 00000100
  253. #define P9_DOTL_EXCL 00000200
  254. #define P9_DOTL_NOCTTY 00000400
  255. #define P9_DOTL_TRUNC 00001000
  256. #define P9_DOTL_APPEND 00002000
  257. #define P9_DOTL_NONBLOCK 00004000
  258. #define P9_DOTL_DSYNC 00010000
  259. #define P9_DOTL_FASYNC 00020000
  260. #define P9_DOTL_DIRECT 00040000
  261. #define P9_DOTL_LARGEFILE 00100000
  262. #define P9_DOTL_DIRECTORY 00200000
  263. #define P9_DOTL_NOFOLLOW 00400000
  264. #define P9_DOTL_NOATIME 01000000
  265. #define P9_DOTL_CLOEXEC 02000000
  266. #define P9_DOTL_SYNC 04000000
  267. /* 9p2000.L at flags */
  268. #define P9_DOTL_AT_REMOVEDIR 0x200
  269. /* 9p2000.L lock type */
  270. #define P9_LOCK_TYPE_RDLCK 0
  271. #define P9_LOCK_TYPE_WRLCK 1
  272. #define P9_LOCK_TYPE_UNLCK 2
  273. /**
  274. * enum p9_qid_t - QID types
  275. * @P9_QTDIR: directory
  276. * @P9_QTAPPEND: append-only
  277. * @P9_QTEXCL: excluse use (only one open handle allowed)
  278. * @P9_QTMOUNT: mount points
  279. * @P9_QTAUTH: authentication file
  280. * @P9_QTTMP: non-backed-up files
  281. * @P9_QTSYMLINK: symbolic links (9P2000.u)
  282. * @P9_QTLINK: hard-link (9P2000.u)
  283. * @P9_QTFILE: normal files
  284. *
  285. * QID types are a subset of permissions - they are primarily
  286. * used to differentiate semantics for a file system entity via
  287. * a jump-table. Their value is also the most significant 16 bits
  288. * of the permission_t
  289. *
  290. * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
  291. */
  292. enum p9_qid_t {
  293. P9_QTDIR = 0x80,
  294. P9_QTAPPEND = 0x40,
  295. P9_QTEXCL = 0x20,
  296. P9_QTMOUNT = 0x10,
  297. P9_QTAUTH = 0x08,
  298. P9_QTTMP = 0x04,
  299. P9_QTSYMLINK = 0x02,
  300. P9_QTLINK = 0x01,
  301. P9_QTFILE = 0x00,
  302. };
  303. /* 9P Magic Numbers */
  304. #define P9_NOTAG ((u16)(~0))
  305. #define P9_NOFID ((u32)(~0))
  306. #define P9_MAXWELEM 16
  307. /* Minimal header size: size[4] type[1] tag[2] */
  308. #define P9_HDRSZ 7
  309. /* ample room for Twrite/Rread header */
  310. #define P9_IOHDRSZ 24
  311. /* Room for readdir header */
  312. #define P9_READDIRHDRSZ 24
  313. /* size of header for zero copy read/write */
  314. #define P9_ZC_HDR_SZ 4096
  315. /* maximum length of an error string */
  316. #define P9_ERRMAX 128
  317. /**
  318. * struct p9_qid - file system entity information
  319. * @type: 8-bit type &p9_qid_t
  320. * @version: 16-bit monotonically incrementing version number
  321. * @path: 64-bit per-server-unique ID for a file system element
  322. *
  323. * qids are identifiers used by 9P servers to track file system
  324. * entities. The type is used to differentiate semantics for operations
  325. * on the entity (ie. read means something different on a directory than
  326. * on a file). The path provides a server unique index for an entity
  327. * (roughly analogous to an inode number), while the version is updated
  328. * every time a file is modified and can be used to maintain cache
  329. * coherency between clients and serves.
  330. * Servers will often differentiate purely synthetic entities by setting
  331. * their version to 0, signaling that they should never be cached and
  332. * should be accessed synchronously.
  333. *
  334. * See Also://plan9.bell-labs.com/magic/man2html/2/stat
  335. */
  336. struct p9_qid {
  337. u8 type;
  338. u32 version;
  339. u64 path;
  340. };
  341. /**
  342. * struct p9_wstat - file system metadata information
  343. * @size: length prefix for this stat structure instance
  344. * @type: the type of the server (equivalent to a major number)
  345. * @dev: the sub-type of the server (equivalent to a minor number)
  346. * @qid: unique id from the server of type &p9_qid
  347. * @mode: Plan 9 format permissions of type &p9_perm_t
  348. * @atime: Last access/read time
  349. * @mtime: Last modify/write time
  350. * @length: file length
  351. * @name: last element of path (aka filename)
  352. * @uid: owner name
  353. * @gid: group owner
  354. * @muid: last modifier
  355. * @extension: area used to encode extended UNIX support
  356. * @n_uid: numeric user id of owner (part of 9p2000.u extension)
  357. * @n_gid: numeric group id (part of 9p2000.u extension)
  358. * @n_muid: numeric user id of laster modifier (part of 9p2000.u extension)
  359. *
  360. * See Also: http://plan9.bell-labs.com/magic/man2html/2/stat
  361. */
  362. struct p9_wstat {
  363. u16 size;
  364. u16 type;
  365. u32 dev;
  366. struct p9_qid qid;
  367. u32 mode;
  368. u32 atime;
  369. u32 mtime;
  370. u64 length;
  371. const char *name;
  372. const char *uid;
  373. const char *gid;
  374. const char *muid;
  375. char *extension; /* 9p2000.u extensions */
  376. kuid_t n_uid; /* 9p2000.u extensions */
  377. kgid_t n_gid; /* 9p2000.u extensions */
  378. kuid_t n_muid; /* 9p2000.u extensions */
  379. };
  380. struct p9_stat_dotl {
  381. u64 st_result_mask;
  382. struct p9_qid qid;
  383. u32 st_mode;
  384. kuid_t st_uid;
  385. kgid_t st_gid;
  386. u64 st_nlink;
  387. u64 st_rdev;
  388. u64 st_size;
  389. u64 st_blksize;
  390. u64 st_blocks;
  391. u64 st_atime_sec;
  392. u64 st_atime_nsec;
  393. u64 st_mtime_sec;
  394. u64 st_mtime_nsec;
  395. u64 st_ctime_sec;
  396. u64 st_ctime_nsec;
  397. u64 st_btime_sec;
  398. u64 st_btime_nsec;
  399. u64 st_gen;
  400. u64 st_data_version;
  401. };
  402. #define P9_STATS_MODE 0x00000001ULL
  403. #define P9_STATS_NLINK 0x00000002ULL
  404. #define P9_STATS_UID 0x00000004ULL
  405. #define P9_STATS_GID 0x00000008ULL
  406. #define P9_STATS_RDEV 0x00000010ULL
  407. #define P9_STATS_ATIME 0x00000020ULL
  408. #define P9_STATS_MTIME 0x00000040ULL
  409. #define P9_STATS_CTIME 0x00000080ULL
  410. #define P9_STATS_INO 0x00000100ULL
  411. #define P9_STATS_SIZE 0x00000200ULL
  412. #define P9_STATS_BLOCKS 0x00000400ULL
  413. #define P9_STATS_BTIME 0x00000800ULL
  414. #define P9_STATS_GEN 0x00001000ULL
  415. #define P9_STATS_DATA_VERSION 0x00002000ULL
  416. #define P9_STATS_BASIC 0x000007ffULL /* Mask for fields up to BLOCKS */
  417. #define P9_STATS_ALL 0x00003fffULL /* Mask for All fields above */
  418. /**
  419. * struct p9_iattr_dotl - P9 inode attribute for setattr
  420. * @valid: bitfield specifying which fields are valid
  421. * same as in struct iattr
  422. * @mode: File permission bits
  423. * @uid: user id of owner
  424. * @gid: group id
  425. * @size: File size
  426. * @atime_sec: Last access time, seconds
  427. * @atime_nsec: Last access time, nanoseconds
  428. * @mtime_sec: Last modification time, seconds
  429. * @mtime_nsec: Last modification time, nanoseconds
  430. */
  431. struct p9_iattr_dotl {
  432. u32 valid;
  433. u32 mode;
  434. kuid_t uid;
  435. kgid_t gid;
  436. u64 size;
  437. u64 atime_sec;
  438. u64 atime_nsec;
  439. u64 mtime_sec;
  440. u64 mtime_nsec;
  441. };
  442. #define P9_LOCK_SUCCESS 0
  443. #define P9_LOCK_BLOCKED 1
  444. #define P9_LOCK_ERROR 2
  445. #define P9_LOCK_GRACE 3
  446. #define P9_LOCK_FLAGS_BLOCK 1
  447. #define P9_LOCK_FLAGS_RECLAIM 2
  448. /* struct p9_flock: POSIX lock structure
  449. * @type - type of lock
  450. * @flags - lock flags
  451. * @start - starting offset of the lock
  452. * @length - number of bytes
  453. * @proc_id - process id which wants to take lock
  454. * @client_id - client id
  455. */
  456. struct p9_flock {
  457. u8 type;
  458. u32 flags;
  459. u64 start;
  460. u64 length;
  461. u32 proc_id;
  462. char *client_id;
  463. };
  464. /* struct p9_getlock: getlock structure
  465. * @type - type of lock
  466. * @start - starting offset of the lock
  467. * @length - number of bytes
  468. * @proc_id - process id which wants to take lock
  469. * @client_id - client id
  470. */
  471. struct p9_getlock {
  472. u8 type;
  473. u64 start;
  474. u64 length;
  475. u32 proc_id;
  476. char *client_id;
  477. };
  478. struct p9_rstatfs {
  479. u32 type;
  480. u32 bsize;
  481. u64 blocks;
  482. u64 bfree;
  483. u64 bavail;
  484. u64 files;
  485. u64 ffree;
  486. u64 fsid;
  487. u32 namelen;
  488. };
  489. /**
  490. * struct p9_fcall - primary packet structure
  491. * @size: prefixed length of the structure
  492. * @id: protocol operating identifier of type &p9_msg_t
  493. * @tag: transaction id of the request
  494. * @offset: used by marshalling routines to track current position in buffer
  495. * @capacity: used by marshalling routines to track total malloc'd capacity
  496. * @sdata: payload
  497. *
  498. * &p9_fcall represents the structure for all 9P RPC
  499. * transactions. Requests are packaged into fcalls, and reponses
  500. * must be extracted from them.
  501. *
  502. * See Also: http://plan9.bell-labs.com/magic/man2html/2/fcall
  503. */
  504. struct p9_fcall {
  505. u32 size;
  506. u8 id;
  507. u16 tag;
  508. size_t offset;
  509. size_t capacity;
  510. struct kmem_cache *cache;
  511. u8 *sdata;
  512. };
  513. int p9_errstr2errno(char *errstr, int len);
  514. int p9_error_init(void);
  515. #endif /* NET_9P_H */