ceph_fs.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752
  1. /*
  2. * ceph_fs.h - Ceph constants and data types to share between kernel and
  3. * user space.
  4. *
  5. * Most types in this file are defined as little-endian, and are
  6. * primarily intended to describe data structures that pass over the
  7. * wire or that are stored on disk.
  8. *
  9. * LGPL2
  10. */
  11. #ifndef CEPH_FS_H
  12. #define CEPH_FS_H
  13. #include "msgr.h"
  14. #include "rados.h"
  15. /*
  16. * subprotocol versions. when specific messages types or high-level
  17. * protocols change, bump the affected components. we keep rev
  18. * internal cluster protocols separately from the public,
  19. * client-facing protocol.
  20. */
  21. #define CEPH_OSD_PROTOCOL 8 /* cluster internal */
  22. #define CEPH_MDS_PROTOCOL 12 /* cluster internal */
  23. #define CEPH_MON_PROTOCOL 5 /* cluster internal */
  24. #define CEPH_OSDC_PROTOCOL 24 /* server/client */
  25. #define CEPH_MDSC_PROTOCOL 32 /* server/client */
  26. #define CEPH_MONC_PROTOCOL 15 /* server/client */
  27. #define CEPH_INO_ROOT 1
  28. #define CEPH_INO_CEPH 2 /* hidden .ceph dir */
  29. /* arbitrary limit on max # of monitors (cluster of 3 is typical) */
  30. #define CEPH_MAX_MON 31
  31. /*
  32. * feature bits
  33. */
  34. #define CEPH_FEATURE_UID (1<<0)
  35. #define CEPH_FEATURE_NOSRCADDR (1<<1)
  36. #define CEPH_FEATURE_MONCLOCKCHECK (1<<2)
  37. #define CEPH_FEATURE_FLOCK (1<<3)
  38. #define CEPH_FEATURE_SUBSCRIBE2 (1<<4)
  39. #define CEPH_FEATURE_MONNAMES (1<<5)
  40. #define CEPH_FEATURE_RECONNECT_SEQ (1<<6)
  41. #define CEPH_FEATURE_DIRLAYOUTHASH (1<<7)
  42. /*
  43. * ceph_file_layout - describe data layout for a file/inode
  44. */
  45. struct ceph_file_layout {
  46. /* file -> object mapping */
  47. __le32 fl_stripe_unit; /* stripe unit, in bytes. must be multiple
  48. of page size. */
  49. __le32 fl_stripe_count; /* over this many objects */
  50. __le32 fl_object_size; /* until objects are this big, then move to
  51. new objects */
  52. __le32 fl_cas_hash; /* UNUSED. 0 = none; 1 = sha256 */
  53. /* pg -> disk layout */
  54. __le32 fl_object_stripe_unit; /* UNUSED. for per-object parity, if any */
  55. /* object -> pg layout */
  56. __le32 fl_pg_preferred; /* preferred primary for pg (-1 for none) */
  57. __le32 fl_pg_pool; /* namespace, crush ruleset, rep level */
  58. } __attribute__ ((packed));
  59. #define CEPH_MIN_STRIPE_UNIT 65536
  60. int ceph_file_layout_is_valid(const struct ceph_file_layout *layout);
  61. struct ceph_dir_layout {
  62. __u8 dl_dir_hash; /* see ceph_hash.h for ids */
  63. __u8 dl_unused1;
  64. __u16 dl_unused2;
  65. __u32 dl_unused3;
  66. } __attribute__ ((packed));
  67. /* crypto algorithms */
  68. #define CEPH_CRYPTO_NONE 0x0
  69. #define CEPH_CRYPTO_AES 0x1
  70. #define CEPH_AES_IV "cephsageyudagreg"
  71. /* security/authentication protocols */
  72. #define CEPH_AUTH_UNKNOWN 0x0
  73. #define CEPH_AUTH_NONE 0x1
  74. #define CEPH_AUTH_CEPHX 0x2
  75. #define CEPH_AUTH_UID_DEFAULT ((__u64) -1)
  76. /*********************************************
  77. * message layer
  78. */
  79. /*
  80. * message types
  81. */
  82. /* misc */
  83. #define CEPH_MSG_SHUTDOWN 1
  84. #define CEPH_MSG_PING 2
  85. /* client <-> monitor */
  86. #define CEPH_MSG_MON_MAP 4
  87. #define CEPH_MSG_MON_GET_MAP 5
  88. #define CEPH_MSG_STATFS 13
  89. #define CEPH_MSG_STATFS_REPLY 14
  90. #define CEPH_MSG_MON_SUBSCRIBE 15
  91. #define CEPH_MSG_MON_SUBSCRIBE_ACK 16
  92. #define CEPH_MSG_AUTH 17
  93. #define CEPH_MSG_AUTH_REPLY 18
  94. /* client <-> mds */
  95. #define CEPH_MSG_MDS_MAP 21
  96. #define CEPH_MSG_CLIENT_SESSION 22
  97. #define CEPH_MSG_CLIENT_RECONNECT 23
  98. #define CEPH_MSG_CLIENT_REQUEST 24
  99. #define CEPH_MSG_CLIENT_REQUEST_FORWARD 25
  100. #define CEPH_MSG_CLIENT_REPLY 26
  101. #define CEPH_MSG_CLIENT_CAPS 0x310
  102. #define CEPH_MSG_CLIENT_LEASE 0x311
  103. #define CEPH_MSG_CLIENT_SNAP 0x312
  104. #define CEPH_MSG_CLIENT_CAPRELEASE 0x313
  105. /* pool ops */
  106. #define CEPH_MSG_POOLOP_REPLY 48
  107. #define CEPH_MSG_POOLOP 49
  108. /* osd */
  109. #define CEPH_MSG_OSD_MAP 41
  110. #define CEPH_MSG_OSD_OP 42
  111. #define CEPH_MSG_OSD_OPREPLY 43
  112. #define CEPH_MSG_WATCH_NOTIFY 44
  113. /* watch-notify operations */
  114. enum {
  115. WATCH_NOTIFY = 1, /* notifying watcher */
  116. WATCH_NOTIFY_COMPLETE = 2, /* notifier notified when done */
  117. };
  118. /* pool operations */
  119. enum {
  120. POOL_OP_CREATE = 0x01,
  121. POOL_OP_DELETE = 0x02,
  122. POOL_OP_AUID_CHANGE = 0x03,
  123. POOL_OP_CREATE_SNAP = 0x11,
  124. POOL_OP_DELETE_SNAP = 0x12,
  125. POOL_OP_CREATE_UNMANAGED_SNAP = 0x21,
  126. POOL_OP_DELETE_UNMANAGED_SNAP = 0x22,
  127. };
  128. struct ceph_mon_request_header {
  129. __le64 have_version;
  130. __le16 session_mon;
  131. __le64 session_mon_tid;
  132. } __attribute__ ((packed));
  133. struct ceph_mon_statfs {
  134. struct ceph_mon_request_header monhdr;
  135. struct ceph_fsid fsid;
  136. } __attribute__ ((packed));
  137. struct ceph_statfs {
  138. __le64 kb, kb_used, kb_avail;
  139. __le64 num_objects;
  140. } __attribute__ ((packed));
  141. struct ceph_mon_statfs_reply {
  142. struct ceph_fsid fsid;
  143. __le64 version;
  144. struct ceph_statfs st;
  145. } __attribute__ ((packed));
  146. const char *ceph_pool_op_name(int op);
  147. struct ceph_mon_poolop {
  148. struct ceph_mon_request_header monhdr;
  149. struct ceph_fsid fsid;
  150. __le32 pool;
  151. __le32 op;
  152. __le64 auid;
  153. __le64 snapid;
  154. __le32 name_len;
  155. } __attribute__ ((packed));
  156. struct ceph_mon_poolop_reply {
  157. struct ceph_mon_request_header monhdr;
  158. struct ceph_fsid fsid;
  159. __le32 reply_code;
  160. __le32 epoch;
  161. char has_data;
  162. char data[0];
  163. } __attribute__ ((packed));
  164. struct ceph_mon_unmanaged_snap {
  165. __le64 snapid;
  166. } __attribute__ ((packed));
  167. struct ceph_osd_getmap {
  168. struct ceph_mon_request_header monhdr;
  169. struct ceph_fsid fsid;
  170. __le32 start;
  171. } __attribute__ ((packed));
  172. struct ceph_mds_getmap {
  173. struct ceph_mon_request_header monhdr;
  174. struct ceph_fsid fsid;
  175. } __attribute__ ((packed));
  176. struct ceph_client_mount {
  177. struct ceph_mon_request_header monhdr;
  178. } __attribute__ ((packed));
  179. #define CEPH_SUBSCRIBE_ONETIME 1 /* i want only 1 update after have */
  180. struct ceph_mon_subscribe_item {
  181. __le64 have_version; __le64 have;
  182. __u8 onetime;
  183. } __attribute__ ((packed));
  184. struct ceph_mon_subscribe_ack {
  185. __le32 duration; /* seconds */
  186. struct ceph_fsid fsid;
  187. } __attribute__ ((packed));
  188. /*
  189. * mds states
  190. * > 0 -> in
  191. * <= 0 -> out
  192. */
  193. #define CEPH_MDS_STATE_DNE 0 /* down, does not exist. */
  194. #define CEPH_MDS_STATE_STOPPED -1 /* down, once existed, but no subtrees.
  195. empty log. */
  196. #define CEPH_MDS_STATE_BOOT -4 /* up, boot announcement. */
  197. #define CEPH_MDS_STATE_STANDBY -5 /* up, idle. waiting for assignment. */
  198. #define CEPH_MDS_STATE_CREATING -6 /* up, creating MDS instance. */
  199. #define CEPH_MDS_STATE_STARTING -7 /* up, starting previously stopped mds */
  200. #define CEPH_MDS_STATE_STANDBY_REPLAY -8 /* up, tailing active node's journal */
  201. #define CEPH_MDS_STATE_REPLAY 8 /* up, replaying journal. */
  202. #define CEPH_MDS_STATE_RESOLVE 9 /* up, disambiguating distributed
  203. operations (import, rename, etc.) */
  204. #define CEPH_MDS_STATE_RECONNECT 10 /* up, reconnect to clients */
  205. #define CEPH_MDS_STATE_REJOIN 11 /* up, rejoining distributed cache */
  206. #define CEPH_MDS_STATE_CLIENTREPLAY 12 /* up, replaying client operations */
  207. #define CEPH_MDS_STATE_ACTIVE 13 /* up, active */
  208. #define CEPH_MDS_STATE_STOPPING 14 /* up, but exporting metadata */
  209. extern const char *ceph_mds_state_name(int s);
  210. /*
  211. * metadata lock types.
  212. * - these are bitmasks.. we can compose them
  213. * - they also define the lock ordering by the MDS
  214. * - a few of these are internal to the mds
  215. */
  216. #define CEPH_LOCK_DVERSION 1
  217. #define CEPH_LOCK_DN 2
  218. #define CEPH_LOCK_ISNAP 16
  219. #define CEPH_LOCK_IVERSION 32 /* mds internal */
  220. #define CEPH_LOCK_IFILE 64
  221. #define CEPH_LOCK_IAUTH 128
  222. #define CEPH_LOCK_ILINK 256
  223. #define CEPH_LOCK_IDFT 512 /* dir frag tree */
  224. #define CEPH_LOCK_INEST 1024 /* mds internal */
  225. #define CEPH_LOCK_IXATTR 2048
  226. #define CEPH_LOCK_IFLOCK 4096 /* advisory file locks */
  227. #define CEPH_LOCK_INO 8192 /* immutable inode bits; not a lock */
  228. /* client_session ops */
  229. enum {
  230. CEPH_SESSION_REQUEST_OPEN,
  231. CEPH_SESSION_OPEN,
  232. CEPH_SESSION_REQUEST_CLOSE,
  233. CEPH_SESSION_CLOSE,
  234. CEPH_SESSION_REQUEST_RENEWCAPS,
  235. CEPH_SESSION_RENEWCAPS,
  236. CEPH_SESSION_STALE,
  237. CEPH_SESSION_RECALL_STATE,
  238. };
  239. extern const char *ceph_session_op_name(int op);
  240. struct ceph_mds_session_head {
  241. __le32 op;
  242. __le64 seq;
  243. struct ceph_timespec stamp;
  244. __le32 max_caps, max_leases;
  245. } __attribute__ ((packed));
  246. /* client_request */
  247. /*
  248. * metadata ops.
  249. * & 0x001000 -> write op
  250. * & 0x010000 -> follow symlink (e.g. stat(), not lstat()).
  251. & & 0x100000 -> use weird ino/path trace
  252. */
  253. #define CEPH_MDS_OP_WRITE 0x001000
  254. enum {
  255. CEPH_MDS_OP_LOOKUP = 0x00100,
  256. CEPH_MDS_OP_GETATTR = 0x00101,
  257. CEPH_MDS_OP_LOOKUPHASH = 0x00102,
  258. CEPH_MDS_OP_LOOKUPPARENT = 0x00103,
  259. CEPH_MDS_OP_LOOKUPINO = 0x00104,
  260. CEPH_MDS_OP_SETXATTR = 0x01105,
  261. CEPH_MDS_OP_RMXATTR = 0x01106,
  262. CEPH_MDS_OP_SETLAYOUT = 0x01107,
  263. CEPH_MDS_OP_SETATTR = 0x01108,
  264. CEPH_MDS_OP_SETFILELOCK= 0x01109,
  265. CEPH_MDS_OP_GETFILELOCK= 0x00110,
  266. CEPH_MDS_OP_SETDIRLAYOUT=0x0110a,
  267. CEPH_MDS_OP_MKNOD = 0x01201,
  268. CEPH_MDS_OP_LINK = 0x01202,
  269. CEPH_MDS_OP_UNLINK = 0x01203,
  270. CEPH_MDS_OP_RENAME = 0x01204,
  271. CEPH_MDS_OP_MKDIR = 0x01220,
  272. CEPH_MDS_OP_RMDIR = 0x01221,
  273. CEPH_MDS_OP_SYMLINK = 0x01222,
  274. CEPH_MDS_OP_CREATE = 0x01301,
  275. CEPH_MDS_OP_OPEN = 0x00302,
  276. CEPH_MDS_OP_READDIR = 0x00305,
  277. CEPH_MDS_OP_LOOKUPSNAP = 0x00400,
  278. CEPH_MDS_OP_MKSNAP = 0x01400,
  279. CEPH_MDS_OP_RMSNAP = 0x01401,
  280. CEPH_MDS_OP_LSSNAP = 0x00402,
  281. };
  282. extern const char *ceph_mds_op_name(int op);
  283. #define CEPH_SETATTR_MODE 1
  284. #define CEPH_SETATTR_UID 2
  285. #define CEPH_SETATTR_GID 4
  286. #define CEPH_SETATTR_MTIME 8
  287. #define CEPH_SETATTR_ATIME 16
  288. #define CEPH_SETATTR_SIZE 32
  289. #define CEPH_SETATTR_CTIME 64
  290. union ceph_mds_request_args {
  291. struct {
  292. __le32 mask; /* CEPH_CAP_* */
  293. } __attribute__ ((packed)) getattr;
  294. struct {
  295. __le32 mode;
  296. __le32 uid;
  297. __le32 gid;
  298. struct ceph_timespec mtime;
  299. struct ceph_timespec atime;
  300. __le64 size, old_size; /* old_size needed by truncate */
  301. __le32 mask; /* CEPH_SETATTR_* */
  302. } __attribute__ ((packed)) setattr;
  303. struct {
  304. __le32 frag; /* which dir fragment */
  305. __le32 max_entries; /* how many dentries to grab */
  306. __le32 max_bytes;
  307. } __attribute__ ((packed)) readdir;
  308. struct {
  309. __le32 mode;
  310. __le32 rdev;
  311. } __attribute__ ((packed)) mknod;
  312. struct {
  313. __le32 mode;
  314. } __attribute__ ((packed)) mkdir;
  315. struct {
  316. __le32 flags;
  317. __le32 mode;
  318. __le32 stripe_unit; /* layout for newly created file */
  319. __le32 stripe_count; /* ... */
  320. __le32 object_size;
  321. __le32 file_replication;
  322. __le32 preferred;
  323. } __attribute__ ((packed)) open;
  324. struct {
  325. __le32 flags;
  326. } __attribute__ ((packed)) setxattr;
  327. struct {
  328. struct ceph_file_layout layout;
  329. } __attribute__ ((packed)) setlayout;
  330. struct {
  331. __u8 rule; /* currently fcntl or flock */
  332. __u8 type; /* shared, exclusive, remove*/
  333. __le64 pid; /* process id requesting the lock */
  334. __le64 pid_namespace;
  335. __le64 start; /* initial location to lock */
  336. __le64 length; /* num bytes to lock from start */
  337. __u8 wait; /* will caller wait for lock to become available? */
  338. } __attribute__ ((packed)) filelock_change;
  339. } __attribute__ ((packed));
  340. #define CEPH_MDS_FLAG_REPLAY 1 /* this is a replayed op */
  341. #define CEPH_MDS_FLAG_WANT_DENTRY 2 /* want dentry in reply */
  342. struct ceph_mds_request_head {
  343. __le64 oldest_client_tid;
  344. __le32 mdsmap_epoch; /* on client */
  345. __le32 flags; /* CEPH_MDS_FLAG_* */
  346. __u8 num_retry, num_fwd; /* count retry, fwd attempts */
  347. __le16 num_releases; /* # include cap/lease release records */
  348. __le32 op; /* mds op code */
  349. __le32 caller_uid, caller_gid;
  350. __le64 ino; /* use this ino for openc, mkdir, mknod,
  351. etc. (if replaying) */
  352. union ceph_mds_request_args args;
  353. } __attribute__ ((packed));
  354. /* cap/lease release record */
  355. struct ceph_mds_request_release {
  356. __le64 ino, cap_id; /* ino and unique cap id */
  357. __le32 caps, wanted; /* new issued, wanted */
  358. __le32 seq, issue_seq, mseq;
  359. __le32 dname_seq; /* if releasing a dentry lease, a */
  360. __le32 dname_len; /* string follows. */
  361. } __attribute__ ((packed));
  362. /* client reply */
  363. struct ceph_mds_reply_head {
  364. __le32 op;
  365. __le32 result;
  366. __le32 mdsmap_epoch;
  367. __u8 safe; /* true if committed to disk */
  368. __u8 is_dentry, is_target; /* true if dentry, target inode records
  369. are included with reply */
  370. } __attribute__ ((packed));
  371. /* one for each node split */
  372. struct ceph_frag_tree_split {
  373. __le32 frag; /* this frag splits... */
  374. __le32 by; /* ...by this many bits */
  375. } __attribute__ ((packed));
  376. struct ceph_frag_tree_head {
  377. __le32 nsplits; /* num ceph_frag_tree_split records */
  378. struct ceph_frag_tree_split splits[];
  379. } __attribute__ ((packed));
  380. /* capability issue, for bundling with mds reply */
  381. struct ceph_mds_reply_cap {
  382. __le32 caps, wanted; /* caps issued, wanted */
  383. __le64 cap_id;
  384. __le32 seq, mseq;
  385. __le64 realm; /* snap realm */
  386. __u8 flags; /* CEPH_CAP_FLAG_* */
  387. } __attribute__ ((packed));
  388. #define CEPH_CAP_FLAG_AUTH 1 /* cap is issued by auth mds */
  389. /* inode record, for bundling with mds reply */
  390. struct ceph_mds_reply_inode {
  391. __le64 ino;
  392. __le64 snapid;
  393. __le32 rdev;
  394. __le64 version; /* inode version */
  395. __le64 xattr_version; /* version for xattr blob */
  396. struct ceph_mds_reply_cap cap; /* caps issued for this inode */
  397. struct ceph_file_layout layout;
  398. struct ceph_timespec ctime, mtime, atime;
  399. __le32 time_warp_seq;
  400. __le64 size, max_size, truncate_size;
  401. __le32 truncate_seq;
  402. __le32 mode, uid, gid;
  403. __le32 nlink;
  404. __le64 files, subdirs, rbytes, rfiles, rsubdirs; /* dir stats */
  405. struct ceph_timespec rctime;
  406. struct ceph_frag_tree_head fragtree; /* (must be at end of struct) */
  407. } __attribute__ ((packed));
  408. /* followed by frag array, symlink string, dir layout, xattr blob */
  409. /* reply_lease follows dname, and reply_inode */
  410. struct ceph_mds_reply_lease {
  411. __le16 mask; /* lease type(s) */
  412. __le32 duration_ms; /* lease duration */
  413. __le32 seq;
  414. } __attribute__ ((packed));
  415. struct ceph_mds_reply_dirfrag {
  416. __le32 frag; /* fragment */
  417. __le32 auth; /* auth mds, if this is a delegation point */
  418. __le32 ndist; /* number of mds' this is replicated on */
  419. __le32 dist[];
  420. } __attribute__ ((packed));
  421. #define CEPH_LOCK_FCNTL 1
  422. #define CEPH_LOCK_FLOCK 2
  423. #define CEPH_LOCK_SHARED 1
  424. #define CEPH_LOCK_EXCL 2
  425. #define CEPH_LOCK_UNLOCK 4
  426. struct ceph_filelock {
  427. __le64 start;/* file offset to start lock at */
  428. __le64 length; /* num bytes to lock; 0 for all following start */
  429. __le64 client; /* which client holds the lock */
  430. __le64 pid; /* process id holding the lock on the client */
  431. __le64 pid_namespace;
  432. __u8 type; /* shared lock, exclusive lock, or unlock */
  433. } __attribute__ ((packed));
  434. /* file access modes */
  435. #define CEPH_FILE_MODE_PIN 0
  436. #define CEPH_FILE_MODE_RD 1
  437. #define CEPH_FILE_MODE_WR 2
  438. #define CEPH_FILE_MODE_RDWR 3 /* RD | WR */
  439. #define CEPH_FILE_MODE_LAZY 4 /* lazy io */
  440. #define CEPH_FILE_MODE_NUM 8 /* bc these are bit fields.. mostly */
  441. int ceph_flags_to_mode(int flags);
  442. /* capability bits */
  443. #define CEPH_CAP_PIN 1 /* no specific capabilities beyond the pin */
  444. /* generic cap bits */
  445. #define CEPH_CAP_GSHARED 1 /* client can reads */
  446. #define CEPH_CAP_GEXCL 2 /* client can read and update */
  447. #define CEPH_CAP_GCACHE 4 /* (file) client can cache reads */
  448. #define CEPH_CAP_GRD 8 /* (file) client can read */
  449. #define CEPH_CAP_GWR 16 /* (file) client can write */
  450. #define CEPH_CAP_GBUFFER 32 /* (file) client can buffer writes */
  451. #define CEPH_CAP_GWREXTEND 64 /* (file) client can extend EOF */
  452. #define CEPH_CAP_GLAZYIO 128 /* (file) client can perform lazy io */
  453. /* per-lock shift */
  454. #define CEPH_CAP_SAUTH 2
  455. #define CEPH_CAP_SLINK 4
  456. #define CEPH_CAP_SXATTR 6
  457. #define CEPH_CAP_SFILE 8
  458. #define CEPH_CAP_SFLOCK 20
  459. #define CEPH_CAP_BITS 22
  460. /* composed values */
  461. #define CEPH_CAP_AUTH_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SAUTH)
  462. #define CEPH_CAP_AUTH_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SAUTH)
  463. #define CEPH_CAP_LINK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SLINK)
  464. #define CEPH_CAP_LINK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SLINK)
  465. #define CEPH_CAP_XATTR_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SXATTR)
  466. #define CEPH_CAP_XATTR_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SXATTR)
  467. #define CEPH_CAP_FILE(x) (x << CEPH_CAP_SFILE)
  468. #define CEPH_CAP_FILE_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFILE)
  469. #define CEPH_CAP_FILE_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFILE)
  470. #define CEPH_CAP_FILE_CACHE (CEPH_CAP_GCACHE << CEPH_CAP_SFILE)
  471. #define CEPH_CAP_FILE_RD (CEPH_CAP_GRD << CEPH_CAP_SFILE)
  472. #define CEPH_CAP_FILE_WR (CEPH_CAP_GWR << CEPH_CAP_SFILE)
  473. #define CEPH_CAP_FILE_BUFFER (CEPH_CAP_GBUFFER << CEPH_CAP_SFILE)
  474. #define CEPH_CAP_FILE_WREXTEND (CEPH_CAP_GWREXTEND << CEPH_CAP_SFILE)
  475. #define CEPH_CAP_FILE_LAZYIO (CEPH_CAP_GLAZYIO << CEPH_CAP_SFILE)
  476. #define CEPH_CAP_FLOCK_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SFLOCK)
  477. #define CEPH_CAP_FLOCK_EXCL (CEPH_CAP_GEXCL << CEPH_CAP_SFLOCK)
  478. /* cap masks (for getattr) */
  479. #define CEPH_STAT_CAP_INODE CEPH_CAP_PIN
  480. #define CEPH_STAT_CAP_TYPE CEPH_CAP_PIN /* mode >> 12 */
  481. #define CEPH_STAT_CAP_SYMLINK CEPH_CAP_PIN
  482. #define CEPH_STAT_CAP_UID CEPH_CAP_AUTH_SHARED
  483. #define CEPH_STAT_CAP_GID CEPH_CAP_AUTH_SHARED
  484. #define CEPH_STAT_CAP_MODE CEPH_CAP_AUTH_SHARED
  485. #define CEPH_STAT_CAP_NLINK CEPH_CAP_LINK_SHARED
  486. #define CEPH_STAT_CAP_LAYOUT CEPH_CAP_FILE_SHARED
  487. #define CEPH_STAT_CAP_MTIME CEPH_CAP_FILE_SHARED
  488. #define CEPH_STAT_CAP_SIZE CEPH_CAP_FILE_SHARED
  489. #define CEPH_STAT_CAP_ATIME CEPH_CAP_FILE_SHARED /* fixme */
  490. #define CEPH_STAT_CAP_XATTR CEPH_CAP_XATTR_SHARED
  491. #define CEPH_STAT_CAP_INODE_ALL (CEPH_CAP_PIN | \
  492. CEPH_CAP_AUTH_SHARED | \
  493. CEPH_CAP_LINK_SHARED | \
  494. CEPH_CAP_FILE_SHARED | \
  495. CEPH_CAP_XATTR_SHARED)
  496. #define CEPH_CAP_ANY_SHARED (CEPH_CAP_AUTH_SHARED | \
  497. CEPH_CAP_LINK_SHARED | \
  498. CEPH_CAP_XATTR_SHARED | \
  499. CEPH_CAP_FILE_SHARED)
  500. #define CEPH_CAP_ANY_RD (CEPH_CAP_ANY_SHARED | CEPH_CAP_FILE_RD | \
  501. CEPH_CAP_FILE_CACHE)
  502. #define CEPH_CAP_ANY_EXCL (CEPH_CAP_AUTH_EXCL | \
  503. CEPH_CAP_LINK_EXCL | \
  504. CEPH_CAP_XATTR_EXCL | \
  505. CEPH_CAP_FILE_EXCL)
  506. #define CEPH_CAP_ANY_FILE_WR (CEPH_CAP_FILE_WR | CEPH_CAP_FILE_BUFFER | \
  507. CEPH_CAP_FILE_EXCL)
  508. #define CEPH_CAP_ANY_WR (CEPH_CAP_ANY_EXCL | CEPH_CAP_ANY_FILE_WR)
  509. #define CEPH_CAP_ANY (CEPH_CAP_ANY_RD | CEPH_CAP_ANY_EXCL | \
  510. CEPH_CAP_ANY_FILE_WR | CEPH_CAP_FILE_LAZYIO | \
  511. CEPH_CAP_PIN)
  512. #define CEPH_CAP_LOCKS (CEPH_LOCK_IFILE | CEPH_LOCK_IAUTH | CEPH_LOCK_ILINK | \
  513. CEPH_LOCK_IXATTR)
  514. int ceph_caps_for_mode(int mode);
  515. enum {
  516. CEPH_CAP_OP_GRANT, /* mds->client grant */
  517. CEPH_CAP_OP_REVOKE, /* mds->client revoke */
  518. CEPH_CAP_OP_TRUNC, /* mds->client trunc notify */
  519. CEPH_CAP_OP_EXPORT, /* mds has exported the cap */
  520. CEPH_CAP_OP_IMPORT, /* mds has imported the cap */
  521. CEPH_CAP_OP_UPDATE, /* client->mds update */
  522. CEPH_CAP_OP_DROP, /* client->mds drop cap bits */
  523. CEPH_CAP_OP_FLUSH, /* client->mds cap writeback */
  524. CEPH_CAP_OP_FLUSH_ACK, /* mds->client flushed */
  525. CEPH_CAP_OP_FLUSHSNAP, /* client->mds flush snapped metadata */
  526. CEPH_CAP_OP_FLUSHSNAP_ACK, /* mds->client flushed snapped metadata */
  527. CEPH_CAP_OP_RELEASE, /* client->mds release (clean) cap */
  528. CEPH_CAP_OP_RENEW, /* client->mds renewal request */
  529. };
  530. extern const char *ceph_cap_op_name(int op);
  531. /*
  532. * caps message, used for capability callbacks, acks, requests, etc.
  533. */
  534. struct ceph_mds_caps {
  535. __le32 op; /* CEPH_CAP_OP_* */
  536. __le64 ino, realm;
  537. __le64 cap_id;
  538. __le32 seq, issue_seq;
  539. __le32 caps, wanted, dirty; /* latest issued/wanted/dirty */
  540. __le32 migrate_seq;
  541. __le64 snap_follows;
  542. __le32 snap_trace_len;
  543. /* authlock */
  544. __le32 uid, gid, mode;
  545. /* linklock */
  546. __le32 nlink;
  547. /* xattrlock */
  548. __le32 xattr_len;
  549. __le64 xattr_version;
  550. /* filelock */
  551. __le64 size, max_size, truncate_size;
  552. __le32 truncate_seq;
  553. struct ceph_timespec mtime, atime, ctime;
  554. struct ceph_file_layout layout;
  555. __le32 time_warp_seq;
  556. } __attribute__ ((packed));
  557. /* cap release msg head */
  558. struct ceph_mds_cap_release {
  559. __le32 num; /* number of cap_items that follow */
  560. } __attribute__ ((packed));
  561. struct ceph_mds_cap_item {
  562. __le64 ino;
  563. __le64 cap_id;
  564. __le32 migrate_seq, seq;
  565. } __attribute__ ((packed));
  566. #define CEPH_MDS_LEASE_REVOKE 1 /* mds -> client */
  567. #define CEPH_MDS_LEASE_RELEASE 2 /* client -> mds */
  568. #define CEPH_MDS_LEASE_RENEW 3 /* client <-> mds */
  569. #define CEPH_MDS_LEASE_REVOKE_ACK 4 /* client -> mds */
  570. extern const char *ceph_lease_op_name(int o);
  571. /* lease msg header */
  572. struct ceph_mds_lease {
  573. __u8 action; /* CEPH_MDS_LEASE_* */
  574. __le16 mask; /* which lease */
  575. __le64 ino;
  576. __le64 first, last; /* snap range */
  577. __le32 seq;
  578. __le32 duration_ms; /* duration of renewal */
  579. } __attribute__ ((packed));
  580. /* followed by a __le32+string for dname */
  581. /* client reconnect */
  582. struct ceph_mds_cap_reconnect {
  583. __le64 cap_id;
  584. __le32 wanted;
  585. __le32 issued;
  586. __le64 snaprealm;
  587. __le64 pathbase; /* base ino for our path to this ino */
  588. __le32 flock_len; /* size of flock state blob, if any */
  589. } __attribute__ ((packed));
  590. /* followed by flock blob */
  591. struct ceph_mds_cap_reconnect_v1 {
  592. __le64 cap_id;
  593. __le32 wanted;
  594. __le32 issued;
  595. __le64 size;
  596. struct ceph_timespec mtime, atime;
  597. __le64 snaprealm;
  598. __le64 pathbase; /* base ino for our path to this ino */
  599. } __attribute__ ((packed));
  600. struct ceph_mds_snaprealm_reconnect {
  601. __le64 ino; /* snap realm base */
  602. __le64 seq; /* snap seq for this snap realm */
  603. __le64 parent; /* parent realm */
  604. } __attribute__ ((packed));
  605. /*
  606. * snaps
  607. */
  608. enum {
  609. CEPH_SNAP_OP_UPDATE, /* CREATE or DESTROY */
  610. CEPH_SNAP_OP_CREATE,
  611. CEPH_SNAP_OP_DESTROY,
  612. CEPH_SNAP_OP_SPLIT,
  613. };
  614. extern const char *ceph_snap_op_name(int o);
  615. /* snap msg header */
  616. struct ceph_mds_snap_head {
  617. __le32 op; /* CEPH_SNAP_OP_* */
  618. __le64 split; /* ino to split off, if any */
  619. __le32 num_split_inos; /* # inos belonging to new child realm */
  620. __le32 num_split_realms; /* # child realms udner new child realm */
  621. __le32 trace_len; /* size of snap trace blob */
  622. } __attribute__ ((packed));
  623. /* followed by split ino list, then split realms, then the trace blob */
  624. /*
  625. * encode info about a snaprealm, as viewed by a client
  626. */
  627. struct ceph_mds_snap_realm {
  628. __le64 ino; /* ino */
  629. __le64 created; /* snap: when created */
  630. __le64 parent; /* ino: parent realm */
  631. __le64 parent_since; /* snap: same parent since */
  632. __le64 seq; /* snap: version */
  633. __le32 num_snaps;
  634. __le32 num_prior_parent_snaps;
  635. } __attribute__ ((packed));
  636. /* followed by my snap list, then prior parent snap list */
  637. #endif